ritmex-bot/docs/ccxt/wiki/exchanges/yobit.md

yobit{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchBalance
• fetchMarkets
• fetchOrderBook
• fetchOrderBooks
• fetchTickers
• fetchTicker
• fetchTrades
• fetchTradingFees
• createOrder
• cancelOrder
• fetchOrder
• fetchOpenOrders
• fetchMyTrades
• createDepositAddress
• fetchDepositAddress
• withdraw

fetchBalance{docsify-ignore}

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

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

See: https://yobit.net/en/api

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

yobit.fetchBalance ([params])

fetchMarkets{docsify-ignore}

retrieves data on all markets for yobit

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

See: https://yobit.net/en/api

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

yobit.fetchMarkets ([params])

fetchOrderBook{docsify-ignore}

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

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

See: https://yobit.net/en/api

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

yobit.fetchOrderBook (symbol[, limit, params])

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 yobit
Returns: object - a dictionary of order book structures indexed by market symbol

See: https://yobit.net/en/api

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	max number of entries per orderbook to return, default is undefined
params	object	No	extra parameters specific to the exchange API endpoint

yobit.fetchOrderBooks (symbols[, 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 yobit
Returns: object - a dictionary of ticker structures

See: https://yobit.net/en/api

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
params.all	object	No	you can set to true for convenience to fetch all tickers from this exchange by sending multiple requests

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

See: https://yobit.net/en/api

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

yobit.fetchTicker (symbol[, params])

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://yobit.net/en/api

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

yobit.fetchTrades (symbol[, since, limit, params])

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

Kind: instance method of yobit
Returns: object - a dictionary of fee structures indexed by market symbols

See: https://yobit.net/en/api

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

yobit.fetchTradingFees ([params])

createOrder{docsify-ignore}

create a trade order

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

See: https://yobit.net/en/api

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

yobit.createOrder (symbol, type, side, amount[, price, params])

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://yobit.net/en/api

Param	Type	Required	Description
id	string	Yes	order id
symbol	string	Yes	not used by yobit cancelOrder ()
params	object	No	extra parameters specific to the exchange API endpoint

yobit.cancelOrder (id, symbol[, params])

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See: https://yobit.net/en/api

Param	Type	Required	Description
id	string	Yes	order id
symbol	string	Yes	not used by yobit fetchOrder
params	object	No	extra parameters specific to the exchange API endpoint

yobit.fetchOrder (id, symbol[, params])

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See: https://yobit.net/en/api

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

yobit.fetchOpenOrders (symbol[, since, limit, params])

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See: https://yobit.net/en/api

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

yobit.fetchMyTrades (symbol[, since, limit, params])

createDepositAddress{docsify-ignore}

create a currency deposit address

Kind: instance method of yobit
Returns: object - an address structure

See: https://yobit.net/en/api

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

yobit.createDepositAddress (code[, params])

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

Kind: instance method of yobit
Returns: object - an address structure

See: https://yobit.net/en/api

Param	Type	Required	Description
code	string	Yes	unified currency code
params	object	No	extra parameters specific to the exchange API endpoint

yobit.fetchDepositAddress (code[, params])

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of yobit
Returns: object - a transaction structure

See: https://yobit.net/en/api

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

yobit.withdraw (code, amount, address, tag[, params])