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,310 @@
|
||||
|
||||
<a name="coincheck" id="coincheck"></a>
|
||||
|
||||
## coincheck{docsify-ignore}
|
||||
**Kind**: global class
|
||||
**Extends**: <code>Exchange</code>
|
||||
|
||||
* [fetchBalance](#fetchbalance)
|
||||
* [fetchOpenOrders](#fetchopenorders)
|
||||
* [fetchOrderBook](#fetchorderbook)
|
||||
* [fetchTicker](#fetchticker)
|
||||
* [fetchMyTrades](#fetchmytrades)
|
||||
* [fetchTrades](#fetchtrades)
|
||||
* [fetchTradingFees](#fetchtradingfees)
|
||||
* [createOrder](#createorder)
|
||||
* [cancelOrder](#cancelorder)
|
||||
* [fetchDeposits](#fetchdeposits)
|
||||
* [fetchWithdrawals](#fetchwithdrawals)
|
||||
* [watchOrderBook](#watchorderbook)
|
||||
* [watchTrades](#watchtrades)
|
||||
|
||||
<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>coincheck</code>](#coincheck)
|
||||
**Returns**: <code>object</code> - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure)
|
||||
|
||||
**See**: https://coincheck.com/documents/exchange/api#order-transactions-pagination
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coincheck.fetchBalance ([params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchOpenOrders" id="fetchopenorders"></a>
|
||||
|
||||
### fetchOpenOrders{docsify-ignore}
|
||||
fetch all unfilled currently open orders
|
||||
|
||||
**Kind**: instance method of [<code>coincheck</code>](#coincheck)
|
||||
**Returns**: <code>Array<Order></code> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://coincheck.com/documents/exchange/api#order-opens
|
||||
|
||||
| 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
|
||||
coincheck.fetchOpenOrders (symbol[, since, 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>coincheck</code>](#coincheck)
|
||||
**Returns**: <code>object</code> - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols
|
||||
|
||||
**See**: https://coincheck.com/documents/exchange/api#order-book
|
||||
|
||||
| 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
|
||||
coincheck.fetchOrderBook (symbol[, limit, 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>coincheck</code>](#coincheck)
|
||||
**Returns**: <code>object</code> - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure)
|
||||
|
||||
**See**: https://coincheck.com/documents/exchange/api#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
|
||||
coincheck.fetchTicker (symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchMyTrades" id="fetchmytrades"></a>
|
||||
|
||||
### fetchMyTrades{docsify-ignore}
|
||||
fetch all trades made by the user
|
||||
|
||||
**Kind**: instance method of [<code>coincheck</code>](#coincheck)
|
||||
**Returns**: <code>Array<Trade></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
|
||||
|
||||
**See**: https://coincheck.com/documents/exchange/api#order-transactions-pagination
|
||||
|
||||
| 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
|
||||
coincheck.fetchMyTrades (symbol[, since, limit, 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>coincheck</code>](#coincheck)
|
||||
**Returns**: <code>Array<Trade></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades)
|
||||
|
||||
**See**: https://coincheck.com/documents/exchange/api#public-trades
|
||||
|
||||
| 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
|
||||
coincheck.fetchTrades (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchTradingFees" id="fetchtradingfees"></a>
|
||||
|
||||
### fetchTradingFees{docsify-ignore}
|
||||
fetch the trading fees for multiple markets
|
||||
|
||||
**Kind**: instance method of [<code>coincheck</code>](#coincheck)
|
||||
**Returns**: <code>object</code> - a dictionary of [fee structures](https://docs.ccxt.com/#/?id=fee-structure) indexed by market symbols
|
||||
|
||||
**See**: https://coincheck.com/documents/exchange/api#account-info
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coincheck.fetchTradingFees ([params])
|
||||
```
|
||||
|
||||
|
||||
<a name="createOrder" id="createorder"></a>
|
||||
|
||||
### createOrder{docsify-ignore}
|
||||
create a trade order
|
||||
|
||||
**Kind**: instance method of [<code>coincheck</code>](#coincheck)
|
||||
**Returns**: <code>object</code> - an [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://coincheck.com/documents/exchange/api#order-new
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | unified symbol of the market to create an order in |
|
||||
| type | <code>string</code> | Yes | 'market' or '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
|
||||
coincheck.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>coincheck</code>](#coincheck)
|
||||
**Returns**: <code>object</code> - An [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://coincheck.com/documents/exchange/api#order-cancel
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| id | <code>string</code> | Yes | order id |
|
||||
| symbol | <code>string</code> | Yes | not used by coincheck cancelOrder () |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coincheck.cancelOrder (id, symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchDeposits" id="fetchdeposits"></a>
|
||||
|
||||
### fetchDeposits{docsify-ignore}
|
||||
fetch all deposits made to an account
|
||||
|
||||
**Kind**: instance method of [<code>coincheck</code>](#coincheck)
|
||||
**Returns**: <code>Array<object></code> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure)
|
||||
|
||||
**See**: https://coincheck.com/documents/exchange/api#account-deposits
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| code | <code>string</code> | Yes | unified currency code |
|
||||
| since | <code>int</code> | No | the earliest time in ms to fetch deposits for |
|
||||
| limit | <code>int</code> | No | the maximum number of deposits structures to retrieve |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coincheck.fetchDeposits (code[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchWithdrawals" id="fetchwithdrawals"></a>
|
||||
|
||||
### fetchWithdrawals{docsify-ignore}
|
||||
fetch all withdrawals made from an account
|
||||
|
||||
**Kind**: instance method of [<code>coincheck</code>](#coincheck)
|
||||
**Returns**: <code>Array<object></code> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure)
|
||||
|
||||
**See**: https://coincheck.com/documents/exchange/api#withdraws
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| code | <code>string</code> | Yes | unified currency code |
|
||||
| since | <code>int</code> | No | the earliest time in ms to fetch withdrawals for |
|
||||
| limit | <code>int</code> | No | the maximum number of withdrawals structures to retrieve |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coincheck.fetchWithdrawals (code[, 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>coincheck</code>](#coincheck)
|
||||
**Returns**: <code>object</code> - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols
|
||||
|
||||
**See**: https://coincheck.com/documents/exchange/api#websocket-order-book
|
||||
|
||||
| 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
|
||||
coincheck.watchOrderBook (symbol[, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="watchTrades" id="watchtrades"></a>
|
||||
|
||||
### watchTrades{docsify-ignore}
|
||||
watches information on multiple trades made in a market
|
||||
|
||||
**Kind**: instance method of [<code>coincheck</code>](#coincheck)
|
||||
**Returns**: <code>Array<object></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
|
||||
|
||||
**See**: https://coincheck.com/documents/exchange/api#websocket-trades
|
||||
|
||||
| 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
|
||||
coincheck.watchTrades (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user