ContextQMD
Back to Ccxt

Upbit

wiki/exchanges/upbit.md

4.5.5832.9 KB
Original Source

<a name="upbit" id="upbit"></a>

upbit{docsify-ignore}

Kind: global class
Extends: <code>Exchange</code>

<a name="fetchMarkets" id="fetchmarkets"></a>

fetchMarkets{docsify-ignore}

retrieves data on all markets for upbit

Kind: instance method of <code>upbit</code>
Returns: <code>Array<object></code> - an array of objects representing market data

See

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.fetchMarkets (params?)

<a name="fetchBalance" id="fetchbalance"></a>

fetchBalance{docsify-ignore}

query for balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - a balance structure

See

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.fetchBalance (params?)

<a name="fetchOrderBooks" id="fetchorderbooks"></a>

fetchOrderBooks{docsify-ignore}

fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data for multiple markets

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - a dictionary of order book structures indexed by market symbol

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>, <code>undefined</code>Yeslist of unified market symbols, all symbols fetched if undefined, default is undefined
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.fetchOrderBooks (symbols, limit?, params?)

<a name="fetchOrderBook" id="fetchorderbook"></a>

fetchOrderBook{docsify-ignore}

fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.fetchOrderBook (symbol, limit?, params?)

<a name="fetchTickers" id="fetchtickers"></a>

fetchTickers{docsify-ignore}

fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - a dictionary of ticker structures

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>, <code>undefined</code>Yesunified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.fetchTickers (symbols, params?)

<a name="fetchTicker" id="fetchticker"></a>

fetchTicker{docsify-ignore}

fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - a ticker structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.fetchTicker (symbol, params?)

<a name="fetchTrades" id="fetchtrades"></a>

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>upbit</code>
Returns: <code>Array<Trade></code> - a list of trade structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.fetchTrades (symbol, since?, limit?, params?)

<a name="fetchTradingFee" id="fetchtradingfee"></a>

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - a fee structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.fetchTradingFee (symbol, params?)

<a name="fetchTradingFees" id="fetchtradingfees"></a>

fetchTradingFees{docsify-ignore}

fetch the trading fees for markets

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - a trading fee structure

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.fetchTradingFees (params?)

<a name="fetchOHLCV" id="fetchohlcv"></a>

fetchOHLCV{docsify-ignore}

fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market

Kind: instance method of <code>upbit</code>
Returns: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
since<code>int</code>Notimestamp in ms of the earliest candle to fetch
limit<code>int</code>Nothe maximum amount of candles to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.fetchOHLCV (symbol, timeframe, since?, limit?, params?)

<a name="createOrder" id="createorder"></a>

createOrder{docsify-ignore}

create a trade order

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - an order structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to create an order in
type<code>string</code>Yessupports 'market' and 'limit'. if params.ordType is set to best, a best-type order will be created regardless of the value of type.
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Yeshow much you want to trade in units of the base currency
price<code>float</code>Nothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.cost<code>float</code>Nofor market buy and best buy orders, the quote quantity that can be used as an alternative for the amount
params.ordType<code>string</code>Nothis field can be used to place a ‘best’ type order
params.timeInForce<code>string</code>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<code>string</code>No'reduce', 'cancel_maker', 'cancel_taker' https://global-docs.upbit.com/docs/smp
params.test<code>boolean</code>NoIf test is true, testOrder will be executed. It allows you to validate the request without creating an actual order. Default is false.
javascript
upbit.createOrder (symbol, type, side, amount, price?, params?)

<a name="cancelOrder" id="cancelorder"></a>

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - An order structure

See

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesnot used by upbit cancelOrder ()
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.cancelOrder (id, symbol, params?)

<a name="editOrder" id="editorder"></a>

editOrder{docsify-ignore}

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 <code>upbit</code>
Returns: <code>object</code> - An order structure

See

