Skip to content

Class: RestClientV2 ​

REST client for Bitget Classic V2 APIs. For Unified Trading Account APIs, use RestClientV3.

Extends ​

  • default

Constructors ​

Constructor ​

ts
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 ​

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

Returns ​

RestClientV2

Inherited from ​

BaseRestClient.constructor

Methods ​

batchCreateVirtualSubaccountAndAPIKey() ​

ts
batchCreateVirtualSubaccountAndAPIKey(params: CreateVirtualSubRequestV2): Promise<APIResponse<CreateVirtualSubAccountAndApiKeyV2[]>>;

Parameters ​

ParameterType
paramsCreateVirtualSubRequestV2

Returns ​

Promise<APIResponse<CreateVirtualSubAccountAndApiKeyV2[]>>


borrowLoan() ​

ts
borrowLoan(params: BorrowLoanRequestV2): Promise<APIResponse<{
  orderId: string;
}>>;

Parameters ​

ParameterType
paramsBorrowLoanRequestV2

Returns ​

Promise<APIResponse<{ orderId: string; }>>


cancelSpotFollowerOrder() ​

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

Copy Trading | Spot copy trading | Follower api

Parameters ​

ParameterType
params{ trackingNoList: string[]; }
params.trackingNoListstring[]

Returns ​

Promise<APIResponse<string>>


closeFuturesFollowerPositions() ​

ts
closeFuturesFollowerPositions(params: CloseFuturesFollowerPositionsRequestV2): Promise<APIResponse<{
  orderIdList: string[];
}>>;

Parameters ​

ParameterType
paramsCloseFuturesFollowerPositionsRequestV2

Returns ​

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


closeFuturesTraderOrder() ​

ts
closeFuturesTraderOrder(params: object): Promise<APIResponse<object[]>>;

Parameters ​

ParameterType
params{ productType: CopyTradingProductTypeV2; symbol: string; trackingNo: string; }
params.productTypeCopyTradingProductTypeV2
params.symbolstring
params.trackingNostring

Returns ​

Promise<APIResponse<object[]>>


convert() ​

ts
convert(params: ConvertRequestV2): Promise<APIResponse<ConvertTradeResponseV2>>;

Parameters ​

ParameterType
paramsConvertRequestV2

Returns ​

Promise<APIResponse<ConvertTradeResponseV2>>


convertBGB() ​

ts
convertBGB(params: object): Promise<APIResponse<ConvertBGBResponseV2>>;

Parameters ​

ParameterType
params{ coinList: string; }
params.coinListstring

Returns ​

Promise<APIResponse<ConvertBGBResponseV2>>


createAgentSubaccount() ​

ts
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 ​

ParameterType
paramsCreateAgentSubaccountRequestV2

Returns ​

Promise<APIResponse<CreateAgentSubaccountV2>>


createSubaccount() ​

ts
createSubaccount(params: object): Promise<APIResponse<CreateSubaccountResponseV2>>;

Parameters ​

ParameterType
params{ label: string; subaccountName: string; }
params.labelstring
params.subaccountNamestring

Returns ​

Promise<APIResponse<CreateSubaccountResponseV2>>


createSubaccountApiKey() ​

ts
createSubaccountApiKey(params: CreateSubAccountApiKeyRequestV2): Promise<APIResponse<CreateSubaccountApiKeyResponseV2>>;

Broker | Api Key

Parameters ​

ParameterType
paramsCreateSubAccountApiKeyRequestV2

Returns ​

Promise<APIResponse<CreateSubaccountApiKeyResponseV2>>


createSubaccountDepositAddress() ​

ts
createSubaccountDepositAddress(params: object): Promise<APIResponse<CreateSubaccountDepositAddressV2>>;

Parameters ​

ParameterType
params{ chain?: string; coin: string; subUid: string; }
params.chain?string
params.coinstring
params.subUidstring

Returns ​

Promise<APIResponse<CreateSubaccountDepositAddressV2>>


createVirtualSubaccount() ​

ts
createVirtualSubaccount(params: object): Promise<APIResponse<CreateVirtualSubAccountV2>>;
  • Common | Virtual Subaccount

Parameters ​

ParameterType
params{ subAccountList: string[]; }
params.subAccountListstring[]

Returns ​

Promise<APIResponse<CreateVirtualSubAccountV2>>


createVirtualSubaccountAPIKey() ​

ts
createVirtualSubaccountAPIKey(params: CreateVirtualSubApiKeyRequestV2): Promise<APIResponse<CreateVirtualSubAccountApiKeyV2>>;

Parameters ​

ParameterType
paramsCreateVirtualSubApiKeyRequestV2

Returns ​

Promise<APIResponse<CreateVirtualSubAccountApiKeyV2>>


deletePrivate() ​

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

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.deletePrivate


deleteSubaccountApiKey() ​

ts
deleteSubaccountApiKey(params: DeleteSubAccountApiKeyRequestV2): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsDeleteSubAccountApiKeyRequestV2

Returns ​

Promise<APIResponse<string>>


earnRedeemSavings() ​

ts
earnRedeemSavings(params: RedeemSavingsRequestV2): Promise<APIResponse<{
  orderId: string;
  status: string;
}>>;

Parameters ​

ParameterType
paramsRedeemSavingsRequestV2

Returns ​

Promise<APIResponse<{ orderId: string; status: string; }>>


earnSubscribeSavings() ​

ts
earnSubscribeSavings(params: object): Promise<APIResponse<{
  orderId: string;
  status: string;
}>>;

Parameters ​

ParameterType
params{ amount: string; periodType: string; productId: string; }
params.amountstring
params.periodTypestring
params.productIdstring

Returns ​

Promise<APIResponse<{ orderId: string; status: string; }>>


fetchLatencySummary() ​

ts
fetchLatencySummary(): Promise<any>;

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

Returns ​

Promise<any>


fetchServerTime() ​

ts
fetchServerTime(): Promise<number>;

Returns ​

Promise<number>


futuresBatchCancelOrders() ​

ts
futuresBatchCancelOrders(params: FuturesBatchCancelOrderRequestV2): Promise<APIResponse<FuturesBatchOrderResponseV2>>;

Parameters ​

ParameterType
paramsFuturesBatchCancelOrderRequestV2

Returns ​

Promise<APIResponse<FuturesBatchOrderResponseV2>>


futuresBatchSubmitOrders() ​

ts
futuresBatchSubmitOrders(params: FuturesBatchOrderRequestV2): Promise<APIResponse<FuturesBatchOrderResponseV2>>;

Parameters ​

ParameterType
paramsFuturesBatchOrderRequestV2

Returns ​

Promise<APIResponse<FuturesBatchOrderResponseV2>>


futuresCancelAllOrders() ​

ts
futuresCancelAllOrders(params: FuturesCancelAllOrdersRequestV2): Promise<APIResponse<FuturesCancelAllOrdersV2>>;

Parameters ​

ParameterType
paramsFuturesCancelAllOrdersRequestV2

Returns ​

Promise<APIResponse<FuturesCancelAllOrdersV2>>


futuresCancelOrder() ​

ts
futuresCancelOrder(params: FuturesCancelOrderRequestV2): Promise<APIResponse<{
  clientOid: string;
  orderId: string;
}>>;

Parameters ​

ParameterType
paramsFuturesCancelOrderRequestV2

Returns ​

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


futuresCancelPlanOrder() ​

ts
futuresCancelPlanOrder(params: FuturesCancelPlanOrderRequestV2): Promise<APIResponse<FuturesCancelPlanOrderV2>>;

Parameters ​

ParameterType
paramsFuturesCancelPlanOrderRequestV2

Returns ​

Promise<APIResponse<FuturesCancelPlanOrderV2>>


futuresFlashClosePositions() ​

ts
futuresFlashClosePositions(params: FuturesFlashClosePositionsRequestV2): Promise<APIResponse<FuturesClosePositionResponseV2>>;

Parameters ​

ParameterType
paramsFuturesFlashClosePositionsRequestV2

Returns ​

Promise<APIResponse<FuturesClosePositionResponseV2>>


futuresModifyOrder() ​

ts
futuresModifyOrder(params: FuturesModifyOrderRequestV2): Promise<APIResponse<{
  clientOid: string;
  orderId: string;
}>>;

Parameters ​

ParameterType
paramsFuturesModifyOrderRequestV2

Returns ​

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


futuresModifyPlanOrder() ​

ts
futuresModifyPlanOrder(params: FuturesModifyPlanOrderRequestV2): Promise<APIResponse<{
  clientOid: string;
  orderId: string;
}>>;

Parameters ​

ParameterType
paramsFuturesModifyPlanOrderRequestV2

Returns ​

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


futuresModifyTPSLPOrder() ​

ts
futuresModifyTPSLPOrder(params: FuturesModifyTPSLOrderRequestV2): Promise<APIResponse<{
  clientOid: string;
  orderId: string;
}>>;

Parameters ​

ParameterType
paramsFuturesModifyTPSLOrderRequestV2

Returns ​

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


futuresSubmitOrder() ​

ts
futuresSubmitOrder(params: FuturesPlaceOrderRequestV2): Promise<APIResponse<{
  clientOid: string;
  orderId: string;
}>>;
  • Futures | Trade

Parameters ​

ParameterType
paramsFuturesPlaceOrderRequestV2

Returns ​

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


futuresSubmitPlanOrder() ​

ts
futuresSubmitPlanOrder(params: FuturesPlanOrderRequestV2): Promise<APIResponse<{
  clientOid: string;
  orderId: string;
}>>;

Parameters ​

ParameterType
paramsFuturesPlanOrderRequestV2

Returns ​

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


futuresSubmitPositionTPSL() ​

ts
futuresSubmitPositionTPSL(params: FuturesPositionTPSLOrderRequestV2): Promise<APIResponse<object[]>>;

Parameters ​

ParameterType
paramsFuturesPositionTPSLOrderRequestV2

Returns ​

Promise<APIResponse<object[]>>


futuresSubmitReversal() ​

ts
futuresSubmitReversal(params: FuturesReversalOrderRequestV2): Promise<APIResponse<{
  clientOid: string;
  orderId: string;
}>>;

Parameters ​

ParameterType
paramsFuturesReversalOrderRequestV2

Returns ​

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


futuresSubmitTPSLOrder() ​

ts
futuresSubmitTPSLOrder(params: FuturesTPSLOrderRequestV2): Promise<APIResponse<{
  clientOid: string;
  orderId: string;
}>>;

Parameters ​

ParameterType
paramsFuturesTPSLOrderRequestV2

Returns ​

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


get() ​

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

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.get


getAgentCommissionDetail() ​

ts
getAgentCommissionDetail(params?: GetAgentCommissionDetailRequestV2): Promise<APIResponse<AgentCommissionDetailV2>>;

Parameters ​

ParameterType
params?GetAgentCommissionDetailRequestV2

Returns ​

Promise<APIResponse<AgentCommissionDetailV2>>


getAgentCustomerAssets() ​

ts
getAgentCustomerAssets(params?: AgentCustomerAssetRequestV2): Promise<APIResponse<AgentCustomerAssetItemV2[]>>;

Parameters ​

ParameterType
params?AgentCustomerAssetRequestV2

Returns ​

Promise<APIResponse<AgentCustomerAssetItemV2[]>>


getAgentCustomerCommissions() ​

ts
getAgentCustomerCommissions(params?: GetAgentCustomerCommissionsRequestV2): Promise<APIResponse<AgentCustomerCommissionsV2>>;
  • Broker | Agent (affiliate) customer APIs

Parameters ​

ParameterType
params?GetAgentCustomerCommissionsRequestV2

Returns ​

Promise<APIResponse<AgentCustomerCommissionsV2>>


getAgentCustomerDeposits() ​

ts
getAgentCustomerDeposits(params?: AgentCustomerDepositRequestV2): Promise<APIResponse<AgentCustomerDepositItemV2[]>>;

Parameters ​

ParameterType
params?AgentCustomerDepositRequestV2

Returns ​

Promise<APIResponse<AgentCustomerDepositItemV2[]>>


getAgentCustomerKycResult() ​

ts
getAgentCustomerKycResult(params?: GetAgentCustomerKycResultRequestV2): Promise<APIResponse<AgentCustomerKycResultV2>>;

Parameters ​

ParameterType
params?GetAgentCustomerKycResultRequestV2

Returns ​

Promise<APIResponse<AgentCustomerKycResultV2>>


getAgentCustomerList() ​

ts
getAgentCustomerList(params?: AgentCustomerListRequestV2): Promise<APIResponse<AgentCustomerListItemV2[]>>;

Without startTime/endTime, returns all registered customers (no time restriction).

Parameters ​

ParameterType
params?AgentCustomerListRequestV2

Returns ​

Promise<APIResponse<AgentCustomerListItemV2[]>>


getAgentCustomerTradeVolume() ​

ts
getAgentCustomerTradeVolume(params?: AgentCustomerTradeVolumeRequestV2): Promise<APIResponse<AgentCustomerTradeVolumeItemV2[]>>;

Parameters ​

ParameterType
params?AgentCustomerTradeVolumeRequestV2

Returns ​

Promise<APIResponse<AgentCustomerTradeVolumeItemV2[]>>


