An open API service indexing awesome lists of open source software.

https://github.com/jkorf/blofin.net

A C# .netstandard client library for the BloFin REST and Websocket Futures API focusing on clear usage and models
https://github.com/jkorf/blofin.net

api-wrapper blofin blofin-api blofin-exchange blofin-net crypto cryptocurrency cryptocurrency-exchanges csharp dotnet exchange tradeapi

Last synced: 2 months ago
JSON representation

A C# .netstandard client library for the BloFin REST and Websocket Futures API focusing on clear usage and models

Awesome Lists containing this project

README

          

# ![BloFin.Net](https://raw.githubusercontent.com/JKorf/BloFin.Net/main/BloFin.Net/Icon/icon.png) BloFin.Net

[![.NET](https://img.shields.io/github/actions/workflow/status/JKorf/BloFin.Net/dotnet.yml?style=for-the-badge)](https://github.com/JKorf/BloFin.Net/actions/workflows/dotnet.yml) ![License](https://img.shields.io/github/license/JKorf/BloFin.Net?style=for-the-badge)

BloFin.Net is a client library for accessing the [BloFin REST and Websocket API](https://docs.blofin.com/index.html).

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

## Supported Frameworks
The library is targeting both `.NET Standard 2.0` and `.NET Standard 2.1` for optimal compatibility, as well as the latest dotnet versions to use the latest framework features.

|.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](https://img.shields.io/nuget/v/BloFin.net.svg?style=for-the-badge)](https://www.nuget.org/packages/BloFin.Net) [![Nuget downloads](https://img.shields.io/nuget/dt/BloFin.Net.svg?style=for-the-badge)](https://www.nuget.org/packages/BloFin.Net)

dotnet add package BloFin.Net

### GitHub packages
BloFin.Net is available on [GitHub packages](https://github.com/JKorf/BloFin.Net/pkgs/nuget/BloFin.Net). You'll need to add `https://nuget.pkg.github.com/JKorf/index.json` as a NuGet package source.

### Download release
[![GitHub Release](https://img.shields.io/github/v/release/JKorf/BloFin.Net?style=for-the-badge&label=GitHub)](https://github.com/JKorf/BloFin.Net/releases)

The NuGet package files are added along side the source with the latest GitHub release which can found [here](https://github.com/JKorf/BloFin.Net/releases).

## API key
For accessing authenticated endpoints an API key is required. When creating an API key in the BloFin web interface select `Connect to Third-Party Application` and select `JKorf` as the application name. BloFin requires users to select the application they're using with the API key. Selecting a different application will not work with the library.

## How to use
*Basic request:*
```csharp
// Get the ETH/USDT ticker via rest request
var restClient = new BloFinRestClient();
var tickerResult = await restClient.FuturesApi.ExchangeData.GetTickersAsync("ETH-USDT");
var lastPrice = tickerResult.Data.FirstOrDefault()?.LastPrice;
```

*Place order:*
```csharp
var restClient = new BloFinRestClient(opts => {
opts.ApiCredentials = new BloFinCredentials("APIKEY", "APISECRET");
});

// Place Limit order to go long for 0.1 ETH at 2000
var orderResult = await restClient.FuturesApi.Trading.PlaceOrderAsync(
"ETH-USDT",
OrderSide.Buy,
OrderType.Limit,
0.1m,
MarginMode.Cross,
2000,
positionSide: PositionSide.Long);
```

*WebSocket subscription:*
```csharp
// Subscribe to ETH/USDT ticker updates via the websocket API
var socketClient = new BloFinSocketClient();
var tickerSubscriptionResult = socketClient.FuturesApi.SubscribeToTickerUpdatesAsync("ETH-USDT", (update) =>
{
var lastPrice = update.Data.LastPrice;
});
```

For information on the clients, dependency injection, response processing and more see the [documentation](https://cryptoexchange.jkorf.dev/client-libs/getting-started), or have a look at the examples [here](https://github.com/JKorf/BloFin.Net/tree/main/Examples) or [here](https://github.com/JKorf/CryptoExchange.Net/tree/master/Examples).

## CryptoExchange.Net
BloFin.Net is based on the [CryptoExchange.Net](https://github.com/JKorf/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](https://jkorf.github.io/CryptoExchange.Net#idocs_shared).

|Exchange|Repository|Nuget|
|--|--|--|
|Aster|[JKorf/Aster.Net](https://github.com/JKorf/Aster.Net)|[![Nuget version](https://img.shields.io/nuget/v/JKorf.Aster.net.svg?style=flat-square)](https://www.nuget.org/packages/JKorf.Aster.Net)|
|Binance|[JKorf/Binance.Net](https://github.com/JKorf/Binance.Net)|[![Nuget version](https://img.shields.io/nuget/v/Binance.net.svg?style=flat-square)](https://www.nuget.org/packages/Binance.Net)|
|BingX|[JKorf/BingX.Net](https://github.com/JKorf/BingX.Net)|[![Nuget version](https://img.shields.io/nuget/v/JK.BingX.net.svg?style=flat-square)](https://www.nuget.org/packages/JK.BingX.Net)|
|Bitfinex|[JKorf/Bitfinex.Net](https://github.com/JKorf/Bitfinex.Net)|[![Nuget version](https://img.shields.io/nuget/v/Bitfinex.net.svg?style=flat-square)](https://www.nuget.org/packages/Bitfinex.Net)|
|Bitget|[JKorf/Bitget.Net](https://github.com/JKorf/Bitget.Net)|[![Nuget version](https://img.shields.io/nuget/v/JK.Bitget.net.svg?style=flat-square)](https://www.nuget.org/packages/JK.Bitget.Net)|
|BitMart|[JKorf/BitMart.Net](https://github.com/JKorf/BitMart.Net)|[![Nuget version](https://img.shields.io/nuget/v/BitMart.net.svg?style=flat-square)](https://www.nuget.org/packages/BitMart.Net)|
|BitMEX|[JKorf/BitMEX.Net](https://github.com/JKorf/BitMEX.Net)|[![Nuget version](https://img.shields.io/nuget/v/JKorf.BitMEX.net.svg?style=flat-square)](https://www.nuget.org/packages/JKorf.BitMEX.Net)|
|Bitstamp|[JKorf/Bitstamp.Net](https://github.com/JKorf/Bitstamp.Net)|[![Nuget version](https://img.shields.io/nuget/v/Bitstamp.Net.svg?style=flat-square)](https://www.nuget.org/packages/Bitstamp.Net)|
|Bybit|[JKorf/Bybit.Net](https://github.com/JKorf/Bybit.Net)|[![Nuget version](https://img.shields.io/nuget/v/Bybit.net.svg?style=flat-square)](https://www.nuget.org/packages/Bybit.Net)|
|Coinbase|[JKorf/Coinbase.Net](https://github.com/JKorf/Coinbase.Net)|[![Nuget version](https://img.shields.io/nuget/v/JKorf.Coinbase.net.svg?style=flat-square)](https://www.nuget.org/packages/JKorf.Coinbase.Net)|
|CoinEx|[JKorf/CoinEx.Net](https://github.com/JKorf/CoinEx.Net)|[![Nuget version](https://img.shields.io/nuget/v/CoinEx.net.svg?style=flat-square)](https://www.nuget.org/packages/CoinEx.Net)|
|CoinGecko|[JKorf/CoinGecko.Net](https://github.com/JKorf/CoinGecko.Net)|[![Nuget version](https://img.shields.io/nuget/v/CoinGecko.net.svg?style=flat-square)](https://www.nuget.org/packages/CoinGecko.Net)|
|CoinW|[JKorf/CoinW.Net](https://github.com/JKorf/CoinW.Net)|[![Nuget version](https://img.shields.io/nuget/v/CoinW.net.svg?style=flat-square)](https://www.nuget.org/packages/CoinW.Net)|
|Crypto.com|[JKorf/CryptoCom.Net](https://github.com/JKorf/CryptoCom.Net)|[![Nuget version](https://img.shields.io/nuget/v/CryptoCom.net.svg?style=flat-square)](https://www.nuget.org/packages/CryptoCom.Net)|
|DeepCoin|[JKorf/DeepCoin.Net](https://github.com/JKorf/DeepCoin.Net)|[![Nuget version](https://img.shields.io/nuget/v/DeepCoin.net.svg?style=flat-square)](https://www.nuget.org/packages/DeepCoin.Net)|
|Gate.io|[JKorf/GateIo.Net](https://github.com/JKorf/GateIo.Net)|[![Nuget version](https://img.shields.io/nuget/v/GateIo.net.svg?style=flat-square)](https://www.nuget.org/packages/GateIo.Net)|
|HTX|[JKorf/HTX.Net](https://github.com/JKorf/HTX.Net)|[![Nuget version](https://img.shields.io/nuget/v/JKorf.HTX.net.svg?style=flat-square)](https://www.nuget.org/packages/Jkorf.HTX.Net)|
|HyperLiquid|[JKorf/HyperLiquid.Net](https://github.com/JKorf/HyperLiquid.Net)|[![Nuget version](https://img.shields.io/nuget/v/HyperLiquid.Net.svg?style=flat-square)](https://www.nuget.org/packages/HyperLiquid.Net)|
|Kraken|[JKorf/Kraken.Net](https://github.com/JKorf/Kraken.Net)|[![Nuget version](https://img.shields.io/nuget/v/KrakenExchange.net.svg?style=flat-square)](https://www.nuget.org/packages/KrakenExchange.Net)|
|Kucoin|[JKorf/Kucoin.Net](https://github.com/JKorf/Kucoin.Net)|[![Nuget version](https://img.shields.io/nuget/v/Kucoin.net.svg?style=flat-square)](https://www.nuget.org/packages/Kucoin.Net)|
|Mexc|[JKorf/Mexc.Net](https://github.com/JKorf/Mexc.Net)|[![Nuget version](https://img.shields.io/nuget/v/JK.Mexc.net.svg?style=flat-square)](https://www.nuget.org/packages/JK.Mexc.Net)|
|OKX|[JKorf/OKX.Net](https://github.com/JKorf/OKX.Net)|[![Nuget version](https://img.shields.io/nuget/v/JK.OKX.net.svg?style=flat-square)](https://www.nuget.org/packages/JK.OKX.Net)|
|Polymarket|[JKorf/Polymarket.Net](https://github.com/JKorf/Polymarket.Net)|[![Nuget version](https://img.shields.io/nuget/v/Polymarket.net.svg?style=flat-square)](https://www.nuget.org/packages/Polymarket.Net)|
|Toobit|[JKorf/Toobit.Net](https://github.com/JKorf/Toobit.Net)|[![Nuget version](https://img.shields.io/nuget/v/Toobit.net.svg?style=flat-square)](https://www.nuget.org/packages/Toobit.Net)|
|Upbit|[JKorf/Upbit.Net](https://github.com/JKorf/Upbit.Net)|[![Nuget version](https://img.shields.io/nuget/v/JKorf.Upbit.net.svg?style=flat-square)](https://www.nuget.org/packages/JKorf.Upbit.Net)|
|WhiteBit|[JKorf/WhiteBit.Net](https://github.com/JKorf/WhiteBit.Net)|[![Nuget version](https://img.shields.io/nuget/v/WhiteBit.net.svg?style=flat-square)](https://www.nuget.org/packages/WhiteBit.Net)|
|XT|[JKorf/XT.Net](https://github.com/JKorf/XT.Net)|[![Nuget version](https://img.shields.io/nuget/v/XT.net.svg?style=flat-square)](https://www.nuget.org/packages/XT.Net)|

When using multiple of these API's the [CryptoClients.Net](https://github.com/JKorf/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](https://img.shields.io/discord/847020490588422145?style=for-the-badge)](https://discord.gg/MSpeEtSY8t)
A Discord server is available [here](https://discord.gg/MSpeEtSY8t). For discussion and/or questions around the CryptoExchange.Net and implementation libraries, feel free to join.

## Supported functionality

### Spot
|API|Supported|Location|
|--|--:|--|
|Spot API not yet available|

### Futures REST
|API|Supported|Location|
|--|--:|--|
|Public Data|✓|`restClient.FuturesApi.ExchangeData`|
|Account|✓|`restClient.AccountApi`|
|Trading|✓|`restClient.FuturesApi.AccountApi`/`restClient.FuturesApi.TradingApi`|
|User|✓|`restClient.AccountApi`|
|Copy Trading|X||
|Affiliate|X||

### Futures WebSocket
|API|Supported|Location|
|--|--:|--|
|Public Data|✓|`socketClient.FuturesApi`|
|Trading|✓|`socketClient.FuturesApi`|
|Copy Trading|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](https://github.com/sponsors/JKorf).

## Release notes
* Version 2.10.1 - 24 Mar 2026
* Fix issue in credentials copying

* Version 2.10.0 - 24 Mar 2026
* Updated CryptoExchange.Net to version 11.0.1, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
* Updated class for supplying API credentials from ApiCredentials to BloFinCredentials
* Updated Shared order status parsing to default to Unknown value if not parsable
* Added restClient.FuturesApi.ExchangeData.GetPositionTiersAsync endpoint

* Notes for updating:
* Update ApiCredentials to BloFinCredentials for authentication, i.e. `ApiCredentials = new ApiCredentials(..)` => `ApiCredentials = new BloFinCredentials(..)`

* Version 2.9.0 - 09 Mar 2026
* Added restClient.FuturesApi.Trading.GetPositionHistoryAsync endpoint
* Added Shared IPositionHistoryRestClient implementation
* Updated xml comments to include json fields

* Version 2.8.0 - 06 Mar 2026
* Updated CryptoExchange.Net to version 10.8.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
* Improved method XML comments

* Version 2.7.0 - 24 Feb 2026
* Updated CryptoExchange.Net to version 10.7.0
* Added additional Http settings to client options
* Updated Shared REST interfaces pagination logic
* Updated HttpClient registration, fixing issue of DNS changes not getting processed
* Fixed UserClientProvider using unconfigured HttpClient
* Fixed restClient.FutuersApi.Trading.GetClosedOrdersAsync limit parameter serialization

* Version 2.6.0 - 16 Feb 2026
* Updated CryptoExchange.Net to version 10.6.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
* Fixed SymbolOrderBook websocket subscription not getting closed if when waiting for initial data times out

* Version 2.5.0 - 10 Feb 2026
* Updated CryptoExchange.Net to version 10.5.1, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
* Fixed websocket query topic mapping
* Updated UserClientProvider internal client cache to non-static to prevent cleanup issues

* Version 2.4.0 - 06 Feb 2026
* Updated CryptoExchange.Net to version 10.4.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
* Added BloFinUserFuturesDataTracker
* Added additional methods for requesting supported symbols to Shared IFuturesSymbolRestClient interfaces
* Added PositionMode mapping on SharedPosition models
* Added Status mapping for SharedDeposit models
* Fixed disposed clients getting returned from UserClientProvider
* Fixed issues in SubscribeToPositionUpdatesAsync, SubscribeToOrderUpdatesAsync and SubscribeToTriggerOrderUpdatesAsync update processing
* Fixed BloFinPosition deserialization issue

* Version 2.3.0 - 22 Jan 2026
* Updated CryptoExchange.Net to version 10.3.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
* Removed legacy websocket message handling and the corresponding UseUpdatedDeserialization client option
* Added Metadata to BloFinExchange

* Version 2.2.1 - 14 Jan 2026
* Updated CryptoExchange.Net to version 10.2.3, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes

* Version 2.2.0 - 13 Jan 2026
* Updated CryptoExchange.Net to version 10.2.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
* Added SequenceNumber to order book websocket updates
* Added timestamping to SymbolOrderBook implementation
* Updated SymbolOrderBook sequence checking

* Version 2.1.1 - 07 Jan 2026
* Disabled default enabled AutoTimestamp as it's not support by API

* Version 2.1.0 - 07 Jan 2026
* Updated CryptoExchange.Net version to 10.1.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
* Added DataTimeLocal and DataAge properties to DataEvent object
* Added UpdateServerTime, UpdateLocalTime and DataAge properties to (I)SymbolOrderBook

* Version 2.0.0 - 16 Dec 2025
* Added Net10.0 target framework
* Updated CryptoExchange.Net version to 10.0.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
* Improved performance across the board, biggest gains in websocket message processing
* Updated REST message response handling
* Updated WebSocket message handling
* Added UseUpdatedDeserialization socket client options to toggle by new and old message handling
* Added SocketIndividualSubscriptionCombineTarget socket client option
* Updated Shared API's subscription update types from ExchangeEvent to DataEvent
* Fixed exception in Shared GetFuturesTickersAsync endpoint when request fails

* Version 1.4.0 - 11 Nov 2025
* Updated CryptoExchange.Net version to 9.13.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
* Added restClient.FuturesApi.Trading.GetOrderAsync endpoint
* Added restClient.FuturesApi.Trading.GetTpSlOrderAsync endpoint

* Version 1.3.0 - 03 Nov 2025
* Updated CryptoExchange.Net to version 9.12.0
* Added support for using SharedSymbol.UsdOrStable in Shared APIs
* Fixed exception when initial trade snapshot has no items in TradeTracker
* Removed some unhelpful verbose logs

* Version 1.2.0 - 16 Oct 2025
* Updated CryptoExchange.Net version to 9.10.0, see https://github.com/JKorf/CryptoExchange.Net/releases/

* Version 1.1.0 - 30 Sep 2025
* Updated CryptoExchange.Net version to 9.8.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
* Added ITrackerFactory to TrackerFactory implementation
* Added missing Shared service registration for account endpoints

* Version 1.0.0 - 17 Sep 2025
* Initial release