Zephyr® API access & documents

🧾 What you can get via the API — the typical data & format…

• Time-series pollutant measurements: e.g. PM1, PM2.5, PM10, NO₂, NO, O₃, CO, SO₂, etc — depending on your cartridge configuration. 

• Environmental data: temperature, relative humidity, pressure. 

• Metadata: sensor ID / serial number, location (for GPS-enabled Zephyrs), timestamp, maybe upload status. The Zephyr supports GPS and can be used in mobile or static deployments. 

• Downloadable formats: JSON (for programmatic integration) or CSV (for easier import into spreadsheets or other tools).

What is in Zephyr API (ZAPI)— what it does include?

• The Zephyr is our air-quality monitoring device measuring pollutants (e.g. PM1/2.5/10, NO₂, NO, O₃, optionally CO, SO₂, etc.), plus environment variables (temperature, humidity, etc.). 

• Data collected by Zephyr hardware is transmitted (via GSM, WiFi, etc.) to EarthSense’s cloud (AWS) where it is stored. 

• The Zephyr API (called “ZAPI” by EarthSense) provides programmatic access to that data — so you can pull sensor measurements into your own application or system.

🔐 What you need before using ZAPI

1. A deployed Zephyr unit (with a valid subscription, or rental, and correct cartridge configuration for the pollutant species you want).

2. Credentials / API access provided by EarthSense — typically you get these when you purchase or subscribe.

3. A decision about which data you want — e.g. particulate matter (PM), gases (NO₂, CO, etc.), environmental data (temperature, humidity), and over what time period.

4. The ID or serial number of your Zephyr unit(s) — to specify which sensor(s) you’re querying.

🧑‍💻 How to call the ZAPI — typical workflow

1. Authenticate — Via an API key or token provided by EarthSense (not publicly documented), to authorize your requests.

2. Send request to the Zephyr API endpoint(s). The official API documentation is at the “ZAPI” docs page. docs.earthsense.co.uk

3. Specify what you want: E.g. time range (start/end), pollutant species, possibly location or sensor ID.

4. Receive data — often in JSON (or optionally CSV) format. The API returns the measurement data collected by the Zephyr. 

5. Process the data — you can import it into your own dashboards, integrate into third-party systems (e.g. traffic management, smart-city dashboards or equivalent) and perform analysis/visualisation.

📥 Example flow for ZAPI — pseudo-code

import requests

API_BASE = "https://api.earthsense.co.uk/zapi"  # example; get real base from docs
API_KEY = "your_api_key_here"

headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Accept": "application/json"
}

params = {
    "sensor_id": "ZEPHYR-123456",       # replace with your unit’s ID
    "start": "2025-12-01T00:00:00Z",
    "end":   "2025-12-09T23:59:59Z",
    "pollutants": ["PM2.5","NO2","Temperature"]
}

response = requests.get(f"{API_BASE}/measurements", headers=headers, params=params)
data = response.json()

# Now data contains time-series for requested pollutants
for entry in data["measurements"]:
    print(entry["timestamp"], entry["PM2.5"], entry["NO2"], entry["temperature"])

📚 Where to find the official ZAPI docs