# Zumper Sitemap

Lists the public pages Zumper publishes, with title and url. kind: count, search, listings, buildings, addresses, rent-research, or blog. Use it to enumerate listing and building ids.

- **Documentation:** [https://scrappa.co/docs/zumper-api/zumper_sitemap](https://scrappa.co/docs/zumper-api/zumper_sitemap)
- **API group:** Zumper API
- **Endpoint:** `GET https://scrappa.co/api/zumper/sitemap`

## 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 |
| --- | --- | --- | --- |
| `kind` | string | Yes | Which inventory to list. Allowed: count, search, listings, buildings, addresses, rent-research, blog. |
| `site` | string | No | zumper (default) or padmapper. Allowed: zumper, padmapper. |

## Example response

```json
{
    "data": {
        "sitemap": [
            {
                "url": "/apartments-for-rent/beaverton-or/raleigh-west",
                "title": "Apartments for Rent in Raleigh West, Beaverton, OR"
            }
        ]
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | The requested listing, building, or page was not found. This response is not billable. |
| 422 | Validation Error | A required public parameter is missing or invalid. This response is not billable. |
| 503 | Service Unavailable | The service could not obtain a complete result. This response is not billable. |

## 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)