Interface AccountApiInterface

AccountApi - interface AccountApi

Implemented by

DerivativesTradingUsdsFuturesRestAPI.AccountApi

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: 5
Parameters
- OptionalrequestParameters: DerivativesTradingUsdsFuturesRestAPI.AccountInformationV2Request
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.AccountInformationV2Response,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:830

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: 5
Parameters
- OptionalrequestParameters: AccountInformationV3Request
  Request parameters.
Returns Promise<RestApiResponse<AccountInformationV3Response>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:844

futuresAccountBalanceV2

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

Weight: 5
Parameters
- OptionalrequestParameters: DerivativesTradingUsdsFuturesRestAPI.FuturesAccountBalanceV2Request
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.FuturesAccountBalanceV2Response,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:858

futuresAccountBalanceV3

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

Weight: 5
Parameters
- OptionalrequestParameters: FuturesAccountBalanceV3Request
  Request parameters.
Returns Promise<RestApiResponse<FuturesAccountBalanceV3Response>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:872

futuresAccountConfiguration

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

Weight: 5
Parameters
- OptionalrequestParameters: FuturesAccountConfigurationRequest
  Request parameters.
Returns Promise<RestApiResponse<FuturesAccountConfigurationResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:886

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
Parameters
- OptionalrequestParameters: FuturesTradingQuantitativeRulesIndicatorsRequest
  Request parameters.
Returns Promise<RestApiResponse<FuturesTradingQuantitativeRulesIndicatorsResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:901

getBnbBurnStatus

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

Weight: 30
Parameters
- OptionalrequestParameters: DerivativesTradingUsdsFuturesRestAPI.GetBnbBurnStatusRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetBnbBurnStatusResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:915

getCurrentMultiAssetsMode

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

Weight: 30
Parameters
- OptionalrequestParameters: GetCurrentMultiAssetsModeRequest
  Request parameters.
Returns Promise<RestApiResponse<GetCurrentMultiAssetsModeResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:929

getCurrentPositionMode

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

Weight: 30
Parameters
- OptionalrequestParameters: DerivativesTradingUsdsFuturesRestAPI.GetCurrentPositionModeRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetCurrentPositionModeResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:943

getDownloadIdForFuturesOrderHistory

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

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

Weight: 1000
Parameters
- requestParameters: DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesOrderHistoryRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesOrderHistoryResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:960

getDownloadIdForFuturesTradeHistory

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

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

Weight: 1000
Parameters
- requestParameters: DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesTradeHistoryRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesTradeHistoryResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:977

getDownloadIdForFuturesTransactionHistory

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

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

Weight: 1000
Parameters
- requestParameters: DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesTransactionHistoryRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetDownloadIdForFuturesTransactionHistoryResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:994

getIncomeHistory

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

If neither startTime nor endTime is sent, the recent 7-day data will be returned. If incomeType is not sent, all kinds of flow will be returned "trandId" is unique in the same incomeType for a user Income history only contains data for the last three months

Weight: 30
Parameters
- OptionalrequestParameters: DerivativesTradingUsdsFuturesRestAPI.GetIncomeHistoryRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.GetIncomeHistoryResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:1061

notionalAndLeverageBrackets

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

Weight: 1
Parameters
- OptionalrequestParameters: NotionalAndLeverageBracketsRequest
  Request parameters.
Returns Promise<RestApiResponse<NotionalAndLeverageBracketsResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:1075

queryUserRateLimit

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

Weight: 1
Parameters
- OptionalrequestParameters: DerivativesTradingUsdsFuturesRestAPI.QueryUserRateLimitRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.QueryUserRateLimitResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:1089

symbolConfiguration

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

Weight: 5
Parameters
- OptionalrequestParameters: SymbolConfigurationRequest
  Request parameters.
Returns Promise<RestApiResponse<SymbolConfigurationResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:1103

toggleBnbBurnOnFuturesTrade

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

Weight: 1
Parameters
- requestParameters: ToggleBnbBurnOnFuturesTradeRequest
  Request parameters.
Returns Promise<RestApiResponse<ToggleBnbBurnOnFuturesTradeResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:1117

userCommissionRate

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

Weight: 20
Parameters
- requestParameters: DerivativesTradingUsdsFuturesRestAPI.UserCommissionRateRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingUsdsFuturesRestAPI.UserCommissionRateResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-usds-futures/src/rest-api/modules/account-api.ts:1131

Interface AccountApiInterface

Implemented by

Index

Methods

Methods

accountInformationV2

Parameters

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

Throws

Memberof

accountInformationV3

Parameters

Returns Promise<RestApiResponse<AccountInformationV3Response>>

Throws

Memberof

futuresAccountBalanceV2

Parameters

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

Throws

Memberof

futuresAccountBalanceV3

Parameters

Returns Promise<RestApiResponse<FuturesAccountBalanceV3Response>>

Throws

Memberof

futuresAccountConfiguration

Parameters

Returns Promise<RestApiResponse<FuturesAccountConfigurationResponse>>

Throws

Memberof

futuresTradingQuantitativeRulesIndicators

Parameters

Returns Promise<RestApiResponse<FuturesTradingQuantitativeRulesIndicatorsResponse>>

Throws

Memberof

getBnbBurnStatus

Parameters

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

Throws

Memberof

getCurrentMultiAssetsMode

Parameters

Returns Promise<RestApiResponse<GetCurrentMultiAssetsModeResponse>>

Throws

Memberof

getCurrentPositionMode

Parameters

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

Throws

Memberof

getDownloadIdForFuturesOrderHistory

Parameters

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

Throws

Memberof

getDownloadIdForFuturesTradeHistory

Parameters

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

Throws

Memberof

getDownloadIdForFuturesTransactionHistory

Parameters

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

Throws

Memberof

getFuturesOrderHistoryDownloadLinkById

Parameters

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

Throws

Memberof

getFuturesTradeDownloadLinkById

Parameters

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

Throws

Memberof

getFuturesTransactionHistoryDownloadLinkById

Parameters

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

Throws

Memberof

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,
>,
>