# Zumper Autocomplete

Returns matches for a search text: cities, neighborhoods, ZIP codes, addresses, and buildings, each with a label and the slug to pass to search. Set exclude_buildings to skip building matches. Set site to padmapper to use the PadMapper index.

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

## 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 |
| --- | --- | --- | --- |
| `query` | string | Yes | Free text: city, neighborhood, ZIP, address, or building name. |
| `exclude_buildings` | boolean | No | Leave building matches out. |
| `site` | string | No | zumper (default) or padmapper. Allowed: zumper, padmapper. |

## Example response

```json
{
    "data": {
        "status": "success",
        "matches": [
            {
                "box": [],
                "lat": 37.779238,
                "lng": -122.419359,
                "url": "san-francisco-ca",
                "city": "San Francisco",
                "name": "San Francisco",
                "state": "CA",
                "country": "USA",
                "record_id": 396900358,
                "record_type": "city"
            }
        ]
    },
    "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)