Air Quality

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.

Live Test Air Quality API →

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.

1
2

curl "https://api.apiverve.com/v1/airquality?city=San%20Francisco" \
  -H "x-api-key: your_api_key_here"

1
2
3
4
5
6
7
8

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);

1
2
3
4
5
6
7
8
9
10

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"])

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

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.

Parameters

Sent in the query string. Premium parameters are accepted on every plan but only take effect on plans that include them.

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.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

{
  "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.

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.

Use cases

HVAC Air Intake Automation

Smart thermostat controllers read local PM2.5 and PM10 concentrations to automatically switch ventilation systems to internal recirculation during high pollution spikes.

Outdoor Workout Planning

Fitness mobile apps show runners actionable health recommendations and particulate ratings by city before they start an outdoor training session.

Property Environmental Profiles

Display local particulate measurements and health advice on real estate listings so buyers can evaluate neighborhood environmental quality.

School Sports Scheduling

When particulate counts exceed safe thresholds, athletic directors consult real-time pollution readings and health recommendations to move student practices indoors.

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: