!

Sorting

Most of the endpoints on the Houski API allow you to sort the data returned by the API by a field.

There is no additional cost for sorting the data returned by the Houski API.

Sorting is performed by adding query parameters to the request URL. For example, to sort the properties returned by the properties endpoint by the estimated list price field, you can do either of the following:

SortTypeExample
Sort lowest to highestascestimate_list_price_sort=asc
Sort highest to lowestdescestimate_list_price_sort=desc
Programming language

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

Sorting by estimated list price
Request
Shell session
curl -X GET "https://api.houski.ca/properties?api_key=YOUR_API_KEY&country_abbreviation=ca&estimate_list_price_sort=asc&province_abbreviation=ab&results_per_page=3&select=estimate_list_price"
TypeScript code
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('country_abbreviation', 'ca');
    url.searchParams.set('estimate_list_price_sort', 'asc');
    url.searchParams.set('province_abbreviation', 'ab');
    url.searchParams.set('results_per_page', '3');
    url.searchParams.set('select', 'estimate_list_price');

    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);
})();
Response
JSON
{
  "cache_hit": false,
  "cost_cents": 0.9000000357627869,
  "data": [
    {
      "address": "102 9260 108 Avenue",
      "estimate_list_price": 92252,
      "property_id": "bf793a6dbfb903b0"
    },
    {
      "address": "108 9260 108 Avenue",
      "estimate_list_price": 92252,
      "property_id": "557312108502a6dc"
    },
    {
      "address": "124 9740 82 Avenue",
      "estimate_list_price": 97305,
      "property_id": "37de36589d2dad45"
    }
  ],
  "error": "",
  "pagination": {
    "current_page": 1,
    "has_next_page": true,
    "has_previous_page": false,
    "page_total": 519593
  },
  "price_quote": false,
  "result_total": 1558778,
  "time_ms": 186,
  "ui_info": {
    "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"
  }
}