A RESTful API for permit information using the BLDS data format
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
public
.gitignore
README.md
config.js
index.js
package.json

README.md

#Permit Data API

A RESTful API for permit information using the BLDS data format.

Base URL

http://openpermit.cloudapp.net/api/

HTTP Headers

To query permit, imspection or contractor data for a specific jurisdiction, you use a jurisdiction ID. To get a list of jurisdiction IDs, access the /jurisdictions endpoint.

Jurisdiction IDs are passed as an HTTP header called x-jurisdiction-id.

API Methods

Get Jurisdictions

  • Description: Retrieves a list of jurisdictions supplying data.
  • HTTP Method: GET
  • Path: /jurisdictions
[
  "alameda-0ad8aa80-e1cb",
  "deschutes_co-5b133ecf-43e2",
  "bernco-6772b345-399c"
]

Get Permits

  • Description: Retrieves a list of permits.
  • HTTP Method: GET
  • Path: /permits
Parameter Required
limit false

Get Permit

  • Description: Retrieves a specific permit record details.
  • HTTP Method: GET
  • Path: /permits/{permitnum}
Parameter Required
permitnum true

Get Permit Timeline

  • Description: Retrieves the history of a specific permit record.
  • HTTP Method: GET
  • Path: /permits/{permitnum}/timeline
Parameter Required
permitnum true

Get Permit Inspections

  • Description: Retrieves the inspections for a specific permit.
  • HTTP Method: GET
  • Path: /permits/{permitnum}/inspections
Parameter Required
permitnum true

Get Permit Contractors

  • Description: Retrieves the contractors for a specific permit.
  • HTTP Method: GET
  • Path: /permits/{permitnum}/contractors
Parameter Required
permitnum true

Get Inspections

  • Description: Retreives a list of inspections.
  • HTTP Method: GET
  • Path: /inspections
Parameter Required
limit false

Get Inpsection

  • Description: Retrieves details of a specific inspection.
  • HTTP Method: GET
  • Path: /inspections/{inspectionid}
Parameter Required
inspectionid true

Get Contractors

  • Description: Retrieves a list of contractors.
  • HTTP Method: GET
  • Path: /contractors
Parameter Required
limit false

Get Contractor

  • Description: Retrieves details for a specific contractor
  • HTTP Method: GET
  • Path: /contractors/{contractorid}
Parameter Required
contractorid true