Data Streams Candlestick API

The Candlestick API is designed and implemented to satisfy the TradingView implementation spec, the industry standard for sharing aggregated trading data.

Alignment with the TradingView spec allows for TradingView integration and direct customer access to prices without resorting to consuming and decoding reports for non-transactional use cases, like dashboards, analytics platforms, portfolio trackers, research tools, and more.

Domains

API Endpoints

Authorize and get token

Endpoint

/api/v1/authorize

Sample request

curl -X POST \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "login={YOUR_USER_ID}&password={YOUR_API_KEY}" \
  https://priceapi.testnet-dataengine.chain.link/api/v1/authorize

Response

• Status: 200

  {
    "d": {
      "access_token": "[ACCESS_TOKEN]",
      "expiration": 1747203979
    },
    "s": "ok"
  }
  

  Field	Type	Description
  s	string	The status of the request.
  d	object	The data returned by the API call.
  access_token	string	The JWT token for subsequent requests.
  expiration	number	The expiry timestamp (unix) of the token.

Error Responses

Get list of supported symbols

Endpoint

/api/v1/symbol_info

Sample request

curl -X GET \
  -H "Authorization: Bearer {YOUR_ACCESS_TOKEN}" \
  https://priceapi.testnet-dataengine.chain.link/api/v1/symbol_info

Response

• Status: 200

  {
    "s": "ok",
    "symbol": ["ETHUSD", "BTCUSD"],
    "currency": ["USD", "USD"],
    "base-currency": ["ETH", "BTC"]
  }
  

  Field	Type	Description
  s	string	The status of the request.
  symbol	array	Array of supported symbols.
  currency	array	Array of symbol currencies.
  base-currency	array	Array of symbol base currencies.

Error Responses

Get candlestick data (column format)

Endpoint

/api/v1/history

Note: The resolution of the data is based on the size of the time window:

Sample request

curl -X GET \
  -H "Authorization: Bearer {YOUR_ACCESS_TOKEN}" \
  "https://priceapi.testnet-dataengine.chain.link/api/v1/history?symbol=ETHUSD&resolution=1m&from=1746072068&to=1746158468"

Response

• Status: 200

  {
    "s": "ok",
    "t": [1746158460, 1746158400, 1746158340],
    "c": [1.84685e21, 1.848515087189567e21, 1.8490380305e21, 1.8481266e21],
    "o": [1.8483674e21, 1.848602513e21, 1.8481267e21],
    "h": [1.8498753129131415e21, 1.848875387e21, 1.8490380305e21],
    "l": [1.8468008021426886e21, 1.848243519e21, 1.8475677870725296e21],
    "v": []
  }
  

  Field	Type	Description
  s	string	The status of the request.
  t	array	Array of unix timestamps (the time of each candle).
  c	array	Array of numbers (the close (last) value of each candle).
  o	array	Array of numbers (the open (first) value of each candle).
  h	array	Array of numbers (the high (max) value of each candle).
  l	array	Array of numbers (the low (min) value of each candle).
  v	array	Array of numbers (the volume of each candle. Not currently supported).

  Note: If candles cannot be found for the given symbol/time period, a response with empty arrays will be provided. eg: { "s": "ok", "t": [], "c": [], "o": [], "h": [], "l": [], "v": [] }

Error Responses

Get candlestick data (row format)

Endpoint

/api/v1/history/rows

Sample request

curl -X GET \
  -H "Authorization: Bearer {YOUR_ACCESS_TOKEN}" \
  "https://priceapi.testnet-dataengine.chain.link/api/v1/history/rows?symbol=ETHUSD&resolution=1m&from=1746072068&to=1746158468"

Response

• Status: 200

  {
    "s": "ok",
    "candles": [
      [1746158460, 1.8483674e21, 1.8498753129131415e21, 1.8468008021426886e21, 1.84685e21, 0],
      [1746158400, 1.848602513e21, 1.848875387e21, 1.848243519e21, 1.848515087189567e21, 0],
      [1746158340, 1.8481267e21, 1.8490380305e21, 1.8475677870725296e21, 1.8490380305e21, 0]
    ]
  }
  

  Field	Type	Description
  s	string	The status of the request.
  candles	array	Array of arrays of numbers. Each array candle contains: [ time, open, high, low, close, volume ].

  Note: If candles cannot be found for the given symbol/time period, a response with an empty candles array is provided. eg: { "s": "ok", "candles": [] }

Error Responses

Get streaming price updates

Endpoint

/api/v1/streaming

Sample request

curl -X GET \
  -H "Authorization: Bearer {YOUR_ACCESS_TOKEN}" \
  -H "Connection: keep-alive" \
  "https://priceapi.testnet-dataengine.chain.link/api/v1/streaming?symbol=ETHUSD,BTCUSD"

Response

• Status: 200 (Streaming)

  A stream of JSON objects.

  Trade Response:

  {
    "f": "t",
    "i": "ETHUSD",
    "fid": "[FEED_ID]",
    "p": 2.68312e21,
    "t": 1748525526,
    "s": 1
  }
  

  Field	Type	Description
  f	string	Message type. Will always be “t” to indicate a trade response.
  i	string	Identifier. The symbol for this response.
  fid	string	The hex-encoded feed ID for this response.
  p	float64	The latest price update for the symbol/feedId.
  t	float64	The time of the price as a unix timestamp.
  s	float64	Size of the trade. This will always be 1.

  Heartbeat (sent every 5 seconds):

  { "heartbeat": 1748525528 }
  

  Field	Type	Description
  heartbeat	float64	The time of the heartbeat message as a unix timestamp.

Error Responses