ParamTypeRequiredDescription
id<code>string</code>Yesthe uuid of the previous order you want to edit.
symbol<code>string</code>Yesthe symbol of the new order. it must be the same as the symbol of the previous order.
type<code>string</code>Yesthe 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<code>string</code>Yesthe side of the new order. it must be the same as the side of the previous order.
amount<code>number</code>Yesthe amount of the asset you want to buy or sell. It could be overridden by specifying the new_volume parameter in params.
price<code>number</code>Yesthe price of the asset you want to buy or sell. It could be overridden by specifying the new_price parameter in params.
params<code>object</code>Noextra parameters specific to the exchange API endpoint.
params.clientOrderId<code>string</code>Noto identify the previous order, either the id or this field is required in this method.
params.cost<code>float</code>Nofor market buy and best buy orders, the quote quantity that can be used as an alternative for the amount.
params.newTimeInForce<code>string</code>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<code>string</code>Nothe order ID that the user can define.
params.newOrdType<code>string</code>Nothis 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<code>string</code>No'reduce', 'cancel_maker', 'cancel_taker' https://global-docs.upbit.com/docs/smp
javascript
upbit.editOrder (id, symbol, type, side, amount, price, params?)

<a name="fetchDeposits" id="fetchdeposits"></a>

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

Kind: instance method of <code>upbit</code>
Returns: <code>Array<object></code> - a list of transaction structures

See

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch deposits for
limit<code>int</code>Nothe maximum number of deposits structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.fetchDeposits (code, since?, limit?, params?)

<a name="fetchDeposit" id="fetchdeposit"></a>

fetchDeposit{docsify-ignore}

fetch information on a deposit

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - a transaction structure

See

ParamTypeRequiredDescription
id<code>string</code>Yesthe unique id for the deposit
code<code>string</code>Nounified currency code of the currency deposited
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.txid<code>string</code>Nowithdrawal transaction id, the id argument is reserved for uuid
javascript
upbit.fetchDeposit (id, code?, params?)

<a name="fetchWithdrawals" id="fetchwithdrawals"></a>

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

Kind: instance method of <code>upbit</code>
Returns: <code>Array<object></code> - a list of transaction structures

See

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch withdrawals for
limit<code>int</code>Nothe maximum number of withdrawals structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.fetchWithdrawals (code, since?, limit?, params?)

<a name="fetchWithdrawal" id="fetchwithdrawal"></a>

fetchWithdrawal{docsify-ignore}

fetch data on a currency withdrawal via the withdrawal id

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - a transaction structure

See

ParamTypeRequiredDescription
id<code>string</code>Yesthe unique id for the withdrawal
code<code>string</code>Nounified currency code of the currency withdrawn
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.txid<code>string</code>Nowithdrawal transaction id, the id argument is reserved for uuid
javascript
upbit.fetchWithdrawal (id, code?, params?)

<a name="fetchOpenOrders" id="fetchopenorders"></a>

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of <code>upbit</code>
Returns: <code>Array<Order></code> - a list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch open orders for
limit<code>int</code>Nothe maximum number of open order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.state<code>string</code>Nodefault is 'wait', set to 'watch' for stop limit orders
javascript
upbit.fetchOpenOrders (symbol, since?, limit?, params?)

<a name="fetchClosedOrders" id="fetchclosedorders"></a>

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

Kind: instance method of <code>upbit</code>
Returns: <code>Array<Order></code> - a list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms of the latest order
javascript
upbit.fetchClosedOrders (symbol, since?, limit?, params?)

<a name="fetchCanceledOrders" id="fetchcanceledorders"></a>

fetchCanceledOrders{docsify-ignore}

fetches information on multiple canceled orders made by the user

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - a list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Notimestamp in ms of the earliest order, default is undefined
limit<code>int</code>Nomax number of orders to return, default is undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms of the latest order
javascript
upbit.fetchCanceledOrders (symbol, since?, limit?, params?)

<a name="fetchOrder" id="fetchorder"></a>

fetchOrder{docsify-ignore}

fetches information on an order made by the user

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - An order structure

See

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesnot used by upbit fetchOrder
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.fetchOrder (id, symbol, params?)

<a name="fetchDepositAddresses" id="fetchdepositaddresses"></a>

