Intraday Candle Data V3
This API is an extended version of standard Intraday Candle Data API, which allows you to retrieve Open, High, Low, and Close (OHLC) values for the current trading day. It supports customizable time intervals across various units such as minutes
, hours
, days
.
This API is particularly useful for traders and analysts who require detailed intraday data for technical analysis, backtesting, or algorithmic trading strategies.
This API provides the following unit and interval options for intraday data:
Unit | Interval Options |
---|---|
minutes | 1, 2, 3, ... 300 |
hours | 1, 2, ... 5 |
days | 1 |
NOTE
- This V3 API provides additional custom interval options that are not available in the standard Intraday Candle Data API.
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. |
unit | true | string | Specifies the unit for the candles. Possible values: minutes , hours , days . |
interval | true | string | Specifies the interval for the candles. Possible values: 1 , 2 , 3 , ..., 300 for minutes. 1 , 2 , ..., 5 for hours. 1 for days. |
Responses
- 200
- 4XX
Response Body
{
"status": "success",
"data": {
"candles": [
[
"2025-01-12T15:15:00+05:30",
2305.3,
2307.05,
2301,
2304.65,
559982,
0
],
[
"2025-01-12T14: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. |
UDAPI100011 | Invalid Instrument key - The instrument key you provided doesn't match any of the recognized keys in the system. |
UDAPI1146 | Invalid unit - The unit you provided is not recognized. Valid options are minutes , hours , days , weeks , or months . |
UDAPI1147 | Invalid interval - The interval you provided is not valid for the specified unit. For example, if the unit is minutes , valid intervals are 1 to 300 . |
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.
Loading...