---
title: "Resolve one input to a place"
method: GET
path: "/v1/places/resolve"
tags: ["Places"]
---

# Resolve one input to a place

`GET /v1/places/resolve`

## Request

- Base URL: `https://api.onegoodarea.com`
- URL: `https://api.onegoodarea.com/v1/places/resolve`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Resolves a postcode, an official code (ONS, Scottish Government or ISO), a place id or a place name to the place it names, with the alias it resolved through. A name that could mean several places returns candidates with status ambiguous (HTTP 200). An input that names nothing returns status not_found with a reason (HTTP 404). Postcodes, codes and ids resolve on our own spine; names use the place search.

## Query parameters

- `q` string, required

## Response `200`

Default Response

- object
  - `result` union, required
    - object
      - `status` 'resolved', required
      - `input` string, required
      - `place` object, required
        - `place_id` string, required
        - `place_type` 'country' | 'nation' | 'region' | 'district' | 'group' | 'neighbourhood', required
        - `name` string, required
        - `country` string, required
        - `nation` string, required
      - `resolved_via` object, required
        - `kind` 'place_id' | 'postcode' | 'code' | 'name', required
        - `scheme` 'iso3166-1' | 'iso3166-2' | 'ctry' | 'rgn' | 'lad' | 'msoa21' | 'iz2022' | 'lsoa21' | 'dz2022' | 'lsoa11' | 'dz2011' | 'iz2011', required
        - `value` string, required
      - `postcode` object, required
        - `postcode` string, required
        - `status` 'live' | 'terminated', required
        - `terminated_on` string, required
    - object
      - `status` 'ambiguous', required
      - `input` string, required
      - `candidates` object[], required
        - `label` string, required
        - `postcode` string, required
        - `place` object, required
          - `place_id` string, required
          - `place_type` 'country' | 'nation' | 'region' | 'district' | 'group' | 'neighbourhood', required
          - `name` string, required
          - `country` string, required
          - `nation` string, required
    - object
      - `status` 'not_found', required
      - `input` string, required
      - `reason` 'empty_input' | 'input_too_long' | 'invalid_input' | 'invalid_place_id' | 'unknown_place_id' | 'unknown_postcode' | 'unknown_code' | 'nation_not_covered' | 'name_not_found' | 'name_not_supported_in_batch', required
      - `message` string, required
  - `meta` object, required
    - `engine_version` string, required
    - `generated_at` string, required

## Other responses

- `400`: Default Response
- `401`: Default Response
- `403`: Default Response
- `404`: Default Response
- `429`: Default Response
- `500`: Default Response

---

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