Signals

Query areas by signal

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."

get/v1/areas

Request

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

Query parameters

signalstring required

Signal key to rank by (e.g. 'crime.total_12m', 'deprivation.income').

country'England' | 'Wales' | 'Scotland'

Required with a deprivation signal unless lad is given.

ladstring

Local authority district code. Required with a deprivation signal unless country is given.

min_percentilenumber

Keep areas at or above this national percentile (0 to 100).

max_percentilenumber

Keep areas at or below this national percentile (0 to 100).

min_valuenumber

Keep areas whose value is at least this.

max_valuenumber

Keep areas whose value is at most this.

sort'percentile' | 'percentile_desc' | 'value' | 'value_desc'

Order of the ranked list.

limitinteger

Rows to return; capped at 1000.

scope'national' | 'regional'

Rank within the nation (default) or within the region.

bundlestring

Optional bundle ID to scope available signals.

Response

Default Response

signalstring required
countnumber required

Changes

No recorded changes to this operation across all 2 revisions of this API.