Skip to content

Class: RestClientV3 ​

REST client for Bitget Unified Trading Account V3 APIs.

Extends ​

  • default

Constructors ​

Constructor ​

ts
new RestClientV3(restOptions?: RestClientOptions, networkOptions?: AxiosRequestConfig): RestClientV3;

Create an instance of the REST client. Pass API credentials in the object in the first parameter.

Parameters ​

ParameterTypeDescription
restOptions?RestClientOptions-
networkOptions?AxiosRequestConfigHTTP networking options for axios

Returns ​

RestClientV3

Inherited from ​

BaseRestClient.constructor

Methods ​

addGridInvestment() ​

ts
addGridInvestment(params: AddGridInvestmentRequestV3): Promise<APIResponse<GridBotIdResponseV3>>;

Parameters ​

ParameterType
paramsAddGridInvestmentRequestV3

Returns ​

Promise<APIResponse<GridBotIdResponseV3>>


addStpGroupMembers() ​

ts
addStpGroupMembers(params: StpGroupMembersRequestV3): Promise<APIResponse<StpGroupMembersResponseV3>>;

Add STP Group Members uids is a comma-separated string, max 50. A sub-account can belong to only one group. Adding it moves it. MM whitelist only.

Parameters ​

ParameterType
paramsStpGroupMembersRequestV3

Returns ​

Promise<APIResponse<StpGroupMembersResponseV3>>


adjustAccountMode() ​

ts
adjustAccountMode(params: AdjustAccountModeRequestV3): Promise<APIResponse<null>>;

Set the account mode to basic, advanced or isolated. For delta-neutral mode, use mode: 'advanced' with deltaSwitch; mode: 'delta' is deprecated. Rate limit: 1 request per second per UID.

Parameters ​

ParameterType
paramsAdjustAccountModeRequestV3

Returns ​

Promise<APIResponse<null>>


batchModifyOrders() ​

ts
batchModifyOrders(params: BatchModifyOrderRequestV3[]): Promise<APIResponse<BatchModifyOrderResponseV3[]>>;

Batch Modify Orders

Parameters ​

ParameterType
paramsBatchModifyOrderRequestV3[]

Returns ​

Promise<APIResponse<BatchModifyOrderResponseV3[]>>


bindLoanUid() ​

ts
bindLoanUid(params: BindUidRequestV3): Promise<APIResponse<BindUidResponseV3>>;

Bind/Unbind UID to Risk Unit

Parameters ​

ParameterType
paramsBindUidRequestV3

Returns ​

Promise<APIResponse<BindUidResponseV3>>


borrow() ​

ts
borrow(params: BorrowRequestV3): Promise<APIResponse<BorrowResponseV3>>;

Parameters ​

ParameterType
paramsBorrowRequestV3

Returns ​

Promise<APIResponse<BorrowResponseV3>>


brokerSubWithdrawal() ​

ts
brokerSubWithdrawal(params: BrokerSubWithdrawalRequestV3): Promise<APIResponse<BrokerSubWithdrawalResponseV3>>;

Withdraw from an ND Broker sub-account. Only the ND Broker master account can call this endpoint. Rate limit: 20 requests per second per UID. Supported currencies are restricted; check the current Broker sub-account withdrawal reference before submitting.

Parameters ​

ParameterType
paramsBrokerSubWithdrawalRequestV3

Returns ​

Promise<APIResponse<BrokerSubWithdrawalResponseV3>>


cancelAllCfdOrders() ​

ts
cancelAllCfdOrders(params?: CancelAllCfdOrdersRequestV3): Promise<APIResponse<null>>;

Parameters ​

ParameterType
params?CancelAllCfdOrdersRequestV3

Returns ​

Promise<APIResponse<null>>


cancelAllOrders() ​

ts
cancelAllOrders(params: CancelAllOrdersRequestV3): Promise<APIResponse<CancelAllOrdersResponseV3>>;

Cancel All Orders

Parameters ​

ParameterType
paramsCancelAllOrdersRequestV3

Returns ​

Promise<APIResponse<CancelAllOrdersResponseV3>>


cancelBatchOrders() ​

ts
cancelBatchOrders(params: CancelBatchOrdersRequestV3[]): Promise<APIResponse<CancelBatchOrdersResponseV3[]>>;

Batch Cancel

Parameters ​

ParameterType
paramsCancelBatchOrdersRequestV3[]

Returns ​

Promise<APIResponse<CancelBatchOrdersResponseV3[]>>


cancelCfdOrder() ​

ts
cancelCfdOrder(params: CancelCfdOrderRequestV3): Promise<APIResponse<null>>;

Parameters ​

ParameterType
paramsCancelCfdOrderRequestV3

Returns ​

Promise<APIResponse<null>>


cancelCopyFuturesTpSl() ​

ts
cancelCopyFuturesTpSl(params: CancelCopyFuturesTpSlRequestV3): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsCancelCopyFuturesTpSlRequestV3

Returns ​

Promise<APIResponse<string>>


cancelOrder() ​

ts
cancelOrder(params: CancelOrderRequestV3): Promise<APIResponse<CancelOrderResponseV3>>;

Cancel Order

Parameters ​

ParameterType
paramsCancelOrderRequestV3

Returns ​

Promise<APIResponse<CancelOrderResponseV3>>

See ​

UTA order management


cancelRealityOrder() ​

ts
cancelRealityOrder(params: CancelRealityOrderRequestV3): Promise<APIResponse<CancelOrderResponseV3>>;

Cancel Reality Order - Cancel an unfilled or partially filled Reality stock order

Parameters ​

ParameterType
paramsCancelRealityOrderRequestV3

Returns ​

Promise<APIResponse<CancelOrderResponseV3>>


cancelStockPlusOrder() ​

ts
cancelStockPlusOrder(params: CancelStockPlusOrderRequestV3): Promise<APIResponse<StockPlusPlaceOrderResponseV3>>;

Parameters ​

ParameterType
paramsCancelStockPlusOrderRequestV3

Returns ​

Promise<APIResponse<StockPlusPlaceOrderResponseV3>>


cancelStrategyOrder() ​

ts
cancelStrategyOrder(params: CancelStrategyOrderRequestV3): Promise<APIResponse<null>>;

Cancel Strategy Order

Parameters ​

ParameterType
paramsCancelStrategyOrderRequestV3

Returns ​

Promise<APIResponse<null>>


cancelWithdrawal() ​

ts
cancelWithdrawal(params: CancelWithdrawalRequestV3): Promise<APIResponse<string>>;

Cancel a withdrawal still in the cooling-off period. Rate limit: 1/sec/UID.

Parameters ​

ParameterType
paramsCancelWithdrawalRequestV3

Returns ​

Promise<APIResponse<string>>


cfdTransfer() ​

ts
cfdTransfer(params: CfdTransferRequestV3): Promise<APIResponse<CfdTransferResponseV3>>;

Parameters ​

ParameterType
paramsCfdTransferRequestV3

Returns ​

Promise<APIResponse<CfdTransferResponseV3>>


closeAllCfdPositions() ​

ts
closeAllCfdPositions(params?: CloseAllCfdPositionsRequestV3): Promise<APIResponse<null>>;

Parameters ​

ParameterType
params?CloseAllCfdPositionsRequestV3

Returns ​

Promise<APIResponse<null>>


closeAllCopyFuturesPositions() ​

ts
closeAllCopyFuturesPositions(params: CloseAllCopyFuturesRequestV3): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsCloseAllCopyFuturesRequestV3

Returns ​

Promise<APIResponse<string>>


closeAllPositions() ​

ts
closeAllPositions(params: CloseAllPositionsRequestV3): Promise<APIResponse<CloseAllPositionsResponseV3>>;

Close All Positions

Parameters ​

ParameterType
paramsCloseAllPositionsRequestV3

Returns ​

Promise<APIResponse<CloseAllPositionsResponseV3>>


closeCfdPositions() ​

ts
closeCfdPositions(params: CloseCfdPositionsRequestV3): Promise<APIResponse<null>>;

Parameters ​

ParameterType
paramsCloseCfdPositionsRequestV3

Returns ​

Promise<APIResponse<null>>


closeCopyFuturesPositions() ​

ts
closeCopyFuturesPositions(params: CloseCopyFuturesPositionsRequestV3): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsCloseCopyFuturesPositionsRequestV3

Returns ​

Promise<APIResponse<string>>


closeGridBot() ​

ts
closeGridBot(params: CloseGridBotRequestV3): Promise<APIResponse<GridBotIdResponseV3>>;

Parameters ​

ParameterType
paramsCloseGridBotRequestV3

Returns ​

Promise<APIResponse<GridBotIdResponseV3>>


confirmP2pOrderPayment() ​

ts
confirmP2pOrderPayment(params: P2pOrderActionRequestV3): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsP2pOrderActionRequestV3

Returns ​

Promise<APIResponse<string>>


copyFuturesFollowerTransfer() ​

ts
copyFuturesFollowerTransfer(params: CopyFuturesFollowerTransferRequestV3): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsCopyFuturesFollowerTransferRequestV3

Returns ​

Promise<APIResponse<string>>


copyFuturesTransfer() ​

ts
copyFuturesTransfer(params: CopyFuturesTransferRequestV3): Promise<APIResponse<CopyFuturesTransferResponseV3>>;

Transfer funds between spot/funding and the copy-trading lead account. Rate limit: 1/sec/UID.

Parameters ​

ParameterType
paramsCopyFuturesTransferRequestV3

Returns ​

Promise<APIResponse<CopyFuturesTransferResponseV3>>


countdownCancelAll() ​

ts
countdownCancelAll(params: CountdownCancelAllRequestV3): Promise<APIResponse<string>>;

CountDown Cancel All

Parameters ​

ParameterType
paramsCountdownCancelAllRequestV3

Returns ​

Promise<APIResponse<string>>


createAgentSubAccount() ​

ts
createAgentSubAccount(params: CreateAgentSubAccountRequestV3): Promise<APIResponse<CreateAgentSubAccountResponseV3>>;

Create Agent Sub-account

Parameters ​

ParameterType
paramsCreateAgentSubAccountRequestV3

Returns ​

Promise<APIResponse<CreateAgentSubAccountResponseV3>>


createBrokerSubAccount() ​

ts
createBrokerSubAccount(params: CreateBrokerSubAccountRequestV3): Promise<APIResponse<CreateBrokerSubAccountResponseV3>>;

Create Broker Sub-Account

Rate limit: 20/sec/UID Only the master account with a user type of ND Broker can call this API endpoint.

Parameters ​

ParameterType
paramsCreateBrokerSubAccountRequestV3

Returns ​

Promise<APIResponse<CreateBrokerSubAccountResponseV3>>


createBrokerSubApiKey() ​

ts
createBrokerSubApiKey(params: CreateBrokerSubApiKeyRequestV3): Promise<APIResponse<CreateBrokerSubApiKeyResponseV3>>;

Create Broker Sub-Account API Key

Rate limit: 20/sec/UID Only the master account with a user type of ND Broker can call this API endpoint.

Parameters ​

ParameterType
paramsCreateBrokerSubApiKeyRequestV3

Returns ​

Promise<APIResponse<CreateBrokerSubApiKeyResponseV3>>


createCopyFutures() ​

ts
createCopyFutures(params: CreateCopyFuturesRequestV3): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsCreateCopyFuturesRequestV3

Returns ​

Promise<APIResponse<string>>


createGridBot() ​

ts
createGridBot(params: CreateGridBotRequestV3): Promise<APIResponse<GridBotIdResponseV3>>;

Parameters ​

ParameterType
paramsCreateGridBotRequestV3

Returns ​

Promise<APIResponse<GridBotIdResponseV3>>


createNeutralGridBot() ​

ts
createNeutralGridBot(params: CreateNeutralGridBotRequestV3): Promise<APIResponse<GridBotIdResponseV3>>;

Parameters ​

ParameterType
paramsCreateNeutralGridBotRequestV3

Returns ​

Promise<APIResponse<GridBotIdResponseV3>>


createP2pAd() ​

ts
createP2pAd(params: CreateP2pAdRequestV3): Promise<APIResponse<P2pCreateAdResponseV3>>;

Parameters ​

ParameterType
paramsCreateP2pAdRequestV3

Returns ​

Promise<APIResponse<P2pCreateAdResponseV3>>


createStpGroup() ​

ts
createStpGroup(params: CreateStpGroupRequestV3): Promise<APIResponse<CreateStpGroupResponseV3>>;

Create STP Group MM whitelist only. Sub-accounts in one group do not match each other.

Parameters ​

ParameterType
paramsCreateStpGroupRequestV3

Returns ​

Promise<APIResponse<CreateStpGroupResponseV3>>


createSubAccount() ​

ts
createSubAccount(params: CreateSubAccountRequestV3): Promise<APIResponse<CreateSubAccountResponseV3>>;

Create Sub-account

Parameters ​

ParameterType
paramsCreateSubAccountRequestV3

Returns ​

Promise<APIResponse<CreateSubAccountResponseV3>>


createSubAccountApiKey() ​

ts
createSubAccountApiKey(params: CreateSubAccountApiKeyRequestV3): Promise<APIResponse<CreateSubAccountApiKeyResponseV3>>;

Create Sub-account API Key

Parameters ​

ParameterType
paramsCreateSubAccountApiKeyRequestV3

Returns ​

Promise<APIResponse<CreateSubAccountApiKeyResponseV3>>


deleteBrokerSubApiKey() ​

ts
deleteBrokerSubApiKey(params: DeleteBrokerSubApiKeyRequestV3): Promise<APIResponse<null>>;

Delete Broker Subaccount Apikey

This endpoint has no response parameters. It returns the deletion result synchronously. Determine whether the deletion succeeded or failed (and the failure reason) based on the returned code and msg.

Rate limit: 20/sec/UID Only the master account with a user type of ND Broker can call this API endpoint.

Parameters ​

ParameterType
paramsDeleteBrokerSubApiKeyRequestV3

Returns ​

Promise<APIResponse<null>>


deletePrivate() ​

ts
deletePrivate(endpoint: string, params?: any): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.deletePrivate


deleteSubAccount() ​

ts
deleteSubAccount(params: DeleteSubAccountRequestV3): Promise<APIResponse<Record<string, never>>>;

Parameters ​

ParameterType
paramsDeleteSubAccountRequestV3

Returns ​

Promise<APIResponse<Record<string, never>>>


deleteSubAccountApiKey() ​

ts
deleteSubAccountApiKey(params: DeleteSubAccountApiKeyRequestV3): Promise<APIResponse<any>>;

Delete Sub-account API Key

Parameters ​

ParameterType
paramsDeleteSubAccountApiKeyRequestV3

Returns ​

Promise<APIResponse<any>>


downgradeAccountToClassic() ​

ts
downgradeAccountToClassic(): Promise<APIResponse<null>>;

Switch Account - Switch to classic account mode Only supports parent accounts. This endpoint is only used for switching to classic account mode. Please note that since the account switching process takes approximately 1 minute, the successful response you receive only indicates that the request has been received, and does not mean that the account has been successfully switched to the classic account. Please use the query switching status interface to confirm whether the account switching is successful.

Returns ​

Promise<APIResponse<null>>


earnRedeemSavings() ​

