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:
| Sort | Type | Example |
|---|---|---|
| Sort lowest to highest | asc | estimate_list_price_sort=asc |
| Sort highest to lowest | desc | estimate_list_price_sort=desc |
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&country_abbreviation=ca&estimate_list_price_sort=asc&province_abbreviation=ab&results_per_page=3&select=estimate_list_price"
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);
})();
{
"cache_hit": false,
"cost_cents": 0.9000000357627869,
"data": [
{
"address": "104 10415 93 Street NW NW",
"estimate_list_price": 96119,
"property_id": "988b559b61680dcc"
},
{
"address": "306 10415 93 Street NW",
"estimate_list_price": 97315,
"property_id": "89710e522a13d0f3"
},
{
"address": "806 12831 66 Street NW",
"estimate_list_price": 97451,
"property_id": "6a44bc168b5a1abd"
}
],
"error": "",
"pagination": {
"current_page": 1,
"has_next_page": true,
"has_previous_page": false,
"page_total": 517535
},
"price_quote": false,
"result_total": 1552603,
"time_ms": 172,
"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"
}
}