0.1.10 • Published 7 months ago

node-api-kucoin v0.1.10

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

node-api-kucoin

WARNING: This package is still early beta! Expect breaking changes until this sees a major release.

Non-official implementation of KuCoin's API's. Developed for personal use.

For support on using the API's or development issues, please refer to the official API documentation. For questions regarding this package, please consult the code first.

PUBLIC API

  const kucoin=require('node-api-kucoin');

  const publicAPI=new kucoin.publicApi();

Market Data

Symbols & Ticker

APIDESCRIPTION
getSymbolshttps://docs.kucoin.com/#get-symbols-list
getTickerhttps://docs.kucoin.com/#get-ticker
getAllTickershttps://docs.kucoin.com/#get-all-tickers
getMarketStatshttps://docs.kucoin.com/#get-24hr-stats
getMarketshttps://docs.kucoin.com/#get-market-list

Order Book

APIDESCRIPTION
getPartOrderbookhttps://docs.kucoin.com/#get-part-order-book-aggregated

Histories

APIDESCRIPTION
getTradeHistorieshttps://docs.kucoin.com/#get-trade-histories
getKlineshttps://docs.kucoin.com/#get-klines

Currencies

APIDESCRIPTION
getCurrencieshttps://docs.kucoin.com/#get-currencies
getCurrencyDetailhttps://docs.kucoin.com/#get-currency-detail-recommend
getFiatPricehttps://docs.kucoin.com/#get-fiat-price

Others

APIDESCRIPTION
getServerTimehttps://docs.kucoin.com/#server-time
getServiceStatushttps://docs.kucoin.com/#service-status
getPublicTokenhttps://docs.kucoin.com/#websocket-feed

PRIVATE API

  const kucoin=require('node-api-kucoin');

  const auth = {
    apikey: 'MY_API_KEY',
    secret: 'MY_API_SECRET'
  };

  const privateAPI=new kucoin.privateApi(auth);

Market Data

Order Book

APIDESCRIPTION
getPartOrderbookhttps://docs.kucoin.com/#get-part-order-book-aggregated
getOrderbookhttps://docs.kucoin.com/#get-full-order-book-aggregated

User

User Info

APIDESCRIPTION
getSubUserInfohttps://docs.kucoin.com/#get-user-info-of-all-sub-accounts https://docs.kucoin.com/#get-paginated-list-of-sub-accounts

Account

APIDESCRIPTION
listAccountshttps://docs.kucoin.com/#list-accounts
getAccounthttps://docs.kucoin.com/#get-an-account
getAccountLedgershttps://docs.kucoin.com/#get-account-ledgers
getAccountSummaryhttps://docs.kucoin.com/#get-account-summary-info-v2
createSubAccounthttps://docs.kucoin.com/#create-sub-account-v2
getSubAccountAPIshttps://docs.kucoin.com/#get-sub-account-spot-api-list
createSubAccountAPIhttps://docs.kucoin.com/#create-spot-apis-for-sub-account
modifySubAccountAPIhttps://docs.kucoin.com/#modify-sub-account-spot-apis
deleteSubAccountAPIhttps://docs.kucoin.com/#delete-sub-account-spot-apis
getSubBalancehttps://docs.kucoin.com/#get-account-balance-of-a-sub-account
getAggregatedBalancehttps://docs.kucoin.com/#get-the-aggregated-balance-of-all-sub-accounts
getSubAccountDetailshttps://docs.kucoin.com/#get-paginated-sub-account-information
getTransferablehttps://docs.kucoin.com/#get-the-transferable
accountTransferhttps://docs.kucoin.com/#transfer-between-master-user-and-sub-user
innerTransferhttps://docs.kucoin.com/#inner-transfer

Deposit

APIDESCRIPTION
createDepositAddresshttps://docs.kucoin.com/#create-deposit-address
getDepositAddresseshttps://docs.kucoin.com/#get-deposit-addresses-v2
getDepositAddresshttps://docs.kucoin.com/#get-deposit-address
getDepositshttps://docs.kucoin.com/#get-deposit-list
getHistDepositshttps://docs.kucoin.com/#get-v1-historical-deposits-list

Withdrawals

APIDESCRIPTION
getWithdrawalshttps://docs.kucoin.com/#get-withdrawals-list
getHistWithdrawalshttps://docs.kucoin.com/#get-v1-historical-withdrawals-list
getWithdrawalQuotahttps://docs.kucoin.com/#get-withdrawal-quotas
applyWithdrawhttps://docs.kucoin.com/#apply-withdraw-2
cancelWithdrawhttps://docs.kucoin.com/#cancel-withdrawal

Trade Fee

APIDESCRIPTION
getUserFeehttps://docs.kucoin.com/#basic-user-fee
getSymbolFeehttps://docs.kucoin.com/#actual-fee-rate-of-the-trading-pair

Trade

Orders

APIDESCRIPTION
createOrderhttps://docs.kucoin.com/#place-a-new-order
createMarginOrderhttps://docs.kucoin.com/#place-a-margin-order
createOrdershttps://docs.kucoin.com/#place-bulk-orders
cancelOrderhttps://docs.kucoin.com/#cancel-an-order
cancelClientOrderIDhttps://docs.kucoin.com/#cancel-single-order-by-clientoid
cancelAllOrdershttps://docs.kucoin.com/#cancel-all-orders
getOrdershttps://docs.kucoin.com/#list-orders
getRecentOrdershttps://docs.kucoin.com/#recent-orders
getOrderhttps://docs.kucoin.com/#get-an-order
getClientOrderIDhttps://docs.kucoin.com/#get-single-active-order-by-clientoid

