Sign in

v4

latestOpenAPI 3.1.0Proprietary2026-08-034715226.2 KB
metadata

List jurisdictions

Public metadata — no API key required.

Returns all active jurisdictions. By default, only real geographic jurisdictions (US states + Canadian provinces, scope=state) are returned — cross-cutting federal sources and sub-state regional feeds are filtered out so customer pickers stay clean.

Use ?scope=federal to list cross-cutting federal sources (EIA, FHWA, WZDX_NPS), ?scope=regional for sub-state feeds (511SF, WZDX_AUSTIN, ...), or ?scope=all to return everything.

Each row's group_id (when present) points at a record in GET /jurisdictions/groups: a state's primary feed plus its WZDx and sub-state siblings collapsed under one umbrella id.

get/jurisdictions

Query parameters

scope'state' | 'federal' | 'regional' | 'all'

Filter by jurisdiction scope; default state

Response

Array of jurisdictions

codestring required

Identifier used everywhere else in the API (source, jurisdiction, webhook filters, etc.). Two-letter postal codes for US states and Canadian provinces; WZDX_<STATE> for the parallel WZDx feed; ad-hoc codes for sub-state and federal sources (511SF, EIA, FHWA, WZDX_NPS, ...).

countrystring required

ISO 3166-1 alpha-2 (US, CA, DE, ...).

group_idstring nullable

When non-null, points at a record in GET /jurisdictions/groups — the canonical bundle that includes this row's primary code plus its WZDx / CWZ / regional siblings. Querying ?jurisdiction=<primary> on /events or /features auto-expands to all members.

is_activeboolean required
last_sync_atstring date-time nullable
namestring required
official_namestring nullable
scope'state' | 'federal' | 'regional' required

state is the default — real geographic jurisdictions (US states, Canadian provinces). federal covers cross-cutting national sources (EIA, FHWA, WZDX_NPS). regional covers sub-state feeds (511SF, WZDX_AUSTIN, WZDX_MCDOT, WZDX_STC_MO). The default response from GET /jurisdictions is scope=state only.