{"@context": "https://schema.org", "@type": "WebAPI", "name": "OpenAQ API", "description": "API for OpenAQ LCS", "provider": {"@type": "Organization", "name": "openaq.local"}, "documentation": "https://docs.openaq.org/openapi.json"}
Index / APIs / openaq.local

OpenAQ API

API for OpenAQ LCS

Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.

Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.

base URLs: http://openaq.local

find it by capability: POST /search {"query":{"text":"..."}} returns these operations with their invocation detail. Connect any agent client.

OpenAQ v2.0.0

API for OpenAQ LCS

methodpathwhat the vendor says it does
GET/favicon.icoFavico
GET/pingPong Sanity check. This will let the user know that the service is operational. And this path operation will:
GET/v1/citiesProvides a simple listing of cities within the platform v1
GET/v1/countriesCountries Getv1 v1
GET/v1/countries/{country_id}Countries Get v1
GET/v1/latestLatest V1 Get v1
GET/v1/latest/{location_id}Latest V1 Get v1
GET/v1/locationsLocationsv1 Get v1
GET/v1/locations/{location_id}Locationsv1 Get v1
GET/v1/measurementsMeasurements Get V1 v1
GET/v1/parametersParameters Getv1 v1
GET/v1/sourcesSources V1 Get v1
GET/v2/averagesAverages V2 Get v2
GET/v2/citiesProvides a simple listing of cities within the platform v2
GET/v2/countriesCountries Get v2
GET/v2/countries/{country_id}Countries Get v2
GET/v2/latestLatest Get v2
GET/v2/latest/{location_id}Latest Get v2
GET/v2/locationsLocations Get v2
GET/v2/locations/tiles/mobile-generalized/tiles.jsonMobilegentilejson v2
GET/v2/locations/tiles/mobile-generalized/{z}/{x}/{y}.pbfGet Mobilegentile v2
GET/v2/locations/tiles/mobile/tiles.jsonMobiletilejson v2
GET/v2/locations/tiles/mobile/{z}/{x}/{y}.pbfGet Mobiletile v2
GET/v2/locations/tiles/tiles.jsonTilejson v2
GET/v2/locations/tiles/viewerDemo v2
GET/v2/locations/tiles/{z}/{x}/{y}.pbfGet Tile v2
GET/v2/locations/{location_id}Locations Get v2
GET/v2/manufacturersMfr Get v2
GET/v2/measurementsMeasurements Get v2
GET/v2/modelsModel Get v2
GET/v2/parametersParameters Get v2
GET/v2/projectsProjects Get v2
GET/v2/projects/{project_id}Projects Get v2
GET/v2/sourcesSources Get v2
GET/v2/sources/readme/{slug}Readme Get v2
GET/v2/summarySummary Get v2

specification origin: https://docs.openaq.org/openapi.json

nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.