# Zillow Location & Address Lookup

<p>Resolve a place name, region or street address into the identifiers the other Zillow endpoints use. Each result carries a display name, a result type, coordinates, and where applicable a property id and region id.</p><h2>Write freeform prefixes</h2><p>Query with a freeform prefix such as <code>Redmond WA</code> or <code>98101</code>. A comma-form address returns no results.</p><h2>Check the city</h2><p>An ambiguous street number can resolve to a different city than you meant, with no error. Compare the returned <code>city</code> and <code>state</code> against what you asked for before using a property id.</p>

- **Documentation:** [https://scrappa.co/docs/zillow-api/zillow_autocomplete](https://scrappa.co/docs/zillow-api/zillow_autocomplete)
- **API group:** Zillow API
- **Endpoint:** `GET https://scrappa.co/api/zillow/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 | Freeform place prefix, for example "Redmond WA". A comma-form address returns no results. |
| `result_count` | integer | No | Maximum number of results, 1 to 20. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/zillow/autocomplete?query=Redmond+WA"
```

## Example response

```json
{
    "data": {
        "results": [],
        "count": 0
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 400 | The request validation failed | A query parameter is missing, malformed, or outside its documented range. This is the only Zillow response that carries no error code: the body has a message and a field list and nothing else, so match it on the 400 status. |
| 422 | No research dataset matches that family and geography | The requested research file does not exist for the combination given. |
| 422 | More than one research dataset matches | The family, geography and variant given do not identify a single research file. |
| 422 | No accuracy figures are published for that region | The named state or metropolitan area publishes no estimate-accuracy data. |
| 422 | The upstream rejected the request | Zillow answered with a deterministic 4xx. |
| 422 | The building returned does not match the requested address | The decoded building token resolved to a building at a different address than the slug names. |
| 503 | The listing source answered with a block or rate-limit page | The request reached the source, but what came back was a challenge or rate-limit page rather than the data. |
| 503 | The listing source returned a server error | The request was served and answered with a 5xx. |
| 503 | The listing source did not answer in time | The request was sent and no answer came back before the deadline. |
| 503 | The request could not be sent | No approved exit could be reached, so the request never reached the listing source. |
| 503 | No approved exit is available | There was no usable approved exit to send the request through. |
| 503 | The upstream returned a document this integration cannot read | The publisher changed the shape of a response or served a document that is not the expected file. |

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