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&city=calgary&country_abbreviation=ca&expand=listings_rent&filter_expand_match=all&province_abbreviation=ab"
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('city', 'calgary');
url.searchParams.set('country_abbreviation', 'ca');
url.searchParams.set('expand', 'listings_rent');
url.searchParams.set('filter_expand_match', 'all');
url.searchParams.set('province_abbreviation', 'ab');
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.4500000476837158,
"data": [
{
"address": "335 Millrise Drive Southwest",
"listings_rent": [
{
"expand_estimate_rent_monthly": 2995,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2024-10-25",
"expand_listing_rent_event": "Listed",
"property_id": "100523ae7fef83ad"
},
{
"expand_estimate_rent_monthly": 2695,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2024-10-29",
"expand_listing_rent_event": "Price decrease",
"property_id": "100523ae7fef83ad"
},
{
"expand_estimate_rent_monthly": 2595,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2024-11-20",
"expand_listing_rent_event": "Price decrease",
"property_id": "100523ae7fef83ad"
},
{
"expand_estimate_rent_monthly": 2495,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2024-12-03",
"expand_listing_rent_event": "Price decrease",
"property_id": "100523ae7fef83ad"
},
{
"expand_estimate_rent_monthly": 2495,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2024-12-10",
"expand_listing_rent_event": "Unlisted",
"property_id": "100523ae7fef83ad"
}
],
"property_id": "100523ae7fef83ad"
},
{
"address": "697 Savanna Boulevard NE",
"listings_rent": [
{
"expand_estimate_rent_monthly": 2500,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2024-03-26",
"expand_listing_rent_event": "Listed",
"property_id": "1005604551e5d0d8"
},
{
"expand_estimate_rent_monthly": 2475,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2024-03-28",
"expand_listing_rent_event": "Price decrease",
"property_id": "1005604551e5d0d8"
},
{
"expand_estimate_rent_monthly": 2475,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2024-04-04",
"expand_listing_rent_event": "Unlisted",
"property_id": "1005604551e5d0d8"
},
{
"expand_estimate_rent_monthly": 2400,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2025-03-16",
"expand_listing_rent_event": "Price decrease",
"property_id": "1005604551e5d0d8"
},
{
"expand_estimate_rent_monthly": 2400,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2025-03-23",
"expand_listing_rent_event": "Unlisted",
"property_id": "1005604551e5d0d8"
}
],
"property_id": "1005604551e5d0d8"
},
{
"address": "94 Cougarstone Court Southwest",
"listings_rent": [
{
"expand_estimate_rent_monthly": 3100,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2024-06-11",
"expand_listing_rent_event": "Listed",
"property_id": "100a7aeb6001427"
},
{
"expand_estimate_rent_monthly": 3200,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2024-07-14",
"expand_listing_rent_event": "Price increase",
"property_id": "100a7aeb6001427"
},
{
"expand_estimate_rent_monthly": 3000,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2024-08-11",
"expand_listing_rent_event": "Price decrease",
"property_id": "100a7aeb6001427"
},
{
"expand_estimate_rent_monthly": 2850,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2024-09-08",
"expand_listing_rent_event": "Price decrease",
"property_id": "100a7aeb6001427"
},
{
"expand_estimate_rent_monthly": 2750,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2024-09-21",
"expand_listing_rent_event": "Price decrease",
"property_id": "100a7aeb6001427"
},
{
"expand_estimate_rent_monthly": 2750,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2024-09-28",
"expand_listing_rent_event": "Unlisted",
"property_id": "100a7aeb6001427"
}
],
"property_id": "100a7aeb6001427"
},
{
"address": "3216 Breen Road NW",
"listings_rent": [
{
"expand_estimate_rent_monthly": 1650,
"expand_for_rent_what_is": "Basement",
"expand_listing_rent_date": "2024-04-06",
"expand_listing_rent_event": "Listed",
"property_id": "10106e1d99f8de60"
},
{
"expand_estimate_rent_monthly": 1600,
"expand_for_rent_what_is": "Basement",
"expand_listing_rent_date": "2024-04-08",
"expand_listing_rent_event": "Price decrease",
"property_id": "10106e1d99f8de60"
},
{
"expand_estimate_rent_monthly": 1600,
"expand_for_rent_what_is": "Basement",
"expand_listing_rent_date": "2024-04-15",
"expand_listing_rent_event": "Unlisted",
"property_id": "10106e1d99f8de60"
},
{
"expand_estimate_rent_monthly": 1800,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2025-05-06",
"expand_listing_rent_event": "Price increase",
"property_id": "10106e1d99f8de60"
},
{
"expand_estimate_rent_monthly": 1800,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2025-05-13",
"expand_listing_rent_event": "Unlisted",
"property_id": "10106e1d99f8de60"
}
],
"property_id": "10106e1d99f8de60"
},
{
"address": "430 Covecreek Circle Northeast",
"listings_rent": [
{
"expand_estimate_rent_monthly": 1900,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2025-04-01",
"expand_listing_rent_event": "Listed",
"property_id": "101831e9c61d4335"
},
{
"expand_estimate_rent_monthly": 1900,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2025-04-08",
"expand_listing_rent_event": "Unlisted",
"property_id": "101831e9c61d4335"
}
],
"property_id": "101831e9c61d4335"
},
{
"address": "611 3 Avenue Northeast",
"listings_rent": [
{
"expand_estimate_rent_monthly": 5200,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2024-08-07",
"expand_listing_rent_event": "Listed",
"property_id": "101dd060a6c69ed8"
},
{
"expand_estimate_rent_monthly": 5200,
"expand_for_rent_what_is": "Entire property",
"expand_listing_rent_date": "2024-08-14",
"expand_listing_rent_event": "Unlisted",
"property_id": "101dd060a6c69ed8"
}
],
"property_id": "101dd060a6c69ed8"
}
],
"error": "",
"pagination": {
"current_page": 1,
"has_next_page": true,
"has_previous_page": false,
"page_total": 3217
},
"price_quote": false,
"result_total": 19298,
"time_ms": 112,
"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"
}
}