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,767 @@
|
||||
|
||||
<a name="bitrue" id="bitrue"></a>
|
||||
|
||||
## bitrue{docsify-ignore}
|
||||
**Kind**: global class
|
||||
**Extends**: <code>Exchange</code>
|
||||
|
||||
* [fetchStatus](#fetchstatus)
|
||||
* [fetchTime](#fetchtime)
|
||||
* [fetchCurrencies](#fetchcurrencies)
|
||||
* [fetchMarkets](#fetchmarkets)
|
||||
* [fetchBalance](#fetchbalance)
|
||||
* [fetchOrderBook](#fetchorderbook)
|
||||
* [fetchTicker](#fetchticker)
|
||||
* [fetchOHLCV](#fetchohlcv)
|
||||
* [fetchBidsAsks](#fetchbidsasks)
|
||||
* [fetchTickers](#fetchtickers)
|
||||
* [fetchTrades](#fetchtrades)
|
||||
* [createMarketBuyOrderWithCost](#createmarketbuyorderwithcost)
|
||||
* [createOrder](#createorder)
|
||||
* [fetchOrder](#fetchorder)
|
||||
* [fetchClosedOrders](#fetchclosedorders)
|
||||
* [fetchOpenOrders](#fetchopenorders)
|
||||
* [cancelOrder](#cancelorder)
|
||||
* [cancelAllOrders](#cancelallorders)
|
||||
* [fetchMyTrades](#fetchmytrades)
|
||||
* [fetchDeposits](#fetchdeposits)
|
||||
* [fetchWithdrawals](#fetchwithdrawals)
|
||||
* [withdraw](#withdraw)
|
||||
* [fetchDepositWithdrawFees](#fetchdepositwithdrawfees)
|
||||
* [fetchTransfers](#fetchtransfers)
|
||||
* [transfer](#transfer)
|
||||
* [setLeverage](#setleverage)
|
||||
* [setMargin](#setmargin)
|
||||
* [watchBalance](#watchbalance)
|
||||
* [watchOrders](#watchorders)
|
||||
|
||||
<a name="fetchStatus" id="fetchstatus"></a>
|
||||
|
||||
### fetchStatus{docsify-ignore}
|
||||
the latest known information on the availability of the exchange API
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - a [status structure](https://docs.ccxt.com/#/?id=exchange-status-structure)
|
||||
|
||||
**See**: https://github.com/Bitrue-exchange/Spot-official-api-docs#test-connectivity
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.fetchStatus ([params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchTime" id="fetchtime"></a>
|
||||
|
||||
### fetchTime{docsify-ignore}
|
||||
fetches the current integer timestamp in milliseconds from the exchange server
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>int</code> - the current integer timestamp in milliseconds from the exchange server
|
||||
|
||||
**See**: https://github.com/Bitrue-exchange/Spot-official-api-docs#check-server-time
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.fetchTime ([params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchCurrencies" id="fetchcurrencies"></a>
|
||||
|
||||
### fetchCurrencies{docsify-ignore}
|
||||
fetches all available currencies on an exchange
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - an associative dictionary of currencies
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.fetchCurrencies ([params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchMarkets" id="fetchmarkets"></a>
|
||||
|
||||
### fetchMarkets{docsify-ignore}
|
||||
retrieves data on all markets for bitrue
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>Array<object></code> - an array of objects representing market data
|
||||
|
||||
**See**
|
||||
|
||||
- https://github.com/Bitrue-exchange/Spot-official-api-docs#exchangeInfo_endpoint
|
||||
- https://www.bitrue.com/api-docs#current-open-contract
|
||||
- https://www.bitrue.com/api_docs_includes_file/delivery.html#current-open-contract
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange api endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.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>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://github.com/Bitrue-exchange/Spot-official-api-docs#account-information-user_data
|
||||
- https://www.bitrue.com/api-docs#account-information-v2-user_data-hmac-sha256
|
||||
- https://www.bitrue.com/api_docs_includes_file/delivery.html#account-information-v2-user_data-hmac-sha256
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
| params.type | <code>string</code> | No | 'future', 'delivery', 'spot', 'swap' |
|
||||
| params.subType | <code>string</code> | No | 'linear', 'inverse' |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.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>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols
|
||||
|
||||
**See**
|
||||
|
||||
- https://github.com/Bitrue-exchange/Spot-official-api-docs#order-book
|
||||
- https://www.bitrue.com/api-docs#order-book
|
||||
- https://www.bitrue.com/api_docs_includes_file/delivery.html#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
|
||||
bitrue.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>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://github.com/Bitrue-exchange/Spot-official-api-docs#24hr-ticker-price-change-statistics
|
||||
- https://www.bitrue.com/api-docs#ticker
|
||||
- https://www.bitrue.com/api_docs_includes_file/delivery.html#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
|
||||
bitrue.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>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume
|
||||
|
||||
**See**
|
||||
|
||||
- https://www.bitrue.com/api_docs_includes_file/spot/index.html#kline-data
|
||||
- https://www.bitrue.com/api_docs_includes_file/futures/index.html#kline-candlestick-data
|
||||
|
||||
|
||||
| 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 |
|
||||
| params.until | <code>int</code> | No | the latest time in ms to fetch transfers for |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.fetchOHLCV (symbol, timeframe[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchBidsAsks" id="fetchbidsasks"></a>
|
||||
|
||||
### fetchBidsAsks{docsify-ignore}
|
||||
fetches the bid and ask price and volume for multiple markets
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://github.com/Bitrue-exchange/Spot-official-api-docs#symbol-order-book-ticker
|
||||
- https://www.bitrue.com/api-docs#ticker
|
||||
- https://www.bitrue.com/api_docs_includes_file/delivery.html#ticker
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbols | <code>Array<string></code>, <code>undefined</code> | Yes | unified symbols of the markets to fetch the bids and asks for, all markets are returned if not assigned |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.fetchBidsAsks (symbols[, 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>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://github.com/Bitrue-exchange/Spot-official-api-docs#24hr-ticker-price-change-statistics
|
||||
- https://www.bitrue.com/api-docs#ticker
|
||||
- https://www.bitrue.com/api_docs_includes_file/delivery.html#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
|
||||
bitrue.fetchTickers (symbols[, 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>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>Array<Trade></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades)
|
||||
|
||||
**See**: https://github.com/Bitrue-exchange/Spot-official-api-docs#recent-trades-list
|
||||
|
||||
| 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
|
||||
bitrue.fetchTrades (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="createMarketBuyOrderWithCost" id="createmarketbuyorderwithcost"></a>
|
||||
|
||||
### createMarketBuyOrderWithCost{docsify-ignore}
|
||||
create a market buy order by providing the symbol and cost
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - an [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://www.bitrue.com/api-docs#new-order-trade-hmac-sha256
|
||||
- https://www.bitrue.com/api_docs_includes_file/delivery.html#new-order-trade-hmac-sha256
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | unified symbol of the market to create an order in |
|
||||
| cost | <code>float</code> | Yes | how much you want to trade in units of the quote currency |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.createMarketBuyOrderWithCost (symbol, cost[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="createOrder" id="createorder"></a>
|
||||
|
||||
### createOrder{docsify-ignore}
|
||||
create a trade order
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - an [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://www.bitrue.com/api_docs_includes_file/spot/index.html#new-order-trade
|
||||
- https://www.bitrue.com/api_docs_includes_file/futures/index.html#new-order-trade-hmac-sha256
|
||||
|
||||
|
||||
| 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 |
|
||||
| params.triggerPrice | <code>float</code> | No | *spot only* the price at which a trigger order is triggered at |
|
||||
| params.clientOrderId | <code>string</code> | No | a unique id for the order, automatically generated if not sent |
|
||||
| params.leverage | <code>decimal</code> | No | in future order, the leverage value of the order should consistent with the user contract configuration, default is 1 |
|
||||
| params.timeInForce | <code>string</code> | No | 'fok', 'ioc' or 'po' |
|
||||
| params.postOnly | <code>bool</code> | No | default false |
|
||||
| params.reduceOnly | <code>bool</code> | No | default false EXCHANGE SPECIFIC PARAMETERS |
|
||||
| params.icebergQty | <code>decimal</code> | No | |
|
||||
| params.recvWindow | <code>long</code> | No | |
|
||||
| params.cost | <code>float</code> | No | *swap market buy only* the quote quantity that can be used as an alternative for the amount |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.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>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - An [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://www.bitrue.com/api_docs_includes_file/spot/index.html#query-order-user_data
|
||||
- https://www.bitrue.com/api_docs_includes_file/futures/index.html#query-order-user_data-hmac-sha256
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| id | <code>string</code> | Yes | the 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
|
||||
bitrue.fetchOrder (id, symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchClosedOrders" id="fetchclosedorders"></a>
|
||||
|
||||
### fetchClosedOrders{docsify-ignore}
|
||||
fetches information on multiple closed orders made by the user
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>Array<Order></code> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://www.bitrue.com/api_docs_includes_file/spot/index.html#all-orders-user_data
|
||||
|
||||
| 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
|
||||
bitrue.fetchClosedOrders (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchOpenOrders" id="fetchopenorders"></a>
|
||||
|
||||
### fetchOpenOrders{docsify-ignore}
|
||||
fetch all unfilled currently open orders
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>Array<Order></code> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://www.bitrue.com/api_docs_includes_file/spot/index.html#current-open-orders-user_data
|
||||
- https://www.bitrue.com/api_docs_includes_file/futures/index.html#cancel-all-open-orders-trade-hmac-sha256
|
||||
|
||||
|
||||
| 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 order structures to retrieve |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.fetchOpenOrders (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="cancelOrder" id="cancelorder"></a>
|
||||
|
||||
### cancelOrder{docsify-ignore}
|
||||
cancels an open order
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - An [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://github.com/Bitrue-exchange/Spot-official-api-docs#cancel-order-trade
|
||||
- https://www.bitrue.com/api-docs#cancel-order-trade-hmac-sha256
|
||||
- https://www.bitrue.com/api_docs_includes_file/delivery.html#cancel-order-trade-hmac-sha256
|
||||
|
||||
|
||||
| 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
|
||||
bitrue.cancelOrder (id, symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="cancelAllOrders" id="cancelallorders"></a>
|
||||
|
||||
### cancelAllOrders{docsify-ignore}
|
||||
cancel all open orders in a market
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>Array<object></code> - a list of [order structures](https://github.com/ccxt/ccxt/wiki/Manual#order-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://www.bitrue.com/api-docs#cancel-all-open-orders-trade-hmac-sha256
|
||||
- https://www.bitrue.com/api_docs_includes_file/delivery.html#cancel-all-open-orders-trade-hmac-sha256
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | unified market symbol of the market to cancel orders in |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
| params.marginMode | <code>string</code> | No | 'cross' or 'isolated', for spot margin trading |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.cancelAllOrders (symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchMyTrades" id="fetchmytrades"></a>
|
||||
|
||||
### fetchMyTrades{docsify-ignore}
|
||||
fetch all trades made by the user
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>Array<Trade></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://www.bitrue.com/api_docs_includes_file/spot/index.html#account-trade-list-user_data
|
||||
- https://www.bitrue.com/api_docs_includes_file/futures/index.html#account-trade-list-user_data-hmac-sha256
|
||||
|
||||
|
||||
| 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
|
||||
bitrue.fetchMyTrades (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchDeposits" id="fetchdeposits"></a>
|
||||
|
||||
### fetchDeposits{docsify-ignore}
|
||||
fetch all deposits made to an account
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>Array<object></code> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure)
|
||||
|
||||
**See**: https://github.com/Bitrue-exchange/Spot-official-api-docs#deposit-history--withdraw_data
|
||||
|
||||
| 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
|
||||
bitrue.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>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>Array<object></code> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure)
|
||||
|
||||
**See**: https://github.com/Bitrue-exchange/Spot-official-api-docs#withdraw-history--withdraw_data
|
||||
|
||||
| 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
|
||||
bitrue.fetchWithdrawals (code[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="withdraw" id="withdraw"></a>
|
||||
|
||||
### withdraw{docsify-ignore}
|
||||
make a withdrawal
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure)
|
||||
|
||||
**See**: https://github.com/Bitrue-exchange/Spot-official-api-docs#withdraw-commit--withdraw_data
|
||||
|
||||
| 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
|
||||
bitrue.withdraw (code, amount, address, tag[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchDepositWithdrawFees" id="fetchdepositwithdrawfees"></a>
|
||||
|
||||
### fetchDepositWithdrawFees{docsify-ignore}
|
||||
fetch deposit and withdraw fees
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - a list of [fee structures](https://docs.ccxt.com/#/?id=fee-structure)
|
||||
|
||||
**See**: https://github.com/Bitrue-exchange/Spot-official-api-docs#exchangeInfo_endpoint
|
||||
|
||||
| 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
|
||||
bitrue.fetchDepositWithdrawFees (codes[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchTransfers" id="fetchtransfers"></a>
|
||||
|
||||
### fetchTransfers{docsify-ignore}
|
||||
fetch a history of internal transfers made on an account
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>Array<object></code> - a list of [transfer structures](https://github.com/ccxt/ccxt/wiki/Manual#transfer-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://www.bitrue.com/api-docs#get-future-account-transfer-history-list-user_data-hmac-sha256
|
||||
- https://www.bitrue.com/api_docs_includes_file/delivery.html#get-future-account-transfer-history-list-user_data-hmac-sha256
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| code | <code>string</code> | Yes | unified currency code of the currency transferred |
|
||||
| since | <code>int</code> | No | the earliest time in ms to fetch transfers for |
|
||||
| limit | <code>int</code> | No | the maximum number of transfers structures to retrieve |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
| params.until | <code>int</code> | No | the latest time in ms to fetch transfers for |
|
||||
| params.type | <code>string</code> | No | transfer type wallet_to_contract or contract_to_wallet |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.fetchTransfers (code[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="transfer" id="transfer"></a>
|
||||
|
||||
### transfer{docsify-ignore}
|
||||
transfer currency internally between wallets on the same account
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - a [transfer structure](https://github.com/ccxt/ccxt/wiki/Manual#transfer-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://www.bitrue.com/api-docs#new-future-account-transfer-user_data-hmac-sha256
|
||||
- https://www.bitrue.com/api_docs_includes_file/delivery.html#user-commission-rate-user_data-hmac-sha256
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| code | <code>string</code> | Yes | unified currency code |
|
||||
| amount | <code>float</code> | Yes | amount to transfer |
|
||||
| fromAccount | <code>string</code> | Yes | account to transfer from |
|
||||
| toAccount | <code>string</code> | Yes | account to transfer to |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.transfer (code, amount, fromAccount, toAccount[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="setLeverage" id="setleverage"></a>
|
||||
|
||||
### setLeverage{docsify-ignore}
|
||||
set the level of leverage for a market
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - response from the exchange
|
||||
|
||||
**See**
|
||||
|
||||
- https://www.bitrue.com/api-docs#change-initial-leverage-trade-hmac-sha256
|
||||
- https://www.bitrue.com/api_docs_includes_file/delivery.html#change-initial-leverage-trade-hmac-sha256
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| leverage | <code>float</code> | Yes | the rate of leverage |
|
||||
| symbol | <code>string</code> | Yes | unified market symbol |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.setLeverage (leverage, symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="setMargin" id="setmargin"></a>
|
||||
|
||||
### setMargin{docsify-ignore}
|
||||
Either adds or reduces margin in an isolated position in order to set the margin to a specific value
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - A [margin structure](https://github.com/ccxt/ccxt/wiki/Manual#add-margin-structure)
|
||||
|
||||
**See**
|
||||
|
||||
- https://www.bitrue.com/api-docs#modify-isolated-position-margin-trade-hmac-sha256
|
||||
- https://www.bitrue.com/api_docs_includes_file/delivery.html#modify-isolated-position-margin-trade-hmac-sha256
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | unified market symbol of the market to set margin in |
|
||||
| amount | <code>float</code> | Yes | the amount to set the margin to |
|
||||
| params | <code>object</code> | No | parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.setMargin (symbol, amount[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="watchBalance" id="watchbalance"></a>
|
||||
|
||||
### watchBalance{docsify-ignore}
|
||||
watch balance and get the amount of funds available for trading or funds locked in orders
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure)
|
||||
|
||||
**See**: https://github.com/Bitrue-exchange/Spot-official-api-docs#balance-update
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.watchBalance ([params])
|
||||
```
|
||||
|
||||
|
||||
<a name="watchOrders" id="watchorders"></a>
|
||||
|
||||
### watchOrders{docsify-ignore}
|
||||
watches information on user orders
|
||||
|
||||
**Kind**: instance method of [<code>bitrue</code>](#bitrue)
|
||||
**Returns**: <code>object</code> - A dictionary of [order structure](https://docs.ccxt.com/#/?id=order-structure) indexed by market symbols
|
||||
|
||||
**See**: https://github.com/Bitrue-exchange/Spot-official-api-docs#order-update
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | |
|
||||
| since | <code>int</code> | No | timestamp in ms of the earliest order |
|
||||
| limit | <code>int</code> | No | the maximum amount of orders to return |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
bitrue.watchOrders (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user