Skip to Content
Hey Town Hall Data docs

Records

Coverage

What the data holds and where: two endpoints that need no key and are never billed.

View as Markdown

Coverage today is British Columbia. The United States is being added.

These two endpoints say what the live data holds. They need no key, are never billed and do not count against a rate limit. They always read the live data, never the sandbox, and their answers are cached for an hour.

Counts and coverage

GET /v1/stats

What the data holds. Counts and the span of the live data. No key needed; not billed.

Reference and playground for what the data holds. No key needed.

Fields, GET /v1/stats
FieldTypeWhat it holds
jurisdictionsnumber
jurisdictions_with_meetingsnumber
meetingsnumber
first_meeting_onstring or nullYYYY-MM-DD.
last_meeting_onstring or nullYYYY-MM-DD.
read_atstring or nullISO 8601 instant, UTC.
countriesarray of string
regionsarray of string

GET /v1/coverage

Coverage by jurisdiction. Each jurisdiction with how much of it is read (ingest_profile), its meetings and their span, its meeting vendors, and what is held now in each family (held): what is held, never what a body is expected to have. Every family is offered for every country. No key needed; not billed.

Reference and playground for coverage by jurisdiction. No key needed.

Filters
ParameterWhat it takes
regionA two-letter province or state code.
countryCA or US.
kindThe record kind; each endpoint says which kinds it holds.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/coverage
FieldTypeWhat it holds
idstring
kindstring
namestring
countrystring or null
regionstring or null
meetingsnumber or null
first_meeting_onstring or nullYYYY-MM-DD.
last_meeting_onstring or nullYYYY-MM-DD.
read_atstring or nullISO 8601 instant, UTC.
meeting_vendorsarray of string
ingest_profilestring or null
heldobjectRecords held now, by family (meetings, motions, recordings, documents, bylaws, financial_reports, posts, permits, officials, departments, platforms): what is held, never what is expected. Posts count only those still published.

On this page