# Orderly CLI reference Generated from `orderly schema` v2.1.2. Orderly Network CLI. This file is generated from `src/data/commands.json`; do not edit it by hand. ## Global flags - `--network ` — Network: mainnet or testnet - `--csv` — Output as CSV instead of JSON (for list data) - `--pretty` — Pretty-print JSON output (2-space indent) ## Commands ### `account-balance` Get account balances - **Usage:** `orderly account-balance [--account ]` - **Mutates:** no **Flags:** - `--account ` — Account ID (auto-resolves if single account) ### `account-info` Get account information - **Usage:** `orderly account-info [--account ]` - **Mutates:** no **Flags:** - `--account ` — Account ID (auto-resolves if single account) ### `account-limits` Get margin requirements and position limits. imr_factor: per-symbol factor used in initial margin calculation — IMR_i = max(1/max_leverage, base_imr, imr_factor * |notional|^0.8) max_notional: max position size in USD per symbol base_imr / base_mmr: minimum initial/maintenance margin ratios (shown with --symbol) base_mmr: threshold for liquidation — MMR_i = max(base_mmr, (base_mmr/base_imr) * imr_factor * |notional|^0.8) - **Usage:** `orderly account-limits [--symbol ] [--account ]` - **Mutates:** no **Flags:** - `--symbol ` — Show limits for one symbol (includes base_imr, base_mmr, order rules) - `--account ` — Account ID (auto-resolves if single account) ### `account-liquidations` Get account liquidation history - **Usage:** `orderly account-liquidations [--symbol ] [--page ] [--size ] [--account ]` - **Mutates:** no **Flags:** - `--symbol ` — Filter by symbol - `--page ` — Page number (default: 1) - `--size ` — Page size (default: 25) - `--account ` — Account ID (auto-resolves if single account) ### `account-statistics` Get account trading statistics (volume, fees, days since registration) - **Usage:** `orderly account-statistics [--account ]` - **Mutates:** no **Flags:** - `--account ` — Account ID (auto-resolves if single account) ### `algo-order-cancel` Cancel an algo order - **Usage:** `orderly algo-order-cancel [--symbol ] [--dry-run] [--account ]` - **Mutates:** yes **Flags:** - `order_id` (required) - `--symbol ` — Symbol of the order (auto-fetched if not provided) - `--dry-run` — Print the request payload without signing or sending it - `--account ` — Account ID (auto-resolves if single account) ### `algo-order-cancel-all` Cancel all algo orders - **Usage:** `orderly algo-order-cancel-all [--symbol ] [--algo-type ] [--account ]` - **Mutates:** yes **Flags:** - `--symbol ` — Filter by symbol (optional) - `--algo-type ` — Filter by algo type: STOP, TP_SL, TRAILING_STOP, BRACKET - `--account ` — Account ID (auto-resolves if single account) ### `algo-order-cancel-by-client-id` Cancel an algo order by client order ID - **Usage:** `orderly algo-order-cancel-by-client-id [--account ]` - **Mutates:** yes **Flags:** - `client_order_id` (required) - `symbol` (required) - `--account ` — Account ID (auto-resolves if single account) ### `algo-order-edit` Edit a pending algo order (only specify what to change: price, quantity, trigger-price, callback-rate) - **Usage:** `orderly algo-order-edit [--symbol ] [--price ] [--quantity ] [--trigger-price ] [--callback-rate ] [--account ]` - **Mutates:** yes **Flags:** - `order_id` (required) - `--symbol ` — Symbol of the order (auto-fetched if not provided) - `--price ` — New order price - `--quantity ` — New order quantity - `--trigger-price ` — New trigger price - `--callback-rate ` — New callback rate: 1-15 for percentage, or 0.01-0.15 as decimal - `--account ` — Account ID (auto-resolves if single account) ### `algo-order-get` Get details for a specific algo order - **Usage:** `orderly algo-order-get [--symbol ] [--account ]` - **Mutates:** no **Flags:** - `order_id` (required) - `--symbol ` — Symbol of the order (auto-fetched if not provided) - `--account ` — Account ID (auto-resolves if single account) ### `algo-order-list` List algo orders (defaults to open/active orders) - **Usage:** `orderly algo-order-list [--symbol ] [--status ] [--all] [--algo-type ] [--page ] [--size ] [--account ]` - **Mutates:** no **Flags:** - `--symbol ` — Filter by symbol - `--status ` — Filter by status. Default: INCOMPLETE - `--all` — Show all orders (overrides default INCOMPLETE filter) - `--algo-type ` — Filter by algo type: STOP, TP_SL, POSITIONAL_TP_SL, TRAILING_STOP, BRACKET - `--page ` — Page number (default: 1) - `--size ` — Page size (default: 25, max: 500) - `--account ` — Account ID (auto-resolves if single account) ### `algo-order-place` Place an algo order. Valid algoTypes and their required flags: STOP --trigger-price TP_SL --tp-trigger-price and/or --sl-trigger-price POSITIONAL_TP_SL --tp-trigger-price and/or --sl-trigger-price (quantity must be 0) TRAILING_STOP --callback-rate (1-15%) BRACKET --trigger-price + --tp-trigger-price and/or --sl-trigger-price Valid sides: BUY, SELL - **Usage:** `orderly algo-order-place [--trigger-price ] [--callback-rate ] [--price ] [--tp-trigger-price ] [--tp-price ] [--sl-trigger-price ] [--sl-price ] [--reduce-only] [--client-order-id ] [--dry-run] [--account ]` - **Mutates:** yes **Flags:** - `symbol` (required) - `side` (required) - `algo_type` (required) - `quantity` (required) - `--trigger-price ` — Trigger price (required for STOP and BRACKET) - `--callback-rate ` — Trailing callback rate: 1-15 for percentage, or 0.01-0.15 as decimal. Required for TRAILING_STOP - `--price ` — Order price (for limit orders) - `--tp-trigger-price ` — Take-profit trigger price (for TP_SL/POSITIONAL_TP_SL/BRACKET) - `--tp-price ` — Take-profit order price (optional, MARKET if not set) - `--sl-trigger-price ` — Stop-loss trigger price (for TP_SL/POSITIONAL_TP_SL/BRACKET) - `--sl-price ` — Stop-loss order price (optional, MARKET if not set) - `--reduce-only` — Reduce-only order (can only reduce existing position, not open new) - `--client-order-id ` — Custom client order ID (optional) - `--dry-run` — Print the request payload without signing or sending it - `--account ` — Account ID (auto-resolves if single account) ### `algo-order-trades` Get trades for a specific algo order - **Usage:** `orderly algo-order-trades [--symbol ] [--account ]` - **Mutates:** no **Flags:** - `order_id` (required) - `--symbol ` — Symbol of the order (auto-fetched if not provided) - `--account ` — Account ID (auto-resolves if single account) ### `asset-history` Get asset deposit/withdraw history - **Usage:** `orderly asset-history [--token ] [--side ] [--status ] [--page ] [--size ] [--account ]` - **Mutates:** no **Flags:** - `--token ` — Filter by token - `--side ` — Filter by side: DEPOSIT or WITHDRAW - `--status ` — Filter by status: NEW, CONFIRM, PROCESSING, COMPLETED, FAILED, PENDING_REBALANCE - `--page ` — Page number (default: 1) - `--size ` — Page size (default: 25) - `--account ` — Account ID (auto-resolves if single account) ### `auth-cleanup` Remove all stored API keys for a network - **Usage:** `orderly auth-cleanup` - **Mutates:** yes ### `auth-export-key` Export Ed25519 private key (requires interactive TTY) - **Usage:** `orderly auth-export-key [account-id]` - **Mutates:** no **Flags:** - `account_id` — Account ID (positional) ### `auth-import` Import existing Ed25519 API key (for users who already have one) - **Usage:** `orderly auth-import [private-key] [--account ]` - **Mutates:** yes **Flags:** - `private_key` — Ed25519 private key (positional) - `--account ` — Account ID (auto-resolves if single account) ### `auth-list` List all stored API keys (public keys only) - **Usage:** `orderly auth-list [--ids]` - **Mutates:** no **Flags:** - `--ids` — Output only account IDs, one per line (for scripting/piping) ### `auth-logout` Remove API key from keychain - **Usage:** `orderly auth-logout [account-id]` - **Mutates:** yes **Flags:** - `account_id` — Account ID (positional) ### `auth-show` Show public key for an account - **Usage:** `orderly auth-show [--account ]` - **Mutates:** no **Flags:** - `--account ` — Account ID (auto-resolves if single account) ### `batch-order-cancel` Cancel multiple orders by IDs - **Usage:** `orderly batch-order-cancel [--dry-run] [--account ]` - **Mutates:** yes **Flags:** - `order_ids` (required) - `--dry-run` — Print the request payload without signing or sending it - `--account ` — Account ID (auto-resolves if single account) ### `batch-order-cancel-by-client-id` Cancel multiple orders by client order IDs (max 10) - **Usage:** `orderly batch-order-cancel-by-client-id [--account ]` - **Mutates:** yes **Flags:** - `client_order_ids` (required) - `--account ` — Account ID (auto-resolves if single account) ### `batch-order-place` Place multiple orders (max 10) - **Usage:** `orderly batch-order-place [--dry-run] [--account ]` - **Mutates:** yes **Flags:** - `orders` (required) — JSON array of orders, or a path to a JSON file - `--dry-run` — Print the request payload without signing or sending it - `--account ` — Account ID (auto-resolves if single account) ### `broker-create` Create a broker ID via Orderly One - **Usage:** `orderly broker-create [broker-id] [--address
] [--tx-hash ] [--chain ] [--chain-id ] [--payment-type ] [--maker-fee ] [--taker-fee ] [--rwa-maker-fee ] [--rwa-taker-fee ]` - **Mutates:** yes **Flags:** - `broker_id` — Desired broker ID - `--address
` — EVM wallet address (prompts if not provided) - `--tx-hash ` — Payment tx hash (skip info, go straight to verify) - `--chain ` — Payment chain: ethereum, arbitrum, base - `--chain-id ` — Chain ID: 1, 42161, 8453 - `--payment-type ` — Payment token: usdc, usdt, or order - `--maker-fee ` — Maker fee in basis points (-0.5 to 15) - `--taker-fee ` — Taker fee in basis points (3 to 15) - `--rwa-maker-fee ` — RWA maker fee in basis points (-0.5 to 15) - `--rwa-taker-fee ` — RWA taker fee in basis points (5 to 15) ### `broker-status` Show your DEX/broker status (requires EVM wallet) - **Usage:** `orderly broker-status [--address
]` - **Mutates:** no **Flags:** - `--address
` — EVM wallet address (prompts if not provided) ### `chains` List supported chains (no auth required) - **Usage:** `orderly chains [--broker-id ] [--verbose]` - **Mutates:** no **Flags:** - `--broker-id ` — Filter chains by broker ID - `--verbose` — Include broker_ids array for each chain ### `deposit-info` Get deposit info for a token - **Usage:** `orderly deposit-info ` - **Mutates:** no **Flags:** - `token` (required) - `chain_id` (required) ### `distribution-history` Get broker fee and referral rebate history - **Usage:** `orderly distribution-history [--status ] [--type ] [--start-time ] [--end-time ] [--page ] [--size ] [--account ]` - **Mutates:** no **Flags:** - `--status ` — Filter by status: CREATED, SPLIT, COMPLETED - `--type ` — Filter by type: BROKER_FEE, REFEREE_REBATE, REFERRER_REBATE - `--start-time ` — Start timestamp (Unix ms) - `--end-time ` — End timestamp (Unix ms) - `--page ` — Page number (default: 1) - `--size ` — Page size (default: 25) - `--account ` — Account ID (auto-resolves if single account) ### `faucet-account` Request testnet USDC for a stored Orderly account - **Usage:** `orderly faucet-account [--chain-id ] [--broker-id ] [--wait] [--timeout ] [--account ]` - **Mutates:** yes **Flags:** - `--chain-id ` — Destination chain ID for EVM (default: 421614, Arbitrum Sepolia) - `--broker-id ` — Broker ID (auto-resolved from the account if omitted) - `--wait` — Wait for the USDC to appear in the Orderly account balance - `--timeout ` — Maximum seconds to wait for the balance (default: 120) - `--account ` — Account ID (auto-resolves if single account) ### `faucet-usdc` Get test USDC from faucet (testnet only) - **Usage:** `orderly faucet-usdc
[--chain-id ] [--broker-id ]` - **Mutates:** yes **Flags:** - `address` (required) - `--chain-id ` — Required. EVM: 421614 (Arbitrum Sepolia), 84532 (Base Sepolia). SOL: 901901901 (Devnet) - `--broker-id ` — Broker ID (default: demo) ### `fee-tier` Get current fee rates (futures, RWA, default) - **Usage:** `orderly fee-tier [--account ]` - **Mutates:** no **Flags:** - `--account ` — Account ID (auto-resolves if single account) ### `funding-history` Get funding fee history - **Usage:** `orderly funding-history [--symbol ] [--start-time ] [--end-time ] [--page ] [--size ] [--account ]` - **Mutates:** no **Flags:** - `--symbol ` — Filter by symbol - `--start-time ` — Start timestamp (Unix ms) - `--end-time ` — End timestamp (Unix ms) - `--page ` — Page number (default: 1) - `--size ` — Page size (default: 25) - `--account ` — Account ID (auto-resolves if single account) ### `funding-rates` Get public funding rates for all symbols (no auth required) - **Usage:** `orderly funding-rates [--symbol ]` - **Mutates:** no **Flags:** - `--symbol ` — Filter by symbol ### `key-info` Get registered API key info and scopes - **Usage:** `orderly key-info [--account ]` - **Mutates:** no **Flags:** - `--account ` — Account ID (auto-resolves if single account) ### `kline` Get candlestick/kline data. Valid intervals: 1m, 5m, 15m, 30m, 1h, 4h, 12h, 1d, 1w, 1mon - **Usage:** `orderly kline [--size ]` - **Mutates:** no **Flags:** - `symbol` (required) - `type` (required) - `--size ` — Number of candles (default: 100, max: 1000) ### `leverage` Get or set leverage for a symbol - **Usage:** `orderly leverage [value] [--dry-run] [--account ]` - **Mutates:** yes **Flags:** - `symbol` (required) - `value` - `--dry-run` — Print the request payload without signing or sending it - `--account ` — Account ID (auto-resolves if single account) ### `liquidated-positions` Get public liquidated positions (no auth required) - **Usage:** `orderly liquidated-positions [--symbol ] [--page ] [--size ]` - **Mutates:** no **Flags:** - `--symbol ` — Filter by symbol - `--page ` — Page number (default: 1) - `--size ` — Page size (default: 25) ### `market-orderbook` Get orderbook snapshot - **Usage:** `orderly market-orderbook [--depth ]` - **Mutates:** no **Flags:** - `symbol` (required) - `--depth ` — Number of price levels per side (default: all) ### `market-price` Get current market price - **Usage:** `orderly market-price ` - **Mutates:** no **Flags:** - `symbol` (required) ### `market-trades` Get recent public trades - **Usage:** `orderly market-trades [--size ]` - **Mutates:** no **Flags:** - `symbol` (required) - `--size ` — Number of trades (default: 50) ### `notification-inbox` List notification inbox messages - **Usage:** `orderly notification-inbox [--type ] [--page ] [--size ] [--account ]` - **Mutates:** no **Flags:** - `--type ` — Filter by type: TRADE or SYSTEM - `--page ` — Page number (default: 1) - `--size ` — Page size (default: 25) - `--account ` — Account ID (auto-resolves if single account) ### `notification-unread` Get unread notification count and messages - **Usage:** `orderly notification-unread [--account ]` - **Mutates:** no **Flags:** - `--account ` — Account ID (auto-resolves if single account) ### `open-interest` Get long/short open interest for all symbols (no auth required) - **Usage:** `orderly open-interest [--symbol ]` - **Mutates:** no **Flags:** - `--symbol ` — Filter by symbol ### `order-cancel` Cancel an order - **Usage:** `orderly order-cancel [--symbol ] [--dry-run] [--account ]` - **Mutates:** yes **Flags:** - `order_id` (required) - `--symbol ` — Symbol of the order (auto-fetched if not provided) - `--dry-run` — Print the request payload without signing or sending it - `--account ` — Account ID (auto-resolves if single account) ### `order-cancel-all` Cancel all orders - **Usage:** `orderly order-cancel-all [--symbol ] [--account ]` - **Mutates:** yes **Flags:** - `--symbol ` — Filter by symbol (optional) - `--account ` — Account ID (auto-resolves if single account) ### `order-cancel-by-client-id` Cancel an order by client order ID - **Usage:** `orderly order-cancel-by-client-id [--account ]` - **Mutates:** yes **Flags:** - `client_order_id` (required) - `symbol` (required) - `--account ` — Account ID (auto-resolves if single account) ### `order-edit` Edit a pending order (only specify what to change) - **Usage:** `orderly order-edit [--symbol ] [--price ] [--quantity ] [--dry-run] [--account ]` - **Mutates:** yes **Flags:** - `order_id` (required) - `--symbol ` — Symbol of the order (auto-fetched if not provided) - `--price ` — New order price - `--quantity ` — New order quantity - `--dry-run` — Print the request payload without signing or sending it - `--account ` — Account ID (auto-resolves if single account) ### `order-get` Get order details. Auto-detects numeric order ID vs client order ID - **Usage:** `orderly order-get [order-id] [--client-order-id ] [--account ]` - **Mutates:** no **Flags:** - `order_id` - `--client-order-id ` — Explicitly look up by client order ID - `--account ` — Account ID (auto-resolves if single account) ### `order-list` List orders (defaults to open/active orders) - **Usage:** `orderly order-list [--symbol ] [--status ] [--side ] [--order-type ] [--sort-by ] [--page ] [--size ] [--product-type ] [--all] [--account ]` - **Mutates:** no **Flags:** - `--symbol ` — Filter by symbol - `--status ` — Filter by status. Individual: NEW, FILLED, CANCELLED, PARTIAL_FILLED, REJECTED. Bundled: INCOMPLETE, COMPLETED. Default: INCOMPLETE - `--side ` — Filter by side: BUY, SELL - `--order-type ` — Filter by type: LIMIT, MARKET - `--sort-by ` — Sort: CREATED_TIME_ASC, CREATED_TIME_DESC, UPDATED_TIME_ASC, UPDATED_TIME_DESC - `--page ` — Page number (default: 1) - `--size ` — Page size (default: 25, max: 500) - `--product-type ` — Filter by product type: PERP or BINARY - `--all` — Show all orders (overrides default INCOMPLETE filter) - `--account ` — Account ID (auto-resolves if single account) ### `order-place` Place a new order - **Usage:** `orderly order-place [type] [quantity] [--price ] [--client-order-id ] [--reduce-only] [--dry-run] [--account ]` - **Mutates:** yes **Flags:** - `symbol` (required) - `side` (required) - `type` — Order type (omitted for the short BID/ASK form) - `quantity` - `--price ` — Order price (required for LIMIT, IOC, FOK, POST_ONLY) - `--client-order-id ` — Custom client order ID (optional) - `--reduce-only` — Reduce-only order (can only reduce existing position, not open new) - `--dry-run` — Print the request payload without signing or sending it - `--account ` — Account ID (auto-resolves if single account) ### `order-trades` Get trades for a specific order - **Usage:** `orderly order-trades [--symbol ] [--account ]` - **Mutates:** no **Flags:** - `order_id` (required) - `--symbol ` — Symbol of the order (auto-fetched if not provided) - `--account ` — Account ID (auto-resolves if single account) ### `positions-close` Close a position - **Usage:** `orderly positions-close [--quantity ] [--dry-run] [--account ]` - **Mutates:** yes **Flags:** - `symbol` (required) - `--quantity ` — Partial close quantity (default: full position) - `--dry-run` — Print the request payload without signing or sending it - `--account ` — Account ID (auto-resolves if single account) ### `positions-history` Get position history - **Usage:** `orderly positions-history [--symbol ] [--start-time ] [--end-time ] [--page ] [--size ] [--product-type ] [--account ]` - **Mutates:** no **Flags:** - `--symbol ` — Filter by symbol - `--start-time ` — Start timestamp (Unix ms) - `--end-time ` — End timestamp (Unix ms) - `--page ` — Page number (default: 1) - `--size ` — Page size (default: 25) - `--product-type ` — Filter by product type: PERP or BINARY - `--account ` — Account ID (auto-resolves if single account) ### `positions-list` List open positions - **Usage:** `orderly positions-list [--product-type ] [--account ]` - **Mutates:** no **Flags:** - `--product-type ` — Filter by product type: PERP or BINARY - `--account ` — Account ID (auto-resolves if single account) ### `predict-buy` Buy UP or DOWN shares in a Predict round - **Usage:** `orderly predict-buy [--price ] [--type ] [--post-only-adjust] [--client-order-id ] [--dry-run] [--account ]` - **Mutates:** yes **Flags:** - `symbol` (required) — Round symbol - `direction` (required) — Direction: UP or DOWN - `shares` (required) — Number of shares - `--price ` — Limit price in the selected direction (0.01-0.99) - `--type ` — Order type: LIMIT, IOC, POST_ONLY (default: LIMIT) - `--post-only-adjust` — Adjust a POST_ONLY price by one tick toward the best price - `--client-order-id ` — Custom client order ID (optional) - `--dry-run` — Print the request payload without signing or sending it - `--account ` — Account ID (auto-resolves if single account) ### `predict-close` Close (part of) a Predict position with a protected IOC order - **Usage:** `orderly predict-close [--shares ] [--protect-ticks ] [--dry-run] [--account ]` - **Mutates:** yes **Flags:** - `symbol` (required) — Round symbol - `--shares ` — Shares to close (default: full position) - `--protect-ticks ` — Price protection in ticks (default: 2) - `--dry-run` — Print the request payload without signing or sending it - `--account ` — Account ID (auto-resolves if single account) ### `predict-orderbook` Show the UP and DOWN order books for a Predict round - **Usage:** `orderly predict-orderbook [symbol] [--depth ]` - **Mutates:** no **Flags:** - `symbol` — Round symbol (defaults to the current round) - `--depth ` — Number of price levels per side (default: all) ### `predict-round` Show a Predict round (defaults to the current round) - **Usage:** `orderly predict-round [symbol]` - **Mutates:** no **Flags:** - `symbol` — Round symbol (defaults to the current round) ### `predict-rounds` List Orderly Predict rounds (5-minute BTC Up/Down) - **Usage:** `orderly predict-rounds [--status ] [--current] [--limit ] [--all]` - **Mutates:** no **Flags:** - `--status ` — Filter by status: ACTIVE, DELISTING, RECYCLING, DELISTED - `--current` — Only show the round currently in its observation window - `--limit ` — Maximum rows to print (default: 20, max: 300) - `--all` — Print all rounds (overrides --limit) ### `predict-sell` Sell (reduce) an existing Predict position - **Usage:** `orderly predict-sell [--price ] [--type ] [--post-only-adjust] [--client-order-id ] [--dry-run] [--account ]` - **Mutates:** yes **Flags:** - `symbol` (required) — Round symbol - `direction` (required) — Direction: UP or DOWN - `shares` (required) — Number of shares - `--price ` — Limit price in the selected direction (0.01-0.99) - `--type ` — Order type: LIMIT, IOC, POST_ONLY (default: LIMIT) - `--post-only-adjust` — Adjust a POST_ONLY price by one tick toward the best price - `--client-order-id ` — Custom client order ID (optional) - `--dry-run` — Print the request payload without signing or sending it - `--account ` — Account ID (auto-resolves if single account) ### `price-changes` Get price changes for all symbols (5m, 30m, 1h, 24h, 7d, 30d) (no auth required) - **Usage:** `orderly price-changes [--symbol ]` - **Mutates:** no **Flags:** - `--symbol ` — Filter by symbol ### `referral-info` Get referral information (referrer/referee stats and codes) - **Usage:** `orderly referral-info [--account ]` - **Mutates:** no **Flags:** - `--account ` — Account ID (auto-resolves if single account) ### `schema` Print a machine-readable manifest of the entire CLI surface - **Usage:** `orderly schema [--json]` - **Mutates:** no **Flags:** - `--json` — Machine-readable JSON manifest (default output) ### `settle-pnl` Settle unrealized PnL into account balance - **Usage:** `orderly settle-pnl [--dry-run] [--account ]` - **Mutates:** yes **Flags:** - `--dry-run` — Print the request payload without signing or sending it - `--account ` — Account ID (auto-resolves if single account) ### `settle-pnl-history` Get on-chain PnL settlement history - **Usage:** `orderly settle-pnl-history [--page ] [--size ] [--account ]` - **Mutates:** no **Flags:** - `--page ` — Page number (default: 1) - `--size ` — Page size (default: 25) - `--account ` — Account ID (auto-resolves if single account) ### `symbols` List trading symbols. Default: compact list (symbol, pair, prices). Use --info for full order rules (lot size, min notional, price tick, etc.) - **Usage:** `orderly symbols [--info]` - **Mutates:** no **Flags:** - `--info` — Show detailed per-symbol order rules instead of compact list ### `system-status` Get Orderly system maintenance status (no auth required) - **Usage:** `orderly system-status` - **Mutates:** no ### `tokens` List supported tokens (no auth required) - **Usage:** `orderly tokens [--verbose]` - **Mutates:** no **Flags:** - `--verbose` — Include chain_details array for each token ### `trades` Get trade history - **Usage:** `orderly trades [--symbol ] [--start-time ] [--end-time ] [--page ] [--size ] [--product-type ] [--account ]` - **Mutates:** no **Flags:** - `--symbol ` — Filter by symbol - `--start-time ` — Start timestamp (Unix ms) - `--end-time ` — End timestamp (Unix ms) - `--page ` — Page number (default: 1) - `--size ` — Page size (default: 25) - `--product-type ` — Filter by product type: PERP or BINARY - `--account ` — Account ID (auto-resolves if single account) ### `volume-stats` Get perp trading volume statistics (today, 1d, 7d, 30d, YTD, LTD) - **Usage:** `orderly volume-stats [--account ]` - **Mutates:** no **Flags:** - `--account ` — Account ID (auto-resolves if single account) ### `wallet-add-key` Add Orderly API key for trading (Step 3 of setup) - **Usage:** `orderly wallet-add-key [--address
] [--scope ] [--broker-id ]` - **Mutates:** yes **Flags:** - `--address
` — Wallet address (required for AI/scripts, prompts if omitted) - `--scope ` — Key scopes: read,trading,asset (default: read,trading) - `--broker-id ` — Broker ID (required when no API key stored for wallet) ### `wallet-create` Create a new EVM or SOL wallet - **Usage:** `orderly wallet-create [--type ]` - **Mutates:** yes **Flags:** - `--type ` — Wallet type: EVM or SOL (required in non-interactive mode) ### `wallet-import` Import an existing wallet private key - **Usage:** `orderly wallet-import [private-key] [--type ] [--address
] [--private-key ]` - **Mutates:** yes **Flags:** - `private_key` — Private key (positional) - `--type ` — Wallet type: EVM or SOL (required in non-interactive mode) - `--address
` — Wallet address (optional, derived from key) - `--private-key ` — Private key (alternative to positional arg, for non-interactive use) ### `wallet-list` List all stored wallets - **Usage:** `orderly wallet-list` - **Mutates:** no ### `wallet-logout` Remove wallet from keychain (alias for wallet-remove) - **Usage:** `orderly wallet-logout [address]` - **Mutates:** yes **Flags:** - `address` — Wallet address ### `wallet-register` Register an Orderly account with your wallet (Step 2 of setup) - **Usage:** `orderly wallet-register [--broker-id ] [--address
]` - **Mutates:** yes **Flags:** - `--broker-id ` — Broker ID, e.g., "demo" (required for AI/scripts, prompts if omitted) - `--address
` — Wallet address (required for AI/scripts, prompts if omitted) ### `wallet-remove` Remove wallet private key from keychain. WARNING: can cause permanent loss of access to dependent accounts. - **Usage:** `orderly wallet-remove [address] [--force]` - **Mutates:** yes **Flags:** - `address` — Wallet address - `--force` — Skip confirmation prompt (required in non-interactive mode) ### `wallet-revoke-key` Revoke the current Orderly API key (server-side + local keychain removal). WARNING: This permanently deactivates the key. You will lose ALL access to the account via this key. Use wallet-add-key to generate a new one after. - **Usage:** `orderly wallet-revoke-key [--account ] [--force]` - **Mutates:** yes **Flags:** - `--account ` — Account ID (auto-resolves if single account) - `--force` — Skip confirmation prompt (required in non-interactive mode) ### `wallet-show` Show wallet info (address required for AI/scripts, prompts if omitted) - **Usage:** `orderly wallet-show [address]` - **Mutates:** no **Flags:** - `address` — Wallet address ### `withdraw` Withdraw tokens (auto-signs with wallet key). Omit --receiver to withdraw to your own wallet address. - **Usage:** `orderly withdraw [--receiver
] [--amount ] [--raw] [--allow-cross-chain] [--dry-run] [--account ]` - **Mutates:** yes **Flags:** - `token` (required) - `chain_id` (required) - `--receiver
` — Destination address (defaults to your wallet address) - `--amount ` — Amount to withdraw (required, e.g. 10.5) - `--raw` — Amount is in smallest units (default: false, use human-readable like 10.5) - `--allow-cross-chain` — Allow cross-chain withdrawal (required when destination chain differs from deposit chain) - `--dry-run` — Print the request payload without signing or sending it - `--account ` — Account ID (auto-resolves if single account)