API Documentation
v1.0
Programmatic access to NWGSGrid wastewater surveillance, genomic variant, and demographic burden data.
Base URL: https://api.nwgsgrid.org/v1Authentication
All API requests require an API key passed in the header:
Authorization: Bearer YOUR_API_KEYRate Limits
Free Tier100 req/day
Research10,000 req/day
EnterpriseUnlimited
Rate limit headers included in all responses.
Categories
Response Codes
200
Success400
Bad Request401
Unauthorized429
Rate Limited500
Server Error| Name | Type | Required | Description |
|---|---|---|---|
| region_id | string | Required | Region identifier (state FIPS, county FIPS, or site ID) |
| pathogen | string | Required | Pathogen: 'SARS-CoV-2', 'RSV', 'Influenza-A', 'Influenza-B' |
| start_date | date | Required | Start date (ISO 8601 format: YYYY-MM-DD) |
| end_date | date | Required | End date (ISO 8601 format: YYYY-MM-DD) |
| metric | string | Optional | Metric type: 'wval', 'concentration', 'percentile' (default: 'wval') |
| granularity | string | Optional | Time granularity: 'daily', 'weekly' (default: 'weekly') |
Example Request
GET /api/timeseries?region_id=36&pathogen=SARS-CoV-2&start_date=2024-01-01&end_date=2024-03-01Client Libraries
Official SDKs for popular languages
Python
R
JavaScript
OpenAPI Spec
Download the full API specification
Support
Need help with the API?
