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,758 @@
|
||||
|
||||
<a name="alpaca" id="alpaca"></a>
|
||||
|
||||
## alpaca{docsify-ignore}
|
||||
**Kind**: global class
|
||||
**Extends**: <code>Exchange</code>
|
||||
|
||||
* [fetchTime](#fetchtime)
|
||||
* [fetchMarkets](#fetchmarkets)
|
||||
* [fetchTrades](#fetchtrades)
|
||||
* [fetchOrderBook](#fetchorderbook)
|
||||
* [fetchOHLCV](#fetchohlcv)
|
||||
* [fetchTicker](#fetchticker)
|
||||
* [fetchTickers](#fetchtickers)
|
||||
* [createMarketOrderWithCost](#createmarketorderwithcost)
|
||||
* [createMarketBuyOrderWithCost](#createmarketbuyorderwithcost)
|
||||
* [createMarketSellOrderWithCost](#createmarketsellorderwithcost)
|
||||
* [createOrder](#createorder)
|
||||
* [cancelOrder](#cancelorder)
|
||||
* [cancelAllOrders](#cancelallorders)
|
||||
* [fetchOrder](#fetchorder)
|
||||
* [fetchOrders](#fetchorders)
|
||||
* [fetchOpenOrders](#fetchopenorders)
|
||||
* [fetchClosedOrders](#fetchclosedorders)
|
||||
* [editOrder](#editorder)
|
||||
* [fetchMyTrades](#fetchmytrades)
|
||||
* [fetchDepositAddress](#fetchdepositaddress)
|
||||
* [withdraw](#withdraw)
|
||||
* [fetchDepositsWithdrawals](#fetchdepositswithdrawals)
|
||||
* [fetchDeposits](#fetchdeposits)
|
||||
* [fetchWithdrawals](#fetchwithdrawals)
|
||||
* [fetchBalance](#fetchbalance)
|
||||
* [watchTicker](#watchticker)
|
||||
* [watchOHLCV](#watchohlcv)
|
||||
* [watchOrderBook](#watchorderbook)
|
||||
* [watchTrades](#watchtrades)
|
||||
* [watchMyTrades](#watchmytrades)
|
||||
* [watchOrders](#watchorders)
|
||||
|
||||
<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>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>int</code> - the current integer timestamp in milliseconds from the exchange server
|
||||
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.fetchTime ([params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchMarkets" id="fetchmarkets"></a>
|
||||
|
||||
### fetchMarkets{docsify-ignore}
|
||||
retrieves data on all markets for alpaca
|
||||
|
||||
**Kind**: instance method of [<code>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>Array<object></code> - an array of objects representing market data
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/get-v2-assets
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange api endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.fetchMarkets ([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>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>Array<Trade></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades)
|
||||
|
||||
**See**
|
||||
|
||||
- https://docs.alpaca.markets/reference/cryptotrades
|
||||
- https://docs.alpaca.markets/reference/cryptolatesttrades
|
||||
|
||||
|
||||
| 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 |
|
||||
| params.loc | <code>string</code> | No | crypto location, default: us |
|
||||
| params.method | <code>string</code> | No | method, default: marketPublicGetV1beta3CryptoLocTrades |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.fetchTrades (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>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>object</code> - A dictionary of [order book structures](https://github.com/ccxt/ccxt/wiki/Manual#order-book-structure) indexed by market symbols
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/cryptolatestorderbooks
|
||||
|
||||
| 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 |
|
||||
| params.loc | <code>string</code> | No | crypto location, default: us |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.fetchOrderBook (symbol[, limit, 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>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume
|
||||
|
||||
**See**
|
||||
|
||||
- https://docs.alpaca.markets/reference/cryptobars
|
||||
- https://docs.alpaca.markets/reference/cryptolatestbars
|
||||
|
||||
|
||||
| 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 alpha api endpoint |
|
||||
| params.loc | <code>string</code> | No | crypto location, default: us |
|
||||
| params.method | <code>string</code> | No | method, default: marketPublicGetV1beta3CryptoLocBars |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.fetchOHLCV (symbol, timeframe[, since, 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>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>object</code> - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/cryptosnapshots-1
|
||||
|
||||
| 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 |
|
||||
| params.loc | <code>string</code> | No | crypto location, default: us |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.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>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>object</code> - a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/cryptosnapshots-1
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbols | <code>Array<string></code> | Yes | unified symbols of the markets to fetch tickers for |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
| params.loc | <code>string</code> | No | crypto location, default: us |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.fetchTickers (symbols[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="createMarketOrderWithCost" id="createmarketorderwithcost"></a>
|
||||
|
||||
### createMarketOrderWithCost{docsify-ignore}
|
||||
create a market order by providing the symbol, side and cost
|
||||
|
||||
**Kind**: instance method of [<code>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>object</code> - an [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/postorder
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | unified symbol of the market to create an order in |
|
||||
| side | <code>string</code> | Yes | 'buy' or 'sell' |
|
||||
| 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
|
||||
alpaca.createMarketOrderWithCost (symbol, side, cost[, 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>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>object</code> - an [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/postorder
|
||||
|
||||
| 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
|
||||
alpaca.createMarketBuyOrderWithCost (symbol, cost[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="createMarketSellOrderWithCost" id="createmarketsellorderwithcost"></a>
|
||||
|
||||
### createMarketSellOrderWithCost{docsify-ignore}
|
||||
create a market sell order by providing the symbol and cost
|
||||
|
||||
**Kind**: instance method of [<code>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>object</code> - an [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/postorder
|
||||
|
||||
| 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
|
||||
alpaca.createMarketSellOrderWithCost (symbol, cost[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="createOrder" id="createorder"></a>
|
||||
|
||||
### createOrder{docsify-ignore}
|
||||
create a trade order
|
||||
|
||||
**Kind**: instance method of [<code>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>object</code> - an [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/postorder
|
||||
|
||||
| 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', 'limit' or 'stop_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 | The price at which a trigger order is triggered at |
|
||||
| params.cost | <code>float</code> | No | *market orders only* the cost of the order in units of the quote currency |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.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>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>object</code> - An [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/deleteorderbyorderid
|
||||
|
||||
| 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
|
||||
alpaca.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>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>Array<object></code> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/deleteallorders
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | Yes | alpaca cancelAllOrders cannot setting symbol, it will cancel all open orders |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.cancelAllOrders (symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchOrder" id="fetchorder"></a>
|
||||
|
||||
### fetchOrder{docsify-ignore}
|
||||
fetches information on an order made by the user
|
||||
|
||||
**Kind**: instance method of [<code>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>object</code> - An [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/getorderbyorderid
|
||||
|
||||
| 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
|
||||
alpaca.fetchOrder (id, symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchOrders" id="fetchorders"></a>
|
||||
|
||||
### fetchOrders{docsify-ignore}
|
||||
fetches information on multiple orders made by the user
|
||||
|
||||
**Kind**: instance method of [<code>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>Array<Order></code> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/getallorders
|
||||
|
||||
| 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 |
|
||||
| params.until | <code>int</code> | No | the latest time in ms to fetch orders for |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.fetchOrders (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchOpenOrders" id="fetchopenorders"></a>
|
||||
|
||||
### fetchOpenOrders{docsify-ignore}
|
||||
fetch all unfilled currently open orders
|
||||
|
||||
**Kind**: instance method of [<code>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>Array<Order></code> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/getallorders
|
||||
|
||||
| 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 |
|
||||
| params.until | <code>int</code> | No | the latest time in ms to fetch orders for |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.fetchOpenOrders (symbol[, since, limit, 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>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>Array<Order></code> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/getallorders
|
||||
|
||||
| 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 |
|
||||
| params.until | <code>int</code> | No | the latest time in ms to fetch orders for |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.fetchClosedOrders (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="editOrder" id="editorder"></a>
|
||||
|
||||
### editOrder{docsify-ignore}
|
||||
edit a trade order
|
||||
|
||||
**Kind**: instance method of [<code>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>object</code> - an [order structure](https://docs.ccxt.com/#/?id=order-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/patchorderbyorderid-1
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| id | <code>string</code> | Yes | order id |
|
||||
| symbol | <code>string</code> | No | unified symbol of the market to create an order in |
|
||||
| type | <code>string</code> | No | 'market', 'limit' or 'stop_limit' |
|
||||
| side | <code>string</code> | No | 'buy' or 'sell' |
|
||||
| amount | <code>float</code> | No | how much of the currency you want to trade in units of the base currency |
|
||||
| price | <code>float</code> | No | the price for the order, 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>string</code> | No | the price to trigger a stop order |
|
||||
| params.timeInForce | <code>string</code> | No | for crypto trading either 'gtc' or 'ioc' can be used |
|
||||
| params.clientOrderId | <code>string</code> | No | a unique identifier for the order, automatically generated if not sent |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.editOrder (id[, symbol, type, side, amount, price, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchMyTrades" id="fetchmytrades"></a>
|
||||
|
||||
### fetchMyTrades{docsify-ignore}
|
||||
fetch all trades made by the user
|
||||
|
||||
**Kind**: instance method of [<code>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>Array<Trade></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/getaccountactivitiesbyactivitytype-1
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| symbol | <code>string</code> | No | 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 trade 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 trades for |
|
||||
| params.page_token | <code>string</code> | No | page_token - used for paging |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.fetchMyTrades ([symbol, 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>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>object</code> - an [address structure](https://docs.ccxt.com/#/?id=address-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/listcryptofundingwallets
|
||||
|
||||
| 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
|
||||
alpaca.fetchDepositAddress (code[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="withdraw" id="withdraw"></a>
|
||||
|
||||
### withdraw{docsify-ignore}
|
||||
make a withdrawal
|
||||
|
||||
**Kind**: instance method of [<code>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>object</code> - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/createcryptotransferforaccount
|
||||
|
||||
| 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 | a memo for the transaction |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.withdraw (code, amount, address, tag[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchDepositsWithdrawals" id="fetchdepositswithdrawals"></a>
|
||||
|
||||
### fetchDepositsWithdrawals{docsify-ignore}
|
||||
fetch history of deposits and withdrawals
|
||||
|
||||
**Kind**: instance method of [<code>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>object</code> - a list of [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/listcryptofundingtransfers
|
||||
|
||||
| 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
|
||||
alpaca.fetchDepositsWithdrawals ([code, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="fetchDeposits" id="fetchdeposits"></a>
|
||||
|
||||
### fetchDeposits{docsify-ignore}
|
||||
fetch all deposits made to an account
|
||||
|
||||
**Kind**: instance method of [<code>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>Array<object></code> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/listcryptofundingtransfers
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| code | <code>string</code> | No | 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 deposit structures to retrieve |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.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>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>Array<object></code> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/listcryptofundingtransfers
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| code | <code>string</code> | No | 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 withdrawal structures to retrieve |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.fetchWithdrawals ([code, since, limit, 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>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>object</code> - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/reference/getaccount-1
|
||||
|
||||
| Param | Type | Required | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.fetchBalance ([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>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>object</code> - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/docs/real-time-crypto-pricing-data#quotes
|
||||
|
||||
| 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
|
||||
alpaca.watchTicker (symbol[, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="watchOHLCV" id="watchohlcv"></a>
|
||||
|
||||
### watchOHLCV{docsify-ignore}
|
||||
watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
|
||||
|
||||
**Kind**: instance method of [<code>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume
|
||||
|
||||
**See**: https://docs.alpaca.markets/docs/real-time-crypto-pricing-data#bars
|
||||
|
||||
| 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
|
||||
alpaca.watchOHLCV (symbol, timeframe[, 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>alpaca</code>](#alpaca)
|
||||
**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.alpaca.markets/docs/real-time-crypto-pricing-data#orderbooks
|
||||
|
||||
| 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
|
||||
alpaca.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>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>Array<object></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/docs/real-time-crypto-pricing-data#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 orders 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
|
||||
alpaca.watchTrades (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="watchMyTrades" id="watchmytrades"></a>
|
||||
|
||||
### watchMyTrades{docsify-ignore}
|
||||
watches information on multiple trades made by the user
|
||||
|
||||
**Kind**: instance method of [<code>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>Array<object></code> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
|
||||
|
||||
**See**: https://docs.alpaca.markets/docs/websocket-streaming#trade-updates
|
||||
|
||||
| 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 |
|
||||
| params.unifiedMargin | <code>boolean</code> | No | use unified margin account |
|
||||
|
||||
|
||||
```javascript
|
||||
alpaca.watchMyTrades (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
|
||||
<a name="watchOrders" id="watchorders"></a>
|
||||
|
||||
### watchOrders{docsify-ignore}
|
||||
watches information on multiple orders made by the user
|
||||
|
||||
**Kind**: instance method of [<code>alpaca</code>](#alpaca)
|
||||
**Returns**: <code>Array<object></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 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
|
||||
alpaca.watchOrders (symbol[, since, limit, params])
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user