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. Every function available on the API can be called through a REST request or over WebSocket.

Prerequisites
Install
Getting started REST WebSocket
General
- Time REST WebSocket
- Markets REST WebSocket
- Assets REST WebSocket
Market Data
- Book REST WebSocket
- Public Trades REST WebSocket
- Candles REST WebSocket
- Price Ticker REST WebSocket
- Book Ticker REST WebSocket
- 24 Hour Ticker REST WebSocket
Private
- Place Order REST WebSocket
- Update Order REST WebSocket
- Get Order REST WebSocket
- Cancel Order REST WebSocket
- Get Orders REST WebSocket
- Cancel Orders REST WebSocket
- Orders Open REST WebSocket
- Trades REST WebSocket
- Account REST WebSocket
- Balance REST WebSocket
- Deposit Assets REST WebSocket
- Withdraw Assets REST WebSocket
- Deposit History REST WebSocket
- Withdrawal History REST WebSocket
Subscriptions

Prerequisites

To start programming with Bitvavo SDK for Node.js you need:

Node.js installed on your development device
A Node app. Use your favorite IDE, or run from the command line
An API key and secret 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 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 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 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.

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 and with callbacks. This means that the following two functions have the same effect.

// 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

// 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)
}

View Response

{ time: 1543478503490 }

Get markets

// 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)
}

View Response

{ 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' ] }
  ...

Get assets

// 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)
}

View Response

{ 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: '' }
  ...

Market Data

Get book per market

// 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)
}

View Response

{ 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' ] ] }

Get trades per market

// 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)
}

View Response

{ 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' }
  ...

Get candles per market

// 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]

View Response

[ 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' ]
 ...

Get price ticker

// 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)
}

View Response

{ 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' }
...

Get book ticker

// 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)
}

View Response

{ 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' }
...

Get 24 hour ticker

// 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)
}

View Response

{ 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 }
...

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.

// 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)
}

View Response

{
  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'
}

Update order

When updating an order make sure that at least one of the optional parameters has been set. Otherwise nothing can be updated.

// 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)
}

View Response

{ 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 }

Get order

// 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);
}

View Response

{
  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'
}

Cancel order

// 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)
}

View Response

{ orderId: 'bb4076a3-d7b6-4bf6-aa35-b12f14fcb092' }

Get orders

Returns the same as get order, but can be used to return multiple orders at once.

// 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)
}

View Response

[
  {
    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'
  }
    ...
]

Cancel orders

Cancels all orders in a market. If no market is specified, all orders of an account will be canceled.

// 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)
}

View Response

{ orderId: '7e7a20ce-44f2-401c-aaca-64f36e6f3e09' }
{ orderId: '35f17a0c-3344-452c-b348-20f3424574b8' }
...

Get orders open

Returns all orders which are not filled or canceled.

// 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)
}

View Response

[ 
  { 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 },
    ...
]

Get trades

Returns all trades within a market for this account.

// 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)
}

View Response

[ 
  {
    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'
  },
  ...
]

Get account

Returns the fee tier for this account.

// 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)
}

View Response

{
  fees: {
    taker: '0.0025'
    maker: '0.0015'
    volume: '100.00'
  }
}

Get balance

Returns the balance for this account.

// 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)
}

View Response

{ 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' }
...

Deposit assets

Returns the address which can be used to deposit funds.

// 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)
}

View Response

{ address: 'BitcoinAddress'}

Withdraw Assets

Can be used to withdraw funds from Bitvavo.

// 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)
}

View Response

{ success: true, symbol: 'BTC', amount: '1' }

Get deposit history

Returns the deposit history of your account.

// 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)
}

View Response

{ 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' }
  ...

Get withdrawal history

Returns the withdrawal history of an account.

// 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)
}

View Response

