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.
In this example, we are retrieving properties that have permit data inside a geographic polygon. Properties with permit, assessment, or listing data will be returned when using the filter_expand_match_any parameter.
curl -X GET "https://api.houski.ca/properties?api_key=YOUR_API_KEY&country_abbreviation=ca&expand=permits,assessments,listings&filter_expand_match=any&polygon=51.0447_-114.0719,51.0544_-114.0719,51.0544_-114.0856,51.0452_-114.0856&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('country_abbreviation', 'ca');
url.searchParams.set('expand', 'permits,assessments,listings');
url.searchParams.set('filter_expand_match', 'any');
url.searchParams.set('polygon', '51.0447_-114.0719,51.0544_-114.0719,51.0544_-114.0856,51.0452_-114.0856');
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": 1.0499999523162842,
"data": [
{
"address": "903 801 2 Avenue SW",
"assessments": [
{
"expand_assessment_value": 341500,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2005,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 359000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2006,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 524000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2007,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 608500,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2008,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 605000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2009,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 494500,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2010,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 530500,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2011,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 472000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2012,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 461000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2013,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 474500,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2014,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 510000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2015,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 571500,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2016,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 539500,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2017,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 519000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2018,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 514000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2019,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 493000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2020,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 489000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2021,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 497000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2022,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 512500,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2023,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
},
{
"expand_assessment_value": 534500,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2024,
"expand_assessment_year_source": "Document",
"property_id": "75867e673b8e6cab"
}
],
"property_id": "75867e673b8e6cab"
},
{
"address": "291V 738 1 Avenue SW",
"assessments": [
{
"expand_assessment_value": 89000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2020,
"expand_assessment_year_source": "Document",
"property_id": "5305781bc24a5acb"
},
{
"expand_assessment_value": 89000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2021,
"expand_assessment_year_source": "Document",
"property_id": "5305781bc24a5acb"
},
{
"expand_assessment_value": 89000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2022,
"expand_assessment_year_source": "Document",
"property_id": "5305781bc24a5acb"
},
{
"expand_assessment_value": 89000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2023,
"expand_assessment_year_source": "Document",
"property_id": "5305781bc24a5acb"
},
{
"expand_assessment_value": 89000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2024,
"expand_assessment_year_source": "Document",
"property_id": "5305781bc24a5acb"
}
],
"property_id": "5305781bc24a5acb"
},
{
"address": "403 660 Eau Claire Avenue SW",
"assessments": [
{
"expand_assessment_value": 469000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2005,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 544000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2006,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 654500,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2007,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 940000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2008,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 783000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2009,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 642500,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2010,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 592500,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2011,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 682000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2012,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 697000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2013,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 697000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2014,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 815000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2015,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 788000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2016,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 758000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2017,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 745500,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2018,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 653000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2019,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 506500,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2020,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 481000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2021,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 467000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2022,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 515000,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2023,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
},
{
"expand_assessment_value": 599500,
"expand_assessment_value_source": "Document",
"expand_assessment_year": 2024,
"expand_assessment_year_source": "Document",
"property_id": "2bd726fa5ffe1803"
}
],
"property_id": "2bd726fa5ffe1803"
}
],
"error": "",
"pagination": {
"current_page": 1,
"has_next_page": true,
"has_previous_page": false,
"page_total": 614
},
"price_quote": false,
"result_total": 1842,
"time_ms": 1167,
"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"
}
}