Skip to content

Commit f3683bf

Browse files
No release notes for this build
1 parent 58cb6b9 commit f3683bf

File tree

677 files changed

+3930
-841
lines changed

Some content is hidden

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

677 files changed

+3930
-841
lines changed

README.md

Lines changed: 12 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.73.0
8-
- Package version: 6.32.1
7+
- API version: 2.75.0
8+
- Package version: 6.33.0
99

1010

1111
## Requirements.
@@ -169,6 +169,7 @@ Class | Method | HTTP request | Description
169169
*IndexApi* | [**get_economic_index_data_point_text**](docs/IndexApi.md#get_economic_index_data_point_text) | **GET** /indices/economic/{identifier}/data_point/{tag}/text | Data Point (Text) for an Economic Index
170170
*IndexApi* | [**get_economic_index_historical_data**](docs/IndexApi.md#get_economic_index_historical_data) | **GET** /indices/economic/{identifier}/historical_data/{tag} | Historical Data for an Economic Index
171171
*IndexApi* | [**get_eod_index_price_by_id**](docs/IndexApi.md#get_eod_index_price_by_id) | **GET** /indices/{identifier}/eod | End of Day Index Prices By Identifier
172+
*IndexApi* | [**get_index_constituents_by_id**](docs/IndexApi.md#get_index_constituents_by_id) | **GET** /indices/{identifier}/constituents | Index Constituents By Index Identifier
172173
*IndexApi* | [**get_index_summary_by_id**](docs/IndexApi.md#get_index_summary_by_id) | **GET** /indices/{identifier} | Index Summary By Identifier
173174
*IndexApi* | [**get_realtime_index_price_by_id**](docs/IndexApi.md#get_realtime_index_price_by_id) | **GET** /indices/{identifier}/realtime | Realtime Index Price By Identifier
174175
*IndexApi* | [**get_sic_index_by_id**](docs/IndexApi.md#get_sic_index_by_id) | **GET** /indices/sic/{identifier} | Lookup SIC Index
@@ -191,6 +192,8 @@ Class | Method | HTTP request | Description
191192
*OptionsApi* | [**get_option_aggregates**](docs/OptionsApi.md#get_option_aggregates) | **GET** /options/aggregates | Total open interest and volume aggregated by ticker
192193
*OptionsApi* | [**get_option_expirations_realtime**](docs/OptionsApi.md#get_option_expirations_realtime) | **GET** /options/expirations/{symbol}/realtime | Options Expirations
193194
*OptionsApi* | [**get_option_strikes_realtime**](docs/OptionsApi.md#get_option_strikes_realtime) | **GET** /options/strikes/{symbol}/{strike}/realtime | Option Strikes Realtime
195+
*OptionsApi* | [**get_option_trades**](docs/OptionsApi.md#get_option_trades) | **GET** /options/trades | Option Trades
196+
*OptionsApi* | [**get_option_trades_by_contract**](docs/OptionsApi.md#get_option_trades_by_contract) | **GET** /options/{identifier}/trades | Option Trades By Contract
194197
*OptionsApi* | [**get_options**](docs/OptionsApi.md#get_options) | **GET** /options/{symbol} | Options
195198
*OptionsApi* | [**get_options_by_symbol_realtime**](docs/OptionsApi.md#get_options_by_symbol_realtime) | **GET** /options/{symbol}/realtime | Options by Symbol Realtime
196199
*OptionsApi* | [**get_options_chain**](docs/OptionsApi.md#get_options_chain) | **GET** /options/chain/{symbol}/{expiration} | Options Chain
@@ -205,6 +208,7 @@ Class | Method | HTTP request | Description
205208
*OptionsApi* | [**get_options_prices**](docs/OptionsApi.md#get_options_prices) | **GET** /options/prices/{identifier} | Option Prices
206209
*OptionsApi* | [**get_options_prices_batch_realtime**](docs/OptionsApi.md#get_options_prices_batch_realtime) | **POST** /options/prices/realtime/batch | Option Prices Batch Realtime
207210
*OptionsApi* | [**get_options_prices_eod**](docs/OptionsApi.md#get_options_prices_eod) | **GET** /options/prices/{identifier}/eod | Option Prices EOD
211+
*OptionsApi* | [**get_options_prices_eod_by_ticker**](docs/OptionsApi.md#get_options_prices_eod_by_ticker) | **GET** /options/prices/by_ticker/{symbol}/eod | Option Prices End of Day By Ticker
208212
*OptionsApi* | [**get_options_prices_realtime**](docs/OptionsApi.md#get_options_prices_realtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
209213
*OptionsApi* | [**get_options_prices_realtime_by_ticker**](docs/OptionsApi.md#get_options_prices_realtime_by_ticker) | **GET** /options/prices/by_ticker/{symbol}/realtime | Option Prices Realtime By Ticker
210214
*OptionsApi* | [**get_options_snapshots**](docs/OptionsApi.md#get_options_snapshots) | **GET** /options/snapshots | Option Prices Realtime Snapshot
@@ -377,6 +381,7 @@ Class | Method | HTTP request | Description
377381
- [ApiResponseForexPrices](docs/ApiResponseForexPrices.md)
378382
- [ApiResponseHistoricalData](docs/ApiResponseHistoricalData.md)
379383
- [ApiResponseIndex](docs/ApiResponseIndex.md)
384+
- [ApiResponseIndexConstituents](docs/ApiResponseIndexConstituents.md)
380385
- [ApiResponseIndices](docs/ApiResponseIndices.md)
381386
- [ApiResponseInitialPublicOfferings](docs/ApiResponseInitialPublicOfferings.md)
382387
- [ApiResponseInsiderTransactionFilings](docs/ApiResponseInsiderTransactionFilings.md)
@@ -392,6 +397,7 @@ Class | Method | HTTP request | Description
392397
- [ApiResponseOptionsExpirations](docs/ApiResponseOptionsExpirations.md)
393398
- [ApiResponseOptionsPriceRealtime](docs/ApiResponseOptionsPriceRealtime.md)
394399
- [ApiResponseOptionsPricesBatchRealtime](docs/ApiResponseOptionsPricesBatchRealtime.md)
400+
- [ApiResponseOptionsPricesByTickerEod](docs/ApiResponseOptionsPricesByTickerEod.md)
395401
- [ApiResponseOptionsPricesByTickerRealtime](docs/ApiResponseOptionsPricesByTickerRealtime.md)
396402
- [ApiResponseOptionsPricesEod](docs/ApiResponseOptionsPricesEod.md)
397403
- [ApiResponseOptionsRealtime](docs/ApiResponseOptionsRealtime.md)
@@ -528,6 +534,7 @@ Class | Method | HTTP request | Description
528534
- [FundamentalSummary](docs/FundamentalSummary.md)
529535
- [HistoricalData](docs/HistoricalData.md)
530536
- [IchimokuKinkoHyoTechnicalValue](docs/IchimokuKinkoHyoTechnicalValue.md)
537+
- [IndexConstituents](docs/IndexConstituents.md)
531538
- [InsiderTransaction](docs/InsiderTransaction.md)
532539
- [InsiderTransactionFiling](docs/InsiderTransactionFiling.md)
533540
- [InstitutionalHolding](docs/InstitutionalHolding.md)
@@ -565,8 +572,11 @@ Class | Method | HTTP request | Description
565572
- [OptionSnapshotGroup](docs/OptionSnapshotGroup.md)
566573
- [OptionSnapshotsResult](docs/OptionSnapshotsResult.md)
567574
- [OptionStatsRealtime](docs/OptionStatsRealtime.md)
575+
- [OptionTrades](docs/OptionTrades.md)
576+
- [OptionTradesResult](docs/OptionTradesResult.md)
568577
- [OptionUnusualTrade](docs/OptionUnusualTrade.md)
569578
- [OptionsAggregate](docs/OptionsAggregate.md)
579+
- [OptionsPriceEod](docs/OptionsPriceEod.md)
570580
- [Owner](docs/Owner.md)
571581
- [OwnerSummary](docs/OwnerSummary.md)
572582
- [RealtimeIndexPrice](docs/RealtimeIndexPrice.md)
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
2+
3+
[//]: # (CLASS:ApiResponseIndexConstituents)
4+
5+
[//]: # (KIND:object)
6+
7+
### ApiResponseIndexConstituents
8+
9+
#### Properties
10+
11+
[//]: # (START_DEFINITION)
12+
13+
Name | Type | Description
14+
------------ | ------------- | -------------
15+
**index** | [**ApiResponseIndex**](ApiResponseIndex.md) | The index  
16+
**date** | date | The date when an update was last received for the index constituents  
17+
**constituents** | [**IndexConstituents**](IndexConstituents.md) |  
18+
19+
[//]: # (END_DEFINITION)
20+
21+
22+
[//]: # (CONTAINED_CLASS:ApiResponseIndex)
23+
24+
25+
[//]: # (CONTAINED_CLASS:IndexConstituents)
26+
27+
28+
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
3+
[//]: # (CLASS:ApiResponseOptionsPricesByTickerEod)
4+
5+
[//]: # (KIND:object)
6+
7+
### ApiResponseOptionsPricesByTickerEod
8+
9+
#### Properties
10+
11+
[//]: # (START_DEFINITION)
12+
13+
Name | Type | Description
14+
------------ | ------------- | -------------
15+
**next_page** | str | The token required to request the next page of the data. If null, no further results are available.  
16+
**prices** | [**list[OptionsPriceEod]**](OptionsPriceEod.md) | The contracts pricing for this security.  
17+
18+
[//]: # (END_DEFINITION)
19+
20+
21+
[//]: # (CONTAINED_CLASS:OptionsPriceEod)
22+
23+
24+

docs/CompanyApi.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -588,8 +588,8 @@ from intrinio_sdk.rest import ApiException
588588
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
589589
intrinio.ApiClient().allow_retries(True)
590590

591-
identifier = 'AAPL'
592-
tag = 'marketcap'
591+
identifier = '$$v2_company_data_point_identifier_default$$'
592+
tag = '$$v2_company_data_point_item_number_default$$'
593593

594594
response = intrinio.CompanyApi().get_company_data_point_number(identifier, tag)
595595
print(response)
@@ -607,8 +607,8 @@ print(response)
607607

608608
Name | Type | Description | Notes
609609
------------- | ------------- | ------------- | -------------
610-
**identifier** | str| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |  
611-
**tag** | str| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |  
610+
**identifier** | str| $$v2_company_data_point_identifier_description$$ |  
611+
**tag** | str| $$v2_company_data_point_item_description$$ |  
612612
<br/>
613613

614614
[//]: # (END_PARAMETERS)
@@ -665,8 +665,8 @@ from intrinio_sdk.rest import ApiException
665665
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
666666
intrinio.ApiClient().allow_retries(True)
667667

668-
identifier = 'AAPL'
669-
tag = 'ceo'
668+
identifier = '$$v2_company_data_point_identifier_default$$'
669+
tag = '$$v2_company_data_point_item_text_default$$'
670670

671671
response = intrinio.CompanyApi().get_company_data_point_text(identifier, tag)
672672
print(response)
@@ -684,8 +684,8 @@ print(response)
684684

685685
Name | Type | Description | Notes
686686
------------- | ------------- | ------------- | -------------
687-
**identifier** | str| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | &nbsp;
688-
**tag** | str| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | &nbsp;
687+
**identifier** | str| $$v2_company_data_point_identifier_description$$ | &nbsp;
688+
**tag** | str| $$v2_company_data_point_item_description$$ | &nbsp;
689689
<br/>
690690

691691
[//]: # (END_PARAMETERS)
@@ -912,7 +912,7 @@ Name | Type | Description | Notes
912912
#### Historical Data for Company
913913

914914

915-
Returns historical values for the given `tag` and the Company with the given `identifier`
915+
$$v2_company_historical_data_description$$
916916

917917
[//]: # (END_OVERVIEW)
918918

@@ -928,8 +928,8 @@ from intrinio_sdk.rest import ApiException
928928
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
929929
intrinio.ApiClient().allow_retries(True)
930930

931-
identifier = 'AAPL'
932-
tag = 'marketcap'
931+
identifier = '$$v2_company_historical_data_identifier_default$$'
932+
tag = '$$v2_company_historical_data_item_default$$'
933933
frequency = 'daily'
934934
type = ''
935935
start_date = '2018-01-01'
@@ -954,8 +954,8 @@ print(response)
954954

955955
Name | Type | Description | Notes
956956
------------- | ------------- | ------------- | -------------
957-
**identifier** | str| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | &nbsp;
958-
**tag** | str| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | &nbsp;
957+
**identifier** | str| $$v2_company_historical_data_identifier_description$$ | &nbsp;
958+
**tag** | str| $$v2_company_historical_data_item_description$$ | &nbsp;
959959
**frequency** | str| Return historical data in the given frequency | [optional] [default to daily] &nbsp;
960960
**type** | str| Return historical data for given fiscal period type | [optional] &nbsp;
961961
**start_date** | date| Return historical data on or after this date | [optional] &nbsp;

docs/DataPointApi.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Method | HTTP request | Description
3838
#### Data Point (Number)
3939

4040

41-
Returns a numeric value for the given `tag` and the entity with the given `identifier`
41+
$$v2_data_point_number_description$$
4242

4343
[//]: # (END_OVERVIEW)
4444

@@ -54,8 +54,8 @@ from intrinio_sdk.rest import ApiException
5454
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
5555
intrinio.ApiClient().allow_retries(True)
5656

57-
identifier = 'AAPL'
58-
tag = 'marketcap'
57+
identifier = '$$v2_data_point_identifier_default$$'
58+
tag = '$$v2_data_point_item_number_default$$'
5959

6060
response = intrinio.DataPointApi().get_data_point_number(identifier, tag)
6161
print(response)
@@ -73,8 +73,8 @@ print(response)
7373

7474
Name | Type | Description | Notes
7575
------------- | ------------- | ------------- | -------------
76-
**identifier** | str| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) | &nbsp;
77-
**tag** | str| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | &nbsp;
76+
**identifier** | str| $$v2_data_point_identifier_description$$ | &nbsp;
77+
**tag** | str| $$v2_data_point_item_description$$ | &nbsp;
7878
<br/>
7979

8080
[//]: # (END_PARAMETERS)
@@ -115,7 +115,7 @@ Name | Type | Description | Notes
115115
#### Data Point (Text)
116116

117117

118-
Returns a text value for the given `tag` for the Security with the given `identifier`
118+
$$v2_data_point_text_description$$
119119

120120
[//]: # (END_OVERVIEW)
121121

@@ -131,8 +131,8 @@ from intrinio_sdk.rest import ApiException
131131
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
132132
intrinio.ApiClient().allow_retries(True)
133133

134-
identifier = 'AAPL'
135-
tag = 'ceo'
134+
identifier = '$$v2_data_point_identifier_default$$'
135+
tag = '$$v2_data_point_item_text_default$$'
136136

137137
response = intrinio.DataPointApi().get_data_point_text(identifier, tag)
138138
print(response)
@@ -150,8 +150,8 @@ print(response)
150150

151151
Name | Type | Description | Notes
152152
------------- | ------------- | ------------- | -------------
153-
**identifier** | str| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) | &nbsp;
154-
**tag** | str| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | &nbsp;
153+
**identifier** | str| $$v2_data_point_identifier_description$$ | &nbsp;
154+
**tag** | str| $$v2_data_point_item_description$$ | &nbsp;
155155
<br/>
156156

157157
[//]: # (END_PARAMETERS)

docs/FilingApi.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Method | HTTP request | Description
4242

4343
[//]: # (START_OVERVIEW)
4444

45-
> ApiResponseFilings get_all_filings(company=company, report_type=report_type, start_date=start_date, end_date=end_date, industry_category=industry_category, industry_group=industry_group, thea_enabled=thea_enabled, page_size=page_size, next_page=next_page)
45+
> ApiResponseFilings get_all_filings(company=company, report_type=report_type, start_date=start_date, end_date=end_date, industry_category=industry_category, industry_group=industry_group, thea_enabled=thea_enabled, earnings_release=earnings_release, page_size=page_size, next_page=next_page)
4646
4747
#### All Filings
4848

@@ -70,10 +70,11 @@ end_date = ''
7070
industry_category = ''
7171
industry_group = ''
7272
thea_enabled = ''
73+
earnings_release = ''
7374
page_size = 100
7475
next_page = ''
7576

76-
response = intrinio.FilingApi().get_all_filings(company=company, report_type=report_type, start_date=start_date, end_date=end_date, industry_category=industry_category, industry_group=industry_group, thea_enabled=thea_enabled, page_size=page_size, next_page=next_page)
77+
response = intrinio.FilingApi().get_all_filings(company=company, report_type=report_type, start_date=start_date, end_date=end_date, industry_category=industry_category, industry_group=industry_group, thea_enabled=thea_enabled, earnings_release=earnings_release, page_size=page_size, next_page=next_page)
7778
print(response)
7879

7980
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)
@@ -96,6 +97,7 @@ Name | Type | Description | Notes
9697
**industry_category** | str| Return companies in the given industry category | [optional] &nbsp;
9798
**industry_group** | str| Return companies in the given industry group | [optional] &nbsp;
9899
**thea_enabled** | bool| Return filings that have been read by our Thea NLP and are ready for our answers endpoint | [optional] &nbsp;
100+
**earnings_release** | bool| Return filings that have been tagged as having Results of Operations and Financial Conditions | [optional] &nbsp;
99101
**page_size** | int| The number of results to return | [optional] [default to 100] &nbsp;
100102
**next_page** | str| Gets the next page of data from a previous API call | [optional] &nbsp;
101103
<br/>

docs/FundamentalsApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ intrinio.ApiClient().set_api_key('YOUR_API_KEY')
383383
intrinio.ApiClient().allow_retries(True)
384384

385385
id = 'AAPL-income_statement-2020-FY'
386-
tag = 'ceo'
386+
tag = '$$v2_data_point_item_text_default$$'
387387

388388
response = intrinio.FundamentalsApi().get_fundamental_standardized_financials_dimensions(id, tag)
389389
print(response)
@@ -402,7 +402,7 @@ print(response)
402402
Name | Type | Description | Notes
403403
------------- | ------------- | ------------- | -------------
404404
**id** | str| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental | &nbsp;
405-
**tag** | str| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | &nbsp;
405+
**tag** | str| $$v2_data_point_item_description$$ | &nbsp;
406406
<br/>
407407

408408
[//]: # (END_PARAMETERS)

docs/HistoricalDataApi.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Method | HTTP request | Description
3737
#### Historical Data
3838

3939

40-
Returns historical values for the given `tag` and the entity represented by the given `identifier`
40+
$$v2_historical_data_description$$
4141

4242
[//]: # (END_OVERVIEW)
4343

@@ -53,8 +53,8 @@ from intrinio_sdk.rest import ApiException
5353
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
5454
intrinio.ApiClient().allow_retries(True)
5555

56-
identifier = 'AAPL'
57-
tag = 'marketcap'
56+
identifier = '$$v2_historical_data_identifier_default$$'
57+
tag = '$$v2_historical_data_item_default$$'
5858
frequency = 'daily'
5959
type = ''
6060
start_date = '2015-01-01'
@@ -79,8 +79,8 @@ print(response)
7979

8080
Name | Type | Description | Notes
8181
------------- | ------------- | ------------- | -------------
82-
**identifier** | str| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) | &nbsp;
83-
**tag** | str| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | &nbsp;
82+
**identifier** | str| $$v2_historical_data_identifier_description$$ | &nbsp;
83+
**tag** | str| $$v2_historical_data_item_description$$ | &nbsp;
8484
**frequency** | str| Return historical data in the given frequency | [optional] [default to daily] &nbsp;
8585
**type** | str| Filter by type, when applicable | [optional] &nbsp;
8686
**start_date** | date| Get historical data on or after this date | [optional] &nbsp;

0 commit comments

Comments
 (0)