Skip to content

Class: SpotClient ​

Extends ​

  • BaseRestClient

Constructors ​

Constructor ​

ts
new SpotClient(restClientOptions?: RestClientOptions, networkOptions?: AxiosRequestConfig): SpotClient;

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

Parameters ​

ParameterTypeDescription
restClientOptions?RestClientOptionsoptions to configure REST API connectivity
networkOptions?AxiosRequestConfigHTTP networking options for axios

Returns ​

SpotClient

Inherited from ​

BaseRestClient.constructor

Methods ​

addMarginOcoOrder() ​

ts
addMarginOcoOrder(params: SubmitMarginOcoOrderRequest): Promise<APISuccessResponse<MarginOcoOrderResponse>>;

Add Margin OCO Order

Place OCO order to the Margin trading system

Parameters ​

ParameterType
paramsSubmitMarginOcoOrderRequest

Returns ​

Promise<APISuccessResponse<MarginOcoOrderResponse>>


addMarginStopOrder() ​

ts
addMarginStopOrder(params: SubmitMarginStopOrderRequest): Promise<APISuccessResponse<MarginStopOrderResponse>>;

Add Margin Stop Order

Place stop order to the margin trading system. The maximum untriggered stop orders for a single trading pair in one account is 20.

Parameters ​

ParameterType
paramsSubmitMarginStopOrderRequest

Returns ​

Promise<APISuccessResponse<MarginStopOrderResponse>>


batchCancelMarginOcoOrders() ​

ts
batchCancelMarginOcoOrders(params?: BatchCancelMarginOcoOrdersRequest): Promise<APISuccessResponse<CancelMarginOrdersResponse>>;

Batch Cancel Margin OCO Orders

This interface can batch cancel OCO orders through orderIds.

Parameters ​

ParameterType
params?BatchCancelMarginOcoOrdersRequest

Returns ​

Promise<APISuccessResponse<CancelMarginOrdersResponse>>


batchCancelMarginStopOrder() ​

ts
batchCancelMarginStopOrder(params: BatchCancelMarginStopOrdersRequest): Promise<APISuccessResponse<CancelMarginOrdersResponse>>;

Batch Cancel Margin Stop Orders

Request via this interface to cancel a batch of stop orders.

Parameters ​

ParameterType
paramsBatchCancelMarginStopOrdersRequest

Returns ​

Promise<APISuccessResponse<CancelMarginOrdersResponse>>


cancelAllOrders() ​

ts
cancelAllOrders(params?: CancelAllOrdersRequest): Promise<APISuccessResponse<{
  cancelledOrderIds: string[];
}>>;

Parameters ​

ParameterType
params?CancelAllOrdersRequest

Returns ​

Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>

Deprecated ​

This method is deprecated. It is recommended to use the cancelHFAllOrders() endpoint instead of this endpoint


cancelConvertLimitOrder() ​

ts
cancelConvertLimitOrder(params: CancelConvertLimitOrderRequest): Promise<APISuccessResponse<null>>;

Cancel Convert Limit Order

Cancel Convert Limit Order

Parameters ​

ParameterType
paramsCancelConvertLimitOrderRequest

Returns ​

Promise<APISuccessResponse<null>>


cancelHFAllMarginOrders() ​

ts
cancelHFAllMarginOrders(params: object): Promise<any>;

Cancel All Orders By Symbol

This endpoint can cancel all open Margin orders by symbol

Parameters ​

ParameterType
params{ symbol: string; tradeType: string; }
params.symbolstring
params.tradeTypestring

Returns ​

Promise<any>


cancelHFAllOrders() ​

ts
cancelHFAllOrders(): Promise<APISuccessResponse<CancelAllHFOrdersResponse>>;

Cancel All Orders

This endpoint can cancel all spot orders for all symbol.

Returns ​

Promise<APISuccessResponse<CancelAllHFOrdersResponse>>


cancelHFAllOrdersBySymbol() ​

ts
cancelHFAllOrdersBySymbol(params: object): Promise<APISuccessResponse<string>>;

Cancel All Orders By Symbol

This endpoint can cancel all spot orders for specific symbol.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<string>>


cancelHFMarginOrder() ​

ts
cancelHFMarginOrder(params: object): Promise<APISuccessResponse<{
  orderId: string;
}>>;

Cancel Order By OrderId

This endpoint can be used to cancel a margin order by orderId.

Parameters ​

ParameterType
params{ orderId: string; symbol: string; }
params.orderIdstring
params.symbolstring

Returns ​

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


cancelHFMarginOrderByClientOid() ​

ts
cancelHFMarginOrderByClientOid(params: object): Promise<APISuccessResponse<{
  clientOid: string;
}>>;

Cancel Order By ClientOid

This endpoint can be used to cancel a margin order by clientOid.

Parameters ​

ParameterType
params{ clientOid: string; symbol: string; }
params.clientOidstring
params.symbolstring

Returns ​

Promise<APISuccessResponse<{ clientOid: string; }>>


cancelHFOrder() ​

ts
cancelHFOrder(params: object): Promise<APISuccessResponse<{
  orderId: string;
}>>;

Cancel Order By OrderId

This endpoint can be used to cancel a spot order by orderId. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.

Parameters ​

ParameterType
params{ orderId: string; symbol: string; }
params.orderIdstring
params.symbolstring

Returns ​

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

See ​

Manage Spot orders and recover uncertain outcomes


cancelHFOrderAutoSetting() ​

ts
cancelHFOrderAutoSetting(params: object): Promise<APISuccessResponse<{
  currentTime: number;
  triggerTime: number;
}>>;

Set DCP

Set Disconnection Protect(Deadman Swich) Through this endpoint, Call this endpoint to automatically cancel all orders of the set trading pair after the specified time. If this endpoint is not called again for renewal or cancellation before the set time, the system will help the user to cancel the order of the corresponding trading pair. Otherwise it will not.

Parameters ​

ParameterType
params{ symbols?: string; timeout: number; }
params.symbols?string
params.timeoutnumber

Returns ​

Promise<APISuccessResponse<{ currentTime: number; triggerTime: number; }>>


cancelHFOrderAutoSettingQuery() ​

ts
cancelHFOrderAutoSettingQuery(): Promise<APISuccessResponse<AutoCancelHFOrderSettingQueryResponse>>;

Get DCP

Get Disconnection Protect(Deadman Swich) Through this endpoint, you can query the settings of automatic order cancellation

Returns ​

Promise<APISuccessResponse<AutoCancelHFOrderSettingQueryResponse>>


cancelHFOrderByClientOId() ​

ts
cancelHFOrderByClientOId(params: object): Promise<APISuccessResponse<{
  clientOid: string;
}>>;

Cancel Order By ClientOid

This endpoint can be used to cancel a spot order by clientOid. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.

Parameters ​

ParameterType
params{ clientOid: string; symbol: string; }
params.clientOidstring
params.symbolstring

Returns ​

Promise<APISuccessResponse<{ clientOid: string; }>>

See ​

Manage Spot orders and recover uncertain outcomes


cancelHFOrdersNumber() ​

ts
cancelHFOrdersNumber(params: CancelSpecifiedNumberHFOrdersRequest): Promise<{
  cancelSize: string;
  orderId: string;
}>;

Cancel Partial Order

This endpoint can cancel the specified quantity of the order according to the orderId.

Parameters ​

ParameterType
paramsCancelSpecifiedNumberHFOrdersRequest

Returns ​

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


cancelHFOrderSync() ​

ts
cancelHFOrderSync(params: object): Promise<APISuccessResponse<SyncCancelHFOrderResponse>>;

Cancel Order By OrderId Sync

This endpoint can be used to cancel a spot order by orderId. The difference between this endpoint and "cancelHFOrder()" is that this endpoint will synchronously return the order information after the order canceling is completed.

Parameters ​

ParameterType
params{ orderId: string; symbol: string; }
params.orderIdstring
params.symbolstring

Returns ​

Promise<APISuccessResponse<SyncCancelHFOrderResponse>>


cancelHFOrderSyncByClientOId() ​

ts
cancelHFOrderSyncByClientOId(params: object): Promise<APISuccessResponse<SyncCancelHFOrderResponse>>;

Cancel Order By ClientOid Sync

This endpoint can be used to cancel a spot order by clientOid. The difference between this endpoint and "cancelHFOrderByClientOId()" is that this endpoint will synchronously return the order information after the order canceling is completed.

Parameters ​

ParameterType
params{ clientOid: string; symbol: string; }
params.clientOidstring
params.symbolstring

Returns ​

Promise<APISuccessResponse<SyncCancelHFOrderResponse>>


cancelMarginOcoOrderByClientOid() ​

ts
cancelMarginOcoOrderByClientOid(params: CancelMarginOcoOrderByClientOidRequest): Promise<APISuccessResponse<CancelMarginOrdersResponse>>;

Cancel Margin OCO Order By ClientOid

Request via this interface to cancel a stop order via the clientOid.

Parameters ​

ParameterType
paramsCancelMarginOcoOrderByClientOidRequest

Returns ​

Promise<APISuccessResponse<CancelMarginOrdersResponse>>


cancelMarginOcoOrderByOrderId() ​

ts
cancelMarginOcoOrderByOrderId(params: CancelMarginOcoOrderByOrderIdRequest): Promise<APISuccessResponse<CancelMarginOrdersResponse>>;

Cancel Margin OCO Order By OrderId

Request via this endpoint the cancellation of a single OCO order previously placed.

Parameters ​

ParameterType
paramsCancelMarginOcoOrderByOrderIdRequest

Returns ​

Promise<APISuccessResponse<CancelMarginOrdersResponse>>


cancelMarginStopOrderByClientOid() ​

ts
cancelMarginStopOrderByClientOid(params: CancelMarginStopOrderByClientOidRequest): Promise<APISuccessResponse<CancelMarginOrdersResponse>>;

Cancel Margin Stop Order By ClientOid

This endpoint can be used to cancel a stop order by clientOid.

Parameters ​

ParameterType
paramsCancelMarginStopOrderByClientOidRequest

Returns ​

Promise<APISuccessResponse<CancelMarginOrdersResponse>>


cancelMarginStopOrderByOrderId() ​

ts
cancelMarginStopOrderByOrderId(params: object): Promise<APISuccessResponse<CancelMarginOrdersResponse>>;

Cancel Margin Stop Order By OrderId

Request via this endpoint the cancellation of a single stop order previously placed.

Parameters ​

ParameterType
params{ orderId: string; }
params.orderIdstring

Returns ​

Promise<APISuccessResponse<CancelMarginOrdersResponse>>


