This page contains examples of common use cases for the Houski API.
You can copy and paste the code examples into your own application.
Select the programming language you want to display the code examples in.
curl -X GET "https://api.houski.ca/properties?api_key=YOUR_API_KEY&bbox_ne_lat=51.1005&bbox_ne_lng=-113.508&bbox_sw_lat=50.6668&bbox_sw_lng=-114.4593&country_abbreviation=ca&expand=permits&filter_expand_match=all&province_abbreviation=ab&results_per_page=3"
const houski_recipe_data = async (): Promise<PropertiesResponse> => {
// You must copy the PropertiesResponse type declarations from the
// Houski API documentation to strongly type the response
const url = new URL('https://api.houski.ca/properties');
url.searchParams.set('api_key', 'YOUR_API_KEY');
url.searchParams.set('bbox_ne_lat', '51.1005');
url.searchParams.set('bbox_ne_lng', '-113.508');
url.searchParams.set('bbox_sw_lat', '50.6668');
url.searchParams.set('bbox_sw_lng', '-114.4593');
url.searchParams.set('country_abbreviation', 'ca');
url.searchParams.set('expand', 'permits');
url.searchParams.set('filter_expand_match', 'all');
url.searchParams.set('province_abbreviation', 'ab');
url.searchParams.set('results_per_page', '3');
const response = await fetch(url);
const data = await response.json();
return data;
}
(async () => {
let data: PropertiesResponse = await houski_recipe_data();
// Log the response
console.log(data);
})();
{
"cache_hit": false,
"cost_cents": 0.6500000357627869,
"data": [
{
"address": "52 Cedargrove Way SW",
"permits": [
{
"expand_permit_application_date": "2018-07-09",
"expand_permit_content": "Status: Released|Category: Residential - Secondary Suite|Description: NEW: SECONDARY SUITE (EXISTING - BASEMENT)|Proposed use code: C2626|Proposed use description: SECONDARY SUITE|Permitted/discretionary: Discretionary|Land use district: R-C1|Land use district description: Residential - Contextual One Dwelling|Concurrent LOC: N/A|Decision: Approval|Decision by: Development Authority|Decision date: 2018-08-16|Canceled/refused date: N/A|SDAB Number: N/A|SDAB hearing date: N/A|SDAB Decision: N/A|SDAB decision date: N/A",
"expand_permit_id": "DP2018-3294",
"expand_permit_type": "Development",
"property_id": "1000c277cd905d3b"
}
],
"property_id": "1000c277cd905d3b"
},
{
"address": "28 Sundown Gr SE",
"permits": [
{
"expand_permit_application_date": "2018-06-21",
"expand_permit_content": "Status: Completed|Issued date: 2018-06-22T00:00:00.000|Completed date: 2018-07-20T00:00:00.000|Estimated project cost: 17832.84|Permit class: Single Family|Permit type: Residential Improvement Project|Permit type mapped: Building|Work class: Alteration|Work class group: Improvement|Work class mapped: Existing|applicant: PERMIT MASTERS|contractor: N/A|estimated project cost: 17832.84|Total square feet affected: N/A|Housing units affected: 0",
"expand_permit_id": "BP2018-08003",
"expand_permit_type": "Building",
"property_id": "1001109ab2aebbc0"
},
{
"expand_permit_application_date": "1994-06-02",
"expand_permit_content": "Status: Released|Category: N/A|Description: CONVERTED JOB - HEIGHT RELAXATION FOR SATELLITE DISH ANTENNA|Proposed use code: B8172|Proposed use description: SINGLE-DETACHED DWELLING|Permitted/discretionary: Discretionary|Land use district: R-1|Land use district description: RESIDENTIAL SINGLE-DETACHED DISTRICT|Concurrent LOC: N/A|Decision: Approval|Decision by: Development Authority|Decision date: 1994-07-14|Canceled/refused date: 1994-08-08|SDAB Number: N/A|SDAB hearing date: N/A|SDAB Decision: N/A|SDAB decision date: N/A",
"expand_permit_id": "DP1994-1981",
"expand_permit_type": "Development",
"property_id": "1001109ab2aebbc0"
}
],
"property_id": "1001109ab2aebbc0"
},
{
"address": "6619 34 Street SW",
"permits": [
{
"expand_permit_application_date": "2010-02-18",
"expand_permit_content": "Status: Completed|Issued date: 2010-02-18T00:00:00.000|Completed date: 2010-03-18T00:00:00.000|Estimated project cost: 19100.0|Permit class: Single Family|Permit type: Residential Improvement Project|Permit type mapped: Building|Work class: Alteration|Work class group: Improvement|Work class mapped: Existing|applicant: INVENTURE MANAGEMENT|contractor: INVENTURE MANAGEMENT|estimated project cost: 19100.0|Total square feet affected: N/A|Housing units affected: 0",
"expand_permit_id": "BP2010-01843",
"expand_permit_type": "Building",
"property_id": "10014f3c7e5bfad9"
},
{
"expand_permit_application_date": "2009-07-31",
"expand_permit_content": "Status: Completed|Issued date: 2009-07-31T00:00:00.000|Completed date: 2009-08-12T00:00:00.000|Estimated project cost: 1000.0|Permit class: Single Family|Permit type: Residential Improvement Project|Permit type mapped: Building|Work class: Alteration|Work class group: Improvement|Work class mapped: Existing|applicant: INVENTURE MANAGEMENT|contractor: INVENTURE MANAGEMENT|estimated project cost: 1000.0|Total square feet affected: N/A|Housing units affected: 0",
"expand_permit_id": "BP2009-08327",
"expand_permit_type": "Building",
"property_id": "10014f3c7e5bfad9"
}
],
"property_id": "10014f3c7e5bfad9"
}
],
"error": "",
"pagination": {
"current_page": 1,
"has_next_page": true,
"has_previous_page": false,
"page_total": 61594
},
"price_quote": false,
"result_total": 184781,
"time_ms": 1033,
"ui_info": {
"country": "Canada",
"country_abbreviation": "CA",
"country_abbreviation_id": "9ace2b6431b7f1be",
"country_abbreviation_link": "ca",
"country_slug": "canada",
"province": "Alberta",
"province_abbreviation": "AB",
"province_abbreviation_id": "aae1f05a0f89d2c7",
"province_abbreviation_link": "ca/ab",
"province_slug": "alberta"
}
}