Documentation

Everything you need to make your first request and keep your data current.

Quickstart

Create a key in your account, then send it in the x-api-key header.

curl "https://country.atlasref.dev/api/v1/countries/DE" \
  -H "x-api-key: $ATLASREF_KEY"

Limits

Each key has a rate limit and a monthly quota.

Responses carry X-Quota-Limit and X-Quota-Remaining. When the quota is used up, requests return 429 with quota_exceeded and the time it resets.

Endpoints

Every product host proxies the same API under /api.

Country
GET /v1/countriesList countries
GET /v1/countries/{code}One country with names in many languages
GET /v1/countries/{code}/divisionsAdministrative divisions from national sources
GET /v1/search?q=Search regions by name prefix
Holiday
GET /v1/holidays?date=Holidays on a date
GET /v1/countries/{code}/holidays?year=Holidays of a country and year
GET /v1/holidays/coverageCoverage and verification status per country
Currency
GET /v1/currenciesList currencies
GET /v1/currencies/{code}One currency with minor units and countries
Locale
GET /v1/localesList locales
GET /v1/locales/{tag}Date, number and measurement conventions
Platform
GET /v1/sourcesSources with licence, attribution and freshness
GET /v1/changes?since=Change feed after a cursor
GET /v1/snapshotsPublished snapshots
POST /v1/webhooksSubscribe a URL to signed notifications
GET /v1/exports/latestLatest file bundle with signed download links

Start building with atlasref

Create a free account and make your first request in a minute.

Get your API key