---
title: "Two shapes under one route. `postcode` resolves to an outcode plus the addresses inside it; `term` runs free-text autocomplete and answers with a `results` list instead. A client that typed on `data.addresses` sees null whenever it passes `term`, so both are documented rather than one being silently assumed"
method: GET
path: "/rightmove/address"
tags: ["Rightmove"]
---

# Two shapes under one route. \`postcode\` resolves to an outcode plus the addresses inside it; \`term\` runs free-text autocomplete and answers with a \`results\` list instead. A client that typed on \`data.addresses\` sees null whenever it passes \`term\`, so both are documented rather than one being silently assumed

`GET /rightmove/address`

## Request

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

## Query parameters

- `postcode` string, nullable
- `term` string, nullable

## Response `200`

- object
  - `data` object, required
    - `postcode` string, nullable
    - `outcode` string, nullable
    - `location_identifier` string, nullable
    - `addresses` unknown[]
      - unknown
    - `results` unknown[]
      - unknown
    - `count` integer

## Other responses

- `401`: Unauthorized - API key is missing or invalid
- `422`: Validation error

---

[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/1e1aa78ff103?raw)