getAgentSubCustomerList() ​

ts
getAgentSubCustomerList(params?: GetAgentSubCustomerListRequestV2): Promise<APIResponse<AgentSubCustomerListV2>>;

Without startTime/endTime, returns all registered sub-customers (no time restriction).

Parameters ​

ParameterType
params?GetAgentSubCustomerListRequestV2

Returns ​

Promise<APIResponse<AgentSubCustomerListV2>>


getAllSubDepositWithdrawalRecords() ​

ts
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 ​

ParameterType
params?GetAllSubDepositWithdrawalRequestV2

Returns ​

Promise<APIResponse<{ endId: string; list: AllSubDepositWithdrawalRecordV2[]; }>>


getAllTradeRates() ​

ts
getAllTradeRates(params: GetAllTradeRatesRequestV2): Promise<APIResponse<object[]>>;

Parameters ​

ParameterType
paramsGetAllTradeRatesRequestV2

Returns ​

Promise<APIResponse<object[]>>


getAnnouncements() ​

ts
getAnnouncements(params?: GetAnnouncementsRequestV2): Promise<APIResponse<AnnouncementV2[]>>;
  • Common | Notice

Parameters ​

ParameterType
params?GetAnnouncementsRequestV2

Returns ​

Promise<APIResponse<AnnouncementV2[]>>


getBalances() ​

ts
getBalances(): Promise<APIResponse<object[]>>;

Get assets overview

Returns ​

Promise<APIResponse<object[]>>


getBotAccount() ​

ts
getBotAccount(params?: object): Promise<APIResponse<BotAssetV2[]>>;

Parameters ​

ParameterType
params?{ accountType?: string; }
params.accountType?string

Returns ​

Promise<APIResponse<BotAssetV2[]>>


getBrokerCommissions() ​

ts
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 ​

ParameterType
params?GetBrokerCommissionsRequestV2

Returns ​

Promise<APIResponse<BrokerCommissionV2[]>>


getBrokerInfo() ​

ts
getBrokerInfo(): Promise<APIResponse<{
  maxSubAccountSize: string;
  subAccountSize: string;
  uTime: string;
}>>;

Returns ​

Promise<APIResponse<{ maxSubAccountSize: string; subAccountSize: string; uTime: string; }>>


getBrokerOrderCommission() ​

ts
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 ​

ParameterType
params?GetBrokerOrderCommissionRequestV2

Returns ​

Promise<APIResponse<BrokerOrderCommissionV2>>


getBrokerRebateInfo() ​

ts
getBrokerRebateInfo(params: GetBrokerRebateInfoRequestV2): Promise<APIResponse<BrokerRebateInfoV2>>;

Get Rebate Info

  • Rate limit: 20 req/sec/UID
  • Data retention: 30 days
  • Real-time data

Parameters ​

ParameterType
paramsGetBrokerRebateInfoRequestV2

Returns ​

Promise<APIResponse<BrokerRebateInfoV2>>


getBrokerSubaccounts() ​

ts
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 ​

ParameterType
params?GetBrokerSubaccountsRequestV2

Returns ​

Promise<APIResponse<BrokerSubaccountInfoV2[]>>


getBrokerTotalCommission() ​

ts
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 ​

ParameterType
params?GetBrokerTotalCommissionRequestV2

Returns ​

Promise<APIResponse<BrokerTotalCommissionV2[]>>


getBrokerTraders() ​

ts
getBrokerTraders(params: object): Promise<APIResponse<any>>;

Copy Trading | Future copy trading | Broker api

Parameters ​

ParameterType
paramsobject

Returns ​

Promise<APIResponse<any>>


getBrokerTradersHistoricalOrders() ​

ts
getBrokerTradersHistoricalOrders(params: object): Promise<APIResponse<any>>;

Parameters ​

ParameterType
paramsobject

Returns ​

Promise<APIResponse<any>>


getBrokerTradersPendingOrders() ​

ts
getBrokerTradersPendingOrders(params: object): Promise<APIResponse<any>>;

Parameters ​

ParameterType
paramsobject

Returns ​

Promise<APIResponse<any>>


getBrokerTradeVolume() ​

ts
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 ​

ParameterType
params?GetBrokerTradeVolumeRequestV2

Returns ​

Promise<APIResponse<BrokerTradeVolumeV2[]>>


getClientType() ​

ts
getClientType(): "v2";

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

Returns ​

"v2"

Overrides ​

BaseRestClient.getClientType


getConvertBGBCoins() ​

ts
getConvertBGBCoins(): Promise<APIResponse<{
  coinList: BGBConvertCoinV2[];
}>>;
  • Common | BGB Convert

Returns ​

Promise<APIResponse<{ coinList: BGBConvertCoinV2[]; }>>


getConvertBGBHistory() ​

ts
getConvertBGBHistory(params: GetConvertBGBHistoryRequestV2): Promise<APIResponse<BGBConvertHistoryV2[]>>;

Parameters ​

ParameterType
paramsGetConvertBGBHistoryRequestV2

Returns ​

Promise<APIResponse<BGBConvertHistoryV2[]>>


getConvertCoins() ​

ts
getConvertCoins(): Promise<APIResponse<ConvertCurrencyV2[]>>;
  • Common | Convert

Returns ​

Promise<APIResponse<ConvertCurrencyV2[]>>


getConvertHistory() ​

ts
getConvertHistory(params: GetConvertHistoryRequestV2): Promise<APIResponse<{
  dataList: ConvertRecordV2[];
  endId: string;
}>>;

Parameters ​

ParameterType
paramsGetConvertHistoryRequestV2

Returns ​

Promise<APIResponse<{ dataList: ConvertRecordV2[]; endId: string; }>>


getConvertQuotedPrice() ​

ts
getConvertQuotedPrice(params: ConvertQuoteRequestV2): Promise<APIResponse<ConvertQuotedPriceV2>>;

Parameters ​

ParameterType
paramsConvertQuoteRequestV2

Returns ​

Promise<APIResponse<ConvertQuotedPriceV2>>


getEarnAccount() ​

ts
getEarnAccount(params?: object): Promise<APIResponse<object[]>>;

Earn | Earn Account

Parameters ​

ParameterType
params?{ coin?: string; }
params.coin?string

Returns ​

Promise<APIResponse<object[]>>


getEarnEliteAssets() ​

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

Returns ​

Promise<APIResponse<EarnEliteAssetsV2>>


getEarnEliteProducts() ​

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

Earn | On-Chain Elite

Returns ​

Promise<APIResponse<EarnEliteProductV2[]>>


getEarnEliteRecords() ​

ts
getEarnEliteRecords(params: GetEarnEliteRecordsRequestV2): Promise<APIResponse<EarnEliteRecordsV2>>;

Parameters ​

ParameterType
paramsGetEarnEliteRecordsRequestV2

Returns ​

Promise<APIResponse<EarnEliteRecordsV2>>


getEarnEliteRedeemInfo() ​

ts
getEarnEliteRedeemInfo(params: GetEarnEliteRedeemInfoRequestV2): Promise<APIResponse<EarnEliteRedeemInfoV2>>;

Parameters ​

ParameterType
paramsGetEarnEliteRedeemInfoRequestV2

Returns ​

Promise<APIResponse<EarnEliteRedeemInfoV2>>


getEarnEliteSubscribeInfo() ​

ts
getEarnEliteSubscribeInfo(params: GetEarnEliteSubscribeInfoRequestV2): Promise<APIResponse<EarnEliteSubscribeInfoV2>>;

Parameters ​

ParameterType
paramsGetEarnEliteSubscribeInfoRequestV2

Returns ​

Promise<APIResponse<EarnEliteSubscribeInfoV2>>


getEarnEliteSubscribeResult() ​

ts
getEarnEliteSubscribeResult(params: GetEarnEliteSubscribeResultRequestV2): Promise<APIResponse<EarnEliteSubscribeStatusV2>>;

Parameters ​

ParameterType
paramsGetEarnEliteSubscribeResultRequestV2

Returns ​

Promise<APIResponse<EarnEliteSubscribeStatusV2>>


getEarnSavingsAccount() ​

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

Returns ​

Promise<APIResponse<EarnSavingsAccountV2>>


getEarnSavingsAssets() ​

ts
getEarnSavingsAssets(params: GetEarnSavingsAssetsRequestV2): Promise<APIResponse<EarnSavingsAssetsV2>>;

Parameters ​

ParameterType
paramsGetEarnSavingsAssetsRequestV2

Returns ​

Promise<APIResponse<EarnSavingsAssetsV2>>


getEarnSavingsProducts() ​

ts
getEarnSavingsProducts(params?: object): Promise<APIResponse<EarnSavingsProductsV2[]>>;

Earn | Savings

Parameters ​

ParameterType
params?{ coin?: string; filter?: string; }
params.coin?string
params.filter?string

Returns ​

Promise<APIResponse<EarnSavingsProductsV2[]>>


getEarnSavingsRecords() ​

ts
getEarnSavingsRecords(params: GetEarnSavingsRecordsRequestV2): Promise<APIResponse<EarnSavingsRecordsV2>>;

Parameters ​

ParameterType
paramsGetEarnSavingsRecordsRequestV2

Returns ​

Promise<APIResponse<EarnSavingsRecordsV2>>


getEarnSavingsRedemptionResult() ​

ts
getEarnSavingsRedemptionResult(params: object): Promise<APIResponse<{
  msg: string;
  result: "success" | "fail";
}>>;

Parameters ​

ParameterType
params{ orderId: string; periodType: string; }
params.orderIdstring
params.periodTypestring

Returns ​

Promise<APIResponse<{ msg: string; result: "success" | "fail"; }>>


getEarnSavingsSubscription() ​

ts
getEarnSavingsSubscription(params: object): Promise<APIResponse<EarnSavingsSubscriptionDetailV2>>;

Parameters ​

ParameterType
params{ periodType: string; productId: string; }
params.periodTypestring
params.productIdstring

Returns ​

Promise<APIResponse<EarnSavingsSubscriptionDetailV2>>


getEarnSavingsSubscriptionResult() ​

ts
getEarnSavingsSubscriptionResult(params: object): Promise<APIResponse<{
  msg: string;
  result: "success" | "fail";
}>>;

Parameters ​

ParameterType
params{ periodType: string; productId: string; }
params.periodTypestring
params.productIdstring

Returns ​

Promise<APIResponse<{ msg: string; result: "success" | "fail"; }>>


getFundingAssets() ​

ts
getFundingAssets(params?: object): Promise<APIResponse<FundingAssetV2[]>>;
  • Common | Assets

Parameters ​

ParameterType
params?{ coin?: string; }
params.coin?string

Returns ​

Promise<APIResponse<FundingAssetV2[]>>


getFuturesAccountAsset() ​

ts
getFuturesAccountAsset(params: FuturesSingleAccountRequestV2): Promise<APIResponse<FuturesAccountV2>>;
  • Futures | Account

Parameters ​

ParameterType
paramsFuturesSingleAccountRequestV2

Returns ​

Promise<APIResponse<FuturesAccountV2>>


getFuturesAccountAssets() ​

ts
getFuturesAccountAssets(params: object): Promise<APIResponse<FuturesAccountsV2[]>>;

Parameters ​

ParameterType
params{ productType: FuturesProductTypeV2; }
params.productTypeFuturesProductTypeV2

Returns ​

Promise<APIResponse<FuturesAccountsV2[]>>


getFuturesAccountBills() ​

ts
getFuturesAccountBills(params: FuturesAccountBillRequestV2): Promise<APIResponse<{
  bills: FuturesAccountBillV2[];
  endId: string;
}>>;

Parameters ​

ParameterType
paramsFuturesAccountBillRequestV2

Returns ​

Promise<APIResponse<{ bills: FuturesAccountBillV2[]; endId: string; }>>


getFuturesActiveBuySellVolumeData() ​

ts
getFuturesActiveBuySellVolumeData(params: object): Promise<APIResponse<FuturesLongShortRatioV2[]>>;

Parameters ​

ParameterType
params{ period?: string; symbol: string; }
params.period?string
params.symbolstring

Returns ​

Promise<APIResponse<FuturesLongShortRatioV2[]>>


getFuturesActiveLongShortAccountData() ​

ts
getFuturesActiveLongShortAccountData(params: object): Promise<APIResponse<FuturesActiveLongShortAccountV2[]>>;

Parameters ​

ParameterType
params{ period?: string; symbol: string; }
params.period?string
params.symbolstring

Returns ​

Promise<APIResponse<FuturesActiveLongShortAccountV2[]>>


getFuturesActiveLongShortPositionData() ​

ts
getFuturesActiveLongShortPositionData(params: object): Promise<APIResponse<FuturesActiveLongShortPositionV2[]>>;

Parameters ​

ParameterType
params{ period?: string; symbol: string; }
params.period?string
params.symbolstring

Returns ​

Promise<APIResponse<FuturesActiveLongShortPositionV2[]>>


getFuturesActiveTakerBuySellVolumeData() ​

ts
getFuturesActiveTakerBuySellVolumeData(params: object): Promise<APIResponse<FuturesActiveBuySellVolumeV2[]>>;

Parameters ​

