Getting Started

    API Endpoint: https://doorinsight.com/api/
                

The Door Insight API provides access to rental rates and comparable listings for neighbourhoods and cities across Canada.

To use this API, you need an API key. Please contact us at info@doorinsight.com to get your own API key.

Rent By Address

# Here is a curl example
curl \
-X POST https://doorinsight.com/api/search-address \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d '{"city": "toronto", "province": "ON", "street": "York St", "postalCode": "M5J", "beds": "2", "baths": "1", "homeType":"condo", "radius": 5}' 
                

Rent By Address will return median, average, lowest, highest rent and rent per sqft rent. This search looks back to 3 months of data to draw estimations.

Adjusting parameters such as home type, beds, baths and radius will further specify the results.

Providing a radius value is optional and omitting it will allow the system to automatically select a suitable radius that provides the best results.

To retrieve a rent search for an address, you will need to make a POST request to the following url:
https://doorinsight.com/api/search-address

Result example :

{
    "result_count": 17,
    "estimate": 3000,
    "average_price": 3094,
    "lowest_price": 2750,
    "highest_price": 3650,
    "price_per_sqft": 2.03,
    "median_price": 3000,
    "radius": 5,
    "text_address": "1 Mint Leaf Blvd, Brampton, ON, L6R 2Y9, CAN",
    "address_object": {
        "text": "1 Mint Leaf Blvd, Brampton, ON, L6R 2Y9, CAN",
        "lat": 43.758472103513,
        "lon": -79.75151073176
    },
    "home_type": "house",
    "beds": 3,
    "baths": 2,
    "estimate_id": 9
}
                

QUERY PARAMETERS [POST]

Add the following required parameters to your post request.

Rent Stats By City (Coming Soon)

# Here is a curl example
curl \
-X POST https://doorinsight.com/api/search-city \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d '{"city": "toronto", "province": "ON", "beds": "3", "baths": "2", "homeType":"house"}' 
                

Rent by city will return median, average, lowest, highest rent on the city level. This search looks back to 1 months of data to draw estimations. If a sample size greater than 15 is not found, 3 months time span will be used to estimate.

Adjusting parameters such as home type, beds, baths will further specify the results but may also limit sample size, especially in smaller cities.

To retrieve a rent search for a city, you will need to make a POST request to the following url:
https://doorinsight.com/api/search-city

Result example :

{
"query": {"city":"Toronto","homeType":"house","beds":"3","baths":"2"},
"sample_size":29,
"median_price":4199,
"average_price":4445,
"lowest_price":3250,
"highest_price":6995,
"price_per_sqft":3.07
}
                

QUERY PARAMETERS [POST]

Add the following required parameters to your post request.

Rent Stats By Address Area (Coming Soon)

# Here is a curl example
curl \
-X POST https://doorinsight.com/api/search-stats \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d '{"city": "toronto", "province": "ON", "street": "3 Garfield Cres"}' 
                

Rent by address area will return a breakdown of every bedroom type in a 5KM radius depending on the area. This search looks back to 6 months of data to draw estimations. If a sample size greater than 15 is not found, a greater radius or timespan is used.

Result example :

[
    {
        "average_rent": 3687,
        "beds": 3.5
    },
    {
        "average_rent": 8050,
        "beds": 7
    },
    {
        "average_rent": 4294,
        "beds": 5
    },
    {
        "average_rent": 3001,
        "beds": 2.5
    },
    {
        "average_rent": 1695,
        "beds": 1
    },
    {
        "average_rent": 3599,
        "beds": 4
    },
    {
        "average_rent": 1499,
        "beds": 0
    },
    ...
]
                

QUERY PARAMETERS [POST]

Add the following required parameters to your post request.

Address Details (Coming Soon)

# Here is a curl example
curl \
-X POST https://doorinsight.com/api/address-details \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d '{"address": "9 King St, Toronto"' 
                

Address Details will return meta data about a rental address

You will need to make a POST request to the following url:
https://doorinsight.com/api/address-details/

Result example :

{
    "original_query": "9 King St, Toronto",
    "address": "9 King Street, Toronto",
    "city": "Toronto",
    "province": "Ontario",
    "beds": 3,
    "baths": 2,
    "type": "actual"
}
                

QUERY PARAMETERS [POST]

Add the following required parameters to your post request.

Errors

The API uses descriptive errors to help diagnose issues.