Skip to content

Commit 2dd4bda

Browse files
committed
No release notes for this build
1 parent 7ee5da2 commit 2dd4bda

File tree

536 files changed

+3280
-525
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

536 files changed

+3280
-525
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ To get an API key, [sign up here](https://intrinio.com/).
44

55
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.
66

7-
- API version: 2.25.6
8-
- Package version: 5.15.0
7+
- API version: 2.26.1
8+
- Package version: 5.16.0
99

1010

1111
## Requirements.
@@ -175,10 +175,12 @@ Class | Method | HTTP request | Description
175175
*OptionsApi* | [**get_options**](docs/OptionsApi.md#get_options) | **GET** /options/{symbol} | Options
176176
*OptionsApi* | [**get_options_by_symbol_realtime**](docs/OptionsApi.md#get_options_by_symbol_realtime) | **GET** /options/{symbol}/realtime | Options by Symbol Realtime
177177
*OptionsApi* | [**get_options_chain**](docs/OptionsApi.md#get_options_chain) | **GET** /options/chain/{symbol}/{expiration} | Options Chain
178+
*OptionsApi* | [**get_options_chain_eod**](docs/OptionsApi.md#get_options_chain_eod) | **GET** /options/chain/{symbol}/{expiration}/eod | Options Chain EOD
178179
*OptionsApi* | [**get_options_chain_realtime**](docs/OptionsApi.md#get_options_chain_realtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
179180
*OptionsApi* | [**get_options_expirations**](docs/OptionsApi.md#get_options_expirations) | **GET** /options/expirations/{symbol} | Options Expirations
180181
*OptionsApi* | [**get_options_prices**](docs/OptionsApi.md#get_options_prices) | **GET** /options/prices/{identifier} | Option Prices
181182
*OptionsApi* | [**get_options_prices_batch_realtime**](docs/OptionsApi.md#get_options_prices_batch_realtime) | **POST** /options/prices/realtime/batch | Option Prices Batch Realtime
183+
*OptionsApi* | [**get_options_prices_eod**](docs/OptionsApi.md#get_options_prices_eod) | **GET** /options/prices/{identifier}/eod | Option Prices EOD
182184
*OptionsApi* | [**get_options_prices_realtime**](docs/OptionsApi.md#get_options_prices_realtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
183185
*OptionsApi* | [**get_options_stats_realtime**](docs/OptionsApi.md#get_options_stats_realtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime
184186
*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
327329
- [ApiResponseOptionPrices](docs/ApiResponseOptionPrices.md)
328330
- [ApiResponseOptions](docs/ApiResponseOptions.md)
329331
- [ApiResponseOptionsChain](docs/ApiResponseOptionsChain.md)
332+
- [ApiResponseOptionsChainEod](docs/ApiResponseOptionsChainEod.md)
330333
- [ApiResponseOptionsChainRealtime](docs/ApiResponseOptionsChainRealtime.md)
331334
- [ApiResponseOptionsExpirations](docs/ApiResponseOptionsExpirations.md)
332335
- [ApiResponseOptionsPriceRealtime](docs/ApiResponseOptionsPriceRealtime.md)
333336
- [ApiResponseOptionsPricesBatchRealtime](docs/ApiResponseOptionsPricesBatchRealtime.md)
337+
- [ApiResponseOptionsPricesEod](docs/ApiResponseOptionsPricesEod.md)
334338
- [ApiResponseOptionsRealtime](docs/ApiResponseOptionsRealtime.md)
335339
- [ApiResponseOptionsStatsRealtime](docs/ApiResponseOptionsStatsRealtime.md)
336340
- [ApiResponseOptionsTickers](docs/ApiResponseOptionsTickers.md)
@@ -465,11 +469,14 @@ Class | Method | HTTP request | Description
465469
- [OnBalanceVolumeTechnicalValue](docs/OnBalanceVolumeTechnicalValue.md)
466470
- [Option](docs/Option.md)
467471
- [OptionChain](docs/OptionChain.md)
472+
- [OptionChainEod](docs/OptionChainEod.md)
468473
- [OptionChainRealtime](docs/OptionChainRealtime.md)
469474
- [OptionContractsList](docs/OptionContractsList.md)
475+
- [OptionEod](docs/OptionEod.md)
470476
- [OptionFactorsRealtime](docs/OptionFactorsRealtime.md)
471477
- [OptionPrice](docs/OptionPrice.md)
472478
- [OptionPriceBatchRealtime](docs/OptionPriceBatchRealtime.md)
479+
- [OptionPriceEod](docs/OptionPriceEod.md)
473480
- [OptionPriceRealtime](docs/OptionPriceRealtime.md)
474481
- [OptionRealtime](docs/OptionRealtime.md)
475482
- [OptionStatsRealtime](docs/OptionStatsRealtime.md)

docs/ApiResponseOptionsChainEod.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
3+
[//]: # (CLASS:ApiResponseOptionsChainEod)
4+
5+
[//]: # (KIND:object)
6+
7+
### ApiResponseOptionsChainEod
8+
9+
#### Properties
10+
11+
[//]: # (START_DEFINITION)
12+
13+
Name | Type | Description
14+
------------ | ------------- | -------------
15+
**chain** | [**list[OptionChainEod]**](OptionChainEod.md) | A list of realtime options for the provided expiration date their respective option prices.  
16+
17+
[//]: # (END_DEFINITION)
18+
19+
20+
[//]: # (CONTAINED_CLASS:OptionChainEod)
21+
22+
23+
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
3+
[//]: # (CLASS:ApiResponseOptionsPricesEod)
4+
5+
[//]: # (KIND:object)
6+
7+
### ApiResponseOptionsPricesEod
8+
9+
#### Properties
10+
11+
[//]: # (START_DEFINITION)
12+
13+
Name | Type | Description
14+
------------ | ------------- | -------------
15+
**prices** | [**list[OptionPriceEod]**](OptionPriceEod.md) | A list of options prices with the given symbol  
16+
**option** | [**OptionEod**](OptionEod.md) |  
17+
18+
[//]: # (END_DEFINITION)
19+
20+
21+
[//]: # (CONTAINED_CLASS:OptionPriceEod)
22+
23+
24+
[//]: # (CONTAINED_CLASS:OptionEod)
25+
26+
27+

docs/OptionChainEod.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
3+
[//]: # (CLASS:OptionChainEod)
4+
5+
[//]: # (KIND:object)
6+
7+
### OptionChainEod
8+
9+
#### Properties
10+
11+
[//]: # (START_DEFINITION)
12+
13+
Name | Type | Description
14+
------------ | ------------- | -------------
15+
**option** | [**OptionEod**](OptionEod.md) |  
16+
**price** | [**OptionPriceEod**](OptionPriceEod.md) |  
17+
18+
[//]: # (END_DEFINITION)
19+
20+
21+
[//]: # (CONTAINED_CLASS:OptionEod)
22+
23+
24+
[//]: # (CONTAINED_CLASS:OptionPriceEod)
25+
26+
27+

docs/OptionEod.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
3+
[//]: # (CLASS:OptionEod)
4+
5+
[//]: # (KIND:object)
6+
7+
### OptionEod
8+
9+
#### Properties
10+
11+
[//]: # (START_DEFINITION)
12+
13+
Name | Type | Description
14+
------------ | ------------- | -------------
15+
**code** | str | The Intrinio Code for the Option.  
16+
**ticker** | str | The ticker symbol of the Security for the Option.  
17+
**expiration** | str | The date on which the Option expires. The Option becomes invalid after this date and cannot be exercised.  
18+
**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.  
19+
**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's expiration date. A call option gives the holder the right to buy an underlying asset at a specified price, before the option's expiration date.  
20+
21+
[//]: # (END_DEFINITION)
22+
23+
24+

docs/OptionPriceEod.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
2+
3+
[//]: # (CLASS:OptionPriceEod)
4+
5+
[//]: # (KIND:object)
6+
7+
### OptionPriceEod
8+
9+
#### Properties
10+
11+
[//]: # (START_DEFINITION)
12+
13+
Name | Type | Description
14+
------------ | ------------- | -------------
15+
**date** | str | The date of the price, in the format YYYY-MM-DD  
16+
**close** | float | The closing price of the options contract.  
17+
**close_bid** | float | The closing bid price of the options contract.  
18+
**close_ask** | float | The closing ask price of the options contract.  
19+
**volume** | int | The cumulative volume of this options contract that traded that day.  
20+
**open** | float | The price at the beginning of the period  
21+
**open_ask** | float | The ask at the beginning of the period  
22+
**open_bid** | float | The bid at the beginning of the period  
23+
**open_interest** | int | The total number of this options contract that are still open.  
24+
**high** | float | The highest price over the span of the period  
25+
**low** | float | The highest price over the span of the period  
26+
**mark** | float | The mid price between the latest bid and ask spread  
27+
**ask_high** | float | The highest ask over the span of the period  
28+
**ask_low** | float | The lowest ask over the span of the period  
29+
**bid_high** | float | The highest bid over the span of the period  
30+
**bid_low** | object | The lowest bid over the span of the period  
31+
32+
[//]: # (END_DEFINITION)
33+
34+
35+

docs/OptionsApi.md

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,12 @@ Method | HTTP request | Description
1010
[**get_options**](OptionsApi.md#get_options) | **GET** /options/{symbol} | Options
1111
[**get_options_by_symbol_realtime**](OptionsApi.md#get_options_by_symbol_realtime) | **GET** /options/{symbol}/realtime | Options by Symbol Realtime
1212
[**get_options_chain**](OptionsApi.md#get_options_chain) | **GET** /options/chain/{symbol}/{expiration} | Options Chain
13+
[**get_options_chain_eod**](OptionsApi.md#get_options_chain_eod) | **GET** /options/chain/{symbol}/{expiration}/eod | Options Chain EOD
1314
[**get_options_chain_realtime**](OptionsApi.md#get_options_chain_realtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
1415
[**get_options_expirations**](OptionsApi.md#get_options_expirations) | **GET** /options/expirations/{symbol} | Options Expirations
1516
[**get_options_prices**](OptionsApi.md#get_options_prices) | **GET** /options/prices/{identifier} | Option Prices
1617
[**get_options_prices_batch_realtime**](OptionsApi.md#get_options_prices_batch_realtime) | **POST** /options/prices/realtime/batch | Option Prices Batch Realtime
18+
[**get_options_prices_eod**](OptionsApi.md#get_options_prices_eod) | **GET** /options/prices/{identifier}/eod | Option Prices EOD
1719
[**get_options_prices_realtime**](OptionsApi.md#get_options_prices_realtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
1820
[**get_options_stats_realtime**](OptionsApi.md#get_options_stats_realtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime
1921
[**get_unusual_activity**](OptionsApi.md#get_unusual_activity) | **GET** /options/unusual_activity/{symbol} | Options Unusual Activity
@@ -510,6 +512,88 @@ Name | Type | Description | Notes
510512
[//]: # (END_OPERATION)
511513

512514

515+
[//]: # (START_OPERATION)
516+
517+
[//]: # (CLASS:OptionsApi)
518+
519+
[//]: # (METHOD:get_options_chain_eod)
520+
521+
[//]: # (RETURN_TYPE:ApiResponseOptionsChainEod)
522+
523+
[//]: # (RETURN_TYPE_KIND:object)
524+
525+
[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsChainEod.md)
526+
527+
[//]: # (OPERATION:get_options_chain_eod_v2)
528+
529+
[//]: # (ENDPOINT:/options/chain/{symbol}/{expiration}/eod)
530+
531+
[//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_chain_eod)
532+
533+
## **get_options_chain_eod**
534+
535+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/python/get_options_chain_eod_v2)
536+
537+
[//]: # (START_OVERVIEW)
538+
539+
> ApiResponseOptionsChainEod get_options_chain_eod(symbol, expiration, type=type, strike=strike, strike_greater_than=strike_greater_than, strike_less_than=strike_less_than)
540+
541+
#### Options Chain EOD
542+
543+
544+
Returns all EOD options contracts and their prices for the given symbol and expiration date.
545+
546+
[//]: # (END_OVERVIEW)
547+
548+
### Example
549+
[//]: # (START_CODE_EXAMPLE)
550+
551+
```python
552+
from __future__ import print_function
553+
import time
554+
import intrinio_sdk as intrinio
555+
from intrinio_sdk.rest import ApiException
556+
557+
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
558+
intrinio.ApiClient().allow_retries(True)
559+
560+
symbol = 'AAPL'
561+
expiration = '2023-01-20'
562+
type = ''
563+
564+
response = intrinio.OptionsApi().get_options_chain_eod(symbol, expiration, type=type, )
565+
print(response)
566+
567+
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)
568+
```
569+
[//]: # (END_CODE_EXAMPLE)
570+
571+
[//]: # (START_DEFINITION)
572+
573+
### Parameters
574+
575+
[//]: # (START_PARAMETERS)
576+
577+
578+
Name | Type | Description | Notes
579+
------------- | ------------- | ------------- | -------------
580+
**symbol** | str| The option symbol, corresponding to the underlying security. |  
581+
**expiration** | str| The expiration date of the options contract |  
582+
**type** | str| The option contract type. | [optional]  
583+
**strike** | float| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]  
584+
**strike_greater_than** | float| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]  
585+
**strike_less_than** | float| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]  
586+
<br/>
587+
588+
[//]: # (END_PARAMETERS)
589+
590+
### Return type
591+
592+
[**ApiResponseOptionsChainEod**](ApiResponseOptionsChainEod.md)
593+
594+
[//]: # (END_OPERATION)
595+
596+
513597
[//]: # (START_OPERATION)
514598

515599
[//]: # (CLASS:OptionsApi)
@@ -845,6 +929,81 @@ Name | Type | Description | Notes
845929
[//]: # (END_OPERATION)
846930

847931

932+
[//]: # (START_OPERATION)
933+
934+
[//]: # (CLASS:OptionsApi)
935+
936+
[//]: # (METHOD:get_options_prices_eod)
937+
938+
[//]: # (RETURN_TYPE:ApiResponseOptionsPricesEod)
939+
940+
[//]: # (RETURN_TYPE_KIND:object)
941+
942+
[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsPricesEod.md)
943+
944+
[//]: # (OPERATION:get_options_prices_eod_v2)
945+
946+
[//]: # (ENDPOINT:/options/prices/{identifier}/eod)
947+
948+
[//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_prices_eod)
949+
950+
## **get_options_prices_eod**
951+
952+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/python/get_options_prices_eod_v2)
953+
954+
[//]: # (START_OVERVIEW)
955+
956+
> ApiResponseOptionsPricesEod get_options_prices_eod(identifier)
957+
958+
#### Option Prices EOD
959+
960+
961+
Returns all option prices for a given option contract identifier.
962+
963+
[//]: # (END_OVERVIEW)
964+
965+
### Example
966+
[//]: # (START_CODE_EXAMPLE)
967+
968+
```python
969+
from __future__ import print_function
970+
import time
971+
import intrinio_sdk as intrinio
972+
from intrinio_sdk.rest import ApiException
973+
974+
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
975+
intrinio.ApiClient().allow_retries(True)
976+
977+
identifier = 'AAPL230616P00190000'
978+
979+
response = intrinio.OptionsApi().get_options_prices_eod(identifier)
980+
print(response)
981+
982+
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)
983+
```
984+
[//]: # (END_CODE_EXAMPLE)
985+
986+
[//]: # (START_DEFINITION)
987+
988+
### Parameters
989+
990+
[//]: # (START_PARAMETERS)
991+
992+
993+
Name | Type | Description | Notes
994+
------------- | ------------- | ------------- | -------------
995+
**identifier** | str| The Intrinio ID or code of the options contract to request prices for. | &nbsp;
996+
<br/>
997+
998+
[//]: # (END_PARAMETERS)
999+
1000+
### Return type
1001+
1002+
[**ApiResponseOptionsPricesEod**](ApiResponseOptionsPricesEod.md)
1003+
1004+
[//]: # (END_OPERATION)
1005+
1006+
8481007
[//]: # (START_OPERATION)
8491008

8501009
[//]: # (CLASS:OptionsApi)

0 commit comments

Comments
 (0)