ts
earnRedeemSavings(params: RedeemSavingsRequestV3): Promise<APIResponse<RedeemSavingsResponseV3>>;

Redeem Savings. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
paramsRedeemSavingsRequestV3

Returns ​

Promise<APIResponse<RedeemSavingsResponseV3>>


earnSubscribeSavings() ​

ts
earnSubscribeSavings(params: SubscribeSavingsRequestV3): Promise<APIResponse<SubscribeSavingsResponseV3>>;

Subscribe Savings. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
paramsSubscribeSavingsRequestV3

Returns ​

Promise<APIResponse<SubscribeSavingsResponseV3>>


fetchLatencySummary() ​

ts
fetchLatencySummary(): Promise<any>;

Estimate request latency and the clock difference between the client and server. This SDK utility is intended for diagnostics, not an official exchange endpoint. Results are approximate and can vary between requests.

Returns ​

Promise<any>


fetchServerTime() ​

ts
fetchServerTime(): Promise<number>;

Returns ​

Promise<number>


freezeSubAccount() ​

ts
freezeSubAccount(params: FreezeSubAccountRequestV3): Promise<APIResponse<object>>;

Freeze/Unfreeze Sub-account

Parameters ​

ParameterType
paramsFreezeSubAccountRequestV3

Returns ​

Promise<APIResponse<object>>


get() ​

ts
get(endpoint: string, params?: any): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.get


getAccountInfo() ​

ts
getAccountInfo(): Promise<APIResponse<AccountInfoV3>>;

Query account metadata (UID, inviter, parent account, channel, IP whitelist, permissions). Rate limit: 5/sec/UID

Returns ​

Promise<APIResponse<AccountInfoV3>>


getAccountSettings() ​

ts
getAccountSettings(): Promise<APIResponse<AccountSettingsV3>>;

Get account settings (hold mode, margin mode, leverage, symbol/coin config). Rate limit: 20/sec/UID

Returns ​

Promise<APIResponse<AccountSettingsV3>>


getAgentCustomerAssets() ​

ts
getAgentCustomerAssets(params?: AgentCustomerAssetRequestV3): Promise<APIResponse<AgentCustomerAssetItemV3[]>>;

Get Agent Customer Asset. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
params?AgentCustomerAssetRequestV3

Returns ​

Promise<APIResponse<AgentCustomerAssetItemV3[]>>


getAgentCustomerCommissions() ​

ts
getAgentCustomerCommissions(params?: GetAgentCustomerCommissionsRequestV3): Promise<APIResponse<AgentCustomerCommissionsV3>>;

Get Agent Customer Commission. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
params?GetAgentCustomerCommissionsRequestV3

Returns ​

Promise<APIResponse<AgentCustomerCommissionsV3>>


getAgentCustomerDeposits() ​

ts
getAgentCustomerDeposits(params?: AgentCustomerDepositRequestV3): Promise<APIResponse<AgentCustomerDepositItemV3[]>>;

Get Agent Customer Deposit. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
params?AgentCustomerDepositRequestV3

Returns ​

Promise<APIResponse<AgentCustomerDepositItemV3[]>>


getAgentCustomerKycResult() ​

ts
getAgentCustomerKycResult(params?: GetAgentCustomerKycResultRequestV3): Promise<APIResponse<AgentCustomerKycResultV3>>;

Get Agent Customer Kyc Result. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
params?GetAgentCustomerKycResultRequestV3

Returns ​

Promise<APIResponse<AgentCustomerKycResultV3>>


getAgentCustomerList() ​

ts
getAgentCustomerList(params?: AgentCustomerListRequestV3): Promise<APIResponse<AgentCustomerListItemV3[]>>;

Get Agent Customer List. Rate limit: 10/sec/UID. Without startTime/endTime, returns all registered customers (no time restriction).

Parameters ​

ParameterType
params?AgentCustomerListRequestV3

Returns ​

Promise<APIResponse<AgentCustomerListItemV3[]>>


getAgentCustomerTradeVolume() ​

ts
getAgentCustomerTradeVolume(params?: AgentCustomerTradeVolumeRequestV3): Promise<APIResponse<AgentCustomerTradeVolumeItemV3[]>>;

Get Agent Customer Trade Volume. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
params?AgentCustomerTradeVolumeRequestV3

Returns ​

Promise<APIResponse<AgentCustomerTradeVolumeItemV3[]>>


getAgentSubCustomerList() ​

ts
getAgentSubCustomerList(params?: GetAgentSubCustomerListRequestV3): Promise<APIResponse<AgentSubCustomerListV3>>;

Get Agent Sub Customer List. Rate limit: 10/sec/UID. Without startTime/endTime, returns all registered customers (no time restriction).

Parameters ​

ParameterType
params?GetAgentSubCustomerListRequestV3

Returns ​

Promise<APIResponse<AgentSubCustomerListV3>>


getAllFeeRates() ​

ts
getAllFeeRates(params: GetAllFeeRatesRequestV3): Promise<APIResponse<AllSymbolFeeRateV3[]>>;

Get All Symbol Fee Rates - Query fee rates for all trading pairs under a product type

Parameters ​

ParameterType
paramsGetAllFeeRatesRequestV3

Returns ​

Promise<APIResponse<AllSymbolFeeRateV3[]>>


getAnnouncements() ​

ts
getAnnouncements(params: GetAnnouncementsRequestV3): Promise<APIResponse<AnnouncementV3[]>>;

Get announcements. Public responses can include annDesc and cTime; the exchange reference documents createdTime instead of cTime. Both timestamp fields are optional in the SDK type.

Parameters ​

ParameterType
paramsGetAnnouncementsRequestV3

Returns ​

Promise<APIResponse<AnnouncementV3[]>>


getBalances() ​

ts
getBalances(): Promise<APIResponse<AccountAssetsV3>>;

Get Account Assets

Returns ​

Promise<APIResponse<AccountAssetsV3>>

See ​

Read Unified Trading Account balances


getBrokerAllSubDepositWithdrawal() ​

ts
getBrokerAllSubDepositWithdrawal(params?: GetBrokerAllSubDepositWithdrawalRequestV3): Promise<APIResponse<GetBrokerAllSubDepositWithdrawalResponseV3>>;

Get All Broker Subaccount Deposit Withdrawal

Rate limit: 20/sec/UID Only the master account with a user type of ND Broker can call this API endpoint.

Parameters ​

ParameterType
params?GetBrokerAllSubDepositWithdrawalRequestV3

Returns ​

Promise<APIResponse<GetBrokerAllSubDepositWithdrawalResponseV3>>


getBrokerCommission() ​

ts
getBrokerCommission(params?: GetBrokerCommissionRequestV3): Promise<APIResponse<BrokerCommissionRecordV3[]>>;

Get Broker Commission

Rate limit: 20/sec/UID Only the master account with a user type of ND Broker can call this API endpoint.

Parameters ​

ParameterType
params?GetBrokerCommissionRequestV3

Returns ​

Promise<APIResponse<BrokerCommissionRecordV3[]>>


getBrokerOrderCommission() ​

ts
getBrokerOrderCommission(params?: GetBrokerOrderCommissionRequestV3): Promise<APIResponse<BrokerOrderCommissionV3>>;

Get Order Commission. Rate limit: 20/sec/UID.

Parameters ​

ParameterType
params?GetBrokerOrderCommissionRequestV3

Returns ​

Promise<APIResponse<BrokerOrderCommissionV3>>


getBrokerRebateInfo() ​

ts
getBrokerRebateInfo(params: GetBrokerRebateInfoRequestV3): Promise<APIResponse<BrokerRebateInfoV3>>;

Get Rebate Info. Rate limit: 20/sec/UID.

Parameters ​

ParameterType
paramsGetBrokerRebateInfoRequestV3

Returns ​

Promise<APIResponse<BrokerRebateInfoV3>>


getBrokerSubAccountList() ​

ts
getBrokerSubAccountList(params?: GetBrokerSubAccountListRequestV3): Promise<APIResponse<GetBrokerSubAccountListResponseV3>>;

Get Broker Sub-Account List

Rate limit: 20/sec/UID Only the master account with a user type of ND Broker can call this API endpoint.

Parameters ​

ParameterType
params?GetBrokerSubAccountListRequestV3

Returns ​

Promise<APIResponse<GetBrokerSubAccountListResponseV3>>


getBrokerSubApiKey() ​

ts
getBrokerSubApiKey(params: GetBrokerSubApiKeyRequestV3): Promise<APIResponse<GetBrokerSubApiKeyResponseV3>>;

Get Broker Sub-Account API Key

Rate limit: 20/sec/UID Only the master account with a user type of ND Broker can call this API endpoint.

Parameters ​

ParameterType
paramsGetBrokerSubApiKeyRequestV3

Returns ​

Promise<APIResponse<GetBrokerSubApiKeyResponseV3>>


getBrokerSubDepositAddress() ​

ts
getBrokerSubDepositAddress(params: GetBrokerSubDepositAddressRequestV3): Promise<APIResponse<BrokerSubDepositAddressV3>>;

Get Broker Subaccount Deposit Address

Rate limit: 20/sec/UID Only the master account with a user type of ND Broker can call this API endpoint.

Parameters ​

ParameterType
paramsGetBrokerSubDepositAddressRequestV3

Returns ​

Promise<APIResponse<BrokerSubDepositAddressV3>>


getBrokerTotalCommission() ​

ts
getBrokerTotalCommission(params?: GetBrokerTotalCommissionRequestV3): Promise<APIResponse<BrokerTotalCommissionV3[]>>;

Get Total Commission. Rate limit: 20/sec/UID.

Parameters ​

ParameterType
params?GetBrokerTotalCommissionRequestV3

Returns ​

Promise<APIResponse<BrokerTotalCommissionV3[]>>


getBrokerTradeVolume() ​

ts
getBrokerTradeVolume(params?: GetBrokerTradeVolumeRequestV3): Promise<APIResponse<BrokerTradeVolumeV3[]>>;

Get Broker Trade Volume. Rate limit: 5/sec/UID. Contact your BD or RM to apply for access permissions.

Parameters ​

ParameterType
params?GetBrokerTradeVolumeRequestV3

Returns ​

Promise<APIResponse<BrokerTradeVolumeV3[]>>


getCandles() ​

ts
getCandles(params: GetCandlesRequestV3): Promise<APIResponse<CandlestickV3[]>>;

Get Kline/Candlestick Maximum number of returned entries: 1,000

Parameters ​

ParameterType
paramsGetCandlesRequestV3

Returns ​

Promise<APIResponse<CandlestickV3[]>>


getCashDividendRecords() ​

ts
getCashDividendRecords(params: GetCashDividendRecordsRequestV3): Promise<APIResponse<CashDividendRecordV3[]>>;

Get Cash Dividend Records - RWA stock futures cash dividend records

Parameters ​

ParameterType
paramsGetCashDividendRecordsRequestV3

Returns ​

Promise<APIResponse<CashDividendRecordV3[]>>


getCfdCurrentPositions() ​

ts
getCfdCurrentPositions(params?: GetCfdCurrentPositionsRequestV3): Promise<APIResponse<CfdCurrentPositionV3[]>>;

Parameters ​

ParameterType
params?GetCfdCurrentPositionsRequestV3

Returns ​

Promise<APIResponse<CfdCurrentPositionV3[]>>


getCfdFinancialRecords() ​

ts
getCfdFinancialRecords(params?: GetCfdFinancialRecordsRequestV3): Promise<APIResponse<CfdFinancialRecordV3[]>>;

Parameters ​

ParameterType
params?GetCfdFinancialRecordsRequestV3

Returns ​

Promise<APIResponse<CfdFinancialRecordV3[]>>


getCfdFundDetail() ​

ts
getCfdFundDetail(): Promise<APIResponse<CfdFundDetailV3>>;

Returns ​

Promise<APIResponse<CfdFundDetailV3>>


getCfdHistoryCandlestick() ​

ts
getCfdHistoryCandlestick(params: GetCfdHistoryCandlestickRequestV3): Promise<APIResponse<CfdCandlestickV3[]>>;

Parameters ​

ParameterType
paramsGetCfdHistoryCandlestickRequestV3

Returns ​

Promise<APIResponse<CfdCandlestickV3[]>>


getCfdInstruments() ​

ts
getCfdInstruments(params?: GetCfdInstrumentsRequestV3): Promise<APIResponse<CfdInstrumentV3[]>>;

Parameters ​

ParameterType
params?GetCfdInstrumentsRequestV3

Returns ​

Promise<APIResponse<CfdInstrumentV3[]>>


getCfdOrderHistory() ​

ts
getCfdOrderHistory(params: GetCfdOrderHistoryRequestV3): Promise<APIResponse<CfdOrderHistoryV3>>;

Get CFD Order History cursor is omitted on the first page. Later pages pass the last orderId. The first page may return more rows than limit.

Parameters ​

ParameterType
paramsGetCfdOrderHistoryRequestV3

Returns ​

Promise<APIResponse<CfdOrderHistoryV3>>


getCfdTickers() ​

ts
getCfdTickers(params?: GetCfdTickersRequestV3): Promise<APIResponse<CfdTickerV3[]>>;

=====CFD======= endpoints

Parameters ​

ParameterType
params?GetCfdTickersRequestV3

Returns ​

Promise<APIResponse<CfdTickerV3[]>>


getCfdTransferRecords() ​

ts
getCfdTransferRecords(params?: GetCfdTransferRecordsRequestV3): Promise<APIResponse<CfdTransferRecordsV3>>;

Parameters ​

ParameterType
params?GetCfdTransferRecordsRequestV3

Returns ​

Promise<APIResponse<CfdTransferRecordsV3>>


getCfdUnfilledOrders() ​

ts
getCfdUnfilledOrders(params?: GetCfdUnfilledOrdersRequestV3): Promise<APIResponse<CfdUnfilledOrderV3[]>>;

Parameters ​

ParameterType
params?GetCfdUnfilledOrdersRequestV3

Returns ​

Promise<APIResponse<CfdUnfilledOrderV3[]>>


getClientType() ​

ts
getClientType(): "v3";

Defines the client type (affecting how requests & signatures behave)

Returns ​

"v3"

Overrides ​

BaseRestClient.getClientType


getCoins() ​

ts
getCoins(params?: GetCoinsRequestV3): Promise<APIResponse<MarketCoinV3[]>>;

Get coin and chain information. Public responses can use withdrawMinScale; the exchange reference documents withdrawPrecision instead.

Parameters ​

ParameterType
params?GetCoinsRequestV3

Returns ​

Promise<APIResponse<MarketCoinV3[]>>


getCollateralType() ​

ts
getCollateralType(): Promise<APIResponse<CollateralTypeConfigV3>>;

Get Collateral Type - Query unified account collateral configuration

Returns ​

Promise<APIResponse<CollateralTypeConfigV3>>


getContractsOi() ​

ts
getContractsOi(params: GetContractsOiRequestV3): Promise<APIResponse<ContractOiV3[]>>;

Get Open Interest Limit

Parameters ​

ParameterType
paramsGetContractsOiRequestV3

Returns ​

Promise<APIResponse<ContractOiV3[]>>


getConvertRecords() ​

