Class AccountApi

AccountApi - object-oriented interface AccountApi

Implements

DerivativesTradingUsdsFuturesRestAPI.AccountApiInterface

Constructors

constructor

new AccountApi(
configuration: ConfigurationRestAPI,
): DerivativesTradingUsdsFuturesRestAPI.AccountApi
Parameters
- configuration: ConfigurationRestAPI
Returns DerivativesTradingUsdsFuturesRestAPI.AccountApi
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:1724

Methods

accountInformationV2

accountInformationV2(
    requestParameters?: DerivativesTradingUsdsFuturesRestAPI.AccountInformationV2Request,
): Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.AccountInformationV2Response,
    >,
>
Get current account information. User in single-asset/ multi-assets mode will see different value, see comments in response section for detail.

Weight(IP): 5

Security Type: USER_DATA
Parameters
- requestParameters: DerivativesTradingUsdsFuturesRestAPI.AccountInformationV2Request = {}
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.AccountInformationV2Response,
    >,
>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.accountInformationV2
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:1743

accountInformationV3

accountInformationV3(
requestParameters?: AccountInformationV3Request,
): Promise<RestApiResponse<AccountInformationV3Response>>
Get current account information. User in single-asset/ multi-assets mode will see different value, see comments in response section for detail.

Weight(IP): 5

Security Type: USER_DATA
Parameters
- requestParameters: AccountInformationV3Request = {}
  Request parameters.
Returns Promise<RestApiResponse<AccountInformationV3Response>>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.accountInformationV3
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:1775

futuresAccountBalanceV2

futuresAccountBalanceV2(
    requestParameters?: DerivativesTradingUsdsFuturesRestAPI.FuturesAccountBalanceV2Request,
): Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.FuturesAccountBalanceV2Response,
    >,
>
Query account balance information.

Weight(IP): 5

Security Type: USER_DATA
Parameters
- requestParameters: DerivativesTradingUsdsFuturesRestAPI.FuturesAccountBalanceV2Request = {}
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.FuturesAccountBalanceV2Response,
    >,
>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.futuresAccountBalanceV2
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:1807

futuresAccountBalanceV3

futuresAccountBalanceV3(
requestParameters?: FuturesAccountBalanceV3Request,
): Promise<RestApiResponse<FuturesAccountBalanceV3Response>>
Query account balance information.

Weight(IP): 5

Security Type: USER_DATA
Parameters
- requestParameters: FuturesAccountBalanceV3Request = {}
  Request parameters.
Returns Promise<RestApiResponse<FuturesAccountBalanceV3Response>>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.futuresAccountBalanceV3
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:1839

futuresAccountConfiguration

futuresAccountConfiguration(
requestParameters?: FuturesAccountConfigurationRequest,
): Promise<RestApiResponse<FuturesAccountConfigurationResponse>>
Query account configuration

Weight(IP): 5

Security Type: USER_DATA
Parameters
- requestParameters: FuturesAccountConfigurationRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<FuturesAccountConfigurationResponse>>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.futuresAccountConfiguration
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:1871

futuresTradingQuantitativeRulesIndicators

futuresTradingQuantitativeRulesIndicators(
requestParameters?: FuturesTradingQuantitativeRulesIndicatorsRequest,
): Promise<
RestApiResponse<FuturesTradingQuantitativeRulesIndicatorsResponse>,
>
Futures trading quantitative rules indicators, for more information on this, please refer to the Futures Trading Quantitative Rules

Weight: - 1 for a single symbol
- 10 when the symbol parameter is omitted
Security Type: USER_DATA
Parameters
- requestParameters: FuturesTradingQuantitativeRulesIndicatorsRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<FuturesTradingQuantitativeRulesIndicatorsResponse>>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.futuresTradingQuantitativeRulesIndicators
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:1904

getBnbBurnStatus

