Query account balance
Weight: 20
Optional
requestParameters: AccountBalanceRequestRequest parameters.
Query account information
Weight: 20
Optional
requestParameters: DerivativesTradingPortfolioMarginRestAPI.AccountInformationRequestRequest parameters.
Transfer BNB in and out of UM
The endpoint can only be called 10 times per 10 minutes in a rolling manner
Weight: 750
Request parameters.
Change Auto-repay-futures Status
Weight: 750
Request parameters.
Change user's initial leverage of specific symbol in CM.
Weight: 1
Request parameters.
Change user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol in CM
Weight: 1
Request parameters.
Change user's initial leverage of specific symbol in UM.
Weight: 1
Request parameters.
Change user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol in UM
Weight: 1
Request parameters.
Query CM notional and leverage brackets
Weight: 1
Optional
requestParameters: CmNotionalAndLeverageBracketsRequestRequest parameters.
Fund collection for Portfolio Margin
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: 750
Optional
requestParameters: DerivativesTradingPortfolioMarginRestAPI.FundAutoCollectionRequestRequest parameters.
Transfers specific asset from Futures Account to Margin account
The BNB transfer is not be supported
Weight: 30
Request parameters.
Query Auto-repay-futures Status
Weight: 30
Optional
requestParameters: DerivativesTradingPortfolioMarginRestAPI.GetAutoRepayFuturesStatusRequestRequest parameters.
Get current CM account asset and position information.
Weight: 5
Optional
requestParameters: GetCmAccountDetailRequestRequest parameters.
Get user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol in CM
Weight: 30
Optional
requestParameters: GetCmCurrentPositionModeRequestRequest parameters.
Get CM 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 interval between startTime
and endTime
can not exceed 200 days:
If startTime
and endTime
are not sent, the last 200 days will be returned
Weight: 30
Optional
requestParameters: GetCmIncomeHistoryRequestRequest parameters.
Get download id for UM 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: 1500
Request parameters.
Get download id for UM 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: 1500
Request parameters.
Get download id for UM 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: 1500
Request parameters.
Get Margin Borrow/Loan Interest History
Response in descending order
The max interval between startTime and endTime is 30 days. It is a MUST to ensure data correctness.
If startTime
and endTime
not sent, return records of the last 7 days by default
If startTime
is sent and endTime
is not sent, the records from startTime
to the present will be returned; if startTime
is more than 30 days ago, the records of the past 30 days will be returned.
If startTime
is not sent and endTime
is sent, the records of the 7 days before endTime
is returned.
Type in response has 5 enums:
PERIODIC
interest charged per hour
ON_BORROW
first interest charged on borrow
PERIODIC_CONVERTED
interest charged per hour converted into BNB
ON_BORROW_CONVERTED
first interest charged on borrow converted into BNB
PORTFOLIO
Portfolio Margin negative balance daily interest
Weight: 1
Optional
requestParameters: GetMarginBorrowLoanInterestHistoryRequestRequest parameters.
Get current UM account asset and position information.
Weight: 5
Optional
requestParameters: GetUmAccountDetailRequestRequest parameters.
Get current UM account asset and position information.
Weight: 5
Optional
requestParameters: GetUmAccountDetailV2RequestRequest parameters.
Get user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol in UM
Weight: 30
Optional
requestParameters: GetUmCurrentPositionModeRequestRequest parameters.
Get UM futures order download link by Id
Download link expiration: 24h
Weight: 10
Request parameters.
Get UM futures trade download link by Id
Download link expiration: 24h
Weight: 10
Request parameters.
Get UM futures Transaction download link by Id
Download link expiration: 24h
Weight: 10
Request parameters.
Get UM 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
Optional
requestParameters: GetUmIncomeHistoryRequestRequest parameters.
Get User Commission Rate for CM
Weight: 20
Request parameters.
Get User Commission Rate for UM
Weight: 20
Request parameters.
Query margin max borrow
Weight: 5
Request parameters.
Portfolio Margin UM Trading Quantitative Rules Indicators
Weight: 1 for a single symbol 10 when the symbol parameter is omitted
Optional
requestParameters: PortfolioMarginUmTradingQuantitativeRulesIndicatorsRequestRequest parameters.
Get current CM position information.
If neither marginAsset
nor pair
is sent, positions of all symbols with TRADING
status will be returned.
for One-way Mode user, the response will only show the "BOTH" positions
for Hedge Mode user, the response will show "LONG", and "SHORT" positions.
Please use with user data stream ACCOUNT_UPDATE
to meet your timeliness and accuracy needs.
Weight: 1
Optional
requestParameters: QueryCmPositionInformationRequestRequest parameters.
Query margin loan record
txId or startTime must be sent. txId takes precedence.
Response in descending order
The max interval between startTime
and endTime
is 30 days.
If startTime
and endTime
not sent, return records of the last 7 days by default
Set archived
to true
to query data from 6 months ago
Weight: 10
Request parameters.
Query Margin Max Withdraw
Weight: 5
Request parameters.
Query margin repay record.
txId or startTime must be sent. txId takes precedence.
Response in descending order
The max interval between startTime
and endTime
is 30 days.
If startTime
and endTime
not sent, return records of the last 7 days by default
Set archived
to true
to query data from 6 months ago
Weight: 10
Request parameters.
Query interest history of negative balance for portfolio margin.
Response in descending order
The max interval between startTime and endTime is 30 days. It is a MUST to ensure data correctness.
If startTime
and endTime
not sent, return records of the last 7 days by default
If startTime
is sent and endTime
is not sent, the records from startTime
to the present will be returned; if startTime
is more than 30 days ago, the records of the past 30 days will be returned.
If startTime
is not sent and endTime
is sent, the records of the 7 days before endTime
is returned.
Weight: 50
Optional
requestParameters: QueryPortfolioMarginNegativeBalanceInterestHistoryRequestRequest parameters.
Get current UM position information.
Please use with user data stream ACCOUNT_UPDATE
to meet your timeliness and accuracy needs.
for One-way Mode user, the response will only show the "BOTH" positions
for Hedge Mode user, the response will show "LONG", and "SHORT" positions.
Weight: 5
Optional
requestParameters: QueryUmPositionInformationRequestRequest parameters.
Query user negative balance auto exchange record
Response in descending order
The max interval between startTime
and endTime
is 3 months.
Weight: 100
Request parameters.
Query User Rate Limit
Weight: 1
Optional
requestParameters: DerivativesTradingPortfolioMarginRestAPI.QueryUserRateLimitRequestRequest parameters.
Repay futures Negative Balance
Weight: 750
Optional
requestParameters: DerivativesTradingPortfolioMarginRestAPI.RepayFuturesNegativeBalanceRequestRequest parameters.
Query UM Futures account configuration
Weight: 5
Optional
requestParameters: UmFuturesAccountConfigurationRequestRequest parameters.
Get current UM account symbol configuration.
Weight: 5
Optional
requestParameters: UmFuturesSymbolConfigurationRequestRequest parameters.
Query UM notional and leverage brackets
Weight: 1
Optional
requestParameters: UmNotionalAndLeverageBracketsRequestRequest parameters.
AccountApi - interface AccountApi