intrinio-sdk 5.2.0 → 5.6.1

data/docs/ETFAnalytics.md

@@ -0,0 +1,31 @@
+
+
+[//]: # (CLASS:Intrinio::ETFAnalytics)
+
+[//]: # (KIND:object)
+
+### Intrinio::ETFAnalytics
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**fifty_two_week_high** | Float | Highest trading price for the security in the preceding 52 weeks  
+**fifty_two_week_low** | Float | Lowest trading price for the security in the preceding 52 weeks  
+**volume_traded** | Float | The total quantity of shares traded on the latest trading day  
+**average_daily_volume_one_month** | Float | The average quantity of shares traded per day for the last month  
+**average_daily_volume_three_month** | Float | The average quantity of shares traded per day for the last three months  
+**average_daily_volume_six_month** | Float | The average quantity of shares traded per day for the last six months  
+**market_cap** | Float | The market capitalization for the Exchange Traded Fund (ETF)  
+**shares_outstanding** | Float | The number of shares outstanding for the Exchange Traded Fund (ETF)  
+**etf** | [**ETFSummary**](ETFSummary.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::ETFSummary)
+
+
+

data/docs/ETFHolding.md

@@ -0,0 +1,37 @@
+
+
+[//]: # (CLASS:Intrinio::ETFHolding)
+
+[//]: # (KIND:object)
+
+### Intrinio::ETFHolding
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**as_of_date** | Date | The date on which the holding and their weights correspond  
+**name** | String | The common name for the holding  
+**ticker** | String | The common exchange ticker for the holding  
+**type** | String | The type of instrument for this holding.  Examples (Bond = 'BOND', Equity = 'EQUI', Options = 'OPTN')  
+**composite_figi** | String | The OpenFIGI ticker for the holding  
+**isin** | String | International Securities Identification Number (ISIN) for the holding  
+**ric** | String | Reuters Instrument Code (RIC) for the holding  
+**sedol** | String | Stock Exchange Daily Official List (SEDOL) for the holding  
+**face** | Float | Face value of the debt security, if available  
+**coupon** | Float | Coupon rate of the debt security, if available  
+**market_value_held** | Float | The market value of this holding in the ETF as of the `as_of_date`  
+**notional_value** | Float | Notional value of derivatives contracts held in the Exchange Traded Fund (ETF) or Exchange Traded Note (ETN)  
+**maturity** | Date | Maturity date for the debt security, if available  
+**quantity_held** | Float | Number of units of the security held if available  
+**weighting** | Float | Fraction of the funds market value held  
+**quantity_units** | Float | The unit of the `quanity_held` field. Examples ('oz', 'shares', 'contracts')  
+**quantity_per_share** | Float | Number of units of the security held per units of shares outstanding of the Exchange Traded Fund (ETF), if available  
+**contract_expiry_date** | Date | Expiry date for the futures contract held in the Exchange Traded Fund (ETF) or Exchange Traded Note (ETN)  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/ETFStats.md

@@ -0,0 +1,53 @@
+
+
+[//]: # (CLASS:Intrinio::ETFStats)
+
+[//]: # (KIND:object)
+
+### Intrinio::ETFStats
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**date** | Date |   
+**net_asset_value** | Float | The net asset value (NAV = Total Assets - Total Liabilities)  
+**beta_vs_spy** | Float | Volatility this ETF is versus the SPY ETF  
+**trailing_one_month_return_split_and_dividend** | Float | Trailing one month return including dividends  
+**trailing_one_month_return_split_only** | Float | Trailing one month return excluding dividends  
+**trailing_one_year_return_split_and_dividend** | Float | Trailing one year return including dividends  
+**trailing_one_year_return_split_only** | Float | Trailing one year return excluding dividends  
+**trailing_one_year_volatility_annualized** | Float | Annualized standard deviation of daily price returns over trailing 252 trading days  
+**trailing_three_year_annualized_return_split_and_dividend** | Float | Trailing three year return including dividends  
+**trailing_three_year_annualized_return_split_only** | Float | Trailing three year return excluding dividends  
+**trailing_three_year_volatility_annualized** | Float | Annualized standard deviation of daily price returns over trailing 756 trading days  
+**trailing_five_year_annualized_return_split_and_dividend** | Float | Trailing five year return including dividends  
+**trailing_five_year_annualized_return_split_only** | Float | Trailing five year return excluding dividends  
+**trailing_five_year_volatility_annualized** | Float | Annualized standard  deviation  of  daily  price  returns  over  trailing 1260 trading days  
+**trailing_ten_year_annualized_return_split_and_dividend** | Float | Trailing ten year return including dividends  
+**trailing_ten_year_annualized_return_split_only** | Float | Trailing ten year return excluding dividends  
+**inception_annualized_return_split_and_dividend** | Float | Annualized return including dividends since inception  
+**inception_annualized_return_split_only** | Float | Annualized return excluding dividends since inception  
+**calendar_year_5_return_split_and_dividend** | Float | Five years ago calendar year return including dividends  
+**calendar_year_5_return_split_only** | Float | Five years ago calendar year return excluding dividends  
+**calendar_year_4_return_split_and_dividend** | Float | Four years ago calendar year return including dividends  
+**calendar_year_4_return_split_only** | Float | Four years ago calendar year return excluding dividends  
+**calendar_year_3_return_split_and_dividend** | Float | Three years ago calendar year return including dividends  
+**calendar_year_3_return_split_only** | Float | Three years ago calendar year return excluding dividends  
+**calendar_year_2_return_split_and_dividend** | Float | Two years ago calendar year return including dividends  
+**calendar_year_2_return_split_only** | Float | Two years ago calendar year return excluding dividends  
+**calendar_year_1_return_split_and_dividend** | Float | One year ago calendar year return including dividends  
+**calendar_year_1_return_split_only** | Float | One year ago calendar year return excluding dividends  
+**calendar_year_to_date_return_split_and_dividend** | Float | Calendar year to date (YTD) return including dividends  
+**calendar_year_to_date_return_split_only** | Float | Calendar year to date (YTD) return excluding dividends  
+**etf** | [**ETFSummary**](ETFSummary.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::ETFSummary)
+
+
+

data/docs/ETFSummary.md

@@ -0,0 +1,27 @@
+
+
+[//]: # (CLASS:Intrinio::ETFSummary)
+
+[//]: # (KIND:object)
+
+### Intrinio::ETFSummary
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**id** | String | The Intrinio ID of the ETF  
+**name** | String | The common name of the ETF  
+**ticker** | String | The common ticker symbol for the ETF  
+**figi_ticker** | String | The OpenFIGI ticker for the ETF  
+**ric** | String | Reuters Instrument Code (RIC) for the ETF  
+**isin** | String | International Securities Identification Number (ISIN) for the ETF  
+**sedol** | String | Stock Exchange Daily Official List (SEDOL) for the ETF  
+**exchange_mic** | String | The exchange Market Identifier Code (MIC) from the International Standards Organization (ISO)  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/ETFsApi.md

@@ -0,0 +1,517 @@
+# Intrinio::ETFsApi
+
+All URIs are relative to *https://api-v2.intrinio.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_all_etfs**](ETFsApi.md#get_all_etfs) | **GET** /etfs | All ETFs
+[**get_etf**](ETFsApi.md#get_etf) | **GET** /etfs/{identifier} | Lookup ETF
+[**get_etf_analytics**](ETFsApi.md#get_etf_analytics) | **GET** /etfs/{identifier}/analytics | ETF Analytics
+[**get_etf_holdings**](ETFsApi.md#get_etf_holdings) | **GET** /etfs/{identifier}/holdings | ETF Holdings
+[**get_etf_stats**](ETFsApi.md#get_etf_stats) | **GET** /etfs/{identifier}/stats | Exchange Traded Fund (ETF) stats
+[**search_etfs**](ETFsApi.md#search_etfs) | **GET** /etfs/search | Search ETFs
+
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::ETFsApi)
+
+[//]: # (METHOD:get_all_etfs)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseETFs)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseETFs.md)
+
+[//]: # (OPERATION:get_all_etfs_v2)
+
+[//]: # (ENDPOINT:/etfs)
+
+[//]: # (DOCUMENT_LINK:ETFsApi.md#get_all_etfs)
+
+## **get_all_etfs**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_etfs_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseETFs get_all_etfs(opts)
+
+#### All ETFs
+
+
+Returns a list of Exchange Traded Funds (ETFs) sourced from FirstBridge
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+end
+
+eTFs_api = Intrinio::ETFsApi.new
+
+opts = { 
+  exchange: "XNAS", # String | 
+  page_size: 100, # Integer | The number of results to return
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = eTFs_api.get_all_etfs(opts)
+  pp result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling ETFsApi->get_all_etfs: #{e}"
+end
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **exchange** | String|  | [optional]   
+ **page_size** | Integer| The number of results to return | [optional] [default to 100]  
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseETFs**](ApiResponseETFs.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::ETFsApi)
+
+[//]: # (METHOD:get_etf)
+
+[//]: # (RETURN_TYPE:Intrinio::ETF)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ETF.md)
+
+[//]: # (OPERATION:get_etf_v2)
+
+[//]: # (ENDPOINT:/etfs/{identifier})
+
+[//]: # (DOCUMENT_LINK:ETFsApi.md#get_etf)
+
+## **get_etf**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_etf_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ETF get_etf(identifier)
+
+#### Lookup ETF
+
+
+Returns the Exchange Traded Fund (ETF) with the given identifier
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+end
+
+eTFs_api = Intrinio::ETFsApi.new
+
+identifier = "SPY" # String | An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
+
+
+begin
+  result = eTFs_api.get_etf(identifier)
+  pp result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling ETFsApi->get_etf: #{e}"
+end
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID) |   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ETF**](ETF.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::ETFsApi)
+
+[//]: # (METHOD:get_etf_analytics)
+
+[//]: # (RETURN_TYPE:Intrinio::ETFAnalytics)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ETFAnalytics.md)
+
+[//]: # (OPERATION:get_etf_analytics_v2)
+
+[//]: # (ENDPOINT:/etfs/{identifier}/analytics)
+
+[//]: # (DOCUMENT_LINK:ETFsApi.md#get_etf_analytics)
+
+## **get_etf_analytics**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_etf_analytics_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ETFAnalytics get_etf_analytics(identifier)
+
+#### ETF Analytics
+
+
+Returns analytics for the Exchange Traded Fund (ETF) including volume, market cap, 52 week high, and 52 week low
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+end
+
+eTFs_api = Intrinio::ETFsApi.new
+
+identifier = "SPY" # String | An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
+
+
+begin
+  result = eTFs_api.get_etf_analytics(identifier)
+  pp result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling ETFsApi->get_etf_analytics: #{e}"
+end
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID) |   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ETFAnalytics**](ETFAnalytics.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::ETFsApi)
+
+[//]: # (METHOD:get_etf_holdings)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseETFHoldings)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseETFHoldings.md)
+
+[//]: # (OPERATION:get_etf_holdings_v2)
+
+[//]: # (ENDPOINT:/etfs/{identifier}/holdings)
+
+[//]: # (DOCUMENT_LINK:ETFsApi.md#get_etf_holdings)
+
+## **get_etf_holdings**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_etf_holdings_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseETFHoldings get_etf_holdings(identifier, opts)
+
+#### ETF Holdings
+
+
+Returns the holdings sorted by weight descending and the Exchange Traded Fund (ETF) summary
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+end
+
+eTFs_api = Intrinio::ETFsApi.new
+
+identifier = "SPY" # String | An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
+
+opts = { 
+  page_size: 100, # Integer | The number of results to return
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = eTFs_api.get_etf_holdings(identifier, opts)
+  pp result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling ETFsApi->get_etf_holdings: #{e}"
+end
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| 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** | String| Gets the next page of data from a previous API call | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseETFHoldings**](ApiResponseETFHoldings.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::ETFsApi)
+
+[//]: # (METHOD:get_etf_stats)
+
+[//]: # (RETURN_TYPE:Intrinio::ETFStats)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ETFStats.md)
+
+[//]: # (OPERATION:get_etf_stats_v2)
+
+[//]: # (ENDPOINT:/etfs/{identifier}/stats)
+
+[//]: # (DOCUMENT_LINK:ETFsApi.md#get_etf_stats)
+
+## **get_etf_stats**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_etf_stats_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ETFStats get_etf_stats(identifier)
+
+#### Exchange Traded Fund (ETF) stats
+
+
+Returns daily stats for the Exchange Traded Fund (ETF) including net asset value, beta vs spy, returns, and volatility
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+end
+
+eTFs_api = Intrinio::ETFsApi.new
+
+identifier = "SPY" # String | An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
+
+
+begin
+  result = eTFs_api.get_etf_stats(identifier)
+  pp result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling ETFsApi->get_etf_stats: #{e}"
+end
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID) |   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ETFStats**](ETFStats.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::ETFsApi)
+
+[//]: # (METHOD:search_etfs)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseETFs)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseETFs.md)
+
+[//]: # (OPERATION:search_etfs_v2)
+
+[//]: # (ENDPOINT:/etfs/search)
+
+[//]: # (DOCUMENT_LINK:ETFsApi.md#search_etfs)
+
+## **search_etfs**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/search_etfs_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseETFs search_etfs(query)
+
+#### Search ETFs
+
+
+Searches for Exchange Traded Funds (ETFs) matching the text `query`
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+end
+
+eTFs_api = Intrinio::ETFsApi.new
+
+query = "iShares" # String | 
+
+
+begin
+  result = eTFs_api.search_etfs(query)
+  pp result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling ETFsApi->search_etfs: #{e}"
+end
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | String|  |   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseETFs**](ApiResponseETFs.md)
+
+[//]: # (END_OPERATION)
+