bitvavo
Version:
This is the NodeJS wrapper for the Bitvavo API
1,933 lines (1,800 loc) • 72.5 kB
Markdown
# Bitvavo SDK for Node.js
Crypto starts with Bitvavo.
You use Bitvavo SDK for Node.js to buy, sell, and store over 200 digital assets on Bitvavo from inside your app.
To trade and execute your advanced trading strategies, Bitvavo SDK for Node.js is a wrapper that enables you to easily call every endpoint in [Bitvavo API](https://docs.bitvavo.com/). Every function available on the API can be called through a REST request or over WebSocket.
* [Prerequisites](#prerequisites)
* [Install](#installation)
* Getting started [REST](#getting-started) [WebSocket](#getting-started-1)
* General
* Time [REST](#get-time) [WebSocket](#get-time-1)
* Markets [REST](#get-markets) [WebSocket](#get-markets-1)
* Assets [REST](#get-assets) [WebSocket](#get-assets-1)
* Market Data
* Book [REST](#get-book-per-market) [WebSocket](#get-book-per-market-1)
* Public Trades [REST](#get-trades-per-market) [WebSocket](#get-trades-per-market-1)
* Candles [REST](#get-candles-per-market) [WebSocket](#get-candles-per-market-1)
* Price Ticker [REST](#get-price-ticker) [WebSocket](#get-price-ticker-1)
* Book Ticker [REST](#get-book-ticker) [WebSocket](#get-book-ticker-1)
* 24 Hour Ticker [REST](#get-24-hour-ticker) [WebSocket](#get-24-hour-ticker-1)
* Private
* Place Order [REST](#place-order) [WebSocket](#place-order-1)
* Update Order [REST](#update-order) [WebSocket](#update-order-1)
* Get Order [REST](#get-order) [WebSocket](#get-order-1)
* Cancel Order [REST](#cancel-order) [WebSocket](#cancel-order-1)
* Get Orders [REST](#get-orders) [WebSocket](#get-orders-1)
* Cancel Orders [REST](#cancel-orders) [WebSocket](#cancel-orders-1)
* Orders Open [REST](#get-orders-open) [WebSocket](#get-orders-open-1)
* Trades [REST](#get-trades) [WebSocket](#get-trades-1)
* Account [REST](#get-account) [WebSocket](#get-account-1)
* Balance [REST](#get-balance) [WebSocket](#get-balance-1)
* Deposit Assets [REST](#deposit-assets) [WebSocket](#deposit-assets-1)
* Withdraw Assets [REST](#withdraw-assets) [WebSocket](#withdraw-assets-1)
* Deposit History [REST](#get-deposit-history) [WebSocket](#get-deposit-history-1)
* Withdrawal History [REST](#get-withdrawal-history) [WebSocket](#get-withdrawal-history-1)
* [Subscriptions](#subscriptions)
* [Ticker Subscription](#ticker-subscription)
* [Ticker 24 Hour Subscription](#ticker-24-hour-subscription)
* [Account Subscription](#account-subscription)
* [Candles Subscription](#candles-subscription)
* [Trades Subscription](#trades-subscription)
* [Book Subscription](#book-subscription)
* [Book Subscription With Local Copy](#book-subscription-with-local-copy)
* [Unsubscribe](#unsubscribe)
## Prerequisites
To start programming with Bitvavo SDK for Node.js you need:
- [Node.js](https://nodejs.org/en) installed on your development device
- A Node app. Use your favorite IDE, or run from the command line
- An [API key and secret](https://support.bitvavo.com/hc/en-us/articles/4405059841809) associated with your Bitvavo account
You control the actions your app can do using the rights you assign to the API key.
Possible rights are:
+ **View**: retrieve information about your balance, account, deposit and withdrawals
+ **Trade**: place, update, view and cancel orders
+ **Withdraw**: withdraw funds
Best practice is to not grant this privilege, withdrawals using the API do not require 2FA and e-mail confirmation.
## Installation
To install Bitvavo SDK for Node.js, run the following command in your Node app:
```
npm i bitvavo
```
## Rate Limiting
Bitvavo uses a weight based rate limiting system, with an allowed limit of 1000 per IP or API key each minute. Please inspect each endpoint in the [Bitvavo API documentation](https://docs.bitvavo.com/) to see the weight. Failure to respect the rate limit will result in an IP or API key ban.
Since the remaining limit is returned in the header on each REST request, the remaining limit is tracked locally and can be requested through:
```
let limitRemaining = bitvavo.getRemainingLimit()
```
The WebSocket functions however do not return a remaining limit, therefore the limit is only updated locally once a ban has been issued.
## REST requests
The general convention used in all functions (both REST and WebSocket), is that all optional parameters are passed as an object, while required parameters are passed as separate values. Only when [placing orders](#place-order) some of the optional parameters are required, since a limit order requires more information than a market order. The returned responses are all converted to an object as well, such that `response['<key>'] = '<value>'` and `response.<key> = '<value>'`.
### Getting started
The API key and secret are required for private calls and optional for public calls. The access window and debugging parameter are optional for all calls. The access window is used to determine whether the request arrived within time, the value is specified in milliseconds. You can use the [time](#get-time) function to synchronize your time to our server time if errors arise. REST url and WS url can be used to set a different endpoint (for testing purposes). Debugging should be set to true when you want to log additional information and full responses. Any parameter can be omitted, private functions will return an error when the api key and secret have not been set.
```javascript
const bitvavo = require('bitvavo')().options({
APIKEY: '<APIKEY>',
APISECRET: '<APISECRET>',
ACCESSWINDOW: 10000,
RESTURL: 'https://api.bitvavo.com/v2',
WSURL: 'wss://ws.bitvavo.com/v2/',
DEBUGGING: false
})
```
Our Node wrapper functions both with [promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) and with [callbacks](https://developer.mozilla.org/en-US/docs/Glossary/Callback_function). This means that the following two functions have the same effect.
```javascript
// Callback
bitvavo.time((error, response) => {
if (error === null) {
console.log('Handle the response here', response)
} else {
console.log('Handle the error here', error)
}
})
// Promise
try {
let response = await bitvavo.time()
console.log('Handle the response here', response)
} catch (error) {
console.log('Handle errors here', error)
}
```
### General
#### Get time
```javascript
// Function with callback
bitvavo.time((error, response) => {
if (error === null) {
console.log(response)
} else {
console.log(error)
}
})
// Function with promise
try {
let response = await bitvavo.time()
console.log(response)
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{ time: 1543478503490 }
```
</details>
#### Get markets
```javascript
// Function with callback
// options: market
bitvavo.markets({}, (error, response) => {
if (error === null) {
for (let entry of response) {
console.log(entry)
}
} else {
console.log(error)
}
})
// Function with promise
// options: market
try {
let response = await bitvavo.markets({})
for (let entry of response) {
console.log(entry)
}
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{ market: 'ADA-BTC',
status: 'trading',
base: 'ADA',
quote: 'BTC',
pricePrecision: 5,
minOrderInBaseAsset: '100',
minOrderInQuoteAsset: '0.001',
orderTypes: [ 'market', 'limit' ] }
{ market: 'ADA-EUR',
status: 'trading',
base: 'ADA',
quote: 'EUR',
pricePrecision: 5,
minOrderInBaseAsset: '100',
minOrderInQuoteAsset: '10',
orderTypes: [ 'market', 'limit' ] }
{ market: 'AE-BTC',
status: 'trading',
base: 'AE',
quote: 'BTC',
pricePrecision: 5,
minOrderInBaseAsset: '10',
minOrderInQuoteAsset: '0.001',
orderTypes: [ 'market', 'limit' ] }
{ market: 'AE-EUR',
status: 'trading',
base: 'AE',
quote: 'EUR',
pricePrecision: 5,
minOrderInBaseAsset: '10',
minOrderInQuoteAsset: '10',
orderTypes: [ 'market', 'limit' ] }
{ market: 'AION-BTC',
status: 'trading',
base: 'AION',
quote: 'BTC',
pricePrecision: 5,
minOrderInBaseAsset: '30',
minOrderInQuoteAsset: '0.001',
orderTypes: [ 'market', 'limit' ] }
...
```
</details>
#### Get assets
```javascript
// Function with callback
// options: symbol
bitvavo.assets({}, (error, response) => {
if (error === null) {
for (let entry of response) {
console.log(entry)
}
} else {
console.log(error)
}
})
// Function with promise
// options: symbol
try {
let response = await bitvavo.assets({})
for (let entry of response) {
console.log(entry)
}
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{ symbol: 'ADA',
name: 'Cardano',
decimals: 6,
depositFee: '0',
depositConfirmations: 30,
depositStatus: 'OK',
withdrawalFee: '0.2',
withdrawalMinAmount: '0.2',
withdrawalStatus: 'OK',
networks: [
'Mainnet'
],
message: '' }
{ symbol: 'BAT',
name: 'Basic Attention Token',
decimals: 8,
depositFee: '0',
depositConfirmations: 20,
depositStatus: 'OK',
withdrawalFee: '7',
withdrawalMinAmount: '7',
withdrawalStatus: 'OK',
networks: [
'Mainnet'
],
message: '' }
{ symbol: 'BCH',
name: 'Bitcoin Cash',
decimals: 8,
depositFee: '0',
depositConfirmations: 20,
depositStatus: 'OK',
withdrawalFee: '0.0001',
withdrawalMinAmount: '0.00001',
withdrawalStatus: 'OK',
networks: [
'Mainnet'
],
message: '' }
{ symbol: 'BTC',
name: 'Bitcoin',
decimals: 8,
depositFee: '0',
depositConfirmations: 3,
depositStatus: 'OK',
withdrawalFee: '0.00006',
withdrawalMinAmount: '0.00001',
withdrawalStatus: 'OK',
networks: [
'Mainnet'
],
message: '' }
...
```
</details>
### Market Data
#### Get book per market
```javascript
// Function with callback
// options: depth
bitvavo.book('BTC-EUR', {}, (error, response) => {
if (error === null) {
console.log(response)
} else {
console.log(error)
}
})
// Function with promise
// options: depth
try {
let response = await bitvavo.book('BTC-EUR', {})
console.log(response)
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{ market: 'BTC-EUR',
nonce: 39785,
bids:
[ [ '3304', '0.00303' ],
[ '3297.2', '0.0030344' ],
[ '3290.2', '0.00304085' ],
[ '3283.9', '0.00304669' ],
[ '3277.6', '0.00305254' ],
[ '3269.5', '0.00306011' ],
[ '3262.9', '0.0030663' ],
[ '3256.5', '0.00307232' ],
[ '3249.7', '0.00307875' ],
[ '3243', '0.00308511' ],
[ '3236.4', '0.0030914' ],
[ '3229.8', '0.00309772' ],
[ '3224.1', '0.0031032' ],
[ '3217.5', '0.00310956' ],
[ '3210', '0.00311683' ],
[ '3203.4', '0.00312325' ],
[ '3197.7', '0.00312882' ],
[ '3186.3', '0.00314001' ],
[ '3182.3', '0.00314396' ],
[ '3177.7', '0.00314851' ],
[ '3166.6', '0.00315955' ],
[ '3160', '0.00316614' ],
[ '3153.4', '0.00317277' ],
[ '3146.8', '0.00317943' ],
[ '3138.7', '0.00318763' ] ],
asks:
[ [ '3310.7', '0.00302503' ],
[ '3317.4', '0.00302494' ],
[ '3324.1', '0.00302494' ],
[ '3330.7', '0.00302494' ],
[ '3337.3', '0.00302494' ],
[ '3343.9', '0.00302494' ],
[ '3350.5', '0.00302494' ],
[ '3357.1', '0.00302503' ],
[ '3366.3', '0.00302266' ],
[ '3372.9', '0.00302266' ],
[ '3379.6', '0.00302266' ],
[ '3386.2', '0.00302266' ],
[ '3392.8', '0.00302266' ],
[ '3399.5', '0.00302266' ],
[ '3401.3', '0.00302687' ],
[ '3408', '0.00302687' ],
[ '3414.4', '0.00302705' ],
[ '3420.8', '0.00302723' ],
[ '3427', '0.0030276' ],
[ '3433.3', '0.00302787' ],
[ '3439.1', '0.00302861' ],
[ '3445.7', '0.00302861' ],
[ '3451.9', '0.00302897' ],
[ '3458.2', '0.00302925' ],
[ '3464.3', '0.00302971' ],
[ '3500.1', '0.002032' ] ] }
```
</details>
#### Get trades per market
```javascript
// Function with callback
// options: limit, start, end, tradeIdFrom, tradeIdTo
bitvavo.publicTrades('BTC-EUR', {}, (error, response) => {
if (error === null) {
console.log(response)
} else {
console.log(error)
}
})
// Function with promise
// options: limit, start, end, tradeIdFrom, tradeIdTo
try {
let response = await bitvavo.publicTrades('BTC-EUR', {})
for (let entry of response) {
console.log(entry)
}
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{ id: '5400feff-54b8-40a3-90d4-5f0f68f28c25',
timestamp: 1545213249947,
amount: '0.001',
price: '3500.1',
side: 'buy' }
{ id: '0294c35a-c2d3-41b3-9f6d-759312c51e8d',
timestamp: 1545213234550,
amount: '0.003039',
price: '3453.7',
side: 'buy' }
{ id: '3501ca58-3980-4797-bccc-70fd58405c96',
timestamp: 1545213234535,
amount: '0.003039',
price: '3447.1',
side: 'buy' }
{ id: '6ac6944d-870c-466d-bec3-f03d1cc43409',
timestamp: 1545213234521,
amount: '0.00303191',
price: '3441.9',
side: 'buy' }
{ id: 'f79a2d5d-4839-4191-b0b3-65044bb4861d',
timestamp: 1545213234508,
amount: '0.003039',
price: '3440.5',
side: 'buy' }
{ id: '8a5cf6c5-d802-4f05-a6bc-63e0ad79423a',
timestamp: 1545213234491,
amount: '0.00303568',
price: '3431.1',
side: 'buy' }
{ id: '896c451f-a5f2-4b77-80d0-5b095a90d139',
timestamp: 1545213234479,
amount: '0.00303568',
price: '3424.5',
side: 'buy' }
{ id: '300bc05a-f63a-4ad2-ba87-b7b3900a4ed9',
timestamp: 1545213234458,
amount: '0.00303375',
price: '3420',
side: 'buy' }
...
```
</details>
#### Get candles per market
```javascript
// Function with callback
// options: limit, start, end
bitvavo.candles('BTC-EUR', '1h', {}, (error, response) => {
if (error === null) {
for (let entry of response) {
console.log(entry)
}
} else {
console.log(error)
}
})
// Function with promise
// options: limit, start, end
try {
let response = await bitvavo.candles('BTC-EUR', '1h', {})
for (let entry of response) {
console.log(entry)
}
} catch (error) {
console.log(error)
}
// Return parameters are: 'Timestamp: ', entry[0], ' Open: ', entry[1], ' High: ', entry[2],
// ' Low: ', entry[3], ' Close: ', entry[4], ' Volume: ', entry[5]
```
<details>
<summary>View Response</summary>
```javascript
[ 1545210000000, '3308.2', '3500.1', '3308.2', '3500.1', '0.07684055' ]
[ 1545138000000, '3158.2', '3199.6', '3158.2', '3199.6', '0.02477561' ]
[ 1545134400000, '3154.8', '3158.2', '3154.8', '3158.2', '0.003' ]
[ 1545130800000, '3154.8', '3154.8', '3154.8', '3154.8', '0.001' ]
[ 1545210000000, '3308.2', '3500.1', '3308.2', '3500.1', '0.07684055' ]
[ 1545138000000, '3158.2', '3199.6', '3158.2', '3199.6', '0.02477561' ]
[ 1545134400000, '3154.8', '3158.2', '3154.8', '3158.2', '0.003' ]
[ 1545130800000, '3154.8', '3154.8', '3154.8', '3154.8', '0.001' ]
...
```
</details>
#### Get price ticker
```javascript
// Function with callback
// options: market
bitvavo.tickerPrice({}, (error, response) => {
if (error === null) {
for (let entry of response) {
console.log(entry)
}
} else {
console.log(error)
}
})
// Function with promise
// options: market
try {
let response = await bitvavo.tickerPrice({})
for (let entry of response) {
console.log(entry)
}
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{ market: 'XRP-BTC', price: '0.000097983' }
{ market: 'MIOTA-BTC', price: '0.000078189' }
{ market: 'LSK-BTC', price: '0.00034486' }
{ market: 'BCH-EUR', price: '102.1' }
{ market: 'XRP-EUR', price: '0.32418' }
{ market: 'AE-BTC', price: '0.00011033' }
{ market: 'AION-BTC', price: '0.000034426' }
{ market: 'ANT-BTC', price: '0.00011455' }
{ market: 'ARK-BTC', price: '0.00009624' }
{ market: 'BAT-BTC', price: '0.000037708' }
{ market: 'BTC-EUR', price: '3500.1' }
{ market: 'CMT-BTC', price: '0.000006695' }
{ market: 'DCR-BTC', price: '0.0048841' }
{ market: 'DGB-BTC', price: '0.0000030977' }
{ market: 'ELF-EUR', price: '0.10219' }
{ market: 'EOS-BTC', price: '0.00068749' }
{ market: 'ETC-BTC', price: '0.0011361' }
{ market: 'ETH-BTC', price: '0.027504' }
{ market: 'GAS-BTC', price: '0.0005364' }
{ market: 'GNT-BTC', price: '0.000018384' }
{ market: 'ICX-EUR', price: '0.17683' }
{ market: 'LRC-BTC', price: '0.000011178' }
{ market: 'LTC-EUR', price: '24.622' }
{ market: 'NANO-BTC', price: '0.00025949' }
{ market: 'NAS-EUR', price: '0.46102' }
{ market: 'NEO-BTC', price: '0.0018661' }
{ market: 'NEO-EUR', price: '5.6134' }
{ market: 'OMG-BTC', price: '0.000365' }
{ market: 'ONT-BTC', price: '0.00018014' }
{ market: 'ONT-EUR', price: '0.48529' }
{ market: 'POWR-BTC', price: '0.000020786' }
{ market: 'POWR-EUR', price: '0.068639' }
{ market: 'QTUM-EUR', price: '1.9927' }
{ market: 'RDD-EUR', price: '0.0011917' }
...
```
</details>
#### Get book ticker
```javascript
// Function with callback
// options: market
bitvavo.tickerBook({}, (error, response) => {
if (error === null) {
for (let entry of response) {
console.log(entry)
}
} else {
console.log(error)
}
})
// Function with promise
// options: market
try {
let response = await bitvavo.tickerBook({})
for (let entry of response) {
console.log(entry)
}
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{ market: 'XVG-BTC',
bid: '0.00000043',
ask: '0.00000044',
bidSize: '20520.72555668',
askSize: '28577.12228909' }
{ market: 'XVG-EUR',
bid: '0.0043516',
ask: '0.0044561',
bidSize: '1560387.75456382',
askSize: '1456319.40904593' }
{ market: 'ZIL-BTC',
bid: '0.00000081',
ask: '0.00000082',
bidSize: '13992.6485724',
askSize: '5737.46205762' }
{ market: 'ZIL-EUR',
bid: '0.0081972',
ask: '0.0083046',
bidSize: '19825.02546306',
askSize: '19039.17428288' }
{ market: 'ZRX-BTC',
bid: '0.000016184',
ask: '0.000016215',
bidSize: '827.21868459',
askSize: '872.2554613' }
{ market: 'ZRX-EUR',
bid: '0.16378',
ask: '0.16417',
bidSize: '901.91558201',
askSize: '420.84088941' }
...
```
</details>
#### Get 24 hour ticker
```javascript
// Function with callback
// options: market
bitvavo.ticker24h({}, (error, response) => {
if (error === null) {
for (let entry of response) {
console.log(entry)
}
} else {
console.log(error)
}
})
// Function with promise
// options: market
try {
let response = await bitvavo.ticker24h({})
console.log(response)
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{ market: 'XTZ-EUR',
open: '1.23',
high: '1.2303',
low: '1.211',
last: '1.2212',
volume: '6070.883854',
volumeQuote: '7402.08',
bid: '1.211',
bidSize: '135.55716',
ask: '1.2145',
askSize: '196.660095',
timestamp: 1565686663799 }
{ market: 'XVG-EUR',
open: '0.0045853',
high: '0.0045853',
low: '0.0043599',
last: '0.0044047',
volume: '554786.9689017',
volumeQuote: '2465.30',
bid: '0.0043539',
bidSize: '1559571.35409598',
ask: '0.0044579',
askSize: '1455715.43144938',
timestamp: 1565686663855 }
{ market: 'ZIL-EUR',
open: '0.0081309',
high: '0.0084196',
low: '0.0077389',
last: '0.0084042',
volume: '890193.39720644',
volumeQuote: '7220.30',
bid: '0.0082015',
bidSize: '19814.65293866',
ask: '0.008308',
askSize: '19039.17428288',
timestamp: 1565686663816 }
{ market: 'ZRX-EUR',
open: '0.1731',
high: '0.1731',
low: '0.16426',
last: '0.16477',
volume: '22486.29651877',
volumeQuote: '3727.45',
bid: '0.16387',
bidSize: '901.47028373',
ask: '0.16423',
askSize: '420.66230814',
timestamp: 1565686663431 }
...
```
</details>
### Private
#### Place order
When placing an order, make sure that the correct optional parameters are set. For a limit order it is required to set both the amount and price. A market order is valid if either the amount or the amountQuote has been set.
```javascript
// Function with callback
// Optional parameters: limit:(amount, price, postOnly), market:(amount, amountQuote, disableMarketProtection),
// stopLoss/takeProfit:(amount, amountQuote, disableMarketProtection, triggerType, triggerReference, triggerAmount)
// stopLossLimit/takeProfitLimit:(amount, price, postOnly, triggerType, triggerReference, triggerAmount)
// all orderTypes: timeInForce, selfTradePrevention, responseRequired, clientOrderId
bitvavo.placeOrder('BTC-EUR', 'sell', 'limit', { amount: '1', price: '3000' }, (error, response) => {
if (error === null) {
console.log(response)
} else {
console.log(error)
}
})
// Function with promise
// Optional parameters: limit:(amount, price, postOnly), market:(amount, amountQuote, disableMarketProtection),
// stopLoss/takeProfit:(amount, amountQuote, disableMarketProtection, triggerType, triggerReference, triggerAmount)
// stopLossLimit/takeProfitLimit:(amount, price, postOnly, triggerType, triggerReference, triggerAmount)
// all orderTypes: timeInForce, selfTradePrevention, responseRequired, clientOrderId
try {
let response = await bitvavo.placeOrder('BTC-EUR', 'sell', 'limit', { 'amount': '1', 'price': 3000 })
console.log(response)
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{
orderId: '6a57e514-60aa-4a91-8958-5e70fa5c0ed3',
market: 'BTC-EUR',
created: 1548668202114,
updated: 1548668202114,
status: 'new',
side: 'buy',
orderType: 'limit',
amount: '1',
amountRemaining: '1',
price: '3000',
onHold: '3007.5',
onHoldCurrency: 'EUR',
filledAmount: '0',
filledAmountQuote: '0',
feePaid: '0',
feeCurrency: 'EUR',
fills: [],
selfTradePrevention: 'decrementAndCancel',
visible: true,
timeInForce: 'GTC',
postOnly: false,
clientOrderId: 'bb4076a3-d7b6-4bf6-aa35-b12f14fcb092'
}
```
</details>
#### Update order
When updating an order make sure that at least one of the optional parameters has been set. Otherwise nothing can be updated.
```javascript
// Function with callback
// Optional parameters: limit:(amount, amountRemaining, price, timeInForce, selfTradePrevention, postOnly)
// untriggered stopLoss/takeProfit:(amount, amountQuote, disableMarketProtection, triggerType, triggerReference, triggerAmount)
// stopLossLimit/takeProfitLimit: (amount, price, postOnly, triggerType, triggerReference, triggerAmount)
bitvavo.updateOrder('BTC-EUR', 'bb4076a3-d7b6-4bf6-aa35-b12f14fcb092', { price: 4500 }, (error, response) => {
if (error === null) {
console.log(response)
} else {
console.log(error)
}
})
// Function with promise
// Optional parameters: limit:(amount, amountRemaining, price, timeInForce, selfTradePrevention, postOnly)
// untriggered stopLoss/takeProfit:(amount, amountQuote, disableMarketProtection, triggerType, triggerReference, triggerAmount)
// stopLossLimit/takeProfitLimit: (amount, price, postOnly, triggerType, triggerReference, triggerAmount)
try {
let response = await bitvavo.updateOrder('BTC-EUR', 'bb4076a3-d7b6-4bf6-aa35-b12f14fcb092', { amount: 0.2 })
console.log(response)
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{ orderId: '6a57e514-60aa-4a91-8958-5e70fa5c0ed3',
market: 'BTC-EUR',
created: 1548668202114,
updated: 1548668368746,
status: 'new',
side: 'buy',
orderType: 'limit',
amount: '0.5',
amountRemaining: '0.5',
price: '3000',
onHold: '1503.75',
onHoldCurrency: 'EUR',
filledAmount: '0',
filledAmountQuote: '0',
feePaid: '0',
feeCurrency: 'EUR',
fills: [],
selfTradePrevention: 'decrementAndCancel',
visible: true,
timeInForce: 'GTC',
postOnly: false }
```
</details>
#### Get order
```javascript
// Optional parameters: orderId, clientOrderId
// Function with callback
bitvavo.getOrder('BTC-EUR', { clientOrderId: '0fc09a0a-ac77-4923-a06b-68b5c23fe6ec' }, (error, response) => {
if (error === null) {
console.log(response);
} else {
console.log(error);
}
});
// Function with promise
try {
const response = await bitvavo.getOrder('BTC-EUR', { clientOrderId: '0fc09a0a-ac77-4923-a06b-68b5c23fe6ec' });
console.log(response);
} catch (error) {
console.log(error);
}
```
<details>
<summary>View Response</summary>
```javascript
{
orderId: '6a57e514-60aa-4a91-8958-5e70fa5c0ed3',
market: 'BTC-EUR',
created: 1548668202114,
updated: 1548668202114,
status: 'new',
side: 'buy',
orderType: 'limit',
amount: '1',
amountRemaining: '1',
price: '3000',
onHold: '3007.5',
onHoldCurrency: 'EUR',
filledAmount: '0',
filledAmountQuote: '0',
feePaid: '0',
feeCurrency: 'EUR',
fills: [],
selfTradePrevention: 'decrementAndCancel',
visible: true,
timeInForce: 'GTC',
postOnly: false,
clientOrderId: '0fc09a0a-ac77-4923-a06b-68b5c23fe6ec'
}
```
</details>
#### Cancel order
```javascript
// Function with callback
bitvavo.cancelOrder('BTC-EUR', 'bb4076a3-d7b6-4bf6-aa35-b12f14fcb092', (error, response) => {
if (error === null) {
console.log(response)
} else {
console.log(error)
}
})
// Function with promise
try {
let response = await bitvavo.cancelOrder('BTC-EUR', '99e9a45b-26c8-4079-9da2-f0f42e008edb')
console.log(response)
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{ orderId: 'bb4076a3-d7b6-4bf6-aa35-b12f14fcb092' }
```
</details>
#### Get orders
Returns the same as get order, but can be used to return multiple orders at once.
```javascript
// Function with callback
// options: limit, start, end, orderIdFrom, orderIdTo
bitvavo.getOrders('BTC-EUR', {}, (error, response) => {
if (error === null) {
for (let entry of response) {
console.log(entry)
}
} else {
console.log(error)
}
})
// Function with promise
// options: limit, start, end, orderIdFrom, orderIdTo
try {
let response = await bitvavo.getOrders('BTC-EUR', {})
for (let entry of response) {
console.log(entry)
}
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
[
{
orderId: '6a57e514-60aa-4a91-8958-5e70fa5c0ed3',
market: 'BTC-EUR',
created: 1548668202114,
updated: 1548668368746,
status: 'new',
side: 'buy',
orderType: 'limit',
amount: '0.5',
amountRemaining: '0.5',
price: '3000',
onHold: '1503.75',
onHoldCurrency: 'EUR',
filledAmount: '0',
filledAmountQuote: '0',
feePaid: '0',
feeCurrency: 'EUR',
fills: [],
selfTradePrevention: 'decrementAndCancel',
visible: true,
timeInForce: 'GTC',
postOnly: false,
clientOrderId: '0fc09a0a-ac77-4923-a06b-68b5c23fe6ec'
},
{
orderId: 'b8c6c4d1-eb8c-4b24-83e1-fcced3df168d',
market: 'BTC-EUR',
created: 1548666712066,
updated: 1548666712066,
status: 'filled',
side: 'buy',
orderType: 'limit',
amount: '0.1',
amountRemaining: '0',
price: '4000',
onHold: '0',
onHoldCurrency: 'EUR',
filledAmount: '0.1',
filledAmountQuote: '400',
feePaid: '1',
feeCurrency: 'EUR',
fills: [ [Object] ],
selfTradePrevention: 'decrementAndCancel',
visible: true,
timeInForce: 'GTC',
postOnly: false,
clientOrderId: 'f1ea3b4c-a23c-4913-83b2-3c4756a3078a'
},
{
orderId: '198a85ce-1cb2-44b9-acb1-6cb9a1dde555',
market: 'BTC-EUR',
created: 1548666514216,
updated: 1548666514216,
status: 'filled',
side: 'buy',
orderType: 'limit',
amount: '0.1',
amountRemaining: '0',
price: '4000',
onHold: '0',
onHoldCurrency: 'EUR',
filledAmount: '0.1',
filledAmountQuote: '400',
feePaid: '0.8',
feeCurrency: 'EUR',
fills: [ [Object] ],
selfTradePrevention: 'decrementAndCancel',
visible: true,
timeInForce: 'GTC',
postOnly: false,
clientOrderId: 'f08242ea-7bbb-441f-acae-20f0a3d11ffe'
},
{
orderId: 'e68dd35c-156b-4f50-92d8-ff24623fba03',
market: 'BTC-EUR',
created: 1548666373398,
updated: 1548666373398,
status: 'filled',
side: 'buy',
orderType: 'limit',
amount: '0.1',
amountRemaining: '0',
price: '4000',
onHold: '0',
onHoldCurrency: 'EUR',
filledAmount: '0.1',
filledAmountQuote: '400',
feePaid: '1',
feeCurrency: 'EUR',
fills: [ [Object] ],
selfTradePrevention: 'decrementAndCancel',
visible: true,
timeInForce: 'GTC',
postOnly: false,
clientOrderId: '2fc50e19-e164-4613-b49f-70b8953b1fe6'
}
...
]
```
</details>
#### Cancel orders
Cancels all orders in a market. If no market is specified, all orders of an account will be canceled.
```javascript
// Function with callback
// options: market
bitvavo.cancelOrders({}, (error, response) => {
if (error === null) {
for (let entry of response) {
console.log(entry)
}
} else {
console.log(error)
}
})
// Function with promise
// options: market
try {
let response = await bitvavo.cancelOrders({})
for (let entry of response) {
console.log(entry)
}
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{ orderId: '7e7a20ce-44f2-401c-aaca-64f36e6f3e09' }
{ orderId: '35f17a0c-3344-452c-b348-20f3424574b8' }
...
```
</details>
#### Get orders open
Returns all orders which are not filled or canceled.
```javascript
// Function with callback
// options: market
bitvavo.ordersOpen({}, (error, response) => {
if (error === null) {
for (let entry of response) {
console.log(entry)
}
} else {
console.log(error)
}
})
// Function with promise
// options: market
try {
let response = await bitvavo.ordersOpen({})
for (let entry of response) {
console.log(entry)
}
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
[
{ orderId: '6a57e514-60aa-4a91-8958-5e70fa5c0ed3',
market: 'BTC-EUR',
created: 1548668202114,
updated: 1548668368746,
status: 'new',
side: 'buy',
orderType: 'limit',
amount: '0.5',
amountRemaining: '0.5',
price: '3000',
onHold: '1503.75',
onHoldCurrency: 'EUR',
filledAmount: '0',
filledAmountQuote: '0',
feePaid: '0',
feeCurrency: 'EUR',
fills: [],
selfTradePrevention: 'decrementAndCancel',
visible: true,
timeInForce: 'GTC',
postOnly: false },
{ orderId: '96cd3157-a6cb-4d7f-9a1d-8041c29dc982',
market: 'BTC-EUR',
created: 1545216249448,
updated: 1545216249448,
status: 'new',
side: 'buy',
orderType: 'limit',
amount: '0.1',
amountRemaining: '0.1',
price: '2900',
onHold: '290.73',
onHoldCurrency: 'EUR',
filledAmount: '0',
filledAmountQuote: '0',
feePaid: '0',
feeCurrency: 'EUR',
fills: [],
selfTradePrevention: 'decrementAndCancel',
visible: true,
timeInForce: 'GTC',
postOnly: false },
...
]
```
</details>
#### Get trades
Returns all trades within a market for this account.
```javascript
// Function with callback
// options: limit, start, end, tradeIdFrom, tradeIdTo
bitvavo.trades('LTC-EUR', {}, (error, response) => {
if (error === null) {
for (let entry of response) {
console.log(entry)
}
} else {
console.log(error)
}
})
// Function with promise
// options: limit, start, end, tradeIdFrom, tradeIdTo
try {
let response = await bitvavo.trades('BTC-EUR', {})
for (let entry of response) {
console.log(entry)
}
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
[
{
id: '79e4bf2f-4fac-4895-9bb2-a5c9c6e2ff3f',
timestamp: 1548666712071,
market: 'BTC-EUR',
side: 'buy',
amount: '0.1',
price: '4000',
taker: true,
fee: '1',
feeCurrency: 'EUR',
settled: true,
clientOrderId: '13351170-21d0-4855-ae1e-d71c0cb2828e'
},
{
id: '102486d3-5b72-4fa2-89cf-84c934edb7ae',
timestamp: 1548666561486,
market: 'BTC-EUR',
side: 'buy',
amount: '0.1',
price: '4000',
taker: false,
fee: '0.8',
feeCurrency: 'EUR',
settled: true,
clientOrderId: 'ae0bb95e-4862-4318-88c5-bd0d2b69566b'
},
{
id: '965facc7-b3c3-43d0-8a1d-30a2f782ee17',
timestamp: 1548666373407,
market: 'BTC-EUR',
side: 'buy',
amount: '0.1',
price: '4000',
taker: true,
fee: '1',
feeCurrency: 'EUR',
settled: true,
clientOrderId: 'd750696b-5843-48ad-9d29-5b60ff67c142'
},
...
]
```
</details>
#### Get account
Returns the fee tier for this account.
```javascript
// Function with callback
bitvavo.account((error, response) => {
if (error == null) {
console.log(response)
} else {
console.log(error)
}
})
// Function with promise
try {
let response = await bitvavo.account()
console.log(response)
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{
fees: {
taker: '0.0025'
maker: '0.0015'
volume: '100.00'
}
}
```
</details>
#### Get balance
Returns the balance for this account.
```javascript
// Function with callback
// options: symbol
bitvavo.balance({}, (error, response) => {
if (error == null) {
for (let entry of response) {
console.log(response)
}
} else {
console.log(error)
}
})
// Function with promise
// options: symbol
try {
let response = await bitvavo.balance({})
for (let entry of response) {
console.log(entry)
}
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{ symbol: 'EUR', available: '1179.28', inOrder: '17738.27' }
{ symbol: 'BTC', available: '3.99704969', inOrder: '0' }
{ symbol: 'ADA', available: '123.1', inOrder: '0' }
{ symbol: 'BCH', available: '3.99704969', inOrder: '0' }
{ symbol: 'BSV', available: '3.99704969', inOrder: '0' }
{ symbol: 'DASH', available: '53', inOrder: '0' }
{ symbol: 'EOS', available: '79.267', inOrder: '1.3562' }
{ symbol: 'ETH', available: '45.435', inOrder: '0' }
{ symbol: 'LTC', available: '10', inOrder: '0' }
{ symbol: 'NEO', available: '243.4', inOrder: '0' }
{ symbol: 'QTUM', available: '13', inOrder: '0' }
{ symbol: 'TRX', available: '45', inOrder: '0' }
{ symbol: 'XEM', available: '34.43', inOrder: '0' }
{ symbol: 'XLM', available: '324', inOrder: '0' }
...
```
</details>
#### Deposit assets
Returns the address which can be used to deposit funds.
```javascript
// Function with callback
bitvavo.depositAssets('BTC', (error, response) => {
if (error == null) {
console.log(response)
} else {
console.log(error)
}
})
// Function with promise
try {
let response = await bitvavo.depositAssets('BTC')
console.log(response)
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{ address: 'BitcoinAddress'}
```
</details>
#### Withdraw Assets
Can be used to withdraw funds from Bitvavo.
```javascript
// Function with callback
// Optional parameters: paymentId, internal, addWithdrawalFee
bitvavo.withdrawAssets('BTC', 1, 'BitcoinAddress', {}, (error, response) => {
if (error == null) {
console.log(response)
} else {
console.log(error)
}
})
// Function with promise
// Optional parameters: paymentId, internal, addWithdrawalFee
try {
let response = await bitvavo.withdrawAssets('BTC', 1, 'BitcoinAddress', {})
console.log(response)
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{ success: true, symbol: 'BTC', amount: '1' }
```
</details>
#### Get deposit history
Returns the deposit history of your account.
```javascript
// Function with callback
// options: symbol, limit, start, end
bitvavo.depositHistory({}, (error, response) => {
if (error == null) {
for (let entry of response) {
console.log(entry)
}
} else {
console.log(error)
}
})
// Function with promise
// options: symbol, limit, start, end
try {
let response = await bitvavo.depositHistory({})
for (let entry of response) {
console.log(entry)
}
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{ timestamp: 1545226978000,
symbol: 'BTC',
amount: '1.35',
address: '',
paymentId: '',
txId: '387a2cd34ac0dcaf0b63d374e703e227f39984808d52951c81283f23ea107088',
fee: '0',
status: 'completed' }
{ timestamp: 1545226940000,
symbol: 'XRP',
amount: '121.11',
address: '',
paymentId: '',
txId: 'EAB486A626819D87C848AA46F6B0B3C4B944D0304F5C7FA6D7D31DBDD7C662EA',
fee: '0',
status: 'completed' }
...
```
</details>
#### Get withdrawal history
Returns the withdrawal history of an account.
```javascript
// Function with callback
// options: symbol, limit, start, end
bitvavo.withdrawalHistory({}, (error, response) => {
if (error == null) {
for (let entry of response) {
console.log(entry)
}
} else {
console.log(error)
}
})
// Function with promise
// options: symbol, limit, start, end
try {
let response = await bitvavo.withdrawalHistory({})
for (let entry of response) {
console.log(entry)
}
} catch (error) {
console.log(error)
}
```
<details>
<summary>View Response</summary>
```javascript
{ timestamp: 1543485186000,
symbol: 'BTC',
amount: '0.99994',
address: 'BitcoinAddress',
paymentId: '',
txId: '',
fee: '0.00006',
status: 'awaiting_processing' }
{ timestamp: 1543485186000,
symbol: 'BTC',
amount: '1.99994',
address: 'BitcoinAddress',
paymentId: '',
txId: '',
fee: '0.00006',
status: 'awaiting_processing' }
{ timestamp: 1543485176000,
symbol: 'BTC',
amount: '1.99994',
address: 'BitcoinAddress',
paymentId: '',
txId: '',
fee: '0.00006',
status: 'awaiting_processing' }
{ timestamp: 1543485175000,
symbol: 'BTC',
amount: '0.99994',
address: 'BitcoinAddress',
paymentId: '',
txId: '',
fee: '0.00006',
status: 'awaiting_processing' }
{ timestamp: 1543400914000,
symbol: 'BTC',
amount: '0.99994',
address: 'BitcoinAddress',
paymentId: '',
txId: '',
fee: '0.00006',
status: 'awaiting_processing' }
...
```
</details>
## WebSocket
All requests which can be done through REST requests can also be performed over WebSocket. Bitvavo also provides six [subscriptions](#subscriptions). If subscribed to these, updates specific for that type/market are pushed immediately.
### Getting started
It is not necessary to initialise the WebSocket through a function, it will automatically be initialized once you call a function of the WebSocket class. The first thing you should do is set the error [emitter](https://nodejs.org/api/events.html#events_class_eventemitter). To receive responses on the WebSocket the emitter should also be set per called function. The emitter is initialized automatically and can be retrieved through the `bitvavo.getEmitter()` function. After which you should set the emitter key to the function name (camelCase). This means that if you call the time function, the emitter should be set in the following manner:
```javascript
let emitter = bitvavo.getEmitter()
emitter.on('error', (response) => {
console.log('Handle errors here', response)
})
emitter.on('time', (response) => {
console.log('Handle your response here', response)
})
bitvavo.WebSocket.time()
```
The api key and secret are copied from the bitvavo object. Therefore if you want to use the private portion of the WebSocket API, you should set both the key and secret as specified in [REST requests](#rest-requests).
### requestId
It is possible to include a numeric `requestId` in the request to uniquely identify it, and this ID will always be returned in the response, even in case of errors.
### Public
#### Get time
```javascript
bitvavo.getEmitter().on('time', (response) => {
console.log(response)
})
bitvavo.websocket.time()
```
<details>
<summary>View Response</summary>
```javascript
{ time: 1543478503490 }
```
</details>
#### Get markets
```javascript
bitvavo.getEmitter().on('markets', (response) => {
for (let entry of response) {
console.log(entry)
}
})
// options: market
bitvavo.websocket.markets({})
```
<details>
<summary>View Response</summary>
```javascript
{ market: 'ADA-BTC',
status: 'trading',
base: 'ADA',
quote: 'BTC',
pricePrecision: 5,
minOrderInBaseAsset: '100',
minOrderInQuoteAsset: '0.001',
orderTypes: [ 'market', 'limit' ] }
{ market: 'ADA-EUR',
status: 'trading',
base: 'ADA',
quote: 'EUR',
pricePrecision: 5,
minOrderInBaseAsset: '100',
minOrderInQuoteAsset: '10',
orderTypes: [ 'market', 'limit' ] }
{ market: 'AE-BTC',
status: 'trading',
base: 'AE',
quote: 'BTC',
pricePrecision: 5,
minOrderInBaseAsset: '10',
minOrderInQuoteAsset: '0.001',
orderTypes: [ 'market', 'limit' ] }
{ market: 'AE-EUR',
status: 'trading',
base: 'AE',
quote: 'EUR',
pricePrecision: 5,
minOrderInBaseAsset: '10',
minOrderInQuoteAsset: '10',
orderTypes: [ 'market', 'limit' ] }
{ market: 'AION-BTC',
status: 'trading',
base: 'AION',
quote: 'BTC',
pricePrecision: 5,
minOrderInBaseAsset: '30',
minOrderInQuoteAsset: '0.001',
orderTypes: [ 'market', 'limit' ] }
...
```
</details>
#### Get assets
```javascript
bitvavo.getEmitter().on('assets', (response) => {
for (let entry of response) {
console.log(entry)
}
})
// options: symbol
bitvavo.websocket.assets({})
```
<details>
<summary>View Response</summary>
```javascript
{ symbol: 'ADA',
name: 'Cardano',
decimals: 6,
depositFee: '0',
depositConfirmations: 0,
depositStatus: 'OK',
withdrawalFee: '0.2',
withdrawalMinAmount: '0.2',
withdrawalStatus: 'OK',
networks: [
'Mainnet'
],
message: '' }
{ symbol: 'BAT',
name: 'Basic Attention Token',
decimals: 8,
depositFee: '0',
depositConfirmations: 0,
depositStatus: 'OK',
withdrawalFee: '7',
withdrawalMinAmount: '7',
withdrawalStatus: 'OK',
networks: [
'Mainnet'
],
message: '' }
{ symbol: 'BCH',
name: 'Bitcoin Cash',
decimals: 8,
depositFee: '0',
depositConfirmations: 0,
depositStatus: 'OK',
withdrawalFee: '0.0001',
withdrawalMinAmount: '0.00001',
withdrawalStatus: 'OK',
networks: [
'Mainnet'
],
message: '' }
{ symbol: 'BTC',
name: 'Bitcoin',
decimals: 8,
depositFee: '0',
depositConfirmations: 0,
depositStatus: 'OK',
withdrawalFee: '0.00006',
withdrawalMinAmount: '0.00001',
withdrawalStatus: 'OK',
networks: [
'Mainnet'
],
message: '' }
...
```
</details>
#### Get book per market
```javascript
bitvavo.getEmitter().on('book', (response) => {
console.log(response)
})
// options: depth
bitvavo.websocket.book('BTC-EUR', {})
```
<details>
<summary>View Response</summary>
```javascript
{ market: 'BTC-EUR',
nonce: 39785,
bids:
[ [ '3304', '0.00303' ],
[ '3297.2', '0.0030344' ],
[ '3290.2', '0.00304085' ],
[ '3283.9', '0.00304669' ],
[ '3277.6', '0.00305254' ],
[ '3269.5', '0.00306011' ],
[ '3262.9', '0.0030663' ],
[ '3256.5', '0.00307232' ],
[ '3249.7', '0.00307875' ],
[ '3243', '0.00308511' ],
[ '3236.4', '0.0030914' ],
[ '3229.8', '0.00309772' ],
[ '3224.1', '0.0031032' ],
[ '3217.5', '0.00310956' ],
[ '3210', '0.00311683' ],
[ '3203.4', '0.00312325' ],
[ '3197.7', '0.00312882' ],
[ '3186.3', '0.00314001' ],
[ '3182.3', '0.00314396' ],
[ '3177.7', '0.00314851' ],
[ '3166.6', '0.00315955' ],
[ '3160', '0.00316614' ],
[ '3153.4', '0.00317277' ],
[ '3146.8', '0.00317943' ],
[ '3138.7', '0.00318763' ] ],
asks:
[ [ '3310.7', '0.00302503' ],
[ '3317.4', '0.00302494' ],
[ '3324.1', '0.00302494' ],
[ '3330.7', '0.00302494' ],
[ '3337.3', '0.00302494' ],
[ '3343.9', '0.00302494' ],
[ '3350.5', '0.00302494' ],
[ '3357.1', '0.00302503' ],
[ '3366.3', '0.00302266' ],
[ '3372.9', '0.00302266' ],
[ '3379.6', '0.00302266' ],
[ '3386.2', '0.00302266' ],
[ '3392.8', '0.00302266' ],
[ '3399.5', '0.00302266' ],
[ '3401.3', '0.00302687' ],
[ '3408', '0.00302687' ],
[ '3414.4', '0.00302705' ],
[ '3420.8', '0.00302723' ],
[ '3427', '0.0030276' ],
[ '3433.3', '0.00302787' ],
[ '3439.1', '0.00302861' ],
[ '3445.7', '0.00302861' ],
[ '3451.9', '0.00302897' ],
[ '3458.2', '0.00302925' ],
[ '3464.3', '0.00302971' ],
[ '3500.1', '0.002032' ] ] }
```
</details>
#### Get trades per market
```javascript
bitvavo.getEmitter().on('publicTrades', (response) => {
for (let entry of response) {
console.log(entry)
}
})
// options: limit, start, end, tradeIdFrom, tradeIdTo
bitvavo.websocket.publicTrades('BTC-EUR', {})
```
<details>
<summary>View Response</summary>
```javascript
{ id: '5400feff-54b8-40a3-90d4-5f0f68f28c25',
timestamp: 1545213249947,
amount: '0.001',
price: '3500.1',
side: 'buy' }
{ id: '0294c35a-c2d3-41b3-9f6d-759312c51e8d',
timestamp: 1545213234550,
amount: '0.003039',
price: '3453.7',
side: 'buy' }
{ id: '3501ca58-3980-4797-bccc-70fd58405c96',
timestamp: 1545213234535,
amount: '0.003039',
price: '3447.1',
side: 'buy' }
{ id: '6ac6944d-870c-466d-bec3-f03d1cc43409',
timestamp: 1545213234521,
amount: '0.00303191',
price: '3441.9',
side: 'buy' }
{ id: 'f79a2d5d-4839-4191-b0b3-65044bb4861d',
timestamp: 1545213234508,
amount: '0.003039',
price: '3440.5',
side: 'buy' }
{ id: '8a5cf6c5-d802-4f05-a6bc-63e0ad79423a',
timestamp: 1545213234491,
amount: '0.00303568',
price: '3431.1',
side: 'buy' }
{ id: '896c451f-a5f2-4b77-80d0-5b095a90d139',
timestamp: 1545213234479,
amount: '0.00303568',
price: '3424.5',
side: 'buy' }
{ id: '300bc05a-f63a-4ad2-ba87-b7b3900a4ed9',
timestamp: 1545213234458,
amount: '0.00303375',
price: '3420',
side: 'buy' }
...
```
</details>
#### Get candles per market
```javascript
bitvavo.getEmitter().on('candles', (response) => {
for (let entry of response) {
console.log(entry)
}
})
// options: limit, start, end
bitvavo.websocket.candles('BTC-EUR', '1h', {})
```
<details>
<summary>View Response</summary>
```javascript
[ 1545210000000, '3308.2', '3500.1', '3308.2', '3500.1', '0.07684055' ]
[ 1545138000000, '3158.2', '3199.6', '3158.2', '3199.6', '0.02477561' ]
[ 1545134400000, '3154.8', '3158.2', '3154.8', '3158.2', '0.003' ]
[ 1545130800000, '3154.8', '3154.8', '3154.8', '3154.8', '0.001' ]
[ 1545210000000, '3308.2', '3500.1', '3308.2', '3500.1', '0.07684055' ]
[ 1545138000000, '3158.2', '3199.6', '3158.2', '3199.6', '0.02477561' ]
[ 1545134400000, '3154.8', '3158.2', '3154.8', '3158.2', '0.003' ]
[ 1545130800000, '3154.8', '3154.8', '3154.8', '3154.8', '0.001' ]
...
```
</details>
#### Get price ticker
```javascript
bitvavo.getEmitter().on('tickerPrice', (response) => {
for (let entry of response) {
console.log(entry)
}
})
// options: market
bitvavo.websocket.tickerPrice({})
```
<details>
<summary>View Response</summary>
```javascript
{ market: 'XRP-BTC', price: '0.000097983' }
{ market: 'MIOTA-BTC', price: '0.000078189' }
{ market: 'LSK-BTC', price: '0.00034486' }
{ market: 'BCH-EUR', price: '102.1' }
{ market: 'XRP-EUR', price: '0.32418' }
{ market: 'AE-BTC', price: '0.00011033' }
{ market: 'AION-BTC', price: '0.000034426' }
{ market: 'ANT-BTC', price: '0.00011455' }
{ market: 'ARK-BTC', price: '0.00009624' }
{ market: 'BAT-BTC', price: '0.000037708' }
{ market: 'BTC-EUR', price: '3500.1' }
{ market: 'CMT-BTC', price: '0.000006695' }
{ market: 'DCR-BTC', price: '0.0048841' }
{ market: 'DGB-BTC', price: '0.0000030977' }
{ market: 'ELF-EUR', price: '0.10219' }
{ market: 'EOS-BTC', price: '0.00068749' }
{ market: 'ETC-BTC', price: '0.0011361' }
{ market: 'ETH-BTC', price: '0.027504' }
{ market: 'GAS-BTC', price: '0.0005364' }
{ market: 'GNT-BTC', price: '0.000018384' }
{ market: 'ICX-EUR', price: '0.17683' }
{ market: 'LRC-BTC', price: '0.000011178' }
{ market: 'LTC-EUR', price: '24.622' }
{ market: 'NANO-BTC', price: '0.00025949' }
{ market: 'NAS-EUR', price: '0.46102' }
{ market: 'NEO-BTC', price: '0.0018661' }
{ market: 'NEO-EUR', price: '5.6134' }
{ market: 'OMG-BTC', price: '0.000365' }
{ market: 'ONT-BTC', price: '0.00018014' }
{ market: 'ONT-EUR', price: '0.48529' }
{ market: 'POWR-BTC', price: '0.000020786' }
{ market: 'POWR-EUR', price: '0.068639' }
{ market: 'QTUM-EUR', price: '1.9927' }
{ market: 'RDD-EUR', price: '0.0011917' }
...
```
</details>
#### Get book ticker
```javascript
bitvavo.getEmitter().on('tickerBook', (response) => {
for (let entry of response) {
console.log(entry)
}
})
// options: market
bitvavo.websocket.tickerBook({})
```
<details>
<summary>View Response</summary>
```javascript
{ market: 'XVG-BTC',
bid: '0.00000043',
ask: '0.00000044',
bidSize: '20520.72555668',
askSize: '28577.12228909' }
{ market: 'XVG-EUR',
bid: '0.0043516',
ask: '0.0044561',
bidSize: '1560387.75456382',
askSize: '1456319.40904593' }
{ market: 'ZIL-BTC',
bid: '0.00000081',
ask: '0.00000082',
bidSize: '13992.6485724',
askSize: '5737.46205762' }
{ market: 'ZIL-EUR',
bid: '0.0081972',
ask: '0.0083046',
bidSize: '19825.02546306',
askSize: '19039.17428288' }
{ market: 'ZRX-BTC',
bid: '0.000016184',
ask: '0.000016215',
bidSize: '827.21868459',
askSize: '872.2554613' }
{ market: 'ZRX-EUR',
bid: '0.16378',
ask: '0.16417',
bidSize: '901.91558201',
askSize: '420.84088941' }
...
```
</details>
#### Get 24 hour ticker
```javascript
bitvavo.getEmitter().on('ticker24h', (response) =