Class: SpotClient
Extends
BaseRestClient
Constructors
Constructor
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
| Parameter | Type | Description |
|---|---|---|
restClientOptions? | RestClientOptions | options to configure REST API connectivity |
networkOptions? | AxiosRequestConfig | HTTP networking options for axios |
Returns
SpotClient
Inherited from
BaseRestClient.constructor
Methods
addMarginOcoOrder()
addMarginOcoOrder(params: SubmitMarginOcoOrderRequest): Promise<APISuccessResponse<MarginOcoOrderResponse>>;Add Margin OCO Order
Place OCO order to the Margin trading system
Parameters
| Parameter | Type |
|---|---|
params | SubmitMarginOcoOrderRequest |
Returns
Promise<APISuccessResponse<MarginOcoOrderResponse>>
addMarginStopOrder()
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
| Parameter | Type |
|---|---|
params | SubmitMarginStopOrderRequest |
Returns
Promise<APISuccessResponse<MarginStopOrderResponse>>
batchCancelMarginOcoOrders()
batchCancelMarginOcoOrders(params?: BatchCancelMarginOcoOrdersRequest): Promise<APISuccessResponse<CancelMarginOrdersResponse>>;Batch Cancel Margin OCO Orders
This interface can batch cancel OCO orders through orderIds.
Parameters
| Parameter | Type |
|---|---|
params? | BatchCancelMarginOcoOrdersRequest |
Returns
Promise<APISuccessResponse<CancelMarginOrdersResponse>>
batchCancelMarginStopOrder()
batchCancelMarginStopOrder(params: BatchCancelMarginStopOrdersRequest): Promise<APISuccessResponse<CancelMarginOrdersResponse>>;Batch Cancel Margin Stop Orders
Request via this interface to cancel a batch of stop orders.
Parameters
| Parameter | Type |
|---|---|
params | BatchCancelMarginStopOrdersRequest |
Returns
Promise<APISuccessResponse<CancelMarginOrdersResponse>>
cancelAllOrders()
cancelAllOrders(params?: CancelAllOrdersRequest): Promise<APISuccessResponse<{
cancelledOrderIds: string[];
}>>;Parameters
| Parameter | Type |
|---|---|
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()
cancelConvertLimitOrder(params: CancelConvertLimitOrderRequest): Promise<APISuccessResponse<null>>;Cancel Convert Limit Order
Cancel Convert Limit Order
Parameters
| Parameter | Type |
|---|---|
params | CancelConvertLimitOrderRequest |
Returns
Promise<APISuccessResponse<null>>
cancelHFAllMarginOrders()
cancelHFAllMarginOrders(params: object): Promise<any>;Cancel All Orders By Symbol
This endpoint can cancel all open Margin orders by symbol
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; tradeType: string; } |
params.symbol | string |
params.tradeType | string |
Returns
Promise<any>
cancelHFAllOrders()
cancelHFAllOrders(): Promise<APISuccessResponse<CancelAllHFOrdersResponse>>;Cancel All Orders
This endpoint can cancel all spot orders for all symbol.
Returns
Promise<APISuccessResponse<CancelAllHFOrdersResponse>>
cancelHFAllOrdersBySymbol()
cancelHFAllOrdersBySymbol(params: object): Promise<APISuccessResponse<string>>;Cancel All Orders By Symbol
This endpoint can cancel all spot orders for specific symbol.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<string>>
cancelHFMarginOrder()
cancelHFMarginOrder(params: object): Promise<APISuccessResponse<{
orderId: string;
}>>;Cancel Order By OrderId
This endpoint can be used to cancel a margin order by orderId.
Parameters
| Parameter | Type |
|---|---|
params | { orderId: string; symbol: string; } |
params.orderId | string |
params.symbol | string |
Returns
Promise<APISuccessResponse<{ orderId: string; }>>
cancelHFMarginOrderByClientOid()
cancelHFMarginOrderByClientOid(params: object): Promise<APISuccessResponse<{
clientOid: string;
}>>;Cancel Order By ClientOid
This endpoint can be used to cancel a margin order by clientOid.
Parameters
| Parameter | Type |
|---|---|
params | { clientOid: string; symbol: string; } |
params.clientOid | string |
params.symbol | string |
Returns
Promise<APISuccessResponse<{ clientOid: string; }>>
cancelHFOrder()
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
| Parameter | Type |
|---|---|
params | { orderId: string; symbol: string; } |
params.orderId | string |
params.symbol | string |
Returns
Promise<APISuccessResponse<{ orderId: string; }>>
See
Manage Spot orders and recover uncertain outcomes
cancelHFOrderAutoSetting()
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
| Parameter | Type |
|---|---|
params | { symbols?: string; timeout: number; } |
params.symbols? | string |
params.timeout | number |
Returns
Promise<APISuccessResponse<{ currentTime: number; triggerTime: number; }>>
cancelHFOrderAutoSettingQuery()
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()
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
| Parameter | Type |
|---|---|
params | { clientOid: string; symbol: string; } |
params.clientOid | string |
params.symbol | string |
Returns
Promise<APISuccessResponse<{ clientOid: string; }>>
See
Manage Spot orders and recover uncertain outcomes
cancelHFOrdersNumber()
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
| Parameter | Type |
|---|---|
params | CancelSpecifiedNumberHFOrdersRequest |
Returns
Promise<{ cancelSize: string; orderId: string; }>
cancelHFOrderSync()
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
| Parameter | Type |
|---|---|
params | { orderId: string; symbol: string; } |
params.orderId | string |
params.symbol | string |
Returns
Promise<APISuccessResponse<SyncCancelHFOrderResponse>>
cancelHFOrderSyncByClientOId()
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
| Parameter | Type |
|---|---|
params | { clientOid: string; symbol: string; } |
params.clientOid | string |
params.symbol | string |
Returns
Promise<APISuccessResponse<SyncCancelHFOrderResponse>>
cancelMarginOcoOrderByClientOid()
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
| Parameter | Type |
|---|---|
params | CancelMarginOcoOrderByClientOidRequest |
Returns
Promise<APISuccessResponse<CancelMarginOrdersResponse>>
cancelMarginOcoOrderByOrderId()
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
| Parameter | Type |
|---|---|
params | CancelMarginOcoOrderByOrderIdRequest |
Returns
Promise<APISuccessResponse<CancelMarginOrdersResponse>>
cancelMarginStopOrderByClientOid()
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
| Parameter | Type |
|---|---|
params | CancelMarginStopOrderByClientOidRequest |
Returns
Promise<APISuccessResponse<CancelMarginOrdersResponse>>
cancelMarginStopOrderByOrderId()
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
| Parameter | Type |
|---|---|
params | { orderId: string; } |
params.orderId | string |
Returns
Promise<APISuccessResponse<CancelMarginOrdersResponse>>
cancelMultipleOCOOrders()
cancelMultipleOCOOrders(params?: object): Promise<APISuccessResponse<{
cancelledOrderIds: string[];
}>>;Batch Cancel OCO Order
This endpoint can batch cancel OCO orders through orderIds.
Parameters
| Parameter | Type |
|---|---|
params? | { orderIds?: string; symbol?: string; } |
params.orderIds? | string |
params.symbol? | string |
Returns
Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>
cancelOCOOrderByClientOid()
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
| Parameter | Type |
|---|---|
params | { clientOid: string; } |
params.clientOid | string |
Returns
Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>
cancelOCOOrderById()
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
| Parameter | Type |
|---|---|
params | { orderId: string; } |
params.orderId | string |
Returns
Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>
cancelOrderByClientOid()
cancelOrderByClientOid(params: object): Promise<APISuccessResponse<{
cancelledOrderId: string;
clientOid: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | { clientOid: string; } |
params.clientOid | string |
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()
cancelOrderById(params: object): Promise<APISuccessResponse<{
cancelledOrderIds: string[];
}>>;Parameters
| Parameter | Type |
|---|---|
params | { orderId: string; } |
params.orderId | string |
Returns
Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>
Deprecated
This method is deprecated. It is recommended to use the cancelHFOrder() endpoint instead of this endpoint
cancelStopOrderByClientOid()
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
| Parameter | Type |
|---|---|
params | { clientOid: string; symbol?: string; } |
params.clientOid | string |
params.symbol? | string |
Returns
Promise<APISuccessResponse<{ cancelledOrderId: string; clientOid: string; }>>
cancelStopOrderById()
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
| Parameter | Type |
|---|---|
params | { orderId: string; } |
params.orderId | string |
Returns
Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>
cancelStopOrders()
cancelStopOrders(params?: CancelStopOrdersRequest): Promise<APISuccessResponse<{
cancelledOrderIds: string[];
}>>;Batch Cancel Stop Orders
Request via this endpoint to cancel a batch of stop orders.
Parameters
| Parameter | Type |
|---|---|
params? | CancelStopOrdersRequest |
Returns
Promise<APISuccessResponse<{ cancelledOrderIds: string[]; }>>
cancelWithdrawal()
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
| Parameter | Type |
|---|---|
params | { withdrawalId: string; } |
params.withdrawalId | string |
Returns
Promise<APISuccessResponse<string | null>>
createDepositAddress()
createDepositAddress(params: object): Promise<APISuccessResponse<DepositAddress>>;Parameters
| Parameter | Type |
|---|---|
params | { chain?: string; currency: string; } |
params.chain? | string |
params.currency | string |
Returns
Promise<APISuccessResponse<DepositAddress>>
Deprecated
This method is deprecated. Please use createDepositAddressV3() instead.
createDepositAddressV3()
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
| Parameter | Type |
|---|---|
params | CreateDepositAddressV3Request |
Returns
Promise<APISuccessResponse<CreateDepositAddressV3Response>>
createSubAccount()
createSubAccount(params: CreateSubAccountRequest): Promise<APISuccessResponse<CreateSubAccount>>;Add SubAccount
This endpoint is used to create a sub-account.
Parameters
| Parameter | Type |
|---|---|
params | CreateSubAccountRequest |
Returns
Promise<APISuccessResponse<CreateSubAccount>>
createSubAPI()
createSubAPI(params: CreateSubAccountAPIRequest): Promise<APISuccessResponse<CreateSubAPI>>;Add SubAccount API
This endpoint can be used to create APIs for sub-accounts.
Parameters
| Parameter | Type |
|---|---|
params | CreateSubAccountAPIRequest |
Returns
Promise<APISuccessResponse<CreateSubAPI>>
deletePrivate()
deletePrivate(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.deletePrivate
deleteSubAPI()
deleteSubAPI(params: DeleteSubAccountAPIRequest): Promise<APISuccessResponse<DeleteSubAccountAPI>>;Delete SubAccount API
This endpoint can be used to delete an API for a sub-account.
Parameters
| Parameter | Type |
|---|---|
params | DeleteSubAccountAPIRequest |
Returns
Promise<APISuccessResponse<DeleteSubAccountAPI>>
enableSubAccountFutures()
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
| Parameter | Type |
|---|---|
params | { uid: string; } |
params.uid | string |
Returns
Promise<boolean | null>
enableSubAccountMargin()
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
| Parameter | Type |
|---|---|
params | { uid: string; } |
params.uid | string |
Returns
Promise<boolean | null>
fetchLatencySummary()
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()
generateNewOrderID(): string;Misc Utility Methods
Returns
string
get()
get(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.get
get24hrStats()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<Symbol24hrStats>>
getAccountDetail()
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
| Parameter | Type |
|---|---|
params | { accountId: any; } |
params.accountId | any |
Returns
Promise<APISuccessResponse<Account>>
getAccountSummary()
getAccountSummary(): Promise<APISuccessResponse<SpotAccountSummary>>;Get Account Summary Info
This endpoint can be used to obtain account summary information.
Returns
Promise<APISuccessResponse<SpotAccountSummary>>
getAccountSummaryV3()
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()
getAffiliateCommission(params?: GetAffiliateCommissionRequest): Promise<APISuccessResponse<AffiliateCommissionItem[]>>;Get Commission
My commission information can be obtained at this endpoint.
Parameters
| Parameter | Type |
|---|---|
params? | GetAffiliateCommissionRequest |
Returns
Promise<APISuccessResponse<AffiliateCommissionItem[]>>
getAffiliateInvitees()
getAffiliateInvitees(params?: GetAffiliateInviteesRequest): Promise<APISuccessResponse<AffiliateInvitees>>;Get Invited
Affiliate user invited information can be obtained at this endpoint.
Parameters
| Parameter | Type |
|---|---|
params? | GetAffiliateInviteesRequest |
Returns
Promise<APISuccessResponse<AffiliateInvitees>>
getAffiliateTradeHistory()
getAffiliateTradeHistory(params: GetAffiliateTradeHistoryRequest): Promise<APISuccessResponse<AffiliateTradeHistory>>;Get Trade History
Trade history information can be obtained at this endpoint.
Parameters
| Parameter | Type |
|---|---|
params | GetAffiliateTradeHistoryRequest |
Returns
Promise<APISuccessResponse<AffiliateTradeHistory>>
getAffiliateTransaction()
getAffiliateTransaction(params: GetAffiliateTransactionRequest): Promise<APISuccessResponse<AffiliateTransaction>>;Get Transaction
Transaction information can be obtained at this endpoint.
Parameters
| Parameter | Type |
|---|---|
params | GetAffiliateTransactionRequest |
Returns
Promise<APISuccessResponse<AffiliateTransaction>>
getAffiliateUserRebateInfo()
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()
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
| Parameter | Type |
|---|---|
params? | GetAnnouncementsRequest |
Returns
Promise<APISuccessResponse<Announcements>>
getApikeyInfo()
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()
getBalances(params?: GetBalancesRequest): Promise<APISuccessResponse<Balances[]>>;Get a list of acounts and their balance states (spot/margin/trade_hf)
Get Account List - Spot
Parameters
| Parameter | Type |
|---|---|
params? | GetBalancesRequest |
Returns
Promise<APISuccessResponse<Balances[]>>
See
getBasicUserFee()
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
| Parameter | Type |
|---|---|
params | { currencyType: number; } |
params.currencyType | number |
Returns
Promise<APISuccessResponse<{ makerFeeRate: string; takerFeeRate: string; }>>
getBorrowInterestRate()
getBorrowInterestRate(params?: GetBorrowInterestRateRequest): Promise<APISuccessResponse<BorrowInterestRate>>;Get Borrow Interest Rate
Query the borrowing interest rate through this interface.
Parameters
| Parameter | Type |
|---|---|
params? | GetBorrowInterestRateRequest |
Returns
Promise<APISuccessResponse<BorrowInterestRate>>
getBrokerRebateOrderDownloadLink()
getBrokerRebateOrderDownloadLink(params: object): Promise<APISuccessResponse<any>>;Get download link for broker rebate orders
trade type 1 = spot, trade type 2 = futures
Parameters
| Parameter | Type |
|---|---|
params | { begin: string; end: string; tradeType: 1 | 2; } |
params.begin | string |
params.end | string |
params.tradeType | 1 | 2 |
Returns
Promise<APISuccessResponse<any>>
Deprecated
Use getBrokerRebateOrderDownloadLinkV2 instead
getBrokerRebateOrderDownloadLinkV2()
getBrokerRebateOrderDownloadLinkV2(params: object): Promise<APISuccessResponse<any>>;Get download link for broker rebate orders
trade type SPOT = spot, FUTURE = futures
Parameters
| Parameter | Type |
|---|---|
params | { begin: string; end: string; tradeType: "SPOT" | "FUTURE"; } |
params.begin | string |
params.end | string |
params.tradeType | "SPOT" | "FUTURE" |
Returns
Promise<APISuccessResponse<any>>
getCallAuctionInfo()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<CallAuctionInfo>>
getCallAuctionPartOrderBook()
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
| Parameter | Type |
|---|---|
params | { size: 20 | 100; symbol: string; } |
params.size | 20 | 100 |
params.symbol | string |
Returns
Promise<APISuccessResponse<OrderBookLevel>>
getClientType()
getClientType(): RestClientType;Defines the client type (affecting how requests & signatures behave)
Returns
RestClientType
Overrides
BaseRestClient.getClientType
getConvertCurrencies()
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()
getConvertLimitOrder(params: GetConvertLimitOrderDetailRequest): Promise<APISuccessResponse<ConvertLimitOrder>>;Get Convert Limit Order Detail
Query convert limit order detail
Parameters
| Parameter | Type |
|---|---|
params | GetConvertLimitOrderDetailRequest |
Returns
Promise<APISuccessResponse<ConvertLimitOrder>>
getConvertLimitOrders()
getConvertLimitOrders(params?: GetConvertLimitOrdersRequest): Promise<APISuccessResponse<ConvertLimitOrdersList>>;Get Convert Limit Orders
Query Active and Historical Convert Limit Orders
Parameters
| Parameter | Type |
|---|---|
params? | GetConvertLimitOrdersRequest |
Returns
Promise<APISuccessResponse<ConvertLimitOrdersList>>
getConvertLimitQuote()
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
| Parameter | Type |
|---|---|
params | GetConvertLimitQuoteRequest |
Returns
Promise<APISuccessResponse<ConvertLimitQuote>>
getConvertOrder()
getConvertOrder(params: GetConvertOrderDetailRequest): Promise<APISuccessResponse<ConvertOrder>>;Get Convert Order Detail
Query convert market order details
Parameters
| Parameter | Type |
|---|---|
params | GetConvertOrderDetailRequest |
Returns
Promise<APISuccessResponse<ConvertOrder>>
getConvertOrderHistory()
getConvertOrderHistory(params?: GetConvertOrderHistoryRequest): Promise<APISuccessResponse<ConvertOrderHistory>>;Get Convert Order History
Query convert market order history
Parameters
| Parameter | Type |
|---|---|
params? | GetConvertOrderHistoryRequest |
Returns
Promise<APISuccessResponse<ConvertOrderHistory>>
getConvertQuote()
getConvertQuote(params: GetConvertQuoteRequest): Promise<APISuccessResponse<ConvertQuote>>;Get Convert Quote
Request via this endpoint to get the quote for convert.
Parameters
| Parameter | Type |
|---|---|
params | GetConvertQuoteRequest |
Returns
Promise<APISuccessResponse<ConvertQuote>>
getConvertSymbol()
getConvertSymbol(params: GetConvertSymbolRequest): Promise<APISuccessResponse<ConvertSymbol>>;Get Convert Symbol
Request via this endpoint to get detail currency pairs for convert.
Parameters
| Parameter | Type |
|---|---|
params | GetConvertSymbolRequest |
Returns
Promise<APISuccessResponse<ConvertSymbol>>
getCurrencies()
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()
getCurrency(params: object): Promise<APISuccessResponse<CurrencyInfo>>;Get Currency
Request via this endpoint to get the currency details of a specified currency.
Parameters
| Parameter | Type |
|---|---|
params | { chain?: string; currency: string; } |
params.chain? | string |
params.currency | string |
Returns
Promise<APISuccessResponse<CurrencyInfo>>
getDepositAddressesV2()
getDepositAddressesV2(params: object): Promise<APISuccessResponse<DepositAddressV2[]>>;Parameters
| Parameter | Type |
|---|---|
params | { currency: string; } |
params.currency | string |
Returns
Promise<APISuccessResponse<DepositAddressV2[]>>
Deprecated
This method is deprecated. Please use getDepositAddressesV3() instead.
getDepositAddressesV3()
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
| Parameter | Type |
|---|---|
params | { amount?: string; chain?: string; currency: string; } |
params.amount? | string |
params.chain? | string |
params.currency | string |
Returns
Promise<APISuccessResponse<DepositAddressV3[]>>
getDepositAddressV1()
getDepositAddressV1(params: object): Promise<APISuccessResponse<DepositAddress>>;Parameters
| Parameter | Type |
|---|---|
params | { chain?: string; currency: string; } |
params.chain? | string |
params.currency | string |
Returns
Promise<APISuccessResponse<DepositAddress>>
Deprecated
This method is deprecated. Please use getDepositAddressesV3() instead.
getDeposits()
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
| Parameter | Type |
|---|---|
params? | GetDepositsRequest |
Returns
Promise<APISuccessResponse<Deposits>>
getDiscountRateConfigs()
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()
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
| Parameter | Type |
|---|---|
params | GetDualInvestmentProductsRequest |
Returns
Promise<APISuccessResponse<DualInvestmentProduct[]>>
getEarnEthStakingProducts()
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
| Parameter | Type |
|---|---|
params? | { currency: string; } |
params.currency | string |
Returns
Promise<APISuccessResponse<EarnProduct[]>>
getEarnFixedIncomeHoldAssets()
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
| Parameter | Type |
|---|---|
params? | GetEarnFixedIncomeHoldAssetsRequest |
Returns
Promise<APISuccessResponse<EarnFixedIncomeHoldAssets>>
getEarnKcsStakingProducts()
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
| Parameter | Type |
|---|---|
params? | { currency?: string; } |
params.currency? | string |
Returns
Promise<APISuccessResponse<EarnProduct[]>>
getEarnPromotionProducts()
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
| Parameter | Type |
|---|---|
params? | { currency?: string; } |
params.currency? | string |
Returns
Promise<APISuccessResponse<EarnProduct[]>>
getEarnRedeemPreview()
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
| Parameter | Type |
|---|---|
params | GetEarnRedeemPreviewRequest |
Returns
Promise<APISuccessResponse<GetEarnRedeemPreviewResponse>>
getEarnSavingsProducts()
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
| Parameter | Type |
|---|---|
params? | { currency?: string; } |
params.currency? | string |
Returns
Promise<APISuccessResponse<EarnProduct[]>>
getEarnStakingProducts()
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
| Parameter | Type |
|---|---|
params? | { currency?: string; } |
params.currency? | string |
Returns
Promise<APISuccessResponse<EarnProduct[]>>
getFiatPrice()
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
| Parameter | Type |
|---|---|
params? | { base?: string; currencies?: string; } |
params.base? | string |
params.currencies? | string |
Returns
Promise<any>
getFills()
getFills(params?: GetFillsRequest): Promise<APISuccessResponse<SpotOrderFills>>;Parameters
| Parameter | Type |
|---|---|
params? | GetFillsRequest |
Returns
Promise<APISuccessResponse<SpotOrderFills>>
Deprecated
This method is deprecated. It is recommended to use the getHFFilledOrders() instead of this endpoint
getFullOrderBook()
getFullOrderBook(params: object): Promise<APISuccessResponse<OrderBookLevel>>;Get Full OrderBook
Query for full orderbook depth data. (aggregated by price)
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<OrderBookLevel>>
getHFActiveMarginOrders()
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
| Parameter | Type |
|---|---|
params | HFMarginRequestOrder |
Returns
Promise<APISuccessResponse<HFMarginOrder[]>>
getHFActiveOrders()
getHFActiveOrders(params: object): Promise<APISuccessResponse<HFOrder[]>>;Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
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()
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
| Parameter | Type |
|---|---|
params | { pageNum?: number; pageSize?: number; symbol: string; } |
params.pageNum? | number |
params.pageSize? | number |
params.symbol | string |
Returns
Promise<APISuccessResponse<{ currentPage: number; items: HFOrder[]; pageSize: number; totalNum: number; totalPage: number; }>>
See
Manage Spot orders and recover uncertain outcomes
getHFActiveSymbols()
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()
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
| Parameter | Type |
|---|---|
params | GetHFCompletedOrdersRequest |
Returns
Promise<APISuccessResponse<{ items: HFOrder[]; lastId: number; }>>
See
Manage Spot orders and recover uncertain outcomes
getHFFilledOrders()
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
| Parameter | Type |
|---|---|
params | GetHFFilledListRequest |
Returns
Promise<APISuccessResponse<{ items: HFFilledOrder[]; lastId: number; }>>
See
Manage Spot orders and recover uncertain outcomes
getHFMarginFilledOrders()
getHFMarginFilledOrders(params: GetHFMarginFilledRequest): Promise<APISuccessResponse<{
items: HFMarginOrder[];
lastId: number;
}>>;Get Closed Orders
This endpoint is to obtain all Margin Closed order lists
Parameters
| Parameter | Type |
|---|---|
params | GetHFMarginFilledRequest |
Returns
Promise<APISuccessResponse<{ items: HFMarginOrder[]; lastId: number; }>>
getHFMarginFills()
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
| Parameter | Type |
|---|---|
params | getHFMarginFillsRequest |
Returns
Promise<APISuccessResponse<{ items: HFMarginTransactionRecord[]; lastId: number; }>>
getHFMarginOpenSymbols()
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
| Parameter | Type |
|---|---|
params | { tradeType: string; } |
params.tradeType | string |
Returns
Promise<APISuccessResponse<{ symbols: string[]; symbolSize: number; }>>
getHFMarginOrderByClientOid()
getHFMarginOrderByClientOid(params: object): Promise<APISuccessResponse<HFMarginOrder>>;Get Order By ClientOid
This endpoint can be used to obtain a Margin order by clientOid.
Parameters
| Parameter | Type |
|---|---|
params | { clientOid: string; symbol: string; } |
params.clientOid | string |
params.symbol | string |
Returns
Promise<APISuccessResponse<HFMarginOrder>>
getHFMarginOrderByOrderId()
getHFMarginOrderByOrderId(params: object): Promise<APISuccessResponse<HFMarginOrder>>;Get Order By OrderId
This endpoint can be used to obtain a Margin order by orderId.
Parameters
| Parameter | Type |
|---|---|
params | { orderId: string; symbol: string; } |
params.orderId | string |
params.symbol | string |
Returns
Promise<APISuccessResponse<HFMarginOrder>>
getHFMarginTransactions()
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
| Parameter | Type |
|---|---|
params | AccountHFMarginTransactionsRequest |
Returns
Promise<APISuccessResponse<AccountHFMarginTransactions[]>>
getHFOrderDetailsByClientOid()
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
| Parameter | Type |
|---|---|
params | { clientOid: string; symbol: string; } |
params.clientOid | string |
params.symbol | string |
Returns
Promise<APISuccessResponse<HFOrder>>
See
Manage Spot orders and recover uncertain outcomes
getHFOrderDetailsByOrderId()
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
| Parameter | Type |
|---|---|
params | { orderId: string; symbol: string; } |
params.orderId | string |
params.symbol | string |
Returns
Promise<APISuccessResponse<HFOrder>>
See
Manage Spot orders and recover uncertain outcomes
getHFTransactions()
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
| Parameter | Type |
|---|---|
params | AccountHFTransactionsRequest |
Returns
Promise<APISuccessResponse<SpotAccountTransaction[]>>
getHistoricalDepositsV1()
getHistoricalDepositsV1(params?: GetDepositsRequest): Promise<APISuccessResponse<V1HistoricalDeposits>>;Parameters
| Parameter | Type |
|---|---|
params? | GetDepositsRequest |
Returns
Promise<APISuccessResponse<V1HistoricalDeposits>>
Deprecated
This method is deprecated. It is recommended to use the getDeposits() endpoint instead of this endpoint
getHistoricalWithdrawalsV1()
getHistoricalWithdrawalsV1(params?: GetWithdrawalsRequest): Promise<APISuccessResponse<HistoricalWithdrawalsV1>>;Parameters
| Parameter | Type |
|---|---|
params? | GetWithdrawalsRequest |
Returns
Promise<APISuccessResponse<HistoricalWithdrawalsV1>>
Deprecated
This method is deprecated. It is recommended to use the getWithdrawals() endpoint instead of this endpoint
getIsolatedMarginAccount()
getIsolatedMarginAccount(params: object): Promise<APISuccessResponse<SingleIsolatedMarginAccountInfo>>;Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
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()
getIsolatedMarginAccounts(params?: object): Promise<APISuccessResponse<IsolatedMarginAccountInfo>>;Parameters
| Parameter | Type |
|---|---|
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()
getIsolatedMarginBalance(params?: GetIsolatedMarginBalanceRequest): Promise<APISuccessResponse<IsolatedMarginBalance[]>>;Get Account - Isolated Margin
Request isolated margin account info. Preferred queryType: ISOLATED. ISOLATED_V2 phased out gradually.
Parameters
| Parameter | Type |
|---|---|
params? | GetIsolatedMarginBalanceRequest |
Returns
Promise<APISuccessResponse<IsolatedMarginBalance[]>>
getIsolatedMarginSymbolsConfig()
getIsolatedMarginSymbolsConfig(): Promise<APISuccessResponse<IsolatedMarginSymbolsConfig[]>>;Get Symbols - Isolated Margin
This endpoint allows querying the configuration of isolated margin symbol.
Returns
Promise<APISuccessResponse<IsolatedMarginSymbolsConfig[]>>
getKlines()
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
| Parameter | Type |
|---|---|
params | GetSpotKlinesRequest |
Returns
Promise<APISuccessResponse<Kline[]>>
See
getKumining()
getKumining(params?: GetKuminingRequest): Promise<APISuccessResponse<KuminingItem[]>>;Get Kumining
The kumining information can be obtained at this endpoint.
Parameters
| Parameter | Type |
|---|---|
params? | GetKuminingRequest |
Returns
Promise<APISuccessResponse<KuminingItem[]>>
getKYCRegions()
getKYCRegions(): Promise<APISuccessResponse<KYCRegion[]>>;Get KYC Regions
This endpoint can be used to obtain this user's KYC regions.
Returns
Promise<APISuccessResponse<KYCRegion[]>>
getLendingCurrencyV3()
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
| Parameter | Type |
|---|---|
params? | { currency?: string; } |
params.currency? | string |
Returns
Promise<APISuccessResponse<LendingCurrencyV3>>
Deprecated
KuCoin removed this endpoint on 21 Oct 2026. Calls will fail.
getLendingInterestRateV3()
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
| Parameter | Type |
|---|---|
params | { currency: string; } |
params.currency | string |
Returns
Promise<APISuccessResponse<object[]>>
Deprecated
KuCoin removed this endpoint on 21 Oct 2026. Calls will fail.
getLendingRedemptionOrdersV3()
getLendingRedemptionOrdersV3(params: GetLendingRedemptionOrdersV3Request): Promise<APISuccessResponse<LendingRedemption>>;Get Redeem Orders
This API endpoint provides pagination query for the redeem orders.
Parameters
| Parameter | Type |
|---|---|
params | GetLendingRedemptionOrdersV3Request |
Returns
Promise<APISuccessResponse<LendingRedemption>>
Deprecated
KuCoin removed this endpoint on 21 Oct 2026. Calls will fail.
getLendingSubscriptionOrdersV3()
getLendingSubscriptionOrdersV3(params: GetLendingSubscriptionOrdersV3Request): Promise<APISuccessResponse<LendingRedemption>>;Get Purchase Orders
This API endpoint provides pagination query for the purchase orders.
Parameters
| Parameter | Type |
|---|---|
params | GetLendingSubscriptionOrdersV3Request |
Returns
Promise<APISuccessResponse<LendingRedemption>>
Deprecated
KuCoin removed this endpoint on 21 Oct 2026. Calls will fail.
getMarginActivePairsV3()
getMarginActivePairsV3(params?: object): Promise<APISuccessResponse<{
items: MarginActivePairsV3[];
timestamp: number;
}>>;Get Symbols - Cross Margin
This endpoint allows querying the configuration of cross margin symbol.
Parameters
| Parameter | Type |
|---|---|
params? | { symbol?: string; } |
params.symbol? | string |
Returns
Promise<APISuccessResponse<{ items: MarginActivePairsV3[]; timestamp: number; }>>
getMarginBalance()
getMarginBalance(params?: GetMarginBalanceRequest): Promise<APISuccessResponse<MarginBalance>>;Get Account - Cross Margin
Request cross margin account info. Preferred queryType: MARGIN. MARGIN_V2 phased out gradually.
Parameters
| Parameter | Type |
|---|---|
params? | GetMarginBalanceRequest |
Returns
Promise<APISuccessResponse<MarginBalance>>
getMarginBalances()
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()
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
| Parameter | Type |
|---|---|
params | MarginHistoryV3Request |
Returns
Promise<APISuccessResponse<MarginBorrowHistoryV3[]>>
getMarginCollateralRatio()
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
| Parameter | Type |
|---|---|
params? | GetMarginCollateralRatioRequest |
Returns
Promise<APISuccessResponse<MarginCollateralRatioData[]>>
getMarginConfigInfo()
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()
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
| Parameter | Type |
|---|---|
params? | MarginInterestRecordsRequest |
Returns
Promise<APISuccessResponse<MarginInterestRecords>>
getMarginLeveragedToken()
getMarginLeveragedToken(params?: object): Promise<APISuccessResponse<MarginLevTokenInfo[]>>;Parameters
| Parameter | Type |
|---|---|
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()
getMarginMarkPrice(params: object): Promise<APISuccessResponse<MarginMarkPrice>>;Get Mark Price Detail
This endpoint returns the current Mark price for specified margin trading pairs.
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<MarginMarkPrice>>
getMarginMarkPrices()
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()
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
| Parameter | Type |
|---|---|
params | GetMarginOcoOrderByClientOidRequest |
Returns
Promise<APISuccessResponse<MarginOcoOrderItem>>
getMarginOcoOrderDetailByOrderId()
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
| Parameter | Type |
|---|---|
params | GetMarginOcoOrderDetailByOrderIdRequest |
Returns
Promise<APISuccessResponse<MarginOcoOrderDetails>>
getMarginRepayHistoryV3()
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
| Parameter | Type |
|---|---|
params | MarginHistoryV3Request |
Returns
Promise<APISuccessResponse<MarginRepayHistoryV3[]>>
getMarginRiskLimitConfig()
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
| Parameter | Type |
|---|---|
params | MarginRiskLimitRequest |
Returns
Promise<APISuccessResponse<MarginRiskLimit[]>>
getMarginStopOrderByClientOid()
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
| Parameter | Type |
|---|---|
params | GetMarginStopOrderByClientOidRequest |
Returns
Promise<APISuccessResponse<MarginStopOrderItem>>
getMarginStopOrderByOrderId()
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
| Parameter | Type |
|---|---|
params | GetMarginStopOrderByOrderIdRequest |
Returns
Promise<APISuccessResponse<MarginStopOrderItem>>
getMarginStopOrdersList()
getMarginStopOrdersList(params?: GetMarginStopOrdersListRequest): Promise<APISuccessResponse<MarginStopOrdersList>>;Get Margin Stop Orders List
Request via this endpoint to get your current untriggered stop order list.
Parameters
| Parameter | Type |
|---|---|
params? | GetMarginStopOrdersListRequest |
Returns
Promise<APISuccessResponse<MarginStopOrdersList>>
getMarketAvailableInventory()
getMarketAvailableInventory(params?: object): Promise<APISuccessResponse<MarketAvailableInventoryItem[]>>;Get Market Available Inventory
Request the platform available inventory
Parameters
| Parameter | Type |
|---|---|
params? | { currency?: string; } |
params.currency? | string |
Returns
Promise<APISuccessResponse<MarketAvailableInventoryItem[]>>
getMarkets()
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()
getMyIp(): Promise<APISuccessResponse<number>>;Returns
Promise<APISuccessResponse<number>>
getOCOOrderByClientOid()
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
| Parameter | Type |
|---|---|
params | { clientOid: string; } |
params.clientOid | string |
Returns
Promise<APISuccessResponse<OCOOrderListItem>>
getOCOOrderByOrderId()
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
| Parameter | Type |
|---|---|
params | { orderId: string; } |
params.orderId | string |
Returns
Promise<APISuccessResponse<OCOOrderListItem>>
getOCOOrderDetails()
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
| Parameter | Type |
|---|---|
params | { orderId: string; } |
params.orderId | string |
Returns
Promise<APISuccessResponse<OCOOrderDetails>>
getOCOOrders()
getOCOOrders(params: GetOCOOrdersRequest): Promise<APISuccessResponse<OCOOrders>>;Get OCO Order List
Request via this endpoint to get your current OCO order list.
Parameters
| Parameter | Type |
|---|---|
params | GetOCOOrdersRequest |
Returns
Promise<APISuccessResponse<OCOOrders>>
getOrderBookLevel100()
getOrderBookLevel100(params: object): Promise<APISuccessResponse<OrderBookLevel>>;Get Part OrderBook
Query for part orderbook depth data. Level 100(aggregated by price)
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<OrderBookLevel>>
getOrderBookLevel20()
getOrderBookLevel20(params: object): Promise<APISuccessResponse<OrderBookLevel>>;Get Part OrderBook
Query for part orderbook depth data. Level 20(aggregated by price)
Parameters
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<OrderBookLevel>>
See
getOrderByClientOid()
getOrderByClientOid(params: object): Promise<APISuccessResponse<SpotOrder>>;Parameters
| Parameter | Type |
|---|---|
params | { clientOid: string; } |
params.clientOid | string |
Returns
Promise<APISuccessResponse<SpotOrder>>
Deprecated
This method is deprecated. It is recommended to use the getHFOrderDetailsByClientOid() instead of this endpoint
getOrderByOrderId()
getOrderByOrderId(params: object): Promise<APISuccessResponse<SpotOrder>>;Parameters
| Parameter | Type |
|---|---|
params | { orderId: string; } |
params.orderId | string |
Returns
Promise<APISuccessResponse<SpotOrder>>
Deprecated
This method is deprecated. It is recommended to use the getHFOrderDetailsByOrderId() instead of this endpoint
getOrders()
getOrders(params?: GetOrderListRequest): Promise<APISuccessResponse<SpotOrderList>>;Parameters
| Parameter | Type |
|---|---|
params? | GetOrderListRequest |
Returns
Promise<APISuccessResponse<SpotOrderList>>
Deprecated
This method is deprecated. It is recommended to use the getHfOrderDetails() endpoint instead of this endpoint
getOtcLoan()
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()
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()
getPrivate(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.getPrivate
getPrivateWSConnectionToken()
getPrivateWSConnectionToken(): Promise<APISuccessResponse<WsConnectionInfo>>;Private V1 WS Connection Token & URL
Returns
Promise<APISuccessResponse<WsConnectionInfo>>
See
Follow private account updates
getPrivateWSConnectionTokenV2()
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()
getPublicWSConnectionToken(): Promise<APISuccessResponse<WsConnectionInfo>>;Public V1 WS Connection Token & URL
Returns
Promise<APISuccessResponse<WsConnectionInfo>>
getRecentFills()
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()
getRecentOrders(params?: object): Promise<APISuccessResponse<SpotOrder[]>>;Parameters
| Parameter | Type |
|---|---|
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()
getServerTime(): Promise<APISuccessResponse<number>>;Returns
Promise<APISuccessResponse<number>>
getServiceStatus()
getServiceStatus(): Promise<APISuccessResponse<ServiceStatus>>;Returns
Promise<APISuccessResponse<ServiceStatus>>
getStopOrderByClientOid()
getStopOrderByClientOid(params: object): Promise<APISuccessResponse<StopOrderItem[]>>;Get Stop Order By ClientOid
Parameters
| Parameter | Type |
|---|---|
params | { clientOid: string; symbol?: string; } |
params.clientOid | string |
params.symbol? | string |
Returns
Promise<APISuccessResponse<StopOrderItem[]>>
getStopOrderByOrderId()
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
| Parameter | Type |
|---|---|
params | { orderId: string; } |
params.orderId | string |
Returns
Promise<APISuccessResponse<StopOrderItem>>
getStopOrders()
getStopOrders(params?: GetStopOrdersListRequest): Promise<APISuccessResponse<StopOrders>>;Get Stop Orders List
Request via this endpoint to get your current untriggered stop order list.
Parameters
| Parameter | Type |
|---|---|
params? | GetStopOrdersListRequest |
Returns
Promise<APISuccessResponse<StopOrders>>
getStructuredProductOrders()
getStructuredProductOrders(params: GetStructuredProductOrdersRequest): Promise<APISuccessResponse<StructuredProductOrders>>;Get Structured Product Orders
This endpoint is to query structured product orders
Parameters
| Parameter | Type |
|---|---|
params | GetStructuredProductOrdersRequest |
Returns
Promise<APISuccessResponse<StructuredProductOrders>>
getSubAccountBalance()
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
| Parameter | Type |
|---|---|
params | { baseAmount?: string; baseCurrency?: string; includeBaseAmount: boolean; subUserId: string; } |
params.baseAmount? | string |
params.baseCurrency? | string |
params.includeBaseAmount | boolean |
params.subUserId | string |
Returns
Promise<APISuccessResponse<SubAccountBalance>>
getSubAccountBalancesV1()
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()
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
| Parameter | Type |
|---|---|
params? | { currentPage?: number; pageSize?: number; } |
params.currentPage? | number |
params.pageSize? | number |
Returns
Promise<APISuccessResponse<SubAccountBalancesV2>>
getSubAccountsV1()
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()
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
| Parameter | Type |
|---|---|
params? | { currentPage?: number; pageSize?: number; } |
params.currentPage? | number |
params.pageSize? | number |
Returns
Promise<APISuccessResponse<SubAccountsV2>>
getSubAPIs()
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
| Parameter | Type |
|---|---|
params | { apiKey?: string; subName: string; } |
params.apiKey? | string |
params.subName | string |
Returns
Promise<APISuccessResponse<SubAccountAPIInfo[]>>
getSymbol()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<SymbolInfo>>
getSymbols()
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
| Parameter | Type |
|---|---|
params? | { market?: string; } |
params.market? | string |
Returns
Promise<APISuccessResponse<SymbolInfo[]>>
See
getTicker()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<Ticker>>
See
getTickers()
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()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<TradeHistory[]>>
getTradingPairFee()
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
| Parameter | Type |
|---|---|
params | { symbol: string; } |
params.symbol | string |
Returns
Promise<APISuccessResponse<object[]>>
getTransactions()
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
| Parameter | Type |
|---|---|
params? | GetSpotTransactionsRequest |
Returns
Promise<APISuccessResponse<SpotAccountTransactions>>
getTransferable()
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
| Parameter | Type |
|---|---|
params | GetTransferableRequest |
Returns
Promise<APISuccessResponse<TransferableFunds>>
getUserType()
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()
getWithdrawalById(params: object): Promise<APISuccessResponse<WithdrawalById>>;Get Withdrawal History By ID
Request a withdrawal history by id via this endpoint.
Parameters
| Parameter | Type |
|---|---|
params | { withdrawalId: string; } |
params.withdrawalId | string |
Returns
Promise<APISuccessResponse<WithdrawalById>>
getWithdrawalQuotas()
getWithdrawalQuotas(params: object): Promise<APISuccessResponse<WithdrawalQuotas>>;Get Withdrawal Quotas
This endpoint can obtain the withdrawal quotas information of this currency.
Parameters
| Parameter | Type |
|---|---|
params | { chain?: string; currency: string; } |
params.chain? | string |
params.currency | string |
Returns
Promise<APISuccessResponse<WithdrawalQuotas>>
getWithdrawals()
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
| Parameter | Type |
|---|---|
params? | GetWithdrawalsRequest |
Returns
Promise<APISuccessResponse<Withdrawals>>
hasAccessToken()
hasAccessToken(): boolean;Returns
boolean
Inherited from
BaseRestClient.hasAccessToken
marginBorrowV3()
marginBorrowV3(params: MarginBorrowV3Request): Promise<APISuccessResponse<MarginOrderV3>>;Borrow
This API endpoint is used to initiate an application for cross or isolated margin borrowing.
Parameters
| Parameter | Type |
|---|---|
params | MarginBorrowV3Request |
Returns
Promise<APISuccessResponse<MarginOrderV3>>
marginRepayV3()
marginRepayV3(params: MarginRepayV3Request): Promise<APISuccessResponse<MarginOrderV3>>;Repay
This API endpoint is used to initiate an application for cross or isolated margin repayment.
Parameters
| Parameter | Type |
|---|---|
params | MarginRepayV3Request |
Returns
Promise<APISuccessResponse<MarginOrderV3>>
post()
post(endpoint: string, params?: any): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
Returns
Promise<any>
Inherited from
BaseRestClient.post
postPrivate()
postPrivate(
endpoint: string,
params?: any,
internalReqContext?: InternalRequestContext
): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | any |
internalReqContext? | InternalRequestContext |
Returns
Promise<any>
Inherited from
BaseRestClient.postPrivate
setAccessToken()
setAccessToken(newAccessToken: string): void;Parameters
| Parameter | Type |
|---|---|
newAccessToken | string |
Returns
void
Inherited from
BaseRestClient.setAccessToken
submitConvertLimitOrder()
submitConvertLimitOrder(params: AddConvertLimitOrderRequest): Promise<APISuccessResponse<SumbitConvertLimitResp>>;Add Convert Limit Order
Place Convert Limit Order
Parameters
| Parameter | Type |
|---|---|
params | AddConvertLimitOrderRequest |
Returns
Promise<APISuccessResponse<SumbitConvertLimitResp>>
submitConvertOrder()
submitConvertOrder(params: AddConvertOrderRequest): Promise<APISuccessResponse<SubmitConvertOrderResponse>>;Add Convert Order
Place market order for convert
Parameters
| Parameter | Type |
|---|---|
params | AddConvertOrderRequest |
Returns
Promise<APISuccessResponse<SubmitConvertOrderResponse>>
submitFlexTransfer()
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
| Parameter | Type |
|---|---|
params | FlexTransferRequest |
Returns
Promise<APISuccessResponse<{ orderId: string; }>>
submitHFMarginOrder()
submitHFMarginOrder(params: SubmitHFMarginOrderRequest): Promise<APISuccessResponse<MarginSubmitOrderV3Response>>;Add Order
Place order to the Cross-margin or Isolated-margin trading system
Parameters
| Parameter | Type |
|---|---|
params | SubmitHFMarginOrderRequest |
Returns
Promise<APISuccessResponse<MarginSubmitOrderV3Response>>
submitHFMarginOrderTest()
submitHFMarginOrderTest(params: SubmitHFMarginOrderRequest): Promise<MarginSubmitOrderV3Response>;Add Order Test
This endpoint is used to test the order submission.
Parameters
| Parameter | Type |
|---|---|
params | SubmitHFMarginOrderRequest |
Returns
Promise<MarginSubmitOrderV3Response>
submitHFMultipleOrders()
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
| Parameter | Type |
|---|---|
params | { orderList: SubmitHFOrderRequest[]; } |
params.orderList | SubmitHFOrderRequest[] |
Returns
Promise<APISuccessResponse<SubmitMultipleHFOrdersResponse[]>>
submitHFMultipleOrdersSync()
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
| Parameter | Type |
|---|---|
params | { orderList: SubmitHFOrderRequest[]; } |
params.orderList | SubmitHFOrderRequest[] |
Returns
Promise<APISuccessResponse<SubmitMultipleHFOrdersSyncResponse[]>>
submitHFOrder()
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
| Parameter | Type |
|---|---|
params | SubmitHFOrderRequest |
Returns
Promise<APISuccessResponse<{ clientOid: string; orderId: string; }>>
See
Manage Spot orders and recover uncertain outcomes
submitHFOrderSync()
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
| Parameter | Type |
|---|---|
params | SubmitHFOrderRequest |
Returns
Promise<APISuccessResponse<SubmitHFOrderSyncResponse>>
submitHFOrderTest()
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
| Parameter | Type |
|---|---|
params | SubmitHFOrderRequest |
Returns
Promise<any>
See
Validate an order without matching
submitInnerTransfer()
submitInnerTransfer(params: InnerTransferRequest): Promise<APISuccessResponse<{
orderId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | InnerTransferRequest |
Returns
Promise<APISuccessResponse<{ orderId: string; }>>
Deprecated
This method is deprecated. It is recommended to use the submitFlexTransfer() endpoint instead of this endpoint
submitLendingRedemptionV3()
submitLendingRedemptionV3(params: InitiateLendingRedemptionV3Request): Promise<APISuccessResponse<object[]>>;Redeem
Redeem your loan order
Parameters
| Parameter | Type |
|---|---|
params | InitiateLendingRedemptionV3Request |
Returns
Promise<APISuccessResponse<object[]>>
Deprecated
KuCoin removed this endpoint on 21 Oct 2026. Calls will fail.
submitLendingSubscriptionV3()
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
| Parameter | Type |
|---|---|
params | InitiateLendingSubscriptionV3Request |
Returns
Promise<APISuccessResponse<object[]>>
Deprecated
KuCoin removed this endpoint on 21 Oct 2026. Calls will fail.
submitMarginOrder()
submitMarginOrder(params: SubmitMarginOrderRequest): Promise<APISuccessResponse<SubmitMarginOrderResponse>>;Parameters
| Parameter | Type |
|---|---|
params | SubmitMarginOrderRequest |
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()
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()
submitMultipleOrders(params: object): Promise<APISuccessResponse<MultipleOrdersResponse[]>>;Parameters
| Parameter | Type |
|---|---|
params | { orderList: SubmitMultipleOrdersRequest[]; symbol: string; } |
params.orderList | SubmitMultipleOrdersRequest[] |
params.symbol | string |
Returns
Promise<APISuccessResponse<MultipleOrdersResponse[]>>
Deprecated
This method is deprecated. It is recommended to use the submitMultipleHFOrders() endpoint instead of this endpoint
submitOCOOrder()
submitOCOOrder(params: SubmitOCOOrderRequest): Promise<APISuccessResponse<{
orderId: string;
}>>;Add OCO Order
Place OCO order to the Spot trading system
Parameters
| Parameter | Type |
|---|---|
params | SubmitOCOOrderRequest |
Returns
Promise<APISuccessResponse<{ orderId: string; }>>
submitOrder()
submitOrder(params: SubmitOrderRequest): Promise<APISuccessResponse<{
orderId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | SubmitOrderRequest |
Returns
Promise<APISuccessResponse<{ orderId: string; }>>
Deprecated
This method is deprecated. It is recommended to use the submitHFOrder() endpoint instead of this endpoint
submitOrderTest()
submitOrderTest(): Promise<any>;Returns
Promise<any>
Deprecated
This method is deprecated. It is recommended to use the submitHFOrderTest() endpoint instead of this endpoint
submitRedemption()
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
| Parameter | Type |
|---|---|
params | InitiateRedemptionRequest |
Returns
Promise<APISuccessResponse<InitiateRedemptionResponse>>
submitStopOrder()
submitStopOrder(params: SubmitStopOrderRequest): Promise<APISuccessResponse<{
clientOid: string;
orderId: string;
}>>;Add Stop Order
Place stop order to the Spot trading system.
Parameters
| Parameter | Type |
|---|---|
params | SubmitStopOrderRequest |
Returns
Promise<APISuccessResponse<{ clientOid: string; orderId: string; }>>
submitStructuredProductPurchase()
submitStructuredProductPurchase(params: StructuredProductPurchaseRequest): Promise<APISuccessResponse<StructuredProductPurchaseResponse>>;Structured Product Purchase
This endpoint allows you to subscribe Struct-Earn products.
Parameters
| Parameter | Type |
|---|---|
params | StructuredProductPurchaseRequest |
Returns
Promise<APISuccessResponse<StructuredProductPurchaseResponse>>
submitTransferMasterSub()
submitTransferMasterSub(params: submitTransferMasterSubRequest): Promise<APISuccessResponse<{
orderId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | submitTransferMasterSubRequest |
Returns
Promise<APISuccessResponse<{ orderId: string; }>>
Deprecated
This method is deprecated. It is recommended to use the submitFlexTransfer() endpoint instead of this endpoint
submitWithdraw()
submitWithdraw(params: ApplyWithdrawRequest): Promise<APISuccessResponse<{
withdrawalId: string;
}>>;Parameters
| Parameter | Type |
|---|---|
params | ApplyWithdrawRequest |
Returns
Promise<APISuccessResponse<{ withdrawalId: string; }>>
Deprecated
This method is deprecated. Please use submitWithdrawV3() instead.
submitWithdrawV3()
submitWithdrawV3(params: SubmitWithdrawV3Request): Promise<APISuccessResponse<{
withdrawalId: string;
}>>;Withdraw(V3)
Use this endpoint to withdraw the specified currency
Parameters
| Parameter | Type |
|---|---|
params | SubmitWithdrawV3Request |
Returns
Promise<APISuccessResponse<{ withdrawalId: string; }>>
subscribeEarnFixedIncome()
subscribeEarnFixedIncome(params: SubscribeEarnFixedIncomeRequest): Promise<APISuccessResponse<SubscribeEarnFixedIncomeResponse>>;/**
- Earn Purchase
- This endpoint allows subscribing earn product
Parameters
| Parameter | Type |
|---|---|
params | SubscribeEarnFixedIncomeRequest |
Returns
Promise<APISuccessResponse<SubscribeEarnFixedIncomeResponse>>
updateHFOrder()
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
| Parameter | Type |
|---|---|
params | ModifyHFOrderRequest |
Returns
Promise<APISuccessResponse<{ clientOid: string; newOrderId: string; }>>
See
Manage Spot orders and recover uncertain outcomes
updateLendingSubscriptionOrdersV3()
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
| Parameter | Type |
|---|---|
params | ModifyLendingSubscriptionOrdersV3Request |
Returns
Promise<any>
Deprecated
KuCoin removed this endpoint on 21 Oct 2026. Calls will fail.
updateMarginLeverageV3()
updateMarginLeverageV3(params: object): Promise<APISuccessResponse<any>>;Modify Leverage
This endpoint allows modifying the leverage multiplier for cross margin or isolated margin.
Parameters
| Parameter | Type |
|---|---|
params | { isIsolated?: boolean; leverage: string; symbol?: string; } |
params.isIsolated? | boolean |
params.leverage | string |
params.symbol? | string |
Returns
Promise<APISuccessResponse<any>>
updateSubAPI()
updateSubAPI(params: UpdateSubAccountAPIRequest): Promise<APISuccessResponse<UpdateSubAPI>>;Modify SubAccount API
This endpoint can be used to update APIs for sub-accounts.
Parameters
| Parameter | Type |
|---|---|
params | UpdateSubAccountAPIRequest |
Returns
Promise<APISuccessResponse<UpdateSubAPI>>