coinone

coinone{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchCurrencies
• fetchMarkets
• fetchBalance
• fetchOrderBook
• fetchTickers
• fetchTicker
• fetchTrades
• createOrder
• fetchOrder
• fetchOpenOrders
• fetchMyTrades
• cancelOrder
• fetchDepositAddresses
• watchOrderBook
• watchTicker
• watchTrades

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of coinone
Returns: object - an associative dictionary of currencies

See: https://docs.coinone.co.kr/reference/currencies

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

coinone.fetchCurrencies (params?)

fetchMarkets{docsify-ignore}

retrieves data on all markets for coinone

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

See: https://docs.coinone.co.kr/v1.0/reference/tickers

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

coinone.fetchMarkets (params?)

fetchBalance{docsify-ignore}

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

Kind: instance method of coinone
Returns: object - a balance structure

See: https://docs.coinone.co.kr/v1.0/reference/v21

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

coinone.fetchBalance (params?)

fetchOrderBook{docsify-ignore}

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

Kind: instance method of coinone
Returns: object - A dictionary of order book structures indexed by market symbols

See: https://docs.coinone.co.kr/v1.0/reference/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

coinone.fetchOrderBook (symbol, limit?, params?)

fetchTickers{docsify-ignore}

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

Kind: instance method of coinone
Returns: object - a dictionary of ticker structures

See

• https://docs.coinone.co.kr/v1.0/reference/tickers
• https://docs.coinone.co.kr/v1.0/reference/ticker

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

coinone.fetchTickers (symbols, params?)

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 coinone
Returns: object - a ticker structure

See: https://docs.coinone.co.kr/v1.0/reference/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

coinone.fetchTicker (symbol, params?)

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of coinone
Returns: Array<Trade> - a list of trade structures

See: https://docs.coinone.co.kr/v1.0/reference/recent-completed-orders

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

coinone.fetchTrades (symbol, since?, limit?, params?)

createOrder{docsify-ignore}

create a trade order

Kind: instance method of coinone
Returns: object - an order structure

See

• https://doc.coinone.co.kr/#tag/Order-V2/operation/v2_order_limit_buy
• https://doc.coinone.co.kr/#tag/Order-V2/operation/v2_order_limit_sell

Param	Type	Required	Description
symbol	string	Yes	unified symbol of the market to create an order in
type	string	Yes	must be 'limit'
side	string	Yes	'buy' or 'sell'
amount	float	Yes	how much of currency you want to trade in units of 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

coinone.createOrder (symbol, type, side, amount, price?, params?)

fetchOrder{docsify-ignore}

fetches information on an order made by the user

Kind: instance method of coinone
Returns: object - An order structure

Param	Type	Required	Description
id	string	Yes	order id
symbol	string	Yes	unified symbol of the market the order was made in
params	object	No	extra parameters specific to the exchange API endpoint

coinone.fetchOrder (id, symbol, params?)

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of coinone
Returns: Array<Order> - a list of order structures

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 orders structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

coinone.fetchOpenOrders (symbol, since?, limit?, params?)

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

Kind: instance method of coinone
Returns: Array<Trade> - a list of trade structures

Param	Type	Required	Description
symbol	string	Yes	unified market symbol
since	int	No	the earliest time in ms to fetch trades for
limit	int	No	the maximum number of trades structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

coinone.fetchMyTrades (symbol, since?, limit?, params?)

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of coinone
Returns: object - An order structure

Param	Type	Required	Description
id	string	Yes	order id
symbol	string	Yes	unified symbol of the market the order was made in
params	object	No	extra parameters specific to the exchange API endpoint

coinone.cancelOrder (id, symbol, params?)

fetchDepositAddresses{docsify-ignore}

fetch deposit addresses for multiple currencies and chain types

Kind: instance method of coinone
Returns: object - a list of address structures

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

coinone.fetchDepositAddresses (codes, params?)

watchOrderBook{docsify-ignore}

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

Kind: instance method of coinone
Returns: object - A dictionary of order book structures indexed by market symbols

See: https://docs.coinone.co.kr/reference/public-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

coinone.watchOrderBook (symbol, limit?, params?)

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 coinone
Returns: object - a ticker structure

See: https://docs.coinone.co.kr/reference/public-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

coinone.watchTicker (symbol, params?)

watchTrades{docsify-ignore}

watches information on multiple trades made in a market

Kind: instance method of coinone
Returns: Array<object> - a list of trade structures

See: https://docs.coinone.co.kr/reference/public-websocket-trade

Param	Type	Required	Description
symbol	string	Yes	unified market symbol of the market trades were made in
since	int	No	the earliest time in ms to fetch trades for
limit	int	No	the maximum number of trade structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

coinone.watchTrades (symbol, since?, limit?, params?)