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": {
"date": "2023-12-25"
}
}
'import requests
url = "https://macrobymark.com/api/forecast/run"
payload = {
"slug": "<string>",
"modelId": "<string>",
"transform": "level",
"lookback": 123,
"horizon": 123,
"sampleStart": "2023-12-25",
"sampleEnd": "2023-12-25",
"mcs": True,
"modelOptions": {},
"vintage": { "date": "2023-12-25" }
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
slug: '<string>',
modelId: '<string>',
transform: 'level',
lookback: 123,
horizon: 123,
sampleStart: '2023-12-25',
sampleEnd: '2023-12-25',
mcs: true,
modelOptions: {},
vintage: {date: '2023-12-25'}
})
};
fetch('https://macrobymark.com/api/forecast/run', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://macrobymark.com/api/forecast/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'slug' => '<string>',
'modelId' => '<string>',
'transform' => 'level',
'lookback' => 123,
'horizon' => 123,
'sampleStart' => '2023-12-25',
'sampleEnd' => '2023-12-25',
'mcs' => true,
'modelOptions' => [
],
'vintage' => [
'date' => '2023-12-25'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://macrobymark.com/api/forecast/run"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"modelId\": \"<string>\",\n \"transform\": \"level\",\n \"lookback\": 123,\n \"horizon\": 123,\n \"sampleStart\": \"2023-12-25\",\n \"sampleEnd\": \"2023-12-25\",\n \"mcs\": true,\n \"modelOptions\": {},\n \"vintage\": {\n \"date\": \"2023-12-25\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://macrobymark.com/api/forecast/run")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"modelId\": \"<string>\",\n \"transform\": \"level\",\n \"lookback\": 123,\n \"horizon\": 123,\n \"sampleStart\": \"2023-12-25\",\n \"sampleEnd\": \"2023-12-25\",\n \"mcs\": true,\n \"modelOptions\": {},\n \"vintage\": {\n \"date\": \"2023-12-25\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://macrobymark.com/api/forecast/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"<string>\",\n \"modelId\": \"<string>\",\n \"transform\": \"level\",\n \"lookback\": 123,\n \"horizon\": 123,\n \"sampleStart\": \"2023-12-25\",\n \"sampleEnd\": \"2023-12-25\",\n \"mcs\": true,\n \"modelOptions\": {},\n \"vintage\": {\n \"date\": \"2023-12-25\"\n }\n}"
response = http.request(request)
puts response.read_body{
"cacheKey": "<string>",
"forecast": {},
"diagnostics": {},
"audit": {},
"reproducibility": {}
}Forecasting
Run Forecast
Execute a forecast model on an indicator series.
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": {
"date": "2023-12-25"
}
}
'import requests
url = "https://macrobymark.com/api/forecast/run"
payload = {
"slug": "<string>",
"modelId": "<string>",
"transform": "level",
"lookback": 123,
"horizon": 123,
"sampleStart": "2023-12-25",
"sampleEnd": "2023-12-25",
"mcs": True,
"modelOptions": {},
"vintage": { "date": "2023-12-25" }
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
slug: '<string>',
modelId: '<string>',
transform: 'level',
lookback: 123,
horizon: 123,
sampleStart: '2023-12-25',
sampleEnd: '2023-12-25',
mcs: true,
modelOptions: {},
vintage: {date: '2023-12-25'}
})
};
fetch('https://macrobymark.com/api/forecast/run', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://macrobymark.com/api/forecast/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'slug' => '<string>',
'modelId' => '<string>',
'transform' => 'level',
'lookback' => 123,
'horizon' => 123,
'sampleStart' => '2023-12-25',
'sampleEnd' => '2023-12-25',
'mcs' => true,
'modelOptions' => [
],
'vintage' => [
'date' => '2023-12-25'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://macrobymark.com/api/forecast/run"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"modelId\": \"<string>\",\n \"transform\": \"level\",\n \"lookback\": 123,\n \"horizon\": 123,\n \"sampleStart\": \"2023-12-25\",\n \"sampleEnd\": \"2023-12-25\",\n \"mcs\": true,\n \"modelOptions\": {},\n \"vintage\": {\n \"date\": \"2023-12-25\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://macrobymark.com/api/forecast/run")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"modelId\": \"<string>\",\n \"transform\": \"level\",\n \"lookback\": 123,\n \"horizon\": 123,\n \"sampleStart\": \"2023-12-25\",\n \"sampleEnd\": \"2023-12-25\",\n \"mcs\": true,\n \"modelOptions\": {},\n \"vintage\": {\n \"date\": \"2023-12-25\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://macrobymark.com/api/forecast/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"<string>\",\n \"modelId\": \"<string>\",\n \"transform\": \"level\",\n \"lookback\": 123,\n \"horizon\": 123,\n \"sampleStart\": \"2023-12-25\",\n \"sampleEnd\": \"2023-12-25\",\n \"mcs\": true,\n \"modelOptions\": {},\n \"vintage\": {\n \"date\": \"2023-12-25\"\n }\n}"
response = http.request(request)
puts response.read_body{
"cacheKey": "<string>",
"forecast": {},
"diagnostics": {},
"audit": {},
"reproducibility": {}
}Authorizations
Body
application/json
Indicator slug
Model identifier (e.g. "arima-auto", "ets-auto", "var-2")
Available options:
level, mom, yoy, annualized, index-100 Number of historical observations
Forecast horizon periods
Run Model Confidence Set
Show child attributes
Show child attributes