Skip to Content
Hey Town Hall Data docs

Records

Development

Development applications, permits with their rules and fees, and road and utility works.

View as Markdown

What is being built, what it takes to build, and what is being dug up.

Development applications

GET /v1/applications

List development applications. Rezonings, development permits and subdivisions a government's tracker lists, with their stage. Billed as one records request a page. Filters: jurisdiction, region, country, kind, from, to, since.

Reference and playground for list development applications

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
kindThe application kind, such as rezoning.
fromOn or after this date (YYYY-MM-DD).
toOn or before this date (YYYY-MM-DD).
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/applications
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
titlestring
addressstring or null
folder_numberstring or null
application_kindstring or null
type_labelstring or null
statusstring or null
applied_onstring or nullYYYY-MM-DD.
stagestring or null
stage_sincestring or nullYYYY-MM-DD.
listed_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.

Permits, rules and fees

GET /v1/permits

List permits, their rules and fees. Each kind of permit a government issues: where to apply, the fee table as published, the timeline it states and its desk. Billed as one records request a page. Filters: jurisdiction, region, country, kind, since.

Reference and playground for list permits, their rules and fees

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
kindThe permit kind, such as building.
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/permits
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
kindstring
page_titlestring or null
portal_urlstring or null
portal_platformstring or null
fee_headingstring or null
fee_rowsanyThe fee table as read, rows of the page's own columns; null when the fee page changed since it was read.
fee_quotestring or null
fee_source_urlstring or null
fee_bylaw_numberstring or null
timeline_quotestring or null
desk_phonestring or nullThe permit desk's published number (an office, not a person).
desk_emailstring or null
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

Road and utility works

GET /v1/works

List road and utility works. Announced road and utility work, with its days and streets. Billed as one records request a page. Filters: jurisdiction, region, country, kind, from, to, since.

Reference and playground for list road and utility works

Filters
ParameterWhat it takes
jurisdictionA jurisdiction id.
regionA two-letter province or state code.
countryCA or US.
kindroad or utility.
fromOn or after this date (YYYY-MM-DD).
toOn or before this date (YYYY-MM-DD).
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/works
FieldTypeWhat it holds
idstring
jurisdiction_idstring
countrystring or null
regionstring or null
titlestring or null
kindstring or null
daysarray of string or null
from_daystring or nullYYYY-MM-DD.
to_daystring or nullYYYY-MM-DD.
hoursstring or null
streetsarray of string
source_urlstring or nullThe page, document, video or platform the record was read from.
read_atstring or nullWhen it was read.

On this page