/predict

GET

https://api.houski.ca/predict

The predict endpoint is used for predicting various property metrics over time such as list prices, sale prices and rent prices.

This endpoint handles single and batch requests. Batch requests, which enable predictions for multiple properties at once, are useful for analyzing trends across a portfolio of properties.

To see all the fields that can be be predicted, see the fields page.

Example use cases

You can find examples for common use cases on our recipes page.

Local governments can anticipate housing market trends to plan for affordable housing initiatives
Property managers can set competitive rent prices based on predicted market trends
Home buyers can determine the best time to buy a property based on predicted sale prices
Home sellers can decide when to put a property on the market for maximum profit
Data analysts can integrate property prediction data into broader economic models or studies
Mortgage lenders can evaluate the risk of mortgage default based on future property values
App developers can integrate real-time property predictions into apps for various industries, such as finance or real estate
Academic researchers can conduct studies on housing markets and urban development risks using predictive data

Request parameters

Name	Required	Type	Description
api_key	Yes	UUID v4	Authorization API key
property_id	Yes	String	The target property's ID (for batch selection, seperate ids by a comma)
start_date	Yes	String	Start date for prediction in YYYY-MM-DD format
fields	Yes	String	Any predictable field
period	No (default: week)	String	The time period for the predictions - day, week, month, year
next	No (default: 0)	Integer	How many future periods after the start_date to predict
last	No (default: 0)	Integer	How many previous periods before the start_date to predict

Response object

Type declarations are available at the bottom of this page.

Name	Type	Description
cache_hit	Boolean	Indicates if the data was retrieved from the cache
cost_cents	Number	Cost of the API call in cents
data	Object	Contains the prediction data
error	String	Details about the error. Empty if no error
pagination	Object	Pagination information
price_quote	Boolean	Request is for a price quote
result_total	Number	Total number of results
time_ms	Number	Time taken for the request to complete in milliseconds

Example requests and responses

Programming language

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

Predict a property's list and sale price

By default, predict endpoint responses are returned in a nested format.

Request

Shell session

curl -X GET "https://api.houski.ca/predict?api_key=YOUR_API_KEY&fields=estimate_sale_price,estimate_list_price&last=3&next=3&period=week&property_id=bd9c6fb24c31c772&start_date=2023-02-01"

TypeScript code

const houski_predict_data = async (): Promise<PredictResponse> => {

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

    const url = new URL('https://api.houski.ca/predict');
    url.searchParams.set('api_key', 'YOUR_API_KEY');
    url.searchParams.set('fields', 'estimate_sale_price,estimate_list_price');
    url.searchParams.set('last', '3');
    url.searchParams.set('next', '3');
    url.searchParams.set('period', 'week');
    url.searchParams.set('property_id', 'bd9c6fb24c31c772');
    url.searchParams.set('start_date', '2023-02-01');

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

    return data;
}

(async () => {
let data: PredictResponse = await houski_predict_data();

// Log the response
console.log(data);
})();

Response

JSON

{
  "cache_hit": false,
  "cost_cents": 0.14000000059604645,
  "data": [
    {
      "predictions": [
        {
          "date": "2023-01-11",
          "estimate_list_price": 255993.0,
          "estimate_sale_price": 244139.0
        },
        {
          "date": "2023-01-18",
          "estimate_list_price": 255817.0,
          "estimate_sale_price": 246208.0
        },
        {
          "date": "2023-01-25",
          "estimate_list_price": 262163.0,
          "estimate_sale_price": 253326.0
        },
        {
          "date": "2023-02-01",
          "estimate_list_price": 262748.0,
          "estimate_sale_price": 254070.0
        },
        {
          "date": "2023-02-08",
          "estimate_list_price": 264171.0,
          "estimate_sale_price": 253568.0
        },
        {
          "date": "2023-02-15",
          "estimate_list_price": 264590.0,
          "estimate_sale_price": 253834.0
        },
        {
          "date": "2023-02-22",
          "estimate_list_price": 266310.0,
          "estimate_sale_price": 257313.0
        }
      ],
      "property_id": "bd9c6fb24c31c772"
    }
  ],
  "error": "",
  "price_quote": true,
  "result_total": 1,
  "time_ms": 935
}

Response type declarations

TypeScript code

interface PredictResponse {
    cache_hit: boolean;
    cost_cents: number;
    data: PredictData[];
    error: string;
    price_quote: boolean;
    result_total: number;
    time_ms: number;
}

interface PredictData {
    property_id: string;
    predictions: Prediction[];
}

interface Pagination {
    current_page: number;
    has_next_page: boolean;
    has_previous_page: boolean;
    page_total: number;
}

API Docs

Properties

Services