Skip to content
Scrappa Get API key
Condos.ca API 1 credit/request

Condos.ca Autocomplete API Documentation

GET https://scrappa.co/api/condos-ca/autocomplete

Condos.ca Autocomplete API finds cities, districts and neighbourhoods by name and tolerates typos. Each item has an area_id and an area_type. Send both to the search route. sale_count and rent_count show how many active listings the area has. A query with no match returns an empty list. Failed requests are not billed.

Condos.ca Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/condos-ca/autocomplete
Auth header
x-api-key
Cost
1 credit/request
q = coffee shops
Response preview
200 OK
{
    "data": {
        "items": [
            {
                "url": "https://condos.ca/toronto",
                "name": "Toronto",
                "area_id": 1,
                "latitude": 43.721746540723366,
                "area_type": "Locality",
                "long_name": "Toronto",
                "longitude": -79.37494455390618,
                "breadcrumb": "ON",
                "rent_count": 4984,
                "sale_count": 6903,
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

1 optional filter available.

q string Required

Required. Search text, 1 to 100 characters. Example: toronto.

Example value coffee shops
limit integer Optional

Number of areas, 1 to 50. Default 10.

Example value 10

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "items": [
            {
                "url": "https://condos.ca/toronto",
                "name": "Toronto",
                "area_id": 1,
                "latitude": 43.721746540723366,
                "area_type": "Locality",
                "long_name": "Toronto",
                "longitude": -79.37494455390618,
                "breadcrumb": "ON",
                "rent_count": 4984,
                "sale_count": 6903,
                "province_id": 9
            },
            {
                "url": "https://condos.ca/brampton/toronto-gore-rural-estate",
                "name": "Toronto Gore Rural Estate",
                "area_id": 935,
                "latitude": 43.79740075703428,
                "area_type": "Neighbourhood",
                "long_name": "Toronto Gore Rural Estate",
                "longitude": -79.71935969439906,
                "breadcrumb": "Brampton, ON",
                "rent_count": 1,
                "sale_count": 2,
                "province_id": 9
            }
        ],
        "search_metadata": {
            "query": "toronto"
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A parameter is missing or invalid. This response is not billable.

{
    "errors": {
        "q": [
            "The q field is required."
        ]
    },
    "message": "The request validation failed"
}
503

Upstream Unavailable

Condos.ca could not be reached. This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "autocomplete"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Condos.ca could not be reached. Please retry shortly."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.