ParameterType
params{ period?: string; symbol: string; }
params.period?string
params.symbolstring

Returns ​

Promise<APIResponse<FuturesActiveBuySellVolumeV2[]>>


getFuturesAllTickers() ​

ts
getFuturesAllTickers(params: object): Promise<APIResponse<FuturesTickerV2[]>>;

Parameters ​

ParameterType
params{ productType: FuturesProductTypeV2; }
params.productTypeFuturesProductTypeV2

Returns ​

Promise<APIResponse<FuturesTickerV2[]>>


getFuturesCandles() ​

ts
getFuturesCandles(params: FuturesCandlesRequestV2): Promise<APIResponse<FuturesCandlestickV2[]>>;

Parameters ​

ParameterType
paramsFuturesCandlesRequestV2

Returns ​

Promise<APIResponse<FuturesCandlestickV2[]>>


getFuturesContractConfig() ​

ts
getFuturesContractConfig(params: object): Promise<APIResponse<FuturesContractConfigV2[]>>;

Parameters ​

ParameterType
params{ productType: FuturesProductTypeV2; symbol?: string; }
params.productTypeFuturesProductTypeV2
params.symbol?string

Returns ​

Promise<APIResponse<FuturesContractConfigV2[]>>


getFuturesCurrentFundingRate() ​

ts
getFuturesCurrentFundingRate(params: object): Promise<APIResponse<object[]>>;

Parameters ​

ParameterType
params{ productType: FuturesProductTypeV2; symbol?: string; }
params.productTypeFuturesProductTypeV2
params.symbol?string

Returns ​

Promise<APIResponse<object[]>>


getFuturesDiscountRate() ​

ts
getFuturesDiscountRate(): Promise<APIResponse<FuturesDiscountRatesV2[]>>;

Returns ​

Promise<APIResponse<FuturesDiscountRatesV2[]>>


getFuturesFills() ​

ts
getFuturesFills(params: FuturesGetOrderFillsRequestV2): Promise<APIResponse<{
  endId: string;
  fillList: FuturesOrderFillV2[];
}>>;

Parameters ​

ParameterType
paramsFuturesGetOrderFillsRequestV2

Returns ​

Promise<APIResponse<{ endId: string; fillList: FuturesOrderFillV2[]; }>>


getFuturesFollowerCurrentOrders() ​

ts
getFuturesFollowerCurrentOrders(params: GetFollowerFuturesCurrentTrackingOrdersRequestV2): Promise<APIResponse<CTFuturesFollowerCurrentOrdersV2[]>>;

Copy Trading | Future copy trading | Follower Api

Parameters ​

ParameterType
paramsGetFollowerFuturesCurrentTrackingOrdersRequestV2

Returns ​

Promise<APIResponse<CTFuturesFollowerCurrentOrdersV2[]>>


getFuturesFollowerFollowLimit() ​

ts
getFuturesFollowerFollowLimit(params: object): Promise<APIResponse<object[]>>;

Parameters ​

ParameterType
params{ productType: CopyTradingProductTypeV2; symbol: string; }
params.productTypeCopyTradingProductTypeV2
params.symbolstring

Returns ​

Promise<APIResponse<object[]>>


getFuturesFollowerHistoryOrders() ​

ts
getFuturesFollowerHistoryOrders(params: GetFollowerFuturesHistoryTrackingOrdersRequestV2): Promise<APIResponse<CTFuturesFollowerHistoryOrdersV2>>;

Parameters ​

ParameterType
paramsGetFollowerFuturesHistoryTrackingOrdersRequestV2

Returns ​

Promise<APIResponse<CTFuturesFollowerHistoryOrdersV2>>


getFuturesFollowerSettings() ​

ts
getFuturesFollowerSettings(params: object): Promise<APIResponse<CTFuturesFollowerSettingsV2>>;

Parameters ​

ParameterType
params{ traderId: string; }
params.traderIdstring

Returns ​

Promise<APIResponse<CTFuturesFollowerSettingsV2>>


getFuturesFollowerTraders() ​

ts
getFuturesFollowerTraders(params: GetFuturesFollowerTradersRequestV2): Promise<APIResponse<CTFuturesFollowerMyTradersV2[]>>;

Parameters ​

ParameterType
paramsGetFuturesFollowerTradersRequestV2

Returns ​

Promise<APIResponse<CTFuturesFollowerMyTradersV2[]>>


getFuturesHistoricCandles() ​

ts
getFuturesHistoricCandles(params: FuturesCandlesRequestV2): Promise<APIResponse<FuturesCandlestickV2[]>>;

Parameters ​

ParameterType
paramsFuturesCandlesRequestV2

Returns ​

Promise<APIResponse<FuturesCandlestickV2[]>>


getFuturesHistoricFundingRates() ​

ts
getFuturesHistoricFundingRates(params: object): Promise<APIResponse<FuturesHistoricalFundingRateV2[]>>;

Parameters ​

ParameterType
params{ pageNo?: string; pageSize?: string; productType: FuturesProductTypeV2; symbol: string; }
params.pageNo?string
params.pageSize?string
params.productTypeFuturesProductTypeV2
params.symbolstring

Returns ​

Promise<APIResponse<FuturesHistoricalFundingRateV2[]>>


getFuturesHistoricIndexPriceCandles() ​

ts
getFuturesHistoricIndexPriceCandles(params: FuturesCandlesRequestV2): Promise<APIResponse<FuturesCandlestickV2[]>>;

Parameters ​

ParameterType
paramsFuturesCandlesRequestV2

Returns ​

Promise<APIResponse<FuturesCandlestickV2[]>>


getFuturesHistoricMarkPriceCandles() ​

ts
getFuturesHistoricMarkPriceCandles(params: FuturesCandlesRequestV2): Promise<APIResponse<FuturesCandlestickV2[]>>;

Parameters ​

ParameterType
paramsFuturesCandlesRequestV2

Returns ​

Promise<APIResponse<FuturesCandlestickV2[]>>


getFuturesHistoricOrderFills() ​

ts
getFuturesHistoricOrderFills(params: FuturesGetHistoricalFillsRequestV2): Promise<APIResponse<{
  endId: string;
  fillList: FuturesOrderFillV2[];
}>>;

Parameters ​

ParameterType
paramsFuturesGetHistoricalFillsRequestV2

Returns ​

Promise<APIResponse<{ endId: string; fillList: FuturesOrderFillV2[]; }>>


getFuturesHistoricOrders() ​

ts
getFuturesHistoricOrders(params: FuturesGetHistoryOrdersRequestV2): Promise<APIResponse<{
  endId: string;
  entrustedList: FuturesHistoryOrderV2[];
}>>;

Parameters ​

ParameterType
paramsFuturesGetHistoryOrdersRequestV2

Returns ​

Promise<APIResponse<{ endId: string; entrustedList: FuturesHistoryOrderV2[]; }>>


getFuturesHistoricPlanOrders() ​

ts
getFuturesHistoricPlanOrders(params: FuturesGetHistoryPlanOrdersRequestV2): Promise<APIResponse<{
  endId: string;
  entrustedList: FuturesHistoryPlanOrderV2[];
}>>;

Parameters ​

ParameterType
paramsFuturesGetHistoryPlanOrdersRequestV2

Returns ​

Promise<APIResponse<{ endId: string; entrustedList: FuturesHistoryPlanOrderV2[]; }>>


getFuturesHistoricPositions() ​

ts
getFuturesHistoricPositions(params?: FuturesHistoricalPositionsRequestV2): Promise<APIResponse<{
  endId: string;
  list: FuturesHistoryPositionV2[];
}>>;

Parameters ​

ParameterType
params?FuturesHistoricalPositionsRequestV2

Returns ​

Promise<APIResponse<{ endId: string; list: FuturesHistoryPositionV2[]; }>>


getFuturesHistoricTrades() ​

ts
getFuturesHistoricTrades(params: FuturesHistoricTradesRequestV2): Promise<APIResponse<FuturesFillV2[]>>;

Parameters ​

ParameterType
paramsFuturesHistoricTradesRequestV2

Returns ​

Promise<APIResponse<FuturesFillV2[]>>


getFuturesInterestExchangeRate() ​

ts
getFuturesInterestExchangeRate(): Promise<APIResponse<object[]>>;

Returns ​

Promise<APIResponse<object[]>>


getFuturesInterestHistory() ​

ts
getFuturesInterestHistory(params: FuturesInterestHistoryRequestV2): Promise<APIResponse<FuturesInterestHistoryV2[]>>;

Parameters ​

ParameterType
paramsFuturesInterestHistoryRequestV2

Returns ​

Promise<APIResponse<FuturesInterestHistoryV2[]>>


getFuturesInterestRateHistory() ​

ts
getFuturesInterestRateHistory(params: object): Promise<APIResponse<{
  coin: string;
  historyInterestRateList: FuturesHistoryInterestRateV2[];
}>>;

Parameters ​

ParameterType
params{ coin: string; }
params.coinstring

Returns ​

Promise<APIResponse<{ coin: string; historyInterestRateList: FuturesHistoryInterestRateV2[]; }>>


getFuturesIsolatedSymbols() ​

ts
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 ​

ParameterType
paramsFuturesIsolatedSymbolsRequestV2

Returns ​

Promise<APIResponse<FuturesIsolatedSymbolV2[]>>


getFuturesLiquidationPrice() ​

ts
getFuturesLiquidationPrice(params: FuturesLiquidationPriceRequestV2): Promise<APIResponse<FuturesLiquidationPriceV2>>;

Get Liquidation Price

  • Rate limit: 20 req/sec/UID
  • Get Liquidation Price

Parameters ​

ParameterType
paramsFuturesLiquidationPriceRequestV2

Returns ​

Promise<APIResponse<FuturesLiquidationPriceV2>>


getFuturesLongShortRatio() ​

ts
getFuturesLongShortRatio(params: object): Promise<APIResponse<LeveragedLongShortRatioV2[]>>;

Parameters ​

ParameterType
params{ coin?: string; period?: string; symbol: string; }
params.coin?string
params.period?string
params.symbolstring

Returns ​

Promise<APIResponse<LeveragedLongShortRatioV2[]>>


getFuturesMaxOpenableQuantity() ​

ts
getFuturesMaxOpenableQuantity(params: FuturesMaxOpenRequestV2): Promise<APIResponse<FuturesMaxOpenV2>>;

Get Max Openable Quantity

  • Rate limit: 20 req/sec/UID
  • Get Max Openable Quantity

Parameters ​

ParameterType
paramsFuturesMaxOpenRequestV2

Returns ​

Promise<APIResponse<FuturesMaxOpenV2>>


getFuturesMergeDepth() ​

ts
getFuturesMergeDepth(params: FuturesMergeDepthRequestV2): Promise<APIResponse<FuturesMergeDepthV2>>;

Parameters ​

ParameterType
paramsFuturesMergeDepthRequestV2

Returns ​

Promise<APIResponse<FuturesMergeDepthV2>>


getFuturesNextFundingTime() ​

ts
getFuturesNextFundingTime(params: object): Promise<APIResponse<FuturesFundingTimeV2[]>>;

Parameters ​

ParameterType
params{ productType: FuturesProductTypeV2; symbol: string; }
params.productTypeFuturesProductTypeV2
params.symbolstring

Returns ​

Promise<APIResponse<FuturesFundingTimeV2[]>>


getFuturesOiLimit() ​

ts
getFuturesOiLimit(params: FuturesOiLimitRequestV2): Promise<APIResponse<object[]>>;

Parameters ​

ParameterType
paramsFuturesOiLimitRequestV2

Returns ​

Promise<APIResponse<object[]>>


getFuturesOpenCount() ​

ts
getFuturesOpenCount(params: FuturesOpenCountRequestV2): Promise<APIResponse<{
  size: string;
}>>;

Parameters ​

ParameterType
paramsFuturesOpenCountRequestV2

Returns ​

Promise<APIResponse<{ size: string; }>>


getFuturesOpenInterest() ​

ts
getFuturesOpenInterest(params: object): Promise<APIResponse<{
  openInterestList: FuturesOpenInterestV2[];
  ts: string;
}>>;

Parameters ​

ParameterType
params{ productType: FuturesProductTypeV2; symbol: string; }
params.productTypeFuturesProductTypeV2
params.symbolstring

Returns ​

Promise<APIResponse<{ openInterestList: FuturesOpenInterestV2[]; ts: string; }>>


getFuturesOpenOrders() ​

ts
getFuturesOpenOrders(params: FuturesGetOpenOrdersRequestV2): Promise<APIResponse<{
  endId: string;
  entrustedList: FuturesOpenOrderV2[] | null;
}>>;

Parameters ​

ParameterType
paramsFuturesGetOpenOrdersRequestV2

Returns ​

Promise<APIResponse<{ endId: string; entrustedList: FuturesOpenOrderV2[] | null; }>>


getFuturesOrder() ​

ts
getFuturesOrder(params: FuturesGetOrderRequestV2): Promise<APIResponse<FuturesOrderDetailV2>>;

Parameters ​

ParameterType
paramsFuturesGetOrderRequestV2

Returns ​

Promise<APIResponse<FuturesOrderDetailV2>>


getFuturesPlanOrders() ​

