# Willhaben Autocomplete API Documentation

<p>Scrappa's `GET /api/willhaben/autocomplete` endpoint is the Willhaben Autocomplete API documentation page for developers who need place and keyword suggestions as structured JSON.

    ## What this endpoint returns

    Send at least two characters and the response returns matching phrases. Each suggestion reports whether it resolves to a location category or is a free-text suggestion, so a search box can distinguish the two.

    ## How to use it

    Use this to power search-as-you-type, then run the chosen term through [Willhaben Search](/docs/willhaben-api/willhaben_search). Use [Locations](/docs/willhaben-api/willhaben_locations) when you want to browse the tree instead of typing.</p>

- **Documentation:** [https://scrappa.co/docs/willhaben-api/willhaben_autocomplete](https://scrappa.co/docs/willhaben-api/willhaben_autocomplete)
- **API group:** Willhaben API
- **Endpoint:** `GET https://scrappa.co/api/willhaben/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 |
| --- | --- | --- | --- |
| `term` | string | Yes | Search term to complete. |

## Example response

```json
{
    "data": {
        "term": "Wien",
        "suggestions": [
            {
                "count": 4774,
                "phrase": "Wien",
                "category": "Wien",
                "categoryId": 900,
                "totalCount": 4774
            }
        ]
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | The requested listing, agency or seller does not exist upstream. Non-billable, and not retryable: a different exit returns the same 404. |
| 422 | Validation Error | A query parameter failed validation — a missing required id, an unknown vertical, or a value outside the documented range. Messages are per field in Laravel's standard wording, so the accepted vertical ids are published on the `vertical` parameter of each page rather than repeated in the message. Non-billable. |
| 503 | Upstream Rejected The Request | Willhaben answered with a JSON application error — an invalid filter, or a sort id that the vertical does not offer. Non-billable, and not retryable: the same request fails the same way on every exit. Published as 503 because SanitizeApiErrorResponse rewrites every upstream 502 before the response leaves the app; branch on `meta.retryable` rather than on the status code. |
| 503 | Temporarily Unavailable | Willhaben could not be reached at all: no exit was available, the transport failed, the edge refused every exit, or every exit was rate limited. All of these rotate and retry, so this row is always retryable. The `failure_type` says which one happened — `upstream_unreachable`, `transport_error`, `edge_blocked`, `rate_limited` or `attempts_exhausted` — so a caller can tell a dead provider from a throttled one. Non-billable; a later request with a fresh pool fetch is worth making. |

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