Search Models

Search forecast models.

Search Models

get

Returns a paginated list of forecast models belonging to the authenticated organization. Supports full-text search across name, label, and external_id via the q parameter, and filtering by Saved Location ID and readiness status.

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

Query parameters

qstringOptional

Fulltext search across name, label and external_id.

location.saved_location_idstring[]Optional

A comma-separated list of Saved Location IDs to filter on.

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.

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

get

/v1/forecasts/models

HTTPcURLJavaScriptPython

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

{
  "errors": [
    "text"
  ],
  "warnings": [
    "text"
  ],
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "algo": "text",
      "create_dt": "2026-05-14T18:11:50.498Z",
      "demand_type": {
        "interval": "text",
        "industry": "accommodation"
      },
      "external_id": "text",
      "forecast_window": "1d",
      "label": [
        "text"
      ],
      "location": {
        "saved_location_id": "text"
      },
      "metrics": {
        "accuracy": {
          "mape": 1,
          "mae": 1,
          "rmse": 1,
          "wape": 1
        },
        "demand_data": {
          "date_range": {
            "start": "2026-05-14",
            "end": "2026-05-14"
          }
        },
        "training_data": {
          "date_range": {
            "start": "2026-05-14",
            "end": "2026-05-14"
          },
          "missing_pct": 0,
          "missing_dates": [
            "2026-05-14"
          ]
        }
      },
      "model_id": "text",
      "name": "text",
      "readiness": {
        "status": "created",
        "error_code": "text",
        "error_message": "text"
      },
      "train_dt": "2026-05-14T18:11:50.498Z",
      "update_dt": "2026-05-14T18:11:50.498Z"
    }
  ]
}

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