ts
getFuturesPlanOrders(params: FuturesGetPlanOrdersRequestV2): Promise<APIResponse<{
  endId: string;
  entrustedList:   | FuturesPendingPlanOrderV2[]
     | null;
}>>;

Parameters ​

ParameterType
paramsFuturesGetPlanOrdersRequestV2

Returns ​

Promise<APIResponse<{ endId: string; entrustedList: | FuturesPendingPlanOrderV2[] | null; }>>


getFuturesPosition() ​

ts
getFuturesPosition(params: object): Promise<APIResponse<FuturesPositionV2[]>>;

Parameters ​

ParameterType
params{ marginCoin: string; productType: FuturesProductTypeV2; symbol: string; }
params.marginCoinstring
params.productTypeFuturesProductTypeV2
params.symbolstring

Returns ​

Promise<APIResponse<FuturesPositionV2[]>>


getFuturesPositionAdlRank() ​

ts
getFuturesPositionAdlRank(params: FuturesPositionAdlRankRequestV2): Promise<APIResponse<FuturesPositionAdlRankV2[]>>;

Parameters ​

ParameterType
paramsFuturesPositionAdlRankRequestV2

Returns ​

Promise<APIResponse<FuturesPositionAdlRankV2[]>>


getFuturesPositions() ​

ts
getFuturesPositions(params: object): Promise<APIResponse<FuturesPositionV2[]>>;

Parameters ​

ParameterType
params{ marginCoin?: string; productType: FuturesProductTypeV2; }
params.marginCoin?string
params.productTypeFuturesProductTypeV2

Returns ​

Promise<APIResponse<FuturesPositionV2[]>>


getFuturesPositionTier() ​

ts
getFuturesPositionTier(params: object): Promise<APIResponse<FuturesPositionTierV2[]>>;
  • Futures | Position

Parameters ​

ParameterType
params{ productType: FuturesProductTypeV2; symbol: string; }
params.productTypeFuturesProductTypeV2
params.symbolstring

Returns ​

Promise<APIResponse<FuturesPositionTierV2[]>>


getFuturesRecentTrades() ​

ts
getFuturesRecentTrades(params: FuturesRecentTradesRequestV2): Promise<APIResponse<FuturesFillV2[]>>;

Parameters ​

ParameterType
paramsFuturesRecentTradesRequestV2

Returns ​

Promise<APIResponse<FuturesFillV2[]>>


getFuturesSubAccountAssets() ​

ts
getFuturesSubAccountAssets(params: object): Promise<APIResponse<object[]>>;

Parameters ​

ParameterType
params{ productType: FuturesProductTypeV2; }
params.productTypeFuturesProductTypeV2

Returns ​

Promise<APIResponse<object[]>>


getFuturesSymbolPrice() ​

ts
getFuturesSymbolPrice(params: object): Promise<APIResponse<FuturesSymbolPriceV2[]>>;

Parameters ​

ParameterType
params{ productType: FuturesProductTypeV2; symbol: string; }
params.productTypeFuturesProductTypeV2
params.symbolstring

Returns ​

Promise<APIResponse<FuturesSymbolPriceV2[]>>


getFuturesTicker() ​

ts
getFuturesTicker(params: object): Promise<APIResponse<FuturesTickerV2[]>>;

Parameters ​

ParameterType
params{ productType: FuturesProductTypeV2; symbol: string; }
params.productTypeFuturesProductTypeV2
params.symbolstring

Returns ​

Promise<APIResponse<FuturesTickerV2[]>>


getFuturesTraderCurrentOrder() ​

ts
getFuturesTraderCurrentOrder(params: GetFuturesTraderCurrentOrdersRequestV2): Promise<APIResponse<CTFuturesTraderCurrentOrdersV2>>;

Copy Trading | Future copy trading | Trader Api

Parameters ​

ParameterType
paramsGetFuturesTraderCurrentOrdersRequestV2

Returns ​

Promise<APIResponse<CTFuturesTraderCurrentOrdersV2>>


getFuturesTraderFollowers() ​

ts
getFuturesTraderFollowers(params?: GetFuturesTraderFollowersRequestV2): Promise<APIResponse<CTFuturesTraderMyFollowersV2[]>>;

Parameters ​

ParameterType
params?GetFuturesTraderFollowersRequestV2

Returns ​

Promise<APIResponse<CTFuturesTraderMyFollowersV2[]>>


getFuturesTraderHistoryOrders() ​

ts
getFuturesTraderHistoryOrders(params: GetFuturesTraderHistoryOrdersRequestV2): Promise<APIResponse<CTFuturesTraderHistoryOrderV2>>;

Parameters ​

ParameterType
paramsGetFuturesTraderHistoryOrdersRequestV2

Returns ​

Promise<APIResponse<CTFuturesTraderHistoryOrderV2>>


getFuturesTraderOrder() ​

ts
getFuturesTraderOrder(): Promise<APIResponse<CTFuturesTraderTotalOrderSummaryV2>>;

Returns ​

Promise<APIResponse<CTFuturesTraderTotalOrderSummaryV2>>


getFuturesTraderProfitHistory() ​

ts
getFuturesTraderProfitHistory(): Promise<APIResponse<CTFuturesTraderHistoryProfitSummaryV2>>;

Returns ​

Promise<APIResponse<CTFuturesTraderHistoryProfitSummaryV2>>


getFuturesTraderProfitShare() ​

ts
getFuturesTraderProfitShare(params?: object): Promise<APIResponse<object[]>>;

Parameters ​

ParameterType
params?{ coin?: string; pageNo?: string; pageSize?: string; }
params.coin?string
params.pageNo?string
params.pageSize?string

Returns ​

Promise<APIResponse<object[]>>


getFuturesTraderProfitShareGroup() ​

ts
getFuturesTraderProfitShareGroup(params?: object): Promise<APIResponse<object[]>>;

Parameters ​

ParameterType
params?{ pageNo?: string; pageSize?: string; }
params.pageNo?string
params.pageSize?string

Returns ​

Promise<APIResponse<object[]>>


getFuturesTraderProfitShareHistory() ​

ts
getFuturesTraderProfitShareHistory(params: GetFuturesTraderProfitShareDetailRequestV2): Promise<APIResponse<CTFuturesTraderProfitShareHistoryV2>>;

Parameters ​

ParameterType
paramsGetFuturesTraderProfitShareDetailRequestV2

Returns ​

Promise<APIResponse<CTFuturesTraderProfitShareHistoryV2>>


getFuturesTraderSymbolSettings() ​

ts
getFuturesTraderSymbolSettings(params: object): Promise<APIResponse<CTFuturesTraderSymbolSettingsV2[]>>;

Parameters ​

ParameterType
params{ productType: CopyTradingProductTypeV2; }
params.productTypeCopyTradingProductTypeV2

Returns ​

Promise<APIResponse<CTFuturesTraderSymbolSettingsV2[]>>


getFuturesTransactionRecords() ​

ts
getFuturesTransactionRecords(params: GetFuturesTransactionsRequestV2): Promise<APIResponse<FuturesTransactionRecordV2[]>>;

Parameters ​

ParameterType
paramsGetFuturesTransactionsRequestV2

Returns ​

Promise<APIResponse<FuturesTransactionRecordV2[]>>


getFuturesTriggerSubOrder() ​

ts
getFuturesTriggerSubOrder(params: object): Promise<APIResponse<FuturesTriggerSubOrderV2[]>>;
  • Futures | Trigger Orders

Parameters ​

ParameterType
params{ planOrderId: string; planType: "normal_plan" | "track_plan"; productType: FuturesProductTypeV2; }
params.planOrderIdstring
params.planType"normal_plan" | "track_plan"
params.productTypeFuturesProductTypeV2

Returns ​

Promise<APIResponse<FuturesTriggerSubOrderV2[]>>


getFuturesVIPFeeRate() ​

ts
getFuturesVIPFeeRate(): Promise<APIResponse<FuturesVipFeeRateV2[]>>;
  • Futures | Market

Returns ​

Promise<APIResponse<FuturesVipFeeRateV2[]>>


getIsolatedMarginBorrowingRatio() ​

ts
getIsolatedMarginBorrowingRatio(params: object): Promise<APIResponse<IsolatedMarginBorrowingRatioV2[]>>;

Parameters ​

ParameterType
params{ period?: string; symbol: string; }
params.period?string
params.symbolstring

Returns ​

Promise<APIResponse<IsolatedMarginBorrowingRatioV2[]>>


getLoanCurrencies() ​

ts
getLoanCurrencies(params?: object): Promise<APIResponse<EarnLoanCurrenciesV2>>;

Earn | Loan

Parameters ​

ParameterType
params?{ coin?: string; }
params.coin?string

Returns ​

Promise<APIResponse<EarnLoanCurrenciesV2>>


getLoanDebts() ​

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

Returns ​

Promise<APIResponse<EarnLoanDebtsV2>>


getLoanEstInterestAndBorrowable() ​

ts
getLoanEstInterestAndBorrowable(params: GetLoanEstInterestAndBorrowableRequestV2): Promise<APIResponse<{
  hourInterest: string;
  loanAmount: string;
}>>;

Parameters ​

ParameterType
paramsGetLoanEstInterestAndBorrowableRequestV2

Returns ​

Promise<APIResponse<{ hourInterest: string; loanAmount: string; }>>


getLoanHistory() ​

ts
getLoanHistory(params: GetLoanHistoryRequestV2): Promise<APIResponse<EarnLoanHistoryV2[]>>;

Parameters ​

ParameterType
paramsGetLoanHistoryRequestV2

Returns ​

Promise<APIResponse<EarnLoanHistoryV2[]>>


getLoanLiquidationRecords() ​

ts
getLoanLiquidationRecords(params: GetLiquidationRecordsRequestV2): Promise<APIResponse<EarnLoanLiquidationRecordsV2[]>>;

Parameters ​

ParameterType
paramsGetLiquidationRecordsRequestV2

Returns ​

Promise<APIResponse<EarnLoanLiquidationRecordsV2[]>>


getLoanLTVConvert() ​

ts
getLoanLTVConvert(params?: GetInstLoanLTVConvertRequestV2): Promise<APIResponse<InstLoanLTVConvertV2>>;

Parameters ​

ParameterType
params?GetInstLoanLTVConvertRequestV2

Returns ​

Promise<APIResponse<InstLoanLTVConvertV2>>


getLoanMarginCoinInfo() ​

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

Parameters ​

ParameterType
paramsGetInstLoanMarginCoinInfoRequestV2

Returns ​

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


getLoanOrder() ​

ts
getLoanOrder(params?: GetInstLoanOrderRequestV2): Promise<APIResponse<InstLoanOrderV2[]>>;

Parameters ​

ParameterType
params?GetInstLoanOrderRequestV2

Returns ​

Promise<APIResponse<InstLoanOrderV2[]>>


getLoanPledgeRateHistory() ​

ts
getLoanPledgeRateHistory(params: GetLoanPledgeRateHistoryRequestV2): Promise<APIResponse<EarnLoanPledgeRateHistoryV2[]>>;

Parameters ​

ParameterType
paramsGetLoanPledgeRateHistoryRequestV2

Returns ​

Promise<APIResponse<EarnLoanPledgeRateHistoryV2[]>>


getLoanProductInfo() ​

ts
getLoanProductInfo(params: GetInstLoanProductInfoRequestV2): Promise<APIResponse<InstLoanProductInfoV2>>;
  • Inst Loan | Product Info

Parameters ​

ParameterType
paramsGetInstLoanProductInfoRequestV2

Returns ​

Promise<APIResponse<InstLoanProductInfoV2>>


getLoanRepaidHistory() ​

ts
getLoanRepaidHistory(params?: GetInstLoanRepaidHistoryRequestV2): Promise<APIResponse<InstLoanRepaidHistoryItemV2[]>>;
  • Inst Loan | Orders

Parameters ​

ParameterType
params?GetInstLoanRepaidHistoryRequestV2

Returns ​

Promise<APIResponse<InstLoanRepaidHistoryItemV2[]>>


getLoanRiskUnit() ​

ts
getLoanRiskUnit(): Promise<APIResponse<{
  riskUnitId: string[];
}>>;
  • Inst Loan | Account

Returns ​

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


getLoanSymbols() ​

ts
getLoanSymbols(params: GetInstLoanSymbolsRequestV2): Promise<APIResponse<InstLoanSymbolsV2>>;

Parameters ​

ParameterType
paramsGetInstLoanSymbolsRequestV2

Returns ​

Promise<APIResponse<InstLoanSymbolsV2>>


getMarginAccountAssets() ​

ts
getMarginAccountAssets(marginType: MarginType, params?: object): Promise<APIResponse<MarginAccountAssetV2[]>>;
  • Margin | Cross/Isolated | Account

Parameters ​

ParameterType
marginTypeMarginType
params?{ coin?: string; }
params.coin?string

Returns ​

Promise<APIResponse<MarginAccountAssetV2[]>>


getMarginBorrowHistory() ​

ts
getMarginBorrowHistory(marginType: MarginType, params: GetBorrowHistoryRequestV2): Promise<APIResponse<{
  maxId: string;
  minId: string;
  resultList: MarginBorrowHistoryItemV2[];
}>>;
  • Margin | Cross/Isolated | Order Record

