naftiko: 1.0.0-alpha2 info: label: OpenAQ description: OpenAQ is a nonprofit organization providing universal access to air quality data to empower a global community of changemakers to solve air inequality-the unequal access to clean air. tags: - Openaq - API created: '2026-05-06' modified: '2026-05-06' capability: consumes: - type: http namespace: openaq baseUri: https://api.example.com description: OpenAQ HTTP API. authentication: type: apikey in: header name: X-API-Key value: '{{OPENAQ_TOKEN}}' resources: - name: v3-instruments-instruments-id path: /v3/instruments/{instruments_id} operations: - name: instrument-get-v3-instruments-instruments-id-get method: GET description: OpenAQ Get an instrument by ID inputParameters: - name: instruments_id in: path type: integer required: true description: Limit the results to a specific instruments id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-instruments path: /v3/instruments operations: - name: instruments-get-v3-instruments-get method: GET description: OpenAQ Get instruments inputParameters: - name: order_by in: query type: string description: The field by which to order results - name: sort_order in: query type: string description: Sort results ascending or descending. Default ASC - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-manufacturers-manufacturers-id-instruments path: /v3/manufacturers/{manufacturers_id}/instruments operations: - name: get-instruments-by-manufacturer-v3-manufacturers method: GET description: OpenAQ Get instruments by manufacturer ID inputParameters: - name: manufacturers_id in: path type: integer required: true description: Limit results to a specific manufacturer id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-locations-locations-id path: /v3/locations/{locations_id} operations: - name: location-get-v3-locations-locations-id-get method: GET description: OpenAQ Get a location by ID inputParameters: - name: locations_id in: path type: integer required: true description: Limit the results to a specific location by id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-locations path: /v3/locations operations: - name: locations-get-v3-locations-get method: GET description: OpenAQ Get locations inputParameters: - name: coordinates in: query type: string 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 - name: radius in: query type: string 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 in: query type: string 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 in: query type: string - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results - name: owner_contacts_id in: query type: string 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 in: query type: string - name: order_by in: query type: string description: The field by which to order results - name: sort_order in: query type: string description: Sort results ascending or descending. Default ASC - name: licenses_id in: query type: string - name: monitor in: query type: string description: Is the location considered a reference monitor? - name: mobile in: query type: string description: Is the location considered a mobile location? - name: instruments_id in: query type: string - name: iso in: query type: string description: Limit the results to a specific country using ISO 3166-1 alpha-2 code - name: countries_id in: query type: string 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 in: query type: string 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 ' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-licenses-licenses-id path: /v3/licenses/{licenses_id} operations: - name: license-get-v3-licenses-licenses-id-get method: GET description: OpenAQ Get an instrument by ID inputParameters: - name: licenses_id in: path type: integer required: true description: Limit the results to a specific licenses id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-licenses path: /v3/licenses operations: - name: instruments-get-v3-licenses-get method: GET description: OpenAQ Get licenses inputParameters: - name: order_by in: query type: string description: The field by which to order results - name: sort_order in: query type: string description: Sort results ascending or descending. Default ASC - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-parameters-parameters-id path: /v3/parameters/{parameters_id} operations: - name: parameter-get-v3-parameters-parameters-id-get method: GET description: OpenAQ Get a parameter by ID inputParameters: - name: parameters_id in: path type: integer required: true description: Limit the results to a specific parameters id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-parameters path: /v3/parameters operations: - name: parameters-get-v3-parameters-get method: GET description: OpenAQ Get a parameters inputParameters: - name: order_by in: query type: string description: The field by which to order results - name: sort_order in: query type: string description: Sort results ascending or descending. Default ASC - name: parameter_type in: query type: string description: Limit the results to a specific parameters type - name: coordinates in: query type: string 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 - name: radius in: query type: string description: Search radius from coordinates as center in meters. Maximum of 25,000 (25km) defaults to 1000 (1km) e.g. radius=1000 - name: bbox in: query type: string 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 ' - name: iso in: query type: string description: Limit the results to a specific country using ISO 3166-1 alpha-2 code - name: countries_id in: query type: string 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 in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-countries-countries-id path: /v3/countries/{countries_id} operations: - name: country-get-v3-countries-countries-id-get method: GET description: OpenAQ Get a country by ID inputParameters: - name: countries_id in: path type: integer required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-countries path: /v3/countries operations: - name: countries-get-v3-countries-get method: GET description: OpenAQ Get countries inputParameters: - name: order_by in: query type: string description: The field by which to order results - name: sort_order in: query type: string description: Sort results ascending or descending. Default ASC - name: providers_id in: query type: string 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 in: query type: string - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-manufacturers-manufacturers-id path: /v3/manufacturers/{manufacturers_id} operations: - name: manufacturer-get-v3-manufacturers-manufacturers- method: GET description: OpenAQ Get a manufacturer by ID inputParameters: - name: manufacturers_id in: path type: integer required: true description: Limit the results to a specific manufacturers id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-manufacturers path: /v3/manufacturers operations: - name: manufacturers-get-v3-manufacturers-get method: GET description: OpenAQ Get manufacturers inputParameters: - name: order_by in: query type: string description: The field by which to order results - name: sort_order in: query type: string description: Sort results ascending or descending. Default ASC - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id-measurements path: /v3/sensors/{sensors_id}/measurements operations: - name: sensor-measurements-get-v3-sensors-sensors-id-me method: GET description: OpenAQ Get measurements by sensor ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id - name: datetime_to in: query type: string description: To when? - name: datetime_from in: query type: string description: From when? - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id-measurements-hourly path: /v3/sensors/{sensors_id}/measurements/hourly operations: - name: sensor-measurements-aggregated-get-hourly-v3-sen method: GET description: OpenAQ Get measurements aggregated to hours by sensor ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id - name: datetime_to in: query type: string description: To when? - name: datetime_from in: query type: string description: From when? - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id-measurements-daily path: /v3/sensors/{sensors_id}/measurements/daily operations: - name: sensor-measurements-aggregated-get-daily-v3-sens method: GET description: OpenAQ Get measurements aggregated to days by sensor ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id - name: datetime_to in: query type: string description: To when? - name: datetime_from in: query type: string description: From when? - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id-hours path: /v3/sensors/{sensors_id}/hours operations: - name: sensor-hourly-measurements-get-v3-sensors-sensor method: GET description: OpenAQ Get measurements aggregated to hour by sensor ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id - name: datetime_to in: query type: string description: To when? - name: datetime_from in: query type: string description: From when? - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id-hours-daily path: /v3/sensors/{sensors_id}/hours/daily operations: - name: sensor-hourly-measurements-aggregate-to-day-get- method: GET description: OpenAQ Get measurements aggregated from hour to day by sensor ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id - name: datetime_to in: query type: string description: To when? - name: datetime_from in: query type: string description: From when? - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id-hours-monthly path: /v3/sensors/{sensors_id}/hours/monthly operations: - name: sensor-hourly-measurements-aggregate-to-month-ge method: GET description: OpenAQ Get measurements aggregated from hour to month by sensor ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id - name: datetime_to in: query type: string description: To when? - name: datetime_from in: query type: string description: From when? - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id-hours-yearly path: /v3/sensors/{sensors_id}/hours/yearly operations: - name: sensor-hourly-measurements-aggregate-to-year-get method: GET description: OpenAQ Get measurements aggregated from hour to year by sensor ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id - name: datetime_to in: query type: string description: To when? - name: datetime_from in: query type: string description: From when? - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id-hours-hourofday path: /v3/sensors/{sensors_id}/hours/hourofday operations: - name: sensor-hourly-measurements-aggregate-to-hod-get- method: GET description: OpenAQ Get measurements aggregated from hour to day of week by sensor ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id - name: datetime_to in: query type: string description: To when? - name: datetime_from in: query type: string description: From when? outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id-hours-dayofweek path: /v3/sensors/{sensors_id}/hours/dayofweek operations: - name: sensor-hourly-measurements-aggregate-to-dow-get- method: GET description: OpenAQ Get measurements aggregated from hour to day of week by sensor ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id - name: datetime_to in: query type: string description: To when? - name: datetime_from in: query type: string description: From when? outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id-hours-monthofyear path: /v3/sensors/{sensors_id}/hours/monthofyear operations: - name: sensor-hourly-measurements-aggregate-to-moy-get- method: GET description: OpenAQ Get measurements aggregated from hour to day of week by sensor ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id - name: datetime_to in: query type: string description: To when? - name: datetime_from in: query type: string description: From when? outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id-days-dayofweek path: /v3/sensors/{sensors_id}/days/dayofweek operations: - name: sensor-daily-measurements-aggregate-to-dow-get-v method: GET description: OpenAQ Get measurements aggregated from day to day of week by sensor ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id - name: date_to in: query type: string description: To when? - name: date_from in: query type: string description: From when? outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id-days-monthofyear path: /v3/sensors/{sensors_id}/days/monthofyear operations: - name: sensor-daily-measurements-aggregate-to-moy-get-v method: GET description: OpenAQ Get measurements aggregated from day to day of week by sensor ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id - name: date_to in: query type: string description: To when? - name: date_from in: query type: string description: From when? outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id-days path: /v3/sensors/{sensors_id}/days operations: - name: sensor-daily-get-v3-sensors-sensors-id-days-get method: GET description: OpenAQ Get measurements aggregated to day by sensor ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id - name: date_to in: query type: string description: To when? - name: date_from in: query type: string description: From when? - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id-days-monthly path: /v3/sensors/{sensors_id}/days/monthly operations: - name: sensor-daily-aggregate-to-month-get-v3-sensors-s method: GET description: OpenAQ Get measurements aggregated from hour to month by sensor ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id - name: date_to in: query type: string description: To when? - name: date_from in: query type: string description: From when? - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id-days-yearly path: /v3/sensors/{sensors_id}/days/yearly operations: - name: sensor-daily-aggregate-to-year-get-v3-sensors-se method: GET description: OpenAQ Get measurements aggregated from day to year by sensor ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id - name: date_to in: query type: string description: To when? - name: date_from in: query type: string description: From when? - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id-years path: /v3/sensors/{sensors_id}/years operations: - name: sensor-yearly-get-v3-sensors-sensors-id-years-ge method: GET description: OpenAQ Get measurements aggregated to year by sensor ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id - name: date_to in: query type: string description: To when? - name: date_from in: query type: string description: From when? - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-owners-owners-id path: /v3/owners/{owners_id} operations: - name: owner-get-v3-owners-owners-id-get method: GET description: OpenAQ Get a owner by ID inputParameters: - name: owners_id in: path type: integer required: true description: Limit the results to a specific owner by id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-owners path: /v3/owners operations: - name: owners-get-v3-owners-get method: GET description: OpenAQ Get owners inputParameters: - name: order_by in: query type: string description: The field by which to order results - name: sort_order in: query type: string description: Sort results ascending or descending. Default ASC - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-providers-providers-id path: /v3/providers/{providers_id} operations: - name: provider-get-v3-providers-providers-id-get method: GET description: OpenAQ Get a provider by ID inputParameters: - name: providers_id in: path type: integer required: true description: Limit the results to a specific provider by id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-providers path: /v3/providers operations: - name: providers-get-v3-providers-get method: GET description: OpenAQ Get providers inputParameters: - name: order_by in: query type: string description: The field by which to order results - name: sort_order in: query type: string description: Sort results ascending or descending. Default ASC - name: parameters_id in: query type: string - name: monitor in: query type: string description: Is the location considered a reference monitor? - name: iso in: query type: string description: Limit the results to a specific country using ISO 3166-1 alpha-2 code - name: countries_id in: query type: string 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 in: query type: string 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 ' - name: coordinates in: query type: string 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 - name: radius in: query type: string description: Search radius from coordinates as center in meters. Maximum of 25,000 (25km) defaults to 1000 (1km) e.g. radius=1000 - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-locations-locations-id-sensors path: /v3/locations/{locations_id}/sensors operations: - name: sensors-get-v3-locations-locations-id-sensors-ge method: GET description: OpenAQ Get sensors by location ID inputParameters: - name: locations_id in: path type: integer required: true description: Limit the results to a specific sensors id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensors-id path: /v3/sensors/{sensors_id} operations: - name: sensor-get-v3-sensors-sensors-id-get method: GET description: OpenAQ Get a sensor by ID inputParameters: - name: sensors_id in: path type: integer required: true description: Limit the results to a specific sensors id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-parameters-parameters-id-latest path: /v3/parameters/{parameters_id}/latest operations: - name: parameters-latest-get-v3-parameters-parameters-i method: GET description: OpenAQ Parameters Latest Get inputParameters: - name: parameters_id in: path type: integer required: true description: Limit the results to a specific parameters id - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results - name: datetime_min in: query type: string description: Minimum datetime outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-locations-locations-id-latest path: /v3/locations/{locations_id}/latest operations: - name: location-latest-get-v3-locations-locations-id-la method: GET description: OpenAQ Get a location's latest measurements inputParameters: - name: locations_id in: path type: integer required: true description: Limit the results to a specific location by id - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results - name: datetime_min in: query type: string description: Minimum datetime outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-locations-locations-id-flags path: /v3/locations/{locations_id}/flags operations: - name: location-flags-get-v3-locations-locations-id-fla method: GET description: OpenAQ Get flags by location ID inputParameters: - name: locations_id in: path type: integer required: true description: Limit the results to a specific locations - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results - name: datetime_from in: query type: string description: To when? - name: datetime_to in: query type: string description: To when? outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v3-sensors-sensor-id-flags path: /v3/sensors/{sensor_id}/flags operations: - name: sensor-flags-get-v3-sensors-sensor-id-flags-get method: GET description: OpenAQ Get flags by sensor ID inputParameters: - name: sensor_id in: path type: integer required: true description: Limit the results to a specific sensor - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results - name: datetime_from in: query type: string description: To when? - name: datetime_to in: query type: string description: To when? outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v2-averages path: /v2/averages operations: - name: averages-v2-get-v2-averages-get method: GET description: OpenAQ Get averaged values inputParameters: - name: temporal in: query type: string description: Period to aggregate. month, day, hour - name: parameters_id in: query type: string description: What measurand would you like? - name: date_to in: query type: string description: To when? - name: date_from in: query type: string description: From when? - name: locations_id in: query type: integer description: Limit the results to a specific location by id - name: spatial in: query type: string description: Define how you want to aggregate in space - name: limit in: query type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: integer description: Paginate through results. e.g. page=1 will return first page of results outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v2-cities path: /v2/cities operations: - name: cities-get-v2-cities-get method: GET description: OpenAQ Get cities inputParameters: - name: limit in: query type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page in: query type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset in: query type: string - name: sort in: query type: string description: Define sort order. e.g. ?sort=asc - name: country_id in: query type: string description: Limit results by a certain country using two digit country ID. e.g. 13 - name: country in: query type: string description: Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX - name: city in: query type: string description: Limit results by a certain city or cities. (e.g. ?city=Chicago or ?city=Chicago&city=Boston) - name: order_by in: query type: string description: Order by a field e.g. ?order_by=city - name: entity in: query type: string outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-cities path: /v1/cities operations: - name: cities-getv1-v1-cities-get method: GET description: OpenAQ Get cities inputParameters: - name: limit in: query type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page in: query type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset in: query type: string - name: sort in: query type: string description: Define sort order. e.g. ?sort=asc - name: order_by in: query type: string description: Order by a field e.g. ?order_by=city - name: country in: query type: string description: Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v2-countries-country-id path: /v2/countries/{country_id} operations: - name: countries-by-path-v2-countries-country-id-get method: GET description: OpenAQ Get country by ID inputParameters: - name: country_id in: path type: integer required: true - name: limit in: query type: integer description: Limit the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset in: query type: string - name: sort in: query type: string description: Define sort order. e.g. ?sort=asc - name: order_by in: query type: string description: Order by a field e.g. ?order_by=name outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-countries-country-id path: /v1/countries/{country_id} operations: - name: countries-by-path-v1-countries-country-id-get method: GET description: OpenAQ Get country by ID inputParameters: - name: country_id in: path type: integer required: true - name: limit in: query type: integer description: Limit the number of results returned. e.g. limit=100 will return up to 100 results - name: page in: query type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset in: query type: string - name: sort in: query type: string description: Define sort order. e.g. ?sort=asc - name: order_by in: query type: string description: Order by a field e.g. ?order_by=name outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v2-countries path: /v2/countries operations: - name: countries-get-v2-countries-get method: GET description: OpenAQ Get countries inputParameters: - name: limit in: query type: integer - name: page in: query type: string - name: offset in: query type: string - name: sort in: query type: string - name: country_id in: query type: string - name: order_by in: query type: string outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-countries path: /v1/countries operations: - name: countries-getv1-v1-countries-get method: GET description: OpenAQ Get countries inputParameters: - name: limit in: query type: integer - name: page in: query type: string - name: offset in: query type: string - name: sort in: query type: string - name: order_by in: query type: string outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v2-locations-location-id path: /v2/locations/{location_id} operations: - name: get-v2-location-by-id-v2-locations-location-id-g method: GET description: OpenAQ Get a location by ID inputParameters: - name: location_id in: path type: integer required: true description: The ID of the location - name: limit in: query type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page in: query type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset in: query type: string - name: sort in: query type: string description: Define sort order. e.g. ?sort=asc outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v2-locations path: /v2/locations operations: - name: locations-get-v2-locations-get method: GET description: OpenAQ Get locations inputParameters: - name: limit in: query type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page in: query type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset in: query type: string - name: sort in: query type: string description: Sort Direction e.g. sort=desc - name: parameter_id in: query type: string 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 in: query type: string description: (optional) A parameter name or ID by which to filter measurement results. e.g. parameter=pm25 or parameter=pm25¶meter=pm10 - name: unit in: query type: string - name: coordinates in: query type: string description: Coordinate pair in form lat,lng. Up to 8 decimal points of precision e.g. 38.907,-77.037 - name: radius in: query type: integer 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 in: query type: string description: Limit results by a certain country using two digit country ID. e.g. 13 - name: country in: query type: string description: Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX - name: city in: query type: string description: Limit results by a certain city or cities. (e.g. ?city=Chicago or ?city=Chicago&city=Boston) - name: location_id in: query type: string - name: location in: query type: string - name: order_by in: query type: string description: Order by a field - name: is_mobile in: query type: string description: Location is mobile e.g. ?isMobile=true - name: is_analysis in: query type: string description: Data is the product of a previous analysis/aggregation and not raw measurements e.g. ?isAnalysis=true - name: source_name in: query type: string description: Name of the data source e.g. ?sourceName=Houston%20Mobile - name: entity in: query type: string description: Source entity type. e.g. ?entity=government - name: sensor_type in: query type: string description: Type of Sensor e.g. ?sensorType=reference%20grade - name: model_name in: query type: string description: Model Name of Sensor e.g. ?modelName=AE33 - name: manufacturer_name in: query type: string description: Manufacturer of Sensor e.g. ?manufacturer=Ecotech - name: dump_raw in: query type: string outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v2-latest-location-id path: /v2/latest/{location_id} operations: - name: get-v2-latest-by-id-v2-latest-location-id-get method: GET description: OpenAQ Get latest measurements by location ID inputParameters: - name: location_id in: path type: integer required: true description: The ID of the location - name: limit in: query type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page in: query type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset in: query type: string - name: sort in: query type: string description: Define sort order. e.g. ?sort=asc outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v2-latest path: /v2/latest operations: - name: latest-get-v2-latest-get method: GET description: OpenAQ Get latest measurements inputParameters: - name: limit in: query type: string - name: page in: query type: string - name: offset in: query type: string - name: sort in: query type: string - name: parameter_id in: query type: string - name: coordinates in: query type: string - name: radius in: query type: integer - name: country_id in: query type: string - name: order_by in: query type: string - name: is_mobile in: query type: string - name: is_analysis in: query type: string - name: entity in: query type: string - name: sensor_type in: query type: string - name: dump_raw in: query type: string outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-latest-location-id path: /v1/latest/{location_id} operations: - name: get-v1-latest-by-id-v1-latest-location-id-get method: GET description: OpenAQ Get latest measurements by location ID inputParameters: - name: location_id in: path type: integer required: true description: The ID of the location - name: limit in: query type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page in: query type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset in: query type: string - name: sort in: query type: string description: Define sort order. e.g. ?sort=asc outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-latest path: /v1/latest operations: - name: latest-v1-get-v1-latest-get method: GET description: OpenAQ Get latest measurements inputParameters: - name: limit in: query type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page in: query type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset in: query type: string - name: sort in: query type: string description: Sort Direction e.g. sort=desc - name: parameter_id in: query type: string 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 in: query type: string description: (optional) A parameter name or ID by which to filter measurement results. e.g. parameter=pm25 or parameter=pm25¶meter=pm10 - name: unit in: query type: string - name: coordinates in: query type: string description: Coordinate pair in form lat,lng. Up to 8 decimal points of precision e.g. 38.907,-77.037 - name: radius in: query type: integer 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 in: query type: string description: Limit results by a certain country using two digit country ID. e.g. 13 - name: country in: query type: string description: Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX - name: city in: query type: string description: Limit results by a certain city or cities. (e.g. ?city=Chicago or ?city=Chicago&city=Boston) - name: location_id in: query type: string - name: location in: query type: string - name: order_by in: query type: string description: Order by a field - name: is_mobile in: query type: string description: Location is mobile e.g. ?isMobile=true - name: is_analysis in: query type: string description: Data is the product of a previous analysis/aggregation and not raw measurements e.g. ?isAnalysis=true - name: source_name in: query type: string description: Name of the data source e.g. ?sourceName=Houston%20Mobile - name: entity in: query type: string description: Source entity type. e.g. ?entity=government - name: sensor_type in: query type: string description: Type of Sensor e.g. ?sensorType=reference%20grade - name: model_name in: query type: string description: Model Name of Sensor e.g. ?modelName=AE33 - name: manufacturer_name in: query type: string description: Manufacturer of Sensor e.g. ?manufacturer=Ecotech - name: dump_raw in: query type: string outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-locations-location-id path: /v1/locations/{location_id} operations: - name: get-v1-locations-by-id-v1-locations-location-id- method: GET description: OpenAQ Get location by ID inputParameters: - name: location_id in: path type: integer required: true description: The ID of the location - name: limit in: query type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page in: query type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset in: query type: string - name: sort in: query type: string description: Define sort order. e.g. ?sort=asc outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-locations path: /v1/locations operations: - name: locationsv1-get-v1-locations-get method: GET description: OpenAQ Get locations inputParameters: - name: limit in: query type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page in: query type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset in: query type: string - name: sort in: query type: string description: Sort Direction e.g. sort=desc - name: parameter_id in: query type: string 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 in: query type: string description: (optional) A parameter name or ID by which to filter measurement results. e.g. parameter=pm25 or parameter=pm25¶meter=pm10 - name: unit in: query type: string - name: coordinates in: query type: string description: Coordinate pair in form lat,lng. Up to 8 decimal points of precision e.g. 38.907,-77.037 - name: radius in: query type: integer 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 in: query type: string description: Limit results by a certain country using two digit country ID. e.g. 13 - name: country in: query type: string description: Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX - name: city in: query type: string description: Limit results by a certain city or cities. (e.g. ?city=Chicago or ?city=Chicago&city=Boston) - name: location_id in: query type: string - name: location in: query type: string - name: order_by in: query type: string description: Order by a field - name: is_mobile in: query type: string description: Location is mobile e.g. ?isMobile=true - name: is_analysis in: query type: string description: Data is the product of a previous analysis/aggregation and not raw measurements e.g. ?isAnalysis=true - name: source_name in: query type: string description: Name of the data source e.g. ?sourceName=Houston%20Mobile - name: entity in: query type: string description: Source entity type. e.g. ?entity=government - name: sensor_type in: query type: string description: Type of Sensor e.g. ?sensorType=reference%20grade - name: model_name in: query type: string description: Model Name of Sensor e.g. ?modelName=AE33 - name: manufacturer_name in: query type: string description: Manufacturer of Sensor e.g. ?manufacturer=Ecotech - name: dump_raw in: query type: string outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v2-measurements path: /v2/measurements operations: - name: measurements-get-v2-measurements-get method: GET description: OpenAQ Get measurements inputParameters: - name: format in: query type: string - name: date_from in: query type: string description: From when? - name: date_to in: query type: string description: to when? - name: limit in: query type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page in: query type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset in: query type: string - name: sort in: query type: string - name: has_geo in: query type: string - name: parameter_id in: query type: string 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 in: query type: string description: (optional) A parameter name or ID by which to filter measurement results. e.g. parameter=pm25 or parameter=pm25¶meter=pm10 - name: unit in: query type: string - name: coordinates in: query type: string description: Coordinate pair in form lat,lng. Up to 8 decimal points of precision e.g. 38.907,-77.037 - name: radius in: query type: integer 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 in: query type: string description: Limit results by a certain country using two digit country ID. e.g. 13 - name: country in: query type: string description: Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX - name: city in: query type: string description: Limit results by a certain city or cities. (e.g. ?city=Chicago or ?city=Chicago&city=Boston) - name: location_id in: query type: string - name: location in: query type: string - name: order_by in: query type: string - name: is_mobile in: query type: string description: Location is mobile e.g. ?isMobile=true - name: is_analysis in: query type: string description: Data is the product of a previous analysis/aggregation and not raw measurements e.g. ?isAnalysis=false - name: project in: query type: string - name: entity in: query type: string - name: sensor_type in: query type: string description: Filter by sensor type (i,e. reference grade, low-cost sensor) e.g. ?sensorType=reference%20grade - name: value_from in: query type: string - name: value_to in: query type: string - name: include_fields in: query type: string description: Additional fields to include in response e.g. ?include_fields=sourceName outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-measurements path: /v1/measurements operations: - name: measurements-get-v1-v1-measurements-get method: GET description: OpenAQ Get a list of measurements inputParameters: - name: format in: query type: string - name: date_from in: query type: string description: From when? - name: date_to in: query type: string description: to when? - name: limit in: query type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page in: query type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset in: query type: string - name: sort in: query type: string - name: has_geo in: query type: string - name: parameter_id in: query type: string 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 in: query type: string description: (optional) A parameter name or ID by which to filter measurement results. e.g. parameter=pm25 or parameter=pm25¶meter=pm10 - name: unit in: query type: string - name: coordinates in: query type: string description: Coordinate pair in form lat,lng. Up to 8 decimal points of precision e.g. 38.907,-77.037 - name: radius in: query type: integer 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 in: query type: string description: Limit results by a certain country using two digit country ID. e.g. 13 - name: country in: query type: string description: Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX - name: city in: query type: string description: Limit results by a certain city or cities. (e.g. ?city=Chicago or ?city=Chicago&city=Boston) - name: location_id in: query type: string - name: location in: query type: string - name: order_by in: query type: string - name: is_mobile in: query type: string description: Location is mobile e.g. ?isMobile=true - name: is_analysis in: query type: string description: Data is the product of a previous analysis/aggregation and not raw measurements e.g. ?isAnalysis=false - name: project in: query type: string - name: entity in: query type: string - name: sensor_type in: query type: string description: Filter by sensor type (i,e. reference grade, low-cost sensor) e.g. ?sensorType=reference%20grade - name: value_from in: query type: string - name: value_to in: query type: string - name: include_fields in: query type: string description: Additional fields to include in response e.g. ?include_fields=sourceName outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v2-parameters path: /v2/parameters operations: - name: parameters-get-v2-parameters-get method: GET description: OpenAQ Get parameters inputParameters: - name: limit in: query type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page in: query type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset in: query type: string - name: sort in: query type: string description: Define sort order. e.g. ?sort=asc - name: order_by in: query type: string outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v1-parameters path: /v1/parameters operations: - name: parameters-getv1-v1-parameters-get method: GET description: OpenAQ Get parameters inputParameters: - name: limit in: query type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page in: query type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset in: query type: string - name: sort in: query type: string description: Define sort order. e.g. ?sort=asc - name: order_by in: query type: string outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v2-projects-project-id path: /v2/projects/{project_id} operations: - name: projects-get-v2-projects-project-id-get method: GET description: OpenAQ Project by ID inputParameters: - name: project_id in: path type: integer required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: v2-projects path: /v2/projects operations: - name: projects-get-v2-projects-get method: GET description: OpenAQ Projects inputParameters: - name: country_id in: query type: string required: true - name: limit in: query type: string required: true - name: page in: query type: string required: true - name: offset in: query type: string required: true - name: sort in: query type: string description: Limit results by a certain country using two digit country ID. e.g. 13 - name: parameter_id in: query type: string description: Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX - name: parameter in: query type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: unit in: query type: string description: Paginate through results. e.g. page=1 will return first page of results - name: project_id in: query type: string - name: project in: query type: string description: Define sort order. e.g. ?sort=asc - name: order_by in: query type: string 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 in: query type: string 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 in: query type: string - name: entity in: query type: string - name: sensor_type in: query type: string - name: source_name in: query type: string outputRawFormat: json outputParameters: - name: result type: object value: $. exposes: - type: rest port: 8080 namespace: openaq-rest description: REST adapter for OpenAQ. resources: - path: /v3/instruments/{instruments_id} name: instrument-get-v3-instruments-instruments-id-get operations: - method: GET name: instrument-get-v3-instruments-instruments-id-get description: OpenAQ Get an instrument by ID call: openaq.instrument-get-v3-instruments-instruments-id-get with: instruments_id: rest.instruments_id outputParameters: - type: object mapping: $. - path: /v3/instruments name: instruments-get-v3-instruments-get operations: - method: GET name: instruments-get-v3-instruments-get description: OpenAQ Get instruments call: openaq.instruments-get-v3-instruments-get outputParameters: - type: object mapping: $. - path: /v3/manufacturers/{manufacturers_id}/instruments name: get-instruments-by-manufacturer-v3-manufacturers operations: - method: GET name: get-instruments-by-manufacturer-v3-manufacturers description: OpenAQ Get instruments by manufacturer ID call: openaq.get-instruments-by-manufacturer-v3-manufacturers with: manufacturers_id: rest.manufacturers_id outputParameters: - type: object mapping: $. - path: /v3/locations/{locations_id} name: location-get-v3-locations-locations-id-get operations: - method: GET name: location-get-v3-locations-locations-id-get description: OpenAQ Get a location by ID call: openaq.location-get-v3-locations-locations-id-get with: locations_id: rest.locations_id outputParameters: - type: object mapping: $. - path: /v3/locations name: locations-get-v3-locations-get operations: - method: GET name: locations-get-v3-locations-get description: OpenAQ Get locations call: openaq.locations-get-v3-locations-get outputParameters: - type: object mapping: $. - path: /v3/licenses/{licenses_id} name: license-get-v3-licenses-licenses-id-get operations: - method: GET name: license-get-v3-licenses-licenses-id-get description: OpenAQ Get an instrument by ID call: openaq.license-get-v3-licenses-licenses-id-get with: licenses_id: rest.licenses_id outputParameters: - type: object mapping: $. - path: /v3/licenses name: instruments-get-v3-licenses-get operations: - method: GET name: instruments-get-v3-licenses-get description: OpenAQ Get licenses call: openaq.instruments-get-v3-licenses-get outputParameters: - type: object mapping: $. - path: /v3/parameters/{parameters_id} name: parameter-get-v3-parameters-parameters-id-get operations: - method: GET name: parameter-get-v3-parameters-parameters-id-get description: OpenAQ Get a parameter by ID call: openaq.parameter-get-v3-parameters-parameters-id-get with: parameters_id: rest.parameters_id outputParameters: - type: object mapping: $. - path: /v3/parameters name: parameters-get-v3-parameters-get operations: - method: GET name: parameters-get-v3-parameters-get description: OpenAQ Get a parameters call: openaq.parameters-get-v3-parameters-get outputParameters: - type: object mapping: $. - path: /v3/countries/{countries_id} name: country-get-v3-countries-countries-id-get operations: - method: GET name: country-get-v3-countries-countries-id-get description: OpenAQ Get a country by ID call: openaq.country-get-v3-countries-countries-id-get with: countries_id: rest.countries_id outputParameters: - type: object mapping: $. - path: /v3/countries name: countries-get-v3-countries-get operations: - method: GET name: countries-get-v3-countries-get description: OpenAQ Get countries call: openaq.countries-get-v3-countries-get outputParameters: - type: object mapping: $. - path: /v3/manufacturers/{manufacturers_id} name: manufacturer-get-v3-manufacturers-manufacturers operations: - method: GET name: manufacturer-get-v3-manufacturers-manufacturers- description: OpenAQ Get a manufacturer by ID call: openaq.manufacturer-get-v3-manufacturers-manufacturers- with: manufacturers_id: rest.manufacturers_id outputParameters: - type: object mapping: $. - path: /v3/manufacturers name: manufacturers-get-v3-manufacturers-get operations: - method: GET name: manufacturers-get-v3-manufacturers-get description: OpenAQ Get manufacturers call: openaq.manufacturers-get-v3-manufacturers-get outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id}/measurements name: sensor-measurements-get-v3-sensors-sensors-id-me operations: - method: GET name: sensor-measurements-get-v3-sensors-sensors-id-me description: OpenAQ Get measurements by sensor ID call: openaq.sensor-measurements-get-v3-sensors-sensors-id-me with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id}/measurements/hourly name: sensor-measurements-aggregated-get-hourly-v3-sen operations: - method: GET name: sensor-measurements-aggregated-get-hourly-v3-sen description: OpenAQ Get measurements aggregated to hours by sensor ID call: openaq.sensor-measurements-aggregated-get-hourly-v3-sen with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id}/measurements/daily name: sensor-measurements-aggregated-get-daily-v3-sens operations: - method: GET name: sensor-measurements-aggregated-get-daily-v3-sens description: OpenAQ Get measurements aggregated to days by sensor ID call: openaq.sensor-measurements-aggregated-get-daily-v3-sens with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id}/hours name: sensor-hourly-measurements-get-v3-sensors-sensor operations: - method: GET name: sensor-hourly-measurements-get-v3-sensors-sensor description: OpenAQ Get measurements aggregated to hour by sensor ID call: openaq.sensor-hourly-measurements-get-v3-sensors-sensor with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id}/hours/daily name: sensor-hourly-measurements-aggregate-to-day-get operations: - method: GET name: sensor-hourly-measurements-aggregate-to-day-get- description: OpenAQ Get measurements aggregated from hour to day by sensor ID call: openaq.sensor-hourly-measurements-aggregate-to-day-get- with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id}/hours/monthly name: sensor-hourly-measurements-aggregate-to-month-ge operations: - method: GET name: sensor-hourly-measurements-aggregate-to-month-ge description: OpenAQ Get measurements aggregated from hour to month by sensor ID call: openaq.sensor-hourly-measurements-aggregate-to-month-ge with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id}/hours/yearly name: sensor-hourly-measurements-aggregate-to-year-get operations: - method: GET name: sensor-hourly-measurements-aggregate-to-year-get description: OpenAQ Get measurements aggregated from hour to year by sensor ID call: openaq.sensor-hourly-measurements-aggregate-to-year-get with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id}/hours/hourofday name: sensor-hourly-measurements-aggregate-to-hod-get operations: - method: GET name: sensor-hourly-measurements-aggregate-to-hod-get- description: OpenAQ Get measurements aggregated from hour to day of week by sensor ID call: openaq.sensor-hourly-measurements-aggregate-to-hod-get- with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id}/hours/dayofweek name: sensor-hourly-measurements-aggregate-to-dow-get operations: - method: GET name: sensor-hourly-measurements-aggregate-to-dow-get- description: OpenAQ Get measurements aggregated from hour to day of week by sensor ID call: openaq.sensor-hourly-measurements-aggregate-to-dow-get- with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id}/hours/monthofyear name: sensor-hourly-measurements-aggregate-to-moy-get operations: - method: GET name: sensor-hourly-measurements-aggregate-to-moy-get- description: OpenAQ Get measurements aggregated from hour to day of week by sensor ID call: openaq.sensor-hourly-measurements-aggregate-to-moy-get- with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id}/days/dayofweek name: sensor-daily-measurements-aggregate-to-dow-get-v operations: - method: GET name: sensor-daily-measurements-aggregate-to-dow-get-v description: OpenAQ Get measurements aggregated from day to day of week by sensor ID call: openaq.sensor-daily-measurements-aggregate-to-dow-get-v with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id}/days/monthofyear name: sensor-daily-measurements-aggregate-to-moy-get-v operations: - method: GET name: sensor-daily-measurements-aggregate-to-moy-get-v description: OpenAQ Get measurements aggregated from day to day of week by sensor ID call: openaq.sensor-daily-measurements-aggregate-to-moy-get-v with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id}/days name: sensor-daily-get-v3-sensors-sensors-id-days-get operations: - method: GET name: sensor-daily-get-v3-sensors-sensors-id-days-get description: OpenAQ Get measurements aggregated to day by sensor ID call: openaq.sensor-daily-get-v3-sensors-sensors-id-days-get with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id}/days/monthly name: sensor-daily-aggregate-to-month-get-v3-sensors-s operations: - method: GET name: sensor-daily-aggregate-to-month-get-v3-sensors-s description: OpenAQ Get measurements aggregated from hour to month by sensor ID call: openaq.sensor-daily-aggregate-to-month-get-v3-sensors-s with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id}/days/yearly name: sensor-daily-aggregate-to-year-get-v3-sensors-se operations: - method: GET name: sensor-daily-aggregate-to-year-get-v3-sensors-se description: OpenAQ Get measurements aggregated from day to year by sensor ID call: openaq.sensor-daily-aggregate-to-year-get-v3-sensors-se with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id}/years name: sensor-yearly-get-v3-sensors-sensors-id-years-ge operations: - method: GET name: sensor-yearly-get-v3-sensors-sensors-id-years-ge description: OpenAQ Get measurements aggregated to year by sensor ID call: openaq.sensor-yearly-get-v3-sensors-sensors-id-years-ge with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/owners/{owners_id} name: owner-get-v3-owners-owners-id-get operations: - method: GET name: owner-get-v3-owners-owners-id-get description: OpenAQ Get a owner by ID call: openaq.owner-get-v3-owners-owners-id-get with: owners_id: rest.owners_id outputParameters: - type: object mapping: $. - path: /v3/owners name: owners-get-v3-owners-get operations: - method: GET name: owners-get-v3-owners-get description: OpenAQ Get owners call: openaq.owners-get-v3-owners-get outputParameters: - type: object mapping: $. - path: /v3/providers/{providers_id} name: provider-get-v3-providers-providers-id-get operations: - method: GET name: provider-get-v3-providers-providers-id-get description: OpenAQ Get a provider by ID call: openaq.provider-get-v3-providers-providers-id-get with: providers_id: rest.providers_id outputParameters: - type: object mapping: $. - path: /v3/providers name: providers-get-v3-providers-get operations: - method: GET name: providers-get-v3-providers-get description: OpenAQ Get providers call: openaq.providers-get-v3-providers-get outputParameters: - type: object mapping: $. - path: /v3/locations/{locations_id}/sensors name: sensors-get-v3-locations-locations-id-sensors-ge operations: - method: GET name: sensors-get-v3-locations-locations-id-sensors-ge description: OpenAQ Get sensors by location ID call: openaq.sensors-get-v3-locations-locations-id-sensors-ge with: locations_id: rest.locations_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensors_id} name: sensor-get-v3-sensors-sensors-id-get operations: - method: GET name: sensor-get-v3-sensors-sensors-id-get description: OpenAQ Get a sensor by ID call: openaq.sensor-get-v3-sensors-sensors-id-get with: sensors_id: rest.sensors_id outputParameters: - type: object mapping: $. - path: /v3/parameters/{parameters_id}/latest name: parameters-latest-get-v3-parameters-parameters-i operations: - method: GET name: parameters-latest-get-v3-parameters-parameters-i description: OpenAQ Parameters Latest Get call: openaq.parameters-latest-get-v3-parameters-parameters-i with: parameters_id: rest.parameters_id outputParameters: - type: object mapping: $. - path: /v3/locations/{locations_id}/latest name: location-latest-get-v3-locations-locations-id-la operations: - method: GET name: location-latest-get-v3-locations-locations-id-la description: OpenAQ Get a location's latest measurements call: openaq.location-latest-get-v3-locations-locations-id-la with: locations_id: rest.locations_id outputParameters: - type: object mapping: $. - path: /v3/locations/{locations_id}/flags name: location-flags-get-v3-locations-locations-id-fla operations: - method: GET name: location-flags-get-v3-locations-locations-id-fla description: OpenAQ Get flags by location ID call: openaq.location-flags-get-v3-locations-locations-id-fla with: locations_id: rest.locations_id outputParameters: - type: object mapping: $. - path: /v3/sensors/{sensor_id}/flags name: sensor-flags-get-v3-sensors-sensor-id-flags-get operations: - method: GET name: sensor-flags-get-v3-sensors-sensor-id-flags-get description: OpenAQ Get flags by sensor ID call: openaq.sensor-flags-get-v3-sensors-sensor-id-flags-get with: sensor_id: rest.sensor_id outputParameters: - type: object mapping: $. - path: /v2/averages name: averages-v2-get-v2-averages-get operations: - method: GET name: averages-v2-get-v2-averages-get description: OpenAQ Get averaged values call: openaq.averages-v2-get-v2-averages-get outputParameters: - type: object mapping: $. - path: /v2/cities name: cities-get-v2-cities-get operations: - method: GET name: cities-get-v2-cities-get description: OpenAQ Get cities call: openaq.cities-get-v2-cities-get outputParameters: - type: object mapping: $. - path: /v1/cities name: cities-getv1-v1-cities-get operations: - method: GET name: cities-getv1-v1-cities-get description: OpenAQ Get cities call: openaq.cities-getv1-v1-cities-get outputParameters: - type: object mapping: $. - path: /v2/countries/{country_id} name: countries-by-path-v2-countries-country-id-get operations: - method: GET name: countries-by-path-v2-countries-country-id-get description: OpenAQ Get country by ID call: openaq.countries-by-path-v2-countries-country-id-get with: country_id: rest.country_id outputParameters: - type: object mapping: $. - path: /v1/countries/{country_id} name: countries-by-path-v1-countries-country-id-get operations: - method: GET name: countries-by-path-v1-countries-country-id-get description: OpenAQ Get country by ID call: openaq.countries-by-path-v1-countries-country-id-get with: country_id: rest.country_id outputParameters: - type: object mapping: $. - path: /v2/countries name: countries-get-v2-countries-get operations: - method: GET name: countries-get-v2-countries-get description: OpenAQ Get countries call: openaq.countries-get-v2-countries-get outputParameters: - type: object mapping: $. - path: /v1/countries name: countries-getv1-v1-countries-get operations: - method: GET name: countries-getv1-v1-countries-get description: OpenAQ Get countries call: openaq.countries-getv1-v1-countries-get outputParameters: - type: object mapping: $. - path: /v2/locations/{location_id} name: get-v2-location-by-id-v2-locations-location-id-g operations: - method: GET name: get-v2-location-by-id-v2-locations-location-id-g description: OpenAQ Get a location by ID call: openaq.get-v2-location-by-id-v2-locations-location-id-g with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v2/locations name: locations-get-v2-locations-get operations: - method: GET name: locations-get-v2-locations-get description: OpenAQ Get locations call: openaq.locations-get-v2-locations-get outputParameters: - type: object mapping: $. - path: /v2/latest/{location_id} name: get-v2-latest-by-id-v2-latest-location-id-get operations: - method: GET name: get-v2-latest-by-id-v2-latest-location-id-get description: OpenAQ Get latest measurements by location ID call: openaq.get-v2-latest-by-id-v2-latest-location-id-get with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v2/latest name: latest-get-v2-latest-get operations: - method: GET name: latest-get-v2-latest-get description: OpenAQ Get latest measurements call: openaq.latest-get-v2-latest-get outputParameters: - type: object mapping: $. - path: /v1/latest/{location_id} name: get-v1-latest-by-id-v1-latest-location-id-get operations: - method: GET name: get-v1-latest-by-id-v1-latest-location-id-get description: OpenAQ Get latest measurements by location ID call: openaq.get-v1-latest-by-id-v1-latest-location-id-get with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/latest name: latest-v1-get-v1-latest-get operations: - method: GET name: latest-v1-get-v1-latest-get description: OpenAQ Get latest measurements call: openaq.latest-v1-get-v1-latest-get outputParameters: - type: object mapping: $. - path: /v1/locations/{location_id} name: get-v1-locations-by-id-v1-locations-location-id operations: - method: GET name: get-v1-locations-by-id-v1-locations-location-id- description: OpenAQ Get location by ID call: openaq.get-v1-locations-by-id-v1-locations-location-id- with: location_id: rest.location_id outputParameters: - type: object mapping: $. - path: /v1/locations name: locationsv1-get-v1-locations-get operations: - method: GET name: locationsv1-get-v1-locations-get description: OpenAQ Get locations call: openaq.locationsv1-get-v1-locations-get outputParameters: - type: object mapping: $. - path: /v2/measurements name: measurements-get-v2-measurements-get operations: - method: GET name: measurements-get-v2-measurements-get description: OpenAQ Get measurements call: openaq.measurements-get-v2-measurements-get outputParameters: - type: object mapping: $. - path: /v1/measurements name: measurements-get-v1-v1-measurements-get operations: - method: GET name: measurements-get-v1-v1-measurements-get description: OpenAQ Get a list of measurements call: openaq.measurements-get-v1-v1-measurements-get outputParameters: - type: object mapping: $. - path: /v2/parameters name: parameters-get-v2-parameters-get operations: - method: GET name: parameters-get-v2-parameters-get description: OpenAQ Get parameters call: openaq.parameters-get-v2-parameters-get outputParameters: - type: object mapping: $. - path: /v1/parameters name: parameters-getv1-v1-parameters-get operations: - method: GET name: parameters-getv1-v1-parameters-get description: OpenAQ Get parameters call: openaq.parameters-getv1-v1-parameters-get outputParameters: - type: object mapping: $. - path: /v2/projects/{project_id} name: projects-get-v2-projects-project-id-get operations: - method: GET name: projects-get-v2-projects-project-id-get description: OpenAQ Project by ID call: openaq.projects-get-v2-projects-project-id-get with: project_id: rest.project_id outputParameters: - type: object mapping: $. - path: /v2/projects name: projects-get-v2-projects-get operations: - method: GET name: projects-get-v2-projects-get description: OpenAQ Projects call: openaq.projects-get-v2-projects-get outputParameters: - type: object mapping: $. - type: mcp port: 9090 namespace: openaq-mcp transport: http description: MCP adapter for OpenAQ for AI agent use. tools: - name: instrument-get-v3-instruments-instruments-id-get description: OpenAQ Get an instrument by ID hints: readOnly: true destructive: false idempotent: true call: openaq.instrument-get-v3-instruments-instruments-id-get with: instruments_id: tools.instruments_id inputParameters: - name: instruments_id type: integer description: Limit the results to a specific instruments id required: true outputParameters: - type: object mapping: $. - name: instruments-get-v3-instruments-get description: OpenAQ Get instruments hints: readOnly: true destructive: false idempotent: true call: openaq.instruments-get-v3-instruments-get with: order_by: tools.order_by sort_order: tools.sort_order limit: tools.limit page: tools.page inputParameters: - name: order_by type: string description: The field by which to order results - name: sort_order type: string description: Sort results ascending or descending. Default ASC - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: get-instruments-by-manufacturer-v3-manufacturers description: OpenAQ Get instruments by manufacturer ID hints: readOnly: true destructive: false idempotent: true call: openaq.get-instruments-by-manufacturer-v3-manufacturers with: manufacturers_id: tools.manufacturers_id inputParameters: - name: manufacturers_id type: integer description: Limit results to a specific manufacturer id required: true outputParameters: - type: object mapping: $. - name: location-get-v3-locations-locations-id-get description: OpenAQ Get a location by ID hints: readOnly: true destructive: false idempotent: true call: openaq.location-get-v3-locations-locations-id-get with: locations_id: tools.locations_id inputParameters: - name: locations_id type: integer description: Limit the results to a specific location by id required: true outputParameters: - type: object mapping: $. - name: locations-get-v3-locations-get description: OpenAQ Get locations hints: readOnly: true destructive: false idempotent: true call: openaq.locations-get-v3-locations-get with: coordinates: tools.coordinates radius: tools.radius providers_id: tools.providers_id parameters_id: tools.parameters_id limit: tools.limit page: tools.page owner_contacts_id: tools.owner_contacts_id manufacturers_id: tools.manufacturers_id order_by: tools.order_by sort_order: tools.sort_order licenses_id: tools.licenses_id monitor: tools.monitor mobile: tools.mobile instruments_id: tools.instruments_id iso: tools.iso countries_id: tools.countries_id bbox: tools.bbox inputParameters: - name: coordinates type: string 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 - name: radius type: string 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 type: string 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 type: string description: parameters_id - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results - name: owner_contacts_id type: string 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 type: string description: manufacturers_id - name: order_by type: string description: The field by which to order results - name: sort_order type: string description: Sort results ascending or descending. Default ASC - name: licenses_id type: string description: licenses_id - name: monitor type: string description: Is the location considered a reference monitor? - name: mobile type: string description: Is the location considered a mobile location? - name: instruments_id type: string description: instruments_id - name: iso type: string description: Limit the results to a specific country using ISO 3166-1 alpha-2 code - name: countries_id type: string 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 type: string 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 ' outputParameters: - type: object mapping: $. - name: license-get-v3-licenses-licenses-id-get description: OpenAQ Get an instrument by ID hints: readOnly: true destructive: false idempotent: true call: openaq.license-get-v3-licenses-licenses-id-get with: licenses_id: tools.licenses_id inputParameters: - name: licenses_id type: integer description: Limit the results to a specific licenses id required: true outputParameters: - type: object mapping: $. - name: instruments-get-v3-licenses-get description: OpenAQ Get licenses hints: readOnly: true destructive: false idempotent: true call: openaq.instruments-get-v3-licenses-get with: order_by: tools.order_by sort_order: tools.sort_order limit: tools.limit page: tools.page inputParameters: - name: order_by type: string description: The field by which to order results - name: sort_order type: string description: Sort results ascending or descending. Default ASC - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: parameter-get-v3-parameters-parameters-id-get description: OpenAQ Get a parameter by ID hints: readOnly: true destructive: false idempotent: true call: openaq.parameter-get-v3-parameters-parameters-id-get with: parameters_id: tools.parameters_id inputParameters: - name: parameters_id type: integer description: Limit the results to a specific parameters id required: true outputParameters: - type: object mapping: $. - name: parameters-get-v3-parameters-get description: OpenAQ Get a parameters hints: readOnly: true destructive: false idempotent: true call: openaq.parameters-get-v3-parameters-get with: order_by: tools.order_by sort_order: tools.sort_order parameter_type: tools.parameter_type coordinates: tools.coordinates radius: tools.radius bbox: tools.bbox iso: tools.iso countries_id: tools.countries_id limit: tools.limit page: tools.page inputParameters: - name: order_by type: string description: The field by which to order results - name: sort_order type: string description: Sort results ascending or descending. Default ASC - name: parameter_type type: string description: Limit the results to a specific parameters type - name: coordinates type: string 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 - name: radius type: string description: Search radius from coordinates as center in meters. Maximum of 25,000 (25km) defaults to 1000 (1km) e.g. radius=1000 - name: bbox type: string 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 ' - name: iso type: string description: Limit the results to a specific country using ISO 3166-1 alpha-2 code - name: countries_id type: string 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 type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: country-get-v3-countries-countries-id-get description: OpenAQ Get a country by ID hints: readOnly: true destructive: false idempotent: true call: openaq.country-get-v3-countries-countries-id-get with: countries_id: tools.countries_id inputParameters: - name: countries_id type: integer description: countries_id required: true outputParameters: - type: object mapping: $. - name: countries-get-v3-countries-get description: OpenAQ Get countries hints: readOnly: true destructive: false idempotent: true call: openaq.countries-get-v3-countries-get with: order_by: tools.order_by sort_order: tools.sort_order providers_id: tools.providers_id parameters_id: tools.parameters_id limit: tools.limit page: tools.page inputParameters: - name: order_by type: string description: The field by which to order results - name: sort_order type: string description: Sort results ascending or descending. Default ASC - name: providers_id type: string 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 type: string description: parameters_id - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: manufacturer-get-v3-manufacturers-manufacturers- description: OpenAQ Get a manufacturer by ID hints: readOnly: true destructive: false idempotent: true call: openaq.manufacturer-get-v3-manufacturers-manufacturers- with: manufacturers_id: tools.manufacturers_id inputParameters: - name: manufacturers_id type: integer description: Limit the results to a specific manufacturers id required: true outputParameters: - type: object mapping: $. - name: manufacturers-get-v3-manufacturers-get description: OpenAQ Get manufacturers hints: readOnly: true destructive: false idempotent: true call: openaq.manufacturers-get-v3-manufacturers-get with: order_by: tools.order_by sort_order: tools.sort_order limit: tools.limit page: tools.page inputParameters: - name: order_by type: string description: The field by which to order results - name: sort_order type: string description: Sort results ascending or descending. Default ASC - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: sensor-measurements-get-v3-sensors-sensors-id-me description: OpenAQ Get measurements by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-measurements-get-v3-sensors-sensors-id-me with: sensors_id: tools.sensors_id datetime_to: tools.datetime_to datetime_from: tools.datetime_from limit: tools.limit page: tools.page inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true - name: datetime_to type: string description: To when? - name: datetime_from type: string description: From when? - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: sensor-measurements-aggregated-get-hourly-v3-sen description: OpenAQ Get measurements aggregated to hours by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-measurements-aggregated-get-hourly-v3-sen with: sensors_id: tools.sensors_id datetime_to: tools.datetime_to datetime_from: tools.datetime_from limit: tools.limit page: tools.page inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true - name: datetime_to type: string description: To when? - name: datetime_from type: string description: From when? - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: sensor-measurements-aggregated-get-daily-v3-sens description: OpenAQ Get measurements aggregated to days by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-measurements-aggregated-get-daily-v3-sens with: sensors_id: tools.sensors_id datetime_to: tools.datetime_to datetime_from: tools.datetime_from limit: tools.limit page: tools.page inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true - name: datetime_to type: string description: To when? - name: datetime_from type: string description: From when? - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: sensor-hourly-measurements-get-v3-sensors-sensor description: OpenAQ Get measurements aggregated to hour by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-hourly-measurements-get-v3-sensors-sensor with: sensors_id: tools.sensors_id datetime_to: tools.datetime_to datetime_from: tools.datetime_from limit: tools.limit page: tools.page inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true - name: datetime_to type: string description: To when? - name: datetime_from type: string description: From when? - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: sensor-hourly-measurements-aggregate-to-day-get- description: OpenAQ Get measurements aggregated from hour to day by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-hourly-measurements-aggregate-to-day-get- with: sensors_id: tools.sensors_id datetime_to: tools.datetime_to datetime_from: tools.datetime_from limit: tools.limit page: tools.page inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true - name: datetime_to type: string description: To when? - name: datetime_from type: string description: From when? - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: sensor-hourly-measurements-aggregate-to-month-ge description: OpenAQ Get measurements aggregated from hour to month by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-hourly-measurements-aggregate-to-month-ge with: sensors_id: tools.sensors_id datetime_to: tools.datetime_to datetime_from: tools.datetime_from limit: tools.limit page: tools.page inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true - name: datetime_to type: string description: To when? - name: datetime_from type: string description: From when? - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: sensor-hourly-measurements-aggregate-to-year-get description: OpenAQ Get measurements aggregated from hour to year by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-hourly-measurements-aggregate-to-year-get with: sensors_id: tools.sensors_id datetime_to: tools.datetime_to datetime_from: tools.datetime_from limit: tools.limit page: tools.page inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true - name: datetime_to type: string description: To when? - name: datetime_from type: string description: From when? - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: sensor-hourly-measurements-aggregate-to-hod-get- description: OpenAQ Get measurements aggregated from hour to day of week by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-hourly-measurements-aggregate-to-hod-get- with: sensors_id: tools.sensors_id datetime_to: tools.datetime_to datetime_from: tools.datetime_from inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true - name: datetime_to type: string description: To when? - name: datetime_from type: string description: From when? outputParameters: - type: object mapping: $. - name: sensor-hourly-measurements-aggregate-to-dow-get- description: OpenAQ Get measurements aggregated from hour to day of week by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-hourly-measurements-aggregate-to-dow-get- with: sensors_id: tools.sensors_id datetime_to: tools.datetime_to datetime_from: tools.datetime_from inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true - name: datetime_to type: string description: To when? - name: datetime_from type: string description: From when? outputParameters: - type: object mapping: $. - name: sensor-hourly-measurements-aggregate-to-moy-get- description: OpenAQ Get measurements aggregated from hour to day of week by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-hourly-measurements-aggregate-to-moy-get- with: sensors_id: tools.sensors_id datetime_to: tools.datetime_to datetime_from: tools.datetime_from inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true - name: datetime_to type: string description: To when? - name: datetime_from type: string description: From when? outputParameters: - type: object mapping: $. - name: sensor-daily-measurements-aggregate-to-dow-get-v description: OpenAQ Get measurements aggregated from day to day of week by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-daily-measurements-aggregate-to-dow-get-v with: sensors_id: tools.sensors_id date_to: tools.date_to date_from: tools.date_from inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true - name: date_to type: string description: To when? - name: date_from type: string description: From when? outputParameters: - type: object mapping: $. - name: sensor-daily-measurements-aggregate-to-moy-get-v description: OpenAQ Get measurements aggregated from day to day of week by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-daily-measurements-aggregate-to-moy-get-v with: sensors_id: tools.sensors_id date_to: tools.date_to date_from: tools.date_from inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true - name: date_to type: string description: To when? - name: date_from type: string description: From when? outputParameters: - type: object mapping: $. - name: sensor-daily-get-v3-sensors-sensors-id-days-get description: OpenAQ Get measurements aggregated to day by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-daily-get-v3-sensors-sensors-id-days-get with: sensors_id: tools.sensors_id date_to: tools.date_to date_from: tools.date_from limit: tools.limit page: tools.page inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true - name: date_to type: string description: To when? - name: date_from type: string description: From when? - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: sensor-daily-aggregate-to-month-get-v3-sensors-s description: OpenAQ Get measurements aggregated from hour to month by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-daily-aggregate-to-month-get-v3-sensors-s with: sensors_id: tools.sensors_id date_to: tools.date_to date_from: tools.date_from limit: tools.limit page: tools.page inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true - name: date_to type: string description: To when? - name: date_from type: string description: From when? - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: sensor-daily-aggregate-to-year-get-v3-sensors-se description: OpenAQ Get measurements aggregated from day to year by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-daily-aggregate-to-year-get-v3-sensors-se with: sensors_id: tools.sensors_id date_to: tools.date_to date_from: tools.date_from limit: tools.limit page: tools.page inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true - name: date_to type: string description: To when? - name: date_from type: string description: From when? - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: sensor-yearly-get-v3-sensors-sensors-id-years-ge description: OpenAQ Get measurements aggregated to year by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-yearly-get-v3-sensors-sensors-id-years-ge with: sensors_id: tools.sensors_id date_to: tools.date_to date_from: tools.date_from limit: tools.limit page: tools.page inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true - name: date_to type: string description: To when? - name: date_from type: string description: From when? - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: owner-get-v3-owners-owners-id-get description: OpenAQ Get a owner by ID hints: readOnly: true destructive: false idempotent: true call: openaq.owner-get-v3-owners-owners-id-get with: owners_id: tools.owners_id inputParameters: - name: owners_id type: integer description: Limit the results to a specific owner by id required: true outputParameters: - type: object mapping: $. - name: owners-get-v3-owners-get description: OpenAQ Get owners hints: readOnly: true destructive: false idempotent: true call: openaq.owners-get-v3-owners-get with: order_by: tools.order_by sort_order: tools.sort_order limit: tools.limit page: tools.page inputParameters: - name: order_by type: string description: The field by which to order results - name: sort_order type: string description: Sort results ascending or descending. Default ASC - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: provider-get-v3-providers-providers-id-get description: OpenAQ Get a provider by ID hints: readOnly: true destructive: false idempotent: true call: openaq.provider-get-v3-providers-providers-id-get with: providers_id: tools.providers_id inputParameters: - name: providers_id type: integer description: Limit the results to a specific provider by id required: true outputParameters: - type: object mapping: $. - name: providers-get-v3-providers-get description: OpenAQ Get providers hints: readOnly: true destructive: false idempotent: true call: openaq.providers-get-v3-providers-get with: order_by: tools.order_by sort_order: tools.sort_order parameters_id: tools.parameters_id monitor: tools.monitor iso: tools.iso countries_id: tools.countries_id bbox: tools.bbox coordinates: tools.coordinates radius: tools.radius limit: tools.limit page: tools.page inputParameters: - name: order_by type: string description: The field by which to order results - name: sort_order type: string description: Sort results ascending or descending. Default ASC - name: parameters_id type: string description: parameters_id - name: monitor type: string description: Is the location considered a reference monitor? - name: iso type: string description: Limit the results to a specific country using ISO 3166-1 alpha-2 code - name: countries_id type: string 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 type: string 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 ' - name: coordinates type: string 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 - name: radius type: string description: Search radius from coordinates as center in meters. Maximum of 25,000 (25km) defaults to 1000 (1km) e.g. radius=1000 - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: sensors-get-v3-locations-locations-id-sensors-ge description: OpenAQ Get sensors by location ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensors-get-v3-locations-locations-id-sensors-ge with: locations_id: tools.locations_id inputParameters: - name: locations_id type: integer description: Limit the results to a specific sensors id required: true outputParameters: - type: object mapping: $. - name: sensor-get-v3-sensors-sensors-id-get description: OpenAQ Get a sensor by ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-get-v3-sensors-sensors-id-get with: sensors_id: tools.sensors_id inputParameters: - name: sensors_id type: integer description: Limit the results to a specific sensors id required: true outputParameters: - type: object mapping: $. - name: parameters-latest-get-v3-parameters-parameters-i description: OpenAQ Parameters Latest Get hints: readOnly: true destructive: false idempotent: true call: openaq.parameters-latest-get-v3-parameters-parameters-i with: parameters_id: tools.parameters_id limit: tools.limit page: tools.page datetime_min: tools.datetime_min inputParameters: - name: parameters_id type: integer description: Limit the results to a specific parameters id required: true - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results - name: datetime_min type: string description: Minimum datetime outputParameters: - type: object mapping: $. - name: location-latest-get-v3-locations-locations-id-la description: OpenAQ Get a location's latest measurements hints: readOnly: true destructive: false idempotent: true call: openaq.location-latest-get-v3-locations-locations-id-la with: locations_id: tools.locations_id limit: tools.limit page: tools.page datetime_min: tools.datetime_min inputParameters: - name: locations_id type: integer description: Limit the results to a specific location by id required: true - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results - name: datetime_min type: string description: Minimum datetime outputParameters: - type: object mapping: $. - name: location-flags-get-v3-locations-locations-id-fla description: OpenAQ Get flags by location ID hints: readOnly: true destructive: false idempotent: true call: openaq.location-flags-get-v3-locations-locations-id-fla with: locations_id: tools.locations_id limit: tools.limit page: tools.page datetime_from: tools.datetime_from datetime_to: tools.datetime_to inputParameters: - name: locations_id type: integer description: Limit the results to a specific locations required: true - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results - name: datetime_from type: string description: To when? - name: datetime_to type: string description: To when? outputParameters: - type: object mapping: $. - name: sensor-flags-get-v3-sensors-sensor-id-flags-get description: OpenAQ Get flags by sensor ID hints: readOnly: true destructive: false idempotent: true call: openaq.sensor-flags-get-v3-sensors-sensor-id-flags-get with: sensor_id: tools.sensor_id limit: tools.limit page: tools.page datetime_from: tools.datetime_from datetime_to: tools.datetime_to inputParameters: - name: sensor_id type: integer description: Limit the results to a specific sensor required: true - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results - name: datetime_from type: string description: To when? - name: datetime_to type: string description: To when? outputParameters: - type: object mapping: $. - name: averages-v2-get-v2-averages-get description: OpenAQ Get averaged values hints: readOnly: true destructive: false idempotent: true call: openaq.averages-v2-get-v2-averages-get with: temporal: tools.temporal parameters_id: tools.parameters_id date_to: tools.date_to date_from: tools.date_from locations_id: tools.locations_id spatial: tools.spatial limit: tools.limit page: tools.page inputParameters: - name: temporal type: string description: Period to aggregate. month, day, hour - name: parameters_id type: string description: What measurand would you like? - name: date_to type: string description: To when? - name: date_from type: string description: From when? - name: locations_id type: integer description: Limit the results to a specific location by id - name: spatial type: string description: Define how you want to aggregate in space - name: limit type: integer description: Change the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: integer description: Paginate through results. e.g. page=1 will return first page of results outputParameters: - type: object mapping: $. - name: cities-get-v2-cities-get description: OpenAQ Get cities hints: readOnly: true destructive: false idempotent: true call: openaq.cities-get-v2-cities-get with: limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort country_id: tools.country_id country: tools.country city: tools.city order_by: tools.order_by entity: tools.entity inputParameters: - name: limit type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset type: string description: offset - name: sort type: string description: Define sort order. e.g. ?sort=asc - name: country_id type: string description: Limit results by a certain country using two digit country ID. e.g. 13 - name: country type: string description: Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX - name: city type: string description: Limit results by a certain city or cities. (e.g. ?city=Chicago or ?city=Chicago&city=Boston) - name: order_by type: string description: Order by a field e.g. ?order_by=city - name: entity type: string description: entity outputParameters: - type: object mapping: $. - name: cities-getv1-v1-cities-get description: OpenAQ Get cities hints: readOnly: true destructive: false idempotent: true call: openaq.cities-getv1-v1-cities-get with: limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort order_by: tools.order_by country: tools.country inputParameters: - name: limit type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset type: string description: offset - name: sort type: string description: Define sort order. e.g. ?sort=asc - name: order_by type: string description: Order by a field e.g. ?order_by=city - name: country type: string description: Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX outputParameters: - type: object mapping: $. - name: countries-by-path-v2-countries-country-id-get description: OpenAQ Get country by ID hints: readOnly: true destructive: false idempotent: true call: openaq.countries-by-path-v2-countries-country-id-get with: country_id: tools.country_id limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort order_by: tools.order_by inputParameters: - name: country_id type: integer description: country_id required: true - name: limit type: integer description: Limit the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset type: string description: offset - name: sort type: string description: Define sort order. e.g. ?sort=asc - name: order_by type: string description: Order by a field e.g. ?order_by=name outputParameters: - type: object mapping: $. - name: countries-by-path-v1-countries-country-id-get description: OpenAQ Get country by ID hints: readOnly: true destructive: false idempotent: true call: openaq.countries-by-path-v1-countries-country-id-get with: country_id: tools.country_id limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort order_by: tools.order_by inputParameters: - name: country_id type: integer description: country_id required: true - name: limit type: integer description: Limit the number of results returned. e.g. limit=100 will return up to 100 results - name: page type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset type: string description: offset - name: sort type: string description: Define sort order. e.g. ?sort=asc - name: order_by type: string description: Order by a field e.g. ?order_by=name outputParameters: - type: object mapping: $. - name: countries-get-v2-countries-get description: OpenAQ Get countries hints: readOnly: true destructive: false idempotent: true call: openaq.countries-get-v2-countries-get with: limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort country_id: tools.country_id order_by: tools.order_by inputParameters: - name: limit type: integer description: limit - name: page type: string description: page - name: offset type: string description: offset - name: sort type: string description: sort - name: country_id type: string description: country_id - name: order_by type: string description: order_by outputParameters: - type: object mapping: $. - name: countries-getv1-v1-countries-get description: OpenAQ Get countries hints: readOnly: true destructive: false idempotent: true call: openaq.countries-getv1-v1-countries-get with: limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort order_by: tools.order_by inputParameters: - name: limit type: integer description: limit - name: page type: string description: page - name: offset type: string description: offset - name: sort type: string description: sort - name: order_by type: string description: order_by outputParameters: - type: object mapping: $. - name: get-v2-location-by-id-v2-locations-location-id-g description: OpenAQ Get a location by ID hints: readOnly: true destructive: false idempotent: true call: openaq.get-v2-location-by-id-v2-locations-location-id-g with: location_id: tools.location_id limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort inputParameters: - name: location_id type: integer description: The ID of the location required: true - name: limit type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset type: string description: offset - name: sort type: string description: Define sort order. e.g. ?sort=asc outputParameters: - type: object mapping: $. - name: locations-get-v2-locations-get description: OpenAQ Get locations hints: readOnly: true destructive: false idempotent: true call: openaq.locations-get-v2-locations-get with: limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort parameter_id: tools.parameter_id parameter: tools.parameter unit: tools.unit coordinates: tools.coordinates radius: tools.radius country_id: tools.country_id country: tools.country city: tools.city location_id: tools.location_id location: tools.location order_by: tools.order_by is_mobile: tools.is_mobile is_analysis: tools.is_analysis source_name: tools.source_name entity: tools.entity sensor_type: tools.sensor_type model_name: tools.model_name manufacturer_name: tools.manufacturer_name dump_raw: tools.dump_raw inputParameters: - name: limit type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset type: string description: offset - name: sort type: string description: Sort Direction e.g. sort=desc - name: parameter_id type: string 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 type: string description: (optional) A parameter name or ID by which to filter measurement results. e.g. parameter=pm25 or parameter=pm25¶meter=pm10 - name: unit type: string description: unit - name: coordinates type: string description: Coordinate pair in form lat,lng. Up to 8 decimal points of precision e.g. 38.907,-77.037 - name: radius type: integer 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 type: string description: Limit results by a certain country using two digit country ID. e.g. 13 - name: country type: string description: Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX - name: city type: string description: Limit results by a certain city or cities. (e.g. ?city=Chicago or ?city=Chicago&city=Boston) - name: location_id type: string description: location_id - name: location type: string description: location - name: order_by type: string description: Order by a field - name: is_mobile type: string description: Location is mobile e.g. ?isMobile=true - name: is_analysis type: string description: Data is the product of a previous analysis/aggregation and not raw measurements e.g. ?isAnalysis=true - name: source_name type: string description: Name of the data source e.g. ?sourceName=Houston%20Mobile - name: entity type: string description: Source entity type. e.g. ?entity=government - name: sensor_type type: string description: Type of Sensor e.g. ?sensorType=reference%20grade - name: model_name type: string description: Model Name of Sensor e.g. ?modelName=AE33 - name: manufacturer_name type: string description: Manufacturer of Sensor e.g. ?manufacturer=Ecotech - name: dump_raw type: string description: dump_raw outputParameters: - type: object mapping: $. - name: get-v2-latest-by-id-v2-latest-location-id-get description: OpenAQ Get latest measurements by location ID hints: readOnly: true destructive: false idempotent: true call: openaq.get-v2-latest-by-id-v2-latest-location-id-get with: location_id: tools.location_id limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort inputParameters: - name: location_id type: integer description: The ID of the location required: true - name: limit type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset type: string description: offset - name: sort type: string description: Define sort order. e.g. ?sort=asc outputParameters: - type: object mapping: $. - name: latest-get-v2-latest-get description: OpenAQ Get latest measurements hints: readOnly: true destructive: false idempotent: true call: openaq.latest-get-v2-latest-get with: limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort parameter_id: tools.parameter_id coordinates: tools.coordinates radius: tools.radius country_id: tools.country_id order_by: tools.order_by is_mobile: tools.is_mobile is_analysis: tools.is_analysis entity: tools.entity sensor_type: tools.sensor_type dump_raw: tools.dump_raw inputParameters: - name: limit type: string description: limit - name: page type: string description: page - name: offset type: string description: offset - name: sort type: string description: sort - name: parameter_id type: string description: parameter_id - name: coordinates type: string description: coordinates - name: radius type: integer description: radius - name: country_id type: string description: country_id - name: order_by type: string description: order_by - name: is_mobile type: string description: is_mobile - name: is_analysis type: string description: is_analysis - name: entity type: string description: entity - name: sensor_type type: string description: sensor_type - name: dump_raw type: string description: dump_raw outputParameters: - type: object mapping: $. - name: get-v1-latest-by-id-v1-latest-location-id-get description: OpenAQ Get latest measurements by location ID hints: readOnly: true destructive: false idempotent: true call: openaq.get-v1-latest-by-id-v1-latest-location-id-get with: location_id: tools.location_id limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort inputParameters: - name: location_id type: integer description: The ID of the location required: true - name: limit type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset type: string description: offset - name: sort type: string description: Define sort order. e.g. ?sort=asc outputParameters: - type: object mapping: $. - name: latest-v1-get-v1-latest-get description: OpenAQ Get latest measurements hints: readOnly: true destructive: false idempotent: true call: openaq.latest-v1-get-v1-latest-get with: limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort parameter_id: tools.parameter_id parameter: tools.parameter unit: tools.unit coordinates: tools.coordinates radius: tools.radius country_id: tools.country_id country: tools.country city: tools.city location_id: tools.location_id location: tools.location order_by: tools.order_by is_mobile: tools.is_mobile is_analysis: tools.is_analysis source_name: tools.source_name entity: tools.entity sensor_type: tools.sensor_type model_name: tools.model_name manufacturer_name: tools.manufacturer_name dump_raw: tools.dump_raw inputParameters: - name: limit type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset type: string description: offset - name: sort type: string description: Sort Direction e.g. sort=desc - name: parameter_id type: string 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 type: string description: (optional) A parameter name or ID by which to filter measurement results. e.g. parameter=pm25 or parameter=pm25¶meter=pm10 - name: unit type: string description: unit - name: coordinates type: string description: Coordinate pair in form lat,lng. Up to 8 decimal points of precision e.g. 38.907,-77.037 - name: radius type: integer 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 type: string description: Limit results by a certain country using two digit country ID. e.g. 13 - name: country type: string description: Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX - name: city type: string description: Limit results by a certain city or cities. (e.g. ?city=Chicago or ?city=Chicago&city=Boston) - name: location_id type: string description: location_id - name: location type: string description: location - name: order_by type: string description: Order by a field - name: is_mobile type: string description: Location is mobile e.g. ?isMobile=true - name: is_analysis type: string description: Data is the product of a previous analysis/aggregation and not raw measurements e.g. ?isAnalysis=true - name: source_name type: string description: Name of the data source e.g. ?sourceName=Houston%20Mobile - name: entity type: string description: Source entity type. e.g. ?entity=government - name: sensor_type type: string description: Type of Sensor e.g. ?sensorType=reference%20grade - name: model_name type: string description: Model Name of Sensor e.g. ?modelName=AE33 - name: manufacturer_name type: string description: Manufacturer of Sensor e.g. ?manufacturer=Ecotech - name: dump_raw type: string description: dump_raw outputParameters: - type: object mapping: $. - name: get-v1-locations-by-id-v1-locations-location-id- description: OpenAQ Get location by ID hints: readOnly: true destructive: false idempotent: true call: openaq.get-v1-locations-by-id-v1-locations-location-id- with: location_id: tools.location_id limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort inputParameters: - name: location_id type: integer description: The ID of the location required: true - name: limit type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset type: string description: offset - name: sort type: string description: Define sort order. e.g. ?sort=asc outputParameters: - type: object mapping: $. - name: locationsv1-get-v1-locations-get description: OpenAQ Get locations hints: readOnly: true destructive: false idempotent: true call: openaq.locationsv1-get-v1-locations-get with: limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort parameter_id: tools.parameter_id parameter: tools.parameter unit: tools.unit coordinates: tools.coordinates radius: tools.radius country_id: tools.country_id country: tools.country city: tools.city location_id: tools.location_id location: tools.location order_by: tools.order_by is_mobile: tools.is_mobile is_analysis: tools.is_analysis source_name: tools.source_name entity: tools.entity sensor_type: tools.sensor_type model_name: tools.model_name manufacturer_name: tools.manufacturer_name dump_raw: tools.dump_raw inputParameters: - name: limit type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset type: string description: offset - name: sort type: string description: Sort Direction e.g. sort=desc - name: parameter_id type: string 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 type: string description: (optional) A parameter name or ID by which to filter measurement results. e.g. parameter=pm25 or parameter=pm25¶meter=pm10 - name: unit type: string description: unit - name: coordinates type: string description: Coordinate pair in form lat,lng. Up to 8 decimal points of precision e.g. 38.907,-77.037 - name: radius type: integer 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 type: string description: Limit results by a certain country using two digit country ID. e.g. 13 - name: country type: string description: Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX - name: city type: string description: Limit results by a certain city or cities. (e.g. ?city=Chicago or ?city=Chicago&city=Boston) - name: location_id type: string description: location_id - name: location type: string description: location - name: order_by type: string description: Order by a field - name: is_mobile type: string description: Location is mobile e.g. ?isMobile=true - name: is_analysis type: string description: Data is the product of a previous analysis/aggregation and not raw measurements e.g. ?isAnalysis=true - name: source_name type: string description: Name of the data source e.g. ?sourceName=Houston%20Mobile - name: entity type: string description: Source entity type. e.g. ?entity=government - name: sensor_type type: string description: Type of Sensor e.g. ?sensorType=reference%20grade - name: model_name type: string description: Model Name of Sensor e.g. ?modelName=AE33 - name: manufacturer_name type: string description: Manufacturer of Sensor e.g. ?manufacturer=Ecotech - name: dump_raw type: string description: dump_raw outputParameters: - type: object mapping: $. - name: measurements-get-v2-measurements-get description: OpenAQ Get measurements hints: readOnly: true destructive: false idempotent: true call: openaq.measurements-get-v2-measurements-get with: format: tools.format date_from: tools.date_from date_to: tools.date_to limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort has_geo: tools.has_geo parameter_id: tools.parameter_id parameter: tools.parameter unit: tools.unit coordinates: tools.coordinates radius: tools.radius country_id: tools.country_id country: tools.country city: tools.city location_id: tools.location_id location: tools.location order_by: tools.order_by is_mobile: tools.is_mobile is_analysis: tools.is_analysis project: tools.project entity: tools.entity sensor_type: tools.sensor_type value_from: tools.value_from value_to: tools.value_to include_fields: tools.include_fields inputParameters: - name: format type: string description: format - name: date_from type: string description: From when? - name: date_to type: string description: to when? - name: limit type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset type: string description: offset - name: sort type: string description: sort - name: has_geo type: string description: has_geo - name: parameter_id type: string 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 type: string description: (optional) A parameter name or ID by which to filter measurement results. e.g. parameter=pm25 or parameter=pm25¶meter=pm10 - name: unit type: string description: unit - name: coordinates type: string description: Coordinate pair in form lat,lng. Up to 8 decimal points of precision e.g. 38.907,-77.037 - name: radius type: integer 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 type: string description: Limit results by a certain country using two digit country ID. e.g. 13 - name: country type: string description: Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX - name: city type: string description: Limit results by a certain city or cities. (e.g. ?city=Chicago or ?city=Chicago&city=Boston) - name: location_id type: string description: location_id - name: location type: string description: location - name: order_by type: string description: order_by - name: is_mobile type: string description: Location is mobile e.g. ?isMobile=true - name: is_analysis type: string description: Data is the product of a previous analysis/aggregation and not raw measurements e.g. ?isAnalysis=false - name: project type: string description: project - name: entity type: string description: entity - name: sensor_type type: string description: Filter by sensor type (i,e. reference grade, low-cost sensor) e.g. ?sensorType=reference%20grade - name: value_from type: string description: value_from - name: value_to type: string description: value_to - name: include_fields type: string description: Additional fields to include in response e.g. ?include_fields=sourceName outputParameters: - type: object mapping: $. - name: measurements-get-v1-v1-measurements-get description: OpenAQ Get a list of measurements hints: readOnly: true destructive: false idempotent: true call: openaq.measurements-get-v1-v1-measurements-get with: format: tools.format date_from: tools.date_from date_to: tools.date_to limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort has_geo: tools.has_geo parameter_id: tools.parameter_id parameter: tools.parameter unit: tools.unit coordinates: tools.coordinates radius: tools.radius country_id: tools.country_id country: tools.country city: tools.city location_id: tools.location_id location: tools.location order_by: tools.order_by is_mobile: tools.is_mobile is_analysis: tools.is_analysis project: tools.project entity: tools.entity sensor_type: tools.sensor_type value_from: tools.value_from value_to: tools.value_to include_fields: tools.include_fields inputParameters: - name: format type: string description: format - name: date_from type: string description: From when? - name: date_to type: string description: to when? - name: limit type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset type: string description: offset - name: sort type: string description: sort - name: has_geo type: string description: has_geo - name: parameter_id type: string 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 type: string description: (optional) A parameter name or ID by which to filter measurement results. e.g. parameter=pm25 or parameter=pm25¶meter=pm10 - name: unit type: string description: unit - name: coordinates type: string description: Coordinate pair in form lat,lng. Up to 8 decimal points of precision e.g. 38.907,-77.037 - name: radius type: integer 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 type: string description: Limit results by a certain country using two digit country ID. e.g. 13 - name: country type: string description: Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX - name: city type: string description: Limit results by a certain city or cities. (e.g. ?city=Chicago or ?city=Chicago&city=Boston) - name: location_id type: string description: location_id - name: location type: string description: location - name: order_by type: string description: order_by - name: is_mobile type: string description: Location is mobile e.g. ?isMobile=true - name: is_analysis type: string description: Data is the product of a previous analysis/aggregation and not raw measurements e.g. ?isAnalysis=false - name: project type: string description: project - name: entity type: string description: entity - name: sensor_type type: string description: Filter by sensor type (i,e. reference grade, low-cost sensor) e.g. ?sensorType=reference%20grade - name: value_from type: string description: value_from - name: value_to type: string description: value_to - name: include_fields type: string description: Additional fields to include in response e.g. ?include_fields=sourceName outputParameters: - type: object mapping: $. - name: parameters-get-v2-parameters-get description: OpenAQ Get parameters hints: readOnly: true destructive: false idempotent: true call: openaq.parameters-get-v2-parameters-get with: limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort order_by: tools.order_by inputParameters: - name: limit type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset type: string description: offset - name: sort type: string description: Define sort order. e.g. ?sort=asc - name: order_by type: string description: order_by outputParameters: - type: object mapping: $. - name: parameters-getv1-v1-parameters-get description: OpenAQ Get parameters hints: readOnly: true destructive: false idempotent: true call: openaq.parameters-getv1-v1-parameters-get with: limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort order_by: tools.order_by inputParameters: - name: limit type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: page type: string description: Paginate through results. e.g. page=1 will return first page of results - name: offset type: string description: offset - name: sort type: string description: Define sort order. e.g. ?sort=asc - name: order_by type: string description: order_by outputParameters: - type: object mapping: $. - name: projects-get-v2-projects-project-id-get description: OpenAQ Project by ID hints: readOnly: true destructive: false idempotent: true call: openaq.projects-get-v2-projects-project-id-get with: project_id: tools.project_id inputParameters: - name: project_id type: integer description: project_id required: true outputParameters: - type: object mapping: $. - name: projects-get-v2-projects-get description: OpenAQ Projects hints: readOnly: true destructive: false idempotent: true call: openaq.projects-get-v2-projects-get with: country_id: tools.country_id limit: tools.limit page: tools.page offset: tools.offset sort: tools.sort parameter_id: tools.parameter_id parameter: tools.parameter unit: tools.unit project_id: tools.project_id project: tools.project order_by: tools.order_by is_mobile: tools.is_mobile is_analysis: tools.is_analysis entity: tools.entity sensor_type: tools.sensor_type source_name: tools.source_name inputParameters: - name: country_id type: string description: country_id required: true - name: limit type: string description: limit required: true - name: page type: string description: page required: true - name: offset type: string description: offset required: true - name: sort type: string description: Limit results by a certain country using two digit country ID. e.g. 13 - name: parameter_id type: string description: Limit results by a certain country using two letter country code. e.g. ?country=US or ?country=US&country=MX - name: parameter type: string description: Change the number of results returned. e.g. limit=1000 will return up to 1000 results - name: unit type: string description: Paginate through results. e.g. page=1 will return first page of results - name: project_id type: string description: project_id - name: project type: string description: Define sort order. e.g. ?sort=asc - name: order_by type: string 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 type: string 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 type: string description: is_analysis - name: entity type: string description: entity - name: sensor_type type: string description: sensor_type - name: source_name type: string description: source_name outputParameters: - type: object mapping: $. binds: - namespace: env keys: OPENAQ_TOKEN: OPENAQ_TOKEN