Skip to main content
POST
/
api
/
forecast
/
run
Execute a forecast run
curl --request POST \
  --url https://macrobymark.com/api/forecast/run \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "slug": "<string>",
  "modelId": "<string>",
  "transform": "level",
  "lookback": 123,
  "horizon": 123,
  "sampleStart": "2023-12-25",
  "sampleEnd": "2023-12-25",
  "mcs": true,
  "modelOptions": {},
  "vintage": {
    "mode": "latest",
    "date": "2023-12-25"
  }
}
'
{
  "cacheKey": "<string>",
  "forecast": {},
  "diagnostics": {},
  "audit": {},
  "reproducibility": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.macrobymark.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-API-Key
string
header
required

Body

application/json
slug
string
required

Indicator slug

modelId
string
required

Model identifier (e.g. "arima-auto", "ets-auto", "var-2")

transform
enum<string>
default:level
Available options:
level,
mom,
yoy,
annualized,
index-100
lookback
integer

Number of historical observations

horizon
integer

Forecast horizon periods

sampleStart
string<date>
sampleEnd
string<date>
mcs
boolean

Run Model Confidence Set

modelOptions
object
vintage
object

Response

Forecast result

cacheKey
string
forecast
object
diagnostics
object
audit
object
reproducibility
object