Parameters ​

ParameterType
marginTypeMarginType
paramsGetBorrowHistoryRequestV2

Returns ​

Promise<APIResponse<{ maxId: string; minId: string; resultList: MarginBorrowHistoryItemV2[]; }>>


getMarginCurrencies() ​

ts
getMarginCurrencies(): Promise<APIResponse<MarginCurrencyV2[]>>;
  • Margin | Common

Returns ​

Promise<APIResponse<MarginCurrencyV2[]>>


getMarginFinancialHistory() ​

ts
getMarginFinancialHistory(marginType: MarginType, params: GetFinancialHistoryRequestV2): Promise<APIResponse<{
  maxId: string;
  minId: string;
  resultList: MarginFinancialHistoryItemV2[];
}>>;

Parameters ​

ParameterType
marginTypeMarginType
paramsGetFinancialHistoryRequestV2

Returns ​

Promise<APIResponse<{ maxId: string; minId: string; resultList: MarginFinancialHistoryItemV2[]; }>>


getMarginFlashRepayResult() ​

ts
getMarginFlashRepayResult(marginType: MarginType, params: object): Promise<APIResponse<object[]>>;

Parameters ​

ParameterType
marginTypeMarginType
params{ idList: string; }
params.idListstring

Returns ​

Promise<APIResponse<object[]>>


getMarginHistoricOrderFills() ​

ts
getMarginHistoricOrderFills(marginType: MarginType, params: GetMarginOrderFillsRequestV2): Promise<APIResponse<{
  fills: MarginOrderFillV2[];
  maxId: string;
  minId: string;
}>>;

Parameters ​

ParameterType
marginTypeMarginType
paramsGetMarginOrderFillsRequestV2

Returns ​

Promise<APIResponse<{ fills: MarginOrderFillV2[]; maxId: string; minId: string; }>>


getMarginHistoricOrders() ​

ts
getMarginHistoricOrders(marginType: MarginType, params: GetHistoryOrdersRequestV2): Promise<APIResponse<{
  maxId: string;
  minId: string;
  orderList: MarginHistoryOrderV2[];
}>>;

Parameters ​

ParameterType
marginTypeMarginType
paramsGetHistoryOrdersRequestV2

Returns ​

Promise<APIResponse<{ maxId: string; minId: string; orderList: MarginHistoryOrderV2[]; }>>


getMarginInterestHistory() ​

ts
getMarginInterestHistory(marginType: MarginType, params: GetInterestHistoryRequestV2): Promise<APIResponse<{
  maxId: string;
  minId: string;
  resultList: MarginInterestHistoryItemV2[];
}>>;

Parameters ​

ParameterType
marginTypeMarginType
paramsGetInterestHistoryRequestV2

Returns ​

Promise<APIResponse<{ maxId: string; minId: string; resultList: MarginInterestHistoryItemV2[]; }>>


getMarginInterestRateAndMaxBorrowable() ​

ts
getMarginInterestRateAndMaxBorrowable(marginType: MarginType, params: object): Promise<APIResponse<
  | IsolatedInterestRateAndLimitResponseV2[]
| CrossInterestRateAndLimitResponseV2[]>>;

Parameters ​

ParameterType
marginTypeMarginType
params{ coin: string; }
params.coinstring

Returns ​

Promise<APIResponse< | IsolatedInterestRateAndLimitResponseV2[] | CrossInterestRateAndLimitResponseV2[]>>


getMarginLiquidationHistory() ​

ts
getMarginLiquidationHistory(marginType: MarginType, params: GetLiquidationHistoryRequestV2): Promise<APIResponse<{
  maxId: string;
  minId: string;
  resultList: MarginLiquidationHistoryItemV2[];
}>>;

Parameters ​

ParameterType
marginTypeMarginType
paramsGetLiquidationHistoryRequestV2

Returns ​

Promise<APIResponse<{ maxId: string; minId: string; resultList: MarginLiquidationHistoryItemV2[]; }>>


getMarginLiquidationOrders() ​

ts
getMarginLiquidationOrders(marginType: MarginType, params: GetMarginLiquidationOrdersRequestV2): Promise<APIResponse<{
  idLessThan: string;
  resultList: MarginLiquidationOrderV2[];
}>>;

Parameters ​

ParameterType
marginTypeMarginType
paramsGetMarginLiquidationOrdersRequestV2

Returns ​

Promise<APIResponse<{ idLessThan: string; resultList: MarginLiquidationOrderV2[]; }>>


getMarginLoanGrowthRate() ​

ts
getMarginLoanGrowthRate(params: object): Promise<APIResponse<MarginLoanGrowthRateV2[]>>;

Parameters ​

ParameterType
params{ coin?: string; period?: string; symbol: string; }
params.coin?string
params.period?string
params.symbolstring

Returns ​

Promise<APIResponse<MarginLoanGrowthRateV2[]>>


getMarginMaxBorrowable() ​

ts
getMarginMaxBorrowable(marginType: MarginType, params: object): Promise<APIResponse<
  | CrossMaxBorrowableResponseV2
| IsolatedMaxBorrowableResponseV2>>;

Parameters ​

ParameterType
marginTypeMarginType
params{ coin: string; }
params.coinstring

Returns ​

Promise<APIResponse< | CrossMaxBorrowableResponseV2 | IsolatedMaxBorrowableResponseV2>>


getMarginMaxTransferable() ​

ts
getMarginMaxTransferable(marginType: MarginType, params: object): Promise<APIResponse<
  | CrossMaxTransferableResponseV2
| IsolatedMaxTransferableResponseV2>>;

Parameters ​

ParameterType
marginTypeMarginType
params{ coin: string; }
params.coinstring

Returns ​

Promise<APIResponse< | CrossMaxTransferableResponseV2 | IsolatedMaxTransferableResponseV2>>


getMarginOpenOrders() ​

ts
getMarginOpenOrders(marginType: MarginType, params: GetMarginCurrentOrdersRequestV2): Promise<APIResponse<{
  maxId: string;
  minId: string;
  orderList: MarginCurrentOrderV2[];
}>>;

Parameters ​

ParameterType
marginTypeMarginType
paramsGetMarginCurrentOrdersRequestV2

Returns ​

Promise<APIResponse<{ maxId: string; minId: string; orderList: MarginCurrentOrderV2[]; }>>


getMarginRepayHistory() ​

ts
getMarginRepayHistory(marginType: MarginType, params: GetRepayHistoryRequestV2): Promise<APIResponse<{
  maxId: string;
  minId: string;
  resultList: MarginRepaymentHistoryItemV2[];
}>>;

Parameters ​

ParameterType
marginTypeMarginType
paramsGetRepayHistoryRequestV2

Returns ​

Promise<APIResponse<{ maxId: string; minId: string; resultList: MarginRepaymentHistoryItemV2[]; }>>


getMarginRiskRate() ​

ts
getMarginRiskRate(marginType: MarginType): Promise<APIResponse<object[]>>;

Parameters ​

ParameterType
marginTypeMarginType

Returns ​

Promise<APIResponse<object[]>>


getMarginTierConfiguration() ​

ts
getMarginTierConfiguration(marginType: MarginType, params: object): Promise<APIResponse<
  | CrossTierConfigurationResponseV2[]
| IsolatedTierConfigurationResponseV2[]>>;

Parameters ​

ParameterType
marginTypeMarginType
params{ coin: string; }
params.coinstring

Returns ​

Promise<APIResponse< | CrossTierConfigurationResponseV2[] | IsolatedTierConfigurationResponseV2[]>>


getMarginTransactionRecords() ​

ts
getMarginTransactionRecords(params: GetMarginTransactionsRequestV2): Promise<APIResponse<MarginTransactionRecordV2[]>>;

Parameters ​

ParameterType
paramsGetMarginTransactionsRequestV2

Returns ​

Promise<APIResponse<MarginTransactionRecordV2[]>>


getOngoingLoanOrders() ​

ts
getOngoingLoanOrders(params?: object): Promise<APIResponse<EarnLoanOrdersV2[]>>;

Parameters ​

ParameterType
params?{ loanCoin?: string; orderId?: string; pledgeCoin?: string; }
params.loanCoin?string
params.orderId?string
params.pledgeCoin?string

Returns ​

Promise<APIResponse<EarnLoanOrdersV2[]>>


getP2PMerchantAdvertisementList() ​

ts
getP2PMerchantAdvertisementList(params: GetMerchantAdvertisementsRequestV2): Promise<APIResponse<{
  advList: P2PMerchantAdvertismentV2[];
  minAdvId: string;
}>>;

Parameters ​

ParameterType
paramsGetMerchantAdvertisementsRequestV2

Returns ​

Promise<APIResponse<{ advList: P2PMerchantAdvertismentV2[]; minAdvId: string; }>>


getP2PMerchantInfo() ​

ts
getP2PMerchantInfo(): Promise<APIResponse<P2PMerchantInfoV2>>;

Returns ​

Promise<APIResponse<P2PMerchantInfoV2>>


getP2PMerchantList() ​

ts
getP2PMerchantList(params?: GetP2PMerchantsRequestV2): Promise<APIResponse<{
  merchantList: P2PMerchantV2[];
  minMerchantId: string;
}>>;
  • Common | P2P

Parameters ​

ParameterType
params?GetP2PMerchantsRequestV2

Returns ​

Promise<APIResponse<{ merchantList: P2PMerchantV2[]; minMerchantId: string; }>>


getP2PMerchantOrders() ​

ts
getP2PMerchantOrders(params: GetMerchantP2POrdersRequestV2): Promise<APIResponse<{
  minOrderId: string;
  orderList: P2PMerchantOrderV2[];
}>>;

Parameters ​

ParameterType
paramsGetMerchantP2POrdersRequestV2

Returns ​

Promise<APIResponse<{ minOrderId: string; orderList: P2PMerchantOrderV2[]; }>>


getP2PTransactionRecords() ​

ts
getP2PTransactionRecords(params: GetP2PTransactionsRequestV2): Promise<APIResponse<P2PMerchantOrdersV2[]>>;

Parameters ​

ParameterType
paramsGetP2PTransactionsRequestV2

Returns ​

Promise<APIResponse<P2PMerchantOrdersV2[]>>


getPrivate() ​

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

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.getPrivate


getRepayHistory() ​

ts
getRepayHistory(params: GetLoanRepayHistoryRequestV2): Promise<APIResponse<EarnLoanRepayHistoryV2>>;

Parameters ​

ParameterType
paramsGetLoanRepayHistoryRequestV2

Returns ​

Promise<APIResponse<EarnLoanRepayHistoryV2>>


getServerTime() ​

ts
getServerTime(): Promise<APIResponse<{
  serverTime: string;
}>>;
  • Common | Public

Returns ​

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


getSharkfinAccount() ​

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

Returns ​

Promise<APIResponse<EarnSharkfinAccountV2>>


getSharkfinAssets() ​

ts
getSharkfinAssets(params: GetSharkfinAssetsRequestV2): Promise<APIResponse<EarnSharkfinAssetsV2>>;

Parameters ​

ParameterType
paramsGetSharkfinAssetsRequestV2

Returns ​

Promise<APIResponse<EarnSharkfinAssetsV2>>


getSharkfinProducts() ​

ts
getSharkfinProducts(params: object): Promise<APIResponse<EarnSharkfinProductsV2>>;

Earn | Shark Fin

Parameters ​

ParameterType
params{ coin: string; idLessThan?: string; limit?: string; }
params.coinstring
params.idLessThan?string
params.limit?string

Returns ​

Promise<APIResponse<EarnSharkfinProductsV2>>


getSharkfinRecords() ​

ts
getSharkfinRecords(params: GetSharkfinRecordsRequestV2): Promise<APIResponse<EarnSharkfinRecordsV2>>;

Parameters ​

ParameterType
paramsGetSharkfinRecordsRequestV2

Returns ​

Promise<APIResponse<EarnSharkfinRecordsV2>>


getSharkfinSubscription() ​

ts
getSharkfinSubscription(params: object): Promise<APIResponse<EarnSharkfinSubscriptionDetailV2>>;

Parameters ​

ParameterType
params{ productId: string; }
params.productIdstring

Returns ​

Promise<APIResponse<EarnSharkfinSubscriptionDetailV2>>


getSharkfinSubscriptionResult() ​

ts
getSharkfinSubscriptionResult(params: object): Promise<APIResponse<{
  msg: string;
  result: "success" | "fail";
}>>;

Parameters ​

ParameterType
params{ orderId: string; }
params.orderIdstring

Returns ​

Promise<APIResponse<{ msg: string; result: "success" | "fail"; }>>


getSpotAccount() ​

ts
getSpotAccount(): Promise<APIResponse<SpotAccountInfoV2>>;
  • Spot | Account

Returns ​

Promise<APIResponse<SpotAccountInfoV2>>


getSpotAccountAssets() ​

ts
getSpotAccountAssets(params?: object): Promise<APIResponse<SpotAccountAssetV2[]>>;

Parameters ​

ParameterType
params?{ assetType?: string; coin?: string; }
params.assetType?string
params.coin?string

Returns ​

