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

HouseSigma Market Summary API Documentation

GET https://scrappa.co/api/housesigma/market?municipality_id=10343

Scrappa's GET /api/housesigma/market returns the current market summary of one city on HouseSigma.

What you get

municipality (id, name, province, slug, location), period, median_sold_price_90_days, active_listings, average_days_on_market, sold_count, new_listings, median_sold_price and price_change (month, year, five years, ten years). A figure that HouseSigma does not publish for the city is null. property_types shows the active listings per property type with their share. highlights holds the monthly market text of the site and summary its one-line summary. nearby_municipalities lists other cities with their ids.

Input

municipality_id comes from /api/housesigma/locations. Use the matching province. An unknown id returns a non-billable 422 (unknown_location). The summary covers the whole city and all property types.

HouseSigma Market Summary API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/housesigma/market?municipality_id=10343
Auth header
x-api-key
Cost
1 credit/request
municipality_id = 10343
Response preview
200 OK
{
    "success": true,
    "municipality": {
        "id": 10343,
        "name": "Toronto",
        "province": "ON",
        "slug": "/on/toronto-real-estate",
        "location": {
            "lon": -79.3831843,
            "lat": 43.653226
        }
    },
    "period": "October 2026",
    "median_sold_price_90_days": 830000,
...

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.

municipality_id integer Required

City id from /api/housesigma/locations (cities.municipality_id), for example 10343 for Toronto.

Example value 10343
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/market?municipality_id=10343",
    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/market?municipality_id=10343');

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/market?municipality_id=10343', 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/market?municipality_id=10343',
    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/market?municipality_id=10343")
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/market?municipality_id=10343", 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/market?municipality_id=10343', 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/market?municipality_id=10343")
        .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/market?municipality_id=10343", 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/market?municipality_id=10343"
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/market?municipality_id=10343"));
            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/market?municipality_id=10343',
            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/market?municipality_id=10343")
        .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 municipality period median_sold_price_90_days active_listings average_days_on_market sold_count new_listings +7 more

Common property_types fields

code label listings share
JSON Response
200 OK
{
    "success": true,
    "municipality": {
        "id": 10343,
        "name": "Toronto",
        "province": "ON",
        "slug": "/on/toronto-real-estate",
        "location": {
            "lon": -79.3831843,
            "lat": 43.653226
        }
    },
    "period": "October 2026",
    "median_sold_price_90_days": 830000,
    "active_listings": 4977,
    "average_days_on_market": 32,
    "sold_count": null,
    "new_listings": null,
    "median_sold_price": null,
    "price_change": {
        "month": null,
        "year": null,
        "five_years": null,
        "ten_years": null
    },
    "property_types": [
        {
            "code": "C.",
            "label": "Condo Apt",
            "listings": 37048,
            "share": 0.61
        }
    ],
    "highlights": [
        {
            "title": "September 2026 Toronto Median Rental Price",
            "text": "In September 2026, Toronto had a median rental price of $2,600."
        }
    ],
    "summary": "There are 5145 real estate and homes for sale in Toronto, ON for sale.",
    "nearby_municipalities": [
        {
            "municipality_id": 10343,
            "name": "Toronto",
            "slug": "/on/toronto-real-estate"
        }
    ],
    "meta": {
        "endpoint_family": "market",
        "billable": true,
        "attempts": 1
    }
}

Errors

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

422

Unknown Location

HouseSigma does not know the `municipality_id` (`unknown_location`). Take the id from `/api/housesigma/locations`. Non-billable.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": false,
        "endpoint_family": "market"
    },
    "error": {
        "code": "unknown_location",
        "message": "Unknown location. Use a municipality_id from /api/housesigma/locations."
    },
    "success": false
}
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": "market"
    },
    "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.