Skip to content

v0.1.0: Measured air quality via the OpenAQ v3 API

Choose a tag to compare

@cyanheads cyanheads released this 14 Jun 10:17
· 7 commits to main since this release
81b3414

Measured air quality via the OpenAQ v3 API

Initial release. Wraps the OpenAQ v3 API to expose measured air quality — physical-sensor observations from government reference monitors and research-grade sensors worldwide. An empty result means no monitoring coverage there, not clean air.

Added:

  • openaq_find_locations — find stations near a point, in a bounding box, or by country; returns coordinates, distance, provider, parameters measured, and data span.
  • openaq_get_readings — latest value per sensor at a station, each joined with its pollutant and unit. Accepts a locationId or coordinates + parametersId.
  • openaq_get_measurements — historical series for one pollutant at one station; raw/hourly/daily aggregation, large series spill to a DataCanvas.
  • openaq_list_parameters — pollutant + unit catalog with a pollutantsOnly toggle (the unit-disambiguation reference).
  • openaq_list_countries — country coverage catalog for availability checks before a regional sweep.
  • openaq_dataframe_query / openaq_dataframe_describe — read-only SQL over measurement series staged on a DataCanvas (CANVAS_PROVIDER_TYPE=duckdb).
  • Resources — openaq://location/{locationId} and openaq://parameters.

Notes:

  • Units are surfaced verbatim and never converted.
  • Requires a free OpenAQ API key in OPENAQ_API_KEY (sent as the X-API-Key header).

64 tests pass; bun run devcheck clean.