Documentation menu
Docs / Reference / Search major capital projects

Search major capital projects

GET/major_project

Parameters

ParameterTypeDescription
municipalitystringoptionalFilter 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.)
qstringoptionalFull-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").
categorystringoptionalProcurement category: CNST, GD, SRV, SRVTGD. For recalls: product category (e.g. 'Baby products', 'Toys and games'). For healthcare: facility category (acute, long_term, home, behavioral, outpatient, specialty). For storage tanks: record type (tank or release).
statusstringoptionalFilter by status. Contracts/tenders: Active, Expired, Cancelled, Open (exact). Permits: use a status_canonical value instead (issued, in_review, completed, expired, cancelled, unknown).
sectorstringoptionalCanonical sector (major_project): transit, roads_bridges, education, healthcare, residential, energy, industrial, infrastructure, municipal, recreation_culture, commercial, institutional. Spans both official languages and every source inventory.
citystringoptionalFilter 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.
value_minnumberoptionalMinimum value, applied to the entity's value field (construction_value for permits, contract_value for contracts, agreement_value for grants, monetary_amount for contributions, total_co2e for emissions, assessed_value for assessments). Ignored for entity types with no monetary field.
value_maxnumberoptionalMaximum value; same per-entity field mapping as value_min. Ignored for entity types with no monetary field.
issued_afterstringoptionalFilter by date >= YYYY-MM-DD (issued_date). Aliases: date_from, date_after
issued_beforestringoptionalFilter by date <= YYYY-MM-DD. Aliases: date_to, date_before
latnumberoptionalLatitude for proximity search. Send with lng.
lngnumberoptionalLongitude for proximity search. Send with lat.
radius_kmnumberoptionalRadius 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_bystringoptionalSort 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_orderstringoptionalSort order: asc or desc
limitintegeroptional
offsetintegeroptional
cursorstringoptionalPagination 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/major_project' \
  --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/major_project"
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/major_project", {
  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/major_project");
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/major_project")
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.body
package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://builddata-canadian-construction-data-api.p.rapidapi.com/major_project", 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/major_project"))
    .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 major_project record. Measured over 2,742 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.

FieldTypeDescription
addressstringPopulated in 46% of sampled records.
approval_statusstringPopulated in 15% of sampled records.
architectstringPopulated in 13% of sampled records.
areastringPopulated in 61% of sampled records.
clean_energybooleanPopulated in 15% of sampled records.
completion_datestringPopulated in 85% of sampled records.
construction_subtypestringPopulated in 15% of sampled records.
construction_typestringAlways present.
cost_bandstringPopulated in 74% of sampled records.
descriptionstringPopulated in 85% of sampled records.
developerstringPopulated in 38% of sampled records.
estimated_costnumberPopulated in 74% of sampled records.
fetched_atstringWhen Nimbus last ingested this record. Bookkeeping, not source data. Always present.
first_entry_datestringPopulated in 15% of sampled records.
geocode_precisionstringPopulated in 17% of sampled records.
green_buildingbooleanPopulated in 15% of sampled records.
indigenous_involvementbooleanPopulated in 15% of sampled records.
last_updatestringPopulated in 15% of sampled records.
latnumberPopulated in 97% of sampled records.
lngnumberPopulated in 97% of sampled records.
ministrystringPopulated in 70% of sampled records.
municipalitiesarrayPopulated in 15% of sampled records.
municipalitystringCity slug. Call /{entity_type}/coverage for every slug in this dataset. Always present.
normalized_addressstringAddress normalized for joining the same property across datasets. Populated in 46% of sampled records.
normalized_business_namestringBusiness name normalized for joining the same business across datasets. Populated in 38% of sampled records.
postal_codestringPopulated in 57% of sampled records.
project_categorystringPopulated in 15% of sampled records.
project_namestringAlways present.
project_statusstringPopulated in 99% of sampled records.
project_status_canonicalstringPopulated in 99% of sampled records.
project_subtypestringPopulated in 14% of sampled records.
project_typestringPopulated in 15% of sampled records.
project_websitestringPopulated in 16% of sampled records.
provincestringAlways present.
public_fundingbooleanPopulated in 15% of sampled records.
record_idstringStable identifier for this record. Pass it to the /{entity_type}/{record_id} endpoint. Always present.
regionstringPopulated in 84% of sampled records.
resultstringPopulated in 52% of sampled records.
sector_canonicalstringAlways present.
start_datestringPopulated in 19% of sampled records.
30 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.

FieldTypePopulated
change_notesstring8.6%
clean_technologyboolean0.4%
clean_technology_typestring0.3%
construction_jobsinteger0.4%
contract_numberstring0.5%
contract_term_monthsstring0.7%
contractorstring3.4%
delivery_divisionstring0.7%
environmental_assessment_stagestring0.0%
estimated_cost_rangestring1.1%
federal_fundingstring0.0%
indigenous_nationsstring0.1%
infrastructure_namestring8.6%
locationstring9.0%
managerstring8.6%
municipal_fundingstring0.0%
neighbourhoodstring0.3%
operating_jobsinteger0.4%
other_fundingstring0.0%
parent_companystring0.2%
partner_fundingnumber2.7%
power_capacity_mwnumber0.0%
project_stagestring9.8%
provincial_fundingnumber4.3%
sourcing_typestring0.7%
target_award_yearstring0.7%
target_sourcing_yearstring0.7%
transit_linestring3.5%
update_activitystring1.4%
work_typestring8.6%

Errors

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

StatusWhen
400The 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.
403Missing or invalid API key.
404No such endpoint, or no record with that id.
422A 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.
429Rate limit or plan quota exceeded.
500Unexpected server error.
504The 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 →