fetchDepositAddresses{docsify-ignore}

fetch deposit addresses for multiple currencies and chain types

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - a list of address structures

See

ParamTypeRequiredDescription
codes<code>Array<string></code>, <code>undefined</code>Yeslist of unified currency codes, default is undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.fetchDepositAddresses (codes, params?)

<a name="fetchDepositAddress" id="fetchdepositaddress"></a>

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - an address structure

See

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.network<code>string</code>Yesdeposit chain, can view all chains via this.publicGetWalletAssets, default is eth, unless the currency has a default chain within this.options['networks']
javascript
upbit.fetchDepositAddress (code, params?)

<a name="createDepositAddress" id="createdepositaddress"></a>

createDepositAddress{docsify-ignore}

create a currency deposit address

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - an address structure

See

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code of the currency for the deposit address
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.createDepositAddress (code, params?)

<a name="withdraw" id="withdraw"></a>

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - a transaction structure

See

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
amount<code>float</code>Yesthe amount to withdraw
address<code>string</code>Yesthe address to withdraw to
tag<code>string</code>Yes
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.withdraw (code, amount, address, tag, params?)

<a name="watchTicker" id="watchticker"></a>

watchTicker{docsify-ignore}

watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - a ticker structure

See: https://global-docs.upbit.com/reference/websocket-ticker

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.watchTicker (symbol, params?)

<a name="watchTickers" id="watchtickers"></a>

watchTickers{docsify-ignore}

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 <code>upbit</code>
Returns: <code>object</code> - a ticker structure

See: https://global-docs.upbit.com/reference/websocket-ticker

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.watchTickers (symbols, params?)

<a name="watchTrades" id="watchtrades"></a>

watchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>upbit</code>
Returns: <code>Array<object></code> - a list of trade structures

See: https://global-docs.upbit.com/reference/websocket-trade

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.watchTrades (symbol, since?, limit?, params?)

<a name="watchTradesForSymbols" id="watchtradesforsymbols"></a>

watchTradesForSymbols{docsify-ignore}

get the list of most recent trades for a list of symbols

Kind: instance method of <code>upbit</code>
Returns: <code>Array<object></code> - a list of trade structures

See: https://global-docs.upbit.com/reference/websocket-trade

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.watchTradesForSymbols (symbols, since?, limit?, params?)

<a name="watchOrderBook" id="watchorderbook"></a>

watchOrderBook{docsify-ignore}

watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See: https://global-docs.upbit.com/reference/websocket-orderbook

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.watchOrderBook (symbol, limit?, params?)

<a name="watchOHLCV" id="watchohlcv"></a>

watchOHLCV{docsify-ignore}

watches information an OHLCV with timestamp, openingPrice, highPrice, lowPrice, tradePrice, baseVolume in 1s.

Kind: instance method of <code>upbit</code>
Returns: <code>Array<OHLCV></code> - a list of OHLCV structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
timeframe<code>string</code>Yesspecifies the OHLCV candle interval to watch. As of now, Upbit only supports 1s candles.
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.watchOHLCV (symbol, timeframe, since?, limit?, params?)

<a name="watchOrders" id="watchorders"></a>

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

Kind: instance method of <code>upbit</code>
Returns: <code>Array<object></code> - a list of order structures

See: https://global-docs.upbit.com/reference/websocket-myorder

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.watchOrders (symbol, since?, limit?, params?)

<a name="watchMyTrades" id="watchmytrades"></a>

watchMyTrades{docsify-ignore}

watches information on multiple trades made by the user

Kind: instance method of <code>upbit</code>
Returns: <code>Array<object></code> - a list of trade structures

See: https://global-docs.upbit.com/reference/websocket-myorder

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.watchMyTrades (symbol, since?, limit?, params?)

<a name="watchBalance" id="watchbalance"></a>

watchBalance{docsify-ignore}

query for balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of <code>upbit</code>
Returns: <code>object</code> - a balance structure

See: https://global-docs.upbit.com/reference/websocket-myasset

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
upbit.watchBalance (params?)