Skip to Content
Hey Town Hall Data docs
Jurisdictions

API reference · Jurisdictions

Who governs a point

View as Markdown
GET
/v1/jurisdictions/at

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.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Query Parameters

lat*number
lng*number

Response Body

The jurisdictions, broadest kind first.

application/json
  1. response
query*

The filters as the API read them, defaults included.

as_of*string

ISO 8601 instant, UTC.

results*array<>
next_cursor*|

Pass as cursor for the next page; null on the last.

environment*string

sandbox answers carry fictional towns.

Value in"sandbox""live"
Example Request
curl -X GET 'https://data.heytownhall.com/v1/jurisdictions/at?lat=0&lng=0'
Example Response
{  "query": {    "property1": null,    "property2": null  },  "as_of": "string",  "results": [    {      "id": "string",      "kind": "string",      "name": "string",      "country": "string",      "region": "string",      "area_kind": "string",      "area_name": "string",      "read_at": "string"    }  ],  "next_cursor": "string",  "environment": "sandbox"}

List documents GET

The documents a government publishes on its own site, by kind (staff reports, budgets, plans, bylaws, notices), and whether their text is held. Billed as one records request a page. Filters: jurisdiction, region, country, kind, from, to, since.

Retrieve a jurisdiction GET

One jurisdiction. Billed as one records request.