Get Forecast

Get forecast values for an existing model.

Please note that phq_features can only be retrieved if you have also purchased the Features product.

Get Forecast

get

Returns the generated forecast results for a trained model. Each result includes a date and predicted demand value. Supports filtering by date range.

Authorizations

BearerAuth

AuthorizationstringRequired

Enter your PredictHQ API key. The Bearer prefix is added automatically.

When calling the API directly, send: Authorization: Bearer <YOUR_API_KEY> as documented at https://docs.predicthq.com/api/overview/authenticating

Path parameters

model_idstringRequired

The unique identifier of the forecast model.

Query parameters

date.gtstring · dateOptional

Filters forecast results after the specified date (exclusive).

Expected format: YYYY-MM-DD

date.gtestring · dateOptional

Filters forecast results on or after the specified date.

Expected format: YYYY-MM-DD.

Example: 2025-01-01

date.ltstring · dateOptional

Filters forecast results before the specified date (exclusive).

Expected format: YYYY-MM-DD.

date.ltestring · dateOptional

Filters forecast results on or before the specified date.

Expected format: YYYY-MM-DD.

Example: 2025-01-07

limitintegerOptional

The maximum number of results to return per page. Defaults to 10.

Default: 10

offsetintegerOptional

The number of results to skip before returning. Used for pagination. Defaults to 0.

Default: 0

Responses

200

Successful Response

application/json

errorsstring[]Optional

List of error messages, if any.

Default: []

warningsstring[]Optional

List of warning messages, if any.

Default: []

countintegerRequired

Total number of results matching the query.

nextstring · nullableOptional

URL for the next page of results. Null if no more results.

previousstring · nullableOptional

URL for the previous page of results. Null if on the first page.

400

Bad Request

application/json

401

Unauthorized

application/json

402

Payment Required

application/json

403

Forbidden

application/json

404

Not Found

application/json

get/v1/forecasts/models/{model_id}/forecast

HTTPcURLJavaScriptPython

GET /v1/forecasts/models/{model_id}/forecast HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "errors": [
    "text"
  ],
  "warnings": [
    "text"
  ],
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "date": "2026-07-17",
      "forecast": 1,
      "phq_explainability": {
        "events": [
          {
            "id": "text",
            "category": "text",
            "title": "text",
            "start_local": "2026-07-17T19:54:42.040Z",
            "end_local": "2026-07-17T19:54:42.040Z",
            "phq_rank": 1,
            "local_rank": 1
          }
        ]
      },
      "phq_features": [
        {
          "name": "text",
          "value": 1
        }
      ]
    }
  ]
}

OpenAPI Spec

The OpenAPI spec for Forecasts API can be found here.

Guides

• Getting Started with Forecasts API
• Understanding Forecast Accuracy Metrics
• Troubleshooting Guide for Forecasts API