Skip to content

Commit

Permalink
No notes for this build.
Browse files Browse the repository at this point in the history
  • Loading branch information
ssnyder-intrinio committed Jun 5, 2024
1 parent c308ad7 commit 097cf43
Show file tree
Hide file tree
Showing 656 changed files with 7,649 additions and 643 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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.56.6
- API version: 2.61.1
- Package version: 6.27.2


Expand Down Expand Up @@ -158,13 +158,18 @@ Class | Method | HTTP request | Description
*FundamentalsApi* | [**lookup_fundamental**](docs/FundamentalsApi.md#lookup_fundamental) | **GET** /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental
*HistoricalDataApi* | [**get_historical_data**](docs/HistoricalDataApi.md#get_historical_data) | **GET** /historical_data/{identifier}/{tag} | Historical Data
*IndexApi* | [**get_all_economic_indices**](docs/IndexApi.md#get_all_economic_indices) | **GET** /indices/economic | All Economic Indices
*IndexApi* | [**get_all_eod_index_prices**](docs/IndexApi.md#get_all_eod_index_prices) | **GET** /indices/prices/eod | All End of Day Index Prices
*IndexApi* | [**get_all_index_summaries**](docs/IndexApi.md#get_all_index_summaries) | **GET** /indices | All Index Summaries
*IndexApi* | [**get_all_realtime_index_prices**](docs/IndexApi.md#get_all_realtime_index_prices) | **GET** /indices/prices/realtime | All Realtime Index Prices
*IndexApi* | [**get_all_sic_indices**](docs/IndexApi.md#get_all_sic_indices) | **GET** /indices/sic | All SIC Indices
*IndexApi* | [**get_all_stock_market_indices**](docs/IndexApi.md#get_all_stock_market_indices) | **GET** /indices/stock_market | All Stock Market Indices
*IndexApi* | [**get_economic_index_by_id**](docs/IndexApi.md#get_economic_index_by_id) | **GET** /indices/economic/{identifier} | Lookup Economic Index
*IndexApi* | [**get_economic_index_data_point_number**](docs/IndexApi.md#get_economic_index_data_point_number) | **GET** /indices/economic/{identifier}/data_point/{tag}/number | Data Point (Number) for an Economic Index
*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_realtime_index_price_by_id**](docs/IndexApi.md#get_realtime_index_price_by_id) | **GET** /indices/{identifier}/realtime | Realtime Index Price
*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_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
*IndexApi* | [**get_sic_index_data_point_number**](docs/IndexApi.md#get_sic_index_data_point_number) | **GET** /indices/sic/{identifier}/data_point/{tag}/number | Data Point (Number) for an SIC Index
*IndexApi* | [**get_sic_index_data_point_text**](docs/IndexApi.md#get_sic_index_data_point_text) | **GET** /indices/sic/{identifier}/data_point/{tag}/text | Data Point (Text) for an SIC Index
Expand All @@ -182,6 +187,7 @@ Class | Method | HTTP request | Description
*MunicipalityApi* | [**get_municipality_by_id**](docs/MunicipalityApi.md#get_municipality_by_id) | **GET** /municipalities/{id} | Municipality by ID
*MunicipalityApi* | [**get_municipality_financials**](docs/MunicipalityApi.md#get_municipality_financials) | **GET** /municipalities/{id}/financials | Financials for a Municipality
*OptionsApi* | [**get_all_options_tickers**](docs/OptionsApi.md#get_all_options_tickers) | **GET** /options/tickers | Options Tickers
*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_options**](docs/OptionsApi.md#get_options) | **GET** /options/{symbol} | Options
Expand Down Expand Up @@ -307,10 +313,13 @@ Class | Method | HTTP request | Description
*TechnicalApi* | [**get_security_price_technicals_vwap**](docs/TechnicalApi.md#get_security_price_technicals_vwap) | **GET** /securities/{identifier}/prices/technicals/vwap | Volume Weighted Average Price
*TechnicalApi* | [**get_security_price_technicals_wr**](docs/TechnicalApi.md#get_security_price_technicals_wr) | **GET** /securities/{identifier}/prices/technicals/wr | Williams %R
*ZacksApi* | [**get_zacks_analyst_ratings**](docs/ZacksApi.md#get_zacks_analyst_ratings) | **GET** /zacks/analyst_ratings | Zacks Analyst Ratings
*ZacksApi* | [**get_zacks_ebitda_consensus**](docs/ZacksApi.md#get_zacks_ebitda_consensus) | **GET** /zacks/ebitda_consensus | Zacks EBITDA Consensus
*ZacksApi* | [**get_zacks_eps_estimates**](docs/ZacksApi.md#get_zacks_eps_estimates) | **GET** /zacks/eps_estimates | Zacks EPS Estimates
*ZacksApi* | [**get_zacks_eps_growth_rates**](docs/ZacksApi.md#get_zacks_eps_growth_rates) | **GET** /zacks/eps_growth_rates | Zacks EPS Growth Rates
*ZacksApi* | [**get_zacks_eps_surprises**](docs/ZacksApi.md#get_zacks_eps_surprises) | **GET** /zacks/eps_surprises | Zacks EPS Surprises
*ZacksApi* | [**get_zacks_etf_holdings**](docs/ZacksApi.md#get_zacks_etf_holdings) | **GET** /zacks/etf_holdings | Zacks ETF Holdings
*ZacksApi* | [**get_zacks_forward_pe**](docs/ZacksApi.md#get_zacks_forward_pe) | **GET** /zacks/forward_pe | Zacks Forward PE Estimates
*ZacksApi* | [**get_zacks_forward_pe_by_identifier**](docs/ZacksApi.md#get_zacks_forward_pe_by_identifier) | **GET** /zacks/forward_pe/{identifier} | Zacks Forward PE by identifer
*ZacksApi* | [**get_zacks_institutional_holding_companies**](docs/ZacksApi.md#get_zacks_institutional_holding_companies) | **GET** /zacks/institutional_holdings/companies | Zacks Institutional Holding Companies
*ZacksApi* | [**get_zacks_institutional_holding_owners**](docs/ZacksApi.md#get_zacks_institutional_holding_owners) | **GET** /zacks/institutional_holdings/owners | Zacks Institutional Holding Owners
*ZacksApi* | [**get_zacks_institutional_holdings**](docs/ZacksApi.md#get_zacks_institutional_holdings) | **GET** /zacks/institutional_holdings | Zacks Institutional Holdings
Expand Down Expand Up @@ -349,6 +358,8 @@ Class | Method | HTTP request | Description
- [ApiResponseEconomicIndexHistoricalData](docs/ApiResponseEconomicIndexHistoricalData.md)
- [ApiResponseEconomicIndices](docs/ApiResponseEconomicIndices.md)
- [ApiResponseEconomicIndicesSearch](docs/ApiResponseEconomicIndicesSearch.md)
- [ApiResponseEodIndexPrices](docs/ApiResponseEodIndexPrices.md)
- [ApiResponseEodIndexPricesAll](docs/ApiResponseEodIndexPricesAll.md)
- [ApiResponseFilingAnswers](docs/ApiResponseFilingAnswers.md)
- [ApiResponseFilingFundamentals](docs/ApiResponseFilingFundamentals.md)
- [ApiResponseFilingNotes](docs/ApiResponseFilingNotes.md)
Expand All @@ -358,13 +369,16 @@ Class | Method | HTTP request | Description
- [ApiResponseForexPairs](docs/ApiResponseForexPairs.md)
- [ApiResponseForexPrices](docs/ApiResponseForexPrices.md)
- [ApiResponseHistoricalData](docs/ApiResponseHistoricalData.md)
- [ApiResponseIndex](docs/ApiResponseIndex.md)
- [ApiResponseIndices](docs/ApiResponseIndices.md)
- [ApiResponseInitialPublicOfferings](docs/ApiResponseInitialPublicOfferings.md)
- [ApiResponseInsiderTransactionFilings](docs/ApiResponseInsiderTransactionFilings.md)
- [ApiResponseMunicipalities](docs/ApiResponseMunicipalities.md)
- [ApiResponseMunicipalitiyFinancials](docs/ApiResponseMunicipalitiyFinancials.md)
- [ApiResponseNews](docs/ApiResponseNews.md)
- [ApiResponseOptionPrices](docs/ApiResponseOptionPrices.md)
- [ApiResponseOptions](docs/ApiResponseOptions.md)
- [ApiResponseOptionsAggregates](docs/ApiResponseOptionsAggregates.md)
- [ApiResponseOptionsChain](docs/ApiResponseOptionsChain.md)
- [ApiResponseOptionsChainEod](docs/ApiResponseOptionsChainEod.md)
- [ApiResponseOptionsChainRealtime](docs/ApiResponseOptionsChainRealtime.md)
Expand All @@ -379,6 +393,7 @@ Class | Method | HTTP request | Description
- [ApiResponseOwnerInsiderTransactionFilings](docs/ApiResponseOwnerInsiderTransactionFilings.md)
- [ApiResponseOwnerInstitutionalHoldings](docs/ApiResponseOwnerInstitutionalHoldings.md)
- [ApiResponseOwners](docs/ApiResponseOwners.md)
- [ApiResponseRealtimeIndexPrices](docs/ApiResponseRealtimeIndexPrices.md)
- [ApiResponseReportedFinancials](docs/ApiResponseReportedFinancials.md)
- [ApiResponseSICIndexHistoricalData](docs/ApiResponseSICIndexHistoricalData.md)
- [ApiResponseSICIndices](docs/ApiResponseSICIndices.md)
Expand Down Expand Up @@ -437,10 +452,12 @@ Class | Method | HTTP request | Description
- [ApiResponseStockMarketIndices](docs/ApiResponseStockMarketIndices.md)
- [ApiResponseStockMarketIndicesSearch](docs/ApiResponseStockMarketIndicesSearch.md)
- [ApiResponseZacksAnalystRatings](docs/ApiResponseZacksAnalystRatings.md)
- [ApiResponseZacksEBITDAConsensus](docs/ApiResponseZacksEBITDAConsensus.md)
- [ApiResponseZacksEPSEstimates](docs/ApiResponseZacksEPSEstimates.md)
- [ApiResponseZacksEPSGrowthRates](docs/ApiResponseZacksEPSGrowthRates.md)
- [ApiResponseZacksEPSSurprises](docs/ApiResponseZacksEPSSurprises.md)
- [ApiResponseZacksETFHoldings](docs/ApiResponseZacksETFHoldings.md)
- [ApiResponseZacksForwardPEs](docs/ApiResponseZacksForwardPEs.md)
- [ApiResponseZacksInstitutionalHoldingCompanies](docs/ApiResponseZacksInstitutionalHoldingCompanies.md)
- [ApiResponseZacksInstitutionalHoldingOwners](docs/ApiResponseZacksInstitutionalHoldingOwners.md)
- [ApiResponseZacksInstitutionalHoldings](docs/ApiResponseZacksInstitutionalHoldings.md)
Expand Down Expand Up @@ -485,6 +502,8 @@ Class | Method | HTTP request | Description
- [EaseOfMovementTechnicalValue](docs/EaseOfMovementTechnicalValue.md)
- [EconomicIndex](docs/EconomicIndex.md)
- [EconomicIndexSummary](docs/EconomicIndexSummary.md)
- [EodIndexPrice](docs/EodIndexPrice.md)
- [EodIndexPriceSummary](docs/EodIndexPriceSummary.md)
- [Filing](docs/Filing.md)
- [FilingNote](docs/FilingNote.md)
- [FilingNoteFiling](docs/FilingNoteFiling.md)
Expand Down Expand Up @@ -536,6 +555,7 @@ Class | Method | HTTP request | Description
- [OptionSnapshotsResult](docs/OptionSnapshotsResult.md)
- [OptionStatsRealtime](docs/OptionStatsRealtime.md)
- [OptionUnusualTrade](docs/OptionUnusualTrade.md)
- [OptionsAggregate](docs/OptionsAggregate.md)
- [Owner](docs/Owner.md)
- [OwnerSummary](docs/OwnerSummary.md)
- [RealtimeIndexPrice](docs/RealtimeIndexPrice.md)
Expand Down Expand Up @@ -587,11 +607,13 @@ Class | Method | HTTP request | Description
- [ZacksAnalystRating](docs/ZacksAnalystRating.md)
- [ZacksAnalystRatingSnapshot](docs/ZacksAnalystRatingSnapshot.md)
- [ZacksAnalystRatingSummary](docs/ZacksAnalystRatingSummary.md)
- [ZacksEBITDAConsensus](docs/ZacksEBITDAConsensus.md)
- [ZacksEPSEstimate](docs/ZacksEPSEstimate.md)
- [ZacksEPSGrowthRate](docs/ZacksEPSGrowthRate.md)
- [ZacksEPSSurprise](docs/ZacksEPSSurprise.md)
- [ZacksEPSSurpriseSummary](docs/ZacksEPSSurpriseSummary.md)
- [ZacksETFHolding](docs/ZacksETFHolding.md)
- [ZacksForwardPE](docs/ZacksForwardPE.md)
- [ZacksInstitutionalHolding](docs/ZacksInstitutionalHolding.md)
- [ZacksInstitutionalHoldingCompanyDetail](docs/ZacksInstitutionalHoldingCompanyDetail.md)
- [ZacksInstitutionalHoldingCompanySummary](docs/ZacksInstitutionalHoldingCompanySummary.md)
Expand Down
28 changes: 28 additions & 0 deletions docs/ApiResponseEodIndexPrices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@


[//]: # (CLASS:ApiResponseEodIndexPrices)

[//]: # (KIND:object)

### ApiResponseEodIndexPrices

#### Properties

[//]: # (START_DEFINITION)

Name | Type | Description
------------ | ------------- | -------------
**prices** | [**list[EodIndexPriceSummary]**](EodIndexPriceSummary.md) |  
**index** | [**ApiResponseIndex**](ApiResponseIndex.md) | The index  
**next_page** | str | The token required to request the next page of the data. If null, no further results are available.  

[//]: # (END_DEFINITION)


[//]: # (CONTAINED_CLASS:EodIndexPriceSummary)


[//]: # (CONTAINED_CLASS:ApiResponseIndex)



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


[//]: # (CLASS:ApiResponseEodIndexPricesAll)

[//]: # (KIND:object)

### ApiResponseEodIndexPricesAll

#### Properties

[//]: # (START_DEFINITION)

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

[//]: # (END_DEFINITION)


[//]: # (CONTAINED_CLASS:EodIndexPrice)



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


[//]: # (CLASS:ApiResponseIndex)

[//]: # (KIND:object)

### ApiResponseIndex

#### Properties

[//]: # (START_DEFINITION)

Name | Type | Description
------------ | ------------- | -------------
**symbol** | str | The index symbol  
**name** | str | The index name  

[//]: # (END_DEFINITION)



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


[//]: # (CLASS:ApiResponseIndices)

[//]: # (KIND:object)

### ApiResponseIndices

#### Properties

[//]: # (START_DEFINITION)

Name | Type | Description
------------ | ------------- | -------------
**indices** | [**list[ApiResponseIndex]**](ApiResponseIndex.md) |  
**next_page** | str | The token required to request the next page of the data. If null, no further results are available.  

[//]: # (END_DEFINITION)


[//]: # (CONTAINED_CLASS:ApiResponseIndex)



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


[//]: # (CLASS:ApiResponseOptionsAggregates)

[//]: # (KIND:object)

### ApiResponseOptionsAggregates

#### Properties

[//]: # (START_DEFINITION)

Name | Type | Description
------------ | ------------- | -------------
**aggregates** | [**list[OptionsAggregate]**](OptionsAggregate.md) | A list of option expiration dates in descending order  
**next_page** | str | The token required to request the next page of the data. If null, no further results are available.  

[//]: # (END_DEFINITION)


[//]: # (CONTAINED_CLASS:OptionsAggregate)



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


[//]: # (CLASS:ApiResponseRealtimeIndexPrices)

[//]: # (KIND:object)

### ApiResponseRealtimeIndexPrices

#### Properties

[//]: # (START_DEFINITION)

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

[//]: # (END_DEFINITION)


[//]: # (CONTAINED_CLASS:RealtimeIndexPrice)



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


[//]: # (CLASS:ApiResponseZacksEBITDAConsensus)

[//]: # (KIND:object)

### ApiResponseZacksEBITDAConsensus

#### Properties

[//]: # (START_DEFINITION)

Name | Type | Description
------------ | ------------- | -------------
**ebitda_consensuses** | [**list[ZacksEBITDAConsensus]**](ZacksEBITDAConsensus.md) | Zacks target price consensuses for the latest date  
**next_page** | str | The token required to request the next page of the data. If null, no further results are available.  

[//]: # (END_DEFINITION)


[//]: # (CONTAINED_CLASS:ZacksEBITDAConsensus)



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


[//]: # (CLASS:ApiResponseZacksForwardPEs)

[//]: # (KIND:object)

### ApiResponseZacksForwardPEs

#### Properties

[//]: # (START_DEFINITION)

Name | Type | Description
------------ | ------------- | -------------
**forward_pe** | [**list[ZacksForwardPE]**](ZacksForwardPE.md) | Zacks forward PE ratio estimates  
**next_page** | str | The token required to request the next page of the data. If null, no further results are available.  

[//]: # (END_DEFINITION)


[//]: # (CONTAINED_CLASS:ZacksForwardPE)



12 changes: 7 additions & 5 deletions docs/CompanyApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ print(response)

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**specific_source** | str| Only news from this source. | [optional]  
**specific_source** | str| Only news from this source. Defaults to highest available if not present. | [optional]  
**page_size** | int| The maximum number of results to return. | [optional] [default to 100]  
**sentiment** | str| Filter by sentiment. Unsupported for yahoo source. | [optional]  
**topic** | str| Filter by topic. Unsupported for yahoo source. | [optional]  
Expand Down Expand Up @@ -1140,7 +1140,7 @@ print(response)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | str| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |  
**specific_source** | str| Only news from this source | [optional]  
**specific_source** | str| Only news from this source. Defaults to highest available if not present. | [optional]  
**page_size** | int| The maximum number of results to return | [optional] [default to 100]  
**sentiment** | str| Filter by sentiment. Unsupported for yahoo source. | [optional]  
**topic** | str| Filter by topic. Unsupported for yahoo source. | [optional]  
Expand Down Expand Up @@ -1671,7 +1671,7 @@ Name | Type | Description | Notes

[//]: # (START_OVERVIEW)

> ApiResponseCompaniesSearch search_companies(query, active=active, page_size=page_size)
> ApiResponseCompaniesSearch search_companies(query, active=active, mode=mode, page_size=page_size)
#### Search Companies

Expand All @@ -1694,9 +1694,10 @@ intrinio.ApiClient().allow_retries(True)

query = 'Apple'
active = True
mode = ''
page_size = 100

response = intrinio.CompanyApi().search_companies(query, active=active, page_size=page_size)
response = intrinio.CompanyApi().search_companies(query, active=active, mode=mode, page_size=page_size)
print(response)

# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)
Expand All @@ -1713,7 +1714,8 @@ print(response)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**query** | str| Search parameters |  
**active** | bool| When True, return companies that are actively traded (having stock prices within the past 14 days). When False, return companies that are not actively traded or never have been traded. | [optional]  
**active** | bool| When True, return companies that are actively traded (having stock prices within the past 14 days). When False, return companies that are not actively traded or never have been traded. Not setting this value returns all. Not used when mode is set. | [optional]  
**mode** | str| When set, changes search mode to the specified mode. | [optional]  
**page_size** | int| The number of results to return | [optional] [default to 100]  
<br/>

Expand Down
1 change: 1 addition & 0 deletions docs/CompanyNews.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Name | Type | Description
**business_relevance** | float | How strongly correlated the news article is to the business &nbsp;
**article_sentiment** | str | The news sentiment. &nbsp;
**article_sentiment_confidence** | float | The confidence score of the sentiment rating &nbsp;
**body** | str | The article body. Requires additional access. &nbsp;

[//]: # (END_DEFINITION)

Expand Down
Loading

0 comments on commit 097cf43

Please sign in to comment.