OpenAPI Reference

This page renders the live unified API OpenAPI document.

GET/.well-known/mcp.json
Operation
getMCPDiscovery
Auth
Public
Responses
200, 429, 503

MCP discovery manifest

View source OpenAPI JSON
GET/account
Operation
getAccount
Auth
API key
Responses
200, 401, 429, 500

Return account identity, plan, limits, and usage

View source OpenAPI JSON
GET/account/keys
Operation
listAPIKeys
Auth
API key
Responses
200, 401, 429, 500

List API keys

View source OpenAPI JSON
POST/account/keys
Operation
createAPIKey
Auth
API key
Responses
201, 400, 401, 409, 413, 429, 500

Create an API key

View source OpenAPI JSON
DELETE/account/keys/{id}
Operation
revokeAPIKey
Auth
API key
Responses
200, 401, 404, 429, 500

Revoke an API key

View source OpenAPI JSON
POST/account/register
Operation
registerAccount
Auth
Public
Responses
200, 429, 503

Request an account verification OTP

View source OpenAPI JSON
GET/account/usage
Operation
getAccountUsage
Auth
API key
Responses
200, 401, 429, 500

Return current account usage and limits

View source OpenAPI JSON
POST/account/verify
Operation
verifyAccount
Auth
Public
Responses
200, 429, 503

Verify an OTP and receive an API key

View source OpenAPI JSON
GET/context/candles
Operation
getCandles
Auth
API key
Responses
200, 400, 401, 406, 409, 429, 501, 502, 503

Get release-bound candle data for a symbol

View source OpenAPI JSON
GET/context/datasets
Operation
listDatasets
Auth
API key
Responses
200, 400, 401, 429, 502, 503

List available datasets

View source OpenAPI JSON
GET/context/funding
Operation
getFunding
Auth
API key
Responses
200, 400, 401, 406, 409, 429, 501, 502, 503

Get release-bound funding data for a symbol

View source OpenAPI JSON
GET/context/leaderboard
Operation
getLeaderboard
Auth
API key
Responses
200, 401, 429, 503

List paper-trading strategy leaderboard entries

View source OpenAPI JSON
GET/context/markets
Operation
listMarkets
Auth
API key
Responses
200, 400, 401, 429, 502, 503

List supported markets

View source OpenAPI JSON
GET/context/scan
Operation
scanSetups
Auth
API key
Responses
200, 400, 401, 429, 502

List real market intelligence setups

View source OpenAPI JSON
GET/context/setup/{symbol}
Operation
getSetup
Auth
API key
Responses
200, 400, 401, 429, 502

Get real setup evidence for a canonical pair

View source OpenAPI JSON
GET/context/traders
Operation
listTraders
Auth
API key
Responses
401, 429, 501

Tracked traders are not available yet

View source OpenAPI JSON
GET/context/traders/{wallet}
Operation
getTrader
Auth
API key
Responses
401, 429, 501

Tracked trader details are not available yet

View source OpenAPI JSON
GET/context/venues
Operation
listVenues
Auth
API key
Responses
200, 401, 429, 503

List supported venues

View source OpenAPI JSON
GET/health
Operation
getHealth
Auth
Public
Responses
200, 429, 503

Health check

View source OpenAPI JSON
GET/install.txt
Operation
getInstallText
Auth
Public
Responses
200, 429, 503

Install instructions for MCP clients

View source OpenAPI JSON
GET/livez
Operation
getLiveness
Auth
Public
Responses
200, 429, 503

Liveness check

View source OpenAPI JSON
POST/mcp
Operation
callMCP
Auth
API key
Responses
200, 401, 429, 503

Call the authenticated Streamable HTTP MCP endpoint

View source OpenAPI JSON
GET/openapi.json
Operation
getOpenAPI
Auth
Public
Responses
200, 429, 503

Authoritative OpenAPI contract

View source OpenAPI JSON
GET/readyz
Operation
getReadiness
Auth
Public
Responses
200, 429, 503

Dependency readiness check

View source OpenAPI JSON
GET/runtime/backtests
Operation
listBacktests
Auth
API key
Responses
200, 401, 429

List and create backtests

View source OpenAPI JSON
POST/runtime/backtests
Operation
createBacktest
Auth
API key
Responses
202, 401, 429

List and create backtests

View source OpenAPI JSON
GET/runtime/backtests/dataset
Operation
getLatestBacktestDataset
Auth
API key
Responses
200, 400, 401, 429, 502, 503

Get the latest backtest dataset for an exact market

View source OpenAPI JSON
GET/runtime/backtests/{id}
Operation
getBacktest
Auth
API key
Responses
200, 401, 409, 429

Get or delete a backtest

View source OpenAPI JSON
DELETE/runtime/backtests/{id}
Operation
deleteBacktest
Auth
API key
Responses
200, 401, 409, 429

Get or delete a backtest

