{"id":20020125,"url":"https://github.com/wonism/upbit-api-node","last_synced_at":"2025-05-04T23:32:41.888Z","repository":{"id":39649713,"uuid":"146177045","full_name":"wonism/upbit-api-node","owner":"wonism","description":"Upbit API for Node.js","archived":false,"fork":false,"pushed_at":"2023-01-03T15:16:20.000Z","size":704,"stargazers_count":18,"open_issues_count":12,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-13T11:31:01.501Z","etag":null,"topics":["bitcoin","cryptocurrency","exchange","market","nodejs","upbit","upbit-api"],"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/wonism.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-26T12:04:00.000Z","updated_at":"2023-05-18T13:32:12.000Z","dependencies_parsed_at":"2023-02-01T07:01:33.266Z","dependency_job_id":null,"html_url":"https://github.com/wonism/upbit-api-node","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wonism%2Fupbit-api-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wonism%2Fupbit-api-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wonism%2Fupbit-api-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wonism%2Fupbit-api-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wonism","download_url":"https://codeload.github.com/wonism/upbit-api-node/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224417745,"owners_count":17307673,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["bitcoin","cryptocurrency","exchange","market","nodejs","upbit","upbit-api"],"created_at":"2024-11-13T08:29:57.969Z","updated_at":"2024-11-13T08:29:58.545Z","avatar_url":"https://github.com/wonism.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Upbit API Node\n\u003e API wrapper for Upbit\n\n[![npm version](https://badge.fury.io/js/upbit-api-node.svg)](https://badge.fury.io/js/upbit-api-node)\n[![Build Status](https://travis-ci.org/wonism/upbit-api-node.svg)](https://travis-ci.org/wonism/upbit-api-node)\n\n## Install\n```\n$ npm i -S upbit-api-node\n```\n\n## Disclaimer\n```\nI am not responsible for anything done with this.\nYou use it at your own risk.\nThere are no warranties or guarantees expressed or implied.\nYou assume all responsibility and liability.\n```\n\n## Quotation APIs\n### subscribe(options) =\u003e ws\nGet websocket instance to subscribe websocket protocol\n\n**Kind**: global function\n\n| Param                    | Type     | Description                                                  |\n| ------------------------ | -------- | ------------------------------------------------------------ |\n| options                  | Object   |                                                              |\n| options.reconnect        | Function | Callback that is executed when try to reconnect to websocket |\n| options.openCallback     | Function | Callback that is executed when websocket is opened           |\n| options.messageCallback  | Function | Callback that is executed when message is received           |\n| options.subscriptionList | Object   | List that you want to subscribe                              |\n\n### getTicker(markets) =\u003e Promise\nGet tickers of given markets\n\n**Kind**: global async function\n\n| Param                    | Type     | Description                                                  |\n| ------------------------ | -------- | ------------------------------------------------------------ |\n| markets                  | String[] | Element should folow AAA-BBB                                 |\n\n### getMinCandles(market, minutes, count) =\u003e Promise\nGet candles of given market (time unit: minutes)\n\n**Kind**: global async function\n\n| Param                    | Type     | Description                                                  |\n| ------------------------ | -------- | ------------------------------------------------------------ |\n| markets                  | String   | AAA-BBB                                                      |\n| minutes                  | Number   | Interval of candle. one of [1, 3, 5, 10, 30, 60]             |\n| count                    | Number   | Numbers of candle count you want. 1 - 200                    |\n\n### getCandles(market, timeUnit, count) =\u003e Promise\nGet candles of given market (time unit: day | week | month)\n\n**Kind**: global async function\n\n| Param                    | Type     | Description                                                  |\n| ------------------------ | -------- | ------------------------------------------------------------ |\n| markets                  | String   | AAA-BBB                                                      |\n| timeUnit                 | String   | Interval of candle. one of [days, weeks, months]             |\n| count                    | Number   | Numbers of candle count you want. 1 - 200                    |\n\n### getTick(market, count) =\u003e Promise\nGet Tick price of given market\n\n**Kind**: global async function\n\n| Param                    | Type     | Description                                                  |\n| ------------------------ | -------- | ------------------------------------------------------------ |\n| markets                  | String   | AAA-BBB                                                      |\n| count                    | Number   | Numbers of candle count you want. 1 - 200                    |\n\n### getOrderbook(markets, count) =\u003e Promise\nGet Orderbook of given market\n\n**Kind**: global async function\n\n| Param                    | Type     | Description                                                  |\n| ------------------------ | -------- | ------------------------------------------------------------ |\n| markets                  | String[] | Element should folow AAA-BBB                                 |\n| count                    | Number   | Numbers of candle count you want. 1 - 200                    |\n\n### getMarketList() =\u003e Promise\nGet Market List\n\n**Kind**: global async function\n\n| Param                    | Type     | Description                                                  |\n| ------------------------ | -------- | ------------------------------------------------------------ |\n| n/a                      | n/a      | n/a                                                          |\n\n## Exchange APIs\nYou need to create instance of Exchange class before using methods\n\n### How to create instance of Exchange class?\n```\nimport { Exchange } from 'upbit-api-node';\nconst upbitExchange = new Exchange(ACCESS_KEY, SECRET_KEY);\n```\n\n| Param                    | Type     | Description                                                  |\n| ------------------------ | -------- | ------------------------------------------------------------ |\n| accessKey                | String   | n\\a                                                          |\n| secretKey                | String   | n\\a                                                          |\n\n- You should go to [Open API Management page](https://upbit.com/mypage/open_api_management) to acquire these keys.\n\n### upbitExchange.getMyAssets() =\u003e Promise\nGet user's asset information\n\n**Kind**: async method of instance of Exchange\n\n| Param                    | Type     | Description                                                  |\n| ------------------------ | -------- | ------------------------------------------------------------ |\n| n\\a                      | n\\a      | n\\a                                                          |\n\n### upbitExchange.getOrderChance(market) =\u003e Promise\nGet order chance\n\n**Kind**: async method of instance of Exchange\n\n| Param                    | Type     | Description                                                  |\n| ------------------------ | -------- | ------------------------------------------------------------ |\n| market                   | String   | AAA-BBB                                                      |\n\n### upbitExchange.getOrderList(market?, state, page, orderBy) =\u003e Promise\nGet user's order list\n\n**Kind**: async method of instance of Exchange\n\n| Param                    | Type             | Description                                                  |\n| ------------------------ | ---------------- | ------------------------------------------------------------ |\n| market                   | String           | AAA-BBB (Optional)                                           |\n| state                    | String           | status of order. one of [wait, done, cancel]                 |\n| page                     | String           | page number                                                  |\n| orderBy                  | String | Number  | sorting method. one of [asc, desc]                           |\n\n### upbitExchange.getOrder(uuid) =\u003e Promise\nGet user's specific order\n\n**Kind**: async method of instance of Exchange\n\n| Param                    | Type     | Description                                                  |\n| ------------------------ | -------- | ------------------------------------------------------------ |\n| uuid                     | String   | uuid for order                                               |\n\n### upbitExchange.createOrder(market, side, volume, price, orderType) =\u003e Promise\nCreate order\n\n**Kind**: async method of instance of Exchange\n\n| Param                    | Type     | Description                                                  |\n| ------------------------ | -------- | ------------------------------------------------------------ |\n| market                   | String   | AAA-BBB                                                      |\n| side                     | String   | one of [bid, ask] (bid: buy, ask: sell)                      |\n| volume                   | String   | amount you want to trade                                     |\n| price                    | String   | price you want to trade                                      |\n| orderType                | String   | one of [limit]                                               |\n\n### upbitExchange.cancelOrder(uuid) =\u003e Promise\nCancel order\n\n**Kind**: async method of instance of Exchange\n\n| Param                    | Type     | Description                                                  |\n| ------------------------ | -------- | ------------------------------------------------------------ |\n| uuid                     | String   | uuid for order                                               |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwonism%2Fupbit-api-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwonism%2Fupbit-api-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwonism%2Fupbit-api-node/lists"}