!

Recipes

This page contains examples of common use cases for the Houski API.

You can copy and paste the code examples into your own application.

Programming language

Select the programming language you want to display the code examples in.

Choose a recipe

Multigenerational living properties
Gets properties suitable for multigenerational families with secondary suites.
Request
Shell session
curl -X GET "https://api.houski.ca/properties?api_key=YOUR_API_KEY&bedroom_total_gte=4&country_abbreviation=ca&secondary_suite_type_first_neq=None&select=bedroom_total,secondary_suite_type_first,interior_sq_m,bedroom,den,bathroom_full,bathroom_half"
TypeScript code
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('bedroom_total_gte', '4');
    url.searchParams.set('country_abbreviation', 'ca');
    url.searchParams.set('secondary_suite_type_first_neq', 'None');
    url.searchParams.set('select', 'bedroom_total,secondary_suite_type_first,interior_sq_m,bedroom,den,bathroom_full,bathroom_half');

    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);
})();
Response
JSON
{
  "cache_hit": false,
  "cost_cents": 5.40000057220459,
  "data": [
    {
      "address": "160 Longford Drive",
      "bathroom_full": 2,
      "bathroom_half": 0,
      "bedroom": 3,
      "bedroom_total": 5,
      "den": 2,
      "interior_sq_m": 64.93868255615234,
      "property_id": "1001705239331935",
      "secondary_suite_type_first": "Basement suite"
    },
    {
      "address": "190 Cornerbrook Manor NE",
      "bathroom_full": 3,
      "bathroom_half": 1,
      "bedroom": 3,
      "bedroom_total": 4,
      "den": 1,
      "interior_sq_m": 113.52657318115234,
      "property_id": "1020a674f0c9a890",
      "secondary_suite_type_first": "Basement suite"
    },
    {
      "address": "150 Creekside Bay NW",
      "bathroom_full": 3,
      "bathroom_half": 0,
      "bedroom": 2,
      "bedroom_total": 4,
      "den": 2,
      "interior_sq_m": 97.54737854003906,
      "property_id": "1030d0308170362d",
      "secondary_suite_type_first": "Basement suite"
    },
    {
      "address": "3256 Cindy Crescent",
      "bathroom_full": 4,
      "bathroom_half": 0,
      "bedroom": 3,
      "bedroom_total": 4,
      "den": 1,
      "interior_sq_m": 112.2268295288086,
      "property_id": "10367cbd45fb1392",
      "secondary_suite_type_first": "Basement suite"
    },
    {
      "address": "10220 29 Street NW NW",
      "bathroom_full": 3,
      "bathroom_half": 0,
      "bedroom": 4,
      "bedroom_total": 4,
      "den": 0,
      "interior_sq_m": 117.98587799072266,
      "property_id": "103914ae4556908",
      "secondary_suite_type_first": "Garage suite"
    },
    {
      "address": "10816 61 Avenue NW",
      "bathroom_full": 5,
      "bathroom_half": 0,
      "bedroom": 6,
      "bedroom_total": 6,
      "den": 0,
      "interior_sq_m": 132.4786376953125,
      "property_id": "103c6576831f1c30",
      "secondary_suite_type_first": "Garage suite"
    }
  ],
  "error": "",
  "pagination": {
    "current_page": 1,
    "has_next_page": true,
    "has_previous_page": false,
    "page_total": 1484
  },
  "price_quote": false,
  "result_total": 8902,
  "time_ms": 54,
  "ui_info": {
    "country": "Canada",
    "country_abbreviation": "CA",
    "country_abbreviation_id": "9ace2b6431b7f1be",
    "country_abbreviation_link": "ca",
    "country_slug": "canada"
  }
}