Promise<APIResponse<SpotAccountAssetV2[]>>

See ​

Read Classic Spot balances


getSpotAccountBills() ​

ts
getSpotAccountBills(params?: GetSpotAccountBillsRequestV2): Promise<APIResponse<SpotAccountBillV2[]>>;

Parameters ​

ParameterType
params?GetSpotAccountBillsRequestV2

Returns ​

Promise<APIResponse<SpotAccountBillV2[]>>


getSpotBGBDeductInfo() ​

ts
getSpotBGBDeductInfo(): Promise<APIResponse<{
  deduct: string;
}>>;

Returns ​

Promise<APIResponse<{ deduct: string; }>>


getSpotCallAuction() ​

ts
getSpotCallAuction(params: SpotCallAuctionRequestV2): Promise<APIResponse<SpotCallAuctionV2>>;

Parameters ​

ParameterType
paramsSpotCallAuctionRequestV2

Returns ​

Promise<APIResponse<SpotCallAuctionV2>>


getSpotCandles() ​

ts
getSpotCandles(params: SpotCandlesRequestV2): Promise<APIResponse<SpotCandlestickV2[]>>;

Parameters ​

ParameterType
paramsSpotCandlesRequestV2

Returns ​

Promise<APIResponse<SpotCandlestickV2[]>>


getSpotCoinInfo() ​

ts
getSpotCoinInfo(params?: object): Promise<APIResponse<SpotCoinInfoV2[]>>;
  • Spot | Market

Parameters ​

ParameterType
params?{ coin?: string; }
params.coin?string

Returns ​

Promise<APIResponse<SpotCoinInfoV2[]>>


getSpotCurrentPlanOrders() ​

ts
getSpotCurrentPlanOrders(params: GetSpotCurrentPlanOrdersRequestV2): Promise<APIResponse<{
  idLessThan: string;
  nextFlag: boolean;
  orderList: SpotCurrentPlanOrderV2[];
}>>;

Parameters ​

ParameterType
paramsGetSpotCurrentPlanOrdersRequestV2

Returns ​

Promise<APIResponse<{ idLessThan: string; nextFlag: boolean; orderList: SpotCurrentPlanOrderV2[]; }>>


getSpotDepositAddress() ​

ts
getSpotDepositAddress(params: object): Promise<APIResponse<SpotDepositAddressV2>>;

Parameters ​

ParameterType
params{ chain?: string; coin: string; size: string; }
params.chain?string
params.coinstring
params.sizestring

Returns ​

Promise<APIResponse<SpotDepositAddressV2>>


getSpotDepositHistory() ​

ts
getSpotDepositHistory(params: GetSpotDepositRecordRequestV2): Promise<APIResponse<SpotDepositRecordV2[]>>;

Parameters ​

ParameterType
paramsGetSpotDepositRecordRequestV2

Returns ​

Promise<APIResponse<SpotDepositRecordV2[]>>


getSpotFills() ​

ts
getSpotFills(params: GetSpotFillsRequestV2): Promise<APIResponse<SpotFillV2[]>>;

Parameters ​

ParameterType
paramsGetSpotFillsRequestV2

Returns ​

Promise<APIResponse<SpotFillV2[]>>


getSpotFollowerCurrentTraderSymbols() ​

ts
getSpotFollowerCurrentTraderSymbols(params: object): Promise<APIResponse<{
  currentTradingList: string[];
}>>;

Parameters ​

ParameterType
params{ traderId: string; }
params.traderIdstring

Returns ​

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


getSpotFollowerHistoryOrders() ​

ts
getSpotFollowerHistoryOrders(params: GetSpotFollowerHistoryOrdersRequestV2): Promise<APIResponse<CTSpotFollowerHistoryOrdersV2>>;

Parameters ​

ParameterType
paramsGetSpotFollowerHistoryOrdersRequestV2

Returns ​

Promise<APIResponse<CTSpotFollowerHistoryOrdersV2>>


getSpotFollowerOpenOrders() ​

ts
getSpotFollowerOpenOrders(params: GetSpotFollowerOpenOrdersRequestV2): Promise<APIResponse<CTSpotFollowerCurrentOrdersV2>>;

Parameters ​

ParameterType
paramsGetSpotFollowerOpenOrdersRequestV2

Returns ​

Promise<APIResponse<CTSpotFollowerCurrentOrdersV2>>


getSpotFollowerSettings() ​

ts
getSpotFollowerSettings(params: object): Promise<APIResponse<CTSpotFollowerFollowConfigurationV2>>;

Parameters ​

ParameterType
params{ traderId: string; }
params.traderIdstring

Returns ​

Promise<APIResponse<CTSpotFollowerFollowConfigurationV2>>


getSpotFollowerTraders() ​

ts
getSpotFollowerTraders(params?: object): Promise<APIResponse<CTSpotFollowerMyTradersV2>>;

Parameters ​

ParameterType
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() ​

ts
getSpotFundFlow(params: object): Promise<APIResponse<SpotFundFlowV2>>;

Parameters ​

ParameterType
params{ period?: string; symbol: string; }
params.period?string
params.symbolstring

Returns ​

Promise<APIResponse<SpotFundFlowV2>>


getSpotFundNetFlowData() ​

ts
getSpotFundNetFlowData(params: object): Promise<APIResponse<object[]>>;

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APIResponse<object[]>>


getSpotHistoricCandles() ​

ts
getSpotHistoricCandles(params: SpotHistoricCandlesRequestV2): Promise<APIResponse<SpotCandlestickV2[]>>;

Parameters ​

ParameterType
paramsSpotHistoricCandlesRequestV2

Returns ​

Promise<APIResponse<SpotCandlestickV2[]>>


getSpotHistoricOrders() ​

ts
getSpotHistoricOrders(params?: GetSpotHistoryOrdersRequestV2): Promise<APIResponse<SpotOrderInfoV2[]>>;

Parameters ​

ParameterType
params?GetSpotHistoryOrdersRequestV2

Returns ​

Promise<APIResponse<SpotOrderInfoV2[]>>


getSpotHistoricPlanOrders() ​

ts
getSpotHistoricPlanOrders(params: GetSpotHistoryPlanOrdersRequestV2): Promise<APIResponse<{
  idLessThan: string;
  nextFlag: boolean;
  orderList: SpotHistoryPlanOrderV2[];
}>>;

Parameters ​

ParameterType
paramsGetSpotHistoryPlanOrdersRequestV2

Returns ​

Promise<APIResponse<{ idLessThan: string; nextFlag: boolean; orderList: SpotHistoryPlanOrderV2[]; }>>


getSpotHistoricTrades() ​

ts
getSpotHistoricTrades(params: SpotHistoricTradesRequestV2): Promise<APIResponse<SpotTradeV2[]>>;

Parameters ​

ParameterType
paramsSpotHistoricTradesRequestV2

Returns ​

Promise<APIResponse<SpotTradeV2[]>>


getSpotMainSubTransferRecord() ​

ts
getSpotMainSubTransferRecord(params: SpotMainSubTransferRecordRequestV2): Promise<APIResponse<SpotMainSubTransferRecordV2[]>>;

Parameters ​

ParameterType
paramsSpotMainSubTransferRecordRequestV2

Returns ​

Promise<APIResponse<SpotMainSubTransferRecordV2[]>>


getSpotMergeDepth() ​

ts
getSpotMergeDepth(params: object): Promise<APIResponse<SpotMergeDepthV2>>;

Parameters ​

ParameterType
params{ limit?: string; precision?: string; symbol: string; }
params.limit?string
params.precision?string
params.symbolstring

Returns ​

Promise<APIResponse<SpotMergeDepthV2>>


getSpotOpenOrders() ​

ts
getSpotOpenOrders(params?: GetSpotOpenOrdersRequestV2): Promise<APIResponse<SpotOpenOrderV2[]>>;

Parameters ​

ParameterType
params?GetSpotOpenOrdersRequestV2

Returns ​

Promise<APIResponse<SpotOpenOrderV2[]>>


getSpotOrder() ​

ts
getSpotOrder(params?: GetSpotOrderInfoRequestV2): Promise<APIResponse<SpotOrderInfoV2[]>>;

Parameters ​

ParameterType
params?GetSpotOrderInfoRequestV2

Returns ​

Promise<APIResponse<SpotOrderInfoV2[]>>


getSpotOrderBookDepth() ​

ts
getSpotOrderBookDepth(params: object): Promise<APIResponse<SpotOrderBookDepthV2>>;

Parameters ​

ParameterType
params{ limit?: string; symbol: string; type?: string; }
params.limit?string
params.symbolstring
params.type?string

Returns ​

Promise<APIResponse<SpotOrderBookDepthV2>>


getSpotPlanSubOrder() ​

ts
getSpotPlanSubOrder(params: object): Promise<APIResponse<SpotPlanSubOrderV2[]>>;

Parameters ​

ParameterType
params{ planOrderId: string; }
params.planOrderIdstring

Returns ​

Promise<APIResponse<SpotPlanSubOrderV2[]>>


getSpotRecentTrades() ​

ts
getSpotRecentTrades(params: object): Promise<APIResponse<SpotTradeV2[]>>;

Parameters ​

ParameterType
params{ limit?: string; symbol: string; }
params.limit?string
params.symbolstring

Returns ​

Promise<APIResponse<SpotTradeV2[]>>


getSpotSubAccountAssets() ​

ts
getSpotSubAccountAssets(): Promise<APIResponse<SpotSubAccountAssetsV2[]>>;

Returns ​

Promise<APIResponse<SpotSubAccountAssetsV2[]>>


getSpotSubDepositAddress() ​

ts
getSpotSubDepositAddress(params: object): Promise<APIResponse<SpotDepositAddressV2>>;

Parameters ​

ParameterType
params{ chain?: string; coin: string; size: string; subUid: string; }
params.chain?string
params.coinstring
params.sizestring
params.subUidstring

Returns ​

Promise<APIResponse<SpotDepositAddressV2>>


getSpotSymbolInfo() ​

ts
getSpotSymbolInfo(params?: object): Promise<APIResponse<SpotSymbolInfoV2[]>>;

Parameters ​

ParameterType
params?{ symbol?: string; }
params.symbol?string

Returns ​

Promise<APIResponse<SpotSymbolInfoV2[]>>


getSpotTicker() ​

ts
getSpotTicker(params?: object): Promise<APIResponse<SpotTickerV2[]>>;

Parameters ​

ParameterType
params?{ symbol?: string; }
params.symbol?string

Returns ​

Promise<APIResponse<SpotTickerV2[]>>


getSpotTraderConfiguration() ​

ts
getSpotTraderConfiguration(): Promise<APIResponse<any>>;

Returns ​

Promise<APIResponse<any>>


getSpotTraderCurrentOrders() ​

ts
getSpotTraderCurrentOrders(params: GetSpotTraderCurrentOrdersRequestV2): Promise<APIResponse<CTSpotTraderCurrentTrackingOrdersV2>>;

Parameters ​

ParameterType
paramsGetSpotTraderCurrentOrdersRequestV2

Returns ​

Promise<APIResponse<CTSpotTraderCurrentTrackingOrdersV2>>


getSpotTraderFollowers() ​

ts
getSpotTraderFollowers(params: GetSpotTraderFollowersRequestV2): Promise<APIResponse<CTSpotTraderFollowerListV2[]>>;

Parameters ​

ParameterType
paramsGetSpotTraderFollowersRequestV2

Returns ​

Promise<APIResponse<CTSpotTraderFollowerListV2[]>>


getSpotTraderHistoryOrders() ​

ts
getSpotTraderHistoryOrders(params: GetSpotTraderHistoryOrdersRequestV2): Promise<APIResponse<CTSpotTraderHistoryOrdersV2>>;

Parameters ​

ParameterType
paramsGetSpotTraderHistoryOrdersRequestV2

Returns ​

Promise<APIResponse<CTSpotTraderHistoryOrdersV2>>


getSpotTraderHistoryProfit() ​

ts
getSpotTraderHistoryProfit(params: GetSpotTraderHistoryProfitRequestV2): Promise<APIResponse<CTSpotTraderHistoryProfitSharingV2>>;

Parameters ​

ParameterType
paramsGetSpotTraderHistoryProfitRequestV2

Returns ​

Promise<APIResponse<CTSpotTraderHistoryProfitSharingV2>>


getSpotTraderOrder() ​

ts
getSpotTraderOrder(): Promise<APIResponse<CTSpotTraderTotalOrderDetailV2>>;

Returns ​

Promise<APIResponse<CTSpotTraderTotalOrderDetailV2>>


getSpotTraderProfit() ​

ts
getSpotTraderProfit(): Promise<APIResponse<CTSpotTraderProfitSummaryV2>>;

Copy Trading | Spot copy trading | Trader api

Returns ​

Promise<APIResponse<CTSpotTraderProfitSummaryV2>>


getSpotTraderSymbolSettings() ​

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

Parameters ​

ParameterType
params{ settingType: "add" | "delete"; symbolList: string[]; }
params.settingType"add" | "delete"
params.symbolListstring[]

Returns ​

Promise<APIResponse<string>>


getSpotTraderUnrealizedProfit() ​

