Requests you can copy and run. Each one returns live data from the API.
A request that selects a field with a source column carries exclude=inferred, which leaves out the values Houski worked out, unless it looks up one named property. Remove it to get those values too.
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&cap_rate_gt=0.10&city=calgary&country_abbreviation=ca&exclude=inferred&page=1&property_type_eq=Apartment&province_abbreviation=ab&results_per_page=5&select=address,estimate_list_price,estimate_rent_monthly,cap_rate,cash_on_cash_return,maintenance_fee,property_taxes,interior_sq_m,bedroom_total"
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('cap_rate_gt', '0.10');
url.searchParams.set('city', 'calgary');
url.searchParams.set('country_abbreviation', 'ca');
url.searchParams.set('exclude', 'inferred');
url.searchParams.set('page', '1');
url.searchParams.set('property_type_eq', 'Apartment');
url.searchParams.set('province_abbreviation', 'ab');
url.searchParams.set('results_per_page', '5');
url.searchParams.set('select', 'address,estimate_list_price,estimate_rent_monthly,cap_rate,cash_on_cash_return,maintenance_fee,property_taxes,interior_sq_m,bedroom_total');
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": true,
"checked_fields": [
"property_taxes",
"interior_sq_m"
],
"cost_cents": 4.1000004,
"data": [
{
"address": "492 8948 Elbow Drive SW",
"bedroom_total": 2,
"cap_rate": 0.1289589,
"cash_on_cash_return": 0.30645755,
"estimate_list_price": 214335,
"estimate_rent_monthly": 1932,
"interior_sq_m": 80.45336,
"maintenance_fee": 567,
"property_id": "12481decb8b6c044",
"property_taxes": 1486
},
{
"address": "715 8880 Horton Road SW",
"bedroom_total": 1,
"cap_rate": 0.1309992,
"cash_on_cash_return": 0.3146187,
"estimate_list_price": 178471,
"estimate_rent_monthly": 1633,
"interior_sq_m": 46.636936,
"maintenance_fee": 320,
"property_id": "13596fd5601acf67",
"property_taxes": 1386
},
{
"address": "1608 8710 Horton Road SW",
"bedroom_total": 2,
"cap_rate": 0.10005247,
"cash_on_cash_return": 0.19083183,
"estimate_list_price": 318478,
"estimate_rent_monthly": 2257,
"interior_sq_m": 90.2081,
"maintenance_fee": 569,
"property_id": "13b9c58820d65421",
"property_taxes": 2033
},
{
"address": "413 8880 Horton Road SW",
"bedroom_total": 1,
"cap_rate": 0.10475548,
"cash_on_cash_return": 0.20964387,
"estimate_list_price": 238772,
"estimate_rent_monthly": 1767,
"interior_sq_m": 75.99406,
"maintenance_fee": 442,
"property_id": "13df26e6013064c5",
"property_taxes": 1442
},
{
"address": "401 8880 Horton Road SW",
"bedroom_total": 1,
"cap_rate": 0.10131951,
"cash_on_cash_return": 0.19589996,
"estimate_list_price": 221996,
"estimate_rent_monthly": 1592,
"interior_sq_m": 66.33222,
"maintenance_fee": 315,
"property_id": "14cb688d236472fc",
"property_taxes": 1294
}
],
"error": "",
"pagination": {
"current_page": 1,
"has_next_page": true,
"has_previous_page": false,
"page_total": 1797
},
"price_quote": false,
"result_total": 8985,
"time_ms": 36,
"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"
}
}