Interface AccountApiInterface

AccountApi - interface AccountApi

Implemented by

DerivativesTradingPortfolioMarginProRestAPI.AccountApi

Index

Methods

bnbTransfer changeAutoRepayFuturesStatus fundAutoCollection fundCollectionByAsset getAutoRepayFuturesStatus getPortfolioMarginProAccountBalance getPortfolioMarginProAccountInfo getPortfolioMarginProSpanAccountInfo getTransferableEarnAssetBalanceForPortfolioMargin mintBfusdForPortfolioMargin portfolioMarginProBankruptcyLoanRepay queryPortfolioMarginProBankruptcyLoanAmount queryPortfolioMarginProBankruptcyLoanRepayHistory queryPortfolioMarginProNegativeBalanceInterestHistory redeemBfusdForPortfolioMargin repayFuturesNegativeBalance transferLdusdtForPortfolioMargin

Methods

bnbTransfer

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

You can only use this function 2 times per 10 minutes in a rolling manner

Weight: 1500
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:763

changeAutoRepayFuturesStatus

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

Weight: 1500
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:777

fundAutoCollection

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

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.

Weight: 1500
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:794

fundCollectionByAsset

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

The BNB transfer is not be supported

Weight: 60
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:810

getAutoRepayFuturesStatus

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

Weight: 30
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:824

getPortfolioMarginProAccountBalance

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

Weight: 20
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:838

getPortfolioMarginProAccountInfo

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

Weight: 5
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:852

getPortfolioMarginProSpanAccountInfo

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

Weight: 5
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:866

getTransferableEarnAssetBalanceForPortfolioMargin

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

Weight: 1500
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:880

mintBfusdForPortfolioMargin

mintBfusdForPortfolioMargin(
requestParameters: MintBfusdForPortfolioMarginRequest,
): Promise<RestApiResponse<MintBfusdForPortfolioMarginResponse>>
Mint BFUSD for all types of Portfolio Margin account

Weight: 1500
Parameters
- requestParameters: MintBfusdForPortfolioMarginRequest
  Request parameters.
Returns Promise<RestApiResponse<MintBfusdForPortfolioMarginResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:894

portfolioMarginProBankruptcyLoanRepay

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

Weight: 3000
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:908

queryPortfolioMarginProBankruptcyLoanAmount

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

If there’s no classic portfolio margin bankruptcy loan, the amount would be 0

Weight: 500
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:924

queryPortfolioMarginProBankruptcyLoanRepayHistory

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

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].

Weight: 500
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:943

queryPortfolioMarginProNegativeBalanceInterestHistory

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

Weight: 50
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:957

redeemBfusdForPortfolioMargin

redeemBfusdForPortfolioMargin(
requestParameters: RedeemBfusdForPortfolioMarginRequest,
): Promise<RestApiResponse<RedeemBfusdForPortfolioMarginResponse>>
Redeem BFUSD for all types of Portfolio Margin account

Weight: 1500
Parameters
- requestParameters: RedeemBfusdForPortfolioMarginRequest
  Request parameters.
Returns Promise<RestApiResponse<RedeemBfusdForPortfolioMarginResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:971

repayFuturesNegativeBalance

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

Weight: 1500
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:985

transferLdusdtForPortfolioMargin

transferLdusdtForPortfolioMargin(
requestParameters: TransferLdusdtForPortfolioMarginRequest,
): Promise<RestApiResponse<TransferLdusdtForPortfolioMarginResponse>>
Transfer LDUSDT as collateral for all types of Portfolio Margin account

Weight: 1500
Parameters
- requestParameters: TransferLdusdtForPortfolioMarginRequest
  Request parameters.
Returns Promise<RestApiResponse<TransferLdusdtForPortfolioMarginResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/account-api.ts:999

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

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

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

mintBfusdForPortfolioMargin

Parameters

Returns Promise<RestApiResponse<MintBfusdForPortfolioMarginResponse>>

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

queryPortfolioMarginProNegativeBalanceInterestHistory

Parameters

Returns Promise< RestApiResponse< QueryPortfolioMarginProNegativeBalanceInterestHistoryResponse, >,>

Throws

Memberof

redeemBfusdForPortfolioMargin

Parameters

Returns Promise<RestApiResponse<RedeemBfusdForPortfolioMarginResponse>>

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