Skip to main content
GET
Read a bot's cycles

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

Query Parameters

cursor
string

Pass the cursor from the previous page to fetch the next one.

limit
integer
default:20

Number of cycles to return per page, from 1 to 100.

Required range: 1 <= x <= 100
phase

Filter 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

Response

cursor
string | null
required

Pass as cursor to fetch the next page, or null when no more pages exist.

items
BotCycle · object[]
required

Cycles, newest first.