Skip to content

Latest commit

 

History

History
2100 lines (1195 loc) · 48.5 KB

IndexApi.md

File metadata and controls

2100 lines (1195 loc) · 48.5 KB

intrinioSDK.IndexApi

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

Method HTTP request Description
getAllEconomicIndices GET /indices/economic All Economic Indices
getAllEodIndexPrices GET /indices/prices/eod All End of Day Index Prices
getAllIndexSummaries GET /indices All Index Summaries
getAllRealtimeIndexPrices GET /indices/prices/realtime All Realtime Index Prices
getAllSicIndices GET /indices/sic All SIC Indices
getAllStockMarketIndices GET /indices/stock_market All Stock Market Indices
getEconomicIndexById GET /indices/economic/{identifier} Lookup Economic Index
getEconomicIndexDataPointNumber GET /indices/economic/{identifier}/data_point/{tag}/number Data Point (Number) for an Economic Index
getEconomicIndexDataPointText GET /indices/economic/{identifier}/data_point/{tag}/text Data Point (Text) for an Economic Index
getEconomicIndexHistoricalData GET /indices/economic/{identifier}/historical_data/{tag} Historical Data for an Economic Index
getEodIndexPriceById GET /indices/{identifier}/eod End of Day Index Prices By Identifier
getIndexConstituentsById GET /indices/{identifier}/constituents Index Constituents By Index Identifier
getIndexSummaryById GET /indices/{identifier} Index Summary By Identifier
getRealtimeIndexPriceById GET /indices/{identifier}/realtime Realtime Index Price By Identifier
getSicIndexById GET /indices/sic/{identifier} Lookup SIC Index
getSicIndexDataPointNumber GET /indices/sic/{identifier}/data_point/{tag}/number Data Point (Number) for an SIC Index
getSicIndexDataPointText GET /indices/sic/{identifier}/data_point/{tag}/text Data Point (Text) for an SIC Index
getSicIndexHistoricalData GET /indices/sic/{identifier}/historical_data/{tag} Historical Data for an SIC Index
getStockMarketIndexById GET /indices/stock_market/{identifier} Lookup Stock Market Index
getStockMarketIndexDataPointNumber GET /indices/stock_market/{identifier}/data_point/{tag}/number Data Point (Number) for Stock Market Index
getStockMarketIndexDataPointText GET /indices/stock_market/{identifier}/data_point/{tag}/text Data Point (Text) for Stock Market Index
getStockMarketIndexHistoricalData GET /indices/stock_market/{identifier}/historical_data/{tag} Historical Data for Stock Market Index
searchEconomicIndices GET /indices/economic/search Search Economic Indices
searchSicIndices GET /indices/sic/search Search SIC Indices
searchStockMarketsIndices GET /indices/stock_market/search Search Stock Market Indices

getAllEconomicIndices

View Intrinio API Documentation

ApiResponseEconomicIndices getAllEconomicIndices(opts)

All Economic Indices

Returns a list of reference data on more than 200,000 economic indices from the Federal Reserve Economic Data (FRED) database.

Example

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

var index = new intrinioSDK.IndexApi();

var opts = { 
  'pageSize': 100,
  'nextPage': null
};

