Skip to Content
Hey Town Hall Data docs
Jurisdictions

API reference · Jurisdictions

Retrieve a jurisdiction

View as Markdown
GET
/v1/jurisdictions/{id}

One jurisdiction. Billed as one records request.

Authorization

bearerAuth
headerAuthorizationBearer <token>

htd_test_ (sandbox, free, fictional towns) or htd_live_ (live, billed) key.

Path Parameters

id*string
Match^[a-z0-9][a-z0-9-]{0,63}$

Response Body

The record.

application/json
  1. response
id*string

The jurisdiction id (e.g. victoria, capital-regional-district).

kind*string

municipality, regional_district, school_district, first_nation, county, township, special_district, …

name*string
name_fr*string|null
country*string|null
region*string|null
parent_id*|

The regional district or county it sits in.

population*number|null
time_zone*string|null
legal_form*string|null
website*string|null
register_ids*

Ids registers give it, by scheme (census, GNIS, OCD, Wikidata, …).

has_boundary*boolean
ingest_profile*|

How much of it is read: resident_full (everything, for residents and business), records_full (every public record), meetings_only (its meetings alone). A family not read is absent, never "none".

dissolved_at*|

When the body was dissolved, if it was.

source_url*|

The page, document, video or platform the record was read from.

read_at*|

When it was read.

environment*string
Value in"sandbox""live"
Example Request
curl -X GET 'https://data.heytownhall.com/v1/jurisdictions/string'
Example Response
{  "id": "string",  "kind": "string",  "name": "string",  "name_fr": "string",  "country": "string",  "region": "string",  "parent_id": "string",  "population": 0,  "time_zone": "string",  "legal_form": "string",  "website": "string",  "register_ids": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "has_boundary": true,  "ingest_profile": "string",  "dissolved_at": "string",  "source_url": "string",  "read_at": "string",  "environment": "sandbox"}

Who governs a point GET

Every jurisdiction whose boundary covers the point: the municipality, the regional district or county, the school district, the health authority and so on. Billed as one records request.

List jurisdictions GET

Every public body held: municipalities, regional districts and counties, school districts, First Nations, special districts. Each with its kind, parent, population, time zone, register ids and whether its boundary is held. Billed as one records request a page. Filters: region, country, kind, parent, name.