Skip to main content

Chart Data API

📊 Overview

This API is used to fetch intraday and historical chart data for supported exchanges and instruments.

📝 Endpoint Details

PropertyValue
NameChart Data
MethodGET
DescriptionFetches intraday & historic chart data

🌐🔗 Base URL Format

<protocol>://<host name>:<service port>/:version/chart/data/: exchange/: token/: period/: interval/:source?from=2021-05-25 09:00:00&to=2021-05-28 17:00:00

📜 Example Request

https://demo.synapsewave.com:3000/v1/chart/data/NSE_EQ/22/1/MIN/DIET?from=2021-05-25 09:00:00&to=2021-05-28 17:00:00

Request Format

🎫 Headers

Content-Type: application/json Authorization: Bearer <access_token>

Pass the access token as a Bearer token in the Authorization header. Token generation is explained in Access Key Generation Flow.

🛣️ URL Path Parameters

ParameterTypeRequiredDescriptionValues / Examples
versionvarcharYesAPI Versionv1
exchangevarchar(15)YesExchange nameNSE_EQ, NSE_FO, BSE_EQ, BSE_FO, MCX_FO, NCDEX_FO, NSE_CUR, NSE_COMM, BSE_CUR, BSE_COMM, ICEX_FO, MSE_EQ, MSE_FO, MSE_CUR, NSE_OTS
tokenintYesInstrument tokene.g., 22
periodvarcharYesCandle record periodSee mapping below
intervalvarcharYesCandle record interval1 MIN is intraday; others are historical
sourcevarcharYesSource of requestDIET, WEBAPI, MOBILEAPI, AERO, WAVE, WAVE2

🛠️ Period & Interval Mapping

PeriodInterval
1MIN
1DAY
1WEEK
1MONTH
1YEAR

❓ Query String Parameters

ParameterTypeMandatoryDescriptionExample / Format
fromvarcharOptionalStart date-time of records"YYYY-MM-DD HH:mm:ss" e.g., "2021-05-25 09:00:00"
tovarcharMandatoryEnd date-time of records"YYYY-MM-DD HH:mm:ss" e.g., "2021-05-28 17:00:00"
countbackintMandatoryNumber of candles to returne.g., 100

Response

🌏 Schema

KeyTypeDescription
statusstringStatus of the request: success / failure
messagestringError message in case of failure
dataarrayArray of candle objects (O, H, L, C, V, DT)

Example

{
"status": "success",
"message": "",
"data": [
{
"O": 78.53,
"H": 78.66,
"L": 78.03,
"C": 78.43,
"V": 4834800,
"DT": "2021-05-28 17:00:00"
}
]
}