The Forecasting Company API

Endpointhttps://api.retrocast.com

Model inference

POST

https://api.retrocast.com

/forecast

Perform inference with foundation models.

Model inference › query Parameters

model

string · enum · required

The forecasting model to use for inference. Note that only tabpfn-ts, moirai and moirai-moe support exogenous variables.

Enum values:

moirai

chronos

chronos-bolt

timesfm

timesfm-2

moirai-moe

moirai-2

tabpfn-ts

Default: tabpfn-ts

cloud

string · enum

Specify the cloud provider to use for inference. If none is set then any may be used depending on availability.

Enum values:

gcp

aws

oci

Model inference › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Model inference › Request Body

API request model for the model inference endpoint.

object[] · required

horizon

integer · min: 1 · max: 10000 · required

Number of steps to forecast given the frequency.

Example: 5

freq

string · enum · required

Frequency of the time series.

Enum values:

5min

15min

30min

Example: D

The amount of history to use when forecasting. This is the number of steps to look back in the target series. More history can improve the forecast accuracy, but can also increase the computation time. By default this is set to the max of model capability or the length of the provided target series, whichever is shorter.

Example: 20

Default: null

Default: [0.1,0.9,0.4,0.5]

Apply additional co-variates provided by TFC. Only supported by the following models: Navi, Moirai, Moriai-MoE and TabPFN-TS.

Example: {"0":{"config":{"country":"US"},"type":"holidays"}}

Default: null

Optional model-specific configuration overrides.

Example: {"config":{"season_length":7},"model":"aarima"}

Default: null

Model inference › Responses

Success

Default: null

Default: completed

POST/forecast

curl --request POST \
  --url 'https://api.retrocast.com/forecast?model=tabpfn-ts' \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "series": [
    {
      "index": [
        "2001-01-06",
        "2001-01-07",
        "2001-01-08",
        "2001-01-09",
        "2001-01-10"
      ],
      "target": [
        125,
        120,
        140,
        135,
        133
      ]
    }
  ],
  "horizon": 5,
  "freq": "D",
  "context": null,
  "quantiles": [
    0.1,
    0.9,
    0.4,
    0.5
  ]
}
'

shell

Example Request Body

{
  "series": [
    {
      "index": [
        "2001-01-06",
        "2001-01-07",
        "2001-01-08",
        "2001-01-09",
        "2001-01-10"
      ],
      "target": [
        125,
        120,
        140,
        135,
        133
      ]
    }
  ],
  "horizon": 5,
  "freq": "D",
  "context": null,
  "quantiles": [
    0.1,
    0.9,
    0.4,
    0.5
  ]
}

json

application/json

Example Responses

{
  "series": [
    [
      {
        "prediction": {
          "0.1": [
            1,
            2,
            3
          ],
          "0.9": [
            1,
            2,
            3
          ],
          "mean": [
            1,
            2,
            3
          ]
        },
        "index": [
          "string"
        ],
        "metrics": {
          "mae": 0,
          "mape": 0,
          "crps": 0,
          "wape": 0,
          "scaled_bias": 0
        }
      }
    ]
  ],
  "status": "completed"
}

json

application/json

Submit job for forecasting

POST

https://api.retrocast.com

/forecast-jobs

Perform historic inference for a range of forecast creation dates (fcds). These jobs can run longer and need to be retrieved with a separate endpoint and the returned job ID.

Submit job for forecasting › query Parameters

model

string · enum · required

The forecasting model to use for inference. Note that only tabpfn-ts, moirai, and moirai-moe support exogenous variables.

Enum values:

moirai

chronos

chronos-bolt

chronos-2

timesfm

timesfm-2

moirai-moe

moirai-2

Default: tabpfn-ts

Submit job for forecasting › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Submit job for forecasting › Request Body

API request model for the model inference endpoint.

object[] · required

horizon

integer · min: 1 · max: 10000 · required

Number of steps to forecast given the frequency.

Example: 5

freq

string · enum · required

Frequency of the time series.

Enum values:

5min

15min

30min

Example: D

