No release notes for this build

intrinio · Oct 31, 2024 · 9261f18 · 9261f18
1 parent 5a0dc24
commit 9261f18
Show file tree

Hide file tree

Showing 654 changed files with 2,431 additions and 662 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.70.0
-- Package version: 6.31.0
+- API version: 2.72.2
+- Package version: 6.32.0
 
 
 ## Requirements.
@@ -280,6 +280,8 @@ Class | Method | HTTP request | Description
 *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_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
 *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_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
@@ -450,6 +452,7 @@ Class | Method | HTTP request | Description
  - [ApiResponseSecurityZacksSalesSurprises](docs/ApiResponseSecurityZacksSalesSurprises.md)
  - [ApiResponseStandardizedFinancials](docs/ApiResponseStandardizedFinancials.md)
  - [ApiResponseStandardizedFinancialsDimensions](docs/ApiResponseStandardizedFinancialsDimensions.md)
+ - [ApiResponseStockExchangeMovers](docs/ApiResponseStockExchangeMovers.md)
  - [ApiResponseStockExchangeQuote](docs/ApiResponseStockExchangeQuote.md)
  - [ApiResponseStockExchangeRealtimeStockPrices](docs/ApiResponseStockExchangeRealtimeStockPrices.md)
  - [ApiResponseStockExchangeSecurities](docs/ApiResponseStockExchangeSecurities.md)
@@ -595,6 +598,7 @@ Class | Method | HTTP request | Description
  - [StandardizedFinancialsDimension](docs/StandardizedFinancialsDimension.md)
  - [StochasticOscillatorTechnicalValue](docs/StochasticOscillatorTechnicalValue.md)
  - [StockExchange](docs/StockExchange.md)
+ - [StockExchangeMover](docs/StockExchangeMover.md)
  - [StockMarketIndex](docs/StockMarketIndex.md)
  - [StockMarketIndexSummary](docs/StockMarketIndexSummary.md)
  - [StockPrice](docs/StockPrice.md)

diff --git a/docs/ApiResponseStockExchangeMovers.md b/docs/ApiResponseStockExchangeMovers.md
@@ -0,0 +1,27 @@
+
+
+[//]: # (CLASS:ApiResponseStockExchangeMovers)
+
+[//]: # (KIND:object)
+
+### ApiResponseStockExchangeMovers
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**movers** | [**list[StockExchangeMover]**](StockExchangeMover.md) | The mover security. &nbsp;
+**stock_exchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier &nbsp;
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:StockExchangeMover)
+
+
+[//]: # (CONTAINED_CLASS:StockExchange)
+
+
+
diff --git a/docs/OptionsApi.md b/docs/OptionsApi.md
@@ -1632,7 +1632,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)
+> 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)
 
 #### Option Prices Realtime By Ticker
 
@@ -1661,8 +1661,10 @@ page_size = 250
 stock_price_source = ''
 model = ''
 show_extended_price = ''
+expiration_start_date = "2024-01-01"
+expiration_end_date = "2024-02-02"
 
-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)
+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)
 print(response)
 
 # Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
@@ -1686,6 +1688,8 @@ Name | Type | Description  | Notes
  **stock_price_source** | str| Source for underlying price for calculating Greeks. | [optional]   &nbsp;
  **model** | str| Model for calculating Greek values. Default is black_scholes. | [optional]   &nbsp;
  **show_extended_price** | bool| Whether to include open close high low type fields. | [optional]   &nbsp;
