Air Quality
Air Quality is a simple tool for getting air quality data. It returns the air quality index, o3, pm2, and more.
This API provides reliable and fast access to air quality data through a simple REST interface. Built for developers who need consistent, high-quality results with minimal setup time.
To use this API, you need an API key. You can get one by creating a free account and visiting your dashboard.
View API in DirectoryEndpoint
GET https://api.apiverve.com/v1/airqualityCode Examples
Here are examples of how to call this API in different programming languages:
curl -X GET \
"https://api.apiverve.com/v1/airquality?city=San Francisco" \
-H "X-API-Key: your_api_key_here"const response = await fetch('https://api.apiverve.com/v1/airquality', {
method: 'GET',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
response = requests.get('https://api.apiverve.com/v1/airquality', headers=headers)
data = response.json()
print(data)const https = require('https');
const url = require('url');
const options = {
method: 'GET',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
};
const req = https.request('https://api.apiverve.com/v1/airquality', options, (res) => {
let data = '';
res.on('data', (chunk) => data += chunk);
res.on('end', () => console.log(JSON.parse(data)));
});
req.end();<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apiverve.com/v1/airquality');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'X-API-Key: your_api_key_here',
'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/airquality", nil)
req.Header.Set("X-API-Key", "your_api_key_here")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require 'net/http'
require 'json'
uri = URI('https://api.apiverve.com/v1/airquality')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['X-API-Key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'
response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))Authentication
This API requires authentication via API key. Include your API key in the request header:
X-API-Key: your_api_key_hereParameters
The following parameters are available for this API endpoint:
| Parameter | Type | Required | Location | Description | Example |
|---|---|---|---|---|---|
| city | string | Yes | query | The city name for which you want to get the air quality data (e.g., New York) | San Francisco |
Response
The API returns responses in JSON, XML, and YAML formats:
Example Responses
{
"status": "ok",
"error": null,
"data": {
"pm2_5": 25.345,
"pm10": 32.005,
"us-epa-index": 2,
"gb-defra-index": 3,
"carbonMonoxide": 745.55,
"ozone": 47,
"nitrogenDioxide": 54.02,
"sulfurdioxide": 4.625,
"recommendation": "The air quality in San Francisco is good. It is safe to go outside.",
"city": "San Francisco"
}
}<Root>
<status>ok</status>
<error />
<data>
<pm2_5>25.345</pm2_5>
<pm10>32.005</pm10>
<us-epa-index>2</us-epa-index>
<gb-defra-index>3</gb-defra-index>
<carbonMonoxide>745.55</carbonMonoxide>
<ozone>47</ozone>
<nitrogenDioxide>54.02</nitrogenDioxide>
<sulfurdioxide>4.625</sulfurdioxide>
<recommendation>The air quality in San Francisco is good. It is safe to go outside.</recommendation>
<city>San Francisco</city>
</data>
</Root>status: ok
error:
data:
pm2_5: 25.345
pm10: 32.005
us-epa-index: 2
gb-defra-index: 3
carbonMonoxide: 745.55
ozone: 47
nitrogenDioxide: 54.02
sulfurdioxide: 4.625
recommendation: The air quality in San Francisco is good. It is safe to go outside.
city: San FranciscoResponse Structure
All API responses follow a consistent structure with the following fields:
| Field | Type | Description | Example |
|---|---|---|---|
| status | string | Indicates whether the request was successful ("ok") or failed ("error") | ok |
| error | string | null | Contains error message if status is "error", otherwise null | null |
| data | object | null | Contains the API response data if successful, otherwise null | {...} |
Response Data Fields
When the request is successful, the data object contains the following fields:
| Field | Type | Sample Value |
|---|---|---|
| pm2_5 | number | 25.345 |
| pm10 | number | 32.005 |
| us-epa-index | number | 2 |
| gb-defra-index | number | 3 |
| carbonMonoxide | number | 745.55 |
| ozone | number | 47 |
| nitrogenDioxide | number | 54.02 |
| sulfurdioxide | number | 4.625 |
| recommendation | string | "The air quality in San Francisco is good. It is safe to go outside." |
| city | string | "San Francisco" |
Headers
Required and optional headers for API requests:
| Header Name | Required | Example Value | Description |
|---|---|---|---|
| X-API-Key | Yes | your_api_key_here | Your APIVerve API key. Found in your dashboard under API Keys. |
| Accept | No | application/json | Specify response format: application/json (default), application/xml, or application/yaml |
| User-Agent | No | MyApp/1.0 | Identifies your application for analytics and debugging purposes |
| X-Request-ID | No | req_123456789 | Custom request identifier for tracking and debugging requests |
| Cache-Control | No | no-cache | Control caching behavior for the request and response |
Client Libraries
To get started with minimal code, most of our APIs are available through client libraries and clients:
Error Codes
The API uses standard HTTP status codes to indicate success or failure:
| Status Code | Message | Description |
|---|---|---|
| 200 | OK | Request successful, data returned |
| 400 | Bad Request | Invalid request parameters or malformed request |
| 401 | Unauthorized | Missing or invalid API key |
| 403 | Forbidden | API key does not have permission for this endpoint |
| 429 | Too Many Requests | Rate limit exceeded, please slow down requests |
| 500 | Internal Server Error | Server error, please try again later |
Was this page helpful?
Help us improve our documentation