ts
getConvertRecords(params: GetConvertRecordsRequestV3): Promise<APIResponse<{
  cursor: string;
  list: ConvertRecordV3[];
}>>;

Get Convert Records

Parameters ​

ParameterType
paramsGetConvertRecordsRequestV3

Returns ​

Promise<APIResponse<{ cursor: string; list: ConvertRecordV3[]; }>>


getCopyFuturesCopyMaxTransferable() ​

ts
getCopyFuturesCopyMaxTransferable(params: GetCopyFuturesCopyMaxTransferableRequestV3): Promise<APIResponse<CopyFuturesCopyMaxTransferableV3>>;

Max transferable amount of a follower copy account for one coin. Not the lead-account max-transferable endpoint. Requires projectId. Rate limit: 1/sec/UID.

Parameters ​

ParameterType
paramsGetCopyFuturesCopyMaxTransferableRequestV3

Returns ​

Promise<APIResponse<CopyFuturesCopyMaxTransferableV3>>


getCopyFuturesCopyProfitDetails() ​

ts
getCopyFuturesCopyProfitDetails(params: GetCopyFuturesCopyProfitDetailsRequestV3): Promise<APIResponse<CopyFuturesCopyProfitDetailsV3>>;

Parameters ​

ParameterType
paramsGetCopyFuturesCopyProfitDetailsRequestV3

Returns ​

Promise<APIResponse<CopyFuturesCopyProfitDetailsV3>>


getCopyFuturesCopySettings() ​

ts
getCopyFuturesCopySettings(params: GetCopyFuturesCopySettingsRequestV3): Promise<APIResponse<CopyFuturesCopySettingsV3>>;

Parameters ​

ParameterType
paramsGetCopyFuturesCopySettingsRequestV3

Returns ​

Promise<APIResponse<CopyFuturesCopySettingsV3>>


getCopyFuturesCurrentCopy() ​

ts
getCopyFuturesCurrentCopy(params: GetCopyFuturesCurrentCopyRequestV3): Promise<APIResponse<CopyFuturesCurrentCopyV3>>;

Parameters ​

ParameterType
paramsGetCopyFuturesCurrentCopyRequestV3

Returns ​

Promise<APIResponse<CopyFuturesCurrentCopyV3>>


getCopyFuturesCurrentFollowers() ​

ts
getCopyFuturesCurrentFollowers(params?: GetCopyFuturesFollowersRequestV3): Promise<APIResponse<CopyFuturesCurrentFollowersV3>>;

Parameters ​

ParameterType
params?GetCopyFuturesFollowersRequestV3

Returns ​

Promise<APIResponse<CopyFuturesCurrentFollowersV3>>


getCopyFuturesCurrentPositions() ​

ts
getCopyFuturesCurrentPositions(params: GetCopyFuturesCurrentPositionsRequestV3): Promise<APIResponse<CopyFuturesFollowerPositionsV3>>;

Parameters ​

ParameterType
paramsGetCopyFuturesCurrentPositionsRequestV3

Returns ​

Promise<APIResponse<CopyFuturesFollowerPositionsV3>>


getCopyFuturesCurrentTpSlOrders() ​

ts
getCopyFuturesCurrentTpSlOrders(params: GetCopyFuturesCurrentTpSlOrdersRequestV3): Promise<APIResponse<CopyFuturesCurrentTpSlOrdersV3>>;

Parameters ​

ParameterType
paramsGetCopyFuturesCurrentTpSlOrdersRequestV3

Returns ​

Promise<APIResponse<CopyFuturesCurrentTpSlOrdersV3>>


getCopyFuturesFollowerTransferRecords() ​

ts
getCopyFuturesFollowerTransferRecords(params: GetCopyFuturesFollowerTransferRecordRequestV3): Promise<APIResponse<CopyFuturesFollowerTransferRecordListV3>>;

Parameters ​

ParameterType
paramsGetCopyFuturesFollowerTransferRecordRequestV3

Returns ​

Promise<APIResponse<CopyFuturesFollowerTransferRecordListV3>>


getCopyFuturesHistoryFollowers() ​

ts
getCopyFuturesHistoryFollowers(params?: GetCopyFuturesFollowersRequestV3): Promise<APIResponse<CopyFuturesHistoryFollowersV3>>;

Parameters ​

ParameterType
params?GetCopyFuturesFollowersRequestV3

Returns ​

Promise<APIResponse<CopyFuturesHistoryFollowersV3>>


getCopyFuturesMaxTransferable() ​

ts
getCopyFuturesMaxTransferable(params: GetCopyFuturesMaxTransferableRequestV3): Promise<APIResponse<CopyFuturesMaxTransferableV3>>;

Get max transferable amount and available balance for the copy-trading lead account. Rate limit: 1/sec/UID.

Parameters ​

ParameterType
paramsGetCopyFuturesMaxTransferableRequestV3

Returns ​

Promise<APIResponse<CopyFuturesMaxTransferableV3>>


getCopyFuturesPortfolioOverview() ​

ts
getCopyFuturesPortfolioOverview(params: GetCopyFuturesPortfolioOverviewRequestV3): Promise<APIResponse<CopyFuturesPortfolioOverviewV3>>;

Parameters ​

ParameterType
paramsGetCopyFuturesPortfolioOverviewRequestV3

Returns ​

Promise<APIResponse<CopyFuturesPortfolioOverviewV3>>


getCopyFuturesPositionSummary() ​

ts
getCopyFuturesPositionSummary(): Promise<APIResponse<CopyFuturesPositionSummaryV3[]>>;

Get copy-trading position summary

Rate limit: 5/sec/UID. Permission: Unified Account — Futures Copy-Trading Positions — Read-only.

Returns ​

Promise<APIResponse<CopyFuturesPositionSummaryV3[]>>


getCopyFuturesProfitDetails() ​

ts
getCopyFuturesProfitDetails(params?: GetCopyFuturesProfitDetailsRequestV3): Promise<APIResponse<CopyFuturesProfitDetailsV3>>;

Parameters ​

ParameterType
params?GetCopyFuturesProfitDetailsRequestV3

Returns ​

Promise<APIResponse<CopyFuturesProfitDetailsV3>>


getCopyFuturesProfitSummary() ​

ts
getCopyFuturesProfitSummary(): Promise<APIResponse<CopyFuturesProfitSummaryV3>>;

Returns ​

Promise<APIResponse<CopyFuturesProfitSummaryV3>>


getCopyFuturesTpSlOrderHistory() ​

ts
getCopyFuturesTpSlOrderHistory(params: GetCopyFuturesTpSlOrderHistoryRequestV3): Promise<APIResponse<CopyFuturesTpSlOrderHistoryV3>>;

Parameters ​

ParameterType
paramsGetCopyFuturesTpSlOrderHistoryRequestV3

Returns ​

Promise<APIResponse<CopyFuturesTpSlOrderHistoryV3>>


getCopyFuturesTradingPairs() ​

ts
getCopyFuturesTradingPairs(): Promise<APIResponse<CopyFuturesTradingPairV3[]>>;

Get copy-trading trading pair information

Rate limit: 5/sec/UID. Permission: Unified Account — Futures Copy-Trading Orders — Read-only.

Returns ​

Promise<APIResponse<CopyFuturesTradingPairV3[]>>


getCopyFuturesTransferRecords() ​

ts
getCopyFuturesTransferRecords(params?: GetCopyFuturesTransferRecordRequestV3): Promise<APIResponse<CopyFuturesTransferRecordListV3>>;

Query copy-trading lead account transfer history. Rate limit: 1/sec/UID.

Parameters ​

ParameterType
params?GetCopyFuturesTransferRecordRequestV3

Returns ​

Promise<APIResponse<CopyFuturesTransferRecordListV3>>


getCurrentFundingRate() ​

ts
getCurrentFundingRate(params: GetCurrentFundingRateRequestV3): Promise<APIResponse<CurrentFundingRateV3[]>>;

Get Current Funding Rate

Parameters ​

ParameterType
paramsGetCurrentFundingRateRequestV3

Returns ​

Promise<APIResponse<CurrentFundingRateV3[]>>


getCurrentPosition() ​

ts
getCurrentPosition(params: GetCurrentPositionRequestV3): Promise<APIResponse<{
  list: CurrentPositionV3[] | null;
}>>;

Get Position Info

Parameters ​

ParameterType
paramsGetCurrentPositionRequestV3

Returns ​

Promise<APIResponse<{ list: CurrentPositionV3[] | null; }>>


getCustomCollateralCoins() ​

ts
getCustomCollateralCoins(): Promise<APIResponse<CustomCollateralCoinV3[]>>;

Get Custom Collateral Coins - Platform-supported custom collateral coins

Returns ​

Promise<APIResponse<CustomCollateralCoinV3[]>>


getDeductInfo() ​

ts
getDeductInfo(): Promise<APIResponse<{
  deduct: "off" | "on";
}>>;

Get Deduct Info - Get BGB deduction status

Returns ​

Promise<APIResponse<{ deduct: "off" | "on"; }>>


getDeltaInfo() ​

ts
getDeltaInfo(): Promise<APIResponse<AccountDeltaInfoV3>>;

Delta-neutral metrics (equity ratio, thresholds, per-coin position ratios). Only available when the account is in delta-neutral mode. Rate limit: 20/sec/UID.

Returns ​

Promise<APIResponse<AccountDeltaInfoV3>>


getDepositAddress() ​

ts
getDepositAddress(params: GetDepositAddressRequestV3): Promise<APIResponse<DepositAddressV3>>;

Get Deposit Address

Parameters ​

ParameterType
paramsGetDepositAddressRequestV3

Returns ​

Promise<APIResponse<DepositAddressV3>>


getDepositRecords() ​

ts
getDepositRecords(params: GetDepositRecordsRequestV3): Promise<APIResponse<DepositRecordV3[]>>;

Get Deposit Records

Parameters ​

ParameterType
paramsGetDepositRecordsRequestV3

Returns ​

Promise<APIResponse<DepositRecordV3[]>>


getDiscountRate() ​

ts
getDiscountRate(): Promise<APIResponse<DiscountRateV3[]>>;

Get Discount Rate

Returns ​

Promise<APIResponse<DiscountRateV3[]>>


getEarnCashPlusHistoryOrders() ​

ts
getEarnCashPlusHistoryOrders(params?: GetEarnCashPlusHistoryOrdersRequestV3): Promise<APIResponse<EarnCashPlusHistoryOrdersV3>>;

Cash+ history. Pass nextCursor as cursor. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
params?GetEarnCashPlusHistoryOrdersRequestV3

Returns ​

Promise<APIResponse<EarnCashPlusHistoryOrdersV3>>


getEarnCashPlusPositions() ​

ts
getEarnCashPlusPositions(): Promise<APIResponse<EarnCashPlusPositionV3>>;

Cash+ holding, cumulative profit, and APR. Rate limit: 10/sec/UID.

Returns ​

Promise<APIResponse<EarnCashPlusPositionV3>>


getEarnCashPlusRedeemInfo() ​

ts
getEarnCashPlusRedeemInfo(): Promise<APIResponse<EarnCashPlusRedeemInfoV3>>;

Cash+ redemption prerequisites: credited coins and the redeemable position. Rate limit: 10/sec/UID.

Returns ​

Promise<APIResponse<EarnCashPlusRedeemInfoV3>>


getEarnCashPlusRedeemResult() ​

ts
getEarnCashPlusRedeemResult(params: GetEarnCashPlusRedeemResultRequestV3): Promise<APIResponse<EarnCashPlusRedeemStatusV3>>;

Result of a Cash+ redemption order. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
paramsGetEarnCashPlusRedeemResultRequestV3

Returns ​

Promise<APIResponse<EarnCashPlusRedeemStatusV3>>


getEarnCashPlusSubscribeInfo() ​

ts
getEarnCashPlusSubscribeInfo(): Promise<APIResponse<EarnCashPlusSubscribeInfoV3>>;

Cash+ subscription prerequisites: APR and the subscribable coin list. Rate limit: 10/sec/UID.

Returns ​

Promise<APIResponse<EarnCashPlusSubscribeInfoV3>>


getEarnCashPlusSubscribeResult() ​

ts
getEarnCashPlusSubscribeResult(params: GetEarnCashPlusSubscribeResultRequestV3): Promise<APIResponse<EarnCashPlusSubscribeStatusV3>>;

Result of a Cash+ subscription order. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
paramsGetEarnCashPlusSubscribeResultRequestV3

Returns ​

Promise<APIResponse<EarnCashPlusSubscribeStatusV3>>


getEarnEliteAssets() ​

ts
getEarnEliteAssets(): Promise<APIResponse<EarnEliteAssetsV3>>;

Returns ​

Promise<APIResponse<EarnEliteAssetsV3>>


getEarnEliteProducts() ​

ts
getEarnEliteProducts(): Promise<APIResponse<EarnEliteProductV3[]>>;

=====Earn | On-Chain Elite (UTA)=====

Returns ​

Promise<APIResponse<EarnEliteProductV3[]>>


getEarnEliteRecords() ​

ts
getEarnEliteRecords(params: GetEarnEliteRecordsRequestV3): Promise<APIResponse<EarnEliteRecordsV3>>;

Parameters ​

ParameterType
paramsGetEarnEliteRecordsRequestV3

Returns ​

Promise<APIResponse<EarnEliteRecordsV3>>


getEarnEliteRedeemInfo() ​

ts
getEarnEliteRedeemInfo(params: GetEarnEliteRedeemInfoRequestV3): Promise<APIResponse<EarnEliteRedeemInfoV3>>;

Parameters ​

ParameterType
paramsGetEarnEliteRedeemInfoRequestV3

Returns ​

Promise<APIResponse<EarnEliteRedeemInfoV3>>


getEarnEliteSubscribeInfo() ​

ts
getEarnEliteSubscribeInfo(params: GetEarnEliteSubscribeInfoRequestV3): Promise<APIResponse<EarnEliteSubscribeInfoV3>>;

Parameters ​

ParameterType
paramsGetEarnEliteSubscribeInfoRequestV3

Returns ​

Promise<APIResponse<EarnEliteSubscribeInfoV3>>


getEarnEliteSubscribeResult() ​

ts
getEarnEliteSubscribeResult(params: GetEarnEliteSubscribeResultRequestV3): Promise<APIResponse<EarnEliteSubscribeStatusV3>>;

Parameters ​

ParameterType
paramsGetEarnEliteSubscribeResultRequestV3

Returns ​

Promise<APIResponse<EarnEliteSubscribeStatusV3>>


getEarnSavingsAccount() ​

ts
getEarnSavingsAccount(): Promise<APIResponse<EarnSavingsAccountV3>>;

Savings Account. Rate limit: 10/sec/UID.

Returns ​

Promise<APIResponse<EarnSavingsAccountV3>>


getEarnSavingsAssets() ​

ts
getEarnSavingsAssets(params: GetEarnSavingsAssetsRequestV3): Promise<APIResponse<EarnSavingsAssetsV3>>;

Savings Assets. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
paramsGetEarnSavingsAssetsRequestV3

Returns ​

Promise<APIResponse<EarnSavingsAssetsV3>>


getEarnSavingsProducts() ​

