kucoin-node-sdk
KuCoin API SDK for Node.js language
Env
Nodejs version >= 10.0
Install
# install by npm
npm install kucoin-node-sdk
# install by yarn
yarn add kucoin-node-sdk
Usage
/** Require SDK */
const API = require('kucoin-node-sdk');
/** Init Configure */
API.init(require('./config'));
/** API use */
const main = async () => {
const getTimestampRl = await API.rest.Others.getTimestamp();
console.log(getTimestampRl.data);
};
/** Run Demo */
main();
Init Configure
{
baseUrl: '',
apiAuth: {
key: '', // KC-API-KEY
secret: '', // API-Secret
passphrase: '', // KC-API-PASSPHRASE
},
authVersion: 2, // KC-API-KEY-VERSION. Notice: for v2 API-KEY, not required for v1 version.
}
API Modules
Rest/User
Signature is required for this part.
Rest/User/UserInfo
- getSubUsers
Rest/User/Account
- createAccount
- getAccountsList
- getAccountInformation
- getAccountLedgers
- getHolds
- getBalanceOfSubAccount
- getAggregatedBalanceOfAllSubAccounts
- getTransferable
- transferBetweenMasterUserAndSubUser
- innerTransfer
Rest/User/Deposit
- createDepositAddress
- getDepositAddressV2
- getDepositAddress
- getDepositList
- getV1HistoricalDepositsList
Rest/User/Withdrawals
- getWithdrawalsList
- getV1HistoricalWithdrawalsList
- getWithdrawalQuotas
- applyWithdraw
- cancelWithdrawal
Rest/User/TradeFee
- getBasicUserFee
- getActualFeeRateBySymbols
Rest/Trade
Signature is required for this part.
Rest/Trade/Orders
- postOrder
- postMultiOrders
- cancelOrder
- cancelOrderByClientOid
- cancelAllOrders
- getOrdersList
- getV1HistoricalOrdersList
- getRecentOrders
- getOrderByID
- getSingleActiveOrderByClientOid
Rest/Trade/StopOrder
- postStopOrder
- cancelOrder
- cancelMultiOrders
- getOrder
- getStopOrderList
- getOrderByClientOid
- cancelSingleOrderByClientOid
Rest/Trade/Fills
- getFillsList
- getRecentFills
Rest/Market
Signature is not required for this part
Rest/Market/Symbols
- getSymbolsList
- getTicker
- getAllTickers
- get24hrStats
- getMarketList
Rest/Market/OrderBook
- getLevel2_20
- getLevel2_100
- getLevel2_full
- getLevel3_full
Rest/Market/Histories
- getMarketHistories
- getMarketCandles
Rest/Market/Currencies
- getCurrencies
- getCurrencyDetail
- getFiatPrice
Rest/Margin/MarginInfo
- getMarkPrice
- getMarginConfigurationInfo
- getMarginAccount
- postMarginOrder
- getMarginPriceStrategy
Rest/Margin/BorrowAndLend
- postBorrowOrder
- getBorrowOrder
- getRepayRecord
- getRepaymentRecord
- repayAll
- repaySingle
- postLendOrder
- cancelLendOrder
- setAutoLend
- getActiveOrder
- getLentHistory
- getActiveLendOrdersList
- getSettledLendOrderHistory
- getAccountLendRecord
- getLendingMarketData
- getMarginFillsTradeData
Rest/Others
- getTimestamp
- getStatus
Websocket Datafeed
API.websocket.Datafeed
Manage websocket connect/private/subscribe/unsubscribe and get realtime datafeed.
DEMO: demo/ticker_demo.js
API.websocket.Level2
Get realtime orderbook in level2 datafeed.
DEMO: demo/level2_demo.js
API.websocket.Level3
// TODO