Get Demand Data

Get previously uploaded demand data.

Public Preview

Forecasts API is now available in Public Preview to all customers until May 31, 2025. The underlying algorithm and functionality has been thoroughly tested in production use-cases and is now available to be used to improve forecast accuracy for your business.

Get Demand Data

get

Authorizations

Path parameters

model_idstringRequired

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

Limit the number of results.

Default: 10

offsetintegerOptional

Offset the results.

Default: 0

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

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

{
  "errors": [
    "text"
  ],
  "warnings": [
    "text"
  ],
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "date": "2025-06-06",
      "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