Skip to content

Latest commit

 

History

History
396 lines (314 loc) · 20.9 KB

README.md

File metadata and controls

396 lines (314 loc) · 20.9 KB
Raw

.Bitget.Net Bitget.Net

.NET License

Bitget.Net is a strongly typed client library for accessing the Bitget REST and Websocket 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
  • Client 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 JK.Bitget.Net

GitHub packages

Bitget.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 BitgetRestClient();
var tickerResult = await restClient.SpotApi.ExchangeData.GetTickerAsync("ETHUSDT_SPBL");
var lastPrice = tickerResult.Data.ClosePrice;

Websocket streams

// Subscribe to ETH/USDT ticker updates via the websocket API
var socketClient = new BitgetSocketClient();
var tickerSubscriptionResult = socketClient.SpotApi.SubscribeToTickerUpdatesAsync("ETHUSDT", (update) => 
{
  var lastPrice = update.Data.LastPrice;
});

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

CryptoExchange.Net

Biget.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
BitMart JKorf/BitMart.Net Nuget version
Bybit JKorf/Bybit.Net Nuget version
Coinbase JKorf/Coinbase.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
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

Discord

Nuget version
A Discord server is available here. Feel free to join for discussion and/or questions around the CryptoExchange.Net and implementation libraries.

Supported functionality

Both V1 API and V2 are currently supported

V2

Spot

API Supported Location
Rest Market ✓ restClient.SpotApiV2.ExchangeData
Rest Trade ✓ restClient.SpotApiV2.Trading
Rest Trigger ✓ restClient.SpotApi.Account
Rest Account ✓ restClient.SpotApi.Account
Websocket Public ✓ socketClient.SpotApiV2
Websocket Private ✓ socketClient.SpotApiV2

Future (usdt/usdc/coin)

API Supported Location
Rest Market ✓ restClient.FuturesApiV2.ExchangeData
Rest Account ✓ restClient.FuturesApiV2.Account
Rest Position ✓ restClient.FuturesApiV2.Trading
Rest Trade ✓ restClient.FuturesApiV2.Trading
Rest Trigger Order ✓ restClient.FuturesApiV2.Trading
Websocket Public ✓ socketClient.FuturesApiV2
Websocket Private ✓ socketClient.FuturesApiV2

Margin

API Supported Location
Common ✓ restClient.SpotApiV2.Margin
Rest Cross ✓ restClient.SpotApiV2.Margin
Rest Isolated ✓ restClient.SpotApiV2.Margin
Websocket ✓ socketClient.SpotApiV2

V1

Spot

API Supported Location
Rest Public ✓ restClient.SpotApi.ExchangeData
Rest Market ✓ restClient.SpotApi.ExchangeData
Rest Wallet ✓ restClient.SpotApi.Account
Rest Account ✓ restClient.SpotApi.Account
Rest Trade ✓ restClient.SpotApi.Trading
Rest P2P X
Rest Sub-Account X
Rest Convert X
Websocket Public ✓ socketClient.SpotApi
Websocket Private ✓ socketClient.SpotApi

Futures USDT/Coin

API Supported Location
Rest Market ✓ restClient.FuturesApi.ExchangeData
Rest Account ✓ restClient.FuturesApi.Account
Rest Trade ✓ restClient.FuturesApi.Trading
Websocket Public ✓ socketClient.FuturesApi
Websocket Private ✓ socketClient.FuturesApi

Support the project

