> Documentation index: https://docs.scrapier.io/llms.txt
> Auth: header `X-API-Key: <key>` · Base: https://api.scrapier.io/api/v2 · Synchronous; paginate with `cursor` ← `data.next_cursor`.

# Realtor.com Property Detail Scraper

Structured Realtor.com data: send `urls`. Cursor-paginated, 1 credit per successful call.

`GET|POST https://api.scrapier.io/api/v2/realtor-property/` · 1 credit per successful call · Cursor-paginated · Long-running

## Overview

Call `GET /api/v2/realtor-property/` with `urls`. The results are in `data.properties`; send `data.next_cursor` back as `cursor` to get the next page. 3 optional parameters refine the call (see Parameters).

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/realtor-property/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "urls=https://www.realtor.com/realestateandhomes-search/Las-Vegas_NV" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/realtor-property/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"urls": "https://www.realtor.com/realestateandhomes-search/Las-Vegas_NV"},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

print(body["data"]["properties"])
```

POST with a JSON body works too (same parameters; the body is merged over the query string).

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `X-API-Key` (header) | string | yes | — | Your API key. |
| `urls` | string | yes | e.g. `https://www.realtor.com/realestateandhomes-search/Las-Vegas_NV` | Realtor.com search or detail URL. Required on first call; ignored when `cursor` is supplied. |
| `cursor` | string | no | — | Pagination cursor returned in the previous response's `next_cursor`. Pass it back unchanged to fetch the next page. When `next_cursor` is null, you have reached the last page. |
| `mode` | string | no | `BUY` | Mode for search URLs: BUY \| RENT \| SELL (detail URLs unchanged). Locked into the cursor. One of: `BUY`, `RENT`, `SELL`. |
| `include_floorplans` | boolean | no | `true` | Include floor plan images in photos. Locked into the cursor. |
| `use_proxy` | boolean | no | `true` | Route the request through Scrapier's residential proxy pool. Default: `true`. Leave as is unless support tells you otherwise. |
| `raw_data` | boolean | no | `false` | When true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under `raw_responses`, in place of the formatted items. When false (default) you get the formatted output. Pagination (`cursor` / `next_cursor`) works the same in both modes. |

## Response

HTTP 200. Results are in `data.properties`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "urls": "https://www.realtor.com/realestateandhomes-search/Las-Vegas_NV",
    "page": 1,
    "page_size": 20,
    "properties": [
      {
        "url": "1234-main-st_las-vegas_nv_89101_M12345-67890",
        "status": "for_sale",
        "id": "1234567890",
        "listPrice": 450000,
        "baths": 3,
        "baths_full": 2,
        "baths_full_calc": 2,
        "beds": 4,
        "sqft": 2150,
        "stories": 2,
        "sub_type": null,
        "text": "Beautiful family home...",
        "type": "single_family",
        "year_built": 2015,
        "coordinates": {
          "latitude": 36.1699,
          "longitude": -115.1398
        },
        "address": {
          "street": "1234 Main St",
          "locality": "Las Vegas",
          "region": "NV",
          "postalCode": "89101"
        },
        "photos": [],
        "scraped_at": "2026-12-01T12:00:00.000Z",
        "input_url": "https://www.realtor.com/realestateandhomes-search/Las-Vegas_NV"
      }
    ],
    "next_cursor": "eyJoIjoiYWJjMTIzZGVmIiwiaSI6Imh0dHBzOi8vd3d3LnJlYWx0b3IuY29tLy4uLiIsInAiOjIsImxrIjp7fX0"
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `urls` | string | `https://www.realtor.com/realestateandhomes-se…` |  |
| `page` | integer | `1` |  |
| `page_size` | integer | `20` |  |
| `properties` | array | `[1 item]` | The results. |
| `next_cursor` | string | `eyJoIjoiYWJjMTIzZGVmIiwiaSI6Imh0dHBzOi8vd3d3L…` | Pass back as `cursor` for the next page. `null` on the last page. |
| `properties[].url` | string | `1234-main-st_las-vegas_nv_89101_M12345-67890` |  |
| `properties[].status` | string | `for_sale` |  |
| `properties[].id` | string | `1234567890` |  |
| `properties[].listPrice` | integer | `450000` |  |
| `properties[].baths` | integer | `3` |  |
| `properties[].baths_full` | integer | `2` |  |
| `properties[].baths_full_calc` | integer | `2` |  |
| `properties[].beds` | integer | `4` |  |
| `properties[].sqft` | integer | `2150` |  |
| `properties[].stories` | integer | `2` |  |
| `properties[].sub_type` | null | `null` |  |
| `properties[].text` | string | `Beautiful family home...` |  |
| `properties[].type` | string | `single_family` |  |
| `properties[].year_built` | integer | `2015` |  |
| `properties[].coordinates` | object | `{…}` |  |
| `properties[].address` | object | `{…}` |  |
| `properties[].photos` | array | `[]` |  |
| `properties[].scraped_at` | string | `2026-12-01T12:00:00.000Z` |  |
| `properties[].input_url` | string | `https://www.realtor.com/realestateandhomes-se…` |  |

## Pagination

Pass `data.next_cursor` back as `cursor` until it is `null`. Required inputs are ignored once a cursor is sent. Each page is one billed call.

```python
import requests

URL = "https://api.scrapier.io/api/v2/realtor-property/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"urls": "https://www.realtor.com/realestateandhomes-search/Las-Vegas_NV"}
items = []

for _ in range(10):  # each page is one billed call
    resp = requests.get(URL, headers=HEADERS, params=params, timeout=210)
    resp.raise_for_status()
    data = resp.json()["data"]
    items.extend(data.get("properties") or [])
    if not data.get("next_cursor"):  # None = last page
        break
    params = {"cursor": data["next_cursor"]}
```

## Errors

Failed calls are free. Branch on HTTP status; the message is in `error` (or `detail`). See https://docs.scrapier.io/errors.md

- **400** Bad input. The exact message varies by endpoint. `{"success":false,"error":"…"}`
- **402** Balance below the endpoint's price. `{"error":"Insufficient credits. Buy more to scrape more.","balance":1,"required":2}`
- **403** Invalid or unknown API key. `{"detail":"Authentication service unavailable or invalid API key."}`
- **429** Throttled — wait for Retry-After. `{"detail":"Request was throttled. Expected available in N seconds."}`
- **404** unknown slug · **503** busy (retry after `Retry-After`) · **5xx** upstream failure or timeout (retry with backoff).

## Notes

- This endpoint can take several minutes. Set your client timeout to at least 210 seconds.

## Related

- [Realtor.com Agents by ZIP](https://docs.scrapier.io/api-reference/realtor/realtor-agent-by-zipcode.md): Structured Realtor.com data: send `zipcodes`. Cursor-paginated, 1 credit per successful call.
- [Realtor.com Search Listings](https://docs.scrapier.io/api-reference/realtor/realtor-search-listings.md): Structured Realtor.com data: send `urls`. Cursor-paginated, 1 credit per successful call.
