API Reference

Welcome to the AeroViz API documentation. This comprehensive guide will help you integrate with our platform and access air quality data programmatically.

All API requests require authentication using an API key. Include your API key in the request header:

Authorization: Bearer YOUR_API_KEY

Getting an API Key

To obtain an API key:

1. Log in to your AeroViz account
2. Navigate to Settings → API Keys
3. Generate a new API key
4. Store it securely

Get Air Quality Data

Retrieve current air quality measurements from monitoring stations.

Example Request

GET /api/v1/data/air-quality?station_id=TAIPEI_001¶meter=PM2.5&start_date=2025-01-01&end_date=2025-01-31

Example Response

{
  "status": "success",
  "data": {
    "station_id": "TAIPEI_001",
    "station_name": "Taipei Main Station",
    "location": {
      "latitude": 25.0478,
      "longitude": 121.5319
    },
    "measurements": [
      {
        "timestamp": "2025-01-15T10:00:00Z",
        "parameter": "PM2.5",
        "value": 25.3,
        "unit": "μg/m³",
        "aqi": 75
      }
    ]
  }
}

Real-time monitoring endpoints for live data streams.

Live Data Stream

Subscribe to real-time air quality updates using WebSocket connection.

wss://api.aeroviz.org/v1/stream/air-quality

Access research data and publications through our API.

Get Research Publications

GET /api/v1/research/publications

Configure webhooks to receive notifications when specific conditions are met.

Setting up Webhooks

1. Create a webhook endpoint on your server
2. Register the webhook URL with our API
3. Configure trigger conditions
4. Handle incoming webhook payloads

API requests are rate-limited to ensure fair usage:

• Free Tier: 100 requests per hour
• Pro Tier: 1,000 requests per hour
• Enterprise: 10,000 requests per hour

Common HTTP status codes and their meanings: