API Reference ccxt_client v#0.6.1

Copy Markdown View Source

Modules

Unified cryptocurrency exchange client library.

Unified auto-deleveraging (ADL) rank data.

Unified exchange account data.

OTP Application for CCXT.

Aster exchange — generated from spec.

Unified account balance across currencies.

Binance exchange — generated from spec.

Binance COIN-M exchange — generated from spec.

Binance US exchange — generated from spec.

Binance USDⓈ-M exchange — generated from spec.

Bitfinex exchange — generated from spec.

BitMEX exchange — generated from spec.

Unified borrow interest data.

Unified borrow rate data.

Bybit exchange — generated from spec.

Per-exchange circuit breakers using the :fuse Erlang library.

Coinbase Exchange exchange — generated from spec.

Unified currency conversion data.

API credentials for exchange authentication.

Unified currency data.

Centralized default configuration values for ccxt_client.

Unified deposit address data.

Unified deposit/withdraw fee data.

Deribit exchange — generated from spec.

derive exchange — generated from spec.

Shared request dispatcher for generated exchange endpoint functions.

Unified error types for exchange operations.

Exchange configuration struct and constructor.

Compile-time generator for all exchange modules.

Fee information attached to trades and orders.

Unified funding payment history data.

Unified funding rate data.

Unified funding rate history entry.

Gate exchange — generated from spec.

Gate exchange — generated from spec.

Unified options greeks data.

HTTP client for exchange API requests.

HTX exchange — generated from spec.

HTX exchange — generated from spec.

Hyperliquid exchange — generated from spec.

Kraken exchange — generated from spec.

KuCoin exchange — generated from spec.

KuCoin Futures exchange — generated from spec.

Unified last price data.

Unified ledger entry data.

Unified leverage settings data.

Unified leverage tier data.

Lighter exchange — generated from spec.

Unified liquidation event data.

Unified long/short ratio data.

MCP tool definitions for the CCXT API.

Unified margin mode data.

Unified margin modification data.

Unified market/instrument metadata.

MyOKX (EEA) exchange — generated from spec.

Candlestick (OHLCV) bar data.

OKX exchange — generated from spec.

OKX (US) exchange — generated from spec.

Unified open interest data.

Unified options contract data.

Unified order data.

Unified order book (market depth) data.

Unified derivatives position data.

Per-credential weighted rate limiter for exchange API requests.

Parses rate limit status headers from exchange API responses.

Rate limit status information parsed from exchange response headers.

ETS-backed store for rate limit status across exchanges.

Compile-time exchange lookup registry.

Signing pattern library for exchange authentication.

Behaviour for signing pattern implementations.

Classifies exchange signing patterns from spec AST data.

Custom signing escape hatch for exchanges with non-standard authentication.

Deribit-style HMAC-SHA256 signing with custom Authorization header.

HMAC-SHA256 headers signing pattern (Bybit-style).

HMAC-SHA256 with ISO timestamp and passphrase (OKX-style).

HMAC-SHA256 with HMAC-signed passphrase (KuCoin-style).

HMAC-SHA256 query string signing pattern (Binance-style).

HMAC-SHA384 payload signing pattern (Bitfinex/Gemini-style).

HMAC-SHA512 Gate.io-style signing pattern.

HMAC-SHA512 with nonce signing pattern (Kraken-style).

Compile-time JSON spec loader for exchange specifications.

Bidirectional symbol normalization between unified and exchange-specific formats.

Error raised when symbol conversion fails.

Centralized telemetry contract for CCXT.

ETS-backed credential registry for integration testing.

Unified market ticker data.

Unified trade execution data.

Unified trading fee schedule data.

Unified deposit/withdrawal transaction data.

Unified internal transfer data.

Compile-time mapping of unified method names to endpoint configs.

WebSocket entry point. Thin wrapper around ZenWebsocket.Client that binds a %CCXT.Exchange{} to a connection so subscribe/3 can pick the correct exchange-native frame builder.

WebSocket authentication pattern dispatcher.

Behaviour for WebSocket authentication pattern implementations.

Direct HMAC Expiry auth pattern — bybit, bitmex, and htx/huobi families.

Pure helpers for computing auth session expiry timing.

Inline Subscribe auth pattern — coinbaseexchange.

ISO Passphrase auth pattern — okx family, kucoin family, bitget.

JSON-RPC Linebreak auth pattern — deribit.

Listen Key auth pattern — binance family, aster.

REST Token auth pattern — kraken.

SHA384 Nonce auth pattern — bitfinex.

SHA512 Newline auth pattern — gate, gateio.

Per-exchange WebSocket configuration.

Pure helpers for WS URL resolution.

WebSocket subscription pattern dispatcher.

Alpaca/LBank-style subscribe frame keyed on an "action" field with a params object.

Behaviour for WebSocket subscription pattern implementations.

Escape hatch for exchanges whose subscribe frames don't fit any named pattern. The module dispatches on config[:custom_type]

Gate/Bitfinex/Bitget-style subscribe frame keyed on an "event" field.

Deribit-style JSON-RPC 2.0 subscribe frame.

Coinex/Phemex-style subscribe frame where the method name IS the channel.

Kraken v2 / Crypto.com-style subscribe frame.

Binance/XT/Aster-style subscribe frame.

Hyperliquid-style subscribe frame.

Exmo-style subscribe frame.

Bybit/Bitmex-style subscribe frame.

OKX-style subscribe frame with object-valued args.

BingX-style subscribe frame.

HTX/Huobi-style subscribe frame.

KuCoin/Coinbase-style subscribe frame keyed on a "type" field.

Pure URL resolution for WebSocket endpoints.

Mix Tasks

Reports signing pattern classification for all exchanges.