Class: RestClientV2
REST client for Bitget Classic V2 APIs. For Unified Trading Account APIs, use RestClientV3.
Extends
default
Constructors
Constructor
new RestClientV2(restOptions?: RestClientOptions, networkOptions?: AxiosRequestConfig): RestClientV2;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
RestClientV2
Inherited from
BaseRestClient.constructor
Methods
batchCreateVirtualSubaccountAndAPIKey()
batchCreateVirtualSubaccountAndAPIKey(params: CreateVirtualSubRequestV2): Promise<APIResponse<CreateVirtualSubAccountAndApiKeyV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | CreateVirtualSubRequestV2 |
Returns
Promise<APIResponse<CreateVirtualSubAccountAndApiKeyV2[]>>
borrowLoan()
borrowLoan(params: BorrowLoanRequestV2): Promise<APIResponse<{
orderId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | BorrowLoanRequestV2 |
Returns
Promise<APIResponse<{ orderId: string; }>>
cancelSpotFollowerOrder()
cancelSpotFollowerOrder(params: object): Promise<APIResponse<string>>;Copy Trading | Spot copy trading | Follower api
Parameters
| Parameter | Type |
|---|---|
params | { trackingNoList: string[]; } |
params.trackingNoList | string[] |
Returns
Promise<APIResponse<string>>
closeFuturesFollowerPositions()
closeFuturesFollowerPositions(params: CloseFuturesFollowerPositionsRequestV2): Promise<APIResponse<{
orderIdList: string[];
}>>;Parameters
| Parameter | Type |
|---|---|
params | CloseFuturesFollowerPositionsRequestV2 |
Returns
Promise<APIResponse<{ orderIdList: string[]; }>>
closeFuturesTraderOrder()
closeFuturesTraderOrder(params: object): Promise<APIResponse<object[]>>;Parameters
| Parameter | Type |
|---|---|
params | { productType: CopyTradingProductTypeV2; symbol: string; trackingNo: string; } |
params.productType | CopyTradingProductTypeV2 |
params.symbol | string |
params.trackingNo | string |
Returns
Promise<APIResponse<object[]>>
convert()
convert(params: ConvertRequestV2): Promise<APIResponse<ConvertTradeResponseV2>>;Parameters
| Parameter | Type |
|---|---|
params | ConvertRequestV2 |
Returns
Promise<APIResponse<ConvertTradeResponseV2>>
convertBGB()
convertBGB(params: object): Promise<APIResponse<ConvertBGBResponseV2>>;Parameters
| Parameter | Type |
|---|---|
params | { coinList: string; } |
params.coinList | string |
Returns
Promise<APIResponse<ConvertBGBResponseV2>>
createAgentSubaccount()
createAgentSubaccount(params: CreateAgentSubaccountRequestV2): Promise<APIResponse<CreateAgentSubaccountV2>>;Create a dedicated sub-account for an AI Agent instance. Frequency limit: 1/s per UID. Agent sub-accounts cannot be edited after creation.
Parameters
| Parameter | Type |
|---|---|
params | CreateAgentSubaccountRequestV2 |
Returns
Promise<APIResponse<CreateAgentSubaccountV2>>
createSubaccount()
createSubaccount(params: object): Promise<APIResponse<CreateSubaccountResponseV2>>;Parameters
| Parameter | Type |
|---|---|
params | { label: string; subaccountName: string; } |
params.label | string |
params.subaccountName | string |
Returns
Promise<APIResponse<CreateSubaccountResponseV2>>
createSubaccountApiKey()
createSubaccountApiKey(params: CreateSubAccountApiKeyRequestV2): Promise<APIResponse<CreateSubaccountApiKeyResponseV2>>;Broker | Api Key
Parameters
| Parameter | Type |
|---|---|
params | CreateSubAccountApiKeyRequestV2 |
Returns
Promise<APIResponse<CreateSubaccountApiKeyResponseV2>>
createSubaccountDepositAddress()
createSubaccountDepositAddress(params: object): Promise<APIResponse<CreateSubaccountDepositAddressV2>>;Parameters
| Parameter | Type |
|---|---|
params | { chain?: string; coin: string; subUid: string; } |
params.chain? | string |
params.coin | string |
params.subUid | string |
Returns
Promise<APIResponse<CreateSubaccountDepositAddressV2>>
createVirtualSubaccount()
createVirtualSubaccount(params: object): Promise<APIResponse<CreateVirtualSubAccountV2>>;- Common | Virtual Subaccount
Parameters
| Parameter | Type |
|---|---|
params | { subAccountList: string[]; } |
params.subAccountList | string[] |
Returns
Promise<APIResponse<CreateVirtualSubAccountV2>>
createVirtualSubaccountAPIKey()
createVirtualSubaccountAPIKey(params: CreateVirtualSubApiKeyRequestV2): Promise<APIResponse<CreateVirtualSubAccountApiKeyV2>>;Parameters
| Parameter | Type |
|---|---|
params | CreateVirtualSubApiKeyRequestV2 |
Returns
Promise<APIResponse<CreateVirtualSubAccountApiKeyV2>>
deletePrivate()
deletePrivate(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.deletePrivate
deleteSubaccountApiKey()
deleteSubaccountApiKey(params: DeleteSubAccountApiKeyRequestV2): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | DeleteSubAccountApiKeyRequestV2 |
Returns
Promise<APIResponse<string>>
earnRedeemSavings()
earnRedeemSavings(params: RedeemSavingsRequestV2): Promise<APIResponse<{
orderId: string;
status: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | RedeemSavingsRequestV2 |
Returns
Promise<APIResponse<{ orderId: string; status: string; }>>
earnSubscribeSavings()
earnSubscribeSavings(params: object): Promise<APIResponse<{
orderId: string;
status: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | { amount: string; periodType: string; productId: string; } |
params.amount | string |
params.periodType | string |
params.productId | string |
Returns
Promise<APIResponse<{ orderId: string; status: string; }>>
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>
futuresBatchCancelOrders()
futuresBatchCancelOrders(params: FuturesBatchCancelOrderRequestV2): Promise<APIResponse<FuturesBatchOrderResponseV2>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesBatchCancelOrderRequestV2 |
Returns
Promise<APIResponse<FuturesBatchOrderResponseV2>>
futuresBatchSubmitOrders()
futuresBatchSubmitOrders(params: FuturesBatchOrderRequestV2): Promise<APIResponse<FuturesBatchOrderResponseV2>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesBatchOrderRequestV2 |
Returns
Promise<APIResponse<FuturesBatchOrderResponseV2>>
futuresCancelAllOrders()
futuresCancelAllOrders(params: FuturesCancelAllOrdersRequestV2): Promise<APIResponse<FuturesCancelAllOrdersV2>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesCancelAllOrdersRequestV2 |
Returns
Promise<APIResponse<FuturesCancelAllOrdersV2>>
futuresCancelOrder()
futuresCancelOrder(params: FuturesCancelOrderRequestV2): Promise<APIResponse<{
clientOid: string;
orderId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesCancelOrderRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; orderId: string; }>>
futuresCancelPlanOrder()
futuresCancelPlanOrder(params: FuturesCancelPlanOrderRequestV2): Promise<APIResponse<FuturesCancelPlanOrderV2>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesCancelPlanOrderRequestV2 |
Returns
Promise<APIResponse<FuturesCancelPlanOrderV2>>
futuresFlashClosePositions()
futuresFlashClosePositions(params: FuturesFlashClosePositionsRequestV2): Promise<APIResponse<FuturesClosePositionResponseV2>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesFlashClosePositionsRequestV2 |
Returns
Promise<APIResponse<FuturesClosePositionResponseV2>>
futuresModifyOrder()
futuresModifyOrder(params: FuturesModifyOrderRequestV2): Promise<APIResponse<{
clientOid: string;
orderId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesModifyOrderRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; orderId: string; }>>
futuresModifyPlanOrder()
futuresModifyPlanOrder(params: FuturesModifyPlanOrderRequestV2): Promise<APIResponse<{
clientOid: string;
orderId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesModifyPlanOrderRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; orderId: string; }>>
futuresModifyTPSLPOrder()
futuresModifyTPSLPOrder(params: FuturesModifyTPSLOrderRequestV2): Promise<APIResponse<{
clientOid: string;
orderId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesModifyTPSLOrderRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; orderId: string; }>>
futuresSubmitOrder()
futuresSubmitOrder(params: FuturesPlaceOrderRequestV2): Promise<APIResponse<{
clientOid: string;
orderId: string;
}>>;- Futures | Trade
Parameters
| Parameter | Type |
|---|---|
params | FuturesPlaceOrderRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; orderId: string; }>>
futuresSubmitPlanOrder()
futuresSubmitPlanOrder(params: FuturesPlanOrderRequestV2): Promise<APIResponse<{
clientOid: string;
orderId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesPlanOrderRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; orderId: string; }>>
futuresSubmitPositionTPSL()
futuresSubmitPositionTPSL(params: FuturesPositionTPSLOrderRequestV2): Promise<APIResponse<object[]>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesPositionTPSLOrderRequestV2 |
Returns
Promise<APIResponse<object[]>>
futuresSubmitReversal()
futuresSubmitReversal(params: FuturesReversalOrderRequestV2): Promise<APIResponse<{
clientOid: string;
orderId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesReversalOrderRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; orderId: string; }>>
futuresSubmitTPSLOrder()
futuresSubmitTPSLOrder(params: FuturesTPSLOrderRequestV2): Promise<APIResponse<{
clientOid: string;
orderId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesTPSLOrderRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; orderId: string; }>>
get()
get(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.get
getAgentCommissionDetail()
getAgentCommissionDetail(params?: GetAgentCommissionDetailRequestV2): Promise<APIResponse<AgentCommissionDetailV2>>;Parameters
| Parameter | Type |
|---|---|
params? | GetAgentCommissionDetailRequestV2 |
Returns
Promise<APIResponse<AgentCommissionDetailV2>>
getAgentCustomerAssets()
getAgentCustomerAssets(params?: AgentCustomerAssetRequestV2): Promise<APIResponse<AgentCustomerAssetItemV2[]>>;Parameters
| Parameter | Type |
|---|---|
params? | AgentCustomerAssetRequestV2 |
Returns
Promise<APIResponse<AgentCustomerAssetItemV2[]>>
getAgentCustomerCommissions()
getAgentCustomerCommissions(params?: GetAgentCustomerCommissionsRequestV2): Promise<APIResponse<AgentCustomerCommissionsV2>>;- Broker | Agent (affiliate) customer APIs
Parameters
| Parameter | Type |
|---|---|
params? | GetAgentCustomerCommissionsRequestV2 |
Returns
Promise<APIResponse<AgentCustomerCommissionsV2>>
getAgentCustomerDeposits()
getAgentCustomerDeposits(params?: AgentCustomerDepositRequestV2): Promise<APIResponse<AgentCustomerDepositItemV2[]>>;Parameters
| Parameter | Type |
|---|---|
params? | AgentCustomerDepositRequestV2 |
Returns
Promise<APIResponse<AgentCustomerDepositItemV2[]>>
getAgentCustomerKycResult()
getAgentCustomerKycResult(params?: GetAgentCustomerKycResultRequestV2): Promise<APIResponse<AgentCustomerKycResultV2>>;Parameters
| Parameter | Type |
|---|---|
params? | GetAgentCustomerKycResultRequestV2 |
Returns
Promise<APIResponse<AgentCustomerKycResultV2>>
getAgentCustomerList()
getAgentCustomerList(params?: AgentCustomerListRequestV2): Promise<APIResponse<AgentCustomerListItemV2[]>>;Without startTime/endTime, returns all registered customers (no time restriction).
Parameters
| Parameter | Type |
|---|---|
params? | AgentCustomerListRequestV2 |
Returns
Promise<APIResponse<AgentCustomerListItemV2[]>>
getAgentCustomerTradeVolume()
getAgentCustomerTradeVolume(params?: AgentCustomerTradeVolumeRequestV2): Promise<APIResponse<AgentCustomerTradeVolumeItemV2[]>>;Parameters
| Parameter | Type |
|---|---|
params? | AgentCustomerTradeVolumeRequestV2 |
Returns
Promise<APIResponse<AgentCustomerTradeVolumeItemV2[]>>
getAgentSubCustomerList()
getAgentSubCustomerList(params?: GetAgentSubCustomerListRequestV2): Promise<APIResponse<AgentSubCustomerListV2>>;Without startTime/endTime, returns all registered sub-customers (no time restriction).
Parameters
| Parameter | Type |
|---|---|
params? | GetAgentSubCustomerListRequestV2 |
Returns
Promise<APIResponse<AgentSubCustomerListV2>>
getAllSubDepositWithdrawalRecords()
getAllSubDepositWithdrawalRecords(params?: GetAllSubDepositWithdrawalRequestV2): Promise<APIResponse<{
endId: string;
list: AllSubDepositWithdrawalRecordV2[];
}>>;Get All Sub-accounts Deposit and Withdrawal Records
- Only applicable for ND broker main-account
- Rate limit: 5 req/sec/UID
- Able to get ND sub-accounts deposit and withdrawal records within 90 days
Parameters
| Parameter | Type |
|---|---|
params? | GetAllSubDepositWithdrawalRequestV2 |
Returns
Promise<APIResponse<{ endId: string; list: AllSubDepositWithdrawalRecordV2[]; }>>
getAllTradeRates()
getAllTradeRates(params: GetAllTradeRatesRequestV2): Promise<APIResponse<object[]>>;Parameters
| Parameter | Type |
|---|---|
params | GetAllTradeRatesRequestV2 |
Returns
Promise<APIResponse<object[]>>
getAnnouncements()
getAnnouncements(params?: GetAnnouncementsRequestV2): Promise<APIResponse<AnnouncementV2[]>>;- Common | Notice
Parameters
| Parameter | Type |
|---|---|
params? | GetAnnouncementsRequestV2 |
Returns
Promise<APIResponse<AnnouncementV2[]>>
getBalances()
getBalances(): Promise<APIResponse<object[]>>;Get assets overview
Returns
Promise<APIResponse<object[]>>
getBotAccount()
getBotAccount(params?: object): Promise<APIResponse<BotAssetV2[]>>;Parameters
| Parameter | Type |
|---|---|
params? | { accountType?: string; } |
params.accountType? | string |
Returns
Promise<APIResponse<BotAssetV2[]>>
getBrokerCommissions()
getBrokerCommissions(params?: GetBrokerCommissionsRequestV2): Promise<APIResponse<BrokerCommissionV2[]>>;Get Broker Subaccounts Commissions
- Rate limit: 5 req/sec/UID
- Please contact your BD or RM to apply for access permissions
Parameters
| Parameter | Type |
|---|---|
params? | GetBrokerCommissionsRequestV2 |
Returns
Promise<APIResponse<BrokerCommissionV2[]>>
getBrokerInfo()
getBrokerInfo(): Promise<APIResponse<{
maxSubAccountSize: string;
subAccountSize: string;
uTime: string;
}>>;Returns
Promise<APIResponse<{ maxSubAccountSize: string; subAccountSize: string; uTime: string; }>>
getBrokerOrderCommission()
getBrokerOrderCommission(params?: GetBrokerOrderCommissionRequestV2): Promise<APIResponse<BrokerOrderCommissionV2>>;Get broker-tagged order commissions. Bitget documents 30 days of retained history and a maximum 30-day query span, updated daily for the preceding day in UTC+8. Set both startTime and endTime, or omit both to query yesterday. Rate limit: 20 requests per second per UID.
Parameters
| Parameter | Type |
|---|---|
params? | GetBrokerOrderCommissionRequestV2 |
Returns
Promise<APIResponse<BrokerOrderCommissionV2>>
getBrokerRebateInfo()
getBrokerRebateInfo(params: GetBrokerRebateInfoRequestV2): Promise<APIResponse<BrokerRebateInfoV2>>;Get Rebate Info
- Rate limit: 20 req/sec/UID
- Data retention: 30 days
- Real-time data
Parameters
| Parameter | Type |
|---|---|
params | GetBrokerRebateInfoRequestV2 |
Returns
Promise<APIResponse<BrokerRebateInfoV2>>
getBrokerSubaccounts()
getBrokerSubaccounts(params?: GetBrokerSubaccountsRequestV2): Promise<APIResponse<BrokerSubaccountInfoV2[]>>;Get Broker Subaccounts
- Rate limit: 5 req/sec/UID
- Please contact your BD or RM to apply for access permissions
Parameters
| Parameter | Type |
|---|---|
params? | GetBrokerSubaccountsRequestV2 |
Returns
Promise<APIResponse<BrokerSubaccountInfoV2[]>>
getBrokerTotalCommission()
getBrokerTotalCommission(params?: GetBrokerTotalCommissionRequestV2): Promise<APIResponse<BrokerTotalCommissionV2[]>>;Get Total Commission
- Rate limit: 20 req/sec/UID
- Data retention: 365 days
- Historical data available from: 2025/6/1
- Data granularity: daily
- Data update granularity: daily, previous day's data is updated on the current day
- Time zone: UTC+8
- startTime and endTime should either both be set or both left unset
- This API supports retrieving data within the past 365 days (data is available starting from 2025/6/1 at the earliest)
- If startTime and endTime are not set in the request, the default returned information will be for yesterday (00:00-23:59 UTC+8)
- Data update frequency: T+1 (UTC+8)
Parameters
| Parameter | Type |
|---|---|
params? | GetBrokerTotalCommissionRequestV2 |
Returns
Promise<APIResponse<BrokerTotalCommissionV2[]>>
getBrokerTraders()
getBrokerTraders(params: object): Promise<APIResponse<any>>;Copy Trading | Future copy trading | Broker api
Parameters
| Parameter | Type |
|---|---|
params | object |
Returns
Promise<APIResponse<any>>
getBrokerTradersHistoricalOrders()
getBrokerTradersHistoricalOrders(params: object): Promise<APIResponse<any>>;Parameters
| Parameter | Type |
|---|---|
params | object |
Returns
Promise<APIResponse<any>>
getBrokerTradersPendingOrders()
getBrokerTradersPendingOrders(params: object): Promise<APIResponse<any>>;Parameters
| Parameter | Type |
|---|---|
params | object |
Returns
Promise<APIResponse<any>>
getBrokerTradeVolume()
getBrokerTradeVolume(params?: GetBrokerTradeVolumeRequestV2): Promise<APIResponse<BrokerTradeVolumeV2[]>>;Get Broker Trade Volume
- Rate limit: 5 req/sec/UID
- Please contact your BD or RM to apply for access permissions
Parameters
| Parameter | Type |
|---|---|
params? | GetBrokerTradeVolumeRequestV2 |
Returns
Promise<APIResponse<BrokerTradeVolumeV2[]>>
getClientType()
getClientType(): "v2";Defines the client type (affecting how requests & signatures behave)
Returns
"v2"
Overrides
BaseRestClient.getClientType
getConvertBGBCoins()
getConvertBGBCoins(): Promise<APIResponse<{
coinList: BGBConvertCoinV2[];
}>>;- Common | BGB Convert
Returns
Promise<APIResponse<{ coinList: BGBConvertCoinV2[]; }>>
getConvertBGBHistory()
getConvertBGBHistory(params: GetConvertBGBHistoryRequestV2): Promise<APIResponse<BGBConvertHistoryV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | GetConvertBGBHistoryRequestV2 |
Returns
Promise<APIResponse<BGBConvertHistoryV2[]>>
getConvertCoins()
getConvertCoins(): Promise<APIResponse<ConvertCurrencyV2[]>>;- Common | Convert
Returns
Promise<APIResponse<ConvertCurrencyV2[]>>
getConvertHistory()
getConvertHistory(params: GetConvertHistoryRequestV2): Promise<APIResponse<{
dataList: ConvertRecordV2[];
endId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | GetConvertHistoryRequestV2 |
Returns
Promise<APIResponse<{ dataList: ConvertRecordV2[]; endId: string; }>>
getConvertQuotedPrice()
getConvertQuotedPrice(params: ConvertQuoteRequestV2): Promise<APIResponse<ConvertQuotedPriceV2>>;Parameters
| Parameter | Type |
|---|---|
params | ConvertQuoteRequestV2 |
Returns
Promise<APIResponse<ConvertQuotedPriceV2>>
getEarnAccount()
getEarnAccount(params?: object): Promise<APIResponse<object[]>>;Earn | Earn Account
Parameters
| Parameter | Type |
|---|---|
params? | { coin?: string; } |
params.coin? | string |
Returns
Promise<APIResponse<object[]>>
getEarnEliteAssets()
getEarnEliteAssets(): Promise<APIResponse<EarnEliteAssetsV2>>;Returns
Promise<APIResponse<EarnEliteAssetsV2>>
getEarnEliteProducts()
getEarnEliteProducts(): Promise<APIResponse<EarnEliteProductV2[]>>;Earn | On-Chain Elite
Returns
Promise<APIResponse<EarnEliteProductV2[]>>
getEarnEliteRecords()
getEarnEliteRecords(params: GetEarnEliteRecordsRequestV2): Promise<APIResponse<EarnEliteRecordsV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetEarnEliteRecordsRequestV2 |
Returns
Promise<APIResponse<EarnEliteRecordsV2>>
getEarnEliteRedeemInfo()
getEarnEliteRedeemInfo(params: GetEarnEliteRedeemInfoRequestV2): Promise<APIResponse<EarnEliteRedeemInfoV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetEarnEliteRedeemInfoRequestV2 |
Returns
Promise<APIResponse<EarnEliteRedeemInfoV2>>
getEarnEliteSubscribeInfo()
getEarnEliteSubscribeInfo(params: GetEarnEliteSubscribeInfoRequestV2): Promise<APIResponse<EarnEliteSubscribeInfoV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetEarnEliteSubscribeInfoRequestV2 |
Returns
Promise<APIResponse<EarnEliteSubscribeInfoV2>>
getEarnEliteSubscribeResult()
getEarnEliteSubscribeResult(params: GetEarnEliteSubscribeResultRequestV2): Promise<APIResponse<EarnEliteSubscribeStatusV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetEarnEliteSubscribeResultRequestV2 |
Returns
Promise<APIResponse<EarnEliteSubscribeStatusV2>>
getEarnSavingsAccount()
getEarnSavingsAccount(): Promise<APIResponse<EarnSavingsAccountV2>>;Returns
Promise<APIResponse<EarnSavingsAccountV2>>
getEarnSavingsAssets()
getEarnSavingsAssets(params: GetEarnSavingsAssetsRequestV2): Promise<APIResponse<EarnSavingsAssetsV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetEarnSavingsAssetsRequestV2 |
Returns
Promise<APIResponse<EarnSavingsAssetsV2>>
getEarnSavingsProducts()
getEarnSavingsProducts(params?: object): Promise<APIResponse<EarnSavingsProductsV2[]>>;Earn | Savings
Parameters
| Parameter | Type |
|---|---|
params? | { coin?: string; filter?: string; } |
params.coin? | string |
params.filter? | string |
Returns
Promise<APIResponse<EarnSavingsProductsV2[]>>
getEarnSavingsRecords()
getEarnSavingsRecords(params: GetEarnSavingsRecordsRequestV2): Promise<APIResponse<EarnSavingsRecordsV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetEarnSavingsRecordsRequestV2 |
Returns
Promise<APIResponse<EarnSavingsRecordsV2>>
getEarnSavingsRedemptionResult()
getEarnSavingsRedemptionResult(params: object): Promise<APIResponse<{
msg: string;
result: "success" | "fail";
}>>;Parameters
| Parameter | Type |
|---|---|
params | { orderId: string; periodType: string; } |
params.orderId | string |
params.periodType | string |
Returns
Promise<APIResponse<{ msg: string; result: "success" | "fail"; }>>
getEarnSavingsSubscription()
getEarnSavingsSubscription(params: object): Promise<APIResponse<EarnSavingsSubscriptionDetailV2>>;Parameters
| Parameter | Type |
|---|---|
params | { periodType: string; productId: string; } |
params.periodType | string |
params.productId | string |
Returns
Promise<APIResponse<EarnSavingsSubscriptionDetailV2>>
getEarnSavingsSubscriptionResult()
getEarnSavingsSubscriptionResult(params: object): Promise<APIResponse<{
msg: string;
result: "success" | "fail";
}>>;Parameters
| Parameter | Type |
|---|---|
params | { periodType: string; productId: string; } |
params.periodType | string |
params.productId | string |
Returns
Promise<APIResponse<{ msg: string; result: "success" | "fail"; }>>
getFundingAssets()
getFundingAssets(params?: object): Promise<APIResponse<FundingAssetV2[]>>;- Common | Assets
Parameters
| Parameter | Type |
|---|---|
params? | { coin?: string; } |
params.coin? | string |
Returns
Promise<APIResponse<FundingAssetV2[]>>
getFuturesAccountAsset()
getFuturesAccountAsset(params: FuturesSingleAccountRequestV2): Promise<APIResponse<FuturesAccountV2>>;- Futures | Account
Parameters
| Parameter | Type |
|---|---|
params | FuturesSingleAccountRequestV2 |
Returns
Promise<APIResponse<FuturesAccountV2>>
getFuturesAccountAssets()
getFuturesAccountAssets(params: object): Promise<APIResponse<FuturesAccountsV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { productType: FuturesProductTypeV2; } |
params.productType | FuturesProductTypeV2 |
Returns
Promise<APIResponse<FuturesAccountsV2[]>>
getFuturesAccountBills()
getFuturesAccountBills(params: FuturesAccountBillRequestV2): Promise<APIResponse<{
bills: FuturesAccountBillV2[];
endId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesAccountBillRequestV2 |
Returns
Promise<APIResponse<{ bills: FuturesAccountBillV2[]; endId: string; }>>
getFuturesActiveBuySellVolumeData()
getFuturesActiveBuySellVolumeData(params: object): Promise<APIResponse<FuturesLongShortRatioV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { period?: string; symbol: string; } |
params.period? | string |
params.symbol | string |
Returns
Promise<APIResponse<FuturesLongShortRatioV2[]>>
getFuturesActiveLongShortAccountData()
getFuturesActiveLongShortAccountData(params: object): Promise<APIResponse<FuturesActiveLongShortAccountV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { period?: string; symbol: string; } |
params.period? | string |
params.symbol | string |
Returns
Promise<APIResponse<FuturesActiveLongShortAccountV2[]>>
getFuturesActiveLongShortPositionData()
getFuturesActiveLongShortPositionData(params: object): Promise<APIResponse<FuturesActiveLongShortPositionV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { period?: string; symbol: string; } |
params.period? | string |
params.symbol | string |
Returns
Promise<APIResponse<FuturesActiveLongShortPositionV2[]>>
getFuturesActiveTakerBuySellVolumeData()
getFuturesActiveTakerBuySellVolumeData(params: object): Promise<APIResponse<FuturesActiveBuySellVolumeV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { period?: string; symbol: string; } |
params.period? | string |
params.symbol | string |
Returns
Promise<APIResponse<FuturesActiveBuySellVolumeV2[]>>
getFuturesAllTickers()
getFuturesAllTickers(params: object): Promise<APIResponse<FuturesTickerV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { productType: FuturesProductTypeV2; } |
params.productType | FuturesProductTypeV2 |
Returns
Promise<APIResponse<FuturesTickerV2[]>>
getFuturesCandles()
getFuturesCandles(params: FuturesCandlesRequestV2): Promise<APIResponse<FuturesCandlestickV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesCandlesRequestV2 |
Returns
Promise<APIResponse<FuturesCandlestickV2[]>>
getFuturesContractConfig()
getFuturesContractConfig(params: object): Promise<APIResponse<FuturesContractConfigV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { productType: FuturesProductTypeV2; symbol?: string; } |
params.productType | FuturesProductTypeV2 |
params.symbol? | string |
Returns
Promise<APIResponse<FuturesContractConfigV2[]>>
getFuturesCurrentFundingRate()
getFuturesCurrentFundingRate(params: object): Promise<APIResponse<object[]>>;Parameters
| Parameter | Type |
|---|---|
params | { productType: FuturesProductTypeV2; symbol?: string; } |
params.productType | FuturesProductTypeV2 |
params.symbol? | string |
Returns
Promise<APIResponse<object[]>>
getFuturesDiscountRate()
getFuturesDiscountRate(): Promise<APIResponse<FuturesDiscountRatesV2[]>>;Returns
Promise<APIResponse<FuturesDiscountRatesV2[]>>
getFuturesFills()
getFuturesFills(params: FuturesGetOrderFillsRequestV2): Promise<APIResponse<{
endId: string;
fillList: FuturesOrderFillV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesGetOrderFillsRequestV2 |
Returns
Promise<APIResponse<{ endId: string; fillList: FuturesOrderFillV2[]; }>>
getFuturesFollowerCurrentOrders()
getFuturesFollowerCurrentOrders(params: GetFollowerFuturesCurrentTrackingOrdersRequestV2): Promise<APIResponse<CTFuturesFollowerCurrentOrdersV2[]>>;Copy Trading | Future copy trading | Follower Api
Parameters
| Parameter | Type |
|---|---|
params | GetFollowerFuturesCurrentTrackingOrdersRequestV2 |
Returns
Promise<APIResponse<CTFuturesFollowerCurrentOrdersV2[]>>
getFuturesFollowerFollowLimit()
getFuturesFollowerFollowLimit(params: object): Promise<APIResponse<object[]>>;Parameters
| Parameter | Type |
|---|---|
params | { productType: CopyTradingProductTypeV2; symbol: string; } |
params.productType | CopyTradingProductTypeV2 |
params.symbol | string |
Returns
Promise<APIResponse<object[]>>
getFuturesFollowerHistoryOrders()
getFuturesFollowerHistoryOrders(params: GetFollowerFuturesHistoryTrackingOrdersRequestV2): Promise<APIResponse<CTFuturesFollowerHistoryOrdersV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetFollowerFuturesHistoryTrackingOrdersRequestV2 |
Returns
Promise<APIResponse<CTFuturesFollowerHistoryOrdersV2>>
getFuturesFollowerSettings()
getFuturesFollowerSettings(params: object): Promise<APIResponse<CTFuturesFollowerSettingsV2>>;Parameters
| Parameter | Type |
|---|---|
params | { traderId: string; } |
params.traderId | string |
Returns
Promise<APIResponse<CTFuturesFollowerSettingsV2>>
getFuturesFollowerTraders()
getFuturesFollowerTraders(params: GetFuturesFollowerTradersRequestV2): Promise<APIResponse<CTFuturesFollowerMyTradersV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | GetFuturesFollowerTradersRequestV2 |
Returns
Promise<APIResponse<CTFuturesFollowerMyTradersV2[]>>
getFuturesHistoricCandles()
getFuturesHistoricCandles(params: FuturesCandlesRequestV2): Promise<APIResponse<FuturesCandlestickV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesCandlesRequestV2 |
Returns
Promise<APIResponse<FuturesCandlestickV2[]>>
getFuturesHistoricFundingRates()
getFuturesHistoricFundingRates(params: object): Promise<APIResponse<FuturesHistoricalFundingRateV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { pageNo?: string; pageSize?: string; productType: FuturesProductTypeV2; symbol: string; } |
params.pageNo? | string |
params.pageSize? | string |
params.productType | FuturesProductTypeV2 |
params.symbol | string |
Returns
Promise<APIResponse<FuturesHistoricalFundingRateV2[]>>
getFuturesHistoricIndexPriceCandles()
getFuturesHistoricIndexPriceCandles(params: FuturesCandlesRequestV2): Promise<APIResponse<FuturesCandlestickV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesCandlesRequestV2 |
Returns
Promise<APIResponse<FuturesCandlestickV2[]>>
getFuturesHistoricMarkPriceCandles()
getFuturesHistoricMarkPriceCandles(params: FuturesCandlesRequestV2): Promise<APIResponse<FuturesCandlestickV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesCandlesRequestV2 |
Returns
Promise<APIResponse<FuturesCandlestickV2[]>>
getFuturesHistoricOrderFills()
getFuturesHistoricOrderFills(params: FuturesGetHistoricalFillsRequestV2): Promise<APIResponse<{
endId: string;
fillList: FuturesOrderFillV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesGetHistoricalFillsRequestV2 |
Returns
Promise<APIResponse<{ endId: string; fillList: FuturesOrderFillV2[]; }>>
getFuturesHistoricOrders()
getFuturesHistoricOrders(params: FuturesGetHistoryOrdersRequestV2): Promise<APIResponse<{
endId: string;
entrustedList: FuturesHistoryOrderV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesGetHistoryOrdersRequestV2 |
Returns
Promise<APIResponse<{ endId: string; entrustedList: FuturesHistoryOrderV2[]; }>>
getFuturesHistoricPlanOrders()
getFuturesHistoricPlanOrders(params: FuturesGetHistoryPlanOrdersRequestV2): Promise<APIResponse<{
endId: string;
entrustedList: FuturesHistoryPlanOrderV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesGetHistoryPlanOrdersRequestV2 |
Returns
Promise<APIResponse<{ endId: string; entrustedList: FuturesHistoryPlanOrderV2[]; }>>
getFuturesHistoricPositions()
getFuturesHistoricPositions(params?: FuturesHistoricalPositionsRequestV2): Promise<APIResponse<{
endId: string;
list: FuturesHistoryPositionV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
params? | FuturesHistoricalPositionsRequestV2 |
Returns
Promise<APIResponse<{ endId: string; list: FuturesHistoryPositionV2[]; }>>
getFuturesHistoricTrades()
getFuturesHistoricTrades(params: FuturesHistoricTradesRequestV2): Promise<APIResponse<FuturesFillV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesHistoricTradesRequestV2 |
Returns
Promise<APIResponse<FuturesFillV2[]>>
getFuturesInterestExchangeRate()
getFuturesInterestExchangeRate(): Promise<APIResponse<object[]>>;Returns
Promise<APIResponse<object[]>>
getFuturesInterestHistory()
getFuturesInterestHistory(params: FuturesInterestHistoryRequestV2): Promise<APIResponse<FuturesInterestHistoryV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesInterestHistoryRequestV2 |
Returns
Promise<APIResponse<FuturesInterestHistoryV2[]>>
getFuturesInterestRateHistory()
getFuturesInterestRateHistory(params: object): Promise<APIResponse<{
coin: string;
historyInterestRateList: FuturesHistoryInterestRateV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
params | { coin: string; } |
params.coin | string |
Returns
Promise<APIResponse<{ coin: string; historyInterestRateList: FuturesHistoryInterestRateV2[]; }>>
getFuturesIsolatedSymbols()
getFuturesIsolatedSymbols(params: FuturesIsolatedSymbolsRequestV2): Promise<APIResponse<FuturesIsolatedSymbolV2[]>>;Get Isolated Symbols
- Rate limits: 10 time/1s (uid)
- Retrieve trading pairs with isolated margin mode under the account.
Parameters
| Parameter | Type |
|---|---|
params | FuturesIsolatedSymbolsRequestV2 |
Returns
Promise<APIResponse<FuturesIsolatedSymbolV2[]>>
getFuturesLiquidationPrice()
getFuturesLiquidationPrice(params: FuturesLiquidationPriceRequestV2): Promise<APIResponse<FuturesLiquidationPriceV2>>;Get Liquidation Price
- Rate limit: 20 req/sec/UID
- Get Liquidation Price
Parameters
| Parameter | Type |
|---|---|
params | FuturesLiquidationPriceRequestV2 |
Returns
Promise<APIResponse<FuturesLiquidationPriceV2>>
getFuturesLongShortRatio()
getFuturesLongShortRatio(params: object): Promise<APIResponse<LeveragedLongShortRatioV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { coin?: string; period?: string; symbol: string; } |
params.coin? | string |
params.period? | string |
params.symbol | string |
Returns
Promise<APIResponse<LeveragedLongShortRatioV2[]>>
getFuturesMaxOpenableQuantity()
getFuturesMaxOpenableQuantity(params: FuturesMaxOpenRequestV2): Promise<APIResponse<FuturesMaxOpenV2>>;Get Max Openable Quantity
- Rate limit: 20 req/sec/UID
- Get Max Openable Quantity
Parameters
| Parameter | Type |
|---|---|
params | FuturesMaxOpenRequestV2 |
Returns
Promise<APIResponse<FuturesMaxOpenV2>>
getFuturesMergeDepth()
getFuturesMergeDepth(params: FuturesMergeDepthRequestV2): Promise<APIResponse<FuturesMergeDepthV2>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesMergeDepthRequestV2 |
Returns
Promise<APIResponse<FuturesMergeDepthV2>>
getFuturesNextFundingTime()
getFuturesNextFundingTime(params: object): Promise<APIResponse<FuturesFundingTimeV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { productType: FuturesProductTypeV2; symbol: string; } |
params.productType | FuturesProductTypeV2 |
params.symbol | string |
Returns
Promise<APIResponse<FuturesFundingTimeV2[]>>
getFuturesOiLimit()
getFuturesOiLimit(params: FuturesOiLimitRequestV2): Promise<APIResponse<object[]>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesOiLimitRequestV2 |
Returns
Promise<APIResponse<object[]>>
getFuturesOpenCount()
getFuturesOpenCount(params: FuturesOpenCountRequestV2): Promise<APIResponse<{
size: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesOpenCountRequestV2 |
Returns
Promise<APIResponse<{ size: string; }>>
getFuturesOpenInterest()
getFuturesOpenInterest(params: object): Promise<APIResponse<{
openInterestList: FuturesOpenInterestV2[];
ts: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | { productType: FuturesProductTypeV2; symbol: string; } |
params.productType | FuturesProductTypeV2 |
params.symbol | string |
Returns
Promise<APIResponse<{ openInterestList: FuturesOpenInterestV2[]; ts: string; }>>
getFuturesOpenOrders()
getFuturesOpenOrders(params: FuturesGetOpenOrdersRequestV2): Promise<APIResponse<{
endId: string;
entrustedList: FuturesOpenOrderV2[] | null;
}>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesGetOpenOrdersRequestV2 |
Returns
Promise<APIResponse<{ endId: string; entrustedList: FuturesOpenOrderV2[] | null; }>>
getFuturesOrder()
getFuturesOrder(params: FuturesGetOrderRequestV2): Promise<APIResponse<FuturesOrderDetailV2>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesGetOrderRequestV2 |
Returns
Promise<APIResponse<FuturesOrderDetailV2>>
getFuturesPlanOrders()
getFuturesPlanOrders(params: FuturesGetPlanOrdersRequestV2): Promise<APIResponse<{
endId: string;
entrustedList: | FuturesPendingPlanOrderV2[]
| null;
}>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesGetPlanOrdersRequestV2 |
Returns
Promise<APIResponse<{ endId: string; entrustedList: | FuturesPendingPlanOrderV2[] | null; }>>
getFuturesPosition()
getFuturesPosition(params: object): Promise<APIResponse<FuturesPositionV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { marginCoin: string; productType: FuturesProductTypeV2; symbol: string; } |
params.marginCoin | string |
params.productType | FuturesProductTypeV2 |
params.symbol | string |
Returns
Promise<APIResponse<FuturesPositionV2[]>>
getFuturesPositionAdlRank()
getFuturesPositionAdlRank(params: FuturesPositionAdlRankRequestV2): Promise<APIResponse<FuturesPositionAdlRankV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesPositionAdlRankRequestV2 |
Returns
Promise<APIResponse<FuturesPositionAdlRankV2[]>>
getFuturesPositions()
getFuturesPositions(params: object): Promise<APIResponse<FuturesPositionV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { marginCoin?: string; productType: FuturesProductTypeV2; } |
params.marginCoin? | string |
params.productType | FuturesProductTypeV2 |
Returns
Promise<APIResponse<FuturesPositionV2[]>>
getFuturesPositionTier()
getFuturesPositionTier(params: object): Promise<APIResponse<FuturesPositionTierV2[]>>;- Futures | Position
Parameters
| Parameter | Type |
|---|---|
params | { productType: FuturesProductTypeV2; symbol: string; } |
params.productType | FuturesProductTypeV2 |
params.symbol | string |
Returns
Promise<APIResponse<FuturesPositionTierV2[]>>
getFuturesRecentTrades()
getFuturesRecentTrades(params: FuturesRecentTradesRequestV2): Promise<APIResponse<FuturesFillV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesRecentTradesRequestV2 |
Returns
Promise<APIResponse<FuturesFillV2[]>>
getFuturesSubAccountAssets()
getFuturesSubAccountAssets(params: object): Promise<APIResponse<object[]>>;Parameters
| Parameter | Type |
|---|---|
params | { productType: FuturesProductTypeV2; } |
params.productType | FuturesProductTypeV2 |
Returns
Promise<APIResponse<object[]>>
getFuturesSymbolPrice()
getFuturesSymbolPrice(params: object): Promise<APIResponse<FuturesSymbolPriceV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { productType: FuturesProductTypeV2; symbol: string; } |
params.productType | FuturesProductTypeV2 |
params.symbol | string |
Returns
Promise<APIResponse<FuturesSymbolPriceV2[]>>
getFuturesTicker()
getFuturesTicker(params: object): Promise<APIResponse<FuturesTickerV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { productType: FuturesProductTypeV2; symbol: string; } |
params.productType | FuturesProductTypeV2 |
params.symbol | string |
Returns
Promise<APIResponse<FuturesTickerV2[]>>
getFuturesTraderCurrentOrder()
getFuturesTraderCurrentOrder(params: GetFuturesTraderCurrentOrdersRequestV2): Promise<APIResponse<CTFuturesTraderCurrentOrdersV2>>;Copy Trading | Future copy trading | Trader Api
Parameters
| Parameter | Type |
|---|---|
params | GetFuturesTraderCurrentOrdersRequestV2 |
Returns
Promise<APIResponse<CTFuturesTraderCurrentOrdersV2>>
getFuturesTraderFollowers()
getFuturesTraderFollowers(params?: GetFuturesTraderFollowersRequestV2): Promise<APIResponse<CTFuturesTraderMyFollowersV2[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetFuturesTraderFollowersRequestV2 |
Returns
Promise<APIResponse<CTFuturesTraderMyFollowersV2[]>>
getFuturesTraderHistoryOrders()
getFuturesTraderHistoryOrders(params: GetFuturesTraderHistoryOrdersRequestV2): Promise<APIResponse<CTFuturesTraderHistoryOrderV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetFuturesTraderHistoryOrdersRequestV2 |
Returns
Promise<APIResponse<CTFuturesTraderHistoryOrderV2>>
getFuturesTraderOrder()
getFuturesTraderOrder(): Promise<APIResponse<CTFuturesTraderTotalOrderSummaryV2>>;Returns
Promise<APIResponse<CTFuturesTraderTotalOrderSummaryV2>>
getFuturesTraderProfitHistory()
getFuturesTraderProfitHistory(): Promise<APIResponse<CTFuturesTraderHistoryProfitSummaryV2>>;Returns
Promise<APIResponse<CTFuturesTraderHistoryProfitSummaryV2>>
getFuturesTraderProfitShare()
getFuturesTraderProfitShare(params?: object): Promise<APIResponse<object[]>>;Parameters
| Parameter | Type |
|---|---|
params? | { coin?: string; pageNo?: string; pageSize?: string; } |
params.coin? | string |
params.pageNo? | string |
params.pageSize? | string |
Returns
Promise<APIResponse<object[]>>
getFuturesTraderProfitShareGroup()
getFuturesTraderProfitShareGroup(params?: object): Promise<APIResponse<object[]>>;Parameters
| Parameter | Type |
|---|---|
params? | { pageNo?: string; pageSize?: string; } |
params.pageNo? | string |
params.pageSize? | string |
Returns
Promise<APIResponse<object[]>>
getFuturesTraderProfitShareHistory()
getFuturesTraderProfitShareHistory(params: GetFuturesTraderProfitShareDetailRequestV2): Promise<APIResponse<CTFuturesTraderProfitShareHistoryV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetFuturesTraderProfitShareDetailRequestV2 |
Returns
Promise<APIResponse<CTFuturesTraderProfitShareHistoryV2>>
getFuturesTraderSymbolSettings()
getFuturesTraderSymbolSettings(params: object): Promise<APIResponse<CTFuturesTraderSymbolSettingsV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { productType: CopyTradingProductTypeV2; } |
params.productType | CopyTradingProductTypeV2 |
Returns
Promise<APIResponse<CTFuturesTraderSymbolSettingsV2[]>>
getFuturesTransactionRecords()
getFuturesTransactionRecords(params: GetFuturesTransactionsRequestV2): Promise<APIResponse<FuturesTransactionRecordV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | GetFuturesTransactionsRequestV2 |
Returns
Promise<APIResponse<FuturesTransactionRecordV2[]>>
getFuturesTriggerSubOrder()
getFuturesTriggerSubOrder(params: object): Promise<APIResponse<FuturesTriggerSubOrderV2[]>>;- Futures | Trigger Orders
Parameters
| Parameter | Type |
|---|---|
params | { planOrderId: string; planType: "normal_plan" | "track_plan"; productType: FuturesProductTypeV2; } |
params.planOrderId | string |
params.planType | "normal_plan" | "track_plan" |
params.productType | FuturesProductTypeV2 |
Returns
Promise<APIResponse<FuturesTriggerSubOrderV2[]>>
getFuturesVIPFeeRate()
getFuturesVIPFeeRate(): Promise<APIResponse<FuturesVipFeeRateV2[]>>;- Futures | Market
Returns
Promise<APIResponse<FuturesVipFeeRateV2[]>>
getIsolatedMarginBorrowingRatio()
getIsolatedMarginBorrowingRatio(params: object): Promise<APIResponse<IsolatedMarginBorrowingRatioV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { period?: string; symbol: string; } |
params.period? | string |
params.symbol | string |
Returns
Promise<APIResponse<IsolatedMarginBorrowingRatioV2[]>>
getLoanCurrencies()
getLoanCurrencies(params?: object): Promise<APIResponse<EarnLoanCurrenciesV2>>;Earn | Loan
Parameters
| Parameter | Type |
|---|---|
params? | { coin?: string; } |
params.coin? | string |
Returns
Promise<APIResponse<EarnLoanCurrenciesV2>>
getLoanDebts()
getLoanDebts(): Promise<APIResponse<EarnLoanDebtsV2>>;Returns
Promise<APIResponse<EarnLoanDebtsV2>>
getLoanEstInterestAndBorrowable()
getLoanEstInterestAndBorrowable(params: GetLoanEstInterestAndBorrowableRequestV2): Promise<APIResponse<{
hourInterest: string;
loanAmount: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | GetLoanEstInterestAndBorrowableRequestV2 |
Returns
Promise<APIResponse<{ hourInterest: string; loanAmount: string; }>>
getLoanHistory()
getLoanHistory(params: GetLoanHistoryRequestV2): Promise<APIResponse<EarnLoanHistoryV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | GetLoanHistoryRequestV2 |
Returns
Promise<APIResponse<EarnLoanHistoryV2[]>>
getLoanLiquidationRecords()
getLoanLiquidationRecords(params: GetLiquidationRecordsRequestV2): Promise<APIResponse<EarnLoanLiquidationRecordsV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | GetLiquidationRecordsRequestV2 |
Returns
Promise<APIResponse<EarnLoanLiquidationRecordsV2[]>>
getLoanLTVConvert()
getLoanLTVConvert(params?: GetInstLoanLTVConvertRequestV2): Promise<APIResponse<InstLoanLTVConvertV2>>;Parameters
| Parameter | Type |
|---|---|
params? | GetInstLoanLTVConvertRequestV2 |
Returns
Promise<APIResponse<InstLoanLTVConvertV2>>
getLoanMarginCoinInfo()
getLoanMarginCoinInfo(params: GetInstLoanMarginCoinInfoRequestV2): Promise<APIResponse<{
coinInfo: InstLoanCoinInfoV2[];
productId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | GetInstLoanMarginCoinInfoRequestV2 |
Returns
Promise<APIResponse<{ coinInfo: InstLoanCoinInfoV2[]; productId: string; }>>
getLoanOrder()
getLoanOrder(params?: GetInstLoanOrderRequestV2): Promise<APIResponse<InstLoanOrderV2[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetInstLoanOrderRequestV2 |
Returns
Promise<APIResponse<InstLoanOrderV2[]>>
getLoanPledgeRateHistory()
getLoanPledgeRateHistory(params: GetLoanPledgeRateHistoryRequestV2): Promise<APIResponse<EarnLoanPledgeRateHistoryV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | GetLoanPledgeRateHistoryRequestV2 |
Returns
Promise<APIResponse<EarnLoanPledgeRateHistoryV2[]>>
getLoanProductInfo()
getLoanProductInfo(params: GetInstLoanProductInfoRequestV2): Promise<APIResponse<InstLoanProductInfoV2>>;- Inst Loan | Product Info
Parameters
| Parameter | Type |
|---|---|
params | GetInstLoanProductInfoRequestV2 |
Returns
Promise<APIResponse<InstLoanProductInfoV2>>
getLoanRepaidHistory()
getLoanRepaidHistory(params?: GetInstLoanRepaidHistoryRequestV2): Promise<APIResponse<InstLoanRepaidHistoryItemV2[]>>;- Inst Loan | Orders
Parameters
| Parameter | Type |
|---|---|
params? | GetInstLoanRepaidHistoryRequestV2 |
Returns
Promise<APIResponse<InstLoanRepaidHistoryItemV2[]>>
getLoanRiskUnit()
getLoanRiskUnit(): Promise<APIResponse<{
riskUnitId: string[];
}>>;- Inst Loan | Account
Returns
Promise<APIResponse<{ riskUnitId: string[]; }>>
getLoanSymbols()
getLoanSymbols(params: GetInstLoanSymbolsRequestV2): Promise<APIResponse<InstLoanSymbolsV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetInstLoanSymbolsRequestV2 |
Returns
Promise<APIResponse<InstLoanSymbolsV2>>
getMarginAccountAssets()
getMarginAccountAssets(marginType: MarginType, params?: object): Promise<APIResponse<MarginAccountAssetV2[]>>;- Margin | Cross/Isolated | Account
Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params? | { coin?: string; } |
params.coin? | string |
Returns
Promise<APIResponse<MarginAccountAssetV2[]>>
getMarginBorrowHistory()
getMarginBorrowHistory(marginType: MarginType, params: GetBorrowHistoryRequestV2): Promise<APIResponse<{
maxId: string;
minId: string;
resultList: MarginBorrowHistoryItemV2[];
}>>;- Margin | Cross/Isolated | Order Record
Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | GetBorrowHistoryRequestV2 |
Returns
Promise<APIResponse<{ maxId: string; minId: string; resultList: MarginBorrowHistoryItemV2[]; }>>
getMarginCurrencies()
getMarginCurrencies(): Promise<APIResponse<MarginCurrencyV2[]>>;- Margin | Common
Returns
Promise<APIResponse<MarginCurrencyV2[]>>
getMarginFinancialHistory()
getMarginFinancialHistory(marginType: MarginType, params: GetFinancialHistoryRequestV2): Promise<APIResponse<{
maxId: string;
minId: string;
resultList: MarginFinancialHistoryItemV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | GetFinancialHistoryRequestV2 |
Returns
Promise<APIResponse<{ maxId: string; minId: string; resultList: MarginFinancialHistoryItemV2[]; }>>
getMarginFlashRepayResult()
getMarginFlashRepayResult(marginType: MarginType, params: object): Promise<APIResponse<object[]>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | { idList: string; } |
params.idList | string |
Returns
Promise<APIResponse<object[]>>
getMarginHistoricOrderFills()
getMarginHistoricOrderFills(marginType: MarginType, params: GetMarginOrderFillsRequestV2): Promise<APIResponse<{
fills: MarginOrderFillV2[];
maxId: string;
minId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | GetMarginOrderFillsRequestV2 |
Returns
Promise<APIResponse<{ fills: MarginOrderFillV2[]; maxId: string; minId: string; }>>
getMarginHistoricOrders()
getMarginHistoricOrders(marginType: MarginType, params: GetHistoryOrdersRequestV2): Promise<APIResponse<{
maxId: string;
minId: string;
orderList: MarginHistoryOrderV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | GetHistoryOrdersRequestV2 |
Returns
Promise<APIResponse<{ maxId: string; minId: string; orderList: MarginHistoryOrderV2[]; }>>
getMarginInterestHistory()
getMarginInterestHistory(marginType: MarginType, params: GetInterestHistoryRequestV2): Promise<APIResponse<{
maxId: string;
minId: string;
resultList: MarginInterestHistoryItemV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | GetInterestHistoryRequestV2 |
Returns
Promise<APIResponse<{ maxId: string; minId: string; resultList: MarginInterestHistoryItemV2[]; }>>
getMarginInterestRateAndMaxBorrowable()
getMarginInterestRateAndMaxBorrowable(marginType: MarginType, params: object): Promise<APIResponse<
| IsolatedInterestRateAndLimitResponseV2[]
| CrossInterestRateAndLimitResponseV2[]>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | { coin: string; } |
params.coin | string |
Returns
Promise<APIResponse< | IsolatedInterestRateAndLimitResponseV2[] | CrossInterestRateAndLimitResponseV2[]>>
getMarginLiquidationHistory()
getMarginLiquidationHistory(marginType: MarginType, params: GetLiquidationHistoryRequestV2): Promise<APIResponse<{
maxId: string;
minId: string;
resultList: MarginLiquidationHistoryItemV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | GetLiquidationHistoryRequestV2 |
Returns
Promise<APIResponse<{ maxId: string; minId: string; resultList: MarginLiquidationHistoryItemV2[]; }>>
getMarginLiquidationOrders()
getMarginLiquidationOrders(marginType: MarginType, params: GetMarginLiquidationOrdersRequestV2): Promise<APIResponse<{
idLessThan: string;
resultList: MarginLiquidationOrderV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | GetMarginLiquidationOrdersRequestV2 |
Returns
Promise<APIResponse<{ idLessThan: string; resultList: MarginLiquidationOrderV2[]; }>>
getMarginLoanGrowthRate()
getMarginLoanGrowthRate(params: object): Promise<APIResponse<MarginLoanGrowthRateV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { coin?: string; period?: string; symbol: string; } |
params.coin? | string |
params.period? | string |
params.symbol | string |
Returns
Promise<APIResponse<MarginLoanGrowthRateV2[]>>
getMarginMaxBorrowable()
getMarginMaxBorrowable(marginType: MarginType, params: object): Promise<APIResponse<
| CrossMaxBorrowableResponseV2
| IsolatedMaxBorrowableResponseV2>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | { coin: string; } |
params.coin | string |
Returns
Promise<APIResponse< | CrossMaxBorrowableResponseV2 | IsolatedMaxBorrowableResponseV2>>
getMarginMaxTransferable()
getMarginMaxTransferable(marginType: MarginType, params: object): Promise<APIResponse<
| CrossMaxTransferableResponseV2
| IsolatedMaxTransferableResponseV2>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | { coin: string; } |
params.coin | string |
Returns
Promise<APIResponse< | CrossMaxTransferableResponseV2 | IsolatedMaxTransferableResponseV2>>
getMarginOpenOrders()
getMarginOpenOrders(marginType: MarginType, params: GetMarginCurrentOrdersRequestV2): Promise<APIResponse<{
maxId: string;
minId: string;
orderList: MarginCurrentOrderV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | GetMarginCurrentOrdersRequestV2 |
Returns
Promise<APIResponse<{ maxId: string; minId: string; orderList: MarginCurrentOrderV2[]; }>>
getMarginRepayHistory()
getMarginRepayHistory(marginType: MarginType, params: GetRepayHistoryRequestV2): Promise<APIResponse<{
maxId: string;
minId: string;
resultList: MarginRepaymentHistoryItemV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | GetRepayHistoryRequestV2 |
Returns
Promise<APIResponse<{ maxId: string; minId: string; resultList: MarginRepaymentHistoryItemV2[]; }>>
getMarginRiskRate()
getMarginRiskRate(marginType: MarginType): Promise<APIResponse<object[]>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
Returns
Promise<APIResponse<object[]>>
getMarginTierConfiguration()
getMarginTierConfiguration(marginType: MarginType, params: object): Promise<APIResponse<
| CrossTierConfigurationResponseV2[]
| IsolatedTierConfigurationResponseV2[]>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | { coin: string; } |
params.coin | string |
Returns
Promise<APIResponse< | CrossTierConfigurationResponseV2[] | IsolatedTierConfigurationResponseV2[]>>
getMarginTransactionRecords()
getMarginTransactionRecords(params: GetMarginTransactionsRequestV2): Promise<APIResponse<MarginTransactionRecordV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | GetMarginTransactionsRequestV2 |
Returns
Promise<APIResponse<MarginTransactionRecordV2[]>>
getOngoingLoanOrders()
getOngoingLoanOrders(params?: object): Promise<APIResponse<EarnLoanOrdersV2[]>>;Parameters
| Parameter | Type |
|---|---|
params? | { loanCoin?: string; orderId?: string; pledgeCoin?: string; } |
params.loanCoin? | string |
params.orderId? | string |
params.pledgeCoin? | string |
Returns
Promise<APIResponse<EarnLoanOrdersV2[]>>
getP2PMerchantAdvertisementList()
getP2PMerchantAdvertisementList(params: GetMerchantAdvertisementsRequestV2): Promise<APIResponse<{
advList: P2PMerchantAdvertismentV2[];
minAdvId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | GetMerchantAdvertisementsRequestV2 |
Returns
Promise<APIResponse<{ advList: P2PMerchantAdvertismentV2[]; minAdvId: string; }>>
getP2PMerchantInfo()
getP2PMerchantInfo(): Promise<APIResponse<P2PMerchantInfoV2>>;Returns
Promise<APIResponse<P2PMerchantInfoV2>>
getP2PMerchantList()
getP2PMerchantList(params?: GetP2PMerchantsRequestV2): Promise<APIResponse<{
merchantList: P2PMerchantV2[];
minMerchantId: string;
}>>;- Common | P2P
Parameters
| Parameter | Type |
|---|---|
params? | GetP2PMerchantsRequestV2 |
Returns
Promise<APIResponse<{ merchantList: P2PMerchantV2[]; minMerchantId: string; }>>
getP2PMerchantOrders()
getP2PMerchantOrders(params: GetMerchantP2POrdersRequestV2): Promise<APIResponse<{
minOrderId: string;
orderList: P2PMerchantOrderV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
params | GetMerchantP2POrdersRequestV2 |
Returns
Promise<APIResponse<{ minOrderId: string; orderList: P2PMerchantOrderV2[]; }>>
getP2PTransactionRecords()
getP2PTransactionRecords(params: GetP2PTransactionsRequestV2): Promise<APIResponse<P2PMerchantOrdersV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | GetP2PTransactionsRequestV2 |
Returns
Promise<APIResponse<P2PMerchantOrdersV2[]>>
getPrivate()
getPrivate(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.getPrivate
getRepayHistory()
getRepayHistory(params: GetLoanRepayHistoryRequestV2): Promise<APIResponse<EarnLoanRepayHistoryV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetLoanRepayHistoryRequestV2 |
Returns
Promise<APIResponse<EarnLoanRepayHistoryV2>>
getServerTime()
getServerTime(): Promise<APIResponse<{
serverTime: string;
}>>;- Common | Public
Returns
Promise<APIResponse<{ serverTime: string; }>>
getSharkfinAccount()
getSharkfinAccount(): Promise<APIResponse<EarnSharkfinAccountV2>>;Returns
Promise<APIResponse<EarnSharkfinAccountV2>>
getSharkfinAssets()
getSharkfinAssets(params: GetSharkfinAssetsRequestV2): Promise<APIResponse<EarnSharkfinAssetsV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetSharkfinAssetsRequestV2 |
Returns
Promise<APIResponse<EarnSharkfinAssetsV2>>
getSharkfinProducts()
getSharkfinProducts(params: object): Promise<APIResponse<EarnSharkfinProductsV2>>;Earn | Shark Fin
Parameters
| Parameter | Type |
|---|---|
params | { coin: string; idLessThan?: string; limit?: string; } |
params.coin | string |
params.idLessThan? | string |
params.limit? | string |
Returns
Promise<APIResponse<EarnSharkfinProductsV2>>
getSharkfinRecords()
getSharkfinRecords(params: GetSharkfinRecordsRequestV2): Promise<APIResponse<EarnSharkfinRecordsV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetSharkfinRecordsRequestV2 |
Returns
Promise<APIResponse<EarnSharkfinRecordsV2>>
getSharkfinSubscription()
getSharkfinSubscription(params: object): Promise<APIResponse<EarnSharkfinSubscriptionDetailV2>>;Parameters
| Parameter | Type |
|---|---|
params | { productId: string; } |
params.productId | string |
Returns
Promise<APIResponse<EarnSharkfinSubscriptionDetailV2>>
getSharkfinSubscriptionResult()
getSharkfinSubscriptionResult(params: object): Promise<APIResponse<{
msg: string;
result: "success" | "fail";
}>>;Parameters
| Parameter | Type |
|---|---|
params | { orderId: string; } |
params.orderId | string |
Returns
Promise<APIResponse<{ msg: string; result: "success" | "fail"; }>>
getSpotAccount()
getSpotAccount(): Promise<APIResponse<SpotAccountInfoV2>>;- Spot | Account
Returns
Promise<APIResponse<SpotAccountInfoV2>>
getSpotAccountAssets()
getSpotAccountAssets(params?: object): Promise<APIResponse<SpotAccountAssetV2[]>>;Parameters
| Parameter | Type |
|---|---|
params? | { assetType?: string; coin?: string; } |
params.assetType? | string |
params.coin? | string |
Returns
Promise<APIResponse<SpotAccountAssetV2[]>>
See
getSpotAccountBills()
getSpotAccountBills(params?: GetSpotAccountBillsRequestV2): Promise<APIResponse<SpotAccountBillV2[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetSpotAccountBillsRequestV2 |
Returns
Promise<APIResponse<SpotAccountBillV2[]>>
getSpotBGBDeductInfo()
getSpotBGBDeductInfo(): Promise<APIResponse<{
deduct: string;
}>>;Returns
Promise<APIResponse<{ deduct: string; }>>
getSpotCallAuction()
getSpotCallAuction(params: SpotCallAuctionRequestV2): Promise<APIResponse<SpotCallAuctionV2>>;Parameters
| Parameter | Type |
|---|---|
params | SpotCallAuctionRequestV2 |
Returns
Promise<APIResponse<SpotCallAuctionV2>>
getSpotCandles()
getSpotCandles(params: SpotCandlesRequestV2): Promise<APIResponse<SpotCandlestickV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | SpotCandlesRequestV2 |
Returns
Promise<APIResponse<SpotCandlestickV2[]>>
getSpotCoinInfo()
getSpotCoinInfo(params?: object): Promise<APIResponse<SpotCoinInfoV2[]>>;- Spot | Market
Parameters
| Parameter | Type |
|---|---|
params? | { coin?: string; } |
params.coin? | string |
Returns
Promise<APIResponse<SpotCoinInfoV2[]>>
getSpotCurrentPlanOrders()
getSpotCurrentPlanOrders(params: GetSpotCurrentPlanOrdersRequestV2): Promise<APIResponse<{
idLessThan: string;
nextFlag: boolean;
orderList: SpotCurrentPlanOrderV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
params | GetSpotCurrentPlanOrdersRequestV2 |
Returns
Promise<APIResponse<{ idLessThan: string; nextFlag: boolean; orderList: SpotCurrentPlanOrderV2[]; }>>
getSpotDepositAddress()
getSpotDepositAddress(params: object): Promise<APIResponse<SpotDepositAddressV2>>;Parameters
| Parameter | Type |
|---|---|
params | { chain?: string; coin: string; size: string; } |
params.chain? | string |
params.coin | string |
params.size | string |
Returns
Promise<APIResponse<SpotDepositAddressV2>>
getSpotDepositHistory()
getSpotDepositHistory(params: GetSpotDepositRecordRequestV2): Promise<APIResponse<SpotDepositRecordV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | GetSpotDepositRecordRequestV2 |
Returns
Promise<APIResponse<SpotDepositRecordV2[]>>
getSpotFills()
getSpotFills(params: GetSpotFillsRequestV2): Promise<APIResponse<SpotFillV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | GetSpotFillsRequestV2 |
Returns
Promise<APIResponse<SpotFillV2[]>>
getSpotFollowerCurrentTraderSymbols()
getSpotFollowerCurrentTraderSymbols(params: object): Promise<APIResponse<{
currentTradingList: string[];
}>>;Parameters
| Parameter | Type |
|---|---|
params | { traderId: string; } |
params.traderId | string |
Returns
Promise<APIResponse<{ currentTradingList: string[]; }>>
getSpotFollowerHistoryOrders()
getSpotFollowerHistoryOrders(params: GetSpotFollowerHistoryOrdersRequestV2): Promise<APIResponse<CTSpotFollowerHistoryOrdersV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetSpotFollowerHistoryOrdersRequestV2 |
Returns
Promise<APIResponse<CTSpotFollowerHistoryOrdersV2>>
getSpotFollowerOpenOrders()
getSpotFollowerOpenOrders(params: GetSpotFollowerOpenOrdersRequestV2): Promise<APIResponse<CTSpotFollowerCurrentOrdersV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetSpotFollowerOpenOrdersRequestV2 |
Returns
Promise<APIResponse<CTSpotFollowerCurrentOrdersV2>>
getSpotFollowerSettings()
getSpotFollowerSettings(params: object): Promise<APIResponse<CTSpotFollowerFollowConfigurationV2>>;Parameters
| Parameter | Type |
|---|---|
params | { traderId: string; } |
params.traderId | string |
Returns
Promise<APIResponse<CTSpotFollowerFollowConfigurationV2>>
getSpotFollowerTraders()
getSpotFollowerTraders(params?: object): Promise<APIResponse<CTSpotFollowerMyTradersV2>>;Parameters
| Parameter | Type |
|---|---|
params? | { endTime?: string; pageNo?: string; pageSize?: string; startTime?: string; } |
params.endTime? | string |
params.pageNo? | string |
params.pageSize? | string |
params.startTime? | string |
Returns
Promise<APIResponse<CTSpotFollowerMyTradersV2>>
getSpotFundFlow()
getSpotFundFlow(params: object): Promise<APIResponse<SpotFundFlowV2>>;Parameters
| Parameter | Type |
|---|---|
params | { period?: string; symbol: string; } |
params.period? | string |
params.symbol | string |
Returns
Promise<APIResponse<SpotFundFlowV2>>
getSpotFundNetFlowData()
getSpotFundNetFlowData(params: object): Promise<APIResponse<object[]>>;Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APIResponse<object[]>>
getSpotHistoricCandles()
getSpotHistoricCandles(params: SpotHistoricCandlesRequestV2): Promise<APIResponse<SpotCandlestickV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | SpotHistoricCandlesRequestV2 |
Returns
Promise<APIResponse<SpotCandlestickV2[]>>
getSpotHistoricOrders()
getSpotHistoricOrders(params?: GetSpotHistoryOrdersRequestV2): Promise<APIResponse<SpotOrderInfoV2[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetSpotHistoryOrdersRequestV2 |
Returns
Promise<APIResponse<SpotOrderInfoV2[]>>
getSpotHistoricPlanOrders()
getSpotHistoricPlanOrders(params: GetSpotHistoryPlanOrdersRequestV2): Promise<APIResponse<{
idLessThan: string;
nextFlag: boolean;
orderList: SpotHistoryPlanOrderV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
params | GetSpotHistoryPlanOrdersRequestV2 |
Returns
Promise<APIResponse<{ idLessThan: string; nextFlag: boolean; orderList: SpotHistoryPlanOrderV2[]; }>>
getSpotHistoricTrades()
getSpotHistoricTrades(params: SpotHistoricTradesRequestV2): Promise<APIResponse<SpotTradeV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | SpotHistoricTradesRequestV2 |
Returns
Promise<APIResponse<SpotTradeV2[]>>
getSpotMainSubTransferRecord()
getSpotMainSubTransferRecord(params: SpotMainSubTransferRecordRequestV2): Promise<APIResponse<SpotMainSubTransferRecordV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | SpotMainSubTransferRecordRequestV2 |
Returns
Promise<APIResponse<SpotMainSubTransferRecordV2[]>>
getSpotMergeDepth()
getSpotMergeDepth(params: object): Promise<APIResponse<SpotMergeDepthV2>>;Parameters
| Parameter | Type |
|---|---|
params | { limit?: string; precision?: string; symbol: string; } |
params.limit? | string |
params.precision? | string |
params.symbol | string |
Returns
Promise<APIResponse<SpotMergeDepthV2>>
getSpotOpenOrders()
getSpotOpenOrders(params?: GetSpotOpenOrdersRequestV2): Promise<APIResponse<SpotOpenOrderV2[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetSpotOpenOrdersRequestV2 |
Returns
Promise<APIResponse<SpotOpenOrderV2[]>>
getSpotOrder()
getSpotOrder(params?: GetSpotOrderInfoRequestV2): Promise<APIResponse<SpotOrderInfoV2[]>>;Parameters
| Parameter | Type |
|---|---|
params? | GetSpotOrderInfoRequestV2 |
Returns
Promise<APIResponse<SpotOrderInfoV2[]>>
getSpotOrderBookDepth()
getSpotOrderBookDepth(params: object): Promise<APIResponse<SpotOrderBookDepthV2>>;Parameters
| Parameter | Type |
|---|---|
params | { limit?: string; symbol: string; type?: string; } |
params.limit? | string |
params.symbol | string |
params.type? | string |
Returns
Promise<APIResponse<SpotOrderBookDepthV2>>
getSpotPlanSubOrder()
getSpotPlanSubOrder(params: object): Promise<APIResponse<SpotPlanSubOrderV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { planOrderId: string; } |
params.planOrderId | string |
Returns
Promise<APIResponse<SpotPlanSubOrderV2[]>>
getSpotRecentTrades()
getSpotRecentTrades(params: object): Promise<APIResponse<SpotTradeV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { limit?: string; symbol: string; } |
params.limit? | string |
params.symbol | string |
Returns
Promise<APIResponse<SpotTradeV2[]>>
getSpotSubAccountAssets()
getSpotSubAccountAssets(): Promise<APIResponse<SpotSubAccountAssetsV2[]>>;Returns
Promise<APIResponse<SpotSubAccountAssetsV2[]>>
getSpotSubDepositAddress()
getSpotSubDepositAddress(params: object): Promise<APIResponse<SpotDepositAddressV2>>;Parameters
| Parameter | Type |
|---|---|
params | { chain?: string; coin: string; size: string; subUid: string; } |
params.chain? | string |
params.coin | string |
params.size | string |
params.subUid | string |
Returns
Promise<APIResponse<SpotDepositAddressV2>>
getSpotSymbolInfo()
getSpotSymbolInfo(params?: object): Promise<APIResponse<SpotSymbolInfoV2[]>>;Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<APIResponse<SpotSymbolInfoV2[]>>
getSpotTicker()
getSpotTicker(params?: object): Promise<APIResponse<SpotTickerV2[]>>;Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<APIResponse<SpotTickerV2[]>>
getSpotTraderConfiguration()
getSpotTraderConfiguration(): Promise<APIResponse<any>>;Returns
Promise<APIResponse<any>>
getSpotTraderCurrentOrders()
getSpotTraderCurrentOrders(params: GetSpotTraderCurrentOrdersRequestV2): Promise<APIResponse<CTSpotTraderCurrentTrackingOrdersV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetSpotTraderCurrentOrdersRequestV2 |
Returns
Promise<APIResponse<CTSpotTraderCurrentTrackingOrdersV2>>
getSpotTraderFollowers()
getSpotTraderFollowers(params: GetSpotTraderFollowersRequestV2): Promise<APIResponse<CTSpotTraderFollowerListV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | GetSpotTraderFollowersRequestV2 |
Returns
Promise<APIResponse<CTSpotTraderFollowerListV2[]>>
getSpotTraderHistoryOrders()
getSpotTraderHistoryOrders(params: GetSpotTraderHistoryOrdersRequestV2): Promise<APIResponse<CTSpotTraderHistoryOrdersV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetSpotTraderHistoryOrdersRequestV2 |
Returns
Promise<APIResponse<CTSpotTraderHistoryOrdersV2>>
getSpotTraderHistoryProfit()
getSpotTraderHistoryProfit(params: GetSpotTraderHistoryProfitRequestV2): Promise<APIResponse<CTSpotTraderHistoryProfitSharingV2>>;Parameters
| Parameter | Type |
|---|---|
params | GetSpotTraderHistoryProfitRequestV2 |
Returns
Promise<APIResponse<CTSpotTraderHistoryProfitSharingV2>>
getSpotTraderOrder()
getSpotTraderOrder(): Promise<APIResponse<CTSpotTraderTotalOrderDetailV2>>;Returns
Promise<APIResponse<CTSpotTraderTotalOrderDetailV2>>
getSpotTraderProfit()
getSpotTraderProfit(): Promise<APIResponse<CTSpotTraderProfitSummaryV2>>;Copy Trading | Spot copy trading | Trader api
Returns
Promise<APIResponse<CTSpotTraderProfitSummaryV2>>
getSpotTraderSymbolSettings()
getSpotTraderSymbolSettings(params: object): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | { settingType: "add" | "delete"; symbolList: string[]; } |
params.settingType | "add" | "delete" |
params.symbolList | string[] |
Returns
Promise<APIResponse<string>>
getSpotTraderUnrealizedProfit()
getSpotTraderUnrealizedProfit(params?: object): Promise<APIResponse<CTSpotTraderUnrealizedProfitV2[]>>;Parameters
| Parameter | Type |
|---|---|
params? | { coin?: string; pageNo?: string; pageSize?: string; } |
params.coin? | string |
params.pageNo? | string |
params.pageSize? | string |
Returns
Promise<APIResponse<CTSpotTraderUnrealizedProfitV2[]>>
getSpotTransactionRecords()
getSpotTransactionRecords(params: GetSpotTransactionsRequestV2): Promise<APIResponse<SpotTransactionRecordV2[]>>;- Common | Tax
Parameters
| Parameter | Type |
|---|---|
params | GetSpotTransactionsRequestV2 |
Returns
Promise<APIResponse<SpotTransactionRecordV2[]>>
getSpotTransferableCoins()
getSpotTransferableCoins(params: object): Promise<APIResponse<string[]>>;Parameters
| Parameter | Type |
|---|---|
params | { fromType: SpotAccountTypeV2; toType: SpotAccountTypeV2; } |
params.fromType | SpotAccountTypeV2 |
params.toType | SpotAccountTypeV2 |
Returns
Promise<APIResponse<string[]>>
getSpotTransferHistory()
getSpotTransferHistory(params: GetSpotTransferRecordRequestV2): Promise<APIResponse<SpotTransferRecordV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | GetSpotTransferRecordRequestV2 |
Returns
Promise<APIResponse<SpotTransferRecordV2[]>>
getSpotVIPFeeRate()
getSpotVIPFeeRate(): Promise<APIResponse<SpotVipFeeRateV2[]>>;Returns
Promise<APIResponse<SpotVipFeeRateV2[]>>
getSpotWhaleNetFlowData()
getSpotWhaleNetFlowData(params: object): Promise<APIResponse<SpotWhaleNetFlowV2[]>>;- Common | Trading insights
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APIResponse<SpotWhaleNetFlowV2[]>>
getSpotWithdrawalHistory()
getSpotWithdrawalHistory(params: GetSpotWithdrawalRecordRequestV2): Promise<APIResponse<SpotWithdrawalRecordV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | GetSpotWithdrawalRecordRequestV2 |
Returns
Promise<APIResponse<SpotWithdrawalRecordV2[]>>
getSubaccountApiKey()
getSubaccountApiKey(params: object): Promise<APIResponse<SubaccountApiKeyV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { subUid: string; } |
params.subUid | string |
Returns
Promise<APIResponse<SubaccountApiKeyV2[]>>
getSubAccountDepositRecords()
getSubAccountDepositRecords(params: GetSpotSubAccountDepositRecordRequestV2): Promise<APIResponse<SpotSubAccountDepositRecordV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | GetSpotSubAccountDepositRecordRequestV2 |
Returns
Promise<APIResponse<SpotSubAccountDepositRecordV2[]>>
getSubaccountEmail()
getSubaccountEmail(params: object): Promise<APIResponse<SubaccountEmailV2>>;Parameters
| Parameter | Type |
|---|---|
params | { subUid: string; } |
params.subUid | string |
Returns
Promise<APIResponse<SubaccountEmailV2>>
getSubaccountFuturesAssets()
getSubaccountFuturesAssets(params: object): Promise<APIResponse<{
assetsList: BrokerSubaccountFutureAssetV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
params | { productType: FuturesProductTypeV2; subUid: string; } |
params.productType | FuturesProductTypeV2 |
params.subUid | string |
Returns
Promise<APIResponse<{ assetsList: BrokerSubaccountFutureAssetV2[]; }>>
getSubaccounts()
getSubaccounts(params?: GetSubAccountsRequestV2): Promise<APIResponse<{
hasNextPage: boolean;
idLessThan: number;
subList: BrokerSubaccountV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
params? | GetSubAccountsRequestV2 |
Returns
Promise<APIResponse<{ hasNextPage: boolean; idLessThan: number; subList: BrokerSubaccountV2[]; }>>
getSubaccountSpotAssets()
getSubaccountSpotAssets(params: object): Promise<APIResponse<{
assetsList: BrokerSubaccountSpotAssetV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
params | { assetType?: "all" | "hold_only"; coin?: string; subUid: string; } |
params.assetType? | "all" | "hold_only" |
params.coin? | string |
params.subUid | string |
Returns
Promise<APIResponse<{ assetsList: BrokerSubaccountSpotAssetV2[]; }>>
getSubAffiliateInfo()
getSubAffiliateInfo(params?: GetSubAffiliateInfoRequestV2): Promise<APIResponse<SubAffiliateInfoV2>>;Parameters
| Parameter | Type |
|---|---|
params? | GetSubAffiliateInfoRequestV2 |
Returns
Promise<APIResponse<SubAffiliateInfoV2>>
getSwitchUnionUsdt()
getSwitchUnionUsdt(): Promise<APIResponse<UnionSwitchUsdtV2>>;Get Switch Union USDT
- Rate limit: 1 time/1s (uid)
- Get USDT quota for switching from union margin to single margin
Returns
Promise<APIResponse<UnionSwitchUsdtV2>>
getTradeDataSupportSymbols()
getTradeDataSupportSymbols(): Promise<APIResponse<{
futureList: string[];
spotList: string[];
}>>;Returns
Promise<APIResponse<{ futureList: string[]; spotList: string[]; }>>
getTradeRate()
getTradeRate(params: GetTradeRateRequestV2): Promise<APIResponse<{
makerFeeRate: string;
takerFeeRate: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | GetTradeRateRequestV2 |
Returns
Promise<APIResponse<{ makerFeeRate: string; takerFeeRate: string; }>>
getUnifiedAccountSwitchStatus()
getUnifiedAccountSwitchStatus(params?: object): Promise<APIResponse<{
status: "processProcessing" | "successSuccess" | "failFailed";
}>>;Get Upgrade Status - Get account upgrade status No account type restrictions; both parent and sub-accounts are supported.
Parameters
| Parameter | Type |
|---|---|
params? | { subUid?: string; } |
params.subUid? | string |
Returns
Promise<APIResponse<{ status: "processProcessing" | "successSuccess" | "failFailed"; }>>
getUnionConfig()
getUnionConfig(): Promise<APIResponse<UnionConfigV2>>;Get Union Config
- Rate limit: 1 time/1s (uid)
- Get API for union margin configuration parameters (Liability Initial Margin Rate, Liability Maintenance Margin Rate, Personal Liability Limit, Personal Liability Limit Ratio)
Returns
Promise<APIResponse<UnionConfigV2>>
getUnionTransferLimits()
getUnionTransferLimits(params: GetUnionTransferLimitsRequestV2): Promise<APIResponse<UnionTransferLimitsV2>>;Get Union Transfer Limits
- Rate limit: 1 time/1s (uid)
- Get union margin currency transfer limits
Parameters
| Parameter | Type |
|---|---|
params | GetUnionTransferLimitsRequestV2 |
Returns
Promise<APIResponse<UnionTransferLimitsV2>>
getVirtualSubaccountAPIKeys()
getVirtualSubaccountAPIKeys(params: object): Promise<APIResponse<SubAccountApiKeyItemV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { subAccountUid: string; } |
params.subAccountUid | string |
Returns
Promise<APIResponse<SubAccountApiKeyItemV2[]>>
getVirtualSubaccounts()
getVirtualSubaccounts(params?: object): Promise<APIResponse<{
endId: string;
subAccountList: VirtualSubAccountV2[];
}>>;Parameters
| Parameter | Type |
|---|---|
params? | { idLessThan?: string; limit?: string; status?: "normal" | "freeze"; } |
params.idLessThan? | string |
params.limit? | string |
params.status? | "normal" | "freeze" |
Returns
Promise<APIResponse<{ endId: string; subAccountList: VirtualSubAccountV2[]; }>>
marginBatchCancelOrders()
marginBatchCancelOrders(marginType: MarginType, params: object): Promise<APIResponse<MarginBatchOrdersResponseV2>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | { orderIdList: string[]; symbol: string; } |
params.orderIdList | string[] |
params.symbol | string |
Returns
Promise<APIResponse<MarginBatchOrdersResponseV2>>
marginBatchSubmitOrders()
marginBatchSubmitOrders(marginType: MarginType, params: MarginBatchOrdersRequestV2): Promise<APIResponse<MarginBatchOrdersResponseV2>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | MarginBatchOrdersRequestV2 |
Returns
Promise<APIResponse<MarginBatchOrdersResponseV2>>
marginBorrow()
marginBorrow(marginType: MarginType, params: object): Promise<APIResponse<{
borrowAmount: string;
coin: string;
loanId: string;
symbol: string;
}>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | { borrowAmount: string; coin: string; loanId: string; symbol: string; } |
params.borrowAmount | string |
params.coin | string |
params.loanId | string |
params.symbol | string |
Returns
Promise<APIResponse<{ borrowAmount: string; coin: string; loanId: string; symbol: string; }>>
marginCancelOrder()
marginCancelOrder(marginType: MarginType, params: object): Promise<APIResponse<{
clientOid: string;
orderId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | { clientOid?: string; orderId?: string; symbol: string; } |
params.clientOid? | string |
params.orderId? | string |
params.symbol | string |
Returns
Promise<APIResponse<{ clientOid: string; orderId: string; }>>
marginFlashRepay()
marginFlashRepay(marginType: MarginType, params: object): Promise<APIResponse<{
coin?: string;
repayId: string;
result?: string;
symbol?: string;
}>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | { coin: string; } |
params.coin | string |
Returns
Promise<APIResponse<{ coin?: string; repayId: string; result?: string; symbol?: string; }>>
marginRepay()
marginRepay(marginType: MarginType, params: object): Promise<APIResponse<{
coin: string;
remainDebtAmount: string;
repayAmount: string;
repayId: string;
symbol: string;
}>>;Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | { coin: string; remainDebtAmount: string; repayAmount: string; repayId: string; symbol: string; } |
params.coin | string |
params.remainDebtAmount | string |
params.repayAmount | string |
params.repayId | string |
params.symbol | string |
Returns
Promise<APIResponse<{ coin: string; remainDebtAmount: string; repayAmount: string; repayId: string; symbol: string; }>>
marginSubmitOrder()
marginSubmitOrder(marginType: MarginType, params: MarginPlaceOrderRequestV2): Promise<APIResponse<{
clientOid: string;
orderId: string;
}>>;- Margin | Cross/Isolated | Trade
Parameters
| Parameter | Type |
|---|---|
marginType | MarginType |
params | MarginPlaceOrderRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; orderId: string; }>>
modifyFuturesTraderOrderTPSL()
modifyFuturesTraderOrderTPSL(params: ModifyFuturesTraderOrderTPSLRequestV2): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | ModifyFuturesTraderOrderTPSLRequestV2 |
Returns
Promise<APIResponse<string>>
modifySpotTraderOrderTPSL()
modifySpotTraderOrderTPSL(params: object): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | { stopLossPrice?: string; stopSurplusPrice?: string; trackingNo: string; } |
params.stopLossPrice? | string |
params.stopSurplusPrice? | string |
params.trackingNo | string |
Returns
Promise<APIResponse<string>>
modifySubaccount()
modifySubaccount(params: ModifySubRequestV2): Promise<APIResponse<ModifySubaccountResponseV2>>;Parameters
| Parameter | Type |
|---|---|
params | ModifySubRequestV2 |
Returns
Promise<APIResponse<ModifySubaccountResponseV2>>
modifySubaccountApiKey()
modifySubaccountApiKey(params: ModifySubAccountApiKeyRequestV2): Promise<APIResponse<ModifySubaccountApiKeyResponseV2>>;Parameters
| Parameter | Type |
|---|---|
params | ModifySubAccountApiKeyRequestV2 |
Returns
Promise<APIResponse<ModifySubaccountApiKeyResponseV2>>
modifySubaccountEmail()
modifySubaccountEmail(params: object): Promise<APIResponse<string>>;- Broker | Subaccount
Parameters
| Parameter | Type |
|---|---|
params | { subaccountEmail: string; subUid: string; } |
params.subaccountEmail | string |
params.subUid | string |
Returns
Promise<APIResponse<string>>
modifyVirtualSubaccount()
modifyVirtualSubaccount(params: ModifyVirtualSubRequestV2): Promise<APIResponse<{
result: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | ModifyVirtualSubRequestV2 |
Returns
Promise<APIResponse<{ result: string; }>>
modifyVirtualSubaccountAPIKey()
modifyVirtualSubaccountAPIKey(params: ModifyVirtualSubApiKeyRequestV2): Promise<APIResponse<ModifyVirtualSubAccountApiKeyV2>>;Parameters
| Parameter | Type |
|---|---|
params | ModifyVirtualSubApiKeyRequestV2 |
Returns
Promise<APIResponse<ModifyVirtualSubAccountApiKeyV2>>
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
redeemEarnElite()
redeemEarnElite(params: RedeemEarnEliteRequestV2): Promise<APIResponse<RedeemEarnEliteResultV2>>;Parameters
| Parameter | Type |
|---|---|
params | RedeemEarnEliteRequestV2 |
Returns
Promise<APIResponse<RedeemEarnEliteResultV2>>
removeFuturesTraderFollower()
removeFuturesTraderFollower(params: object): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | { followerUid: string; } |
params.followerUid | string |
Returns
Promise<APIResponse<string>>
removeSpotTraderFollowers()
removeSpotTraderFollowers(params: object): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | { followerUid: string; } |
params.followerUid | string |
Returns
Promise<APIResponse<string>>
repayLoan()
repayLoan(params: RepayLoanRequestV2): Promise<APIResponse<EarnLoanRepayResponseV2>>;Parameters
| Parameter | Type |
|---|---|
params | RepayLoanRequestV2 |
Returns
Promise<APIResponse<EarnLoanRepayResponseV2>>
sellSpotFollower()
sellSpotFollower(params: object): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; trackingNoList: string[]; } |
params.symbol | string |
params.trackingNoList | string[] |
Returns
Promise<APIResponse<string>>
sellSpotTrader()
sellSpotTrader(params: object): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; trackingNoList: string[]; } |
params.symbol | string |
params.trackingNoList | string[] |
Returns
Promise<APIResponse<string>>
setFuturesAssetMode()
setFuturesAssetMode(params: object): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | { assetMode: "single" | "union"; productType: "USDT-FUTURES" | "SUSDT-FUTURES"; } |
params.assetMode | "single" | "union" |
params.productType | "USDT-FUTURES" | "SUSDT-FUTURES" |
Returns
Promise<APIResponse<string>>
setFuturesLeverage()
setFuturesLeverage(params: FuturesSetLeverageRequestV2): Promise<APIResponse<SetLeverageResponseV2>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesSetLeverageRequestV2 |
Returns
Promise<APIResponse<SetLeverageResponseV2>>
setFuturesMarginMode()
setFuturesMarginMode(params: FuturesSetMarginModeRequestV2): Promise<APIResponse<SetMarginModeResponseV2>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesSetMarginModeRequestV2 |
Returns
Promise<APIResponse<SetMarginModeResponseV2>>
setFuturesPositionAutoMargin()
setFuturesPositionAutoMargin(params: FuturesSetAutoMarginRequestV2): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesSetAutoMarginRequestV2 |
Returns
Promise<APIResponse<string>>
setFuturesPositionMargin()
setFuturesPositionMargin(params: FuturesSetPositionMarginRequestV2): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | FuturesSetPositionMarginRequestV2 |
Returns
Promise<APIResponse<string>>
setFuturesPositionMode()
setFuturesPositionMode(params: object): Promise<APIResponse<{
posMode: "one_way_mode" | "hedge_mode";
}>>;Parameters
| Parameter | Type |
|---|---|
params | { posMode: "one_way_mode" | "hedge_mode"; productType: FuturesProductTypeV2; } |
params.posMode | "one_way_mode" | "hedge_mode" |
params.productType | FuturesProductTypeV2 |
Returns
Promise<APIResponse<{ posMode: "one_way_mode" | "hedge_mode"; }>>
spotBatchCancelandSubmitOrder()
spotBatchCancelandSubmitOrder(params: object): Promise<APIResponse<CancelAndSubmitSpotOrderResponseV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { orderList: SpotCancelandSubmitOrderRequestV2[]; } |
params.orderList | SpotCancelandSubmitOrderRequestV2[] |
Returns
Promise<APIResponse<CancelAndSubmitSpotOrderResponseV2[]>>
spotBatchCancelOrders()
spotBatchCancelOrders(params: SpotBatchCancelOrderRequestV2): Promise<APIResponse<SubmitSpotBatchOrdersResponseV2>>;Parameters
| Parameter | Type |
|---|---|
params | SpotBatchCancelOrderRequestV2 |
Returns
Promise<APIResponse<SubmitSpotBatchOrdersResponseV2>>
spotBatchSubmitOrders()
spotBatchSubmitOrders(params: SpotBatchOrderRequestV2): Promise<APIResponse<SubmitSpotBatchOrdersResponseV2>>;Parameters
| Parameter | Type |
|---|---|
params | SpotBatchOrderRequestV2 |
Returns
Promise<APIResponse<SubmitSpotBatchOrdersResponseV2>>
spotCancelandSubmitOrder()
spotCancelandSubmitOrder(params: SpotCancelandSubmitOrderRequestV2): Promise<APIResponse<CancelAndSubmitSpotOrderResponseV2>>;Parameters
| Parameter | Type |
|---|---|
params | SpotCancelandSubmitOrderRequestV2 |
Returns
Promise<APIResponse<CancelAndSubmitSpotOrderResponseV2>>
spotCancelOrder()
spotCancelOrder(params: SpotCancelOrderRequestV2): Promise<APIResponse<{
clientOid: string;
orderId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | SpotCancelOrderRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; orderId: string; }>>
spotCancelPlanOrder()
spotCancelPlanOrder(params: object): Promise<APIResponse<{
result: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | { clientOid?: string; orderId?: string; } |
params.clientOid? | string |
params.orderId? | string |
Returns
Promise<APIResponse<{ result: string; }>>
spotCancelPlanOrders()
spotCancelPlanOrders(params?: object): Promise<APIResponse<SpotCancelPlanOrdersV2>>;Parameters
| Parameter | Type |
|---|---|
params? | { symbolList?: string[]; } |
params.symbolList? | string[] |
Returns
Promise<APIResponse<SpotCancelPlanOrdersV2>>
spotCancelSymbolOrder()
spotCancelSymbolOrder(params: object): Promise<APIResponse<{
symbol: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APIResponse<{ symbol: string; }>>
spotCancelWithdrawal()
spotCancelWithdrawal(params: object): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | { orderId: string; } |
params.orderId | string |
Returns
Promise<APIResponse<string>>
spotModifyDepositAccount()
spotModifyDepositAccount(params: object): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | { accountType: string; coin: string; } |
params.accountType | string |
params.coin | string |
Returns
Promise<APIResponse<string>>
spotModifyPlanOrder()
spotModifyPlanOrder(params: SpotModifyPlanOrderRequestV2): Promise<APIResponse<{
clientOid: string;
orderId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | SpotModifyPlanOrderRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; orderId: string; }>>
spotSubmitOrder()
spotSubmitOrder(params: SpotOrderRequestV2): Promise<APIResponse<{
clientOid: string;
orderId: string;
}>>;- Spot | Trade
Parameters
| Parameter | Type |
|---|---|
params | SpotOrderRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; orderId: string; }>>
spotSubmitPlanOrder()
spotSubmitPlanOrder(params: SpotPlanOrderRequestV2): Promise<APIResponse<{
clientOid: string;
orderId: string;
}>>;- Spot | Trigger Orders
Parameters
| Parameter | Type |
|---|---|
params | SpotPlanOrderRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; orderId: string; }>>
spotSubTransfer()
spotSubTransfer(params: SpotSubAccountTransferRequestV2): Promise<APIResponse<{
clientOid: string;
transferId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | SpotSubAccountTransferRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; transferId: string; }>>
spotSwitchBGBDeduct()
spotSwitchBGBDeduct(params: object): Promise<APIResponse<boolean>>;Parameters
| Parameter | Type |
|---|---|
params | { deduct: boolean; } |
params.deduct | boolean |
Returns
Promise<APIResponse<boolean>>
spotTransfer()
spotTransfer(params: SpotTransferRequestV2): Promise<APIResponse<{
clientOid: string;
transferId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | SpotTransferRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; transferId: string; }>>
spotWithdraw()
spotWithdraw(params: SpotWithdrawalRequestV2): Promise<APIResponse<{
clientOid: string;
orderId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | SpotWithdrawalRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; orderId: string; }>>
subaccountDepositRecords()
subaccountDepositRecords(params: SubDepositRecordsRequestV2): Promise<APIResponse<SubaccountDepositV2>>;Sub Deposit Records
- Only applicable for ND broker main-account to get ND sub-accounts deposit record
Parameters
| Parameter | Type |
|---|---|
params | SubDepositRecordsRequestV2 |
Returns
Promise<APIResponse<SubaccountDepositV2>>
subaccountSetAutoTransfer()
subaccountSetAutoTransfer(params: object): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | { coin: string; subUid: string; toAccountType: string; } |
params.coin | string |
params.subUid | string |
params.toAccountType | string |
Returns
Promise<APIResponse<string>>
subaccountWithdrawal()
subaccountWithdrawal(params: SubWithdrawalRequestV2): Promise<APIResponse<{
clientOid: string;
orderId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | SubWithdrawalRequestV2 |
Returns
Promise<APIResponse<{ clientOid: string; orderId: string; }>>
subaccountWithdrawalRecords()
subaccountWithdrawalRecords(params: SubWithdrawalRecordsRequestV2): Promise<APIResponse<{
endId: string;
resultList: BrokerSubaccountWithdrawalV2[];
}>>;Sub Withdrawal Records
- Only applicable for ND broker main-account
Parameters
| Parameter | Type |
|---|---|
params | SubWithdrawalRecordsRequestV2 |
Returns
Promise<APIResponse<{ endId: string; resultList: BrokerSubaccountWithdrawalV2[]; }>>
subscribeEarnElite()
subscribeEarnElite(params: EarnEliteSubscribeRequestV2): Promise<APIResponse<EarnEliteSubscribeResultV2>>;Parameters
| Parameter | Type |
|---|---|
params | EarnEliteSubscribeRequestV2 |
Returns
Promise<APIResponse<EarnEliteSubscribeResultV2>>
subscribeSharkfin()
subscribeSharkfin(params: object): Promise<APIResponse<{
orderId: string;
status: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | { amount: string; productId: string; } |
params.amount | string |
params.productId | string |
Returns
Promise<APIResponse<{ orderId: string; status: string; }>>
unfollowFuturesTrader()
unfollowFuturesTrader(params: object): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | { traderId: string; } |
params.traderId | string |
Returns
Promise<APIResponse<string>>
unfollowSpotTrader()
unfollowSpotTrader(params: object): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | { traderId: string; } |
params.traderId | string |
Returns
Promise<APIResponse<string>>
unionConvert()
unionConvert(params: UnionConvertRequestV2): Promise<APIResponse<UnionConvertV2>>;Union Convert
- Rate limit: 1 time/1s (uid)
- Union margin exchange
Parameters
| Parameter | Type |
|---|---|
params | UnionConvertRequestV2 |
Returns
Promise<APIResponse<UnionConvertV2>>
updateFuturesFollowerSettings()
updateFuturesFollowerSettings(params: UpdateFuturesFollowerSettingsRequestV2): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | UpdateFuturesFollowerSettingsRequestV2 |
Returns
Promise<APIResponse<string>>
updateFuturesFollowerTPSL()
updateFuturesFollowerTPSL(params: UpdateFuturesFollowerTPSLRequestV2): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | UpdateFuturesFollowerTPSLRequestV2 |
Returns
Promise<APIResponse<string>>
updateFuturesTraderGlobalSettings()
updateFuturesTraderGlobalSettings(params?: object): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params? | { enable?: "YES" | "NO"; showTotalEquity?: "YES" | "NO"; showTpsl?: "YES" | "NO"; } |
params.enable? | "YES" | "NO" |
params.showTotalEquity? | "YES" | "NO" |
params.showTpsl? | "YES" | "NO" |
Returns
Promise<APIResponse<string>>
updateFuturesTraderSymbolSettings()
updateFuturesTraderSymbolSettings(params: object): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | { settingList: FuturesTraderSymbolSettingRequestV2[]; } |
params.settingList | FuturesTraderSymbolSettingRequestV2[] |
Returns
Promise<APIResponse<string>>
updateLoanPledgeRate()
updateLoanPledgeRate(params: ModifyLoanPledgeRateRequestV2): Promise<APIResponse<{
afterPledgeRate: string;
loanCoin: string;
pledgeCoin: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | ModifyLoanPledgeRateRequestV2 |
Returns
Promise<APIResponse<{ afterPledgeRate: string; loanCoin: string; pledgeCoin: string; }>>
updateSpotFollowerSettings()
updateSpotFollowerSettings(params: object): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | { autoCopy?: "off" | "on"; mode?: "basic" | "advanced"; settings: SpotFollowerCopyTradeSettingV2[]; traderId: string; } |
params.autoCopy? | "off" | "on" |
params.mode? | "basic" | "advanced" |
params.settings | SpotFollowerCopyTradeSettingV2[] |
params.traderId | string |
Returns
Promise<APIResponse<string>>
updateSpotFollowerTPSL()
updateSpotFollowerTPSL(params: object): Promise<APIResponse<string>>;Parameters
| Parameter | Type |
|---|---|
params | { stopLossPrice?: string; stopSurplusPrice?: string; trackingNo: string; } |
params.stopLossPrice? | string |
params.stopSurplusPrice? | string |
params.trackingNo | string |
Returns
Promise<APIResponse<string>>
upgradeToUnifiedAccount()
upgradeToUnifiedAccount(params?: object): Promise<APIResponse<null>>;Upgrade Account - Upgrade to unified account mode No account type restrictions; both parent and sub-accounts are supported. This interface is only used for upgrading to the unified account mode. Please note that as the account upgrade 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 upgraded to a unified account. Please use the query upgrade status interface to confirm whether the account upgrade is successful.
Parameters
| Parameter | Type |
|---|---|
params? | { subUid?: string; } |
params.subUid? | string |
Returns
Promise<APIResponse<null>>