action meteosource_air_quality_air_quality_get {
label: "Returns air quality data for a single point (geographic name or GPS)"
description: "## Air quality forecast for a single location\n\n### Location specification\nThe location of the weather data is the only parameter that is required and must be specified. There are two ways to do this:\n1. Specify the GPS coordinates of the location using the parameters `lat` and `lon`.\n2. **OR** specify the name of the place using the parameter `place_id`. To obtain the `place_id` for the location you want, please use endpoints `/find_places_prefix` (search by prefix) or `/find_places` (search by full name).\n\n### Notes\n* **For a detailed description of variables, please consult ⚠️ description of variables ⚠️ in Documentation or `Schema` of the response (link next to Example value in the Responses section below).**\n* Do **not** make any assumptions about the number and ordering of the variables. New variables and sections may be introduced in the future. Always check the data are present before you try to use them.\n* The response contains an `Expires` header, which defines the point at which the API response will not change for the same request. We highly recommend using this to avoid unnecessary requests and **increase the performance of your app**.\n* Meteosource API supports HTTP compression. To enable it, simply add an `Accept-Encoding: gzip` header to your request.\n* When daylight saving time starts, one hourly record will be missing (typically `2:00:00 AM`). When daylight saving time ends, the hourly forecast will contain two records with duplicate times (typically `2:00:00 AM`).\n"
provider: meteosource
method: GET
path: "/air_quality"
encoding: json
input: {
type: "object"
properties: {
key: {
type: "string"
description: "Your unique API key. You can either specify it in this parameter, or set it in `X-API-Key` header."
}
lat: {
type: "string"
description: "Latitude in format 12N, 12.3N, 12.3, or 13S, 13.2S, -13.4"
}
lon: {
type: "string"
description: "Longitude in format 12E, 12.3E, 12.3, or 13W, 13.2W, -13.4"
}
place_id: {
type: "string"
description: "Identifier of a place. To obtain the `place_id` for the location you want, please use endpoints `/find_places_prefix` (search by prefix) or `/find_places` (search by full name)."
}
timezone: {
type: "string"
description: "Timezone to be used for the date fields. If not specified, local timezone of the forecast location will be used.\nThe format is according to the tzinfo database, so values like `Europe/Prague` or `UTC` can be used.\nAlternatively you may use the value ``auto`` in which case the local timezone of the location is used.\nThe full list of valid timezone strings can be found [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).\n"
}
}
additionalProperties: false
}
output: {
type: "object"
required: ["data", "elevation", "lat", "lon"]
properties: {
data: {
type: "array"
items: {
type: "object"
properties: {
aerosol_550: {
type: "number"
description: "Total aerosol optical depth at 550 nm.\nUnit: dimensionless"
}
air_quality: {
type: "number"
description: "Air quality index. The following values can appear:\n\n* 1 - Very good\n* 2 - Good\n* 3 - Medium\n* 4 - Poor\n* 5 - Very poor\n* 6 - Extremely poor\n\nUnit: index"
}
co_surface: {
type: "number"
description: "Carbon monoxide at surface level.\nUnit: µg/m3"
}
date: {
type: "string"
format: "date-time"
description: "Datetime in YYYY-MM-DDTHH:MM:SS format."
}
dust_550nm: {
type: "number"
description: "Dust aerosol optical depth at 550 nm.\nUnit: dimensionless"
}
dust_mixing_ratio_05: {
type: "number"
description: "Dust aerosol (0.55 - 0.9 µm) mixing ratio.\nUnit: kg/kg"
}
no2_surface: {
type: "number"
description: "Nitrogen dioxide at surface level.\nUnit: µg/m3"
}
no_surface: {
type: "number"
description: "Nitrogen monoxide at surface level.\nUnit: µg/m3"
}
ozone_surface: {
type: "number"
description: "Ozone.\nUnit: µg/m3"
}
ozone_total: {
type: "number"
description: "Total column ozone.\nUnit: Dobson"
}
pm10: {
type: "number"
description: "Particulate matter d < 10 µm (PM10).\nUnit: µg/m3"
}
pm25: {
type: "number"
description: "Particulate matter d < 2.5 µm (PM2.5).\nUnit: µg/m3"
}
so2_surface: {
type: "number"
description: "Sulphur dioxide at surface level.\nUnit: µg/m3"
}
}
}
}
elevation: {
type: "integer"
description: "Elevation above sea level in metres (for units 'metric', 'uk', 'ca') or feet (for units 'us')"
}
lat: {
type: "string"
description: "Latitude of the point, always in the format , for example ``23.5S``"
}
lon: {
type: "string"
description: "Longitude of the point, always in the format , for example ``23.5W``"
}
timezone: {
type: "string"
description: "Name of the timezone in format like 'Europe/London'. Available only when the place is specified through place ID."
}
}
}
}