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

Zumper Building

GET https://scrappa.co/api/zumper/building

Returns one building with every floorplan (floorplan_listings: rent, beds, baths, area, availability, lease terms, fees), amenities as numbers and readable tags, manager and agents, description, year built, and media. The payload is large, so call it on demand and not in a loop. Set site to padmapper to read the PadMapper copy.

Zumper Building 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zumper/building
Auth header
x-api-key
Cost
1 credit/request
building_id = 1717500
Response preview
200 OK
{
    "data": {
        "lat": 37.78714246632131,
        "lng": -122.39963719035394,
        "name": "Blueground San Francisco",
        "media": [
            {
                "name": null,
                "width": 804,
                "height": 534,
                "media_id": 761884337,
                "media_type": 1,
                "is_available": true,
                "process_state": null
...

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.

building_id string Required

Building id from search results.

Example value 1717500
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": {
        "lat": 37.78714246632131,
        "lng": -122.39963719035394,
        "name": "Blueground San Francisco",
        "media": [
            {
                "name": null,
                "width": 804,
                "height": 534,
                "media_id": 761884337,
                "media_type": 1,
                "is_available": true,
                "process_state": null
            }
        ],
        "street": "New Montgomery St",
        "homepage": "https://www.theblueground.com/sp?placeId=ct-eyJ0eXBlIjoiY...",
        "amenities": [
            17
        ],
        "building_id": 1717500,
        "description": "We\u2019re Blueground, a global proptech company with several ...",
        "book_online_referral_url": null
    },
    "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.