index.getAllEconomicIndices(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
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

ApiResponseEconomicIndices

getAllEodIndexPrices

View Intrinio API Documentation

ApiResponseEodIndexPricesAll getAllEodIndexPrices(opts)

All End of Day Index Prices

Example

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

var index = new intrinioSDK.IndexApi();

var opts = { 
  'pageSize': 100,
  'startDate': null,
  'endDate': null
};

index.getAllEodIndexPrices(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
pageSize Number The number of results to return [optional] [default to 100]  
startDate Date Limit prices to those on or after this date [optional]  
endDate Date Limit prices to those on or before this date [optional]  

Return type

ApiResponseEodIndexPricesAll

getAllIndexSummaries

View Intrinio API Documentation

ApiResponseIndices getAllIndexSummaries(opts)

All Index Summaries

Example

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

var index = new intrinioSDK.IndexApi();

var opts = { 
  'pageSize': 100
};

index.getAllIndexSummaries(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
pageSize Number The number of results to return [optional] [default to 100]  

Return type

ApiResponseIndices

getAllRealtimeIndexPrices

View Intrinio API Documentation

ApiResponseRealtimeIndexPrices getAllRealtimeIndexPrices(opts)

All Realtime Index Prices

Example

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

var index = new intrinioSDK.IndexApi();

var opts = { 
  'pageSize': 100
};

index.getAllRealtimeIndexPrices(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
pageSize Number The number of results to return [optional] [default to 100]  

Return type

ApiResponseRealtimeIndexPrices

getAllSicIndices

View Intrinio API Documentation

ApiResponseSICIndices getAllSicIndices(opts)

All SIC Indices

Example

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

var index = new intrinioSDK.IndexApi();

var opts = { 
  'pageSize': 100,
  'nextPage': null
};

index.getAllSicIndices(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
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

ApiResponseSICIndices

getAllStockMarketIndices

View Intrinio API Documentation

ApiResponseStockMarketIndices getAllStockMarketIndices(opts)

All Stock Market Indices

Example

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

var index = new intrinioSDK.IndexApi();

var opts = { 
  'pageSize': 100,
  'nextPage': null
};

index.getAllStockMarketIndices(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
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

ApiResponseStockMarketIndices

getEconomicIndexById

View Intrinio API Documentation

EconomicIndex getEconomicIndexById(identifier)

Lookup Economic Index

Returns reference data for a specified Federal Reserve Economic Data (FRED) series ID.

Example

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

var index = new intrinioSDK.IndexApi();

var identifier = "$GDP";


index.getEconomicIndexById(identifier).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 Index Identifier (symbol, Intrinio ID)  

Return type

EconomicIndex

getEconomicIndexDataPointNumber

View Intrinio API Documentation

'Number' getEconomicIndexDataPointNumber(identifier, tag)

Data Point (Number) for an Economic Index

Returns latest data for a specified Federal Reserve Economic Data (FRED) ID.

Example

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

var index = new intrinioSDK.IndexApi();

var identifier = "$GDP";
var tag = "level";


index.getEconomicIndexDataPointNumber(identifier, tag).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 Index Identifier (symbol, Intrinio ID)  
tag String An Intrinio data tag <a href='https://data.intrinio.com/data-tags/economic&#39;&gt;reference&lt;/a>  

Return type

'Number'

getEconomicIndexDataPointText

View Intrinio API Documentation

'String' getEconomicIndexDataPointText(identifier, tag)

Data Point (Text) for an Economic Index

Returns a text value for the given `tag` for the Economic Index with the given `identifier`

Example

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

var index = new intrinioSDK.IndexApi();

var identifier = "$GDP";
var tag = "level";


index.getEconomicIndexDataPointText(identifier, tag).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 Index Identifier (symbol, Intrinio ID)  
tag String An Intrinio data tag ID or code-name  

Return type

'String'

getEconomicIndexHistoricalData

View Intrinio API Documentation

ApiResponseEconomicIndexHistoricalData getEconomicIndexHistoricalData(identifier, tag, opts)

Historical Data for an Economic Index

Returns historical data for a specified Federal Reserve Economic Data (FRED) ID over a period of time.

Example

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

var index = new intrinioSDK.IndexApi();

var identifier = "$GDP";
var tag = "level";


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

index.getEconomicIndexHistoricalData(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 Index Identifier (symbol, Intrinio ID)  
tag String An Intrinio data tag <a href='https://data.intrinio.com/data-tags/economic&#39;&gt;reference&lt;/a>  
type String Filter by type, when applicable [optional]  
startDate Date Get historical data on or after this date [optional]  
endDate Date Get historical data 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

ApiResponseEconomicIndexHistoricalData

getEodIndexPriceById

View Intrinio API Documentation

ApiResponseEodIndexPrices getEodIndexPriceById(identifier, opts)

End of Day Index Prices By Identifier

Example

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

var index = new intrinioSDK.IndexApi();

var identifier = "SPX";


var opts = { 
  'pageSize': 100,
  'startDate': null,
  'endDate': null
};

index.getEodIndexPriceById(identifier, 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 The index symbol  
pageSize Number The number of results to return [optional] [default to 100]  
startDate Date Limit prices to those on or after this date [optional]  
endDate Date Limit prices to those on or before this date [optional]  

Return type

ApiResponseEodIndexPrices

getIndexConstituentsById

View Intrinio API Documentation

ApiResponseIndexConstituents getIndexConstituentsById(identifier)

Index Constituents By Index Identifier

Example

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

var index = new intrinioSDK.IndexApi();

var identifier = "DJI";


index.getIndexConstituentsById(identifier).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String The index symbol  

Return type

ApiResponseIndexConstituents

getIndexSummaryById

View Intrinio API Documentation

ApiResponseIndex getIndexSummaryById(identifier)

Index Summary By Identifier

Example

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

var index = new intrinioSDK.IndexApi();

var identifier = "SPX";


index.getIndexSummaryById(identifier).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String The index symbol  

Return type

ApiResponseIndex

getRealtimeIndexPriceById

View Intrinio API Documentation

RealtimeIndexPrice getRealtimeIndexPriceById(identifier)

Realtime Index Price By Identifier

Example

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

var index = new intrinioSDK.IndexApi();

var identifier = "SPX";


index.getRealtimeIndexPriceById(identifier).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String The index symbol  

Return type

RealtimeIndexPrice

getSicIndexById

View Intrinio API Documentation

SICIndex getSicIndexById(identifier)

Lookup SIC Index

Example

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

var index = new intrinioSDK.IndexApi();

var identifier = "$SIC.2911";


index.getSicIndexById(identifier).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 Index Identifier (symbol, Intrinio ID)  

Return type

SICIndex

getSicIndexDataPointNumber

View Intrinio API Documentation

'Number' getSicIndexDataPointNumber(identifier, tag)

Data Point (Number) for an SIC Index

Returns a numeric value for the given `tag` for the SIC Index with the given `identifier`

Example

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

var index = new intrinioSDK.IndexApi();

var identifier = "$SIC.2911";
var tag = "marketcap";


index.getSicIndexDataPointNumber(identifier, tag).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 Index Identifier (symbol, Intrinio ID)  
tag String An Intrinio data tag ID or code-name  

Return type

'Number'

getSicIndexDataPointText

View Intrinio API Documentation

'String' getSicIndexDataPointText(identifier, tag)

Data Point (Text) for an SIC Index

Returns a text value for the given `tag` for the SIC Index with the given `identifier`

Example

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

var index = new intrinioSDK.IndexApi();

var identifier = "$SIC.2911";
var tag = "marketcap";


index.getSicIndexDataPointText(identifier, tag).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 Index Identifier (symbol, Intrinio ID)  
tag String An Intrinio data tag ID or code-name  

Return type

'String'

getSicIndexHistoricalData

View Intrinio API Documentation

ApiResponseSICIndexHistoricalData getSicIndexHistoricalData(identifier, tag, opts)

Historical Data for an SIC Index

Returns historical values for the given `tag` and the SIC Index with the given `identifier`

Example

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

var index = new intrinioSDK.IndexApi();

var identifier = "$SIC.1";
var tag = "marketcap";


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

index.getSicIndexHistoricalData(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 Index Identifier (symbol, Intrinio ID)  
tag String An Intrinio data tag ID or code-name  
type String Filter by type, when applicable [optional]  
startDate Date Get historical data on or after this date [optional]  
endDate Date Get historical data 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

ApiResponseSICIndexHistoricalData

getStockMarketIndexById

View Intrinio API Documentation

StockMarketIndex getStockMarketIndexById(identifier)

Lookup Stock Market Index

Example

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

var index = new intrinioSDK.IndexApi();

var identifier = "$DJI";


index.getStockMarketIndexById(identifier).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 Index Identifier (symbol, Intrinio ID)  

Return type

StockMarketIndex

getStockMarketIndexDataPointNumber

View Intrinio API Documentation

'Number' getStockMarketIndexDataPointNumber(identifier, tag)

Data Point (Number) for Stock Market Index

Returns a numeric value for the given `tag` for the Stock Market Index with the given `identifier`

Example

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

var index = new intrinioSDK.IndexApi();

var identifier = "$DJI";
var tag = "level";


index.getStockMarketIndexDataPointNumber(identifier, tag).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 Index Identifier (symbol, Intrinio ID)  
tag String An Intrinio data tag ID or code-name  

Return type

'Number'

getStockMarketIndexDataPointText

View Intrinio API Documentation

'String' getStockMarketIndexDataPointText(identifier, tag)

Data Point (Text) for Stock Market Index

Returns a text value for the given `tag` for the Stock Market Index with the given `identifier`

Example

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

var index = new intrinioSDK.IndexApi();

var identifier = "$DJI";
var tag = "level";


index.getStockMarketIndexDataPointText(identifier, tag).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 Index Identifier (symbol, Intrinio ID)  
tag String An Intrinio data tag ID or code-name  

Return type

'String'

getStockMarketIndexHistoricalData

View Intrinio API Documentation

ApiResponseStockMarketIndexHistoricalData getStockMarketIndexHistoricalData(identifier, tag, opts)

Historical Data for Stock Market Index

Returns historical values for the given `tag` and the Stock Market Index with the given `identifier`

Example

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

var index = new intrinioSDK.IndexApi();

var identifier = "$DJI";
var tag = "level";


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

index.getStockMarketIndexHistoricalData(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 Index Identifier (symbol, Intrinio ID)  
tag String An Intrinio data tag ID or code-name  
type String Filter by type, when applicable [optional]  
startDate Date Get historical data on or after this date [optional]  
endDate Date Get historical data 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

ApiResponseStockMarketIndexHistoricalData

searchEconomicIndices

View Intrinio API Documentation

ApiResponseEconomicIndicesSearch searchEconomicIndices(query, opts)

Search Economic Indices

Search the Federal Reserve Economic Data (FRED) database and return a list of economic indices matching the text query parameter passed through.

Example

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

var index = new intrinioSDK.IndexApi();

var query = "GDP";


var opts = { 
  'pageSize': 100
};

index.searchEconomicIndices(query, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
query String Search query  
pageSize Number The number of results to return [optional] [default to 100]  

Return type

ApiResponseEconomicIndicesSearch

searchSicIndices

View Intrinio API Documentation

ApiResponseSICIndicesSearch searchSicIndices(query, opts)

Search SIC Indices

Searches for indices using the text in `query`

Example

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

var index = new intrinioSDK.IndexApi();

var query = "agriculture";


var opts = { 
  'pageSize': 100
};

index.searchSicIndices(query, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
query String Search query  
pageSize Number The number of results to return [optional] [default to 100]  

Return type

ApiResponseSICIndicesSearch

searchStockMarketsIndices

View Intrinio API Documentation

ApiResponseStockMarketIndicesSearch searchStockMarketsIndices(query, opts)

Search Stock Market Indices

Searches for indices using the text in `query`

Example

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

var index = new intrinioSDK.IndexApi();

var query = "dow";


var opts = { 
  'pageSize': 100
};

index.searchStockMarketsIndices(query, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
query String Search query  
pageSize Number The number of results to return [optional] [default to 100]  

Return type

ApiResponseStockMarketIndicesSearch