Searches Canadian property inventory. transaction_type accepts for_sale, for_rent and sold. property_type_group accepts residential and commercial. Range filters use min-max with 0 meaning no upper bound, so bed_range=3-0 is three or more bedrooms. Price filters map to the sale fields for sale and sold inventory and to the rental fields for rent inventory. Scope a search with a bounding box, a geo_id, an individual_id or an organization_id. Results carry the full listing record including the brokerage and the listing agents.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
This endpoint has no required query parameters.
26 optional filters available.
string
Optional
for_sale, for_rent or sold.
for_sale
string
Optional
residential or commercial.
example
string
Optional
price_asc, price_desc, newest, oldest, virtual_tour, most_photos or floor_area.
relevance
integer
Optional
Commercial sub-type, so it requires property_type_group=commercial and is refused with 422 on residential inventory. Coverage overlaps between sub-types, so totals are not additive.
1234567890
integer
Optional
Minimum price in CAD. Applies to the rental range on rent inventory.
10
integer
Optional
Maximum price in CAD. Applies to the rental range on rent inventory.
10
string
Optional
min-max with 0 for no upper bound, for example 3-0.
example
string
Optional
min-max with 0 for no upper bound, for example 2-0.
example
string
Optional
min-max with 0 for no upper bound, for example 1-0.
example
boolean
Optional
Only listings with a garage.
true
boolean
Optional
Only listings with a pool.
true
boolean
Optional
Only waterfront listings.
true
boolean
Optional
Only listings with a fireplace.
true
boolean
Optional
Only listings with air conditioning.
true
boolean
Optional
Only acreage listings.
true
number
Optional
South edge of the bounding box. Send all four bounds together.
43.63
number
Optional
North edge of the bounding box.
43.68
number
Optional
West edge of the bounding box.
-79.43
number
Optional
East edge of the bounding box.
-79.35
string
Optional
Location id from the locations endpoint.
1234567890
integer
Optional
Listings represented by one REALTOR.
1234567890
integer
Optional
Listings from one brokerage.
1234567890
integer
Optional
Page number within the current scope, 1 to 100. The paging hint in a response never names a page beyond that. If the origin still reports pages past that limit, the response carries next.page_ceiling_reached with the current page and the origin's total_pages instead of next.scope_exhausted, so a capped result set is never mistaken for a complete one.
1
integer
Optional
Results requested per page.
2
integer
Optional
Required when transaction_type=sold: look back this many days, capped at 365. A sold search without it is refused with 422 rather than answered with an unbounded national set or a silently narrowed one. Rejected on any other transaction type.
10
integer
Optional
Map zoom used to group result markers. Accepted range 1 to 20, default 12.
10
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/realtor-ca/search?transaction_type=for_sale&latitude_min=43.63&latitude_max=43.68&longitude_min=-79.43&longitude_max=-79.35&records_per_page=2",
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/realtor-ca/search?transaction_type=for_sale&latitude_min=43.63&latitude_max=43.68&longitude_min=-79.43&longitude_max=-79.35&records_per_page=2');
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/realtor-ca/search?transaction_type=for_sale&latitude_min=43.63&latitude_max=43.68&longitude_min=-79.43&longitude_max=-79.35&records_per_page=2', 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/realtor-ca/search?transaction_type=for_sale&latitude_min=43.63&latitude_max=43.68&longitude_min=-79.43&longitude_max=-79.35&records_per_page=2',
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/realtor-ca/search?transaction_type=for_sale&latitude_min=43.63&latitude_max=43.68&longitude_min=-79.43&longitude_max=-79.35&records_per_page=2")
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/realtor-ca/search?transaction_type=for_sale&latitude_min=43.63&latitude_max=43.68&longitude_min=-79.43&longitude_max=-79.35&records_per_page=2", 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/realtor-ca/search?transaction_type=for_sale&latitude_min=43.63&latitude_max=43.68&longitude_min=-79.43&longitude_max=-79.35&records_per_page=2', 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/realtor-ca/search?transaction_type=for_sale&latitude_min=43.63&latitude_max=43.68&longitude_min=-79.43&longitude_max=-79.35&records_per_page=2")
.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/realtor-ca/search?transaction_type=for_sale&latitude_min=43.63&latitude_max=43.68&longitude_min=-79.43&longitude_max=-79.35&records_per_page=2", 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/realtor-ca/search?transaction_type=for_sale&latitude_min=43.63&latitude_max=43.68&longitude_min=-79.43&longitude_max=-79.35&records_per_page=2"
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/realtor-ca/search?transaction_type=for_sale&latitude_min=43.63&latitude_max=43.68&longitude_min=-79.43&longitude_max=-79.35&records_per_page=2"));
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/realtor-ca/search?transaction_type=for_sale&latitude_min=43.63&latitude_max=43.68&longitude_min=-79.43&longitude_max=-79.35&records_per_page=2',
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/realtor-ca/search?transaction_type=for_sale&latitude_min=43.63&latitude_max=43.68&longitude_min=-79.43&longitude_max=-79.35&records_per_page=2")
.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
data
{
"success": true,
"data": {
"search": {
"results": [
{
"Id": "30362491",
"MlsNumber": "C13859810",
"Price": 1200000
}
],
"count": 1,
"paging": {
"total_records": 2777
},
"map_pins": []
}
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Listing Not Found
The requested listing reference number resolved to nothing on the origin. This response is not billable and is not retryable: a well-behaved client should not resend a reference number that does not exist.
Validation Error
A public parameter is invalid, including an unknown transaction type, property group or out-of-range price. This response is not billable.
Service Unavailable
The service could not obtain a complete result. This response is not billable.
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.