No release notes for this build

intrinio · Oct 6, 2021 · 2dd4bda · 2dd4bda
1 parent 7ee5da2
commit 2dd4bda
Show file tree

Hide file tree

Showing 536 changed files with 3,280 additions and 525 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.25.6
-- Package version: 5.15.0
+- API version: 2.26.1
+- Package version: 5.16.0
 
 
 ## Requirements.
@@ -175,10 +175,12 @@ Class | Method | HTTP request | Description
 *OptionsApi* | [**get_options**](docs/OptionsApi.md#get_options) | **GET** /options/{symbol} | Options
 *OptionsApi* | [**get_options_by_symbol_realtime**](docs/OptionsApi.md#get_options_by_symbol_realtime) | **GET** /options/{symbol}/realtime | Options by Symbol Realtime
 *OptionsApi* | [**get_options_chain**](docs/OptionsApi.md#get_options_chain) | **GET** /options/chain/{symbol}/{expiration} | Options Chain
+*OptionsApi* | [**get_options_chain_eod**](docs/OptionsApi.md#get_options_chain_eod) | **GET** /options/chain/{symbol}/{expiration}/eod | Options Chain EOD
 *OptionsApi* | [**get_options_chain_realtime**](docs/OptionsApi.md#get_options_chain_realtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
 *OptionsApi* | [**get_options_expirations**](docs/OptionsApi.md#get_options_expirations) | **GET** /options/expirations/{symbol} | Options Expirations
 *OptionsApi* | [**get_options_prices**](docs/OptionsApi.md#get_options_prices) | **GET** /options/prices/{identifier} | Option Prices
 *OptionsApi* | [**get_options_prices_batch_realtime**](docs/OptionsApi.md#get_options_prices_batch_realtime) | **POST** /options/prices/realtime/batch | Option Prices Batch Realtime
+*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_unusual_activity**](docs/OptionsApi.md#get_unusual_activity) | **GET** /options/unusual_activity/{symbol} | Options Unusual Activity
@@ -327,10 +329,12 @@ Class | Method | HTTP request | Description
  - [ApiResponseOptionPrices](docs/ApiResponseOptionPrices.md)
  - [ApiResponseOptions](docs/ApiResponseOptions.md)
  - [ApiResponseOptionsChain](docs/ApiResponseOptionsChain.md)
+ - [ApiResponseOptionsChainEod](docs/ApiResponseOptionsChainEod.md)
  - [ApiResponseOptionsChainRealtime](docs/ApiResponseOptionsChainRealtime.md)
  - [ApiResponseOptionsExpirations](docs/ApiResponseOptionsExpirations.md)
  - [ApiResponseOptionsPriceRealtime](docs/ApiResponseOptionsPriceRealtime.md)
  - [ApiResponseOptionsPricesBatchRealtime](docs/ApiResponseOptionsPricesBatchRealtime.md)
+ - [ApiResponseOptionsPricesEod](docs/ApiResponseOptionsPricesEod.md)
  - [ApiResponseOptionsRealtime](docs/ApiResponseOptionsRealtime.md)
  - [ApiResponseOptionsStatsRealtime](docs/ApiResponseOptionsStatsRealtime.md)
  - [ApiResponseOptionsTickers](docs/ApiResponseOptionsTickers.md)
@@ -465,11 +469,14 @@ Class | Method | HTTP request | Description
  - [OnBalanceVolumeTechnicalValue](docs/OnBalanceVolumeTechnicalValue.md)
  - [Option](docs/Option.md)
  - [OptionChain](docs/OptionChain.md)
+ - [OptionChainEod](docs/OptionChainEod.md)
  - [OptionChainRealtime](docs/OptionChainRealtime.md)
  - [OptionContractsList](docs/OptionContractsList.md)
+ - [OptionEod](docs/OptionEod.md)
  - [OptionFactorsRealtime](docs/OptionFactorsRealtime.md)
  - [OptionPrice](docs/OptionPrice.md)
  - [OptionPriceBatchRealtime](docs/OptionPriceBatchRealtime.md)
+ - [OptionPriceEod](docs/OptionPriceEod.md)
  - [OptionPriceRealtime](docs/OptionPriceRealtime.md)
  - [OptionRealtime](docs/OptionRealtime.md)
  - [OptionStatsRealtime](docs/OptionStatsRealtime.md)

diff --git a/docs/ApiResponseOptionsChainEod.md b/docs/ApiResponseOptionsChainEod.md
@@ -0,0 +1,23 @@
+
+
+[//]: # (CLASS:ApiResponseOptionsChainEod)
+
+[//]: # (KIND:object)
+
+### ApiResponseOptionsChainEod
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**chain** | [**list[OptionChainEod]**](OptionChainEod.md) | A list of realtime options for the provided expiration date their respective option prices. &nbsp;
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:OptionChainEod)
+
+
+
diff --git a/docs/ApiResponseOptionsPricesEod.md b/docs/ApiResponseOptionsPricesEod.md
@@ -0,0 +1,27 @@
+
+
+[//]: # (CLASS:ApiResponseOptionsPricesEod)
+
+[//]: # (KIND:object)
+
+### ApiResponseOptionsPricesEod
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**prices** | [**list[OptionPriceEod]**](OptionPriceEod.md) | A list of options prices with the given symbol &nbsp;
+**option** | [**OptionEod**](OptionEod.md) |  &nbsp;
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:OptionPriceEod)
+
+
+[//]: # (CONTAINED_CLASS:OptionEod)
+
+
+
diff --git a/docs/OptionChainEod.md b/docs/OptionChainEod.md
@@ -0,0 +1,27 @@
+
+
+[//]: # (CLASS:OptionChainEod)
+
+[//]: # (KIND:object)
+
+### OptionChainEod
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**option** | [**OptionEod**](OptionEod.md) |  &nbsp;
+**price** | [**OptionPriceEod**](OptionPriceEod.md) |  &nbsp;
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:OptionEod)
+
+
+[//]: # (CONTAINED_CLASS:OptionPriceEod)
+
+
+
diff --git a/docs/OptionEod.md b/docs/OptionEod.md
@@ -0,0 +1,24 @@
+
+
+[//]: # (CLASS:OptionEod)
+
+[//]: # (KIND:object)
+
+### OptionEod
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**code** | str | The Intrinio Code for the Option. &nbsp;
+**ticker** | str | The ticker symbol of the Security for the Option. &nbsp;
+**expiration** | str | The date on which the Option expires. The Option becomes invalid after this date and cannot be exercised. &nbsp;
+**strike** | float | The strike price is the fixed price at which a derivative can be exercised, and refers to the price of the derivative’s underlying asset.  In a call option, the strike price is the price at which the option holder can purchase the underlying security.  For a put option, the strike price is the price at which the option holder can sell the underlying security. &nbsp;
+**type** | str | The type of Option (put or call). A put option is an option contract giving the owner the right, but not the obligation, to sell a specified amount of an underlying asset at a specified price before the option&#39;s expiration date. A call option gives the holder the right to buy an underlying asset at a specified price, before the option&#39;s expiration date. &nbsp;
+
+[//]: # (END_DEFINITION)
+
+
+
diff --git a/docs/OptionPriceEod.md b/docs/OptionPriceEod.md
@@ -0,0 +1,35 @@
+
+
+[//]: # (CLASS:OptionPriceEod)
+
+[//]: # (KIND:object)
+
+### OptionPriceEod
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**date** | str | The date of the price, in the format YYYY-MM-DD &nbsp;
+**close** | float | The closing price of the options contract. &nbsp;
+**close_bid** | float | The closing bid price of the options contract. &nbsp;
+**close_ask** | float | The closing ask price of the options contract. &nbsp;
+**volume** | int | The cumulative volume of this options contract that traded that day. &nbsp;
+**open** | float | The price at the beginning of the period &nbsp;
+**open_ask** | float | The ask at the beginning of the period &nbsp;
+**open_bid** | float | The bid at the beginning of the period &nbsp;
+**open_interest** | int | The total number of this options contract that are still open. &nbsp;
+**high** | float | The highest price over the span of the period &nbsp;
+**low** | float | The highest price over the span of the period &nbsp;
+**mark** | float | The mid price between the latest bid and ask spread &nbsp;
+**ask_high** | float | The highest ask over the span of the period &nbsp;
+**ask_low** | float | The lowest ask over the span of the period &nbsp;
+**bid_high** | float | The highest bid over the span of the period &nbsp;
+**bid_low** | object | The lowest bid over the span of the period &nbsp;
+
+[//]: # (END_DEFINITION)
+
+
+
diff --git a/docs/OptionsApi.md b/docs/OptionsApi.md
@@ -10,10 +10,12 @@ Method | HTTP request | Description
 [**get_options**](OptionsApi.md#get_options) | **GET** /options/{symbol} | Options
 [**get_options_by_symbol_realtime**](OptionsApi.md#get_options_by_symbol_realtime) | **GET** /options/{symbol}/realtime | Options by Symbol Realtime
 [**get_options_chain**](OptionsApi.md#get_options_chain) | **GET** /options/chain/{symbol}/{expiration} | Options Chain
+[**get_options_chain_eod**](OptionsApi.md#get_options_chain_eod) | **GET** /options/chain/{symbol}/{expiration}/eod | Options Chain EOD
 [**get_options_chain_realtime**](OptionsApi.md#get_options_chain_realtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
 [**get_options_expirations**](OptionsApi.md#get_options_expirations) | **GET** /options/expirations/{symbol} | Options Expirations
 [**get_options_prices**](OptionsApi.md#get_options_prices) | **GET** /options/prices/{identifier} | Option Prices
 [**get_options_prices_batch_realtime**](OptionsApi.md#get_options_prices_batch_realtime) | **POST** /options/prices/realtime/batch | Option Prices Batch Realtime
+[**get_options_prices_eod**](OptionsApi.md#get_options_prices_eod) | **GET** /options/prices/{identifier}/eod | Option Prices EOD
 [**get_options_prices_realtime**](OptionsApi.md#get_options_prices_realtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
 [**get_options_stats_realtime**](OptionsApi.md#get_options_stats_realtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime
 [**get_unusual_activity**](OptionsApi.md#get_unusual_activity) | **GET** /options/unusual_activity/{symbol} | Options Unusual Activity
@@ -510,6 +512,88 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:OptionsApi)
+
+[//]: # (METHOD:get_options_chain_eod)
+
+[//]: # (RETURN_TYPE:ApiResponseOptionsChainEod)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsChainEod.md)
+
+[//]: # (OPERATION:get_options_chain_eod_v2)
+
+[//]: # (ENDPOINT:/options/chain/{symbol}/{expiration}/eod)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_chain_eod)
+
+## **get_options_chain_eod**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/python/get_options_chain_eod_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsChainEod get_options_chain_eod(symbol, expiration, type=type, strike=strike, strike_greater_than=strike_greater_than, strike_less_than=strike_less_than)
+
+#### Options Chain EOD
+
+
+Returns all EOD options contracts and their prices for the given symbol and expiration date.
+
+[//]: # (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)
+
+symbol = 'AAPL'
+expiration = '2023-01-20'
+type = ''
+
+response = intrinio.OptionsApi().get_options_chain_eod(symbol, expiration, type=type, )
+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
+------------- | ------------- | ------------- | -------------
+ **symbol** | str| The option symbol, corresponding to the underlying security. |   &nbsp;
+ **expiration** | str| The expiration date of the options contract |   &nbsp;
+ **type** | str| The option contract type. | [optional]   &nbsp;
+ **strike** | float| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]   &nbsp;
+ **strike_greater_than** | float| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]   &nbsp;
+ **strike_less_than** | float| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]   &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsChainEod**](ApiResponseOptionsChainEod.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:OptionsApi)
@@ -845,6 +929,81 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:OptionsApi)
+
+[//]: # (METHOD:get_options_prices_eod)
+
+[//]: # (RETURN_TYPE:ApiResponseOptionsPricesEod)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsPricesEod.md)
+
+[//]: # (OPERATION:get_options_prices_eod_v2)
+
+[//]: # (ENDPOINT:/options/prices/{identifier}/eod)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_prices_eod)
+
+## **get_options_prices_eod**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/python/get_options_prices_eod_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsPricesEod get_options_prices_eod(identifier)
+
+#### Option Prices EOD
+
+
+Returns all option prices for a given option contract 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 = 'AAPL230616P00190000'
+
+response = intrinio.OptionsApi().get_options_prices_eod(identifier)
+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| The Intrinio ID or code of the options contract to request prices for. |   &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsPricesEod**](ApiResponseOptionsPricesEod.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:OptionsApi)