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=edmonton&country_abbreviation=ca&province_abbreviation=ab&results_per_page=1&select=demographic_employment_industries_agriculture_forestry_fishing_and_hunting_percent,demographic_employment_industries_mining_quarrying_and_oil_and_gas_extraction_percent,demographic_employment_industries_utilities_percent,demographic_employment_industries_construction_percent,demographic_employment_industries_manufacturing_percent,demographic_employment_industries_wholesale_trade_percent,demographic_employment_industries_retail_trade_percent,demographic_employment_industries_transportation_and_warehousing_percent,demographic_employment_industries_information_and_cultural_industries_percent,demographic_employment_industries_finance_and_insurance_percent,demographic_employment_industries_real_estate_and_rental_and_leasing_percent,demographic_employment_industries_professional_scientific_and_technical_services_percent,demographic_employment_industries_management_of_companies_and_enterprises_percent,demographic_employment_industries_administrative_and_support_waste_management_and_remediation_services_percent,demographic_employment_industries_educational_services_percent,demographic_employment_industries_health_care_and_social_assistance_percent,demographic_employment_industries_arts_entertainment_and_recreation_percent,demographic_employment_industries_accommodation_and_food_services_percent,demographic_employment_industries_other_services_percent,demographic_employment_industries_public_administration_percent"
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', 'edmonton');
url.searchParams.set('country_abbreviation', 'ca');
url.searchParams.set('province_abbreviation', 'ab');
url.searchParams.set('results_per_page', '1');
url.searchParams.set('select', 'demographic_employment_industries_agriculture_forestry_fishing_and_hunting_percent,demographic_employment_industries_mining_quarrying_and_oil_and_gas_extraction_percent,demographic_employment_industries_utilities_percent,demographic_employment_industries_construction_percent,demographic_employment_industries_manufacturing_percent,demographic_employment_industries_wholesale_trade_percent,demographic_employment_industries_retail_trade_percent,demographic_employment_industries_transportation_and_warehousing_percent,demographic_employment_industries_information_and_cultural_industries_percent,demographic_employment_industries_finance_and_insurance_percent,demographic_employment_industries_real_estate_and_rental_and_leasing_percent,demographic_employment_industries_professional_scientific_and_technical_services_percent,demographic_employment_industries_management_of_companies_and_enterprises_percent,demographic_employment_industries_administrative_and_support_waste_management_and_remediation_services_percent,demographic_employment_industries_educational_services_percent,demographic_employment_industries_health_care_and_social_assistance_percent,demographic_employment_industries_arts_entertainment_and_recreation_percent,demographic_employment_industries_accommodation_and_food_services_percent,demographic_employment_industries_other_services_percent,demographic_employment_industries_public_administration_percent');
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": 2.200000047683716,
"data": [
{
"address": "433 1818 Rutherford Road SW",
"demographic_employment_industries_accommodation_and_food_services_percent": 0.01650165021419525,
"demographic_employment_industries_administrative_and_support_waste_management_and_remediation_services_percent": 0.024752475321292877,
"demographic_employment_industries_agriculture_forestry_fishing_and_hunting_percent": 0.0,
"demographic_employment_industries_arts_entertainment_and_recreation_percent": 0.01650165021419525,
"demographic_employment_industries_construction_percent": 0.08085808902978897,
"demographic_employment_industries_educational_services_percent": 0.11386138945817947,
"demographic_employment_industries_finance_and_insurance_percent": 0.04125412553548813,
"demographic_employment_industries_health_care_and_social_assistance_percent": 0.10726072639226912,
"demographic_employment_industries_information_and_cultural_industries_percent": 0.023102309554815292,
"demographic_employment_industries_management_of_companies_and_enterprises_percent": 0.0,
"demographic_employment_industries_manufacturing_percent": 0.07260726392269135,
"demographic_employment_industries_mining_quarrying_and_oil_and_gas_extraction_percent": 0.04125412553548813,
"demographic_employment_industries_other_services_percent": 0.056105609983205795,
"demographic_employment_industries_professional_scientific_and_technical_services_percent": 0.11386138945817947,
"demographic_employment_industries_public_administration_percent": 0.04125412553548813,
"demographic_employment_industries_real_estate_and_rental_and_leasing_percent": 0.01650165021419525,
"demographic_employment_industries_retail_trade_percent": 0.1551155149936676,
"demographic_employment_industries_transportation_and_warehousing_percent": 0.039603959769010544,
"demographic_employment_industries_utilities_percent": 0.0,
"demographic_employment_industries_wholesale_trade_percent": 0.039603959769010544,
"property_id": "10001f3bac65c527"
}
],
"error": "",
"pagination": {
"current_page": 1,
"has_next_page": true,
"has_previous_page": false,
"page_total": 511241
},
"price_quote": false,
"result_total": 511241,
"time_ms": 132,
"ui_info": {
"city": "Edmonton",
"city_id": "ba0db02120e894c9",
"city_link": "ca/ab/edmonton",
"city_slug": "edmonton",
"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"
}
}