Use this file to route common user intents to the correct XT.Net client member. If a method name or parameter is not listed here, inspect XT.Net/Interfaces/Clients/** before generating code.
| Intent | Use |
|---|---|
| REST calls | new XTRestClient() |
| WebSocket streams | new XTSocketClient() |
| API key authentication | options.ApiCredentials = new XTCredentials("key", "secret") |
| Live environment | XTEnvironment.Live |
| Custom environment | XTEnvironment.CreateCustom(...) |
| Dependency injection | services.AddXT(options => { ... }) |
| Spot REST API | client.SpotApi |
| USDT-M Futures REST API | client.UsdtFuturesApi |
| Coin-M Futures REST API | client.CoinFuturesApi |
| Spot socket API | socketClient.SpotApi |
| Futures socket API | socketClient.FuturesApi |
Spot source examples use symbols like eth_usdt.
| User intent | XT.Net member |
|---|---|
| Get server time | client.SpotApi.ExchangeData.GetServerTimeAsync() |
| Get client IP | client.SpotApi.ExchangeData.GetClientIpAsync() |
| Get spot symbols | client.SpotApi.ExchangeData.GetSymbolsAsync() |
| Get info for one spot symbol | client.SpotApi.ExchangeData.GetSymbolsAsync(symbol: "eth_usdt") |
| Get spot order book | client.SpotApi.ExchangeData.GetOrderBookAsync("eth_usdt", limit: 100) |
| Get spot klines/candles | client.SpotApi.ExchangeData.GetKlinesAsync("eth_usdt", KlineInterval.OneMinute) |
| Get recent spot trades | client.SpotApi.ExchangeData.GetRecentTradesAsync("eth_usdt") |
| Get spot trade history | client.SpotApi.ExchangeData.GetTradeHistoryAsync("eth_usdt") |
| Get spot ticker | client.SpotApi.ExchangeData.GetTickersAsync("eth_usdt") |
| Get all spot tickers | client.SpotApi.ExchangeData.GetTickersAsync() |
| Get spot price ticker | client.SpotApi.ExchangeData.GetPriceTickersAsync("eth_usdt") |
| Get spot book ticker | client.SpotApi.ExchangeData.GetBookTickersAsync("eth_usdt") |
| Get 24h spot ticker | client.SpotApi.ExchangeData.Get24HTickersAsync("eth_usdt") |
| Get assets | client.SpotApi.ExchangeData.GetAssetsAsync() |
| Get asset network info | client.SpotApi.ExchangeData.GetAssetNetworksAsync() |
| Get one spot balance | client.SpotApi.Account.GetBalanceAsync("usdt") |
| Get spot balances | client.SpotApi.Account.GetBalancesAsync() |
| Get deposit address | client.SpotApi.Account.GetDepositAddressAsync(asset, network) |
| Get deposit history | client.SpotApi.Account.GetDepositHistoryAsync(asset, network) |
| Withdraw asset | client.SpotApi.Account.WithdrawAsync(asset, network, address, quantity) |
| Get withdrawal history | client.SpotApi.Account.GetWithdrawalHistoryAsync(asset, network) |
| Transfer between account types | client.SpotApi.Account.TransferAsync(asset, from, to, quantity, clientId) |
| Transfer to subaccount | client.SpotApi.Account.SubAccountTransferAsync(...) |
| Get spot private socket token | client.SpotApi.Account.GetWebsocketTokenAsync() |
| Place spot order | client.SpotApi.Trading.PlaceOrderAsync(...) |
| Query spot order by id | client.SpotApi.Trading.GetOrderAsync(orderId) |
| Query spot order by client id | client.SpotApi.Trading.GetOrderByClientOrderIdAsync(clientOrderId) |
| Cancel spot order | client.SpotApi.Trading.CancelOrderAsync(orderId) |
| Get open spot orders | client.SpotApi.Trading.GetOpenOrdersAsync(...) |
| Get closed spot orders | client.SpotApi.Trading.GetClosedOrdersAsync(...) |
| Cancel all spot orders | client.SpotApi.Trading.CancelAllOrdersAsync(BusinessType.Spot, symbol: "eth_usdt") |
| Edit spot order | client.SpotApi.Trading.EditOrderAsync(orderId, quantity, price) |
| Get multiple spot orders | client.SpotApi.Trading.GetOrdersAsync(orderIds) |
| Cancel multiple spot orders | client.SpotApi.Trading.CancelOrdersAsync(orderIds) |
| Get spot user trades | client.SpotApi.Trading.GetUserTradesAsync(...) |
Use CoinFuturesApi instead of UsdtFuturesApi for Coin-M futures. The futures REST interface shape is shared.
| User intent | XT.Net member |
|---|---|
| Get futures server time | client.UsdtFuturesApi.ExchangeData.GetServerTimeAsync() |
| Get futures client IP | client.UsdtFuturesApi.ExchangeData.GetClientIpAsync() |
| Get futures quote assets | client.UsdtFuturesApi.ExchangeData.GetSymbolAssetsAsync() |
| Get one futures symbol | client.UsdtFuturesApi.ExchangeData.GetSymbolAsync("ETH_USDT") |
| Get futures symbols | client.UsdtFuturesApi.ExchangeData.GetSymbolsAsync() |
| Get leverage bracket for symbol | client.UsdtFuturesApi.ExchangeData.GetLeverageBracketsAsync("ETH_USDT") |
| Get all leverage brackets | client.UsdtFuturesApi.ExchangeData.GetLeverageBracketsAsync() |
| Get futures ticker | client.UsdtFuturesApi.ExchangeData.GetTickerAsync("ETH_USDT") |
| Get all futures tickers | client.UsdtFuturesApi.ExchangeData.GetTickersAsync() |
| Get futures recent trades | client.UsdtFuturesApi.ExchangeData.GetRecentTradesAsync("ETH_USDT") |
| Get futures order book | client.UsdtFuturesApi.ExchangeData.GetOrderBookAsync("ETH_USDT") |
| Get index price | client.UsdtFuturesApi.ExchangeData.GetIndexPriceAsync("ETH_USDT") |
| Get all index prices | client.UsdtFuturesApi.ExchangeData.GetIndexPricesAsync() |
| Get mark price | client.UsdtFuturesApi.ExchangeData.GetMarkPriceAsync("ETH_USDT") |
| Get all mark prices | client.UsdtFuturesApi.ExchangeData.GetMarkPricesAsync() |
| Get futures klines | client.UsdtFuturesApi.ExchangeData.GetKlinesAsync("ETH_USDT", FuturesKlineInterval.OneMinute) |
| Get futures market info | client.UsdtFuturesApi.ExchangeData.GetMarketInfoAsync("ETH_USDT") |
| Get all futures market info | client.UsdtFuturesApi.ExchangeData.GetMarketInfosAsync() |
| Get funding rate | client.UsdtFuturesApi.ExchangeData.GetFundingRateAsync("ETH_USDT") |
| Get futures book ticker | client.UsdtFuturesApi.ExchangeData.GetBookTickerAsync("ETH_USDT") |
| Get all futures book tickers | client.UsdtFuturesApi.ExchangeData.GetBookTickersAsync() |
| Get funding rate history | client.UsdtFuturesApi.ExchangeData.GetFundingRateHistoryAsync("ETH_USDT") |
| Get risk balance | client.UsdtFuturesApi.ExchangeData.GetRiskBalanceAsync("ETH_USDT") |
| Get open interest | client.UsdtFuturesApi.ExchangeData.GetOpenInterestAsync("ETH_USDT") |
| Get futures symbol info | client.UsdtFuturesApi.ExchangeData.GetSymbolInfoAsync() |
| Get futures balances | client.UsdtFuturesApi.Account.GetBalancesAsync() |
| Get futures account info | client.UsdtFuturesApi.Account.GetAccountInfoAsync() |
| Get futures user asset | client.UsdtFuturesApi.Account.GetUserAssetAsync("USDT") |
| Get futures user assets | client.UsdtFuturesApi.Account.GetUserAssetsAsync() |
| Get futures account bills | client.UsdtFuturesApi.Account.GetAccountBillsAsync() |
| Get funding fee history | client.UsdtFuturesApi.Account.GetFundingFeeHistoryAsync() |
| Get futures fee rate | client.UsdtFuturesApi.Account.GetFeeRateAsync() |
| Set leverage | client.UsdtFuturesApi.Account.SetLeverageAsync("ETH_USDT", PositionSide.Long, 5) |
| Adjust margin | client.UsdtFuturesApi.Account.AdjustMarginAsync(...) |
| Get ADL info | client.UsdtFuturesApi.Account.GetAdlInfoAsync() |
| Set position type | client.UsdtFuturesApi.Account.SetPositionTypeAsync(...) |
| Get futures private socket listen key | client.UsdtFuturesApi.Account.GetListenKeyAsync() |
| Place futures order | client.UsdtFuturesApi.Trading.PlaceOrderAsync(...) |
| Place multiple futures orders | client.UsdtFuturesApi.Trading.PlaceMultipleOrdersAsync(orders) |
| Edit futures order | client.UsdtFuturesApi.Trading.EditOrderAsync(...) |
| Get closed futures orders | client.UsdtFuturesApi.Trading.GetClosedOrdersAsync(...) |
| Get futures user trades | client.UsdtFuturesApi.Trading.GetUserTradesAsync(...) |
| Query futures order | client.UsdtFuturesApi.Trading.GetOrderAsync(orderId) |
| Get futures orders | client.UsdtFuturesApi.Trading.GetOrdersAsync(...) |
| Cancel futures order | client.UsdtFuturesApi.Trading.CancelOrderAsync(orderId) |
| Cancel all futures orders | client.UsdtFuturesApi.Trading.CancelAllOrdersAsync("ETH_USDT") |
| Get open futures positions | client.UsdtFuturesApi.Trading.GetPositionsAsync("ETH_USDT") |
| Get futures position info | client.UsdtFuturesApi.Trading.GetPositionsInfoAsync("ETH_USDT") |
| Close all positions | client.UsdtFuturesApi.Trading.CloseAllPositionsAsync() |
| Get margin call info | client.UsdtFuturesApi.Trading.GetMarginCallInfoAsync("ETH_USDT") |
| Place trigger order | client.UsdtFuturesApi.Trading.PlaceTriggerOrderAsync(...) |
| Cancel trigger order | client.UsdtFuturesApi.Trading.CancelTriggerOrderAsync(orderId) |
| Cancel all trigger orders | client.UsdtFuturesApi.Trading.CancelAllTriggerOrdersAsync("ETH_USDT") |
| Get trigger orders | client.UsdtFuturesApi.Trading.GetTriggerOrdersAsync(...) |
| Get trigger order | client.UsdtFuturesApi.Trading.GetTriggerOrderAsync(orderId) |
| Get closed trigger orders | client.UsdtFuturesApi.Trading.GetClosedTriggerOrdersAsync(...) |
| Place stop-limit order | client.UsdtFuturesApi.Trading.PlaceStopLimitOrderAsync(...) |
| Cancel stop-limit order | client.UsdtFuturesApi.Trading.CancelStopLimitOrderAsync(orderId) |
| Get stop-limit orders | client.UsdtFuturesApi.Trading.GetStopLimitOrdersAsync(...) |
| Place track order | client.UsdtFuturesApi.Trading.PlaceTrackOrderAsync(...) |
| Cancel track order | client.UsdtFuturesApi.Trading.CancelTrackOrderAsync(orderId) |
| Get track order | client.UsdtFuturesApi.Trading.GetTrackOrderAsync(orderId) |
| Get open track orders | client.UsdtFuturesApi.Trading.GetOpenTrackOrdersAsync(...) |
| Get closed track orders | client.UsdtFuturesApi.Trading.GetClosedTrackOrdersAsync(...) |
| User intent | XT.Net member |
|---|---|
| Coin-M futures market data | client.CoinFuturesApi.ExchangeData.* |
| Coin-M futures account calls | client.CoinFuturesApi.Account.* |
| Coin-M futures trading calls | client.CoinFuturesApi.Trading.* |
| Coin-M shared REST client | client.CoinFuturesApi.SharedClient |
| User intent | XT.Net member |
|---|---|
| Subscribe spot trade updates | socketClient.SpotApi.SubscribeToTradeUpdatesAsync("eth_usdt", handler) |
| Subscribe many spot trade updates | socketClient.SpotApi.SubscribeToTradeUpdatesAsync(symbols, handler) |
| Subscribe spot kline updates | socketClient.SpotApi.SubscribeToKlineUpdatesAsync("eth_usdt", KlineInterval.OneMinute, handler) |
| Subscribe spot order book updates | socketClient.SpotApi.SubscribeToOrderBookUpdatesAsync("eth_usdt", depth, handler) |
| Subscribe spot incremental order book updates | socketClient.SpotApi.SubscribeToIncrementalOrderBookUpdatesAsync("eth_usdt", handler) |
| Subscribe spot ticker updates | socketClient.SpotApi.SubscribeToTickerUpdatesAsync("eth_usdt", handler) |
| Subscribe spot balance updates | socketClient.SpotApi.SubscribeToBalanceUpdatesAsync(token, handler) |
| Subscribe spot order updates | socketClient.SpotApi.SubscribeToOrderUpdatesAsync(token, handler) |
| Subscribe spot user trade updates | socketClient.SpotApi.SubscribeToUserTradeUpdatesAsync(token, handler) |
Private spot streams require token = await restClient.SpotApi.Account.GetWebsocketTokenAsync().
| User intent | XT.Net member |
|---|---|
| Subscribe futures trades | socketClient.FuturesApi.SubscribeToTradeUpdatesAsync("ETH_USDT", handler) |
| Subscribe futures klines | socketClient.FuturesApi.SubscribeToKlineUpdatesAsync("ETH_USDT", KlineInterval.OneMinute, handler) |
| Subscribe futures ticker | socketClient.FuturesApi.SubscribeToTickerUpdatesAsync("ETH_USDT", handler) |
| Subscribe futures aggregated ticker | socketClient.FuturesApi.SubscribeToAggregatedTickerUpdatesAsync("ETH_USDT", handler) |
| Subscribe futures index price | socketClient.FuturesApi.SubscribeToIndexPriceUpdatesAsync("ETH_USDT", handler) |
| Subscribe futures mark price | socketClient.FuturesApi.SubscribeToMarkPriceUpdatesAsync("ETH_USDT", handler) |
| Subscribe futures incremental order book | socketClient.FuturesApi.SubscribeToIncrementalOrderBookUpdatesAsync("ETH_USDT", updateInterval, handler) |
| Subscribe futures order book | socketClient.FuturesApi.SubscribeToOrderBookUpdatesAsync("ETH_USDT", depth, updateInterval, handler) |
| Subscribe futures funding rate | socketClient.FuturesApi.SubscribeToFundingRateUpdatesAsync("ETH_USDT", handler) |
| Subscribe futures balance updates | socketClient.FuturesApi.SubscribeToBalancesUpdatesAsync(listenKey, handler) |
| Subscribe futures position updates | socketClient.FuturesApi.SubscribeToPositionUpdatesAsync(listenKey, handler) |
| Subscribe futures order updates | socketClient.FuturesApi.SubscribeToOrderUpdatesAsync(listenKey, handler) |
| Subscribe futures user trade updates | socketClient.FuturesApi.SubscribeToUserTradeUpdatesAsync(listenKey, handler) |
| Subscribe futures notification updates | socketClient.FuturesApi.SubscribeToNotificationUpdatesAsync(listenKey, handler) |
Private futures streams require listenKey = await restClient.UsdtFuturesApi.Account.GetListenKeyAsync().
| User intent | XT.Net member or interface |
|---|---|
| Shared spot REST client | new XTRestClient().SpotApi.SharedClient |
| Shared USDT-M futures REST client | new XTRestClient().UsdtFuturesApi.SharedClient |
| Shared Coin-M futures REST client | new XTRestClient().CoinFuturesApi.SharedClient |
| Shared spot socket client | new XTSocketClient().SpotApi.SharedClient |
| Shared futures socket client | new XTSocketClient().FuturesApi.SharedClient |
| Get shared spot symbols and populate the catalog | ISpotSymbolRestClient.GetSpotSymbolsAsync(new GetSymbolsRequest(...)), then ISpotSymbolRestClient.SpotSymbolCatalog |
| Get shared futures symbols and populate the catalog | IFuturesSymbolRestClient.GetFuturesSymbolsAsync(new GetSymbolsRequest(...)), then IFuturesSymbolRestClient.FuturesSymbolCatalog |
| Shared spot ticker REST | ISpotTickerRestClient.GetSpotTickerAsync(new GetTickerRequest(symbol)) |
| Shared spot order REST | ISpotOrderRestClient.PlaceSpotOrderAsync(...) |
| Shared futures ticker REST | IFuturesTickerRestClient.GetFuturesTickerAsync(...) |
| Shared futures order REST | IFuturesOrderRestClient.PlaceFuturesOrderAsync(...) |
| Shared ticker socket | ITickerSocketClient.SubscribeToTickerUpdatesAsync(...) |
| Shared order book socket | IOrderBookSocketClient.SubscribeToOrderBookUpdatesAsync(...) |
| Discover shared capabilities | client.SpotApi.SharedClient.Discover() or the equivalent futures/socket SharedClient root |
Shared spot and futures symbol results include DisplayName and shared asset type/subtype metadata. XT tags are mapped to crypto, stablecoin, equity, and commodity classifications where available.
For shared socket subscriptions, keep the concrete XTSocketClient and unsubscribe with await socketClient.UnsubscribeAsync(subscription.Data).
| Situation | Pattern |
|---|---|
| REST success check | Direct and shared REST methods return HttpResult<T> / HttpResult |
| Socket subscription success check | Direct and shared subscriptions return WebSocketResult<UpdateSubscription> |
| Generic success check | if (!result.Success) { Console.WriteLine(result.Error); return; } |
| Read result data | Read result.Data only after result.Success |
| Retry decision | Retry only when result.Error?.IsTransient == true |
| Cancellation | Pass ct: cancellationToken |
| Do not use | Use instead |
|---|---|
Raw HttpClient |
XTRestClient / XTSocketClient |
ApiCredentials |
XTCredentials |
XTClient |
XTRestClient / XTSocketClient |
socketClient.UsdtFuturesApi |
socketClient.FuturesApi |
socketClient.CoinFuturesApi |
socketClient.FuturesApi |
SpotApi.Margin |
SpotApi.Account / SpotApi.Trading with BusinessType.Leverage where supported |
.Data without .Success check |
Check .Success first |
| Private spot stream without token | SpotApi.Account.GetWebsocketTokenAsync() then subscribe |
| Private futures stream without listen key | UsdtFuturesApi.Account.GetListenKeyAsync() then subscribe |
| Inventing testnet environment | XTEnvironment.Live or XTEnvironment.CreateCustom(...) |