Read a bot's cycles
curl --request GET \
--url https://perps-api.vooi.io/bots/{id}/cycles \
--header 'Authorization: Bearer <token>'import requests
url = "https://perps-api.vooi.io/bots/{id}/cycles"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://perps-api.vooi.io/bots/{id}/cycles', 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://perps-api.vooi.io/bots/{id}/cycles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://perps-api.vooi.io/bots/{id}/cycles"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://perps-api.vooi.io/bots/{id}/cycles")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://perps-api.vooi.io/bots/{id}/cycles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"cursor": "<string>",
"items": [
{
"closedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"economics": {
"complete": true,
"feesUsd": "<string>",
"fundingUsd": "<string>",
"netPnlUsd": "<string>",
"notionalHoursUsd": "<string>",
"notionalOpenedUsd": "<string>",
"partial": true,
"realizedPnlUsd": "<string>",
"unrealizedPnlUsd": "<string>",
"volumeUsd": "<string>"
},
"entry": {
"candidates": [
{
"asset": "<string>",
"long": "aster",
"short": "aster",
"entryBasisBps": 123,
"expectedNetBps": 123,
"limitLeg": "long",
"roundTripCostBps": 123,
"spreadBpsPerHour": 123,
"averageSpreadBpsPerHour": 123,
"feesBps": 123,
"longMarketId": "<string>",
"longSlippageBps": 123,
"shortMarketId": "<string>",
"shortSlippageBps": 123
}
],
"pairs": 4503599627370495,
"rejected": [
{
"pairs": 123,
"reason": "average_not_paying"
}
],
"scannedAt": "2023-11-07T05:31:56Z",
"skipped": [
{
"asset": "<string>",
"long": "aster",
"short": "aster",
"reason": "<string>"
}
],
"nearMisses": [],
"config": {
"exchanges": [
"hyperliquid:io",
"lighter"
],
"leverage": 2,
"maxRoundTripCostBps": 25,
"notionalUsd": 500,
"categories": [
"commodities"
],
"maxHoldHours": 24,
"minExpectedNetBps": 20,
"requiredExchange": "aster",
"risk": "low"
},
"fees": {
"long": {
"makerBps": 123,
"shared": true,
"takerBps": 123
},
"short": {
"makerBps": 123,
"shared": true,
"takerBps": 123
}
}
},
"entryOrder": {
"createdAt": "2023-11-07T05:31:56Z",
"finishedAt": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legs": [
{
"exchange": "aster",
"filledSize": "<string>",
"orderId": "<string>",
"price": "<string>",
"side": "buy",
"size": "<string>"
}
],
"status": "canceled"
},
"exit": {
"reason": "spread_flipped",
"spreadBpsPerHour": 123,
"averageSpreadBpsPerHour": 123
},
"exitOrders": [
{
"createdAt": "2023-11-07T05:31:56Z",
"finishedAt": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legs": [
{
"exchange": "aster",
"filledSize": "<string>",
"orderId": "<string>",
"price": "<string>",
"side": "buy",
"size": "<string>"
}
],
"status": "canceled"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pair": {
"asset": "<string>",
"baseQuantity": "<string>",
"heldFrom": "2023-11-07T05:31:56Z",
"limitLeg": "long",
"long": {
"baseSymbol": "<string>",
"exchange": "aster",
"marketId": "<string>",
"quoteSymbol": "<string>",
"userExchangeId": "<string>"
},
"openedAt": "2023-11-07T05:31:56Z",
"short": {
"baseSymbol": "<string>",
"exchange": "aster",
"marketId": "<string>",
"quoteSymbol": "<string>",
"userExchangeId": "<string>"
}
},
"phase": "aborted"
}
]
}Bots
Read a bot's cycles
Lists the round trips this bot has recorded, newest first, each with the pair it traded, the scan that chose it, the orders it placed and what it earned and cost. Trades, positions and funding are refreshed from the venues at most once a minute before the figures are computed.
GET
/
bots
/
{id}
/
cycles
Read a bot's cycles
curl --request GET \
--url https://perps-api.vooi.io/bots/{id}/cycles \
--header 'Authorization: Bearer <token>'import requests
url = "https://perps-api.vooi.io/bots/{id}/cycles"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://perps-api.vooi.io/bots/{id}/cycles', 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://perps-api.vooi.io/bots/{id}/cycles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://perps-api.vooi.io/bots/{id}/cycles"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://perps-api.vooi.io/bots/{id}/cycles")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://perps-api.vooi.io/bots/{id}/cycles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"cursor": "<string>",
"items": [
{
"closedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"economics": {
"complete": true,
"feesUsd": "<string>",
"fundingUsd": "<string>",
"netPnlUsd": "<string>",
"notionalHoursUsd": "<string>",
"notionalOpenedUsd": "<string>",
"partial": true,
"realizedPnlUsd": "<string>",
"unrealizedPnlUsd": "<string>",
"volumeUsd": "<string>"
},
"entry": {
"candidates": [
{
"asset": "<string>",
"long": "aster",
"short": "aster",
"entryBasisBps": 123,
"expectedNetBps": 123,
"limitLeg": "long",
"roundTripCostBps": 123,
"spreadBpsPerHour": 123,
"averageSpreadBpsPerHour": 123,
"feesBps": 123,
"longMarketId": "<string>",
"longSlippageBps": 123,
"shortMarketId": "<string>",
"shortSlippageBps": 123
}
],
"pairs": 4503599627370495,
"rejected": [
{
"pairs": 123,
"reason": "average_not_paying"
}
],
"scannedAt": "2023-11-07T05:31:56Z",
"skipped": [
{
"asset": "<string>",
"long": "aster",
"short": "aster",
"reason": "<string>"
}
],
"nearMisses": [],
"config": {
"exchanges": [
"hyperliquid:io",
"lighter"
],
"leverage": 2,
"maxRoundTripCostBps": 25,
"notionalUsd": 500,
"categories": [
"commodities"
],
"maxHoldHours": 24,
"minExpectedNetBps": 20,
"requiredExchange": "aster",
"risk": "low"
},
"fees": {
"long": {
"makerBps": 123,
"shared": true,
"takerBps": 123
},
"short": {
"makerBps": 123,
"shared": true,
"takerBps": 123
}
}
},
"entryOrder": {
"createdAt": "2023-11-07T05:31:56Z",
"finishedAt": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legs": [
{
"exchange": "aster",
"filledSize": "<string>",
"orderId": "<string>",
"price": "<string>",
"side": "buy",
"size": "<string>"
}
],
"status": "canceled"
},
"exit": {
"reason": "spread_flipped",
"spreadBpsPerHour": 123,
"averageSpreadBpsPerHour": 123
},
"exitOrders": [
{
"createdAt": "2023-11-07T05:31:56Z",
"finishedAt": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legs": [
{
"exchange": "aster",
"filledSize": "<string>",
"orderId": "<string>",
"price": "<string>",
"side": "buy",
"size": "<string>"
}
],
"status": "canceled"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pair": {
"asset": "<string>",
"baseQuantity": "<string>",
"heldFrom": "2023-11-07T05:31:56Z",
"limitLeg": "long",
"long": {
"baseSymbol": "<string>",
"exchange": "aster",
"marketId": "<string>",
"quoteSymbol": "<string>",
"userExchangeId": "<string>"
},
"openedAt": "2023-11-07T05:31:56Z",
"short": {
"baseSymbol": "<string>",
"exchange": "aster",
"marketId": "<string>",
"quoteSymbol": "<string>",
"userExchangeId": "<string>"
}
},
"phase": "aborted"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Bot identifier
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Query Parameters
Pass the cursor from the previous page to fetch the next one.
Number of cycles to return per page, from 1 to 100.
Required range:
1 <= x <= 100Filter by one or more phases, repeating the parameter for several: closed for the pairs the bot closed, plus aborted for the entries that never filled. Keep the same filter on every page of one cursor.
Available options:
aborted, closed, closing, holding, opening