# binance_elixir v0.2.1 - Table of Contents

> Unofficial Binance Spot REST and WebSocket connector for Elixir

## Pages

- [BinanceElixir](readme.md)

## Modules

- [BinanceElixir](BinanceElixir.md): Binance Spot REST client. Requests return `{:ok, %BinanceElixir.Response{}}` or
`{:error, %BinanceElixir.Error{}}`.
- [BinanceElixir.Clock](BinanceElixir.Clock.md): A supervised clock with a Binance server-time offset.
- [BinanceElixir.RateLimit](BinanceElixir.RateLimit.md): Shared, supervised observation of Binance REST rate-limit headers.
- [BinanceElixir.Response](BinanceElixir.Response.md): Decoded response with HTTP metadata and Binance rate-limit headers.
- [BinanceElixir.Signature](BinanceElixir.Signature.md): HMAC-SHA256 and Ed25519 signing for Binance REST and WebSocket API.
- [BinanceElixir.Spot](BinanceElixir.Spot.md): Common Binance Spot REST endpoints. All functions return a response or error tuple.
- [BinanceElixir.Spot.Events](BinanceElixir.Spot.Events.md): Lossless normalization of supported Spot market and account events.
- [BinanceElixir.Spot.Filters](BinanceElixir.Spot.Filters.md): Exact-decimal local preflight for Spot LIMIT, MARKET, and STOP_LOSS orders.
- [BinanceElixir.Spot.MarketStream](BinanceElixir.Spot.MarketStream.md): Supervised Binance Spot market WebSocket stream with a bounded event queue.
- [BinanceElixir.Spot.Reconciliation](BinanceElixir.Spot.Reconciliation.md): Submits a Spot order once and reconciles uncertain results by client order ID.
- [BinanceElixir.Spot.UserStream](BinanceElixir.Spot.UserStream.md): Supervised signed Spot User Data Stream over Binance WebSocket API.
- [BinanceElixir.Transport](BinanceElixir.Transport.md): HTTP transport contract; implement this to inject a custom client.

- Exceptions
  - [BinanceElixir.Error](BinanceElixir.Error.md): An HTTP, Binance API, validation, or transport failure.

