BuildData
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}Filtering, search and pagination
Narrow results with filters and full-text search, and page through large result sets.
Most BuildData search endpoints accept query parameters to filter results, plus limit and offset to page through them.
Filter and search
Use q for full-text search across fields, and the endpoint-specific filters listed on each reference page. Combine as many as you need:
GET https://builddata-canadian-construction-data-api.p.rapidapi.com/zone?q=example&limit=50Page through results
Responses include a count and an offset. Increase offset by your limit to walk the results:
GET https://builddata-canadian-construction-data-api.p.rapidapi.com/zone?limit=100&offset=0
GET https://builddata-canadian-construction-data-api.p.rapidapi.com/zone?limit=100&offset=100Limits
limit is capped at 500 records per request, and offset at 9500. Asking for more returns a 422 or 400 explaining the ceiling.
Going past 9500 records
Offset paging stops at 9500. To walk a larger result set, pass the next_cursor from each response back as cursor on the next request, and keep going until next_cursor comes back null:
GET https://builddata-canadian-construction-data-api.p.rapidapi.com/zone?limit=500
GET https://builddata-canadian-construction-data-api.p.rapidapi.com/zone?limit=500&cursor=THE_NEXT_CURSOR_FROM_THE_LAST_RESPONSECursor paging cannot be combined with sort_by=value, sort_by=published or sort_by=closing.