Responses

Data responses

Every response that returns data includes these fields next to the data itself:

Field	Meaning
dataset_version	The release the values come from. null before the first release.
doi	The Zenodo DOI of that release. null before the first release.
citation	A citation ready to paste.

Field names and units match the published files exactly. Each dataset page lists them.

Headers

Header	Meaning
X-RateLimit-Limit	Calls allowed in the current minute
X-RateLimit-Remaining	Calls left in the current minute
X-RateLimit-Reset	When the minute window resets, as a Unix time
Retry-After	On a 429 only: seconds to wait

Errors

{"error": {"code": "not_found", "message": "Storm AL992017 not in the catalog.", "docs_url": "https://docs.heimdallresearch.com/errors/not_found"}}

code is stable and safe to branch on. message is for people and may change. See Errors for every code.