Signals

Get signals by category

Changed on

Returns all signals for a specific category (crime, deprivation, property, schools, amenities, transport, environment). The grain query applies the same group or district aggregation as GET /v1/area.

get/v1/signals/{category}

Request

  • Base URL: https://api.onegoodarea.com
  • URL: https://api.onegoodarea.com/v1/signals/{category}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

categorystring required

Signal category name.

Query parameters

areastring

A place id, an official neighbourhood code or a UK place name.

postcodestring

UK postcode, live or retired.

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