Overview
Air Quality works by retrieving the air quality data from various reliable sources and providing it in a structured format. You can expect accurate and up-to-date information.
Endpoint
One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.
curl "https://api.apiverve.com/v1/airquality?city=San%20Francisco" \
-H "x-api-key: your_api_key_here"const res = await fetch('https://api.apiverve.com/v1/airquality?city=San%20Francisco', {
headers: { 'x-api-key': 'your_api_key_here' },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.get(
"https://api.apiverve.com/v1/airquality?city=San%20Francisco",
headers={"x-api-key": "your_api_key_here"},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/airquality?city=San%20Francisco", nil)
req.Header.Set("x-api-key", "your_api_key_here")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.
Authentication
Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent in the query string. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
cityRequired | string | The city name for which you want to get the air quality data (e.g., New York) |
Response
Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.
{
"status": "ok",
"error": null,
"data": {
"pm2_5": 16.75,
"pm10": 18.85,
"carbonMonoxide": 387.85,
"ozone": 9,
"nitrogenDioxide": 38.55,
"sulfurdioxide": 5.95,
"usEpaIndex": 2,
"gbDefraIndex": 2,
"recommendation": "The air quality in San Francisco is good. It is safe to go outside.",
"city": "San Francisco"
}
}Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
pm2_5 | number | 16.75 | Fine particulate matter concentration in micrograms per cubic meter |
pm10 | number | 18.85 | Coarse particulate matter concentration in micrograms per cubic meter |
carbonMonoxidePremium | number | 387.85 | Carbon monoxide concentration level in parts per billion |
ozonePremium | number | 9 | Ground-level ozone concentration in parts per billion |
nitrogenDioxidePremium | number | 38.55 | Nitrogen dioxide concentration level in parts per billion |
sulfurdioxidePremium | number | 5.95 | Sulfur dioxide concentration level in parts per billion |
usEpaIndexPremium | number | 2 | US EPA air quality index rating from one to six scale |
gbDefraIndexPremium | number | 2 | UK DEFRA air quality index rating from one to ten scale |
recommendation | string | "The air quality in San Francisco is good. It is safe to go outside." | Air quality assessment and health recommendation for the city |
city | string | "San Francisco" | The city name for which air quality data was retrieved |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Use cases
- Health Monitoring
- Monitor air quality by using the Air Quality API to get real-time air quality data. Use the data to track pollution levels and protect your users' health
- Environmental Analysis
- Analyze environmental conditions by using the Air Quality API to get air quality data. Use the data to study pollution levels and their impact on the environment
- Weather Forecasting
- Forecast weather conditions by using the Air Quality API to get air quality data. Use the data to predict air pollution levels and plan outdoor activities
- City Planning
- Plan urban development by using the Air Quality API to get air quality data. Use the data to assess pollution levels and make informed decisions on city planning
Other ways to use Air Quality
Set up Air Quality on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.
Related
More in Weather: