Skip to main content
POST
Start a bot

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

config
BotConfig · object | null
required

Bot configuration, applied by the runner on its next poll; null when the stored configuration no longer matches the current schema and the bot must be recreated.

createdAt
string<date-time>
required

When the bot was created.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
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)$
lastError
string | null
required

What needs your attention, or null when nothing does: while the bot runs, a problem it keeps retrying or waits out, such as a venue key to reconnect, and once it halts, why it halted.

lastScan
BotScan · object | null
required

The last scan that opened nothing, with the pairs it ranked and why each was passed over; null while the bot has never scanned, entered on every scan, or its stored scan no longer matches the current schema.

openCycle
BotOpenCycle · object | null
required

The pair the bot is working on, or null while it holds none.

status
enum<string>
required

running — the bot executes scheduled ticks. stopping — the runner closes the pair it holds, if any, then stops. stopped — it has never been started, or you stopped it. halted — it hit a state it will not act on and stopped itself; lastError says which.

Available options:
halted,
running,
stopped,
stopping
updatedAt
string<date-time>
required

When the bot last changed.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$