Fills

APIDESCRIPTION
getFillshttps://docs.kucoin.com/#list-fills
getRecentFillshttps://docs.kucoin.com/#recent-fills

Stop Order

APIDESCRIPTION
createStopOrderhttps://docs.kucoin.com/#place-a-new-order-2
cancelStopOrderhttps://docs.kucoin.com/#cancel-an-order-2
cancelStopOrdershttps://docs.kucoin.com/#cancel-orders
getStopOrderhttps://docs.kucoin.com/#get-single-order-info
getStopOrdershttps://docs.kucoin.com/#list-stop-orders
getStopClientOrderIDhttps://docs.kucoin.com/#get-single-order-by-clientoid
cancelStopClientOrderIDhttps://docs.kucoin.com/#cancel-single-order-by-clientoid-2

Margin Trade

Margin Info

APIDESCRIPTION
getMarkPricehttps://docs.kucoin.com/#get-mark-price
getMarginConfighttps://docs.kucoin.com/#get-margin-configuration-info
getMarginAccounthttps://docs.kucoin.com/#get-margin-account
getMarginRiskLimithttps://docs.kucoin.com/#query-the-cross-isolated-margin-risk-limit

Margin Trading

APIDESCRIPTION
createBorrowOrderhttps://docs.kucoin.com/#1-margin-borrowing
repayBorrowOrderhttps://docs.kucoin.com/#2-repayment
getBorrowOrderhttps://docs.kucoin.com/#get-borrow-order
getRepayHistoryhttps://docs.kucoin.com/#4-get-repayment-history

Lending Market

APIDESCRIPTION
getCurrencyDetailshttps://docs.kucoin.com/#1-get-currency-information
getInterestRateshttps://docs.kucoin.com/#2-get-interest-rates
purchaseMarginLendhttps://docs.kucoin.com/#3-subscription
redeemMarginLendhttps://docs.kucoin.com/#4-redemption
updateMarginLendhttps://docs.kucoin.com/#5-modify-subscription-orders
getRedemptionOrdershttps://docs.kucoin.com/#6-get-redemption-orders
getPurchaseOrdershttps://docs.kucoin.com/#7-get-subscription-orders

Others

APIDESCRIPTION
getPrivateTokenhttps://docs.kucoin.com/#websocket-feed

WEBSOCKET API

  const kucoin=require('node-api-kucoin');

  const auth = {
    apikey: 'MY_API_KEY',
    secret: 'MY_API_SECRET'
  };

  const marketAPI=new kucoin.sockets.marketApi();
  marketAPI.socket._ws.on('initialized', async () => {
    // do your own initialization
  });

  const tradingAPI=new kucoin.sockets.tradingApi(auth);
  tradingAPI.setHandler('orders', (symbol,method,data,option) => { updateOrder(symbol,method,data); });

  tradingAPI.socket._ws.on('authenticated', async () => {
    const res=await tradingAPI.subscribeOrderUpdates();
  });

  tradingAPI.socket._ws.on('closed', async () => {
    // do something, like clean-up and reconnect
  });

  function updateOrder(symbol,method,data) {
    // do something
  };

Public Channels

APIHANDLERDESCRIPTION
subscribeTicker unsubscribeTickertrade.tickerhttps://docs.kucoin.com/#symbol-ticker https://docs.kucoin.com/#all-symbols-ticker
subscribeSnapshot unsubscribeSnapshottrade.snapshothttps://docs.kucoin.com/#symbol-snapshot https://docs.kucoin.com/#market-snapshot
subscribeOrderbook unsubscribeOrderbooktrade.l2updatehttps://docs.kucoin.com/#level-2-market-data
subscribeBest unsubscribeBestlevel2https://docs.kucoin.com/#level2-5-best-ask-bid-orders https://docs.kucoin.com/#level2-50-best-ask-bid-orders
subscribeCandles unsubscribeCandlestrade.candles.updatehttps://docs.kucoin.com/#klines
subscribeTrades unsubscribeTradestrade.l3matchhttps://docs.kucoin.com/#match-execution-data
subscribeIndexPrice unsubscribeIndexPricetickhttps://docs.kucoin.com/#index-price
subscribeMarkPrice unsubscribeMarkPricetickhttps://docs.kucoin.com/#mark-price
subscribeMarginBook unsubscribeMarginBookfunding.updatehttps://docs.kucoin.com/#order-book-change

Private Channels

APIHANDLERDESCRIPTION
subscribeOrderUpdates unsubscribeOrderUpdatesorderChangehttps://docs.kucoin.com/#private-order-change-events
subscribeBalanceUpdates ubsubscribeBalanceUpdatesaccount.balancehttps://docs.kucoin.com/#account-balance-notice
subscribeDebRatioUpdates unsubscribeDebRatioUpdatesdebt.ratio position.statushttps://docs.kucoin.com/#debt-ratio-change
subscribeMarginOrdersorder.open order.update order.donehttps://docs.kucoin.com/#margin-trade-order-enters-event https://docs.kucoin.com/#margin-order-update-event https://docs.kucoin.com/#margin-order-done-event
subscribeStopOrdersstopOrderhttps://docs.kucoin.com/#stop-order-event
0.1.10

7 months ago

0.1.8

9 months ago

0.1.9

9 months ago

0.1.7

1 year ago

0.1.6

1 year ago

0.1.5

1 year ago

0.1.4

1 year ago

0.1.3

1 year ago

0.1.2

1 year ago

0.1.1

1 year ago

0.1.0

1 year ago

0.0.1

1 year ago