Skip to content
Scrappa Get API key
HouseSigma API 1 credit/request

HouseSigma Location Autocomplete API Documentation

GET https://scrappa.co/api/housesigma/locations?q=toronto

Scrappa's GET /api/housesigma/locations suggests places for a text, such as toronto, a street or a neighbourhood.

What you get

Six lists, each possibly empty:

  • cities: municipality_id (use it in search and market), name, label, province, slug and location.
  • communities and community_suggestions: neighbourhoods with community_id (use it as community_id in search), municipality_id, municipality, province and location.
  • places: address and area matches with a listing_id when the match is a listing.
  • houses: matching listings with address, price, rooms text, status, location and photo. listing_id feeds the listing endpoint.
  • precon: new-build projects with name, address, property types, completion and photo.

Pass province (ON, BC or AB) to bias the suggestions to that province.

HouseSigma Location Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/housesigma/locations?q=toronto
Auth header
x-api-key
Cost
1 credit/request
q = toronto
Response preview
200 OK
{
    "success": true,
    "query": "toronto",
    "province": "ON",
    "cities": [
        {
            "municipality_id": 10343,
            "name": "Toronto",
            "label": "Toronto, ON",
            "province": "ON",
            "slug": "toronto-real-estate",
            "location": {
                "lat": 43.653226,
                "lon": -79.3831843
...

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

Search text, at least 2 characters, for example toronto.

Example value toronto
province string Optional

ON (default), BC or AB.

Example value example

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/housesigma/locations?q=toronto",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/housesigma/locations?q=toronto');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/housesigma/locations?q=toronto', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/housesigma/locations?q=toronto',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/housesigma/locations?q=toronto")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/housesigma/locations?q=toronto", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/housesigma/locations?q=toronto', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/housesigma/locations?q=toronto")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/housesigma/locations?q=toronto", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/housesigma/locations?q=toronto"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/housesigma/locations?q=toronto"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/housesigma/locations?q=toronto',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/housesigma/locations?q=toronto")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

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

Example response fields

Scan these fields before integrating.

success query province cities communities community_suggestions places houses +2 more

Common cities fields

municipality_id name label province
JSON Response
200 OK
{
    "success": true,
    "query": "toronto",
    "province": "ON",
    "cities": [
        {
            "municipality_id": 10343,
            "name": "Toronto",
            "label": "Toronto, ON",
            "province": "ON",
            "slug": "toronto-real-estate",
            "location": {
                "lat": 43.653226,
                "lon": -79.3831843
            }
        }
    ],
    "communities": [
        {
            "community_id": 67,
            "name": "Danforth",
            "municipality_id": 10343,
            "municipality": "Toronto",
            "province": "ON",
            "location": {
                "lat": 43.6845831,
                "lon": -79.3289205
            }
        }
    ],
    "community_suggestions": [],
    "places": [
        {
            "listing_id": "eVbOYENw0kKyx2P0",
            "label": "Toronto Avenue, Oshawa - Central, ON",
            "municipality_id": 10243,
            "province": "ON",
            "location": {
                "lat": 43.88416,
                "lon": -78.84898
            }
        }
    ],
    "houses": [
        {
            "listing_id": "eVbOYENw0kKyx2P0",
            "address": "Toronto Avenue",
            "community": "Central",
            "municipality_id": 10243,
            "municipality": "Oshawa",
            "province": "ON",
            "property_type": "Vacant Land",
            "rooms": "0 Bedroom, 0 Bathroom,  Garage",
            "price": 219000,
            "status": "For Sale",
            "location": {
                "lat": 43.88416,
                "lon": -78.84898
            },
            "photo": null
        }
    ],
    "precon": [
        {
            "project_id": "njJKdOYrjY54lWL8",
            "name": "155 Cumberland",
            "address": "15 Cumberland St, Toronto",
            "municipality": "Toronto",
            "province": "ON",
            "property_types": [
                "Condo"
            ],
            "price": null,
            "completion": null,
            "photo": null
        }
    ],
    "meta": {
        "endpoint_family": "locations",
        "billable": true,
        "attempts": 1
    }
}

Errors

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

422

Validation Error

A query parameter is missing, unknown or unusable, for example `page` above 200. Unknown parameters are rejected, never ignored. Non-billable.

{
    "errors": {
        "type": [
            "The selected type is invalid."
        ]
    },
    "message": "The selected type is invalid."
}
503

Upstream Unavailable

HouseSigma could not be reached after retries, answered with an error, or returned an unexpected answer (`upstream_unavailable`, `upstream_blocked`, `token_unavailable`, `upstream_changed`). Retryable and never billed. Clients are never rate limited.

{
    "meta": {
        "attempts": 3,
        "billable": false,
        "retryable": true,
        "endpoint_family": "locations"
    },
    "error": {
        "code": "upstream_unavailable",
        "message": "HouseSigma is temporarily unavailable. Please retry."
    },
    "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.