Skip to Content
Hey Town Hall Data docs
Documents

API reference · Documents

List defined terms

View as Markdown
GET
/v1/defined-terms

The terms a body's bylaws define (an 'accessory building', a 'protected tree'), each with the start of its definition, as printed. Billed as one records request a page. Filters: jurisdiction, region, country, term, since.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Query Parameters

jurisdiction?string

A jurisdiction id.

Match^[a-z0-9][a-z0-9-]{0,63}$
region?string

A two-letter province or state code.

country?string

CA or US.

term?string

Words in the defined term.

Length2 <= length <= 80
since?string

Records read at or after this instant: what is new since your last read.

limit?integer

Results a page, 1 to 100. Default 25.

cursor?string

next_cursor from the previous page.

Response Body

A page.

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/defined-terms'
Example Response
{  "query": {    "property1": null,    "property2": null  },  "as_of": "string",  "results": [    {      "id": "string",      "jurisdiction_id": "string",      "country": "string",      "region": "string",      "term": "string",      "definition": "string",      "source_url": "string",      "read_at": "string"    }  ],  "next_cursor": "string",  "environment": "sandbox"}

List bylaws GET

Bylaws by number, title, kind and adoption date. Billed as one records request a page. Filters: jurisdiction, region, country, kind, subject, from, to, since.

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.