uan

upbit-api-node

Upbit API for Node.js

Showing:

Popularity

Downloads/wk

3

GitHub Stars

17

Maintenance

Last Commit

2yrs ago

Contributors

3

Package

Dependencies

4

Size (min+gzip)

14.7KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Upbit API Node

API wrapper for Upbit

npm version Build Status

Install

$ npm i -S upbit-api-node

Disclaimer

I am not responsible for anything done with this.
You use it at your own risk.
There are no warranties or guarantees expressed or implied.
You assume all responsibility and liability.

Quotation APIs

subscribe(options) => ws

Get websocket instance to subscribe websocket protocol

Kind: global function

ParamTypeDescription
optionsObject
options.reconnectFunctionCallback that is executed when try to reconnect to websocket
options.openCallbackFunctionCallback that is executed when websocket is opened
options.messageCallbackFunctionCallback that is executed when message is received
options.subscriptionListObjectList that you want to subscribe

getTicker(markets) => Promise

Get tickers of given markets

Kind: global async function

ParamTypeDescription
marketsString[]Element should folow AAA-BBB

getMinCandles(market, minutes, count) => Promise

Get candles of given market (time unit: minutes)

Kind: global async function

ParamTypeDescription
marketsStringAAA-BBB
minutesNumberInterval of candle. one of [1, 3, 5, 10, 30, 60]
countNumberNumbers of candle count you want. 1 - 200

getCandles(market, timeUnit, count) => Promise

Get candles of given market (time unit: day | week | month)

Kind: global async function

ParamTypeDescription
marketsStringAAA-BBB
timeUnitStringInterval of candle. one of [days, weeks, months]
countNumberNumbers of candle count you want. 1 - 200

getTick(market, count) => Promise

Get Tick price of given market

Kind: global async function

ParamTypeDescription
marketsStringAAA-BBB
countNumberNumbers of candle count you want. 1 - 200

getOrderbook(markets, count) => Promise

Get Orderbook of given market

Kind: global async function

ParamTypeDescription
marketsString[]Element should folow AAA-BBB
countNumberNumbers of candle count you want. 1 - 200

getMarketList() => Promise

Get Market List

Kind: global async function

ParamTypeDescription
n/an/an/a

Exchange APIs

You need to create instance of Exchange class before using methods

How to create instance of Exchange class?

import { Exchange } from 'upbit-api-node';
const upbitExchange = new Exchange(ACCESS_KEY, SECRET_KEY);
ParamTypeDescription
accessKeyStringn\a
secretKeyStringn\a

upbitExchange.getMyAssets() => Promise

Get user's asset information

Kind: async method of instance of Exchange

ParamTypeDescription
n\an\an\a

upbitExchange.getOrderChance(market) => Promise

Get order chance

Kind: async method of instance of Exchange

ParamTypeDescription
marketStringAAA-BBB

upbitExchange.getOrderList(market?, state, page, orderBy) => Promise

Get user's order list

Kind: async method of instance of Exchange

ParamTypeDescription
marketStringAAA-BBB (Optional)
stateStringstatus of order. one of [wait, done, cancel]
pageStringpage number
orderByStringNumber

upbitExchange.getOrder(uuid) => Promise

Get user's specific order

Kind: async method of instance of Exchange

ParamTypeDescription
uuidStringuuid for order

upbitExchange.createOrder(market, side, volume, price, orderType) => Promise

Create order

Kind: async method of instance of Exchange

ParamTypeDescription
marketStringAAA-BBB
sideStringone of [bid, ask] (bid: buy, ask: sell)
volumeStringamount you want to trade
priceStringprice you want to trade
orderTypeStringone of [limit]

upbitExchange.cancelOrder(uuid) => Promise

Cancel order

Kind: async method of instance of Exchange

ParamTypeDescription
uuidStringuuid for order

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100