Get candlestick data

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

Returns the OHLCV market data used to create candlestick charts.

Candlestick data is always returned in chronological order from the latest to the earliest. Data is returned when trades are made in the interval represented by that candlestick. If no trades occur you see a gap in data flow - zero trades are represented by zero candlesticks.

Rate limit weight points: 1

Request

Schema

Body

actionstring
Set value to getCandles.
Example: getCandles
requestIdinteger
Your identifier for the request.
Example: 1
marketstringrequired
The market for which to return the order book.
Example: BTC-EUR
intervalstringrequired
The time interval between each candlestick. Determines the allowed values for start and end parameters.
Possible values: [1m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 1W, 1M]
limitinteger
The maximum number of candlestick data to return.
Possible values: >= 1 and <= 1440
Default value: 1440
startinteger
The Unix timestamp in milliseconds starting from which to return the candlestick data.

The timestamp must align exactly with the start of the specified interval. For example, for a 1-hour candlestick that starts at 13:00:00.000 Amsterdam time, use 1704067200000.
Example: 1704067200000
endinteger
The Unix timestamp in milliseconds until which to return the candlestick data.

The timestamp must align exactly with the end of the specified interval. For example, for a 1-hour candlestick that ends at 14:00:00.000 Amsterdam time, use 1766062800000.
Example: 1704153600000

Example (body)

{
  "action": "getCandles",
  "requestId": 1,
  "market": "BTC-EUR",
  "interval": "1m",
  "limit": 1440,
  "start": 1704067200000,
  "end": 1704153600000
}

Response

Schema

Schema

actionstring
The action performed.
Example: getCandles
requestIdinteger
Your identifier for the request.
Example: 1
responsearray[]
An array with the candlestick data for the specified time period. Each element is an array containing exactly 6 values in this order:
• timestamp (integer): Unix timestamp in milliseconds for the start of the candlestick period.
• open (string): The starting price for the market at timestamp.
• high (string): The highest price for the market during the interval.
• low (string): The lowest price for the market during the interval.
• close (string): The closing price for the market after the interval.
• volume (string): The amount traded in the market during the interval.
Possible values: >= 6, <= 6
Example: [[1704153540000,"40050","40071","40049","40071","0.52680563"],[1704153480000,"40021","40054","40021","40053","2.64389051"]]

Example (body)

{
  "action": "getCandles",
  "requestId": 1,
  "response": [
    [
      1704153540000,
      "40050",
      "40071",
      "40049",
      "40071",
      "0.52680563"
    ],
    [
      1704153480000,
      "40021",
      "40054",
      "40021",
      "40053",
      "2.64389051"
    ]
  ]
}