getBnbBurnStatus(
    requestParameters?: DerivativesTradingUsdsFuturesRestAPI.GetBnbBurnStatusRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetBnbBurnStatusResponse,
    >,
>
Get user's BNB Fee Discount (Fee Discount On or Fee Discount Off )

Weight(IP): 30

Security Type: USER_DATA
Parameters
- requestParameters: DerivativesTradingUsdsFuturesRestAPI.GetBnbBurnStatusRequest = {}
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetBnbBurnStatusResponse,
    >,
>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.getBnbBurnStatus
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:1938

getCurrentMultiAssetsMode

getCurrentMultiAssetsMode(
requestParameters?: GetCurrentMultiAssetsModeRequest,
): Promise<RestApiResponse<GetCurrentMultiAssetsModeResponse>>
Get user's Multi-Assets mode (Multi-Assets Mode or Single-Asset Mode) on Every symbol

Weight(IP): 30

Security Type: USER_DATA
Parameters
- requestParameters: GetCurrentMultiAssetsModeRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetCurrentMultiAssetsModeResponse>>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.getCurrentMultiAssetsMode
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:1970

getCurrentPositionMode

getCurrentPositionMode(
    requestParameters?: DerivativesTradingUsdsFuturesRestAPI.GetCurrentPositionModeRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetCurrentPositionModeResponse,
    >,
>
Get user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol

Weight(IP): 30

Security Type: USER_DATA
Parameters
- requestParameters: DerivativesTradingUsdsFuturesRestAPI.GetCurrentPositionModeRequest = {}
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetCurrentPositionModeResponse,
    >,
>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.getCurrentPositionMode
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:2002

getDownloadIdForFuturesOrderHistory

getDownloadIdForFuturesOrderHistory(
    requestParameters: DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesOrderHistoryRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesOrderHistoryResponse,
    >,
>
Get Download Id For Futures Order History

Weight(IP): 1000

Security Type: USER_DATA

Notes:
- Request Limitation is 10 times per month, shared by front end download page and rest api
- The time between startTime and endTime can not be longer than 1 year
Parameters
- requestParameters: DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesOrderHistoryRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesOrderHistoryResponse,
    >,
>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.getDownloadIdForFuturesOrderHistory
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:2038

getDownloadIdForFuturesTradeHistory

getDownloadIdForFuturesTradeHistory(
    requestParameters: DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesTradeHistoryRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesTradeHistoryResponse,
    >,
>
Get download id for futures trade history

Weight(IP): 1000

Security Type: USER_DATA

Notes:
- Request Limitation is 5 times per month, shared by front end download page and rest api
- The time between startTime and endTime can not be longer than 1 year
Parameters
- requestParameters: DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesTradeHistoryRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesTradeHistoryResponse,
    >,
>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.getDownloadIdForFuturesTradeHistory
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:2077

getDownloadIdForFuturesTransactionHistory

getDownloadIdForFuturesTransactionHistory(
    requestParameters: DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesTransactionHistoryRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesTransactionHistoryResponse,
    >,
>
Get download id for futures transaction history

Weight(IP): 1000

Security Type: USER_DATA

Notes:
- Request Limitation is 5 times per month, shared by front end download page and rest api
- The time between startTime and endTime can not be longer than 1 year
Parameters
- requestParameters: DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesTransactionHistoryRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesTransactionHistoryResponse,
    >,
>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.getDownloadIdForFuturesTransactionHistory
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:2116

getIncomeHistory

getIncomeHistory(
    requestParameters?: DerivativesTradingUsdsFuturesRestAPI.GetIncomeHistoryRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetIncomeHistoryResponse,
    >,
>
Query income history

Weight(IP): 30

Security Type: USER_DATA

Notes:
- If incomeType is not sent, all kinds of flow will be returned
- If startTime and endTime are not sent, the recent 7-day data will be returned.
- trandId is unique in the same incomeType for a user.
- Income history only contains data for the last three months.
Parameters
- requestParameters: DerivativesTradingUsdsFuturesRestAPI.GetIncomeHistoryRequest = {}
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetIncomeHistoryResponse,
    >,
>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.getIncomeHistory
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:2268

notionalAndLeverageBrackets

notionalAndLeverageBrackets(
requestParameters?: NotionalAndLeverageBracketsRequest,
): Promise<RestApiResponse<NotionalAndLeverageBracketsResponse>>
Query user notional and leverage bracket on speicfic symbol

Weight(IP): 1

Security Type: USER_DATA
Parameters
- requestParameters: NotionalAndLeverageBracketsRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<NotionalAndLeverageBracketsResponse>>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.notionalAndLeverageBrackets
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:2306

queryUserRateLimit

queryUserRateLimit(
    requestParameters?: DerivativesTradingUsdsFuturesRestAPI.QueryUserRateLimitRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.QueryUserRateLimitResponse,
    >,
>
Query User Rate Limit

Weight(IP): 1

Security Type: USER_DATA
Parameters
- requestParameters: DerivativesTradingUsdsFuturesRestAPI.QueryUserRateLimitRequest = {}
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.QueryUserRateLimitResponse,
    >,
>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.queryUserRateLimit
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:2339

symbolConfiguration

symbolConfiguration(
requestParameters?: SymbolConfigurationRequest,
): Promise<RestApiResponse<SymbolConfigurationResponse>>
Get current account symbol configuration.

Weight(IP): 5

Security Type: USER_DATA
Parameters
- requestParameters: SymbolConfigurationRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<SymbolConfigurationResponse>>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.symbolConfiguration
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:2371

toggleBnbBurnOnFuturesTrade

toggleBnbBurnOnFuturesTrade(
requestParameters: ToggleBnbBurnOnFuturesTradeRequest,
): Promise<RestApiResponse<ToggleBnbBurnOnFuturesTradeResponse>>
Change user's BNB Fee Discount (Fee Discount On or Fee Discount Off ) on EVERY symbol

Weight(IP): 1

Security Type: TRADE
Parameters
- requestParameters: ToggleBnbBurnOnFuturesTradeRequest
  Request parameters.
Returns Promise<RestApiResponse<ToggleBnbBurnOnFuturesTradeResponse>>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.toggleBnbBurnOnFuturesTrade
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:2404

userCommissionRate

userCommissionRate(
    requestParameters: DerivativesTradingUsdsFuturesRestAPI.UserCommissionRateRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.UserCommissionRateResponse,
    >,
>
Get User Commission Rate

Weight(IP): 20

Security Type: USER_DATA
Parameters
- requestParameters: DerivativesTradingUsdsFuturesRestAPI.UserCommissionRateRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.UserCommissionRateResponse,
    >,
>
Throws
Memberof
AccountApi

See
Binance API Documentation
Implementation of AccountApiInterface.userCommissionRate
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:2437

Class AccountApi

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DerivativesTradingUsdsFuturesRestAPI.AccountApi

Methods

accountInformationV2

Parameters

Returns Promise< RestApiResponse< DerivativesTradingUsdsFuturesRestAPI.AccountInformationV2Response, >,>

Throws

Memberof

See

accountInformationV3

Parameters

Returns Promise<RestApiResponse<AccountInformationV3Response>>

Throws

Memberof

See

futuresAccountBalanceV2

Parameters

Returns Promise< RestApiResponse< DerivativesTradingUsdsFuturesRestAPI.FuturesAccountBalanceV2Response, >,>

Throws

Memberof

See

futuresAccountBalanceV3

Parameters

Returns Promise<RestApiResponse<FuturesAccountBalanceV3Response>>

Throws

Memberof

See

futuresAccountConfiguration

Parameters

Returns Promise<RestApiResponse<FuturesAccountConfigurationResponse>>

Throws

Memberof

See

futuresTradingQuantitativeRulesIndicators

Parameters

Returns Promise<RestApiResponse<FuturesTradingQuantitativeRulesIndicatorsResponse>>

Throws

Memberof

See

getBnbBurnStatus

Parameters

Returns Promise< RestApiResponse< DerivativesTradingUsdsFuturesRestAPI.GetBnbBurnStatusResponse, >,>

Throws

Memberof

See

getCurrentMultiAssetsMode

Parameters

Returns Promise<RestApiResponse<GetCurrentMultiAssetsModeResponse>>

Throws

Memberof

See

getCurrentPositionMode

Parameters

Returns Promise< RestApiResponse< DerivativesTradingUsdsFuturesRestAPI.GetCurrentPositionModeResponse, >,>

Throws

Memberof

See

getDownloadIdForFuturesOrderHistory

Parameters

Returns Promise< RestApiResponse< DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesOrderHistoryResponse, >,>

Throws

Memberof

See

getDownloadIdForFuturesTradeHistory

Parameters

Returns Promise< RestApiResponse< DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesTradeHistoryResponse, >,>

Throws

Memberof

See

getDownloadIdForFuturesTransactionHistory

Parameters

Returns Promise< RestApiResponse< DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesTransactionHistoryResponse, >,>

Throws

Returns Promise<
RestApiResponse<
DerivativesTradingUsdsFuturesRestAPI.AccountInformationV2Response,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingUsdsFuturesRestAPI.FuturesAccountBalanceV2Response,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingUsdsFuturesRestAPI.GetBnbBurnStatusResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingUsdsFuturesRestAPI.GetCurrentPositionModeResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesOrderHistoryResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesTradeHistoryResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesTransactionHistoryResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingUsdsFuturesRestAPI.GetFuturesOrderHistoryDownloadLinkByIdResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingUsdsFuturesRestAPI.GetFuturesTradeDownloadLinkByIdResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingUsdsFuturesRestAPI.GetFuturesTransactionHistoryDownloadLinkByIdResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingUsdsFuturesRestAPI.GetIncomeHistoryResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingUsdsFuturesRestAPI.QueryUserRateLimitResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingUsdsFuturesRestAPI.UserCommissionRateResponse,
>,
>