# Functions
NewClient initialize an API client instance with API key and secret key.
No description provided by the author
No description provided by the author
WithHeader set or add a header value to the request.
WithHeaders set or replace the headers of the request.
WithRecvWindow set recvWindow param for the request.
WsAggTradeServe serve websocket that push trade information that is aggregated for a single taker order.
WsAllBookTickerServe serve websocket that pushes updates to the best bid or ask price or quantity in real-time for all symbols.
WsAllLiquidationOrderServe serve websocket that pushes force liquidation order information for all symbols.
WsAllMarketTickerServe serve websocket that pushes price and funding rate for all markets.
WsAllMiniMarketTickerServe serve websocket that pushes price and funding rate for all markets.
WsBookTickerServe serve websocket that pushes updates to the best bid or ask price or quantity in real-time for a specified symbol.
WsContinuousKlineServe serve websocket kline handler with a pair, a contract type and interval like 15m, 30s.
WsDiffDepthServe serve websocket diff.
WsDiffDepthServe serve websocket diff.
WsIndexPriceKlineServe serve websocket kline handler with a pair and interval like 15m, 30s.
WsIndexPriceServe serve websocket that pushes index price for a pair.
WsKlineServe serve websocket kline handler with a symbol and interval like 15m, 30s.
WsLiquidationOrderServe serve websocket that pushes force liquidation order information for specific symbol.
WsMarketTickerServe serve websocket that pushes 24hr rolling window mini-ticker statistics for a single symbol.
WsMarkPriceKlineServe serve websocket kline handler with a symbol and interval like 15m, 30s.
WsMarkPriceServe serve websocket that pushes price and funding rate for a single symbol.
WsMiniMarketTickerServe serve websocket that pushes 24hr rolling window mini-ticker statistics for a single symbol.
WsPairMarkPriceServe serve websocket that pushes price and funding rate for all symbol.
WsPartialDepthServe serve websocket partial depth handler.
WsPartialDepthServeWithRate serve websocket partial depth handler with rate.
WsUserDataServe serve user data handler with listen key.
# Constants
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Fill or Kill.
Good Till Cancel.
Good Till Crossing (Post Only).
Immediate or Cancel.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
Global enums.
# Variables
No description provided by the author
UseTestnet switch all the WS streams from production to the testnet.
WebsocketKeepalive enables sending ping/pong messages to check the connection stability.
WebsocketTimeout is an interval for sending ping/pong messages if WebsocketKeepalive is enabled.
# Structs
Account define account info.
AccountAsset define account asset.
AccountPosition define account position.
Balance define user balance of your account.
BookTicker define book ticker info.
CancelAllOpenOrdersService cancel all open orders.
CancelOrderResponse define response of canceling order.
CancelOrderService cancel an order.
ChangeLeverageService change user's initial leverage of specific symbol market.
ChangeMarginTypeService change user's margin type of specific symbol market.
ChangePositionModeService change user's position mode.
Client define API client.
CloseUserStreamService delete listen key.
CreateOrderResponse define create order response.
CreateOrderService create order.
ExchangeInfo exchange info.
ExchangeInfoService exchange info service.
No description provided by the author
GetAccountService get account info.
GetBalanceService get account balance.
No description provided by the author
GetOrderService get an order.
GetPositionModeService get user's position mode.
GetPositionRiskService get account balance.
KeepaliveUserStreamService update listen key.
Kline define kline info.
KlinesService list klines.
LiquidationOrder define liquidation order.
ListBookTickersService list best price/qty on the order book for a symbol or symbols.
ListLiquidationOrdersService list liquidation orders.
ListOpenOrdersService list opened orders.
ListOrdersService all account orders; active, canceled, or filled.
ListPriceChangeStatsService show stats of price change in last 24 hours for single symbol, all symbols or pairs of symbols.
ListPricesService list latest price for a symbol or symbols.
LotSizeFilter define lot size filter of symbol.
MarketLotSizeFilter define market lot size filter of symbol.
MaxNumAlgoOrdersFilter define max num orders filter of symbol of algo.
MaxNumOrdersFilter define max num orders filter of symbol.
Order define order info.
PercentPriceFilter define percent price filter of symbol.
PingService ping server.
Response of user's position mode.
PositionRisk define position risk info.
PriceChangeStats define price change stats.
PriceFilter define price filter of symbol.
RateLimit struct.
ServerTimeService get server time.
SetServerTimeService set server time.
StartUserStreamService create listen key for user stream service.
Symbol market symbol.
SymbolLeverage define leverage info of symbol.
SymbolPrice define symbol, price and pair.
UpdatePositionMarginService update isolated position margin.
WsAccountConfigUpdate define account config update.
WsAccountUpdate define account update.
WsAggTradeEvent define websocket aggTrde event.
WsBalance define balance.
WsBookTickerEvent define websocket best book ticker event.
WsConfig webservice configuration.
WsContinuousKline define websocket continuous kline.
WsContinuousKlineEvent define websocket continuous kline event.
WsDepthEvent define websocket depth book event.
WsIndexPriceEvent define websocket indexPriceUpdate event.
WsIndexPriceKline define websocket index price kline.
WsIndexPriceKlineEvent define websocket index price kline event.
WsKline define websocket kline.
WsKlineEvent define websocket kline event.
WsLiquidationOrder define websocket liquidation order.
WsLiquidationOrderEvent define websocket liquidation order event.
WsMarketTickerEvent define websocket market ticker event.
WsMarkPriceEvent define websocket markPriceUpdate event.
WsMarkPriceKline define websocket market price kline.
WsMarkPriceKlineEvent define websocket market price kline event.
WsMiniMarketTickerEvent define websocket mini market ticker event.
WsOrderTradeUpdate define order trade update.
WsPosition define position.
WsUserDataEvent define user data event.
# Type aliases
Ask is a type alias for PriceLevel.
Bid is a type alias for PriceLevel.
ErrHandler handles errors.
MarginType define margin type.
NewOrderRespType define response JSON verbosity.
OrderExecutionType define order execution type.
OrderStatusType define order status type.
OrderType define order type.
PositionSideType define position side type of order.
RequestOption define option type for request.
SideEffectType define side effect type for orders.
SideType define side type of order.
SymbolFilterType define symbol filter type.
SymbolStatusType define symbol status type.
SymbolType define symbol type.
TimeInForceType define time in force type of order.
UserDataEventReasonType define reason type for user data event.
UserDataEventType define user data event type.
WorkingType define working type.
WsAggTradeHandler handle websocket that push trade information that is aggregated for a single taker order.
WsAllMarketTickerEvent define an array of websocket mini ticker events.
WsAllMarketTickerHandler handle websocket that pushes price and funding rate for all markets.
WsAllMiniMarketTickerEvent define an array of websocket mini market ticker events.
WsAllMiniMarketTickerHandler handle websocket that pushes price and funding rate for all markets.
WsBookTickerHandler handle websocket that pushes updates to the best bid or ask price or quantity in real-time for a specified symbol.
WsContinuousKlineHandler handle websocket continuous kline event.
WsDepthHandler handle websocket depth event.
WsHandler handle raw websocket message.
WsIndexPriceHandler handle websocket that push index price for a pair.
WsIndexPriceKlineHandler handle websocket index kline event.
WsKlineHandler handle websocket kline event.
WsLiquidationOrderHandler handle websocket that pushes force liquidation order information for specific symbol.
WsMarketTickerHandler handle websocket that pushes 24hr rolling window mini-ticker statistics for a single symbol.
WsMarkPriceHandler handle websocket that pushes price and funding rate for a single symbol.
WsMarkPriceKlineHandler handle websocket market price kline event.
WsMiniMarketTickerHandler handle websocket that pushes 24hr rolling window mini-ticker statistics for a single symbol.
WsPairMarkPriceEvent defines an array of websocket markPriceUpdate events.
WsPairMarkPriceHandler handle websocket that pushes price and funding rate for all symbol.
WsUserDataHandler handle WsUserDataEvent.