{ "opencollection": "1.0.0", "info": { "name": "OpenAQ Averages Locations API", "version": "2.0.0" }, "items": [ { "info": { "name": "Locations", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Get a location by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/locations/:locations_id", "params": [ { "name": "locations_id", "value": "", "type": "path", "description": "Limit the results to a specific location by id" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a location by location ID" }, { "info": { "name": "OpenAQ Get locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/locations", "params": [ { "name": "coordinates", "value": "", "type": "query", "description": "WGS 84 Coordinate pair in form latitude,longitude. Supports up to 4 decimal points of precision, additional decimal precision will be truncated in the query e.g. 38.9074,-77.0373" }, { "name": "radius", "value": "", "type": "query", "description": "Search radius from coordinates as center in meters. Maximum of 25,000 (25km) defaults to 1000 (1km) e.g. radius=1000" }, { "name": "providers_id", "value": "", "type": "query", "description": "Limit the results to a specific provider or multiple providers with a single provider ID or a comma delimited list of IDs" }, { "name": "parameters_id", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Change the number of results returned.\n e.g. limit=100 will return up to 100 results" }, { "name": "page", "value": "", "type": "query", "description": "Paginate through results. e.g. page=1 will return first page of results" }, { "name": "owner_contacts_id", "value": "", "type": "query", "description": "Limit the results to a specific owner by owner ID with a single owner ID or comma delimited list of IDs" }, { "name": "manufacturers_id", "value": "", "type": "query" }, { "name": "order_by", "value": "", "type": "query", "description": "The field by which to order results" }, { "name": "sort_order", "value": "", "type": "query", "description": "Sort results ascending or descending. Default ASC" }, { "name": "licenses_id", "value": "", "type": "query" }, { "name": "monitor", "value": "", "type": "query", "description": "Is the location considered a reference monitor?" }, { "name": "mobile", "value": "", "type": "query", "description": "Is the location considered a mobile location?" }, { "name": "instruments_id", "value": "", "type": "query" }, { "name": "iso", "value": "", "type": "query", "description": "Limit the results to a specific country using ISO 3166-1 alpha-2 code" }, { "name": "countries_id", "value": "", "type": "query", "description": "Limit the results to a specific country or countries by country ID as a single country ID or a comma delimited list of IDs" }, { "name": "bbox", "value": "", "type": "query", "description": "geospatial bounding box of Min X, min Y, max X, max Y in WGS 84 coordinates. Up to 4 decimal points of precision, addtional decimal precision will be truncated to 4 decimal points precision e.g. -77.037,38.907,-77.0,39.910" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of locations" }, { "info": { "name": "OpenAQ Get sensors by location ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/locations/:locations_id/sensors", "params": [ { "name": "locations_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of sensors by location ID" }, { "info": { "name": "OpenAQ Get a location's latest measurements", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/locations/:locations_id/latest", "params": [ { "name": "locations_id", "value": "", "type": "path", "description": "Limit the results to a specific location by id" }, { "name": "limit", "value": "", "type": "query", "description": "Change the number of results returned.\n e.g. limit=100 will return up to 100 results" }, { "name": "page", "value": "", "type": "query", "description": "Paginate through results. e.g. page=1 will return first page of results" }, { "name": "datetime_min", "value": "", "type": "query", "description": "Minimum datetime" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Providers a location's latest measurement values" }, { "info": { "name": "OpenAQ Get flags by location ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/locations/:locations_id/flags", "params": [ { "name": "locations_id", "value": "", "type": "path", "description": "Limit the results to a specific locations" }, { "name": "limit", "value": "", "type": "query", "description": "Change the number of results returned.\n e.g. limit=100 will return up to 100 results" }, { "name": "page", "value": "", "type": "query", "description": "Paginate through results. e.g. page=1 will return first page of results" }, { "name": "datetime_from", "value": "", "type": "query", "description": "To when?" }, { "name": "datetime_to", "value": "", "type": "query", "description": "To when?" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of flags by location ID" }, { "info": { "name": "OpenAQ Get a location by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/locations/:location_id", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the location" }, { "name": "limit", "value": "", "type": "query", "description": "Change the number of results returned. e.g. limit=1000 will return up to 1000 results" }, { "name": "page", "value": "", "type": "query", "description": "Paginate through results. e.g. page=1 will return first page of results" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query", "description": "Define sort order. e.g. ?sort=asc" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a location by location ID" }, { "info": { "name": "OpenAQ Get locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/locations", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Change the number of results returned. e.g. limit=1000 will return up to 1000 results" }, { "name": "page", "value": "", "type": "query", "description": "Paginate through results. e.g. page=1 will return first page of results" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query", "description": "Sort Direction e.g. sort=desc" }, { "name": "parameter_id", "value": "", "type": "query", "description": "(optional) A parameter ID to filter measurement results. e.g. parameter_id=2 (i.e. PM2.5) will limit measurement results to only PM2.5 measurements" }, { "name": "parameter", "value": "", "type": "query", "description": "(optional) A parameter name or ID by which to filter measurement results. e.g. parameter=pm25 or parameter=pm25¶meter=pm10" }, { "name": "unit", "value": "", "type": "query" }, { "name": "coordinates", "value": "", "type": "query", "description": "Coordinate pair in form lat,lng. Up to 8 decimal points of precision e.g. 38.907,-77.037" }, { "name": "radius", "value": "", "type": "query", "description": "Search radius from coordinates as center in meters. Maximum of 25,000 (25km) defaults to 1000 (1km) e.g. radius=10000" }, { "name": "country_id", "value": "", "type": "query", "description": "Limit results by a certain country using two digit country ID. e.g. 13" }, { "name": "country", "value": "", "type": "query", "description": "Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX" }, { "name": "city", "value": "", "type": "query", "description": "Limit results by a certain city or cities. (e.g. ?city=Chicago or ?city=Chicago&city=Boston)" }, { "name": "location_id", "value": "", "type": "query" }, { "name": "location", "value": "", "type": "query" }, { "name": "order_by", "value": "", "type": "query", "description": "Order by a field" }, { "name": "is_mobile", "value": "", "type": "query", "description": "Location is mobile e.g. ?isMobile=true" }, { "name": "is_analysis", "value": "", "type": "query", "description": "Data is the product of a previous analysis/aggregation and not raw measurements e.g. ?isAnalysis=true " }, { "name": "source_name", "value": "", "type": "query", "description": "Name of the data source e.g. ?sourceName=Houston%20Mobile" }, { "name": "entity", "value": "", "type": "query", "description": "Source entity type. e.g. ?entity=government" }, { "name": "sensor_type", "value": "", "type": "query", "description": "Type of Sensor e.g. ?sensorType=reference%20grade" }, { "name": "model_name", "value": "", "type": "query", "description": "Model Name of Sensor e.g. ?modelName=AE33" }, { "name": "manufacturer_name", "value": "", "type": "query", "description": "Manufacturer of Sensor e.g. ?manufacturer=Ecotech" }, { "name": "dump_raw", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of locations" }, { "info": { "name": "OpenAQ Get latest measurements by location ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/latest/:location_id", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the location" }, { "name": "limit", "value": "", "type": "query", "description": "Change the number of results returned. e.g. limit=1000 will return up to 1000 results" }, { "name": "page", "value": "", "type": "query", "description": "Paginate through results. e.g. page=1 will return first page of results" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query", "description": "Define sort order. e.g. ?sort=asc" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides latest measurements for a locations by location ID" }, { "info": { "name": "OpenAQ Get latest measurements by location ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/latest/:location_id", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the location" }, { "name": "limit", "value": "", "type": "query", "description": "Change the number of results returned. e.g. limit=1000 will return up to 1000 results" }, { "name": "page", "value": "", "type": "query", "description": "Paginate through results. e.g. page=1 will return first page of results" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query", "description": "Define sort order. e.g. ?sort=asc" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "OpenAQ Get latest measurements by location ID" }, { "info": { "name": "OpenAQ Get location by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/locations/:location_id", "params": [ { "name": "location_id", "value": "", "type": "path", "description": "The ID of the location" }, { "name": "limit", "value": "", "type": "query", "description": "Change the number of results returned. e.g. limit=1000 will return up to 1000 results" }, { "name": "page", "value": "", "type": "query", "description": "Paginate through results. e.g. page=1 will return first page of results" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query", "description": "Define sort order. e.g. ?sort=asc" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "OpenAQ Get location by ID" }, { "info": { "name": "OpenAQ Get locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/locations", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Change the number of results returned. e.g. limit=1000 will return up to 1000 results" }, { "name": "page", "value": "", "type": "query", "description": "Paginate through results. e.g. page=1 will return first page of results" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query", "description": "Sort Direction e.g. sort=desc" }, { "name": "parameter_id", "value": "", "type": "query", "description": "(optional) A parameter ID to filter measurement results. e.g. parameter_id=2 (i.e. PM2.5) will limit measurement results to only PM2.5 measurements" }, { "name": "parameter", "value": "", "type": "query", "description": "(optional) A parameter name or ID by which to filter measurement results. e.g. parameter=pm25 or parameter=pm25¶meter=pm10" }, { "name": "unit", "value": "", "type": "query" }, { "name": "coordinates", "value": "", "type": "query", "description": "Coordinate pair in form lat,lng. Up to 8 decimal points of precision e.g. 38.907,-77.037" }, { "name": "radius", "value": "", "type": "query", "description": "Search radius from coordinates as center in meters. Maximum of 25,000 (25km) defaults to 1000 (1km) e.g. radius=10000" }, { "name": "country_id", "value": "", "type": "query", "description": "Limit results by a certain country using two digit country ID. e.g. 13" }, { "name": "country", "value": "", "type": "query", "description": "Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX" }, { "name": "city", "value": "", "type": "query", "description": "Limit results by a certain city or cities. (e.g. ?city=Chicago or ?city=Chicago&city=Boston)" }, { "name": "location_id", "value": "", "type": "query" }, { "name": "location", "value": "", "type": "query" }, { "name": "order_by", "value": "", "type": "query", "description": "Order by a field" }, { "name": "is_mobile", "value": "", "type": "query", "description": "Location is mobile e.g. ?isMobile=true" }, { "name": "is_analysis", "value": "", "type": "query", "description": "Data is the product of a previous analysis/aggregation and not raw measurements e.g. ?isAnalysis=true " }, { "name": "source_name", "value": "", "type": "query", "description": "Name of the data source e.g. ?sourceName=Houston%20Mobile" }, { "name": "entity", "value": "", "type": "query", "description": "Source entity type. e.g. ?entity=government" }, { "name": "sensor_type", "value": "", "type": "query", "description": "Type of Sensor e.g. ?sensorType=reference%20grade" }, { "name": "model_name", "value": "", "type": "query", "description": "Model Name of Sensor e.g. ?modelName=AE33" }, { "name": "manufacturer_name", "value": "", "type": "query", "description": "Manufacturer of Sensor e.g. ?manufacturer=Ecotech" }, { "name": "dump_raw", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "OpenAQ Get locations" } ] } ], "bundled": true }