-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
upbit
Kind: global class
Extends: Exchange
- fetchMarkets
- fetchBalance
- fetchOrderBooks
- fetchOrderBook
- fetchTickers
- fetchTicker
- fetchTrades
- fetchTradingFee
- fetchTradingFees
- fetchOHLCV
- createOrder
- cancelOrder
- editOrder
- fetchDeposits
- fetchDeposit
- fetchWithdrawals
- fetchWithdrawal
- fetchOpenOrders
- fetchClosedOrders
- fetchCanceledOrders
- fetchOrder
- fetchDepositAddresses
- fetchDepositAddress
- createDepositAddress
- withdraw
- watchTicker
- watchTickers
- watchTrades
- watchTradesForSymbols
- watchOrderBook
- watchOHLCV
- watchOrders
- watchMyTrades
- watchBalance
retrieves data on all markets for upbit
Kind: instance method of upbit
Returns: Array<object> - an array of objects representing market data
See
- https://docs.upbit.com/kr/reference/list-trading-pairs
- https://global-docs.upbit.com/reference/list-trading-pairs
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.fetchMarkets ([params])query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of upbit
Returns: object - a balance structure
See
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.fetchBalance ([params])fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data for multiple markets
Kind: instance method of upbit
Returns: object - a dictionary of order book structures indexed by market symbol
See
- https://docs.upbit.com/kr/reference/list-orderbooks
- https://global-docs.upbit.com/reference/list-orderbooks
| Param | Type | Required | Description |
|---|---|---|---|
| symbols |
Array<string>, undefined
|
Yes | list of unified market symbols, all symbols fetched if undefined, default is undefined |
| limit | int |
No | the maximum amount of order book entries to return |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.fetchOrderBooks (symbols[, limit, params])fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of upbit
Returns: object - A dictionary of order book structures indexed by market symbols
See
- https://docs.upbit.com/kr/reference/list-orderbooks
- https://global-docs.upbit.com/reference/list-orderbooks
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the order book for |
| limit | int |
No | the maximum amount of order book entries to return |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.fetchOrderBook (symbol[, limit, params])fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
Kind: instance method of upbit
Returns: object - a dictionary of ticker structures
See
- https://docs.upbit.com/kr/reference/list-tickers
- https://global-docs.upbit.com/reference/list-tickers
| Param | Type | Required | Description |
|---|---|---|---|
| symbols |
Array<string>, undefined
|
Yes | unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.fetchTickers (symbols[, params])fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of upbit
Returns: object - a ticker structure
See
- https://docs.upbit.com/kr/reference/list-tickers
- https://global-docs.upbit.com/reference/list-tickers
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the ticker for |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.fetchTicker (symbol[, params])get the list of most recent trades for a particular symbol
Kind: instance method of upbit
Returns: Array<Trade> - a list of trade structures
See
- https://docs.upbit.com/kr/reference/list-pair-trades
- https://global-docs.upbit.com/reference/list-pair-trades
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch trades for |
| since | int |
No | timestamp in ms of the earliest trade to fetch |
| limit | int |
No | the maximum amount of trades to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.fetchTrades (symbol[, since, limit, params])fetch the trading fees for a market
Kind: instance method of upbit
Returns: object - a fee structure
See
- https://docs.upbit.com/kr/reference/available-order-information
- https://global-docs.upbit.com/reference/available-order-information
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.fetchTradingFee (symbol[, params])fetch the trading fees for markets
Kind: instance method of upbit
Returns: object - a trading fee structure
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.fetchTradingFees ([params])fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of upbit
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See
- https://docs.upbit.com/kr/reference/list-candles-minutes
- https://global-docs.upbit.com/reference/list-candles-minutes
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
Yes | the length of time each candle represents |
| since | int |
No | timestamp in ms of the earliest candle to fetch |
| limit | int |
No | the maximum amount of candles to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.fetchOHLCV (symbol, timeframe[, since, limit, params])create a trade order
Kind: instance method of upbit
Returns: object - an order structure
See
- https://docs.upbit.com/kr/reference/new-order
- https://global-docs.upbit.com/reference/new-order
- https://docs.upbit.com/kr/reference/order-test
- https://global-docs.upbit.com/reference/order-test
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to create an order in |
| type | string |
Yes | supports 'market' and 'limit'. if params.ordType is set to best, a best-type order will be created regardless of the value of type. |
| side | string |
Yes | 'buy' or 'sell' |
| amount | float |
Yes | how much you want to trade in units of the base currency |
| price | float |
No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.cost | float |
No | for market buy and best buy orders, the quote quantity that can be used as an alternative for the amount |
| params.ordType | string |
No | this field can be used to place a ‘best’ type order |
| params.timeInForce | string |
No | 'IOC' or 'FOK' for limit or best type orders, 'PO' for limit orders. this field is required when the order type is 'best'. |
| params.selfTradePrevention | string |
No | 'reduce', 'cancel_maker', 'cancel_taker' https://global-docs.upbit.com/docs/smp |
| params.test | boolean |
No | If test is true, testOrder will be executed. It allows you to validate the request without creating an actual order. Default is false. |
upbit.createOrder (symbol, type, side, amount[, price, params])cancels an open order
Kind: instance method of upbit
Returns: object - An order structure
See
- https://docs.upbit.com/kr/reference/cancel-order
- https://global-docs.upbit.com/reference/cancel-order
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | order id |
| symbol | string |
Yes | not used by upbit cancelOrder () |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.cancelOrder (id, symbol[, params])canceled existing order and create new order. It's only generated same side and symbol as the canceled order. it returns the data of the canceled order, except for new_order_uuid and new_identifier. to get the details of the new order, use fetchOrder(new_order_uuid).
Kind: instance method of upbit
Returns: object - An order structure
See
- https://docs.upbit.com/kr/reference/cancel-and-new-order
- https://global-docs.upbit.com/reference/cancel-and-new-order
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | the uuid of the previous order you want to edit. |
| symbol | string |
Yes | the symbol of the new order. it must be the same as the symbol of the previous order. |
| type | string |
Yes | the type of the new order. only limit or market is accepted. if params.newOrdType is set to best, a best-type order will be created regardless of the value of type. |
| side | string |
Yes | the side of the new order. it must be the same as the side of the previous order. |
| amount | number |
Yes | the amount of the asset you want to buy or sell. It could be overridden by specifying the new_volume parameter in params. |
| price | number |
Yes | the price of the asset you want to buy or sell. It could be overridden by specifying the new_price parameter in params. |
| params | object |
No | extra parameters specific to the exchange API endpoint. |
| params.clientOrderId | string |
No | to identify the previous order, either the id or this field is required in this method. |
| params.cost | float |
No | for market buy and best buy orders, the quote quantity that can be used as an alternative for the amount. |
| params.newTimeInForce | string |
No | 'IOC' or 'FOK' for limit or best type orders, 'PO' for limit orders. this field is required when the order type is 'best'. |
| params.newClientOrderId | string |
No | the order ID that the user can define. |
| params.newOrdType | string |
No | this field only accepts limit, price, market, or best. You can refer to the Upbit developer documentation for details on how to use this field. |
| params.selfTradePrevention | string |
No | 'reduce', 'cancel_maker', 'cancel_taker' https://global-docs.upbit.com/docs/smp |
upbit.editOrder (id, symbol, type, side, amount, price[, params])fetch all deposits made to an account
Kind: instance method of upbit
Returns: Array<object> - a list of transaction structures
See
- https://docs.upbit.com/kr/reference/list-deposits
- https://global-docs.upbit.com/reference/list-deposits
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| since | int |
No | the earliest time in ms to fetch deposits for |
| limit | int |
No | the maximum number of deposits structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.fetchDeposits (code[, since, limit, params])fetch information on a deposit
Kind: instance method of upbit
Returns: object - a transaction structure
See
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | the unique id for the deposit |
| code | string |
No | unified currency code of the currency deposited |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.txid | string |
No | withdrawal transaction id, the id argument is reserved for uuid |
upbit.fetchDeposit (id[, code, params])fetch all withdrawals made from an account
Kind: instance method of upbit
Returns: Array<object> - a list of transaction structures
See
- https://docs.upbit.com/kr/reference/list-withdrawals
- https://global-docs.upbit.com/reference/list-withdrawals
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| since | int |
No | the earliest time in ms to fetch withdrawals for |
| limit | int |
No | the maximum number of withdrawals structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.fetchWithdrawals (code[, since, limit, params])fetch data on a currency withdrawal via the withdrawal id
Kind: instance method of upbit
Returns: object - a transaction structure
See
- https://docs.upbit.com/kr/reference/get-withdrawal
- https://global-docs.upbit.com/reference/get-withdrawal
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | the unique id for the withdrawal |
| code | string |
No | unified currency code of the currency withdrawn |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.txid | string |
No | withdrawal transaction id, the id argument is reserved for uuid |
upbit.fetchWithdrawal (id[, code, params])fetch all unfilled currently open orders
Kind: instance method of upbit
Returns: Array<Order> - a list of order structures
See
- https://docs.upbit.com/kr/reference/list-open-orders
- https://global-docs.upbit.com/reference/list-open-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| since | int |
No | the earliest time in ms to fetch open orders for |
| limit | int |
No | the maximum number of open order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.state | string |
No | default is 'wait', set to 'watch' for stop limit orders |
upbit.fetchOpenOrders (symbol[, since, limit, params])fetches information on multiple closed orders made by the user
Kind: instance method of upbit
Returns: Array<Order> - a list of order structures
See
- https://docs.upbit.com/kr/reference/list-closed-orders
- https://global-docs.upbit.com/reference/list-closed-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.until | int |
No | timestamp in ms of the latest order |
upbit.fetchClosedOrders (symbol[, since, limit, params])fetches information on multiple canceled orders made by the user
Kind: instance method of upbit
Returns: object - a list of order structures
See
- https://docs.upbit.com/kr/reference/list-closed-orders
- https://global-docs.upbit.com/reference/list-closed-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | timestamp in ms of the earliest order, default is undefined |
| limit | int |
No | max number of orders to return, default is undefined |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.until | int |
No | timestamp in ms of the latest order |
upbit.fetchCanceledOrders (symbol[, since, limit, params])fetches information on an order made by the user
Kind: instance method of upbit
Returns: object - An order structure
See
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | order id |
| symbol | string |
Yes | not used by upbit fetchOrder |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.fetchOrder (id, symbol[, params])fetch deposit addresses for multiple currencies and chain types
Kind: instance method of upbit
Returns: object - a list of address structures
See
- https://docs.upbit.com/kr/reference/list-deposit-addresses
- https://global-docs.upbit.com/reference/list-deposit-addresses
| Param | Type | Required | Description |
|---|---|---|---|
| codes |
Array<string>, undefined
|
Yes | list of unified currency codes, default is undefined |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.fetchDepositAddresses (codes[, params])fetch the deposit address for a currency associated with this account
Kind: instance method of upbit
Returns: object - an address structure
See
- https://docs.upbit.com/kr/reference/get-deposit-address
- https://global-docs.upbit.com/reference/get-deposit-address
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.network | string |
Yes | deposit chain, can view all chains via this.publicGetWalletAssets, default is eth, unless the currency has a default chain within this.options['networks'] |
upbit.fetchDepositAddress (code[, params])create a currency deposit address
Kind: instance method of upbit
Returns: object - an address structure
See
- https://docs.upbit.com/kr/reference/create-deposit-address
- https://global-docs.upbit.com/reference/create-deposit-address
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code of the currency for the deposit address |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.createDepositAddress (code[, params])make a withdrawal
Kind: instance method of upbit
Returns: object - a transaction structure
See
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| amount | float |
Yes | the amount to withdraw |
| address | string |
Yes | the address to withdraw to |
| tag | string |
Yes | |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.withdraw (code, amount, address, tag[, params])watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of upbit
Returns: object - a ticker structure
See: https://global-docs.upbit.com/reference/websocket-ticker
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the ticker for |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.watchTicker (symbol[, params])watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list
Kind: instance method of upbit
Returns: object - a ticker structure
See: https://global-docs.upbit.com/reference/websocket-ticker
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> |
Yes | unified symbol of the market to fetch the ticker for |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.watchTickers (symbols[, params])get the list of most recent trades for a particular symbol
Kind: instance method of upbit
Returns: Array<object> - a list of trade structures
See: https://global-docs.upbit.com/reference/websocket-trade
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch trades for |
| since | int |
No | timestamp in ms of the earliest trade to fetch |
| limit | int |
No | the maximum amount of trades to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.watchTrades (symbol[, since, limit, params])get the list of most recent trades for a list of symbols
Kind: instance method of upbit
Returns: Array<object> - a list of trade structures
See: https://global-docs.upbit.com/reference/websocket-trade
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> |
Yes | unified symbol of the market to fetch trades for |
| since | int |
No | timestamp in ms of the earliest trade to fetch |
| limit | int |
No | the maximum amount of trades to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.watchTradesForSymbols (symbols[, since, limit, params])watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of upbit
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://global-docs.upbit.com/reference/websocket-orderbook
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the order book for |
| limit | int |
No | the maximum amount of order book entries to return |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.watchOrderBook (symbol[, limit, params])watches information an OHLCV with timestamp, openingPrice, highPrice, lowPrice, tradePrice, baseVolume in 1s.
Kind: instance method of upbit
Returns: Array<OHLCV> - a list of OHLCV structures
See
- https://docs.upbit.com/kr/reference/websocket-candle for Upbit KR
- https://global-docs.upbit.com/reference/websocket-candle for Upbit Global
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| timeframe | string |
Yes | specifies the OHLCV candle interval to watch. As of now, Upbit only supports 1s candles. |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.watchOHLCV (symbol, timeframe[, since, limit, params])watches information on multiple orders made by the user
Kind: instance method of upbit
Returns: Array<object> - a list of order structures
See: https://global-docs.upbit.com/reference/websocket-myorder
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.watchOrders (symbol[, since, limit, params])watches information on multiple trades made by the user
Kind: instance method of upbit
Returns: Array<object> - a list of trade structures
See: https://global-docs.upbit.com/reference/websocket-myorder
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.watchMyTrades (symbol[, since, limit, params])query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of upbit
Returns: object - a balance structure
See: https://global-docs.upbit.com/reference/websocket-myasset
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
upbit.watchBalance ([params])(If the page is not being rendered for you, you can refer to the mirror at https://docs.ccxt.com/)
- Install
- Examples
- Manual
- CCXT Pro
- Contributing
- Supported Exchanges
- Exchanges By Country
- API Spec By Method
- FAQ
- Changelog
- Awesome
- API Spec by Exchange
- fetchCurrencies
- alpaca
- apex
- arkham
- ascendex
- aster
- backpack
- bigone
- binance
- bingx
- bit2c
- bitbank
- bitbns
- bitfinex
- bitflyer
- bitget
- bithumb
- bitmart
- bitmex
- bitopro
- bitrue
- bitso
- bitstamp
- bitteam
- bittrade
- bitvavo
- blockchaincom
- blofin
- btcbox
- btcmarkets
- btcturk
- bullish
- bybit
- bydfi
- cex
- coinbase
- coinbaseexchange
- coinbaseinternational
- coincheck
- coinex
- coinmate
- coinmetro
- coinone
- coinsph
- coinspot
- cryptocom
- cryptomus
- deepcoin
- delta
- deribit
- derive
- digifinex
- dydx
- exmo
- foxbit
- gate
- gemini
- grvt
- hashkey
- hibachi
- hitbtc
- hollaex
- htx
- hyperliquid
- independentreserve
- indodax
- kraken
- krakenfutures
- kucoin
- fetchBidsAsks
- latoken
- lbank
- lighter
- luno
- mercado
- mexc
- modetrade
- ndax
- novadax
- okx
- onetrading
- oxfun
- p2b
- pacifica
- paradex
- paymium
- phemex
- poloniex
- tokocrypto
- toobit
- upbit
- wavesexchange
- weex
- whitebit
- woo
- woofipro
- xt
- yobit
- zaif
- fetchStatus