---
title: "Forecast signal"
method: POST
path: "/v1/forecast"
tags: ["Intelligence"]
---

# Forecast signal

`POST /v1/forecast`

## Request

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

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.

## Request body

- object
  - `target` object, required: Exactly one of geo_code, postcode, or area must be set.
    - `geo_code` string
    - `postcode` string
    - `area` string
  - `signal_key` string
  - `window_months` integer

## Response `200`

Default Response

- object
  - `target` object, required
    - `geo_code` string, required
    - `postcode_status` 'live' | 'terminated'
    - `postcode_terminated_on` string
  - `signal_key` string, required
  - `points` object[], required
    - `observed_period` string, required
    - `period` object, required
      - `start` string, required
      - `end` string, required
    - `projected_value` number, required
    - `lower_bound` number, required
    - `upper_bound` number, required
  - `meta` object, required
    - `warnings` string[]
    - `generated_at` string, required
    - `scope` string, required
    - `window_months` integer, required
    - `horizon_months` integer, required
    - `n_observations` integer, required
    - `r2` number, required
    - `slope_per_month` number, required
    - `intercept` number, required
    - `residual_stderr` number, required
    - `latest_observed_period` string, required
    - `latest_period` object, required
      - `start` string, required
      - `end` string, required

## Other responses

- `400`: Default Response
- `404`: Default Response
- `422`: Default Response
- `500`: Default Response

---

[API](https://skmtc.dev/onegoodarea/apis/onegoodarea-api.md) · [All operations](https://skmtc.dev/onegoodarea/apis/onegoodarea-api/llms.txt) · [OpenAPI document](https://skmtc.dev/onegoodarea/apis/onegoodarea-api/revisions/b318d28b3412?raw)