## bitvavo{docsify-ignore}
**Kind**: global class
**Extends**: Exchange
* [fetchTime](#fetchtime)
* [fetchMarkets](#fetchmarkets)
* [fetchCurrencies](#fetchcurrencies)
* [fetchTicker](#fetchticker)
* [fetchTickers](#fetchtickers)
* [fetchTrades](#fetchtrades)
* [fetchTradingFees](#fetchtradingfees)
* [fetchOrderBook](#fetchorderbook)
* [fetchOHLCV](#fetchohlcv)
* [fetchBalance](#fetchbalance)
* [fetchDepositAddress](#fetchdepositaddress)
* [createOrder](#createorder)
* [editOrder](#editorder)
* [cancelOrder](#cancelorder)
* [cancelAllOrders](#cancelallorders)
* [fetchOrder](#fetchorder)
* [fetchOrders](#fetchorders)
* [fetchOpenOrders](#fetchopenorders)
* [fetchMyTrades](#fetchmytrades)
* [withdraw](#withdraw)
* [fetchWithdrawals](#fetchwithdrawals)
* [fetchDeposits](#fetchdeposits)
* [fetchDepositWithdrawFees](#fetchdepositwithdrawfees)
* [watchTicker](#watchticker)
* [watchTrades](#watchtrades)
* [watchOHLCV](#watchohlcv)
* [watchOrderBook](#watchorderbook)
* [watchOrders](#watchorders)
* [watchMyTrades](#watchmytrades)
* [createOrderWs](#createorderws)
* [editOrderWs](#editorderws)
* [cancelOrderWs](#cancelorderws)
* [cancelAllOrdersWs](#cancelallordersws)
* [fetchOrderWs](#fetchorderws)
* [fetchOrdersWs](#fetchordersws)
* [fetchOpenOrdersWs](#fetchopenordersws)
* [fetchMyTradesWs](#fetchmytradesws)
* [withdrawWs](#withdrawws)
* [fetchWithdrawalsWs](#fetchwithdrawalsws)
* [fetchOHLCVWs](#fetchohlcvws)
* [fetchDepositsWs](#fetchdepositsws)
* [fetchTradingFeesWs](#fetchtradingfeesws)
* [fetchMarketsWs](#fetchmarketsws)
* [fetchCurrenciesWs](#fetchcurrenciesws)
* [fetchBalanceWs](#fetchbalancews)
### fetchTime{docsify-ignore}
fetches the current integer timestamp in milliseconds from the exchange server
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: int
- the current integer timestamp in milliseconds from the exchange server
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.fetchTime ([params])
```
### fetchMarkets{docsify-ignore}
retrieves data on all markets for bitvavo
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<object>
- an array of objects representing market data
**See**: https://docs.bitvavo.com/#tag/General/paths/~1markets/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.fetchMarkets ([params])
```
### fetchCurrencies{docsify-ignore}
fetches all available currencies on an exchange
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- an associative dictionary of currencies
**See**: https://docs.bitvavo.com/#tag/General/paths/~1assets/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.fetchCurrencies ([params])
```
### 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 [bitvavo
](#bitvavo)
**Returns**: object
- a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure)
**See**: https://docs.bitvavo.com/#tag/Market-Data/paths/~1ticker~124h/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to fetch the ticker for |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.fetchTicker (symbol[, params])
```
### fetchTickers{docsify-ignore}
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure)
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbols | Array<string>
, undefined
| Yes | unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.fetchTickers (symbols[, params])
```
### fetchTrades{docsify-ignore}
get the list of most recent trades for a particular symbol
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<Trade>
- a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades)
**See**: https://docs.bitvavo.com/#tag/Market-Data/paths/~1{market}~1trades/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to fetch trades for |
| since | int
| No | timestamp in ms of the earliest trade to fetch |
| limit | int
| No | the maximum amount of trades to fetch |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.until | int
| No | the latest time in ms to fetch entries for |
| params.paginate | boolean
| No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params) |
```javascript
bitvavo.fetchTrades (symbol[, since, limit, params])
```
### fetchTradingFees{docsify-ignore}
fetch the trading fees for multiple markets
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- a dictionary of [fee structures](https://docs.ccxt.com/#/?id=fee-structure) indexed by market symbols
**See**: https://docs.bitvavo.com/#tag/Account/paths/~1account/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.fetchTradingFees ([params])
```
### fetchOrderBook{docsify-ignore}
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols
**See**: https://docs.bitvavo.com/#tag/Market-Data/paths/~1{market}~1book/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to fetch the order book for |
| limit | int
| No | the maximum amount of order book entries to return |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.fetchOrderBook (symbol[, limit, params])
```
### 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 [bitvavo
](#bitvavo)
**Returns**: Array<Array<int>>
- A list of candles ordered as timestamp, open, high, low, close, volume
**See**: https://docs.bitvavo.com/#tag/Market-Data/paths/~1{market}~1candles/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string
| Yes | the length of time each candle represents |
| since | int
| No | timestamp in ms of the earliest candle to fetch |
| limit | int
| No | the maximum amount of candles to fetch |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.until | int
| No | the latest time in ms to fetch entries for |
| params.paginate | boolean
| No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params) |
```javascript
bitvavo.fetchOHLCV (symbol, timeframe[, since, limit, params])
```
### fetchBalance{docsify-ignore}
query for balance and get the amount of funds available for trading or funds locked in orders
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- a [balance structure](https://docs.ccxt.com/#/?id=balance-structure)
**See**: https://docs.bitvavo.com/#tag/Account/paths/~1balance/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.fetchBalance ([params])
```
### fetchDepositAddress{docsify-ignore}
fetch the deposit address for a currency associated with this account
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- an [address structure](https://docs.ccxt.com/#/?id=address-structure)
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| code | string
| Yes | unified currency code |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.fetchDepositAddress (code[, params])
```
### createOrder{docsify-ignore}
create a trade order
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- an [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://docs.bitvavo.com/#tag/Orders/paths/~1order/post
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to create an order in |
| type | string
| Yes | 'market' or 'limit' |
| side | string
| Yes | 'buy' or 'sell' |
| amount | float
| Yes | how much of currency you want to trade in units of base currency |
| price | float
| Yes | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
| params.timeInForce | string
| No | "GTC", "IOC", or "PO" |
| params.stopPrice | float
| No | The price at which a trigger order is triggered at |
| params.triggerPrice | float
| No | The price at which a trigger order is triggered at |
| params.postOnly | bool
| No | If true, the order will only be posted to the order book and not executed immediately |
| params.stopLossPrice | float
| No | The price at which a stop loss order is triggered at |
| params.takeProfitPrice | float
| No | The price at which a take profit order is triggered at |
| params.triggerType | string
| No | "price" |
| params.triggerReference | string
| No | "lastTrade", "bestBid", "bestAsk", "midPrice" Only for stop orders: Use this to determine which parameter will trigger the order |
| params.selfTradePrevention | string
| No | "decrementAndCancel", "cancelOldest", "cancelNewest", "cancelBoth" |
| params.disableMarketProtection | bool
| No | don't cancel if the next fill price is 10% worse than the best fill price |
| params.responseRequired | bool
| No | Set this to 'false' when only an acknowledgement of success or failure is required, this is faster. |
```javascript
bitvavo.createOrder (symbol, type, side, amount, price[, params])
```
### editOrder{docsify-ignore}
edit a trade order
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- an [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://docs.bitvavo.com/#tag/Orders/paths/~1order/put
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| id | string
| Yes | cancel order id |
| symbol | string
| Yes | unified symbol of the market to create an order in |
| type | string
| Yes | 'market' or 'limit' |
| side | string
| Yes | 'buy' or 'sell' |
| amount | float
| No | how much of currency you want to trade in units of base currency |
| price | float
| No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.editOrder (id, symbol, type, side[, amount, price, params])
```
### cancelOrder{docsify-ignore}
cancels an open order
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- An [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**
- https://docs.bitvavo.com/#tag/Orders/paths/~1order/delete
- https://docs.bitvavo.com/#tag/Trading-endpoints/paths/~1order/delete
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| id | string
| Yes | order id |
| symbol | string
| Yes | unified symbol of the market the order was made in |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.cancelOrder (id, symbol[, params])
```
### cancelAllOrders{docsify-ignore}
cancel all open orders
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<object>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://docs.bitvavo.com/#tag/Orders/paths/~1orders/delete
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.cancelAllOrders (symbol[, params])
```
### fetchOrder{docsify-ignore}
fetches information on an order made by the user
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- An [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://docs.bitvavo.com/#tag/Trading-endpoints/paths/~1order/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| id | string
| Yes | the order id |
| symbol | string
| Yes | unified symbol of the market the order was made in |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.fetchOrder (id, symbol[, params])
```
### fetchOrders{docsify-ignore}
fetches information on multiple orders made by the user
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<Order>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://docs.bitvavo.com/#tag/Trading-endpoints/paths/~1orders/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol of the market orders were made in |
| since | int
| No | the earliest time in ms to fetch orders for |
| limit | int
| No | the maximum number of order structures to retrieve |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.paginate | boolean
| No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params) |
| params.until | int
| No | the latest time in ms to fetch entries for |
```javascript
bitvavo.fetchOrders (symbol[, since, limit, params])
```
### fetchOpenOrders{docsify-ignore}
fetch all unfilled currently open orders
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<Order>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol |
| since | int
| No | the earliest time in ms to fetch open orders for |
| limit | int
| No | the maximum number of open orders structures to retrieve |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.fetchOpenOrders (symbol[, since, limit, params])
```
### fetchMyTrades{docsify-ignore}
fetch all trades made by the user
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<Trade>
- a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
**See**: https://docs.bitvavo.com/#tag/Trades/paths/~1trades/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol |
| since | int
| No | the earliest time in ms to fetch trades for |
| limit | int
| No | the maximum number of trades structures to retrieve |
| params | object
| No | extra parameters specific to the exchange API endpoint |
| params.until | int
| No | the latest time in ms to fetch entries for |
| params.paginate | boolean
| No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params) |
```javascript
bitvavo.fetchMyTrades (symbol[, since, limit, params])
```
### withdraw{docsify-ignore}
make a withdrawal
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure)
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| code | string
| Yes | unified currency code |
| amount | float
| Yes | the amount to withdraw |
| address | string
| Yes | the address to withdraw to |
| tag | string
| Yes | |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.withdraw (code, amount, address, tag[, params])
```
### fetchWithdrawals{docsify-ignore}
fetch all withdrawals made from an account
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<object>
- a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure)
**See**: https://docs.bitvavo.com/#tag/Account/paths/~1withdrawalHistory/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| code | string
| Yes | unified currency code |
| since | int
| No | the earliest time in ms to fetch withdrawals for |
| limit | int
| No | the maximum number of withdrawals structures to retrieve |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.fetchWithdrawals (code[, since, limit, params])
```
### fetchDeposits{docsify-ignore}
fetch all deposits made to an account
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<object>
- a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure)
**See**: https://docs.bitvavo.com/#tag/Account/paths/~1depositHistory/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| code | string
| Yes | unified currency code |
| since | int
| No | the earliest time in ms to fetch deposits for |
| limit | int
| No | the maximum number of deposits structures to retrieve |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.fetchDeposits (code[, since, limit, params])
```
### fetchDepositWithdrawFees{docsify-ignore}
fetch deposit and withdraw fees
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- a list of [fee structures](https://docs.ccxt.com/#/?id=fee-structure)
**See**: https://docs.bitvavo.com/#tag/General/paths/~1assets/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| codes | Array<string>
, undefined
| Yes | list of unified currency codes |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.fetchDepositWithdrawFees (codes[, params])
```
### 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 [bitvavo
](#bitvavo)
**Returns**: object
- a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure)
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to fetch the ticker for |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.watchTicker (symbol[, params])
```
### watchTrades{docsify-ignore}
get the list of most recent trades for a particular symbol
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<object>
- a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades)
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to fetch trades for |
| since | int
| No | timestamp in ms of the earliest trade to fetch |
| limit | int
| No | the maximum amount of trades to fetch |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.watchTrades (symbol[, since, limit, params])
```
### 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 [bitvavo
](#bitvavo)
**Returns**: Array<Array<int>>
- A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string
| Yes | the length of time each candle represents |
| since | int
| No | timestamp in ms of the earliest candle to fetch |
| limit | int
| No | the maximum amount of candles to fetch |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.watchOHLCV (symbol, timeframe[, since, limit, params])
```
### watchOrderBook{docsify-ignore}
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to fetch the order book for |
| limit | int
| No | the maximum amount of order book entries to return |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.watchOrderBook (symbol[, limit, params])
```
### watchOrders{docsify-ignore}
watches information on multiple orders made by the user
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<object>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol of the market orders were made in |
| since | int
| No | the earliest time in ms to fetch orders for |
| limit | int
| No | the maximum number of order structures to retrieve |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.watchOrders (symbol[, since, limit, params])
```
### watchMyTrades{docsify-ignore}
watches information on multiple trades made by the user
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<object>
- a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol of the market trades were made in |
| since | int
| No | the earliest time in ms to fetch trades for |
| limit | int
| No | the maximum number of trade structures to retrieve |
| params | object
| No | extra parameters specific to the exchange API endpoint |
```javascript
bitvavo.watchMyTrades (symbol[, since, limit, params])
```
### createOrderWs{docsify-ignore}
create a trade order
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- an [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://docs.bitvavo.com/#tag/Orders/paths/~1order/post
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to create an order in |
| type | string
| Yes | 'market' or 'limit' |
| side | string
| Yes | 'buy' or 'sell' |
| amount | float
| Yes | how much of currency you want to trade in units of base currency |
| price | float
| Yes | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
| params.timeInForce | string
| No | "GTC", "IOC", or "PO" |
| params.stopPrice | float
| No | The price at which a trigger order is triggered at |
| params.triggerPrice | float
| No | The price at which a trigger order is triggered at |
| params.postOnly | bool
| No | If true, the order will only be posted to the order book and not executed immediately |
| params.stopLossPrice | float
| No | The price at which a stop loss order is triggered at |
| params.takeProfitPrice | float
| No | The price at which a take profit order is triggered at |
| params.triggerType | string
| No | "price" |
| params.triggerReference | string
| No | "lastTrade", "bestBid", "bestAsk", "midPrice" Only for stop orders: Use this to determine which parameter will trigger the order |
| params.selfTradePrevention | string
| No | "decrementAndCancel", "cancelOldest", "cancelNewest", "cancelBoth" |
| params.disableMarketProtection | bool
| No | don't cancel if the next fill price is 10% worse than the best fill price |
| params.responseRequired | bool
| No | Set this to 'false' when only an acknowledgement of success or failure is required, this is faster. |
```javascript
bitvavo.createOrderWs (symbol, type, side, amount, price[, params])
```
### editOrderWs{docsify-ignore}
edit a trade order
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- an [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://docs.bitvavo.com/#tag/Orders/paths/~1order/put
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| id | string
| Yes | cancel order id |
| symbol | string
| Yes | unified symbol of the market to create an order in |
| type | string
| Yes | 'market' or 'limit' |
| side | string
| Yes | 'buy' or 'sell' |
| amount | float
| No | how much of currency you want to trade in units of base currency |
| price | float
| No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.editOrderWs (id, symbol, type, side[, amount, price, params])
```
### cancelOrderWs{docsify-ignore}
cancels an open order
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- An [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://docs.bitvavo.com/#tag/Orders/paths/~1order/delete
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| id | string
| Yes | order id |
| symbol | string
| Yes | unified symbol of the market the order was made in |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.cancelOrderWs (id, symbol[, params])
```
### cancelAllOrdersWs{docsify-ignore}
cancel all open orders
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<object>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://docs.bitvavo.com/#tag/Orders/paths/~1orders/delete
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.cancelAllOrdersWs (symbol[, params])
```
### fetchOrderWs{docsify-ignore}
fetches information on an order made by the user
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- An [order structure](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://docs.bitvavo.com/#tag/General/paths/~1assets/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| id | string
| Yes | the order id |
| symbol | string
| Yes | unified symbol of the market the order was made in |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.fetchOrderWs (id, symbol[, params])
```
### fetchOrdersWs{docsify-ignore}
fetches information on multiple orders made by the user
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<Order>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
**See**: https://docs.bitvavo.com/#tag/Orders/paths/~1orders/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol of the market orders were made in |
| since | int
| No | the earliest time in ms to fetch orders for |
| limit | int
| No | the maximum number of orde structures to retrieve |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.fetchOrdersWs (symbol[, since, limit, params])
```
### fetchOpenOrdersWs{docsify-ignore}
fetch all unfilled currently open orders
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<Order>
- a list of [order structures](https://docs.ccxt.com/#/?id=order-structure)
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol |
| since | int
| No | the earliest time in ms to fetch open orders for |
| limit | int
| No | the maximum number of open orders structures to retrieve |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.fetchOpenOrdersWs (symbol[, since, limit, params])
```
### fetchMyTradesWs{docsify-ignore}
fetch all trades made by the user
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<Trade>
- a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure)
**See**: https://docs.bitvavo.com/#tag/Trades
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified market symbol |
| since | int
| No | the earliest time in ms to fetch trades for |
| limit | int
| No | the maximum number of trades structures to retrieve |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.fetchMyTradesWs (symbol[, since, limit, params])
```
### withdrawWs{docsify-ignore}
make a withdrawal
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure)
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| code | string
| Yes | unified currency code |
| amount | float
| Yes | the amount to withdraw |
| address | string
| Yes | the address to withdraw to |
| tag | string
| Yes | |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.withdrawWs (code, amount, address, tag[, params])
```
### fetchWithdrawalsWs{docsify-ignore}
fetch all withdrawals made from an account
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<object>
- a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure)
**See**: https://docs.bitvavo.com/#tag/Account/paths/~1withdrawalHistory/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| code | string
| Yes | unified currency code |
| since | int
| No | the earliest time in ms to fetch withdrawals for |
| limit | int
| No | the maximum number of withdrawals structures to retrieve |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.fetchWithdrawalsWs (code[, since, limit, params])
```
### fetchOHLCVWs{docsify-ignore}
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<Array<int>>
- A list of candles ordered as timestamp, open, high, low, close, volume
**See**: https://docs.bitvavo.com/#tag/Market-Data/paths/~1{market}~1candles/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| symbol | string
| Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string
| Yes | the length of time each candle represents |
| since | int
| No | timestamp in ms of the earliest candle to fetch |
| limit | int
| No | the maximum amount of candles to fetch |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.fetchOHLCVWs (symbol, timeframe[, since, limit, params])
```
### fetchDepositsWs{docsify-ignore}
fetch all deposits made to an account
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<object>
- a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure)
**See**: https://docs.bitvavo.com/#tag/Account/paths/~1depositHistory/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| code | string
| Yes | unified currency code |
| since | int
| No | the earliest time in ms to fetch deposits for |
| limit | int
| No | the maximum number of deposits structures to retrieve |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.fetchDepositsWs (code[, since, limit, params])
```
### fetchTradingFeesWs{docsify-ignore}
fetch the trading fees for multiple markets
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- a dictionary of [fee structures](https://docs.ccxt.com/#/?id=fee-structure) indexed by market symbols
**See**: https://docs.bitvavo.com/#tag/Account/paths/~1account/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.fetchTradingFeesWs ([params])
```
### fetchMarketsWs{docsify-ignore}
retrieves data on all markets for bitvavo
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: Array<object>
- an array of objects representing market data
**See**: https://docs.bitvavo.com/#tag/General/paths/~1markets/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the exchange api endpoint |
```javascript
bitvavo.fetchMarketsWs ([params])
```
### fetchCurrenciesWs{docsify-ignore}
fetches all available currencies on an exchange
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- an associative dictionary of currencies
**See**: https://docs.bitvavo.com/#tag/General/paths/~1assets/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.fetchCurrenciesWs ([params])
```
### fetchBalanceWs{docsify-ignore}
query for balance and get the amount of funds available for trading or funds locked in orders
**Kind**: instance method of [bitvavo
](#bitvavo)
**Returns**: object
- a [balance structure](https://docs.ccxt.com/en/latest/manual.html?#balance-structure)
**See**: https://docs.bitvavo.com/#tag/Account/paths/~1balance/get
| Param | Type | Required | Description |
| --- | --- | --- | --- |
| params | object
| No | extra parameters specific to the bitvavo api endpoint |
```javascript
bitvavo.fetchBalanceWs ([params])
```