Documentation menu
Getting started
QuickstartCookbook
OverviewNew permit leadsHighest-value permitsFurnace and rewire permitsPermits near a pointMegaproject pipelineProjects near a siteZoning at an addressEverything at one addressEndpoints
GET/zoneGET/geocodeGET/reverse-geocodeGET/zoningGET/sourcesGET/sources/coverageGET/contractor/statsGET/contractor/coverageGET/contractorGET/propertyGET/address/normalizeGET/opening_soonGET/openingGET/businessGET/business/statsGET/business/coverageGET/permit/feedGET/contractor/{name_normalized}GET/permitGET/inspectionGET/licenceGET/development_permitGET/planning_applicationGET/assessmentGET/major_projectGET/permit/statsGET/inspection/statsGET/licence/statsGET/development_permit/statsGET/planning_application/statsGET/assessment/statsGET/major_project/statsGET/permit/coverageGET/inspection/coverageGET/licence/coverageGET/development_permit/coverageGET/planning_application/coverageGET/assessment/coverageGET/major_project/coverageGET/permit/{record_id}/historyGET/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}Search planning applications
Parameters
| Parameter | Type | Description | |
|---|---|---|---|
municipality | string | optional | Filter to one city by its slug, e.g. 'new_westminster', 'toronto', 'north_vancouver_city'. Exact match. This is the city filter for BuildData datasets (permits, development permits, planning applications, inspections); call /{entity_type}/coverage for the list of valid slugs. The 'city' param is accepted as an alias here. (For the US liquor/healthcare/tank datasets, 'city' is instead a distinct filter and 'municipality' does not apply.) |
q | string | optional | Full-text search across the indexed fields of the record, including names (business, establishment, vendor, contractor) wherever the dataset carries them, e.g. q=brewery or q="Iron Hill". This is the name search: there is no separate name= parameter, and it works on every plan including free. It matches the BUSINESS or trade name, the address, city, county and licence/permit number. It does NOT match an owner, licensee or applicant's personal name: these datasets carry public business records only and never store an individual's name, so searching for a person returns nothing. Space-separated words require all terms (e.g. "wood panel"). Use OR to match any term ("wood OR panel OR acoustic"), quotes for exact phrases ("supply arrangement"), and a leading minus to exclude ("software -hardware"). |
status | string | optional | Filter by status. Contracts/tenders: Active, Expired, Cancelled, Open (exact). Permits: use a status_canonical value instead (issued, in_review, completed, expired, cancelled, unknown). |
status_canonical | string | optional | Normalized permit status: issued, in_review, completed, expired, cancelled, unknown |
city | string | optional | Filter by city. For the US liquor/healthcare/storage-tank datasets this is a distinct filter (exact, case-insensitive). For all other datasets it is an alias for municipality. |
issued_after | string | optional | Filter by date >= YYYY-MM-DD (issued_date). Aliases: date_from, date_after |
issued_before | string | optional | Filter by date <= YYYY-MM-DD. Aliases: date_to, date_before |
lat | number | optional | Latitude for proximity search. Send with lng. |
lng | number | optional | Longitude for proximity search. Send with lat. |
radius_km | number | optional | Radius in km, 0.1 to 25. Optional: lat and lng with no radius search 1 km around the point. The radius actually applied is returned as radius_km in the response, so a default is never silent. For every record at one street address rather than everything near it, use /property. |
sort_by | string | optional | Sort field: published (publication_date, tenders only), date (event date; this is award_date for contracts/awards), value (the entity's value field), closing (closing_date for tenders) |
sort_order | string | optional | Sort order: asc or desc |
limit | integer | optional | |
offset | integer | optional | |
cursor | string | optional | Pagination cursor from next_cursor in a previous response. Use instead of offset for deep pagination. |
Request
curl --request GET \
--url 'https://builddata-canadian-construction-data-api.p.rapidapi.com/planning_application' \
--header 'x-rapidapi-host: builddata-canadian-construction-data-api.p.rapidapi.com' \
--header 'x-rapidapi-key: YOUR_RAPIDAPI_KEY'import requests
url = "https://builddata-canadian-construction-data-api.p.rapidapi.com/planning_application"
headers = {"x-rapidapi-host": "builddata-canadian-construction-data-api.p.rapidapi.com", "x-rapidapi-key": "YOUR_RAPIDAPI_KEY"}
resp = requests.get(url, headers=headers)
print(resp.json())const res = await fetch("https://builddata-canadian-construction-data-api.p.rapidapi.com/planning_application", {
headers: {
"x-rapidapi-host": "builddata-canadian-construction-data-api.p.rapidapi.com",
"x-rapidapi-key": "YOUR_RAPIDAPI_KEY",
},
});
const data = await res.json();
console.log(data);<?php
$ch = curl_init("https://builddata-canadian-construction-data-api.p.rapidapi.com/planning_application");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"x-rapidapi-host: builddata-canadian-construction-data-api.p.rapidapi.com",
"x-rapidapi-key: YOUR_RAPIDAPI_KEY",
]);
echo curl_exec($ch);require "net/http"
require "uri"
uri = URI("https://builddata-canadian-construction-data-api.p.rapidapi.com/planning_application")
req = Net::HTTP::Get.new(uri)
req["x-rapidapi-host"] = "builddata-canadian-construction-data-api.p.rapidapi.com"
req["x-rapidapi-key"] = "YOUR_RAPIDAPI_KEY"
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.bodypackage main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://builddata-canadian-construction-data-api.p.rapidapi.com/planning_application", nil)
req.Header.Add("x-rapidapi-host", "builddata-canadian-construction-data-api.p.rapidapi.com")
req.Header.Add("x-rapidapi-key", "YOUR_RAPIDAPI_KEY")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}import java.net.URI;
import java.net.http.*;
HttpRequest req = HttpRequest.newBuilder()
.uri(URI.create("https://builddata-canadian-construction-data-api.p.rapidapi.com/planning_application"))
.header("x-rapidapi-host", "builddata-canadian-construction-data-api.p.rapidapi.com")
.header("x-rapidapi-key", "YOUR_RAPIDAPI_KEY")
.build();
HttpResponse<String> res = HttpClient.newHttpClient()
.send(req, HttpResponse.BodyHandlers.ofString());
System.out.println(res.body());Example response
{
"entity_type": "permit",
"count": 1,
"offset": 0,
"results": [
{
"record_id": "24 223023 PLB:00",
"municipality": "toronto",
"lat": 43.65401,
"lng": -79.42376,
"work": "Building Permit Related(PS)",
"status": "Permit Issued",
"address": "865 COLLEGE ST",
"description": "Plumbing - INTERIOR ALTERNATION OF 3RD FLOOR SUITE",
"issued_date": "2025-01-29",
"permit_type": "Plumbing(PS)",
"application_date": "2024-10-07",
"construction_value": null
}
]
}Response fields
One planning_application record. Measured over 5,867 live records sampled across municipalities. Percentages say how often each field is populated: sources publish different columns, so a field missing from a given record is normal rather than an error.
| Field | Type | Description |
|---|---|---|
address | string | Populated in 96% of sampled records. |
applicant | string | Populated in 17% of sampled records. |
applicant_name | string | Populated in 13% of sampled records. |
application_date | string | Populated in 94% of sampled records. |
application_subtype | string | Always present. |
application_type | string | Populated in 31% of sampled records. |
application_type_code | string | Populated in 10% of sampled records. |
application_url | string | Populated in 12% of sampled records. |
category | string | Populated in 14% of sampled records. |
decision_date | string | Populated in 11% of sampled records. |
description | string | Populated in 84% of sampled records. |
fetched_at | string | When Nimbus last ingested this record. Bookkeeping, not source data. Always present. |
folder_type | string | Populated in 14% of sampled records. |
lat | string | Populated in 12% of sampled records. |
lng | string | Populated in 12% of sampled records. |
municipality | string | City slug. Call /{entity_type}/coverage for every slug in this dataset. Always present. |
neighborhood | string | Populated in 20% of sampled records. |
normalized_address | string | Address normalized for joining the same property across datasets. Populated in 96% of sampled records. |
permit_type | string | Populated in 26% of sampled records. |
pipeline_stage | string | Populated in 89% of sampled records. |
province | string | Always present. |
record_id | string | Stable identifier for this record. Pass it to the /{entity_type}/{record_id} endpoint. Always present. |
record_number | string | Populated in 93% of sampled records. |
status | string | Populated in 97% of sampled records. |
status_canonical | string | Status mapped onto a shared vocabulary. This is what the status_canonical filter matches. Populated in 97% of sampled records. |
ward | string | Populated in 24% of sampled records. |
97 more fields published by only one or two cities
Present on under 10% of records. Useful when you are working with a specific city, not something to rely on across the dataset.
| Field | Type | Populated |
|---|---|---|
additional_scope | string | 0.1% |
agent | string | 0.1% |
agent_name | string | 3.2% |
appealed | string | 0.5% |
application_number | integer | 3.4% |
application_scope | string | 3.2% |
application_type_fr | string | 3.4% |
approval_date | string | 1.2% |
approved_date | string | 1.1% |
approved_total_units | integer | 1.5% |
benchmark_days | integer | 3.4% |
benchmark_met | string | 3.4% |
character_area | string | 3.4% |
city_planner | string | 2.9% |
city_web | string | 1.7% |
community | string | 6.8% |
community_meeting_date | string | 0.8% |
community_plan | string | 3.4% |
condo_number | string | 0.1% |
construction_type | string | 2.0% |
contact | string | 1.7% |
contact_name | string | 3.2% |
council_decision_date | string | 0.7% |
council_meeting_date | string | 3.1% |
council_report_url | string | 0.3% |
current_land_use | string | 3.4% |
current_zoning | string | 3.2% |
days_to_process | integer | 3.4% |
deemed_complete_date | string | 5.2% |
demand_id | string | 3.4% |
detail_url | string | 3.4% |
district | string | 3.4% |
documents_link | string | 0.5% |
domain | string | 3.4% |
dwelling_units_created | string | 3.4% |
dwelling_units_lost | string | 3.4% |
engage_url | string | 2.8% |
existing_zoning | string | 0.9% |
folder_description | string | 6.8% |
folder_name | string | 3.4% |
folder_rsn | string | 3.4% |
folderrsn | integer | 3.4% |
geocode_failed | boolean | 0.5% |
gis_link | string | 3.4% |
heritage_designation | string | 0.1% |
inside_mtsa | string | 3.4% |
inspector | string | 3.4% |
intended_use | string | 2.1% |
issue_date | string | 0.2% |
issued_date | string | 1.3% |
latitude | string | 3.4% |
layer | string | 6.8% |
legal_description | string | 3.4% |
longitude | string | 3.4% |
lots | string | 3.4% |
major_use | string | 2.2% |
max_storeys | integer | 1.7% |
meeting_date | string | 0.0% |
mtsa_name | string | 3.4% |
municipality_name | string | 3.3% |
neighbourhood | string | 3.4% |
non_residential_gfa_m2 | integer | 3.4% |
normalized_business_name | string | 0.0% |
opa_number | string | 1.0% |
parent_folder_number | string | 1.5% |
planner | string | 6.7% |
planner_email | string | 3.4% |
planner_name | string | 3.3% |
postal | string | 4.9% |
proposed_land_use | string | 3.4% |
proposed_total_units | integer | 2.9% |
proposed_use | string | 6.0% |
proposed_use_code | string | 3.4% |
proposed_zoning | string | 3.2% |
public_meeting_date | string | 0.1% |
public_status_description | string | 2.8% |
published_date | string | 3.4% |
record_type | string | 3.4% |
reference_file | string | 0.3% |
regional_number | string | 0.1% |
registered_residential_lots | string | 0.0% |
residential_units | integer | 3.4% |
sector | string | 3.4% |
status_date | string | 3.4% |
subcategory | string | 3.4% |
subdivision_number | string | 0.2% |
title | string | 3.4% |
updated_date | string | 3.4% |
ward_id | integer | 3.4% |
ward_name | string | 3.4% |
ward_number | string | 3.4% |
web_link | string | 0.9% |
weblink | string | 3.4% |
year_of_application | integer | 3.4% |
year_quarter | string | 2.0% |
zba_number | string | 2.7% |
zone | string | 3.4% |
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?Subscribe on RapidAPI to get your key and start calling BuildData in minutes.
Get your API key →