No release notes for this build

intrinio · Nov 27, 2024 · 2ea84c1 · 2ea84c1
1 parent e1ddcff
commit 2ea84c1
Show file tree

Hide file tree

Showing 670 changed files with 2,088 additions and 691 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.75.0
-- Package version: 6.33.0
+- API version: 2.76.3
+- Package version: 6.34.0
 
 
 ## Requirements.
@@ -283,6 +283,7 @@ Class | Method | HTTP request | Description
 *SecurityApi* | [**screen_securities**](docs/SecurityApi.md#screen_securities) | **POST** /securities/screen | Screen Securities
 *SecurityApi* | [**search_securities**](docs/SecurityApi.md#search_securities) | **GET** /securities/search | Search Securities
 *StockExchangeApi* | [**get_all_stock_exchanges**](docs/StockExchangeApi.md#get_all_stock_exchanges) | **GET** /stock_exchanges | All Stock Exchanges
+*StockExchangeApi* | [**get_stock_exchange_betas**](docs/StockExchangeApi.md#get_stock_exchange_betas) | **GET** /stock_exchanges/{identifier}/betas | Security Betas
 *StockExchangeApi* | [**get_stock_exchange_by_id**](docs/StockExchangeApi.md#get_stock_exchange_by_id) | **GET** /stock_exchanges/{identifier} | Lookup Stock Exchange
 *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
@@ -458,6 +459,7 @@ Class | Method | HTTP request | Description
  - [ApiResponseSecurityZacksSalesSurprises](docs/ApiResponseSecurityZacksSalesSurprises.md)
  - [ApiResponseStandardizedFinancials](docs/ApiResponseStandardizedFinancials.md)
  - [ApiResponseStandardizedFinancialsDimensions](docs/ApiResponseStandardizedFinancialsDimensions.md)
+ - [ApiResponseStockExchangeBetas](docs/ApiResponseStockExchangeBetas.md)
  - [ApiResponseStockExchangeMovers](docs/ApiResponseStockExchangeMovers.md)
  - [ApiResponseStockExchangeQuote](docs/ApiResponseStockExchangeQuote.md)
  - [ApiResponseStockExchangeRealtimeStockPrices](docs/ApiResponseStockExchangeRealtimeStockPrices.md)
@@ -486,6 +488,7 @@ Class | Method | HTTP request | Description
  - [AverageDirectionalIndexTechnicalValue](docs/AverageDirectionalIndexTechnicalValue.md)
  - [AverageTrueRangeTechnicalValue](docs/AverageTrueRangeTechnicalValue.md)
  - [AwesomeOscillatorTechnicalValue](docs/AwesomeOscillatorTechnicalValue.md)
+ - [Beta](docs/Beta.md)
  - [BollingerBandsTechnicalValue](docs/BollingerBandsTechnicalValue.md)
  - [BulkDownloadLinks](docs/BulkDownloadLinks.md)
  - [BulkDownloadSummary](docs/BulkDownloadSummary.md)

diff --git a/docs/ApiResponseStockExchangeBetas.md b/docs/ApiResponseStockExchangeBetas.md
@@ -0,0 +1,28 @@
+
+
+[//]: # (CLASS:ApiResponseStockExchangeBetas)
+
+[//]: # (KIND:object)
+
+### ApiResponseStockExchangeBetas
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**betas** | [**list[Beta]**](Beta.md) | The mover security. &nbsp;
+**stock_exchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier &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:Beta)
+
+
+[//]: # (CONTAINED_CLASS:StockExchange)
+
+
+
diff --git a/docs/Beta.md b/docs/Beta.md
@@ -0,0 +1,29 @@
+
+
+[//]: # (CLASS:Beta)
+
+[//]: # (KIND:object)
+
+### Beta
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**period_type** | str | Type of period for this beta value. &nbsp;
+**one_year_beta** | float | The one year beta value for this security. &nbsp;
+**three_year_beta** | float | The three year beta value for this security. &nbsp;
+**five_year_beta** | float | The five year beta value for this security. &nbsp;
+**seven_year_beta** | float | The seven year beta value for this security. &nbsp;
+**ten_year_beta** | float | The ten year beta value for this security. &nbsp;
+**security** | [**SecuritySummary**](SecuritySummary.md) | The Security. &nbsp;
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:SecuritySummary)
+
+
+
diff --git a/docs/OptionInterval.md b/docs/OptionInterval.md
@@ -18,9 +18,10 @@ Name | Type | Description
 **high** | float | The highest traded contract price in this interval. &nbsp;
 **low** | float | The lowest traded contract price in this interval. &nbsp;
 **close** | float | The last traded contract price in this interval. &nbsp;
-**volume** | float | The volume of contract trades in this interval. &nbsp;
+**volume** | float | The volume of contracts traded in this interval. &nbsp;
 **average** | float | The volume weighted average price of contract trades in this interval. &nbsp;
 **change** | float | The ratio of Close minus Open to Open. &nbsp;
+**trade_count** | float | The number of qualified trades executed during the period &nbsp;
 
 [//]: # (END_DEFINITION)
 

diff --git a/docs/OptionIntervalMover.md b/docs/OptionIntervalMover.md
@@ -18,8 +18,9 @@ Name | Type | Description
 **high** | float | The highest traded contract price in this interval. &nbsp;
 **low** | float | The lowest traded contract price in this interval. &nbsp;
 **close** | float | The last traded contract price in this interval. &nbsp;
-**volume** | float | The volume of contract trades in this interval. &nbsp;
+**volume** | float | The volume of contracts traded in this interval. &nbsp;
 **average** | float | The volume weighted average price of contract trades in this interval. &nbsp;
+**trade_count** | float | The number of contract trades executed in this interval &nbsp;
 
 [//]: # (END_DEFINITION)
 

diff --git a/docs/OptionsApi.md b/docs/OptionsApi.md
@@ -60,7 +60,7 @@ Method | HTTP request | Description
 
 [//]: # (START_OVERVIEW)
 
-> ApiResponseOptionsTickers get_all_options_tickers()
+> ApiResponseOptionsTickers get_all_options_tickers(use_underlying_symbols=use_underlying_symbols)
 
 #### Options Tickers
 
@@ -81,8 +81,9 @@ from intrinio_sdk.rest import ApiException
 intrinio.ApiClient().set_api_key('YOUR_API_KEY')
 intrinio.ApiClient().allow_retries(True)
 
+use_underlying_symbols = False
 
-response = intrinio.OptionsApi().get_all_options_tickers()
+response = intrinio.OptionsApi().get_all_options_tickers(use_underlying_symbols=use_underlying_symbols)
 print(response)
 
 # Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
@@ -95,7 +96,10 @@ print(response)
 
 [//]: # (START_PARAMETERS)
 
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **use_underlying_symbols** | bool| Use underlying symbol vs contract symbol | [optional] [default to False]  &nbsp;
 <br/>
 
 [//]: # (END_PARAMETERS)

diff --git a/docs/SecurityIntervalMover.md b/docs/SecurityIntervalMover.md
@@ -18,8 +18,9 @@ Name | Type | Description
 **high** | float | The highest traded price in this interval. &nbsp;
 **low** | float | The lowest traded price in this interval. &nbsp;
 **close** | float | The last traded price in this interval. &nbsp;
-**volume** | float | The volume of trades in this interval. &nbsp;
+**volume** | float | The volume of shares in this interval. &nbsp;
 **average** | float | The volume weighted average price of trades in this interval. &nbsp;
+**trade_count** | float | The of trades in this interval. &nbsp;
 
 [//]: # (END_DEFINITION)
 

diff --git a/docs/StockExchangeApi.md b/docs/StockExchangeApi.md
@@ -5,6 +5,7 @@ All URIs are relative to *https://api-v2.intrinio.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_all_stock_exchanges**](StockExchangeApi.md#get_all_stock_exchanges) | **GET** /stock_exchanges | All Stock Exchanges
+[**get_stock_exchange_betas**](StockExchangeApi.md#get_stock_exchange_betas) | **GET** /stock_exchanges/{identifier}/betas | Security Betas
 [**get_stock_exchange_by_id**](StockExchangeApi.md#get_stock_exchange_by_id) | **GET** /stock_exchanges/{identifier} | Lookup Stock Exchange
 [**get_stock_exchange_gainers**](StockExchangeApi.md#get_stock_exchange_gainers) | **GET** /stock_exchanges/{identifier}/gainers | Top Gainers by Exchange
 [**get_stock_exchange_losers**](StockExchangeApi.md#get_stock_exchange_losers) | **GET** /stock_exchanges/{identifier}/losers | Top Losers by Exchange
@@ -97,6 +98,89 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:StockExchangeApi)
+
+[//]: # (METHOD:get_stock_exchange_betas)
+
+[//]: # (RETURN_TYPE:ApiResponseStockExchangeBetas)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseStockExchangeBetas.md)
+
+[//]: # (OPERATION:get_stock_exchange_betas_v2)
+
+[//]: # (ENDPOINT:/stock_exchanges/{identifier}/betas)
+
+[//]: # (DOCUMENT_LINK:StockExchangeApi.md#get_stock_exchange_betas)
+
+## **get_stock_exchange_betas**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/python/get_stock_exchange_betas_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseStockExchangeBetas get_stock_exchange_betas(identifier, type=type, date=date, page_size=page_size, next_page=next_page)
+
+#### Security Betas
+
+
+Returns security beta data in the Stock Exchange with the given `identifier`
+
+[//]: # (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 = 'USCOMP'
+type = 'weekly'
+date = "2024-04-24"
+page_size = 100
+next_page = ''
+
+response = intrinio.StockExchangeApi().get_stock_exchange_betas(identifier, type=type, date=date, 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| A Stock Exchange identifier (MIC or Intrinio ID) |   &nbsp;
+ **type** | str| Only of the given type | [optional] [default to weekly]  &nbsp;
+ **date** | [**object**](.md)| Return data for this period end date. | [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
+
+[**ApiResponseStockExchangeBetas**](ApiResponseStockExchangeBetas.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:StockExchangeApi)

diff --git a/docs/StockPriceInterval.md b/docs/StockPriceInterval.md
@@ -36,6 +36,7 @@ Name | Type | Description
 **ask_first_time** | datetime | The timestamp that represents the first ask time from the interval span. &nbsp;
 **ask_last_time** | datetime | The timestamp that represents the last ask time from the interval span. &nbsp;
 **ask_change_percent** | float | The ratio of the close to open ask difference, in percent. &nbsp;
+**trade_count** | float | The number of qualified trades executed during the period &nbsp;
 
 [//]: # (END_DEFINITION)
 

diff --git a/intrinio_sdk/__init__.py b/intrinio_sdk/__init__.py
@@ -7,7 +7,7 @@
 
     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.  # noqa: E501
 
-    OpenAPI spec version: 2.75.0
+    OpenAPI spec version: 2.76.3
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
@@ -158,6 +158,7 @@
 from intrinio_sdk.models.api_response_security_zacks_sales_surprises import ApiResponseSecurityZacksSalesSurprises
 from intrinio_sdk.models.api_response_standardized_financials import ApiResponseStandardizedFinancials
 from intrinio_sdk.models.api_response_standardized_financials_dimensions import ApiResponseStandardizedFinancialsDimensions
+from intrinio_sdk.models.api_response_stock_exchange_betas import ApiResponseStockExchangeBetas
 from intrinio_sdk.models.api_response_stock_exchange_movers import ApiResponseStockExchangeMovers
 from intrinio_sdk.models.api_response_stock_exchange_quote import ApiResponseStockExchangeQuote
 from intrinio_sdk.models.api_response_stock_exchange_realtime_stock_prices import ApiResponseStockExchangeRealtimeStockPrices
@@ -186,6 +187,7 @@
 from intrinio_sdk.models.average_directional_index_technical_value import AverageDirectionalIndexTechnicalValue
 from intrinio_sdk.models.average_true_range_technical_value import AverageTrueRangeTechnicalValue
 from intrinio_sdk.models.awesome_oscillator_technical_value import AwesomeOscillatorTechnicalValue
+from intrinio_sdk.models.beta import Beta
 from intrinio_sdk.models.bollinger_bands_technical_value import BollingerBandsTechnicalValue
 from intrinio_sdk.models.bulk_download_links import BulkDownloadLinks
 from intrinio_sdk.models.bulk_download_summary import BulkDownloadSummary

diff --git a/intrinio_sdk/api/bulk_downloads_api.py b/intrinio_sdk/api/bulk_downloads_api.py
@@ -5,7 +5,7 @@
 
     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.  # noqa: E501
 
-    OpenAPI spec version: 2.75.0
+    OpenAPI spec version: 2.76.3
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

diff --git a/intrinio_sdk/api/company_api.py b/intrinio_sdk/api/company_api.py
@@ -5,7 +5,7 @@
 
     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.  # noqa: E501
 
-    OpenAPI spec version: 2.75.0
+    OpenAPI spec version: 2.76.3
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

diff --git a/intrinio_sdk/api/data_point_api.py b/intrinio_sdk/api/data_point_api.py
@@ -5,7 +5,7 @@
 
     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.  # noqa: E501
 
-    OpenAPI spec version: 2.75.0
+    OpenAPI spec version: 2.76.3
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

diff --git a/intrinio_sdk/api/data_tag_api.py b/intrinio_sdk/api/data_tag_api.py
@@ -5,7 +5,7 @@
 
     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.  # noqa: E501
 
-    OpenAPI spec version: 2.75.0
+    OpenAPI spec version: 2.76.3
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

diff --git a/intrinio_sdk/api/esg_api.py b/intrinio_sdk/api/esg_api.py
@@ -5,7 +5,7 @@
 
     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.  # noqa: E501
 
-    OpenAPI spec version: 2.75.0
+    OpenAPI spec version: 2.76.3
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

diff --git a/intrinio_sdk/api/et_fs_api.py b/intrinio_sdk/api/et_fs_api.py
@@ -5,7 +5,7 @@
 
     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.  # noqa: E501
 
-    OpenAPI spec version: 2.75.0
+    OpenAPI spec version: 2.76.3
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

diff --git a/intrinio_sdk/api/filing_api.py b/intrinio_sdk/api/filing_api.py
@@ -5,7 +5,7 @@
 
     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.  # noqa: E501
 
-    OpenAPI spec version: 2.75.0
+    OpenAPI spec version: 2.76.3
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

diff --git a/intrinio_sdk/api/forex_api.py b/intrinio_sdk/api/forex_api.py
@@ -5,7 +5,7 @@
 
     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.  # noqa: E501
 
-    OpenAPI spec version: 2.75.0
+    OpenAPI spec version: 2.76.3
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

diff --git a/intrinio_sdk/api/fundamentals_api.py b/intrinio_sdk/api/fundamentals_api.py
@@ -5,7 +5,7 @@
 
     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.  # noqa: E501
 
-    OpenAPI spec version: 2.75.0
+    OpenAPI spec version: 2.76.3
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

diff --git a/intrinio_sdk/api/historical_data_api.py b/intrinio_sdk/api/historical_data_api.py
@@ -5,7 +5,7 @@
 
     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.  # noqa: E501
 
-    OpenAPI spec version: 2.75.0
+    OpenAPI spec version: 2.76.3
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """