API recipes

Requests you can copy and run. Each one returns live data from the API.

A request that selects a field with a source column carries exclude=inferred, which leaves out the values Houski worked out, unless it looks up one named property. Remove it to get those values too.

Examples

Leave out inferred floor areas

Programming language

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

Leave out inferred floor areas
exclude=inferred leaves out every floor area Houski worked out and keeps only the homes whose floor area remains. This pulls Austin homes with interior_sq_m_source saying where each floor area came from. exclude=inferred,observed is stricter and keeps only floor areas from a linked public record. The same parameter checks every selected field that has a source column.
Request
Shell session
curl -X GET "https://api.houski.ca/properties?api_key=YOUR_API_KEY&city=austin&country_abbreviation=us&exclude=inferred&page=1&province_abbreviation=tx&results_per_page=3&select=address,interior_sq_m,interior_sq_m_source"
TypeScript code
const houski_recipe_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', 'austin');
    url.searchParams.set('country_abbreviation', 'us');
    url.searchParams.set('exclude', 'inferred');
    url.searchParams.set('page', '1');
    url.searchParams.set('province_abbreviation', 'tx');
    url.searchParams.set('results_per_page', '3');
    url.searchParams.set('select', 'address,interior_sq_m,interior_sq_m_source');

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

    return data;
}

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

// Log the response
console.log(data);
})();
Response
JSON
{
  "cache_hit": true,
  "checked_fields": [
    "interior_sq_m",
    "interior_sq_m_source"
  ],
  "cost_cents": 0.39000002,
  "data": [
    {
      "address": "10303 Fulton Avenue",
      "interior_sq_m": 140.6552,
      "interior_sq_m_source": "https://traviscad.org/publicinformation",
      "property_id": "10004f251ed3fd8f"
    },
    {
      "address": "4605 Madrona Drive",
      "interior_sq_m": 192.95961,
      "interior_sq_m_source": "https://traviscad.org/publicinformation",
      "property_id": "100060040c2f7ad7"
    },
    {
      "address": "5903 Wellington Drive",
      "interior_sq_m": 154.59065,
      "interior_sq_m_source": "https://traviscad.org/publicinformation",
      "property_id": "10010339156d48b7"
    }
  ],
  "error": "",
  "pagination": {
    "current_page": 1,
    "has_next_page": true,
    "has_previous_page": false,
    "page_total": 72703
  },
  "price_quote": false,
  "result_total": 218107,
  "time_ms": 30,
  "ui_info": {
    "city": "Austin",
    "city_id": "bef7f3c5ea4794db",
    "city_link": "us/tx/austin",
    "city_slug": "austin",
    "country": "United States",
    "country_abbreviation": "US",
    "country_abbreviation_id": "c148472ce4bd39d",
    "country_abbreviation_link": "us",
    "country_slug": "united_states",
    "province": "Texas",
    "province_abbreviation": "TX",
    "province_abbreviation_id": "ccdfc6d473cdc27a",
    "province_abbreviation_link": "us/tx",
    "province_slug": "texas"
  }
}