cancelMultipleOCOOrders() ​

ts
cancelMultipleOCOOrders(params?: object): Promise<APISuccessResponse<{
  cancelledOrderIds: string[];
}>>;

Batch Cancel OCO Order

This endpoint can batch cancel OCO orders through orderIds.

Parameters ​

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

Returns ​

Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>


cancelOCOOrderByClientOid() ​

ts
cancelOCOOrderByClientOid(params: object): Promise<APISuccessResponse<{
  cancelledOrderIds: string[];
}>>;

Cancel OCO Order By ClientOid

Request via this endpoint to cancel a single oco order previously placed.

Parameters ​

ParameterType
params{ clientOid: string; }
params.clientOidstring

Returns ​

Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>


cancelOCOOrderById() ​

ts
cancelOCOOrderById(params: object): Promise<APISuccessResponse<{
  cancelledOrderIds: string[];
}>>;

Cancel OCO Order By OrderId

Request via this endpoint to cancel a single oco order previously placed.

Parameters ​

ParameterType
params{ orderId: string; }
params.orderIdstring

Returns ​

Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>


cancelOrderByClientOid() ​

ts
cancelOrderByClientOid(params: object): Promise<APISuccessResponse<{
  cancelledOrderId: string;
  clientOid: string;
}>>;

Parameters ​

ParameterType
params{ clientOid: string; }
params.clientOidstring

Returns ​

Promise<APISuccessResponse<{ cancelledOrderId: string; clientOid: string; }>>

Deprecated ​

This method is deprecated. It is recommended to use the cancelHFOrderByClientOid() endpoint instead of this endpoint


cancelOrderById() ​

ts
cancelOrderById(params: object): Promise<APISuccessResponse<{
  cancelledOrderIds: string[];
}>>;

Parameters ​

ParameterType
params{ orderId: string; }
params.orderIdstring

Returns ​

Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>

Deprecated ​

This method is deprecated. It is recommended to use the cancelHFOrder() endpoint instead of this endpoint


cancelStopOrderByClientOid() ​

ts
cancelStopOrderByClientOid(params: object): Promise<APISuccessResponse<{
  cancelledOrderId: string;
  clientOid: string;
}>>;

Cancel Stop Order By ClientOid

This endpoint can be used to cancel a spot stop order by clientOid.

Parameters ​

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

Returns ​

Promise<APISuccessResponse<{ cancelledOrderId: string; clientOid: string; }>>


cancelStopOrderById() ​

ts
cancelStopOrderById(params: object): Promise<APISuccessResponse<{
  cancelledOrderIds: string[];
}>>;

Cancel Stop Order By OrderId

Request via this endpoint to cancel a single stop order previously placed.

Parameters ​

ParameterType
params{ orderId: string; }
params.orderIdstring

Returns ​

Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>


cancelStopOrders() ​

ts
cancelStopOrders(params?: CancelStopOrdersRequest): Promise<APISuccessResponse<{
  cancelledOrderIds: string[];
}>>;

Batch Cancel Stop Orders

Request via this endpoint to cancel a batch of stop orders.

Parameters ​

ParameterType
params?CancelStopOrdersRequest

Returns ​

Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>


cancelWithdrawal() ​

ts
cancelWithdrawal(params: object): Promise<APISuccessResponse<string | null>>;

Cancel Withdrawal

This endpoint can cancel the withdrawal, Only withdrawals requests of PROCESSING status could be canceled.

Parameters ​

ParameterType
params{ withdrawalId: string; }
params.withdrawalIdstring

Returns ​

Promise<APISuccessResponse<string | null>>


createDepositAddress() ​

ts
createDepositAddress(params: object): Promise<APISuccessResponse<DepositAddress>>;

Parameters ​

ParameterType
params{ chain?: string; currency: string; }
params.chain?string
params.currencystring

Returns ​

Promise<APISuccessResponse<DepositAddress>>

Deprecated ​

This method is deprecated. Please use createDepositAddressV3() instead.


createDepositAddressV3() ​

ts
createDepositAddressV3(params: CreateDepositAddressV3Request): Promise<APISuccessResponse<CreateDepositAddressV3Response>>;

Add Deposit Address(V3)

Request via this endpoint to create a deposit address for a currency you intend to deposit.

Parameters ​

ParameterType
paramsCreateDepositAddressV3Request

Returns ​

Promise<APISuccessResponse<CreateDepositAddressV3Response>>


createSubAccount() ​

ts
createSubAccount(params: CreateSubAccountRequest): Promise<APISuccessResponse<CreateSubAccount>>;

Add SubAccount

This endpoint is used to create a sub-account.

Parameters ​

ParameterType
paramsCreateSubAccountRequest

Returns ​

Promise<APISuccessResponse<CreateSubAccount>>


createSubAPI() ​

ts
createSubAPI(params: CreateSubAccountAPIRequest): Promise<APISuccessResponse<CreateSubAPI>>;

Add SubAccount API

This endpoint can be used to create APIs for sub-accounts.

Parameters ​

ParameterType
paramsCreateSubAccountAPIRequest

Returns ​

Promise<APISuccessResponse<CreateSubAPI>>


deletePrivate() ​

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

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.deletePrivate


deleteSubAPI() ​

ts
deleteSubAPI(params: DeleteSubAccountAPIRequest): Promise<APISuccessResponse<DeleteSubAccountAPI>>;

Delete SubAccount API

This endpoint can be used to delete an API for a sub-account.

Parameters ​

ParameterType
paramsDeleteSubAccountAPIRequest

Returns ​

Promise<APISuccessResponse<DeleteSubAccountAPI>>


enableSubAccountFutures() ​

ts
enableSubAccountFutures(params: object): Promise<boolean | null>;

Add SubAccount Futures Permission

This endpoint can be used to add sub-accounts Futures permission. Before using this endpoints, you need to ensure that the master account apikey has Futures permissions and the Futures function has been activated.

Parameters ​

ParameterType
params{ uid: string; }
params.uidstring

Returns ​

Promise<boolean | null>


enableSubAccountMargin() ​

ts
enableSubAccountMargin(params: object): Promise<boolean | null>;

Add SubAccount Margin Permission

This endpoint can be used to add sub-accounts Margin permission. Before using this endpoints, you need to ensure that the master account apikey has Margin permissions and the Margin function has been activated.

Parameters ​

ParameterType
params{ uid: string; }
params.uidstring

Returns ​

Promise<boolean | null>


fetchLatencySummary() ​

ts
fetchLatencySummary(): Promise<any>;

This method is used to get the latency and time sync between the client and the server. This is not official API endpoint and is only used for internal testing purposes. Use this method to check the latency and time sync between the client and the server. Final values might vary slightly, but it should be within few ms difference. If you have any suggestions or improvements to this measurement, please create an issue or pull request on GitHub.

Returns ​

Promise<any>


generateNewOrderID() ​

ts
generateNewOrderID(): string;

Misc Utility Methods

Returns ​

string


get() ​

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

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.get


get24hrStats() ​

ts
get24hrStats(params: object): Promise<APISuccessResponse<Symbol24hrStats>>;

Get 24hr Stats

Request via this endpoint to get the statistics of the specified ticker in the last 24 hours.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<Symbol24hrStats>>


getAccountDetail() ​

ts
getAccountDetail(params: object): Promise<APISuccessResponse<Account>>;

Get Account Detail - Spot

Get Information for a single spot account. Use this endpoint when you know the accountId.

Parameters ​

ParameterType
params{ accountId: any; }
params.accountIdany

Returns ​

Promise<APISuccessResponse<Account>>


getAccountSummary() ​

ts
getAccountSummary(): Promise<APISuccessResponse<SpotAccountSummary>>;

Get Account Summary Info

This endpoint can be used to obtain account summary information.

Returns ​

Promise<APISuccessResponse<SpotAccountSummary>>


getAccountSummaryV3() ​

ts
getAccountSummaryV3(): Promise<APISuccessResponse<SpotAccountSummaryV3>>;

Get Account Summary Info (V3)

Returns the VIP level and shared sub-account quota usage, instead of the per-permission sub-account counts returned by V2 (2026.11.06).

Returns ​

Promise<APISuccessResponse<SpotAccountSummaryV3>>


getAffiliateCommission() ​

ts
getAffiliateCommission(params?: GetAffiliateCommissionRequest): Promise<APISuccessResponse<AffiliateCommissionItem[]>>;

Get Commission

My commission information can be obtained at this endpoint.

Parameters ​

ParameterType
params?GetAffiliateCommissionRequest

Returns ​

Promise<APISuccessResponse<AffiliateCommissionItem[]>>


getAffiliateInvitees() ​

ts
getAffiliateInvitees(params?: GetAffiliateInviteesRequest): Promise<APISuccessResponse<AffiliateInvitees>>;

Get Invited

Affiliate user invited information can be obtained at this endpoint.

Parameters ​

ParameterType
params?GetAffiliateInviteesRequest

Returns ​

Promise<APISuccessResponse<AffiliateInvitees>>


getAffiliateTradeHistory() ​

ts
getAffiliateTradeHistory(params: GetAffiliateTradeHistoryRequest): Promise<APISuccessResponse<AffiliateTradeHistory>>;

Get Trade History

Trade history information can be obtained at this endpoint.

Parameters ​

ParameterType
paramsGetAffiliateTradeHistoryRequest

Returns ​

Promise<APISuccessResponse<AffiliateTradeHistory>>


getAffiliateTransaction() ​

ts
getAffiliateTransaction(params: GetAffiliateTransactionRequest): Promise<APISuccessResponse<AffiliateTransaction>>;

Get Transaction

Transaction information can be obtained at this endpoint.

Parameters ​

ParameterType
paramsGetAffiliateTransactionRequest

Returns ​

Promise<APISuccessResponse<AffiliateTransaction>>


getAffiliateUserRebateInfo() ​

ts
getAffiliateUserRebateInfo(): Promise<APISuccessResponse<any>>;

Returns ​

Promise<APISuccessResponse<any>>

Deprecated ​

This method is deprecated. Use other affiliate endpoints instead. Get Affiliate User Rebate Information

This endpoint allows getting affiliate user rebate information.


getAnnouncements() ​

ts
getAnnouncements(params?: GetAnnouncementsRequest): Promise<APISuccessResponse<Announcements>>;

Get Announcements

This endpoint can obtain the latest news announcements, and the default page search is for announcements within a month.

Parameters ​

ParameterType
params?GetAnnouncementsRequest

Returns ​

Promise<APISuccessResponse<Announcements>>


getApikeyInfo() ​

ts
getApikeyInfo(): Promise<APISuccessResponse<ApiKeyInfo>>;

