Search models
Search forecast models.
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.
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
Fulltext search across name, label and external_id.
A comma-separated list of Saved Location IDs to filter on.
The maximum number of results to return per page. Defaults to 10.
10The number of results to skip before returning. Used for pagination. Defaults to 0.
0Successful Response
List of error messages, if any.
[]List of warning messages, if any.
[]Total number of results matching the query.
URL for the next page of results. Null if no more results.
URL for the previous page of results. Null if on the first page.
Bad Request
Unauthorized
Payment Required
Forbidden
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-01-01T00:00:00.000Z",
"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-01-01",
"end": "2026-01-01"
}
},
"training_data": {
"date_range": {
"start": "2026-01-01",
"end": "2026-01-01"
},
"missing_pct": 0,
"missing_dates": [
"2026-01-01"
]
}
},
"model_id": "text",
"name": "text",
"readiness": {
"status": "created",
"error_code": "text",
"error_message": "text"
},
"train_dt": "2026-01-01T00:00:00.000Z",
"update_dt": "2026-01-01T00:00:00.000Z"
}
]
}OpenAPI Spec
The OpenAPI spec for Forecasts API can be found here.
Guides
Last updated
Was this helpful?