Skip to content

Latest commit

 

History

History
157 lines (112 loc) · 5.06 KB

HistoryApi.md

File metadata and controls

157 lines (112 loc) · 5.06 KB
Raw

UpstoxClient.HistoryApi

All URIs are relative to https://api-v2.upstox.com

Method HTTP request Description
getHistoricalCandleData GET /historical-candle/{instrumentKey}/{interval}/{to_date} Historical candle data
getHistoricalCandleData1 GET /historical-candle/{instrumentKey}/{interval}/{to_date}/{from_date} Historical candle data
getIntraDayCandleData GET /historical-candle/intraday/{instrumentKey}/{interval} Intra day candle data

getHistoricalCandleData

GetHistoricalCandleResponse getHistoricalCandleData(instrumentKey, interval, toDate, apiVersion)

Historical candle data

Get OHLC values for all instruments across various timeframes. Historical data can be fetched for the following durations. 1minute: last 1 month candles till endDate 30minute: last 1 year candles till endDate day: last 1 year candles till endDate week: last 10 year candles till endDate month: last 10 year candles till endDate

Example

import {UpstoxClient} from 'upstox-js-sdk';

let apiInstance = new UpstoxClient.HistoryApi();
let instrumentKey = "instrumentKey_example"; // String | 
let interval = "interval_example"; // String | 
let toDate = "toDate_example"; // String | 
let apiVersion = "apiVersion_example"; // String | API Version Header

apiInstance.getHistoricalCandleData(instrumentKey, interval, toDate, apiVersion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
instrumentKey String
interval String
toDate String
apiVersion String API Version Header

Return type

GetHistoricalCandleResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, /

getHistoricalCandleData1

GetHistoricalCandleResponse getHistoricalCandleData1(instrumentKey, interval, toDate, fromDate, apiVersion)

Historical candle data

Get OHLC values for all instruments across various timeframes. Historical data can be fetched for the following durations. 1minute: last 1 month candles till endDate 30minute: last 1 year candles till endDate day: last 1 year candles till endDate week: last 10 year candles till endDate month: last 10 year candles till endDate

Example

import {UpstoxClient} from 'upstox-js-sdk';

let apiInstance = new UpstoxClient.HistoryApi();
let instrumentKey = "instrumentKey_example"; // String | 
let interval = "interval_example"; // String | 
let toDate = "toDate_example"; // String | 
let fromDate = "fromDate_example"; // String | 
let apiVersion = "apiVersion_example"; // String | API Version Header

apiInstance.getHistoricalCandleData1(instrumentKey, interval, toDate, fromDate, apiVersion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
instrumentKey String
interval String
toDate String
fromDate String
apiVersion String API Version Header

Return type

GetHistoricalCandleResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, /

getIntraDayCandleData

GetIntraDayCandleResponse getIntraDayCandleData(instrumentKey, interval, apiVersion)

Intra day candle data

Get OHLC values for all instruments for the present trading day

Example

import {UpstoxClient} from 'upstox-js-sdk';

let apiInstance = new UpstoxClient.HistoryApi();
let instrumentKey = "instrumentKey_example"; // String | 
let interval = "interval_example"; // String | 
let apiVersion = "apiVersion_example"; // String | API Version Header

apiInstance.getIntraDayCandleData(instrumentKey, interval, apiVersion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
instrumentKey String
interval String
apiVersion String API Version Header

Return type

GetIntraDayCandleResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, /