{ 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' }
  ...

WebSocket

All requests which can be done through REST requests can also be performed over WebSocket. Bitvavo also provides six 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. 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:

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.

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

bitvavo.getEmitter().on('time', (response) => {
  console.log(response)
})

bitvavo.websocket.time()

View Response

{ time: 1543478503490 }

Get markets

bitvavo.getEmitter().on('markets', (response) => {
  for (let entry of response) {
    console.log(entry)
  }
})

// options: market
bitvavo.websocket.markets({})

View Response

{ 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' ] }
  ...

Get assets

bitvavo.getEmitter().on('assets', (response) => {
  for (let entry of response) {
    console.log(entry)
  }
})

// options: symbol
bitvavo.websocket.assets({})

View Response

{ 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: '' }
  ...

Get book per market

bitvavo.getEmitter().on('book', (response) => {
  console.log(response)
})

// options: depth
bitvavo.websocket.book('BTC-EUR', {})

View Response

{ 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' ] ] }

Get trades per market

bitvavo.getEmitter().on('publicTrades', (response) => {
  for (let entry of response) {
    console.log(entry)
  }
})

// options: limit, start, end, tradeIdFrom, tradeIdTo
bitvavo.websocket.publicTrades('BTC-EUR', {})

View Response

{ 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' }
  ...

Get candles per market

bitvavo.getEmitter().on('candles', (response) => {
  for (let entry of response) {
    console.log(entry)
  }
})

// options: limit, start, end
bitvavo.websocket.candles('BTC-EUR', '1h', {})

View Response

[ 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' ]
 ...

Get price ticker

bitvavo.getEmitter().on('tickerPrice', (response) => {
  for (let entry of response) {
    console.log(entry)
  }
})

// options: market
bitvavo.websocket.tickerPrice({})

View Response

{ 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' }
...

Get book ticker

bitvavo.getEmitter().on('tickerBook', (response) => {
  for (let entry of response) {
    console.log(entry)
  }
})

// options: market
bitvavo.websocket.tickerBook({})

View Response

{ 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' }
...

Get 24 hour ticker

bitvavo.getEmitter().on('ticker24h', (response) => {
  for (let entry of response) {
    console.log(entry)
  }
})

// options: market
bitvavo.websocket.ticker24h({})

View Response

{ 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 }
...

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.

bitvavo.getEmitter().on('placeOrder', (response) => {
  console.log(response)
})

// 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.websocket.placeOrder('BTC-EUR', 'buy', 'limit', { amount: 0.1, price: 5000 })

View Response

{ orderId: 'bb4076a3-d7b6-4bf6-aa35-b12f14fcb092',
  market: 'BTC-EUR',
  created: 1543482451221,
  updated: 1543482451221,
  status: 'new',
  side: 'sell',
  orderType: 'limit',
  amount: '0.1',
  price: '5000',
  onHold: '0.1',
  onHoldCurrency: 'BTC',
  filledAmount: '0',
  filledPrice: '0',
  feePaid: '0',
  feeCurrency: 'EUR',
  fills: [],
  selfTradePrevention: 'decrementAndCancel',
  visible: true,
  timeInForce: 'GTC',
  postOnly: false }

Update order

When updating an order make sure that at least one of the optional parameters has been set. Otherwise nothing can be updated.

bitvavo.getEmitter().on('updateOrder', (response) => {
  console.log(response)
})

// 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.websocket.updateOrder('BTC-EUR', 'bb4076a3-d7b6-4bf6-aa35-b12f14fcb092', { amount: '0.2' })

View Response

{ orderId: 'bb4076a3-d7b6-4bf6-aa35-b12f14fcb092',
  market: 'BTC-EUR',
  created: 1543482451221,
  updated: 1543482646215,
  status: 'new',
  side: 'sell',
  orderType: 'limit',
  amount: '0.2',
  price: '5000',
  onHold: '0.2',
  onHoldCurrency: 'BTC',
  filledAmount: '0',
  filledPrice: '0',
  feePaid: '0',
  feeCurrency: 'EUR',
  fills: [],
  selfTradePrevention: 'decrementAndCancel',
  visible: true,
  timeInForce: 'GTC',
  postOnly: false }

Get order

bitvavo.getEmitter().on('getOrder', (response) => {
  console.log(response)
})

// Optional parameters: orderId, clientOrderId
bitvavo.websocket.getOrder('BTC-EUR', { clientOrderId: '2fc50e19-e164-4613-b49f-70b8953b1fe6' })

View Response

{
  orderId: 'bb4076a3-d7b6-4bf6-aa35-b12f14fcb092',
  market: 'BTC-EUR',
  created: 1543482451221,
  updated: 1543482646215,
  status: 'new',
  side: 'sell',
  orderType: 'limit',
  amount: '0.2',
  price: '5000',
  onHold: '0.2',
  onHoldCurrency: 'BTC',
  filledAmount: '0',
  filledPrice: '0',
  feePaid: '0',
  feeCurrency: 'EUR',
  fills: [],
  selfTradePrevention: 'decrementAndCancel',
  visible: true,
  timeInForce: 'GTC',
  postOnly: false,
  clientOrderId: '2fc50e19-e164-4613-b49f-70b8953b1fe6'
}

Cancel order

bitvavo.getEmitter().on('cancelOrder', (response) => {
  console.log(response)
})

bitvavo.websocket.cancelOrder('BTC-EUR', 'bb4076a3-d7b6-4bf6-aa35-b12f14fcb092')

View Response

{ orderId: 'bb4076a3-d7b6-4bf6-aa35-b12f14fcb092' }

Get orders

Returns the same as get order, but can be used to return multiple orders at once.

bitvavo.getEmitter().on('getOrders', (response) => {
  for (let entry of response) {
    console.log(entry)
  }
})

// options: limit, start, end, orderIdFrom, orderIdTo
bitvavo.websocket.getOrders('BTC-EUR', {})

View Response

{
  orderId: '99e9a45b-26c8-4079-9da2-f0f42e008edb',
  market: 'BTC-EUR',
  created: 1543482451253,
  updated: 1543482902905,
  status: 'canceled',
  side: 'sell',
  orderType: 'limit',
  amount: '0.1',
  price: '5000',
  onHold: '0',
  onHoldCurrency: 'BTC',
  filledAmount: '0',
  filledPrice: '0',
  feePaid: '0',
  feeCurrency: 'EUR',
  fills: [],
  selfTradePrevention: 'decrementAndCancel',
  visible: false,
  timeInForce: 'GTC',
  postOnly: false,
  clientOrderId: '2fc50e19-e164-4613-b49f-70b8953b1fe6'
},
{
  orderId: 'bb4076a3-d7b6-4bf6-aa35-b12f14fcb092',
  market: 'BTC-EUR',
  created: 1543482451221,
  updated: 1543482902930,
  status: 'canceled',
  side: 'sell',
  orderType: 'limit',
  amount: '0.2',
  price: '5000',
  onHold: '0',
  onHoldCurrency: 'BTC',
  filledAmount: '0',
  filledPrice: '0',
  feePaid: '0',
  feeCurrency: 'EUR',
  fills: [],
  selfTradePrevention: 'decrementAndCancel',
  visible: false,
  timeInForce: 'GTC',
  postOnly: false,
  clientOrderId: '8e6c4a2b-d55b-42d7-94f6-3a6b88295c8e'
},
{
  orderId: 'baf3eca0-36c1-41c9-b21f-8f46e45f9ff5',
  market: 'BTC-EUR',
  created: 1543229981645,
  updated: 1543229993276,
  status: 'canceled',
  side: 'sell',
  orderType: 'limit',
  amount: '0.1',
  price: '5000',
  onHold: '0',
  onHoldCurrency: 'BTC',
  filledAmount: '0',
  filledPrice: '0',
  feePaid: '0',
  feeCurrency: 'EUR',
  fills: [],
  selfTradePrevention: 'decrementAndCancel',
  visible: false,
  timeInForce: 'GTC',
  postOnly: false,
  clientOrderId: 'e4c66a7f-ec6e-4ba9-86bc-af3a7a735c09'
},
  ...

Cancel orders

Cancels all orders in a market. If no market is specified, all orders of an account will be canceled.

bitvavo.getEmitter().on('cancelOrders', (response) => {
  for (let entry of response) {
    console.log(entry)
  }
})

// options: market
bitvavo.websocket.cancelOrders({})

View Response

{ orderId: '7e7a20ce-44f2-401c-aaca-64f36e6f3e09' }
{ orderId: '35f17a0c-3344-452c-b348-20f3424574b8' }
...

Get orders open

Returns all orders which are not filled or canceled.

bitvavo.getEmitter().on('ordersOpen', (response) => {
  for (let entry of response) {
    console.log(entry)
  }
})

// options: market
bitvavo.websocket.ordersOpen({})

View Response

[{
  orderId: '96cd3157-a6cb-4d7f-9a1d-8041c29dc982',
  market: 'BTC-EUR',
  created: 1545216249448,
  updated: 1545216249448,
  status: 'new',
  side: 'buy',
  orderType: 'limit',
  amount: '0.1',
  price: '2900',
  onHold: '290.73',
  onHoldCurrency: 'EUR',
  filledAmount: '0',
  filledPrice: '0',
  feePaid: '0',
  feeCurrency: 'EUR',
  fills: [],
  selfTradePrevention: 'decrementAndCancel',
  visible: true,
  timeInForce: 'GTC',
  postOnly: false,
  clientOrderId: 'e4c66a7f-ec6e-4ba9-86bc-af3a7a735c09'
},
{
  orderId: 'd74440fa-f5d2-48f6-b279-933d84442a8e',
  market: 'BTC-EUR',
  created: 1545216266588,
  updated: 1545216266588,
  status: 'new',
  side: 'buy',
  orderType: 'limit',
  amount: '0.1',
  price: '2950',
  onHold: '295.74',
  onHoldCurrency: 'EUR',
  filledAmount: '0',
  filledPrice: '0',
  feePaid: '0',
  feeCurrency: 'EUR',
  fills: [],
  selfTradePrevention: 'decrementAndCancel',
  visible: true,
  timeInForce: 'GTC',
  postOnly: false,
  clientOrderId: '83a7f9f6-ff55-4375-90a5-0a44216d00d1'
},
{
  orderId: 'f9f4e3b2-de48-4f55-8c98-23fe39f20806',
  market: 'BTC-EUR',
  created: 1545216276974,
  updated: 1545216276974,
  status: 'new',
  side: 'buy',
  orderType: 'limit',
  amount: '0.3',
  price: '2910',
  onHold: '875.19',
  onHoldCurrency: 'EUR',
  filledAmount: '0',
  filledPrice: '0',
  feePaid: '0',
  feeCurrency: 'EUR',
  fills: [],
  selfTradePrevention: 'decrementAndCancel',
  visible: true,
  timeInForce: 'GTC',
  postOnly: false,
  clientOrderId: '13351170-21d0-4855-ae1e-d71c0cb2828e'
},
...

Get trades

Returns all trades within a market for this account.

bitvavo.getEmitter().on('trades', (response) => {
  for (let entry of response) {
    console.log(entry)
  }
})

// options: limit, start, end, tradeIdFrom, tradeIdTo
bitvavo.websocket.trades('BTC-EUR', {})

View Response

[{
  id: '93fd9d6e-16a5-46c7-8a51-7237429d0532',
  orderId: '08a88e63-abe1-4205-a3ea-a430d60b0423',
  timestamp: 1545213249947,
  market: 'BTC-EUR',
  side: 'buy',
  amount: '0.001',
  price: '3500.1',
  taker: true,
  fee: '0.0099',
  feeCurrency: 'EUR',
  settled: true,
  clientOrderId: '13351170-21d0-4855-ae1e-d71c0cb2828e'
},
{
  id: 'b9eadfa5-cd6b-4051-9318-a95a26c5df30',
  orderId: '08a88e63-abe1-4205-a3ea-a430d60b0423',
  timestamp: 1545213234550,
  market: 'BTC-EUR',
  side: 'buy',
  amount: '0.003039',
  price: '3453.7',
  taker: true,
  fee: '0.0242057',
  feeCurrency: 'EUR',
  settled: true,
  clientOrderId: '13351170-21d0-4855-ae1e-d71c0cb2828e'
},
{
  id: 'd750696b-5843-48ad-9d29-5b60ff67c142',
  orderId: '08a88e63-abe1-4205-a3ea-a430d60b0423',
  timestamp: 1545213234535,
  market: 'BTC-EUR',
  side: 'buy',
  amount: '0.003039',
  price: '3447.1',
  taker: true,
  fee: '0.0342631',
  feeCurrency: 'EUR',
  settled: true,
  clientOrderId: '13351170-21d0-4855-ae1e-d71c0cb2828e'
},
{
  id: '1126bfd1-90e8-4a2b-92c4-35385805cf19',
  orderId: '2917abf4-00b0-403d-ab20-3ff5ad1c4d69',
  timestamp: 1545213234521,
  market: 'BTC-EUR',
  side: 'buy',
  amount: '0.00303191',
  price: '3441.9',
  taker: true,
  fee: '0.024468971',
  feeCurrency: 'EUR',
  settled: true,
  clientOrderId: '83a7f9f6-ff55-4375-90a5-0a44216d00d1'
},
{
  id: '59910ac3-0c2c-4fab-961b-7678a26e2c43',
  orderId: '2917abf4-00b0-403d-ab20-3ff5ad1c4d69',
  timestamp: 1545213234508,
  market: 'BTC-EUR',
  side: 'buy',
  amount: '0.003039',
  price: '3440.5',
  taker: true,
  fee: '0.0243205',
  feeCurrency: 'EUR',
  settled: true,
  clientOrderId: '83a7f9f6-ff55-4375-90a5-0a44216d00d1'
},
...

Get account

Returns the fee tier for this account.

bitvavo.getEmitter().on('account', (response) => {
  console.log(response)
})

bitvavo.websocket.account()

View Response

{
  fees: {
    taker: '0.0025'
    maker: '0.0015'
    volume: '100'
  }
}

Get balance

Returns the balance for this account.

bitvavo.getEmitter().on('balance', (response) => {
  for (let entry of response) {
    console.log(entry)
  }
})

// options: symbol
bitvavo.websocket.balance({})

View Response

{ 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' }
...

Deposit assets

Returns the address which can be used to deposit funds.

bitvavo.getEmitter().on('depositAssets', (response) => {
  console.log(response)
})

bitvavo.websocket.depositAssets('BTC')

View Response

{ address: 'BitcoinAddress'}

Withdraw assets

Can be used to withdraw funds from Bitvavo.

bitvavo.getEmitter().on('withdrawAssets', (response) => {
  console.log(response)
})

// Optional parameters: paymentId, internal, addWithdrawalFee
bitvavo.websocket.withdrawAssets('BTC', 1, 'BitcoinAddress', {})

View Response

{ success: true, symbol: 'BTC', amount: '1' }

Get deposit history

Returns the deposit history of your account.

bitvavo.getEmitter().on('depositHistory', (response) => {
  for (let entry of response) {
    console.log(entry)
  }
})

// options: symbol, limit, start, end
bitvavo.websocket.depositHistory({})

View Response

{ 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' }
  ...

Get withdrawal history

Returns the withdrawal history of an account.

bitvavo.getEmitter().on('withdrawalHistory', (response) => {
  for (let entry of response) {
    console.log(entry)
  }
})

// options: symbol, limit, start, end
bitvavo.websocket.withdrawalHistory({})

View Response

{ 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' }
  ...

Subscriptions

For subscriptions callbacks are used instead of the emitter. This is because you can subscribe to the same function, but with different markets/intervals. Callbacks enable you to handle responses differently per market for the same function. Be aware that when you call the same function with the same market (and in the case of candles with the same interval), your older callback will be overwritten. Errors will still be emitted and should be caught in the following manner: emitter.on('error', (error) => { console.log('Handle your error here', error) })

Ticker subscription

Sends an update every time the best bid, best ask or last price changed.

bitvavo.websocket.subscriptionTicker('BTC-EUR', (response) => {
  console.log(response)
})

View Response

{ event: 'ticker',
  market: 'BTC-EUR',
  bestBid: '9319.2',
  bestBidSize: '0.10668336',
  bestAsk: '9319.4',
  bestAskSize: '0.10953201',
  lastPrice: '9335' }

Ticker 24 hour subscription

Updated ticker24h objects are sent on this channel once per second. A ticker24h object is considered updated if one of the values besides timestamp has changed.

bitvavo.websocket.subscriptionTicker24h('BTC-EUR', (response) => {
  console.log(response)
})

View Response

{ market: 'BTC-EUR',
  open: '10492',
  high: '10700',
  low: '10434',
  last: '10478',
  volume: '3.28126159',
  volumeQuote: '34602.84',
  bid: '10435',
  ask: '10436',
  timestamp: 1565352131873,
  bidSize: '0.12426851',
  askSize: '0.2554444' }

Account subscription

Sends an update whenever an event happens which is related to the account. These are ‘order’ events (create, update, cancel) or ‘fill’ events (a trade occurred).

bitvavo.websocket.subscriptionAccount('BTC-EUR', (response) => {
  console.log(response)
})

View Response

Fill:
{ event: 'fill',
  timestamp: 1545220667936,
  market: 'BTC-EUR',
  orderId: '6a830458-c886-407b-b076-d7103de5ce74',
  fillId: '15d14b09-389d-4f83-9413-de9d0d8e7715',
  side: 'buy',
  amount: '0.00296444',
  price: '3540.5',
  taker: true,
  fee: '0.02440018',
  feeCurrency: 'EUR' }

Order (limit):
{ event: 'order',
  orderId: '2f7d49bc-c3e2-4ea0-9e4f-999bb2148591',
  market: 'BTC-EUR',
  created: 1545220585343,
  updated: 1545220585343,
  status: 'new',
  side: 'buy',
  orderType: 'limit',
  amount: '0.3',
  amountRemaining: '0.3',
  price: '2910',
  onHold: '875.19',
  onHoldCurrency: 'EUR',
  selfTradePrevention: 'decrementAndCancel',
  visible: true,
  timeInForce: 'GTC',
  postOnly: false }

Candles subscription

Sends an updated candle after each trade for the specified interval and market.

bitvavo.websocket.subscriptionCandles('BTC-EUR', '1h', (response) => {
  console.log(response)
})

View Response

{ event: 'candle',
  market: 'BTC-EUR',
  interval: '1h',
  candle:
   [ [ 1545217200000,
       '3377.7',
       '3384.4',
       '3377.7',
       '3384.4',
       '0.00593012' ] ] }

Trades subscription

Sends an update whenever a trade has happened on this market. For your own trades, please subscribe to account.

bitvavo.websocket.subscriptionTrades('BTC-EUR', (response) => {
  console.log(response)
})

View Response

{ event: 'trade',
  timestamp: 1545220667509,
  market: 'BTC-EUR',
  id: '7609c9b7-cb50-45d4-bf11-ce0451e2f073',
  amount: '0.00296506',
  price: '3377.7',
  side: 'buy' }

Book subscription

Sends an update whenever the order book for this specific market has changed. A list of tuples ([price, amount]) are returned, where amount ‘0’ means that there are no more orders at this price. If you wish to maintain your own copy of the order book, consider using the next function.

bitvavo.websocket.subscriptionBookUpdate('BTC-EUR', (response) => {
  console.log(response)
})

View Response

{ event: 'book',
  market: 'BTC-EUR',
  nonce: 41186,
  bids: [ [ '3344.5', '0' ], [ '3345.7', '0.00299041' ] ],
  asks: [] }

Book subscription with local copy

This is a combination of get book per market and the book subscription which maintains a local copy. On every update to the order book, the entire order book is returned to the callback, while the book subscription will only return updates to the book.

bitvavo.websocket.subscriptionBook('LTC-EUR', (book) => {
  console.log(book)
})

View Response

{ bids:
   [ [ '3365.2', '0.00297308' ],
     [ '3358.5', '0.00297901' ],
     [ '3351.3', '0.00298541' ],
     [ '3344.5', '0.00299148' ],
     [ '3337.4', '0.00299785' ],
     [ '3331.1', '0.00300352' ],
     [ '3324', '0.00300993' ],
     [ '3318.8', '0.00301465' ],
     [ '3312.1', '0.00302075' ],
     [ '3305.3', '0.00302696' ],
     [ '3297.4', '0.00303421' ],
     [ '3290.7', '0.00304039' ],
     [ '3284', '0.00304659' ],
     [ '3276.9', '0.0030532' ],
     [ '3275.1', '0.00305487' ],
     [ '3268.3', '0.00306123' ],
     [ '3261.6', '0.00306752' ],
     [ '3254.9', '0.00307383' ],
     [ '3248.1', '0.00308027' ],
     [ '3241.4', '0.00308663' ],
     [ '3234.7', '0.00309303' ],
     [ '3227.9', '0.00309954' ],
     [ '3221.2', '0.00310599' ],
     [ '3214.4', '0.00311256' ],
     [ '3207.7', '0.00311906' ],
     [ '2950', '0.1' ],
     [ '2910', '0.3' ],
     [ '2900', '0.1' ] ],
  asks:
   [ [ '3373.1', '0.00296911' ],
     [ '3380', '0.00296893' ],
     [ '3386.6', '0.00296911' ],
     [ '3394.1', '0.0029684' ],
     [ '3400.9', '0.0029684' ],
     [ '3407.6', '0.0029684' ],
     [ '3414.4', '0.0029684' ],
     [ '3421.1', '0.0029684' ],
     [ '3427.9', '0.0029684' ],
     [ '3434.6', '0.0029684' ],
     [ '3441.3', '0.0029684' ],
     [ '3448.1', '0.0029684' ],
     [ '3454.8', '0.0029684' ],
     [ '3460.7', '0.0029692' ],
     [ '3467.4', '0.0029692' ],
     [ '3473.7', '0.00296955' ],
     [ '3479.7', '0.00297025' ],
     [ '3486.4', '0.00297025' ],
     [ '3500', '0.00296444' ],
     [ '3506.8', '0.00296444' ],
     [ '3513.5', '0.00296444' ],
     [ '3520.3', '0.00296444' ],
     [ '3527', '0.00296444' ],
     [ '3533.8', '0.00296444' ],
     [ '3540.5', '0.00296444' ] ],
  nonce: 41175 }

Unsubscribe

Unsubscribe from a previously opened WebSocket connection.

bitvavo.websocket.unsubscribe('LTC-EUR', 'account')

View Response

```javascript { event: 'unsubscribed', subscriptions: {} } ```

Files

README.md

Latest commit

History

README.md

File metadata and controls

Bitvavo SDK for Node.js

Prerequisites

Installation

Rate Limiting

REST requests

Getting started

General

Get time

Get markets

Get assets

Market Data

Get book per market

Get trades per market

Get candles per market

Get price ticker

Get book ticker

Get 24 hour ticker

Private

Place order

Update order

Get order

Cancel order

Get orders

Cancel orders

Get orders open

Get trades

Get account

Get balance

Deposit assets

Withdraw Assets

Get deposit history

Get withdrawal history

WebSocket

Getting started

requestId

Public

Get time

Get markets

Get assets

Get book per market

Get trades per market

Get candles per market

Get price ticker

Get book ticker

Get 24 hour ticker

Private

Place order

Update order

Get order

Cancel order

Get orders

Cancel orders

Get orders open

Get trades

Get account

Get balance

Deposit assets

Withdraw assets

Get deposit history

Get withdrawal history

Subscriptions

Ticker subscription

Ticker 24 hour subscription

Account subscription

Candles subscription

Trades subscription

Book subscription

Book subscription with local copy

Unsubscribe