Signals

Get area profile

Changed on

Full signal profile for a UK postcode (live or retired), a OneGoodArea place id, an official neighbourhood code or a place name. Returns geo metadata plus all signal categories with sources. A store-backed neighbourhood also carries its nation's deprivation domains (income, employment, health, education and more) as deciles: each has a detail object with the published rank and, where the publisher gives one, the score (Scotland publishes none). Wales has no crime domain. With grain=group or grain=district, crime, deprivation, property and schools are aggregated over the member neighbourhoods, deprivation domains contain mean deciles without detail, and all percentile fields are null.

get/v1/area

Request

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

Query parameters

areastring

A place id (oga_pl_...), an official neighbourhood code (LSOA or Data Zone) or a UK place name (e.g. 'Manchester').

postcodestring

UK postcode (e.g. 'SW1A 1AA'). A retired postcode resolves to the neighbourhood it was in; geo.postcode_status says which.

bundlestring

Optional bundle ID to scope available signals.

sortstring

One of period, loaded, released: order the signals newest first by their period, by when OGA loaded them, or by the publisher's release date. Undated signals come last. Omit to keep catalogue order.

grainstring

One of neighbourhood, group, district: aggregate crime, deprivation, property and schools over the neighbourhood the area resolves to, or its group (MSOA or Intermediate Zone) or district (local authority). Examples: area=Oxford&grain=group and area=Oxford&grain=district. Group and district percentiles are null. Amenity, transport and flood distinct counts remain null until AR-1069. Omit for the neighbourhood.

Response

Default Response

Changes

  • b318d28b3412Revision changes
    • warning

      added the new nation_not_covered enum value to the / response property for the response status

    • warning

      added the new nation_not_covered enum value to the / response property for the response status

    • warning

      added the new nation_not_covered enum value to the response property for the response status

    • warning

      added the new nation_not_covered enum value to the response property for the response status

    • warning

      added the new nation_not_covered enum value to the response property for the response status

    • warning

      added the new nation_not_covered enum value to the response property for the response status