mirror of
https://github.com/discountry/ritmex-bot.git
synced 2026-09-10 16:58:08 +00:00
commit
This commit is contained in:
discountry
@@ -0,0 +1,514 @@
|
||||
|
||||
<a name="bitso" id="bitso"></a>
|
||||
|
||||
## bitso{docsify-ignore}
|
||||
**Kind**: global class
|
||||
**Extends**: <code>Exchange</code>
|
||||
|
||||
* [fetchLedger](#fetchledger)
|
||||
* [fetchMarkets](#fetchmarkets)
|
||||
* [fetchBalance](#fetchbalance)
|
||||
* [fetchOrderBook](#fetchorderbook)
|
||||
* [fetchTicker](#fetchticker)
|
||||
* [fetchOHLCV](#fetchohlcv)
|
||||
* [fetchTrades](#fetchtrades)
|
||||
* [fetchTradingFees](#fetchtradingfees)
|
||||
* [fetchMyTrades](#fetchmytrades)
|
||||
* [createOrder](#createorder)
|
||||
* [cancelOrder](#cancelorder)
|
||||
* [cancelOrders](#cancelorders)
|
||||
* [cancelAllOrders](#cancelallorders)
|
||||
* [fetchOpenOrders](#fetchopenorders)
|
||||
* [fetchOrder](#fetchorder)
|
||||
* [fetchOrderTrades](#fetchordertrades)
|
||||
* [fetchDeposit](#fetchdeposit)
|
||||
* [fetchDeposits](#fetchdeposits)
|
||||
* [fetchDepositAddress](#fetchdepositaddress)
|
||||
* [fetchTransactionFees](#fetchtransactionfees)
|
||||
* [fetchDepositWithdrawFees](#fetchdepositwithdrawfees)
|
||||
* [withdraw](#withdraw)
|
||||
|
||||
<a name="fetchLedger" id="fetchledger"></a>
|
||||
|
||||
### fetchLedger{docsify-ignore}
|
||||
fetch the history of changes, actions done by the user or operations that altered the balance of the user
|
||||
|
||||
**Kind**: instance method of [<code>bitso</code>](#bitso)
|
||||
**Returns**: <code>object</code> - a [ledger structure](https://docs.ccxt.com/#/?id=ledger)
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| code | <code>string</code> | No | unified currency code, default is undefined |
|
||||
| since | <code>int</code> | No | timestamp in ms of the earliest ledger entry, default is undefined |
|
||||
| limit | <code>int</code> | No | max number of ledger entries to return, default is undefined |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitso.fetchLedger ([code, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchMarkets" id="fetchmarkets"></a>
|
||||
|
||||
### fetchMarkets{docsify-ignore}
|
||||
retrieves data on all markets for bitso
|
||||
|
||||
**Kind**: instance method of [<code>bitso</code>](#bitso)
|
||||
**Returns**: <code>Array<object></code> - an array of objects representing market data
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-api/docs/list-available-books
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitso.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>bitso</code>](#bitso)
|
||||
**Returns**: <code>object</code> - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure)
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-api/docs/get-account-balance
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitso.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>bitso</code>](#bitso)
|
||||
**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.bitso.com/bitso-api/docs/list-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
|
||||
bitso.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>bitso</code>](#bitso)
|
||||
**Returns**: <code>object</code> - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure)
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-api/docs/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
|
||||
bitso.fetchTicker (symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchOHLCV" id="fetchohlcv"></a>
|
||||
|
||||
### fetchOHLCV{docsify-ignore}
|
||||
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
|
||||
|
||||
**Kind**: instance method of [<code>bitso</code>](#bitso)
|
||||
**Returns**: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | unified symbol of the market to fetch OHLCV data for |
|
||||
| timeframe | <code>string</code> | Yes | the length of time each candle represents |
|
||||
| since | <code>int</code> | No | timestamp in ms of the earliest candle to fetch |
|
||||
| limit | <code>int</code> | No | the maximum amount of candles to fetch |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitso.fetchOHLCV (symbol, timeframe[, 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>bitso</code>](#bitso)
|
||||
**Returns**: <code>Array<Trade></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades)
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-api/docs/list-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
|
||||
bitso.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>bitso</code>](#bitso)
|
||||
**Returns**: <code>object</code> - a dictionary of [fee structures](https://docs.ccxt.com/#/?id=fee-structure) indexed by market symbols
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-api/docs/list-fees
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitso.fetchTradingFees ([params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchMyTrades" id="fetchmytrades"></a>
|
||||
|
||||
### fetchMyTrades{docsify-ignore}
|
||||
fetch all trades made by the user
|
||||
|
||||
**Kind**: instance method of [<code>bitso</code>](#bitso)
|
||||
**Returns**: <code>Array<Trade></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-api/docs/user-trades
|
||||
|
||||
| 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
|
||||
bitso.fetchMyTrades (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="createOrder" id="createorder"></a>
|
||||
|
||||
### createOrder{docsify-ignore}
|
||||
create a trade order
|
||||
|
||||
**Kind**: instance method of [<code>bitso</code>](#bitso)
|
||||
**Returns**: <code>object</code> - an [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-api/docs/place-an-order
|
||||
|
||||
| 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
|
||||
bitso.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>bitso</code>](#bitso)
|
||||
**Returns**: <code>object</code> - An [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-api/docs/cancel-an-order
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| id | <code>string</code> | Yes | order id |
|
||||
| symbol | <code>string</code> | Yes | not used by bitso cancelOrder () |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitso.cancelOrder (id, symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="cancelOrders" id="cancelorders"></a>
|
||||
|
||||
### cancelOrders{docsify-ignore}
|
||||
cancel multiple orders
|
||||
|
||||
**Kind**: instance method of [<code>bitso</code>](#bitso)
|
||||
**Returns**: <code>object</code> - an list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-api/docs/cancel-an-order
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| ids | <code>Array<string></code> | Yes | order ids |
|
||||
| symbol | <code>string</code> | Yes | unified market symbol |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitso.cancelOrders (ids, symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="cancelAllOrders" id="cancelallorders"></a>
|
||||
|
||||
### cancelAllOrders{docsify-ignore}
|
||||
cancel all open orders
|
||||
|
||||
**Kind**: instance method of [<code>bitso</code>](#bitso)
|
||||
**Returns**: <code>Array<object></code> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-api/docs/cancel-an-order
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>undefined</code> | Yes | bitso does not support canceling orders for only a specific market |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitso.cancelAllOrders (symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchOpenOrders" id="fetchopenorders"></a>
|
||||
|
||||
### fetchOpenOrders{docsify-ignore}
|
||||
fetch all unfilled currently open orders
|
||||
|
||||
**Kind**: instance method of [<code>bitso</code>](#bitso)
|
||||
**Returns**: <code>Array<Order></code> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-api/docs/list-open-orders
|
||||
|
||||
| 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
|
||||
bitso.fetchOpenOrders (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchOrder" id="fetchorder"></a>
|
||||
|
||||
### fetchOrder{docsify-ignore}
|
||||
fetches information on an order made by the user
|
||||
|
||||
**Kind**: instance method of [<code>bitso</code>](#bitso)
|
||||
**Returns**: <code>object</code> - An [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-api/docs/look-up-orders
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| id | <code>string</code> | Yes | the order id |
|
||||
| symbol | <code>string</code> | Yes | not used by bitso fetchOrder |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitso.fetchOrder (id, symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchOrderTrades" id="fetchordertrades"></a>
|
||||
|
||||
### fetchOrderTrades{docsify-ignore}
|
||||
fetch all the trades made from a single order
|
||||
|
||||
**Kind**: instance method of [<code>bitso</code>](#bitso)
|
||||
**Returns**: <code>Array<object></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-api/docs/list-user-trades
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| id | <code>string</code> | Yes | order id |
|
||||
| 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 to retrieve |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitso.fetchOrderTrades (id, symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchDeposit" id="fetchdeposit"></a>
|
||||
|
||||
### fetchDeposit{docsify-ignore}
|
||||
fetch information on a deposit
|
||||
|
||||
**Kind**: instance method of [<code>bitso</code>](#bitso)
|
||||
**Returns**: <code>object</code> - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure)
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-payouts-funding/docs/fundings
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| id | <code>string</code> | Yes | deposit id |
|
||||
| code | <code>string</code> | Yes | bitso does not support filtering by currency code and will ignore this argument |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitso.fetchDeposit (id, code[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchDeposits" id="fetchdeposits"></a>
|
||||
|
||||
### fetchDeposits{docsify-ignore}
|
||||
fetch all deposits made to an account
|
||||
|
||||
**Kind**: instance method of [<code>bitso</code>](#bitso)
|
||||
**Returns**: <code>Array<object></code> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure)
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-payouts-funding/docs/fundings
|
||||
|
||||
| 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
|
||||
bitso.fetchDeposits (code[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchDepositAddress" id="fetchdepositaddress"></a>
|
||||
|
||||
### fetchDepositAddress{docsify-ignore}
|
||||
fetch the deposit address for a currency associated with this account
|
||||
|
||||
**Kind**: instance method of [<code>bitso</code>](#bitso)
|
||||
**Returns**: <code>object</code> - an [address structure](https://docs.ccxt.com/#/?id=address-structure)
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| code | <code>string</code> | Yes | unified currency code |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitso.fetchDepositAddress (code[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchTransactionFees" id="fetchtransactionfees"></a>
|
||||
|
||||
### fetchTransactionFees{docsify-ignore}
|
||||
`DEPRECATED`
|
||||
|
||||
please use fetchDepositWithdrawFees instead
|
||||
|
||||
**Kind**: instance method of [<code>bitso</code>](#bitso)
|
||||
**Returns**: <code>Array<object></code> - a list of [fee structures](https://docs.ccxt.com/#/?id=fee-structure)
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-api/docs/list-fees
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| codes | <code>Array<string></code>, <code>undefined</code> | Yes | list of unified currency codes |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitso.fetchTransactionFees (codes[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchDepositWithdrawFees" id="fetchdepositwithdrawfees"></a>
|
||||
|
||||
### fetchDepositWithdrawFees{docsify-ignore}
|
||||
fetch deposit and withdraw fees
|
||||
|
||||
**Kind**: instance method of [<code>bitso</code>](#bitso)
|
||||
**Returns**: <code>Array<object></code> - a list of [fee structures](https://docs.ccxt.com/#/?id=fee-structure)
|
||||
|
||||
**See**: https://docs.bitso.com/bitso-api/docs/list-fees
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| codes | <code>Array<string></code>, <code>undefined</code> | Yes | list of unified currency codes |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitso.fetchDepositWithdrawFees (codes[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="withdraw" id="withdraw"></a>
|
||||
|
||||
### withdraw{docsify-ignore}
|
||||
make a withdrawal
|
||||
|
||||
**Kind**: instance method of [<code>bitso</code>](#bitso)
|
||||
**Returns**: <code>object</code> - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure)
|
||||
|
||||
|
||||
| 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
|
||||
bitso.withdraw (code, amount, address, tag[, params])
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user