Skip to content

ETFsApi.md

Latest commit

 

History

History
861 lines (494 loc) · 20 KB

ETFsApi.md

File metadata and controls

861 lines (494 loc) · 20 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
getEtfHistoricalNavFlows GET /etfs/{identifier}/nav_flows/historical Exchange Traded Fund (ETF) Historical NAV Flows
getEtfHistoricalStats GET /etfs/{identifier}/historical_stats Exchange Traded Fund (ETF) Historical Stats
getEtfHoldings GET /etfs/{identifier}/holdings ETF Holdings
getEtfNavFlows GET /etfs/{identifier}/nav_flows Exchange Traded Fund (ETF) NAV Flows
getEtfStats GET /etfs/{identifier}/stats Exchange Traded Fund (ETF) Stats
getEtfsNavFlows GET /etfs/nav_flows Exchange Traded Funds (ETFs) Latest NAV Flows
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

getEtfHistoricalNavFlows

View Intrinio API Documentation

ETFNavFlowsHistorical getEtfHistoricalNavFlows(identifier, opts)

Exchange Traded Fund (ETF) Historical NAV Flows

Returns a list of historical NAV (Net Asset Value) and flows data for Exchange Traded Funds. Includes NAV returns, NAV values, net flows data, share outstanding counts, and total net assets across multiple dates with pagination support.

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 = { 
  'startDate': new Date("2013-10-20"),
  'endDate': new Date("2013-10-20"),
  'pageSize': 100,
  'nextPage': "nextPage_example"
};

eTFs.getEtfHistoricalNavFlows(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)  
startDate Date Return NAV flows on or after this date [optional]  
endDate Date Return NAV flows on or before this date [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

ETFNavFlowsHistorical

getEtfHistoricalStats

View Intrinio API Documentation

ETFHistoricalStats getEtfHistoricalStats(identifier, opts)

Exchange Traded Fund (ETF) Historical Stats

Returns comprehensive key US ETF historical 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";


var opts = { 
  'startDate': new Date("2020-01-01"),
  'endDate': new Date("2020-12-31"),
  'pageSize': 100
};

eTFs.getEtfHistoricalStats(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)  
startDate Date The start date for the historical stats data in YYYY-MM-DD format. [optional]  
endDate Date The end date for the historical stats data in YYYY-MM-DD format. [optional]  
pageSize Number The maximum number of results to return per page. [optional] [default to 100]  

Return type

ETFHistoricalStats

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

getEtfNavFlows

View Intrinio API Documentation

ETFNavFlows getEtfNavFlows(identifier, opts)

Exchange Traded Fund (ETF) NAV Flows

Returns NAV (Net Asset Value) and flows data for Exchange Traded Funds. Includes NAV returns (daily, monthly, quarterly, yearly, annualized), NAV values (unadjusted and adjusted for splits/dividends), net flows data, share outstanding counts, and total net assets.

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 = { 
  'startDate': new Date("2013-10-20"),
  'endDate': new Date("2013-10-20"),
  'pageSize': 100,
  'nextPage': "nextPage_example"
};

eTFs.getEtfNavFlows(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)  
startDate Date Return NAV flows on or after this date [optional]  
endDate Date Return NAV flows on or before this date [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

ETFNavFlows

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

getEtfsNavFlows

View Intrinio API Documentation

ETFNavFlowsAll getEtfsNavFlows(opts)

Exchange Traded Funds (ETFs) Latest NAV Flows

Returns the latest NAV (Net Asset Value) and flows data for all Exchange Traded Funds in the specified country, sorted by month-end assets in descending order. Each ETF appears only once with its most recent NAV flows data.

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 = { 
  'countryCode': "US",
  'pageSize': 100,
  'nextPage': "nextPage_example"
};

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

Parameters

Name Type Description Notes
countryCode String The ISO country code to filter ETFs by (e.g., US, CA, GB). Defaults to US. [optional] [default to US]  
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

ETFNavFlowsAll

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