Observe candle data

Subscribe to a stream of candle updates

Query Parameters

candleId string required

Unique ID for the candle.

Responses

• 200
• 500
• default

---

A successful response.(streaming responses)

application/json

Schema

Example (from schema)

---

Schema

error object
code int32
details object[]
@type string
message string
result object
candle object
Candle data.
close string
high string
lastUpdate int64
low string
open string
start int64
volume uint64

{
  "error": {
    "code": 0,
    "details": [
      {
        "@type": "string"
      }
    ],
    "message": "string"
  },
  "result": {
    "candle": {
      "close": "string",
      "high": "string",
      "lastUpdate": "string",
      "low": "string",
      "open": "string",
      "start": "string",
      "volume": "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/stream/candle/data

Request

Base URL

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

candleId — query required

curl / cURL

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

python / requests

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

go / native

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

nodejs / axios

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