bitvavo
bitvavo cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.
bitvavo
Kind: global class
Extends: Exchange
- fetchTime
- fetchMarkets
- fetchCurrencies
- fetchTicker
- fetchTickers
- fetchTrades
- fetchTradingFees
- fetchTradingFee
- fetchOrderBook
- fetchOHLCV
- fetchBalance
- fetchAccounts
- transfer
- fetchTransfers
- fetchTransfer
- fetchDepositAddress
- createOrder
- editOrder
- cancelOrder
- cancelAllOrders
- cancelAllOrdersAfter
- fetchOrder
- fetchOrders
- fetchOpenOrders
- fetchMyTrades
- fetchLedger
- withdraw
- fetchWithdrawals
- fetchDeposits
- fetchDepositWithdrawFees
- watchTicker
- watchTickers
- watchBidsAsks
- watchTrades
- watchOHLCV
- watchOrderBook
- watchOrders
- watchMyTrades
- createOrderWs
- editOrderWs
- cancelOrderWs
- cancelAllOrdersWs
- fetchOrderWs
- fetchOrdersWs
- fetchOpenOrdersWs
- fetchMyTradesWs
- withdrawWs
- fetchWithdrawalsWs
- fetchOHLCVWs
- fetchDepositsWs
- fetchTradingFeesWs
- fetchMarketsWs
- fetchCurrenciesWs
- fetchBalanceWs
fetchTime
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of bitvavo
Returns: int - the current integer timestamp in milliseconds from the exchange server
See: https://docs.bitvavo.com/docs/rest-api/get-server-time/
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
bitvavo.fetchTime (params?)fetchMarkets
retrieves data on all markets for bitvavo
Kind: instance method of bitvavo
Returns: Array<object> - an array of objects representing market data
See: https://docs.bitvavo.com/docs/rest-api/get-markets/
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
bitvavo.fetchMarkets (params?)fetchCurrencies
fetches all available currencies on an exchange
Kind: instance method of bitvavo
Returns: object - an associative dictionary of currencies
See: https://docs.bitvavo.com/docs/rest-api/get-asset-data/
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
bitvavo.fetchCurrencies (params?)fetchTicker
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
Returns: object - a ticker structure
See: https://docs.bitvavo.com/docs/rest-api/get-candlestick-data-24-h/
| 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 |
bitvavo.fetchTicker (symbol, params?)fetchTickers
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
Kind: instance method of bitvavo
Returns: object - a dictionary of ticker structures
See: https://docs.bitvavo.com/docs/rest-api/get-candlestick-data-24-h/
| 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 |
bitvavo.fetchTickers (symbols, params?)fetchTrades
get the list of most recent trades for a particular symbol
Kind: instance method of bitvavo
Returns: Array<Trade> - a list of trade structures
See: https://docs.bitvavo.com/docs/rest-api/get-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 |
| 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 |
bitvavo.fetchTrades (symbol, since?, limit?, params?)fetchTradingFees
fetch the trading fees for multiple markets
Kind: instance method of bitvavo
Returns: object - a dictionary of fee structures indexed by market symbols
See: https://docs.bitvavo.com/docs/rest-api/get-account-fees/
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
bitvavo.fetchTradingFees (params?)fetchTradingFee
fetch the trading fees for a market
Kind: instance method of bitvavo
Returns: object - a fee structure
See: https://docs.bitvavo.com/docs/rest-api/get-market-fees/
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| params | object | No | extra parameters specific to the exchange API endpoint |
bitvavo.fetchTradingFee (symbol, params?)fetchOrderBook
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitvavo
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://docs.bitvavo.com/docs/rest-api/get-order-book/
| 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 |
bitvavo.fetchOrderBook (symbol, limit?, params?)fetchOHLCV
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bitvavo
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://docs.bitvavo.com/docs/rest-api/get-candlestick-data/
| 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 |
bitvavo.fetchOHLCV (symbol, timeframe, since?, limit?, params?)fetchBalance
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitvavo
Returns: object - a balance structure
See: https://docs.bitvavo.com/docs/rest-api/get-account-balance/
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
bitvavo.fetchBalance (params?)fetchAccounts
fetch all the accounts associated with a profile
Kind: instance method of bitvavo
Returns: Array<object> - a list of account structures
See: https://docs.bitvavo.com/docs/institutional-api/get-subaccounts/
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchAccounts (params?)transfer
transfer currency internally between the master account and a subaccount
Kind: instance method of bitvavo
Returns: object - a transfer structure
See: https://docs.bitvavo.com/docs/institutional-api/create-transfer/
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code |
| amount | float | Yes | amount to transfer |
| fromAccount | string | Yes | account to transfer from, either 'master' or the subaccount id |
| toAccount | string | Yes | account to transfer to, either 'master' or the subaccount id |
| params | object | No | extra parameters specific to the bitvavo api endpoint |
| params.subaccountId | string | No | the unique identifier for the subaccount |
| params.clientRequestId | string | No | client defined unique id |
bitvavo.transfer (code, amount, fromAccount, toAccount, params?)fetchTransfers
fetch a history of internal transfers made on an account
Kind: instance method of bitvavo
Returns: Array<object> - a list of transfer structures
See: https://docs.bitvavo.com/docs/institutional-api/get-transfers/
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | No | unified currency code of the currency transferred |
| since | int | No | the earliest time in ms to fetch transfers for |
| limit | int | No | the maximum number of transfers structures to retrieve |
| params | object | No | extra parameters specific to the bitvavo api endpoint |
| params.subaccountId | string | No | the unique identifier for the subaccount |
| params.until | int | No | the latest time in ms to fetch transfers for |
bitvavo.fetchTransfers (code?, since?, limit?, params?)fetchTransfer
fetches a transfer
Kind: instance method of bitvavo
Returns: object - a transfer structure
See: https://docs.bitvavo.com/docs/institutional-api/get-transfer/
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | transfer id |
| code | string | No | unified currency code of the currency transferred |
| params | object | No | extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchTransfer (id, code?, params?)fetchDepositAddress
fetch the deposit address for a currency associated with this account
Kind: instance method of bitvavo
Returns: object - an address structure
See: https://docs.bitvavo.com/docs/rest-api/get-deposit-data/
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | unified currency code |
| params | object | No | extra parameters specific to the exchange API endpoint |
bitvavo.fetchDepositAddress (code, params?)createOrder
create a trade order
Kind: instance method of bitvavo
Returns: object - an order structure
See: https://docs.bitvavo.com/docs/rest-api/create-order/
| 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 | Alias for triggerPrice |
| 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 | one of EXPIRE_BOTH, cancelOldest, cancelNewest or decrementAndCancel |
| 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. |
bitvavo.createOrder (symbol, type, side, amount, price, params?)editOrder
edit a trade order
Kind: instance method of bitvavo
Returns: object - an order structure
See: https://docs.bitvavo.com/docs/rest-api/update-order/
| 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 |
bitvavo.editOrder (id, symbol, type, side, amount?, price?, params?)cancelOrder
cancels an open order
Kind: instance method of bitvavo
Returns: object - An order structure
See: https://docs.bitvavo.com/docs/rest-api/cancel-order/
| 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 |
bitvavo.cancelOrder (id, symbol, params?)cancelAllOrders
cancel all open orders
Kind: instance method of bitvavo
Returns: Array<object> - a list of order structures
See: https://docs.bitvavo.com/docs/rest-api/cancel-orders/
| 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 |
bitvavo.cancelAllOrders (symbol, params?)cancelAllOrdersAfter
dead man's switch, cancel all orders after the given timeout
Kind: instance method of bitvavo
Returns: object - the api result
See: https://docs.bitvavo.com/docs/rest-api/cancel-orders-after/
| Param | Type | Required | Description |
|---|---|---|---|
| timeout | number | Yes | time in milliseconds, 0 represents cancel the timer |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.codGroupId | int | No | your identifier for a group of orders, default is 1 |
bitvavo.cancelAllOrdersAfter (timeout, params?)fetchOrder
fetches information on an order made by the user
Kind: instance method of bitvavo
Returns: object - An order structure
See: https://docs.bitvavo.com/docs/rest-api/get-order/
| 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 |
bitvavo.fetchOrder (id, symbol, params?)fetchOrders
fetches information on multiple orders made by the user
Kind: instance method of bitvavo
Returns: Array<Order> - a list of order structures
See: https://docs.bitvavo.com/docs/rest-api/get-orders/
| 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 |
| params.until | int | No | the latest time in ms to fetch entries for |
bitvavo.fetchOrders (symbol, since?, limit?, params?)fetchOpenOrders
fetch all unfilled currently open orders
Kind: instance method of bitvavo
Returns: Array<Order> - a list of order structures
See: https://docs.bitvavo.com/docs/rest-api/get-open-orders/
| 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 |
bitvavo.fetchOpenOrders (symbol, since?, limit?, params?)fetchMyTrades
fetch all trades made by the user
Kind: instance method of bitvavo
Returns: Array<Trade> - a list of trade structures
See: https://docs.bitvavo.com/docs/rest-api/get-trade-history/
| 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 |
bitvavo.fetchMyTrades (symbol, since?, limit?, params?)fetchLedger
fetch the history of changes, actions done by the user or operations that altered the balance of the user
Kind: instance method of bitvavo
Returns: Array<object> - a list of ledger structures
See: https://docs.bitvavo.com/docs/rest-api/get-transaction-history/
| Param | Type | Required | Description |
|---|---|---|---|
| code | string | No | unified currency code |
| since | int | No | timestamp in ms of the earliest ledger entry |
| limit | int | No | max number of ledger entries to return |
| params | object | No | extra parameters specific to the bitvavo api endpoint |
| params.until | int | No | timestamp in ms of the latest ledger entry |
| params.page | int | No | the page number for the transaction history |
bitvavo.fetchLedger (code?, since?, limit?, params?)withdraw
make a withdrawal
Kind: instance method of bitvavo
Returns: object - a transaction structure
See: https://docs.bitvavo.com/docs/rest-api/withdraw-assets/
| 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 |
bitvavo.withdraw (code, amount, address, tag, params?)fetchWithdrawals
fetch all withdrawals made from an account
Kind: instance method of bitvavo
Returns: Array<object> - a list of transaction structures
See: https://docs.bitvavo.com/docs/rest-api/get-withdrawal-history/
| 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 |
bitvavo.fetchWithdrawals (code, since?, limit?, params?)fetchDeposits
fetch all deposits made to an account
Kind: instance method of bitvavo
Returns: Array<object> - a list of transaction structures
See: https://docs.bitvavo.com/docs/rest-api/get-deposit-history/
| 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 |
bitvavo.fetchDeposits (code, since?, limit?, params?)fetchDepositWithdrawFees
fetch deposit and withdraw fees
Kind: instance method of bitvavo
Returns: object - a list of fee structures
See: https://docs.bitvavo.com/docs/rest-api/get-asset-data/
| 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 |
bitvavo.fetchDepositWithdrawFees (codes, params?)watchTicker
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
Returns: object - a ticker structure
See: https://docs.bitvavo.com/#tag/Market-data-subscription-WebSocket/paths/~1subscribeTicker24h/post
| 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 |
bitvavo.watchTicker (symbol, params?)watchTickers
watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list
Kind: instance method of bitvavo
Returns: object - a ticker structure
See: https://docs.bitvavo.com/#tag/Market-data-subscription-WebSocket/paths/~1subscribeTicker24h/post
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | unified symbol of the market to fetch the ticker for |
| params | object | No | extra parameters specific to the exchange API endpoint |
bitvavo.watchTickers (symbols?, params?)watchBidsAsks
watches best bid & ask for symbols
Kind: instance method of bitvavo
Returns: object - a ticker structure
See: https://docs.bitvavo.com/#tag/Market-data-subscription-WebSocket/paths/~1subscribeTicker24h/post
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | Yes | unified symbol of the market to fetch the ticker for |
| params | object | No | extra parameters specific to the exchange API endpoint |
bitvavo.watchBidsAsks (symbols, params?)watchTrades
get the list of most recent trades for a particular symbol
Kind: instance method of bitvavo
Returns: Array<object> - a list of trade structures
| 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 |
bitvavo.watchTrades (symbol, since?, limit?, params?)watchOHLCV
watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of 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 |
bitvavo.watchOHLCV (symbol, timeframe, since?, limit?, params?)watchOrderBook
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitvavo
Returns: object - A dictionary of order book structures 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 |
bitvavo.watchOrderBook (symbol, limit?, params?)watchOrders
watches information on multiple orders made by the user
Kind: instance method of bitvavo
Returns: Array<object> - a list of order structures
| 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 |
bitvavo.watchOrders (symbol, since?, limit?, params?)watchMyTrades
watches information on multiple trades made by the user
Kind: instance method of bitvavo
Returns: Array<object> - a list of trade structures
| 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 |
bitvavo.watchMyTrades (symbol, since?, limit?, params?)createOrderWs
create a trade order
Kind: instance method of bitvavo
Returns: object - an 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. |
bitvavo.createOrderWs (symbol, type, side, amount, price, params?)editOrderWs
edit a trade order
Kind: instance method of bitvavo
Returns: object - an 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 |
bitvavo.editOrderWs (id, symbol, type, side, amount?, price?, params?)cancelOrderWs
cancels an open order
Kind: instance method of bitvavo
Returns: object - An 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 |
bitvavo.cancelOrderWs (id, symbol, params?)cancelAllOrdersWs
cancel all open orders
Kind: instance method of bitvavo
Returns: Array<object> - a list of order structures
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 |
bitvavo.cancelAllOrdersWs (symbol, params?)fetchOrderWs
fetches information on an order made by the user
Kind: instance method of bitvavo
Returns: object - An 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 |
bitvavo.fetchOrderWs (id, symbol, params?)fetchOrdersWs
fetches information on multiple orders made by the user
Kind: instance method of bitvavo
Returns: Array<Order> - a list of order structures
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 |
bitvavo.fetchOrdersWs (symbol, since?, limit?, params?)fetchOpenOrdersWs
fetch all unfilled currently open orders
Kind: instance method of bitvavo
Returns: Array<Order> - a list of order structures
| 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 |
bitvavo.fetchOpenOrdersWs (symbol, since?, limit?, params?)fetchMyTradesWs
fetch all trades made by the user
Kind: instance method of bitvavo
Returns: Array<Trade> - a list of trade structures
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 |
bitvavo.fetchMyTradesWs (symbol, since?, limit?, params?)withdrawWs
make a withdrawal
Kind: instance method of bitvavo
Returns: object - a 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 |
bitvavo.withdrawWs (code, amount, address, tag, params?)fetchWithdrawalsWs
fetch all withdrawals made from an account
Kind: instance method of bitvavo
Returns: Array<object> - a list of transaction structures
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 |
bitvavo.fetchWithdrawalsWs (code, since?, limit?, params?)fetchOHLCVWs
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of 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 |
bitvavo.fetchOHLCVWs (symbol, timeframe, since?, limit?, params?)fetchDepositsWs
fetch all deposits made to an account
Kind: instance method of bitvavo
Returns: Array<object> - a list of transaction structures
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 |
bitvavo.fetchDepositsWs (code, since?, limit?, params?)fetchTradingFeesWs
fetch the trading fees for multiple markets
Kind: instance method of bitvavo
Returns: object - a dictionary of fee structures 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 |
bitvavo.fetchTradingFeesWs (params?)fetchMarketsWs
retrieves data on all markets for bitvavo
Kind: instance method of 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 |
bitvavo.fetchMarketsWs (params?)fetchCurrenciesWs
fetches all available currencies on an exchange
Kind: instance method of 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 |
bitvavo.fetchCurrenciesWs (params?)fetchBalanceWs
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitvavo
Returns: object - a 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 |
bitvavo.fetchBalanceWs (params?)