!

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

Get permit area context for an appraisal or AVM
This request returns permit history of houses and commercial buildings in the area, to look for any potential activity that would be relevant to an appraisal or AVM
Request
Shell session
curl -X GET "https://api.houski.ca/geocoding?api_key=YOUR_API_KEY&country_abbreviation=ca&expand=permits&expand_permit_application_date_gte=2023-06-01&filter_expand_match=all&latitude=49.26249&longitude=-123.10659&property_type_in=House,Commercial&radius=0.5&results_per_page=1&shape=circle"
TypeScript code
const houski_recipe_data = async (): Promise<GeocodingResponse> => {

    // You must copy the GeocodingResponse type declarations from the 
    // Houski API documentation to strongly type the response

    const url = new URL('https://api.houski.ca/geocoding');
    url.searchParams.set('api_key', 'YOUR_API_KEY');
    url.searchParams.set('country_abbreviation', 'ca');
    url.searchParams.set('expand', 'permits');
    url.searchParams.set('expand_permit_application_date_gte', '2023-06-01');
    url.searchParams.set('filter_expand_match', 'all');
    url.searchParams.set('latitude', '49.26249');
    url.searchParams.set('longitude', '-123.10659');
    url.searchParams.set('property_type_in', 'House,Commercial');
    url.searchParams.set('radius', '0.5');
    url.searchParams.set('results_per_page', '1');
    url.searchParams.set('shape', 'circle');

    const response = await fetch(url);
    const data = await response.json();

    return data;
}

(async () => {
let data: GeocodingResponse = await houski_recipe_data();

// Log the response
console.log(data);
})();
Response
JSON
{
  "cache_hit": false,
  "cost_cents": 0.2199999988079071,
  "data": [
    {
      "address": "11 W 10 Avenue",
      "permits": [
        {
          "expand_permit_application_date": "2024-05-03",
          "expand_permit_content": "License RSN: 4498582|License revision number: 10|Business name: Tenth Avenue Community Food Market|Business trade name: N/A|Status: Issued|Expired date: 2024-12-24|Business type: Food Market|Business sub type: N/A|Number of employees: 0.0|Fee paid: N/A|Extract date: 2025-05-01T03:33:00-06:00",
          "expand_permit_id": "24-217182",
          "expand_permit_type": "Business license",
          "property_id": "951a85b85447f34f"
        },
        {
          "expand_permit_application_date": "2025-01-29",
          "expand_permit_content": "License RSN: 4687498|License revision number: 0|Business name: Tenth Avenue Community Food Market|Business trade name: N/A|Status: Issued|Expired date: 2025-12-31|Business type: Food Market|Business sub type: Community Market|Number of employees: 0.0|Fee paid: 12.0|Extract date: 2025-05-07T01:08:54-06:00",
          "expand_permit_id": "25-311599",
          "expand_permit_type": "Business license",
          "property_id": "951a85b85447f34f"
        }
      ],
      "property_id": "951a85b85447f34f"
    }
  ],
  "error": "",
  "pagination": {
    "current_page": 1,
    "has_next_page": true,
    "has_previous_page": false,
    "page_total": 234
  },
  "price_quote": false,
  "result_total": 234,
  "time_ms": 224
}