ts
getEarnSavingsProducts(params?: GetEarnSavingsProductsRequestV3): Promise<APIResponse<EarnSavingsProductV3[]>>;

Get Savings Product List. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
params?GetEarnSavingsProductsRequestV3

Returns ​

Promise<APIResponse<EarnSavingsProductV3[]>>


getEarnSavingsRecords() ​

ts
getEarnSavingsRecords(params: GetEarnSavingsRecordsRequestV3): Promise<APIResponse<EarnSavingsRecordsV3>>;

Savings Records. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
paramsGetEarnSavingsRecordsRequestV3

Returns ​

Promise<APIResponse<EarnSavingsRecordsV3>>


getEarnSavingsRedemptionResult() ​

ts
getEarnSavingsRedemptionResult(params: GetEarnSavingsRedemptionResultRequestV3): Promise<APIResponse<EarnSavingsRedemptionResultV3>>;

Savings Redemption Results. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
paramsGetEarnSavingsRedemptionResultRequestV3

Returns ​

Promise<APIResponse<EarnSavingsRedemptionResultV3>>


getEarnSavingsSubscription() ​

ts
getEarnSavingsSubscription(params: GetEarnSavingsSubscriptionRequestV3): Promise<APIResponse<EarnSavingsSubscriptionDetailV3>>;

Savings Subscription Detail. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
paramsGetEarnSavingsSubscriptionRequestV3

Returns ​

Promise<APIResponse<EarnSavingsSubscriptionDetailV3>>


getEarnSavingsSubscriptionResult() ​

ts
getEarnSavingsSubscriptionResult(params: GetEarnSavingsSubscriptionResultRequestV3): Promise<APIResponse<EarnSavingsSubscriptionResultV3>>;

Savings Subscription Result. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
paramsGetEarnSavingsSubscriptionResultRequestV3

Returns ​

Promise<APIResponse<EarnSavingsSubscriptionResultV3>>


getEligibleDiscountRate() ​

ts
getEligibleDiscountRate(params?: GetEligibleDiscountRateRequestV3): Promise<APIResponse<EligibleDiscountRateV3[]>>;

Parameters ​

ParameterType
params?GetEligibleDiscountRateRequestV3

Returns ​

Promise<APIResponse<EligibleDiscountRateV3[]>>


getEligibleLoanInfo() ​

ts
getEligibleLoanInfo(params?: GetEligibleLoanInfoRequestV3): Promise<APIResponse<EligibleLoanInfoV3[]>>;

Parameters ​

ParameterType
params?GetEligibleLoanInfoRequestV3

Returns ​

Promise<APIResponse<EligibleLoanInfoV3[]>>


getEligibleMarginTier() ​

ts
getEligibleMarginTier(params?: GetEligibleMarginTierRequestV3): Promise<APIResponse<EligibleMarginTierV3[]>>;

Parameters ​

ParameterType
params?GetEligibleMarginTierRequestV3

Returns ​

Promise<APIResponse<EligibleMarginTierV3[]>>


getEligibleSymbols() ​

ts
getEligibleSymbols(params?: GetEligibleSymbolsRequestV3): Promise<APIResponse<EligibleSymbolV3[]>>;

Parameters ​

ParameterType
params?GetEligibleSymbolsRequestV3

Returns ​

Promise<APIResponse<EligibleSymbolV3[]>>


getFeeRate() ​

ts
getFeeRate(params: GetFeeRateRequestV3): Promise<APIResponse<{
  makerFeeRate: string;
  takerFeeRate: string;
}>>;

Get Trading Fee Rate

Parameters ​

ParameterType
paramsGetFeeRateRequestV3

Returns ​

Promise<APIResponse<{ makerFeeRate: string; takerFeeRate: string; }>>


getFills() ​

ts
getFills(params: GetPublicFillsRequestV3): Promise<APIResponse<PublicFillV3[]>>;

Get Recent Public Fills

Parameters ​

ParameterType
paramsGetPublicFillsRequestV3

Returns ​

Promise<APIResponse<PublicFillV3[]>>


getFinancialRecords() ​

ts
getFinancialRecords(params: GetFinancialRecordsRequestV3): Promise<APIResponse<{
  cursor: string | null;
  list: FinancialRecordV3[] | null;
}>>;

Get Financial Records

Parameters ​

ParameterType
paramsGetFinancialRecordsRequestV3

Returns ​

Promise<APIResponse<{ cursor: string | null; list: FinancialRecordV3[] | null; }>>


getFundingAssets() ​

ts
getFundingAssets(params?: GetFundingAssetsRequestV3): Promise<APIResponse<FundingAssetV3[]>>;

Get Fund Account Assets

Parameters ​

ParameterType
params?GetFundingAssetsRequestV3

Returns ​

Promise<APIResponse<FundingAssetV3[]>>


getFundingFinancialRecords() ​

ts
getFundingFinancialRecords(params?: GetFundingFinancialRecordsRequestV3): Promise<APIResponse<{
  cursor: string;
  list: FundingFinancialRecordV3[];
}>>;

Parameters ​

ParameterType
params?GetFundingFinancialRecordsRequestV3

Returns ​

Promise<APIResponse<{ cursor: string; list: FundingFinancialRecordV3[]; }>>


getFuturesAccountLongShort() ​

ts
getFuturesAccountLongShort(params: GetFuturesTradingDataRequestV3): Promise<APIResponse<FuturesAccountLongShortV3[]>>;

Get Futures Active Long Short Account Data

Parameters ​

ParameterType
paramsGetFuturesTradingDataRequestV3

Returns ​

Promise<APIResponse<FuturesAccountLongShortV3[]>>


getFuturesActiveBuySell() ​

ts
getFuturesActiveBuySell(params: GetFuturesTradingDataRequestV3): Promise<APIResponse<FuturesActiveBuySellV3[]>>;

Get Futures Active Buy Sell Volume Data

Parameters ​

ParameterType
paramsGetFuturesTradingDataRequestV3

Returns ​

Promise<APIResponse<FuturesActiveBuySellV3[]>>


getFuturesLongShort() ​

ts
getFuturesLongShort(params: GetFuturesTradingDataRequestV3): Promise<APIResponse<FuturesLongShortV3[]>>;

Get Futures Long Short Ratio Data

Parameters ​

ParameterType
paramsGetFuturesTradingDataRequestV3

Returns ​

Promise<APIResponse<FuturesLongShortV3[]>>


getFuturesPositionLongShort() ​

ts
getFuturesPositionLongShort(params: GetFuturesTradingDataRequestV3): Promise<APIResponse<FuturesPositionLongShortV3[]>>;

Get Futures Active Long Short Position Data

Parameters ​

ParameterType
paramsGetFuturesTradingDataRequestV3

Returns ​

Promise<APIResponse<FuturesPositionLongShortV3[]>>


getGridBotDetail() ​

ts
getGridBotDetail(params: GetGridBotDetailRequestV3): Promise<APIResponse<GridBotDetailV3>>;

Parameters ​

ParameterType
paramsGetGridBotDetailRequestV3

Returns ​

Promise<APIResponse<GridBotDetailV3>>


getGridBotOrderDetails() ​

ts
getGridBotOrderDetails(params: GetGridBotOrderDetailsRequestV3): Promise<APIResponse<GridBotOrderDetailsV3>>;

Parameters ​

ParameterType
paramsGetGridBotOrderDetailsRequestV3

Returns ​

Promise<APIResponse<GridBotOrderDetailsV3>>


getHistoryCandles() ​

ts
getHistoryCandles(params: GetHistoryCandlesRequestV3): Promise<APIResponse<CandlestickV3[]>>;

Get Kline/Candlestick History

Parameters ​

ParameterType
paramsGetHistoryCandlesRequestV3

Returns ​

Promise<APIResponse<CandlestickV3[]>>


getHistoryFundingRate() ​

ts
getHistoryFundingRate(params: GetHistoryFundingRateRequestV3): Promise<APIResponse<HistoryFundingRateV3[]>>;

Get Funding Rate History

Parameters ​

ParameterType
paramsGetHistoryFundingRateRequestV3

Returns ​

Promise<APIResponse<HistoryFundingRateV3[]>>


getHistoryOrders() ​

ts
getHistoryOrders(params: GetHistoryOrdersRequestV3): Promise<APIResponse<{
  cursor: string;
  list: HistoryOrderV3[];
}>>;

Get Order History

Parameters ​

ParameterType
paramsGetHistoryOrdersRequestV3

Returns ​

Promise<APIResponse<{ cursor: string; list: HistoryOrderV3[]; }>>

See ​

UTA order management


getHistoryStrategyOrders() ​

ts
getHistoryStrategyOrders(params: GetHistoryStrategyOrdersRequestV3): Promise<APIResponse<{
  cursor?: string | number;
  list: StrategyOrderV3[];
}>>;

Get Strategy Order History

Parameters ​

ParameterType
paramsGetHistoryStrategyOrdersRequestV3

Returns ​

Promise<APIResponse<{ cursor?: string | number; list: StrategyOrderV3[]; }>>


getIndexComponents() ​

ts
getIndexComponents(params: GetIndexComponentsRequestV3): Promise<APIResponse<IndexPriceComponentsV3>>;

Get Index Price Components

Parameters ​

ParameterType
paramsGetIndexComponentsRequestV3

Returns ​

Promise<APIResponse<IndexPriceComponentsV3>>


getInstruments() ​

ts
getInstruments(params: GetInstrumentsRequestV3): Promise<APIResponse<InstrumentV3[]>>;

Get instrument specifications. instrumentType identifies the asset class; symbolType is deprecated. Traditional-finance metadata includes fullName, marketRegion and isin. Do not assume absent metadata is always null.

Parameters ​

ParameterType
paramsGetInstrumentsRequestV3

Returns ​

Promise<APIResponse<InstrumentV3[]>>


getInterestRateHistory() ​

ts
getInterestRateHistory(params: GetInterestRateHistoryRequestV3): Promise<APIResponse<InterestRateHistoryV3>>;

Get historical margin borrowing rates. Select the tier with level (vip0–vip7 or pro1–pro6); the default is vip0. Requires UTA management read permission.

Parameters ​

ParameterType
paramsGetInterestRateHistoryRequestV3

Returns ​

Promise<APIResponse<InterestRateHistoryV3>>


getLiquidations() ​

ts
getLiquidations(params: GetLiquidationsRequestV3): Promise<APIResponse<LiquidationsV3>>;

Get Liquidations History - Query historical liquidation order data (last 3 days)

Parameters ​

ParameterType
paramsGetLiquidationsRequestV3

Returns ​

Promise<APIResponse<LiquidationsV3>>


getLoanBorrowHistory() ​

ts
getLoanBorrowHistory(params: GetLoanBorrowHistoryRequestV3): Promise<APIResponse<LoanBorrowHistoryItemV3[]>>;

Get Borrow History - Query borrowing history

Parameters ​

ParameterType
paramsGetLoanBorrowHistoryRequestV3

Returns ​

Promise<APIResponse<LoanBorrowHistoryItemV3[]>>


getLoanBorrowOngoing() ​

ts
getLoanBorrowOngoing(params?: GetLoanBorrowOngoingRequestV3): Promise<APIResponse<LoanBorrowOngoingItemV3[]>>;

Get Borrow Ongoing - Query current borrowings

Parameters ​

ParameterType
params?GetLoanBorrowOngoingRequestV3

Returns ​

Promise<APIResponse<LoanBorrowOngoingItemV3[]>>


getLoanCoins() ​

ts
getLoanCoins(params?: GetLoanCoinsRequestV3): Promise<APIResponse<GetLoanCoinsResponseV3>>;

Get Loan Coins - Query supported collateral currencies and borrowable coins

Parameters ​

ParameterType
params?GetLoanCoinsRequestV3

Returns ​

Promise<APIResponse<GetLoanCoinsResponseV3>>


getLoanData() ​

ts
getLoanData(): Promise<APIResponse<LoanDataV3>>;

Get Loan Data - Query current loan data for the unified trading account

Returns ​

Promise<APIResponse<LoanDataV3>>


getLoanDebts() ​

ts
getLoanDebts(): Promise<APIResponse<GetLoanDebtsResponseV3>>;

Get Loan Debts - Query assets and liabilities

Returns ​

Promise<APIResponse<GetLoanDebtsResponseV3>>


getLoanInterest() ​

ts
getLoanInterest(params: GetLoanInterestRequestV3): Promise<APIResponse<GetLoanInterestResponseV3>>;

Get Loan Interest - Query estimated interest and borrowable amount

Parameters ​

ParameterType
paramsGetLoanInterestRequestV3

Returns ​

Promise<APIResponse<GetLoanInterestResponseV3>>


getLoanLTVConvert() ​

ts
getLoanLTVConvert(params?: GetLTVConvertRequestV3): Promise<APIResponse<LTVConvertResponseV3>>;

Get LTV

Parameters ​

ParameterType
params?GetLTVConvertRequestV3

Returns ​

Promise<APIResponse<LTVConvertResponseV3>>


getLoanMarginCoinInfo() ​

ts
getLoanMarginCoinInfo(params: GetEnsureCoinsRequestV3): Promise<APIResponse<{
  coinInfo: CoinInfoV3[];
  productId: string;
}>>;

Get Margin Coin Info

Parameters ​

ParameterType
paramsGetEnsureCoinsRequestV3

Returns ​

Promise<APIResponse<{ coinInfo: CoinInfoV3[]; productId: string; }>>


getLoanOrder() ​

ts
getLoanOrder(params?: GetLoanOrderRequestV3): Promise<APIResponse<LoanOrderV3[]>>;

Get Loan Orders

Parameters ​

ParameterType
params?GetLoanOrderRequestV3

Returns ​

Promise<APIResponse<LoanOrderV3[]>>


getLoanPledgeRateHistory() ​

ts
getLoanPledgeRateHistory(params: GetLoanPledgeRateHistoryRequestV3): Promise<APIResponse<LoanPledgeRateHistoryItemV3[]>>;

Get Pledge Rate History - Query collateral ratio history

Parameters ​

ParameterType
paramsGetLoanPledgeRateHistoryRequestV3

Returns ​

Promise<APIResponse<LoanPledgeRateHistoryItemV3[]>>


getLoanProductInfo() ​

ts
getLoanProductInfo(params: GetProductInfosRequestV3): Promise<APIResponse<LoanProductInfoV3>>;

Get Product Info

Parameters ​

ParameterType
paramsGetProductInfosRequestV3

Returns ​

Promise<APIResponse<LoanProductInfoV3>>


getLoanReduces() ​

ts
getLoanReduces(params: GetLoanReducesRequestV3): Promise<APIResponse<LoanReduceItemV3[]>>;

Get Loan Reduces - Query liquidation records

Parameters ​

ParameterType
paramsGetLoanReducesRequestV3

Returns ​

Promise<APIResponse<LoanReduceItemV3[]>>


getLoanRepaidHistory() ​

ts
getLoanRepaidHistory(params?: GetRepaidHistoryRequestV3): Promise<APIResponse<RepaidHistoryItemV3[]>>;

Get Repayment Orders

Parameters ​

ParameterType
params?GetRepaidHistoryRequestV3

Returns ​

Promise<APIResponse<RepaidHistoryItemV3[]>>


getLoanRepayHistory() ​

