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

HouseSigma Nearby Listings API Documentation

GET https://scrappa.co/api/housesigma/nearby?id=ZxwR7Mj4Jve3KabB

Scrappa's GET /api/housesigma/nearby returns similar homes for sale near one HouseSigma listing.

Input

Pass id, the listing id from search. The answer holds the reference listing (id, MLS number, address) and listings, a list of cards in the same shape as the search endpoint, so price, rooms, area, coordinates, status and brokerage are all there. Pass a card id to the listing endpoint for the full record.

Limits

Only homes for sale are returned. HouseSigma's nearby rentals and sold homes are empty or masked for visitors who are not signed in, so they are not offered. Fewer than 10 similar homes are usual. An empty listings list is a real result.

HouseSigma Nearby Listings API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/housesigma/nearby?id=ZxwR7Mj4Jve3KabB
Auth header
x-api-key
Cost
1 credit/request
id = ZxwR7Mj4Jve3KabB
Response preview
200 OK
{
    "success": true,
    "listing_id": "ZxwR7Mj4Jve3KabB",
    "reference": {
        "id": "ZxwR7Mj4Jve3KabB",
        "ml_num": "W13861182",
        "address": "39 Exeter Street"
    },
    "returned": 1,
    "listings": [
        {
            "id": "ZxwR7Mj4Jve3KabB",
            "ml_num": "W13861182",
            "url": "https://housesigma.com/on/toronto-real-estate/39-exeter-street/home/0A9X3jP8xJEyvgxV/",
...

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.

id string Required

Listing id from search, for example ZxwR7Mj4Jve3KabB.

Example value ZxwR7Mj4Jve3KabB

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/housesigma/nearby?id=ZxwR7Mj4Jve3KabB",
    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/nearby?id=ZxwR7Mj4Jve3KabB');

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/nearby?id=ZxwR7Mj4Jve3KabB', 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/nearby?id=ZxwR7Mj4Jve3KabB',
    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/nearby?id=ZxwR7Mj4Jve3KabB")
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/nearby?id=ZxwR7Mj4Jve3KabB", 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/nearby?id=ZxwR7Mj4Jve3KabB', 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/nearby?id=ZxwR7Mj4Jve3KabB")
        .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/nearby?id=ZxwR7Mj4Jve3KabB", 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/nearby?id=ZxwR7Mj4Jve3KabB"
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/nearby?id=ZxwR7Mj4Jve3KabB"));
            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/nearby?id=ZxwR7Mj4Jve3KabB',
            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/nearby?id=ZxwR7Mj4Jve3KabB")
        .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 listing_id reference returned listings meta

Common listings fields

id ml_num url address
JSON Response
200 OK
{
    "success": true,
    "listing_id": "ZxwR7Mj4Jve3KabB",
    "reference": {
        "id": "ZxwR7Mj4Jve3KabB",
        "ml_num": "W13861182",
        "address": "39 Exeter Street"
    },
    "returned": 1,
    "listings": [
        {
            "id": "ZxwR7Mj4Jve3KabB",
            "ml_num": "W13861182",
            "url": "https://housesigma.com/on/toronto-real-estate/39-exeter-street/home/0A9X3jP8xJEyvgxV/",
            "address": "39 Exeter Street",
            "price": {
                "amount": 930000,
                "currency": "CAD",
                "abbr": "0.93M",
                "gated": false
            },
            "bedrooms": 3,
            "bedrooms_extra": 1,
            "bathrooms": 2,
            "parking": {
                "total": 2,
                "garage": 2,
                "garage_type": "Detached",
                "text": "Detached 2 garage,  2 parking"
            },
            "property_type": {
                "code": "S.",
                "label": "Semi-Detached"
            },
            "style": "2-Storey",
            "area": {
                "text": "1100-1500",
                "min": 1100,
                "max": 1500,
                "unit": "feet\u00b2"
            },
            "lot": {
                "front": 18,
                "depth": 110,
                "area": 1980,
                "unit": "feet"
            },
            "location": {
                "lat": 43.67327,
                "lon": -79.4558
            },
            "status": {
                "kind": "sale",
                "text": "For Sale",
                "code": "A",
                "live": true
            },
            "community": "Weston-Pellam Park",
            "municipality": "Toronto",
            "province": "ON",
            "postal_code": null,
            "listed_at": "2026-10-05",
            "updated_at": "2026-10-25",
            "days_on_site": 20,
            "photo": "https://cache-e15.housesigma.com/file/pix-treb/W13861182/e3665_1_1200.webp?7f6b4e72",
            "brokerage": "SUTTON GROUP REALTY SYSTEMS INC.",
            "estimate": null,
            "rent_yield": 4.1,
            "scores": {
                "school": 6,
                "rent": 7,
                "growth": 5
            },
            "tags": [
                "For Sale"
            ],
            "open_house_date": [],
            "data_source": "PROPTX",
            "gated": false
        }
    ],
    "meta": {
        "endpoint_family": "nearby",
        "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": "nearby"
    },
    "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.