!

Expanding

Many properties have additional data sets, in addition to the regular fields. For example, a property may have a expansion set, which contains information about the schools in the area.

To retrieve this data, you can use the expand query parameter. For example, to retrieve the school data, you would add the following to the request URL: ?expand=schools

Multiple expansions can be specified by seperating them with a comma. For example, to retrieve the school and crime data, you would add the following to the request URL: ?expand=schools,crime

There are lots of other expansion sets, including photos, videos, and more. To see a full list of available expansions, visit the fields & expansions page.

It's important to note that not all properties have all expansion sets. If you request an expansion set that is not available for a property, the API will return an empty array for that expansion set.

Expansion set pricing also varies, and the pricing is based on the cost of the expansion set, multiplied by the number of rows returned.

Programming language

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

Expanding a property's assessment data
Note that property_id and address are expanded by default by the properties endpoint.
Request
Shell session
curl -X GET "https://api.houski.ca/properties?api_key=YOUR_API_KEY&city=calgary&country_abbreviation=ca&expand=assessments&province_abbreviation=ab"
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('city', 'calgary');
    url.searchParams.set('country_abbreviation', 'ca');
    url.searchParams.set('expand', 'assessments');
    url.searchParams.set('province_abbreviation', 'ab');

    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": 2.0299999713897705,
  "data": [
    {
      "address": "31 Hawkside Park NW",
      "assessments": [
        {
          "expand_assessment_value": 244500,
          "expand_assessment_year": 2005,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 255000,
          "expand_assessment_year": 2006,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 416000,
          "expand_assessment_year": 2007,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 424000,
          "expand_assessment_year": 2008,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 410500,
          "expand_assessment_year": 2009,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 369500,
          "expand_assessment_year": 2010,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 525500,
          "expand_assessment_year": 2011,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 460000,
          "expand_assessment_year": 2012,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 490000,
          "expand_assessment_year": 2013,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 476000,
          "expand_assessment_year": 2014,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 529000,
          "expand_assessment_year": 2015,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 493500,
          "expand_assessment_year": 2016,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 473000,
          "expand_assessment_year": 2017,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 456000,
          "expand_assessment_year": 2018,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 455500,
          "expand_assessment_year": 2019,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 426000,
          "expand_assessment_year": 2020,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 404500,
          "expand_assessment_year": 2021,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 427500,
          "expand_assessment_year": 2022,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 484000,
          "expand_assessment_year": 2023,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 562500,
          "expand_assessment_year": 2024,
          "property_id": "10000f97f5cb7b9f"
        },
        {
          "expand_assessment_value": 649000,
          "expand_assessment_year": 2025,
          "property_id": "10000f97f5cb7b9f"
        }
      ],
      "property_id": "10000f97f5cb7b9f"
    },
    {
      "address": "6 1744 7 Street SW",
      "property_id": "10004f7afe0c1946"
    },
    {
      "address": "384 Copperpond Landng SE",
      "property_id": "10007f9761f49940"
    },
    {
      "address": "239 Dalhurst Way NW",
      "assessments": [
        {
          "expand_assessment_value": 338000,
          "expand_assessment_year": 2005,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 360500,
          "expand_assessment_year": 2006,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 554000,
          "expand_assessment_year": 2007,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 591000,
          "expand_assessment_year": 2008,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 592000,
          "expand_assessment_year": 2009,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 565000,
          "expand_assessment_year": 2010,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 702000,
          "expand_assessment_year": 2011,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 692500,
          "expand_assessment_year": 2012,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 697000,
          "expand_assessment_year": 2013,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 710500,
          "expand_assessment_year": 2014,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 775000,
          "expand_assessment_year": 2015,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 769500,
          "expand_assessment_year": 2016,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 731500,
          "expand_assessment_year": 2017,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 772000,
          "expand_assessment_year": 2018,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 777000,
          "expand_assessment_year": 2019,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 767500,
          "expand_assessment_year": 2020,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 761000,
          "expand_assessment_year": 2021,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 833000,
          "expand_assessment_year": 2022,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 898500,
          "expand_assessment_year": 2023,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 983000,
          "expand_assessment_year": 2024,
          "property_id": "100086f6bc064d3f"
        },
        {
          "expand_assessment_value": 1120000,
          "expand_assessment_year": 2025,
          "property_id": "100086f6bc064d3f"
        }
      ],
      "property_id": "100086f6bc064d3f"
    },
    {
      "address": "52 Cedargrove Way SW",
      "assessments": [
        {
          "expand_assessment_value": 216000,
          "expand_assessment_year": 2005,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 224000,
          "expand_assessment_year": 2006,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 329000,
          "expand_assessment_year": 2007,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 390000,
          "expand_assessment_year": 2008,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 363000,
          "expand_assessment_year": 2009,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 452500,
          "expand_assessment_year": 2010,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 463500,
          "expand_assessment_year": 2011,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 476500,
          "expand_assessment_year": 2012,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 499500,
          "expand_assessment_year": 2013,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 516500,
          "expand_assessment_year": 2014,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 615000,
          "expand_assessment_year": 2015,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 430500,
          "expand_assessment_year": 2016,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 418000,
          "expand_assessment_year": 2017,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 428500,
          "expand_assessment_year": 2018,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 425500,
          "expand_assessment_year": 2019,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 402500,
          "expand_assessment_year": 2020,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 398000,
          "expand_assessment_year": 2021,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 427500,
          "expand_assessment_year": 2022,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 490000,
          "expand_assessment_year": 2023,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 529000,
          "expand_assessment_year": 2024,
          "property_id": "1000c277cd905d3b"
        },
        {
          "expand_assessment_value": 626000,
          "expand_assessment_year": 2025,
          "property_id": "1000c277cd905d3b"
        }
      ],
      "property_id": "1000c277cd905d3b"
    },
    {
      "address": "28 Sundown Gr SE",
      "assessments": [
        {
          "expand_assessment_value": 245000,
          "expand_assessment_year": 2005,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 269000,
          "expand_assessment_year": 2006,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 370500,
          "expand_assessment_year": 2007,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 451500,
          "expand_assessment_year": 2008,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 439000,
          "expand_assessment_year": 2009,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 387000,
          "expand_assessment_year": 2010,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 421000,
          "expand_assessment_year": 2011,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 403500,
          "expand_assessment_year": 2012,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 410500,
          "expand_assessment_year": 2013,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 481000,
          "expand_assessment_year": 2015,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 463500,
          "expand_assessment_year": 2016,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 441500,
          "expand_assessment_year": 2017,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 458000,
          "expand_assessment_year": 2018,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 456000,
          "expand_assessment_year": 2019,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 429500,
          "expand_assessment_year": 2020,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 423500,
          "expand_assessment_year": 2021,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 460000,
          "expand_assessment_year": 2022,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 521500,
          "expand_assessment_year": 2023,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 573500,
          "expand_assessment_year": 2024,
          "property_id": "1001109ab2aebbc0"
        },
        {
          "expand_assessment_value": 663500,
          "expand_assessment_year": 2025,
          "property_id": "1001109ab2aebbc0"
        }
      ],
      "property_id": "1001109ab2aebbc0"
    }
  ],
  "error": "",
  "pagination": {
    "current_page": 1,
    "has_next_page": true,
    "has_previous_page": false,
    "page_total": 109203
  },
  "price_quote": false,
  "result_total": 655217,
  "time_ms": 514,
  "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"
  }
}