ts
getLoanRepayHistory(params: GetLoanRepayHistoryRequestV3): Promise<APIResponse<LoanRepayHistoryItemV3[]>>;

Get Repay History - Query repayment history

Parameters ​

ParameterType
paramsGetLoanRepayHistoryRequestV3

Returns ​

Promise<APIResponse<LoanRepayHistoryItemV3[]>>


getLoanRiskUnit() ​

ts
getLoanRiskUnit(): Promise<APIResponse<{
  riskUnitId: string[];
}>>;

Get Risk Unit

Returns ​

Promise<APIResponse<{ riskUnitId: string[]; }>>


getLoanSymbols() ​

ts
getLoanSymbols(params: GetSymbolsRequestV3): Promise<APIResponse<LoanSymbolsV3>>;

Get Trade Symbols

Parameters ​

ParameterType
paramsGetSymbolsRequestV3

Returns ​

Promise<APIResponse<LoanSymbolsV3>>


getLoanTransfered() ​

ts
getLoanTransfered(params: GetTransferedRequestV3): Promise<APIResponse<LoanTransfersV3>>;

Get Transferred Quantity

Parameters ​

ParameterType
paramsGetTransferedRequestV3

Returns ​

Promise<APIResponse<LoanTransfersV3>>


getMarginIsolatedBorrow() ​

ts
getMarginIsolatedBorrow(params: GetMarginIsolatedBorrowRequestV3): Promise<APIResponse<MarginIsolatedBorrowV3[]>>;

Get Isolated Margin Borrowing Ratio Data

Parameters ​

ParameterType
paramsGetMarginIsolatedBorrowRequestV3

Returns ​

Promise<APIResponse<MarginIsolatedBorrowV3[]>>


getMarginLoanGrowth() ​

ts
getMarginLoanGrowth(params: GetMarginLoanGrowthRequestV3): Promise<APIResponse<MarginLoanGrowthV3[]>>;

Get Margin Loan Growth Rate Data

Parameters ​

ParameterType
paramsGetMarginLoanGrowthRequestV3

Returns ​

Promise<APIResponse<MarginLoanGrowthV3[]>>


getMarginLoans() ​

ts
getMarginLoans(params: GetMarginLoansRequestV3): Promise<APIResponse<MarginLoanV3>>;

Get Margin Loan

Parameters ​

ParameterType
paramsGetMarginLoansRequestV3

Returns ​

Promise<APIResponse<MarginLoanV3>>


getMarginLoansAll() ​

ts
getMarginLoansAll(params?: GetMarginLoansAllRequestV3): Promise<APIResponse<MarginLoanAllV3[]>>;

Margin loan info for every coin, or one coin when coin is set. Rate limit: 20/sec/IP.

Parameters ​

ParameterType
params?GetMarginLoansAllRequestV3

Returns ​

Promise<APIResponse<MarginLoanAllV3[]>>


getMarginLongShort() ​

ts
getMarginLongShort(params: GetMarginLongShortRequestV3): Promise<APIResponse<MarginLongShortV3[]>>;

Get Margin Long Short Ratio Data

Parameters ​

ParameterType
paramsGetMarginLongShortRequestV3

Returns ​

Promise<APIResponse<MarginLongShortV3[]>>


getMarketFeeGroup() ​

ts
getMarketFeeGroup(params: GetMarketFeeGroupRequestV3): Promise<APIResponse<MarketFeeGroupV3[]>>;

Get Market Maker Fee Group - Query fee rate tiers and grouping

Parameters ​

ParameterType
paramsGetMarketFeeGroupRequestV3

Returns ​

Promise<APIResponse<MarketFeeGroupV3[]>>


getMarketScoreWeights() ​

ts
getMarketScoreWeights(params?: GetMarketScoreWeightsRequestV3): Promise<APIResponse<MarketScoreWeightV3[]>>;

Get Market Maker Score Weight - Query score weights per symbol

Parameters ​

ParameterType
params?GetMarketScoreWeightsRequestV3

Returns ​

Promise<APIResponse<MarketScoreWeightV3[]>>


getMaxBorrowable() ​

ts
getMaxBorrowable(params: GetMaxBorrowableRequestV3): Promise<APIResponse<MaxBorrowableV3>>;

Parameters ​

ParameterType
paramsGetMaxBorrowableRequestV3

Returns ​

Promise<APIResponse<MaxBorrowableV3>>


getMaxOpenAvailable() ​

ts
getMaxOpenAvailable(params: GetMaxOpenAvailableRequestV3): Promise<APIResponse<GetMaxOpenAvailableResponseV3>>;

Get Max Open Available marginMode defaults to crossed. Under isolated margin, available excludes futures trial funds.

Parameters ​

ParameterType
paramsGetMaxOpenAvailableRequestV3

Returns ​

Promise<APIResponse<GetMaxOpenAvailableResponseV3>>


getMaxTransferable() ​

ts
getMaxTransferable(params: GetMaxTransferableRequestV3): Promise<APIResponse<MaxTransferableV3>>;

Get Max Transferable

  • Rate limit: 3 req/sec/UID
  • Permission: UTA mgt. (read)
  • Get the maximum transferable amount for the unified account.

Parameters ​

ParameterType
paramsGetMaxTransferableRequestV3

Returns ​

Promise<APIResponse<MaxTransferableV3>>


getMaxWithdrawal() ​

ts
getMaxWithdrawal(params: GetMaxWithdrawalRequestV3): Promise<APIResponse<MaxWithdrawalV3>>;

Get Max Withdrawal - Max withdrawable amount for a coin in unified account

Parameters ​

ParameterType
paramsGetMaxWithdrawalRequestV3

Returns ​

Promise<APIResponse<MaxWithdrawalV3>>


getMovePositionHistory() ​

ts
getMovePositionHistory(params: GetMovePositionHistoryRequestV3): Promise<APIResponse<{
  cursor: string;
  list: MovePositionHistoryV3[];
}>>;

Get Move Position History

Parameters ​

ParameterType
paramsGetMovePositionHistoryRequestV3

Returns ​

Promise<APIResponse<{ cursor: string; list: MovePositionHistoryV3[]; }>>


getNeutralGridBotDetail() ​

ts
getNeutralGridBotDetail(params: GetNeutralGridBotDetailRequestV3): Promise<APIResponse<NeutralGridBotDetailV3>>;

Parameters ​

ParameterType
paramsGetNeutralGridBotDetailRequestV3

Returns ​

Promise<APIResponse<NeutralGridBotDetailV3>>


getNeutralGridBotOrderDetails() ​

ts
getNeutralGridBotOrderDetails(params: GetNeutralGridBotOrderDetailsRequestV3): Promise<APIResponse<GridBotOrderDetailsV3>>;

Parameters ​

ParameterType
paramsGetNeutralGridBotOrderDetailsRequestV3

Returns ​

Promise<APIResponse<GridBotOrderDetailsV3>>


getOpenInterest() ​

ts
getOpenInterest(params: GetOpenInterestRequestV3): Promise<APIResponse<OpenInterestV3>>;

Get Open Interest

Parameters ​

ParameterType
paramsGetOpenInterestRequestV3

Returns ​

Promise<APIResponse<OpenInterestV3>>


getOpenInterestHistory() ​

ts
getOpenInterestHistory(params: GetOpenInterestHistoryRequestV3): Promise<APIResponse<OpenInterestHistoryV3>>;

Get Open Interest History period default is 5m. Rate limit 10/sec/IP.

Parameters ​

ParameterType
paramsGetOpenInterestHistoryRequestV3

Returns ​

Promise<APIResponse<OpenInterestHistoryV3>>


getOpenInterestLimit() ​

ts
getOpenInterestLimit(params: GetOpenInterestLimitRequestV3): Promise<APIResponse<OpenInterestLimitV3>>;

Get Open Interest Limit

  • Rate limit: 5/sec/UID
  • Get open interest limit for a symbol

Parameters ​

ParameterType
paramsGetOpenInterestLimitRequestV3

Returns ​

Promise<APIResponse<OpenInterestLimitV3>>


getOrderBook() ​

ts
getOrderBook(params: GetOrderBookRequestV3): Promise<APIResponse<OrderBookV3>>;

Get OrderBook rToken pairs: weekdays during US market hours return only the level-1 BBO. Off-hours return onshore depth up to limit. A crossed book after the rToken matching-engine upgrade is expected.

Parameters ​

ParameterType
paramsGetOrderBookRequestV3

Returns ​

Promise<APIResponse<OrderBookV3>>

See ​

Read an order book


getOrderInfo() ​

ts
getOrderInfo(params: GetOrderInfoRequestV3): Promise<APIResponse<OrderInfoV3>>;

Get Order Details

Parameters ​

ParameterType
paramsGetOrderInfoRequestV3

Returns ​

Promise<APIResponse<OrderInfoV3>>

See ​

UTA order management


getP2pAdInfo() ​

ts
getP2pAdInfo(params: GetP2pAdInfoRequestV3): Promise<APIResponse<P2pAdInfoV3>>;

Parameters ​

ParameterType
paramsGetP2pAdInfoRequestV3

Returns ​

Promise<APIResponse<P2pAdInfoV3>>


getP2pAdLimit() ​

ts
getP2pAdLimit(params: GetP2pAdLimitRequestV3): Promise<APIResponse<P2pAdLimitV3>>;

Parameters ​

ParameterType
paramsGetP2pAdLimitRequestV3

Returns ​

Promise<APIResponse<P2pAdLimitV3>>


getP2pAdList() ​

ts
getP2pAdList(params: GetP2pAdListRequestV3): Promise<APIResponse<P2pPublicAdListItemV3[]>>;

=====P2P Merchant (UTA)=====

Parameters ​

ParameterType
paramsGetP2pAdListRequestV3

Returns ​

Promise<APIResponse<P2pPublicAdListItemV3[]>>


getP2pAllOrders() ​

ts
getP2pAllOrders(params?: GetP2pAllOrdersRequestV3): Promise<APIResponse<P2pCursorListV3<P2pOrderListItemV3>>>;

Parameters ​

ParameterType
params?GetP2pAllOrdersRequestV3

Returns ​

Promise<APIResponse<P2pCursorListV3<P2pOrderListItemV3>>>


getP2pBalance() ​

ts
getP2pBalance(params: GetP2pBalanceRequestV3): Promise<APIResponse<P2pBalanceV3>>;

Parameters ​

ParameterType
paramsGetP2pBalanceRequestV3

Returns ​

Promise<APIResponse<P2pBalanceV3>>


getP2pCurrencies() ​

ts
getP2pCurrencies(): Promise<APIResponse<P2pCurrenciesV3>>;

Returns ​

Promise<APIResponse<P2pCurrenciesV3>>


getP2pExchangeRate() ​

ts
getP2pExchangeRate(params: GetP2pExchangeRateRequestV3): Promise<APIResponse<P2pExchangeRateV3>>;

Parameters ​

ParameterType
paramsGetP2pExchangeRateRequestV3

Returns ​

Promise<APIResponse<P2pExchangeRateV3>>


getP2pMyAds() ​

ts
getP2pMyAds(params?: GetP2pMyAdsRequestV3): Promise<APIResponse<P2pCursorListV3<P2pMyAdListItemV3>>>;

Parameters ​

ParameterType
params?GetP2pMyAdsRequestV3

Returns ​

Promise<APIResponse<P2pCursorListV3<P2pMyAdListItemV3>>>


getP2pOrderInfo() ​

ts
getP2pOrderInfo(params: GetP2pOrderInfoRequestV3): Promise<APIResponse<P2pOrderInfoV3>>;

Parameters ​

ParameterType
paramsGetP2pOrderInfoRequestV3

Returns ​

Promise<APIResponse<P2pOrderInfoV3>>


getP2pPayMethods() ​

ts
getP2pPayMethods(): Promise<APIResponse<P2pPayMethodV3[]>>;

Returns ​

Promise<APIResponse<P2pPayMethodV3[]>>


getP2pPendingOrders() ​

ts
getP2pPendingOrders(params?: GetP2pPendingOrdersRequestV3): Promise<APIResponse<P2pCursorListV3<P2pOrderListItemV3>>>;

Parameters ​

ParameterType
params?GetP2pPendingOrdersRequestV3

Returns ​

Promise<APIResponse<P2pCursorListV3<P2pOrderListItemV3>>>


getP2pUserInfo() ​

ts
getP2pUserInfo(): Promise<APIResponse<P2pUserInfoV3>>;

Returns ​

Promise<APIResponse<P2pUserInfoV3>>


getPaymentCoins() ​

ts
getPaymentCoins(): Promise<APIResponse<{
  maxSelection: string;
  paymentCoinList: PaymentCoinV3[];
}>>;

Get Payment Coins

Returns ​

Promise<APIResponse<{ maxSelection: string; paymentCoinList: PaymentCoinV3[]; }>>


getPositionAdlRank() ​

ts
getPositionAdlRank(): Promise<APIResponse<PositionAdlRankV3[]>>;

Get Position ADL Rank - Get position auto-deleveraging ranking

Returns ​

Promise<APIResponse<PositionAdlRankV3[]>>


getPositionHistory() ​

ts
getPositionHistory(params: GetPositionHistoryRequestV3): Promise<APIResponse<{
  cursor: string;
  list: PositionHistoryV3[];
}>>;

Get Positions History

Parameters ​

ParameterType
paramsGetPositionHistoryRequestV3

Returns ​

Promise<APIResponse<{ cursor: string; list: PositionHistoryV3[]; }>>


getPositionTier() ​

ts
getPositionTier(params: GetPositionTierRequestV3): Promise<APIResponse<PositionTierV3[]>>;

Get Position Tier

Parameters ​

ParameterType
paramsGetPositionTierRequestV3

Returns ​

Promise<APIResponse<PositionTierV3[]>>


getPrivate() ​

ts
getPrivate(endpoint: string, params?: any): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.getPrivate


getProofOfReserves() ​

ts
getProofOfReserves(): Promise<APIResponse<ProofOfReservesV3>>;

Get Proof Of Reserves

Returns ​

Promise<APIResponse<ProofOfReservesV3>>


getRateLimitQuota() ​

ts
getRateLimitQuota(params: GetRateLimitQuotaRequestV3): Promise<APIResponse<RateLimitQuotaV3>>;

Get RateLimit Quota A sub-account can query its own quota. uid is ignored on that call.

Parameters ​

ParameterType
paramsGetRateLimitQuotaRequestV3

Returns ​

Promise<APIResponse<RateLimitQuotaV3>>


getRealityCompanyOverview() ​

ts
getRealityCompanyOverview(params: GetRealityCompanyOverviewRequestV3): Promise<APIResponse<RealityCompanyOverviewV3>>;

Parameters ​

ParameterType
paramsGetRealityCompanyOverviewRequestV3

Returns ​

Promise<APIResponse<RealityCompanyOverviewV3>>


getRealityDividends() ​

ts
getRealityDividends(params: GetRealityDividendsRequestV3): Promise<APIResponse<RealityCursorListV3<RealityDividendItemV3>>>;

Parameters ​

ParameterType
paramsGetRealityDividendsRequestV3

Returns ​

Promise<APIResponse<RealityCursorListV3<RealityDividendItemV3>>>