Example: 20

Default: null

Default: [0.1,0.9,0.4,0.5]

Apply additional co-variates provided by TFC. Only supported by the following models: Navi, Moirai, Moriai-MoE and TabPFN-TS.

Example: {"0":{"config":{"country":"US"},"type":"holidays"}}

Default: null

Optional model-specific configuration overrides.

Example: {"config":{"season_length":7},"model":"aarima"}

Default: null

Submit job for forecasting › Responses

Job submitted successfully

call_id

string

The unique identifier of the submitted job

POST/forecast-jobs

curl --request POST \
  --url 'https://api.retrocast.com/forecast-jobs?model=tabpfn-ts' \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "series": [
    {
      "index": [
        "2001-01-06",
        "2001-01-07",
        "2001-01-08",
        "2001-01-09",
        "2001-01-10"
      ],
      "target": [
        125,
        120,
        140,
        135,
        133
      ]
    }
  ],
  "horizon": 5,
  "freq": "D",
  "context": null,
  "quantiles": [
    0.1,
    0.9,
    0.4,
    0.5
  ]
}
'

shell

Example Request Body

{
  "series": [
    {
      "index": [
        "2001-01-06",
        "2001-01-07",
        "2001-01-08",
        "2001-01-09",
        "2001-01-10"
      ],
      "target": [
        125,
        120,
        140,
        135,
        133
      ]
    }
  ],
  "horizon": 5,
  "freq": "D",
  "context": null,
  "quantiles": [
    0.1,
    0.9,
    0.4,
    0.5
  ]
}

json

application/json

Example Responses

{
  "call_id": "call_id"
}

json

application/json

Retrieve job result

GET

https://api.retrocast.com

/forecast-jobs/{job_id}

Retrieve the forecast result from a forecast job.

Retrieve job result › path Parameters

job_id

string · required

Retrieve job result › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Retrieve job result › Responses

Success

Default: null

Default: completed

GET/forecast-jobs/{job_id}

curl --request GET \
  --url https://api.retrocast.com/forecast-jobs/:job_id \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "series": [
    [
      {
        "prediction": {
          "0.1": [
            1,
            2,
            3
          ],
          "0.9": [
            1,
            2,
            3
          ],
          "mean": [
            1,
            2,
            3
          ]
        },
        "index": [
          "string"
        ],
        "metrics": {
          "mae": 0,
          "mape": 0,
          "crps": 0,
          "wape": 0,
          "scaled_bias": 0
        }
      }
    ]
  ],
  "status": "completed"
}

json

application/json

OpenAPI spec

GET

https://api.retrocast.com

/openapi

Return the OpenAPI spec for the TFC API.

OpenAPI spec › Responses

Rate Limiting Response

type

string · required

A URI reference that identifies the problem.

title

string · required

A short, human-readable summary of the problem.

status

number · required

The HTTP status code.

instance

string

GET/openapi

curl --request GET \
  --url https://api.retrocast.com/openapi

shell

Example Responses

{
  "type": "https://httpproblems.com/http-status/429",
  "title": "Too Many Requests",
  "status": 429,
  "instance": "/foo/bar"
}

json

application/json

Warmup model

GET

https://api.retrocast.com

/warmup

Warmup a model endpoint for better UX in embedded applications.

Warmup model › query Parameters

model

string · enum · required

The forecasting model to warmup.

Enum values:

moirai

chronos

chronos-bolt

timesfm

timesfm-2

moirai-moe

moirai-2

tabpfn-ts

Default: tabpfn-ts

cloud

string · enum

Specify the cloud provider to use. If none is set then any may be used depending on availability.

Enum values:

gcp

aws

oci

Warmup model › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Warmup model › Responses

Rate Limiting Response

type

string · required

A URI reference that identifies the problem.

title

string · required

A short, human-readable summary of the problem.

status

number · required

The HTTP status code.

instance

string

GET/warmup

curl --request GET \
  --url 'https://api.retrocast.com/warmup?model=tabpfn-ts' \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "type": "https://httpproblems.com/http-status/429",
  "title": "Too Many Requests",
  "status": 429,
  "instance": "/foo/bar"
}

