Get Model

Get an existing forecast model.

Get Model

get

Authorizations

Path parameters

model_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

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

{
  "errors": [
    "text"
  ],
  "warnings": [
    "text"
  ],
  "model": {
    "algo": "phq-xgboost",
    "create_dt": "2025-06-27T08:04:15.288Z",
    "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-06-27",
          "end": "2025-06-27"
        }
      },
      "training_data": {
        "date_range": {
          "start": "2025-06-27",
          "end": "2025-06-27"
        },
        "missing_pct": 0,
        "missing_dates": [
          "2025-06-27"
        ]
      }
    },
    "model_id": "text",
    "name": "text",
    "readiness": {
      "status": "created",
      "error_code": "text",
      "error_message": "text"
    },
    "train_dt": "2025-06-27T08:04:15.288Z",
    "update_dt": "2025-06-27T08:04:15.288Z"
  }
}

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