Scrappa's GET /api/housesigma/search returns HouseSigma listings in Ontario, British Columbia and Alberta as structured JSON, for sale (operation=sale, the default) or for rent (rent).
What you get
One request returns one page of up to 20 listings and the site's own match count in total. Each listing has id (feeds the listing and nearby endpoints), ml_num, url, address, price (amount, currency CAD, abbr, gated), bedrooms, bedrooms_extra, bathrooms, parking, property_type (code and label), style, area (a band such as 1100-1500 square feet with min and max), lot, location (lat, lon), status, community, municipality, province, listed_at, updated_at, days_on_site, one photo, brokerage, estimate, rent_yield, scores, tags, open_house_date and data_source.
Location
municipality_id is required. Take it from /api/housesigma/locations (cities.municipality_id), for example 10343 for Toronto, 10597 for Vancouver (province=BC) or 10511 for Calgary (province=AB). community_id narrows the search to one neighbourhood. An id that HouseSigma does not know returns an empty list.
Filters are honoured
The site applies the filters itself. Scrappa then checks every card once more against sale or rent, type, bedrooms, bathrooms, garage, price, area, lot and listing age, and drops a card that contradicts a filter. The number of dropped cards is meta.filtered_out, so a page can hold fewer than 20 listings. total stays the site's count. applied_filters echoes what was applied.
bedroomsis exact, 0 means studio and 5 means five or more.bathroomsandgarageare minimums.area_minandarea_maxare square feet. HouseSigma reports floor area as a band, and a band is kept when it touches your range.price_minandprice_maxare CAD. For rent they are monthly prices.keywordsearches the listing description and is applied by the site.- Unknown parameters are rejected with
422instead of being ignored.
Masked listings
About one listing in ten hides its price, rooms and area from visitors who are not signed in. Such a listing is returned with gated: true and null values, never with invented numbers. When you filter by price, rooms, area or lot, masked listings are left out because they cannot be checked.
Sort and pagination
sort is newest (default), price_asc or price_desc. page is 1-based with 20 listings per page. HouseSigma serves at most 200 pages and counts at most 4000 matches, so pagination.capped is true for large searches. Slice big areas by neighbourhood (community_id) or add filters to reach other listings. A page past the last result page returns an empty list. It never returns another page's listings.
Run this endpoint
Endpoint
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.
17 optional filters available.
integer
Required
City id from /api/housesigma/locations (cities.municipality_id), for example 10343 for Toronto.
10343
integer
Optional
Neighbourhood id from /api/housesigma/locations (communities.community_id).
1234567890
string
Optional
sale (default) or rent.
sale
string
Optional
ON (default), BC or AB. Use the province of the city.
example
string
Optional
detached, semi_detached, freehold_townhouse, condo_townhouse, condo_apartment, link, multiplex, vacant_land or other.
example
integer
Optional
Minimum price in CAD. Rent is the monthly price.
10
integer
Optional
Maximum price in CAD. Rent is the monthly price.
1200000
integer
Optional
0 (studio) to 5. 5 means five or more.
3
integer
Optional
Minimum bathrooms, 1 to 5.
10
integer
Optional
Minimum garage spaces, 1 to 5.
10
integer
Optional
Minimum floor area in square feet.
10
integer
Optional
Maximum floor area in square feet.
10
integer
Optional
Minimum lot size in square feet.
10
integer
Optional
Maximum lot size in square feet.
10
integer
Optional
Listed within the last 1, 3, 7, 30 or 90 days.
10
string
Optional
Words from the listing description, for example pool.
running shoes
string
Optional
newest (default), price_asc or price_desc.
price_asc
integer
Optional
Result page, 1 to 200. 20 listings per page.
1
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/housesigma/search?municipality_id=10343&operation=sale&bedrooms=3&price_max=1200000&sort=price_asc",
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
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/housesigma/search?municipality_id=10343&operation=sale&bedrooms=3&price_max=1200000&sort=price_asc');
if ($response->successful()) {
echo $response->body();
} else {
echo "Error: " . $response->status();
}
const options = {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE'
}
};
fetch('https://scrappa.co/api/housesigma/search?municipality_id=10343&operation=sale&bedrooms=3&price_max=1200000&sort=price_asc', 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));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/housesigma/search?municipality_id=10343&operation=sale&bedrooms=3&price_max=1200000&sort=price_asc',
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);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/housesigma/search?municipality_id=10343&operation=sale&bedrooms=3&price_max=1200000&sort=price_asc")
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
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/search?municipality_id=10343&operation=sale&bedrooms=3&price_max=1200000&sort=price_asc", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
except Exception as e:
print(f"Error: {e}")
finally:
conn.close()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/housesigma/search?municipality_id=10343&operation=sale&bedrooms=3&price_max=1200000&sort=price_asc', headers=headers)
response.raise_for_status()
print(response.text)
except requests.exceptions.RequestException as e:
print(f"Error: {e}")
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/search?municipality_id=10343&operation=sale&bedrooms=3&price_max=1200000&sort=price_asc")
.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());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/housesigma/search?municipality_id=10343&operation=sale&bedrooms=3&price_max=1200000&sort=price_asc", 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))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/housesigma/search?municipality_id=10343&operation=sale&bedrooms=3&price_max=1200000&sort=price_asc"
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/search?municipality_id=10343&operation=sale&bedrooms=3&price_max=1200000&sort=price_asc"));
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
import axios from 'axios';
async function run(): Promise<void> {
try {
const response = await axios({
method: 'GET',
url: 'https://scrappa.co/api/housesigma/search?municipality_id=10343&operation=sale&bedrooms=3&price_max=1200000&sort=price_asc',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE',
},
});
console.log(response.data);
} catch (error) {
console.error('Error:', error);
}
}
void run();
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/search?municipality_id=10343&operation=sale&bedrooms=3&price_max=1200000&sort=price_asc")
.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
total
returned
pagination
applied_filters
listings
meta
Common listings fields
id
ml_num
url
address
{
"success": true,
"total": 990,
"returned": 1,
"pagination": {
"page": 1,
"limit": 20,
"total_pages": 50,
"has_next_page": true,
"has_previous_page": false,
"capped": false
},
"applied_filters": {
"operation": "sale",
"province": "ON",
"municipality_id": 10343,
"sort": "price_asc",
"bedrooms": 3,
"price_max": 1200000
},
"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": "search",
"billable": true,
"attempts": 1,
"filtered_out": 1
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
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."
}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": "search"
},
"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.