Interface AccountApiInterface

AccountApi - interface AccountApi

Implemented by

DerivativesTradingPortfolioMarginProRestAPI.AccountApi

Methods

bnbTransfer

bnbTransfer(
    requestParameters: DerivativesTradingPortfolioMarginProRestAPI.BnbTransferRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingPortfolioMarginProRestAPI.BnbTransferResponse,
    >,
>
BNB transfer can be between Margin Account and USDM Account

Weight(IP): 1500

Security Type: USER_DATA

Notes:
- You can only use this function 2 times per 10 minutes in a rolling manner
Parameters
- requestParameters: DerivativesTradingPortfolioMarginProRestAPI.BnbTransferRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingPortfolioMarginProRestAPI.BnbTransferResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:932

changeAutoRepayFuturesStatus

changeAutoRepayFuturesStatus(
    requestParameters: DerivativesTradingPortfolioMarginProRestAPI.ChangeAutoRepayFuturesStatusRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingPortfolioMarginProRestAPI.ChangeAutoRepayFuturesStatusResponse,
    >,
>
Change Auto-repay-futures Status

Weight(IP): 1500

Security Type: TRADE
Parameters
- requestParameters: DerivativesTradingPortfolioMarginProRestAPI.ChangeAutoRepayFuturesStatusRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingPortfolioMarginProRestAPI.ChangeAutoRepayFuturesStatusResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:948

deleteMarginCallLevel

deleteMarginCallLevel(
requestParameters?: DeleteMarginCallLevelRequest,
): Promise<RestApiResponse<DeleteMarginCallLevelResponse>>
Delete the margin call level for a Portfolio Margin account.

Weight(IP): 1500

Security Type: USER_DATA
Parameters
- OptionalrequestParameters: DeleteMarginCallLevelRequest
  Request parameters.
Returns Promise<RestApiResponse<DeleteMarginCallLevelResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:964

fundAutoCollection

fundAutoCollection(
    requestParameters?: DerivativesTradingPortfolioMarginProRestAPI.FundAutoCollectionRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingPortfolioMarginProRestAPI.FundAutoCollectionResponse,
    >,
>
Transfers all assets from Futures Account to Margin account

Weight(IP): 1500

Security Type: USER_DATA

Notes:
- The BNB would not be collected from UM-PM account to the Portfolio Margin account.
- You can only use this function 500 times per hour in a rolling manner.
Parameters
- OptionalrequestParameters: DerivativesTradingPortfolioMarginProRestAPI.FundAutoCollectionRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingPortfolioMarginProRestAPI.FundAutoCollectionResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:984

fundCollectionByAsset

fundCollectionByAsset(
    requestParameters: DerivativesTradingPortfolioMarginProRestAPI.FundCollectionByAssetRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingPortfolioMarginProRestAPI.FundCollectionByAssetResponse,
    >,
>
Transfers specific asset from Futures Account to Margin account

Weight(IP): 60

Security Type: USER_DATA

Notes:
- The BNB transfer is not be supported
Parameters
- requestParameters: DerivativesTradingPortfolioMarginProRestAPI.FundCollectionByAssetRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingPortfolioMarginProRestAPI.FundCollectionByAssetResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:1003

getAutoRepayFuturesStatus

getAutoRepayFuturesStatus(
    requestParameters?: DerivativesTradingPortfolioMarginProRestAPI.GetAutoRepayFuturesStatusRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingPortfolioMarginProRestAPI.GetAutoRepayFuturesStatusResponse,
    >,
>
Query Auto-repay-futures Status

Weight(IP): 30

Security Type: USER_DATA
Parameters
- OptionalrequestParameters: DerivativesTradingPortfolioMarginProRestAPI.GetAutoRepayFuturesStatusRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingPortfolioMarginProRestAPI.GetAutoRepayFuturesStatusResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:1019

getDeltaModeStatus

getDeltaModeStatus(
requestParameters?: GetDeltaModeStatusRequest,
): Promise<RestApiResponse<GetDeltaModeStatusResponse>>
Query the Delta mode status of current account.

Weight(IP): 1500

Security Type: USER_DATA
Parameters
- OptionalrequestParameters: GetDeltaModeStatusRequest
  Request parameters.
Returns Promise<RestApiResponse<GetDeltaModeStatusResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:1035

getMarginCallLevel

getMarginCallLevel(
requestParameters?: GetMarginCallLevelRequest,
): Promise<RestApiResponse<GetMarginCallLevelResponse>>
Get the margin call level for a Portfolio Margin account.

Weight(IP): 1500

Security Type: USER_DATA
Parameters
- OptionalrequestParameters: GetMarginCallLevelRequest
  Request parameters.
Returns Promise<RestApiResponse<GetMarginCallLevelResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:1051

getPortfolioMarginProAccountBalance

getPortfolioMarginProAccountBalance(
requestParameters?: GetPortfolioMarginProAccountBalanceRequest,
): Promise<RestApiResponse<GetPortfolioMarginProAccountBalanceResponse>>
Query Portfolio Margin Pro account balance

Weight(IP): 20

Security Type: USER_DATA
Parameters
- OptionalrequestParameters: GetPortfolioMarginProAccountBalanceRequest
  Request parameters.
Returns Promise<RestApiResponse<GetPortfolioMarginProAccountBalanceResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:1067

getPortfolioMarginProAccountInfo

getPortfolioMarginProAccountInfo(
requestParameters?: GetPortfolioMarginProAccountInfoRequest,
): Promise<RestApiResponse<GetPortfolioMarginProAccountInfoResponse>>
Get Portfolio Margin Pro Account Info

Weight(UID): 5

Security Type: USER_DATA
Parameters
- OptionalrequestParameters: GetPortfolioMarginProAccountInfoRequest
  Request parameters.
Returns Promise<RestApiResponse<GetPortfolioMarginProAccountInfoResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:1083

getPortfolioMarginProSpanAccountInfo

getPortfolioMarginProSpanAccountInfo(
requestParameters?: GetPortfolioMarginProSpanAccountInfoRequest,
): Promise<RestApiResponse<GetPortfolioMarginProSpanAccountInfoResponse>>
Get Portfolio Margin Pro SPAN Account Info (For Portfolio Margin Pro SPAN users only)

Weight(IP): 5

Security Type: USER_DATA
Parameters
- OptionalrequestParameters: GetPortfolioMarginProSpanAccountInfoRequest
  Request parameters.
Returns Promise<RestApiResponse<GetPortfolioMarginProSpanAccountInfoResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:1099

getTransferableEarnAssetBalanceForPortfolioMargin

getTransferableEarnAssetBalanceForPortfolioMargin(
    requestParameters: GetTransferableEarnAssetBalanceForPortfolioMarginRequest,
): Promise<
    RestApiResponse<
        GetTransferableEarnAssetBalanceForPortfolioMarginResponse,
    >,
>
Get transferable earn asset balance for all types of Portfolio Margin account

Weight(IP): 1500

Security Type: USER_DATA
Parameters
- requestParameters: GetTransferableEarnAssetBalanceForPortfolioMarginRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        GetTransferableEarnAssetBalanceForPortfolioMarginResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:1115

portfolioMarginProBankruptcyLoanRepay

portfolioMarginProBankruptcyLoanRepay(
requestParameters?: PortfolioMarginProBankruptcyLoanRepayRequest,
): Promise<RestApiResponse<PortfolioMarginProBankruptcyLoanRepayResponse>>
Repay Portfolio Margin Pro Bankruptcy Loan

Weight(UID): 3000

Security Type: TRADE

Notes:
- Please note that the API Key has enabled Spot & Margin Trading permissions to access this endpoint.
Parameters
- OptionalrequestParameters: PortfolioMarginProBankruptcyLoanRepayRequest
  Request parameters.
Returns Promise<RestApiResponse<PortfolioMarginProBankruptcyLoanRepayResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:1134

queryPortfolioMarginProBankruptcyLoanAmount

queryPortfolioMarginProBankruptcyLoanAmount(
requestParameters?: QueryPortfolioMarginProBankruptcyLoanAmountRequest,
): Promise<
RestApiResponse<QueryPortfolioMarginProBankruptcyLoanAmountResponse>,
>
Query Portfolio Margin Pro Bankruptcy Loan Amount

Weight(UID): 500

Security Type: USER_DATA

Notes:
- If there’s no classic portfolio margin bankruptcy loan, the amount would be 0
Parameters
- OptionalrequestParameters: QueryPortfolioMarginProBankruptcyLoanAmountRequest
  Request parameters.
Returns Promise<RestApiResponse<QueryPortfolioMarginProBankruptcyLoanAmountResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:1153

queryPortfolioMarginProBankruptcyLoanRepayHistory

queryPortfolioMarginProBankruptcyLoanRepayHistory(
    requestParameters?: QueryPortfolioMarginProBankruptcyLoanRepayHistoryRequest,
): Promise<
    RestApiResponse<
        QueryPortfolioMarginProBankruptcyLoanRepayHistoryResponse,
    >,
>
Query repay history of pmloan for portfolio margin pro.

Weight(IP): 500

Security Type: USER_DATA

Notes:
- startTime and endTime cannot be longer than 360 days
- If startTime and endTime not sent, return records of the last 30 days by default.
- If startTimeis sent and endTime is not sent, return records of [startTime, startTime+30d].
- If startTime is not sent and endTime is sent, return records of [endTime-30d, endTime].
Parameters
- OptionalrequestParameters: QueryPortfolioMarginProBankruptcyLoanRepayHistoryRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        QueryPortfolioMarginProBankruptcyLoanRepayHistoryResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:1175

queryPortfolioMarginProNegativeBalanceInterestHistory

queryPortfolioMarginProNegativeBalanceInterestHistory(
    requestParameters?: QueryPortfolioMarginProNegativeBalanceInterestHistoryRequest,
): Promise<
    RestApiResponse<
        QueryPortfolioMarginProNegativeBalanceInterestHistoryResponse,
    >,
>
Query interest history of negative balance for portfolio margin.

Weight(IP): 50

Security Type: USER_DATA
Parameters
- OptionalrequestParameters: QueryPortfolioMarginProNegativeBalanceInterestHistoryRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        QueryPortfolioMarginProNegativeBalanceInterestHistoryResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:1191

repayFuturesNegativeBalance

repayFuturesNegativeBalance(
    requestParameters?: DerivativesTradingPortfolioMarginProRestAPI.RepayFuturesNegativeBalanceRequest,
): Promise<
    RestApiResponse<
        DerivativesTradingPortfolioMarginProRestAPI.RepayFuturesNegativeBalanceResponse,
    >,
>
Repay futures Negative Balance

Weight(IP): 1500

Security Type: USER_DATA
Parameters
- OptionalrequestParameters: DerivativesTradingPortfolioMarginProRestAPI.RepayFuturesNegativeBalanceRequest
  Request parameters.
Returns Promise<
    RestApiResponse<
        DerivativesTradingPortfolioMarginProRestAPI.RepayFuturesNegativeBalanceResponse,
    >,
>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:1207

setMarginCallLevel

setMarginCallLevel(
requestParameters: SetMarginCallLevelRequest,
): Promise<RestApiResponse<SetMarginCallLevelResponse>>
Set the margin call level for a Portfolio Margin account. When the account's uniMMR drops to the specified level, a notification will be sent via email and SMS.

Weight(IP): 1500

Security Type: USER_DATA
Parameters
- requestParameters: SetMarginCallLevelRequest
  Request parameters.
Returns Promise<RestApiResponse<SetMarginCallLevelResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:1223

switchDeltaMode

switchDeltaMode(
requestParameters: SwitchDeltaModeRequest,
): Promise<RestApiResponse<SwitchDeltaModeResponse>>
Switch the Delta mode for existing PM PRO / PM RETAIL accounts.

Weight(IP): 1500

Security Type: TRADE
Parameters
- requestParameters: SwitchDeltaModeRequest
  Request parameters.
Returns Promise<RestApiResponse<SwitchDeltaModeResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:1239

transferLdusdtRwusdForPortfolioMargin

transferLdusdtRwusdForPortfolioMargin(
requestParameters: TransferLdusdtRwusdForPortfolioMarginRequest,
): Promise<RestApiResponse<TransferLdusdtRwusdForPortfolioMarginResponse>>
Transfer LDUSDT/RWUSD as collateral for all types of Portfolio Margin account

Weight(UID): 1500

Security Type: TRADE
Parameters
- requestParameters: TransferLdusdtRwusdForPortfolioMarginRequest
  Request parameters.
Returns Promise<RestApiResponse<TransferLdusdtRwusdForPortfolioMarginResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:1255

Interface AccountApiInterface

Implemented by

Index

Methods

Methods

bnbTransfer

Parameters

Returns Promise< RestApiResponse< DerivativesTradingPortfolioMarginProRestAPI.BnbTransferResponse, >,>

Throws

Memberof

changeAutoRepayFuturesStatus

Parameters

Returns Promise< RestApiResponse< DerivativesTradingPortfolioMarginProRestAPI.ChangeAutoRepayFuturesStatusResponse, >,>

Throws

Memberof

deleteMarginCallLevel

Parameters

Returns Promise<RestApiResponse<DeleteMarginCallLevelResponse>>

Throws

Memberof

fundAutoCollection

Parameters

Returns Promise< RestApiResponse< DerivativesTradingPortfolioMarginProRestAPI.FundAutoCollectionResponse, >,>

Throws

Memberof

fundCollectionByAsset

Parameters

Returns Promise< RestApiResponse< DerivativesTradingPortfolioMarginProRestAPI.FundCollectionByAssetResponse, >,>

Throws

Memberof

getAutoRepayFuturesStatus

Parameters

Returns Promise< RestApiResponse< DerivativesTradingPortfolioMarginProRestAPI.GetAutoRepayFuturesStatusResponse, >,>

Throws

Memberof

getDeltaModeStatus

Parameters

Returns Promise<RestApiResponse<GetDeltaModeStatusResponse>>

Throws

Memberof

getMarginCallLevel

Parameters

Returns Promise<RestApiResponse<GetMarginCallLevelResponse>>

Throws

Memberof

getPortfolioMarginProAccountBalance

Parameters

Returns Promise<RestApiResponse<GetPortfolioMarginProAccountBalanceResponse>>

Throws

Memberof

getPortfolioMarginProAccountInfo

Parameters

Returns Promise<RestApiResponse<GetPortfolioMarginProAccountInfoResponse>>

Throws

Memberof

getPortfolioMarginProSpanAccountInfo

Parameters

Returns Promise<RestApiResponse<GetPortfolioMarginProSpanAccountInfoResponse>>

Throws

Memberof

getTransferableEarnAssetBalanceForPortfolioMargin

Parameters

Returns Promise< RestApiResponse< GetTransferableEarnAssetBalanceForPortfolioMarginResponse, >,>

Throws

Memberof

portfolioMarginProBankruptcyLoanRepay

Parameters

Returns Promise<RestApiResponse<PortfolioMarginProBankruptcyLoanRepayResponse>>

Throws

Memberof

queryPortfolioMarginProBankruptcyLoanAmount

Parameters

Returns Promise<RestApiResponse<QueryPortfolioMarginProBankruptcyLoanAmountResponse>>

Throws

Memberof

queryPortfolioMarginProBankruptcyLoanRepayHistory

Parameters

Returns Promise< RestApiResponse< QueryPortfolioMarginProBankruptcyLoanRepayHistoryResponse, >,>

Throws

Memberof

Returns Promise<
RestApiResponse<
DerivativesTradingPortfolioMarginProRestAPI.BnbTransferResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingPortfolioMarginProRestAPI.ChangeAutoRepayFuturesStatusResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingPortfolioMarginProRestAPI.FundAutoCollectionResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingPortfolioMarginProRestAPI.FundCollectionByAssetResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingPortfolioMarginProRestAPI.GetAutoRepayFuturesStatusResponse,
>,
>

Returns Promise<
RestApiResponse<
GetTransferableEarnAssetBalanceForPortfolioMarginResponse,
>,
>

Returns Promise<
RestApiResponse<
QueryPortfolioMarginProBankruptcyLoanRepayHistoryResponse,
>,
>

Returns Promise<
RestApiResponse<
QueryPortfolioMarginProNegativeBalanceInterestHistoryResponse,
>,
>

Returns Promise<
RestApiResponse<
DerivativesTradingPortfolioMarginProRestAPI.RepayFuturesNegativeBalanceResponse,
>,
>