json

application/json

The Forecasting Company API

Endpointhttps://api.retrocast.com

Model inference

POST

https://api.retrocast.com

/forecast

Perform inference with foundation models.

Model inference › query Parameters

model

string · enum · required

The forecasting model to use for inference. Note that only tabpfn-ts, moirai and moirai-moe support exogenous variables.

Enum values:

moirai

chronos

chronos-bolt

timesfm

timesfm-2

moirai-moe

moirai-2

tabpfn-ts

Default: tabpfn-ts

cloud

string · enum

Specify the cloud provider to use for inference. If none is set then any may be used depending on availability.

Enum values:

gcp

aws

oci

Model inference › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Model inference › Request Body

API request model for the model inference endpoint.

object[] · required

horizon

integer · min: 1 · max: 10000 · required

Number of steps to forecast given the frequency.

Example: 5

freq

string · enum · required

Frequency of the time series.

Enum values:

5min

15min

30min

Example: D

Example: 20

Default: null

Default: [0.1,0.9,0.4,0.5]

Apply additional co-variates provided by TFC. Only supported by the following models: Navi, Moirai, Moriai-MoE and TabPFN-TS.

Example: {"0":{"config":{"country":"US"},"type":"holidays"}}

Default: null

Optional model-specific configuration overrides.

Example: {"config":{"season_length":7},"model":"aarima"}

Default: null

Model inference › Responses

Success

Default: null

Default: completed

POST/forecast

curl --request POST \
  --url 'https://api.retrocast.com/forecast?model=tabpfn-ts' \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "series": [
    {
      "index": [
        "2001-01-06",
        "2001-01-07",
        "2001-01-08",
        "2001-01-09",
        "2001-01-10"
      ],
      "target": [
        125,
        120,
        140,
        135,
        133
      ]
    }
  ],
  "horizon": 5,
  "freq": "D",
  "context": null,
  "quantiles": [
    0.1,
    0.9,
    0.4,
    0.5
  ]
}
'

shell

Example Request Body

{
  "series": [
    {
      "index": [
        "2001-01-06",
        "2001-01-07",
        "2001-01-08",
        "2001-01-09",
        "2001-01-10"
      ],
      "target": [
        125,
        120,
        140,
        135,
        133
      ]
    }
  ],
  "horizon": 5,
  "freq": "D",
  "context": null,
  "quantiles": [
    0.1,
    0.9,
    0.4,
    0.5
  ]
}

json

application/json

Example Responses

{
  "series": [
    [
      {
        "prediction": {
          "0.1": [
            1,
            2,
            3
          ],
          "0.9": [
            1,
            2,
            3
          ],
          "mean": [
            1,
            2,
            3
          ]
        },
        "index": [
          "string"
        ],
        "metrics": {
          "mae": 0,
          "mape": 0,
          "crps": 0,
          "wape": 0,
          "scaled_bias": 0
        }
      }
    ]
  ],
  "status": "completed"
}

json

application/json

Submit job for forecasting

POST

https://api.retrocast.com

/forecast-jobs

Perform historic inference for a range of forecast creation dates (fcds). These jobs can run longer and need to be retrieved with a separate endpoint and the returned job ID.

Submit job for forecasting › query Parameters

model

string · enum · required

The forecasting model to use for inference. Note that only tabpfn-ts, moirai, and moirai-moe support exogenous variables.

Enum values:

moirai

chronos

chronos-bolt

chronos-2

timesfm

timesfm-2

moirai-moe

moirai-2

Default: tabpfn-ts

Submit job for forecasting › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Submit job for forecasting › Request Body

API request model for the model inference endpoint.

object[] · required

horizon

integer · min: 1 · max: 10000 · required

Number of steps to forecast given the frequency.

Example: 5

freq

string · enum · required

Frequency of the time series.

Enum values:

5min

15min

30min

Example: D

Example: 20

Default: null

Default: [0.1,0.9,0.4,0.5]