+ **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;
 <br/>
 
 [//]: # (END_PARAMETERS)

diff --git a/docs/RealtimeStockPrice.md b/docs/RealtimeStockPrice.md
@@ -28,6 +28,14 @@ Name | Type | Description
 **exchange_volume** | float | The number of shares exchanged during the trading day on the exchange. &nbsp;
 **market_volume** | float | The number of shares exchanged during the trading day for the whole market. &nbsp;
 **updated_on** | datetime | The date and time when the data was last updated. &nbsp;
+**eod_close_price** | float | The previous trading session&#39;s closing price. &nbsp;
+**eod_close_date** | date | The date of the previous trading session&#39;s closing price. &nbsp;
+**normal_market_hours_last_time** | datetime | The date and time of the last trade that qualifies for last price consideration during normal market hours according to exchange rules on trade conditions. &nbsp;
+**normal_market_hours_last_price** | float | The price of the last that qualifies for last price consideration during normal market hours according to exchange rules on trade conditions. &nbsp;
+**normal_market_hours_last_size** | float | The size of the last trade that qualifies for last price consideration during normal market hours according to exchange rules on trade conditions. &nbsp;
+**qualified_last_price** | float | The price of the last trade that qualifies for last price consideration according to exchange rules on trade conditions. &nbsp;
+**qualified_last_time** | datetime | The date and time of the last trade that qualifies for last price consideration according to exchange rules on trade conditions. &nbsp;
+**qualified_last_size** | float | The size of the last trade that qualifies for last price consideration according to exchange rules on trade conditions. &nbsp;
 **source** | str | The source of the data. &nbsp;
 **listing_venue** | str | The listing venue where the trade took place. Available only where source is SIP. Listing Venue Modifiers include: Q – Nasdaq | N – NYSE | A – NYSE American | P – NYSE Arca | u – Other OTC Markets | V – Investors Exchange LLC  &nbsp;
 **sales_conditions** | str | When applicable, indicates any sales condition modifiers associated with the trade. Sales Condition Modifers include: @ – Regular Sale | A – Acquisition | B – Bunched Trade | C – Cash Sale | D – Distribution | E – Placeholder | F – Intermarket Sweep | G – Bunched Sold Trade  | H – Priced Variation Trade | I – Odd Lot Trade | K – Rule 155 Trade (AMEX) | L – Sold Last | M – Market Center Official Close | N – Next Day | O – Opening Prints  | P – Prior Reference Price | Q – Market Center Official Open | R – Seller | S – Split Trade | T – Form T | U – Extended Trading Hours (Sold Out of Sequence)  | V – Contingent Trade | W – Average Price Trade | X – Cross/Periodic Auction Trade | Y – Yellow Flag Regular Trade | Z – Sold (Out of Sequence)  | 1 – Stopped Stock (Regular Trade) | 4 – Derivatively Priced | 5 – Re-Opening Prints | 6 – Closing Prints | 7 – Qualified Contingent Trade (QCT)  | 8 – Placeholder for 611 Exempt | 9 – Corrected Consolidated Close (Per Listing Market)  &nbsp;

diff --git a/docs/SecurityApi.md b/docs/SecurityApi.md
@@ -1037,7 +1037,7 @@ Name | Type | Description  | Notes
  **start_time** | str| Return intervals starting at the specified time on the &#x60;start_date&#x60; (24-hour in &#39;hh:mm:ss&#39; format) | [optional]   &nbsp;
  **end_date** | date| Return intervals stopping at the specified date | [optional]   &nbsp;
  **end_time** | str| Return intervals stopping at the specified time on the &#x60;end_date&#x60; (24-hour in &#39;hh:mm:ss&#39; format) | [optional]   &nbsp;
- **timezone** | str| Returns trading times in this timezone | [optional] [default to UTC]  &nbsp;
+ **timezone** | str| Interprets the input times in this time zone, as well as returns times in this timezone. | [optional] [default to UTC]  &nbsp;
  **page_size** | int| The number of results to return | [optional] [default to 100]  &nbsp;
  **split_adjusted** | bool| Whether to return the values adjusted for splits or not. Default is False. | [optional] [default to False]  &nbsp;
  **include_quote_only_bars** | bool| If True, also include bars where no trades occurred but quotes did. | [optional] [default to False]  &nbsp;
@@ -4004,7 +4004,7 @@ Name | Type | Description  | Notes
 #### Quote for a Security
 
 
-Return a current pricing quote for a security across multiple sources.
+Returns many popular metrics for a security from multiple products conveniently in one API. Realtime stock price data requires at least one realtime product subscription (IEX, NASDAQ Basic, and/or Delayed SIP).  If you are subscribed to multiple realtime stock price products, the api will return the most recent realtime stock price. Previous close price and percent change fields require both an EoD US Stock Price subscription and a realtime stock price subscription. Market_cap, price_to_earnings, and dividendyield data fields require a fundamentals subscription.
 
 [//]: # (END_OVERVIEW)
 

diff --git a/docs/StockExchangeApi.md b/docs/StockExchangeApi.md
@@ -6,6 +6,8 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_all_stock_exchanges**](StockExchangeApi.md#get_all_stock_exchanges) | **GET** /stock_exchanges | All Stock Exchanges
 [**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
 [**get_stock_exchange_price_adjustments**](StockExchangeApi.md#get_stock_exchange_price_adjustments) | **GET** /stock_exchanges/{identifier}/prices/adjustments | Stock Price Adjustments by Exchange
 [**get_stock_exchange_prices**](StockExchangeApi.md#get_stock_exchange_prices) | **GET** /stock_exchanges/{identifier}/prices | Stock Prices by Exchange
 [**get_stock_exchange_quote**](StockExchangeApi.md#get_stock_exchange_quote) | **GET** /stock_exchanges/{identifier}/quote | Realtime Quote Prices by Exchange
@@ -170,6 +172,168 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:StockExchangeApi)
+
+[//]: # (METHOD:get_stock_exchange_gainers)
+
+[//]: # (RETURN_TYPE:ApiResponseStockExchangeMovers)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseStockExchangeMovers.md)
+
+[//]: # (OPERATION:get_stock_exchange_gainers_v2)
+
+[//]: # (ENDPOINT:/stock_exchanges/{identifier}/gainers)
+
+[//]: # (DOCUMENT_LINK:StockExchangeApi.md#get_stock_exchange_gainers)
+
+## **get_stock_exchange_gainers**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/python/get_stock_exchange_gainers_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseStockExchangeMovers get_stock_exchange_gainers(identifier, min_price=min_price, page_size=page_size, source=source)
+
+#### Top Gainers by Exchange
+
+
+Returns securities with the highest gain percent change traded on the chosen stock exchange.
+
+[//]: # (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'
+min_price = 8.14
+page_size = 100
+source = 'delayed_sip'
+
+response = intrinio.StockExchangeApi().get_stock_exchange_gainers(identifier, min_price=min_price, page_size=page_size, source=source)
+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;
+ **min_price** | float| The minimum price filter | [optional]   &nbsp;
+ **page_size** | int| The number of results to return | [optional] [default to 100]  &nbsp;
+ **source** | str| Return the realtime price from the specified source instead of the most recent. | [optional]   &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseStockExchangeMovers**](ApiResponseStockExchangeMovers.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:StockExchangeApi)
+
+[//]: # (METHOD:get_stock_exchange_losers)
+
+[//]: # (RETURN_TYPE:ApiResponseStockExchangeMovers)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseStockExchangeMovers.md)
+
+[//]: # (OPERATION:get_stock_exchange_losers_v2)
+
+[//]: # (ENDPOINT:/stock_exchanges/{identifier}/losers)
+
+[//]: # (DOCUMENT_LINK:StockExchangeApi.md#get_stock_exchange_losers)
+
+## **get_stock_exchange_losers**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/python/get_stock_exchange_losers_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseStockExchangeMovers get_stock_exchange_losers(identifier, min_price=min_price, page_size=page_size, source=source)
+
+#### Top Losers by Exchange
+
+
+Returns securities with the highest loss percent change traded on the chosen stock exchange.
+
+[//]: # (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'
+min_price = 8.14
+page_size = 100
+source = 'delayed_sip'
+
+response = intrinio.StockExchangeApi().get_stock_exchange_losers(identifier, min_price=min_price, page_size=page_size, source=source)
+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;
+ **min_price** | float| The minimum price filter | [optional]   &nbsp;
+ **page_size** | int| The number of results to return | [optional] [default to 100]  &nbsp;
+ **source** | str| Return the realtime price from the specified source instead of the most recent. | [optional]   &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseStockExchangeMovers**](ApiResponseStockExchangeMovers.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:StockExchangeApi)
@@ -369,7 +533,7 @@ Name | Type | Description  | Notes
 #### Realtime Quote Prices by Exchange
 
 
-Returns quote prices for the Stock Exchange with the given `identifier`
+Returns many popular metrics for securities from a given exchange 'identifier' from multiple products conveniently in one API. Realtime stock price data requires at least one realtime product subscription (IEX, NASDAQ Basic, and/or Delayed SIP).  If you are subscribed to multiple realtime stock price products, the api will return the most recent realtime stock price. Previous close price and percent change fields require both an EoD US Stock Price subscription and a realtime stock price subscription. Market_cap, price_to_earnings, and dividendyield data fields require a fundamentals subscription.
 
 [//]: # (END_OVERVIEW)
 

diff --git a/docs/StockExchangeMover.md b/docs/StockExchangeMover.md
@@ -0,0 +1,26 @@
+
+
+[//]: # (CLASS:StockExchangeMover)
+
+[//]: # (KIND:object)
+
+### StockExchangeMover
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**security_id** | str | The Intrinio Identifier for this security. &nbsp;
+**ticker** | str | The ticker symbol for this security. &nbsp;
+**last_price** | float | The last price of the last trade. &nbsp;
+**change** | float | The raw change in price. &nbsp;
+**percent_change** | float | The percent change in price. &nbsp;
+**market_volume** | float | The market volume for the most recent (today) trading day. &nbsp;
+**source** | str | The source of the data. &nbsp;
+
+[//]: # (END_DEFINITION)
+
+
+