---
title: "GET /zoopla/locations"
method: GET
path: "/zoopla/locations"
tags: ["Zoopla"]
---

# GET /zoopla/locations

`GET /zoopla/locations`

## Request

- Base URL: `https://scrappa.co/api`
- URL: `https://scrappa.co/api/zoopla/locations`
- Auth: API key in header `X-API-KEY`

## Query parameters

- `query` string, required

## Response `200`

- union
  - string
  - object
    - `success` boolean, required
    - `query` string, required
    - `geo_suggestions` object, required
    - `areas` unknown[], required: geoIdentifier is null on every autocomplete area row, so it is dropped rather than surfaced as a search key that cannot be searched with.
      - unknown
    - `addresses` unknown, required
    - `raw` unknown, required
    - `meta` object, required
      - `retry_count` integer, required
      - `graphql_errors` unknown, required
      - `resolved_geo_identifier` string, nullable, required

## Other responses

- `401`: Unauthorized - API key is missing or invalid
- `404`: This integration is currently disabled on the server. Availability is switched per environment, so it can be off during a staged rollout.
- `422`: One or more input parameters are missing or invalid.
- `500`: The request could not be processed because of a fault in this service, not the data source. No credit is charged.
- `503`: The data source answered but the response could not be used: empty, oversized, undecodable, or carrying errors with no usable data. No credit is charged. The data source could not complete this request. Try again later.

---

[API](https://skmtc.dev/scrappa/apis/scrappa-api-documentation.md) · [All operations](https://skmtc.dev/scrappa/apis/scrappa-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/scrappa/apis/scrappa-api-documentation/revisions/2f4af6143d10?raw)