getRealityEarningsForecast() ​

ts
getRealityEarningsForecast(params: GetRealityEarningsForecastRequestV3): Promise<APIResponse<RealityEarningsForecastV3>>;

Parameters ​

ParameterType
paramsGetRealityEarningsForecastRequestV3

Returns ​

Promise<APIResponse<RealityEarningsForecastV3>>


getRealityExecutiveShareholdings() ​

ts
getRealityExecutiveShareholdings(params: GetRealityExecutiveShareholdingsRequestV3): Promise<APIResponse<RealityCursorListV3<RealityExecutiveShareholdingItemV3>>>;

Parameters ​

ParameterType
paramsGetRealityExecutiveShareholdingsRequestV3

Returns ​

Promise<APIResponse<RealityCursorListV3<RealityExecutiveShareholdingItemV3>>>


getRealityFills() ​

ts
getRealityFills(params: GetRealityFillsRequestV3): Promise<APIResponse<RealityFillV3[]>>;

Get Reality Fills

Parameters ​

ParameterType
paramsGetRealityFillsRequestV3

Returns ​

Promise<APIResponse<RealityFillV3[]>>


getRealityInnerTrades() ​

ts
getRealityInnerTrades(params: GetRealityInnerTradesRequestV3): Promise<APIResponse<RealityCursorListV3<RealityInnerTradeItemV3>>>;

Parameters ​

ParameterType
paramsGetRealityInnerTradesRequestV3

Returns ​

Promise<APIResponse<RealityCursorListV3<RealityInnerTradeItemV3>>>


getRealityMarketCalendar() ​

ts
getRealityMarketCalendar(): Promise<APIResponse<RealityMarketCalendarV3>>;

Returns ​

Promise<APIResponse<RealityMarketCalendarV3>>


getRealityMarketStates() ​

ts
getRealityMarketStates(): Promise<APIResponse<RealityMarketStateV3[]>>;

Returns ​

Promise<APIResponse<RealityMarketStateV3[]>>


getRealityOrderBook() ​

ts
getRealityOrderBook(params: GetRealityOrderBookRequestV3): Promise<APIResponse<RealityOrderBookV3>>;

Get Reality OrderBook Merged onshore + offshore depth, up to 40 levels. Whitelist required. A crossed book after the matching-engine upgrade is expected.

Parameters ​

ParameterType
paramsGetRealityOrderBookRequestV3

Returns ​

Promise<APIResponse<RealityOrderBookV3>>


getRealityOrderBookSegmented() ​

ts
getRealityOrderBookSegmented(params: GetRealityOrderBookSegmentedRequestV3): Promise<APIResponse<RealityOrderBookSegmentedV3>>;

Get segmented rToken depth, with onshore and offshore quantities at each price. Requires whitelist access.

Parameters ​

ParameterType
paramsGetRealityOrderBookSegmentedRequestV3

Returns ​

Promise<APIResponse<RealityOrderBookSegmentedV3>>


getRealityShareCapitalChange() ​

ts
getRealityShareCapitalChange(params: GetRealityShareCapitalChangeRequestV3): Promise<APIResponse<RealityShareCapitalChangeV3>>;

Parameters ​

ParameterType
paramsGetRealityShareCapitalChangeRequestV3

Returns ​

Promise<APIResponse<RealityShareCapitalChangeV3>>


getRealityShareholdDetail() ​

ts
getRealityShareholdDetail(params: GetRealityShareholdDetailRequestV3): Promise<APIResponse<RealityCursorListV3<RealityShareholdDetailItemV3>>>;

Parameters ​

ParameterType
paramsGetRealityShareholdDetailRequestV3

Returns ​

Promise<APIResponse<RealityCursorListV3<RealityShareholdDetailItemV3>>>


getRealityStockInfo() ​

ts
getRealityStockInfo(params?: GetRealityStockInfoRequestV3): Promise<APIResponse<RealityStockInfoV3[]>>;

Parameters ​

ParameterType
params?GetRealityStockInfoRequestV3

Returns ​

Promise<APIResponse<RealityStockInfoV3[]>>


getRealitySuspensionResumptionInfo() ​

ts
getRealitySuspensionResumptionInfo(params: GetRealitySuspensionResumptionInfoRequestV3): Promise<APIResponse<RealitySuspensionResumptionInfoV3>>;

Parameters ​

ParameterType
paramsGetRealitySuspensionResumptionInfoRequestV3

Returns ​

Promise<APIResponse<RealitySuspensionResumptionInfoV3>>


getRealityValuationIndicators() ​

ts
getRealityValuationIndicators(params: GetRealityValuationIndicatorsRequestV3): Promise<APIResponse<RealityValuationIndicatorsV3>>;

Parameters ​

ParameterType
paramsGetRealityValuationIndicatorsRequestV3

Returns ​

Promise<APIResponse<RealityValuationIndicatorsV3>>


getRepayableCoins() ​

ts
getRepayableCoins(): Promise<APIResponse<{
  maxSelection: string;
  repayableCoinList: RepayableCoinV3[];
}>>;

Get Repayable Coins

Returns ​

Promise<APIResponse<{ maxSelection: string; repayableCoinList: RepayableCoinV3[]; }>>


getRiskReserve() ​

ts
getRiskReserve(params: GetRiskReserveRequestV3): Promise<APIResponse<RiskReserveV3>>;

Get Risk Reserve

Parameters ​

ParameterType
paramsGetRiskReserveRequestV3

Returns ​

Promise<APIResponse<RiskReserveV3>>


getRiskReserveAll() ​

ts
getRiskReserveAll(params: GetRiskReserveAllRequestV3): Promise<APIResponse<RiskReserveAllV3>>;

Get Risk Reserve All — current insurance funds

Parameters ​

ParameterType
paramsGetRiskReserveAllRequestV3

Returns ​

Promise<APIResponse<RiskReserveAllV3>>


getRiskReserveHour() ​

ts
getRiskReserveHour(params: GetRiskReserveRequestV3): Promise<APIResponse<RiskReserveHourV3>>;

Get Risk Reserve (Hourly)

Parameters ​

ParameterType
paramsGetRiskReserveRequestV3

Returns ​

Promise<APIResponse<RiskReserveHourV3>>


getRpiOrderBook() ​

ts
getRpiOrderBook(params: GetRpiOrderBookRequestV3): Promise<APIResponse<RpiOrderBookV3>>;

Get RPI OrderBook - Depth with RPI and non-RPI quantities per price level

Parameters ​

ParameterType
paramsGetRpiOrderBookRequestV3

Returns ​

Promise<APIResponse<RpiOrderBookV3>>


getRpiSymbols() ​

ts
getRpiSymbols(): Promise<APIResponse<RpiSymbolV3[]>>;

Get RPI Symbols - Trading pairs supporting Retail Price Improvement

Returns ​

Promise<APIResponse<RpiSymbolV3[]>>


getServerTime() ​

ts
getServerTime(): Promise<APIResponse<{
  serverTime: string;
  serverTimeMicros: string;
}>>;

Get server time from GET /api/v3/market/time. serverTime is a Unix timestamp in milliseconds; serverTimeMicros is in microseconds.

Returns ​

Promise<APIResponse<{ serverTime: string; serverTimeMicros: string; }>>


getSharkfinAccount() ​

ts
getSharkfinAccount(): Promise<APIResponse<EarnSharkfinAccountV3>>;

SharkFin Account. Rate limit: 10/sec/UID.

Returns ​

Promise<APIResponse<EarnSharkfinAccountV3>>


getSharkfinAssets() ​

ts
getSharkfinAssets(params: GetSharkfinAssetsRequestV3): Promise<APIResponse<EarnSharkfinAssetsV3>>;

SharkFin Assets. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
paramsGetSharkfinAssetsRequestV3

Returns ​

Promise<APIResponse<EarnSharkfinAssetsV3>>


getSharkfinProducts() ​

ts
getSharkfinProducts(params: GetSharkfinProductsRequestV3): Promise<APIResponse<EarnSharkfinProductsV3>>;

Get Sharkfin Products. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
paramsGetSharkfinProductsRequestV3

Returns ​

Promise<APIResponse<EarnSharkfinProductsV3>>


getSharkfinRecords() ​

ts
getSharkfinRecords(params: GetSharkfinRecordsRequestV3): Promise<APIResponse<EarnSharkfinRecordsV3>>;

SharkFin Records. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
paramsGetSharkfinRecordsRequestV3

Returns ​

Promise<APIResponse<EarnSharkfinRecordsV3>>


getSharkfinSubscription() ​

ts
getSharkfinSubscription(params: GetSharkfinSubscriptionRequestV3): Promise<APIResponse<EarnSharkfinSubscriptionDetailV3>>;

SharkFin Subscription Detail. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
paramsGetSharkfinSubscriptionRequestV3

Returns ​

Promise<APIResponse<EarnSharkfinSubscriptionDetailV3>>


getSharkfinSubscriptionResult() ​

ts
getSharkfinSubscriptionResult(params: GetSharkfinSubscriptionResultRequestV3): Promise<APIResponse<EarnSharkfinSubscriptionResultV3>>;

SharkFin Subscription Result. Rate limit: 5/sec/UID.

Parameters ​

ParameterType
paramsGetSharkfinSubscriptionResultRequestV3

Returns ​

Promise<APIResponse<EarnSharkfinSubscriptionResultV3>>


getSmallAssets() ​

ts
getSmallAssets(params?: GetSmallAssetsRequestV3): Promise<APIResponse<SmallAssetV3[]>>;

Parameters ​

ParameterType
params?GetSmallAssetsRequestV3

Returns ​

Promise<APIResponse<SmallAssetV3[]>>


getSmallAssetsHistory() ​

ts
getSmallAssetsHistory(params?: GetSmallAssetsHistoryRequestV3): Promise<APIResponse<{
  cursor: string;
  list: SmallAssetsHistoryItemV3[];
}>>;

Parameters ​

ParameterType
params?GetSmallAssetsHistoryRequestV3

Returns ​

Promise<APIResponse<{ cursor: string; list: SmallAssetsHistoryItemV3[]; }>>


getSplitRecords() ​

ts
getSplitRecords(params?: GetSplitRecordsRequestV3): Promise<APIResponse<SplitRecordV3[]>>;

Parameters ​

ParameterType
params?GetSplitRecordsRequestV3

Returns ​

Promise<APIResponse<SplitRecordV3[]>>


getSpotFundFlow() ​

ts
getSpotFundFlow(params: GetSpotFundFlowRequestV3): Promise<APIResponse<SpotFundFlowV3>>;

Get Spot Fund Flow Data

Parameters ​

ParameterType
paramsGetSpotFundFlowRequestV3

Returns ​

Promise<APIResponse<SpotFundFlowV3>>


getSpotNetFlow() ​

ts
getSpotNetFlow(params: GetSpotNetFlowRequestV3): Promise<APIResponse<SpotNetFlowV3[]>>;

Get Spot 24H Net Capital Inflow Data

Parameters ​

ParameterType
paramsGetSpotNetFlowRequestV3

Returns ​

Promise<APIResponse<SpotNetFlowV3[]>>


getSpotWhaleFlow() ​

ts
getSpotWhaleFlow(params: GetSpotWhaleFlowRequestV3): Promise<APIResponse<SpotWhaleFlowV3[]>>;

Get Spot Whale Net Flow Data

Parameters ​

ParameterType
paramsGetSpotWhaleFlowRequestV3

Returns ​

Promise<APIResponse<SpotWhaleFlowV3[]>>


getStockPlusAccount() ​

ts
getStockPlusAccount(params?: GetStockPlusAccountRequestV3): Promise<APIResponse<StockPlusAccountV3>>;

Parameters ​

ParameterType
params?GetStockPlusAccountRequestV3

Returns ​

Promise<APIResponse<StockPlusAccountV3>>


getStockPlusCandlestick() ​

ts
getStockPlusCandlestick(params: GetStockPlusCandlestickRequestV3): Promise<APIResponse<StockPlusCandlestickV3>>;

Parameters ​

ParameterType
paramsGetStockPlusCandlestickRequestV3

Returns ​

Promise<APIResponse<StockPlusCandlestickV3>>


getStockPlusCashFlow() ​

ts
getStockPlusCashFlow(params: GetStockPlusCashFlowRequestV3): Promise<APIResponse<StockPlusCashFlowV3>>;

Parameters ​

ParameterType
paramsGetStockPlusCashFlowRequestV3

Returns ​

Promise<APIResponse<StockPlusCashFlowV3>>


getStockPlusDepth() ​

ts
getStockPlusDepth(params: GetStockPlusDepthRequestV3): Promise<APIResponse<StockPlusDepthV3>>;

Parameters ​

ParameterType
paramsGetStockPlusDepthRequestV3

Returns ​

Promise<APIResponse<StockPlusDepthV3>>


getStockPlusHistoryCandlestick() ​

ts
getStockPlusHistoryCandlestick(params: GetStockPlusHistoryCandlestickRequestV3): Promise<APIResponse<StockPlusCandlestickV3>>;

Parameters ​

ParameterType
paramsGetStockPlusHistoryCandlestickRequestV3

Returns ​

Promise<APIResponse<StockPlusCandlestickV3>>


getStockPlusHistoryExecutions() ​

ts
getStockPlusHistoryExecutions(params?: GetStockPlusHistoryExecutionsRequestV3): Promise<APIResponse<StockPlusHistoryExecutionsV3>>;

Parameters ​

ParameterType
params?GetStockPlusHistoryExecutionsRequestV3

Returns ​

Promise<APIResponse<StockPlusHistoryExecutionsV3>>


getStockPlusHistoryOrders() ​

ts
getStockPlusHistoryOrders(params?: GetStockPlusHistoryOrdersRequestV3): Promise<APIResponse<StockPlusHistoryOrdersV3>>;

Parameters ​

ParameterType
params?GetStockPlusHistoryOrdersRequestV3

Returns ​

Promise<APIResponse<StockPlusHistoryOrdersV3>>


getStockPlusIntraday() ​

ts
getStockPlusIntraday(params: GetStockPlusIntradayRequestV3): Promise<APIResponse<StockPlusIntradayV3>>;

Parameters ​

ParameterType
paramsGetStockPlusIntradayRequestV3

Returns ​

Promise<APIResponse<StockPlusIntradayV3>>


getStockPlusMaxPurchase() ​

ts
getStockPlusMaxPurchase(params: GetStockPlusMaxPurchaseRequestV3): Promise<APIResponse<StockPlusMaxPurchaseV3>>;

Parameters ​

ParameterType
paramsGetStockPlusMaxPurchaseRequestV3

Returns ​

Promise<APIResponse<StockPlusMaxPurchaseV3>>


getStockPlusOptionChainInfo() ​

ts
getStockPlusOptionChainInfo(params: GetStockPlusOptionChainInfoRequestV3): Promise<APIResponse<StockPlusOptionChainInfoV3>>;

Parameters ​

ParameterType
paramsGetStockPlusOptionChainInfoRequestV3

Returns ​

Promise<APIResponse<StockPlusOptionChainInfoV3>>


getStockPlusOptionExpiryDate() ​

ts
getStockPlusOptionExpiryDate(params: GetStockPlusOptionExpiryDateRequestV3): Promise<APIResponse<StockPlusOptionExpiryDateV3>>;

