Candles subscription

REQUEST wss://ws.bitvavo.com/v2 candles

Subscribes to events that return data used to form candlestick charts.

Request

Schema

Body

actionstringrequired
Set to subscribe to start or to unsubscribe to stop the subscription.
Possible values: [subscribe, unsubscribe]
channels object[]required
The events you want to subscribe to.
Array [
namestring
The channel to which you want to subscribe.
Example: candles
marketsstring[]
The markets for which you want to stream the data.
Example: ["BTC-EUR"]
intervalstring[]
The time period for which to return the candlestick data.
Possible values: [1m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d]
]

Example (body)

{
  "action": "subscribe",
  "channels": [
    {
      "name": "candles",
      "markets": [
        "BTC-EUR"
      ],
      "interval": [
        "1m"
      ]
    }
  ]
}

Response

Candles confirmation

Schema

Schema

eventstring
The returned event.
Example: subscribed
subscriptions object
The object with all currently active subscriptions.
candles object
The object with all current candles subscriptions.
1hstring[]
The markets for which you want stream the data per interval.
Example: ["BTC-EUR"]

Example (body)

{
  "event": "subscribed",
  "subscriptions": {
    "candles": {
      "1h": [
        "BTC-EUR"
      ]
    }
  }
}

Candles event

Schema

Schema

eventstring
The returned event.
Example: candles
marketstring
The markets for which you want stream the data.
Example: BTC-EUR
intervalstring
The time period for which to return the candlestick data.
Example: 1h
candlearray[]
An array with the candlestick data for the specified time period. It contains a timestamp, open, high, low, close, and volume values in that order.
Example: [["1538784000000","4999","5012","4999","5012","0.45"]]

Example (body)

{
  "event": "candles",
  "market": "BTC-EUR",
  "interval": "1h",
  "candle": [
    [
      "1538784000000",
      "4999",
      "5012",
      "4999",
      "5012",
      "0.45"
    ]
  ]
}