Search Models

Search forecast models.

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.

Search Models

get

Authorizations

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

get

HTTPcURLJavaScriptPython

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

{
  "errors": [
    "text"
  ],
  "warnings": [
    "text"
  ],
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "algo": "phq-xgboost",
      "create_dt": "2025-04-25T09:12:10.116Z",
      "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-04-25",
            "end": "2025-04-25"
          }
        },
        "training_data": {
          "date_range": {
            "start": "2025-04-25",
            "end": "2025-04-25"
          },
          "missing_pct": 1,
          "missing_dates": [
            "2025-04-25"
          ]
        }
      },
      "model_id": "text",
      "name": "text",
      "readiness": {
        "status": "created",
        "error_code": "text",
        "error_message": "text"
      },
      "train_dt": "2025-04-25T09:12:10.116Z",
      "update_dt": "2025-04-25T09:12:10.116Z"
    }
  ]
}

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