Skip to content
heimdallresearch.comSign inGet an API key

Errors

Every error has the same shape:

{"error": {"code": "rate_limited", "message": "Rate limit exceeded.", "docs_url": "https://docs.heimdallresearch.com/errors/rate_limited"}}
Code Status Meaning
unauthorized 401 The request had no API key, or the key is unknown or revoked.
forbidden 403 The key is valid but is not allowed to use this resource.
plan_required 403 The data you asked for is part of a paid plan.
not_found 404 The dataset, storm, county, lake or gate in the path does not exist.
not_yet_released 404 The endpoint exists, but the data behind it has not been published yet.
rate_limited 429 The key used up its calls for this minute or this day.
validation_error 422 A parameter was missing or had the wrong type or format.
invalid_email 422 An email address in the request body is not valid.
invalid_download_token 403 The download link is malformed or its signature does not match.
download_link_expired 403 Download links are short-lived and this one has expired.
unknown_plan 404 No plan matches the lookup key sent to checkout.
unknown_product 404 No one-time product matches the name in the order.
no_stripe_customer 409 The organization has no billing record yet, so there is no billing portal to open.
http_error 400 A request failed for a reason without a more specific code.