Skip to content

Latest commit

 

History

History
505 lines (284 loc) · 10.7 KB

ETFsApi.md

File metadata and controls

505 lines (284 loc) · 10.7 KB

intrinioSDK.ETFsApi

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

Method HTTP request Description
getAllEtfs GET /etfs All ETFs
getEtf GET /etfs/{identifier} Lookup ETF
getEtfAnalytics GET /etfs/{identifier}/analytics ETF Analytics
getEtfHoldings GET /etfs/{identifier}/holdings ETF Holdings
getEtfStats GET /etfs/{identifier}/stats Exchange Traded Fund (ETF) stats
searchEtfs GET /etfs/search Search ETFs

getAllEtfs

View Intrinio API Documentation

ApiResponseETFs getAllEtfs(opts)

All ETFs

Returns a list of all currently listed ETFs, with relevant identification information including the ETF Name, Ticker, FIGI Ticker, and Exchange MIC for further usage with our ETF Metadata, Holdings, Stats, and Analytics offerings.

Example

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

var eTFs = new intrinioSDK.ETFsApi();

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

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

Parameters

Name Type Description Notes
exchange String [optional]  
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

ApiResponseETFs

getEtf

View Intrinio API Documentation

ETF getEtf(identifier)

Lookup ETF

Returns classifications and reference data which consists of ~90 columns that give detailed information about an ETF. These granular details include asset class, expense ratio, index name, index weighting scheme, smart beta type and specific investment objectives.

Example

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

var eTFs = new intrinioSDK.ETFsApi();

var identifier = "SPY";


eTFs.getEtf(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 ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)  

Return type

ETF

getEtfAnalytics

View Intrinio API Documentation

ETFAnalytics getEtfAnalytics(identifier)

ETF Analytics

Returns latest market analytics for a specified US ETF, including volume, trailing volume, market cap, 52 week high, and 52 week low.

Example

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

var eTFs = new intrinioSDK.ETFsApi();

var identifier = "SPY";


eTFs.getEtfAnalytics(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 ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)  

Return type

ETFAnalytics

getEtfHoldings

View Intrinio API Documentation

ApiResponseETFHoldings getEtfHoldings(identifier, opts)

ETF Holdings

Returns holdings data that details all the constituent securities in each ETF with names, identifiers, and the weights for each security providing granular level transparency.

Example

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

var eTFs = new intrinioSDK.ETFsApi();

var identifier = "SPY";


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

eTFs.getEtfHoldings(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 An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)  
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

ApiResponseETFHoldings

getEtfStats

View Intrinio API Documentation

ETFStats getEtfStats(identifier)

Exchange Traded Fund (ETF) stats

Returns comprehensive key US ETF performance statistics, including prices, NAVs, flows, returns, and much more for both trailing and calendar year periods.

Example

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

var eTFs = new intrinioSDK.ETFsApi();

var identifier = "SPY";


eTFs.getEtfStats(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 ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)  

Return type

ETFStats

searchEtfs

View Intrinio API Documentation

ApiResponseETFs searchEtfs(query, opts)

Search ETFs

Accepts a string of keyword combinations, and searches across the ETF name and ticker and returns a list of ETFs with related keywords.

Example

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

var eTFs = new intrinioSDK.ETFsApi();

var query = "iShares";


var opts = { 
  'mode': null
};

eTFs.searchEtfs(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  
mode String When set, changes search mode to the specified mode. Paging is not available in rank_order. [optional]  

Return type

ApiResponseETFs