# ccxt_client v0.6.1 - API Reference

## Modules

- [CCXT](CCXT.md): Unified cryptocurrency exchange client library.
- [CCXT.ADLRank](CCXT.ADLRank.md): Unified auto-deleveraging (ADL) rank data.
- [CCXT.Account](CCXT.Account.md): Unified exchange account data.
- [CCXT.Application](CCXT.Application.md): OTP Application for CCXT.
- [CCXT.Aster](CCXT.Aster.md): Aster exchange — generated from spec.
- [CCXT.Balance](CCXT.Balance.md): Unified account balance across currencies.
- [CCXT.Binance](CCXT.Binance.md): Binance exchange — generated from spec.
- [CCXT.Binancecoinm](CCXT.Binancecoinm.md): Binance COIN-M exchange — generated from spec.
- [CCXT.Binanceus](CCXT.Binanceus.md): Binance US exchange — generated from spec.
- [CCXT.Binanceusdm](CCXT.Binanceusdm.md): Binance USDⓈ-M exchange — generated from spec.
- [CCXT.Bitfinex](CCXT.Bitfinex.md): Bitfinex exchange — generated from spec.
- [CCXT.Bitmex](CCXT.Bitmex.md): BitMEX exchange — generated from spec.
- [CCXT.BorrowInterest](CCXT.BorrowInterest.md): Unified borrow interest data.
- [CCXT.BorrowRate](CCXT.BorrowRate.md): Unified borrow rate data.
- [CCXT.Bybit](CCXT.Bybit.md): Bybit exchange — generated from spec.
- [CCXT.CircuitBreaker](CCXT.CircuitBreaker.md): Per-exchange circuit breakers using the `:fuse` Erlang library.
- [CCXT.Coinbaseexchange](CCXT.Coinbaseexchange.md): Coinbase Exchange exchange — generated from spec.
- [CCXT.Conversion](CCXT.Conversion.md): Unified currency conversion data.
- [CCXT.Credentials](CCXT.Credentials.md): API credentials for exchange authentication.
- [CCXT.Currency](CCXT.Currency.md): Unified currency data.
- [CCXT.Defaults](CCXT.Defaults.md): Centralized default configuration values for ccxt_client.
- [CCXT.DepositAddress](CCXT.DepositAddress.md): Unified deposit address data.
- [CCXT.DepositWithdrawFee](CCXT.DepositWithdrawFee.md): Unified deposit/withdraw fee data.
- [CCXT.Deribit](CCXT.Deribit.md): Deribit exchange — generated from spec.
- [CCXT.Derive](CCXT.Derive.md): derive exchange — generated from spec.
- [CCXT.Dispatch](CCXT.Dispatch.md): Shared request dispatcher for generated exchange endpoint functions.
- [CCXT.Exchange](CCXT.Exchange.md): Exchange configuration struct and constructor.
- [CCXT.Exchanges](CCXT.Exchanges.md): Compile-time generator for all exchange modules.
- [CCXT.Fee](CCXT.Fee.md): Fee information attached to trades and orders.
- [CCXT.FundingHistory](CCXT.FundingHistory.md): Unified funding payment history data.
- [CCXT.FundingRate](CCXT.FundingRate.md): Unified funding rate data.
- [CCXT.FundingRateHistory](CCXT.FundingRateHistory.md): Unified funding rate history entry.
- [CCXT.Gate](CCXT.Gate.md): Gate exchange — generated from spec.
- [CCXT.Gateio](CCXT.Gateio.md): Gate exchange — generated from spec.
- [CCXT.Greeks](CCXT.Greeks.md): Unified options greeks data.
- [CCXT.HTTP](CCXT.HTTP.md): HTTP client for exchange API requests.
- [CCXT.Htx](CCXT.Htx.md): HTX exchange — generated from spec.
- [CCXT.Huobi](CCXT.Huobi.md): HTX exchange — generated from spec.
- [CCXT.Hyperliquid](CCXT.Hyperliquid.md): Hyperliquid exchange — generated from spec.
- [CCXT.Kraken](CCXT.Kraken.md): Kraken exchange — generated from spec.
- [CCXT.Kucoin](CCXT.Kucoin.md): KuCoin exchange — generated from spec.
- [CCXT.Kucoinfutures](CCXT.Kucoinfutures.md): KuCoin Futures exchange — generated from spec.
- [CCXT.LastPrice](CCXT.LastPrice.md): Unified last price data.
- [CCXT.LedgerEntry](CCXT.LedgerEntry.md): Unified ledger entry data.
- [CCXT.Leverage](CCXT.Leverage.md): Unified leverage settings data.
- [CCXT.LeverageTier](CCXT.LeverageTier.md): Unified leverage tier data.
- [CCXT.Lighter](CCXT.Lighter.md): Lighter exchange — generated from spec.
- [CCXT.Liquidation](CCXT.Liquidation.md): Unified liquidation event data.
- [CCXT.LongShortRatio](CCXT.LongShortRatio.md): Unified long/short ratio data.
- [CCXT.MCP](CCXT.MCP.md): MCP tool definitions for the CCXT API.
- [CCXT.MarginMode](CCXT.MarginMode.md): Unified margin mode data.
- [CCXT.MarginModification](CCXT.MarginModification.md): Unified margin modification data.
- [CCXT.Market](CCXT.Market.md): Unified market/instrument metadata.
- [CCXT.Myokx](CCXT.Myokx.md): MyOKX (EEA) exchange — generated from spec.
- [CCXT.OHLCV](CCXT.OHLCV.md): Candlestick (OHLCV) bar data.
- [CCXT.Okx](CCXT.Okx.md): OKX exchange — generated from spec.
- [CCXT.Okxus](CCXT.Okxus.md): OKX (US) exchange — generated from spec.
- [CCXT.OpenInterest](CCXT.OpenInterest.md): Unified open interest data.
- [CCXT.OptionData](CCXT.OptionData.md): Unified options contract data.
- [CCXT.Order](CCXT.Order.md): Unified order data.
- [CCXT.OrderBook](CCXT.OrderBook.md): Unified order book (market depth) data.
- [CCXT.Position](CCXT.Position.md): Unified derivatives position data.
- [CCXT.RateLimiter](CCXT.RateLimiter.md): Per-credential weighted rate limiter for exchange API requests.
- [CCXT.RateLimiter.Headers](CCXT.RateLimiter.Headers.md): Parses rate limit status headers from exchange API responses.
- [CCXT.RateLimiter.Info](CCXT.RateLimiter.Info.md): Rate limit status information parsed from exchange response headers.
- [CCXT.RateLimiter.State](CCXT.RateLimiter.State.md): ETS-backed store for rate limit status across exchanges.
- [CCXT.Registry](CCXT.Registry.md): Compile-time exchange lookup registry.
- [CCXT.Signing](CCXT.Signing.md): Signing pattern library for exchange authentication.
- [CCXT.Signing.Behaviour](CCXT.Signing.Behaviour.md): Behaviour for signing pattern implementations.
- [CCXT.Signing.Classifier](CCXT.Signing.Classifier.md): Classifies exchange signing patterns from spec AST data.
- [CCXT.Signing.Custom](CCXT.Signing.Custom.md): Custom signing escape hatch for exchanges with non-standard authentication.
- [CCXT.Signing.Deribit](CCXT.Signing.Deribit.md): Deribit-style HMAC-SHA256 signing with custom Authorization header.
- [CCXT.Signing.HmacSha256Headers](CCXT.Signing.HmacSha256Headers.md): HMAC-SHA256 headers signing pattern (Bybit-style).
- [CCXT.Signing.HmacSha256Iso](CCXT.Signing.HmacSha256Iso.md): HMAC-SHA256 with ISO timestamp and passphrase (OKX-style).
- [CCXT.Signing.HmacSha256Kucoin](CCXT.Signing.HmacSha256Kucoin.md): HMAC-SHA256 with HMAC-signed passphrase (KuCoin-style).
- [CCXT.Signing.HmacSha256Query](CCXT.Signing.HmacSha256Query.md): HMAC-SHA256 query string signing pattern (Binance-style).
- [CCXT.Signing.HmacSha384Payload](CCXT.Signing.HmacSha384Payload.md): HMAC-SHA384 payload signing pattern (Bitfinex/Gemini-style).
- [CCXT.Signing.HmacSha512Gate](CCXT.Signing.HmacSha512Gate.md): HMAC-SHA512 Gate.io-style signing pattern.
- [CCXT.Signing.HmacSha512Nonce](CCXT.Signing.HmacSha512Nonce.md): HMAC-SHA512 with nonce signing pattern (Kraken-style).
- [CCXT.Spec](CCXT.Spec.md): Compile-time JSON spec loader for exchange specifications.
- [CCXT.Symbol](CCXT.Symbol.md): Bidirectional symbol normalization between unified and exchange-specific formats.
- [CCXT.Telemetry](CCXT.Telemetry.md): Centralized telemetry contract for CCXT.
- [CCXT.Testnet](CCXT.Testnet.md): ETS-backed credential registry for integration testing.
- [CCXT.Ticker](CCXT.Ticker.md): Unified market ticker data.
- [CCXT.Trade](CCXT.Trade.md): Unified trade execution data.
- [CCXT.TradingFee](CCXT.TradingFee.md): Unified trading fee schedule data.
- [CCXT.Transaction](CCXT.Transaction.md): Unified deposit/withdrawal transaction data.
- [CCXT.TransferEntry](CCXT.TransferEntry.md): Unified internal transfer data.
- [CCXT.UnifiedMethod](CCXT.UnifiedMethod.md): Compile-time mapping of unified method names to endpoint configs.
- [CCXT.WS](CCXT.WS.md): 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.
- [CCXT.WS.Auth](CCXT.WS.Auth.md): WebSocket authentication pattern dispatcher.
- [CCXT.WS.Auth.Behaviour](CCXT.WS.Auth.Behaviour.md): Behaviour for WebSocket authentication pattern implementations.
- [CCXT.WS.Auth.DirectHmacExpiry](CCXT.WS.Auth.DirectHmacExpiry.md): Direct HMAC Expiry auth pattern — bybit, bitmex, and htx/huobi families.
- [CCXT.WS.Auth.Expiry](CCXT.WS.Auth.Expiry.md): Pure helpers for computing auth session expiry timing.
- [CCXT.WS.Auth.InlineSubscribe](CCXT.WS.Auth.InlineSubscribe.md): Inline Subscribe auth pattern — coinbaseexchange.
- [CCXT.WS.Auth.IsoPassphrase](CCXT.WS.Auth.IsoPassphrase.md): ISO Passphrase auth pattern — okx family, kucoin family, bitget.
- [CCXT.WS.Auth.JsonrpcLinebreak](CCXT.WS.Auth.JsonrpcLinebreak.md): JSON-RPC Linebreak auth pattern — deribit.
- [CCXT.WS.Auth.ListenKey](CCXT.WS.Auth.ListenKey.md): Listen Key auth pattern — binance family, aster.
- [CCXT.WS.Auth.RestToken](CCXT.WS.Auth.RestToken.md): REST Token auth pattern — kraken.
- [CCXT.WS.Auth.Sha384Nonce](CCXT.WS.Auth.Sha384Nonce.md): SHA384 Nonce auth pattern — bitfinex.
- [CCXT.WS.Auth.Sha512Newline](CCXT.WS.Auth.Sha512Newline.md): SHA512 Newline auth pattern — gate, gateio.
- [CCXT.WS.Config](CCXT.WS.Config.md): Per-exchange WebSocket configuration.
- [CCXT.WS.Helpers](CCXT.WS.Helpers.md): Pure helpers for WS URL resolution.
- [CCXT.WS.Subscription](CCXT.WS.Subscription.md): WebSocket subscription pattern dispatcher.
- [CCXT.WS.Subscription.ActionSubscribe](CCXT.WS.Subscription.ActionSubscribe.md): Alpaca/LBank-style subscribe frame keyed on an `"action"` field with a
params object.
- [CCXT.WS.Subscription.Behaviour](CCXT.WS.Subscription.Behaviour.md): Behaviour for WebSocket subscription pattern implementations.
- [CCXT.WS.Subscription.Custom](CCXT.WS.Subscription.Custom.md): Escape hatch for exchanges whose subscribe frames don't fit any named
pattern. The module dispatches on `config[:custom_type]`
- [CCXT.WS.Subscription.EventSubscribe](CCXT.WS.Subscription.EventSubscribe.md): Gate/Bitfinex/Bitget-style subscribe frame keyed on an `"event"` field.
- [CCXT.WS.Subscription.JsonRpc](CCXT.WS.Subscription.JsonRpc.md): Deribit-style JSON-RPC 2.0 subscribe frame.
- [CCXT.WS.Subscription.MethodAsTopic](CCXT.WS.Subscription.MethodAsTopic.md): Coinex/Phemex-style subscribe frame where the method name IS the channel.
- [CCXT.WS.Subscription.MethodParams](CCXT.WS.Subscription.MethodParams.md): Kraken v2 / Crypto.com-style subscribe frame.
- [CCXT.WS.Subscription.MethodSubscribe](CCXT.WS.Subscription.MethodSubscribe.md): Binance/XT/Aster-style subscribe frame.
- [CCXT.WS.Subscription.MethodSubscription](CCXT.WS.Subscription.MethodSubscription.md): Hyperliquid-style subscribe frame.
- [CCXT.WS.Subscription.MethodTopics](CCXT.WS.Subscription.MethodTopics.md): Exmo-style subscribe frame.
- [CCXT.WS.Subscription.OpSubscribe](CCXT.WS.Subscription.OpSubscribe.md): Bybit/Bitmex-style subscribe frame.
- [CCXT.WS.Subscription.OpSubscribeObjects](CCXT.WS.Subscription.OpSubscribeObjects.md): OKX-style subscribe frame with object-valued args.
- [CCXT.WS.Subscription.ReqtypeSub](CCXT.WS.Subscription.ReqtypeSub.md): BingX-style subscribe frame.
- [CCXT.WS.Subscription.SubBased](CCXT.WS.Subscription.SubBased.md): HTX/Huobi-style subscribe frame.
- [CCXT.WS.Subscription.TypeSubscribe](CCXT.WS.Subscription.TypeSubscribe.md): KuCoin/Coinbase-style subscribe frame keyed on a `"type"` field.
- [CCXT.WS.URLRouting](CCXT.WS.URLRouting.md): Pure URL resolution for WebSocket endpoints.

- Exceptions
  - [CCXT.Error](CCXT.Error.md): Unified error types for exchange operations.
  - [CCXT.Symbol.Error](CCXT.Symbol.Error.md): Error raised when symbol conversion fails.

## Mix Tasks

- [mix ccxt.classify_signing](Mix.Tasks.Ccxt.ClassifySigning.md): Reports signing pattern classification for all exchanges.