cbadv-rs, Coinbase Advanced API
cbadv-rs grants access to the Coinbase Advanced REST and WebSocket API.
The cbadv-rs project is designed to help me get my feet wet in Rust. By no means should others consider using this in the near future, especially with the hopes of making money. This is entirely for testing purposes and I am not responsible for your losses. As note that this project is a work-in-progress and subject to change with time. Some functions, structs, enums, etc may be renamed to adhere to better styling guidelines or optimized for efficiency. With these disclaimers aside and if you enjoy this project, you can choose to credit me with any gains made.
Contributions are encouraged! The API reference can be seen at Coinbase Advanced API. 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" }
Features
- Easy-to-use Client.
- Configuration file to hold API Key and API Secret.
- Covers all REST endpoints currently accessible (20230630).
- Covers all WebSocket endpoints currently accessible (20230630).
Documentation
Most of the documentation can be accessed by clicking the following link: docs.rs. That documentation is automatically generated and also accessible from crates.io.
Covered API requests
WebSocket API
Client: use cbadv::websocket::Client
- Authentication [client.connect]
- Subscribe [client.subscribe]
- Unsubscribe [client.unsubscribe]
- Channels Supported
- Status [Channel::STATUS]
- Ticker [Channel::TICKER]
- Ticker Batch [Channel::TICKERBATCH]
- Level2 [Channel::LEVEL2]
- User [Channel::USER]
- Market Trades [Channel::MARKETTRADES]
REST API
Client: use cbadv::rest::Client
- Accounts [client.account]
- List Accounts [client.account.get_bulk]
- Get Account [client.account.get]
- Products [client.product]
- Get Best Bid / Ask [client.product.bestbidask]
- Get Product Book [client.product.productbook]
- List Products [client.product.getbulk]
- 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.createmarket]
- Limit GTC [client.order.createlimitgtc]
- Limit GTD (untested) [client.order.createlimitgtd]
- Stop Limit GTC (untested) [client.order.createstoplimitgtc]
- Stop Limit GTD (untested) [client.order.createstoplimitgtd]
- Cancel Orders [client.order.cancel]
- List Orders [client.order.getbulk]
- List Fills (untested) [client.order.fills]
- Get Order [client.order.get]
- Fees [client.fee]
- Get Transaction Summary [client.fee.get]
Added Requests
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.
- Accounts [client.account]
- Get Account by ID [client.account.getbyid] - Gets an account by the ID (ex BTC or ETH)
- Orders [client.order]
- Get All Orders [client.order.getall] - Obtains all orders for a product.
- Cancel All Orders [client.order.cancelall] - Cancels all OPEN orders for a product.
TODO
Test all endpoints that are currently untested.
Configuration
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.
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 and accepted by Coinbase.
Examples
Check above in the Covered API requests section for possibly covered examples.
- Account API: accountapiexample.rs
- Product API: productapiexample.rs
- Fee API: feeapiexample.rs
- Order API: orderapiexample.rs
- WebSocket API: websocket_example.rs
Tips Appreciated!
Wallet addresses are provided below, or click the badges above!
Bitcoin (BTC): bc1q75w3cgutug8qdxw3jlmqnkjlv9alt3jr7ftha0
Ethereum (ETH): 0x7d75f6a9c021fcc70691fec73368198823fb0f60
Binance (BNB): 0x7d75f6a9c021fcc70691fec73368198823fb0f60