Intelligence

Forecast signal

Project a signal forward in time using linear regression over the trailing window of its monthly history (for example crime.monthly_count; a signal needs at least two months). Each point carries its month as dates. Counts, prices and rates are floored at zero. A retired postcode resolves to the neighbourhood it was in; target.postcode_status and meta.warnings say so.

post/v1/forecast

Request

  • Base URL: https://api.onegoodarea.com
  • URL: https://api.onegoodarea.com/v1/forecast
  • Auth: HTTP bearer

Request body

signal_keystring
window_monthsinteger

Example request

{
  "target": {
    "postcode": "SW1A 1AA"
  },
  "signal_key": "crime.monthly_count",
  "window_months": 24,
  "horizon_months": 12
}

Response

Default Response

signal_keystring required

Changes

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