---
title: "Query areas by signal"
method: GET
path: "/v1/areas"
tags: ["Signals"]
---

# Query areas by signal

`GET /v1/areas`

## Request

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

Rank areas by a signal value. Supports country/LAD scoping, percentile and value filters, and compound multi-signal queries. Deprivation signals (the deciles and ranks, and every domain such as deprivation.income) are relative within a nation, so a deprivation query must pass `country` or `lad`; without one it fails with 400 and the error "Deprivation deciles and ranks are relative within each nation. Pass country=England, Wales or Scotland, or a lad."

## Query parameters

- `signal` string, required
- `country` 'England' | 'Wales' | 'Scotland'
- `lad` string
- `min_percentile` number
- `max_percentile` number
- `min_value` number
- `max_value` number
- `sort` 'percentile' | 'percentile_desc' | 'value' | 'value_desc'
- `limit` integer
- `scope` 'national' | 'regional'
- `bundle` string

## Response `200`

Default Response

- object
  - `signal` string, required
  - `count` number, required
  - `areas` object[], required
    - `geo_type` string, required
    - `geo_code` string, required
    - `value` number, required
    - `normalized_value` number, required
    - `percentile` number, required
    - `period` object
      - `start` string, required
      - `end` string, required
    - `period_basis` 'reference' | 'load'
    - `released_at` string
    - `loaded_at` string, date-time
    - `retrieved_at` string, date-time
    - `signals` object

## Other responses

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