Skip to content

Latest commit

 

History

History
215 lines (174 loc) · 13.3 KB

README.md

File metadata and controls

215 lines (174 loc) · 13.3 KB
Raw

Coinbase.Net Coinbase.Net

.NET License

Coinbase.Net is a client library for accessing the Coinbase Advanced Trade REST and Websocket API and Coinbase App REST API.

Features

  • Response data is mapped to descriptive models
  • Input parameters and response values are mapped to discriptive enum values where possible
  • Automatic websocket (re)connection management
  • Client side rate limiting
  • Cient side order book implementation
  • Extensive logging
  • Support for different environments
  • Easy integration with other exchange client based on the CryptoExchange.Net base library

Supported Frameworks

The library is targeting both .NET Standard 2.0 and .NET Standard 2.1 for optimal compatibility

.NET implementation Version Support
.NET Core 2.0 and higher
.NET Framework 4.6.1 and higher
Mono 5.4 and higher
Xamarin.iOS 10.14 and higher
Xamarin.Android 8.0 and higher
UWP 10.0.16299 and higher
Unity 2018.1 and higher

Install the library

NuGet

NuGet version Nuget downloads

dotnet add package Coinbase.Net

GitHub packages

Coinbase.Net is available on GitHub packages. You'll need to add https://nuget.pkg.github.com/JKorf/index.json as a NuGet package source.

Download release

GitHub Release

The NuGet package files are added along side the source with the latest GitHub release which can found here.

How to use

  • REST Endpoints 
     // Get the ETH/USDT ticker via rest request
 var restClient = new CoinbaseRestClient();
 var tickerResult = await restClient.AdvancedTradeApi.ExchangeData.GetSymbolAsync("ETH-USDT");
 var lastPrice = tickerResult.Data.LastPrice;
  • Websocket streams 
     // Subscribe to ETH/USDT ticker updates via the websocket API
 var socketClient = new CoinbaseSocketClient();
 var tickerSubscriptionResult = socketClient.AdvancedTradeApi.SubscribeToTickerUpdatesAsync("ETHUSDT", (update) => 
 {
   var lastPrice = update.Data.LastPrice;
 });

For information on the clients, dependency injection, response processing and more see the documentation, or have a look at the examples here or here.

CryptoExchange.Net

Coinbase.Net is based on the CryptoExchange.Net base library. Other exchange API implementations based on the CryptoExchange.Net base library are available and follow the same logic.

CryptoExchange.Net also allows for easy access to different exchange API's.

Exchange Repository Nuget
Binance JKorf/Binance.Net Nuget version
BingX JKorf/BingX.Net Nuget version
Bitfinex JKorf/Bitfinex.Net Nuget version
Bitget JKorf/Bitget.Net Nuget version
BitMart JKorf/BitMart.Net Nuget version
Bybit JKorf/Bybit.Net Nuget version
CoinEx JKorf/CoinEx.Net Nuget version
CoinGecko JKorf/CoinGecko.Net Nuget version
Crypto.com JKorf/CryptoCom.Net Nuget version
Gate.io JKorf/GateIo.Net Nuget version
HTX JKorf/HTX.Net Nuget version
Gate.io JKorf/GateIo.Net Nuget version
Kraken JKorf/Kraken.Net Nuget version
Kucoin JKorf/Kucoin.Net Nuget version
Mexc JKorf/Mexc.Net Nuget version
OKX JKorf/OKX.Net Nuget version
WhiteBit JKorf/WhiteBit.Net Nuget version
XT JKorf/XT.Net Nuget version

When using multiple of these API's the CryptoClients.Net package can be used which combines this and the other packages and allows easy access to all exchange API's.

Discord

Discord
A Discord server is available here. For discussion and/or questions around the CryptoExchange.Net and implementation libraries, feel free to join.

Supported functionality

Due to framework restrictions for signing requests only .netstandard 2.1 can currently use private endpoints

Advanced Trade REST

API Supported Location
Account ✓ restClient.AdvancedTradeApi.Account
Products ✓ restClient.AdvancedTradeApi.ExchangeData
Orders ✓ restClient.AdvancedTradeApi.Trading
Portfolios ✓ restClient.AdvancedTradeApi.Account
Futures ✓ restClient.AdvancedTradeApi.Account/restClient.AdvancedTradeApi.Trading
Perpetuals ✓ restClient.AdvancedTradeApi.Account/restClient.AdvancedTradeApi.Trading
Fees ✓ restClient.AdvancedTradeApi.Account
Convert ✓ restClient.AdvancedTradeApi.Account
Public ✓ restClient.AdvancedTradeApi.ExchangeData
Payment Methods ✓ restClient.AdvancedTradeApi.Account
Data API ✓ restClient.AdvancedTradeApi.Account

