Jkorf.Aster.Net 5.0.0

Aster.Net

Aster.Net is a client library for accessing the Aster DEX 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 clients based on the CryptoExchange.Net base library
• Native AOT support

Documentation

The Aster.Net documentation is the main resource for installing, configuring, and using the library.

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.

Install the library

NuGet

dotnet add package JKorf.Aster.Net

GitHub packages

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

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/USDT ticker via rest request
var restClient = new AsterRestClient();
var tickerResult = await restClient.SpotV3Api.ExchangeData.GetTickerAsync("ETHUSDT");
var lastPrice = tickerResult.Data.LastPrice;	

Place order:

var restClient = new AsterRestClient(opts => {
    opts.ApiCredentials = new AsterCredentials(
        new AsterV3Credential(
            EthKey.FromPrivateKey("PRIVATEKEY"), EthKey.FromPrivateKey("SIGNERPRIVATEKEY")));
});

// Place Limit order to go long for 0.1 ETH at 2000
var orderResult = await asterRestClient.FuturesV3Api.Trading.PlaceOrderAsync(
	"ETHUSDT",
	OrderSide.Buy,
	OrderType.Limit,
	0.1m,
	2000,
	positionSide: PositionSide.Long);

WebSocket subscription:

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

For more examples and explanations, continue with the Aster.Net documentation or browse the compilable repository examples.

NOTE
Aster.Net uses the Builder Code mechanism for Aster when using the V3 API, which means that an additional 1bps / 0.01% fee is charged on top of orders placed with the library to fund development. This is entirely optional and can be disabled in the client options by setting BuilderFeePercentage to 0 or null in the client options.

Shared / unified API

The CryptoExchange.Net Shared API V2 provides exchange-agnostic interfaces and models for common operations such as retrieving tickers, order books and balances, placing orders, and subscribing to market updates.

V2 uses a strict interface per capability. The SharedApi property on each API surface therefore exposes only the operations or subscriptions that surface actually supports. IAsterSharedApiClient groups the exchange's Shared API surfaces for dependency injection and runtime capability lookup.

Access a strict capability

using Aster.Net.Clients;
using CryptoExchange.Net.SharedApis;

using var restClient = new AsterRestClient();
IGetTickerRest tickerClient = restClient.SpotV3Api.SharedApi;

var symbol = new SharedSymbol(TradingMode.Spot, "ETH", "USDT");
var result = await tickerClient.GetTickerAsync(
    new GetTickerRequest(symbol));

if (!result.Success)
{
    Console.WriteLine(result.Error);
    return;
}

Console.WriteLine(result.Data.LastPrice);

The request and response models belong to CryptoExchange.Net.SharedApis, so the same operation can accept another exchange's IGetTickerRest implementation. When using dependency injection, inject IAsterSharedApiClient to access all of the exchange's Shared API surfaces or inject a capability such as IGetTickerRest directly. Use GetCapability on the aggregate when the operation, transport, or trading mode is selected at runtime.

AI documentation

For AI coding assistants and quick onboarding:

• AGENTS.md skill-style instructions for Aster.Net usage
• llms.txt provides concise AI context
• llms-full.txt provides detailed patterns, pitfalls and endpoint routing
• docs/ai-api-map.md maps common intents to V3 client members
• Examples/ai-friendly contains compact examples that are compiled by the test suite

See cryptoexchange-skills-hub for installable skills.

Authentication

API credentials can be provided via the AsterV3Credential on the AsterCredentials object.
There are 2 ways to provide credentials for the V3 API:

1. Use the private key of your wallet connected to Aster and the signer wallet private key. The signer wallet has to be registered in the UI or via restClient.FuturesApi.Account.CreateOrApproveAgentAsync (futures only). This gives access to all endpoints.

var credentials = new AsterCredentials(new AsterV3Credential(EthKey.FromPrivateKey("PRIVATEKEY"), EthKey.FromPrivateKey("SIGNERPRIVATEKEY")));
var client = new AsterRestClient(opts => { opts.ApiCredentials = credentials; });
var result = await client.FuturesV3Api.Account.GetBalancesAsync();

2. Use the public address of your wallet connected to Aster and the private signer key . This gives access to most but not all endpoints.

var credentials = new AsterCredentials(new AsterV3Credential(EthKey.FromPublicAddress("PUBLICADDRESS"), EthKey.FromPrivateKey("SIGNERPRIVATEKEY")));
var client = new AsterRestClient(opts => { opts.ApiCredentials = credentials; });
var result = await client.FuturesV3Api.Account.GetBalancesAsync();

CryptoExchange.Net

Aster.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 provides shared access to different exchange APIs.