Get API Key Information

Get information about the API key being used. Works for both master and sub user API keys. Includes KYC region, status, expiration date, and third-party app information.

Returns ​

Promise<APISuccessResponse<ApiKeyInfo>>


getBalances() ​

ts
getBalances(params?: GetBalancesRequest): Promise<APISuccessResponse<Balances[]>>;

Get a list of acounts and their balance states (spot/margin/trade_hf)

Get Account List - Spot

Parameters ​

ParameterType
params?GetBalancesRequest

Returns ​

Promise<APISuccessResponse<Balances[]>>

See ​

Read account balances


getBasicUserFee() ​

ts
getBasicUserFee(params: object): Promise<APISuccessResponse<{
  makerFeeRate: string;
  takerFeeRate: string;
}>>;

Get Basic Fee - Spot/Margin

This endpoint is for the spot/margin basic fee rate of users

Parameters ​

ParameterType
params{ currencyType: number; }
params.currencyTypenumber

Returns ​

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


getBorrowInterestRate() ​

ts
getBorrowInterestRate(params?: GetBorrowInterestRateRequest): Promise<APISuccessResponse<BorrowInterestRate>>;

Get Borrow Interest Rate

Query the borrowing interest rate through this interface.

Parameters ​

ParameterType
params?GetBorrowInterestRateRequest

Returns ​

Promise<APISuccessResponse<BorrowInterestRate>>


ts
getBrokerRebateOrderDownloadLink(params: object): Promise<APISuccessResponse<any>>;

Get download link for broker rebate orders

trade type 1 = spot, trade type 2 = futures

Parameters ​

ParameterType
params{ begin: string; end: string; tradeType: 1 | 2; }
params.beginstring
params.endstring
params.tradeType1 | 2

Returns ​

Promise<APISuccessResponse<any>>

Deprecated ​

Use getBrokerRebateOrderDownloadLinkV2 instead


getBrokerRebateOrderDownloadLinkV2() ​

ts
getBrokerRebateOrderDownloadLinkV2(params: object): Promise<APISuccessResponse<any>>;

Get download link for broker rebate orders

trade type SPOT = spot, FUTURE = futures

Parameters ​

ParameterType
params{ begin: string; end: string; tradeType: "SPOT" | "FUTURE"; }
params.beginstring
params.endstring
params.tradeType"SPOT" | "FUTURE"

Returns ​

Promise<APISuccessResponse<any>>


getCallAuctionInfo() ​

ts
getCallAuctionInfo(params: object): Promise<APISuccessResponse<CallAuctionInfo>>;

Get Call Auction Info

Get call auction data. This endpoint will return the following information for the specified symbol during the call auction phase: estimated transaction price, estimated transaction quantity, bid price range, and ask price range.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<CallAuctionInfo>>


getCallAuctionPartOrderBook() ​

ts
getCallAuctionPartOrderBook(params: object): Promise<APISuccessResponse<OrderBookLevel>>;

Get Call Auction Part OrderBook

Query for call auction part orderbook depth data (aggregated by price). It is recommended that you submit requests via this endpoint as the system response will be faster and consume less traffic.

Parameters ​

ParameterType
params{ size: 20 | 100; symbol: string; }
params.size20 | 100
params.symbolstring

Returns ​

Promise<APISuccessResponse<OrderBookLevel>>


getClientType() ​

ts
getClientType(): RestClientType;

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

Returns ​

RestClientType

Overrides ​

BaseRestClient.getClientType


getConvertCurrencies() ​

ts
getConvertCurrencies(): Promise<APISuccessResponse<ConvertCurrencies>>;

Get Convert Currencies

Request via this endpoint to get the list of cryptocurrencies available for convert.

Returns ​

Promise<APISuccessResponse<ConvertCurrencies>>


getConvertLimitOrder() ​

ts
getConvertLimitOrder(params: GetConvertLimitOrderDetailRequest): Promise<APISuccessResponse<ConvertLimitOrder>>;

Get Convert Limit Order Detail

Query convert limit order detail

Parameters ​

ParameterType
paramsGetConvertLimitOrderDetailRequest

Returns ​

Promise<APISuccessResponse<ConvertLimitOrder>>


getConvertLimitOrders() ​

ts
getConvertLimitOrders(params?: GetConvertLimitOrdersRequest): Promise<APISuccessResponse<ConvertLimitOrdersList>>;

Get Convert Limit Orders

Query Active and Historical Convert Limit Orders

Parameters ​

ParameterType
params?GetConvertLimitOrdersRequest

Returns ​

Promise<APISuccessResponse<ConvertLimitOrdersList>>


getConvertLimitQuote() ​

ts
getConvertLimitQuote(params: GetConvertLimitQuoteRequest): Promise<APISuccessResponse<ConvertLimitQuote>>;

Get Convert Limit Quote

Query the protection price threshold for limit orders for convert,user's order price must be ≥ the protection price

Parameters ​

ParameterType
paramsGetConvertLimitQuoteRequest

Returns ​

Promise<APISuccessResponse<ConvertLimitQuote>>


getConvertOrder() ​

ts
getConvertOrder(params: GetConvertOrderDetailRequest): Promise<APISuccessResponse<ConvertOrder>>;

Get Convert Order Detail

Query convert market order details

Parameters ​

ParameterType
paramsGetConvertOrderDetailRequest

Returns ​

Promise<APISuccessResponse<ConvertOrder>>


getConvertOrderHistory() ​

ts
getConvertOrderHistory(params?: GetConvertOrderHistoryRequest): Promise<APISuccessResponse<ConvertOrderHistory>>;

Get Convert Order History

Query convert market order history

Parameters ​

ParameterType
params?GetConvertOrderHistoryRequest

Returns ​

Promise<APISuccessResponse<ConvertOrderHistory>>


getConvertQuote() ​

ts
getConvertQuote(params: GetConvertQuoteRequest): Promise<APISuccessResponse<ConvertQuote>>;

Get Convert Quote

Request via this endpoint to get the quote for convert.

Parameters ​

ParameterType
paramsGetConvertQuoteRequest

Returns ​

Promise<APISuccessResponse<ConvertQuote>>


getConvertSymbol() ​

ts
getConvertSymbol(params: GetConvertSymbolRequest): Promise<APISuccessResponse<ConvertSymbol>>;

Get Convert Symbol

Request via this endpoint to get detail currency pairs for convert.

Parameters ​

ParameterType
paramsGetConvertSymbolRequest

Returns ​

Promise<APISuccessResponse<ConvertSymbol>>


getCurrencies() ​

ts
getCurrencies(): Promise<APISuccessResponse<CurrencyInfo[]>>;

Get All Currencies

Request via this endpoint to get the currency list. Not all currencies currently can be used for trading.

Returns ​

Promise<APISuccessResponse<CurrencyInfo[]>>


getCurrency() ​

ts
getCurrency(params: object): Promise<APISuccessResponse<CurrencyInfo>>;

Get Currency

Request via this endpoint to get the currency details of a specified currency.

Parameters ​

ParameterType
params{ chain?: string; currency: string; }
params.chain?string
params.currencystring

Returns ​

Promise<APISuccessResponse<CurrencyInfo>>


getDepositAddressesV2() ​

ts
getDepositAddressesV2(params: object): Promise<APISuccessResponse<DepositAddressV2[]>>;

Parameters ​

ParameterType
params{ currency: string; }
params.currencystring

Returns ​

Promise<APISuccessResponse<DepositAddressV2[]>>

Deprecated ​

This method is deprecated. Please use getDepositAddressesV3() instead.


getDepositAddressesV3() ​

ts
getDepositAddressesV3(params: object): Promise<APISuccessResponse<DepositAddressV3[]>>;

Get Deposit Address(V3)

Get all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to Add Deposit Address first.

Parameters ​

ParameterType
params{ amount?: string; chain?: string; currency: string; }
params.amount?string
params.chain?string
params.currencystring

Returns ​

Promise<APISuccessResponse<DepositAddressV3[]>>


getDepositAddressV1() ​

ts
getDepositAddressV1(params: object): Promise<APISuccessResponse<DepositAddress>>;

Parameters ​

ParameterType
params{ chain?: string; currency: string; }
params.chain?string
params.currencystring

Returns ​

Promise<APISuccessResponse<DepositAddress>>

Deprecated ​

This method is deprecated. Please use getDepositAddressesV3() instead.


getDeposits() ​

ts
getDeposits(params?: GetDepositsRequest): Promise<APISuccessResponse<Deposits>>;

Get Deposit History

Request via this endpoint to get deposit list Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.

Parameters ​

ParameterType
params?GetDepositsRequest

Returns ​

Promise<APISuccessResponse<Deposits>>


getDiscountRateConfigs() ​

ts
getDiscountRateConfigs(): Promise<APISuccessResponse<DiscountRateConfig[]>>;

Get Discount Rate Configs

Get the gradient discount rate of each currency. Returns the discount rate configuration for different USDT value ranges per currency.

Returns ​

Promise<APISuccessResponse<DiscountRateConfig[]>>


getDualInvestmentProducts() ​

ts
getDualInvestmentProducts(params: GetDualInvestmentProductsRequest): Promise<APISuccessResponse<DualInvestmentProduct[]>>;

Get Dual Investment Products

Available dual investment products can be obtained at this endpoint. If no products are available, an empty list is returned.

Parameters ​

ParameterType
paramsGetDualInvestmentProductsRequest

Returns ​

Promise<APISuccessResponse<DualInvestmentProduct[]>>


getEarnEthStakingProducts() ​

ts
getEarnEthStakingProducts(params?: object): Promise<APISuccessResponse<EarnProduct[]>>;

Get Earn ETH Staking Products

This endpoint retrieves ETH Staking products. If no ETH Staking products are available, an empty list is returned.

Parameters ​

ParameterType
params?{ currency: string; }
params.currencystring

Returns ​

Promise<APISuccessResponse<EarnProduct[]>>


getEarnFixedIncomeHoldAssets() ​

ts
getEarnFixedIncomeHoldAssets(params?: GetEarnFixedIncomeHoldAssetsRequest): Promise<APISuccessResponse<EarnFixedIncomeHoldAssets>>;

Get Earn Account Holdings

This endpoint retrieves current holding assets of fixed income products. If no current holding assets are available, an empty list is returned.

Parameters ​

ParameterType
params?GetEarnFixedIncomeHoldAssetsRequest

Returns ​

Promise<APISuccessResponse<EarnFixedIncomeHoldAssets>>


getEarnKcsStakingProducts() ​

