Skip to content

Repository files navigation

.Kraken.Net Kraken.Net

.NET License Since

Kraken.Net is a strongly typed client library for accessing the Kraken 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
  • 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 Nuget downloads

dotnet add package KrakenExchange.Net

GitHub packages

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

Basic request:

// Get the ETH/USD ticker via rest request
var restClient = new KrakenRestClient();
var tickerResult = await restClient.SpotApi.ExchangeData.GetTickerAsync("ETHUSD");
var lastPrice = tickerResult.Data.First().Value.LastTrade.Price;

Place order:

var restClient = new KrakenRestClient(opts => {
	opts.ApiCredentials = new KrakenCredentials(
		new HMACCredential("SPOTKEY", "SPOTSECRET"),
		new HMACCredential("FUTURESKEY", "FUTURESSECRET")
	);
});

// Place Limit order to go long for 0.1 ETH at 2000
var orderResult = await restClient.FuturesApi.Trading.PlaceOrderAsync(
    "PF_ETHUSD",
    OrderSide.Buy,
    FuturesOrderType.Limit,
    0.1m,
    2000
    );

WebSocket subscription:

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

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

AI / LLM documentation

Kraken.Net includes AI-oriented documentation and examples for code generation tools:

File Purpose
AGENTS.md Assistant skill with core Kraken.Net patterns, pitfalls, and examples
llms.txt Short LLM index with links to docs, examples, and critical usage rules
llms-full.txt Detailed LLM context with endpoint routing, code patterns, and anti-hallucination checks
docs/ai-api-map.md Table-style intent-to-method map for Spot, Futures, WebSocket, Earn, and SharedApis
Examples/ai-friendly Compilable single-file examples for common REST, WebSocket, shared API, and error handling workflows

See cryptoexchange-skills-hub for installable skills.

CryptoExchange.Net

Kraken.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
Aster JKorf/Aster.Net Nuget version
Binance JKorf/Binance.Net Nuget version
BingX JKorf/BingX.Net Nuget version
Kraken JKorf/Kraken.Net Nuget version
Bitget JKorf/Bitget.Net Nuget version
BitMart JKorf/BitMart.Net Nuget version
BitMEX JKorf/BitMEX.Net Nuget version
Bitstamp JKorf/Bitstamp.Net Nuget version
BloFin JKorf/BloFin.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
CoinW JKorf/CoinW.Net Nuget version
Crypto.com JKorf/CryptoCom.Net Nuget version
DeepCoin JKorf/DeepCoin.Net Nuget version
Gate.io JKorf/GateIo.Net Nuget version
HTX JKorf/HTX.Net Nuget version
HyperLiquid JKorf/HyperLiquid.Net Nuget version
Kucoin JKorf/Kucoin.Net Nuget version
Lighter JKorf/Lighter.Net Nuget version
Mexc JKorf/Mexc.Net Nuget version
OKX JKorf/OKX.Net Nuget version
Pionex JKorf/Pionex.Net Nuget version
Polymarket JKorf/Polymarket.Net Nuget version
Toobit JKorf/Toobit.Net Nuget version
Upbit JKorf/Upbit.Net Nuget version
Weex JKorf/Weex.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

Spot REST

API Supported Location
Market Data restClient.SpotApi.ExchangeData
Account Data restClient.SpotApi.Account / restClient.SpotApi.Trading
Trading restClient.SpotApi.Trading
Funding restClient.SpotApi.Account
Subaccounts X
Earn restClient.SpotApi.Earn
NFT Market Data X
NFT Trading X

Spot Api Websocket V2

API Supported Location
User Trading socketClient.SpotApi
User Data socketClient.SpotApi
Market Data socketClient.SpotApi
Admin socketClient.SpotApi

Spot FIX

API Supported Location
* X

Futures REST

API Supported Location
Trading Market Data restClient.FuturesApi.ExchangeData
Trading Instrument Details restClient.FuturesApi.ExchangeData
Trading Fee Schedules restClient.FuturesApi.ExchangeData
Trading Account Info restClient.FuturesApi.Account / restClient.FuturesApi.Trading
Trading Order Management restClient.FuturesApi.Trading
Subaccounts X
Transfers restClient.FuturesApi.Account
Assignment Program X
Multi-Collateral restClient.FuturesApi.Account / restClient.FuturesApi.Trading
General restClient.FuturesApi.ExchangeData
Historical data restClient.FuturesApi.Trading
Historical Funding Rates restClient.FuturesApi.ExchangeData
History Account History restClient.FuturesApi.Account / restClient.FuturesApi.Trading
History Market History restClient.FuturesApi.ExchangeData
Charts Candles restClient.FuturesApi.ExchangeData
Charts Analytics X

Futures Websocket

