Queue a backtest run
curl --request POST \
--url https://api.example.com/public/v1/backtests \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"strategyVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {
"timeframe": "1h",
"signalInstrument": {
"symbol": "BTCUSDT"
},
"range": {
"start": 1704067200000,
"end": 1735689600000
},
"initialBalance": 10000,
"execution": {
"entryOrderRole": "taker",
"exitOrderRole": "taker",
"riskOrderRole": "taker",
"feeModel": {
"kind": "tiered_maker_taker",
"tiers": [
{
"minCumulativeNotional": 0,
"makerRate": 0.001,
"takerRate": 0.001
}
]
},
"slippage": {
"kind": "none"
}
},
"ambiguityResolution": "multi_resolution",
"ambiguityFallback": "pessimistic"
}
}
'import requests
url = "https://api.example.com/public/v1/backtests"
payload = {
"strategyVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {
"timeframe": "1h",
"signalInstrument": { "symbol": "BTCUSDT" },
"range": {
"start": 1704067200000,
"end": 1735689600000
},
"initialBalance": 10000,
"execution": {
"entryOrderRole": "taker",
"exitOrderRole": "taker",
"riskOrderRole": "taker",
"feeModel": {
"kind": "tiered_maker_taker",
"tiers": [
{
"minCumulativeNotional": 0,
"makerRate": 0.001,
"takerRate": 0.001
}
]
},
"slippage": { "kind": "none" }
},
"ambiguityResolution": "multi_resolution",
"ambiguityFallback": "pessimistic"
}
}
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({
strategyVersionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
config: {
timeframe: '1h',
signalInstrument: {symbol: 'BTCUSDT'},
range: {start: 1704067200000, end: 1735689600000},
initialBalance: 10000,
execution: {
entryOrderRole: 'taker',
exitOrderRole: 'taker',
riskOrderRole: 'taker',
feeModel: {
kind: 'tiered_maker_taker',
tiers: [{minCumulativeNotional: 0, makerRate: 0.001, takerRate: 0.001}]
},
slippage: {kind: 'none'}
},
ambiguityResolution: 'multi_resolution',
ambiguityFallback: 'pessimistic'
}
})
};
fetch('https://api.example.com/public/v1/backtests', 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://api.example.com/public/v1/backtests",
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([
'strategyVersionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'config' => [
'timeframe' => '1h',
'signalInstrument' => [
'symbol' => 'BTCUSDT'
],
'range' => [
'start' => 1704067200000,
'end' => 1735689600000
],
'initialBalance' => 10000,
'execution' => [
'entryOrderRole' => 'taker',
'exitOrderRole' => 'taker',
'riskOrderRole' => 'taker',
'feeModel' => [
'kind' => 'tiered_maker_taker',
'tiers' => [
[
'minCumulativeNotional' => 0,
'makerRate' => 0.001,
'takerRate' => 0.001
]
]
],
'slippage' => [
'kind' => 'none'
]
],
'ambiguityResolution' => 'multi_resolution',
'ambiguityFallback' => 'pessimistic'
]
]),
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://api.example.com/public/v1/backtests"
payload := strings.NewReader("{\n \"strategyVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"timeframe\": \"1h\",\n \"signalInstrument\": {\n \"symbol\": \"BTCUSDT\"\n },\n \"range\": {\n \"start\": 1704067200000,\n \"end\": 1735689600000\n },\n \"initialBalance\": 10000,\n \"execution\": {\n \"entryOrderRole\": \"taker\",\n \"exitOrderRole\": \"taker\",\n \"riskOrderRole\": \"taker\",\n \"feeModel\": {\n \"kind\": \"tiered_maker_taker\",\n \"tiers\": [\n {\n \"minCumulativeNotional\": 0,\n \"makerRate\": 0.001,\n \"takerRate\": 0.001\n }\n ]\n },\n \"slippage\": {\n \"kind\": \"none\"\n }\n },\n \"ambiguityResolution\": \"multi_resolution\",\n \"ambiguityFallback\": \"pessimistic\"\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://api.example.com/public/v1/backtests")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"strategyVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"timeframe\": \"1h\",\n \"signalInstrument\": {\n \"symbol\": \"BTCUSDT\"\n },\n \"range\": {\n \"start\": 1704067200000,\n \"end\": 1735689600000\n },\n \"initialBalance\": 10000,\n \"execution\": {\n \"entryOrderRole\": \"taker\",\n \"exitOrderRole\": \"taker\",\n \"riskOrderRole\": \"taker\",\n \"feeModel\": {\n \"kind\": \"tiered_maker_taker\",\n \"tiers\": [\n {\n \"minCumulativeNotional\": 0,\n \"makerRate\": 0.001,\n \"takerRate\": 0.001\n }\n ]\n },\n \"slippage\": {\n \"kind\": \"none\"\n }\n },\n \"ambiguityResolution\": \"multi_resolution\",\n \"ambiguityFallback\": \"pessimistic\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/public/v1/backtests")
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 \"strategyVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"timeframe\": \"1h\",\n \"signalInstrument\": {\n \"symbol\": \"BTCUSDT\"\n },\n \"range\": {\n \"start\": 1704067200000,\n \"end\": 1735689600000\n },\n \"initialBalance\": 10000,\n \"execution\": {\n \"entryOrderRole\": \"taker\",\n \"exitOrderRole\": \"taker\",\n \"riskOrderRole\": \"taker\",\n \"feeModel\": {\n \"kind\": \"tiered_maker_taker\",\n \"tiers\": [\n {\n \"minCumulativeNotional\": 0,\n \"makerRate\": 0.001,\n \"takerRate\": 0.001\n }\n ]\n },\n \"slippage\": {\n \"kind\": \"none\"\n }\n },\n \"ambiguityResolution\": \"multi_resolution\",\n \"ambiguityFallback\": \"pessimistic\"\n }\n}"
response = http.request(request)
puts response.read_bodyAgent API
Queue a backtest run
Creates a queued backtest job for a ready strategy version. Poll the backtest detail endpoint for status and results.
POST
/
public
/
v1
/
backtests
Queue a backtest run
curl --request POST \
--url https://api.example.com/public/v1/backtests \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"strategyVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {
"timeframe": "1h",
"signalInstrument": {
"symbol": "BTCUSDT"
},
"range": {
"start": 1704067200000,
"end": 1735689600000
},
"initialBalance": 10000,
"execution": {
"entryOrderRole": "taker",
"exitOrderRole": "taker",
"riskOrderRole": "taker",
"feeModel": {
"kind": "tiered_maker_taker",
"tiers": [
{
"minCumulativeNotional": 0,
"makerRate": 0.001,
"takerRate": 0.001
}
]
},
"slippage": {
"kind": "none"
}
},
"ambiguityResolution": "multi_resolution",
"ambiguityFallback": "pessimistic"
}
}
'import requests
url = "https://api.example.com/public/v1/backtests"
payload = {
"strategyVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {
"timeframe": "1h",
"signalInstrument": { "symbol": "BTCUSDT" },
"range": {
"start": 1704067200000,
"end": 1735689600000
},
"initialBalance": 10000,
"execution": {
"entryOrderRole": "taker",
"exitOrderRole": "taker",
"riskOrderRole": "taker",
"feeModel": {
"kind": "tiered_maker_taker",
"tiers": [
{
"minCumulativeNotional": 0,
"makerRate": 0.001,
"takerRate": 0.001
}
]
},
"slippage": { "kind": "none" }
},
"ambiguityResolution": "multi_resolution",
"ambiguityFallback": "pessimistic"
}
}
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({
strategyVersionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
config: {
timeframe: '1h',
signalInstrument: {symbol: 'BTCUSDT'},
range: {start: 1704067200000, end: 1735689600000},
initialBalance: 10000,
execution: {
entryOrderRole: 'taker',
exitOrderRole: 'taker',
riskOrderRole: 'taker',
feeModel: {
kind: 'tiered_maker_taker',
tiers: [{minCumulativeNotional: 0, makerRate: 0.001, takerRate: 0.001}]
},
slippage: {kind: 'none'}
},
ambiguityResolution: 'multi_resolution',
ambiguityFallback: 'pessimistic'
}
})
};
fetch('https://api.example.com/public/v1/backtests', 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://api.example.com/public/v1/backtests",
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([
'strategyVersionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'config' => [
'timeframe' => '1h',
'signalInstrument' => [
'symbol' => 'BTCUSDT'
],
'range' => [
'start' => 1704067200000,
'end' => 1735689600000
],
'initialBalance' => 10000,
'execution' => [
'entryOrderRole' => 'taker',
'exitOrderRole' => 'taker',
'riskOrderRole' => 'taker',
'feeModel' => [
'kind' => 'tiered_maker_taker',
'tiers' => [
[
'minCumulativeNotional' => 0,
'makerRate' => 0.001,
'takerRate' => 0.001
]
]
],
'slippage' => [
'kind' => 'none'
]
],
'ambiguityResolution' => 'multi_resolution',
'ambiguityFallback' => 'pessimistic'
]
]),
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://api.example.com/public/v1/backtests"
payload := strings.NewReader("{\n \"strategyVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"timeframe\": \"1h\",\n \"signalInstrument\": {\n \"symbol\": \"BTCUSDT\"\n },\n \"range\": {\n \"start\": 1704067200000,\n \"end\": 1735689600000\n },\n \"initialBalance\": 10000,\n \"execution\": {\n \"entryOrderRole\": \"taker\",\n \"exitOrderRole\": \"taker\",\n \"riskOrderRole\": \"taker\",\n \"feeModel\": {\n \"kind\": \"tiered_maker_taker\",\n \"tiers\": [\n {\n \"minCumulativeNotional\": 0,\n \"makerRate\": 0.001,\n \"takerRate\": 0.001\n }\n ]\n },\n \"slippage\": {\n \"kind\": \"none\"\n }\n },\n \"ambiguityResolution\": \"multi_resolution\",\n \"ambiguityFallback\": \"pessimistic\"\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://api.example.com/public/v1/backtests")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"strategyVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"timeframe\": \"1h\",\n \"signalInstrument\": {\n \"symbol\": \"BTCUSDT\"\n },\n \"range\": {\n \"start\": 1704067200000,\n \"end\": 1735689600000\n },\n \"initialBalance\": 10000,\n \"execution\": {\n \"entryOrderRole\": \"taker\",\n \"exitOrderRole\": \"taker\",\n \"riskOrderRole\": \"taker\",\n \"feeModel\": {\n \"kind\": \"tiered_maker_taker\",\n \"tiers\": [\n {\n \"minCumulativeNotional\": 0,\n \"makerRate\": 0.001,\n \"takerRate\": 0.001\n }\n ]\n },\n \"slippage\": {\n \"kind\": \"none\"\n }\n },\n \"ambiguityResolution\": \"multi_resolution\",\n \"ambiguityFallback\": \"pessimistic\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/public/v1/backtests")
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 \"strategyVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {\n \"timeframe\": \"1h\",\n \"signalInstrument\": {\n \"symbol\": \"BTCUSDT\"\n },\n \"range\": {\n \"start\": 1704067200000,\n \"end\": 1735689600000\n },\n \"initialBalance\": 10000,\n \"execution\": {\n \"entryOrderRole\": \"taker\",\n \"exitOrderRole\": \"taker\",\n \"riskOrderRole\": \"taker\",\n \"feeModel\": {\n \"kind\": \"tiered_maker_taker\",\n \"tiers\": [\n {\n \"minCumulativeNotional\": 0,\n \"makerRate\": 0.001,\n \"takerRate\": 0.001\n }\n ]\n },\n \"slippage\": {\n \"kind\": \"none\"\n }\n },\n \"ambiguityResolution\": \"multi_resolution\",\n \"ambiguityFallback\": \"pessimistic\"\n }\n}"
response = http.request(request)
puts response.read_body⌘I