ts
getEarnKcsStakingProducts(params?: object): Promise<APISuccessResponse<EarnProduct[]>>;

Get Earn KCS Staking Products

This endpoint retrieves KCS Staking products. If no KCS Staking products are available, an empty list is returned.

Parameters ​

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

Returns ​

Promise<APISuccessResponse<EarnProduct[]>>


getEarnPromotionProducts() ​

ts
getEarnPromotionProducts(params?: object): Promise<APISuccessResponse<EarnProduct[]>>;

Get Earn Limited-Time Promotion Products

This endpoint retrieves limited-time promotion products. If no products are available, an empty list is returned.

Parameters ​

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

Returns ​

Promise<APISuccessResponse<EarnProduct[]>>


getEarnRedeemPreview() ​

ts
getEarnRedeemPreview(params: GetEarnRedeemPreviewRequest): Promise<APISuccessResponse<GetEarnRedeemPreviewResponse>>;

Get Earn Redeem Preview

This endpoint retrieves redemption preview information by holding ID. If the current holding is fully redeemed or in the process of being redeemed, it indicates that the holding does not exist.

Parameters ​

ParameterType
paramsGetEarnRedeemPreviewRequest

Returns ​

Promise<APISuccessResponse<GetEarnRedeemPreviewResponse>>


getEarnSavingsProducts() ​

ts
getEarnSavingsProducts(params?: object): Promise<APISuccessResponse<EarnProduct[]>>;

Get Earn Savings Products

This endpoint retrieves savings products. If no savings products are available, an empty list is returned.

Parameters ​

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

Returns ​

Promise<APISuccessResponse<EarnProduct[]>>


getEarnStakingProducts() ​

ts
getEarnStakingProducts(params?: object): Promise<APISuccessResponse<EarnProduct[]>>;

Get Earn Staking Products

This endpoint retrieves staking products. If no staking products are available, an empty list is returned.

Parameters ​

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

Returns ​

Promise<APISuccessResponse<EarnProduct[]>>


getFiatPrice() ​

ts
getFiatPrice(params?: object): Promise<any>;

Get Fiat Price

Request via this endpoint to get the fiat price of the currencies for the available trading pairs.

Parameters ​

ParameterType
params?{ base?: string; currencies?: string; }
params.base?string
params.currencies?string

Returns ​

Promise<any>


getFills() ​

ts
getFills(params?: GetFillsRequest): Promise<APISuccessResponse<SpotOrderFills>>;

Parameters ​

ParameterType
params?GetFillsRequest

Returns ​

Promise<APISuccessResponse<SpotOrderFills>>

Deprecated ​

This method is deprecated. It is recommended to use the getHFFilledOrders() instead of this endpoint


getFullOrderBook() ​

ts
getFullOrderBook(params: object): Promise<APISuccessResponse<OrderBookLevel>>;

Get Full OrderBook

Query for full orderbook depth data. (aggregated by price)

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<OrderBookLevel>>


getHFActiveMarginOrders() ​

ts
getHFActiveMarginOrders(params: HFMarginRequestOrder): Promise<APISuccessResponse<HFMarginOrder[]>>;

Get Open Orders

This endpoint is to obtain all Margin active order lists, and the return value of the active order endpoint is the paged data of all uncompleted order lists.

Parameters ​

ParameterType
paramsHFMarginRequestOrder

Returns ​

Promise<APISuccessResponse<HFMarginOrder[]>>


getHFActiveOrders() ​

ts
getHFActiveOrders(params: object): Promise<APISuccessResponse<HFOrder[]>>;

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<HFOrder[]>>

Deprecated ​

as of 13-03-2025- use getHFActiveOrdersPaginated() instead Get Open Orders

This endpoint is to obtain all Spot active order lists, and the return value of the active order endpoint is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order.


getHFActiveOrdersPaginated() ​

ts
getHFActiveOrdersPaginated(params: object): Promise<APISuccessResponse<{
  currentPage: number;
  items: HFOrder[];
  pageSize: number;
  totalNum: number;
  totalPage: number;
}>>;

Get Open Orders By Page

This interface is to obtain Spot active order (uncompleted order) lists by page. The returned data is sorted in descending order according to the create time of the order.

Parameters ​

ParameterType
params{ pageNum?: number; pageSize?: number; symbol: string; }
params.pageNum?number
params.pageSize?number
params.symbolstring

Returns ​

Promise<APISuccessResponse<{ currentPage: number; items: HFOrder[]; pageSize: number; totalNum: number; totalPage: number; }>>

See ​

Manage Spot orders and recover uncertain outcomes


getHFActiveSymbols() ​

ts
getHFActiveSymbols(): Promise<APISuccessResponse<{
  symbols: string[];
}>>;

Get Symbols With Open Order

This endpoint can query all spot symbol that has active orders

Returns ​

Promise<APISuccessResponse<{ symbols: string[]; }>>


getHFCompletedOrders() ​

ts
getHFCompletedOrders(params: GetHFCompletedOrdersRequest): Promise<APISuccessResponse<{
  items: HFOrder[];
  lastId: number;
}>>;

Get Closed Orders

This endpoint is to obtain all Spot completed order lists, and the return value of the completed order endpoint is the paged data of all completed order lists. The returned data is sorted in descending order according to the latest update time of the order.

Parameters ​

ParameterType
paramsGetHFCompletedOrdersRequest

Returns ​

Promise<APISuccessResponse<{ items: HFOrder[]; lastId: number; }>>

See ​

Manage Spot orders and recover uncertain outcomes


getHFFilledOrders() ​

ts
getHFFilledOrders(params: GetHFFilledListRequest): Promise<APISuccessResponse<{
  items: HFFilledOrder[];
  lastId: number;
}>>;

Get Trade History

This endpoint can be used to obtain a list of the latest Spot transaction details.

Parameters ​

ParameterType
paramsGetHFFilledListRequest

Returns ​

Promise<APISuccessResponse<{ items: HFFilledOrder[]; lastId: number; }>>

See ​

Manage Spot orders and recover uncertain outcomes


getHFMarginFilledOrders() ​

ts
getHFMarginFilledOrders(params: GetHFMarginFilledRequest): Promise<APISuccessResponse<{
  items: HFMarginOrder[];
  lastId: number;
}>>;

Get Closed Orders

This endpoint is to obtain all Margin Closed order lists

Parameters ​

ParameterType
paramsGetHFMarginFilledRequest

Returns ​

Promise<APISuccessResponse<{ items: HFMarginOrder[]; lastId: number; }>>


getHFMarginFills() ​

ts
getHFMarginFills(params: getHFMarginFillsRequest): Promise<APISuccessResponse<{
  items: HFMarginTransactionRecord[];
  lastId: number;
}>>;

Get Trade History

This endpoint can be used to obtain a list of the latest Margin transaction details.

Parameters ​

ParameterType
paramsgetHFMarginFillsRequest

Returns ​

Promise<APISuccessResponse<{ items: HFMarginTransactionRecord[]; lastId: number; }>>


getHFMarginOpenSymbols() ​

ts
getHFMarginOpenSymbols(params: object): Promise<APISuccessResponse<{
  symbols: string[];
  symbolSize: number;
}>>;

Get Symbols With Open Order

This endpoint can query all Margin symbol that has active orders

Parameters ​

ParameterType
params{ tradeType: string; }
params.tradeTypestring

Returns ​

Promise<APISuccessResponse<{ symbols: string[]; symbolSize: number; }>>


getHFMarginOrderByClientOid() ​

ts
getHFMarginOrderByClientOid(params: object): Promise<APISuccessResponse<HFMarginOrder>>;

Get Order By ClientOid

This endpoint can be used to obtain a Margin order by clientOid.

Parameters ​

ParameterType
params{ clientOid: string; symbol: string; }
params.clientOidstring
params.symbolstring

Returns ​

Promise<APISuccessResponse<HFMarginOrder>>


getHFMarginOrderByOrderId() ​

ts
getHFMarginOrderByOrderId(params: object): Promise<APISuccessResponse<HFMarginOrder>>;

Get Order By OrderId

This endpoint can be used to obtain a Margin order by orderId.

Parameters ​

ParameterType
params{ orderId: string; symbol: string; }
params.orderIdstring
params.symbolstring

Returns ​

Promise<APISuccessResponse<HFMarginOrder>>


getHFMarginTransactions() ​

ts
getHFMarginTransactions(params: AccountHFMarginTransactionsRequest): Promise<APISuccessResponse<AccountHFMarginTransactions[]>>;

Get Account Ledgers - margin_hf

This API endpoint returns all transfer (in and out) records in high-frequency margin trading account and supports multi-coin queries. The query results are sorted in descending order by createdAt and id.

Parameters ​

ParameterType
paramsAccountHFMarginTransactionsRequest

Returns ​

Promise<APISuccessResponse<AccountHFMarginTransactions[]>>


getHFOrderDetailsByClientOid() ​

ts
getHFOrderDetailsByClientOid(params: object): Promise<APISuccessResponse<HFOrder>>;

Get Order By ClientOid

This endpoint can be used to obtain information for a single Spot order using the clientOid.

Parameters ​

ParameterType
params{ clientOid: string; symbol: string; }
params.clientOidstring
params.symbolstring

Returns ​

Promise<APISuccessResponse<HFOrder>>

See ​

Manage Spot orders and recover uncertain outcomes


getHFOrderDetailsByOrderId() ​

ts
getHFOrderDetailsByOrderId(params: object): Promise<APISuccessResponse<HFOrder>>;

Get Order By OrderId

This endpoint can be used to obtain information for a single Spot order using the order id.

Parameters ​

ParameterType
params{ orderId: string; symbol: string; }
params.orderIdstring
params.symbolstring

Returns ​

Promise<APISuccessResponse<HFOrder>>

See ​

Manage Spot orders and recover uncertain outcomes


getHFTransactions() ​

ts
getHFTransactions(params: AccountHFTransactionsRequest): Promise<APISuccessResponse<SpotAccountTransaction[]>>;

Get Account Ledgers - trade_hf

This API endpoint returns all transfer (in and out) records in high-frequency trading account and supports multi-coin queries. The query results are sorted in descending order by createdAt and id.

Parameters ​

ParameterType
paramsAccountHFTransactionsRequest

Returns ​

Promise<APISuccessResponse<SpotAccountTransaction[]>>


getHistoricalDepositsV1() ​

ts
getHistoricalDepositsV1(params?: GetDepositsRequest): Promise<APISuccessResponse<V1HistoricalDeposits>>;

Parameters ​

ParameterType
params?GetDepositsRequest

Returns ​

