Skip to content

Commit

Permalink
No release notes for this build
Browse files Browse the repository at this point in the history
  • Loading branch information
ssnyder-intrinio committed Nov 21, 2024
1 parent 58cb6b9 commit f3683bf
Show file tree
Hide file tree
Showing 677 changed files with 3,930 additions and 841 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.73.0
- Package version: 6.32.1
- API version: 2.75.0
- Package version: 6.33.0


## Requirements.
Expand Down Expand Up @@ -169,6 +169,7 @@ Class | Method | HTTP request | Description
*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
*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
*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
*IndexApi* | [**get_index_constituents_by_id**](docs/IndexApi.md#get_index_constituents_by_id) | **GET** /indices/{identifier}/constituents | Index Constituents By Index Identifier
*IndexApi* | [**get_index_summary_by_id**](docs/IndexApi.md#get_index_summary_by_id) | **GET** /indices/{identifier} | Index Summary By Identifier
*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
*IndexApi* | [**get_sic_index_by_id**](docs/IndexApi.md#get_sic_index_by_id) | **GET** /indices/sic/{identifier} | Lookup SIC Index
Expand All @@ -191,6 +192,8 @@ Class | Method | HTTP request | Description
*OptionsApi* | [**get_option_aggregates**](docs/OptionsApi.md#get_option_aggregates) | **GET** /options/aggregates | Total open interest and volume aggregated by ticker
*OptionsApi* | [**get_option_expirations_realtime**](docs/OptionsApi.md#get_option_expirations_realtime) | **GET** /options/expirations/{symbol}/realtime | Options Expirations
*OptionsApi* | [**get_option_strikes_realtime**](docs/OptionsApi.md#get_option_strikes_realtime) | **GET** /options/strikes/{symbol}/{strike}/realtime | Option Strikes Realtime
*OptionsApi* | [**get_option_trades**](docs/OptionsApi.md#get_option_trades) | **GET** /options/trades | Option Trades
*OptionsApi* | [**get_option_trades_by_contract**](docs/OptionsApi.md#get_option_trades_by_contract) | **GET** /options/{identifier}/trades | Option Trades By Contract
*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
Expand All @@ -205,6 +208,7 @@ Class | Method | HTTP request | Description
*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_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
*OptionsApi* | [**get_options_prices_realtime**](docs/OptionsApi.md#get_options_prices_realtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
*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
*OptionsApi* | [**get_options_snapshots**](docs/OptionsApi.md#get_options_snapshots) | **GET** /options/snapshots | Option Prices Realtime Snapshot
Expand Down Expand Up @@ -377,6 +381,7 @@ Class | Method | HTTP request | Description
- [ApiResponseForexPrices](docs/ApiResponseForexPrices.md)
- [ApiResponseHistoricalData](docs/ApiResponseHistoricalData.md)
- [ApiResponseIndex](docs/ApiResponseIndex.md)
- [ApiResponseIndexConstituents](docs/ApiResponseIndexConstituents.md)
- [ApiResponseIndices](docs/ApiResponseIndices.md)
- [ApiResponseInitialPublicOfferings](docs/ApiResponseInitialPublicOfferings.md)
- [ApiResponseInsiderTransactionFilings](docs/ApiResponseInsiderTransactionFilings.md)
Expand All @@ -392,6 +397,7 @@ Class | Method | HTTP request | Description
- [ApiResponseOptionsExpirations](docs/ApiResponseOptionsExpirations.md)
- [ApiResponseOptionsPriceRealtime](docs/ApiResponseOptionsPriceRealtime.md)
- [ApiResponseOptionsPricesBatchRealtime](docs/ApiResponseOptionsPricesBatchRealtime.md)
- [ApiResponseOptionsPricesByTickerEod](docs/ApiResponseOptionsPricesByTickerEod.md)
- [ApiResponseOptionsPricesByTickerRealtime](docs/ApiResponseOptionsPricesByTickerRealtime.md)
- [ApiResponseOptionsPricesEod](docs/ApiResponseOptionsPricesEod.md)
- [ApiResponseOptionsRealtime](docs/ApiResponseOptionsRealtime.md)
Expand Down Expand Up @@ -528,6 +534,7 @@ Class | Method | HTTP request | Description
- [FundamentalSummary](docs/FundamentalSummary.md)
- [HistoricalData](docs/HistoricalData.md)
- [IchimokuKinkoHyoTechnicalValue](docs/IchimokuKinkoHyoTechnicalValue.md)
- [IndexConstituents](docs/IndexConstituents.md)
- [InsiderTransaction](docs/InsiderTransaction.md)
- [InsiderTransactionFiling](docs/InsiderTransactionFiling.md)
- [InstitutionalHolding](docs/InstitutionalHolding.md)
Expand Down Expand Up @@ -565,8 +572,11 @@ Class | Method | HTTP request | Description
- [OptionSnapshotGroup](docs/OptionSnapshotGroup.md)
- [OptionSnapshotsResult](docs/OptionSnapshotsResult.md)
- [OptionStatsRealtime](docs/OptionStatsRealtime.md)
- [OptionTrades](docs/OptionTrades.md)
- [OptionTradesResult](docs/OptionTradesResult.md)
- [OptionUnusualTrade](docs/OptionUnusualTrade.md)
- [OptionsAggregate](docs/OptionsAggregate.md)
- [OptionsPriceEod](docs/OptionsPriceEod.md)
- [Owner](docs/Owner.md)
- [OwnerSummary](docs/OwnerSummary.md)
- [RealtimeIndexPrice](docs/RealtimeIndexPrice.md)
Expand Down
28 changes: 28 additions & 0 deletions docs/ApiResponseIndexConstituents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@


[//]: # (CLASS:ApiResponseIndexConstituents)

[//]: # (KIND:object)

### ApiResponseIndexConstituents

#### Properties

[//]: # (START_DEFINITION)

Name | Type | Description
------------ | ------------- | -------------
**index** | [**ApiResponseIndex**](ApiResponseIndex.md) | The index  
**date** | date | The date when an update was last received for the index constituents  
**constituents** | [**IndexConstituents**](IndexConstituents.md) |  

[//]: # (END_DEFINITION)


[//]: # (CONTAINED_CLASS:ApiResponseIndex)


[//]: # (CONTAINED_CLASS:IndexConstituents)



24 changes: 24 additions & 0 deletions docs/ApiResponseOptionsPricesByTickerEod.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@


[//]: # (CLASS:ApiResponseOptionsPricesByTickerEod)

[//]: # (KIND:object)

### ApiResponseOptionsPricesByTickerEod

#### Properties

[//]: # (START_DEFINITION)

Name | Type | Description
------------ | ------------- | -------------
**next_page** | str | The token required to request the next page of the data. If null, no further results are available.  
**prices** | [**list[OptionsPriceEod]**](OptionsPriceEod.md) | The contracts pricing for this security.  

[//]: # (END_DEFINITION)


[//]: # (CONTAINED_CLASS:OptionsPriceEod)



26 changes: 13 additions & 13 deletions docs/CompanyApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -588,8 +588,8 @@ from intrinio_sdk.rest import ApiException
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'AAPL'
tag = 'marketcap'
identifier = '$$v2_company_data_point_identifier_default$$'
tag = '$$v2_company_data_point_item_number_default$$'

response = intrinio.CompanyApi().get_company_data_point_number(identifier, tag)
print(response)
Expand All @@ -607,8 +607,8 @@ print(response)

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

[//]: # (END_PARAMETERS)
Expand Down Expand Up @@ -665,8 +665,8 @@ from intrinio_sdk.rest import ApiException
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'AAPL'
tag = 'ceo'
identifier = '$$v2_company_data_point_identifier_default$$'
tag = '$$v2_company_data_point_item_text_default$$'

response = intrinio.CompanyApi().get_company_data_point_text(identifier, tag)
print(response)
Expand All @@ -684,8 +684,8 @@ print(response)

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | str| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | &nbsp;
**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;
**identifier** | str| $$v2_company_data_point_identifier_description$$ | &nbsp;
**tag** | str| $$v2_company_data_point_item_description$$ | &nbsp;
<br/>

[//]: # (END_PARAMETERS)
Expand Down Expand Up @@ -912,7 +912,7 @@ Name | Type | Description | Notes
#### Historical Data for Company


Returns historical values for the given `tag` and the Company with the given `identifier`
$$v2_company_historical_data_description$$

[//]: # (END_OVERVIEW)

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

identifier = 'AAPL'
tag = 'marketcap'
identifier = '$$v2_company_historical_data_identifier_default$$'
tag = '$$v2_company_historical_data_item_default$$'
frequency = 'daily'
type = ''
start_date = '2018-01-01'
Expand All @@ -954,8 +954,8 @@ print(response)

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | str| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | &nbsp;
**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;
**identifier** | str| $$v2_company_historical_data_identifier_description$$ | &nbsp;
**tag** | str| $$v2_company_historical_data_item_description$$ | &nbsp;
**frequency** | str| Return historical data in the given frequency | [optional] [default to daily] &nbsp;
**type** | str| Return historical data for given fiscal period type | [optional] &nbsp;
**start_date** | date| Return historical data on or after this date | [optional] &nbsp;
Expand Down
20 changes: 10 additions & 10 deletions docs/DataPointApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Method | HTTP request | Description
#### Data Point (Number)


Returns a numeric value for the given `tag` and the entity with the given `identifier`
$$v2_data_point_number_description$$

[//]: # (END_OVERVIEW)

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

identifier = 'AAPL'
tag = 'marketcap'
identifier = '$$v2_data_point_identifier_default$$'
tag = '$$v2_data_point_item_number_default$$'

response = intrinio.DataPointApi().get_data_point_number(identifier, tag)
print(response)
Expand All @@ -73,8 +73,8 @@ print(response)

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | str| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) | &nbsp;
**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;
**identifier** | str| $$v2_data_point_identifier_description$$ | &nbsp;
**tag** | str| $$v2_data_point_item_description$$ | &nbsp;
<br/>

[//]: # (END_PARAMETERS)
Expand Down Expand Up @@ -115,7 +115,7 @@ Name | Type | Description | Notes
#### Data Point (Text)


Returns a text value for the given `tag` for the Security with the given `identifier`
$$v2_data_point_text_description$$

[//]: # (END_OVERVIEW)

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

identifier = 'AAPL'
tag = 'ceo'
identifier = '$$v2_data_point_identifier_default$$'
tag = '$$v2_data_point_item_text_default$$'

response = intrinio.DataPointApi().get_data_point_text(identifier, tag)
print(response)
Expand All @@ -150,8 +150,8 @@ print(response)

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | str| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) | &nbsp;
**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;
**identifier** | str| $$v2_data_point_identifier_description$$ | &nbsp;
**tag** | str| $$v2_data_point_item_description$$ | &nbsp;
<br/>

[//]: # (END_PARAMETERS)
Expand Down
6 changes: 4 additions & 2 deletions docs/FilingApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Method | HTTP request | Description

[//]: # (START_OVERVIEW)

> 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)
> 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)
#### All Filings

Expand Down Expand Up @@ -70,10 +70,11 @@ end_date = ''
industry_category = ''
industry_group = ''
thea_enabled = ''
earnings_release = ''
page_size = 100
next_page = ''

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)
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)
print(response)

# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)
Expand All @@ -96,6 +97,7 @@ Name | Type | Description | Notes
**industry_category** | str| Return companies in the given industry category | [optional] &nbsp;
**industry_group** | str| Return companies in the given industry group | [optional] &nbsp;
**thea_enabled** | bool| Return filings that have been read by our Thea NLP and are ready for our answers endpoint | [optional] &nbsp;
**earnings_release** | bool| Return filings that have been tagged as having Results of Operations and Financial Conditions | [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/>
Expand Down
4 changes: 2 additions & 2 deletions docs/FundamentalsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,7 @@ intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

id = 'AAPL-income_statement-2020-FY'
tag = 'ceo'
tag = '$$v2_data_point_item_text_default$$'

response = intrinio.FundamentalsApi().get_fundamental_standardized_financials_dimensions(id, tag)
print(response)
Expand All @@ -402,7 +402,7 @@ print(response)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | str| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental | &nbsp;
**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;
**tag** | str| $$v2_data_point_item_description$$ | &nbsp;
<br/>

[//]: # (END_PARAMETERS)
Expand Down
10 changes: 5 additions & 5 deletions docs/HistoricalDataApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Method | HTTP request | Description
#### Historical Data


Returns historical values for the given `tag` and the entity represented by the given `identifier`
$$v2_historical_data_description$$

[//]: # (END_OVERVIEW)

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

identifier = 'AAPL'
tag = 'marketcap'
identifier = '$$v2_historical_data_identifier_default$$'
tag = '$$v2_historical_data_item_default$$'
frequency = 'daily'
type = ''
start_date = '2015-01-01'
Expand All @@ -79,8 +79,8 @@ print(response)

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | str| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) | &nbsp;
**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;
**identifier** | str| $$v2_historical_data_identifier_description$$ | &nbsp;
**tag** | str| $$v2_historical_data_item_description$$ | &nbsp;
**frequency** | str| Return historical data in the given frequency | [optional] [default to daily] &nbsp;
**type** | str| Filter by type, when applicable | [optional] &nbsp;
**start_date** | date| Get historical data on or after this date | [optional] &nbsp;
Expand Down
Loading

0 comments on commit f3683bf

Please sign in to comment.