Get Demand Data

Get previously uploaded demand data.

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
get
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-27",
      "demand": 1
    }
  ]
}

OpenAPI Spec

The OpenAPI spec for Forecasts API can be found here.

Guides

Last updated

Was this helpful?