Promise<APISuccessResponse<V1HistoricalDeposits>>

Deprecated ​

This method is deprecated. It is recommended to use the getDeposits() endpoint instead of this endpoint


getHistoricalWithdrawalsV1() ​

ts
getHistoricalWithdrawalsV1(params?: GetWithdrawalsRequest): Promise<APISuccessResponse<HistoricalWithdrawalsV1>>;

Parameters ​

ParameterType
params?GetWithdrawalsRequest

Returns ​

Promise<APISuccessResponse<HistoricalWithdrawalsV1>>

Deprecated ​

This method is deprecated. It is recommended to use the getWithdrawals() endpoint instead of this endpoint


getIsolatedMarginAccount() ​

ts
getIsolatedMarginAccount(params: object): Promise<APISuccessResponse<SingleIsolatedMarginAccountInfo>>;

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<SingleIsolatedMarginAccountInfo>>

Deprecated ​

SPOT Margin LF endpoint no longer available (2026.03.04). Use getIsolatedMarginBalance() instead.

See ​

https://www.kucoin.com/announcement/kucoin-margin-notice-250702


getIsolatedMarginAccounts() ​

ts
getIsolatedMarginAccounts(params?: object): Promise<APISuccessResponse<IsolatedMarginAccountInfo>>;

Parameters ​

ParameterType
params?{ balanceCurrency?: "USDT" | "BTC" | "KCS"; }
params.balanceCurrency?"USDT" | "BTC" | "KCS"

Returns ​

Promise<APISuccessResponse<IsolatedMarginAccountInfo>>

Deprecated ​

SPOT Margin LF endpoint no longer available (2026.03.04). Use getIsolatedMarginBalance() instead.

See ​

https://www.kucoin.com/announcement/kucoin-margin-notice-250702


getIsolatedMarginBalance() ​

ts
getIsolatedMarginBalance(params?: GetIsolatedMarginBalanceRequest): Promise<APISuccessResponse<IsolatedMarginBalance[]>>;

Get Account - Isolated Margin

Request isolated margin account info. Preferred queryType: ISOLATED. ISOLATED_V2 phased out gradually.

Parameters ​

ParameterType
params?GetIsolatedMarginBalanceRequest

Returns ​

Promise<APISuccessResponse<IsolatedMarginBalance[]>>


getIsolatedMarginSymbolsConfig() ​

ts
getIsolatedMarginSymbolsConfig(): Promise<APISuccessResponse<IsolatedMarginSymbolsConfig[]>>;

Get Symbols - Isolated Margin

This endpoint allows querying the configuration of isolated margin symbol.

Returns ​

Promise<APISuccessResponse<IsolatedMarginSymbolsConfig[]>>


getKlines() ​

ts
getKlines(params: GetSpotKlinesRequest): Promise<APISuccessResponse<Kline[]>>;

Get Klines

Get the Kline of the symbol. Data are returned in grouped buckets based on requested type.

Parameters ​

ParameterType
paramsGetSpotKlinesRequest

Returns ​

Promise<APISuccessResponse<Kline[]>>

See ​

Read public market data


getKumining() ​

ts
getKumining(params?: GetKuminingRequest): Promise<APISuccessResponse<KuminingItem[]>>;

Get Kumining

The kumining information can be obtained at this endpoint.

Parameters ​

ParameterType
params?GetKuminingRequest

Returns ​

Promise<APISuccessResponse<KuminingItem[]>>


getKYCRegions() ​

ts
getKYCRegions(): Promise<APISuccessResponse<KYCRegion[]>>;

Get KYC Regions

This endpoint can be used to obtain this user's KYC regions.

Returns ​

Promise<APISuccessResponse<KYCRegion[]>>


getLendingCurrencyV3() ​

ts
getLendingCurrencyV3(params?: object): Promise<APISuccessResponse<LendingCurrencyV3>>;

Get Loan Market

This API endpoint is used to get the information about the currencies available for lending.

Parameters ​

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

Returns ​

Promise<APISuccessResponse<LendingCurrencyV3>>

Deprecated ​

KuCoin removed this endpoint on 21 Oct 2026. Calls will fail.


getLendingInterestRateV3() ​

ts
getLendingInterestRateV3(params: object): Promise<APISuccessResponse<object[]>>;

Get Loan Market Interest Rate

This API endpoint is used to get the interest rates of the margin lending market over the past 7 days.

Parameters ​

ParameterType
params{ currency: string; }
params.currencystring

Returns ​

Promise<APISuccessResponse<object[]>>

Deprecated ​

KuCoin removed this endpoint on 21 Oct 2026. Calls will fail.


getLendingRedemptionOrdersV3() ​

ts
getLendingRedemptionOrdersV3(params: GetLendingRedemptionOrdersV3Request): Promise<APISuccessResponse<LendingRedemption>>;

Get Redeem Orders

This API endpoint provides pagination query for the redeem orders.

Parameters ​

ParameterType
paramsGetLendingRedemptionOrdersV3Request

Returns ​

Promise<APISuccessResponse<LendingRedemption>>

Deprecated ​

KuCoin removed this endpoint on 21 Oct 2026. Calls will fail.


getLendingSubscriptionOrdersV3() ​

ts
getLendingSubscriptionOrdersV3(params: GetLendingSubscriptionOrdersV3Request): Promise<APISuccessResponse<LendingRedemption>>;

Get Purchase Orders

This API endpoint provides pagination query for the purchase orders.

Parameters ​

ParameterType
paramsGetLendingSubscriptionOrdersV3Request

Returns ​

Promise<APISuccessResponse<LendingRedemption>>

Deprecated ​

KuCoin removed this endpoint on 21 Oct 2026. Calls will fail.


getMarginActivePairsV3() ​

ts
getMarginActivePairsV3(params?: object): Promise<APISuccessResponse<{
  items: MarginActivePairsV3[];
  timestamp: number;
}>>;

Get Symbols - Cross Margin

This endpoint allows querying the configuration of cross margin symbol.

Parameters ​

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

Returns ​

Promise<APISuccessResponse<{ items: MarginActivePairsV3[]; timestamp: number; }>>


getMarginBalance() ​

ts
getMarginBalance(params?: GetMarginBalanceRequest): Promise<APISuccessResponse<MarginBalance>>;

Get Account - Cross Margin

Request cross margin account info. Preferred queryType: MARGIN. MARGIN_V2 phased out gradually.

Parameters ​

ParameterType
params?GetMarginBalanceRequest

Returns ​

Promise<APISuccessResponse<MarginBalance>>


getMarginBalances() ​

ts
getMarginBalances(): Promise<APISuccessResponse<{
  accounts: MarginAccountBalance[];
  debtRatio: string;
}>>;

Returns ​

Promise<APISuccessResponse<{ accounts: MarginAccountBalance[]; debtRatio: string; }>>

Deprecated ​

SPOT Margin LF endpoint no longer available (2026.03.04). Use getMarginBalance() instead.

See ​

https://www.kucoin.com/announcement/kucoin-margin-notice-250702


getMarginBorrowHistoryV3() ​

ts
getMarginBorrowHistoryV3(params: MarginHistoryV3Request): Promise<APISuccessResponse<MarginBorrowHistoryV3[]>>;

Get Borrow History

This API endpoint is used to get the borrowing orders for cross and isolated margin accounts

Parameters ​

ParameterType
paramsMarginHistoryV3Request

Returns ​

Promise<APISuccessResponse<MarginBorrowHistoryV3[]>>


getMarginCollateralRatio() ​

ts
getMarginCollateralRatio(params?: GetMarginCollateralRatioRequest): Promise<APISuccessResponse<MarginCollateralRatioData[]>>;

Get Margin Collateral Ratio

Request the margin collateral ratio. If currencyList is not specified, all currencies will be returned.

Parameters ​

ParameterType
params?GetMarginCollateralRatioRequest

Returns ​

Promise<APISuccessResponse<MarginCollateralRatioData[]>>


getMarginConfigInfo() ​

ts
getMarginConfigInfo(): Promise<APISuccessResponse<MarginConfigInfo>>;

Get Margin Config

Request via this endpoint to get the configure info of the cross margin.

Returns ​

Promise<APISuccessResponse<MarginConfigInfo>>


getMarginInterestRecordsV3() ​

ts
getMarginInterestRecordsV3(params?: MarginInterestRecordsRequest): Promise<APISuccessResponse<MarginInterestRecords>>;

Get Interest History

Request via this endpoint to get the interest records of the cross/isolated margin lending.

Parameters ​

ParameterType
params?MarginInterestRecordsRequest

Returns ​

Promise<APISuccessResponse<MarginInterestRecords>>


getMarginLeveragedToken() ​

ts
getMarginLeveragedToken(params?: object): Promise<APISuccessResponse<MarginLevTokenInfo[]>>;

Parameters ​

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

Returns ​

Promise<APISuccessResponse<MarginLevTokenInfo[]>>

Deprecated ​

Get ETF Info endpoint deprecated (2026.05.08). /api/v3/etf/info is no longer supported. Get ETF Info

This endpoint returns leveraged token information


getMarginMarkPrice() ​

ts
getMarginMarkPrice(params: object): Promise<APISuccessResponse<MarginMarkPrice>>;

Get Mark Price Detail

This endpoint returns the current Mark price for specified margin trading pairs.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<MarginMarkPrice>>


getMarginMarkPrices() ​

ts
getMarginMarkPrices(): Promise<APISuccessResponse<MarginMarkPrice[]>>;

Get Mark Price List

This endpoint returns the current Mark price for all margin trading pairs.

Returns ​

Promise<APISuccessResponse<MarginMarkPrice[]>>


getMarginOcoOrderByClientOid() ​

ts
getMarginOcoOrderByClientOid(params: GetMarginOcoOrderByClientOidRequest): Promise<APISuccessResponse<MarginOcoOrderItem>>;

Get Margin OCO Order By ClientOid

Request via this interface to get a oco order information via the client order ID.

Parameters ​

ParameterType
paramsGetMarginOcoOrderByClientOidRequest

Returns ​

Promise<APISuccessResponse<MarginOcoOrderItem>>


getMarginOcoOrderDetailByOrderId() ​

ts
getMarginOcoOrderDetailByOrderId(params: GetMarginOcoOrderDetailByOrderIdRequest): Promise<APISuccessResponse<MarginOcoOrderDetails>>;

Get Margin OCO Order Detail By OrderId

Request via this interface to get a oco order detail via the order ID.

Parameters ​

ParameterType
paramsGetMarginOcoOrderDetailByOrderIdRequest

Returns ​

Promise<APISuccessResponse<MarginOcoOrderDetails>>


