Skip to Content
Hey Town Hall Data docs

Records

Places

Jurisdictions, who governs a point, and the software each government runs.

View as Markdown

Every public body held, from municipalities and regional districts to school districts and First Nations. A jurisdiction's id is what every other list takes as jurisdiction.

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

Jurisdictions

GET /v1/jurisdictions

List jurisdictions. 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.

Reference and playground for list jurisdictions

Filters
ParameterWhat it takes
regionA two-letter province or state code.
countryCA or US.
kindmunicipality, regional_district, school_district, first_nation, improvement_district, library, …
parentThe regional district or county a jurisdiction sits in.
nameWords in the name.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/jurisdictions
FieldTypeWhat it holds
idstringThe jurisdiction id (e.g. victoria, capital-regional-district).
kindstringmunicipality, regional_district, school_district, first_nation, county, township, special_district, …
namestring
name_frstring or null
countrystring or null
regionstring or null
parent_idstring or nullThe regional district or county it sits in.
populationnumber or null
time_zonestring or null
legal_formstring or null
websitestring or null
register_idsobjectIds registers give it, by scheme (census, GNIS, OCD, Wikidata, …).
has_boundaryboolean
ingest_profilestring or nullHow 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_atstring or nullWhen the body was dissolved, if it was.
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

GET /v1/jurisdictions/{id}

Retrieve a jurisdiction. One jurisdiction. Billed as one records request.

Reference and playground for retrieve a jurisdiction

Path: {id} such as victoria.

Who governs a point

GET /v1/jurisdictions/at

Who governs a point. 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.

Reference and playground for who governs a point

Filters
ParameterWhat it takes
lat (required)
lng (required)
Fields of each result, GET /v1/jurisdictions/at
FieldTypeWhat it holds
idstring
kindstring
namestring
countrystring or null
regionstring or null
area_kindstring
area_namestring or null
read_atstring or nullISO 8601 instant, UTC.

The software each government runs

GET /v1/platforms

List the software each government runs. The platform census: which vendor each government uses for meetings, permits, payments and more, verified. Billed as one records request a page. Filters: jurisdiction, region, country, kind, since.

Reference and playground for list the software each government runs

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
kindmeetings, permits, payments, garbage, parking, feeds, video.
sinceRecords read at or after this instant: what is new since your last read.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/platforms
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
kindstringmeetings, permits, payments, garbage, parking, feeds, video.
vendorstring
verified_atstring or nullISO 8601 instant, UTC.
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

Vendor tenants

Each meeting vendor's tenant matched to a government and verified: the vendor, its name for the tenant, its host, and how it was matched.

GET /v1/platform-tenants

List vendor tenants. Each meeting vendor's tenant matched to a government and verified by a read of it: the vendor census by tenant. Billed as one records request a page. Filters: jurisdiction, region, country, kind, since.

Reference and playground for list vendor tenants

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
kindThe vendor, such as legistar or civicweb.
sinceRecords read at or after this instant: what is new since your last read.

Pages with limit and cursor (pagination).

Fields of each result, GET /v1/platform-tenants
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
vendorstring
tenant_keystringThe vendor's own name for the tenant.
hoststring or null
match_methodstring or null
match_confidencenumber or null
verified_atstring or nullISO 8601 instant, UTC.
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

On this page