View source OpenAPI JSON
GET/runtime/backtests/{id}/logs
Operation
getBacktestLogs
Auth
API key
Responses
200, 401, 429

Get backtest logs

View source OpenAPI JSON
GET/runtime/deployments
Operation
listDeployments
Auth
API key
Responses
200, 401, 429

List deployments

View source OpenAPI JSON
POST/runtime/deployments
Operation
createDeployment
Auth
API key
Responses
201, 401, 429

Create a deployment

View source OpenAPI JSON
GET/runtime/deployments/{id}
Operation
getDeployment
Auth
API key
Responses
200, 401, 429

Get, update, or delete a deployment

View source OpenAPI JSON
PATCH/runtime/deployments/{id}
Operation
updateDeployment
Auth
API key
Responses
200, 401, 429

Get, update, or delete a deployment

View source OpenAPI JSON
DELETE/runtime/deployments/{id}
Operation
deleteDeployment
Auth
API key
Responses
202, 401, 429

Get, update, or delete a deployment

View source OpenAPI JSON
PUT/runtime/deployments/{id}/credentials
Operation
setDeploymentCredentials
Auth
API key
Responses
200, 401, 429

Attach deployment credentials

View source OpenAPI JSON
GET/runtime/deployments/{id}/logs
Operation
getDeploymentLogs
Auth
API key
Responses
200, 401, 429

Get deployment logs

View source OpenAPI JSON
GET/runtime/deployments/{id}/metrics
Operation
getDeploymentMetrics
Auth
API key
Responses
200, 401, 429

Get deployment metrics

View source OpenAPI JSON
PUT/runtime/deployments/{id}/status
Operation
setDeploymentStatus
Auth
API key
Responses
200, 401, 429

Start or stop a deployment

View source OpenAPI JSON
GET/runtime/executions
Operation
listExecutions
Auth
API key
Responses
200, 401, 429, 503

List durable one-time venue executions

View source OpenAPI JSON
POST/runtime/executions
Operation
createExecution
Auth
API key
Responses
201, 202, 400, 401, 403, 409, 422, 429, 502, 503

Run a one-time venue execution

View source OpenAPI JSON
GET/runtime/executions/{id}
Operation
getExecution
Auth
API key
Responses
200, 401, 404, 429, 503

Get a durable one-time venue execution

View source OpenAPI JSON
GET/runtime/frameworks
Operation
listRuntimeFrameworks
Auth
Public
Responses
200, 429, 503

List supported runtime frameworks

View source OpenAPI JSON
GET/wallet
Operation
getWallet
Auth
API key
Responses
200, 401, 429, 502, 503

Return managed wallet address, deposit details, balances, and venue readiness

View source OpenAPI JSON
GET/wallet/deposits
Operation
listDeposits
Auth
API key
Responses
200, 400, 401, 429, 503

List account-scoped wallet deposits

View source OpenAPI JSON
POST/wallet/venues/{venue}/setup
Operation
setupVenueWallet
Auth
API key
Responses
201, 202, 400, 401, 404, 409, 429, 503

Allocate managed held USDC to a venue

View source OpenAPI JSON
POST/wallet/withdraw
Operation
createWithdrawal
Auth
API key
Responses
202, 400, 401, 404, 409, 410, 429, 502, 503

Create an authorized wallet withdrawal

View source OpenAPI JSON
GET/wallet/withdraw/authorization
Operation
getWithdrawalAuthorization
Auth
API key
Responses
200, 400, 401, 404, 409, 410, 429, 503

Get server-selected withdrawal authorization policy

View source OpenAPI JSON
POST/wallet/withdraw/authorize
Operation
authorizeWithdrawal
Auth
API key
Responses
200, 400, 401, 404, 409, 410, 429, 503

Authorize a withdrawal before moving funds

View source OpenAPI JSON
POST/wallet/withdraw/otp
Operation
requestWithdrawalOTP
Auth
API key
Responses
200, 400, 401, 404, 409, 410, 429, 503

Email a code bound to a withdrawal intent

View source OpenAPI JSON
POST/wallet/withdraw/recover
Operation
recoverWithdrawal
Auth
API key
Responses
200, 400, 401, 403, 409, 429, 503

Resolve or permanently fence an unresolved withdrawal request

View source OpenAPI JSON
GET/wallet/withdraw/sources
Operation
listWithdrawalSources
Auth
API key
Responses
200, 401, 403, 429, 502, 503

List explicit wallet withdrawal sources

View source OpenAPI JSON
GET/wallet/withdrawals
Operation
listWithdrawals
Auth
API key
Responses
200, 401, 429, 503

List wallet withdrawals

View source OpenAPI JSON
GET/wallet/withdrawals/{id}
Operation
getWithdrawal
Auth
API key
Responses
200, 401, 429, 503

Get a wallet withdrawal

View source OpenAPI JSON