CCXT — Cryptocurrency Exchange Trading

You have access to the ccxt CLI tool which lets you interact with 100+ cryptocurrency exchanges (Binance, Bybit, OKX, Kraken, Coinbase, and many more). You can fetch market data, place orders, check balances, and stream live data.

Core Syntax

CODEBLOCK0

Before Calling Any Method

If you're unsure about the required arguments for a method, run:

CODEBLOCK1

This will show you the required and optional arguments with descriptions.

Available Options

Flag	Purpose
INLINECODE1	Show raw request/response data
INLINECODE2

Use testnet/sandbox environment | | --raw | Output clean JSON without formatting | | --swap | Target swap/perpetuals account | | --future | Target futures account | | --spot | Target spot account | | --option | Target options account | | --param key=value | Pass extra exchange-specific params (repeatable) | | --no-keys | Skip API key loading |

Common Operations

Market Data (Public — No API Keys Required)

Fetch markets (list all trading pairs on an exchange):
CODEBLOCK2

Fetch a single ticker:
CODEBLOCK3

Fetch multiple tickers:
CODEBLOCK4

Fetch order book:
CODEBLOCK5

Fetch OHLCV candles:
CODEBLOCK6

Fetch recent trades:
CODEBLOCK7

Fetch exchange status:
CODEBLOCK8

Fetch currencies:
CODEBLOCK9

Trading (Private — Requires API Keys)

Create an order:
CODEBLOCK10

Create order with extra params:
CODEBLOCK11

Cancel an order:
CODEBLOCK12

Fetch open orders:
CODEBLOCK13

Fetch closed orders:
CODEBLOCK14

Fetch a specific order:
CODEBLOCK15

Account (Private — Requires API Keys)

Fetch balance:
CODEBLOCK16

Fetch balance for derivatives:
CODEBLOCK17

Fetch my trades:
CODEBLOCK18

Fetch positions (derivatives):
CODEBLOCK19

Fetch deposit address:
CODEBLOCK20

Derivatives

Fetch funding rate:
CODEBLOCK21

Fetch funding rate history:
CODEBLOCK22

Fetch mark price / index price:
CODEBLOCK23

Important Rules

1. 1. Always quote symbols that contain / or : — e.g., "BTC/USDT", "BTC/USDT:USDT".
2. Use undefined as a positional placeholder to skip optional arguments while providing later ones. For example: ccxt binance fetchOHLCV "BTC/USDT" 1h undefined 10 skips since but provides limit.
3. Use --raw when you need to parse the output programmatically or when the user needs clean JSON.
4. Use --sandbox for testing with testnet environments. Always recommend sandbox mode when the user is experimenting with orders.
5. ISO8601 datetimes (e.g., "2025-01-01T00:00:00Z") are auto-converted to milliseconds.
6. API keys must be configured via environment variables (e.g., BINANCE_APIKEY, BINANCE_SECRET) or the config file. If a private method fails due to missing credentials, instruct the user to set them up.
7. Derivatives symbols use the format "BASE/QUOTE:SETTLE" — e.g., "BTC/USDT:USDT" for USDT-margined perpetuals.
8. Be careful with order methods — always confirm amounts and prices with the user before executing createOrder. The CLI executes immediately with no confirmation prompt.
9. When the output is large (e.g., fetchMarkets returns hundreds of entries), consider piping through | head or filtering, or suggest the user narrows their query.
10. For the list of supported exchanges, you can check: ccxt exchanges or refer to https://docs.ccxt.com.

Authentication Setup

Tell users to configure credentials in one of two ways:

Option 1 — Environment variables:
CODEBLOCK24

Option 2 — Config file (path shown in ccxt --help):
CODEBLOCK25

Error Handling

• - If you get an AuthenticationError, the API keys are missing or invalid.
• If you get an ExchangeNotAvailable or NetworkError, the exchange may be down or rate-limiting.
• If you get an BadSymbol, the trading pair doesn't exist on that exchange — use fetchMarkets to check available pairs.
• If you get an InsufficientFunds, the account doesn't have enough balance for the operation.