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

HotPads Rental Search API Documentation

GET https://scrappa.co/api/hotpads/search?area=albuquerque-nm&type=apartments

Search rental listings on HotPads for one area: city, zip code, state or neighborhood slug. Each result is one building or house with its name, url, address, location, rent range in USD, beds, baths, square feet, available unit count, price drop count, special offer, labels, photos, and listed and updated dates (ISO 8601, UTC). Filter by property type, bedrooms and rent. Pages hold 40 results; use total_pages and has_more to page. A valid area without matching listings is a successful empty result.

HotPads Rental Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/hotpads/search?area=albuquerque-nm&type=apartments
Auth header
x-api-key
Cost
1 credit/request
area = albuquerque-nm
Response preview
200 OK
{
    "success": true,
    "data": {
        "area": {
            "title": "Albuquerque, NM Apartments for Rent",
            "url": "https://hotpads.com/albuquerque-nm/apartments-for-rent"
        },
        "results": [
            {
                "id": "24fd5j2",
                "name": "Allaso Vineyards",
                "url": "https://hotpads.com/allaso-vineyards-albuquerque-nm-87122-24fd5j2/pad",
                "listing_id": "2c8mre655n0z6",
                "property_type": "large",
...

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.

5 optional filters available.

area string Required

HotPads area slug: city and state such as albuquerque-nm, a zip code such as 60607, a state such as il, or a neighborhood such as river-west-chicago-il. Example: albuquerque-nm.

Example value albuquerque-nm
type string Optional

Property type: apartments, houses, condos or townhomes. Defaults to apartments.

Example value apartments
beds integer Optional

Number of bedrooms, 0 to 5. Use 0 for studios. Works with the apartments and houses types only.

Example value 10
min_price integer Optional

Minimum monthly rent in USD, 0 to 100000.

Example value 10
max_price integer Optional

Maximum monthly rent in USD, at least min_price.

Example value 10
page integer Optional

Page number, 1 to 100. Defaults to 1. Each page holds up to 40 results.

Example value 1

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/hotpads/search?area=albuquerque-nm&type=apartments",
    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/hotpads/search?area=albuquerque-nm&type=apartments');

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/hotpads/search?area=albuquerque-nm&type=apartments', 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/hotpads/search?area=albuquerque-nm&type=apartments',
    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/hotpads/search?area=albuquerque-nm&type=apartments")
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/hotpads/search?area=albuquerque-nm&type=apartments", 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/hotpads/search?area=albuquerque-nm&type=apartments', 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/hotpads/search?area=albuquerque-nm&type=apartments")
        .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/hotpads/search?area=albuquerque-nm&type=apartments", 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/hotpads/search?area=albuquerque-nm&type=apartments"
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/hotpads/search?area=albuquerque-nm&type=apartments"));
            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/hotpads/search?area=albuquerque-nm&type=apartments',
            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/hotpads/search?area=albuquerque-nm&type=apartments")
        .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 meta
JSON Response
200 OK
{
    "success": true,
    "data": {
        "area": {
            "title": "Albuquerque, NM Apartments for Rent",
            "url": "https://hotpads.com/albuquerque-nm/apartments-for-rent"
        },
        "results": [
            {
                "id": "24fd5j2",
                "name": "Allaso Vineyards",
                "url": "https://hotpads.com/allaso-vineyards-albuquerque-nm-87122-24fd5j2/pad",
                "listing_id": "2c8mre655n0z6",
                "property_type": "large",
                "listing_type": "rental",
                "address": {
                    "street": "8901 Holly Ave NE",
                    "city": "Albuquerque",
                    "state": "NM",
                    "zip": "87122"
                },
                "location": {
                    "latitude": 35.17594813075956,
                    "longitude": -106.54412806034088
                },
                "price": {
                    "min": 1677,
                    "max": 2395,
                    "currency": "USD"
                },
                "beds": {
                    "min": 1,
                    "max": 2
                },
                "baths": {
                    "min": 1,
                    "max": 2
                },
                "sqft": {
                    "min": 761,
                    "max": 1154
                },
                "unit_count": 8,
                "price_drop_count": 6,
                "special_offer": "2 Weeks Free",
                "labels": [
                    "New Today",
                    "2 Weeks Free",
                    "Price Drop"
                ],
                "photos": [
                    "https://photos.zillowstatic.com/fp/31fd1c7864172098f9c6095072b18a94-rentals_large_1200_1200.webp",
                    "https://photos.zillowstatic.com/fp/d1508d9e73bec2e49979cfd8a4919c67-rentals_large_1200_1200.webp",
                    "https://photos.zillowstatic.com/fp/d7d5695ea5d28dcc3454d94279690c8f-rentals_large_1200_1200.webp"
                ],
                "listed_at": "2024-06-20T19:46:59Z",
                "updated_at": "2026-10-14T20:54:38Z"
            },
            {
                "id": "24ujecn",
                "name": "Allaso Olivine",
                "url": "https://hotpads.com/allaso-olivine-albuquerque-nm-87113-24ujecn/pad",
                "listing_id": "4f522xwhsm7ad",
                "property_type": "large",
                "listing_type": "rental",
                "address": {
                    "street": "6925 Alameda Blvd NE",
                    "city": "Albuquerque",
                    "state": "NM",
                    "zip": "87113"
                },
                "location": {
                    "latitude": 35.185219271148405,
                    "longitude": -106.56940519809723
                },
                "price": {
                    "min": 1499,
                    "max": 2125,
                    "currency": "USD"
                },
                "beds": {
                    "min": 0,
                    "max": 2
                },
                "baths": {
                    "min": 1,
                    "max": 2
                },
                "sqft": {
                    "min": 643,
                    "max": 1143
                },
                "unit_count": 6,
                "price_drop_count": 6,
                "special_offer": "$$500 Off",
                "labels": [
                    "$$500 Off",
                    "Price Drop"
                ],
                "photos": [
                    "https://photos.zillowstatic.com/fp/5616333195e43fb534575d18c588aba2-rentals_large_1200_1200.webp",
                    "https://photos.zillowstatic.com/fp/4a61dd6ef988234d0ea26000f70f775f-rentals_large_1200_1200.webp",
                    "https://photos.zillowstatic.com/fp/9576ee227e694714c8c9c418049b637d-rentals_large_1200_1200.webp"
                ],
                "listed_at": "2025-08-29T20:47:01Z",
                "updated_at": "2026-10-14T20:55:14Z"
            }
        ],
        "page": 1,
        "per_page": 40,
        "total_pages": 30,
        "total_results": 4453,
        "has_more": true
    },
    "meta": {
        "endpoint_family": "search",
        "billable": true
    }
}

Errors

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

422

Validation Error

A required query parameter is missing or invalid. This response is not billable.

{
    "errors": {
        "area": [
            "The area field is required."
        ]
    },
    "message": "The request validation failed"
}
404

Resource Not Found

The requested HotPads area does not exist. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "search"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested HotPads resource was not found."
    },
    "success": false
}
503

Upstream Unavailable

HotPads blocked the request on every exit, could not be reached, or answered with a page that no longer matches the documented contract (code UPSTREAM_BLOCKED, UPSTREAM_UNAVAILABLE or PARSER_DRIFT). This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The HotPads API 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.