Skip to main content
GET
Read a bot's totals

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

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)$

Response

feesUsd
string
required

Trading fees you paid on the cycle, stablecoin fees only.

fundingUsd
string
required

Funding you received less funding you paid on both legs, from the entry until the cycle closed or, while it is open, until now; it can lag the venue by up to an hour.

netPnlUsd
string
required

Realized PnL less fees, plus funding, plus unrealized PnL while the cycle is open.

notionalHoursUsd
string
required

Entry notional multiplied by the hours the pair was held, counted to the close or, while the cycle is open, to now; it is zero until the entry fills.

notionalOpenedUsd
string
required

What the entry filled, both legs together.

realizedPnlUsd
string
required

Realized PnL the venues reported on the cycle trades.

unrealizedPnlUsd
string
required

Unrealized PnL on the legs of an open cycle, and zero once the cycle closes.

volumeUsd
string
required

Everything the cycle traded, entry and exit, both legs.

abortedCycles
integer
required

Cycles whose entry finished without filling, so no pair was ever held.

Required range: 0 <= x <= 9007199254740991
cycles
integer
required

Cycles the bot has recorded.

Required range: 0 <= x <= 9007199254740991
incompleteCycles
integer
required

Cycles whose figures are partial; every total here is a partial sum over the cycles, never null.

Required range: 0 <= x <= 9007199254740991
openCycles
integer
required

Cycles whose pair the bot is still working on.

Required range: 0 <= x <= 9007199254740991
partialCycles
integer
required

Cycles whose figures stay partial: closed outside the bot, never confirmed, missing an order, paid in a non-stablecoin, or closed with a gap after the venues were synced. Cycles still syncing are counted in incompleteCycles only.

Required range: 0 <= x <= 9007199254740991