Skip to content

Latest commit

 

History

History
107 lines (66 loc) · 3.05 KB

HistoricalDataApi.md

File metadata and controls

107 lines (66 loc) · 3.05 KB

intrinioSDK.HistoricalDataApi

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

Method HTTP request Description
getHistoricalData GET /historical_data/{identifier}/{tag} Historical Data

getHistoricalData

View Intrinio API Documentation

ApiResponseHistoricalData getHistoricalData(identifier, tag, opts)

Historical Data

Returns historical values for the given `tag` and the entity represented by the given `identifier`

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var historicalData = new intrinioSDK.HistoricalDataApi();

var identifier = "AAPL";
var tag = "marketcap";


var opts = { 
  'frequency': "daily",
  'type': null,
  'startDate': new Date("2015-01-01"),
  'endDate': null,
  'sortOrder': "desc",
  'pageSize': 100,
  'nextPage': null
};

historicalData.getHistoricalData(identifier, tag, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)  
tag String An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a>)  
frequency String Return historical data in the given frequency [optional] [default to daily]  
type String Filter by type, when applicable [optional]  
startDate Date Get historical data on or after this date [optional]  
endDate Date Get historical date on or before this date [optional]  
sortOrder String Sort by date `asc` or `desc` [optional] [default to desc]  
pageSize Number The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseHistoricalData