mirror of
https://github.com/discountry/ritmex-bot.git
synced 2026-09-11 01:08:07 +00:00
commit
This commit is contained in:
discountry
@@ -0,0 +1,373 @@
|
||||
|
||||
<a name="coinmate" id="coinmate"></a>
|
||||
|
||||
## coinmate{docsify-ignore}
|
||||
**Kind**: global class
|
||||
**Extends**: <code>Exchange</code>
|
||||
|
||||
* [fetchMarkets](#fetchmarkets)
|
||||
* [fetchBalance](#fetchbalance)
|
||||
* [fetchOrderBook](#fetchorderbook)
|
||||
* [fetchTicker](#fetchticker)
|
||||
* [fetchTickers](#fetchtickers)
|
||||
* [fetchDepositsWithdrawals](#fetchdepositswithdrawals)
|
||||
* [withdraw](#withdraw)
|
||||
* [fetchMyTrades](#fetchmytrades)
|
||||
* [fetchTrades](#fetchtrades)
|
||||
* [fetchTradingFee](#fetchtradingfee)
|
||||
* [fetchOpenOrders](#fetchopenorders)
|
||||
* [fetchOrders](#fetchorders)
|
||||
* [createOrder](#createorder)
|
||||
* [fetchOrder](#fetchorder)
|
||||
* [cancelOrder](#cancelorder)
|
||||
|
||||
<a name="fetchMarkets" id="fetchmarkets"></a>
|
||||
|
||||
### fetchMarkets{docsify-ignore}
|
||||
retrieves data on all markets for coinmate
|
||||
|
||||
**Kind**: instance method of [<code>coinmate</code>](#coinmate)
|
||||
**Returns**: <code>Array<object></code> - an array of objects representing market data
|
||||
|
||||
**See**: https://coinmate.docs.apiary.io/#reference/trading-pairs/get-trading-pairs/get
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinmate.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>coinmate</code>](#coinmate)
|
||||
**Returns**: <code>object</code> - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure)
|
||||
|
||||
**See**: https://coinmate.docs.apiary.io/#reference/balance/get-balances/post
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinmate.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>coinmate</code>](#coinmate)
|
||||
**Returns**: <code>object</code> - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols
|
||||
|
||||
**See**: https://coinmate.docs.apiary.io/#reference/order-book/get-order-book/get
|
||||
|
||||
| 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
|
||||
coinmate.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>coinmate</code>](#coinmate)
|
||||
**Returns**: <code>object</code> - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure)
|
||||
|
||||
**See**: https://coinmate.docs.apiary.io/#reference/ticker/get-ticker/get
|
||||
|
||||
| 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
|
||||
coinmate.fetchTicker (symbol[, 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>coinmate</code>](#coinmate)
|
||||
**Returns**: <code>object</code> - a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure)
|
||||
|
||||
**See**: https://coinmate.docs.apiary.io/#reference/ticker/get-ticker-all/get
|
||||
|
||||
| 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
|
||||
coinmate.fetchTickers (symbols[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchDepositsWithdrawals" id="fetchdepositswithdrawals"></a>
|
||||
|
||||
### fetchDepositsWithdrawals{docsify-ignore}
|
||||
fetch history of deposits and withdrawals
|
||||
|
||||
**Kind**: instance method of [<code>coinmate</code>](#coinmate)
|
||||
**Returns**: <code>object</code> - a list of [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure)
|
||||
|
||||
**See**: https://coinmate.docs.apiary.io/#reference/transfers/get-transfer-history/post
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| code | <code>string</code> | No | unified currency code for the currency of the deposit/withdrawals, default is undefined |
|
||||
| since | <code>int</code> | No | timestamp in ms of the earliest deposit/withdrawal, default is undefined |
|
||||
| limit | <code>int</code> | No | max number of deposit/withdrawals to return, default is undefined |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinmate.fetchDepositsWithdrawals ([code, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="withdraw" id="withdraw"></a>
|
||||
|
||||
### withdraw{docsify-ignore}
|
||||
make a withdrawal
|
||||
|
||||
**Kind**: instance method of [<code>coinmate</code>](#coinmate)
|
||||
**Returns**: <code>object</code> - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://coinmate.docs.apiary.io/#reference/bitcoin-withdrawal-and-deposit/withdraw-bitcoins/post
|
||||
- https://coinmate.docs.apiary.io/#reference/litecoin-withdrawal-and-deposit/withdraw-litecoins/post
|
||||
- https://coinmate.docs.apiary.io/#reference/ethereum-withdrawal-and-deposit/withdraw-ethereum/post
|
||||
- https://coinmate.docs.apiary.io/#reference/ripple-withdrawal-and-deposit/withdraw-ripple/post
|
||||
- https://coinmate.docs.apiary.io/#reference/cardano-withdrawal-and-deposit/withdraw-cardano/post
|
||||
- https://coinmate.docs.apiary.io/#reference/solana-withdrawal-and-deposit/withdraw-solana/post
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| code | <code>string</code> | Yes | unified currency code |
|
||||
| amount | <code>float</code> | Yes | the amount to withdraw |
|
||||
| address | <code>string</code> | Yes | the address to withdraw to |
|
||||
| tag | <code>string</code> | Yes | |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinmate.withdraw (code, amount, address, tag[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchMyTrades" id="fetchmytrades"></a>
|
||||
|
||||
### fetchMyTrades{docsify-ignore}
|
||||
fetch all trades made by the user
|
||||
|
||||
**Kind**: instance method of [<code>coinmate</code>](#coinmate)
|
||||
**Returns**: <code>Array<Trade></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
|
||||
|
||||
**See**: https://coinmate.docs.apiary.io/#reference/trade-history/get-trade-history/post
|
||||
|
||||
| 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
|
||||
coinmate.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>coinmate</code>](#coinmate)
|
||||
**Returns**: <code>Array<Trade></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades)
|
||||
|
||||
**See**: https://coinmate.docs.apiary.io/#reference/transactions/transactions/get
|
||||
|
||||
| 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
|
||||
coinmate.fetchTrades (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchTradingFee" id="fetchtradingfee"></a>
|
||||
|
||||
### fetchTradingFee{docsify-ignore}
|
||||
fetch the trading fees for a market
|
||||
|
||||
**Kind**: instance method of [<code>coinmate</code>](#coinmate)
|
||||
**Returns**: <code>object</code> - a [fee structure](https://docs.ccxt.com/#/?id=fee-structure)
|
||||
|
||||
**See**: https://coinmate.docs.apiary.io/#reference/trader-fees/get-trading-fees/post
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | unified market symbol |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinmate.fetchTradingFee (symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchOpenOrders" id="fetchopenorders"></a>
|
||||
|
||||
### fetchOpenOrders{docsify-ignore}
|
||||
fetch all unfilled currently open orders
|
||||
|
||||
**Kind**: instance method of [<code>coinmate</code>](#coinmate)
|
||||
**Returns**: <code>Array<Order></code> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://coinmate.docs.apiary.io/#reference/order/get-open-orders/post
|
||||
|
||||
| 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
|
||||
coinmate.fetchOpenOrders (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchOrders" id="fetchorders"></a>
|
||||
|
||||
### fetchOrders{docsify-ignore}
|
||||
fetches information on multiple orders made by the user
|
||||
|
||||
**Kind**: instance method of [<code>coinmate</code>](#coinmate)
|
||||
**Returns**: <code>Array<Order></code> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://coinmate.docs.apiary.io/#reference/order/order-history/post
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | unified market symbol of the market orders were made in |
|
||||
| since | <code>int</code> | No | the earliest time in ms to fetch orders for |
|
||||
| limit | <code>int</code> | No | the maximum number of order structures to retrieve |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinmate.fetchOrders (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="createOrder" id="createorder"></a>
|
||||
|
||||
### createOrder{docsify-ignore}
|
||||
create a trade order
|
||||
|
||||
**Kind**: instance method of [<code>coinmate</code>](#coinmate)
|
||||
**Returns**: <code>object</code> - an [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://coinmate.docs.apiary.io/#reference/order/buy-limit-order/post
|
||||
- https://coinmate.docs.apiary.io/#reference/order/sell-limit-order/post
|
||||
- https://coinmate.docs.apiary.io/#reference/order/buy-instant-order/post
|
||||
- https://coinmate.docs.apiary.io/#reference/order/sell-instant-order/post
|
||||
|
||||
|
||||
| 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
|
||||
coinmate.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>coinmate</code>](#coinmate)
|
||||
**Returns**: <code>object</code> - An [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://coinmate.docs.apiary.io/#reference/order/get-order-by-orderid/post
|
||||
- https://coinmate.docs.apiary.io/#reference/order/get-order-by-clientorderid/post
|
||||
|
||||
|
||||
| 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
|
||||
coinmate.fetchOrder (id, symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="cancelOrder" id="cancelorder"></a>
|
||||
|
||||
### cancelOrder{docsify-ignore}
|
||||
cancels an open order
|
||||
|
||||
**Kind**: instance method of [<code>coinmate</code>](#coinmate)
|
||||
**Returns**: <code>object</code> - An [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://coinmate.docs.apiary.io/#reference/order/cancel-order/post
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| id | <code>string</code> | Yes | order id |
|
||||
| symbol | <code>string</code> | Yes | not used by coinmate cancelOrder () |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
coinmate.cancelOrder (id, symbol[, params])
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user