Intraday Candle Data

API to retrieve OHLC (Open, High, Low, Close) values for instruments during the current trading day. Data is accessible for 1-minute and 30-minute intervals from the beginning of the market session. For real-time candlestick updates, it is advisable to utilize the Market Update Stream.

NOTE

It's important to note that instrument_key parameter accepts only a single identifier per request; comma-separated values or multiple identifiers are not supported.
A minor delay may be experienced in the delivery of the most recent candle data, attributable to CDN caching. For immediate access to the latest data, it is advisable to connect to the websocket endpoints.

Header Parameters

Name	Required	Type	Description
Accept	true	string	Defines the content format the client expects, which should be set to `application/json`.

Path Parameters

Name	Required	Type	Description
instrument_key	true	string	The unique identifier for the financial instrument for which historical data is being queried. For the regex pattern applicable to this field, see the Field Pattern Appendix.
interval	true	string	Specifies the time frame of the candles. Possible values: `1minute`, `30minute`.

Responses

Response Body

{
  "status": "success",
  "data": {
    "candles": [
      [
        "2023-10-19T15:15:00+05:30",
        2305.3,
        2307.05,
        2301,
        2304.65,
        559982,
        0
      ],
      [
        "2023-10-19T14:45:00+05:30",
        2309.1,
        2310.75,
        2305.25,
        2305.3,
        740124,
        0
      ]
    ]
  }
}

Name	Type	Description
status	string	A string indicating the outcome of the request. Typically `success` for successful operations.
data	object	Contains OHLC values for all instruments across various timeframes.
data.candles	array[]	Array of candle data, each presented as an array with sequential elements representing trading activity.
data.candle[0]	number	`Timestamp`: Indicating the start time of the candle's timeframe.
data.candle[1]	number	`Open`: The opening price of the asset for the given timeframe.
data.candle[2]	number	`High`: The highest price at which the asset traded during the timeframe.
data.candle[3]	number	`Low`: The lowest price at which the asset traded during the timeframe.
data.candle[4]	number	`Close`: The closing price of the asset for the given timeframe.
data.candle[5]	number	`Volume`: The total amount of the asset that was traded during the timeframe.
data.candle[6]	number	`Open Interest`: The total number of outstanding derivative contracts, such as options or futures.

Error codes

Error code	Description
UDAPI1021	Instrument key is of invalid format - The provided instrument key doesn't conform to the expected format.
UDAPI1020	Interval accepts one of (1minute,30minute,day,week,month) - Ensure the 'interval' is one of the specified values.
UDAPI100011	Invalid Instrument key - The instrument key you provided doesn't match any of the recognized keys in the system.

Examples

A comprehensive set of examples is provided to illustrate various use cases and implementation scenarios for this API. To view detailed examples and access sample code, please refer to: API Examples.