Exchange	Repository	Nuget
Binance	JKorf/Binance.Net
BingX	JKorf/BingX.Net
Bitfinex	JKorf/Bitfinex.Net
Bitget	JKorf/Bitget.Net
Bitstamp	JKorf/Bitstamp.Net
Bitunix	JKorf/Bitunix.Net
BloFin	JKorf/BloFin.Net
Bybit	JKorf/Bybit.Net
Coinbase	JKorf/Coinbase.Net
CoinGecko	JKorf/CoinGecko.Net
CoinW	JKorf/CoinW.Net
Crypto.com	JKorf/CryptoCom.Net
DeepCoin	JKorf/DeepCoin.Net
Gate.io	JKorf/GateIo.Net
HTX	JKorf/HTX.Net
HyperLiquid	JKorf/HyperLiquid.Net
Kraken	JKorf/Kraken.Net
Kucoin	JKorf/Kucoin.Net
LBank	JKorf/LBank.Net
Lighter	JKorf/Lighter.Net
Mexc	JKorf/Mexc.Net
OKX	JKorf/OKX.Net
Pionex	JKorf/Pionex.Net
Polymarket	JKorf/Polymarket.Net
Tapbit	JKorf/Tapbit.Net
Toobit	JKorf/Toobit.Net
Upbit	JKorf/Upbit.Net
Weex	JKorf/Weex.Net
WhiteBit	JKorf/WhiteBit.Net
XT	JKorf/XT.Net

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

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

Supported functionality

Spot V3 REST

Spot V3 WebSocket

Futures V3 REST

Futures V3 WebSocket

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 in a different currency or network send me a message.

USDT (TRX) TKigKeJPXZYyMVDgMyXxMf17MWYia92Rjd

Sponsor

Alternatively, sponsor me on Github using Github Sponsors.

Release notes

• Version 5.0.0 - 06 Nov 2026

  • Updated CryptoExchange.Net to v13.2.3
  • Added CryptoExchange.Net.Web3 dependency
  • Updated AsterCredentials to use EthKey instead of separate public/private key strings
    • EthKey passing: new AsterV3Credential(EthKey.FromPrivateKey("<wallet PK>"), EthKey.FromPrivateKey("<signer PK>"))
  • Removed SpotApi and FuturesApi (V1) from the library
  • Added Builder logic for Spot API
  • Added restClient.SpotV3Api.Account.ApproveBuilderAsync, UpdateBuilderAsync, DeleteBuilderAsync and GetApprovedBuildersAsync endpoints
  • Added Type to AsterAsset model
  • Updated SymbolOrderBook implementations to use V3 instead of V1 API
  • Updated Tracker implementations to use V3 instead of V1 API
  • Updated Builder registration check

• Version 4.6.0 - 30 Sep 2026

  • Updated CryptoExchange.Net to V13.1.0

• Version 4.5.0 - 24 Sep 2026

  • Updated CryptoExchange.Net to v13.0.0
  • Shared APIs
    • Added SharedApi V2 support
    • Added .SharedApi property to clients
    • Added (I)AsterSharedApiClient containing all V2 SharedApi references
    • Added SharedApi to AsterOptions to provide SharedApi related options
    • See https://cryptoexchange.jkorf.dev/docs/shared-api?sharedApiVersion=v2 for more info about the V2 update and https://github.com/JKorf/CryptoExchange.Net/blob/master/docs/SHARED_API_V2_MIGRATION.md for migrating from V1
    • SharedApi V1 will still be supported
  • Rate limiting
    • Added rate limit admission callback to client options to allow rate limit admission ruling on request definition
    • Added WithRateLimitAdmissionAsync to client to allow rate limit admission ruling on a specific request
    • Update rate limit safety margin logic
    • Fixed some rate limit calculation issues
  • Request coalescing
    • Sending identical public GET requests on the same client at the same time will only send a single request to the server and use the same response
    • Coalescing is enabled by default and can be disabled with the RequestCoalescingEnabled client option

• Version 4.4.0 - 21 Aug 2026

  • Updated to CryptoExchange.Net v12.5.0
  • Added LowerPriceLimitPercentage, UpperPriceLimitPercentage to SharedFuturesSymbol
  • Added LowerPriceLimitPercentage, UpperPriceLimitPercentage to SharedSpotSymbol

• Version 4.3.1 - 12 Aug 2026

  • Fixed builder code logic for multi-user

• Version 4.3.0 - 29 Jul 2026

  • Updated CryptoExchange.Net to version 12.4.0
  • Added calculation of AveragePrice on Shared order models if data is available and AveragePrice is not set
  • Added DebuggerDisplay attributes to Result models
  • Added AveragePrice property to SharedQuantity model
  • Updated SharedFuturesTicker, SharedSpotTicker, SharedTrade and SharedKline to use SharedOrderQuantity for volumes/quantities

• Version 4.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

• Version 4.1.1 - 13 Jul 2026

  • Fixed exception during authentication when retrying requests

• Version 4.1.0 - 09 Jul 2026

  • Updated CryptoExchange.Net to v12.1.0Added strategy order endpoints
  • Added Pending order status
  • Added MarginType.Cross value mapping
  • Fixed some ChaseOrder endpoint issues

• Version 4.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
    • 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
    • Removed IListenKey support, listen keys now rely on internal management
  • Added user subscription overloads without listenkey which manages the listen key internally
  • 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 setter to AsterExchange.RateLimiter to allow custom rate limit settings
  • Updated FuturesV3 EditOrderAsync parameters to non-nullable
  • Various small performance improvements
  • Fixed websocket connection attempts counting towards rate limit even when server could not be reached