Documentation menu
API reference

Permits and cases

permit

Building and trade permits, with their decisions.

The permit object

objectstring
The object's type. Always permit.
idstring
A permit id.
numberstring
Permit number, as published. Null when not published.
typeobject
Permit type, as published. Null when not published.
Show fields
codestring
Code, as published.
descriptionstring
Meaning of the code, as published. Null when not published.
standardstring
Standard value, shared across jurisdictions. Null when not yet classified.
statusobject
Status, as published.
Show fields
codestring
Code, as published.
descriptionstring
Meaning of the code, as published. Null when not published.
standardstring
Standard value, shared across jurisdictions. Null when not yet classified.
jurisdictionobject
The jurisdiction that issues the permit.
Show fields
idstring
A jurisdiction id.
namestring
The jurisdiction's common name.
typestring
Kind of jurisdiction, in local terms, such as county, parish, city or town.
fipsstring
The Census GEOID. Null outside the US.
hrefstring
The object's path in the API.
withinarray of objects
The jurisdictions that contain jurisdiction, largest first.
Show fields
idstring
A jurisdiction id.
namestring
The jurisdiction's common name.
tierstring
Level of government. One of national, region (a state or province), subregion (a county or district) or local (a city, town, village or township).
typestring
Kind of jurisdiction, in local terms, such as county, parish, city or town.
fipsstring
The Census GEOID. Null outside the US.
agencyobject
The office that handled the permit. Null when not published.
Show fields
namestring
Office name, as published.
typestring
Office type, such as building, planning, zoning_board or commission. Null when not published.
descriptionstring
Description of the work, as published. Null when not published.
parcelsarray of objects
Parcels the permit concerns. Empty when none are matched, which is common when only an address is published.
Show fields
idstring
A parcel id.
numberstring
Primary parcel number. Null when not published.
hrefstring
The object's path in the API.
addressesarray of objects
Addresses on the permit. Empty when none are published.
Show fields
rawstring
Full address on one line: every line it is published on, in order, joined with a comma.
recipientstring
Care-of or attention line, as published. Null when there is none.
street_line_1string
First street line: house number and street, or a PO box. Null when not published.
street_line_2string
Second street line: apartment, suite, unit or building. Null when there is none.
street_numberstring
House number. Null when not published.
street_namestring
Street name, without its type. Null when not published.
unitstring
Unit number. Null when there is none.
localitystring
City, town or village. Null when not published.
regionstring
State, as its two-letter abbreviation. Null when not published.
postal_codestring
ZIP or postal code. Null when not published.
pointobject
Location of the address point, as published. Null when not published.
Show fields
latnumber
Latitude, in WGS 84.
lonnumber
Longitude, in WGS 84.
partiesarray of objects
People and companies named on the permit. Empty when none are published.
Show fields
namestring
Name, as published.
rolestring
Role, such as applicant, owner, contractor, architect, engineer or representative. Null when not published.
organizationstring
Company or organization represented. Null when not published.
licensestring
License number. Null when not published.
datesobject
Key dates. A null date means not published, not that the step did not happen.
Show fields
applieddate
Application date. Null when not published.
issueddate
Issue date. Null when not issued or not published.
decideddate
Decision date: the issue date, or the date of a denial. Null when not decided.
expiresdate
Expiration date. Null when not published.
completeddate
Completion date of the work. Null when not published.
valuationobject
Declared value of the work. Null when not published.
Show fields
amountnumber
Amount, in currency.
currencystring
ISO 4217 currency code.
feesarray of objects
Fees, by category. Empty when none are published.
Show fields
categorystring
Fee category, such as building, zoning, plan_review or impact.
totalnumber
Amount charged. Null when not published.
paidnumber
Amount paid. Null when not published.
unpaidnumber
Amount outstanding. Null when not published.
waivednumber
Amount waived. Null when not published.
currencystring
ISO 4217 currency code. Null when no amount is published.
decisionobject
The decision: issued on its issue date, or refused. Null while the permit is pending.
Show fields
outcomeobject
Outcome, as published. On a permit this is its status, so a permit issued and since expired reads Expired.
Show fields
codestring
Code, as published.
descriptionstring
Meaning of the code, as published. Null when not published.
standardstring
Standard value, shared across jurisdictions. Null when not yet classified.
decided_ondate
Decision date. Null when not published.
effective_fromdate
Effective date. Null when not published.
effective_todate
End date. Null while in effect.
conditionsarray of objects
Conditions of approval, as published. Empty when there are none. A listed condition is not necessarily met.
Show fields
textstring
Condition text, as published.
scopestring
What the condition applies to, as published. Null when not stated.
timingstring
When the condition must be met, such as before_permit, before_occupancy or ongoing. Null when not stated.
duedate
Due date. Null when not stated.
documentobject
The published record. Null when not recorded.
Show fields
urlstring
URL of the published record. Null when not published.
retrieveddate
Date the record was retrieved. Null when not recorded.
as_ofdate
Date of the most recent update to this permit. Null when not recorded.
hrefstring
The object's path in the API.

Endpoints

case

Zoning and development cases: rezonings, variances, special uses, subdivisions and site plans, with their decisions.

