Get started

Early access

The API is live and free to use, but it's in early access. We're still shaping it around what people ask of it, so parts of v1 will change before it's frozen.

What may change

Until early access ends, any part of the request and response shape can change, including:

  • Routes. Endpoints may be renamed, merged into others or removed.
  • Parameters. Names, defaults and accepted values may change.
  • Responses. Fields may be added, renamed or moved.
  • Ids. Measure, dataset, location and crosswalk ids may be renamed.

Not for production yet

Build against the API, but expect to update your code. If something you rely on would be hard to change, open an issue so we can weigh it before we change it.

What stays the same

  • Area codes. Official codes like E08000025 are the publishers' own, so they don't change with the API.
  • Published values. Values come back as they were published. A correction gives a new Atlas release, not a quiet edit.
  • Read-only, no keys. The data is openly licensed and needs no API key.

Keeping up

The OpenAPI description always describes the API as it's currently served, and the reference is generated from it. The changelog lists changes you might notice and marks the ones that break existing requests. Each response's atlasRelease tells you when the data behind it has changed.

get/openapi.yamlGet the OpenAPI specget/atlas-releaseGet the current release