Get Demand Data

Get previously uploaded demand data.

Get Demand Data

get

Returns the demand data that has been uploaded to the model. Supports filtering by date range.

By setting the Accept header, you can specify the format of the response. The default is JSON. Supported formats: application/json, text/csv, application/x-ndjson.

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 demand after the specified date (exclusive).

Expected format: YYYY-MM-DD

date.gtestring · dateOptional

Filters demand on or after the specified date.

Expected format: YYYY-MM-DD.

Example: 2025-01-01

date.ltstring · dateOptional

Filters demand before the specified date (exclusive).

Expected format: YYYY-MM-DD.

date.ltestring · dateOptional

Filters demand 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/jsonapplication/x-ndjsontext/csv

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.

nextany ofOptional

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

stringOptional

or

nullOptional

previousany ofOptional

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

stringOptional

or

nullOptional

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}/demand

HTTPcURLJavaScriptPython

GET /v1/forecasts/models/{model_id}/demand 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-05-17",
      "demand": 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