ts
getSpotTraderUnrealizedProfit(params?: object): Promise<APIResponse<CTSpotTraderUnrealizedProfitV2[]>>;

Parameters ​

ParameterType
params?{ coin?: string; pageNo?: string; pageSize?: string; }
params.coin?string
params.pageNo?string
params.pageSize?string

Returns ​

Promise<APIResponse<CTSpotTraderUnrealizedProfitV2[]>>


getSpotTransactionRecords() ​

ts
getSpotTransactionRecords(params: GetSpotTransactionsRequestV2): Promise<APIResponse<SpotTransactionRecordV2[]>>;
  • Common | Tax

Parameters ​

ParameterType
paramsGetSpotTransactionsRequestV2

Returns ​

Promise<APIResponse<SpotTransactionRecordV2[]>>


getSpotTransferableCoins() ​

ts
getSpotTransferableCoins(params: object): Promise<APIResponse<string[]>>;

Parameters ​

ParameterType
params{ fromType: SpotAccountTypeV2; toType: SpotAccountTypeV2; }
params.fromTypeSpotAccountTypeV2
params.toTypeSpotAccountTypeV2

Returns ​

Promise<APIResponse<string[]>>


getSpotTransferHistory() ​

ts
getSpotTransferHistory(params: GetSpotTransferRecordRequestV2): Promise<APIResponse<SpotTransferRecordV2[]>>;

Parameters ​

ParameterType
paramsGetSpotTransferRecordRequestV2

Returns ​

Promise<APIResponse<SpotTransferRecordV2[]>>


getSpotVIPFeeRate() ​

ts
getSpotVIPFeeRate(): Promise<APIResponse<SpotVipFeeRateV2[]>>;

Returns ​

Promise<APIResponse<SpotVipFeeRateV2[]>>


getSpotWhaleNetFlowData() ​

ts
getSpotWhaleNetFlowData(params: object): Promise<APIResponse<SpotWhaleNetFlowV2[]>>;
  • Common | Trading insights

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APIResponse<SpotWhaleNetFlowV2[]>>


getSpotWithdrawalHistory() ​

ts
getSpotWithdrawalHistory(params: GetSpotWithdrawalRecordRequestV2): Promise<APIResponse<SpotWithdrawalRecordV2[]>>;

Parameters ​

ParameterType
paramsGetSpotWithdrawalRecordRequestV2

Returns ​

Promise<APIResponse<SpotWithdrawalRecordV2[]>>


getSubaccountApiKey() ​

ts
getSubaccountApiKey(params: object): Promise<APIResponse<SubaccountApiKeyV2[]>>;

Parameters ​

ParameterType
params{ subUid: string; }
params.subUidstring

Returns ​

Promise<APIResponse<SubaccountApiKeyV2[]>>


getSubAccountDepositRecords() ​

ts
getSubAccountDepositRecords(params: GetSpotSubAccountDepositRecordRequestV2): Promise<APIResponse<SpotSubAccountDepositRecordV2[]>>;

Parameters ​

ParameterType
paramsGetSpotSubAccountDepositRecordRequestV2

Returns ​

Promise<APIResponse<SpotSubAccountDepositRecordV2[]>>


getSubaccountEmail() ​

ts
getSubaccountEmail(params: object): Promise<APIResponse<SubaccountEmailV2>>;

Parameters ​

ParameterType
params{ subUid: string; }
params.subUidstring

Returns ​

Promise<APIResponse<SubaccountEmailV2>>


getSubaccountFuturesAssets() ​

ts
getSubaccountFuturesAssets(params: object): Promise<APIResponse<{
  assetsList: BrokerSubaccountFutureAssetV2[];
}>>;

Parameters ​

ParameterType
params{ productType: FuturesProductTypeV2; subUid: string; }
params.productTypeFuturesProductTypeV2
params.subUidstring

Returns ​

Promise<APIResponse<{ assetsList: BrokerSubaccountFutureAssetV2[]; }>>


getSubaccounts() ​

ts
getSubaccounts(params?: GetSubAccountsRequestV2): Promise<APIResponse<{
  hasNextPage: boolean;
  idLessThan: number;
  subList: BrokerSubaccountV2[];
}>>;

Parameters ​

ParameterType
params?GetSubAccountsRequestV2

Returns ​

Promise<APIResponse<{ hasNextPage: boolean; idLessThan: number; subList: BrokerSubaccountV2[]; }>>


getSubaccountSpotAssets() ​

ts
getSubaccountSpotAssets(params: object): Promise<APIResponse<{
  assetsList: BrokerSubaccountSpotAssetV2[];
}>>;

Parameters ​

ParameterType
params{ assetType?: "all" | "hold_only"; coin?: string; subUid: string; }
params.assetType?"all" | "hold_only"
params.coin?string
params.subUidstring

Returns ​

Promise<APIResponse<{ assetsList: BrokerSubaccountSpotAssetV2[]; }>>


getSubAffiliateInfo() ​

ts
getSubAffiliateInfo(params?: GetSubAffiliateInfoRequestV2): Promise<APIResponse<SubAffiliateInfoV2>>;

Parameters ​

ParameterType
params?GetSubAffiliateInfoRequestV2

Returns ​

Promise<APIResponse<SubAffiliateInfoV2>>


getSwitchUnionUsdt() ​

ts
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() ​

ts
getTradeDataSupportSymbols(): Promise<APIResponse<{
  futureList: string[];
  spotList: string[];
}>>;

Returns ​

Promise<APIResponse<{ futureList: string[]; spotList: string[]; }>>


getTradeRate() ​

ts
getTradeRate(params: GetTradeRateRequestV2): Promise<APIResponse<{
  makerFeeRate: string;
  takerFeeRate: string;
}>>;

Parameters ​

ParameterType
paramsGetTradeRateRequestV2

Returns ​

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


getUnifiedAccountSwitchStatus() ​

ts
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 ​

ParameterType
params?{ subUid?: string; }
params.subUid?string

Returns ​

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


getUnionConfig() ​

ts
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() ​

ts
getUnionTransferLimits(params: GetUnionTransferLimitsRequestV2): Promise<APIResponse<UnionTransferLimitsV2>>;

Get Union Transfer Limits

  • Rate limit: 1 time/1s (uid)
  • Get union margin currency transfer limits

Parameters ​

ParameterType
paramsGetUnionTransferLimitsRequestV2

Returns ​

Promise<APIResponse<UnionTransferLimitsV2>>


getVirtualSubaccountAPIKeys() ​

ts
getVirtualSubaccountAPIKeys(params: object): Promise<APIResponse<SubAccountApiKeyItemV2[]>>;

Parameters ​

ParameterType
params{ subAccountUid: string; }
params.subAccountUidstring

Returns ​

Promise<APIResponse<SubAccountApiKeyItemV2[]>>


getVirtualSubaccounts() ​

ts
getVirtualSubaccounts(params?: object): Promise<APIResponse<{
  endId: string;
  subAccountList: VirtualSubAccountV2[];
}>>;

Parameters ​

ParameterType
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() ​

ts
marginBatchCancelOrders(marginType: MarginType, params: object): Promise<APIResponse<MarginBatchOrdersResponseV2>>;

Parameters ​

ParameterType
marginTypeMarginType
params{ orderIdList: string[]; symbol: string; }
params.orderIdListstring[]
params.symbolstring

Returns ​

Promise<APIResponse<MarginBatchOrdersResponseV2>>


marginBatchSubmitOrders() ​

ts
marginBatchSubmitOrders(marginType: MarginType, params: MarginBatchOrdersRequestV2): Promise<APIResponse<MarginBatchOrdersResponseV2>>;

Parameters ​

ParameterType
marginTypeMarginType
paramsMarginBatchOrdersRequestV2

Returns ​

Promise<APIResponse<MarginBatchOrdersResponseV2>>


marginBorrow() ​

ts
marginBorrow(marginType: MarginType, params: object): Promise<APIResponse<{
  borrowAmount: string;
  coin: string;
  loanId: string;
  symbol: string;
}>>;

Parameters ​

ParameterType
marginTypeMarginType
params{ borrowAmount: string; coin: string; loanId: string; symbol: string; }
params.borrowAmountstring
params.coinstring
params.loanIdstring
params.symbolstring

Returns ​

Promise<APIResponse<{ borrowAmount: string; coin: string; loanId: string; symbol: string; }>>


marginCancelOrder() ​

ts
marginCancelOrder(marginType: MarginType, params: object): Promise<APIResponse<{
  clientOid: string;
  orderId: string;
}>>;

Parameters ​

ParameterType
marginTypeMarginType
params{ clientOid?: string; orderId?: string; symbol: string; }
params.clientOid?string
params.orderId?string
params.symbolstring

Returns ​

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


marginFlashRepay() ​

ts
marginFlashRepay(marginType: MarginType, params: object): Promise<APIResponse<{
  coin?: string;
  repayId: string;
  result?: string;
  symbol?: string;
}>>;

Parameters ​

ParameterType
marginTypeMarginType
params{ coin: string; }
params.coinstring

Returns ​

Promise<APIResponse<{ coin?: string; repayId: string; result?: string; symbol?: string; }>>


marginRepay() ​

ts
marginRepay(marginType: MarginType, params: object): Promise<APIResponse<{
  coin: string;
  remainDebtAmount: string;
  repayAmount: string;
  repayId: string;
  symbol: string;
}>>;

Parameters ​

ParameterType
marginTypeMarginType
params{ coin: string; remainDebtAmount: string; repayAmount: string; repayId: string; symbol: string; }
params.coinstring
params.remainDebtAmountstring
params.repayAmountstring
params.repayIdstring
params.symbolstring

Returns ​

Promise<APIResponse<{ coin: string; remainDebtAmount: string; repayAmount: string; repayId: string; symbol: string; }>>


marginSubmitOrder() ​

ts
marginSubmitOrder(marginType: MarginType, params: MarginPlaceOrderRequestV2): Promise<APIResponse<{
  clientOid: string;
  orderId: string;
}>>;
  • Margin | Cross/Isolated | Trade

Parameters ​

ParameterType
marginTypeMarginType
paramsMarginPlaceOrderRequestV2

Returns ​

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


modifyFuturesTraderOrderTPSL() ​

ts
modifyFuturesTraderOrderTPSL(params: ModifyFuturesTraderOrderTPSLRequestV2): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsModifyFuturesTraderOrderTPSLRequestV2

Returns ​

Promise<APIResponse<string>>


modifySpotTraderOrderTPSL() ​

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

Parameters ​

ParameterType
params{ stopLossPrice?: string; stopSurplusPrice?: string; trackingNo: string; }
params.stopLossPrice?string
params.stopSurplusPrice?string
params.trackingNostring

Returns ​

Promise<APIResponse<string>>


modifySubaccount() ​

ts
modifySubaccount(params: ModifySubRequestV2): Promise<APIResponse<ModifySubaccountResponseV2>>;

Parameters ​

ParameterType
paramsModifySubRequestV2

Returns ​

Promise<APIResponse<ModifySubaccountResponseV2>>


modifySubaccountApiKey() ​

ts
modifySubaccountApiKey(params: ModifySubAccountApiKeyRequestV2): Promise<APIResponse<ModifySubaccountApiKeyResponseV2>>;

Parameters ​

ParameterType
paramsModifySubAccountApiKeyRequestV2

Returns ​

Promise<APIResponse<ModifySubaccountApiKeyResponseV2>>


modifySubaccountEmail() ​

ts
modifySubaccountEmail(params: object): Promise<APIResponse<string>>;
  • Broker | Subaccount

Parameters ​

ParameterType
params{ subaccountEmail: string; subUid: string; }
params.subaccountEmailstring
params.subUidstring

Returns ​

Promise<APIResponse<string>>


modifyVirtualSubaccount() ​

ts
modifyVirtualSubaccount(params: ModifyVirtualSubRequestV2): Promise<APIResponse<{
  result: string;
}>>;

Parameters ​

ParameterType
paramsModifyVirtualSubRequestV2

Returns ​

Promise<APIResponse<{ result: string; }>>


modifyVirtualSubaccountAPIKey() ​

ts
modifyVirtualSubaccountAPIKey(params: ModifyVirtualSubApiKeyRequestV2): Promise<APIResponse<ModifyVirtualSubAccountApiKeyV2>>;

Parameters ​

ParameterType
paramsModifyVirtualSubApiKeyRequestV2

Returns ​

Promise<APIResponse<ModifyVirtualSubAccountApiKeyV2>>


post() ​

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

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.post


postPrivate() ​

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

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.postPrivate


redeemEarnElite() ​

ts
redeemEarnElite(params: RedeemEarnEliteRequestV2): Promise<APIResponse<RedeemEarnEliteResultV2>>;

Parameters ​

ParameterType
paramsRedeemEarnEliteRequestV2

Returns ​

Promise<APIResponse<RedeemEarnEliteResultV2>>


removeFuturesTraderFollower() ​

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

Parameters ​

ParameterType
params{ followerUid: string; }
params.followerUidstring

Returns ​

Promise<APIResponse<string>>


removeSpotTraderFollowers() ​

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

Parameters ​

ParameterType
params{ followerUid: string; }
params.followerUidstring

Returns ​

