Interface AccountApiInterface

AccountApi - interface AccountApi

Implemented by

DerivativesTradingCoinFuturesRestAPI.AccountApi

Index

Methods

accountInformation futuresAccountBalance getCurrentPositionMode getDownloadIdForFuturesOrderHistory getDownloadIdForFuturesTradeHistory getDownloadIdForFuturesTransactionHistory getFuturesOrderHistoryDownloadLinkById getFuturesTradeDownloadLinkById getFuturesTransactionHistoryDownloadLinkById getIncomeHistory notionalBracketForPair notionalBracketForSymbol userCommissionRate

Methods

accountInformation

accountInformation(
    requestParameters?: DerivativesTradingCoinFuturesRestAPI.AccountInformationRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingCoinFuturesRestAPI.AccountInformationResponse,
    >,
>
Get current account information.

for One-way Mode user, the "positions" will only show the "BOTH" positions for Hedge Mode user, the "positions" will show "BOTH", "LONG", and "SHORT" positions.

Weight: 5
Parameters
- OptionalrequestParameters: DerivativesTradingCoinFuturesRestAPI.AccountInformationRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingCoinFuturesRestAPI.AccountInformationResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-coin-futures/src/rest-api/modules/account-api.ts:596

futuresAccountBalance

futuresAccountBalance(
    requestParameters?: DerivativesTradingCoinFuturesRestAPI.FuturesAccountBalanceRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingCoinFuturesRestAPI.FuturesAccountBalanceResponse,
    >,
>
Check futures account balance

Weight: 1
Parameters
- OptionalrequestParameters: DerivativesTradingCoinFuturesRestAPI.FuturesAccountBalanceRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingCoinFuturesRestAPI.FuturesAccountBalanceResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-coin-futures/src/rest-api/modules/account-api.ts:610

getCurrentPositionMode

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

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

getDownloadIdForFuturesOrderHistory

getDownloadIdForFuturesOrderHistory(
    requestParameters: DerivativesTradingCoinFuturesRestAPI.GetDownloadIdForFuturesOrderHistoryRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingCoinFuturesRestAPI.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: 5
Parameters
- requestParameters: DerivativesTradingCoinFuturesRestAPI.GetDownloadIdForFuturesOrderHistoryRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingCoinFuturesRestAPI.GetDownloadIdForFuturesOrderHistoryResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-coin-futures/src/rest-api/modules/account-api.ts:641

getDownloadIdForFuturesTradeHistory

getDownloadIdForFuturesTradeHistory(
    requestParameters: DerivativesTradingCoinFuturesRestAPI.GetDownloadIdForFuturesTradeHistoryRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingCoinFuturesRestAPI.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: 5
Parameters
- requestParameters: DerivativesTradingCoinFuturesRestAPI.GetDownloadIdForFuturesTradeHistoryRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingCoinFuturesRestAPI.GetDownloadIdForFuturesTradeHistoryResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-coin-futures/src/rest-api/modules/account-api.ts:658

getDownloadIdForFuturesTransactionHistory

getDownloadIdForFuturesTransactionHistory(
    requestParameters: DerivativesTradingCoinFuturesRestAPI.GetDownloadIdForFuturesTransactionHistoryRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingCoinFuturesRestAPI.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: 5
Parameters
- requestParameters: DerivativesTradingCoinFuturesRestAPI.GetDownloadIdForFuturesTransactionHistoryRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingCoinFuturesRestAPI.GetDownloadIdForFuturesTransactionHistoryResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-coin-futures/src/rest-api/modules/account-api.ts:675

getIncomeHistory

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

If incomeType is not sent, all kinds of flow will be returned "trandId" is unique in the same "incomeType" for a user The time between startTime and endTime can not be longer than 1 year

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

notionalBracketForPair

notionalBracketForPair(
requestParameters?: NotionalBracketForPairRequest,
): Promise<RestApiResponse<NotionalBracketForPairResponse>>
Not recommended to continue using this v1 endpoint

Get the pair's default notional bracket list, may return ambiguous values when there have been multiple different symbol brackets under the pair, suggest using the following GET /dapi/v2/leverageBracket query instead to get the specific symbol notional bracket list.

Weight: 1
Parameters
- OptionalrequestParameters: NotionalBracketForPairRequest
  Request parameters.
Returns Promise<RestApiResponse<NotionalBracketForPairResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-coin-futures/src/rest-api/modules/account-api.ts:757

notionalBracketForSymbol

notionalBracketForSymbol(
requestParameters?: NotionalBracketForSymbolRequest,
): Promise<RestApiResponse<NotionalBracketForSymbolResponse>>
Get the symbol's notional bracket list.

Weight: 1
Parameters
- OptionalrequestParameters: NotionalBracketForSymbolRequest
  Request parameters.
Returns Promise<RestApiResponse<NotionalBracketForSymbolResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-coin-futures/src/rest-api/modules/account-api.ts:771

userCommissionRate

userCommissionRate(
    requestParameters: DerivativesTradingCoinFuturesRestAPI.UserCommissionRateRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingCoinFuturesRestAPI.UserCommissionRateResponse,
    >,
>
Query user commission rate

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

Interface AccountApiInterface

Implemented by

Index

Methods

Methods

accountInformation

Parameters

Returns Promise< RestApiResponse< DerivativesTradingCoinFuturesRestAPI.AccountInformationResponse, >,>

Throws

Memberof

futuresAccountBalance

Parameters

Returns Promise< RestApiResponse< DerivativesTradingCoinFuturesRestAPI.FuturesAccountBalanceResponse, >,>

Throws

Memberof

getCurrentPositionMode

Parameters

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

Throws

Memberof

getDownloadIdForFuturesOrderHistory

Parameters

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

Throws

Memberof

getDownloadIdForFuturesTradeHistory

Parameters

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

Throws

Memberof

getDownloadIdForFuturesTransactionHistory

Parameters

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

Throws

Memberof

getFuturesOrderHistoryDownloadLinkById

Parameters

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

Throws

Memberof

getFuturesTradeDownloadLinkById

Parameters

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

Throws

Memberof

getFuturesTransactionHistoryDownloadLinkById

Parameters

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

Throws

Memberof

getIncomeHistory

Parameters

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

Throws

Memberof

notionalBracketForPair

Parameters

Returns Promise<RestApiResponse<NotionalBracketForPairResponse>>

Throws

Memberof

notionalBracketForSymbol

Parameters

Returns Promise<RestApiResponse<NotionalBracketForSymbolResponse>>

Throws

Memberof

userCommissionRate

Parameters

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

Throws

Memberof

Settings

On This Page

Returns Promise<
RestApiResponse<
DerivativesTradingCoinFuturesRestAPI.AccountInformationResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingCoinFuturesRestAPI.FuturesAccountBalanceResponse,
>,
>

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

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

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

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

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

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

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

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

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