Many properties have additional data sets, in addition to the regular fields. For example, a property may have a expansion set, which contains information about the schools in the area.
To retrieve this data, you can use the expand query parameter.
For example, to retrieve the school data, you would add the
following to the request URL: ?expand=schools
Multiple expansions can be specified by seperating them with a
comma. For example, to retrieve the school and crime data, you
would add the following to the request URL: ?expand=schools,crime
There are lots of other expansion sets, including photos, videos, and more. To see a full list of available expansions, visit the fields & expansions page.
It's important to note that not all properties have all expansion sets. If you request an expansion set that is not available for a property, the API will return an empty array for that expansion set.
Expansion set pricing also varies, and the pricing is based on the cost of the expansion set, multiplied by the number of rows returned.
Select the programming language you want to display the code examples in.
Note that property_id and address are expanded by default by the properties endpoint.
curl -X GET "https://api.houski.ca/properties?api_key=YOUR_API_KEY&city=calgary&country_abbreviation=ca&expand=assessments&province_abbreviation=ab"
const houski_properties_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('city', 'calgary');
url.searchParams.set('country_abbreviation', 'ca');
url.searchParams.set('expand', 'assessments');
url.searchParams.set('province_abbreviation', 'ab');
const response = await fetch(url);
const data = await response.json();
return data;
}
(async () => {
let data: PropertiesResponse = await houski_properties_data();
// Log the response
console.log(data);
})();
{
"cache_hit": true,
"cost_cents": 2.049999952316284,
"data": [
{
"address": "1180 Cranbrook Garden SE",
"assessments": [
{
"expand_assessment_value": 368500,
"expand_assessment_year": 2020,
"property_id": "2187d710cad6d1b6"
},
{
"expand_assessment_value": 672500,
"expand_assessment_year": 2021,
"property_id": "2187d710cad6d1b6"
},
{
"expand_assessment_value": 736000,
"expand_assessment_year": 2022,
"property_id": "2187d710cad6d1b6"
},
{
"expand_assessment_value": 863500,
"expand_assessment_year": 2023,
"property_id": "2187d710cad6d1b6"
},
{
"expand_assessment_value": 941000,
"expand_assessment_year": 2024,
"property_id": "2187d710cad6d1b6"
}
],
"property_id": "2187d710cad6d1b6"
},
{
"address": "99 Midpark Gardens Southeast",
"property_id": "7d766b1b1dc70388"
},
{
"address": "129 Scenic Ridge Crescent NW",
"assessments": [
{
"expand_assessment_value": 289000,
"expand_assessment_year": 2005,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 307500,
"expand_assessment_year": 2006,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 447500,
"expand_assessment_year": 2007,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 537000,
"expand_assessment_year": 2008,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 507000,
"expand_assessment_year": 2009,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 446000,
"expand_assessment_year": 2010,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 504000,
"expand_assessment_year": 2011,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 491500,
"expand_assessment_year": 2012,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 582000,
"expand_assessment_year": 2013,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 601000,
"expand_assessment_year": 2014,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 595500,
"expand_assessment_year": 2015,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 604000,
"expand_assessment_year": 2016,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 580500,
"expand_assessment_year": 2017,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 598000,
"expand_assessment_year": 2018,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 601500,
"expand_assessment_year": 2019,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 578000,
"expand_assessment_year": 2020,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 569000,
"expand_assessment_year": 2021,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 623000,
"expand_assessment_year": 2022,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 694500,
"expand_assessment_year": 2023,
"property_id": "78a5dafc40e1a7e5"
},
{
"expand_assessment_value": 755500,
"expand_assessment_year": 2024,
"property_id": "78a5dafc40e1a7e5"
}
],
"property_id": "78a5dafc40e1a7e5"
},
{
"address": "4662 Marbank Drive NE",
"assessments": [
{
"expand_assessment_value": 186500,
"expand_assessment_year": 2005,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 193000,
"expand_assessment_year": 2006,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 277500,
"expand_assessment_year": 2007,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 370500,
"expand_assessment_year": 2008,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 351500,
"expand_assessment_year": 2009,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 295000,
"expand_assessment_year": 2010,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 316000,
"expand_assessment_year": 2011,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 290000,
"expand_assessment_year": 2012,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 304500,
"expand_assessment_year": 2013,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 324500,
"expand_assessment_year": 2014,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 370000,
"expand_assessment_year": 2015,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 364000,
"expand_assessment_year": 2016,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 355000,
"expand_assessment_year": 2017,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 357500,
"expand_assessment_year": 2018,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 349000,
"expand_assessment_year": 2019,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 340500,
"expand_assessment_year": 2020,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 325500,
"expand_assessment_year": 2021,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 365500,
"expand_assessment_year": 2022,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 408500,
"expand_assessment_year": 2023,
"property_id": "947040b0939bd4e6"
},
{
"expand_assessment_value": 459000,
"expand_assessment_year": 2024,
"property_id": "947040b0939bd4e6"
}
],
"property_id": "947040b0939bd4e6"
},
{
"address": "3877 30 Avenue SE",
"assessments": [
{
"expand_assessment_value": 158500,
"expand_assessment_year": 2005,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 168500,
"expand_assessment_year": 2006,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 246000,
"expand_assessment_year": 2007,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 324000,
"expand_assessment_year": 2008,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 306000,
"expand_assessment_year": 2009,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 262500,
"expand_assessment_year": 2010,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 275500,
"expand_assessment_year": 2011,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 254000,
"expand_assessment_year": 2012,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 262500,
"expand_assessment_year": 2013,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 278500,
"expand_assessment_year": 2014,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 322500,
"expand_assessment_year": 2015,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 320500,
"expand_assessment_year": 2016,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 317000,
"expand_assessment_year": 2017,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 324500,
"expand_assessment_year": 2018,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 319000,
"expand_assessment_year": 2019,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 310000,
"expand_assessment_year": 2020,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 301500,
"expand_assessment_year": 2021,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 326500,
"expand_assessment_year": 2022,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 369500,
"expand_assessment_year": 2023,
"property_id": "de293d63c8ff323c"
},
{
"expand_assessment_value": 404500,
"expand_assessment_year": 2024,
"property_id": "de293d63c8ff323c"
}
],
"property_id": "de293d63c8ff323c"
},
{
"address": "90 Edgeview Drive NW",
"assessments": [
{
"expand_assessment_value": 325000,
"expand_assessment_year": 2005,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 355500,
"expand_assessment_year": 2006,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 501000,
"expand_assessment_year": 2007,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 619000,
"expand_assessment_year": 2008,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 579500,
"expand_assessment_year": 2009,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 500500,
"expand_assessment_year": 2010,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 565500,
"expand_assessment_year": 2011,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 557000,
"expand_assessment_year": 2012,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 536000,
"expand_assessment_year": 2013,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 573500,
"expand_assessment_year": 2014,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 622000,
"expand_assessment_year": 2015,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 611000,
"expand_assessment_year": 2016,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 584000,
"expand_assessment_year": 2017,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 604000,
"expand_assessment_year": 2018,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 608000,
"expand_assessment_year": 2019,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 586000,
"expand_assessment_year": 2020,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 574000,
"expand_assessment_year": 2021,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 636000,
"expand_assessment_year": 2022,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 690000,
"expand_assessment_year": 2023,
"property_id": "b059bd87a83e8a25"
},
{
"expand_assessment_value": 767000,
"expand_assessment_year": 2024,
"property_id": "b059bd87a83e8a25"
}
],
"property_id": "b059bd87a83e8a25"
}
],
"error": "",
"pagination": {
"current_page": 1,
"has_next_page": true,
"has_previous_page": false,
"page_total": 86641
},
"price_quote": false,
"result_total": 519841,
"time_ms": 47,
"ui_info": {
"city": "Calgary",
"city_id": "6ec95b53075d062c",
"city_link": "ca/ab/calgary",
"city_slug": "calgary",
"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"
}
}