Interface AccountApiInterface

AccountApi - interface

AccountApi

interface AccountApiInterface {
    accountInformation(
        requestParameters?: DerivativesTradingCoinFuturesWebsocketAPI.AccountInformationRequest,
    ): Promise<
        WebsocketApiResponse<
            DerivativesTradingCoinFuturesWebsocketAPI.AccountInformationResponse,
        >,
    >;
    futuresAccountBalance(
        requestParameters?: DerivativesTradingCoinFuturesWebsocketAPI.FuturesAccountBalanceRequest,
    ): Promise<
        WebsocketApiResponse<
            DerivativesTradingCoinFuturesWebsocketAPI.FuturesAccountBalanceResponse,
        >,
    >;
}

Implemented by

DerivativesTradingCoinFuturesWebsocketAPI.AccountApi

Index

Methods

accountInformation futuresAccountBalance

Methods

accountInformation

accountInformation(
    requestParameters?: DerivativesTradingCoinFuturesWebsocketAPI.AccountInformationRequest,
): Promise<
    WebsocketApiResponse<
        DerivativesTradingCoinFuturesWebsocketAPI.AccountInformationResponse,
    >,
>
Get current account information. User in single-asset/ multi-assets mode will see different value, see comments in response section for detail.

Weight: 5
Parameters
- OptionalrequestParameters: DerivativesTradingCoinFuturesWebsocketAPI.AccountInformationRequest
  Request parameters.
Returns Promise<
    WebsocketApiResponse<
        DerivativesTradingCoinFuturesWebsocketAPI.AccountInformationResponse,
    >,
>
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-coin-futures/src/websocket-api/modules/account-api.ts:34

futuresAccountBalance

futuresAccountBalance(
    requestParameters?: DerivativesTradingCoinFuturesWebsocketAPI.FuturesAccountBalanceRequest,
): Promise<
    WebsocketApiResponse<
        DerivativesTradingCoinFuturesWebsocketAPI.FuturesAccountBalanceResponse,
    >,
>
Query account balance info

Weight: 5
Parameters
- OptionalrequestParameters: DerivativesTradingCoinFuturesWebsocketAPI.FuturesAccountBalanceRequest
  Request parameters.
Returns Promise<
    WebsocketApiResponse<
        DerivativesTradingCoinFuturesWebsocketAPI.FuturesAccountBalanceResponse,
    >,
>
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-coin-futures/src/websocket-api/modules/account-api.ts:49