Search Models

Search forecast models.

Search Models

get

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 coma-separated list of Saved Location IDs to filter on.

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

/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": "phq-xgboost",
      "create_dt": "2025-12-23T03:35:43.259Z",
      "demand_type": {
        "interval": "day",
        "industry": "accommodation"
      },
      "external_id": "text",
      "forecast_window": "1d",
      "label": [
        "text"
      ],
      "location": {
        "saved_location_id": "text"
      },
      "metrics": {
        "accuracy": {
          "mape": 1,
          "mae": 1,
          "rmse": 1
        },
        "demand_data": {
          "date_range": {
            "start": "2025-12-23",
            "end": "2025-12-23"
          }
        },
        "training_data": {
          "date_range": {
            "start": "2025-12-23",
            "end": "2025-12-23"
          },
          "missing_pct": 0,
          "missing_dates": [
            "2025-12-23"
          ]
        }
      },
      "model_id": "text",
      "name": "text",
      "readiness": {
        "status": "created",
        "error_code": "text",
        "error_message": "text"
      },
      "train_dt": "2025-12-23T03:35:43.259Z",
      "update_dt": "2025-12-23T03:35:43.259Z"
    }
  ]
}

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