--- # Asynchronous CoinBase Advanced API The **cbadv-rs** crate provides high-performance, asynchronous access to the Coinbase Advanced REST and WebSocket APIs. This project includes features to securely configure API keys and secrets, making it suitable for developers seeking robust API integration. This project is currently a work-in-progress. While the crate is usable, API changes or updates may occur as Coinbase Advanced evolves. Please thoroughly test before using in production. To get started, add this crate to your project using `cargo add cbadv` or manually add the following to your `Cargo.toml`: ```toml [dependencies] cbadv = { git = "https://github.com/ohkthx/cbadv-rs", branch = "main" } ``` --- ## Table of Contents - [Features](#features) - [Documentation](#documentation) - [Configuration](#configuration) - [Examples](#examples) - [API Coverage](#api-coverage) - [WebSocket API](#websocket-api) - [REST API](#rest-api) - [TODO](#todo) - [Contributing](#contributing) - [Tips Appreciated!](#tips-appreciated) --- ## Features - Asynchronous API access with support for REST and WebSocket protocols. - Authenticated and Public REST Endpoints. - Builders to create REST and WebSocket Clients. - Convenient configuration file support for API keys (`features = ["config"]`). - Comprehensive coverage of all accessible REST and WebSocket endpoints (as of **20231206**). - Numerous examples for seamless integration and testing. --- ## Documentation Full API documentation is available at [docs.rs](https://docs.rs/cbadv/latest/cbadv/). You can also find helpful information on [crates.io](https://crates.io/crates/cbadv). --- ## API Coverage ### WebSocket API Client: `use cbadv::{WebSocketClient, WebSocketClientBuilder}` - **Authentication**: `client.connect` - **Subscribe**: `client.subscribe` - **Unsubscribe**: `client.unsubscribe` - **Listen**: `client.listen` - **Channels Supported**: - `Channel::STATUS`: Status - `Channel::CANDLES`: Candles - `Channel::TICKER`: Ticker - `Channel::TICKER_BATCH`: Ticker Batch - `Channel::LEVEL2`: Level 2 Market Data - `Channel::USER`: User-Specific Updates - `Channel::MARKET_TRADES`: Market Trades - `Channel::HEARTBEATS`: Hearbeat (maintains connection.) - `Channel::FUTURES_BALANCE_SUMMARY`: Balance Summary for Futures. ### REST API Client: `use cbadv::{RestClient, RestClientBuilder}` - **Accounts (`client.account`)**: - List Accounts: `client.account.get_bulk` - Get Account: `client.account.get` - **Products (`client.product`)**: - Get Best Bid/Ask: `client.product.best_bid_ask` - Get Product Book: `client.product.product_book` - List Products: `client.product.get_bulk` - Get Product Details: `client.product.get` - Get Product Candles: `client.product.candles` - Get Market Trades (Ticker): `client.product.ticker` - **Orders (`client.order`)**: - Create Order: `client.order.create` - Edit Order: `client.order.edit` - Preview Order Edit: `client.order.preview_edit` - Preview Order Create: `client.order.preview_create` - Cancel Order: `client.order.cancel` - List Orders: `client.order.get_bulk` - List Fills: `client.order.fills` - Get Order: `client.order.get` - Close Position (untested): `client.order.close_position` - **Fees (`client.fee`)**: - Get Transaction Summary: `client.fee.get` - **Converts (`client.convert`)**: - Create Quote: `client.convert.create_quote` - Get Convert: `client.convert.get` - Commit Convert (untested): `client.convert.commit` - **Portfolios (`client.portfolio`)**: - Create Portfolio: `client.portfolio.create` - List Portfolios: `client.portfolio.get_all` - Get Portfolio Breakdown: `client.portfolio.get` - Edit Portfolio: `client.portfolio.edit` - Delete Portfolio: `client.portfolio.delete` - Move Funds (untested): `client.portfolio.move_funds` - **Payments (`client.payment`)** - List Payments: `client.payment.get_all` - Get Payment: `client.payment.get` - **Data (`client.data`)** - API Key Permissions: `client.data.key_permissions` - **Public (`client.public`)**: - Get API Unix Server Time: `client.public.time` - Get Product Book: `client.public.product_book` - List Products: `client.public.products` - Get Product: `client.public.product` - Get Product Candles: `client.public.candles` - Get Product Ticker: `client.public.ticker` --- ## Configuration To enable the configuration feature, include it in your `Cargo.toml`: ```toml [dependencies] cbadv = { version = "*", features = ["config"] } ``` Set up `config.toml` with your API credentials. A sample file can be found at `config.toml.sample`. See the [custom configuration example](https://github.com/Ohkthx/cbadv-rs/tree/main/examples/custom_config.rs) for advanced setups. --- ## Examples Explore the [examples directory](https://github.com/Ohkthx/cbadv-rs/tree/main/examples/) for usage scenarios. --- ## TODO - Test unverified endpoints. - Expand examples to cover more advanced cases. --- ## Contributing Contributions are welcome! Fork the repository, create a feature branch, and submit a pull request. --- ## Tips Appreciated Support this project via cryptocurrency donations: **Ethereum (ETH):** 0x7d75f6a9c021fcc70691fec73368198823fb0f60 **Bitcoin (BTC):** bc1q75w3cgutug8qdxw3jlmqnkjlv9alt3jr7ftha0 **Binance (BNB):** 0x7d75f6a9c021fcc70691fec73368198823fb0f60