500 trial credits · No credit card required

HotPads Find source-compatible locations API

Find source-scoped locality suggestions on HotPads. Get structured JSON through one RealtyCrawl API key.

Send platforms, query, limit in a JSON body. Optional source selectors must be supported by the selected operation. This operation requests source data through its enabled adapter. Preserve observation times, source warnings and any idempotent-replay metadata. Check live capabilities for accepted inputs and availability before running your request.

HotPads API

What can you do with the Find source-compatible locations API?

Find source-scoped locality suggestions on HotPads.

Example request

curl --request POST 'https://realtycrawl.dev/v1/locations/search' \
  --header "x-api-key: $REALTYCRAWL_API_KEY" \
  --header 'X-Max-Credits: 50' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: YOUR_IDEMPOTENCY_KEY' \
  --data '{"platforms":["hotpads"],"query":"Brooklyn","limit":1}'

import os
import json
import requests

headers = {
  "X-Max-Credits": "50",
  "Content-Type": "application/json",
  "Idempotency-Key": "YOUR_IDEMPOTENCY_KEY"
}
headers["x-api-key"] = os.environ["REALTYCRAWL_API_KEY"]
payload = json.loads("{\"platforms\":[\"hotpads\"],\"query\":\"Brooklyn\",\"limit\":1}")

response = requests.request("POST", "https://realtycrawl.dev/v1/locations/search",
    headers=headers, json=payload, timeout=60)
response.raise_for_status()
print(json.dumps(response.json(), indent=2))

