Skip to content

Latest commit

 

History

History
281 lines (230 loc) · 15.9 KB

README.md

File metadata and controls

281 lines (230 loc) · 15.9 KB
Raw

GateIo.Net GateIo.Net

.NET License

GateIo.Net is a client library for accessing the Gate.io 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 GateIo.Net

GitHub packages

GateIo.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 GateIoRestClient();
 var tickerResult = await restClient.SpotApi.ExchangeData.GetTickersAsync("ETH_USDT");
 var lastPrice = tickerResult.Data.First().LastPrice;
  • Websocket streams 
     // Subscribe to ETH/USDT ticker updates via the websocket API
 var socketClient = new GateIoSocketClient();
 var tickerSubscriptionResult = socketClient.SpotApi.SubscribeToTickerUpdatesAsync("ETH_USDT", data =>
 {
 	var lastPrice = data.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

GateIo.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
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
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

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

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

Supported functionality

The following modules are supported of the latest V4 API.

Account & Margin

API Supported Location
Withdrawal ✓ restClient.SpotApi.Account
Wallet ✓ restClient.SpotApi.Account
Subaccount X
Unified ✓ restClient.SpotApi.Account / restClient.SpotApi.ExchangeData
Margin ✓ restClient.SpotApi.Account / restClient.SpotApi.ExchangeData
Marginuni ✓ restClient.SpotApi.Account / restClient.SpotApi.ExchangeData
Flash_swap X
Earnuni X
Collateral-Loan X
Multi-Collateral-Loan X
Earn X
Account ✓ restClient.SpotApi.Account
Rebates X

Spot Rest

API Supported Location
Account ✓ restClient.SpotApi.Account
Public data ✓ restClient.SpotApi.ExchangeData
Trading ✓ restClient.SpotApi.Trading

Spot Websocket

API Supported Location
Public data ✓ socketClient.SpotApi
Trading ✓ socketClient.SpotApi

Perpetual Futures Rest

API Supported Location
Account ✓ restClient.PerpetualFuturesApi.Account
Public data ✓ restClient.PerpetualFuturesApi.ExchangeData
Trading ✓ restClient.PerpetualFuturesApi.Trading

Perpetual Futures Websocket

API Supported Location
Public data ✓ socketClient.PerpetualFuturesApi
Trading ✓ socketClient.PerpetualFuturesApi

Delivery Futures

API Supported Location
* X

Options

API Supported Location
* X

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.15.0 - 03 Dec 2024

    • Updated CryptoExchange.Net to version 8.4.3, see https://github.com/JKorf/CryptoExchange.Net/releases/
    • Added restClient.SpotApi.Account.GetTransferStatusAsync endpoint
    • Added UpdateId to Position model
    • Removed socketClient.SpotApi.SubscribeToOrderBookUpdatesAsync updateMs parameter
    • Removed socketClient.PerpetualFuturesApi.SubscribeToOrderBookUpdatesAsync 1000ms updateMs and 5 and 10 depth valid parameter values
    • Fixed orderbook creation via GateIoBookFactory

  • Version 1.14.0 - 28 Nov 2024

  • Version 1.13.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 GateIoExchange class
    • Updated client constructors to accept IOptions from DI
    • Updated GateIoExchange.ExchangeName value from Gate.io to GateIo
    • Removed redundant GateIoSocketClient constructor

  • Version 1.12.1 - 08 Nov 2024

    • Fixed restClient.PerpetualFuturesApi.Trading.PlaceTriggerOrderAsync parameter serialization

  • Version 1.12.0 - 06 Nov 2024

  • Version 1.11.0 - 04 Nov 2024

    • Added restClient.SpotApi.Account.GetUnifiedLeverageConfigsAsync endpoint
    • Added restClient.SpotApi.Account.GetUnifiedLeverageAsync endpoint
    • Added restClient.SpotApi.Account.SetUnifiedLeverageAsync endpoint
    • Added Id property to restClient.PerpetualFuturesApi.Account.GetLedgerAsync response model
    • Added Leverage property to restClient.SpotApi.ExchangeData.GetDiscountTiersAsync response model
    • Added BestAskQuantity, BestBidQuantity properties to restClient.SpotApi.ExchangeData.GetTickersAsync response model

  • Version 1.10.0 - 28 Oct 2024

  • Version 1.9.0 - 21 Oct 2024

    • Added restClient.SpotApi.Account.GetRateLimitsAsync endpoint
    • Added support for clientOrderId to restClient.PerpetualFuturesApi.Trading.GetOrderAsync, CancelOrderAsync and EditOrderAsync endpoints

  • Version 1.8.1 - 14 Oct 2024

  • Version 1.8.0 - 14 Oct 2024

    • Fixed ICoinbaseOrderBookFactory DI lifetime
    • Added clientOrderId parameter to restClient.SpotApi.Trading.EditOrderAsync
    • Added clientOrderId parameter to socketClient.SpotApi.EditOrderAsync

  • Version 1.7.0 - 08 Oct 2024

    • Added SpotApi.Account.GetTransferHistoryAsync endpoint
    • Added SpotApi.Account.TransferToAccountAsync endpoint
    • Added PerpetualFuturesApi.Trading.EditMultipleOrdersAsync endpoint
    • Added BestBidQuantity/BestAskQuantity properties to GateIoPerpTicker response model
    • Added startTime/endTime parameters to PerpetualFuturesApi.ExchangeData.GetFundingRateHistoryAsync and updated shared implementation to support pagination
    • Added support for clientOrderId to SpotApi.Trading.GetOrderAsync endpoint
    • Fixed some serialization issues in batch endpoints

  • Version 1.6.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 and Perpetual Futures Rest and Socket clients
    • Added api credentials check for Spot user subscriptions
    • Added InitialMargin and MaintenanceMargin properties to GateIoPosition model
    • Added FeeAsset property to GateIoUserTradeUpdate model
    • Updated Sourcelink package version
    • Updated KlineInterval Enum values to match number of seconds
    • Fixed PerpetualFutures.Account.UpdatePositionModeAsync endpoint
    • Fixed SpotApi.ExchangeData.GetTradesAsync reverse parameter
    • Marked ISpotClient references as deprecated

  • Version 1.5.1 - 11 Sep 2024

    • Added startTime and endTime filter to SpotApi.Account.GetUnifiedAccountInterestHistoryAsync endpoint
    • Added options to SpotApi.Account.SetUnifiedAccountModeAsync and GetUnifiedAccountModeAsync endpoints
    • Added BlockNumber field to SpotApi.Account.GetWithdrawalsAsync response

  • Version 1.5.0 - 07 Aug 2024

  • Version 1.4.0 - 27 Jul 2024

  • Version 1.3.0 - 16 Jul 2024

  • Version 1.2.1 - 02 Jul 2024

  • Version 1.2.0 - 25 Jun 2024

  • Version 1.1.0 - 23 Jun 2024

  • Version 1.0.1 - 13 Jun 2024

    • Fixed startTime/endTime filtering on multiple endpoints

  • Version 1.0.0 - 12 Jun 2024

    • Initial release