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

HotPads Listing Detail API Documentation

GET https://scrappa.co/api/hotpads/listing?id=allaso-vineyards-albuquerque-nm-87122-24fd5j2

Retrieve one rental listing from HotPads: name, url, description, address, location, rent range in USD, beds, baths, square feet, available unit count, amenities, lease terms in months, special offers, monthly and one-time fees, floorplans with available units, photos, the listing company and the listed and updated dates (ISO 8601, UTC). An unknown listing id returns a 404 that is not billed.

HotPads Listing Detail API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/hotpads/listing?id=allaso-vineyards-albuquerque-nm-87122-24fd5j2
Auth header
x-api-key
Cost
1 credit/request
id = allaso-vineyards-albuquerque-nm-87122-24fd5j2
Response preview
200 OK
{
    "success": true,
    "data": {
        "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",
        "description": "Live Luxuriously at Allaso Vineyards. Experience luxurious apartment living with one-bedroom and two-bedroom layouts featuring quartz countertops, spacious open floorplans, and stainless-steel appliances. As a tribute to New Mexico's historic past as the oldest wine region in America, Allaso Vineyards offers themed amenities such as grapevines on-site and a winery-inspired lounge. Enjoy resort-style living with a rooftop deck, game lawns, fire pits, private wine lockers, and an indoor-outdoor fitness area. Conveniently located near retail destinations, Allaso Vineyards offers the perfect blend of sophistication and urban walkability.",
        "address": {
            "street": "8901 Holly Ave NE",
            "city": "Albuquerque",
            "state": "NM",
...

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.

id string Required

HotPads listing slug that ends in the lot id, as returned by the search endpoint id and url fields. Example: allaso-vineyards-albuquerque-nm-87122-24fd5j2.

Example value allaso-vineyards-albuquerque-nm-87122-24fd5j2

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/hotpads/listing?id=allaso-vineyards-albuquerque-nm-87122-24fd5j2",
    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/listing?id=allaso-vineyards-albuquerque-nm-87122-24fd5j2');

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/listing?id=allaso-vineyards-albuquerque-nm-87122-24fd5j2', 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/listing?id=allaso-vineyards-albuquerque-nm-87122-24fd5j2',
    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/listing?id=allaso-vineyards-albuquerque-nm-87122-24fd5j2")
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/listing?id=allaso-vineyards-albuquerque-nm-87122-24fd5j2", 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/listing?id=allaso-vineyards-albuquerque-nm-87122-24fd5j2', 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/listing?id=allaso-vineyards-albuquerque-nm-87122-24fd5j2")
        .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/listing?id=allaso-vineyards-albuquerque-nm-87122-24fd5j2", 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/listing?id=allaso-vineyards-albuquerque-nm-87122-24fd5j2"
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/listing?id=allaso-vineyards-albuquerque-nm-87122-24fd5j2"));
            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/listing?id=allaso-vineyards-albuquerque-nm-87122-24fd5j2',
            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/listing?id=allaso-vineyards-albuquerque-nm-87122-24fd5j2")
        .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": {
        "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",
        "description": "Live Luxuriously at Allaso Vineyards. Experience luxurious apartment living with one-bedroom and two-bedroom layouts featuring quartz countertops, spacious open floorplans, and stainless-steel appliances. As a tribute to New Mexico's historic past as the oldest wine region in America, Allaso Vineyards offers themed amenities such as grapevines on-site and a winery-inspired lounge. Enjoy resort-style living with a rooftop deck, game lawns, fire pits, private wine lockers, and an indoor-outdoor fitness area. Conveniently located near retail destinations, Allaso Vineyards offers the perfect blend of sophistication and urban walkability.",
        "address": {
            "street": "8901 Holly Ave NE",
            "city": "Albuquerque",
            "state": "NM",
            "zip": "87122",
            "neighborhood": "Albuquerque"
        },
        "location": {
            "latitude": 35.175946664775,
            "longitude": -106.54412553218
        },
        "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,
        "amenities": [
            "Air Conditioning",
            "Fitness Center",
            "Lounge",
            "Private Wine Lockers",
            "Private Wine Tastings & Events",
            "Rooftop Deck",
            "Sundeck",
            "Swimming Pool"
        ],
        "lease_terms": [
            7,
            8,
            9,
            10,
            11,
            12,
            13,
            15
        ],
        "special_offers": [
            "2 WEEKS FREE (base rent) when you sign a 12-16 month lease. Must move by October 15th. * Fees excluded; restrictions apply"
        ],
        "fees": [
            {
                "name": "Internet Services",
                "amount": 72,
                "currency": "USD",
                "frequency": "monthly"
            },
            {
                "name": "Pest Control Services",
                "amount": 6,
                "currency": "USD",
                "frequency": "monthly"
            },
            {
                "name": "Trash Services - Doorstep",
                "amount": 25,
                "currency": "USD",
                "frequency": "monthly"
            },
            {
                "name": "Security Deposit (Refundable)",
                "amount": 400,
                "max_amount": 500,
                "currency": "USD",
                "frequency": "one_time"
            }
        ],
        "floorplans": [
            {
                "name": "A1",
                "beds": 1,
                "baths": 1,
                "sqft": 761,
                "price": {
                    "min": 1677,
                    "max": 2395,
                    "currency": "USD"
                },
                "available_from": "2026-12-16",
                "units": [
                    {
                        "name": "1219",
                        "available_from": "2026-12-16"
                    }
                ],
                "photos": [
                    "https://photos.zillowstatic.com/fp/43d77940170e010db17789d14709d65a-rentals_large_1200_1200.webp"
                ]
            },
            {
                "name": "A8",
                "beds": 1,
                "baths": 1,
                "sqft": 1154,
                "price": {
                    "min": 1677,
                    "max": 2395,
                    "currency": "USD"
                },
                "units": [
                    {
                        "name": "1205"
                    }
                ],
                "photos": [
                    "https://photos.zillowstatic.com/fp/bb84145fc6e1c989423ad63c590ba0d4-rentals_large_1200_1200.webp"
                ]
            }
        ],
        "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_by": "Greystar",
        "listed_at": "2024-06-20T19:46:59Z",
        "updated_at": "2026-10-14T20:54:38Z"
    },
    "meta": {
        "endpoint_family": "listing",
        "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": {
        "id": [
            "The id field is required."
        ]
    },
    "message": "The request validation failed"
}
404

Resource Not Found

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

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "listing"
    },
    "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": "listing"
    },
    "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.