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.
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.
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.
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.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"VOOI Perps API","colors":{"primary":"#ECBD75","light":"#C97E2A","dark":"#ECBD75"},"logo":{"light":"https://mintcdn.com/vooi/GJB1sx83FVRU2-Io/logo/light.svg?fit=max\u0026auto=format\u0026n=GJB1sx83FVRU2-Io\u0026q=85\u0026s=d45bb70b22c8481a71d8ca5d45c4ef25","dark":"https://mintcdn.com/vooi/GJB1sx83FVRU2-Io/logo/dark.svg?fit=max\u0026auto=format\u0026n=GJB1sx83FVRU2-Io\u0026q=85\u0026s=627a551288253d46bec5d4fd5d868b35"},"favicon":"https://mintcdn.com/vooi/J1OqcXE6vGDR4XrK/favicon.png?fit=max\u0026auto=format\u0026n=J1OqcXE6vGDR4XrK\u0026q=85\u0026s=4be0c6ed3241588765c396bb20b27a4f","navbar":{"links":[{"href":"https://ultra.vooi.io/","label":"VOOI Ultra"},{"href":"https://discord.com/invite/KhAzSuV5Wx","label":"Discord"}]},"footer":{"socials":{"x":"https://twitter.com/vooi_io","discord":"https://discord.com/invite/KhAzSuV5Wx","github":"https://github.com/vooi-app"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vooi","hasAudioNarration":false,"actualSubdomain":"vooi","customDomains":["perps-api.vooi.io"],"gitSource":{"type":"github","owner":"vooi-app","repo":"perps-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ad08cdae141f9b3b65311f5","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":113},{"language":"default","tag":"Documentation","count":25},{"language":"default","tag":"Exchange","count":23},{"language":"default","tag":"User exchange","count":16},{"language":"default","tag":"Connect an Exchange","count":11},{"language":"default","tag":"Broker","count":10},{"language":"default","tag":"Trading","count":8},{"language":"default","tag":"Bots","count":8},{"language":"default","tag":"Broker Statistics","count":7},{"language":"default","tag":"Arbitrage Auto-Close Orders","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/bots/list-your-bots","slug":"/api-reference/bots/list-your-bots","pageMetadata":{"title":"List your bots","description":null,"deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /bots","href":"/api-reference/bots/list-your-bots","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List your bots","description":null,"deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /bots","href":"/api-reference/bots/list-your-bots","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"BotController_getBots","parameters":[],"responses":{"200":"ca9f96ff-43ae-4b59-855a-525905295613"},"security":["69d6485f-c869-457c-a9b8-6ddde2b9f0db"],"summary":"List your bots","tags":["Bots"],"method":"get","type":"path","servers":["c333a04e-6f40-4718-b256-285d8fffae05"],"path":"/bots","baseUrlOptions":["https://perps-api.vooi.io"],"title":"List your bots","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"ca9f96ff-43ae-4b59-855a-525905295613":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"config":{"oneOf":[{"type":"object","title":"BotConfig","description":"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.","required":["exchanges","leverage","maxRoundTripCostBps","notionalUsd"],"properties":{"exchanges":{"minItems":2,"type":"array","items":{"oneOf":[{"type":"string","description":"Supported perpetual exchange","enum":["aster","binance","bybit","extended","gate","hyperliquid","lighter","mexc","ondo","robinhood"],"uniqueKey":"items.[INDEX].config.oneOf.0.exchanges.items.[INDEX].oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","pattern":"^hyperliquid:(xyz|mkts|io|hyperliquid)$","uniqueKey":"items.[INDEX].config.oneOf.0.exchanges.items.[INDEX].oneOf.1","typeLabel":"string"}],"uniqueKey":"items.[INDEX].config.oneOf.0.exchanges.items.[INDEX]","typeLabel":"enum\u003cstring> | string"},"description":"Venues the pair legs may be opened on: an exchange name for all of its markets, or `hyperliquid:\u003cdex>` for one Hyperliquid dex (`hyperliquid:hyperliquid` for Hyperliquid's own perps, otherwise a HIP-3 dex: `xyz`, `mkts` or `io`); each leg of a pair is on a different one of these, and a bare `hyperliquid` counts as one","example":["hyperliquid:io","lighter"],"isRequired":true,"uniqueKey":"items.[INDEX].config.oneOf.0.exchanges","typeLabel":"(enum\u003cstring> | string)[]"},"leverage":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"Leverage per leg, capped by each market limit","example":2,"isRequired":true,"uniqueKey":"items.[INDEX].config.oneOf.0.leverage","typeLabel":"integer"},"maxRoundTripCostBps":{"type":"number","exclusiveMinimum":0,"description":"Most a round trip (entry plus exit: fees, the hedge's book crossing and the resting leg's bid-ask spread) may cost, in basis points of the notional; pairs are ranked by expected funding over the hold minus this cost","example":25,"isRequired":true,"uniqueKey":"items.[INDEX].config.oneOf.0.maxRoundTripCostBps","typeLabel":"number"},"notionalUsd":{"type":"number","exclusiveMinimum":0,"description":"Notional per leg in USD at the full leverage; a pair trades about 5% under it, further under where a venue reserves fee and slippage beyond notionalUsd / leverage (a market leg on Extended, Lighter or Robinhood) or a market caps leverage lower","example":500,"isRequired":true,"uniqueKey":"items.[INDEX].config.oneOf.0.notionalUsd","typeLabel":"number"},"categories":{"description":"Asset classes to trade; omit to trade every category","minItems":1,"type":"array","items":{"type":"string","enum":["commodities","crypto","etf-index","forex","pre-ipo","stocks-asia","stocks-us"],"description":"Asset class of the market","uniqueKey":"items.[INDEX].config.oneOf.0.categories.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"items.[INDEX].config.oneOf.0.categories","typeLabel":"enum\u003cstring>[]"},"maxHoldHours":{"default":24,"description":"Longest time to hold a pair before closing it even while the spread still pays; low for frequent rolls, high for carry","type":"number","exclusiveMinimum":0,"uniqueKey":"items.[INDEX].config.oneOf.0.maxHoldHours","typeLabel":"number"},"minExpectedNetBps":{"description":"Least a pair must be expected to earn over the hold after its round trip, in basis points of the notional; omit to enter on the cost cap alone, as points farming does","example":20,"type":"number","uniqueKey":"items.[INDEX].config.oneOf.0.minExpectedNetBps","typeLabel":"number"},"requiredExchange":{"oneOf":[{"type":"string","description":"Venue one leg of every pair must be on, an exchange or one Hyperliquid dex as in `exchanges`; omit to let any two venues pair up","enum":["aster","binance","bybit","extended","gate","hyperliquid","lighter","mexc","ondo","robinhood"],"uniqueKey":"items.[INDEX].config.oneOf.0.requiredExchange.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Venue one leg of every pair must be on, an exchange or one Hyperliquid dex as in `exchanges`; omit to let any two venues pair up","pattern":"^hyperliquid:(xyz|mkts|io|hyperliquid)$","uniqueKey":"items.[INDEX].config.oneOf.0.requiredExchange.oneOf.1","typeLabel":"string"}],"uniqueKey":"items.[INDEX].config.oneOf.0.requiredExchange","typeLabel":"enum\u003cstring> | string"},"risk":{"default":"low","type":"string","enum":["low","medium","high"],"description":"How much history the bot wants of a pair: low — a spread positive for the last 12 hours that also paid over the last day, held until the day stops paying or the spread flips hard; medium — the same with 6 hours; high — a spread paying now is enough, held until it turns clearly negative","uniqueKey":"items.[INDEX].config.oneOf.0.risk","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"items.[INDEX].config.oneOf.0","typeLabel":"BotConfig · object"},{"type":"null","description":"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.","isRequired":true,"uniqueKey":"items.[INDEX].config.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].config","typeLabel":"BotConfig · object | null"},"createdAt":{"description":"When the bot was created.","type":"string","format":"date-time","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))$","isRequired":true,"uniqueKey":"items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","format":"uuid","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)$","description":"Bot identifier.","isRequired":true,"uniqueKey":"items.[INDEX].id","typeLabel":"string\u003cuuid>"},"lastError":{"oneOf":[{"description":"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.","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].lastError.oneOf.0","typeLabel":"string"},{"description":"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.","type":"null","isRequired":true,"uniqueKey":"items.[INDEX].lastError.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].lastError","typeLabel":"string | null"},"lastScan":{"oneOf":[{"type":"object","title":"BotScan","description":"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.","required":["candidates","pairs","rejected","scannedAt","skipped"],"properties":{"candidates":{"type":"array","items":{"type":"object","properties":{"asset":{"type":"string","description":"Coin the pair trades, as the scanner names it","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].asset","typeLabel":"string"},"long":{"oneOf":[{"type":"string","description":"Venue the pair would be bought on: the exchange, or `hyperliquid:\u003cdex>` on Hyperliquid","enum":["aster","binance","bybit","extended","gate","hyperliquid","lighter","mexc","ondo","robinhood"],"isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].long.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Venue the pair would be bought on: the exchange, or `hyperliquid:\u003cdex>` on Hyperliquid","pattern":"^hyperliquid:(xyz|mkts|vntl|io|hyperliquid)$","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].long.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].long","typeLabel":"enum\u003cstring> | string"},"short":{"oneOf":[{"type":"string","description":"Venue the pair would be sold on: the exchange, or `hyperliquid:\u003cdex>` on Hyperliquid","enum":["aster","binance","bybit","extended","gate","hyperliquid","lighter","mexc","ondo","robinhood"],"isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].short.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Venue the pair would be sold on: the exchange, or `hyperliquid:\u003cdex>` on Hyperliquid","pattern":"^hyperliquid:(xyz|mkts|vntl|io|hyperliquid)$","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].short.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].short","typeLabel":"enum\u003cstring> | string"},"entryBasisBps":{"type":"number","description":"Price gap between the two venues' mids at entry, positive when the short leg is dearer","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].entryBasisBps","typeLabel":"number"},"expectedNetBps":{"type":"number","description":"Funding expected over the configured hold at the lower of the current and the day-average spread, less the round trip cost","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].expectedNetBps","typeLabel":"number"},"limitLeg":{"type":"string","enum":["long","short"],"description":"Which leg would rest as a post-only limit","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].limitLeg","typeLabel":"enum\u003cstring>"},"roundTripCostBps":{"type":"number","description":"Fees, the hedge's book crossing, the resting leg's bid-ask spread and the entry gap, for opening and closing the pair","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].roundTripCostBps","typeLabel":"number"},"spreadBpsPerHour":{"type":"number","description":"Funding spread between the two venues, in bps per hour","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].spreadBpsPerHour","typeLabel":"number"},"averageSpreadBpsPerHour":{"oneOf":[{"description":"Average funding spread over the last day, in bps per hour; null when unknown","type":"number","uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].averageSpreadBpsPerHour.oneOf.0","typeLabel":"number"},{"description":"Average funding spread over the last day, in bps per hour; null when unknown","type":"null","uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].averageSpreadBpsPerHour.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].averageSpreadBpsPerHour","typeLabel":"number | null"},"feesBps":{"description":"Fees for opening and closing the pair at the account's rates, the VOOI fee included, in bps of the notional; part of roundTripCostBps","type":"number","uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].feesBps","typeLabel":"number"},"longMarketId":{"description":"Market the long leg would trade on its venue","type":"string","uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].longMarketId","typeLabel":"string"},"longSlippageBps":{"oneOf":[{"description":"Cost of buying the bot's notional across the long venue's book, in bps of mid; null when the scanner has no depth for it","type":"number","uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].longSlippageBps.oneOf.0","typeLabel":"number"},{"description":"Cost of buying the bot's notional across the long venue's book, in bps of mid; null when the scanner has no depth for it","type":"null","uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].longSlippageBps.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].longSlippageBps","typeLabel":"number | null"},"shortMarketId":{"description":"Market the short leg would trade on its venue","type":"string","uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].shortMarketId","typeLabel":"string"},"shortSlippageBps":{"oneOf":[{"description":"Cost of selling the bot's notional across the short venue's book, in bps of mid; null when the scanner has no depth for it","type":"number","uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].shortSlippageBps.oneOf.0","typeLabel":"number"},{"description":"Cost of selling the bot's notional across the short venue's book, in bps of mid; null when the scanner has no depth for it","type":"null","uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].shortSlippageBps.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX].shortSlippageBps","typeLabel":"number | null"}},"required":["asset","long","short","entryBasisBps","expectedNetBps","limitLeg","roundTripCostBps","spreadBpsPerHour"],"title":"BotScanCandidate","uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates.items.[INDEX]","typeLabel":"BotScanCandidate · object"},"description":"The most promising pairs that passed ranking, best first; only the few the bot would try are kept, and `pairs` less the `rejected` counts is how many passed","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.candidates","typeLabel":"BotScanCandidate · object[]"},"pairs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"How many pairs the scanner returned","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.pairs","typeLabel":"integer"},"rejected":{"type":"array","items":{"type":"object","properties":{"pairs":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"How many pairs this rule dropped","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.rejected.items.[INDEX].pairs","typeLabel":"integer"},"reason":{"type":"string","enum":["average_not_paying","cost_above_cap","expected_net_below_min","no_entry_basis","no_reverse_pair","no_slippage","not_on_required_venue","spread_not_held","spread_not_held_24h","spread_not_paying"],"description":"spread_not_paying — funding does not pay in this direction; spread_not_held — the spread has not been positive for as long as the risk level asks, or its history is unknown; average_not_paying — it pays now but paid nothing net over the last day (low and medium); spread_not_held_24h — the spread turned against the pair in the last day (older scans); not_on_required_venue — neither leg is on the pinned venue; no_entry_basis — a venue is not quoting both sides, or its bid is not below its ask; no_slippage — the scanner has no slippage for the hedging leg; cost_above_cap — the round trip costs more than the configured cap; expected_net_below_min — the funding expected over the hold does not clear the round trip by the configured margin; no_reverse_pair — the venues did not quote the pair the other way (older scans)","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.rejected.items.[INDEX].reason","typeLabel":"enum\u003cstring>"}},"required":["pairs","reason"],"title":"BotScanRejection","uniqueKey":"items.[INDEX].lastScan.oneOf.0.rejected.items.[INDEX]","typeLabel":"BotScanRejection · object"},"description":"What ranking dropped, counted per rule","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.rejected","typeLabel":"BotScanRejection · object[]"},"scannedAt":{"type":"string","format":"date-time","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))$","description":"When the scan ran","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.scannedAt","typeLabel":"string\u003cdate-time>"},"skipped":{"type":"array","items":{"type":"object","properties":{"asset":{"type":"string","description":"Coin the pair trades, as the scanner names it","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.skipped.items.[INDEX].asset","typeLabel":"string"},"long":{"oneOf":[{"type":"string","description":"Venue the pair would be bought on: the exchange, or `hyperliquid:\u003cdex>` on Hyperliquid","enum":["aster","binance","bybit","extended","gate","hyperliquid","lighter","mexc","ondo","robinhood"],"isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.skipped.items.[INDEX].long.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Venue the pair would be bought on: the exchange, or `hyperliquid:\u003cdex>` on Hyperliquid","pattern":"^hyperliquid:(xyz|mkts|vntl|io|hyperliquid)$","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.skipped.items.[INDEX].long.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.skipped.items.[INDEX].long","typeLabel":"enum\u003cstring> | string"},"short":{"oneOf":[{"type":"string","description":"Venue the pair would be sold on: the exchange, or `hyperliquid:\u003cdex>` on Hyperliquid","enum":["aster","binance","bybit","extended","gate","hyperliquid","lighter","mexc","ondo","robinhood"],"isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.skipped.items.[INDEX].short.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Venue the pair would be sold on: the exchange, or `hyperliquid:\u003cdex>` on Hyperliquid","pattern":"^hyperliquid:(xyz|mkts|vntl|io|hyperliquid)$","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.skipped.items.[INDEX].short.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.skipped.items.[INDEX].short","typeLabel":"enum\u003cstring> | string"},"reason":{"type":"string","description":"What stopped the bot from opening this pair","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.skipped.items.[INDEX].reason","typeLabel":"string"}},"required":["asset","long","short","reason"],"title":"BotScanSkip","uniqueKey":"items.[INDEX].lastScan.oneOf.0.skipped.items.[INDEX]","typeLabel":"BotScanSkip · object"},"description":"Ranked pairs the bot could not open, with what stopped each one","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.skipped","typeLabel":"BotScanSkip · object[]"},"nearMisses":{"default":[],"description":"The pairs only the cost cap or only the expected-profit floor refused, the two closest to each limit, the closest first: the cheapest over the cap, the highest expected net under the floor; scans stored before the field have none","type":"array","items":{"type":"object","properties":{"asset":{"type":"string","description":"Coin the pair trades, as the scanner names it","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].asset","typeLabel":"string"},"long":{"oneOf":[{"type":"string","description":"Venue the pair would be bought on: the exchange, or `hyperliquid:\u003cdex>` on Hyperliquid","enum":["aster","binance","bybit","extended","gate","hyperliquid","lighter","mexc","ondo","robinhood"],"isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].long.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Venue the pair would be bought on: the exchange, or `hyperliquid:\u003cdex>` on Hyperliquid","pattern":"^hyperliquid:(xyz|mkts|vntl|io|hyperliquid)$","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].long.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].long","typeLabel":"enum\u003cstring> | string"},"short":{"oneOf":[{"type":"string","description":"Venue the pair would be sold on: the exchange, or `hyperliquid:\u003cdex>` on Hyperliquid","enum":["aster","binance","bybit","extended","gate","hyperliquid","lighter","mexc","ondo","robinhood"],"isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].short.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Venue the pair would be sold on: the exchange, or `hyperliquid:\u003cdex>` on Hyperliquid","pattern":"^hyperliquid:(xyz|mkts|vntl|io|hyperliquid)$","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].short.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].short","typeLabel":"enum\u003cstring> | string"},"entryBasisBps":{"type":"number","description":"Price gap between the two venues' mids at entry, positive when the short leg is dearer","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].entryBasisBps","typeLabel":"number"},"expectedNetBps":{"type":"number","description":"Funding expected over the configured hold at the lower of the current and the day-average spread, less the round trip cost","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].expectedNetBps","typeLabel":"number"},"limitLeg":{"type":"string","enum":["long","short"],"description":"Which leg would rest as a post-only limit","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].limitLeg","typeLabel":"enum\u003cstring>"},"roundTripCostBps":{"type":"number","description":"Fees, the hedge's book crossing, the resting leg's bid-ask spread and the entry gap, for opening and closing the pair","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].roundTripCostBps","typeLabel":"number"},"spreadBpsPerHour":{"type":"number","description":"Funding spread between the two venues, in bps per hour","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].spreadBpsPerHour","typeLabel":"number"},"reason":{"type":"string","enum":["cost_above_cap","expected_net_below_min"],"description":"cost_above_cap — the round trip costs more than the configured cap; expected_net_below_min — the funding expected over the hold does not clear the round trip by the configured margin","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].reason","typeLabel":"enum\u003cstring>"},"averageSpreadBpsPerHour":{"oneOf":[{"description":"Average funding spread over the last day, in bps per hour; null when unknown","type":"number","uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].averageSpreadBpsPerHour.oneOf.0","typeLabel":"number"},{"description":"Average funding spread over the last day, in bps per hour; null when unknown","type":"null","uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].averageSpreadBpsPerHour.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].averageSpreadBpsPerHour","typeLabel":"number | null"},"feesBps":{"description":"Fees for opening and closing the pair at the account's rates, the VOOI fee included, in bps of the notional; part of roundTripCostBps","type":"number","uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].feesBps","typeLabel":"number"},"longMarketId":{"description":"Market the long leg would trade on its venue","type":"string","uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].longMarketId","typeLabel":"string"},"longSlippageBps":{"oneOf":[{"description":"Cost of buying the bot's notional across the long venue's book, in bps of mid; null when the scanner has no depth for it","type":"number","uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].longSlippageBps.oneOf.0","typeLabel":"number"},{"description":"Cost of buying the bot's notional across the long venue's book, in bps of mid; null when the scanner has no depth for it","type":"null","uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].longSlippageBps.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].longSlippageBps","typeLabel":"number | null"},"shortMarketId":{"description":"Market the short leg would trade on its venue","type":"string","uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].shortMarketId","typeLabel":"string"},"shortSlippageBps":{"oneOf":[{"description":"Cost of selling the bot's notional across the short venue's book, in bps of mid; null when the scanner has no depth for it","type":"number","uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].shortSlippageBps.oneOf.0","typeLabel":"number"},{"description":"Cost of selling the bot's notional across the short venue's book, in bps of mid; null when the scanner has no depth for it","type":"null","uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].shortSlippageBps.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX].shortSlippageBps","typeLabel":"number | null"}},"required":["asset","long","short","entryBasisBps","expectedNetBps","limitLeg","roundTripCostBps","spreadBpsPerHour","reason"],"title":"BotScanNearMiss","uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses.items.[INDEX]","typeLabel":"BotScanNearMiss · object"},"uniqueKey":"items.[INDEX].lastScan.oneOf.0.nearMisses","typeLabel":"BotScanNearMiss · object[]"}},"isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.0","typeLabel":"BotScan · object"},{"type":"null","description":"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.","isRequired":true,"uniqueKey":"items.[INDEX].lastScan.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].lastScan","typeLabel":"BotScan · object | null"},"openCycle":{"oneOf":[{"type":"object","title":"BotOpenCycle","description":"The pair the bot is working on, or null while it holds none.","required":["closeAttempts","id","pair","phase"],"properties":{"closeAttempts":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Exit orders the bot has sent for this pair so far, or rounds of closing an unhedged entry at market.","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.closeAttempts","typeLabel":"integer"},"id":{"type":"string","format":"uuid","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)$","description":"Cycle identifier.","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.id","typeLabel":"string\u003cuuid>"},"pair":{"oneOf":[{"type":"object","title":"BotOpenCyclePair","description":"The pair itself, read back from the order that opened it; null when that order is no longer in the database, which leaves the bot holding a pair it cannot describe.","required":["asset","baseQuantity","heldFrom","limitLeg","long","openedAt","short"],"properties":{"asset":{"type":"string","description":"Coin the pair trades.","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.asset","typeLabel":"string"},"baseQuantity":{"type":"string","description":"Size of each leg in base units.","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.baseQuantity","typeLabel":"string"},"heldFrom":{"oneOf":[{"type":"string","description":"When the entry filled and the hold started; null until the hedge fills, and while the pair is unavailable.","format":"date-time","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))$","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.heldFrom.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the entry filled and the hold started; null until the hedge fills, and while the pair is unavailable.","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.heldFrom.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.heldFrom","typeLabel":"string\u003cdate-time> | null"},"limitLeg":{"type":"string","enum":["long","short"],"description":"Which leg rests as a post-only limit: long (bought) or short (sold).","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.limitLeg","typeLabel":"enum\u003cstring>"},"long":{"type":"object","properties":{"baseSymbol":{"type":"string","description":"Base symbol on this venue","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.long.baseSymbol","typeLabel":"string"},"exchange":{"type":"string","enum":["aster","binance","bybit","extended","gate","hyperliquid","lighter","mexc","ondo","robinhood"],"description":"Venue the leg trades on","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.long.exchange","typeLabel":"enum\u003cstring>"},"marketId":{"type":"string","description":"Venue-specific market identifier","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.long.marketId","typeLabel":"string"},"quoteSymbol":{"type":"string","description":"Quote symbol on this venue","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.long.quoteSymbol","typeLabel":"string"},"userExchangeId":{"type":"string","pattern":"^[1-9]\\d*$","description":"Venue account the leg was opened on; it stays the same even if you reconnect the venue.","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.long.userExchangeId","typeLabel":"string"}},"required":["baseSymbol","exchange","marketId","quoteSymbol","userExchangeId"],"title":"BotOpenCycleLeg","description":"Leg the bot bought.","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.long","typeLabel":"BotOpenCycleLeg · object"},"openedAt":{"description":"When the bot sent the entry order.","type":"string","format":"date-time","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))$","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.openedAt","typeLabel":"string\u003cdate-time>"},"short":{"type":"object","properties":{"baseSymbol":{"type":"string","description":"Base symbol on this venue","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.short.baseSymbol","typeLabel":"string"},"exchange":{"type":"string","enum":["aster","binance","bybit","extended","gate","hyperliquid","lighter","mexc","ondo","robinhood"],"description":"Venue the leg trades on","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.short.exchange","typeLabel":"enum\u003cstring>"},"marketId":{"type":"string","description":"Venue-specific market identifier","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.short.marketId","typeLabel":"string"},"quoteSymbol":{"type":"string","description":"Quote symbol on this venue","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.short.quoteSymbol","typeLabel":"string"},"userExchangeId":{"type":"string","pattern":"^[1-9]\\d*$","description":"Venue account the leg was opened on; it stays the same even if you reconnect the venue.","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.short.userExchangeId","typeLabel":"string"}},"required":["baseSymbol","exchange","marketId","quoteSymbol","userExchangeId"],"title":"BotOpenCycleLeg","description":"Leg the bot sold.","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0.short","typeLabel":"BotOpenCycleLeg · object"}},"isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.0","typeLabel":"BotOpenCyclePair · object"},{"type":"null","description":"The pair itself, read back from the order that opened it; null when that order is no longer in the database, which leaves the bot holding a pair it cannot describe.","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.pair","typeLabel":"BotOpenCyclePair · object | null"},"phase":{"type":"string","enum":["closing","holding","opening"],"description":"opening — the entry order is working; holding — both legs are open; closing — an exit order is working, or the bot is closing what an unhedged entry filled.","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0.phase","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.0","typeLabel":"BotOpenCycle · object"},{"type":"null","description":"The pair the bot is working on, or null while it holds none.","isRequired":true,"uniqueKey":"items.[INDEX].openCycle.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].openCycle","typeLabel":"BotOpenCycle · object | null"},"status":{"type":"string","enum":["halted","running","stopped","stopping"],"description":"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.","isRequired":true,"uniqueKey":"items.[INDEX].status","typeLabel":"enum\u003cstring>"},"updatedAt":{"description":"When the bot last changed.","type":"string","format":"date-time","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))$","isRequired":true,"uniqueKey":"items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"}},"required":["config","createdAt","id","lastError","lastScan","openCycle","status","updatedAt"],"title":"Bot","uniqueKey":"items.[INDEX]","typeLabel":"Bot · object"},"uniqueKey":"","typeLabel":"Bot · object[]"},"examples":{"Example":{"title":"Example","value":[{"config":{"exchanges":["hyperliquid:io","lighter"],"leverage":2,"maxRoundTripCostBps":25,"notionalUsd":500,"categories":["commodities"],"maxHoldHours":24,"minExpectedNetBps":20,"requiredExchange":"aster","risk":"low"},"createdAt":"2023-11-07T05:31:56Z","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","lastError":"\u003cstring>","lastScan":{"candidates":[{"asset":"\u003cstring>","long":"aster","short":"aster","entryBasisBps":123,"expectedNetBps":123,"limitLeg":"long","roundTripCostBps":123,"spreadBpsPerHour":123,"averageSpreadBpsPerHour":123,"feesBps":123,"longMarketId":"\u003cstring>","longSlippageBps":123,"shortMarketId":"\u003cstring>","shortSlippageBps":123}],"pairs":4503599627370495,"rejected":[{"pairs":123,"reason":"average_not_paying"}],"scannedAt":"2023-11-07T05:31:56Z","skipped":[{"asset":"\u003cstring>","long":"aster","short":"aster","reason":"\u003cstring>"}],"nearMisses":[]},"openCycle":{"closeAttempts":4503599627370495,"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","pair":{"asset":"\u003cstring>","baseQuantity":"\u003cstring>","heldFrom":"2023-11-07T05:31:56Z","limitLeg":"long","long":{"baseSymbol":"\u003cstring>","exchange":"aster","marketId":"\u003cstring>","quoteSymbol":"\u003cstring>","userExchangeId":"\u003cstring>"},"openedAt":"2023-11-07T05:31:56Z","short":{"baseSymbol":"\u003cstring>","exchange":"aster","marketId":"\u003cstring>","quoteSymbol":"\u003cstring>","userExchangeId":"\u003cstring>"}},"phase":"closing"},"status":"halted","updatedAt":"2023-11-07T05:31:56Z"}]}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"69d6485f-c869-457c-a9b8-6ddde2b9f0db":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http","scopes":[],"schemeName":"bearer"}}},"servers":{"c333a04e-6f40-4718-b256-285d8fffae05":{"url":"https://perps-api.vooi.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"JWT","type":"http","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"https://vooi-api-app.fly.dev/swagger/json"},"subdomain":"vooi","siteName":"VOOI Perps API","title":"List your bots - VOOI Perps API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-15T08:20:53.785Z","originalFileLocation":"api-reference/bots/list-your-bots.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"VOOI Perps API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/vooi/QhqMYf4NA7_PGp-k/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/vooi/QhqMYf4NA7_PGp-k/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/vooi/QhqMYf4NA7_PGp-k/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/vooi/QhqMYf4NA7_PGp-k/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/vooi/QhqMYf4NA7_PGp-k/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/vooi/QhqMYf4NA7_PGp-k/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/vooi/QhqMYf4NA7_PGp-k/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/vooi/QhqMYf4NA7_PGp-k/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/vooi/QhqMYf4NA7_PGp-k/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List your bots - VOOI Perps API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"VOOI Perps API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://perps-api.vooi.io/docs/api-reference/bots/list-your-bots\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vooi.mintlify.site/docs/_mintlify/api/og/v2?division=Bots\u0026amp;title=List+your+bots\u0026amp;theme=087d8eaad99657390b897b67\u0026amp;signature=c17360d1d948d7deff9b15dab0b3bba6029894973b28ecf7b2811d3c8d9da5dc\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List your bots - VOOI Perps API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vooi.mintlify.site/docs/_mintlify/api/og/v2?division=Bots\u0026amp;title=List+your+bots\u0026amp;theme=087d8eaad99657390b897b67\u0026amp;signature=c17360d1d948d7deff9b15dab0b3bba6029894973b28ecf7b2811d3c8d9da5dc\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/vooi/QhqMYf4NA7_PGp-k/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"VOOI Perps API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ECBD75\">\u003clink data-mint-head rel=\"canonical\" href=\"https://perps-api.vooi.io/docs/api-reference/bots/list-your-bots\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/bots/list-your-bots.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://perps-api.vooi.io/#organization\",\"name\":\"VOOI Perps API\",\"url\":\"https://perps-api.vooi.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vooi/GJB1sx83FVRU2-Io/logo/light.svg?fit=max\u0026auto=format\u0026n=GJB1sx83FVRU2-Io\u0026q=85\u0026s=d45bb70b22c8481a71d8ca5d45c4ef25\"}},{\"@type\":\"WebSite\",\"@id\":\"https://perps-api.vooi.io/docs#website\",\"name\":\"VOOI Perps API\",\"url\":\"https://perps-api.vooi.io/docs\",\"publisher\":{\"@id\":\"https://perps-api.vooi.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://perps-api.vooi.io/docs/api-reference/bots/list-your-bots#webpage\",\"url\":\"https://perps-api.vooi.io/docs/api-reference/bots/list-your-bots\",\"name\":\"List your bots\",\"dateModified\":\"2026-10-15T08:20:53.785Z\",\"isPartOf\":{\"@id\":\"https://perps-api.vooi.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://perps-api.vooi.io/docs/api-reference/bots/list-your-bots#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://perps-api.vooi.io/docs/api-reference/bots/list-your-bots#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"VOOI Perps API\",\"item\":\"https://perps-api.vooi.io/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List your bots\",\"item\":\"https://perps-api.vooi.io/docs/api-reference/bots/list-your-bots\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://perps-api.vooi.io/docs/api-reference/bots/list-your-bots#apireference\",\"headline\":\"List your bots\",\"name\":\"List your bots\",\"url\":\"https://perps-api.vooi.io/docs/api-reference/bots/list-your-bots\",\"mainEntityOfPage\":{\"@id\":\"https://perps-api.vooi.io/docs/api-reference/bots/list-your-bots#webpage\"},\"dateModified\":\"2026-10-15T08:20:53.785Z\",\"publisher\":{\"@id\":\"https://perps-api.vooi.io/#organization\"},\"isPartOf\":{\"@id\":\"https://perps-api.vooi.io/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"VOOI Perps API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"VOOI Perps API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Arbitrage Auto-Close Orders","pages":[{"title":"Get a single arbitrage auto-close order","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /arbitrage-auto-close-orders/{id}","href":"/api-reference/arbitrage-auto-close-orders/get-a-single-arbitrage-auto-close-order"},{"title":"Cancel an arbitrage auto-close order","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json delete /arbitrage-auto-close-orders/{id}","href":"/api-reference/arbitrage-auto-close-orders/cancel-an-arbitrage-auto-close-order"},{"title":"Update the conditions of an arbitrage auto-close order","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json patch /arbitrage-auto-close-orders/{id}","href":"/api-reference/arbitrage-auto-close-orders/update-the-conditions-of-an-arbitrage-auto-close-order"},{"title":"List arbitrage auto-close orders","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /arbitrage-auto-close-orders","href":"/api-reference/arbitrage-auto-close-orders/list-arbitrage-auto-close-orders"},{"title":"Create an arbitrage auto-close order","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /arbitrage-auto-close-orders","href":"/api-reference/arbitrage-auto-close-orders/create-an-arbitrage-auto-close-order"}]},{"group":"Arbitrage Orders","pages":[{"title":"Get a single arbitrage order","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /arbitrage-orders/{id}","href":"/api-reference/arbitrage-orders/get-a-single-arbitrage-order"},{"title":"Cancel an arbitrage order","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json delete /arbitrage-orders/{id}","href":"/api-reference/arbitrage-orders/cancel-an-arbitrage-order"},{"title":"List arbitrage orders","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /arbitrage-orders","href":"/api-reference/arbitrage-orders/list-arbitrage-orders"},{"title":"Create an arbitrage order","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /arbitrage-orders","href":"/api-reference/arbitrage-orders/create-an-arbitrage-order"}]},{"group":"Tokens","pages":[{"title":"List named API tokens","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /user/tokens","href":"/api-reference/tokens/list-named-api-tokens"},{"title":"Create a new API token","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /user/tokens","href":"/api-reference/tokens/create-a-new-api-token"},{"title":"Delete an API token","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json delete /user/tokens","href":"/api-reference/tokens/delete-an-api-token"}]},{"group":"User","pages":[{"title":"Get current user info","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /user","href":"/api-reference/user/get-current-user-info"}]},{"group":"Arbitrage Scanner","pages":[{"title":"List arbitrage scanner opportunities","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /arbitrage-scanner","href":"/api-reference/arbitrage-scanner/list-arbitrage-scanner-opportunities"},{"title":"Per-minute funding rates for a market pair","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /arbitrage-scanner/funding-candles","href":"/api-reference/arbitrage-scanner/per-minute-funding-rates-for-a-market-pair"},{"title":"Price spread candles for a market pair","description":"Returns all stored price spread candles for a market pair at the requested resolution, oldest first. Leg A is the buy (ask) side and leg B is the sell (bid) side; the spread is computed as `2 * (bidB - askA) / (bidB + askA)`. Intervals without ticks are omitted, not zero-filled.","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /arbitrage-scanner/price-spread-candles","href":"/api-reference/arbitrage-scanner/price-spread-candles-for-a-market-pair"}]},{"group":"Bots","pages":[{"title":"List your bots","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /bots","href":"/api-reference/bots/list-your-bots"},{"title":"Create a bot","description":"Creates a stopped funding bot. Once started it scans the arbitrage scanner for cross-venue pairs with a positive funding spread, positive for as many hours as `risk` demands, whose round trip costs at most `maxRoundTripCostBps` and, when `minExpectedNetBps` is set, is expected to earn at least that much over it, opens the one expected to earn the most over `maxHoldHours`, holds until the spread turns against the pair (for `low` and `medium` the day average stops paying or the spread flips hard, for `high` it turns clearly negative) or `maxHoldHours` pass, closes, and scans again.","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /bots","href":"/api-reference/bots/create-a-bot"},{"title":"Edit a bot","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json put /bots/{id}","href":"/api-reference/bots/edit-a-bot"},{"title":"Delete a bot","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json delete /bots/{id}","href":"/api-reference/bots/delete-a-bot"},{"title":"Read a bot's cycles","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /bots/{id}/cycles","href":"/api-reference/bots/read-a-bots-cycles"},{"title":"Read a bot's totals","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /bots/{id}/stats","href":"/api-reference/bots/read-a-bots-totals"},{"title":"Start a bot","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /bots/{id}/start","href":"/api-reference/bots/start-a-bot"},{"title":"Stop a bot","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /bots/{id}/stop","href":"/api-reference/bots/stop-a-bot"}]},{"group":"Broker","pages":[{"title":"Deactivate broker settings for a specific exchange","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json delete /broker/exchanges/{exchange}","href":"/api-reference/broker/deactivate-broker-settings-for-a-specific-exchange"},{"title":"Get broker exchange settings for all exchanges","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /broker/exchanges","href":"/api-reference/broker/get-broker-exchange-settings-for-all-exchanges"},{"title":"Add new broker key and fee settings for a specific exchange","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /broker/exchanges","href":"/api-reference/broker/add-new-broker-key-and-fee-settings-for-a-specific-exchange"},{"title":"Get order history for broker users","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /broker/orders","href":"/api-reference/broker/get-order-history-for-broker-users"},{"title":"Get aggregated trading statistics for broker users (max 30-day period)","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /broker/stats","href":"/api-reference/broker/get-aggregated-trading-statistics-for-broker-users-max-30-day-period"},{"title":"Get broker users ranked by API-created order volume in USD, with pagination","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /broker/users/top-volume","href":"/api-reference/broker/get-broker-users-ranked-by-api-created-order-volume-in-usd-with-pagination"},{"title":"Get trade history for broker users","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /broker/trades","href":"/api-reference/broker/get-trade-history-for-broker-users"},{"title":"Get broker users ranked by executed notional volume","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /broker/users/stats","href":"/api-reference/broker/get-broker-users-ranked-by-executed-notional-volume"},{"title":"Register a new user","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /broker/users","href":"/api-reference/broker/register-a-new-user"},{"title":"Set or remove a public key for a user","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json put /broker/users/public-key","href":"/api-reference/broker/set-or-remove-a-public-key-for-a-user"}]},{"group":"Broker Statistics","pages":[{"title":"Get trade volume and unique traders from API-created orders, broken down by exchange, with totals","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /broker-statistics/summary","href":"/api-reference/broker-statistics/get-trade-volume-and-unique-traders-from-api-created-orders-broken-down-by-exchange-with-totals"},{"title":"Get user realized PnL, broken down by exchange","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /broker-statistics/user-pnl","href":"/api-reference/broker-statistics/get-user-realized-pnl-broken-down-by-exchange"},{"title":"Get per-interval (day or hour) realized PnL of a user broken down by exchange, with gaps filled","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /broker-statistics/user-pnl/chart","href":"/api-reference/broker-statistics/get-per-interval-day-or-hour-realized-pnl-of-a-user-broken-down-by-exchange-with-gaps-filled"},{"title":"Get per-user trade volume and broker fees, broken down by exchange, for a list of users","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /broker-statistics/users-volume","href":"/api-reference/broker-statistics/get-per-user-trade-volume-and-broker-fees-broken-down-by-exchange-for-a-list-of-users"},{"title":"Get per-interval (day or hour) trade volume broken down by exchange across a list of users, with gaps filled","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /broker-statistics/users-volume/chart","href":"/api-reference/broker-statistics/get-per-interval-day-or-hour-trade-volume-broken-down-by-exchange-across-a-list-of-users-with-gaps-filled"},{"title":"Get user trade volume and fees, broken down by exchange","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /broker-statistics/user-volume","href":"/api-reference/broker-statistics/get-user-trade-volume-and-fees-broken-down-by-exchange"},{"title":"Get per-interval (day or hour) trade volume of a user broken down by exchange, with gaps filled","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /broker-statistics/user-volume/chart","href":"/api-reference/broker-statistics/get-per-interval-day-or-hour-trade-volume-of-a-user-broken-down-by-exchange-with-gaps-filled"}]},{"group":"Deposit","pages":[{"title":"Get deposit transactions for signing","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /deposit","href":"/api-reference/deposit/get-deposit-transactions-for-signing"}]},{"group":"Funding Strategies","pages":[{"title":"Funding rate history for a single market","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /funding-strategies/funding-rate-history","href":"/api-reference/funding-strategies/funding-rate-history-for-a-single-market"},{"title":"Funding spread chart data","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /funding-strategies/spread-chart","href":"/api-reference/funding-strategies/funding-spread-chart-data"},{"title":"List funding arbitrage strategies","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /funding-strategies","href":"/api-reference/funding-strategies/list-funding-arbitrage-strategies"}]},{"group":"Exchange","pages":[{"title":"Create multiple orders in a single batch","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /exchange/batch-orders","href":"/api-reference/exchange/create-multiple-orders-in-a-single-batch"},{"title":"Cancel multiple orders in a single batch","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json delete /exchange/batch-orders","href":"/api-reference/exchange/cancel-multiple-orders-in-a-single-batch"},{"title":"Cancel all open orders on an exchange (supported on Binance, Extended, and Lighter)","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json delete /exchange/all-orders","href":"/api-reference/exchange/cancel-all-open-orders-on-an-exchange-supported-on-binance-extended-and-lighter"},{"title":"Get order history","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /exchange/orders","href":"/api-reference/exchange/get-order-history"},{"title":"Create a new order","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /exchange/orders","href":"/api-reference/exchange/create-a-new-order"},{"title":"Cancel an open order","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json delete /exchange/orders","href":"/api-reference/exchange/cancel-an-open-order"},{"title":"Create one-time token update token","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /exchange/updates-token","href":"/api-reference/exchange/create-one-time-token-update-token"},{"title":"Get account settings. Aster returns hedge mode, margin type, multi-assets margin. Hyperliquid returns the abstraction mode. Extended returns the applied referral code. Bybit returns the margin mode, unified account balances and the account upgrade status. Lighter and Robinhood return the account fee tier and the fees it charges.","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /exchange/account-info","href":"/api-reference/exchange/get-account-settings-aster-returns-hedge-mode-margin-type-multi-assets-margin-hyperliquid-returns-the-abstraction-mode-extended-returns-the-applied-referral-code-bybit-returns-the-margin-mode-unified-account-balances-and-the-account-upgrade-status-lighter-and-robinhood-return-the-account-fee-tier-and-the-fees-it-charges"},{"title":"Get account balances","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /exchange/accounts","href":"/api-reference/exchange/get-account-balances"},{"title":"Get asset classes in use","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /exchange/markets/categories","href":"/api-reference/exchange/get-asset-classes-in-use"},{"title":"Get available trading markets","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /exchange/markets","href":"/api-reference/exchange/get-available-trading-markets"},{"title":"Get current user settings for a market","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /exchange/market-settings","href":"/api-reference/exchange/get-current-user-settings-for-a-market"},{"title":"Get open orders","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /exchange/open-orders","href":"/api-reference/exchange/get-open-orders"},{"title":"Get a single order by its exchange order ID or your client order ID","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /exchange/order","href":"/api-reference/exchange/get-a-single-order-by-its-exchange-order-id-or-your-client-order-id"},{"title":"Get open positions","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /exchange/positions","href":"/api-reference/exchange/get-open-positions"},{"title":"Get quotes for markets","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /exchange/quotes","href":"/api-reference/exchange/get-quotes-for-markets"},{"title":"Get slippage for provided notional and side","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /exchange/estimate-slippage","href":"/api-reference/exchange/get-slippage-for-provided-notional-and-side"},{"title":"Get quotes for top markets by 24h volume across all exchanges","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /exchange/top-volume-symbols-quotes","href":"/api-reference/exchange/get-quotes-for-top-markets-by-24h-volume-across-all-exchanges"},{"title":"Get trade history","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /exchange/trades","href":"/api-reference/exchange/get-trade-history"},{"title":"Set leverage for a market","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /exchange/leverage","href":"/api-reference/exchange/set-leverage-for-a-market"},{"title":"Set margin mode for a market","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /exchange/margin-mode","href":"/api-reference/exchange/set-margin-mode-for-a-market"},{"title":"Subscribe to order book updates via SSE","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /exchange/updates-orderbook","href":"/api-reference/exchange/subscribe-to-order-book-updates-via-sse"},{"title":"Subscribe to real-time updates (SSE)","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /exchange/updates","href":"/api-reference/exchange/subscribe-to-real-time-updates-sse"}]},{"group":"Exchange / Broker","pages":[{"title":"Submit a signed broker-approval action for the given exchange","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /exchange/broker/execute","href":"/api-reference/exchange-broker/submit-a-signed-broker-approval-action-for-the-given-exchange"},{"title":"Get the configured and on-chain approved builder fees for the user's broker","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /exchange/broker/approved","href":"/api-reference/exchange-broker/get-the-configured-and-on-chain-approved-builder-fees-for-the-users-broker"},{"title":"Build the payload the user must sign to approve a broker on the given exchange","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /exchange/broker/prepare","href":"/api-reference/exchange-broker/build-the-payload-the-user-must-sign-to-approve-a-broker-on-the-given-exchange"}]},{"group":"Exchange / Bybit","pages":[{"title":"Accept a market's trading agreement","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /exchange/bybit/agreement","href":"/api-reference/exchange-bybit/accept-a-markets-trading-agreement"}]},{"group":"Exchange / Hyperliquid","pages":[{"title":"Submit a signed Hyperliquid sendAsset transfer","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /exchange/hyperliquid/send-asset/execute","href":"/api-reference/exchange-hyperliquid/submit-a-signed-hyperliquid-sendasset-transfer"},{"title":"Submit a signed Hyperliquid abstraction mode change","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /exchange/hyperliquid/set-abstraction/execute","href":"/api-reference/exchange-hyperliquid/submit-a-signed-hyperliquid-abstraction-mode-change"},{"title":"Build EIP-712 data the main Hyperliquid wallet must sign to transfer assets between perp DEXes, spot, users, and/or sub-accounts","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /exchange/hyperliquid/send-asset/prepare","href":"/api-reference/exchange-hyperliquid/build-eip-712-data-the-main-hyperliquid-wallet-must-sign-to-transfer-assets-between-perp-dexes-spot-users-andor-sub-accounts"},{"title":"Build EIP-712 data the main Hyperliquid wallet must sign to change the abstraction mode","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /exchange/hyperliquid/set-abstraction/prepare","href":"/api-reference/exchange-hyperliquid/build-eip-712-data-the-main-hyperliquid-wallet-must-sign-to-change-the-abstraction-mode"},{"title":"Swap between stablecoins on the Hyperliquid spot market","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /exchange/hyperliquid/stablecoins-swap","href":"/api-reference/exchange-hyperliquid/swap-between-stablecoins-on-the-hyperliquid-spot-market"}]},{"group":"Exchange / Lighter","pages":[{"title":"Set the account fee tier","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /exchange/lighter/account-tier","href":"/api-reference/exchange-lighter/set-the-account-fee-tier"}]},{"group":"User exchange","pages":[{"title":"Execute exchange registration","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /user-exchange/{exchange}/register/execute","href":"/api-reference/user-exchange/execute-exchange-registration"},{"title":"Check registration status","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /user-exchange/{exchange}/register/status","href":"/api-reference/user-exchange/check-registration-status"},{"title":"Prepare exchange registration","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /user-exchange/{exchange}/register/prepare","href":"/api-reference/user-exchange/prepare-exchange-registration"},{"title":"Disconnect an exchange","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json delete /user-exchange/{exchange}","href":"/api-reference/user-exchange/disconnect-an-exchange"},{"title":"Get connected exchanges","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /user-exchange","href":"/api-reference/user-exchange/get-connected-exchanges"},{"title":"Connect Aster","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /user-exchange/aster","href":"/api-reference/user-exchange/connect-aster"},{"title":"Connect Binance","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /user-exchange/binance","href":"/api-reference/user-exchange/connect-binance"},{"title":"Connect Bybit","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /user-exchange/bybit","href":"/api-reference/user-exchange/connect-bybit"},{"title":"Connect Extended","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /user-exchange/extended","href":"/api-reference/user-exchange/connect-extended"},{"title":"Connect Gate","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /user-exchange/gate","href":"/api-reference/user-exchange/connect-gate"},{"title":"Connect Hyperliquid","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /user-exchange/hyperliquid","href":"/api-reference/user-exchange/connect-hyperliquid"},{"title":"Connect Lighter","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /user-exchange/lighter","href":"/api-reference/user-exchange/connect-lighter"},{"title":"Connect MEXC","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /user-exchange/mexc","href":"/api-reference/user-exchange/connect-mexc"},{"title":"Connect Ondo","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /user-exchange/ondo","href":"/api-reference/user-exchange/connect-ondo"},{"title":"Connect Robinhood","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /user-exchange/robinhood","href":"/api-reference/user-exchange/connect-robinhood"},{"title":"Resolve missing exchange account ids (admin)","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /user-exchange/exchange-account-ids/sync","href":"/api-reference/user-exchange/resolve-missing-exchange-account-ids-admin"}]},{"group":"Extended","pages":[{"title":"Get Extended points earned per season and epoch","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /extended/points/earned","href":"/api-reference/extended/get-extended-points-earned-per-season-and-epoch"},{"title":"Get Extended points summary (total, rank, and league tiers)","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /extended/points","href":"/api-reference/extended/get-extended-points-summary-total-rank-and-league-tiers"},{"title":"Apply a referral code to the Extended account","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /extended/use-referral-code","href":"/api-reference/extended/apply-a-referral-code-to-the-extended-account"}]},{"group":"Kinetiq","pages":[{"title":"Enable Kinetiq kPoints by verifying a wallet signature","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /kinetiq/enable","href":"/api-reference/kinetiq/enable-kinetiq-kpoints-by-verifying-a-wallet-signature"},{"title":"Get current Kinetiq kPoints","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /kinetiq/points","href":"/api-reference/kinetiq/get-current-kinetiq-kpoints"},{"title":"Check whether Kinetiq kPoints are enabled","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /kinetiq/status","href":"/api-reference/kinetiq/check-whether-kinetiq-kpoints-are-enabled"}]},{"group":"Transfer","pages":[{"title":"Execute a prepared transfer","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /transfer/execute","href":"/api-reference/transfer/execute-a-prepared-transfer"},{"title":"Get paginated margin transfer history","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /transfer/history","href":"/api-reference/transfer/get-paginated-margin-transfer-history"},{"title":"Get the status of a margin transfer by ID","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /transfer/status","href":"/api-reference/transfer/get-the-status-of-a-margin-transfer-by-id"},{"title":"Prepare an Arbitrum to exchange transfer","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /transfer/arbitrum","href":"/api-reference/transfer/prepare-an-arbitrum-to-exchange-transfer"},{"title":"Prepare a cross-exchange transfer","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /transfer/prepare","href":"/api-reference/transfer/prepare-a-cross-exchange-transfer"}]},{"group":"Withdraw","pages":[{"title":"Execute a prepared withdraw","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /withdraw/execute","href":"/api-reference/withdraw/execute-a-prepared-withdraw"},{"title":"Prepare a withdraw from an exchange","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /withdraw/prepare","href":"/api-reference/withdraw/prepare-a-withdraw-from-an-exchange"}]},{"group":"Withdraw / Extended","pages":[{"title":"Execute an Extended withdrawal using a quote from /quote","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /withdraw/extended/execute","href":"/api-reference/withdraw-extended/execute-an-extended-withdrawal-using-a-quote-from-quote"},{"title":"Quote an Extended withdrawal (fee, limit, quote id)","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json post /withdraw/extended/quote","href":"/api-reference/withdraw-extended/quote-an-extended-withdrawal-fee-limit-quote-id"}]},{"group":"Ondo","pages":[{"title":"Get Ondo points summary (totals by source and leaderboard rank)","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /ondo/points","href":"/api-reference/ondo/get-ondo-points-summary-totals-by-source-and-leaderboard-rank"},{"title":"Get the total USDC rewards paid out to the Ondo account","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /ondo/rewards/total","href":"/api-reference/ondo/get-the-total-usdc-rewards-paid-out-to-the-ondo-account"}]},{"group":"Robinhood","pages":[{"title":"Get Robinhood points summary (totals, last week, and rank)","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /robinhood/points","href":"/api-reference/robinhood/get-robinhood-points-summary-totals-last-week-and-rank"}]},{"group":"Server","pages":[{"title":"Get current server time","deprecated":null,"version":null,"openapi":"https://vooi-api-app.fly.dev/swagger/json get /time","href":"/api-reference/server/get-current-server-time"}]}]}]},"basePath":"","title":"List your bots - VOOI Perps API","buildId":"dpl_3pZeXn3XukjzFRgAX73A7GNDfRJ1","deploymentId":"dpl_3pZeXn3XukjzFRgAX73A7GNDfRJ1","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CW3yP2DK.js","utils-BN0nty2W.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C8_MydSG.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bsl5xDMQ.js","snippetPresets-DYv9OBej.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-9OnYPrVf.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-xr67xWGO.js","shallow-DO1aDdBF.js","getApiPlaygroundDisplay-o7cLzFL-.js","CodeSnippet-CGr2yOA8.js","CodeSnippets-CzBbqPNh.js","Page-CBlOSKZG.js","getPastedJson-dpi9sn5Y.js","icon-aIWHt8Pn.js","MethodPill-Bv2zLsGY.js","DuplicateIcon-DxFSz0J6.js","createIcon-uDNv6jwj.js","DynamicMarkdown-C91yhnNP.js","SectionHeading-DG_xjOLR.js","axios-vUo_bRtp.js","Markdown-B4M_Eo1P.js","clsx-DShopWo_.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BX6wab7q.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-48h67xm_.js"]}