mirror of
https://github.com/discountry/ritmex-bot.git
synced 2026-09-11 09:18:08 +00:00
commit
This commit is contained in:
discountry
@@ -0,0 +1,375 @@
|
||||
|
||||
<a name="coinone" id="coinone"></a>
|
||||
|
||||
## coinone{docsify-ignore}
|
||||
**Kind**: global class
|
||||
**Extends**: <code>Exchange</code>
|
||||
|
||||
* [fetchCurrencies](#fetchcurrencies)
|
||||
* [fetchMarkets](#fetchmarkets)
|
||||
* [fetchBalance](#fetchbalance)
|
||||
* [fetchOrderBook](#fetchorderbook)
|
||||
* [fetchTickers](#fetchtickers)
|
||||
* [fetchTicker](#fetchticker)
|
||||
* [fetchTrades](#fetchtrades)
|
||||
* [createOrder](#createorder)
|
||||
* [fetchOrder](#fetchorder)
|
||||
* [fetchOpenOrders](#fetchopenorders)
|
||||
* [fetchMyTrades](#fetchmytrades)
|
||||
* [cancelOrder](#cancelorder)
|
||||
* [fetchDepositAddresses](#fetchdepositaddresses)
|
||||
* [watchOrderBook](#watchorderbook)
|
||||
* [watchTicker](#watchticker)
|
||||
* [watchTrades](#watchtrades)
|
||||
|
||||
<a name="fetchCurrencies" id="fetchcurrencies"></a>
|
||||
|
||||
### fetchCurrencies{docsify-ignore}
|
||||
fetches all available currencies on an exchange
|
||||
|
||||
**Kind**: instance method of [<code>coinone</code>](#coinone)
|
||||
**Returns**: <code>object</code> - an associative dictionary of currencies
|
||||
|
||||
**See**: https://docs.coinone.co.kr/reference/currencies
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinone.fetchCurrencies ([params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchMarkets" id="fetchmarkets"></a>
|
||||
|
||||
### fetchMarkets{docsify-ignore}
|
||||
retrieves data on all markets for coinone
|
||||
|
||||
**Kind**: instance method of [<code>coinone</code>](#coinone)
|
||||
**Returns**: <code>Array<object></code> - an array of objects representing market data
|
||||
|
||||
**See**: https://docs.coinone.co.kr/v1.0/reference/tickers
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinone.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>coinone</code>](#coinone)
|
||||
**Returns**: <code>object</code> - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure)
|
||||
|
||||
**See**: https://docs.coinone.co.kr/v1.0/reference/v21
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinone.fetchBalance ([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>coinone</code>](#coinone)
|
||||
**Returns**: <code>object</code> - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols
|
||||
|
||||
**See**: https://docs.coinone.co.kr/v1.0/reference/orderbook
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | unified symbol of the market to fetch the order book for |
|
||||
| limit | <code>int</code> | No | the maximum amount of order book entries to return |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinone.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>coinone</code>](#coinone)
|
||||
**Returns**: <code>object</code> - a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://docs.coinone.co.kr/v1.0/reference/tickers
|
||||
- https://docs.coinone.co.kr/v1.0/reference/ticker
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbols | <code>Array<string></code>, <code>undefined</code> | Yes | unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinone.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>coinone</code>](#coinone)
|
||||
**Returns**: <code>object</code> - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure)
|
||||
|
||||
**See**: https://docs.coinone.co.kr/v1.0/reference/ticker
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | unified symbol of the market to fetch the ticker for |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinone.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>coinone</code>](#coinone)
|
||||
**Returns**: <code>Array<Trade></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades)
|
||||
|
||||
**See**: https://docs.coinone.co.kr/v1.0/reference/recent-completed-orders
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | unified symbol of the market to fetch trades for |
|
||||
| since | <code>int</code> | No | timestamp in ms of the earliest trade to fetch |
|
||||
| limit | <code>int</code> | No | the maximum amount of trades to fetch |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinone.fetchTrades (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="createOrder" id="createorder"></a>
|
||||
|
||||
### createOrder{docsify-ignore}
|
||||
create a trade order
|
||||
|
||||
**Kind**: instance method of [<code>coinone</code>](#coinone)
|
||||
**Returns**: <code>object</code> - an [order structure](https://docs.ccxt.com/#/?id=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 | <code>string</code> | Yes | unified symbol of the market to create an order in |
|
||||
| type | <code>string</code> | Yes | must be 'limit' |
|
||||
| side | <code>string</code> | Yes | 'buy' or 'sell' |
|
||||
| amount | <code>float</code> | Yes | how much of currency you want to trade in units of base currency |
|
||||
| price | <code>float</code> | No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinone.createOrder (symbol, type, side, amount[, price, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchOrder" id="fetchorder"></a>
|
||||
|
||||
### fetchOrder{docsify-ignore}
|
||||
fetches information on an order made by the user
|
||||
|
||||
**Kind**: instance method of [<code>coinone</code>](#coinone)
|
||||
**Returns**: <code>object</code> - An [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| id | <code>string</code> | Yes | order id |
|
||||
| symbol | <code>string</code> | Yes | unified symbol of the market the order was made in |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinone.fetchOrder (id, symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchOpenOrders" id="fetchopenorders"></a>
|
||||
|
||||
### fetchOpenOrders{docsify-ignore}
|
||||
fetch all unfilled currently open orders
|
||||
|
||||
**Kind**: instance method of [<code>coinone</code>](#coinone)
|
||||
**Returns**: <code>Array<Order></code> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | unified market symbol |
|
||||
| since | <code>int</code> | No | the earliest time in ms to fetch open orders for |
|
||||
| limit | <code>int</code> | No | the maximum number of open orders structures to retrieve |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinone.fetchOpenOrders (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchMyTrades" id="fetchmytrades"></a>
|
||||
|
||||
### fetchMyTrades{docsify-ignore}
|
||||
fetch all trades made by the user
|
||||
|
||||
**Kind**: instance method of [<code>coinone</code>](#coinone)
|
||||
**Returns**: <code>Array<Trade></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | unified market symbol |
|
||||
| since | <code>int</code> | No | the earliest time in ms to fetch trades for |
|
||||
| limit | <code>int</code> | No | the maximum number of trades structures to retrieve |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinone.fetchMyTrades (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="cancelOrder" id="cancelorder"></a>
|
||||
|
||||
### cancelOrder{docsify-ignore}
|
||||
cancels an open order
|
||||
|
||||
**Kind**: instance method of [<code>coinone</code>](#coinone)
|
||||
**Returns**: <code>object</code> - An [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| id | <code>string</code> | Yes | order id |
|
||||
| symbol | <code>string</code> | Yes | unified symbol of the market the order was made in |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinone.cancelOrder (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>coinone</code>](#coinone)
|
||||
**Returns**: <code>object</code> - a list of [address structures](https://docs.ccxt.com/#/?id=address-structure)
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| codes | <code>Array<string></code>, <code>undefined</code> | Yes | list of unified currency codes, default is undefined |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinone.fetchDepositAddresses (codes[, 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>coinone</code>](#coinone)
|
||||
**Returns**: <code>object</code> - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols
|
||||
|
||||
**See**: https://docs.coinone.co.kr/reference/public-websocket-orderbook
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | unified symbol of the market to fetch the order book for |
|
||||
| limit | <code>int</code> | No | the maximum amount of order book entries to return |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinone.watchOrderBook (symbol[, limit, 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>coinone</code>](#coinone)
|
||||
**Returns**: <code>object</code> - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure)
|
||||
|
||||
**See**: https://docs.coinone.co.kr/reference/public-websocket-ticker
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | unified symbol of the market to fetch the ticker for |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinone.watchTicker (symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="watchTrades" id="watchtrades"></a>
|
||||
|
||||
### watchTrades{docsify-ignore}
|
||||
watches information on multiple trades made in a market
|
||||
|
||||
**Kind**: instance method of [<code>coinone</code>](#coinone)
|
||||
**Returns**: <code>Array<object></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
|
||||
|
||||
**See**: https://docs.coinone.co.kr/reference/public-websocket-trade
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | unified market symbol of the market trades were made in |
|
||||
| since | <code>int</code> | No | the earliest time in ms to fetch trades for |
|
||||
| limit | <code>int</code> | No | the maximum number of trade structures to retrieve |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinone.watchTrades (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user