---
title: "Find peers"
method: POST
path: "/v1/peers"
tags: ["Intelligence"]
---

# Find peers

`POST /v1/peers`

## Request

- Base URL: `https://api.onegoodarea.com`
- URL: `https://api.onegoodarea.com/v1/peers`
- Auth: HTTP bearer

Find k-nearest-neighbour peers for an area by normalized signal values. A retired postcode resolves to the neighbourhood it was in; target.postcode_status and meta.warnings say so.

## Request body

- object
  - `target` object, required: Exactly one of geo_code, postcode, or area must be set.
    - `geo_code` string
    - `postcode` string
    - `area` string
  - `signals` string[]: Subset of signal dimensions to compare on.
  - `country` 'England' | 'Wales' | 'Scotland'
  - `lad` string
  - `cohort` string: Slug of one of your org's cohorts: candidates are limited to its members.
  - `cohort_id` string: The same, by cohort id. Use one of cohort or cohort_id.

## Response `200`

Default Response

- object
  - `target` object, required
    - `geo_code` string, required
    - `signals_used` string[], required
    - `postcode_status` 'live' | 'terminated'
    - `postcode_terminated_on` string
  - `peers` object[], required
    - `geo_code` string, required
    - `distance` number, required
    - `n_dims_used` integer, required
    - `admin_district` string
    - `region` string
    - `sample_postcode` string
  - `meta` object, required
    - `generated_at` string, required
    - `scope` string, required
    - `warnings` string[]

## Other responses

- `400`: Default Response
- `404`: Default Response
- `422`: 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)