getMarginRepayHistoryV3() ​

ts
getMarginRepayHistoryV3(params: MarginHistoryV3Request): Promise<APISuccessResponse<MarginRepayHistoryV3[]>>;

Get Repay History

This API endpoint is used to get the repayment orders for cross and isolated margin accounts

Parameters ​

ParameterType
paramsMarginHistoryV3Request

Returns ​

Promise<APISuccessResponse<MarginRepayHistoryV3[]>>


getMarginRiskLimitConfig() ​

ts
getMarginRiskLimitConfig(params: MarginRiskLimitRequest): Promise<APISuccessResponse<MarginRiskLimit[]>>;

Get Margin Risk Limit

Request via this endpoint to get the Configure and Risk limit info of the margin.

Parameters ​

ParameterType
paramsMarginRiskLimitRequest

Returns ​

Promise<APISuccessResponse<MarginRiskLimit[]>>


getMarginStopOrderByClientOid() ​

ts
getMarginStopOrderByClientOid(params: GetMarginStopOrderByClientOidRequest): Promise<APISuccessResponse<MarginStopOrderItem>>;

Get Margin Stop Order By ClientOid

Request via this interface to get a stop order information via the clientOid.

Parameters ​

ParameterType
paramsGetMarginStopOrderByClientOidRequest

Returns ​

Promise<APISuccessResponse<MarginStopOrderItem>>


getMarginStopOrderByOrderId() ​

ts
getMarginStopOrderByOrderId(params: GetMarginStopOrderByOrderIdRequest): Promise<APISuccessResponse<MarginStopOrderItem>>;

Get Margin Stop Order By OrderId

Request via this interface to get a stop order information via the order ID.

Parameters ​

ParameterType
paramsGetMarginStopOrderByOrderIdRequest

Returns ​

Promise<APISuccessResponse<MarginStopOrderItem>>


getMarginStopOrdersList() ​

ts
getMarginStopOrdersList(params?: GetMarginStopOrdersListRequest): Promise<APISuccessResponse<MarginStopOrdersList>>;

Get Margin Stop Orders List

Request via this endpoint to get your current untriggered stop order list.

Parameters ​

ParameterType
params?GetMarginStopOrdersListRequest

Returns ​

Promise<APISuccessResponse<MarginStopOrdersList>>


getMarketAvailableInventory() ​

ts
getMarketAvailableInventory(params?: object): Promise<APISuccessResponse<MarketAvailableInventoryItem[]>>;

Get Market Available Inventory

Request the platform available inventory

Parameters ​

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

Returns ​

Promise<APISuccessResponse<MarketAvailableInventoryItem[]>>


getMarkets() ​

ts
getMarkets(): Promise<APISuccessResponse<string[]>>;

Get Market List

Request via this endpoint to get the transaction currency for the entire trading market.

Returns ​

Promise<APISuccessResponse<string[]>>


getMyIp() ​

ts
getMyIp(): Promise<APISuccessResponse<number>>;

Returns ​

Promise<APISuccessResponse<number>>


getOCOOrderByClientOid() ​

ts
getOCOOrderByClientOid(params: object): Promise<APISuccessResponse<OCOOrderListItem>>;

Get OCO Order By ClientOid

Request via this endpoint to get a oco order information via the clientOid.

Parameters ​

ParameterType
params{ clientOid: string; }
params.clientOidstring

Returns ​

Promise<APISuccessResponse<OCOOrderListItem>>


getOCOOrderByOrderId() ​

ts
getOCOOrderByOrderId(params: object): Promise<APISuccessResponse<OCOOrderListItem>>;

Get OCO Order By OrderId

Request via this endpoint to get a oco order information via the order ID.

Parameters ​

ParameterType
params{ orderId: string; }
params.orderIdstring

Returns ​

Promise<APISuccessResponse<OCOOrderListItem>>


getOCOOrderDetails() ​

ts
getOCOOrderDetails(params: object): Promise<APISuccessResponse<OCOOrderDetails>>;

Get OCO Order Details

Request via this endpoint to get a oco order information via the order ID.

Parameters ​

ParameterType
params{ orderId: string; }
params.orderIdstring

Returns ​

Promise<APISuccessResponse<OCOOrderDetails>>


getOCOOrders() ​

ts
getOCOOrders(params: GetOCOOrdersRequest): Promise<APISuccessResponse<OCOOrders>>;

Get OCO Order List

Request via this endpoint to get your current OCO order list.

Parameters ​

ParameterType
paramsGetOCOOrdersRequest

Returns ​

Promise<APISuccessResponse<OCOOrders>>


getOrderBookLevel100() ​

ts
getOrderBookLevel100(params: object): Promise<APISuccessResponse<OrderBookLevel>>;

Get Part OrderBook

Query for part orderbook depth data. Level 100(aggregated by price)

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<OrderBookLevel>>


getOrderBookLevel20() ​

ts
getOrderBookLevel20(params: object): Promise<APISuccessResponse<OrderBookLevel>>;

Get Part OrderBook

Query for part orderbook depth data. Level 20(aggregated by price)

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<OrderBookLevel>>

See ​

Read public market data


getOrderByClientOid() ​

ts
getOrderByClientOid(params: object): Promise<APISuccessResponse<SpotOrder>>;

Parameters ​

ParameterType
params{ clientOid: string; }
params.clientOidstring

Returns ​

Promise<APISuccessResponse<SpotOrder>>

Deprecated ​

This method is deprecated. It is recommended to use the getHFOrderDetailsByClientOid() instead of this endpoint


getOrderByOrderId() ​

ts
getOrderByOrderId(params: object): Promise<APISuccessResponse<SpotOrder>>;

Parameters ​

ParameterType
params{ orderId: string; }
params.orderIdstring

Returns ​

Promise<APISuccessResponse<SpotOrder>>

Deprecated ​

This method is deprecated. It is recommended to use the getHFOrderDetailsByOrderId() instead of this endpoint


getOrders() ​

ts
getOrders(params?: GetOrderListRequest): Promise<APISuccessResponse<SpotOrderList>>;

Parameters ​

ParameterType
params?GetOrderListRequest

Returns ​

Promise<APISuccessResponse<SpotOrderList>>

Deprecated ​

This method is deprecated. It is recommended to use the getHfOrderDetails() endpoint instead of this endpoint


getOtcLoan() ​

ts
getOtcLoan(): Promise<APISuccessResponse<OtcLoan>>;

Get Account Detail - VIP Lending

The following information is only applicable to loans. Get information on off-exchange funding and loans. This endpoint is only for querying accounts that are currently involved in loans.

Returns ​

Promise<APISuccessResponse<OtcLoan>>


getOtcLoanAccounts() ​

ts
getOtcLoanAccounts(): Promise<APISuccessResponse<OtcLoanAccount[]>>;

Get Accounts - VIP Lending

Accounts participating in OTC lending, This endpoint is only for querying accounts currently running OTC lending.

Returns ​

Promise<APISuccessResponse<OtcLoanAccount[]>>


getPrivate() ​

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

Parameters ​

ParameterType
endpointstring
params?any

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.getPrivate


getPrivateWSConnectionToken() ​

ts
getPrivateWSConnectionToken(): Promise<APISuccessResponse<WsConnectionInfo>>;

Private V1 WS Connection Token & URL

Returns ​

Promise<APISuccessResponse<WsConnectionInfo>>

See ​

Follow private account updates


getPrivateWSConnectionTokenV2() ​

ts
getPrivateWSConnectionTokenV2(): Promise<APISuccessResponse<WsConnectionInfo>>;

Fetch connection token for V2 (Pro) private connections. Not needed for public. Only returns token, no URL.

Returns ​

Promise<APISuccessResponse<WsConnectionInfo>>


getPublicWSConnectionToken() ​

ts
getPublicWSConnectionToken(): Promise<APISuccessResponse<WsConnectionInfo>>;

Public V1 WS Connection Token & URL

Returns ​

Promise<APISuccessResponse<WsConnectionInfo>>


getRecentFills() ​

ts
getRecentFills(): Promise<APISuccessResponse<SpotOrderFill[]>>;

Returns ​

Promise<APISuccessResponse<SpotOrderFill[]>>

Deprecated ​

This method is deprecated. It is recommended to use the getHFFilledOrders() instead of this endpoint


getRecentOrders() ​

ts
getRecentOrders(params?: object): Promise<APISuccessResponse<SpotOrder[]>>;

Parameters ​

ParameterType
params?{ currentPage?: number; pageSize?: number; }
params.currentPage?number
params.pageSize?number

Returns ​

Promise<APISuccessResponse<SpotOrder[]>>

Deprecated ​

This method is deprecated. It is recommended to use the getHFOrders() endpoint instead of this endpoint


getServerTime() ​

ts
getServerTime(): Promise<APISuccessResponse<number>>;

Returns ​

Promise<APISuccessResponse<number>>


getServiceStatus() ​

ts
getServiceStatus(): Promise<APISuccessResponse<ServiceStatus>>;

Returns ​

Promise<APISuccessResponse<ServiceStatus>>


getStopOrderByClientOid() ​

ts
getStopOrderByClientOid(params: object): Promise<APISuccessResponse<StopOrderItem[]>>;

Get Stop Order By ClientOid

Parameters ​

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

Returns ​

Promise<APISuccessResponse<StopOrderItem[]>>


getStopOrderByOrderId() ​

ts
getStopOrderByOrderId(params: object): Promise<APISuccessResponse<StopOrderItem>>;

Get Stop Order By OrderId

Request via this endpoint to get a stop order information via the order ID.

Parameters ​

ParameterType
params{ orderId: string; }
params.orderIdstring

Returns ​

Promise<APISuccessResponse<StopOrderItem>>


getStopOrders() ​

ts
getStopOrders(params?: GetStopOrdersListRequest): Promise<APISuccessResponse<StopOrders>>;

Get Stop Orders List

Request via this endpoint to get your current untriggered stop order list.

Parameters ​

ParameterType
params?GetStopOrdersListRequest

Returns ​

Promise<APISuccessResponse<StopOrders>>


getStructuredProductOrders() ​

ts
getStructuredProductOrders(params: GetStructuredProductOrdersRequest): Promise<APISuccessResponse<StructuredProductOrders>>;

Get Structured Product Orders

This endpoint is to query structured product orders

Parameters ​

ParameterType
paramsGetStructuredProductOrdersRequest

Returns ​

Promise<APISuccessResponse<StructuredProductOrders>>


getSubAccountBalance() ​

ts
getSubAccountBalance(params: object): Promise<APISuccessResponse<SubAccountBalance>>;

