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

Zumper Sitemap

GET https://scrappa.co/api/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.

Zumper Sitemap 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zumper/sitemap
Auth header
x-api-key
Cost
1 credit/request
kind = search
Response preview
200 OK
{
    "data": {
        "sitemap": [
            {
                "url": "/apartments-for-rent/beaverton-or/raleigh-west",
                "title": "Apartments for Rent in Raleigh West, Beaverton, OR"
            }
        ]
    },
    "success": true
}

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.

1 optional filter available.

kind string Required

Which inventory to list. Allowed: count, search, listings, buildings, addresses, rent-research, blog.

Example value search
site string Optional

zumper (default) or padmapper. Allowed: zumper, padmapper.

Example value example

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

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

Errors

Handle these documented responses before retrying or showing customer-facing failures.

Not Found

The requested listing, building, or page was not found. This response is not billable.

Validation Error

A required public parameter is missing or invalid. This response is not billable.

Service Unavailable

The service could not obtain a complete result. This response is not billable.

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.