Scrappa's GET /api/housesigma/listing returns the full record of one HouseSigma listing.
Input
Pass id, the 16 letter and digit id from the search, nearby or locations endpoint (houses.listing_id). Other values are refused with 422.
What you get
id, address_id, ml_num, url, title, address, price (amount, currency CAD, abbr, gated), status, property_type, location (lat, lon), community, municipality, province, cross_street, postal_code, bedrooms, bedrooms_extra, bathrooms, parking, area, lot, fees (property tax per year, tax_note, maintenance), dates, description, all photos, agency.name, key_facts, details (property, building, inside, utilities, parking and land groups), rooms (type, level, size in metres and feet, features), history (earlier listings of the address), schools, community_stats, estimate (price, rent, rent yield, scores), open_houses, faq and data_source.
Brokerage, not agents
The listing brokerage is returned as agency.name. HouseSigma shows the listing agent only to signed-in users, so there is no agent object and no agent or agency profile endpoint.
Sold and masked values
Sold and leased prices are masked by HouseSigma for visitors who are not signed in, so history entries carry no sold price. A masked price, room count or area is null and price.gated is true.
Unavailable listings
A listing that HouseSigma shows only to signed-in users returns 503 with listing_unavailable. A removed listing returns 404. Both are non-billable.
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.
string
Required
Listing id from search, for example ZxwR7Mj4Jve3KabB.
ZxwR7Mj4Jve3KabB
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/housesigma/listing?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
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/housesigma/listing?id=ZxwR7Mj4Jve3KabB');
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/listing?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));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/housesigma/listing?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);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/housesigma/listing?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
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/listing?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()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/housesigma/listing?id=ZxwR7Mj4Jve3KabB', 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/listing?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());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/housesigma/listing?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))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/housesigma/listing?id=ZxwR7Mj4Jve3KabB"
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/listing?id=ZxwR7Mj4Jve3KabB"));
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/listing?id=ZxwR7Mj4Jve3KabB',
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/listing?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
meta
{
"success": true,
"listing": {
"id": "ZxwR7Mj4Jve3KabB",
"address_id": "0A9X3jP8xJEyvgxV",
"ml_num": "W13861182",
"url": "https://housesigma.com/on/toronto-real-estate/39-exeter-street/home/0A9X3jP8xJEyvgxV/",
"title": "39 Exeter Street, Toronto, Ontario For Sale | HouseSigma",
"address": "39 Exeter Street",
"price": {
"amount": 930000,
"currency": "CAD",
"abbr": "0.93M",
"gated": false
},
"status": {
"kind": "sale",
"text": "For Sale",
"code": "A",
"live": true
},
"property_type": {
"code": "S.",
"label": "Semi-Detached"
},
"location": {
"lat": 43.67327,
"lon": -79.4558
},
"community": {
"id": 108,
"name": "Weston-Pellam Park"
},
"municipality": {
"id": 10343,
"name": "Toronto",
"area": "All GTA - Central"
},
"province": "ON",
"cross_street": "St Clair Ave/Caledonia Rd",
"bedrooms": 3,
"bedrooms_extra": 1,
"bathrooms": 2,
"parking": {
"total": 2,
"garage": 2,
"garage_type": "Detached",
"text": "Detached 2 garages"
},
"area": {
"text": "1100-1500",
"min": 1100,
"max": 1500,
"unit": "feet\u00b2"
},
"lot": {
"front": 18,
"depth": 110,
"area": 1980,
"unit": "feet",
"text": "18 x 110 feet"
},
"fees": {
"tax": 4540,
"tax_note": "$4,540 / 2025",
"maintenance": null
},
"dates": {
"listed_at": "2026-10-05",
"updated_at": "2026-10-25",
"days_on_site": 21
},
"description": "Green with Envy! Imagine having Wadsworth Park practically as your backyard.",
"photos": [
"https://cache-e15.housesigma.com/file/pix-treb/W13861182/e3665_1.jpg?7f6b4e72"
],
"agency": {
"name": "SUTTON GROUP REALTY SYSTEMS INC."
},
"key_facts": [
{
"name": "Lot Size",
"value": "18 x 110 feet"
},
{
"name": "Tax",
"value": "$4,540 / 2025"
}
],
"details": [
{
"group": "Property",
"items": [
{
"name": "Property Type",
"value": "Semi-Detached"
}
]
}
],
"rooms": [
{
"type": "Living Room",
"level": "Main",
"size_m": "3.3 x 3",
"size_ft": "10.8 x 9.8",
"features": "Ceramic Floor,Open Concept,Window"
}
],
"history": [
{
"listing_id": "ZxwR7Mj4Jve3KabB",
"ml_num": "W13861182",
"status": "For Sale",
"kind": "sale",
"price": 930000,
"date_start": null,
"date_end": null
}
],
"schools": [
{
"name": "St. Demetrius Catholic School",
"board": "Toronto Catholic District School Board",
"level": "Elementary",
"distance_m": 5469,
"score": 7.7
}
],
"community_stats": {
"period_name": "September 2026",
"price_sold_median": 963750,
"sold_count": 3,
"dom_avg": 21
},
"estimate": {
"price": null,
"rent": 3872,
"rent_yield": 4.08
},
"open_houses": [],
"faq": [
{
"question": "How many bedrooms and bathrooms does 39 Exeter Street, Toronto, ON have?",
"answer": "3 bedrooms plus 1 additional room and 2 bathrooms."
}
],
"data_source": "PROPTX"
},
"meta": {
"endpoint_family": "listing",
"billable": true,
"attempts": 1
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Not Found
No HouseSigma listing has that id, or the listing was removed (`not_found`). Non-billable.
{
"meta": {
"attempts": 1,
"billable": false,
"retryable": false,
"endpoint_family": "listing"
},
"error": {
"code": "not_found",
"message": "No HouseSigma listing exists with that identifier."
},
"success": false
}Listing Unavailable
HouseSigma shows this listing only to signed-in users (`listing_unavailable`). Scrappa never uses accounts, so the listing cannot be returned. Non-billable.
{
"meta": {
"attempts": 1,
"billable": false,
"retryable": false,
"endpoint_family": "listing"
},
"error": {
"code": "listing_unavailable",
"message": "HouseSigma shows this listing only to signed-in users."
},
"success": false
}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": "listing"
},
"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.