Get Backtest

GET

simulation

backtests

{job_id}

Get Backtest

curl --request GET \
  --url https://api.polysimulator.com/v1/simulation/backtests/{job_id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.polysimulator.com/v1/simulation/backtests/{job_id}', 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.polysimulator.com/v1/simulation/backtests/{job_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polysimulator.com/v1/simulation/backtests/{job_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.polysimulator.com/v1/simulation/backtests/{job_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "condition_ids": [
    "0xabc123"
  ],
  "created_at": "2026-08-04T18:00:00Z",
  "end": "2026-08-04T19:00:00Z",
  "fill_model": "depth_walk",
  "is_replay": false,
  "job_id": "11111111-1111-1111-1111-111111111111",
  "start": "2026-08-04T18:00:00Z",
  "status": "completed",
  "token_ids": {
    "0xabc123": "tok_yes"
  },
  "universe_eligible": true
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>",
  "feature_key": "<string>",
  "upgrade_url": "<string>",
  "limit": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

Authorizations

X-API-Key

string

header

required

Issue from /v1/keys (or admin-issued for enterprise tier).

Headers

authorization

string | null

X-API-Key

string | null

POLY_API_KEY

string | null

Poly-API-Key

string | null

Path Parameters

job_id

string

required

Response

Successful Response

job_id

string

required

status

enum<string>

required

Available options:

pending,

running,

completed,

failed,

cancelled

condition_ids

string[]

required

start

string

required

end

string

required

fill_model

enum<string>

required

Available options:

midpoint,

top_of_book,

depth_walk,

depth_walk_depletion

created_at

string

required

started_at

string | null

completed_at

string | null

error_message

string | null

initial_bankroll

string | null

total_pnl

string | null

total_return_pct

string | null

win_rate

string | null

Fraction of closed positions that made money, in [0, 1] ("0.5000" = half). Not a percentage.

max_drawdown

string | null

num_trades

integer | null

market_hours_charged

string | null

settlement_scored

boolean

default:false

tick_mode

enum<string> | null

Available options:

grid,

event

ticks_evaluated

integer | null

tick_degraded

boolean

default:false

tick_notice

string | null

is_replay

boolean

default:false

universe_eligible

boolean

default:false

token_ids

Token Ids · object | null

Show child attributes

execution

BacktestExecution · object | null

How a run's orders were executed, computed from the run itself.

Absent on runs stored before it existed. Every field describes what the executor DID, so two runs with different assumptions cannot be mistaken for each other.

Show child attributes

Get Backtest

curl --request GET \
  --url https://api.polysimulator.com/v1/simulation/backtests/{job_id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.polysimulator.com/v1/simulation/backtests/{job_id}', 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.polysimulator.com/v1/simulation/backtests/{job_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polysimulator.com/v1/simulation/backtests/{job_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.polysimulator.com/v1/simulation/backtests/{job_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "condition_ids": [
    "0xabc123"
  ],
  "created_at": "2026-08-04T18:00:00Z",
  "end": "2026-08-04T19:00:00Z",
  "fill_model": "depth_walk",
  "is_replay": false,
  "job_id": "11111111-1111-1111-1111-111111111111",
  "start": "2026-08-04T18:00:00Z",
  "status": "completed",
  "token_ids": {
    "0xabc123": "tok_yes"
  },
  "universe_eligible": true
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>",
  "feature_key": "<string>",
  "upgrade_url": "<string>",
  "limit": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "details": {},
  "request_id": "<string>"
}

Overview

Endpoints

Authorizations

Headers

Path Parameters

Response