const response = await fetch("https://realtycrawl.dev/v1/locations/search", {
  method: "POST",
  headers: {
    "x-api-key": process.env.REALTYCRAWL_API_KEY,
    ...{
      "X-Max-Credits": "50",
      "Content-Type": "application/json",
      "Idempotency-Key": "YOUR_IDEMPOTENCY_KEY"
    }
  },
  body: JSON.stringify({
    "platforms": [
      "hotpads"
    ],
    "query": "Brooklyn",
    "limit": 1
  })
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
console.log(await response.json());

Parameters

Parameters for HotPads Find source-compatible locations API
Parameter	Required	Description
platforms	Yes	platforms
query	Yes	query
limit	Yes	Requested result count, from 1 to 100. The default for source searches is 10; source limits may also apply.

Send platforms, query, limit in a JSON body. Optional source selectors must be supported by the selected operation.

Example response

What does the HotPads Find source-compatible locations API return?

The response includes an array of source-scoped locality suggestions in data, plus source outcomes and request metadata. Explore the structure below before making a call.

Illustrative response

{
  "data": [
    {
      "id": "example_location",
      "name": "Austin, TX",
      "country": "US",
      "type": "locality",
      "source_platform": "hotpads"
    }
  ],
  "meta": {
    "request_id": "example_request",
    "schema_version": "1.0.0",
    "generated_at": "2026-01-01T12:00:00Z",
    "completeness": "unknown",
    "sources": [
      {
        "platform": "hotpads",
        "status": "success"
      }
    ]
  }
}

Schema example with placeholder values; not a live source result. Actual fields, values, and completeness vary by source and request.

API details

How does the HotPads Find source-compatible locations API work?

Send a POST request with your API key and accepted inputs. RealtyCrawl returns structured JSON and preserves the source context for your application.

Method

POST

Response

JSON · CSV · NDJSON

POST /v1/locations/search

Why RealtyCrawl

Why use RealtyCrawl for HotPads Find source-compatible locations?

Keep source collection behind a shared interface so you can focus on the product you’re building.

One API key for supported operations across the RealtyCrawl catalog.
Operation-specific source fields returned in a common JSON schema.
Source identifiers, timestamps, and completeness metadata stay with the result.
50 credits per successful call, with failed calls refunded.

Developer first

How do you bring real estate data into your app?

Use familiar HTTP requests, inspect a common schema, and connect the results to the tools your team already uses.

One key, many sources

Use the same credential across supported operations and check capabilities for each source.

Property data with context

Keep currencies, area units, source identifiers, and observation times with your results.

Your language, your workflow

Call the API with cURL, Python, TypeScript, or any backend that can send an HTTP request.

PythonTypeScript{ }cURL

import requests

# Check current source availability before collecting.
response = requests.get(
    'https://realtycrawl.dev/v1/meta/capabilities',
    params={'platform': 'zillow'}
)
response.raise_for_status()
capabilities = response.json()

// Check current source availability before collecting.
const response = await fetch(
  'https://realtycrawl.dev/v1/meta/capabilities?platform=zillow'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();

curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=zillow'

import requests

# Check current source availability before collecting.
response = requests.get(
    'https://realtycrawl.dev/v1/meta/capabilities',
    params={'platform': 'redfin'}
)
response.raise_for_status()
capabilities = response.json()

// Check current source availability before collecting.
const response = await fetch(
  'https://realtycrawl.dev/v1/meta/capabilities?platform=redfin'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();

curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=redfin'

import requests

# Check current source availability before collecting.
response = requests.get(
    'https://realtycrawl.dev/v1/meta/capabilities',
    params={'platform': 'realtor'}
)
response.raise_for_status()
capabilities = response.json()

// Check current source availability before collecting.
const response = await fetch(
  'https://realtycrawl.dev/v1/meta/capabilities?platform=realtor'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();

curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=realtor'

import requests

# Check current source availability before collecting.
response = requests.get(
    'https://realtycrawl.dev/v1/meta/capabilities',
    params={'platform': 'rightmove'}
)
response.raise_for_status()
capabilities = response.json()

// Check current source availability before collecting.
const response = await fetch(
  'https://realtycrawl.dev/v1/meta/capabilities?platform=rightmove'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();

curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=rightmove'

import requests

# Check current source availability before collecting.
response = requests.get(
    'https://realtycrawl.dev/v1/meta/capabilities',
    params={'platform': 'idealista'}
)
response.raise_for_status()
capabilities = response.json()

// Check current source availability before collecting.
const response = await fetch(
  'https://realtycrawl.dev/v1/meta/capabilities?platform=idealista'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();

curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=idealista'

Capability excerpt · illustrative

{
  "platform": "zillow",
  "operation": "searchPlatformListings",
  "status": "active",
  "geographies": [
    "US"
  ],
  "execution": "sync"
}

{
  "platform": "redfin",
  "operation": "searchPlatformListings",
  "status": "active",
  "geographies": [
    "US"
  ],
  "execution": "sync"
}

{
  "platform": "realtor",
  "operation": "searchPlatformListings",
  "status": "active",
  "geographies": [
    "US"
  ],
  "execution": "sync"
}

{
  "platform": "rightmove",
  "operation": "searchPlatformListings",
  "status": "active",
  "geographies": [
    "GB"
  ],
  "execution": "sync"
}

{
  "platform": "idealista",
  "operation": "searchPlatformListings",
  "status": "active",
  "geographies": [
    "ES"
  ],
  "execution": "sync"
}

ZillowRedfinRealtor.comRightmoveIdealistaBrowse the platform catalog

FAQ

Have a question?
We got answers

Find answers to common questions about HotPads requests, responses, and credits.

How can I try the HotPads Find source-compatible locations API?

Create an account for 500 trial credits, check live capabilities for HotPads, and use the example request above with your API key. This operation lists 50 credits per successful call.

What does the Find source-compatible locations API return?

The JSON response contains an array of source-scoped locality suggestions in data. The meta object carries request diagnostics and source outcomes. CSV/NDJSON exports contain data records with request and credit metadata in headers.

Where do I put the request parameters?

Send platforms, query, limit in a JSON body. Optional source selectors must be supported by the selected operation.

Is this endpoint available for every market?

Availability is operation-specific. Check /v1/meta/capabilities for the platform’s live status, accepted selectors, and markets. Unavailable requests are not charged.

Is this an official HotPads endpoint?

RealtyCrawl is an independent real estate data API and is not affiliated with HotPads.