Air Quality
openweathermap.air_pollution
ActionBusiness appsconnection required
Calls the OpenWeather API with the connection's credentials.
Read the current air-quality index and the pollutant concentrations behind it for one place.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- OpenWeather
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- units, lang, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
place A place name to resolve through the Geocoding API, as 'city', 'city,country code' or 'city,state code,country code' for the US — for example 'London,GB'. | string | No | — | — | London,GB |
lat Latitude of the place to look up, from -90 to 90. Give it together with 'lon', or name a 'place' or a 'postcode' instead. | number | No | — | -90–90 | 51.5074 |
lon Longitude of the place to look up, from -180 to 180. Give it together with 'lat', or name a 'place' or a 'postcode' instead. | number | Conditional | — | -180–180; only with lat | -0.1278 |
postcode A post code and its two-letter country code, divided by a comma, resolved through the Geocoding API — for example '94040,US'. | string | No | — | — | 94040,US |
- At least one of place, lat, postcode must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"lat": 51.5074,
"lon": -0.1278,
"place": "London,GB",
"postcode": "94040,US"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
coord The coordinates OpenWeather answered for. | object | — |
list One entry per measurement, each with 'dt', 'main.aqi' (the 1-5 air-quality index) and a 'components' breakdown in micrograms per cubic metre. | array | — |
location.lat The latitude this call actually used. | number | — |
location.lon The longitude this call actually used. | number | — |
location.name The place name the Geocoding API matched; empty when coordinates were given. | string | — |
location.country The two-letter country code of the matched place, when one was geocoded. | string | — |
location.source How the coordinates were reached: 'coordinates', 'geocode' or 'postcode'. | string | — |
{
"coord": {},
"list": [],
"location": {
"country": "",
"lat": 0,
"lon": 0,
"name": "",
"source": ""
}
}Notes
- 'main.aqi' runs 1 (good) to 5 (very poor); the 'components' figures are raw concentrations and are not scaled to that index.
- A 'place' or 'postcode' costs one extra Geocoding API call before the weather call; passing 'lat' and 'lon' skips it.
See Air Quality run in a workflow.
In a technical demo we add the OpenWeather connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.