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

PadMapper Building Extras

GET https://scrappa.co/api/padmapper/building-additional

Returns the short description, pet policy, rent special, and minimum lease days for one building.

PadMapper Building Extras 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/padmapper/building-additional
Auth header
x-api-key
Cost
1 credit/request
building_id = 2058520
Response preview
200 OK
{
    "data": {
        "building_id": 2058520,
        "min_lease_days": 365,
        "pet_policy_json": null,
        "rent_special_info": "[\"Up to One Month Free Rent\"]",
        "truncated_description": "Live at Mirvish Village\n\nLocated at Bloor and Bathurst, Toronto, Mirvish Village is a purpose-built rental community designed for modern city living. Set on the historic site of Honest Ed\u2019s, it brings together culture, convenience, and everyday comfort in one of Toronto\u2019s most connected neighbourho"
    },
    "meta": {
        "duration_ms": 640,
        "upstream_calls": 1,
        "endpoint_family": "building-additional"
    },
    "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.

building_id string Required

Building id from search results.

Example value 2058520

Response Schema

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

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "building_id": 2058520,
        "min_lease_days": 365,
        "pet_policy_json": null,
        "rent_special_info": "[\"Up to One Month Free Rent\"]",
        "truncated_description": "Live at Mirvish Village\n\nLocated at Bloor and Bathurst, Toronto, Mirvish Village is a purpose-built rental community designed for modern city living. Set on the historic site of Honest Ed\u2019s, it brings together culture, convenience, and everyday comfort in one of Toronto\u2019s most connected neighbourho"
    },
    "meta": {
        "duration_ms": 640,
        "upstream_calls": 1,
        "endpoint_family": "building-additional"
    },
    "success": true
}

Errors

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

Not Found

The requested listing, building, agent, or city was not found. Rent reports exist for US cities only. 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.