Apply additional co-variates provided by TFC. Only supported by the following models: Navi, Moirai, Moriai-MoE and TabPFN-TS.

Example: {"0":{"config":{"country":"US"},"type":"holidays"}}

Default: null

Optional model-specific configuration overrides.

Example: {"config":{"season_length":7},"model":"aarima"}

Default: null

Submit job for forecasting › Responses

Job submitted successfully

call_id

string

The unique identifier of the submitted job

POST/forecast-jobs

curl --request POST \
  --url 'https://api.retrocast.com/forecast-jobs?model=tabpfn-ts' \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "series": [
    {
      "index": [
        "2001-01-06",
        "2001-01-07",
        "2001-01-08",
        "2001-01-09",
        "2001-01-10"
      ],
      "target": [
        125,
        120,
        140,
        135,
        133
      ]
    }
  ],
  "horizon": 5,
  "freq": "D",
  "context": null,
  "quantiles": [
    0.1,
    0.9,
    0.4,
    0.5
  ]
}
'

shell

Example Request Body

{
  "series": [
    {
      "index": [
        "2001-01-06",
        "2001-01-07",
        "2001-01-08",
        "2001-01-09",
        "2001-01-10"
      ],
      "target": [
        125,
        120,
        140,
        135,
        133
      ]
    }
  ],
  "horizon": 5,
  "freq": "D",
  "context": null,
  "quantiles": [
    0.1,
    0.9,
    0.4,
    0.5
  ]
}

json

application/json

Example Responses

{
  "call_id": "call_id"
}

json

application/json

Retrieve job result

GET

https://api.retrocast.com

/forecast-jobs/{job_id}

Retrieve the forecast result from a forecast job.

Retrieve job result › path Parameters

job_id

string · required

Retrieve job result › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Retrieve job result › Responses

Success

Default: null

Default: completed

GET/forecast-jobs/{job_id}

curl --request GET \
  --url https://api.retrocast.com/forecast-jobs/:job_id \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "series": [
    [
      {
        "prediction": {
          "0.1": [
            1,
            2,
            3
          ],
          "0.9": [
            1,
            2,
            3
          ],
          "mean": [
            1,
            2,
            3
          ]
        },
        "index": [
          "string"
        ],
        "metrics": {
          "mae": 0,
          "mape": 0,
          "crps": 0,
          "wape": 0,
          "scaled_bias": 0
        }
      }
    ]
  ],
  "status": "completed"
}

json

application/json

OpenAPI spec

GET

https://api.retrocast.com

/openapi

Return the OpenAPI spec for the TFC API.

OpenAPI spec › Responses

Rate Limiting Response

type

string · required

A URI reference that identifies the problem.

title

string · required

A short, human-readable summary of the problem.

status

number · required

The HTTP status code.

instance

string

GET/openapi

curl --request GET \
  --url https://api.retrocast.com/openapi

shell

Example Responses

{
  "type": "https://httpproblems.com/http-status/429",
  "title": "Too Many Requests",
  "status": 429,
  "instance": "/foo/bar"
}

json

application/json

Warmup model

GET

https://api.retrocast.com

/warmup

Warmup a model endpoint for better UX in embedded applications.

Warmup model › query Parameters

model

string · enum · required

The forecasting model to warmup.

Enum values:

moirai

chronos

chronos-bolt

timesfm

timesfm-2

moirai-moe

moirai-2

tabpfn-ts

Default: tabpfn-ts

cloud

string · enum

Specify the cloud provider to use. If none is set then any may be used depending on availability.

Enum values:

gcp

aws

oci

Warmup model › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Warmup model › Responses

Rate Limiting Response

type

string · required

A URI reference that identifies the problem.

title

string · required

A short, human-readable summary of the problem.

status

number · required

The HTTP status code.

instance

string

GET/warmup

curl --request GET \
  --url 'https://api.retrocast.com/warmup?model=tabpfn-ts' \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "type": "https://httpproblems.com/http-status/429",
  "title": "Too Many Requests",
  "status": 429,
  "instance": "/foo/bar"
}

json

application/json