Scores

Score an area

Changed on

Deterministic composite score for an area by preset or custom weights. Returns component dimensions + confidence.

post/v1/score

Request

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

Query parameters

bundlestring
explain'true' | 'false'

Request body

areastring required

UK postcode or place name.

preset'moving' | 'business' | 'investing' | 'research'
preset_idstring

Org-saved preset ID. Mutually exclusive with preset/weights.

explainboolean
bundlestring

Optional bundle ID to scope available signals.

cohortstring

Slug of one of your org's cohorts. Transport, schools and amenities then rank against the cohort's members instead of neighbourhoods of the same kind; the response's reference says which was used. A cohort needs at least 30 areas with stored signals.

Example request

{
  "area": "M1 1AE",
  "preset": "business",
  "weights": {
    "crime": 5,
    "deprivation": 15,
    "property": 15,
    "schools": 5,
    "amenities": 25,
    "transport": 20,
    "environment": 15
  }
}

Response

Default Response

areastring required
presetstring required
scorenumber required
area_type'urban' | 'suburban' | 'rural' required
rural_urbanstring required
confidencenumber required
weights_source'preset' | 'custom' required
engine_versionstring required
summarystring
recommendationsstring[]
data_sourcesstring[]

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