Docs
Errors
Errors are application/problem+json documents. Their type is a link to a section of this
page.
Each one has type, title, status, detail and
instance (the path you asked for), a request_id to quote if you report a problem, and often
a hint. Error responses are never cached.
| Type | Status | Title |
|---|---|---|
| not-found | 404 | Not found |
| unknown-dataset | 404 | Unknown dataset |
| unknown-version | 404 | Unknown version |
| unknown-file | 404 | Not found |
| unknown-format | 404 | Unknown format |
| unknown-site | 404 | Unknown site |
| rate-limited | 429 | Too many requests |
| data-unavailable | 503 | Data temporarily unavailable |
| internal | 500 | Internal error |
not-found 404
- Title
- Not found
- When
- The path is not an API endpoint.
- What to do
- Start from GET /v1, which links to the catalog and status.
unknown-dataset 404
- Title
- Unknown dataset
- When
- No dataset with that id has been published on this site.
- What to do
- GET /v1/catalog lists the dataset ids. A dataset in the catalog on this website may not be published yet.
unknown-version 404
- Title
- Unknown version
- When
- The version after @ is malformed, was never published, or was quarantined by validation.
- What to do
- GET /v1/{dataset}/versions lists the current, previous and snapshot versions.
unknown-file 404
- Title
- Not found
- When
- The series, location, partition or file is not part of that version.
- What to do
- GET /v1/{dataset}/locations lists every series with its locations (or, for tables, every partition).
unknown-format 404
- Title
- Unknown format
- When
- A data path has no format extension.
- What to do
- End the path with .json or .csv.
unknown-site 404
- Title
- Unknown site
- When
- The request reached the API on a hostname that is not one of the sites.
- What to do
- Use https://api.<domain>. On a local or preview API, add ?site=<id>.
rate-limited 429
- Title
- Too many requests
- When
- More than 120 requests in 60 seconds from one IP address.
- What to do
- Wait for the Retry-After header (60 seconds), cache with ETags, or fetch the bulk download once instead of many small files.
internal 500
- Title
- Internal error
- When
- Something failed on our side.
- What to do
- Retry later. Include the request_id from the response if you report it.