Documentation menu

Getting started

Guides

Authentication Filtering & pagination Export to CSV Monitor new records Errors

Cookbook

Overview New permit leads Highest-value permits Furnace and rewire permits Permits near a point Megaproject pipeline Projects near a site Zoning at an address Everything at one address

Endpoints

GET/zone GET/geocode GET/reverse-geocode GET/zoning POST/permit/estimate GET/contractor/stats GET/contractor/coverage GET/contractor GET/property GET/address/normalize GET/opening_soon GET/opening GET/business GET/business/stats GET/business/coverage GET/contractor/{name_normalized}GET/permit GET/inspection GET/licence GET/development_permit GET/planning_application GET/assessment GET/major_project GET/heritage_status GET/occupancy_permit GET/permit/stats GET/inspection/stats GET/licence/stats GET/development_permit/stats GET/planning_application/stats GET/assessment/stats GET/major_project/stats GET/heritage_status/stats GET/occupancy_permit/stats GET/permit/coverage GET/inspection/coverage GET/licence/coverage GET/development_permit/coverage GET/planning_application/coverage GET/assessment/coverage GET/major_project/coverage GET/heritage_status/coverage GET/occupancy_permit/coverage GET/permit/{record_id}/history GET/permit/{record_id}GET/inspection/{record_id}GET/licence/{record_id}GET/development_permit/{record_id}GET/planning_application/{record_id}GET/assessment/{record_id}GET/major_project/{record_id}GET/heritage_status/{record_id}GET/occupancy_permit/{record_id}

Docs / Reference / Pro: estimated construction value for 1..N permits (by record id or attributes)

Pro: estimated construction value for 1..N permits (by record id or attributes)

POST/permit/estimate

Estimated construction value for permits that carry none. Send up to 100 per call, as record ids from /permit or as attribute objects for permits you hold yourself. Each result has a low, median and high estimate in dollars, a confidence of high or low, and the model that produced it. Paid plans only; a free key gets 403.

Request body

Field	Type	Description
`record_ids`	`array of string`	Permit record ids, as /permit returns them.
`permits`	`array of object`	Permits described by their attributes: municipality, permit_type_canonical, description, area_m2 or area_ft2, dwelling_units, proposed_use, lat, lng. Send what you have; more scope gives a tighter range.

Request

curl --request POST \
  --url 'https://api.builddata.ca/permit/estimate' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"permits": [{"municipality": "calgary", "permit_type_canonical": "new_construction", "description": "New single detached dwelling with attached garage", "area_m2": 210}]}'

import requests

url = "https://api.builddata.ca/permit/estimate"
headers = {"X-API-Key": "YOUR_API_KEY"}
body = {
  "permits": [
    {
      "municipality": "calgary",
      "permit_type_canonical": "new_construction",
      "description": "New single detached dwelling with attached garage",
      "area_m2": 210
    }
  ]
}
resp = requests.post(url, headers=headers, json=body)
print(resp.json())

const res = await fetch("https://api.builddata.ca/permit/estimate", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "permits": [
    {
      "municipality": "calgary",
      "permit_type_canonical": "new_construction",
      "description": "New single detached dwelling with attached garage",
      "area_m2": 210
    }
  ]
}),
});
console.log(await res.json());

Example response

{
  "count": 1,
  "results": [
    {
      "input": {
        "municipality": "calgary",
        "permit_type_canonical": "new_construction",
        "description": "New single detached dwelling with attached garage",
        "area_m2": 210
      },
      "estimate": {
        "low": 101237,
        "median": 290992,
        "high": 592483,
        "confidence": "high",
        "basis": "description model"
      }
    }
  ]
}

Errors

Every error returns {"detail": "…"}, a sentence naming what was wrong and, where there is one, the fix.

Status	When
`400`	The request is understood but cannot be served as asked, e.g. offset above 9500, or cursor combined with sort_by=value. The message names the fix.
`403`	Missing or invalid API key.
`404`	No such endpoint, or no record with that id.
`422`	A parameter is invalid: an unknown city slug, an impossible date, a limit above 500, an unrecognised sort field, or a misspelled parameter name. The message names the parameter and, where there is one, the nearest valid value.
`429`	Rate limit or plan quota exceeded.
`500`	Unexpected server error.
`504`	The query took too long. Narrow it with a municipality or a date range.

Ready to build?Create a free key and start calling BuildData in minutes. No card required.

Get your API key →