Orakel Docs
API reference

Account

API key usage and health

GET/api/municipalitiesAPI key

List Norwegian municipalities

Returns all Norwegian municipalities grouped by county. Optionally filter to a single county with ?county=XX (2-digit county code).

countystringoptional

2-digit Norwegian county code (e.g. '03' for Oslo).

/^\d{2}$/

200Successful response.
401Missing or invalid API key.
402Trial expired. Upgrade required.
429Rate limit or quota exceeded.
GET/api/health

API health check

Returns { status: 'ok' } when the API is reachable. Pass the X-Sync-Secret header to include DB diagnostics and sync status.

200Successful response.
GET/api/keys/usageAPI key

Get API key usage

Returns the caller's own tier, limits (rate/daily/monthly), and current usage counters with reset timestamps.

200Successful response.
401Missing or invalid API key.
402Trial expired. Upgrade required.
429Rate limit or quota exceeded.