Searches US rentals. Pass geo_mid and geo_type from the locations endpoint, or a free-text location that is resolved first. property_type is a bitmask: apartments, houses, condos, comma separated. Townhomes are not a criteria.type value upstream; filter them client side on listingType 16 from property-placards. amenities filters by upstream amenity code. bbox narrows the results: the upstream search route accepts a bounding box and then ignores it, so bbox is applied locally to the coordinates every listing already returns, and total reports the count inside the box. The upstream search route has no pagination, so one call returns a total count plus at most 500 listings and the response names that cap.
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.
11 optional filters available.
string
Optional
Free-text place name, resolved to a geography before searching. Typeahead entity types are translated into the search vocabulary, so a neighborhood resolves to geo_type 5. If the text matches only entity types the search route cannot take, such as a property, street, or airport, the request fails with 422 unmappable_location rather than returning an empty result.
Chicago, IL
string
Optional
Geography id from the locations endpoint.
example
integer
Optional
1 street address, 2 zip, 3 city, 5 neighborhood.
10
string
Optional
apartments, houses, condos, comma separated. Townhomes are not filterable upstream; filter listingType 16 from property-placards.
apartments
integer
Optional
Lowest monthly rent.
10
integer
Optional
Highest monthly rent.
2200
integer
Optional
Lowest bedroom count.
10
integer
Optional
Highest bedroom count.
10
boolean
Optional
Only listings that accept pets.
true
array
Optional
Upstream amenity codes, for example gym or parking.
["example"]
string
Optional
west,south,east,north. Applied locally to returned coordinates, because upstream ignores it; total then counts only listings inside the box.
example
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/apartments-com/search?location=Chicago%2C+IL&property_type=apartments&max_rent=2200",
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/apartments-com/search?location=Chicago%2C+IL&property_type=apartments&max_rent=2200');
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/apartments-com/search?location=Chicago%2C+IL&property_type=apartments&max_rent=2200', 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/apartments-com/search?location=Chicago%2C+IL&property_type=apartments&max_rent=2200',
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/apartments-com/search?location=Chicago%2C+IL&property_type=apartments&max_rent=2200")
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/apartments-com/search?location=Chicago%2C+IL&property_type=apartments&max_rent=2200", 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/apartments-com/search?location=Chicago%2C+IL&property_type=apartments&max_rent=2200', 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/apartments-com/search?location=Chicago%2C+IL&property_type=apartments&max_rent=2200")
.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/apartments-com/search?location=Chicago%2C+IL&property_type=apartments&max_rent=2200", 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/apartments-com/search?location=Chicago%2C+IL&property_type=apartments&max_rent=2200"
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/apartments-com/search?location=Chicago%2C+IL&property_type=apartments&max_rent=2200"));
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/apartments-com/search?location=Chicago%2C+IL&property_type=apartments&max_rent=2200',
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/apartments-com/search?location=Chicago%2C+IL&property_type=apartments&max_rent=2200")
.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": {
"total": 13058,
"returned": 2,
"listings": [
{
"listing_key": "dsd9v8j",
"price": "$1,741+",
"latitude": 41.88,
"longitude": -87.63
}
]
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Not Found
The requested listing, guide, or sitemap was not found. This response is not billable.
Validation Error
A required public parameter is missing or invalid. 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.