Skip to main content
Data Hub collects, processes, and stores environmental and community time-series data from building automation systems, dataloggers, sensors, LoRaWAN networks, and public APIs. Today this data is explored through the Data Visualizer and Data Dashboards. Two additional, complementary mechanisms for accessing the underlying data directly:
  • The Data API — low-latency, read-only programmatic access for applications and automated workflows.
  • The Data Downloader — a UI-driven bulk export flow for offline analysis and archival. This is an interface, not a public API surface — see Share & Export.
Both require a registered, Auth0-authenticated user account.

​
Base URL

The Data API is served from a single base URL, common across all Community Hub organizations:
An organization is not identified via a path parameter. A token is scoped to the user, not to a single organization — it grants exactly the same access the user’s account already has, which may span multiple organizations. Instead, variables are queried and filtered via metered entity rather than organization.
Open: the exact query-parameter design for filtering by metered entity, and how a discovery request returns results across a multi-org user’s full access, aren’t fully decided yet. The current direction is that a variables-discovery request returns a hierarchy — organizations → metered entities → variables — rather than a flat list scoped to one organization. See Discovery Endpoints.

​
Guiding model

  • The primary object exposed is the variable — a measured or derived quantity — not the underlying sensor or acquisition method.
  • Metadata (what a variable represents, its instrument, frequency, units, location, associated metered entity and data source) is a first-class part of the response, retrievable independently or bundled with data.
  • The API is designed to be self-describing: discovery endpoints exist for variables, metered entities, resolutions, units, and standardizations, so you don’t need to memorize IDs upfront.

​
Versioning

URI-based versioning, as part of the base URL (.../public/v1). Backward-incompatible changes are introduced under a new version segment (e.g. .../public/v2), leaving the v1 base URL and all existing integrations unaffected.

​
Environments

No separate sandbox/staging environment at launch. This is a conservative default reflecting the added infrastructure cost of a parallel environment, and may be revisited if development or educational use warrants it.

​
Documentation and licensing

Full API documentation, described using the OpenAPI Specification (OAS) 3.1.x format, is targeted for publication at docs.communityhub.cloud/data-hub by the end of August 2026. The license and usage policy governing use of Data Hub data — including public/private dataset designation, attribution requirements, non-commercial-use restrictions where required by data providers, and usage quotas — will be published as part of that documentation, and enforced consistently across both the Data API and the Data Downloader.

​
Status

Base URL, authentication model, and endpoint design are confirmed — see Authentication and Rate Limits — with the full endpoint list at Discovery Endpoints and Get Variable Data.
This page is a stub for the exact error-response envelope — that hasn’t been finalized in the source spec yet.