!

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": true,
  "cost_cents": 1.9700000286102295,
  "data": [
    {
      "address": "333 Marquis Landing SE",
      "assessments": [
        {
          "expand_assessment_value": 221000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2015,
          "expand_assessment_year_source": "Document",
          "property_id": "eaa8f92bfcdcdded"
        },
        {
          "expand_assessment_value": 238000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2016,
          "expand_assessment_year_source": "Document",
          "property_id": "eaa8f92bfcdcdded"
        },
        {
          "expand_assessment_value": 687500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2017,
          "expand_assessment_year_source": "Document",
          "property_id": "eaa8f92bfcdcdded"
        },
        {
          "expand_assessment_value": 758000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2018,
          "expand_assessment_year_source": "Document",
          "property_id": "eaa8f92bfcdcdded"
        },
        {
          "expand_assessment_value": 795500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2019,
          "expand_assessment_year_source": "Document",
          "property_id": "eaa8f92bfcdcdded"
        },
        {
          "expand_assessment_value": 750000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2020,
          "expand_assessment_year_source": "Document",
          "property_id": "eaa8f92bfcdcdded"
        },
        {
          "expand_assessment_value": 765000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2021,
          "expand_assessment_year_source": "Document",
          "property_id": "eaa8f92bfcdcdded"
        },
        {
          "expand_assessment_value": 798500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2022,
          "expand_assessment_year_source": "Document",
          "property_id": "eaa8f92bfcdcdded"
        },
        {
          "expand_assessment_value": 941500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2023,
          "expand_assessment_year_source": "Document",
          "property_id": "eaa8f92bfcdcdded"
        },
        {
          "expand_assessment_value": 1020000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2024,
          "expand_assessment_year_source": "Document",
          "property_id": "eaa8f92bfcdcdded"
        }
      ],
      "property_id": "eaa8f92bfcdcdded"
    },
    {
      "address": "1312 222 Riverfront Avenue SW",
      "assessments": [
        {
          "expand_assessment_value": 545500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2011,
          "expand_assessment_year_source": "Document",
          "property_id": "3c004c1eb501ac90"
        },
        {
          "expand_assessment_value": 577500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2012,
          "expand_assessment_year_source": "Document",
          "property_id": "3c004c1eb501ac90"
        },
        {
          "expand_assessment_value": 521000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2013,
          "expand_assessment_year_source": "Document",
          "property_id": "3c004c1eb501ac90"
        },
        {
          "expand_assessment_value": 549500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2015,
          "expand_assessment_year_source": "Document",
          "property_id": "3c004c1eb501ac90"
        },
        {
          "expand_assessment_value": 567000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2016,
          "expand_assessment_year_source": "Document",
          "property_id": "3c004c1eb501ac90"
        },
        {
          "expand_assessment_value": 538500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2017,
          "expand_assessment_year_source": "Document",
          "property_id": "3c004c1eb501ac90"
        },
        {
          "expand_assessment_value": 524000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2018,
          "expand_assessment_year_source": "Document",
          "property_id": "3c004c1eb501ac90"
        },
        {
          "expand_assessment_value": 516000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2019,
          "expand_assessment_year_source": "Document",
          "property_id": "3c004c1eb501ac90"
        },
        {
          "expand_assessment_value": 486500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2020,
          "expand_assessment_year_source": "Document",
          "property_id": "3c004c1eb501ac90"
        },
        {
          "expand_assessment_value": 431500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2021,
          "expand_assessment_year_source": "Document",
          "property_id": "3c004c1eb501ac90"
        },
        {
          "expand_assessment_value": 398500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2022,
          "expand_assessment_year_source": "Document",
          "property_id": "3c004c1eb501ac90"
        },
        {
          "expand_assessment_value": 410000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2023,
          "expand_assessment_year_source": "Document",
          "property_id": "3c004c1eb501ac90"
        },
        {
          "expand_assessment_value": 455500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2024,
          "expand_assessment_year_source": "Document",
          "property_id": "3c004c1eb501ac90"
        }
      ],
      "property_id": "3c004c1eb501ac90"
    },
    {
      "address": "56 Howse Hill NE",
      "assessments": [
        {
          "expand_assessment_value": 140000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2017,
          "expand_assessment_year_source": "Document",
          "property_id": "2c71bcf874e32b98"
        },
        {
          "expand_assessment_value": 622000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2018,
          "expand_assessment_year_source": "Document",
          "property_id": "2c71bcf874e32b98"
        },
        {
          "expand_assessment_value": 620000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2019,
          "expand_assessment_year_source": "Document",
          "property_id": "2c71bcf874e32b98"
        },
        {
          "expand_assessment_value": 567500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2020,
          "expand_assessment_year_source": "Document",
          "property_id": "2c71bcf874e32b98"
        },
        {
          "expand_assessment_value": 571500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2021,
          "expand_assessment_year_source": "Document",
          "property_id": "2c71bcf874e32b98"
        },
        {
          "expand_assessment_value": 683000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2022,
          "expand_assessment_year_source": "Document",
          "property_id": "2c71bcf874e32b98"
        },
        {
          "expand_assessment_value": 787000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2023,
          "expand_assessment_year_source": "Document",
          "property_id": "2c71bcf874e32b98"
        },
        {
          "expand_assessment_value": 859500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2024,
          "expand_assessment_year_source": "Document",
          "property_id": "2c71bcf874e32b98"
        }
      ],
      "property_id": "2c71bcf874e32b98"
    },
    {
      "address": "7 Springbank Mount SW",
      "assessments": [
        {
          "expand_assessment_value": 319000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2005,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 366000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2006,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 508000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2007,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 572500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2008,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 542500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2009,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 500000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2010,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 534500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2011,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 544000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2012,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 557000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2013,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 575500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2014,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 614000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2015,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 592500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2016,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 565500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2017,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 598000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2018,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 596000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2019,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 574500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2020,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 553500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2021,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 603000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2022,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 680000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2023,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        },
        {
          "expand_assessment_value": 731500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2024,
          "expand_assessment_year_source": "Document",
          "property_id": "99d1f7907a150e7"
        }
      ],
      "property_id": "99d1f7907a150e7"
    },
    {
      "address": "415 Wilverside Way SE",
      "assessments": [
        {
          "expand_assessment_value": 346500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2005,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 396000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2006,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 643500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2007,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 729500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2008,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 665000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2009,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 541500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2010,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 605500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2011,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 701000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2012,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 696500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2013,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 771000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2014,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 912000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2015,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 861000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2016,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 851500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2017,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 867500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2018,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 870500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2019,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 832500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2020,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 796500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2021,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 860000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2022,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 961500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2023,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        },
        {
          "expand_assessment_value": 1050000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2024,
          "expand_assessment_year_source": "Document",
          "property_id": "7c34e3f3e8b2b8c0"
        }
      ],
      "property_id": "7c34e3f3e8b2b8c0"
    },
    {
      "address": "908 310 12 Avenue SW",
      "assessments": [
        {
          "expand_assessment_value": 546500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2019,
          "expand_assessment_year_source": "Document",
          "property_id": "26aa132d2598edaf"
        },
        {
          "expand_assessment_value": 505000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2020,
          "expand_assessment_year_source": "Document",
          "property_id": "26aa132d2598edaf"
        },
        {
          "expand_assessment_value": 453000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2021,
          "expand_assessment_year_source": "Document",
          "property_id": "26aa132d2598edaf"
        },
        {
          "expand_assessment_value": 426000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2022,
          "expand_assessment_year_source": "Document",
          "property_id": "26aa132d2598edaf"
        },
        {
          "expand_assessment_value": 453000,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2023,
          "expand_assessment_year_source": "Document",
          "property_id": "26aa132d2598edaf"
        },
        {
          "expand_assessment_value": 527500,
          "expand_assessment_value_source": "Document",
          "expand_assessment_year": 2024,
          "expand_assessment_year_source": "Document",
          "property_id": "26aa132d2598edaf"
        }
      ],
      "property_id": "26aa132d2598edaf"
    }
  ],
  "error": "",
  "pagination": {
    "current_page": 1,
    "has_next_page": true,
    "has_previous_page": false,
    "page_total": 85998
  },
  "price_quote": false,
  "result_total": 515984,
  "time_ms": 43,
  "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"
  }
}