Get sub-account Detail - Balance

This endpoint returns the account info of a sub-user specified by the subUserId.

Parameters ​

ParameterType
params{ baseAmount?: string; baseCurrency?: string; includeBaseAmount: boolean; subUserId: string; }
params.baseAmount?string
params.baseCurrency?string
params.includeBaseAmountboolean
params.subUserIdstring

Returns ​

Promise<APISuccessResponse<SubAccountBalance>>


getSubAccountBalancesV1() ​

ts
getSubAccountBalancesV1(): Promise<APISuccessResponse<SubAccountBalance>>;

Returns ​

Promise<APISuccessResponse<SubAccountBalance>>

Deprecated ​

This method is deprecated. It is recommended to use the getSubAccountsV2() endpoint instead of this endpoint


getSubAccountBalancesV2() ​

ts
getSubAccountBalancesV2(params?: object): Promise<APISuccessResponse<SubAccountBalancesV2>>;

Get SubAccount List - Spot Balance(V2)

This endpoint can be used to get paginated Spot sub-account information. Pagination is required.

Parameters ​

ParameterType
params?{ currentPage?: number; pageSize?: number; }
params.currentPage?number
params.pageSize?number

Returns ​

Promise<APISuccessResponse<SubAccountBalancesV2>>


getSubAccountsV1() ​

ts
getSubAccountsV1(): Promise<APISuccessResponse<SubAccountInfo[]>>;

Returns ​

Promise<APISuccessResponse<SubAccountInfo[]>>

Deprecated ​

This method is deprecated. It is recommended to use the getSubAccountsV2() endpoint instead of this endpoint


getSubAccountsV2() ​

ts
getSubAccountsV2(params?: object): Promise<APISuccessResponse<SubAccountsV2>>;

Get SubAccount List - Summary Info

This endpoint can be used to get a paginated list of sub-accounts. Pagination is required.

Parameters ​

ParameterType
params?{ currentPage?: number; pageSize?: number; }
params.currentPage?number
params.pageSize?number

Returns ​

Promise<APISuccessResponse<SubAccountsV2>>


getSubAPIs() ​

ts
getSubAPIs(params: object): Promise<APISuccessResponse<SubAccountAPIInfo[]>>;

Get SubAccount API List

This endpoint can be used to obtain a list of APIs pertaining to a sub-account. (Not contain ND Broker Sub Account)

Parameters ​

ParameterType
params{ apiKey?: string; subName: string; }
params.apiKey?string
params.subNamestring

Returns ​

Promise<APISuccessResponse<SubAccountAPIInfo[]>>


getSymbol() ​

ts
getSymbol(params: object): Promise<APISuccessResponse<SymbolInfo>>;

Get Symbol

Request via this endpoint to get detail currency pairs for trading. If you want to get the market information of the trading symbol, please use Get All Tickers.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<SymbolInfo>>


getSymbols() ​

ts
getSymbols(params?: object): Promise<APISuccessResponse<SymbolInfo[]>>;

Get All Symbols

Request via this endpoint to get detail currency pairs for trading. If you want to get the market information of the trading symbol, please use Get All Tickers.

Parameters ​

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

Returns ​

Promise<APISuccessResponse<SymbolInfo[]>>

See ​

Read public market data


getTicker() ​

ts
getTicker(params: object): Promise<APISuccessResponse<Ticker>>;

Get Ticker

Request via this endpoint to get Level 1 Market Data. The returned value includes the best bid price and size, the best ask price and size as well as the last traded price and the last traded size.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<Ticker>>

See ​

Read a public ticker


getTickers() ​

ts
getTickers(): Promise<APISuccessResponse<AllTickers>>;

Get All Tickers

Request market tickers for all the trading pairs in the market (including 24h volume), takes a snapshot every 2 seconds.

Returns ​

Promise<APISuccessResponse<AllTickers>>


getTradeHistories() ​

ts
getTradeHistories(params: object): Promise<APISuccessResponse<TradeHistory[]>>;

Get Trade History

Request via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<TradeHistory[]>>


getTradingPairFee() ​

ts
getTradingPairFee(params: object): Promise<APISuccessResponse<object[]>>;

Get Actual Fee - Spot/Margin

This endpoint is for the actual fee rate of the trading pair. You can inquire about fee rates of 10 trading pairs each time at most. The fee rate of your sub-account is the same as that of the master account.

Parameters ​

ParameterType
params{ symbol: string; }
params.symbolstring

Returns ​

Promise<APISuccessResponse<object[]>>


getTransactions() ​

ts
getTransactions(params?: GetSpotTransactionsRequest): Promise<APISuccessResponse<SpotAccountTransactions>>;

Get Account Ledgers - Spot/Margin

This endpoint is for transaction records from all types of your accounts, supporting inquiry of various currencies. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.

Parameters ​

ParameterType
params?GetSpotTransactionsRequest

Returns ​

Promise<APISuccessResponse<SpotAccountTransactions>>


getTransferable() ​

ts
getTransferable(params: GetTransferableRequest): Promise<APISuccessResponse<TransferableFunds>>;

Get Transfer Quotas

This endpoint returns the transferable balance of a specified account. Preferred type: MARGIN, ISOLATED. V2 (MARGIN_V2, ISOLATED_V2) phased out gradually.

Parameters ​

ParameterType
paramsGetTransferableRequest

Returns ​

Promise<APISuccessResponse<TransferableFunds>>


getUserType() ​

ts
getUserType(): Promise<APISuccessResponse<boolean>>;

Get Account Type - Spot

This endpoint determines whether the current user is a spot high-frequency user or a spot low-frequency user.

Returns ​

Promise<APISuccessResponse<boolean>>


getWithdrawalById() ​

ts
getWithdrawalById(params: object): Promise<APISuccessResponse<WithdrawalById>>;

Get Withdrawal History By ID

Request a withdrawal history by id via this endpoint.

Parameters ​

ParameterType
params{ withdrawalId: string; }
params.withdrawalIdstring

Returns ​

Promise<APISuccessResponse<WithdrawalById>>


getWithdrawalQuotas() ​

ts
getWithdrawalQuotas(params: object): Promise<APISuccessResponse<WithdrawalQuotas>>;

Get Withdrawal Quotas

This endpoint can obtain the withdrawal quotas information of this currency.

Parameters ​

ParameterType
params{ chain?: string; currency: string; }
params.chain?string
params.currencystring

Returns ​

Promise<APISuccessResponse<WithdrawalQuotas>>


getWithdrawals() ​

ts
getWithdrawals(params?: GetWithdrawalsRequest): Promise<APISuccessResponse<Withdrawals>>;

Get Withdrawal History

Request via this endpoint to get withdrawal list Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.

Parameters ​

ParameterType
params?GetWithdrawalsRequest

Returns ​

Promise<APISuccessResponse<Withdrawals>>


hasAccessToken() ​

ts
hasAccessToken(): boolean;

Returns ​

boolean

Inherited from ​

BaseRestClient.hasAccessToken


marginBorrowV3() ​

ts
marginBorrowV3(params: MarginBorrowV3Request): Promise<APISuccessResponse<MarginOrderV3>>;

Borrow

This API endpoint is used to initiate an application for cross or isolated margin borrowing.

Parameters ​

ParameterType
paramsMarginBorrowV3Request

Returns ​

Promise<APISuccessResponse<MarginOrderV3>>


marginRepayV3() ​

ts
marginRepayV3(params: MarginRepayV3Request): Promise<APISuccessResponse<MarginOrderV3>>;

Repay

This API endpoint is used to initiate an application for cross or isolated margin repayment.

Parameters ​

ParameterType
paramsMarginRepayV3Request

Returns ​

Promise<APISuccessResponse<MarginOrderV3>>


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, 
   internalReqContext?: InternalRequestContext
): Promise<any>;

Parameters ​

ParameterType
endpointstring
params?any
internalReqContext?InternalRequestContext

Returns ​

Promise<any>

Inherited from ​

BaseRestClient.postPrivate


setAccessToken() ​

ts
setAccessToken(newAccessToken: string): void;

Parameters ​

ParameterType
newAccessTokenstring

Returns ​

void

Inherited from ​

BaseRestClient.setAccessToken


submitConvertLimitOrder() ​

ts
submitConvertLimitOrder(params: AddConvertLimitOrderRequest): Promise<APISuccessResponse<SumbitConvertLimitResp>>;

Add Convert Limit Order

Place Convert Limit Order

Parameters ​

ParameterType
paramsAddConvertLimitOrderRequest

Returns ​

Promise<APISuccessResponse<SumbitConvertLimitResp>>


submitConvertOrder() ​

ts
submitConvertOrder(params: AddConvertOrderRequest): Promise<APISuccessResponse<SubmitConvertOrderResponse>>;

Add Convert Order

Place market order for convert

Parameters ​

ParameterType
paramsAddConvertOrderRequest

Returns ​

Promise<APISuccessResponse<SubmitConvertOrderResponse>>


submitFlexTransfer() ​

ts
submitFlexTransfer(params: FlexTransferRequest): Promise<APISuccessResponse<{
  orderId: string;
}>>;

Flex Transfer

Transfers between master/sub accounts and inner transfers. Preferred account types: MARGIN, ISOLATED. For non-INTERNAL type, use MARGIN/ISOLATED (not MARGIN_V2/ISOLATED_V2).

Parameters ​

ParameterType
paramsFlexTransferRequest

Returns ​

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


submitHFMarginOrder() ​

ts
submitHFMarginOrder(params: SubmitHFMarginOrderRequest): Promise<APISuccessResponse<MarginSubmitOrderV3Response>>;

Add Order

Place order to the Cross-margin or Isolated-margin trading system

Parameters ​

ParameterType
paramsSubmitHFMarginOrderRequest

Returns ​

Promise<APISuccessResponse<MarginSubmitOrderV3Response>>


submitHFMarginOrderTest() ​

ts
submitHFMarginOrderTest(params: SubmitHFMarginOrderRequest): Promise<MarginSubmitOrderV3Response>;

Add Order Test

This endpoint is used to test the order submission.

Parameters ​

ParameterType
paramsSubmitHFMarginOrderRequest

Returns ​

Promise<MarginSubmitOrderV3Response>


submitHFMultipleOrders() ​

ts
submitHFMultipleOrders(params: object): Promise<APISuccessResponse<SubmitMultipleHFOrdersResponse[]>>;

Batch Add Orders

This endpoint supports sequential batch order placement from a single endpoint. A maximum of 20 orders can be placed simultaneously.

Parameters ​

