# Madlan Listing Corpus API

Return Madlan listing ids from the public listing sitemaps, in pages. This is the corpus to walk when you need to resolve every listing rather than a search result set: take ids from here and resolve them fifty at a time with the listing details endpoint. The corpus is built in the background and cached, so this call reads a shared artefact and never walks the sitemaps itself. While the corpus is cold the endpoint answers 503 with error.code upstream_unavailable, schedules a rebuild, and charges nothing.

- **Documentation:** [https://scrappa.co/docs/madlan-api/madlan_listing_ids](https://scrappa.co/docs/madlan-api/madlan_listing_ids)
- **API group:** Madlan API
- **Endpoint:** `GET https://scrappa.co/api/madlan/listings/ids`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `offset` | integer | No | Number of ids to skip. |
| `limit` | integer | No | Number of ids to return, 1 to 100. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/madlan/listings/ids?limit=3"
```

## Example response

```json
{
    "success": true,
    "total": 46500,
    "offset": 0,
    "limit": 3,
    "returned": 3,
    "listing_ids": [
        "FBcaajDIb2q",
        "pjo0z0Yqsh1",
        "ojKitWjiZOP"
    ],
    "notes": [
        "These ids come from the public listing sitemaps. That corpus is larger than, and not a superset of, the live search corpus: an id from search may be absent here, and both resolve normally through the batch listing endpoint.",
        "The corpus is built in the background and cached, so this call reads a shared artefact and never walks the sitemaps. A cold corpus answers 503 with error.code upstream_unavailable and is never billed."
    ]
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 503 | Madlan rejected the query | Madlan answered the request but refused to compute it. Branch on `error.code`: this response is not retryable. Nothing is charged for a failed request. |
| 503 | Madlan refused the request | Madlan answered with a client-side rejection before running the query, for example a bad path or an unsupported document. Retrying the same request changes nothing. Branch on `error.code`: this response is not retryable. Nothing is charged. |
| 503 | Madlan returned an unreadable response | Madlan answered, but not with the shape this endpoint reads, for example an HTML page where structured data was expected. The request was not answered, so it is not billed. Branch on `error.code`: this response is not retryable. |
| 503 | Madlan is temporarily unavailable | The upstream could not be reached, returned a server error, or throttled the request. `rate_limited_upstream` is the throttle path and is retryable once the wait has passed; `upstream_unavailable` covers a connection that could not be established, a server error, and a listing corpus that is still cold — the corpus is built in the background, so a cold one is a 503 that schedules a rebuild rather than a fan-out inside your request. Branch on `error.code`, then try again shortly. Nothing is charged. |
| 422 | Invalid parameters | One or more parameters are missing, out of range, or a filter Madlan cannot apply. Filters it cannot apply are refused rather than ignored, so the response never carries the unfiltered corpus in answer to a filter. The response lists the offending fields. |
| 404 | No record under that id | The id is well-formed and Madlan answered, but nothing is published under it. The body carries `found => false`. The lookup was answered, so it is billed; unlike a 503 this is not an upstream fault and retrying will not change it. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)