Release 6.21.0

intrinio · Aug 3, 2022 · d2b12e3 · d2b12e3
1 parent 563474a
commit d2b12e3
Show file tree

Hide file tree

Showing 578 changed files with 8,149 additions and 582 deletions.
diff --git a/README.md b/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.28.0
-- Package version: 5.21.0
+- API version: 2.28.4
+- Package version: 6.21.0
 
 
 ## Requirements.
@@ -123,8 +123,10 @@ Class | Method | HTTP request | Description
 *DataTagApi* | [**get_data_tag_by_id**](docs/DataTagApi.md#get_data_tag_by_id) | **GET** /data_tags/{identifier} | Lookup Data Tag
 *DataTagApi* | [**search_data_tags**](docs/DataTagApi.md#search_data_tags) | **GET** /data_tags/search | Search Data Tags
 *ESGApi* | [**get_esg_companies**](docs/ESGApi.md#get_esg_companies) | **GET** /esg/companies | ESG Companies
+*ESGApi* | [**get_esg_company_comprehensive_ratings**](docs/ESGApi.md#get_esg_company_comprehensive_ratings) | **GET** /esg/{identifier}/comprehensive | ESG Company Comprehensive Ratings History
 *ESGApi* | [**get_esg_company_ratings**](docs/ESGApi.md#get_esg_company_ratings) | **GET** /esg/{identifier} | ESG Company Ratings History
 *ESGApi* | [**get_esg_latest**](docs/ESGApi.md#get_esg_latest) | **GET** /esg | ESG Latest
+*ESGApi* | [**get_esg_latest_comprehensive**](docs/ESGApi.md#get_esg_latest_comprehensive) | **GET** /esg/comprehensive | ESG Latest Comprehensive
 *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
@@ -188,6 +190,7 @@ Class | Method | HTTP request | Description
 *OptionsApi* | [**get_options_prices_eod**](docs/OptionsApi.md#get_options_prices_eod) | **GET** /options/prices/{identifier}/eod | Option Prices EOD
 *OptionsApi* | [**get_options_prices_realtime**](docs/OptionsApi.md#get_options_prices_realtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
 *OptionsApi* | [**get_options_stats_realtime**](docs/OptionsApi.md#get_options_stats_realtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime
+*OptionsApi* | [**get_security_snapshots**](docs/OptionsApi.md#get_security_snapshots) | **GET** /options/snapshots | Option Prices Realtime Snapshot
 *OptionsApi* | [**get_unusual_activity**](docs/OptionsApi.md#get_unusual_activity) | **GET** /options/unusual_activity/{symbol} | Options Unusual Activity
 *OptionsApi* | [**get_unusual_activity_intraday**](docs/OptionsApi.md#get_unusual_activity_intraday) | **GET** /options/unusual_activity/{symbol}/intraday | Options Unusual Activity Intraday
 *OptionsApi* | [**get_unusual_activity_universal**](docs/OptionsApi.md#get_unusual_activity_universal) | **GET** /options/unusual_activity | Options Unusual Activity Universal
@@ -239,6 +242,7 @@ Class | Method | HTTP request | Description
 *SecurityApi* | [**get_security_price_technicals_vwap**](docs/SecurityApi.md#get_security_price_technicals_vwap) | **GET** /securities/{identifier}/prices/technicals/vwap | Volume Weighted Average Price
 *SecurityApi* | [**get_security_price_technicals_wr**](docs/SecurityApi.md#get_security_price_technicals_wr) | **GET** /securities/{identifier}/prices/technicals/wr | Williams %R
 *SecurityApi* | [**get_security_realtime_price**](docs/SecurityApi.md#get_security_realtime_price) | **GET** /securities/{identifier}/prices/realtime | Realtime Stock Price for Security
+*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_prices**](docs/SecurityApi.md#get_security_stock_prices) | **GET** /securities/{identifier}/prices | Stock Prices by Security
 *SecurityApi* | [**get_security_zacks_analyst_ratings**](docs/SecurityApi.md#get_security_zacks_analyst_ratings) | **GET** /securities/{identifier}/zacks/analyst_ratings | Zacks Analyst Ratings for Security
@@ -315,8 +319,10 @@ Class | Method | HTTP request | Description
  - [ApiResponseDataTags](docs/ApiResponseDataTags.md)
  - [ApiResponseDataTagsSearch](docs/ApiResponseDataTagsSearch.md)
  - [ApiResponseESGCompanies](docs/ApiResponseESGCompanies.md)
+ - [ApiResponseESGCompanyComprehensiveRatingHistory](docs/ApiResponseESGCompanyComprehensiveRatingHistory.md)
  - [ApiResponseESGCompanyRatingHistory](docs/ApiResponseESGCompanyRatingHistory.md)
  - [ApiResponseESGLatest](docs/ApiResponseESGLatest.md)
+ - [ApiResponseESGLatestComprehensive](docs/ApiResponseESGLatestComprehensive.md)
  - [ApiResponseETFHoldings](docs/ApiResponseETFHoldings.md)
  - [ApiResponseETFs](docs/ApiResponseETFs.md)
  - [ApiResponseEconomicIndexHistoricalData](docs/ApiResponseEconomicIndexHistoricalData.md)
@@ -442,6 +448,8 @@ Class | Method | HTTP request | Description
  - [DividendRecord](docs/DividendRecord.md)
  - [DonchianChannelTechnicalValue](docs/DonchianChannelTechnicalValue.md)
  - [ESGCompanySummary](docs/ESGCompanySummary.md)
+ - [ESGComprehensiveRating](docs/ESGComprehensiveRating.md)
+ - [ESGComprehensiveRatingWithCompany](docs/ESGComprehensiveRatingWithCompany.md)
  - [ESGRating](docs/ESGRating.md)
  - [ESGRatingWithCompany](docs/ESGRatingWithCompany.md)
  - [ETF](docs/ETF.md)
@@ -493,6 +501,8 @@ Class | Method | HTTP request | Description
  - [OptionPriceEod](docs/OptionPriceEod.md)
  - [OptionPriceRealtime](docs/OptionPriceRealtime.md)
  - [OptionRealtime](docs/OptionRealtime.md)
+ - [OptionSnapshotGroup](docs/OptionSnapshotGroup.md)
+ - [OptionSnapshotsResult](docs/OptionSnapshotsResult.md)
  - [OptionStatsRealtime](docs/OptionStatsRealtime.md)
  - [OptionUnusualTrade](docs/OptionUnusualTrade.md)
  - [Owner](docs/Owner.md)
@@ -509,6 +519,8 @@ Class | Method | HTTP request | Description
  - [SecurityScreenGroup](docs/SecurityScreenGroup.md)
  - [SecurityScreenResult](docs/SecurityScreenResult.md)
  - [SecurityScreenResultData](docs/SecurityScreenResultData.md)
+ - [SecuritySnapshotGroup](docs/SecuritySnapshotGroup.md)
+ - [SecuritySnapshotsResult](docs/SecuritySnapshotsResult.md)
  - [SecuritySummary](docs/SecuritySummary.md)
  - [SimpleMovingAverageTechnicalValue](docs/SimpleMovingAverageTechnicalValue.md)
  - [StandardizedFinancial](docs/StandardizedFinancial.md)

diff --git a/docs/ApiResponseESGCompanyComprehensiveRatingHistory.md b/docs/ApiResponseESGCompanyComprehensiveRatingHistory.md
@@ -0,0 +1,28 @@
+
+
+[//]: # (CLASS:ApiResponseESGCompanyComprehensiveRatingHistory)
+
+[//]: # (KIND:object)
+
+### ApiResponseESGCompanyComprehensiveRatingHistory
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**ratings** | [**list[ESGComprehensiveRating]**](ESGComprehensiveRating.md) |  &nbsp;
+**company** | [**ESGCompanySummary**](ESGCompanySummary.md) |  &nbsp;
+**next_page** | str | The token required to request the next page of the data. If null, no further results are available. &nbsp;
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:ESGComprehensiveRating)
+
+
+[//]: # (CONTAINED_CLASS:ESGCompanySummary)
+
+
+
diff --git a/docs/ApiResponseESGLatestComprehensive.md b/docs/ApiResponseESGLatestComprehensive.md
@@ -0,0 +1,24 @@
+
+
+[//]: # (CLASS:ApiResponseESGLatestComprehensive)
+
+[//]: # (KIND:object)
+
+### ApiResponseESGLatestComprehensive
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**ratings** | [**list[ESGComprehensiveRatingWithCompany]**](ESGComprehensiveRatingWithCompany.md) |  &nbsp;
+**next_page** | str | The token required to request the next page of the data. If null, no further results are available. &nbsp;
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:ESGComprehensiveRatingWithCompany)
+
+
+
diff --git a/docs/ESGApi.md b/docs/ESGApi.md
@@ -5,8 +5,10 @@ All URIs are relative to *https://api-v2.intrinio.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_esg_companies**](ESGApi.md#get_esg_companies) | **GET** /esg/companies | ESG Companies
+[**get_esg_company_comprehensive_ratings**](ESGApi.md#get_esg_company_comprehensive_ratings) | **GET** /esg/{identifier}/comprehensive | ESG Company Comprehensive Ratings History
 [**get_esg_company_ratings**](ESGApi.md#get_esg_company_ratings) | **GET** /esg/{identifier} | ESG Company Ratings History
 [**get_esg_latest**](ESGApi.md#get_esg_latest) | **GET** /esg | ESG Latest
+[**get_esg_latest_comprehensive**](ESGApi.md#get_esg_latest_comprehensive) | **GET** /esg/comprehensive | ESG Latest Comprehensive
 
 
 
@@ -34,7 +36,7 @@ Method | HTTP request | Description
 
 [//]: # (START_OVERVIEW)
 
-> ApiResponseESGCompanies get_esg_companies(country=country, page_size=page_size, next_page=next_page)
+> ApiResponseESGCompanies get_esg_companies(country=country, industry=industry, ticker=ticker, page_size=page_size, next_page=next_page)
 
 #### ESG Companies
 
@@ -54,11 +56,13 @@ from intrinio_sdk.rest import ApiException
 intrinio.ApiClient().set_api_key('YOUR_API_KEY')
 intrinio.ApiClient().allow_retries(True)
 
-country = 'USA'
+country = 'Canada'
+industry = 'Retail'
+ticker = 'SHOP'
 page_size = 100
 next_page = ''
 
-response = intrinio.ESGApi().get_esg_companies(country=country, page_size=page_size, next_page=next_page)
+response = intrinio.ESGApi().get_esg_companies(country=country, industry=industry, ticker=ticker, 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) 
@@ -75,6 +79,8 @@ print(response)
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **country** | str|  | [optional]   &nbsp;
+ **industry** | str|  | [optional]   &nbsp;
+ **ticker** | str|  | [optional]   &nbsp;
  **page_size** | int| The number of results to return | [optional] [default to 100]  &nbsp;
  **next_page** | str| Gets the next page of data from a previous API call | [optional]   &nbsp;
 <br/>
@@ -88,6 +94,84 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:ESGApi)
+
+[//]: # (METHOD:get_esg_company_comprehensive_ratings)
+
+[//]: # (RETURN_TYPE:ApiResponseESGCompanyComprehensiveRatingHistory)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseESGCompanyComprehensiveRatingHistory.md)
+
+[//]: # (OPERATION:get_esg_company_comprehensive_ratings_v2)
+
+[//]: # (ENDPOINT:/esg/{identifier}/comprehensive)
+
+[//]: # (DOCUMENT_LINK:ESGApi.md#get_esg_company_comprehensive_ratings)
+
+## **get_esg_company_comprehensive_ratings**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/python/get_esg_company_comprehensive_ratings_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseESGCompanyComprehensiveRatingHistory get_esg_company_comprehensive_ratings(identifier, page_size=page_size, next_page=next_page)
+
+#### ESG Company Comprehensive Ratings History
+
+
+
+[//]: # (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 = 'AAPL'
+page_size = 100
+next_page = ''
+
+response = intrinio.ESGApi().get_esg_company_comprehensive_ratings(identifier, 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) 
+```
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | str| ISIN, Intrinio ID, or Ticker |   &nbsp;
+ **page_size** | int| The number of results to return | [optional] [default to 100]  &nbsp;
+ **next_page** | str| Gets the next page of data from a previous API call | [optional]   &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseESGCompanyComprehensiveRatingHistory**](ApiResponseESGCompanyComprehensiveRatingHistory.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:ESGApi)
@@ -190,7 +274,7 @@ Name | Type | Description  | Notes
 
 [//]: # (START_OVERVIEW)
 
-> ApiResponseESGLatest get_esg_latest(country=country, country2=country2, page_size=page_size, next_page=next_page)
+> ApiResponseESGLatest get_esg_latest(country=country, page_size=page_size, next_page=next_page)
 
 #### ESG Latest
 
@@ -211,11 +295,10 @@ intrinio.ApiClient().set_api_key('YOUR_API_KEY')
 intrinio.ApiClient().allow_retries(True)
 
 country = 'USA'
-country2 = 'USA'
 page_size = 100
 next_page = ''
 
-response = intrinio.ESGApi().get_esg_latest(country=country, country2=country2, page_size=page_size, next_page=next_page)
+response = intrinio.ESGApi().get_esg_latest(country=country, 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) 
@@ -232,7 +315,6 @@ print(response)
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **country** | str|  | [optional]   &nbsp;
- **country2** | str|  | [optional]   &nbsp;
  **page_size** | int| The number of results to return | [optional] [default to 100]  &nbsp;
  **next_page** | str| Gets the next page of data from a previous API call | [optional]   &nbsp;
 <br/>
@@ -245,3 +327,81 @@ Name | Type | Description  | Notes
 
 [//]: # (END_OPERATION)
 
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:ESGApi)
+
+[//]: # (METHOD:get_esg_latest_comprehensive)
+
+[//]: # (RETURN_TYPE:ApiResponseESGLatestComprehensive)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseESGLatestComprehensive.md)
+
+[//]: # (OPERATION:get_esg_latest_comprehensive_v2)
+
+[//]: # (ENDPOINT:/esg/comprehensive)
+
+[//]: # (DOCUMENT_LINK:ESGApi.md#get_esg_latest_comprehensive)
+
+## **get_esg_latest_comprehensive**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/python/get_esg_latest_comprehensive_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseESGLatestComprehensive get_esg_latest_comprehensive(country=country, page_size=page_size, next_page=next_page)
+
+#### ESG Latest Comprehensive
+
+
+
+[//]: # (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)
+
+country = 'USA'
+page_size = 100
+next_page = ''
+
+response = intrinio.ESGApi().get_esg_latest_comprehensive(country=country, 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) 
+```
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **country** | str|  | [optional]   &nbsp;
+ **page_size** | int| The number of results to return | [optional] [default to 100]  &nbsp;
+ **next_page** | str| Gets the next page of data from a previous API call | [optional]   &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseESGLatestComprehensive**](ApiResponseESGLatestComprehensive.md)
+
+[//]: # (END_OPERATION)
+
diff --git a/docs/ESGCompanySummary.md b/docs/ESGCompanySummary.md
@@ -12,12 +12,12 @@
 
 Name | Type | Description
 ------------ | ------------- | -------------
-**id** | str |  &nbsp;
-**name** | str |  &nbsp;
-**ticker** | str |  &nbsp;
-**isin** | str |  &nbsp;
-**primary_industry** | str |  &nbsp;
-**country** | str |  &nbsp;
+**id** | str | The Intrinio ID of the company. &nbsp;
+**name** | str | The company’s common name. &nbsp;
+**ticker** | str | The stock market ticker symbol associated with the company’s common stock security. &nbsp;
+**isin** | str | The company&#39;s common securities identification 12-digit alphanumeric code. &nbsp;
+**primary_industry** | str | The primary industry associated with the company based on their main revenue generating operations. &nbsp;
+**country** | str | The country in which the company&#39;s headquarters or primary place of business is located. &nbsp;
 
 [//]: # (END_DEFINITION)