Class: RestClientV3
REST client for Bitget Unified Trading Account V3 APIs.
Extends
default
Constructors
Constructor
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
| Parameter | Type | Description |
|---|---|---|
restOptions? | RestClientOptions | - |
networkOptions? | AxiosRequestConfig | HTTP networking options for axios |
Returns
RestClientV3
Inherited from
BaseRestClient.constructor
Methods
addGridInvestment()
addGridInvestment(params: AddGridInvestmentRequestV3): Promise<APIResponse<GridBotIdResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | AddGridInvestmentRequestV3 |
Returns
Promise<APIResponse<GridBotIdResponseV3>>
addStpGroupMembers()
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
| Parameter | Type |
|---|---|
params | StpGroupMembersRequestV3 |
Returns
Promise<APIResponse<StpGroupMembersResponseV3>>
adjustAccountMode()
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
| Parameter | Type |
|---|---|
params | AdjustAccountModeRequestV3 |
Returns
Promise<APIResponse<null>>
batchModifyOrders()
batchModifyOrders(params: BatchModifyOrderRequestV3[]): Promise<APIResponse<BatchModifyOrderResponseV3[]>>;Batch Modify Orders
Parameters
| Parameter | Type |
|---|---|
params | BatchModifyOrderRequestV3[] |
Returns
Promise<APIResponse<BatchModifyOrderResponseV3[]>>
bindLoanUid()
bindLoanUid(params: BindUidRequestV3): Promise<APIResponse<BindUidResponseV3>>;Bind/Unbind UID to Risk Unit
Parameters
| Parameter | Type |
|---|---|
params | BindUidRequestV3 |
Returns
Promise<APIResponse<BindUidResponseV3>>
borrow()
borrow(params: BorrowRequestV3): Promise<APIResponse<BorrowResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | BorrowRequestV3 |
Returns
Promise<APIResponse<BorrowResponseV3>>
brokerSubWithdrawal()
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
| Parameter | Type |
|---|---|
params | BrokerSubWithdrawalRequestV3 |
Returns
Promise<APIResponse<BrokerSubWithdrawalResponseV3>>
cancelAllCfdOrders()
cancelAllCfdOrders(params?: CancelAllCfdOrdersRequestV3): Promise<APIResponse<null>>;Parameters
| Parameter | Type |
|---|---|
params? | CancelAllCfdOrdersRequestV3 |
Returns
Promise<APIResponse<null>>
cancelAllOrders()
cancelAllOrders(params: CancelAllOrdersRequestV3): Promise<APIResponse<CancelAllOrdersResponseV3>>;Cancel All Orders
Parameters
| Parameter | Type |
|---|---|
params | CancelAllOrdersRequestV3 |
Returns
Promise<APIResponse<CancelAllOrdersResponseV3>>
cancelBatchOrders()
cancelBatchOrders(params: CancelBatchOrdersRequestV3[]): Promise<APIResponse<CancelBatchOrdersResponseV3[]>>;Batch Cancel
Parameters
| Parameter | Type |
|---|---|
params | CancelBatchOrdersRequestV3[] |
Returns
Promise<APIResponse<CancelBatchOrdersResponseV3[]>>
cancelCfdOrder()
cancelCfdOrder(params: CancelCfdOrderRequestV3): Promise<APIResponse<null>>;Parameters
| Parameter | Type |
|---|---|
params | CancelCfdOrderRequestV3 |
Returns
Promise<APIResponse<null>>
cancelCopyFuturesTpSl()
cancelCopyFuturesTpSl(params: CancelCopyFuturesTpSlRequestV3): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | CancelCopyFuturesTpSlRequestV3 |
Returns
Promise<APIResponse<string>>
cancelOrder()
cancelOrder(params: CancelOrderRequestV3): Promise<APIResponse<CancelOrderResponseV3>>;Cancel Order
Parameters
| Parameter | Type |
|---|---|
params | CancelOrderRequestV3 |
Returns
Promise<APIResponse<CancelOrderResponseV3>>
See
cancelRealityOrder()
cancelRealityOrder(params: CancelRealityOrderRequestV3): Promise<APIResponse<CancelOrderResponseV3>>;Cancel Reality Order - Cancel an unfilled or partially filled Reality stock order
Parameters
| Parameter | Type |
|---|---|
params | CancelRealityOrderRequestV3 |
Returns
Promise<APIResponse<CancelOrderResponseV3>>
cancelStockPlusOrder()
cancelStockPlusOrder(params: CancelStockPlusOrderRequestV3): Promise<APIResponse<StockPlusPlaceOrderResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | CancelStockPlusOrderRequestV3 |
Returns
Promise<APIResponse<StockPlusPlaceOrderResponseV3>>
cancelStrategyOrder()
cancelStrategyOrder(params: CancelStrategyOrderRequestV3): Promise<APIResponse<null>>;Cancel Strategy Order
Parameters
| Parameter | Type |
|---|---|
params | CancelStrategyOrderRequestV3 |
Returns
Promise<APIResponse<null>>
cancelWithdrawal()
cancelWithdrawal(params: CancelWithdrawalRequestV3): Promise<APIResponse<string>>;Cancel a withdrawal still in the cooling-off period. Rate limit: 1/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | CancelWithdrawalRequestV3 |
Returns
Promise<APIResponse<string>>
cfdTransfer()
cfdTransfer(params: CfdTransferRequestV3): Promise<APIResponse<CfdTransferResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | CfdTransferRequestV3 |
Returns
Promise<APIResponse<CfdTransferResponseV3>>
closeAllCfdPositions()
closeAllCfdPositions(params?: CloseAllCfdPositionsRequestV3): Promise<APIResponse<null>>;Parameters
| Parameter | Type |
|---|---|
params? | CloseAllCfdPositionsRequestV3 |
Returns
Promise<APIResponse<null>>
closeAllCopyFuturesPositions()
closeAllCopyFuturesPositions(params: CloseAllCopyFuturesRequestV3): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | CloseAllCopyFuturesRequestV3 |
Returns
Promise<APIResponse<string>>
closeAllPositions()
closeAllPositions(params: CloseAllPositionsRequestV3): Promise<APIResponse<CloseAllPositionsResponseV3>>;Close All Positions
Parameters
| Parameter | Type |
|---|---|
params | CloseAllPositionsRequestV3 |
Returns
Promise<APIResponse<CloseAllPositionsResponseV3>>
closeCfdPositions()
closeCfdPositions(params: CloseCfdPositionsRequestV3): Promise<APIResponse<null>>;Parameters
| Parameter | Type |
|---|---|
params | CloseCfdPositionsRequestV3 |
Returns
Promise<APIResponse<null>>
closeCopyFuturesPositions()
closeCopyFuturesPositions(params: CloseCopyFuturesPositionsRequestV3): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | CloseCopyFuturesPositionsRequestV3 |
Returns
Promise<APIResponse<string>>
closeGridBot()
closeGridBot(params: CloseGridBotRequestV3): Promise<APIResponse<GridBotIdResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | CloseGridBotRequestV3 |
Returns
Promise<APIResponse<GridBotIdResponseV3>>
confirmP2pOrderPayment()
confirmP2pOrderPayment(params: P2pOrderActionRequestV3): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | P2pOrderActionRequestV3 |
Returns
Promise<APIResponse<string>>
copyFuturesFollowerTransfer()
copyFuturesFollowerTransfer(params: CopyFuturesFollowerTransferRequestV3): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | CopyFuturesFollowerTransferRequestV3 |
Returns
Promise<APIResponse<string>>
copyFuturesTransfer()
copyFuturesTransfer(params: CopyFuturesTransferRequestV3): Promise<APIResponse<CopyFuturesTransferResponseV3>>;Transfer funds between spot/funding and the copy-trading lead account. Rate limit: 1/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | CopyFuturesTransferRequestV3 |
Returns
Promise<APIResponse<CopyFuturesTransferResponseV3>>
countdownCancelAll()
countdownCancelAll(params: CountdownCancelAllRequestV3): Promise<APIResponse<string>>;CountDown Cancel All
Parameters
| Parameter | Type |
|---|---|
params | CountdownCancelAllRequestV3 |
Returns
Promise<APIResponse<string>>
createAgentSubAccount()
createAgentSubAccount(params: CreateAgentSubAccountRequestV3): Promise<APIResponse<CreateAgentSubAccountResponseV3>>;Create Agent Sub-account
Parameters
| Parameter | Type |
|---|---|
params | CreateAgentSubAccountRequestV3 |
Returns
Promise<APIResponse<CreateAgentSubAccountResponseV3>>
createBrokerSubAccount()
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
| Parameter | Type |
|---|---|
params | CreateBrokerSubAccountRequestV3 |
Returns
Promise<APIResponse<CreateBrokerSubAccountResponseV3>>
createBrokerSubApiKey()
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
| Parameter | Type |
|---|---|
params | CreateBrokerSubApiKeyRequestV3 |
Returns
Promise<APIResponse<CreateBrokerSubApiKeyResponseV3>>
createCopyFutures()
createCopyFutures(params: CreateCopyFuturesRequestV3): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | CreateCopyFuturesRequestV3 |
Returns
Promise<APIResponse<string>>
createGridBot()
createGridBot(params: CreateGridBotRequestV3): Promise<APIResponse<GridBotIdResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | CreateGridBotRequestV3 |
Returns
Promise<APIResponse<GridBotIdResponseV3>>
createNeutralGridBot()
createNeutralGridBot(params: CreateNeutralGridBotRequestV3): Promise<APIResponse<GridBotIdResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | CreateNeutralGridBotRequestV3 |
Returns
Promise<APIResponse<GridBotIdResponseV3>>
createP2pAd()
createP2pAd(params: CreateP2pAdRequestV3): Promise<APIResponse<P2pCreateAdResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | CreateP2pAdRequestV3 |
Returns
Promise<APIResponse<P2pCreateAdResponseV3>>
createStpGroup()
createStpGroup(params: CreateStpGroupRequestV3): Promise<APIResponse<CreateStpGroupResponseV3>>;Create STP Group MM whitelist only. Sub-accounts in one group do not match each other.
Parameters
| Parameter | Type |
|---|---|
params | CreateStpGroupRequestV3 |
Returns
Promise<APIResponse<CreateStpGroupResponseV3>>
createSubAccount()
createSubAccount(params: CreateSubAccountRequestV3): Promise<APIResponse<CreateSubAccountResponseV3>>;Create Sub-account
Parameters
| Parameter | Type |
|---|---|
params | CreateSubAccountRequestV3 |
Returns
Promise<APIResponse<CreateSubAccountResponseV3>>
createSubAccountApiKey()
createSubAccountApiKey(params: CreateSubAccountApiKeyRequestV3): Promise<APIResponse<CreateSubAccountApiKeyResponseV3>>;Create Sub-account API Key
Parameters
| Parameter | Type |
|---|---|
params | CreateSubAccountApiKeyRequestV3 |
Returns
Promise<APIResponse<CreateSubAccountApiKeyResponseV3>>
deleteBrokerSubApiKey()
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
| Parameter | Type |
|---|---|
params | DeleteBrokerSubApiKeyRequestV3 |
Returns
Promise<APIResponse<null>>
deletePrivate()
deletePrivate(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.deletePrivate
deleteSubAccount()
deleteSubAccount(params: DeleteSubAccountRequestV3): Promise<APIResponse<Record<string, never>>>;Parameters
| Parameter | Type |
|---|---|
params | DeleteSubAccountRequestV3 |
Returns
Promise<APIResponse<Record<string, never>>>
deleteSubAccountApiKey()
deleteSubAccountApiKey(params: DeleteSubAccountApiKeyRequestV3): Promise<APIResponse<any>>;Delete Sub-account API Key
Parameters
| Parameter | Type |
|---|---|
params | DeleteSubAccountApiKeyRequestV3 |
Returns
Promise<APIResponse<any>>
downgradeAccountToClassic()
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()
earnRedeemSavings(params: RedeemSavingsRequestV3): Promise<APIResponse<RedeemSavingsResponseV3>>;Redeem Savings. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | RedeemSavingsRequestV3 |
Returns
Promise<APIResponse<RedeemSavingsResponseV3>>
earnSubscribeSavings()
earnSubscribeSavings(params: SubscribeSavingsRequestV3): Promise<APIResponse<SubscribeSavingsResponseV3>>;Subscribe Savings. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | SubscribeSavingsRequestV3 |
Returns
Promise<APIResponse<SubscribeSavingsResponseV3>>
fetchLatencySummary()
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()
fetchServerTime(): Promise<number>;Returns
Promise<number>
freezeSubAccount()
freezeSubAccount(params: FreezeSubAccountRequestV3): Promise<APIResponse<object>>;Freeze/Unfreeze Sub-account
Parameters
| Parameter | Type |
|---|---|
params | FreezeSubAccountRequestV3 |
Returns
Promise<APIResponse<object>>
get()
get(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.get
getAccountInfo()
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()
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()
getAgentCustomerAssets(params?: AgentCustomerAssetRequestV3): Promise<APIResponse<AgentCustomerAssetItemV3[]>>;Get Agent Customer Asset. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params? | AgentCustomerAssetRequestV3 |
Returns
Promise<APIResponse<AgentCustomerAssetItemV3[]>>
getAgentCustomerCommissions()
getAgentCustomerCommissions(params?: GetAgentCustomerCommissionsRequestV3): Promise<APIResponse<AgentCustomerCommissionsV3>>;Get Agent Customer Commission. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params? | GetAgentCustomerCommissionsRequestV3 |
Returns
Promise<APIResponse<AgentCustomerCommissionsV3>>
getAgentCustomerDeposits()
getAgentCustomerDeposits(params?: AgentCustomerDepositRequestV3): Promise<APIResponse<AgentCustomerDepositItemV3[]>>;Get Agent Customer Deposit. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params? | AgentCustomerDepositRequestV3 |
Returns
Promise<APIResponse<AgentCustomerDepositItemV3[]>>
getAgentCustomerKycResult()
getAgentCustomerKycResult(params?: GetAgentCustomerKycResultRequestV3): Promise<APIResponse<AgentCustomerKycResultV3>>;Get Agent Customer Kyc Result. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params? | GetAgentCustomerKycResultRequestV3 |
Returns
Promise<APIResponse<AgentCustomerKycResultV3>>
getAgentCustomerList()
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
| Parameter | Type |
|---|---|
params? | AgentCustomerListRequestV3 |
Returns
Promise<APIResponse<AgentCustomerListItemV3[]>>
getAgentCustomerTradeVolume()
getAgentCustomerTradeVolume(params?: AgentCustomerTradeVolumeRequestV3): Promise<APIResponse<AgentCustomerTradeVolumeItemV3[]>>;Get Agent Customer Trade Volume. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params? | AgentCustomerTradeVolumeRequestV3 |
Returns
Promise<APIResponse<AgentCustomerTradeVolumeItemV3[]>>
getAgentSubCustomerList()
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
| Parameter | Type |
|---|---|
params? | GetAgentSubCustomerListRequestV3 |
Returns
Promise<APIResponse<AgentSubCustomerListV3>>
getAllFeeRates()
getAllFeeRates(params: GetAllFeeRatesRequestV3): Promise<APIResponse<AllSymbolFeeRateV3[]>>;Get All Symbol Fee Rates - Query fee rates for all trading pairs under a product type
Parameters
| Parameter | Type |
|---|---|
params | GetAllFeeRatesRequestV3 |
Returns
Promise<APIResponse<AllSymbolFeeRateV3[]>>
getAnnouncements()
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
| Parameter | Type |
|---|---|
params | GetAnnouncementsRequestV3 |
Returns
Promise<APIResponse<AnnouncementV3[]>>
getBalances()
getBalances(): Promise<APIResponse<AccountAssetsV3>>;Get Account Assets
Returns
Promise<APIResponse<AccountAssetsV3>>
See
Read Unified Trading Account balances
getBrokerAllSubDepositWithdrawal()
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
| Parameter | Type |
|---|---|
params? | GetBrokerAllSubDepositWithdrawalRequestV3 |
Returns
Promise<APIResponse<GetBrokerAllSubDepositWithdrawalResponseV3>>
getBrokerCommission()
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
| Parameter | Type |
|---|---|
params? | GetBrokerCommissionRequestV3 |
Returns
Promise<APIResponse<BrokerCommissionRecordV3[]>>
getBrokerOrderCommission()
getBrokerOrderCommission(params?: GetBrokerOrderCommissionRequestV3): Promise<APIResponse<BrokerOrderCommissionV3>>;Get Order Commission. Rate limit: 20/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params? | GetBrokerOrderCommissionRequestV3 |
Returns
Promise<APIResponse<BrokerOrderCommissionV3>>
getBrokerRebateInfo()
getBrokerRebateInfo(params: GetBrokerRebateInfoRequestV3): Promise<APIResponse<BrokerRebateInfoV3>>;Get Rebate Info. Rate limit: 20/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | GetBrokerRebateInfoRequestV3 |
Returns
Promise<APIResponse<BrokerRebateInfoV3>>
getBrokerSubAccountList()
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
| Parameter | Type |
|---|---|
params? | GetBrokerSubAccountListRequestV3 |
Returns
Promise<APIResponse<GetBrokerSubAccountListResponseV3>>
getBrokerSubApiKey()
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
| Parameter | Type |
|---|---|
params | GetBrokerSubApiKeyRequestV3 |
Returns
Promise<APIResponse<GetBrokerSubApiKeyResponseV3>>
getBrokerSubDepositAddress()
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
| Parameter | Type |
|---|---|
params | GetBrokerSubDepositAddressRequestV3 |
Returns
Promise<APIResponse<BrokerSubDepositAddressV3>>
getBrokerTotalCommission()
getBrokerTotalCommission(params?: GetBrokerTotalCommissionRequestV3): Promise<APIResponse<BrokerTotalCommissionV3[]>>;Get Total Commission. Rate limit: 20/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params? | GetBrokerTotalCommissionRequestV3 |
Returns
Promise<APIResponse<BrokerTotalCommissionV3[]>>
getBrokerTradeVolume()
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
| Parameter | Type |
|---|---|
params? | GetBrokerTradeVolumeRequestV3 |
Returns
Promise<APIResponse<BrokerTradeVolumeV3[]>>
getCandles()
getCandles(params: GetCandlesRequestV3): Promise<APIResponse<CandlestickV3[]>>;Get Kline/Candlestick Maximum number of returned entries: 1,000
Parameters
| Parameter | Type |
|---|---|
params | GetCandlesRequestV3 |
Returns
Promise<APIResponse<CandlestickV3[]>>
getCashDividendRecords()
getCashDividendRecords(params: GetCashDividendRecordsRequestV3): Promise<APIResponse<CashDividendRecordV3[]>>;Get Cash Dividend Records - RWA stock futures cash dividend records
Parameters
| Parameter | Type |
|---|---|
params | GetCashDividendRecordsRequestV3 |
Returns
Promise<APIResponse<CashDividendRecordV3[]>>
getCfdCurrentPositions()
getCfdCurrentPositions(params?: GetCfdCurrentPositionsRequestV3): Promise<APIResponse<CfdCurrentPositionV3[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetCfdCurrentPositionsRequestV3 |
Returns
Promise<APIResponse<CfdCurrentPositionV3[]>>
getCfdFinancialRecords()
getCfdFinancialRecords(params?: GetCfdFinancialRecordsRequestV3): Promise<APIResponse<CfdFinancialRecordV3[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetCfdFinancialRecordsRequestV3 |
Returns
Promise<APIResponse<CfdFinancialRecordV3[]>>
getCfdFundDetail()
getCfdFundDetail(): Promise<APIResponse<CfdFundDetailV3>>;Returns
Promise<APIResponse<CfdFundDetailV3>>
getCfdHistoryCandlestick()
getCfdHistoryCandlestick(params: GetCfdHistoryCandlestickRequestV3): Promise<APIResponse<CfdCandlestickV3[]>>;Parameters
| Parameter | Type |
|---|---|
params | GetCfdHistoryCandlestickRequestV3 |
Returns
Promise<APIResponse<CfdCandlestickV3[]>>
getCfdInstruments()
getCfdInstruments(params?: GetCfdInstrumentsRequestV3): Promise<APIResponse<CfdInstrumentV3[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetCfdInstrumentsRequestV3 |
Returns
Promise<APIResponse<CfdInstrumentV3[]>>
getCfdOrderHistory()
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
| Parameter | Type |
|---|---|
params | GetCfdOrderHistoryRequestV3 |
Returns
Promise<APIResponse<CfdOrderHistoryV3>>
getCfdTickers()
getCfdTickers(params?: GetCfdTickersRequestV3): Promise<APIResponse<CfdTickerV3[]>>;=====CFD======= endpoints
Parameters
| Parameter | Type |
|---|---|
params? | GetCfdTickersRequestV3 |
Returns
Promise<APIResponse<CfdTickerV3[]>>
getCfdTransferRecords()
getCfdTransferRecords(params?: GetCfdTransferRecordsRequestV3): Promise<APIResponse<CfdTransferRecordsV3>>;Parameters
| Parameter | Type |
|---|---|
params? | GetCfdTransferRecordsRequestV3 |
Returns
Promise<APIResponse<CfdTransferRecordsV3>>
getCfdUnfilledOrders()
getCfdUnfilledOrders(params?: GetCfdUnfilledOrdersRequestV3): Promise<APIResponse<CfdUnfilledOrderV3[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetCfdUnfilledOrdersRequestV3 |
Returns
Promise<APIResponse<CfdUnfilledOrderV3[]>>
getClientType()
getClientType(): "v3";Defines the client type (affecting how requests & signatures behave)
Returns
"v3"
Overrides
BaseRestClient.getClientType
getCoins()
getCoins(params?: GetCoinsRequestV3): Promise<APIResponse<MarketCoinV3[]>>;Get coin and chain information. Public responses can use withdrawMinScale; the exchange reference documents withdrawPrecision instead.
Parameters
| Parameter | Type |
|---|---|
params? | GetCoinsRequestV3 |
Returns
Promise<APIResponse<MarketCoinV3[]>>
getCollateralType()
getCollateralType(): Promise<APIResponse<CollateralTypeConfigV3>>;Get Collateral Type - Query unified account collateral configuration
Returns
Promise<APIResponse<CollateralTypeConfigV3>>
getContractsOi()
getContractsOi(params: GetContractsOiRequestV3): Promise<APIResponse<ContractOiV3[]>>;Get Open Interest Limit
Parameters
| Parameter | Type |
|---|---|
params | GetContractsOiRequestV3 |
Returns
Promise<APIResponse<ContractOiV3[]>>
getConvertRecords()
getConvertRecords(params: GetConvertRecordsRequestV3): Promise<APIResponse<{
cursor: string;
list: ConvertRecordV3[];
}>>;Get Convert Records
Parameters
| Parameter | Type |
|---|---|
params | GetConvertRecordsRequestV3 |
Returns
Promise<APIResponse<{ cursor: string; list: ConvertRecordV3[]; }>>
getCopyFuturesCopyMaxTransferable()
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
| Parameter | Type |
|---|---|
params | GetCopyFuturesCopyMaxTransferableRequestV3 |
Returns
Promise<APIResponse<CopyFuturesCopyMaxTransferableV3>>
getCopyFuturesCopyProfitDetails()
getCopyFuturesCopyProfitDetails(params: GetCopyFuturesCopyProfitDetailsRequestV3): Promise<APIResponse<CopyFuturesCopyProfitDetailsV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetCopyFuturesCopyProfitDetailsRequestV3 |
Returns
Promise<APIResponse<CopyFuturesCopyProfitDetailsV3>>
getCopyFuturesCopySettings()
getCopyFuturesCopySettings(params: GetCopyFuturesCopySettingsRequestV3): Promise<APIResponse<CopyFuturesCopySettingsV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetCopyFuturesCopySettingsRequestV3 |
Returns
Promise<APIResponse<CopyFuturesCopySettingsV3>>
getCopyFuturesCurrentCopy()
getCopyFuturesCurrentCopy(params: GetCopyFuturesCurrentCopyRequestV3): Promise<APIResponse<CopyFuturesCurrentCopyV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetCopyFuturesCurrentCopyRequestV3 |
Returns
Promise<APIResponse<CopyFuturesCurrentCopyV3>>
getCopyFuturesCurrentFollowers()
getCopyFuturesCurrentFollowers(params?: GetCopyFuturesFollowersRequestV3): Promise<APIResponse<CopyFuturesCurrentFollowersV3>>;Parameters
| Parameter | Type |
|---|---|
params? | GetCopyFuturesFollowersRequestV3 |
Returns
Promise<APIResponse<CopyFuturesCurrentFollowersV3>>
getCopyFuturesCurrentPositions()
getCopyFuturesCurrentPositions(params: GetCopyFuturesCurrentPositionsRequestV3): Promise<APIResponse<CopyFuturesFollowerPositionsV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetCopyFuturesCurrentPositionsRequestV3 |
Returns
Promise<APIResponse<CopyFuturesFollowerPositionsV3>>
getCopyFuturesCurrentTpSlOrders()
getCopyFuturesCurrentTpSlOrders(params: GetCopyFuturesCurrentTpSlOrdersRequestV3): Promise<APIResponse<CopyFuturesCurrentTpSlOrdersV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetCopyFuturesCurrentTpSlOrdersRequestV3 |
Returns
Promise<APIResponse<CopyFuturesCurrentTpSlOrdersV3>>
getCopyFuturesFollowerTransferRecords()
getCopyFuturesFollowerTransferRecords(params: GetCopyFuturesFollowerTransferRecordRequestV3): Promise<APIResponse<CopyFuturesFollowerTransferRecordListV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetCopyFuturesFollowerTransferRecordRequestV3 |
Returns
Promise<APIResponse<CopyFuturesFollowerTransferRecordListV3>>
getCopyFuturesHistoryFollowers()
getCopyFuturesHistoryFollowers(params?: GetCopyFuturesFollowersRequestV3): Promise<APIResponse<CopyFuturesHistoryFollowersV3>>;Parameters
| Parameter | Type |
|---|---|
params? | GetCopyFuturesFollowersRequestV3 |
Returns
Promise<APIResponse<CopyFuturesHistoryFollowersV3>>
getCopyFuturesMaxTransferable()
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
| Parameter | Type |
|---|---|
params | GetCopyFuturesMaxTransferableRequestV3 |
Returns
Promise<APIResponse<CopyFuturesMaxTransferableV3>>
getCopyFuturesPortfolioOverview()
getCopyFuturesPortfolioOverview(params: GetCopyFuturesPortfolioOverviewRequestV3): Promise<APIResponse<CopyFuturesPortfolioOverviewV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetCopyFuturesPortfolioOverviewRequestV3 |
Returns
Promise<APIResponse<CopyFuturesPortfolioOverviewV3>>
getCopyFuturesPositionSummary()
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()
getCopyFuturesProfitDetails(params?: GetCopyFuturesProfitDetailsRequestV3): Promise<APIResponse<CopyFuturesProfitDetailsV3>>;Parameters
| Parameter | Type |
|---|---|
params? | GetCopyFuturesProfitDetailsRequestV3 |
Returns
Promise<APIResponse<CopyFuturesProfitDetailsV3>>
getCopyFuturesProfitSummary()
getCopyFuturesProfitSummary(): Promise<APIResponse<CopyFuturesProfitSummaryV3>>;Returns
Promise<APIResponse<CopyFuturesProfitSummaryV3>>
getCopyFuturesTpSlOrderHistory()
getCopyFuturesTpSlOrderHistory(params: GetCopyFuturesTpSlOrderHistoryRequestV3): Promise<APIResponse<CopyFuturesTpSlOrderHistoryV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetCopyFuturesTpSlOrderHistoryRequestV3 |
Returns
Promise<APIResponse<CopyFuturesTpSlOrderHistoryV3>>
getCopyFuturesTradingPairs()
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()
getCopyFuturesTransferRecords(params?: GetCopyFuturesTransferRecordRequestV3): Promise<APIResponse<CopyFuturesTransferRecordListV3>>;Query copy-trading lead account transfer history. Rate limit: 1/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params? | GetCopyFuturesTransferRecordRequestV3 |
Returns
Promise<APIResponse<CopyFuturesTransferRecordListV3>>
getCurrentFundingRate()
getCurrentFundingRate(params: GetCurrentFundingRateRequestV3): Promise<APIResponse<CurrentFundingRateV3[]>>;Get Current Funding Rate
Parameters
| Parameter | Type |
|---|---|
params | GetCurrentFundingRateRequestV3 |
Returns
Promise<APIResponse<CurrentFundingRateV3[]>>
getCurrentPosition()
getCurrentPosition(params: GetCurrentPositionRequestV3): Promise<APIResponse<{
list: CurrentPositionV3[] | null;
}>>;Get Position Info
Parameters
| Parameter | Type |
|---|---|
params | GetCurrentPositionRequestV3 |
Returns
Promise<APIResponse<{ list: CurrentPositionV3[] | null; }>>
getCustomCollateralCoins()
getCustomCollateralCoins(): Promise<APIResponse<CustomCollateralCoinV3[]>>;Get Custom Collateral Coins - Platform-supported custom collateral coins
Returns
Promise<APIResponse<CustomCollateralCoinV3[]>>
getDeductInfo()
getDeductInfo(): Promise<APIResponse<{
deduct: "off" | "on";
}>>;Get Deduct Info - Get BGB deduction status
Returns
Promise<APIResponse<{ deduct: "off" | "on"; }>>
getDeltaInfo()
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()
getDepositAddress(params: GetDepositAddressRequestV3): Promise<APIResponse<DepositAddressV3>>;Get Deposit Address
Parameters
| Parameter | Type |
|---|---|
params | GetDepositAddressRequestV3 |
Returns
Promise<APIResponse<DepositAddressV3>>
getDepositRecords()
getDepositRecords(params: GetDepositRecordsRequestV3): Promise<APIResponse<DepositRecordV3[]>>;Get Deposit Records
Parameters
| Parameter | Type |
|---|---|
params | GetDepositRecordsRequestV3 |
Returns
Promise<APIResponse<DepositRecordV3[]>>
getDiscountRate()
getDiscountRate(): Promise<APIResponse<DiscountRateV3[]>>;Get Discount Rate
Returns
Promise<APIResponse<DiscountRateV3[]>>
getEarnCashPlusHistoryOrders()
getEarnCashPlusHistoryOrders(params?: GetEarnCashPlusHistoryOrdersRequestV3): Promise<APIResponse<EarnCashPlusHistoryOrdersV3>>;Cash+ history. Pass nextCursor as cursor. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params? | GetEarnCashPlusHistoryOrdersRequestV3 |
Returns
Promise<APIResponse<EarnCashPlusHistoryOrdersV3>>
getEarnCashPlusPositions()
getEarnCashPlusPositions(): Promise<APIResponse<EarnCashPlusPositionV3>>;Cash+ holding, cumulative profit, and APR. Rate limit: 10/sec/UID.
Returns
Promise<APIResponse<EarnCashPlusPositionV3>>
getEarnCashPlusRedeemInfo()
getEarnCashPlusRedeemInfo(): Promise<APIResponse<EarnCashPlusRedeemInfoV3>>;Cash+ redemption prerequisites: credited coins and the redeemable position. Rate limit: 10/sec/UID.
Returns
Promise<APIResponse<EarnCashPlusRedeemInfoV3>>
getEarnCashPlusRedeemResult()
getEarnCashPlusRedeemResult(params: GetEarnCashPlusRedeemResultRequestV3): Promise<APIResponse<EarnCashPlusRedeemStatusV3>>;Result of a Cash+ redemption order. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | GetEarnCashPlusRedeemResultRequestV3 |
Returns
Promise<APIResponse<EarnCashPlusRedeemStatusV3>>
getEarnCashPlusSubscribeInfo()
getEarnCashPlusSubscribeInfo(): Promise<APIResponse<EarnCashPlusSubscribeInfoV3>>;Cash+ subscription prerequisites: APR and the subscribable coin list. Rate limit: 10/sec/UID.
Returns
Promise<APIResponse<EarnCashPlusSubscribeInfoV3>>
getEarnCashPlusSubscribeResult()
getEarnCashPlusSubscribeResult(params: GetEarnCashPlusSubscribeResultRequestV3): Promise<APIResponse<EarnCashPlusSubscribeStatusV3>>;Result of a Cash+ subscription order. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | GetEarnCashPlusSubscribeResultRequestV3 |
Returns
Promise<APIResponse<EarnCashPlusSubscribeStatusV3>>
getEarnEliteAssets()
getEarnEliteAssets(): Promise<APIResponse<EarnEliteAssetsV3>>;Returns
Promise<APIResponse<EarnEliteAssetsV3>>
getEarnEliteProducts()
getEarnEliteProducts(): Promise<APIResponse<EarnEliteProductV3[]>>;=====Earn | On-Chain Elite (UTA)=====
Returns
Promise<APIResponse<EarnEliteProductV3[]>>
getEarnEliteRecords()
getEarnEliteRecords(params: GetEarnEliteRecordsRequestV3): Promise<APIResponse<EarnEliteRecordsV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetEarnEliteRecordsRequestV3 |
Returns
Promise<APIResponse<EarnEliteRecordsV3>>
getEarnEliteRedeemInfo()
getEarnEliteRedeemInfo(params: GetEarnEliteRedeemInfoRequestV3): Promise<APIResponse<EarnEliteRedeemInfoV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetEarnEliteRedeemInfoRequestV3 |
Returns
Promise<APIResponse<EarnEliteRedeemInfoV3>>
getEarnEliteSubscribeInfo()
getEarnEliteSubscribeInfo(params: GetEarnEliteSubscribeInfoRequestV3): Promise<APIResponse<EarnEliteSubscribeInfoV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetEarnEliteSubscribeInfoRequestV3 |
Returns
Promise<APIResponse<EarnEliteSubscribeInfoV3>>
getEarnEliteSubscribeResult()
getEarnEliteSubscribeResult(params: GetEarnEliteSubscribeResultRequestV3): Promise<APIResponse<EarnEliteSubscribeStatusV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetEarnEliteSubscribeResultRequestV3 |
Returns
Promise<APIResponse<EarnEliteSubscribeStatusV3>>
getEarnSavingsAccount()
getEarnSavingsAccount(): Promise<APIResponse<EarnSavingsAccountV3>>;Savings Account. Rate limit: 10/sec/UID.
Returns
Promise<APIResponse<EarnSavingsAccountV3>>
getEarnSavingsAssets()
getEarnSavingsAssets(params: GetEarnSavingsAssetsRequestV3): Promise<APIResponse<EarnSavingsAssetsV3>>;Savings Assets. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | GetEarnSavingsAssetsRequestV3 |
Returns
Promise<APIResponse<EarnSavingsAssetsV3>>
getEarnSavingsProducts()
getEarnSavingsProducts(params?: GetEarnSavingsProductsRequestV3): Promise<APIResponse<EarnSavingsProductV3[]>>;Get Savings Product List. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params? | GetEarnSavingsProductsRequestV3 |
Returns
Promise<APIResponse<EarnSavingsProductV3[]>>
getEarnSavingsRecords()
getEarnSavingsRecords(params: GetEarnSavingsRecordsRequestV3): Promise<APIResponse<EarnSavingsRecordsV3>>;Savings Records. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | GetEarnSavingsRecordsRequestV3 |
Returns
Promise<APIResponse<EarnSavingsRecordsV3>>
getEarnSavingsRedemptionResult()
getEarnSavingsRedemptionResult(params: GetEarnSavingsRedemptionResultRequestV3): Promise<APIResponse<EarnSavingsRedemptionResultV3>>;Savings Redemption Results. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | GetEarnSavingsRedemptionResultRequestV3 |
Returns
Promise<APIResponse<EarnSavingsRedemptionResultV3>>
getEarnSavingsSubscription()
getEarnSavingsSubscription(params: GetEarnSavingsSubscriptionRequestV3): Promise<APIResponse<EarnSavingsSubscriptionDetailV3>>;Savings Subscription Detail. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | GetEarnSavingsSubscriptionRequestV3 |
Returns
Promise<APIResponse<EarnSavingsSubscriptionDetailV3>>
getEarnSavingsSubscriptionResult()
getEarnSavingsSubscriptionResult(params: GetEarnSavingsSubscriptionResultRequestV3): Promise<APIResponse<EarnSavingsSubscriptionResultV3>>;Savings Subscription Result. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | GetEarnSavingsSubscriptionResultRequestV3 |
Returns
Promise<APIResponse<EarnSavingsSubscriptionResultV3>>
getEligibleDiscountRate()
getEligibleDiscountRate(params?: GetEligibleDiscountRateRequestV3): Promise<APIResponse<EligibleDiscountRateV3[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetEligibleDiscountRateRequestV3 |
Returns
Promise<APIResponse<EligibleDiscountRateV3[]>>
getEligibleLoanInfo()
getEligibleLoanInfo(params?: GetEligibleLoanInfoRequestV3): Promise<APIResponse<EligibleLoanInfoV3[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetEligibleLoanInfoRequestV3 |
Returns
Promise<APIResponse<EligibleLoanInfoV3[]>>
getEligibleMarginTier()
getEligibleMarginTier(params?: GetEligibleMarginTierRequestV3): Promise<APIResponse<EligibleMarginTierV3[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetEligibleMarginTierRequestV3 |
Returns
Promise<APIResponse<EligibleMarginTierV3[]>>
getEligibleSymbols()
getEligibleSymbols(params?: GetEligibleSymbolsRequestV3): Promise<APIResponse<EligibleSymbolV3[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetEligibleSymbolsRequestV3 |
Returns
Promise<APIResponse<EligibleSymbolV3[]>>
getFeeRate()
getFeeRate(params: GetFeeRateRequestV3): Promise<APIResponse<{
makerFeeRate: string;
takerFeeRate: string;
}>>;Get Trading Fee Rate
Parameters
| Parameter | Type |
|---|---|
params | GetFeeRateRequestV3 |
Returns
Promise<APIResponse<{ makerFeeRate: string; takerFeeRate: string; }>>
getFills()
getFills(params: GetPublicFillsRequestV3): Promise<APIResponse<PublicFillV3[]>>;Get Recent Public Fills
Parameters
| Parameter | Type |
|---|---|
params | GetPublicFillsRequestV3 |
Returns
Promise<APIResponse<PublicFillV3[]>>
getFinancialRecords()
getFinancialRecords(params: GetFinancialRecordsRequestV3): Promise<APIResponse<{
cursor: string | null;
list: FinancialRecordV3[] | null;
}>>;Get Financial Records
Parameters
| Parameter | Type |
|---|---|
params | GetFinancialRecordsRequestV3 |
Returns
Promise<APIResponse<{ cursor: string | null; list: FinancialRecordV3[] | null; }>>
getFundingAssets()
getFundingAssets(params?: GetFundingAssetsRequestV3): Promise<APIResponse<FundingAssetV3[]>>;Get Fund Account Assets
Parameters
| Parameter | Type |
|---|---|
params? | GetFundingAssetsRequestV3 |
Returns
Promise<APIResponse<FundingAssetV3[]>>
getFundingFinancialRecords()
getFundingFinancialRecords(params?: GetFundingFinancialRecordsRequestV3): Promise<APIResponse<{
cursor: string;
list: FundingFinancialRecordV3[];
}>>;Parameters
| Parameter | Type |
|---|---|
params? | GetFundingFinancialRecordsRequestV3 |
Returns
Promise<APIResponse<{ cursor: string; list: FundingFinancialRecordV3[]; }>>
getFuturesAccountLongShort()
getFuturesAccountLongShort(params: GetFuturesTradingDataRequestV3): Promise<APIResponse<FuturesAccountLongShortV3[]>>;Get Futures Active Long Short Account Data
Parameters
| Parameter | Type |
|---|---|
params | GetFuturesTradingDataRequestV3 |
Returns
Promise<APIResponse<FuturesAccountLongShortV3[]>>
getFuturesActiveBuySell()
getFuturesActiveBuySell(params: GetFuturesTradingDataRequestV3): Promise<APIResponse<FuturesActiveBuySellV3[]>>;Get Futures Active Buy Sell Volume Data
Parameters
| Parameter | Type |
|---|---|
params | GetFuturesTradingDataRequestV3 |
Returns
Promise<APIResponse<FuturesActiveBuySellV3[]>>
getFuturesLongShort()
getFuturesLongShort(params: GetFuturesTradingDataRequestV3): Promise<APIResponse<FuturesLongShortV3[]>>;Get Futures Long Short Ratio Data
Parameters
| Parameter | Type |
|---|---|
params | GetFuturesTradingDataRequestV3 |
Returns
Promise<APIResponse<FuturesLongShortV3[]>>
getFuturesPositionLongShort()
getFuturesPositionLongShort(params: GetFuturesTradingDataRequestV3): Promise<APIResponse<FuturesPositionLongShortV3[]>>;Get Futures Active Long Short Position Data
Parameters
| Parameter | Type |
|---|---|
params | GetFuturesTradingDataRequestV3 |
Returns
Promise<APIResponse<FuturesPositionLongShortV3[]>>
getGridBotDetail()
getGridBotDetail(params: GetGridBotDetailRequestV3): Promise<APIResponse<GridBotDetailV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetGridBotDetailRequestV3 |
Returns
Promise<APIResponse<GridBotDetailV3>>
getGridBotOrderDetails()
getGridBotOrderDetails(params: GetGridBotOrderDetailsRequestV3): Promise<APIResponse<GridBotOrderDetailsV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetGridBotOrderDetailsRequestV3 |
Returns
Promise<APIResponse<GridBotOrderDetailsV3>>
getHistoryCandles()
getHistoryCandles(params: GetHistoryCandlesRequestV3): Promise<APIResponse<CandlestickV3[]>>;Get Kline/Candlestick History
Parameters
| Parameter | Type |
|---|---|
params | GetHistoryCandlesRequestV3 |
Returns
Promise<APIResponse<CandlestickV3[]>>
getHistoryFundingRate()
getHistoryFundingRate(params: GetHistoryFundingRateRequestV3): Promise<APIResponse<HistoryFundingRateV3[]>>;Get Funding Rate History
Parameters
| Parameter | Type |
|---|---|
params | GetHistoryFundingRateRequestV3 |
Returns
Promise<APIResponse<HistoryFundingRateV3[]>>
getHistoryOrders()
getHistoryOrders(params: GetHistoryOrdersRequestV3): Promise<APIResponse<{
cursor: string;
list: HistoryOrderV3[];
}>>;Get Order History
Parameters
| Parameter | Type |
|---|---|
params | GetHistoryOrdersRequestV3 |
Returns
Promise<APIResponse<{ cursor: string; list: HistoryOrderV3[]; }>>
See
getHistoryStrategyOrders()
getHistoryStrategyOrders(params: GetHistoryStrategyOrdersRequestV3): Promise<APIResponse<{
cursor?: string | number;
list: StrategyOrderV3[];
}>>;Get Strategy Order History
Parameters
| Parameter | Type |
|---|---|
params | GetHistoryStrategyOrdersRequestV3 |
Returns
Promise<APIResponse<{ cursor?: string | number; list: StrategyOrderV3[]; }>>
getIndexComponents()
getIndexComponents(params: GetIndexComponentsRequestV3): Promise<APIResponse<IndexPriceComponentsV3>>;Get Index Price Components
Parameters
| Parameter | Type |
|---|---|
params | GetIndexComponentsRequestV3 |
Returns
Promise<APIResponse<IndexPriceComponentsV3>>
getInstruments()
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
| Parameter | Type |
|---|---|
params | GetInstrumentsRequestV3 |
Returns
Promise<APIResponse<InstrumentV3[]>>
getInterestRateHistory()
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
| Parameter | Type |
|---|---|
params | GetInterestRateHistoryRequestV3 |
Returns
Promise<APIResponse<InterestRateHistoryV3>>
getLiquidations()
getLiquidations(params: GetLiquidationsRequestV3): Promise<APIResponse<LiquidationsV3>>;Get Liquidations History - Query historical liquidation order data (last 3 days)
Parameters
| Parameter | Type |
|---|---|
params | GetLiquidationsRequestV3 |
Returns
Promise<APIResponse<LiquidationsV3>>
getLoanBorrowHistory()
getLoanBorrowHistory(params: GetLoanBorrowHistoryRequestV3): Promise<APIResponse<LoanBorrowHistoryItemV3[]>>;Get Borrow History - Query borrowing history
Parameters
| Parameter | Type |
|---|---|
params | GetLoanBorrowHistoryRequestV3 |
Returns
Promise<APIResponse<LoanBorrowHistoryItemV3[]>>
getLoanBorrowOngoing()
getLoanBorrowOngoing(params?: GetLoanBorrowOngoingRequestV3): Promise<APIResponse<LoanBorrowOngoingItemV3[]>>;Get Borrow Ongoing - Query current borrowings
Parameters
| Parameter | Type |
|---|---|
params? | GetLoanBorrowOngoingRequestV3 |
Returns
Promise<APIResponse<LoanBorrowOngoingItemV3[]>>
getLoanCoins()
getLoanCoins(params?: GetLoanCoinsRequestV3): Promise<APIResponse<GetLoanCoinsResponseV3>>;Get Loan Coins - Query supported collateral currencies and borrowable coins
Parameters
| Parameter | Type |
|---|---|
params? | GetLoanCoinsRequestV3 |
Returns
Promise<APIResponse<GetLoanCoinsResponseV3>>
getLoanData()
getLoanData(): Promise<APIResponse<LoanDataV3>>;Get Loan Data - Query current loan data for the unified trading account
Returns
Promise<APIResponse<LoanDataV3>>
getLoanDebts()
getLoanDebts(): Promise<APIResponse<GetLoanDebtsResponseV3>>;Get Loan Debts - Query assets and liabilities
Returns
Promise<APIResponse<GetLoanDebtsResponseV3>>
getLoanInterest()
getLoanInterest(params: GetLoanInterestRequestV3): Promise<APIResponse<GetLoanInterestResponseV3>>;Get Loan Interest - Query estimated interest and borrowable amount
Parameters
| Parameter | Type |
|---|---|
params | GetLoanInterestRequestV3 |
Returns
Promise<APIResponse<GetLoanInterestResponseV3>>
getLoanLTVConvert()
getLoanLTVConvert(params?: GetLTVConvertRequestV3): Promise<APIResponse<LTVConvertResponseV3>>;Get LTV
Parameters
| Parameter | Type |
|---|---|
params? | GetLTVConvertRequestV3 |
Returns
Promise<APIResponse<LTVConvertResponseV3>>
getLoanMarginCoinInfo()
getLoanMarginCoinInfo(params: GetEnsureCoinsRequestV3): Promise<APIResponse<{
coinInfo: CoinInfoV3[];
productId: string;
}>>;Get Margin Coin Info
Parameters
| Parameter | Type |
|---|---|
params | GetEnsureCoinsRequestV3 |
Returns
Promise<APIResponse<{ coinInfo: CoinInfoV3[]; productId: string; }>>
getLoanOrder()
getLoanOrder(params?: GetLoanOrderRequestV3): Promise<APIResponse<LoanOrderV3[]>>;Get Loan Orders
Parameters
| Parameter | Type |
|---|---|
params? | GetLoanOrderRequestV3 |
Returns
Promise<APIResponse<LoanOrderV3[]>>
getLoanPledgeRateHistory()
getLoanPledgeRateHistory(params: GetLoanPledgeRateHistoryRequestV3): Promise<APIResponse<LoanPledgeRateHistoryItemV3[]>>;Get Pledge Rate History - Query collateral ratio history
Parameters
| Parameter | Type |
|---|---|
params | GetLoanPledgeRateHistoryRequestV3 |
Returns
Promise<APIResponse<LoanPledgeRateHistoryItemV3[]>>
getLoanProductInfo()
getLoanProductInfo(params: GetProductInfosRequestV3): Promise<APIResponse<LoanProductInfoV3>>;Get Product Info
Parameters
| Parameter | Type |
|---|---|
params | GetProductInfosRequestV3 |
Returns
Promise<APIResponse<LoanProductInfoV3>>
getLoanReduces()
getLoanReduces(params: GetLoanReducesRequestV3): Promise<APIResponse<LoanReduceItemV3[]>>;Get Loan Reduces - Query liquidation records
Parameters
| Parameter | Type |
|---|---|
params | GetLoanReducesRequestV3 |
Returns
Promise<APIResponse<LoanReduceItemV3[]>>
getLoanRepaidHistory()
getLoanRepaidHistory(params?: GetRepaidHistoryRequestV3): Promise<APIResponse<RepaidHistoryItemV3[]>>;Get Repayment Orders
Parameters
| Parameter | Type |
|---|---|
params? | GetRepaidHistoryRequestV3 |
Returns
Promise<APIResponse<RepaidHistoryItemV3[]>>
getLoanRepayHistory()
getLoanRepayHistory(params: GetLoanRepayHistoryRequestV3): Promise<APIResponse<LoanRepayHistoryItemV3[]>>;Get Repay History - Query repayment history
Parameters
| Parameter | Type |
|---|---|
params | GetLoanRepayHistoryRequestV3 |
Returns
Promise<APIResponse<LoanRepayHistoryItemV3[]>>
getLoanRiskUnit()
getLoanRiskUnit(): Promise<APIResponse<{
riskUnitId: string[];
}>>;Get Risk Unit
Returns
Promise<APIResponse<{ riskUnitId: string[]; }>>
getLoanSymbols()
getLoanSymbols(params: GetSymbolsRequestV3): Promise<APIResponse<LoanSymbolsV3>>;Get Trade Symbols
Parameters
| Parameter | Type |
|---|---|
params | GetSymbolsRequestV3 |
Returns
Promise<APIResponse<LoanSymbolsV3>>
getLoanTransfered()
getLoanTransfered(params: GetTransferedRequestV3): Promise<APIResponse<LoanTransfersV3>>;Get Transferred Quantity
Parameters
| Parameter | Type |
|---|---|
params | GetTransferedRequestV3 |
Returns
Promise<APIResponse<LoanTransfersV3>>
getMarginIsolatedBorrow()
getMarginIsolatedBorrow(params: GetMarginIsolatedBorrowRequestV3): Promise<APIResponse<MarginIsolatedBorrowV3[]>>;Get Isolated Margin Borrowing Ratio Data
Parameters
| Parameter | Type |
|---|---|
params | GetMarginIsolatedBorrowRequestV3 |
Returns
Promise<APIResponse<MarginIsolatedBorrowV3[]>>
getMarginLoanGrowth()
getMarginLoanGrowth(params: GetMarginLoanGrowthRequestV3): Promise<APIResponse<MarginLoanGrowthV3[]>>;Get Margin Loan Growth Rate Data
Parameters
| Parameter | Type |
|---|---|
params | GetMarginLoanGrowthRequestV3 |
Returns
Promise<APIResponse<MarginLoanGrowthV3[]>>
getMarginLoans()
getMarginLoans(params: GetMarginLoansRequestV3): Promise<APIResponse<MarginLoanV3>>;Get Margin Loan
Parameters
| Parameter | Type |
|---|---|
params | GetMarginLoansRequestV3 |
Returns
Promise<APIResponse<MarginLoanV3>>
getMarginLoansAll()
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
| Parameter | Type |
|---|---|
params? | GetMarginLoansAllRequestV3 |
Returns
Promise<APIResponse<MarginLoanAllV3[]>>
getMarginLongShort()
getMarginLongShort(params: GetMarginLongShortRequestV3): Promise<APIResponse<MarginLongShortV3[]>>;Get Margin Long Short Ratio Data
Parameters
| Parameter | Type |
|---|---|
params | GetMarginLongShortRequestV3 |
Returns
Promise<APIResponse<MarginLongShortV3[]>>
getMarketFeeGroup()
getMarketFeeGroup(params: GetMarketFeeGroupRequestV3): Promise<APIResponse<MarketFeeGroupV3[]>>;Get Market Maker Fee Group - Query fee rate tiers and grouping
Parameters
| Parameter | Type |
|---|---|
params | GetMarketFeeGroupRequestV3 |
Returns
Promise<APIResponse<MarketFeeGroupV3[]>>
getMarketScoreWeights()
getMarketScoreWeights(params?: GetMarketScoreWeightsRequestV3): Promise<APIResponse<MarketScoreWeightV3[]>>;Get Market Maker Score Weight - Query score weights per symbol
Parameters
| Parameter | Type |
|---|---|
params? | GetMarketScoreWeightsRequestV3 |
Returns
Promise<APIResponse<MarketScoreWeightV3[]>>
getMaxBorrowable()
getMaxBorrowable(params: GetMaxBorrowableRequestV3): Promise<APIResponse<MaxBorrowableV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetMaxBorrowableRequestV3 |
Returns
Promise<APIResponse<MaxBorrowableV3>>
getMaxOpenAvailable()
getMaxOpenAvailable(params: GetMaxOpenAvailableRequestV3): Promise<APIResponse<GetMaxOpenAvailableResponseV3>>;Get Max Open Available marginMode defaults to crossed. Under isolated margin, available excludes futures trial funds.
Parameters
| Parameter | Type |
|---|---|
params | GetMaxOpenAvailableRequestV3 |
Returns
Promise<APIResponse<GetMaxOpenAvailableResponseV3>>
getMaxTransferable()
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
| Parameter | Type |
|---|---|
params | GetMaxTransferableRequestV3 |
Returns
Promise<APIResponse<MaxTransferableV3>>
getMaxWithdrawal()
getMaxWithdrawal(params: GetMaxWithdrawalRequestV3): Promise<APIResponse<MaxWithdrawalV3>>;Get Max Withdrawal - Max withdrawable amount for a coin in unified account
Parameters
| Parameter | Type |
|---|---|
params | GetMaxWithdrawalRequestV3 |
Returns
Promise<APIResponse<MaxWithdrawalV3>>
getMovePositionHistory()
getMovePositionHistory(params: GetMovePositionHistoryRequestV3): Promise<APIResponse<{
cursor: string;
list: MovePositionHistoryV3[];
}>>;Get Move Position History
Parameters
| Parameter | Type |
|---|---|
params | GetMovePositionHistoryRequestV3 |
Returns
Promise<APIResponse<{ cursor: string; list: MovePositionHistoryV3[]; }>>
getNeutralGridBotDetail()
getNeutralGridBotDetail(params: GetNeutralGridBotDetailRequestV3): Promise<APIResponse<NeutralGridBotDetailV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetNeutralGridBotDetailRequestV3 |
Returns
Promise<APIResponse<NeutralGridBotDetailV3>>
getNeutralGridBotOrderDetails()
getNeutralGridBotOrderDetails(params: GetNeutralGridBotOrderDetailsRequestV3): Promise<APIResponse<GridBotOrderDetailsV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetNeutralGridBotOrderDetailsRequestV3 |
Returns
Promise<APIResponse<GridBotOrderDetailsV3>>
getOpenInterest()
getOpenInterest(params: GetOpenInterestRequestV3): Promise<APIResponse<OpenInterestV3>>;Get Open Interest
Parameters
| Parameter | Type |
|---|---|
params | GetOpenInterestRequestV3 |
Returns
Promise<APIResponse<OpenInterestV3>>
getOpenInterestHistory()
getOpenInterestHistory(params: GetOpenInterestHistoryRequestV3): Promise<APIResponse<OpenInterestHistoryV3>>;Get Open Interest History period default is 5m. Rate limit 10/sec/IP.
Parameters
| Parameter | Type |
|---|---|
params | GetOpenInterestHistoryRequestV3 |
Returns
Promise<APIResponse<OpenInterestHistoryV3>>
getOpenInterestLimit()
getOpenInterestLimit(params: GetOpenInterestLimitRequestV3): Promise<APIResponse<OpenInterestLimitV3>>;Get Open Interest Limit
- Rate limit: 5/sec/UID
- Get open interest limit for a symbol
Parameters
| Parameter | Type |
|---|---|
params | GetOpenInterestLimitRequestV3 |
Returns
Promise<APIResponse<OpenInterestLimitV3>>
getOrderBook()
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
| Parameter | Type |
|---|---|
params | GetOrderBookRequestV3 |
Returns
Promise<APIResponse<OrderBookV3>>
See
getOrderInfo()
getOrderInfo(params: GetOrderInfoRequestV3): Promise<APIResponse<OrderInfoV3>>;Get Order Details
Parameters
| Parameter | Type |
|---|---|
params | GetOrderInfoRequestV3 |
Returns
Promise<APIResponse<OrderInfoV3>>
See
getP2pAdInfo()
getP2pAdInfo(params: GetP2pAdInfoRequestV3): Promise<APIResponse<P2pAdInfoV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetP2pAdInfoRequestV3 |
Returns
Promise<APIResponse<P2pAdInfoV3>>
getP2pAdLimit()
getP2pAdLimit(params: GetP2pAdLimitRequestV3): Promise<APIResponse<P2pAdLimitV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetP2pAdLimitRequestV3 |
Returns
Promise<APIResponse<P2pAdLimitV3>>
getP2pAdList()
getP2pAdList(params: GetP2pAdListRequestV3): Promise<APIResponse<P2pPublicAdListItemV3[]>>;=====P2P Merchant (UTA)=====
Parameters
| Parameter | Type |
|---|---|
params | GetP2pAdListRequestV3 |
Returns
Promise<APIResponse<P2pPublicAdListItemV3[]>>
getP2pAllOrders()
getP2pAllOrders(params?: GetP2pAllOrdersRequestV3): Promise<APIResponse<P2pCursorListV3<P2pOrderListItemV3>>>;Parameters
| Parameter | Type |
|---|---|
params? | GetP2pAllOrdersRequestV3 |
Returns
Promise<APIResponse<P2pCursorListV3<P2pOrderListItemV3>>>
getP2pBalance()
getP2pBalance(params: GetP2pBalanceRequestV3): Promise<APIResponse<P2pBalanceV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetP2pBalanceRequestV3 |
Returns
Promise<APIResponse<P2pBalanceV3>>
getP2pCurrencies()
getP2pCurrencies(): Promise<APIResponse<P2pCurrenciesV3>>;Returns
Promise<APIResponse<P2pCurrenciesV3>>
getP2pExchangeRate()
getP2pExchangeRate(params: GetP2pExchangeRateRequestV3): Promise<APIResponse<P2pExchangeRateV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetP2pExchangeRateRequestV3 |
Returns
Promise<APIResponse<P2pExchangeRateV3>>
getP2pMyAds()
getP2pMyAds(params?: GetP2pMyAdsRequestV3): Promise<APIResponse<P2pCursorListV3<P2pMyAdListItemV3>>>;Parameters
| Parameter | Type |
|---|---|
params? | GetP2pMyAdsRequestV3 |
Returns
Promise<APIResponse<P2pCursorListV3<P2pMyAdListItemV3>>>
getP2pOrderInfo()
getP2pOrderInfo(params: GetP2pOrderInfoRequestV3): Promise<APIResponse<P2pOrderInfoV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetP2pOrderInfoRequestV3 |
Returns
Promise<APIResponse<P2pOrderInfoV3>>
getP2pPayMethods()
getP2pPayMethods(): Promise<APIResponse<P2pPayMethodV3[]>>;Returns
Promise<APIResponse<P2pPayMethodV3[]>>
getP2pPendingOrders()
getP2pPendingOrders(params?: GetP2pPendingOrdersRequestV3): Promise<APIResponse<P2pCursorListV3<P2pOrderListItemV3>>>;Parameters
| Parameter | Type |
|---|---|
params? | GetP2pPendingOrdersRequestV3 |
Returns
Promise<APIResponse<P2pCursorListV3<P2pOrderListItemV3>>>
getP2pUserInfo()
getP2pUserInfo(): Promise<APIResponse<P2pUserInfoV3>>;Returns
Promise<APIResponse<P2pUserInfoV3>>
getPaymentCoins()
getPaymentCoins(): Promise<APIResponse<{
maxSelection: string;
paymentCoinList: PaymentCoinV3[];
}>>;Get Payment Coins
Returns
Promise<APIResponse<{ maxSelection: string; paymentCoinList: PaymentCoinV3[]; }>>
getPositionAdlRank()
getPositionAdlRank(): Promise<APIResponse<PositionAdlRankV3[]>>;Get Position ADL Rank - Get position auto-deleveraging ranking
Returns
Promise<APIResponse<PositionAdlRankV3[]>>
getPositionHistory()
getPositionHistory(params: GetPositionHistoryRequestV3): Promise<APIResponse<{
cursor: string;
list: PositionHistoryV3[];
}>>;Get Positions History
Parameters
| Parameter | Type |
|---|---|
params | GetPositionHistoryRequestV3 |
Returns
Promise<APIResponse<{ cursor: string; list: PositionHistoryV3[]; }>>
getPositionTier()
getPositionTier(params: GetPositionTierRequestV3): Promise<APIResponse<PositionTierV3[]>>;Get Position Tier
Parameters
| Parameter | Type |
|---|---|
params | GetPositionTierRequestV3 |
Returns
Promise<APIResponse<PositionTierV3[]>>
getPrivate()
getPrivate(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.getPrivate
getProofOfReserves()
getProofOfReserves(): Promise<APIResponse<ProofOfReservesV3>>;Get Proof Of Reserves
Returns
Promise<APIResponse<ProofOfReservesV3>>
getRateLimitQuota()
getRateLimitQuota(params: GetRateLimitQuotaRequestV3): Promise<APIResponse<RateLimitQuotaV3>>;Get RateLimit Quota A sub-account can query its own quota. uid is ignored on that call.
Parameters
| Parameter | Type |
|---|---|
params | GetRateLimitQuotaRequestV3 |
Returns
Promise<APIResponse<RateLimitQuotaV3>>
getRealityCompanyOverview()
getRealityCompanyOverview(params: GetRealityCompanyOverviewRequestV3): Promise<APIResponse<RealityCompanyOverviewV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetRealityCompanyOverviewRequestV3 |
Returns
Promise<APIResponse<RealityCompanyOverviewV3>>
getRealityDividends()
getRealityDividends(params: GetRealityDividendsRequestV3): Promise<APIResponse<RealityCursorListV3<RealityDividendItemV3>>>;Parameters
| Parameter | Type |
|---|---|
params | GetRealityDividendsRequestV3 |
Returns
Promise<APIResponse<RealityCursorListV3<RealityDividendItemV3>>>
getRealityEarningsForecast()
getRealityEarningsForecast(params: GetRealityEarningsForecastRequestV3): Promise<APIResponse<RealityEarningsForecastV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetRealityEarningsForecastRequestV3 |
Returns
Promise<APIResponse<RealityEarningsForecastV3>>
getRealityExecutiveShareholdings()
getRealityExecutiveShareholdings(params: GetRealityExecutiveShareholdingsRequestV3): Promise<APIResponse<RealityCursorListV3<RealityExecutiveShareholdingItemV3>>>;Parameters
| Parameter | Type |
|---|---|
params | GetRealityExecutiveShareholdingsRequestV3 |
Returns
Promise<APIResponse<RealityCursorListV3<RealityExecutiveShareholdingItemV3>>>
getRealityFills()
getRealityFills(params: GetRealityFillsRequestV3): Promise<APIResponse<RealityFillV3[]>>;Get Reality Fills
Parameters
| Parameter | Type |
|---|---|
params | GetRealityFillsRequestV3 |
Returns
Promise<APIResponse<RealityFillV3[]>>
getRealityInnerTrades()
getRealityInnerTrades(params: GetRealityInnerTradesRequestV3): Promise<APIResponse<RealityCursorListV3<RealityInnerTradeItemV3>>>;Parameters
| Parameter | Type |
|---|---|
params | GetRealityInnerTradesRequestV3 |
Returns
Promise<APIResponse<RealityCursorListV3<RealityInnerTradeItemV3>>>
getRealityMarketCalendar()
getRealityMarketCalendar(): Promise<APIResponse<RealityMarketCalendarV3>>;Returns
Promise<APIResponse<RealityMarketCalendarV3>>
getRealityMarketStates()
getRealityMarketStates(): Promise<APIResponse<RealityMarketStateV3[]>>;Returns
Promise<APIResponse<RealityMarketStateV3[]>>
getRealityOrderBook()
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
| Parameter | Type |
|---|---|
params | GetRealityOrderBookRequestV3 |
Returns
Promise<APIResponse<RealityOrderBookV3>>
getRealityOrderBookSegmented()
getRealityOrderBookSegmented(params: GetRealityOrderBookSegmentedRequestV3): Promise<APIResponse<RealityOrderBookSegmentedV3>>;Get segmented rToken depth, with onshore and offshore quantities at each price. Requires whitelist access.
Parameters
| Parameter | Type |
|---|---|
params | GetRealityOrderBookSegmentedRequestV3 |
Returns
Promise<APIResponse<RealityOrderBookSegmentedV3>>
getRealityShareCapitalChange()
getRealityShareCapitalChange(params: GetRealityShareCapitalChangeRequestV3): Promise<APIResponse<RealityShareCapitalChangeV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetRealityShareCapitalChangeRequestV3 |
Returns
Promise<APIResponse<RealityShareCapitalChangeV3>>
getRealityShareholdDetail()
getRealityShareholdDetail(params: GetRealityShareholdDetailRequestV3): Promise<APIResponse<RealityCursorListV3<RealityShareholdDetailItemV3>>>;Parameters
| Parameter | Type |
|---|---|
params | GetRealityShareholdDetailRequestV3 |
Returns
Promise<APIResponse<RealityCursorListV3<RealityShareholdDetailItemV3>>>
getRealityStockInfo()
getRealityStockInfo(params?: GetRealityStockInfoRequestV3): Promise<APIResponse<RealityStockInfoV3[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetRealityStockInfoRequestV3 |
Returns
Promise<APIResponse<RealityStockInfoV3[]>>
getRealitySuspensionResumptionInfo()
getRealitySuspensionResumptionInfo(params: GetRealitySuspensionResumptionInfoRequestV3): Promise<APIResponse<RealitySuspensionResumptionInfoV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetRealitySuspensionResumptionInfoRequestV3 |
Returns
Promise<APIResponse<RealitySuspensionResumptionInfoV3>>
getRealityValuationIndicators()
getRealityValuationIndicators(params: GetRealityValuationIndicatorsRequestV3): Promise<APIResponse<RealityValuationIndicatorsV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetRealityValuationIndicatorsRequestV3 |
Returns
Promise<APIResponse<RealityValuationIndicatorsV3>>
getRepayableCoins()
getRepayableCoins(): Promise<APIResponse<{
maxSelection: string;
repayableCoinList: RepayableCoinV3[];
}>>;Get Repayable Coins
Returns
Promise<APIResponse<{ maxSelection: string; repayableCoinList: RepayableCoinV3[]; }>>
getRiskReserve()
getRiskReserve(params: GetRiskReserveRequestV3): Promise<APIResponse<RiskReserveV3>>;Get Risk Reserve
Parameters
| Parameter | Type |
|---|---|
params | GetRiskReserveRequestV3 |
Returns
Promise<APIResponse<RiskReserveV3>>
getRiskReserveAll()
getRiskReserveAll(params: GetRiskReserveAllRequestV3): Promise<APIResponse<RiskReserveAllV3>>;Get Risk Reserve All — current insurance funds
Parameters
| Parameter | Type |
|---|---|
params | GetRiskReserveAllRequestV3 |
Returns
Promise<APIResponse<RiskReserveAllV3>>
getRiskReserveHour()
getRiskReserveHour(params: GetRiskReserveRequestV3): Promise<APIResponse<RiskReserveHourV3>>;Get Risk Reserve (Hourly)
Parameters
| Parameter | Type |
|---|---|
params | GetRiskReserveRequestV3 |
Returns
Promise<APIResponse<RiskReserveHourV3>>
getRpiOrderBook()
getRpiOrderBook(params: GetRpiOrderBookRequestV3): Promise<APIResponse<RpiOrderBookV3>>;Get RPI OrderBook - Depth with RPI and non-RPI quantities per price level
Parameters
| Parameter | Type |
|---|---|
params | GetRpiOrderBookRequestV3 |
Returns
Promise<APIResponse<RpiOrderBookV3>>
getRpiSymbols()
getRpiSymbols(): Promise<APIResponse<RpiSymbolV3[]>>;Get RPI Symbols - Trading pairs supporting Retail Price Improvement
Returns
Promise<APIResponse<RpiSymbolV3[]>>
getServerTime()
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()
getSharkfinAccount(): Promise<APIResponse<EarnSharkfinAccountV3>>;SharkFin Account. Rate limit: 10/sec/UID.
Returns
Promise<APIResponse<EarnSharkfinAccountV3>>
getSharkfinAssets()
getSharkfinAssets(params: GetSharkfinAssetsRequestV3): Promise<APIResponse<EarnSharkfinAssetsV3>>;SharkFin Assets. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | GetSharkfinAssetsRequestV3 |
Returns
Promise<APIResponse<EarnSharkfinAssetsV3>>
getSharkfinProducts()
getSharkfinProducts(params: GetSharkfinProductsRequestV3): Promise<APIResponse<EarnSharkfinProductsV3>>;Get Sharkfin Products. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | GetSharkfinProductsRequestV3 |
Returns
Promise<APIResponse<EarnSharkfinProductsV3>>
getSharkfinRecords()
getSharkfinRecords(params: GetSharkfinRecordsRequestV3): Promise<APIResponse<EarnSharkfinRecordsV3>>;SharkFin Records. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | GetSharkfinRecordsRequestV3 |
Returns
Promise<APIResponse<EarnSharkfinRecordsV3>>
getSharkfinSubscription()
getSharkfinSubscription(params: GetSharkfinSubscriptionRequestV3): Promise<APIResponse<EarnSharkfinSubscriptionDetailV3>>;SharkFin Subscription Detail. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | GetSharkfinSubscriptionRequestV3 |
Returns
Promise<APIResponse<EarnSharkfinSubscriptionDetailV3>>
getSharkfinSubscriptionResult()
getSharkfinSubscriptionResult(params: GetSharkfinSubscriptionResultRequestV3): Promise<APIResponse<EarnSharkfinSubscriptionResultV3>>;SharkFin Subscription Result. Rate limit: 5/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | GetSharkfinSubscriptionResultRequestV3 |
Returns
Promise<APIResponse<EarnSharkfinSubscriptionResultV3>>
getSmallAssets()
getSmallAssets(params?: GetSmallAssetsRequestV3): Promise<APIResponse<SmallAssetV3[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetSmallAssetsRequestV3 |
Returns
Promise<APIResponse<SmallAssetV3[]>>
getSmallAssetsHistory()
getSmallAssetsHistory(params?: GetSmallAssetsHistoryRequestV3): Promise<APIResponse<{
cursor: string;
list: SmallAssetsHistoryItemV3[];
}>>;Parameters
| Parameter | Type |
|---|---|
params? | GetSmallAssetsHistoryRequestV3 |
Returns
Promise<APIResponse<{ cursor: string; list: SmallAssetsHistoryItemV3[]; }>>
getSplitRecords()
getSplitRecords(params?: GetSplitRecordsRequestV3): Promise<APIResponse<SplitRecordV3[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetSplitRecordsRequestV3 |
Returns
Promise<APIResponse<SplitRecordV3[]>>
getSpotFundFlow()
getSpotFundFlow(params: GetSpotFundFlowRequestV3): Promise<APIResponse<SpotFundFlowV3>>;Get Spot Fund Flow Data
Parameters
| Parameter | Type |
|---|---|
params | GetSpotFundFlowRequestV3 |
Returns
Promise<APIResponse<SpotFundFlowV3>>
getSpotNetFlow()
getSpotNetFlow(params: GetSpotNetFlowRequestV3): Promise<APIResponse<SpotNetFlowV3[]>>;Get Spot 24H Net Capital Inflow Data
Parameters
| Parameter | Type |
|---|---|
params | GetSpotNetFlowRequestV3 |
Returns
Promise<APIResponse<SpotNetFlowV3[]>>
getSpotWhaleFlow()
getSpotWhaleFlow(params: GetSpotWhaleFlowRequestV3): Promise<APIResponse<SpotWhaleFlowV3[]>>;Get Spot Whale Net Flow Data
Parameters
| Parameter | Type |
|---|---|
params | GetSpotWhaleFlowRequestV3 |
Returns
Promise<APIResponse<SpotWhaleFlowV3[]>>
getStockPlusAccount()
getStockPlusAccount(params?: GetStockPlusAccountRequestV3): Promise<APIResponse<StockPlusAccountV3>>;Parameters
| Parameter | Type |
|---|---|
params? | GetStockPlusAccountRequestV3 |
Returns
Promise<APIResponse<StockPlusAccountV3>>
getStockPlusCandlestick()
getStockPlusCandlestick(params: GetStockPlusCandlestickRequestV3): Promise<APIResponse<StockPlusCandlestickV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetStockPlusCandlestickRequestV3 |
Returns
Promise<APIResponse<StockPlusCandlestickV3>>
getStockPlusCashFlow()
getStockPlusCashFlow(params: GetStockPlusCashFlowRequestV3): Promise<APIResponse<StockPlusCashFlowV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetStockPlusCashFlowRequestV3 |
Returns
Promise<APIResponse<StockPlusCashFlowV3>>
getStockPlusDepth()
getStockPlusDepth(params: GetStockPlusDepthRequestV3): Promise<APIResponse<StockPlusDepthV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetStockPlusDepthRequestV3 |
Returns
Promise<APIResponse<StockPlusDepthV3>>
getStockPlusHistoryCandlestick()
getStockPlusHistoryCandlestick(params: GetStockPlusHistoryCandlestickRequestV3): Promise<APIResponse<StockPlusCandlestickV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetStockPlusHistoryCandlestickRequestV3 |
Returns
Promise<APIResponse<StockPlusCandlestickV3>>
getStockPlusHistoryExecutions()
getStockPlusHistoryExecutions(params?: GetStockPlusHistoryExecutionsRequestV3): Promise<APIResponse<StockPlusHistoryExecutionsV3>>;Parameters
| Parameter | Type |
|---|---|
params? | GetStockPlusHistoryExecutionsRequestV3 |
Returns
Promise<APIResponse<StockPlusHistoryExecutionsV3>>
getStockPlusHistoryOrders()
getStockPlusHistoryOrders(params?: GetStockPlusHistoryOrdersRequestV3): Promise<APIResponse<StockPlusHistoryOrdersV3>>;Parameters
| Parameter | Type |
|---|---|
params? | GetStockPlusHistoryOrdersRequestV3 |
Returns
Promise<APIResponse<StockPlusHistoryOrdersV3>>
getStockPlusIntraday()
getStockPlusIntraday(params: GetStockPlusIntradayRequestV3): Promise<APIResponse<StockPlusIntradayV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetStockPlusIntradayRequestV3 |
Returns
Promise<APIResponse<StockPlusIntradayV3>>
getStockPlusMaxPurchase()
getStockPlusMaxPurchase(params: GetStockPlusMaxPurchaseRequestV3): Promise<APIResponse<StockPlusMaxPurchaseV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetStockPlusMaxPurchaseRequestV3 |
Returns
Promise<APIResponse<StockPlusMaxPurchaseV3>>
getStockPlusOptionChainInfo()
getStockPlusOptionChainInfo(params: GetStockPlusOptionChainInfoRequestV3): Promise<APIResponse<StockPlusOptionChainInfoV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetStockPlusOptionChainInfoRequestV3 |
Returns
Promise<APIResponse<StockPlusOptionChainInfoV3>>
getStockPlusOptionExpiryDate()
getStockPlusOptionExpiryDate(params: GetStockPlusOptionExpiryDateRequestV3): Promise<APIResponse<StockPlusOptionExpiryDateV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetStockPlusOptionExpiryDateRequestV3 |
Returns
Promise<APIResponse<StockPlusOptionExpiryDateV3>>
getStockPlusOptionQuote()
getStockPlusOptionQuote(params: GetStockPlusOptionQuoteRequestV3): Promise<APIResponse<StockPlusOptionQuoteV3>>;=====Stock+=====
Parameters
| Parameter | Type |
|---|---|
params | GetStockPlusOptionQuoteRequestV3 |
Returns
Promise<APIResponse<StockPlusOptionQuoteV3>>
getStockPlusOptionVolume()
getStockPlusOptionVolume(params: GetStockPlusOptionVolumeRequestV3): Promise<APIResponse<StockPlusOptionVolumeV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetStockPlusOptionVolumeRequestV3 |
Returns
Promise<APIResponse<StockPlusOptionVolumeV3>>
getStockPlusOrderDetail()
getStockPlusOrderDetail(params: GetStockPlusOrderDetailRequestV3): Promise<APIResponse<StockPlusOrderDetailV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetStockPlusOrderDetailRequestV3 |
Returns
Promise<APIResponse<StockPlusOrderDetailV3>>
getStockPlusQuote()
getStockPlusQuote(params: GetStockPlusQuoteRequestV3): Promise<APIResponse<StockPlusQuoteV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetStockPlusQuoteRequestV3 |
Returns
Promise<APIResponse<StockPlusQuoteV3>>
getStockPlusStaticInfo()
getStockPlusStaticInfo(params: GetStockPlusStaticInfoRequestV3): Promise<APIResponse<StockPlusStaticInfoV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetStockPlusStaticInfoRequestV3 |
Returns
Promise<APIResponse<StockPlusStaticInfoV3>>
getStockPlusStockPosition()
getStockPlusStockPosition(params?: GetStockPlusStockPositionRequestV3): Promise<APIResponse<StockPlusStockPositionV3>>;Parameters
| Parameter | Type |
|---|---|
params? | GetStockPlusStockPositionRequestV3 |
Returns
Promise<APIResponse<StockPlusStockPositionV3>>
getStockPlusTodayExecutions()
getStockPlusTodayExecutions(params?: GetStockPlusTodayExecutionsRequestV3): Promise<APIResponse<StockPlusTodayExecutionsV3>>;Parameters
| Parameter | Type |
|---|---|
params? | GetStockPlusTodayExecutionsRequestV3 |
Returns
Promise<APIResponse<StockPlusTodayExecutionsV3>>
getStockPlusTodayOrders()
getStockPlusTodayOrders(params?: GetStockPlusTodayOrdersRequestV3): Promise<APIResponse<StockPlusOrdersV3>>;Parameters
| Parameter | Type |
|---|---|
params? | GetStockPlusTodayOrdersRequestV3 |
Returns
Promise<APIResponse<StockPlusOrdersV3>>
getStockPlusTradeDetail()
getStockPlusTradeDetail(params: GetStockPlusTradeDetailRequestV3): Promise<APIResponse<StockPlusTradeDetailV3>>;Parameters
| Parameter | Type |
|---|---|
params | GetStockPlusTradeDetailRequestV3 |
Returns
Promise<APIResponse<StockPlusTradeDetailV3>>
getStockPlusTransferRecords()
getStockPlusTransferRecords(params?: GetStockPlusTransferRecordsRequestV3): Promise<APIResponse<StockPlusTransferRecordsV3>>;Parameters
| Parameter | Type |
|---|---|
params? | GetStockPlusTransferRecordsRequestV3 |
Returns
Promise<APIResponse<StockPlusTransferRecordsV3>>
getStpGroups()
getStpGroups(): Promise<APIResponse<StpGroupListV3>>;Get STP Groups MM whitelist only.
Returns
Promise<APIResponse<StpGroupListV3>>
getStrategySubOrders()
getStrategySubOrders(params: GetStrategySubOrdersRequestV3): Promise<APIResponse<{
cursor?: string;
list: StrategySubOrderV3[];
}>>;Parameters
| Parameter | Type |
|---|---|
params | GetStrategySubOrdersRequestV3 |
Returns
Promise<APIResponse<{ cursor?: string; list: StrategySubOrderV3[]; }>>
getSubAccountApiKeys()
getSubAccountApiKeys(params: GetSubAccountApiKeysRequestV3): Promise<APIResponse<{
cursor: string;
hasNext: boolean;
items: SubAccountApiKeyV3[];
}>>;Get Sub-account API Keys
Parameters
| Parameter | Type |
|---|---|
params | GetSubAccountApiKeysRequestV3 |
Returns
Promise<APIResponse<{ cursor: string; hasNext: boolean; items: SubAccountApiKeyV3[]; }>>
getSubaccountEmail()
getSubaccountEmail(params: GetSubaccountEmailRequestV3): Promise<APIResponse<SubaccountEmailV3>>;Get Subaccount Email. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | GetSubaccountEmailRequestV3 |
Returns
Promise<APIResponse<SubaccountEmailV3>>
getSubAccountList()
getSubAccountList(params?: GetSubAccountListRequestV3): Promise<APIResponse<{
cursor: string;
hasNext: boolean;
list: SubAccountV3[];
}>>;Get Sub-account List
Parameters
| Parameter | Type |
|---|---|
params? | GetSubAccountListRequestV3 |
Returns
Promise<APIResponse<{ cursor: string; hasNext: boolean; list: SubAccountV3[]; }>>
getSubAffiliateCommission()
getSubAffiliateCommission(params?: GetSubAffiliateCommissionRequestV3): Promise<APIResponse<SubAffiliateCommissionV3>>;Get Sub Affiliate Commission. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params? | GetSubAffiliateCommissionRequestV3 |
Returns
Promise<APIResponse<SubAffiliateCommissionV3>>
getSubAffiliateInfo()
getSubAffiliateInfo(params?: GetSubAffiliateInfoRequestV3): Promise<APIResponse<SubAffiliateInfoV3>>;Get Sub Affiliate Info. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params? | GetSubAffiliateInfoRequestV3 |
Returns
Promise<APIResponse<SubAffiliateInfoV3>>
getSubDepositAddress()
getSubDepositAddress(params: GetSubDepositAddressRequestV3): Promise<APIResponse<DepositAddressV3>>;Get Sub Deposit Address
Parameters
| Parameter | Type |
|---|---|
params | GetSubDepositAddressRequestV3 |
Returns
Promise<APIResponse<DepositAddressV3>>
getSubDepositRecords()
getSubDepositRecords(params: GetSubDepositRecordsRequestV3): Promise<APIResponse<DepositRecordV3[]>>;Get Sub Deposit Records
Parameters
| Parameter | Type |
|---|---|
params | GetSubDepositRecordsRequestV3 |
Returns
Promise<APIResponse<DepositRecordV3[]>>
getSubTransferRecords()
getSubTransferRecords(params?: GetSubTransferRecordsRequestV3): Promise<APIResponse<{
cursor: string;
items: SubTransferRecordV3[];
}>>;Get Main-Sub Transfer Records
Parameters
| Parameter | Type |
|---|---|
params? | GetSubTransferRecordsRequestV3 |
Returns
Promise<APIResponse<{ cursor: string; items: SubTransferRecordV3[]; }>>
getSubUnifiedAssets()
getSubUnifiedAssets(params?: GetSubUnifiedAssetsRequestV3): Promise<APIResponse<SubUnifiedAssetV3[]>>;Get Sub-account Unified Account Assets
Parameters
| Parameter | Type |
|---|---|
params? | GetSubUnifiedAssetsRequestV3 |
Returns
Promise<APIResponse<SubUnifiedAssetV3[]>>
getTaxRecords()
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
| Parameter | Type |
|---|---|
params | GetTaxRecordsRequestV3 |
Returns
Promise<APIResponse<TaxRecordV3[]>>
getTickers()
getTickers(params: GetTickersRequestV3): Promise<APIResponse<TickerV3[]>>;Get Tickers
Parameters
| Parameter | Type |
|---|---|
params | GetTickersRequestV3 |
Returns
Promise<APIResponse<TickerV3[]>>
See
getTradeFills()
getTradeFills(params?: GetFillsRequestV3): Promise<APIResponse<{
cursor: string;
list: FillV3[];
}>>;Get Fill History
Parameters
| Parameter | Type |
|---|---|
params? | GetFillsRequestV3 |
Returns
Promise<APIResponse<{ cursor: string; list: FillV3[]; }>>
See
getTransferableCoins()
getTransferableCoins(params: GetTransferableCoinsRequestV3): Promise<APIResponse<string[]>>;Get Transferable Coins
Parameters
| Parameter | Type |
|---|---|
params | GetTransferableCoinsRequestV3 |
Returns
Promise<APIResponse<string[]>>
getUnfilledOrders()
getUnfilledOrders(params?: GetUnfilledOrdersRequestV3): Promise<APIResponse<{
cursor: string;
list: UnfilledOrderV3[];
}>>;Get Open Orders
Parameters
| Parameter | Type |
|---|---|
params? | GetUnfilledOrdersRequestV3 |
Returns
Promise<APIResponse<{ cursor: string; list: UnfilledOrderV3[]; }>>
See
getUnfilledStrategyOrders()
getUnfilledStrategyOrders(params: GetUnfilledStrategyOrdersRequestV3): Promise<APIResponse<StrategyOrderV3[]>>;Get Unfilled Strategy Orders
Parameters
| Parameter | Type |
|---|---|
params | GetUnfilledStrategyOrdersRequestV3 |
Returns
Promise<APIResponse<StrategyOrderV3[]>>
getUnifiedAccountSwitchStatus()
getUnifiedAccountSwitchStatus(): Promise<APIResponse<{
status: "processProcessing" | "successSuccess" | "failFailed";
}>>;Get account switching status: process, success or fail.
Returns
Promise<APIResponse<{ status: "processProcessing" | "successSuccess" | "failFailed"; }>>
getWithdrawAddressBook()
getWithdrawAddressBook(params?: GetWithdrawAddressBookRequestV3): Promise<APIResponse<WithdrawAddressBookV3>>;Query the withdrawal address book. Rate limit: 1/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params? | GetWithdrawAddressBookRequestV3 |
Returns
Promise<APIResponse<WithdrawAddressBookV3>>
getWithdrawRecords()
getWithdrawRecords(params: GetWithdrawRecordsRequestV3): Promise<APIResponse<WithdrawRecordV3[]>>;Get Withdraw Records
Parameters
| Parameter | Type |
|---|---|
params | GetWithdrawRecordsRequestV3 |
Returns
Promise<APIResponse<WithdrawRecordV3[]>>
loanBorrow()
loanBorrow(params: LoanBorrowRequestV3): Promise<APIResponse<LoanBorrowResponseV3>>;Borrow - Borrow coins
Parameters
| Parameter | Type |
|---|---|
params | LoanBorrowRequestV3 |
Returns
Promise<APIResponse<LoanBorrowResponseV3>>
loanRepay()
loanRepay(params: LoanRepayRequestV3): Promise<APIResponse<LoanRepayResponseV3>>;Repay - Repay coins
Parameters
| Parameter | Type |
|---|---|
params | LoanRepayRequestV3 |
Returns
Promise<APIResponse<LoanRepayResponseV3>>
loanRevisePledge()
loanRevisePledge(params: LoanRevisePledgeRequestV3): Promise<APIResponse<LoanRevisePledgeResponseV3>>;Revise Pledge - Adjust collateral ratio
Parameters
| Parameter | Type |
|---|---|
params | LoanRevisePledgeRequestV3 |
Returns
Promise<APIResponse<LoanRevisePledgeResponseV3>>
modifyBrokerSubAccount()
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
| Parameter | Type |
|---|---|
params | ModifyBrokerSubAccountRequestV3 |
Returns
Promise<APIResponse<ModifyBrokerSubAccountResponseV3>>
modifyBrokerSubApiKey()
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
| Parameter | Type |
|---|---|
params | ModifyBrokerSubApiKeyRequestV3 |
Returns
Promise<APIResponse<ModifyBrokerSubApiKeyResponseV3>>
modifyCfdOrder()
modifyCfdOrder(params: ModifyCfdOrderRequestV3): Promise<APIResponse<ModifyCfdOrderResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | ModifyCfdOrderRequestV3 |
Returns
Promise<APIResponse<ModifyCfdOrderResponseV3>>
modifyCopyFuturesFollowerSettings()
modifyCopyFuturesFollowerSettings(params: ModifyCopyFuturesFollowerSettingsRequestV3): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | ModifyCopyFuturesFollowerSettingsRequestV3 |
Returns
Promise<APIResponse<string>>
modifyCopyFuturesTpSl()
modifyCopyFuturesTpSl(params: ModifyCopyFuturesTpSlRequestV3): Promise<APIResponse<CopyFuturesTpSlResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | ModifyCopyFuturesTpSlRequestV3 |
Returns
Promise<APIResponse<CopyFuturesTpSlResponseV3>>
modifyGridBot()
modifyGridBot(params: ModifyGridBotRequestV3): Promise<APIResponse<GridBotIdResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | ModifyGridBotRequestV3 |
Returns
Promise<APIResponse<GridBotIdResponseV3>>
modifyGridInterval()
modifyGridInterval(params: ModifyGridIntervalRequestV3): Promise<APIResponse<GridBotIdResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | ModifyGridIntervalRequestV3 |
Returns
Promise<APIResponse<GridBotIdResponseV3>>
modifyNeutralGridBot()
modifyNeutralGridBot(params: ModifyNeutralGridBotRequestV3): Promise<APIResponse<GridBotIdResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | ModifyNeutralGridBotRequestV3 |
Returns
Promise<APIResponse<GridBotIdResponseV3>>
modifyNeutralGridInterval()
modifyNeutralGridInterval(params: ModifyNeutralGridIntervalRequestV3): Promise<APIResponse<GridBotIdResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | ModifyNeutralGridIntervalRequestV3 |
Returns
Promise<APIResponse<GridBotIdResponseV3>>
modifyOrder()
modifyOrder(params: ModifyOrderRequestV3): Promise<APIResponse<ModifyOrderResponseV3>>;Modify Order
Parameters
| Parameter | Type |
|---|---|
params | ModifyOrderRequestV3 |
Returns
Promise<APIResponse<ModifyOrderResponseV3>>
See
modifyStockPlusOrder()
modifyStockPlusOrder(params: ModifyStockPlusOrderRequestV3): Promise<APIResponse<StockPlusPlaceOrderResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | ModifyStockPlusOrderRequestV3 |
Returns
Promise<APIResponse<StockPlusPlaceOrderResponseV3>>
modifyStrategyOrder()
modifyStrategyOrder(params: ModifyStrategyOrderRequestV3): Promise<APIResponse<ModifyStrategyOrderResponseV3>>;Modify Strategy Order
Parameters
| Parameter | Type |
|---|---|
params | ModifyStrategyOrderRequestV3 |
Returns
Promise<APIResponse<ModifyStrategyOrderResponseV3>>
modifySubaccountEmail()
modifySubaccountEmail(params: ModifySubaccountEmailRequestV3): Promise<APIResponse<string>>;Modify Subaccount Email. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | ModifySubaccountEmailRequestV3 |
Returns
Promise<APIResponse<string>>
movePositions()
movePositions(params: MovePositionsRequestV3): Promise<APIResponse<MovePositionsResponseV3>>;Move Positions - Transfer positions between master and sub-accounts
Parameters
| Parameter | Type |
|---|---|
params | MovePositionsRequestV3 |
Returns
Promise<APIResponse<MovePositionsResponseV3>>
operateP2pAd()
operateP2pAd(params: OperateP2pAdRequestV3): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | OperateP2pAdRequestV3 |
Returns
Promise<APIResponse<string>>
placeBatchOrders()
placeBatchOrders(params: PlaceBatchOrdersRequestV3[]): Promise<APIResponse<PlaceBatchOrdersResponseV3[]>>;Batch Order
Parameters
| Parameter | Type |
|---|---|
params | PlaceBatchOrdersRequestV3[] |
Returns
Promise<APIResponse<PlaceBatchOrdersResponseV3[]>>
placeCfdOrder()
placeCfdOrder(params: PlaceCfdOrderRequestV3): Promise<APIResponse<PlaceCfdOrderResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | PlaceCfdOrderRequestV3 |
Returns
Promise<APIResponse<PlaceCfdOrderResponseV3>>
placeCopyFuturesTpSl()
placeCopyFuturesTpSl(params: PlaceCopyFuturesTpSlRequestV3): Promise<APIResponse<CopyFuturesTpSlResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | PlaceCopyFuturesTpSlRequestV3 |
Returns
Promise<APIResponse<CopyFuturesTpSlResponseV3>>
placeRealityOrder()
placeRealityOrder(params: PlaceRealityOrderRequestV3): Promise<APIResponse<PlaceOrderResponseV3>>;Place Reality Order - Limit or market order for Reality stock trading pairs
Parameters
| Parameter | Type |
|---|---|
params | PlaceRealityOrderRequestV3 |
Returns
Promise<APIResponse<PlaceOrderResponseV3>>
placeStockPlusOrder()
placeStockPlusOrder(params: PlaceStockPlusOrderRequestV3): Promise<APIResponse<StockPlusPlaceOrderResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | PlaceStockPlusOrderRequestV3 |
Returns
Promise<APIResponse<StockPlusPlaceOrderResponseV3>>
post()
post(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.post
postPrivate()
postPrivate(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.postPrivate
preSetLeverage()
preSetLeverage(params: PreSetLeverageRequestV3): Promise<APIResponse<PreSetLeverageV3>>;Pre Set Leverage - Preview leverage adjustment impact without applying
Parameters
| Parameter | Type |
|---|---|
params | PreSetLeverageRequestV3 |
Returns
Promise<APIResponse<PreSetLeverageV3>>
redeemEarnCashPlus()
redeemEarnCashPlus(params: EarnCashPlusRedeemRequestV3): Promise<APIResponse<EarnCashPlusRedeemResultV3>>;Redeem Cash+. Rate limit: 1/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | EarnCashPlusRedeemRequestV3 |
Returns
Promise<APIResponse<EarnCashPlusRedeemResultV3>>
redeemEarnElite()
redeemEarnElite(params: RedeemEarnEliteRequestV3): Promise<APIResponse<RedeemEarnEliteResultV3>>;Parameters
| Parameter | Type |
|---|---|
params | RedeemEarnEliteRequestV3 |
Returns
Promise<APIResponse<RedeemEarnEliteResultV3>>
releaseP2pOrderAsset()
releaseP2pOrderAsset(params: P2pOrderActionRequestV3): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | P2pOrderActionRequestV3 |
Returns
Promise<APIResponse<string>>
removeStpGroupMembers()
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
| Parameter | Type |
|---|---|
params | StpGroupMembersRequestV3 |
Returns
Promise<APIResponse<StpGroupMembersResponseV3>>
setCollateralType()
setCollateralType(params: SetCollateralTypeRequestV3): Promise<APIResponse<string>>;Set Collateral Type - Configure unified account collateral type
Parameters
| Parameter | Type |
|---|---|
params | SetCollateralTypeRequestV3 |
Returns
Promise<APIResponse<string>>
setDepositAccount()
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
| Parameter | Type |
|---|---|
params | SetDepositAccountRequestV3 |
Returns
Promise<APIResponse<string>>
setHoldMode()
setHoldMode(params: object): Promise<APIResponse<string>>;Set Holding Mode
Parameters
| Parameter | Type |
|---|---|
params | { holdMode: "one_way_mode" | "hedge_mode"; } |
params.holdMode | "one_way_mode" | "hedge_mode" |
Returns
Promise<APIResponse<string>>
setLeverage()
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
| Parameter | Type |
|---|---|
params | SetLeverageRequestV3 |
Returns
Promise<APIResponse<string>>
setMargin()
setMargin(params: SetMarginRequestV3): Promise<APIResponse<string>>;Set Margin - Adjust isolated margin position margin amount
Parameters
| Parameter | Type |
|---|---|
params | SetMarginRequestV3 |
Returns
Promise<APIResponse<string>>
setRateLimitQuota()
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
| Parameter | Type |
|---|---|
params | SetRateLimitQuotaRequestV3 |
Returns
Promise<APIResponse<Record<string, never>>>
setRepayMode()
setRepayMode(params: SetRepayModeRequestV3): Promise<APIResponse<Record<string, never>>>;Parameters
| Parameter | Type |
|---|---|
params | SetRepayModeRequestV3 |
Returns
Promise<APIResponse<Record<string, never>>>
simulateP2pFee()
simulateP2pFee(params: P2pFeeSimulateRequestV3): Promise<APIResponse<P2pFeeSimulateV3>>;Parameters
| Parameter | Type |
|---|---|
params | P2pFeeSimulateRequestV3 |
Returns
Promise<APIResponse<P2pFeeSimulateV3>>
stockPlusTransfer()
stockPlusTransfer(params: StockPlusTransferRequestV3): Promise<APIResponse<StockPlusTransferResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | StockPlusTransferRequestV3 |
Returns
Promise<APIResponse<StockPlusTransferResponseV3>>
subAccountTransfer()
subAccountTransfer(params: SubAccountTransferRequestV3): Promise<APIResponse<{
clientOid: string;
transferId: string;
}>>;Main-Sub Account Transfer
Parameters
| Parameter | Type |
|---|---|
params | SubAccountTransferRequestV3 |
Returns
Promise<APIResponse<{ clientOid: string; transferId: string; }>>
subMasterTransfer()
subMasterTransfer(params: SubMasterTransferRequestV3): Promise<APIResponse<{
clientOid: string;
transferId: string;
}>>;Sub-Main Account Transfer
Parameters
| Parameter | Type |
|---|---|
params | SubMasterTransferRequestV3 |
Returns
Promise<APIResponse<{ clientOid: string; transferId: string; }>>
submitNewOrder()
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
| Parameter | Type |
|---|---|
params | PlaceOrderRequestV3 |
Returns
Promise<APIResponse<PlaceOrderResponseV3>>
See
submitRepay()
submitRepay(params: RepayRequestV3): Promise<APIResponse<RepayResponseV3>>;Repay
Parameters
| Parameter | Type |
|---|---|
params | RepayRequestV3 |
Returns
Promise<APIResponse<RepayResponseV3>>
submitStrategyOrder()
submitStrategyOrder(params: PlaceStrategyOrderRequestV3): Promise<APIResponse<PlaceStrategyOrderResponseV3>>;Place Strategy Order
Parameters
| Parameter | Type |
|---|---|
params | PlaceStrategyOrderRequestV3 |
Returns
Promise<APIResponse<PlaceStrategyOrderResponseV3>>
submitTransfer()
submitTransfer(params: TransferRequestV3): Promise<APIResponse<TransferResponseV3>>;Transfer
Parameters
| Parameter | Type |
|---|---|
params | TransferRequestV3 |
Returns
Promise<APIResponse<TransferResponseV3>>
submitWithdraw()
submitWithdraw(params: WithdrawRequestV3): Promise<APIResponse<WithdrawResponseV3>>;Request an on-chain withdrawal or an internal transfer.
Parameters
| Parameter | Type |
|---|---|
params | WithdrawRequestV3 |
Returns
Promise<APIResponse<WithdrawResponseV3>>
subscribeEarnCashPlus()
subscribeEarnCashPlus(params: EarnCashPlusSubscribeRequestV3): Promise<APIResponse<EarnCashPlusSubscribeResultV3>>;Subscribe to Cash+. Rate limit: 1/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | EarnCashPlusSubscribeRequestV3 |
Returns
Promise<APIResponse<EarnCashPlusSubscribeResultV3>>
subscribeEarnElite()
subscribeEarnElite(params: EarnEliteSubscribeRequestV3): Promise<APIResponse<EarnEliteSubscribeResultV3>>;Parameters
| Parameter | Type |
|---|---|
params | EarnEliteSubscribeRequestV3 |
Returns
Promise<APIResponse<EarnEliteSubscribeResultV3>>
subscribeSharkfin()
subscribeSharkfin(params: SubscribeSharkfinRequestV3): Promise<APIResponse<SubscribeSharkfinResponseV3>>;Subscribe SharkFin. Rate limit: 10/sec/UID.
Parameters
| Parameter | Type |
|---|---|
params | SubscribeSharkfinRequestV3 |
Returns
Promise<APIResponse<SubscribeSharkfinResponseV3>>
switchDeduct()
switchDeduct(params: SwitchDeductRequestV3): Promise<APIResponse<string>>;Switch Deduct - Set BGB deduction
Parameters
| Parameter | Type |
|---|---|
params | SwitchDeductRequestV3 |
Returns
Promise<APIResponse<string>>
tradeSmallAssets()
tradeSmallAssets(params: TradeSmallAssetsRequestV3): Promise<APIResponse<SmallAssetsTradeResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | TradeSmallAssetsRequestV3 |
Returns
Promise<APIResponse<SmallAssetsTradeResponseV3>>
unfollowCopyFutures()
unfollowCopyFutures(params: UnfollowCopyFuturesRequestV3): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | UnfollowCopyFuturesRequestV3 |
Returns
Promise<APIResponse<string>>
updateP2pAd()
updateP2pAd(params: UpdateP2pAdRequestV3): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | UpdateP2pAdRequestV3 |
Returns
Promise<APIResponse<string>>
updateSubAccountApiKey()
updateSubAccountApiKey(params: UpdateSubAccountApiKeyRequestV3): Promise<APIResponse<UpdateSubAccountApiKeyResponseV3>>;Modify Sub-account API Key
Parameters
| Parameter | Type |
|---|---|
params | UpdateSubAccountApiKeyRequestV3 |
Returns
Promise<APIResponse<UpdateSubAccountApiKeyResponseV3>>
validateGridBot()
validateGridBot(params: CreateGridBotRequestV3): Promise<APIResponse<GridValidateResponseV3>>;=====Grid======= endpoints
Parameters
| Parameter | Type |
|---|---|
params | CreateGridBotRequestV3 |
Returns
Promise<APIResponse<GridValidateResponseV3>>
validateNeutralGridBot()
validateNeutralGridBot(params: CreateNeutralGridBotRequestV3): Promise<APIResponse<GridValidateResponseV3>>;Parameters
| Parameter | Type |
|---|---|
params | CreateNeutralGridBotRequestV3 |
Returns
Promise<APIResponse<GridValidateResponseV3>>