Skip to main content

Versioning

The major version is in the path (/v1). Within v1 we only add things: new endpoints, new fields, and new values in enums documented as extensible. Write clients that ignore unknown fields and handle unknown enum values. Breaking changes ship in a new major version. Credit prices are versioned per endpoint. Every response reports the version it was charged at in X-Credit-Price-Version; send that header back to make a request fail with 409 price_changed instead of running at a new price. Every endpoint is currently in beta.

Changelog

GET /v1/changelog (free, no key needed) lists new features, deprecations with their sunset dates, data corrections with the affected dataset and range, and incidents. Pass since to fetch only new entries.

Status

GET /v1/status (free, no key needed) reports each dataset’s health (ok, degraded, stale, or unknown), its live lag and, where available, its complete_to.

Support

Email sales@hyperdash.com and quote the request_id from the response.