# PadMapper Rental Total

Returns how many rentals PadMapper lists in a location, without any filter. Use search with limit 1 for a filtered total.

- **Documentation:** [https://scrappa.co/docs/padmapper-api/padmapper_total](https://scrappa.co/docs/padmapper-api/padmapper_total)
- **API group:** PadMapper API
- **Endpoint:** `GET https://scrappa.co/api/padmapper/total`

## 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 |
| --- | --- | --- | --- |
| `location` | string | Yes | Location slug from autocomplete: city and state or province code, optionally with a neighborhood or ZIP, for example toronto-on, new-york-ny/chelsea or houston-tx/77002. |

## Example response

```json
{
    "data": {
        "total": 2067,
        "location": "toronto-on"
    },
    "meta": {
        "duration_ms": 640,
        "upstream_calls": 1,
        "endpoint_family": "total"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | The requested listing, building, agent, or city was not found. Rent reports exist for US cities only. 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)