In this article

Get Air Quality Index

This endpoint will get the Air Quality Index using the BreezoMeter API.

URL

https://{{HOST}}/weather/BreezoMeter?lat={LATITUDE}&lon={LONGITUDE}

Method

GET

Required IMS Scopes

weatherapi_all

URL Query Parameters

Name	Description	Type
lat requried	Latitude is a geographic coordinate that specifies the north-south position of a point on the Earth’s surface. Range between -90 to 90 (WGS84 standard)	number
lon requried	Longitude is a geographic coordinate that specifies the east-west position of a point on the Earth’s surface. Range between -180 to 180 (WGS84 standard)	number
lang optional	Response language. Currently only support English(“en”) and Hebrew(“he”).	`[en, he]`
fields optional	Allows the API request to be customized to return only the specified data in the response. Concatenate the fields to be returned in the response using a comma (“,”)	breezometer_aqi breezometer_color breezometer_description country_aqi country_aqi_prefix country_color country_description country_name data_valid datetime dominant_pollutant_canonical_name dominant_pollutant_description dominant_pollutant_text pollutants random_recommendations

Request Header Parameters

Type	Value	Description
Authorization	Bearer {access_token} required	IMS access token

Example

Request

curl -X GET 
  'https://{{HOST}}/weather/breezometer/?lat=43.037457&lon=-87.9049005' 
  -H 'Authorization: Bearer {{access_token}}'

Response

{
    "datetime": "2018-04-25T19:00:00",
    "country_name": "United States",
    "breezometer_aqi": 65,
    "breezometer_color": "#A2DB26",
    "breezometer_description": "Fair air quality",
    "country_aqi": 63,
    "country_aqi_prefix": "",
    "country_color": "#FFFF00",
    "country_description": "Moderate air quality",
    "data_valid": true,
    "key_valid": true,
    "random_recommendations": {
        "children": "You should supervise your children in the coming hours and monitor changes in air quality",
        "sport": "You can go on a run - just keep your nose open for any changes!",
        "health": "Exposure to air hazards is dangerous for people with health sensitivities, so it is important to monitor air quality at this time",
        "inside": "The air quality is still good - we'll keep you updated if things get worse",
        "outside": "You can go out, but please pay attention for changes in air quality"
    },
    "dominant_pollutant_canonical_name": "o3",
    "dominant_pollutant_description": "Ozone",
    "dominant_pollutant_text": {
        "main": "The dominant pollutant is ozone (O3).",
        "effects": "Ozone can irritate the airways causing coughing, a burning sensation, wheezing and shortness of breath. Children, people with respiratory or lung and heart diseases, elderly and those who exercise outdoors are particularly vulnerable to ozone exposure.",
        "causes": "Ozone is created in a chemical reaction between atmospheric oxygen, nitrogen oxides, organic compounds and sunlight."
    },
    "pollutants": {
        "co": {
            "pollutant_description": "Carbon monoxide",
            "units": "ppb",
            "concentration": 197
        },
        "no2": {
            "pollutant_description": "Nitrogen dioxide",
            "units": "ppb",
            "concentration": 36.289999999999999
        },
        "o3": {
            "pollutant_description": "Ozone",
            "units": "ppb",
            "concentration": 44.07
        },
        "pm10": {
            "pollutant_description": "Inhalable particulate matter (<10)",
            "units": "ug/m3",
            "concentration": 26.870000000000001
        },
        "pm25": {
            "pollutant_description": "Fine particulate matter (<2.5)",
            "units": "ug/m3",
            "concentration": 15.25
        },
        "so2": {
            "pollutant_description": "Sulfur dioxide",
            "units": "ppb",
            "concentration": 0
        }
    }
}

Note Watch out for unicode characters in the response.