ParameterType
params{ orderList: SubmitHFOrderRequest[]; }
params.orderListSubmitHFOrderRequest[]

Returns ​

Promise<APISuccessResponse<SubmitMultipleHFOrdersResponse[]>>


submitHFMultipleOrdersSync() ​

ts
submitHFMultipleOrdersSync(params: object): Promise<APISuccessResponse<SubmitMultipleHFOrdersSyncResponse[]>>;

Batch Add Orders Sync

This endpoint supports sequential batch order placement from a single endpoint. A maximum of 20 orders can be placed simultaneously. The difference between this endpoint and "submitHFMultipleOrders()" is that this endpoint will synchronously return the order information after the order matching is completed.

Parameters ​

ParameterType
params{ orderList: SubmitHFOrderRequest[]; }
params.orderListSubmitHFOrderRequest[]

Returns ​

Promise<APISuccessResponse<SubmitMultipleHFOrdersSyncResponse[]>>


submitHFOrder() ​

ts
submitHFOrder(params: SubmitHFOrderRequest): Promise<APISuccessResponse<{
  clientOid: string;
  orderId: string;
}>>;

Add Order

Place order to the Spot trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.

Parameters ​

ParameterType
paramsSubmitHFOrderRequest

Returns ​

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

See ​

Manage Spot orders and recover uncertain outcomes


submitHFOrderSync() ​

ts
submitHFOrderSync(params: SubmitHFOrderRequest): Promise<APISuccessResponse<SubmitHFOrderSyncResponse>>;

Add Order Sync

Place order to the spot trading system

The difference between this endpoint and "SubmitHFOrder()" is that this endpoint will synchronously return the order information after the order matching is completed.

Parameters ​

ParameterType
paramsSubmitHFOrderRequest

Returns ​

Promise<APISuccessResponse<SubmitHFOrderSyncResponse>>


submitHFOrderTest() ​

ts
submitHFOrderTest(params: SubmitHFOrderRequest): Promise<any>;

Add Order Test

Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried.

Parameters ​

ParameterType
paramsSubmitHFOrderRequest

Returns ​

Promise<any>

See ​

Validate an order without matching


submitInnerTransfer() ​

ts
submitInnerTransfer(params: InnerTransferRequest): Promise<APISuccessResponse<{
  orderId: string;
}>>;

Parameters ​

ParameterType
paramsInnerTransferRequest

Returns ​

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

Deprecated ​

This method is deprecated. It is recommended to use the submitFlexTransfer() endpoint instead of this endpoint


submitLendingRedemptionV3() ​

ts
submitLendingRedemptionV3(params: InitiateLendingRedemptionV3Request): Promise<APISuccessResponse<object[]>>;

Redeem

Redeem your loan order

Parameters ​

ParameterType
paramsInitiateLendingRedemptionV3Request

Returns ​

Promise<APISuccessResponse<object[]>>

Deprecated ​

KuCoin removed this endpoint on 21 Oct 2026. Calls will fail.


submitLendingSubscriptionV3() ​

ts
submitLendingSubscriptionV3(params: InitiateLendingSubscriptionV3Request): Promise<APISuccessResponse<object[]>>;

Purchase

Invest credit in the market and earn interest,Please ensure that the funds are in the main(funding) account

Parameters ​

ParameterType
paramsInitiateLendingSubscriptionV3Request

Returns ​

Promise<APISuccessResponse<object[]>>

Deprecated ​

KuCoin removed this endpoint on 21 Oct 2026. Calls will fail.


submitMarginOrder() ​

ts
submitMarginOrder(params: SubmitMarginOrderRequest): Promise<APISuccessResponse<SubmitMarginOrderResponse>>;

Parameters ​

ParameterType
paramsSubmitMarginOrderRequest

Returns ​

Promise<APISuccessResponse<SubmitMarginOrderResponse>>

Deprecated ​

SPOT Margin LF endpoint no longer available (2026.03.04). Use submitHFMarginOrder() instead.

See ​

https://www.kucoin.com/announcement/kucoin-margin-notice-250702


submitMarginOrderTest() ​

ts
submitMarginOrderTest(): Promise<any>;

Returns ​

Promise<any>

Deprecated ​

SPOT Margin LF endpoint no longer available (2026.03.04). Use submitHFMarginOrderTest() instead.

See ​

https://www.kucoin.com/announcement/kucoin-margin-notice-250702


submitMultipleOrders() ​

ts
submitMultipleOrders(params: object): Promise<APISuccessResponse<MultipleOrdersResponse[]>>;

Parameters ​

ParameterType
params{ orderList: SubmitMultipleOrdersRequest[]; symbol: string; }
params.orderListSubmitMultipleOrdersRequest[]
params.symbolstring

Returns ​

Promise<APISuccessResponse<MultipleOrdersResponse[]>>

Deprecated ​

This method is deprecated. It is recommended to use the submitMultipleHFOrders() endpoint instead of this endpoint


submitOCOOrder() ​

ts
submitOCOOrder(params: SubmitOCOOrderRequest): Promise<APISuccessResponse<{
  orderId: string;
}>>;

Add OCO Order

Place OCO order to the Spot trading system

Parameters ​

ParameterType
paramsSubmitOCOOrderRequest

Returns ​

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


submitOrder() ​

ts
submitOrder(params: SubmitOrderRequest): Promise<APISuccessResponse<{
  orderId: string;
}>>;

Parameters ​

ParameterType
paramsSubmitOrderRequest

Returns ​

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

Deprecated ​

This method is deprecated. It is recommended to use the submitHFOrder() endpoint instead of this endpoint


submitOrderTest() ​

ts
submitOrderTest(): Promise<any>;

Returns ​

Promise<any>

Deprecated ​

This method is deprecated. It is recommended to use the submitHFOrderTest() endpoint instead of this endpoint


submitRedemption() ​

ts
submitRedemption(params: InitiateRedemptionRequest): Promise<APISuccessResponse<InitiateRedemptionResponse>>;

Earn Redeem

This endpoint allows initiating redemption by holding ID. If the current holding is fully redeemed or in the process of being redeemed, it indicates that the holding does not exist.

Parameters ​

ParameterType
paramsInitiateRedemptionRequest

Returns ​

Promise<APISuccessResponse<InitiateRedemptionResponse>>


submitStopOrder() ​

ts
submitStopOrder(params: SubmitStopOrderRequest): Promise<APISuccessResponse<{
  clientOid: string;
  orderId: string;
}>>;

Add Stop Order

Place stop order to the Spot trading system.

Parameters ​

ParameterType
paramsSubmitStopOrderRequest

Returns ​

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


submitStructuredProductPurchase() ​

ts
submitStructuredProductPurchase(params: StructuredProductPurchaseRequest): Promise<APISuccessResponse<StructuredProductPurchaseResponse>>;

Structured Product Purchase

This endpoint allows you to subscribe Struct-Earn products.

Parameters ​

ParameterType
paramsStructuredProductPurchaseRequest

Returns ​

Promise<APISuccessResponse<StructuredProductPurchaseResponse>>


submitTransferMasterSub() ​

ts
submitTransferMasterSub(params: submitTransferMasterSubRequest): Promise<APISuccessResponse<{
  orderId: string;
}>>;

Parameters ​

ParameterType
paramssubmitTransferMasterSubRequest

Returns ​

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

Deprecated ​

This method is deprecated. It is recommended to use the submitFlexTransfer() endpoint instead of this endpoint


submitWithdraw() ​

ts
submitWithdraw(params: ApplyWithdrawRequest): Promise<APISuccessResponse<{
  withdrawalId: string;
}>>;

Parameters ​

ParameterType
paramsApplyWithdrawRequest

Returns ​

Promise<APISuccessResponse<{ withdrawalId: string; }>>

Deprecated ​

This method is deprecated. Please use submitWithdrawV3() instead.


submitWithdrawV3() ​

ts
submitWithdrawV3(params: SubmitWithdrawV3Request): Promise<APISuccessResponse<{
  withdrawalId: string;
}>>;

Withdraw(V3)

Use this endpoint to withdraw the specified currency

Parameters ​

ParameterType
paramsSubmitWithdrawV3Request

Returns ​

Promise<APISuccessResponse<{ withdrawalId: string; }>>


subscribeEarnFixedIncome() ​

ts
subscribeEarnFixedIncome(params: SubscribeEarnFixedIncomeRequest): Promise<APISuccessResponse<SubscribeEarnFixedIncomeResponse>>;

/**

  • Earn Purchase
  • This endpoint allows subscribing earn product

Parameters ​

ParameterType
paramsSubscribeEarnFixedIncomeRequest

Returns ​

Promise<APISuccessResponse<SubscribeEarnFixedIncomeResponse>>


updateHFOrder() ​

ts
updateHFOrder(params: ModifyHFOrderRequest): Promise<APISuccessResponse<{
  clientOid: string;
  newOrderId: string;
}>>;

Modify Order

This endpoint can modify the price and quantity of the order according to orderId or clientOid.

Parameters ​

ParameterType
paramsModifyHFOrderRequest

Returns ​

Promise<APISuccessResponse<{ clientOid: string; newOrderId: string; }>>

See ​

Manage Spot orders and recover uncertain outcomes


updateLendingSubscriptionOrdersV3() ​

ts
updateLendingSubscriptionOrdersV3(params: ModifyLendingSubscriptionOrdersV3Request): Promise<any>;

Modify Purchase

This API endpoint is used to update the interest rates of subscription orders, which will take effect at the beginning of the next hour.

Parameters ​

ParameterType
paramsModifyLendingSubscriptionOrdersV3Request

Returns ​

Promise<any>

Deprecated ​

KuCoin removed this endpoint on 21 Oct 2026. Calls will fail.


updateMarginLeverageV3() ​

ts
updateMarginLeverageV3(params: object): Promise<APISuccessResponse<any>>;

Modify Leverage

This endpoint allows modifying the leverage multiplier for cross margin or isolated margin.

Parameters ​

ParameterType
params{ isIsolated?: boolean; leverage: string; symbol?: string; }
params.isIsolated?boolean
params.leveragestring
params.symbol?string

Returns ​

Promise<APISuccessResponse<any>>


updateSubAPI() ​

ts
updateSubAPI(params: UpdateSubAccountAPIRequest): Promise<APISuccessResponse<UpdateSubAPI>>;

Modify SubAccount API

This endpoint can be used to update APIs for sub-accounts.

Parameters ​

ParameterType
paramsUpdateSubAccountAPIRequest

Returns ​

Promise<APISuccessResponse<UpdateSubAPI>>

Built by Siebly. Open source SDKs for exchange APIs.