Any support is greatly appreciated.

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.19.0 - 23 Dec 2024

    • Updated CryptoExchange.Net to version 8.5.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
    • Added SetOptions methods on Rest and Socket clients
    • Added setting of DefaultProxyCredentials to CredentialCache.DefaultCredentials on the DI http client
    • Added page parameter to restClient.SpotApi.Account.GetTransferHistoryAsync, marked idLessThan as deprecated
    • Improved websocket disconnect detection

  • Version 1.18.1 - 03 Dec 2024

  • Version 1.18.0 - 28 Nov 2024

  • Version 1.17.0 - 25 Nov 2024

    • Added restClient.SpotApiV2.Account.TransferSubAccountAsync endpoint
    • Added restClient.SpotApiV2.Account.GetSubAccountBalancesAsync endpoint
    • Added restClient.SpotApiV2.Account.GetSubAccountTransferHistoryAsync endpoint
    • Added restClient.SpotApiV2.Account.GetSubAccountDepositAddressAsync endpoint
    • Added restClient.SpotApiV2.Account.GetSubAccountDepositHistoryAsync endpoint
    • Added websocket rate limiting rules
    • Fixed restClient.SetApiCredentials having incorrect ApiCredentials type

  • Version 1.16.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 BitgetExchange class
    • Updated client constructors to accept IOptions from DI
    • Changed restClient.FuturesApiV2.Account.GetLedgerAsync idLessThan parameter to long type to match response model id type
    • Removed redundant BitgetSocketClient constructor

  • Version 1.15.1 - 15 Nov 2024

    • Added missing futures trigger order statuses

  • Version 1.15.0 - 14 Nov 2024

    • Added status filter to restClient.FuturesApiV2.Trading.GetClosedTriggerOrdersAsync
    • Updated restClient.FuturesApiV2.Account.GetLedgerAsync response model

  • Version 1.14.0 - 11 Nov 2024

    • Split and corrected futures trigger plan type parameters

  • Version 1.13.0 - 06 Nov 2024

  • Version 1.12.0 - 04 Nov 2024

    • Added Cross and Isolated Margin API implementation
    • Fixed V1 API GET request authentication for requests without parameters
    • Fixed warning log when subscribing multiple symbols at the same time

  • Version 1.11.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 BitgetExchange class
    • Added support Side setting on SharedTrade model
    • Added BitgetTrackerFactory for creating trackers
    • Added overload to Create method on BitgetOrderBookFactory support SharedSymbol parameter

  • Version 1.10.4 - 15 Oct 2024

    • Fixed V1 GET request signing without parameters
    • Fixed request signing V2 with special characters
    • Fixed restClient.SpotApi.Trading.GetOrderAsync exception when order not found

  • Version 1.10.3 - 14 Oct 2024

  • Version 1.10.2 - 14 Oct 2024

    • Fixed V1 request signing where query parameters contain special characters

  • Version 1.10.1 - 08 Oct 2024

    • Added BitgetSymbolStatus.Halt Enum value
    • Added converting to uppercase for CancelAllOrdersAsync marginAsset parameter
    • Fixed FutureApiV2.Trading.CancelTriggerOrdersAsync endpoint

  • Version 1.10.0 - 27 Sep 2024

    • Updated CryptoExchange.Net to version 8.0.0, see https://github.com/JKorf/CryptoExchange.Net/releases/tag/8.0.0
    • Added Shared client interfaces implementation for Spot Rest and Socket clients
    • Added oneWaySide parameter to FuturesV2.Trading.PlaceTpSlOrderAsync and renamed positionSide parameter to hedgeModePositionSide
    • Updated QuoteQuantityFilled property name to QuoteQuantity on BitgetFuturesOrderUpdate
    • Updated LastTradeId property type from decimal to string? on BitgetFuturesOrderUpdate
    • Updated LastTradeQuantity, AveragePrice, LastTradeFillPrice and LastTradeFillTime property types from decimal to decimal? on BitgetFuturesOrderUpdate
    • Updated BitgetStreamKlineIntervalV2 Enum values to match number of seconds
    • Updated QuantityDecimals and PriceDecimals property types from decimal to int on BitgetContract model
    • Updated Sourcelink package version
    • Fixed FuturesV2.ExchangeData.GetNextFundingTimeAsync potentially throwing InvalidOperationException
    • Fixed various endpoints on FuturesV2.Trading returning null data instead of empty collection
    • Fixed typo in IsolatedMarginProfitAndLoss property on BitgetFuturesBalance model
    • Fixed websocket message identification on subscriptions without symbol parameter
    • Marked ISpotClient references as deprecated

  • Version 1.9.5 - 19 Sep 2024

    • Fixed ClientOrderId websocket order update deserialization

  • Version 1.9.4 - 11 Sep 2024

    • Fixed UsdcPerpetualSimulated Enum value serialization

  • Version 1.9.3 - 28 Aug 2024

  • Version 1.9.2 - 23 Aug 2024

    • Fixed deserialization issue in FuturesApiV2.Account.SetLeverageAsync and SetMarginModeAsync response

  • Version 1.9.1 - 18 Aug 2024

    • Added PositionId to FuturesApiV2.Trading.GetPositionHistoryAsync response model
    • Updated some endpoint ratelimits

  • Version 1.9.0 - 07 Aug 2024

  • Version 1.8.0 - 27 Jul 2024

    • Updated CryptoExchange.Net to version 7.10.0, see https://github.com/JKorf/CryptoExchange.Net/releases/tag/7.10.0
    • Fixed body serialization FuturesV2, fixing PlaceMultipleOrders and CancelMultipleOrdersAsync endpoints
    • Fixed futures plan type parameters
    • Fixed spot GetHistoricalKlinesAsync endTime parameter being required
    • Fixed BitgetFuturesOrder response mapping

  • Version 1.7.0 - 16 Jul 2024

    • Updated CryptoExchange.Net to version 7.9.0, see https://github.com/JKorf/CryptoExchange.Net/releases/tag/7.9.0
    • Updated internal classes to internal access modifier
    • Fixed deserialization error on BitgetPosition model
    • Fixed positionSide parameter on FuturesApiV2.Trading.PlaceOrderAsync endpoint
    • Fixed websocket error response identification
    • Fixed CreateTime and UpdateTime deserialization on FuturesApiV2.Trading.GetPositionHistoryAsync

  • Version 1.6.1 - 02 Jul 2024

  • Version 1.6.0 - 28 Jun 2024

    • Fixed V1 socket subscriptions
    • Fixed FuturesApiV2.Trading.GetOpenOrdersAsync deserialization
    • Updated V2 websocket kline interval Enum values

  • Version 1.5.1 - 25 Jun 2024

  • Version 1.5.0 - 23 Jun 2024

  • Version 1.4.0 - 11 Jun 2024

  • Version 1.3.8 - 02 Jun 2024

    • Added simulated product types to BitgetInstrumentType enum

  • Version 1.3.7 - 07 May 2024

  • Version 1.3.6 - 01 May 2024

  • Version 1.3.5 - 28 Apr 2024

  • Version 1.3.4 - 23 Apr 2024

  • Version 1.3.3 - 18 Apr 2024

  • Version 1.3.2 - 04 Apr 2024

    • Fixed websocket kline deserialization
    • Fixed WithdrawAsync parameter serialization

  • Version 1.3.1 - 24 Mar 2024

  • Version 1.3.0 - 16 Mar 2024

  • Version 1.2.0 - 10 Mar 2024

    • Updated GetBillsAsync endpoints to V2 API to fix some issues occurring with the V1 endpoints. Full update to the V2 API will follow later

  • Version 1.1.2 - 08 Mar 2024

    • Fixed deserialization error for nullable UpdateTime properties

  • Version 1.1.1 - 08 Mar 2024

    • Fixed Socket Futures subscription data handling

  • Version 1.1.0 - 25 Feb 2024

  • Version 1.0.7 - 05 Feb 2024

    • Added FuturesApi.Trading.GetPlanOrdersAsync endpoint
    • Fixed futures order update deserialization when filled

  • Version 1.0.6 - 19 Jan 2024

    • Fixed V5.Trading.GetPlanOrderHistoryAsync
    • Added missing PlanType enum value

  • Version 1.0.5 - 16 Jan 2024

    • Updated PlanType enum
    • Added UpdateTime to BitgetPosition model

  • Version 1.0.4 - 23 Dec 2023

    • Fixed deserialization issues Symbol models

  • Version 1.0.3 - 03 Dec 2023

    • Updated CryptoExchange.Net
    • Fixed nullability on BitgetSymbol model

  • Version 1.0.2 - 23 Nov 2023

    • Fixed FuturesApi.Trading.PlacePlanOrderAsync quantity serialization

  • Version 1.0.1 - 22 Nov 2023

    • Fixed FuturesApi.Trading.GetOpenOrders deserialization error

  • Version 1.0.0 - 24 Oct 2023

    • Updated CryptoExchange.Net

  • Version 0.0.1 - 09 Oct 2023

    • Initial release