{"id":44223637,"url":"https://github.com/alexander-hagen/node-api-kucoin","last_synced_at":"2026-02-10T04:39:11.196Z","repository":{"id":65281322,"uuid":"589014704","full_name":"alexander-hagen/node-api-kucoin","owner":"alexander-hagen","description":"Non-official implementation of KuCoin's API's. Developed for personal use.","archived":false,"fork":false,"pushed_at":"2026-01-02T14:47:26.000Z","size":57,"stargazers_count":2,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-08T21:30:42.366Z","etag":null,"topics":["api-rest","javascript","kucoin","nodejs","websocket"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alexander-hagen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-01-14T19:32:34.000Z","updated_at":"2026-01-02T14:47:30.000Z","dependencies_parsed_at":"2023-01-16T05:45:37.874Z","dependency_job_id":null,"html_url":"https://github.com/alexander-hagen/node-api-kucoin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/alexander-hagen/node-api-kucoin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander-hagen%2Fnode-api-kucoin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander-hagen%2Fnode-api-kucoin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander-hagen%2Fnode-api-kucoin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander-hagen%2Fnode-api-kucoin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexander-hagen","download_url":"https://codeload.github.com/alexander-hagen/node-api-kucoin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexander-hagen%2Fnode-api-kucoin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29290991,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-10T03:42:42.660Z","status":"ssl_error","status_checked_at":"2026-02-10T03:42:41.897Z","response_time":65,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-rest","javascript","kucoin","nodejs","websocket"],"created_at":"2026-02-10T04:39:09.132Z","updated_at":"2026-02-10T04:39:11.186Z","avatar_url":"https://github.com/alexander-hagen.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# node-api-kucoin\n\n**WARNING: This package is still early beta! Expect breaking changes until this sees a major release.**\n\nNon-official implementation of KuCoin's API's. Developed for personal use.\n\nFor 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.\n\n## __PUBLIC API__\n\n```javascript\n  const kucoin=require('node-api-kucoin');\n\n  const publicAPI=new kucoin.publicApi();\n\n```\n\n### Market Data\n\n#### Symbols \u0026 Ticker\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| getSymbols              | https://docs.kucoin.com/#get-symbols-list |\n| getTicker               | https://docs.kucoin.com/#get-ticker |\n| getAllTickers           | https://docs.kucoin.com/#get-all-tickers |\n| getMarketStats          | https://docs.kucoin.com/#get-24hr-stats |\n| getMarkets              | https://docs.kucoin.com/#get-market-list |\n\n#### Order Book\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| getPartOrderbook        | https://docs.kucoin.com/#get-part-order-book-aggregated |\n\n#### Histories\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| getTradeHistories       | https://docs.kucoin.com/#get-trade-histories |\n| getKlines               | https://docs.kucoin.com/#get-klines |\n\n#### Currencies\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| getCurrencies           | https://docs.kucoin.com/#get-currencies |\n| getCurrencyDetail       | https://docs.kucoin.com/#get-currency-detail-recommend |\n| getFiatPrice            | https://docs.kucoin.com/#get-fiat-price |\n\n### Others\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| getServerTime           | https://docs.kucoin.com/#server-time |\n| getServiceStatus        | https://docs.kucoin.com/#service-status |\n| getPublicToken          | https://docs.kucoin.com/#websocket-feed |\n\n## __PRIVATE API__\n\n```javascript\n  const kucoin=require('node-api-kucoin');\n\n  const auth = {\n    apikey: 'MY_API_KEY',\n    secret: 'MY_API_SECRET'\n  };\n\n  const privateAPI=new kucoin.privateApi(auth);\n\n```\n\n### Market Data\n\n#### Order Book\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| getPartOrderbook        | https://docs.kucoin.com/#get-part-order-book-aggregated |\n| getOrderbook            | https://docs.kucoin.com/#get-full-order-book-aggregated |\n\n### User\n\n#### User Info\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| getSubUserInfo          | https://docs.kucoin.com/#get-user-info-of-all-sub-accounts https://docs.kucoin.com/#get-paginated-list-of-sub-accounts|\n\n#### Account\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| listAccounts            | https://docs.kucoin.com/#list-accounts |\n| getAccount              | https://docs.kucoin.com/#get-an-account |\n| getAccountLedgers       | https://docs.kucoin.com/#get-account-ledgers |\n| getAccountSummary       | https://docs.kucoin.com/#get-account-summary-info-v2 |\n| createSubAccount        | https://docs.kucoin.com/#create-sub-account-v2 |\n| getSubAccountAPIs       | https://docs.kucoin.com/#get-sub-account-spot-api-list |\n| createSubAccountAPI     | https://docs.kucoin.com/#create-spot-apis-for-sub-account |\n| modifySubAccountAPI     | https://docs.kucoin.com/#modify-sub-account-spot-apis |\n| deleteSubAccountAPI     | https://docs.kucoin.com/#delete-sub-account-spot-apis |\n| getSubBalance           | https://docs.kucoin.com/#get-account-balance-of-a-sub-account |\n| getAggregatedBalance    | https://docs.kucoin.com/#get-the-aggregated-balance-of-all-sub-accounts |\n| getSubAccountDetails    | https://docs.kucoin.com/#get-paginated-sub-account-information |\n| getTransferable         | https://docs.kucoin.com/#get-the-transferable |\n| accountTransfer         | https://docs.kucoin.com/#transfer-between-master-user-and-sub-user |\n| innerTransfer           | https://docs.kucoin.com/#inner-transfer |\n\n#### Deposit\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| createDepositAddress    | https://docs.kucoin.com/#create-deposit-address |\n| getDepositAddresses     | https://docs.kucoin.com/#get-deposit-addresses-v2 |\n| getDepositAddress       | https://docs.kucoin.com/#get-deposit-address |\n| getDeposits             | https://docs.kucoin.com/#get-deposit-list |\n| getHistDeposits         | https://docs.kucoin.com/#get-v1-historical-deposits-list |\n\n#### Withdrawals\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| getWithdrawals          | https://docs.kucoin.com/#get-withdrawals-list |\n| getHistWithdrawals      | https://docs.kucoin.com/#get-v1-historical-withdrawals-list |\n| getWithdrawalQuota      | https://docs.kucoin.com/#get-withdrawal-quotas |\n| applyWithdraw           | https://docs.kucoin.com/#apply-withdraw-2 |\n| cancelWithdraw          | https://docs.kucoin.com/#cancel-withdrawal |\n\n#### Trade Fee\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| getUserFee              | https://docs.kucoin.com/#basic-user-fee |\n| getSymbolFee            | https://docs.kucoin.com/#actual-fee-rate-of-the-trading-pair | \n\n### Trade\n\n#### Orders\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| createOrder             | https://docs.kucoin.com/#place-a-new-order |\n| createMarginOrder       | https://docs.kucoin.com/#place-a-margin-order |\n| createOrders            | https://docs.kucoin.com/#place-bulk-orders |\n| cancelOrder             | https://docs.kucoin.com/#cancel-an-order |\n| cancelClientOrderID     | https://docs.kucoin.com/#cancel-single-order-by-clientoid |\n| cancelAllOrders         | https://docs.kucoin.com/#cancel-all-orders |\n| getOrders               | https://docs.kucoin.com/#list-orders |\n| getRecentOrders         | https://docs.kucoin.com/#recent-orders |\n| getOrder                | https://docs.kucoin.com/#get-an-order |\n| getClientOrderID        | https://docs.kucoin.com/#get-single-active-order-by-clientoid |\n\n#### Fills\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| getFills                | https://docs.kucoin.com/#list-fills |\n| getRecentFills          | https://docs.kucoin.com/#recent-fills |\n\n#### Stop Order\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| createStopOrder         | https://docs.kucoin.com/#place-a-new-order-2 |\n| cancelStopOrder         | https://docs.kucoin.com/#cancel-an-order-2 |\n| cancelStopOrders        | https://docs.kucoin.com/#cancel-orders |\n| getStopOrder            | https://docs.kucoin.com/#get-single-order-info |\n| getStopOrders           | https://docs.kucoin.com/#list-stop-orders |\n| getStopClientOrderID    | https://docs.kucoin.com/#get-single-order-by-clientoid |\n| cancelStopClientOrderID | https://docs.kucoin.com/#cancel-single-order-by-clientoid-2 |\n\n### Margin Trade\n\n#### Margin Info\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| getMarkPrice            | https://docs.kucoin.com/#get-mark-price |\n| getMarginConfig         | https://docs.kucoin.com/#get-margin-configuration-info |\n| getMarginAccount        | https://docs.kucoin.com/#get-margin-account |\n| getMarginRiskLimit      | https://docs.kucoin.com/#query-the-cross-isolated-margin-risk-limit |\n\n#### Margin Trading\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| createBorrowOrder       | https://docs.kucoin.com/#1-margin-borrowing |\n| repayBorrowOrder        | https://docs.kucoin.com/#2-repayment |\n| getBorrowOrder          | https://docs.kucoin.com/#get-borrow-order |\n| getRepayHistory         | https://docs.kucoin.com/#4-get-repayment-history |\n\n#### Lending Market\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| getCurrencyDetails      | https://docs.kucoin.com/#1-get-currency-information |\n| getInterestRates        | https://docs.kucoin.com/#2-get-interest-rates |\n| purchaseMarginLend      | https://docs.kucoin.com/#3-subscription |\n| redeemMarginLend        | https://docs.kucoin.com/#4-redemption |\n| updateMarginLend        | https://docs.kucoin.com/#5-modify-subscription-orders |\n| getRedemptionOrders     | https://docs.kucoin.com/#6-get-redemption-orders |\n| getPurchaseOrders       | https://docs.kucoin.com/#7-get-subscription-orders |\n\n### Others\n\n| API                     | DESCRIPTION |\n| :----                   | :---- |\n| getPrivateToken         | https://docs.kucoin.com/#websocket-feed |\n\n## __WEBSOCKET API__\n\n```javascript\n  const kucoin=require('node-api-kucoin');\n\n  const auth = {\n    apikey: 'MY_API_KEY',\n    secret: 'MY_API_SECRET'\n  };\n\n  const marketAPI=new kucoin.sockets.marketApi();\n  marketAPI.socket._ws.on('initialized', async () =\u003e {\n    // do your own initialization\n  });\n\n  const tradingAPI=new kucoin.sockets.tradingApi(auth);\n  tradingAPI.setHandler('orders', (symbol,method,data,option) =\u003e { updateOrder(symbol,method,data); });\n\n  tradingAPI.socket._ws.on('authenticated', async () =\u003e {\n    const res=await tradingAPI.subscribeOrderUpdates();\n  });\n\n  tradingAPI.socket._ws.on('closed', async () =\u003e {\n    // do something, like clean-up and reconnect\n  });\n\n  function updateOrder(symbol,method,data) {\n    // do something\n  };\n\n```\n\n### Public Channels\n\n| API                                       | HANDLER              | DESCRIPTION |\n| :----                                     | :----                | :---- |\n| subscribeTicker unsubscribeTicker         | trade.ticker         | https://docs.kucoin.com/#symbol-ticker https://docs.kucoin.com/#all-symbols-ticker |\n| subscribeSnapshot unsubscribeSnapshot     | trade.snapshot       | https://docs.kucoin.com/#symbol-snapshot https://docs.kucoin.com/#market-snapshot |\n| subscribeOrderbook unsubscribeOrderbook   | trade.l2update       | https://docs.kucoin.com/#level-2-market-data |\n| subscribeBest unsubscribeBest             | level2               | https://docs.kucoin.com/#level2-5-best-ask-bid-orders https://docs.kucoin.com/#level2-50-best-ask-bid-orders |\n| subscribeCandles unsubscribeCandles       | trade.candles.update | https://docs.kucoin.com/#klines |\n| subscribeTrades unsubscribeTrades         | trade.l3match        | https://docs.kucoin.com/#match-execution-data |\n| subscribeIndexPrice unsubscribeIndexPrice | tick                 | https://docs.kucoin.com/#index-price |\n| subscribeMarkPrice unsubscribeMarkPrice   | tick                 | https://docs.kucoin.com/#mark-price |\n| subscribeMarginBook unsubscribeMarginBook | funding.update       | https://docs.kucoin.com/#order-book-change |\n\n### Private Channels\n\n| API                                                 | HANDLER                            | DESCRIPTION |\n| :----                                               | :----                              | :---- |\n| subscribeOrderUpdates unsubscribeOrderUpdates       | orderChange                        | https://docs.kucoin.com/#private-order-change-events |\n| subscribeBalanceUpdates ubsubscribeBalanceUpdates   | account.balance                    | https://docs.kucoin.com/#account-balance-notice |\n| subscribeDebRatioUpdates unsubscribeDebRatioUpdates | debt.ratio position.status         | https://docs.kucoin.com/#debt-ratio-change |\n| subscribeMarginOrders                               | order.open order.update order.done | https://docs.kucoin.com/#margin-trade-order-enters-event https://docs.kucoin.com/#margin-order-update-event https://docs.kucoin.com/#margin-order-done-event |\n| subscribeStopOrders                                 | stopOrder                          | https://docs.kucoin.com/#stop-order-event |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexander-hagen%2Fnode-api-kucoin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexander-hagen%2Fnode-api-kucoin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexander-hagen%2Fnode-api-kucoin/lists"}