Parameters ​

ParameterType
paramsGetStockPlusOptionExpiryDateRequestV3

Returns ​

Promise<APIResponse<StockPlusOptionExpiryDateV3>>


getStockPlusOptionQuote() ​

ts
getStockPlusOptionQuote(params: GetStockPlusOptionQuoteRequestV3): Promise<APIResponse<StockPlusOptionQuoteV3>>;

=====Stock+=====

Parameters ​

ParameterType
paramsGetStockPlusOptionQuoteRequestV3

Returns ​

Promise<APIResponse<StockPlusOptionQuoteV3>>


getStockPlusOptionVolume() ​

ts
getStockPlusOptionVolume(params: GetStockPlusOptionVolumeRequestV3): Promise<APIResponse<StockPlusOptionVolumeV3>>;

Parameters ​

ParameterType
paramsGetStockPlusOptionVolumeRequestV3

Returns ​

Promise<APIResponse<StockPlusOptionVolumeV3>>


getStockPlusOrderDetail() ​

ts
getStockPlusOrderDetail(params: GetStockPlusOrderDetailRequestV3): Promise<APIResponse<StockPlusOrderDetailV3>>;

Parameters ​

ParameterType
paramsGetStockPlusOrderDetailRequestV3

Returns ​

Promise<APIResponse<StockPlusOrderDetailV3>>


getStockPlusQuote() ​

ts
getStockPlusQuote(params: GetStockPlusQuoteRequestV3): Promise<APIResponse<StockPlusQuoteV3>>;

Parameters ​

ParameterType
paramsGetStockPlusQuoteRequestV3

Returns ​

Promise<APIResponse<StockPlusQuoteV3>>


getStockPlusStaticInfo() ​

ts
getStockPlusStaticInfo(params: GetStockPlusStaticInfoRequestV3): Promise<APIResponse<StockPlusStaticInfoV3>>;

Parameters ​

ParameterType
paramsGetStockPlusStaticInfoRequestV3

Returns ​

Promise<APIResponse<StockPlusStaticInfoV3>>


getStockPlusStockPosition() ​

ts
getStockPlusStockPosition(params?: GetStockPlusStockPositionRequestV3): Promise<APIResponse<StockPlusStockPositionV3>>;

Parameters ​

ParameterType
params?GetStockPlusStockPositionRequestV3

Returns ​

Promise<APIResponse<StockPlusStockPositionV3>>


getStockPlusTodayExecutions() ​

ts
getStockPlusTodayExecutions(params?: GetStockPlusTodayExecutionsRequestV3): Promise<APIResponse<StockPlusTodayExecutionsV3>>;

Parameters ​

ParameterType
params?GetStockPlusTodayExecutionsRequestV3

Returns ​

Promise<APIResponse<StockPlusTodayExecutionsV3>>


getStockPlusTodayOrders() ​

ts
getStockPlusTodayOrders(params?: GetStockPlusTodayOrdersRequestV3): Promise<APIResponse<StockPlusOrdersV3>>;

Parameters ​

ParameterType
params?GetStockPlusTodayOrdersRequestV3

Returns ​

Promise<APIResponse<StockPlusOrdersV3>>


getStockPlusTradeDetail() ​

ts
getStockPlusTradeDetail(params: GetStockPlusTradeDetailRequestV3): Promise<APIResponse<StockPlusTradeDetailV3>>;

Parameters ​

ParameterType
paramsGetStockPlusTradeDetailRequestV3

Returns ​

Promise<APIResponse<StockPlusTradeDetailV3>>


getStockPlusTransferRecords() ​

ts
getStockPlusTransferRecords(params?: GetStockPlusTransferRecordsRequestV3): Promise<APIResponse<StockPlusTransferRecordsV3>>;

Parameters ​

ParameterType
params?GetStockPlusTransferRecordsRequestV3

Returns ​

Promise<APIResponse<StockPlusTransferRecordsV3>>


getStpGroups() ​

ts
getStpGroups(): Promise<APIResponse<StpGroupListV3>>;

Get STP Groups MM whitelist only.

Returns ​

Promise<APIResponse<StpGroupListV3>>


getStrategySubOrders() ​

ts
getStrategySubOrders(params: GetStrategySubOrdersRequestV3): Promise<APIResponse<{
  cursor?: string;
  list: StrategySubOrderV3[];
}>>;

Parameters ​

ParameterType
paramsGetStrategySubOrdersRequestV3

Returns ​

Promise<APIResponse<{ cursor?: string; list: StrategySubOrderV3[]; }>>


getSubAccountApiKeys() ​

ts
getSubAccountApiKeys(params: GetSubAccountApiKeysRequestV3): Promise<APIResponse<{
  cursor: string;
  hasNext: boolean;
  items: SubAccountApiKeyV3[];
}>>;

Get Sub-account API Keys

Parameters ​

ParameterType
paramsGetSubAccountApiKeysRequestV3

Returns ​

Promise<APIResponse<{ cursor: string; hasNext: boolean; items: SubAccountApiKeyV3[]; }>>


getSubaccountEmail() ​

ts
getSubaccountEmail(params: GetSubaccountEmailRequestV3): Promise<APIResponse<SubaccountEmailV3>>;

Get Subaccount Email. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
paramsGetSubaccountEmailRequestV3

Returns ​

Promise<APIResponse<SubaccountEmailV3>>


getSubAccountList() ​

ts
getSubAccountList(params?: GetSubAccountListRequestV3): Promise<APIResponse<{
  cursor: string;
  hasNext: boolean;
  list: SubAccountV3[];
}>>;

Get Sub-account List

Parameters ​

ParameterType
params?GetSubAccountListRequestV3

Returns ​

Promise<APIResponse<{ cursor: string; hasNext: boolean; list: SubAccountV3[]; }>>


getSubAffiliateCommission() ​

ts
getSubAffiliateCommission(params?: GetSubAffiliateCommissionRequestV3): Promise<APIResponse<SubAffiliateCommissionV3>>;

Get Sub Affiliate Commission. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
params?GetSubAffiliateCommissionRequestV3

Returns ​

Promise<APIResponse<SubAffiliateCommissionV3>>


getSubAffiliateInfo() ​

ts
getSubAffiliateInfo(params?: GetSubAffiliateInfoRequestV3): Promise<APIResponse<SubAffiliateInfoV3>>;

Get Sub Affiliate Info. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
params?GetSubAffiliateInfoRequestV3

Returns ​

Promise<APIResponse<SubAffiliateInfoV3>>


getSubDepositAddress() ​

ts
getSubDepositAddress(params: GetSubDepositAddressRequestV3): Promise<APIResponse<DepositAddressV3>>;

Get Sub Deposit Address

Parameters ​

ParameterType
paramsGetSubDepositAddressRequestV3

Returns ​

Promise<APIResponse<DepositAddressV3>>


getSubDepositRecords() ​

ts
getSubDepositRecords(params: GetSubDepositRecordsRequestV3): Promise<APIResponse<DepositRecordV3[]>>;

Get Sub Deposit Records

Parameters ​

ParameterType
paramsGetSubDepositRecordsRequestV3

Returns ​

Promise<APIResponse<DepositRecordV3[]>>


getSubTransferRecords() ​

ts
getSubTransferRecords(params?: GetSubTransferRecordsRequestV3): Promise<APIResponse<{
  cursor: string;
  items: SubTransferRecordV3[];
}>>;

Get Main-Sub Transfer Records

Parameters ​

ParameterType
params?GetSubTransferRecordsRequestV3

Returns ​

Promise<APIResponse<{ cursor: string; items: SubTransferRecordV3[]; }>>


getSubUnifiedAssets() ​

ts
getSubUnifiedAssets(params?: GetSubUnifiedAssetsRequestV3): Promise<APIResponse<SubUnifiedAssetV3[]>>;

Get Sub-account Unified Account Assets

Parameters ​

ParameterType
params?GetSubUnifiedAssetsRequestV3

Returns ​

Promise<APIResponse<SubUnifiedAssetV3[]>>


getTaxRecords() ​

ts
getTaxRecords(params: GetTaxRecordsRequestV3): Promise<APIResponse<TaxRecordV3[]>>;

Get Tax Records

  • Rate limit: 1/sec/UID
  • Data query range: 366 days
  • Please use the tax API Key to request Creation Portal
  • Get Unified Account Tax Records

Parameters ​

ParameterType
paramsGetTaxRecordsRequestV3

Returns ​

Promise<APIResponse<TaxRecordV3[]>>


getTickers() ​

ts
getTickers(params: GetTickersRequestV3): Promise<APIResponse<TickerV3[]>>;

Get Tickers

Parameters ​

ParameterType
paramsGetTickersRequestV3

Returns ​

Promise<APIResponse<TickerV3[]>>

See ​

Read a public ticker


getTradeFills() ​

ts
getTradeFills(params?: GetFillsRequestV3): Promise<APIResponse<{
  cursor: string;
  list: FillV3[];
}>>;

Get Fill History

Parameters ​

ParameterType
params?GetFillsRequestV3

Returns ​

Promise<APIResponse<{ cursor: string; list: FillV3[]; }>>

See ​

UTA order management


getTransferableCoins() ​

ts
getTransferableCoins(params: GetTransferableCoinsRequestV3): Promise<APIResponse<string[]>>;

Get Transferable Coins

Parameters ​

ParameterType
paramsGetTransferableCoinsRequestV3

Returns ​

Promise<APIResponse<string[]>>


getUnfilledOrders() ​

ts
getUnfilledOrders(params?: GetUnfilledOrdersRequestV3): Promise<APIResponse<{
  cursor: string;
  list: UnfilledOrderV3[];
}>>;

Get Open Orders

Parameters ​

ParameterType
params?GetUnfilledOrdersRequestV3

Returns ​

Promise<APIResponse<{ cursor: string; list: UnfilledOrderV3[]; }>>

See ​

UTA order management


getUnfilledStrategyOrders() ​

ts
getUnfilledStrategyOrders(params: GetUnfilledStrategyOrdersRequestV3): Promise<APIResponse<StrategyOrderV3[]>>;

Get Unfilled Strategy Orders

Parameters ​

ParameterType
paramsGetUnfilledStrategyOrdersRequestV3

Returns ​

Promise<APIResponse<StrategyOrderV3[]>>


getUnifiedAccountSwitchStatus() ​

ts
getUnifiedAccountSwitchStatus(): Promise<APIResponse<{
  status: "processProcessing" | "successSuccess" | "failFailed";
}>>;

Get account switching status: process, success or fail.

Returns ​

Promise<APIResponse<{ status: "processProcessing" | "successSuccess" | "failFailed"; }>>


getWithdrawAddressBook() ​

ts
getWithdrawAddressBook(params?: GetWithdrawAddressBookRequestV3): Promise<APIResponse<WithdrawAddressBookV3>>;

Query the withdrawal address book. Rate limit: 1/sec/UID.

Parameters ​

ParameterType
params?GetWithdrawAddressBookRequestV3

Returns ​

Promise<APIResponse<WithdrawAddressBookV3>>


getWithdrawRecords() ​

ts
getWithdrawRecords(params: GetWithdrawRecordsRequestV3): Promise<APIResponse<WithdrawRecordV3[]>>;

Get Withdraw Records

Parameters ​

ParameterType
paramsGetWithdrawRecordsRequestV3

Returns ​

Promise<APIResponse<WithdrawRecordV3[]>>


loanBorrow() ​

ts
loanBorrow(params: LoanBorrowRequestV3): Promise<APIResponse<LoanBorrowResponseV3>>;

Borrow - Borrow coins

Parameters ​

ParameterType
paramsLoanBorrowRequestV3

Returns ​

Promise<APIResponse<LoanBorrowResponseV3>>


loanRepay() ​

ts
loanRepay(params: LoanRepayRequestV3): Promise<APIResponse<LoanRepayResponseV3>>;

Repay - Repay coins

Parameters ​

ParameterType
paramsLoanRepayRequestV3

Returns ​

Promise<APIResponse<LoanRepayResponseV3>>


loanRevisePledge() ​

ts
loanRevisePledge(params: LoanRevisePledgeRequestV3): Promise<APIResponse<LoanRevisePledgeResponseV3>>;

Revise Pledge - Adjust collateral ratio

Parameters ​

ParameterType
paramsLoanRevisePledgeRequestV3

Returns ​

Promise<APIResponse<LoanRevisePledgeResponseV3>>


modifyBrokerSubAccount() ​

ts
modifyBrokerSubAccount(params: ModifyBrokerSubAccountRequestV3): Promise<APIResponse<ModifyBrokerSubAccountResponseV3>>;

Modify Broker Sub-Account

Rate limit: 20/sec/UID Only the master account with a user type of ND Broker can call this API endpoint.

Parameters ​

ParameterType
paramsModifyBrokerSubAccountRequestV3

Returns ​

Promise<APIResponse<ModifyBrokerSubAccountResponseV3>>


modifyBrokerSubApiKey() ​

ts
modifyBrokerSubApiKey(params: ModifyBrokerSubApiKeyRequestV3): Promise<APIResponse<ModifyBrokerSubApiKeyResponseV3>>;

Modify Broker Sub-Account API Key

Rate limit: 20/sec/UID Only the master account with a user type of ND Broker can call this API endpoint.

Parameters ​

ParameterType
paramsModifyBrokerSubApiKeyRequestV3

Returns ​

Promise<APIResponse<ModifyBrokerSubApiKeyResponseV3>>


modifyCfdOrder() ​

ts
modifyCfdOrder(params: ModifyCfdOrderRequestV3): Promise<APIResponse<ModifyCfdOrderResponseV3>>;

Parameters ​

ParameterType
paramsModifyCfdOrderRequestV3

Returns ​

Promise<APIResponse<ModifyCfdOrderResponseV3>>


modifyCopyFuturesFollowerSettings() ​

ts
modifyCopyFuturesFollowerSettings(params: ModifyCopyFuturesFollowerSettingsRequestV3): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsModifyCopyFuturesFollowerSettingsRequestV3

Returns ​

Promise<APIResponse<string>>


modifyCopyFuturesTpSl() ​

ts
modifyCopyFuturesTpSl(params: ModifyCopyFuturesTpSlRequestV3): Promise<APIResponse<CopyFuturesTpSlResponseV3>>;

Parameters ​

ParameterType
paramsModifyCopyFuturesTpSlRequestV3

Returns ​

Promise<APIResponse<CopyFuturesTpSlResponseV3>>


modifyGridBot() ​

ts
modifyGridBot(params: ModifyGridBotRequestV3): Promise<APIResponse<GridBotIdResponseV3>>;

Parameters ​

ParameterType
paramsModifyGridBotRequestV3

Returns ​

Promise<APIResponse<GridBotIdResponseV3>>


modifyGridInterval() ​

ts
modifyGridInterval(params: ModifyGridIntervalRequestV3): Promise<APIResponse<GridBotIdResponseV3>>;

Parameters ​

ParameterType
paramsModifyGridIntervalRequestV3

Returns ​

Promise<APIResponse<GridBotIdResponseV3>>


modifyNeutralGridBot() ​