API Supported Location
Trading Market Data restClient.FuturesApi.ExchangeData
User Data socketClient.FuturesApi
Market Data socketClient.FuturesApi
Admin 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 8.2.0 - 21 Jul 2026

    • Updated CryptoExchange.Net to v12.2.0
    • Added SpotSymbolCatalog to Shared ISpotSymbolRestClient interface
    • Added FuturesSymbolCatalog to Shared IFuturesSymbolRestClient interface
    • Added BaseAssetType, BaseAssetSubType, QuoteAssetType and QuoteAssetSubType to GetSymbolsRequest model
    • Added DisplayName to SharedSpotSymbol and SharedFuturesSymbol models
    • Added BaseAssetType, BaseAssetSubType, QuoteAssetType and QuoteAssetSubType to SharedSpotSymbol and SharedFuturesSymbol models
    • Added DebuggerDisplay attributes to Shared models
    • Fixed restClient.FuturesApi.Trading.GetOrderAsync exception if not order returned
  • Version 8.1.1 - 13 Jul 2026

    • Fixed exception during authentication when retrying requests
  • Version 8.1.0 - 09 Jul 2026

    • Updated CryptoExchange.Net to v12.1.0
    • Added MethodId, NetworkId, Fee to KrakenWithdrawMethod model
    • Added TradeOrderType, AssetClass, Leverage and TradeId to KrakenUserTrade
    • Added AssetClass, Inputs to KrakenTradeVolume model
    • Added MarginFreeForOrders,UnexecutedValue to KrakenTradeBalance model
    • Added TimeInForce to KrakenOrder model, added AssetClass to KrakenOrderInfo model
    • Added MarginRate to KrakenAssetInfo model
    • Added OpenPrice, HighPrice, LowPrice to KrakenFuturesTickerUpdate model
    • Added HighPrice and LowPrice mapping to Shared Futures SubscribeToTickerUpdatesAsync events
    • Added QuantityRemaining property to KrakenFuturesUserTradesUpdate model
    • Updated KrakenFuturesSnapshotOpenOrders.Reason to enum
    • Updated TimeInForce mapping
    • Updated SpotApi.Account.GetTradeVolumeAsync endpoint
    • Updated futures GetFeesAsync implementation
    • Fixed OrderId not set on Shared Futures SubscribeToFuturesOrderUpdatesAsync updates
    • Fixed incorrect order status mapping Shared Futures SubscribeToFuturesOrderUpdatesAsync updates
    • Fixed Premium deserialization on KrakenFuturesTickerUpdate model
    • Fixed futures orders/user trades subscription missing updates
    • Removed deprecated FuturesApi GetFeeScheduleVolumeAsync, GetInitialMarginRequirementsAsync, GetFeeSchedulesAsync and GetMaxOrderQuantityAsync endpoints
  • Version 8.0.0 - 29 Jun 2026

    • Result types:
      • (Web)CallResult types are replaced by HttpResult, WebSocketResult and QueryResult with the same logic
      • WebSocketResult and QueryResult now return additional info for websocket operations
      • Updated result types to record type
      • Removed implicit result type conversion to bool, if (result) no longer works, instead use if (result.Success)
      • Fixed result object nullability hinting, for example Data might be null if Success isn't checked for true
    • Clients:
      • Added ToString overrides on base API types
      • Added Exchange property on BaseApiClient
      • Added ApiCredentials property on Api clients
      • Updated ILogger source from client name to topic specific client name
      • Removed logging from client creation
      • Fixed issue in SocketApiClient.GetSocketConnection causing requests to always wait the full max 10 seconds when there was a reconnecting socket
    • Shared APIs:
      • Added missing dedicated option types
      • Added Discover method on ISharedClient interface, returning info on supported capabilities and operations
      • Added ResetStaticExchangeParameters method on ExchangeParameters
      • Added Status property to SharedWithdrawal model
      • Added TradingModes property to SharedBalance model
      • Added REST Shared GetPositionsAsync UnrealizedPnl mapping
      • Updated Shared ExchangeParameters parameter names to be case insensitive
      • Updated code comments
      • Replaced ExchangeResult with ExchangeCallResult type
      • Removed TradingMode from the response model, only maintained on models where it makes sense
      • Fixed Shared REST GetFundingRateHistoryAsync not allowing time filtering
    • Added async streaming on UserDataTracker items with StreamUpdatesAsync
    • Added cancellation token support to UserDataTracker starting
    • Added SupportedEnvironments property to PlatformInfo
    • Added Clear() method on UserClientProvider to clear all cached clients
    • Added support for setting API credentials one by one for spot/futures
    • Added UnrealizedPnl to KrakenFuturesPosition model
    • Updated internal websocket token management
    • Various small performance improvements
    • Fixed websocket connection attempts counting towards rate limit even when server could not be reached
    • Fixed exception for credentials when accessing public api
    • Fixed socketClient.SpotApi.EditOrderAsync parameter serialization when not using orderId

Releases

Sponsor this project

Packages

Used by

Contributors

Languages