Advanced Trade Websocket

API Supported Location
All channels ✓ socketClient.AdvancedTradeApi

App

API Supported Location
Accounts X Functionality supported in Advanced Trade API
Addresses ✓ restClient.AdvancedTradeApi.Account
Transactions ✓ restClient.AdvancedTradeApi.Account
Deposits ✓ restClient.AdvancedTradeApi.Account
Withdrawals ✓ restClient.AdvancedTradeApi.Account
Currencies ✓ restClient.AdvancedTradeApi.ExchangeData
Exchange Rates ✓ restClient.AdvancedTradeApi.ExchangeData
Prices ✓ restClient.AdvancedTradeApi.ExchangeData
Time ✓ restClient.AdvancedTradeApi.ExchangeData

Support the project

Any support is greatly appreciated.

Referal

If you do not yet have an account please consider using this referal link to sign up:
Link

Donate

Make a one time donation in a crypto currency of your choice. If you prefer to donate a currency not listed here please contact me.

Btc: bc1q277a5n54s2l2mzlu778ef7lpkwhjhyvghuv8qf
Eth: 0xcb1b63aCF9fef2755eBf4a0506250074496Ad5b7
USDT (TRX) TKigKeJPXZYyMVDgMyXxMf17MWYia92Rjd

Sponsor

Alternatively, sponsor me on Github using Github Sponsors.

Release notes

  • Version 1.7.0 - 23 Dec 2024

  • Version 1.6.1 - 03 Dec 2024

  • Version 1.6.0 - 28 Nov 2024

  • Version 1.5.1 - 21 Nov 2024

    • Fixed deserialization error in SubscribeToBatchedTickerUpdatesAsync subscription when there is no trade price

  • Version 1.5.0 - 19 Nov 2024

    • Updated CryptoExchange.Net to version 8.3.0, see https://github.com/JKorf/CryptoExchange.Net/releases/tag/8.3.0
    • Added support for loading client settings from IConfiguration
    • Added DI registration method for configuring Rest and Socket options at the same time
    • Added DisplayName and ImageUrl properties to CoinbaseExchange class
    • Updated client constructors to accept IOptions from DI
    • Removed redundant CoinbaseSocketClient constructor

  • Version 1.4.0 - 06 Nov 2024

  • Version 1.3.0 - 04 Nov 2024

    • Updated restClient.AdvancedTradeApi.Account.WithdrawCryptoAsync parameters
    • Removed restClient.AdvancedTradeApi.Account.TransferAsync as it's no longer supported

  • Version 1.2.0 - 28 Oct 2024

    • Updated CryptoExchange.Net to version 8.1.0, see https://github.com/JKorf/CryptoExchange.Net/releases/tag/8.1.0
    • Moved FormatSymbol to CoinbaseExchange class
    • Added support Side setting on SharedTrade model
    • Added CoinbaseTrackerFactory for creating trackers
    • Added overload to Create method on CoinbaseOrderBookFactory support SharedSymbol parameter
    • Added GetKlinesAsync to Shared rest client
    • Fixed exception on restClient.AdvancedTradingAi.Trading.CancelOrderAynsc when order not found
    • Fixed exception on restClient.AdvancedTradingAi.Trading.CancelOrdersAynsc when request fails
    • Fixed restClient.AdvancedTradingAi.ExchangeData.GetKlinesAsync time filter
    • Fixed issue with concurrent websocket subscription acknowledgements
    • Removed incorrect rate limit of 100 message per second per ip for websockets

  • Version 1.1.2 - 22 Oct 2024

    • Fixed deserialization issue on websocket ticker updates

  • Version 1.1.1 - 21 Oct 2024

    • Fixed websocket market data subscriptions for "USDT-USDC" and "EURC-USDC" symbols

  • Version 1.1.0 - 15 Oct 2024

    • Updated ExchangeData endpoints to use the Products endpoint instead of Public endpoint if API credentials are provided
    • Added restClient.AdvancedTradeApi.ExchangeData.GetBookTickersAsync and GetBookTickerAsync endpoints

  • Version 1.0.1 - 14 Oct 2024

  • Version 1.0.0 - 07 Oct 2024

    • Initial release