Scrappa's `GET /api/willhaben/locations` endpoint is the Willhaben Locations API documentation page for developers who need Austrian provinces and districts as structured JSON.
## What this endpoint returns
Each response returns one level of the Austrian location tree with the live listing count for every value, so you can build a location picker or scope a search to a region. Omit `area_id` for the nine provinces; pass the id of a province as `area_id` to descend to its districts. A response names the level it answered at in `navigatorId`, because Willhaben serves the walk from its own facet navigator rather than a fixed tree, and that id is what tells you which vocabulary you are looking at. Expect `province` at the top and `district` one level below. `navigatorId` is null when the response carries no values at all — an `area_id` with nothing under it — so treat null as empty rather than as a level. Levels deeper than a district exist upstream and are passed through verbatim, but a descent past a district has not been verified against a captured payload, so treat anything below `district` as undocumented until you have seen it yourself.
## How to use it
Resolve a location first, then pass the id to [Willhaben Search](/docs/willhaben-api/willhaben_search) as `area_id`. Use [Autocomplete](/docs/willhaben-api/willhaben_autocomplete) when your users type a place name instead of browsing a list.</p>
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
This endpoint has no required query parameters.
2 optional filters available.
integer
Optional
Parent location id to descend one level. Omit for provinces.
1234567890
integer
Optional
Vertical id the counts are measured against. One of: 12 Ferienimmobilien kaufen, 14 Grundstuecke, 15 Gewerbe kaufen, 16 Gewerbe mieten, 32 Ferienimmobilien mieten, 35 Sonstige, 42 Neubauprojekte, 90 Immobilien, 101 Eigentumswohnung, 102 Haus kaufen, 131 Mietwohnungen, 132 Haus mieten. Defaults to 131 (Mietwohnungen).
10
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
success
{
"data": {
"locations": [
{
"id": 3,
"hits": 4133,
"label": "Nieder\u00f6sterreich"
},
{
"id": 900,
"hits": 4819,
"label": "Wien"
}
],
"rowsFound": 19604,
"navigatorId": "province",
"parentAreaId": null
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Not Found
The requested listing, agency or seller does not exist upstream. Non-billable, and not retryable: a different exit returns the same 404.
{
"meta": {
"billable": false,
"retryable": false
},
"error": {
"code": "NOT_FOUND",
"message": "The requested Willhaben resource was not found.",
"failure_type": "not_found"
},
"success": false
}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.
{
"errors": {
"adId": [
"The adId field is required."
]
},
"message": "The request validation failed"
}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.
{
"meta": {
"billable": false,
"retryable": false
},
"error": {
"code": "UPSTREAM_REJECTED",
"message": "Willhaben could not accept this request. Please check the filters and retry.",
"failure_type": "invalid_request"
},
"success": false
}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.
{
"meta": {
"billable": false,
"retryable": true
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "The Willhaben API is temporarily unavailable. Please retry.",
"failure_type": "transport_error"
},
"success": false
}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.