# Zolo Autocomplete API Documentation

<p><strong>Zolo Autocomplete API</strong> finds places and listing addresses by name. Pass the <code>search_area</code> of a city or neighbourhood as <code>location</code> to the search route. A listing address has a <code>listing_url</code> for the listing route. A query with no match returns an empty list. Failed requests are not billed.</p>

- **Documentation:** [https://scrappa.co/docs/zolo-api/zolo_autocomplete](https://scrappa.co/docs/zolo-api/zolo_autocomplete)
- **API group:** Zolo API
- **Endpoint:** `GET https://scrappa.co/api/zolo/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 |
| --- | --- | --- | --- |
| `q` | string | Yes | Required. Search text, 1 to 100 characters. Example: toronto. |

## Example response

```json
{
    "data": {
        "count": 3,
        "items": [
            {
                "name": "Toronto, ON",
                "type": "city",
                "group": "locations",
                "listing_url": null,
                "search_area": "Toronto",
                "listing_path": null
            },
            {
                "name": "Toronto Gore Rural Estate, Brampton, ON",
                "type": "neighbourhood",
                "group": "locations",
                "listing_url": null,
                "search_area": "Toronto Gore Rural Estate, Brampton",
                "listing_path": null
            },
            {
                "name": "17-Toronto Toronto Lake Road, Georgian Bay, ON",
                "type": "address",
                "group": "listings",
                "listing_url": "https://www.zolo.ca/georgian-bay-real-estate/toronto-toronto-lake-road/17",
                "search_area": null,
                "listing_path": "/georgian-bay-real-estate/toronto-toronto-lake-road/17"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A parameter is missing or invalid. This response is not billable. |
| 503 | Upstream Unavailable | Zolo could not be reached, or returned data that does not match the request. This response is not billable and is retryable. |

## 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)