The case object

objectstring
The object's type. Always case.
idstring
A case id.
numberstring
Case number, as published. Null when not published.
typeobject
Case type, as published: a rezoning, variance, special use, subdivision or site plan. Null when not published.
Show fields
codestring
Code, as published.
descriptionstring
Meaning of the code, as published. Null when not published.
standardstring
Standard value, shared across jurisdictions. Null when not yet classified.
statusobject
Status, as published.
Show fields
codestring
Code, as published.
descriptionstring
Meaning of the code, as published. Null when not published.
standardstring
Standard value, shared across jurisdictions. Null when not yet classified.
jurisdictionobject
The jurisdiction that decides the case.
Show fields
idstring
A jurisdiction id.
namestring
The jurisdiction's common name.
typestring
Kind of jurisdiction, in local terms, such as county, parish, city or town.
fipsstring
The Census GEOID. Null outside the US.
hrefstring
The object's path in the API.
withinarray of objects
The jurisdictions that contain jurisdiction, largest first.
Show fields
idstring
A jurisdiction id.
namestring
The jurisdiction's common name.
tierstring
Level of government. One of national, region (a state or province), subregion (a county or district) or local (a city, town, village or township).
typestring
Kind of jurisdiction, in local terms, such as county, parish, city or town.
fipsstring
The Census GEOID. Null outside the US.
agencyobject
The office or board that handled the case. Null when not published.
Show fields
namestring
Office name, as published.
typestring
Office type, such as building, planning, zoning_board or commission. Null when not published.
descriptionstring
Description of the request, as published. Null when not published.
parcelsarray of objects
Parcels the case concerns. Empty when none are matched, which is common when only an address is published.
Show fields
idstring
A parcel id.
numberstring
Primary parcel number. Null when not published.
hrefstring
The object's path in the API.
addressesarray of objects
Addresses on the case. Empty when none are published.
Show fields
rawstring
Full address on one line: every line it is published on, in order, joined with a comma.
recipientstring
Care-of or attention line, as published. Null when there is none.
street_line_1string
First street line: house number and street, or a PO box. Null when not published.
street_line_2string
Second street line: apartment, suite, unit or building. Null when there is none.
street_numberstring
House number. Null when not published.
street_namestring
Street name, without its type. Null when not published.
unitstring
Unit number. Null when there is none.
localitystring
City, town or village. Null when not published.
regionstring
State, as its two-letter abbreviation. Null when not published.
postal_codestring
ZIP or postal code. Null when not published.
pointobject
Location of the address point, as published. Null when not published.
Show fields
latnumber
Latitude, in WGS 84.
lonnumber
Longitude, in WGS 84.
partiesarray of objects
People and companies named on the case. Empty when none are published.
Show fields
namestring
Name, as published.
rolestring
Role, such as applicant, owner, contractor, architect, engineer or representative. Null when not published.
organizationstring
Company or organization represented. Null when not published.
licensestring
License number. Null when not published.
datesobject
Key dates. A null date means not published, not that the step did not happen.
Show fields
applieddate
Filing date. Null when not published.
decideddate
Decision date. Null when not decided.
expiresdate
Expiration date of the approval. Null when not published.
completeddate
Date the case was closed. Null when not published.
feesarray of objects
Fees, by category. Empty when none are published.
Show fields
categorystring
Fee category, such as building, zoning, plan_review or impact.
totalnumber
Amount charged. Null when not published.
paidnumber
Amount paid. Null when not published.
unpaidnumber
Amount outstanding. Null when not published.
waivednumber
Amount waived. Null when not published.
currencystring
ISO 4217 currency code. Null when no amount is published.
decisionobject
The decision. Null while the case is pending.
Show fields
outcomeobject
Outcome, as published. On a permit this is its status, so a permit issued and since expired reads Expired.
Show fields
codestring
Code, as published.
descriptionstring
Meaning of the code, as published. Null when not published.
standardstring
Standard value, shared across jurisdictions. Null when not yet classified.
decided_ondate
Decision date. Null when not published.
effective_fromdate
Effective date. Null when not published.
effective_todate
End date. Null while in effect.
conditionsarray of objects
Conditions of approval, as published. Empty when there are none. A listed condition is not necessarily met.
Show fields
textstring
Condition text, as published.
scopestring
What the condition applies to, as published. Null when not stated.
timingstring
When the condition must be met, such as before_permit, before_occupancy or ongoing. Null when not stated.
duedate
Due date. Null when not stated.
zoningarray of objects
Zoning classifications the case concerns. Empty when there are none.
Show fields
idstring
A zoning id.
codestring
District code, as published.
rolestring
Role in the case. One of from (the current district in a rezoning), to (the requested district) or subject (the district, with no change requested).
hrefstring
The object's path in the API.
documentobject
The published record. Null when not recorded.
Show fields
urlstring
URL of the published record. Null when not published.
retrieveddate
Date the record was retrieved. Null when not recorded.
as_ofdate
Date of the most recent update to this case. Null when not recorded.
hrefstring
The object's path in the API.

Endpoints

Next steps

GET /permit

Search permits

Continue