{ "opencollection": "1.0.0", "info": { "name": "OpenAQ", "version": "2.0.0" }, "items": [ { "info": { "name": "Instruments", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Get an instrument by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/instruments/:instruments_id", "params": [ { "name": "instruments_id", "value": "", "type": "path", "description": "Limit the results to a specific instruments id" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a instrument by instrument ID" }, { "info": { "name": "OpenAQ Get instruments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/instruments", "params": [ { "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": "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of instruments" }, { "info": { "name": "OpenAQ Get instruments by manufacturer ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/manufacturers/:manufacturers_id/instruments", "params": [ { "name": "manufacturers_id", "value": "", "type": "path", "description": "Limit results to a specific manufacturer id" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of instruments for a specific manufacturer" } ] }, { "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 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 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" } ] }, { "info": { "name": "Licenses", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Get an instrument by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/licenses/:licenses_id", "params": [ { "name": "licenses_id", "value": "", "type": "path", "description": "Limit the results to a specific licenses id" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a instrument by instrument ID" }, { "info": { "name": "OpenAQ Get licenses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/licenses", "params": [ { "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": "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of licenses" } ] }, { "info": { "name": "Parameters", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Get a parameter by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/parameters/:parameters_id", "params": [ { "name": "parameters_id", "value": "", "type": "path", "description": "Limit the results to a specific parameters id" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a parameter by parameter ID" }, { "info": { "name": "OpenAQ Get a parameters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/parameters", "params": [ { "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": "parameter_type", "value": "", "type": "query", "description": "Limit the results to a specific parameters type" }, { "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": "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" }, { "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": "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of parameters" }, { "info": { "name": "OpenAQ Get parameters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/parameters", "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": "Define sort order. e.g. ?sort=asc" }, { "name": "order_by", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of parameters supported by the platform" }, { "info": { "name": "OpenAQ Get parameters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/parameters", "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": "Define sort order. e.g. ?sort=asc" }, { "name": "order_by", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of parameters supported by the platform" } ] }, { "info": { "name": "Countries", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Get a country by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/countries/:countries_id", "params": [ { "name": "countries_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a country by country ID" }, { "info": { "name": "OpenAQ Get countries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/countries", "params": [ { "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": "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of countries" }, { "info": { "name": "OpenAQ Get country by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/countries/:country_id", "params": [ { "name": "country_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results returned. 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": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query", "description": "Define sort order. e.g. ?sort=asc" }, { "name": "order_by", "value": "", "type": "query", "description": "Order by a field e.g. ?order_by=name" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a single country by country ID" }, { "info": { "name": "OpenAQ Get country by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/countries/:country_id", "params": [ { "name": "country_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of results returned. 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": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query", "description": "Define sort order. e.g. ?sort=asc" }, { "name": "order_by", "value": "", "type": "query", "description": "Order by a field e.g. ?order_by=name" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a single country by country ID" }, { "info": { "name": "OpenAQ Get countries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/countries", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "country_id", "value": "", "type": "query" }, { "name": "order_by", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of countries" }, { "info": { "name": "OpenAQ Get countries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/countries", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order_by", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Providecs a list of countries" } ] }, { "info": { "name": "Manufacturers", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Get a manufacturer by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/manufacturers/:manufacturers_id", "params": [ { "name": "manufacturers_id", "value": "", "type": "path", "description": "Limit the results to a specific manufacturers id" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a manufacturer by manufacturer ID" }, { "info": { "name": "OpenAQ Get manufacturers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/manufacturers", "params": [ { "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": "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of manufacturers" } ] }, { "info": { "name": "Measurements", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Get measurements by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id/measurements", "params": [ { "name": "sensors_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" }, { "name": "datetime_to", "value": "", "type": "query", "description": "To when?" }, { "name": "datetime_from", "value": "", "type": "query", "description": "From when?" }, { "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of measurements by sensor ID" }, { "info": { "name": "OpenAQ Get measurements", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/measurements", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "date_from", "value": "", "type": "query", "description": "From when?" }, { "name": "date_to", "value": "", "type": "query", "description": "to when?" }, { "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" }, { "name": "has_geo", "value": "", "type": "query" }, { "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" }, { "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=false" }, { "name": "project", "value": "", "type": "query" }, { "name": "entity", "value": "", "type": "query" }, { "name": "sensor_type", "value": "", "type": "query", "description": "Filter by sensor type (i,e. reference grade, low-cost sensor) e.g. ?sensorType=reference%20grade" }, { "name": "value_from", "value": "", "type": "query" }, { "name": "value_to", "value": "", "type": "query" }, { "name": "include_fields", "value": "", "type": "query", "description": "Additional fields to include in response e.g. ?include_fields=sourceName" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "OpenAQ Get measurements" }, { "info": { "name": "OpenAQ Get a list of measurements", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/measurements", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "date_from", "value": "", "type": "query", "description": "From when?" }, { "name": "date_to", "value": "", "type": "query", "description": "to when?" }, { "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" }, { "name": "has_geo", "value": "", "type": "query" }, { "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" }, { "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=false" }, { "name": "project", "value": "", "type": "query" }, { "name": "entity", "value": "", "type": "query" }, { "name": "sensor_type", "value": "", "type": "query", "description": "Filter by sensor type (i,e. reference grade, low-cost sensor) e.g. ?sensorType=reference%20grade" }, { "name": "value_from", "value": "", "type": "query" }, { "name": "value_to", "value": "", "type": "query" }, { "name": "include_fields", "value": "", "type": "query", "description": "Additional fields to include in response e.g. ?include_fields=sourceName" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "OpenAQ Get a list of measurements" } ] }, { "info": { "name": "Hourly", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Get measurements aggregated to hours by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id/measurements/hourly", "params": [ { "name": "sensors_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" }, { "name": "datetime_to", "value": "", "type": "query", "description": "To when?" }, { "name": "datetime_from", "value": "", "type": "query", "description": "From when?" }, { "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of measurements by sensor ID" } ] }, { "info": { "name": "Daily", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Get measurements aggregated to days by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id/measurements/daily", "params": [ { "name": "sensors_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" }, { "name": "datetime_to", "value": "", "type": "query", "description": "To when?" }, { "name": "datetime_from", "value": "", "type": "query", "description": "From when?" }, { "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of measurements by sensor ID" }, { "info": { "name": "OpenAQ Get measurements aggregated from hour to day by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id/hours/daily", "params": [ { "name": "sensors_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" }, { "name": "datetime_to", "value": "", "type": "query", "description": "To when?" }, { "name": "datetime_from", "value": "", "type": "query", "description": "From when?" }, { "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of daily summaries of hourly data by sensor ID" } ] }, { "info": { "name": "Hours", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Get measurements aggregated to hour by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id/hours", "params": [ { "name": "sensors_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" }, { "name": "datetime_to", "value": "", "type": "query", "description": "To when?" }, { "name": "datetime_from", "value": "", "type": "query", "description": "From when?" }, { "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of hourly data by sensor ID" }, { "info": { "name": "OpenAQ Get measurements aggregated from hour to month by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id/hours/monthly", "params": [ { "name": "sensors_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" }, { "name": "datetime_to", "value": "", "type": "query", "description": "To when?" }, { "name": "datetime_from", "value": "", "type": "query", "description": "From when?" }, { "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of daily summaries of hourly data by sensor ID" }, { "info": { "name": "OpenAQ Get measurements aggregated from hour to year by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id/hours/yearly", "params": [ { "name": "sensors_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" }, { "name": "datetime_to", "value": "", "type": "query", "description": "To when?" }, { "name": "datetime_from", "value": "", "type": "query", "description": "From when?" }, { "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of yearly summaries of hourly data by sensor ID" }, { "info": { "name": "OpenAQ Get measurements aggregated from hour to day of week by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id/hours/hourofday", "params": [ { "name": "sensors_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" }, { "name": "datetime_to", "value": "", "type": "query", "description": "To when?" }, { "name": "datetime_from", "value": "", "type": "query", "description": "From when?" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of yearly summaries of hourly data by sensor ID" }, { "info": { "name": "OpenAQ Get measurements aggregated from hour to day of week by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id/hours/dayofweek", "params": [ { "name": "sensors_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" }, { "name": "datetime_to", "value": "", "type": "query", "description": "To when?" }, { "name": "datetime_from", "value": "", "type": "query", "description": "From when?" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of yearly summaries of hourly data by sensor ID" }, { "info": { "name": "OpenAQ Get measurements aggregated from hour to day of week by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id/hours/monthofyear", "params": [ { "name": "sensors_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" }, { "name": "datetime_to", "value": "", "type": "query", "description": "To when?" }, { "name": "datetime_from", "value": "", "type": "query", "description": "From when?" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of yearly summaries of hourly data by sensor ID" } ] }, { "info": { "name": "Days", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Get measurements aggregated from day to day of week by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id/days/dayofweek", "params": [ { "name": "sensors_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" }, { "name": "date_to", "value": "", "type": "query", "description": "To when?" }, { "name": "date_from", "value": "", "type": "query", "description": "From when?" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of yearly summaries of dayly data by sensor ID" }, { "info": { "name": "OpenAQ Get measurements aggregated from day to day of week by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id/days/monthofyear", "params": [ { "name": "sensors_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" }, { "name": "date_to", "value": "", "type": "query", "description": "To when?" }, { "name": "date_from", "value": "", "type": "query", "description": "From when?" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of yearly summaries of daily data by sensor ID" }, { "info": { "name": "OpenAQ Get measurements aggregated to day by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id/days", "params": [ { "name": "sensors_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" }, { "name": "date_to", "value": "", "type": "query", "description": "To when?" }, { "name": "date_from", "value": "", "type": "query", "description": "From when?" }, { "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of daily data by sensor ID" }, { "info": { "name": "OpenAQ Get measurements aggregated from hour to month by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id/days/monthly", "params": [ { "name": "sensors_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" }, { "name": "date_to", "value": "", "type": "query", "description": "To when?" }, { "name": "date_from", "value": "", "type": "query", "description": "From when?" }, { "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of daily summaries of hourly data by sensor ID" }, { "info": { "name": "OpenAQ Get measurements aggregated from day to year by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id/days/yearly", "params": [ { "name": "sensors_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" }, { "name": "date_to", "value": "", "type": "query", "description": "To when?" }, { "name": "date_from", "value": "", "type": "query", "description": "From when?" }, { "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of yearly summaries of daily data by sensor ID" } ] }, { "info": { "name": "Sensors", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Get measurements aggregated to year by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id/years", "params": [ { "name": "sensors_id", "value": "", "type": "path", "description": "Limit the results to a specific sensors id" }, { "name": "date_to", "value": "", "type": "query", "description": "To when?" }, { "name": "date_from", "value": "", "type": "query", "description": "From when?" }, { "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of annual data by sensor ID" }, { "info": { "name": "OpenAQ Get a sensor by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensors_id", "params": [ { "name": "sensors_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 sensor by sensor ID" } ] }, { "info": { "name": "Owners", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Get a owner by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/owners/:owners_id", "params": [ { "name": "owners_id", "value": "", "type": "path", "description": "Limit the results to a specific owner by id" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a owner by owner ID" }, { "info": { "name": "OpenAQ Get owners", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/owners", "params": [ { "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": "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of owners" } ] }, { "info": { "name": "Providers", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Get a provider by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/providers/:providers_id", "params": [ { "name": "providers_id", "value": "", "type": "path", "description": "Limit the results to a specific provider by id" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a provider by provider ID" }, { "info": { "name": "OpenAQ Get providers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/providers", "params": [ { "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": "parameters_id", "value": "", "type": "query" }, { "name": "monitor", "value": "", "type": "query", "description": "Is the location considered a reference monitor?" }, { "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" }, { "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": "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of providers" } ] }, { "info": { "name": "Latest", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Parameters Latest Get", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/parameters/:parameters_id/latest", "params": [ { "name": "parameters_id", "value": "", "type": "path", "description": "Limit the results to a specific parameters 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": "OpenAQ Parameters Latest Get" }, { "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 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", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/latest", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "parameter_id", "value": "", "type": "query" }, { "name": "coordinates", "value": "", "type": "query" }, { "name": "radius", "value": "", "type": "query" }, { "name": "country_id", "value": "", "type": "query" }, { "name": "order_by", "value": "", "type": "query" }, { "name": "is_mobile", "value": "", "type": "query" }, { "name": "is_analysis", "value": "", "type": "query" }, { "name": "entity", "value": "", "type": "query" }, { "name": "sensor_type", "value": "", "type": "query" }, { "name": "dump_raw", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of locations with latest measurements" }, { "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 latest measurements", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/latest", "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 latest measurements" } ] }, { "info": { "name": "Flags", "type": "folder" }, "items": [ { "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 flags by sensor ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/sensors/:sensor_id/flags", "params": [ { "name": "sensor_id", "value": "", "type": "path", "description": "Limit the results to a specific sensor" }, { "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 sensor ID" } ] }, { "info": { "name": "Averages", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Get averaged values", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/averages", "params": [ { "name": "temporal", "value": "", "type": "query", "description": "Period to aggregate. month, day, hour" }, { "name": "parameters_id", "value": "", "type": "query", "description": "What measurand would you like?" }, { "name": "date_to", "value": "", "type": "query", "description": "To when?" }, { "name": "date_from", "value": "", "type": "query", "description": "From when?" }, { "name": "locations_id", "value": "", "type": "query", "description": "Limit the results to a specific location by id" }, { "name": "spatial", "value": "", "type": "query", "description": "Define how you want to aggregate in space" }, { "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "OpenAQ Get averaged values" } ] }, { "info": { "name": "Cities", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Get cities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/cities", "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": "Define sort order. e.g. ?sort=asc" }, { "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": "order_by", "value": "", "type": "query", "description": "Order by a field e.g. ?order_by=city" }, { "name": "entity", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of cities supported by the platform" }, { "info": { "name": "OpenAQ Get cities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/cities", "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": "Define sort order. e.g. ?sort=asc" }, { "name": "order_by", "value": "", "type": "query", "description": "Order by a field e.g. ?order_by=city" }, { "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" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of cities supported by the platform" } ] }, { "info": { "name": "Project", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Project by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/projects/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a project by project ID" } ] }, { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Projects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/projects", "params": [ { "name": "country_id", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query", "description": "Limit results by a certain country using two digit country ID. e.g. 13" }, { "name": "parameter_id", "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": "parameter", "value": "", "type": "query", "description": "Change the number of results returned. e.g. limit=1000 will return up to 1000 results" }, { "name": "unit", "value": "", "type": "query", "description": "Paginate through results. e.g. page=1 will return first page of results" }, { "name": "project_id", "value": "", "type": "query" }, { "name": "project", "value": "", "type": "query", "description": "Define sort order. e.g. ?sort=asc" }, { "name": "order_by", "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": "is_mobile", "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": "is_analysis", "value": "", "type": "query" }, { "name": "entity", "value": "", "type": "query" }, { "name": "sensor_type", "value": "", "type": "query" }, { "name": "source_name", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of projects" } ] }, { "info": { "name": "Sources", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Sources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/sources", "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": "Define sort order. e.g. ?sort=asc" }, { "name": "source_name", "value": "", "type": "query" }, { "name": "source_id", "value": "", "type": "query" }, { "name": "source_slug", "value": "", "type": "query" }, { "name": "order_by", "value": "", "type": "query", "description": "Field by which to order the results e.g. ?order_by=sourceName or ?order_by=firstUpdated" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of sources" }, { "info": { "name": "OpenAQ Sources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/sources", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "order_by", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a list of sources" } ] }, { "info": { "name": "Readme", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Source Readme", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/sources/readme/:slug", "params": [ { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a readme for a given source by the source slug" } ] }, { "info": { "name": "Summary", "type": "folder" }, "items": [ { "info": { "name": "OpenAQ Platform Summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/summary", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Provides a summary of platform data" } ] } ], "bundled": true }