Donate with Bitcoin! Donate with Ethereum! Donate with BNB!
crates.io version crates.io downloads # Asynchronous CoinBase Advanced API The objective of this crate is to grant asynchronous access to the **CoinBase Advanced** REST and WebSocket API. Included with the crate are ways to organize your API Keys and Secrets inside of a configuration file. This project is current a work-in-progress. Changes between versions can vary greatly as this API becomes more refined and adapts to CoinBase Advances changing state. I ask you to understand that I am not liable for any issues you may encounter while this project is in this state and encourage you to verify and test before committing to using this yourself in a serious manner. Contributions are encouraged! The API reference can be seen at [CoinBase Advanced API](https://docs.cloud.coinbase.com/advanced-trade-api/reference). If you wish to add this to your project, either use `cargo add cbadv` or add the following line to your dependencies section in **Cargo.toml**: ```toml [dependencies] cbadv = { git = "https://github.com/ohkthx/cbadv-rs", branch = "main" } ``` ## Features - Asynchronous. - Easy-to-use REST and WebSocket clients. - Configuration file to hold API Key and API Secret. `features = ["config"]` - Covers all REST endpoints currently accessible (as of 20231016). - Covers all WebSocket endpoints currently accessible (as of 20231016). - Lots of examples! Check them out to get started. ## Documentation Most of the documentation can be accessed by clicking the following link: [docs.rs](https://docs.rs/cbadv/latest/cbadv/). That documentation is automatically generated and also accessible from [crates.io](https://crates.io/crates/cbadv). ### Covered API requests #### WebSocket API Client: `use cbadv::websocket::WebSocketClient` - **Authentication** [client.connect] - **Subscribe** [client.subscribe / client.sub] - **Unsubscribe** [client.unsubscribe / client.unsub] - **Channels Supported** - Status [Channel::STATUS] - Candles [Channel::CANDLES] - Ticker [Channel::TICKER] - Ticker Batch [Channel::TICKER_BATCH] - Level2 [Channel::LEVEL2] - User [Channel::USER] - Market Trades [Channel::MARKET_TRADES] #### REST API Client: `use cbadv::rest::RestClient` - **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 [client.product.get] - Get Product Candles [client.product.candles] - Get Market Trades (Ticker) [client.product.ticker] - **Orders [client.order]** - Create Order - Market IOC (untested) [client.order.create_market] - Limit GTC [client.order.create_limit_gtc] - Limit GTD (untested) [client.order.create_limit_gtd] - Stop Limit GTC (untested) [client.order.create_stop_limit_gtc] - Stop Limit GTD (untested) [client.order.create_stop_limit_gtd] - Cancel Orders [client.order.cancel] - List Orders [client.order.get_bulk] - List Fills (untested) [client.order.fills] - Get Order [client.order.get] - **Fees [client.fee]** - Get Transaction Summary [client.fee.get] ### Added Requests and Features These functions were created to cover common functionality but not initially part of the CoinBase Advanced API. They may require several API requests to accomplish their results. - **REST: Accounts** [client.account] - Get Account by ID [client.account.get_by_id] - Gets an account by the ID (ex BTC or ETH) - Get All [client.account.get_all] - Gets all accounts. - **REST: Products** [client.product] - Get Candles (Extended) [client.product.candles_ext] - Obtains more than the limit (300) candles. - **REST: Orders** [client.order] - Get All Orders [client.order.get_all] - Obtains all orders for a product. - Cancel All Orders [client.order.cancel_all] - Cancels all OPEN orders for a product. - **WebSocket: Watch Candles** [client.watch_candles] - Watches candles for for updates, produces completed candles for a series. - Candles have 5 minute granularities, this cannot be changed in the current API. ### TODO Test all endpoints that are currently untested. ## Configuration Feature Configuration requires you to add the 'config' feature (`features = ["config"]`) to your `Cargo.toml`. The default configuration is unusable due to the API requiring a Key and Secret. You can create, modify, and delete API Keys and Secrets with this [link](https://www.coinbase.com/settings/api). Copy the `config.toml.sample` to `config.toml` and add in your API information. The `config.toml` file will automatically be read on launch to access your accounts API information. Unlike the depreciated CoinBase Pro API, there's no longer access to Public API endpoints. All access requires authentication. The key and secret is authentication requirements for HTTP requests to be properly [signed](https://docs.cloud.coinbase.com/advanced-trade-api/docs/rest-api-auth) and accepted by CoinBase. __**Custom configurations**__ can be created with additional sections beyond just `[coinbase]`. See [custom_config.toml.sample](https://github.com/Ohkthx/cbadv-rs/tree/main/custom_config.toml.sample) for an example of the configuration file. An example of how to implement and create a custom configuration file can be seen in [custom_config.rs](https://github.com/Ohkthx/cbadv-rs/tree/main/examples/custom_config.rs). Example of enabled `config` feature in `Cargo.toml`. ```toml [dependencies] cbadv = { version = "*", features = ["config"] } ``` ## Examples Check above in the **Covered API requests** section for possibly covered examples. All examples are located at [cbadv-rs/examples](https://github.com/Ohkthx/cbadv-rs/tree/main/examples/) directory. ## Tips Appreciated! Wallet addresses are provided below, or click the badges above! ``` Ethereum (ETH): 0x7d75f6a9c021fcc70691fec73368198823fb0f60 Bitcoin (BTC): bc1q75w3cgutug8qdxw3jlmqnkjlv9alt3jr7ftha0 Binance (BNB): 0x7d75f6a9c021fcc70691fec73368198823fb0f60 ```