No release notes for this build

Author: ssnyder-intrinio

README.md

@@ -4,8 +4,8 @@ To get an API key, [sign up here](https://intrinio.com/).
 
 Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-- API version: 2.103.0
-- Package version: 6.39.0
+- API version: 2.107.0
+- Package version: 6.40.0
 
 
 ## Requirements.
@@ -134,6 +134,7 @@ Class | Method | HTTP request | Description
 *ETFsApi* | [**get_all_etfs**](docs/ETFsApi.md#get_all_etfs) | **GET** /etfs | All ETFs
 *ETFsApi* | [**get_etf**](docs/ETFsApi.md#get_etf) | **GET** /etfs/{identifier} | Lookup ETF
 *ETFsApi* | [**get_etf_analytics**](docs/ETFsApi.md#get_etf_analytics) | **GET** /etfs/{identifier}/analytics | ETF Analytics
+*ETFsApi* | [**get_etf_historical_stats**](docs/ETFsApi.md#get_etf_historical_stats) | **GET** /etfs/{identifier}/historical_stats | Exchange Traded Fund (ETF) stats
 *ETFsApi* | [**get_etf_holdings**](docs/ETFsApi.md#get_etf_holdings) | **GET** /etfs/{identifier}/holdings | ETF Holdings
 *ETFsApi* | [**get_etf_stats**](docs/ETFsApi.md#get_etf_stats) | **GET** /etfs/{identifier}/stats | Exchange Traded Fund (ETF) stats
 *ETFsApi* | [**search_etfs**](docs/ETFsApi.md#search_etfs) | **GET** /etfs/search | Search ETFs
@@ -276,6 +277,8 @@ Class | Method | HTTP request | Description
 *SecurityApi* | [**get_security_replay_file**](docs/SecurityApi.md#get_security_replay_file) | **GET** /securities/replay | Security Replay File
 *SecurityApi* | [**get_security_snapshots**](docs/SecurityApi.md#get_security_snapshots) | **GET** /securities/snapshots | Realtime Stock Prices Snapshot
 *SecurityApi* | [**get_security_stock_price_adjustments**](docs/SecurityApi.md#get_security_stock_price_adjustments) | **GET** /securities/{identifier}/prices/adjustments | Stock Price Adjustments by Security
+*SecurityApi* | [**get_security_stock_price_adjustments_dividends**](docs/SecurityApi.md#get_security_stock_price_adjustments_dividends) | **GET** /securities/{identifier}/prices/adjustments/dividends | Dividends by Security
+*SecurityApi* | [**get_security_stock_price_adjustments_splits**](docs/SecurityApi.md#get_security_stock_price_adjustments_splits) | **GET** /securities/{identifier}/prices/adjustments/splits | Splits by Security
 *SecurityApi* | [**get_security_stock_prices**](docs/SecurityApi.md#get_security_stock_prices) | **GET** /securities/{identifier}/prices | Stock Prices by Security
 *SecurityApi* | [**get_security_trades**](docs/SecurityApi.md#get_security_trades) | **GET** /securities/trades | Security Trades
 *SecurityApi* | [**get_security_trades_by_symbol**](docs/SecurityApi.md#get_security_trades_by_symbol) | **GET** /securities/{identifier}/trades | Security Trades By Symbol
@@ -291,6 +294,8 @@ Class | Method | HTTP request | Description
 *StockExchangeApi* | [**get_stock_exchange_gainers**](docs/StockExchangeApi.md#get_stock_exchange_gainers) | **GET** /stock_exchanges/{identifier}/gainers | Top Gainers by Exchange
 *StockExchangeApi* | [**get_stock_exchange_losers**](docs/StockExchangeApi.md#get_stock_exchange_losers) | **GET** /stock_exchanges/{identifier}/losers | Top Losers by Exchange
 *StockExchangeApi* | [**get_stock_exchange_price_adjustments**](docs/StockExchangeApi.md#get_stock_exchange_price_adjustments) | **GET** /stock_exchanges/{identifier}/prices/adjustments | Stock Price Adjustments by Exchange
+*StockExchangeApi* | [**get_stock_exchange_price_adjustments_dividends**](docs/StockExchangeApi.md#get_stock_exchange_price_adjustments_dividends) | **GET** /stock_exchanges/{identifier}/prices/adjustments/dividends | Dividends by date for exchange
+*StockExchangeApi* | [**get_stock_exchange_price_adjustments_splits**](docs/StockExchangeApi.md#get_stock_exchange_price_adjustments_splits) | **GET** /stock_exchanges/{identifier}/prices/adjustments/splits | Splits by date for exchange
 *StockExchangeApi* | [**get_stock_exchange_prices**](docs/StockExchangeApi.md#get_stock_exchange_prices) | **GET** /stock_exchanges/{identifier}/prices | Stock Prices by Exchange
 *StockExchangeApi* | [**get_stock_exchange_quote**](docs/StockExchangeApi.md#get_stock_exchange_quote) | **GET** /stock_exchanges/{identifier}/quote | Realtime Quote Prices by Exchange
 *StockExchangeApi* | [**get_stock_exchange_realtime_prices**](docs/StockExchangeApi.md#get_stock_exchange_realtime_prices) | **GET** /stock_exchanges/{identifier}/prices/realtime | Realtime Stock Prices by Exchange
@@ -521,6 +526,7 @@ Class | Method | HTTP request | Description
  - [ESGRatingWithCompany](docs/ESGRatingWithCompany.md)
  - [ETF](docs/ETF.md)
  - [ETFAnalytics](docs/ETFAnalytics.md)
+ - [ETFHistoricalStats](docs/ETFHistoricalStats.md)
  - [ETFHolding](docs/ETFHolding.md)
  - [ETFStats](docs/ETFStats.md)
  - [ETFSummary](docs/ETFSummary.md)

docs/CompanyApi.md

@@ -1199,7 +1199,7 @@ Name | Type | Description  | Notes
 #### News Article Body
 
 
-Returns the body of a news article.  This endpoint requires additional authorization beyond basic news access. Please see a representative for details.
+Returns the body of a news article for moody sources.  This endpoint requires additional authorization beyond basic news access and is for your internal use only - no display. Please see a representative for details.
 
 [//]: # (END_OVERVIEW)
 

docs/ETFHistoricalStats.md

@@ -0,0 +1,32 @@
+
+
+[//]: # (CLASS:ETFHistoricalStats)
+
+[//]: # (KIND:object)
+
+### ETFHistoricalStats
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**messages** | [**list[ERRORUNKNOWN]**](.md) | A list of messages related to the request, such as warnings or errors.  
+**etf** | [**ETFSummary**](ETFSummary.md) | A brief summary of the ETF it which these stats refer.  Not included when returning historical stats.  
+**stats** | [**list[ETFStats]**](ETFStats.md) | The historical stats for the ETF  
+**next_page** | str | The token required to request the next page of the data. If null, no further results are available.  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:)
+
+
+[//]: # (CONTAINED_CLASS:ETFSummary)
+
+
+[//]: # (CONTAINED_CLASS:ETFStats)
+
+
+

docs/ETFStats.md

@@ -42,7 +42,7 @@ Name | Type | Description
 **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) |   
+**etf** | [**ETFSummary**](ETFSummary.md) | A brief summary of the ETF to which these stats refer.  Not included when part of historical stats.  
 
 [//]: # (END_DEFINITION)
 

docs/ETFsApi.md

@@ -7,6 +7,7 @@ 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_historical_stats**](ETFsApi.md#get_etf_historical_stats) | **GET** /etfs/{identifier}/historical_stats | Exchange Traded Fund (ETF) stats
 [**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
@@ -242,6 +243,87 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:ETFsApi)
+
+[//]: # (METHOD:get_etf_historical_stats)
+
+[//]: # (RETURN_TYPE:ETFHistoricalStats)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ETFHistoricalStats.md)
+
+[//]: # (OPERATION:get_etf_historical_stats_v2)
+
+[//]: # (ENDPOINT:/etfs/{identifier}/historical_stats)
+
+[//]: # (DOCUMENT_LINK:ETFsApi.md#get_etf_historical_stats)
+
+## **get_etf_historical_stats**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/python/get_etf_historical_stats_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ETFHistoricalStats get_etf_historical_stats(identifier, start_date=start_date, end_date=end_date, page_size=page_size)
+
+#### Exchange Traded Fund (ETF) stats
+
+
+Returns comprehensive key US ETF historical performance statistics, including prices, NAVs, flows, returns, and much more for both trailing and calendar year periods.
+
+[//]: # (END_OVERVIEW)
+
+### Example
+[//]: # (START_CODE_EXAMPLE)
+
+```python
+from __future__ import print_function
+import time
+import intrinio_sdk as intrinio
+from intrinio_sdk.rest import ApiException
+
+intrinio.ApiClient().set_api_key('YOUR_API_KEY')
+intrinio.ApiClient().allow_retries(True)
+
+identifier = 'SPY'
+start_date = '2020-01-01'
+end_date = '2020-12-31'
+page_size = 100
+
+response = intrinio.ETFsApi().get_etf_historical_stats(identifier, start_date=start_date, end_date=end_date, page_size=page_size)
+print(response)
+    
+# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
+```
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | str| An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID) |    
+ **start_date** | date| The start date for the historical stats data in YYYY-MM-DD format. | [optional]    
+ **end_date** | date| The end date for the historical stats data in YYYY-MM-DD format. | [optional]    
+ **page_size** | int| The maximum number of results to return per page. | [optional] [default to 100]   
+<br/>
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ETFHistoricalStats**](ETFHistoricalStats.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:ETFsApi)

docs/Filing.md

@@ -24,6 +24,9 @@ Name | Type | Description
 **industry_category** | str | The company's operating industry category  
 **industry_group** | str | The company's operating industry group  
 **word_count** | int | The number of words in the filing  
+**earnings_disclosed_at** | datetime | The date and time when the earnings information was first disclosed via 8-K filing  
+**earnings_disclosed_8k_id** | str | The Intrinio ID of the 8-K filing where earnings were first disclosed  
+**earnings_8k_url** | str | The URL to the 8-K filing page on the SEC site where earnings were first disclosed  
 **company** | [**CompanySummary**](CompanySummary.md) |   
 
 [//]: # (END_DEFINITION)

docs/Fundamental.md

@@ -22,6 +22,8 @@ Name | Type | Description
 **filing_date** | datetime | The date and time when the Fundamental was filed with the SEC  
 **is_latest** | bool | Is this the latest fundamental available based on the company's most recent filings? Use the Lookup Fundamental endpoint to find the latest fundamental (<a href=\"https://docs.intrinio.com/documentation/web_api/lookup_fundamental_v2\" target=\"_blank\">reference</a>)  
 **updated_date** | datetime | The date and time when the fundamental was last updated  
+**first_calculable** | datetime | The date and time when the fundamental was first calculable  
+**earnings_disclosed_at** | datetime | The date and time when the earnings information was first disclosed via 8-K filing  
 **company** | [**CompanySummary**](CompanySummary.md) | The Company that the Fundamental was belongs to  
 
 [//]: # (END_DEFINITION)

docs/OptionsApi.md

@@ -920,7 +920,7 @@ Name | Type | Description  | Notes
 
 [//]: # (START_OVERVIEW)
 
-> ApiResponseOptionsChainRealtime get_options_chain_realtime(symbol, expiration, source=source, type=type, strike=strike, strike_greater_than=strike_greater_than, strike_less_than=strike_less_than, volume_greater_than=volume_greater_than, volume_less_than=volume_less_than, open_interest_greater_than=open_interest_greater_than, open_interest_less_than=open_interest_less_than, moneyness=moneyness, stock_price_source=stock_price_source, model=model, show_extended_price=show_extended_price, include_related_symbols=include_related_symbols)
+> ApiResponseOptionsChainRealtime get_options_chain_realtime(symbol, expiration, source=source, type=type, strike=strike, strike_greater_than=strike_greater_than, strike_less_than=strike_less_than, volume_greater_than=volume_greater_than, volume_less_than=volume_less_than, open_interest_greater_than=open_interest_greater_than, open_interest_less_than=open_interest_less_than, moneyness=moneyness, stock_price_source=stock_price_source, model=model, show_extended_price=show_extended_price, include_related_symbols=include_related_symbols, show_stats=show_stats)
 
 #### Options Chain Realtime
 
@@ -950,8 +950,9 @@ stock_price_source = ''
 model = ''
 show_extended_price = ''
 include_related_symbols = False
+show_stats = ''
 
-response = intrinio.OptionsApi().get_options_chain_realtime(symbol, expiration, source=source, type=type, moneyness=moneyness, stock_price_source=stock_price_source, model=model, show_extended_price=show_extended_price, include_related_symbols=include_related_symbols)
+response = intrinio.OptionsApi().get_options_chain_realtime(symbol, expiration, source=source, type=type, moneyness=moneyness, stock_price_source=stock_price_source, model=model, show_extended_price=show_extended_price, include_related_symbols=include_related_symbols, show_stats=show_stats)
 print(response)
 
 # Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
@@ -983,6 +984,7 @@ Name | Type | Description  | Notes
  **model** | str| Model for calculating Greek values. Default is black_scholes. | [optional]    
  **show_extended_price** | bool| Whether to include open close high low type fields. | [optional]    
  **include_related_symbols** | bool| Include related symbols that end in a 1 or 2 because of a corporate action. | [optional]    
+ **show_stats** | bool| Whether to include Greek calculations or not. | [optional]    
 <br/>
 
 [//]: # (END_PARAMETERS)
@@ -1261,7 +1263,7 @@ Name | Type | Description  | Notes
 
 [//]: # (START_OVERVIEW)
 
-> ApiResponseOptionsGreeksByTickerRealtime get_options_greeks_by_ticker(identifier, source=source, model=model, iv_mode=iv_mode, stock_price_source=stock_price_source, expiration_start_date=expiration_start_date, expiration_end_date=expiration_end_date, strike=strike, strike_greater_than=strike_greater_than, strike_less_than=strike_less_than, page_size=page_size)
+> ApiResponseOptionsGreeksByTickerRealtime get_options_greeks_by_ticker(identifier, source=source, model=model, iv_mode=iv_mode, stock_price_source=stock_price_source, expiration_start_date=expiration_start_date, expiration_end_date=expiration_end_date, strike=strike, strike_greater_than=strike_greater_than, strike_less_than=strike_less_than, page_size=page_size, next_page=next_page)
 
 #### Options Realtime Greeks & Derived Price by Ticker
 
@@ -1293,8 +1295,9 @@ strike = 3.4
 strike_greater_than = 3.4
 strike_less_than = 3.4
 page_size = 250
+next_page = ''
 
-response = intrinio.OptionsApi().get_options_greeks_by_ticker(identifier, source=source, model=model, iv_mode=iv_mode, stock_price_source=stock_price_source, expiration_start_date=expiration_start_date, expiration_end_date=expiration_end_date, strike=strike, strike_greater_than=strike_greater_than, strike_less_than=strike_less_than, page_size=page_size)
+response = intrinio.OptionsApi().get_options_greeks_by_ticker(identifier, source=source, model=model, iv_mode=iv_mode, stock_price_source=stock_price_source, expiration_start_date=expiration_start_date, expiration_end_date=expiration_end_date, strike=strike, strike_greater_than=strike_greater_than, strike_less_than=strike_less_than, page_size=page_size, next_page=next_page)
 print(response)
 
 # Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
@@ -1321,6 +1324,7 @@ Name | Type | Description  | Notes
  **strike_greater_than** | float| Filter options by minimum strike price | [optional]   &nbsp;
  **strike_less_than** | float| Filter options by maximum strike price | [optional]   &nbsp;
  **page_size** | int| Number of results to return per page | [optional] [default to 250]  &nbsp;
+ **next_page** | str| Gets the next page of data from a previous API call | [optional]   &nbsp;
 <br/>
 
 [//]: # (END_PARAMETERS)
@@ -2175,7 +2179,7 @@ Name | Type | Description  | Notes
 
 [//]: # (START_OVERVIEW)
 
-> ApiResponseOptionsPricesByTickerRealtime get_options_prices_realtime_by_ticker(symbol, source=source, iv_mode=iv_mode, next_page=next_page, page_size=page_size, stock_price_source=stock_price_source, model=model, show_extended_price=show_extended_price, expiration_start_date=expiration_start_date, expiration_end_date=expiration_end_date, strike=strike)
+> ApiResponseOptionsPricesByTickerRealtime get_options_prices_realtime_by_ticker(symbol, source=source, iv_mode=iv_mode, next_page=next_page, page_size=page_size, stock_price_source=stock_price_source, model=model, show_extended_price=show_extended_price, expiration_start_date=expiration_start_date, expiration_end_date=expiration_end_date, strike=strike, show_stats=show_stats, next_page2=next_page2)
 
 #### Option Prices Realtime By Ticker
 
@@ -2207,8 +2211,10 @@ show_extended_price = ''
 expiration_start_date = "2024-01-01"
 expiration_end_date = "2024-02-02"
 strike = 100.0
+show_stats = ''
+next_page2 = ''
 
-response = intrinio.OptionsApi().get_options_prices_realtime_by_ticker(symbol, source=source, iv_mode=iv_mode, next_page=next_page, page_size=page_size, stock_price_source=stock_price_source, model=model, show_extended_price=show_extended_price, expiration_start_date=expiration_start_date, expiration_end_date=expiration_end_date, strike=strike)
+response = intrinio.OptionsApi().get_options_prices_realtime_by_ticker(symbol, source=source, iv_mode=iv_mode, next_page=next_page, page_size=page_size, stock_price_source=stock_price_source, model=model, show_extended_price=show_extended_price, expiration_start_date=expiration_start_date, expiration_end_date=expiration_end_date, strike=strike, show_stats=show_stats, next_page2=next_page2)
 print(response)
 
 # Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
@@ -2235,6 +2241,8 @@ Name | Type | Description  | Notes
  **expiration_start_date** | [**object**](.md)| Filter out contracts that expire before this date. | [optional]   &nbsp;
  **expiration_end_date** | [**object**](.md)| Filter out contracts that expire after this date. | [optional]   &nbsp;
  **strike** | float| Filter out contracts that have this strike price. | [optional]   &nbsp;
+ **show_stats** | bool| Whether to include Greek calculations or not. | [optional]   &nbsp;
+ **next_page2** | str| Gets the next page of data from a previous API call | [optional]   &nbsp;
 <br/>
 
 [//]: # (END_PARAMETERS)