List candle data

Get a list of candle data for a given candle ID. You can get a candle ID from the list candle intervals query

Query Parameters

candleId string required

Candle ID to retrieve candle data for, required field.

fromTimestamp int64

Timestamp to retrieve candles since, in nanoseconds since the epoch.

toTimestamp int64

Timestamp to retrieve candles to, in nanoseconds since the epoch.

pagination.first int32

Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

pagination.after string

If paging forwards, the cursor string for the last row of the previous page.

pagination.last int32

Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

pagination.before string

If paging forwards, the cursor string for the first row of the previous page.

pagination.newestFirst boolean

Newest records first, older records last, default is true.

Responses

• 200
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

candles object
Page of candle data and corresponding page information.
edges object[]
Page of candle data items and their corresponding cursors.
cursor string
node object
Candlestick data, i.e. high, low, open, and closing prices for an interval of trading.
close string
high string
lastUpdate int64
low string
open string
start int64
volume uint64
pageInfo object
Page information that is used for fetching further pages.
endCursor string
hasNextPage boolean
hasPreviousPage boolean
startCursor string

{
  "candles": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "close": "string",
          "high": "string",
          "lastUpdate": "string",
          "low": "string",
          "open": "string",
          "start": "string",
          "volume": "string"
        }
      }
    ],
    "pageInfo": {
      "endCursor": "string",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "string"
    }
  }
}

An internal server error

application/json

Schema

Example (from schema)

---

Schema

code int32
details object[]
@type string
message string

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
details object[]
@type string
message string

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

GET /api/v2/candle

Request

Base URL

https://vega-mainnet-data.commodum.io

candleId — query required

fromTimestamp — query

toTimestamp — query

pagination.first — query

pagination.after — query

pagination.last — query

pagination.before — query

pagination.newestFirst — query

---truefalse

curl / cURL

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/candle' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/candle' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/candle' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/candle' \
-H 'Accept: application/json'