ts
modifyNeutralGridBot(params: ModifyNeutralGridBotRequestV3): Promise<APIResponse<GridBotIdResponseV3>>;

Parameters ​

ParameterType
paramsModifyNeutralGridBotRequestV3

Returns ​

Promise<APIResponse<GridBotIdResponseV3>>


modifyNeutralGridInterval() ​

ts
modifyNeutralGridInterval(params: ModifyNeutralGridIntervalRequestV3): Promise<APIResponse<GridBotIdResponseV3>>;

Parameters ​

ParameterType
paramsModifyNeutralGridIntervalRequestV3

Returns ​

Promise<APIResponse<GridBotIdResponseV3>>


modifyOrder() ​

ts
modifyOrder(params: ModifyOrderRequestV3): Promise<APIResponse<ModifyOrderResponseV3>>;

Modify Order

Parameters ​

ParameterType
paramsModifyOrderRequestV3

Returns ​

Promise<APIResponse<ModifyOrderResponseV3>>

See ​

UTA order management


modifyStockPlusOrder() ​

ts
modifyStockPlusOrder(params: ModifyStockPlusOrderRequestV3): Promise<APIResponse<StockPlusPlaceOrderResponseV3>>;

Parameters ​

ParameterType
paramsModifyStockPlusOrderRequestV3

Returns ​

Promise<APIResponse<StockPlusPlaceOrderResponseV3>>


modifyStrategyOrder() ​

ts
modifyStrategyOrder(params: ModifyStrategyOrderRequestV3): Promise<APIResponse<ModifyStrategyOrderResponseV3>>;

Modify Strategy Order

Parameters ​

ParameterType
paramsModifyStrategyOrderRequestV3

Returns ​

Promise<APIResponse<ModifyStrategyOrderResponseV3>>


modifySubaccountEmail() ​

ts
modifySubaccountEmail(params: ModifySubaccountEmailRequestV3): Promise<APIResponse<string>>;

Modify Subaccount Email. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
paramsModifySubaccountEmailRequestV3

Returns ​

Promise<APIResponse<string>>


movePositions() ​

ts
movePositions(params: MovePositionsRequestV3): Promise<APIResponse<MovePositionsResponseV3>>;

Move Positions - Transfer positions between master and sub-accounts

Parameters ​

ParameterType
paramsMovePositionsRequestV3

Returns ​

Promise<APIResponse<MovePositionsResponseV3>>


operateP2pAd() ​

ts
operateP2pAd(params: OperateP2pAdRequestV3): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsOperateP2pAdRequestV3

Returns ​

Promise<APIResponse<string>>


placeBatchOrders() ​

ts
placeBatchOrders(params: PlaceBatchOrdersRequestV3[]): Promise<APIResponse<PlaceBatchOrdersResponseV3[]>>;

Batch Order

Parameters ​

ParameterType
paramsPlaceBatchOrdersRequestV3[]

Returns ​

Promise<APIResponse<PlaceBatchOrdersResponseV3[]>>


placeCfdOrder() ​

ts
placeCfdOrder(params: PlaceCfdOrderRequestV3): Promise<APIResponse<PlaceCfdOrderResponseV3>>;

Parameters ​

ParameterType
paramsPlaceCfdOrderRequestV3

Returns ​

Promise<APIResponse<PlaceCfdOrderResponseV3>>


placeCopyFuturesTpSl() ​

ts
placeCopyFuturesTpSl(params: PlaceCopyFuturesTpSlRequestV3): Promise<APIResponse<CopyFuturesTpSlResponseV3>>;

Parameters ​

ParameterType
paramsPlaceCopyFuturesTpSlRequestV3

Returns ​

Promise<APIResponse<CopyFuturesTpSlResponseV3>>


placeRealityOrder() ​

ts
placeRealityOrder(params: PlaceRealityOrderRequestV3): Promise<APIResponse<PlaceOrderResponseV3>>;

Place Reality Order - Limit or market order for Reality stock trading pairs

Parameters ​

ParameterType
paramsPlaceRealityOrderRequestV3

Returns ​

Promise<APIResponse<PlaceOrderResponseV3>>


placeStockPlusOrder() ​

ts
placeStockPlusOrder(params: PlaceStockPlusOrderRequestV3): Promise<APIResponse<StockPlusPlaceOrderResponseV3>>;

Parameters ​

ParameterType
paramsPlaceStockPlusOrderRequestV3

Returns ​

Promise<APIResponse<StockPlusPlaceOrderResponseV3>>


post() ​

ts
post(endpoint: string, params?: any): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.post


postPrivate() ​

ts
postPrivate(endpoint: string, params?: any): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.postPrivate


preSetLeverage() ​

ts
preSetLeverage(params: PreSetLeverageRequestV3): Promise<APIResponse<PreSetLeverageV3>>;

Pre Set Leverage - Preview leverage adjustment impact without applying

Parameters ​

ParameterType
paramsPreSetLeverageRequestV3

Returns ​

Promise<APIResponse<PreSetLeverageV3>>


redeemEarnCashPlus() ​

ts
redeemEarnCashPlus(params: EarnCashPlusRedeemRequestV3): Promise<APIResponse<EarnCashPlusRedeemResultV3>>;

Redeem Cash+. Rate limit: 1/sec/UID.

Parameters ​

ParameterType
paramsEarnCashPlusRedeemRequestV3

Returns ​

Promise<APIResponse<EarnCashPlusRedeemResultV3>>


redeemEarnElite() ​

ts
redeemEarnElite(params: RedeemEarnEliteRequestV3): Promise<APIResponse<RedeemEarnEliteResultV3>>;

Parameters ​

ParameterType
paramsRedeemEarnEliteRequestV3

Returns ​

Promise<APIResponse<RedeemEarnEliteResultV3>>


releaseP2pOrderAsset() ​

ts
releaseP2pOrderAsset(params: P2pOrderActionRequestV3): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsP2pOrderActionRequestV3

Returns ​

Promise<APIResponse<string>>


removeStpGroupMembers() ​

ts
removeStpGroupMembers(params: StpGroupMembersRequestV3): Promise<APIResponse<StpGroupMembersResponseV3>>;

Remove STP Group Members uids is a comma-separated string, max 50. After removal, stp_uid falls back to the parent uid. MM whitelist only.

Parameters ​

ParameterType
paramsStpGroupMembersRequestV3

Returns ​

Promise<APIResponse<StpGroupMembersResponseV3>>


setCollateralType() ​

ts
setCollateralType(params: SetCollateralTypeRequestV3): Promise<APIResponse<string>>;

Set Collateral Type - Configure unified account collateral type

Parameters ​

ParameterType
paramsSetCollateralTypeRequestV3

Returns ​

Promise<APIResponse<string>>


setDepositAccount() ​

ts
setDepositAccount(params: SetDepositAccountRequestV3): Promise<APIResponse<string>>;

Set the default account for deposits of a specified symbol. The setting persists and does not need to be repeated for each deposit. Requires UTA management read and write permission.

Parameters ​

ParameterType
paramsSetDepositAccountRequestV3

Returns ​

Promise<APIResponse<string>>


setHoldMode() ​

ts
setHoldMode(params: object): Promise<APIResponse<string>>;

Set Holding Mode

Parameters ​

ParameterType
params{ holdMode: "one_way_mode" | "hedge_mode"; }
params.holdMode"one_way_mode" | "hedge_mode"

Returns ​

Promise<APIResponse<string>>


setLeverage() ​

ts
setLeverage(params: SetLeverageRequestV3): Promise<APIResponse<string>>;

Set leverage. Error 25159 indicates a temporary low-liquidity leverage limit; use the maximum reported in the error message rather than assuming a fixed 5x cap.

Parameters ​

ParameterType
paramsSetLeverageRequestV3

Returns ​

Promise<APIResponse<string>>


setMargin() ​

ts
setMargin(params: SetMarginRequestV3): Promise<APIResponse<string>>;

Set Margin - Adjust isolated margin position margin amount

Parameters ​

ParameterType
paramsSetMarginRequestV3

Returns ​

Promise<APIResponse<string>>


setRateLimitQuota() ​

ts
setRateLimitQuota(params: SetRateLimitQuotaRequestV3): Promise<APIResponse<Record<string, never>>>;

Set RateLimit Quota A sub-account can set its own quota. uids is not required, and is ignored, on that call. The master account must still send uids.

Parameters ​

ParameterType
paramsSetRateLimitQuotaRequestV3

Returns ​

Promise<APIResponse<Record<string, never>>>


setRepayMode() ​

ts
setRepayMode(params: SetRepayModeRequestV3): Promise<APIResponse<Record<string, never>>>;

Parameters ​

ParameterType
paramsSetRepayModeRequestV3

Returns ​

Promise<APIResponse<Record<string, never>>>


simulateP2pFee() ​

ts
simulateP2pFee(params: P2pFeeSimulateRequestV3): Promise<APIResponse<P2pFeeSimulateV3>>;

Parameters ​

ParameterType
paramsP2pFeeSimulateRequestV3

Returns ​

Promise<APIResponse<P2pFeeSimulateV3>>


stockPlusTransfer() ​

ts
stockPlusTransfer(params: StockPlusTransferRequestV3): Promise<APIResponse<StockPlusTransferResponseV3>>;

Parameters ​

ParameterType
paramsStockPlusTransferRequestV3

Returns ​

Promise<APIResponse<StockPlusTransferResponseV3>>


subAccountTransfer() ​

ts
subAccountTransfer(params: SubAccountTransferRequestV3): Promise<APIResponse<{
  clientOid: string;
  transferId: string;
}>>;

Main-Sub Account Transfer

Parameters ​

ParameterType
paramsSubAccountTransferRequestV3

Returns ​

Promise<APIResponse<{ clientOid: string; transferId: string; }>>


subMasterTransfer() ​

ts
subMasterTransfer(params: SubMasterTransferRequestV3): Promise<APIResponse<{
  clientOid: string;
  transferId: string;
}>>;

Sub-Main Account Transfer

Parameters ​

ParameterType
paramsSubMasterTransferRequestV3

Returns ​

Promise<APIResponse<{ clientOid: string; transferId: string; }>>


submitNewOrder() ​

ts
submitNewOrder(params: PlaceOrderRequestV3): Promise<APIResponse<PlaceOrderResponseV3>>;

Place an order. For non-rToken pairs, market orders execute as IOC; Reality/rToken pairs ignore the standard timeInForce field. bboLevel applies to limit orders. For market orders, REST slippageTolerance defaults to 0.02 and accepts 0.001 through 0.05, with up to three decimal places.

Parameters ​

ParameterType
paramsPlaceOrderRequestV3

Returns ​

Promise<APIResponse<PlaceOrderResponseV3>>

See ​

UTA order management


submitRepay() ​

ts
submitRepay(params: RepayRequestV3): Promise<APIResponse<RepayResponseV3>>;

Repay

Parameters ​

ParameterType
paramsRepayRequestV3

Returns ​

Promise<APIResponse<RepayResponseV3>>


submitStrategyOrder() ​

ts
submitStrategyOrder(params: PlaceStrategyOrderRequestV3): Promise<APIResponse<PlaceStrategyOrderResponseV3>>;

Place Strategy Order

Parameters ​

ParameterType
paramsPlaceStrategyOrderRequestV3

Returns ​

Promise<APIResponse<PlaceStrategyOrderResponseV3>>


submitTransfer() ​

ts
submitTransfer(params: TransferRequestV3): Promise<APIResponse<TransferResponseV3>>;

Transfer

Parameters ​

ParameterType
paramsTransferRequestV3

Returns ​

Promise<APIResponse<TransferResponseV3>>


submitWithdraw() ​

ts
submitWithdraw(params: WithdrawRequestV3): Promise<APIResponse<WithdrawResponseV3>>;

Request an on-chain withdrawal or an internal transfer.

Parameters ​

ParameterType
paramsWithdrawRequestV3

Returns ​

Promise<APIResponse<WithdrawResponseV3>>


subscribeEarnCashPlus() ​

ts
subscribeEarnCashPlus(params: EarnCashPlusSubscribeRequestV3): Promise<APIResponse<EarnCashPlusSubscribeResultV3>>;

Subscribe to Cash+. Rate limit: 1/sec/UID.

Parameters ​

ParameterType
paramsEarnCashPlusSubscribeRequestV3

Returns ​

Promise<APIResponse<EarnCashPlusSubscribeResultV3>>


subscribeEarnElite() ​

ts
subscribeEarnElite(params: EarnEliteSubscribeRequestV3): Promise<APIResponse<EarnEliteSubscribeResultV3>>;

Parameters ​

ParameterType
paramsEarnEliteSubscribeRequestV3

Returns ​

Promise<APIResponse<EarnEliteSubscribeResultV3>>


subscribeSharkfin() ​

ts
subscribeSharkfin(params: SubscribeSharkfinRequestV3): Promise<APIResponse<SubscribeSharkfinResponseV3>>;

Subscribe SharkFin. Rate limit: 10/sec/UID.

Parameters ​

ParameterType
paramsSubscribeSharkfinRequestV3

Returns ​

Promise<APIResponse<SubscribeSharkfinResponseV3>>


switchDeduct() ​

ts
switchDeduct(params: SwitchDeductRequestV3): Promise<APIResponse<string>>;

Switch Deduct - Set BGB deduction

Parameters ​

ParameterType
paramsSwitchDeductRequestV3

Returns ​

Promise<APIResponse<string>>


tradeSmallAssets() ​

ts
tradeSmallAssets(params: TradeSmallAssetsRequestV3): Promise<APIResponse<SmallAssetsTradeResponseV3>>;

Parameters ​

ParameterType
paramsTradeSmallAssetsRequestV3

Returns ​

Promise<APIResponse<SmallAssetsTradeResponseV3>>


unfollowCopyFutures() ​

ts
unfollowCopyFutures(params: UnfollowCopyFuturesRequestV3): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsUnfollowCopyFuturesRequestV3

Returns ​

Promise<APIResponse<string>>


updateP2pAd() ​

ts
updateP2pAd(params: UpdateP2pAdRequestV3): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsUpdateP2pAdRequestV3

Returns ​

Promise<APIResponse<string>>


updateSubAccountApiKey() ​

ts
updateSubAccountApiKey(params: UpdateSubAccountApiKeyRequestV3): Promise<APIResponse<UpdateSubAccountApiKeyResponseV3>>;

Modify Sub-account API Key

Parameters ​

ParameterType
paramsUpdateSubAccountApiKeyRequestV3

Returns ​

Promise<APIResponse<UpdateSubAccountApiKeyResponseV3>>


validateGridBot() ​

ts
validateGridBot(params: CreateGridBotRequestV3): Promise<APIResponse<GridValidateResponseV3>>;

=====Grid======= endpoints

Parameters ​

ParameterType
paramsCreateGridBotRequestV3

Returns ​

Promise<APIResponse<GridValidateResponseV3>>


validateNeutralGridBot() ​

ts
validateNeutralGridBot(params: CreateNeutralGridBotRequestV3): Promise<APIResponse<GridValidateResponseV3>>;

Parameters ​

ParameterType
paramsCreateNeutralGridBotRequestV3

Returns ​

Promise<APIResponse<GridValidateResponseV3>>

Built by Siebly. Open source SDKs for exchange APIs.