Skip to content

Latest commit

 

History

History
520 lines (298 loc) · 10.9 KB

ETFsApi.md

File metadata and controls

520 lines (298 loc) · 10.9 KB

IntrinioSDK::ETFsApi

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

Method HTTP request Description
get_all_etfs GET /etfs All ETFs
get_etf GET /etfs/{identifier} Lookup ETF
get_etf_analytics GET /etfs/{identifier}/analytics ETF Analytics
get_etf_holdings GET /etfs/{identifier}/holdings ETF Holdings
get_etf_stats GET /etfs/{identifier}/stats Exchange Traded Fund (ETF) stats
search_etfs GET /etfs/search Search ETFs

get_all_etfs

View Intrinio API Documentation

ApiResponseETFs get_all_etfs(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

# Setup client
client <- IntrinioSDK::ApiClient$new()

# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"

#Configure retries
client$configuration$allowRetries <- TRUE

# Setup API with client
ETFsApi <- IntrinioSDK::ETFsApi$new(client)

# Optional params
opts <- list(
  exchange = "XNAS",
  page_size = 100,
  next_page = NULL
)

response <- ETFsApi$get_all_etfs(opts)

print(response)
print(response$content)

Parameters

Name Type Description Notes
exchange Character [optional]  
page_size Integer The number of results to return [optional] [default to 100]  
next_page Character Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseETFs

get_etf

View Intrinio API Documentation

ETF get_etf(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

# Setup client
client <- IntrinioSDK::ApiClient$new()

# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"

#Configure retries
client$configuration$allowRetries <- TRUE

# Setup API with client
ETFsApi <- IntrinioSDK::ETFsApi$new(client)

# Required params
identifier <- "SPY"

response <- ETFsApi$get_etf(identifier)

print(response)
print(response$content)

Parameters

Name Type Description Notes
identifier Character An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)  

Return type

ETF

get_etf_analytics

View Intrinio API Documentation

ETFAnalytics get_etf_analytics(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

# Setup client
client <- IntrinioSDK::ApiClient$new()

# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"

#Configure retries
client$configuration$allowRetries <- TRUE

# Setup API with client
ETFsApi <- IntrinioSDK::ETFsApi$new(client)

# Required params
identifier <- "SPY"

response <- ETFsApi$get_etf_analytics(identifier)

print(response)
print(response$content)

Parameters

Name Type Description Notes
identifier Character An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)  

Return type

ETFAnalytics

get_etf_holdings

View Intrinio API Documentation

ApiResponseETFHoldings get_etf_holdings(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

# Setup client
client <- IntrinioSDK::ApiClient$new()

# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"

#Configure retries
client$configuration$allowRetries <- TRUE

# Setup API with client
ETFsApi <- IntrinioSDK::ETFsApi$new(client)

# Required params
identifier <- "SPY"

# Optional params
opts <- list(
  page_size = 100,
  next_page = NULL
)

response <- ETFsApi$get_etf_holdings(identifier, opts)

print(response)
print(response$content)

Parameters

Name Type Description Notes
identifier Character An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)  
page_size Integer The number of results to return [optional] [default to 100]  
next_page Character Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseETFHoldings

get_etf_stats

View Intrinio API Documentation

ETFStats get_etf_stats(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

# Setup client
client <- IntrinioSDK::ApiClient$new()

# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"

#Configure retries
client$configuration$allowRetries <- TRUE

# Setup API with client
ETFsApi <- IntrinioSDK::ETFsApi$new(client)

# Required params
identifier <- "SPY"

response <- ETFsApi$get_etf_stats(identifier)

print(response)
print(response$content)

Parameters

Name Type Description Notes
identifier Character An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)  

Return type

ETFStats

search_etfs

View Intrinio API Documentation

ApiResponseETFs search_etfs(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

# Setup client
client <- IntrinioSDK::ApiClient$new()

# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"

#Configure retries
client$configuration$allowRetries <- TRUE

# Setup API with client
ETFsApi <- IntrinioSDK::ETFsApi$new(client)

# Required params
query <- "iShares"

# Optional params
opts <- list(
  mode = NULL
)

response <- ETFsApi$search_etfs(query, opts)

print(response)
print(response$content)

Parameters

Name Type Description Notes
query Character  
mode Character When set, changes search mode to the specified mode. Paging is not available in rank_order. [optional]  

Return type

ApiResponseETFs