-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
yobit
Kind: global class
Extends: Exchange
- fetchBalance
- fetchMarkets
- fetchOrderBook
- fetchOrderBooks
- fetchTickers
- fetchTicker
- fetchTrades
- fetchTradingFees
- createOrder
- cancelOrder
- fetchOrder
- fetchOpenOrders
- fetchMyTrades
- createDepositAddress
- fetchDepositAddress
- withdraw
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
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
yobit.fetchBalance (params?)retrieves data on all markets for yobit
Kind: instance method of yobit
Returns: Array<object> - an array of objects representing market data
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
yobit.fetchMarkets (params?)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
| 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?)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
| 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?)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
| 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?)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
| 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?)get the list of most recent trades for a particular symbol
Kind: instance method of yobit
Returns: Array<Trade> - a list of trade structures
| 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?)fetch the trading fees for multiple markets
Kind: instance method of yobit
Returns: object - a dictionary of fee structures indexed by market symbols
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
yobit.fetchTradingFees (params?)create a trade order
Kind: instance method of yobit
Returns: object - an order structure
| 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?)cancels an open order
Kind: instance method of yobit
Returns: object - An order structure
| 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?)fetches information on an order made by the user
Kind: instance method of yobit
Returns: object - An order structure
| 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?)fetch all unfilled currently open orders
Kind: instance method of yobit
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 order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
yobit.fetchOpenOrders (symbol, since?, limit?, params?)fetch all trades made by the user
Kind: instance method of yobit
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 |
yobit.fetchMyTrades (symbol, since?, limit?, params?)create a currency deposit address
Kind: instance method of yobit
Returns: object - an address structure
| 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?)fetch the deposit address for a currency associated with this account
Kind: instance method of yobit
Returns: object - an address structure
| 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?)make a withdrawal
Kind: instance method of yobit
Returns: object - a transaction structure
| 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?)(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
- 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
- extended
- 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
- p2b
- pacifica
- paradex
- paymium
- phemex
- poloniex
- tokocrypto
- toobit
- upbit
- weex
- whitebit
- woo
- woofipro
- xt
- zaif
- fetchStatus