Promise<APIResponse<string>>


repayLoan() ​

ts
repayLoan(params: RepayLoanRequestV2): Promise<APIResponse<EarnLoanRepayResponseV2>>;

Parameters ​

ParameterType
paramsRepayLoanRequestV2

Returns ​

Promise<APIResponse<EarnLoanRepayResponseV2>>


sellSpotFollower() ​

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

Parameters ​

ParameterType
params{ symbol: string; trackingNoList: string[]; }
params.symbolstring
params.trackingNoListstring[]

Returns ​

Promise<APIResponse<string>>


sellSpotTrader() ​

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

Parameters ​

ParameterType
params{ symbol: string; trackingNoList: string[]; }
params.symbolstring
params.trackingNoListstring[]

Returns ​

Promise<APIResponse<string>>


setFuturesAssetMode() ​

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

Parameters ​

ParameterType
params{ assetMode: "single" | "union"; productType: "USDT-FUTURES" | "SUSDT-FUTURES"; }
params.assetMode"single" | "union"
params.productType"USDT-FUTURES" | "SUSDT-FUTURES"

Returns ​

Promise<APIResponse<string>>


setFuturesLeverage() ​

ts
setFuturesLeverage(params: FuturesSetLeverageRequestV2): Promise<APIResponse<SetLeverageResponseV2>>;

Parameters ​

ParameterType
paramsFuturesSetLeverageRequestV2

Returns ​

Promise<APIResponse<SetLeverageResponseV2>>


setFuturesMarginMode() ​

ts
setFuturesMarginMode(params: FuturesSetMarginModeRequestV2): Promise<APIResponse<SetMarginModeResponseV2>>;

Parameters ​

ParameterType
paramsFuturesSetMarginModeRequestV2

Returns ​

Promise<APIResponse<SetMarginModeResponseV2>>


setFuturesPositionAutoMargin() ​

ts
setFuturesPositionAutoMargin(params: FuturesSetAutoMarginRequestV2): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsFuturesSetAutoMarginRequestV2

Returns ​

Promise<APIResponse<string>>


setFuturesPositionMargin() ​

ts
setFuturesPositionMargin(params: FuturesSetPositionMarginRequestV2): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsFuturesSetPositionMarginRequestV2

Returns ​

Promise<APIResponse<string>>


setFuturesPositionMode() ​

ts
setFuturesPositionMode(params: object): Promise<APIResponse<{
  posMode: "one_way_mode" | "hedge_mode";
}>>;

Parameters ​

ParameterType
params{ posMode: "one_way_mode" | "hedge_mode"; productType: FuturesProductTypeV2; }
params.posMode"one_way_mode" | "hedge_mode"
params.productTypeFuturesProductTypeV2

Returns ​

Promise<APIResponse<{ posMode: "one_way_mode" | "hedge_mode"; }>>


spotBatchCancelandSubmitOrder() ​

ts
spotBatchCancelandSubmitOrder(params: object): Promise<APIResponse<CancelAndSubmitSpotOrderResponseV2[]>>;

Parameters ​

ParameterType
params{ orderList: SpotCancelandSubmitOrderRequestV2[]; }
params.orderListSpotCancelandSubmitOrderRequestV2[]

Returns ​

Promise<APIResponse<CancelAndSubmitSpotOrderResponseV2[]>>


spotBatchCancelOrders() ​

ts
spotBatchCancelOrders(params: SpotBatchCancelOrderRequestV2): Promise<APIResponse<SubmitSpotBatchOrdersResponseV2>>;

Parameters ​

ParameterType
paramsSpotBatchCancelOrderRequestV2

Returns ​

Promise<APIResponse<SubmitSpotBatchOrdersResponseV2>>


spotBatchSubmitOrders() ​

ts
spotBatchSubmitOrders(params: SpotBatchOrderRequestV2): Promise<APIResponse<SubmitSpotBatchOrdersResponseV2>>;

Parameters ​

ParameterType
paramsSpotBatchOrderRequestV2

Returns ​

Promise<APIResponse<SubmitSpotBatchOrdersResponseV2>>


spotCancelandSubmitOrder() ​

ts
spotCancelandSubmitOrder(params: SpotCancelandSubmitOrderRequestV2): Promise<APIResponse<CancelAndSubmitSpotOrderResponseV2>>;

Parameters ​

ParameterType
paramsSpotCancelandSubmitOrderRequestV2

Returns ​

Promise<APIResponse<CancelAndSubmitSpotOrderResponseV2>>


spotCancelOrder() ​

ts
spotCancelOrder(params: SpotCancelOrderRequestV2): Promise<APIResponse<{
  clientOid: string;
  orderId: string;
}>>;

Parameters ​

ParameterType
paramsSpotCancelOrderRequestV2

Returns ​

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


spotCancelPlanOrder() ​

ts
spotCancelPlanOrder(params: object): Promise<APIResponse<{
  result: string;
}>>;

Parameters ​

ParameterType
params{ clientOid?: string; orderId?: string; }
params.clientOid?string
params.orderId?string

Returns ​

Promise<APIResponse<{ result: string; }>>


spotCancelPlanOrders() ​

ts
spotCancelPlanOrders(params?: object): Promise<APIResponse<SpotCancelPlanOrdersV2>>;

Parameters ​

ParameterType
params?{ symbolList?: string[]; }
params.symbolList?string[]

Returns ​

Promise<APIResponse<SpotCancelPlanOrdersV2>>


spotCancelSymbolOrder() ​

ts
spotCancelSymbolOrder(params: object): Promise<APIResponse<{
  symbol: string;
}>>;

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APIResponse<{ symbol: string; }>>


spotCancelWithdrawal() ​

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

Parameters ​

ParameterType
params{ orderId: string; }
params.orderIdstring

Returns ​

Promise<APIResponse<string>>


spotModifyDepositAccount() ​

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

Parameters ​

ParameterType
params{ accountType: string; coin: string; }
params.accountTypestring
params.coinstring

Returns ​

Promise<APIResponse<string>>


spotModifyPlanOrder() ​

ts
spotModifyPlanOrder(params: SpotModifyPlanOrderRequestV2): Promise<APIResponse<{
  clientOid: string;
  orderId: string;
}>>;

Parameters ​

ParameterType
paramsSpotModifyPlanOrderRequestV2

Returns ​

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


spotSubmitOrder() ​

ts
spotSubmitOrder(params: SpotOrderRequestV2): Promise<APIResponse<{
  clientOid: string;
  orderId: string;
}>>;
  • Spot | Trade

Parameters ​

ParameterType
paramsSpotOrderRequestV2

Returns ​

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


spotSubmitPlanOrder() ​

ts
spotSubmitPlanOrder(params: SpotPlanOrderRequestV2): Promise<APIResponse<{
  clientOid: string;
  orderId: string;
}>>;
  • Spot | Trigger Orders

Parameters ​

ParameterType
paramsSpotPlanOrderRequestV2

Returns ​

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


spotSubTransfer() ​

ts
spotSubTransfer(params: SpotSubAccountTransferRequestV2): Promise<APIResponse<{
  clientOid: string;
  transferId: string;
}>>;

Parameters ​

ParameterType
paramsSpotSubAccountTransferRequestV2

Returns ​

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


spotSwitchBGBDeduct() ​

ts
spotSwitchBGBDeduct(params: object): Promise<APIResponse<boolean>>;

Parameters ​

ParameterType
params{ deduct: boolean; }
params.deductboolean

Returns ​

Promise<APIResponse<boolean>>


spotTransfer() ​

ts
spotTransfer(params: SpotTransferRequestV2): Promise<APIResponse<{
  clientOid: string;
  transferId: string;
}>>;

Parameters ​

ParameterType
paramsSpotTransferRequestV2

Returns ​

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


spotWithdraw() ​

ts
spotWithdraw(params: SpotWithdrawalRequestV2): Promise<APIResponse<{
  clientOid: string;
  orderId: string;
}>>;

Parameters ​

ParameterType
paramsSpotWithdrawalRequestV2

Returns ​

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


subaccountDepositRecords() ​

ts
subaccountDepositRecords(params: SubDepositRecordsRequestV2): Promise<APIResponse<SubaccountDepositV2>>;

Sub Deposit Records

  • Only applicable for ND broker main-account to get ND sub-accounts deposit record

Parameters ​

ParameterType
paramsSubDepositRecordsRequestV2

Returns ​

Promise<APIResponse<SubaccountDepositV2>>


subaccountSetAutoTransfer() ​

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

Parameters ​

ParameterType
params{ coin: string; subUid: string; toAccountType: string; }
params.coinstring
params.subUidstring
params.toAccountTypestring

Returns ​

Promise<APIResponse<string>>


subaccountWithdrawal() ​

ts
subaccountWithdrawal(params: SubWithdrawalRequestV2): Promise<APIResponse<{
  clientOid: string;
  orderId: string;
}>>;

Parameters ​

ParameterType
paramsSubWithdrawalRequestV2

Returns ​

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


subaccountWithdrawalRecords() ​

ts
subaccountWithdrawalRecords(params: SubWithdrawalRecordsRequestV2): Promise<APIResponse<{
  endId: string;
  resultList: BrokerSubaccountWithdrawalV2[];
}>>;

Sub Withdrawal Records

  • Only applicable for ND broker main-account

Parameters ​

ParameterType
paramsSubWithdrawalRecordsRequestV2

Returns ​

Promise<APIResponse<{ endId: string; resultList: BrokerSubaccountWithdrawalV2[]; }>>


subscribeEarnElite() ​

ts
subscribeEarnElite(params: EarnEliteSubscribeRequestV2): Promise<APIResponse<EarnEliteSubscribeResultV2>>;

Parameters ​

ParameterType
paramsEarnEliteSubscribeRequestV2

Returns ​

Promise<APIResponse<EarnEliteSubscribeResultV2>>


subscribeSharkfin() ​

ts
subscribeSharkfin(params: object): Promise<APIResponse<{
  orderId: string;
  status: string;
}>>;

Parameters ​

ParameterType
params{ amount: string; productId: string; }
params.amountstring
params.productIdstring

Returns ​

Promise<APIResponse<{ orderId: string; status: string; }>>


unfollowFuturesTrader() ​

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

Parameters ​

ParameterType
params{ traderId: string; }
params.traderIdstring

Returns ​

Promise<APIResponse<string>>


unfollowSpotTrader() ​

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

Parameters ​

ParameterType
params{ traderId: string; }
params.traderIdstring

Returns ​

Promise<APIResponse<string>>


unionConvert() ​

ts
unionConvert(params: UnionConvertRequestV2): Promise<APIResponse<UnionConvertV2>>;

Union Convert

  • Rate limit: 1 time/1s (uid)
  • Union margin exchange

Parameters ​

ParameterType
paramsUnionConvertRequestV2

Returns ​

Promise<APIResponse<UnionConvertV2>>


updateFuturesFollowerSettings() ​

ts
updateFuturesFollowerSettings(params: UpdateFuturesFollowerSettingsRequestV2): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsUpdateFuturesFollowerSettingsRequestV2

Returns ​

Promise<APIResponse<string>>


updateFuturesFollowerTPSL() ​

ts
updateFuturesFollowerTPSL(params: UpdateFuturesFollowerTPSLRequestV2): Promise<APIResponse<string>>;

Parameters ​

ParameterType
paramsUpdateFuturesFollowerTPSLRequestV2

Returns ​

Promise<APIResponse<string>>


updateFuturesTraderGlobalSettings() ​

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

Parameters ​

ParameterType
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() ​

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

Parameters ​

ParameterType
params{ settingList: FuturesTraderSymbolSettingRequestV2[]; }
params.settingListFuturesTraderSymbolSettingRequestV2[]

Returns ​

Promise<APIResponse<string>>


updateLoanPledgeRate() ​

ts
updateLoanPledgeRate(params: ModifyLoanPledgeRateRequestV2): Promise<APIResponse<{
  afterPledgeRate: string;
  loanCoin: string;
  pledgeCoin: string;
}>>;

Parameters ​

ParameterType
paramsModifyLoanPledgeRateRequestV2

Returns ​

Promise<APIResponse<{ afterPledgeRate: string; loanCoin: string; pledgeCoin: string; }>>


updateSpotFollowerSettings() ​

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

Parameters ​

ParameterType
params{ autoCopy?: "off" | "on"; mode?: "basic" | "advanced"; settings: SpotFollowerCopyTradeSettingV2[]; traderId: string; }
params.autoCopy?"off" | "on"
params.mode?"basic" | "advanced"
params.settingsSpotFollowerCopyTradeSettingV2[]
params.traderIdstring

Returns ​

Promise<APIResponse<string>>


updateSpotFollowerTPSL() ​

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

Parameters ​

ParameterType
params{ stopLossPrice?: string; stopSurplusPrice?: string; trackingNo: string; }
params.stopLossPrice?string
params.stopSurplusPrice?string
params.trackingNostring

Returns ​

Promise<APIResponse<string>>


upgradeToUnifiedAccount() ​

ts
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 ​

ParameterType
params?{ subUid?: string; }
params.subUid?string

Returns ​

Promise<APIResponse<null>>

Built by Siebly. Open source SDKs for exchange APIs.