From 99ac1f8a39de7fcf3031303d2ff6f6e6ea4bc599 Mon Sep 17 00:00:00 2001 From: Matt Von Lintel Date: Tue, 5 May 2020 14:50:35 -0600 Subject: [PATCH] No release notes for this build --- ...mulationDistributionIndexTechnicalValue.md | 25 + docs/ApiResponseBulkDownloadLinks.md | 24 + docs/ApiResponseCompanies.md | 25 + docs/ApiResponseCompaniesSearch.md | 24 + docs/ApiResponseCompanyFilings.md | 29 + docs/ApiResponseCompanyFundamentals.md | 29 + docs/ApiResponseCompanyHistoricalData.md | 29 + docs/ApiResponseCompanyNews.md | 29 + docs/ApiResponseCompanySecurities.md | 29 + docs/ApiResponseDataTags.md | 25 + docs/ApiResponseDataTagsSearch.md | 24 + .../ApiResponseEconomicIndexHistoricalData.md | 29 + docs/ApiResponseEconomicIndices.md | 25 + docs/ApiResponseEconomicIndicesSearch.md | 24 + docs/ApiResponseFilingFundamentals.md | 29 + docs/ApiResponseFilingNotes.md | 25 + docs/ApiResponseFilingNotesSearch.md | 24 + docs/ApiResponseFilings.md | 25 + docs/ApiResponseForexCurrencies.md | 24 + docs/ApiResponseForexPairs.md | 24 + docs/ApiResponseForexPrices.md | 29 + docs/ApiResponseHistoricalData.md | 25 + docs/ApiResponseInitialPublicOfferings.md | 25 + docs/ApiResponseMunicipalities.md | 25 + docs/ApiResponseMunicipalitiyFinancials.md | 28 + docs/ApiResponseNews.md | 25 + docs/ApiResponseOptionPrices.md | 29 + docs/ApiResponseOptions.md | 25 + docs/ApiResponseOptionsChain.md | 24 + docs/ApiResponseOptionsExpirations.md | 21 + docs/ApiResponseReportedFinancials.md | 29 + docs/ApiResponseSICIndexHistoricalData.md | 29 + docs/ApiResponseSICIndices.md | 25 + docs/ApiResponseSICIndicesSearch.md | 24 + docs/ApiResponseSecurities.md | 25 + docs/ApiResponseSecuritiesSearch.md | 24 + ...seSecurityAccumulationDistributionIndex.md | 33 + ...sponseSecurityAverageDailyTradingVolume.md | 33 + ...ResponseSecurityAverageDirectionalIndex.md | 33 + docs/ApiResponseSecurityAverageTrueRange.md | 33 + docs/ApiResponseSecurityAwesomeOscillator.md | 33 + docs/ApiResponseSecurityBollingerBands.md | 33 + docs/ApiResponseSecurityChaikinMoneyFlow.md | 33 + ...piResponseSecurityCommodityChannelIndex.md | 33 + ...esponseSecurityDetrendedPriceOscillator.md | 33 + docs/ApiResponseSecurityDonchianChannel.md | 33 + docs/ApiResponseSecurityEaseOfMovement.md | 33 + docs/ApiResponseSecurityForceIndex.md | 33 + docs/ApiResponseSecurityHistoricalData.md | 29 + docs/ApiResponseSecurityIchimokuKinkoHyo.md | 33 + docs/ApiResponseSecurityIntradayPrices.md | 39 + docs/ApiResponseSecurityKeltnerChannel.md | 33 + docs/ApiResponseSecurityKnowSureThing.md | 33 + docs/ApiResponseSecurityMassIndex.md | 33 + docs/ApiResponseSecurityMoneyFlowIndex.md | 33 + ...urityMovingAverageConvergenceDivergence.md | 33 + .../ApiResponseSecurityNegativeVolumeIndex.md | 33 + docs/ApiResponseSecurityOnBalanceVolume.md | 33 + .../ApiResponseSecurityOnBalanceVolumeMean.md | 33 + ...piResponseSecurityRelativeStrengthIndex.md | 33 + .../ApiResponseSecuritySimpleMovingAverage.md | 33 + ...ApiResponseSecurityStochasticOscillator.md | 33 + ...piResponseSecurityStockPriceAdjustments.md | 29 + docs/ApiResponseSecurityStockPrices.md | 29 + ...esponseSecurityTripleExponentialAverage.md | 33 + docs/ApiResponseSecurityTrueStrengthIndex.md | 33 + docs/ApiResponseSecurityUltimateOscillator.md | 33 + docs/ApiResponseSecurityVolumePriceTrend.md | 33 + ...ponseSecurityVolumeWeightedAveragePrice.md | 33 + docs/ApiResponseSecurityVortexIndicator.md | 33 + docs/ApiResponseSecurityWilliamsR.md | 33 + .../ApiResponseSecurityZacksAnalystRatings.md | 29 + ...onseSecurityZacksAnalystRatingsSnapshot.md | 28 + docs/ApiResponseSecurityZacksEPSSurprises.md | 29 + .../ApiResponseSecurityZacksSalesSurprises.md | 29 + docs/ApiResponseStandardizedFinancials.md | 29 + ...esponseStockExchangeRealtimeStockPrices.md | 29 + docs/ApiResponseStockExchangeSecurities.md | 29 + ...ponseStockExchangeStockPriceAdjustments.md | 29 + docs/ApiResponseStockExchangeStockPrices.md | 29 + docs/ApiResponseStockExchanges.md | 25 + ...iResponseStockMarketIndexHistoricalData.md | 29 + docs/ApiResponseStockMarketIndices.md | 25 + docs/ApiResponseStockMarketIndicesSearch.md | 24 + docs/ApiResponseZacksAnalystRatings.md | 25 + docs/ApiResponseZacksEPSEstimates.md | 25 + docs/ApiResponseZacksEPSGrowthRates.md | 25 + docs/ApiResponseZacksEPSSurprises.md | 25 + docs/ApiResponseZacksETFHoldings.md | 25 + ...ponseZacksInstitutionalHoldingCompanies.md | 25 + ...ResponseZacksInstitutionalHoldingOwners.md | 25 + docs/ApiResponseZacksInstitutionalHoldings.md | 25 + docs/ApiResponseZacksLongTermGrowthRates.md | 25 + docs/ApiResponseZacksSalesSurprises.md | 25 + .../ApiResponseZacksTargetPriceConsensuses.md | 25 + ...AverageDailyTradingVolumeTechnicalValue.md | 25 + docs/AverageDirectionalIndexTechnicalValue.md | 27 + docs/AverageTrueRangeTechnicalValue.md | 25 + docs/AwesomeOscillatorTechnicalValue.md | 25 + docs/BollingerBandsTechnicalValue.md | 27 + docs/BulkDownloadLinks.md | 22 + docs/BulkDownloadSummary.md | 29 + docs/BulkDownloadsApi.md | 95 + docs/ChaikinMoneyFlowTechnicalValue.md | 25 + docs/CommodityChannelIndexTechnicalValue.md | 25 + docs/Company.md | 71 + docs/CompanyApi.md | 1289 +++++ docs/CompanyFiling.md | 42 + docs/CompanyInitialPublicOffering.md | 100 + docs/CompanyNews.md | 32 + docs/CompanyNewsSummary.md | 28 + docs/CompanySummary.md | 25 + docs/DataPointApi.md | 194 + docs/DataTag.md | 43 + docs/DataTagApi.md | 295 + docs/DataTagSummary.md | 31 + .../DetrendedPriceOscillatorTechnicalValue.md | 25 + docs/DividendRecord.md | 66 + docs/DonchianChannelTechnicalValue.md | 26 + docs/EarningsRecord.md | 104 + docs/EaseOfMovementTechnicalValue.md | 25 + docs/EconomicIndex.md | 41 + docs/EconomicIndexSummary.md | 40 + docs/Filing.md | 45 + docs/FilingApi.md | 963 ++++ docs/FilingNote.md | 27 + docs/FilingNoteFiling.md | 30 + docs/FilingNoteSummary.md | 26 + docs/FilingSummary.md | 38 + docs/ForceIndexTechnicalValue.md | 25 + docs/ForexApi.md | 289 + docs/ForexCurrency.md | 23 + docs/ForexPair.md | 23 + docs/ForexPrice.md | 30 + docs/Fundamental.md | 55 + docs/FundamentalSummary.md | 50 + docs/FundamentalsApi.md | 378 ++ docs/HistoricalData.md | 28 + docs/HistoricalDataApi.md | 115 + docs/IchimokuKinkoHyoTechnicalValue.md | 29 + docs/IndexApi.md | 1706 ++++++ docs/IntradayStockPrice.md | 49 + docs/KeltnerChannelTechnicalValue.md | 27 + docs/KnowSureThingTechnicalValue.md | 25 + docs/MassIndexTechnicalValue.md | 25 + docs/MoneyFlowIndexTechnicalValue.md | 25 + ...rageConvergenceDivergenceTechnicalValue.md | 27 + docs/Municipality.md | 54 + docs/MunicipalityApi.md | 306 ++ docs/MunicipalityFinancial.md | 188 + docs/NegativeVolumeIndexTechnicalValue.md | 25 + docs/OnBalanceVolumeMeanTechnicalValue.md | 25 + docs/OnBalanceVolumeTechnicalValue.md | 25 + docs/Option.md | 29 + docs/OptionChain.md | 28 + docs/OptionPrice.md | 52 + docs/OptionsApi.md | 418 ++ docs/RealtimeStockPrice.md | 73 + docs/RealtimeStockPriceSecurity.md | 25 + docs/RelativeStrengthIndexTechnicalValue.md | 25 + docs/ReportedFinancial.md | 32 + docs/ReportedFinancialDimension.md | 22 + docs/ReportedTag.md | 27 + docs/SICIndex.md | 25 + docs/Security.md | 63 + docs/SecurityApi.md | 4876 +++++++++++++++++ docs/SecurityScreenClause.md | 36 + docs/SecurityScreenGroup.md | 29 + docs/SecurityScreenResult.md | 28 + docs/SecurityScreenResultData.md | 23 + docs/SecuritySummary.md | 30 + docs/SimpleMovingAverageTechnicalValue.md | 25 + docs/StandardizedFinancial.md | 28 + docs/StochasticOscillatorTechnicalValue.md | 26 + docs/StockExchange.md | 36 + docs/StockExchangeApi.md | 582 ++ docs/StockMarketIndex.md | 39 + docs/StockMarketIndexSummary.md | 38 + docs/StockPrice.md | 82 + docs/StockPriceAdjustment.md | 41 + docs/StockPriceAdjustmentSummary.md | 37 + docs/StockPriceSummary.md | 78 + docs/TechnicalApi.md | 3187 +++++++++++ docs/TechnicalIndicator.md | 22 + .../TripleExponentialAverageTechnicalValue.md | 25 + docs/TrueStrengthIndexTechnicalValue.md | 25 + docs/UltimateOscillatorTechnicalValue.md | 25 + docs/VolumePriceTrendTechnicalValue.md | 25 + docs/VolumeWeightedAveragePriceValue.md | 25 + docs/VortexIndicatorTechnicalValue.md | 26 + docs/WilliamsRTechnicalValue.md | 25 + docs/ZacksAnalystRating.md | 39 + docs/ZacksAnalystRatingSnapshot.md | 43 + docs/ZacksAnalystRatingSummary.md | 35 + docs/ZacksApi.md | 1163 ++++ docs/ZacksEPSEstimate.md | 73 + docs/ZacksEPSGrowthRate.md | 91 + docs/ZacksEPSSurprise.md | 70 + docs/ZacksEPSSurpriseSummary.md | 66 + docs/ZacksETFHolding.md | 36 + docs/ZacksInstitutionalHolding.md | 69 + .../ZacksInstitutionalHoldingCompanyDetail.md | 63 + ...ZacksInstitutionalHoldingCompanySummary.md | 23 + ...ksInstitutionalHoldingHistoricalSummary.md | 28 + docs/ZacksInstitutionalHoldingOwnerDetail.md | 53 + docs/ZacksInstitutionalHoldingOwnerSummary.md | 22 + docs/ZacksLongTermGrowthRate.md | 60 + docs/ZacksSalesSurprise.md | 70 + docs/ZacksSalesSurpriseSummary.md | 74 + docs/ZacksTargetPriceConsensus.md | 54 + 210 files changed, 22573 insertions(+) create mode 100644 docs/AccumulationDistributionIndexTechnicalValue.md create mode 100644 docs/ApiResponseBulkDownloadLinks.md create mode 100644 docs/ApiResponseCompanies.md create mode 100644 docs/ApiResponseCompaniesSearch.md create mode 100644 docs/ApiResponseCompanyFilings.md create mode 100644 docs/ApiResponseCompanyFundamentals.md create mode 100644 docs/ApiResponseCompanyHistoricalData.md create mode 100644 docs/ApiResponseCompanyNews.md create mode 100644 docs/ApiResponseCompanySecurities.md create mode 100644 docs/ApiResponseDataTags.md create mode 100644 docs/ApiResponseDataTagsSearch.md create mode 100644 docs/ApiResponseEconomicIndexHistoricalData.md create mode 100644 docs/ApiResponseEconomicIndices.md create mode 100644 docs/ApiResponseEconomicIndicesSearch.md create mode 100644 docs/ApiResponseFilingFundamentals.md create mode 100644 docs/ApiResponseFilingNotes.md create mode 100644 docs/ApiResponseFilingNotesSearch.md create mode 100644 docs/ApiResponseFilings.md create mode 100644 docs/ApiResponseForexCurrencies.md create mode 100644 docs/ApiResponseForexPairs.md create mode 100644 docs/ApiResponseForexPrices.md create mode 100644 docs/ApiResponseHistoricalData.md create mode 100644 docs/ApiResponseInitialPublicOfferings.md create mode 100644 docs/ApiResponseMunicipalities.md create mode 100644 docs/ApiResponseMunicipalitiyFinancials.md create mode 100644 docs/ApiResponseNews.md create mode 100644 docs/ApiResponseOptionPrices.md create mode 100644 docs/ApiResponseOptions.md create mode 100644 docs/ApiResponseOptionsChain.md create mode 100644 docs/ApiResponseOptionsExpirations.md create mode 100644 docs/ApiResponseReportedFinancials.md create mode 100644 docs/ApiResponseSICIndexHistoricalData.md create mode 100644 docs/ApiResponseSICIndices.md create mode 100644 docs/ApiResponseSICIndicesSearch.md create mode 100644 docs/ApiResponseSecurities.md create mode 100644 docs/ApiResponseSecuritiesSearch.md create mode 100644 docs/ApiResponseSecurityAccumulationDistributionIndex.md create mode 100644 docs/ApiResponseSecurityAverageDailyTradingVolume.md create mode 100644 docs/ApiResponseSecurityAverageDirectionalIndex.md create mode 100644 docs/ApiResponseSecurityAverageTrueRange.md create mode 100644 docs/ApiResponseSecurityAwesomeOscillator.md create mode 100644 docs/ApiResponseSecurityBollingerBands.md create mode 100644 docs/ApiResponseSecurityChaikinMoneyFlow.md create mode 100644 docs/ApiResponseSecurityCommodityChannelIndex.md create mode 100644 docs/ApiResponseSecurityDetrendedPriceOscillator.md create mode 100644 docs/ApiResponseSecurityDonchianChannel.md create mode 100644 docs/ApiResponseSecurityEaseOfMovement.md create mode 100644 docs/ApiResponseSecurityForceIndex.md create mode 100644 docs/ApiResponseSecurityHistoricalData.md create mode 100644 docs/ApiResponseSecurityIchimokuKinkoHyo.md create mode 100644 docs/ApiResponseSecurityIntradayPrices.md create mode 100644 docs/ApiResponseSecurityKeltnerChannel.md create mode 100644 docs/ApiResponseSecurityKnowSureThing.md create mode 100644 docs/ApiResponseSecurityMassIndex.md create mode 100644 docs/ApiResponseSecurityMoneyFlowIndex.md create mode 100644 docs/ApiResponseSecurityMovingAverageConvergenceDivergence.md create mode 100644 docs/ApiResponseSecurityNegativeVolumeIndex.md create mode 100644 docs/ApiResponseSecurityOnBalanceVolume.md create mode 100644 docs/ApiResponseSecurityOnBalanceVolumeMean.md create mode 100644 docs/ApiResponseSecurityRelativeStrengthIndex.md create mode 100644 docs/ApiResponseSecuritySimpleMovingAverage.md create mode 100644 docs/ApiResponseSecurityStochasticOscillator.md create mode 100644 docs/ApiResponseSecurityStockPriceAdjustments.md create mode 100644 docs/ApiResponseSecurityStockPrices.md create mode 100644 docs/ApiResponseSecurityTripleExponentialAverage.md create mode 100644 docs/ApiResponseSecurityTrueStrengthIndex.md create mode 100644 docs/ApiResponseSecurityUltimateOscillator.md create mode 100644 docs/ApiResponseSecurityVolumePriceTrend.md create mode 100644 docs/ApiResponseSecurityVolumeWeightedAveragePrice.md create mode 100644 docs/ApiResponseSecurityVortexIndicator.md create mode 100644 docs/ApiResponseSecurityWilliamsR.md create mode 100644 docs/ApiResponseSecurityZacksAnalystRatings.md create mode 100644 docs/ApiResponseSecurityZacksAnalystRatingsSnapshot.md create mode 100644 docs/ApiResponseSecurityZacksEPSSurprises.md create mode 100644 docs/ApiResponseSecurityZacksSalesSurprises.md create mode 100644 docs/ApiResponseStandardizedFinancials.md create mode 100644 docs/ApiResponseStockExchangeRealtimeStockPrices.md create mode 100644 docs/ApiResponseStockExchangeSecurities.md create mode 100644 docs/ApiResponseStockExchangeStockPriceAdjustments.md create mode 100644 docs/ApiResponseStockExchangeStockPrices.md create mode 100644 docs/ApiResponseStockExchanges.md create mode 100644 docs/ApiResponseStockMarketIndexHistoricalData.md create mode 100644 docs/ApiResponseStockMarketIndices.md create mode 100644 docs/ApiResponseStockMarketIndicesSearch.md create mode 100644 docs/ApiResponseZacksAnalystRatings.md create mode 100644 docs/ApiResponseZacksEPSEstimates.md create mode 100644 docs/ApiResponseZacksEPSGrowthRates.md create mode 100644 docs/ApiResponseZacksEPSSurprises.md create mode 100644 docs/ApiResponseZacksETFHoldings.md create mode 100644 docs/ApiResponseZacksInstitutionalHoldingCompanies.md create mode 100644 docs/ApiResponseZacksInstitutionalHoldingOwners.md create mode 100644 docs/ApiResponseZacksInstitutionalHoldings.md create mode 100644 docs/ApiResponseZacksLongTermGrowthRates.md create mode 100644 docs/ApiResponseZacksSalesSurprises.md create mode 100644 docs/ApiResponseZacksTargetPriceConsensuses.md create mode 100644 docs/AverageDailyTradingVolumeTechnicalValue.md create mode 100644 docs/AverageDirectionalIndexTechnicalValue.md create mode 100644 docs/AverageTrueRangeTechnicalValue.md create mode 100644 docs/AwesomeOscillatorTechnicalValue.md create mode 100644 docs/BollingerBandsTechnicalValue.md create mode 100644 docs/BulkDownloadLinks.md create mode 100644 docs/BulkDownloadSummary.md create mode 100644 docs/BulkDownloadsApi.md create mode 100644 docs/ChaikinMoneyFlowTechnicalValue.md create mode 100644 docs/CommodityChannelIndexTechnicalValue.md create mode 100644 docs/Company.md create mode 100644 docs/CompanyApi.md create mode 100644 docs/CompanyFiling.md create mode 100644 docs/CompanyInitialPublicOffering.md create mode 100644 docs/CompanyNews.md create mode 100644 docs/CompanyNewsSummary.md create mode 100644 docs/CompanySummary.md create mode 100644 docs/DataPointApi.md create mode 100644 docs/DataTag.md create mode 100644 docs/DataTagApi.md create mode 100644 docs/DataTagSummary.md create mode 100644 docs/DetrendedPriceOscillatorTechnicalValue.md create mode 100644 docs/DividendRecord.md create mode 100644 docs/DonchianChannelTechnicalValue.md create mode 100644 docs/EarningsRecord.md create mode 100644 docs/EaseOfMovementTechnicalValue.md create mode 100644 docs/EconomicIndex.md create mode 100644 docs/EconomicIndexSummary.md create mode 100644 docs/Filing.md create mode 100644 docs/FilingApi.md create mode 100644 docs/FilingNote.md create mode 100644 docs/FilingNoteFiling.md create mode 100644 docs/FilingNoteSummary.md create mode 100644 docs/FilingSummary.md create mode 100644 docs/ForceIndexTechnicalValue.md create mode 100644 docs/ForexApi.md create mode 100644 docs/ForexCurrency.md create mode 100644 docs/ForexPair.md create mode 100644 docs/ForexPrice.md create mode 100644 docs/Fundamental.md create mode 100644 docs/FundamentalSummary.md create mode 100644 docs/FundamentalsApi.md create mode 100644 docs/HistoricalData.md create mode 100644 docs/HistoricalDataApi.md create mode 100644 docs/IchimokuKinkoHyoTechnicalValue.md create mode 100644 docs/IndexApi.md create mode 100644 docs/IntradayStockPrice.md create mode 100644 docs/KeltnerChannelTechnicalValue.md create mode 100644 docs/KnowSureThingTechnicalValue.md create mode 100644 docs/MassIndexTechnicalValue.md create mode 100644 docs/MoneyFlowIndexTechnicalValue.md create mode 100644 docs/MovingAverageConvergenceDivergenceTechnicalValue.md create mode 100644 docs/Municipality.md create mode 100644 docs/MunicipalityApi.md create mode 100644 docs/MunicipalityFinancial.md create mode 100644 docs/NegativeVolumeIndexTechnicalValue.md create mode 100644 docs/OnBalanceVolumeMeanTechnicalValue.md create mode 100644 docs/OnBalanceVolumeTechnicalValue.md create mode 100644 docs/Option.md create mode 100644 docs/OptionChain.md create mode 100644 docs/OptionPrice.md create mode 100644 docs/OptionsApi.md create mode 100644 docs/RealtimeStockPrice.md create mode 100644 docs/RealtimeStockPriceSecurity.md create mode 100644 docs/RelativeStrengthIndexTechnicalValue.md create mode 100644 docs/ReportedFinancial.md create mode 100644 docs/ReportedFinancialDimension.md create mode 100644 docs/ReportedTag.md create mode 100644 docs/SICIndex.md create mode 100644 docs/Security.md create mode 100644 docs/SecurityApi.md create mode 100644 docs/SecurityScreenClause.md create mode 100644 docs/SecurityScreenGroup.md create mode 100644 docs/SecurityScreenResult.md create mode 100644 docs/SecurityScreenResultData.md create mode 100644 docs/SecuritySummary.md create mode 100644 docs/SimpleMovingAverageTechnicalValue.md create mode 100644 docs/StandardizedFinancial.md create mode 100644 docs/StochasticOscillatorTechnicalValue.md create mode 100644 docs/StockExchange.md create mode 100644 docs/StockExchangeApi.md create mode 100644 docs/StockMarketIndex.md create mode 100644 docs/StockMarketIndexSummary.md create mode 100644 docs/StockPrice.md create mode 100644 docs/StockPriceAdjustment.md create mode 100644 docs/StockPriceAdjustmentSummary.md create mode 100644 docs/StockPriceSummary.md create mode 100644 docs/TechnicalApi.md create mode 100644 docs/TechnicalIndicator.md create mode 100644 docs/TripleExponentialAverageTechnicalValue.md create mode 100644 docs/TrueStrengthIndexTechnicalValue.md create mode 100644 docs/UltimateOscillatorTechnicalValue.md create mode 100644 docs/VolumePriceTrendTechnicalValue.md create mode 100644 docs/VolumeWeightedAveragePriceValue.md create mode 100644 docs/VortexIndicatorTechnicalValue.md create mode 100644 docs/WilliamsRTechnicalValue.md create mode 100644 docs/ZacksAnalystRating.md create mode 100644 docs/ZacksAnalystRatingSnapshot.md create mode 100644 docs/ZacksAnalystRatingSummary.md create mode 100644 docs/ZacksApi.md create mode 100644 docs/ZacksEPSEstimate.md create mode 100644 docs/ZacksEPSGrowthRate.md create mode 100644 docs/ZacksEPSSurprise.md create mode 100644 docs/ZacksEPSSurpriseSummary.md create mode 100644 docs/ZacksETFHolding.md create mode 100644 docs/ZacksInstitutionalHolding.md create mode 100644 docs/ZacksInstitutionalHoldingCompanyDetail.md create mode 100644 docs/ZacksInstitutionalHoldingCompanySummary.md create mode 100644 docs/ZacksInstitutionalHoldingHistoricalSummary.md create mode 100644 docs/ZacksInstitutionalHoldingOwnerDetail.md create mode 100644 docs/ZacksInstitutionalHoldingOwnerSummary.md create mode 100644 docs/ZacksLongTermGrowthRate.md create mode 100644 docs/ZacksSalesSurprise.md create mode 100644 docs/ZacksSalesSurpriseSummary.md create mode 100644 docs/ZacksTargetPriceConsensus.md diff --git a/docs/AccumulationDistributionIndexTechnicalValue.md b/docs/AccumulationDistributionIndexTechnicalValue.md new file mode 100644 index 0000000..d47b6ae --- /dev/null +++ b/docs/AccumulationDistributionIndexTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:AccumulationDistributionIndexTechnicalValue) + +[//]: # (KIND:object) + +### AccumulationDistributionIndexTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**adi** | Float | The Accumulation/Distribution Index calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/ApiResponseBulkDownloadLinks.md b/docs/ApiResponseBulkDownloadLinks.md new file mode 100644 index 0000000..dc87117 --- /dev/null +++ b/docs/ApiResponseBulkDownloadLinks.md @@ -0,0 +1,24 @@ + +[//]: # (CLASS:ApiResponseBulkDownloadLinks) + +[//]: # (KIND:object) + +### ApiResponseBulkDownloadLinks + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**bulkDownloads** | [**List<BulkDownloadSummary>**](BulkDownloadSummary.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BulkDownloadSummary) + + + + + diff --git a/docs/ApiResponseCompanies.md b/docs/ApiResponseCompanies.md new file mode 100644 index 0000000..ca011a7 --- /dev/null +++ b/docs/ApiResponseCompanies.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseCompanies) + +[//]: # (KIND:object) + +### ApiResponseCompanies + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**companies** | [**List<CompanySummary>**](CompanySummary.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:CompanySummary) + + + + + diff --git a/docs/ApiResponseCompaniesSearch.md b/docs/ApiResponseCompaniesSearch.md new file mode 100644 index 0000000..8924309 --- /dev/null +++ b/docs/ApiResponseCompaniesSearch.md @@ -0,0 +1,24 @@ + +[//]: # (CLASS:ApiResponseCompaniesSearch) + +[//]: # (KIND:object) + +### ApiResponseCompaniesSearch + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**companies** | [**List<CompanySummary>**](CompanySummary.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:CompanySummary) + + + + + diff --git a/docs/ApiResponseCompanyFilings.md b/docs/ApiResponseCompanyFilings.md new file mode 100644 index 0000000..7677b7b --- /dev/null +++ b/docs/ApiResponseCompanyFilings.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseCompanyFilings) + +[//]: # (KIND:object) + +### ApiResponseCompanyFilings + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**filings** | [**List<FilingSummary>**](FilingSummary.md) |   +**company** | [**CompanySummary**](CompanySummary.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:FilingSummary) + + +[//]: # (CONTAINED_CLASS:CompanySummary) + + + + + diff --git a/docs/ApiResponseCompanyFundamentals.md b/docs/ApiResponseCompanyFundamentals.md new file mode 100644 index 0000000..34ab3bc --- /dev/null +++ b/docs/ApiResponseCompanyFundamentals.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseCompanyFundamentals) + +[//]: # (KIND:object) + +### ApiResponseCompanyFundamentals + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**fundamentals** | [**List<FundamentalSummary>**](FundamentalSummary.md) |   +**company** | [**CompanySummary**](CompanySummary.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:FundamentalSummary) + + +[//]: # (CONTAINED_CLASS:CompanySummary) + + + + + diff --git a/docs/ApiResponseCompanyHistoricalData.md b/docs/ApiResponseCompanyHistoricalData.md new file mode 100644 index 0000000..0cfdacb --- /dev/null +++ b/docs/ApiResponseCompanyHistoricalData.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseCompanyHistoricalData) + +[//]: # (KIND:object) + +### ApiResponseCompanyHistoricalData + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**historicalData** | [**List<HistoricalData>**](HistoricalData.md) |   +**company** | [**CompanySummary**](CompanySummary.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:HistoricalData) + + +[//]: # (CONTAINED_CLASS:CompanySummary) + + + + + diff --git a/docs/ApiResponseCompanyNews.md b/docs/ApiResponseCompanyNews.md new file mode 100644 index 0000000..c70c791 --- /dev/null +++ b/docs/ApiResponseCompanyNews.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseCompanyNews) + +[//]: # (KIND:object) + +### ApiResponseCompanyNews + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**news** | [**List<CompanyNewsSummary>**](CompanyNewsSummary.md) |   +**company** | [**CompanySummary**](CompanySummary.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:CompanyNewsSummary) + + +[//]: # (CONTAINED_CLASS:CompanySummary) + + + + + diff --git a/docs/ApiResponseCompanySecurities.md b/docs/ApiResponseCompanySecurities.md new file mode 100644 index 0000000..a684222 --- /dev/null +++ b/docs/ApiResponseCompanySecurities.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseCompanySecurities) + +[//]: # (KIND:object) + +### ApiResponseCompanySecurities + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**securities** | [**List<SecuritySummary>**](SecuritySummary.md) |   +**company** | [**CompanySummary**](CompanySummary.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + +[//]: # (CONTAINED_CLASS:CompanySummary) + + + + + diff --git a/docs/ApiResponseDataTags.md b/docs/ApiResponseDataTags.md new file mode 100644 index 0000000..02cd45d --- /dev/null +++ b/docs/ApiResponseDataTags.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseDataTags) + +[//]: # (KIND:object) + +### ApiResponseDataTags + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**tags** | [**List<DataTag>**](DataTag.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:DataTag) + + + + + diff --git a/docs/ApiResponseDataTagsSearch.md b/docs/ApiResponseDataTagsSearch.md new file mode 100644 index 0000000..18ad986 --- /dev/null +++ b/docs/ApiResponseDataTagsSearch.md @@ -0,0 +1,24 @@ + +[//]: # (CLASS:ApiResponseDataTagsSearch) + +[//]: # (KIND:object) + +### ApiResponseDataTagsSearch + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**tags** | [**List<DataTag>**](DataTag.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:DataTag) + + + + + diff --git a/docs/ApiResponseEconomicIndexHistoricalData.md b/docs/ApiResponseEconomicIndexHistoricalData.md new file mode 100644 index 0000000..c3f0ac9 --- /dev/null +++ b/docs/ApiResponseEconomicIndexHistoricalData.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseEconomicIndexHistoricalData) + +[//]: # (KIND:object) + +### ApiResponseEconomicIndexHistoricalData + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**historicalData** | [**List<HistoricalData>**](HistoricalData.md) |   +**index** | [**EconomicIndexSummary**](EconomicIndexSummary.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:HistoricalData) + + +[//]: # (CONTAINED_CLASS:EconomicIndexSummary) + + + + + diff --git a/docs/ApiResponseEconomicIndices.md b/docs/ApiResponseEconomicIndices.md new file mode 100644 index 0000000..bfa0f31 --- /dev/null +++ b/docs/ApiResponseEconomicIndices.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseEconomicIndices) + +[//]: # (KIND:object) + +### ApiResponseEconomicIndices + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**indices** | [**List<EconomicIndexSummary>**](EconomicIndexSummary.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:EconomicIndexSummary) + + + + + diff --git a/docs/ApiResponseEconomicIndicesSearch.md b/docs/ApiResponseEconomicIndicesSearch.md new file mode 100644 index 0000000..c3730d0 --- /dev/null +++ b/docs/ApiResponseEconomicIndicesSearch.md @@ -0,0 +1,24 @@ + +[//]: # (CLASS:ApiResponseEconomicIndicesSearch) + +[//]: # (KIND:object) + +### ApiResponseEconomicIndicesSearch + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**indices** | [**List<EconomicIndexSummary>**](EconomicIndexSummary.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:EconomicIndexSummary) + + + + + diff --git a/docs/ApiResponseFilingFundamentals.md b/docs/ApiResponseFilingFundamentals.md new file mode 100644 index 0000000..01a6e79 --- /dev/null +++ b/docs/ApiResponseFilingFundamentals.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseFilingFundamentals) + +[//]: # (KIND:object) + +### ApiResponseFilingFundamentals + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**fundamentals** | [**List<FundamentalSummary>**](FundamentalSummary.md) |   +**filing** | [**FilingSummary**](FilingSummary.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:FundamentalSummary) + + +[//]: # (CONTAINED_CLASS:FilingSummary) + + + + + diff --git a/docs/ApiResponseFilingNotes.md b/docs/ApiResponseFilingNotes.md new file mode 100644 index 0000000..c5496db --- /dev/null +++ b/docs/ApiResponseFilingNotes.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseFilingNotes) + +[//]: # (KIND:object) + +### ApiResponseFilingNotes + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**filingNotes** | [**List<FilingNoteSummary>**](FilingNoteSummary.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:FilingNoteSummary) + + + + + diff --git a/docs/ApiResponseFilingNotesSearch.md b/docs/ApiResponseFilingNotesSearch.md new file mode 100644 index 0000000..49dbe80 --- /dev/null +++ b/docs/ApiResponseFilingNotesSearch.md @@ -0,0 +1,24 @@ + +[//]: # (CLASS:ApiResponseFilingNotesSearch) + +[//]: # (KIND:object) + +### ApiResponseFilingNotesSearch + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**filingNotes** | [**List<FilingNoteSummary>**](FilingNoteSummary.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:FilingNoteSummary) + + + + + diff --git a/docs/ApiResponseFilings.md b/docs/ApiResponseFilings.md new file mode 100644 index 0000000..ce3907e --- /dev/null +++ b/docs/ApiResponseFilings.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseFilings) + +[//]: # (KIND:object) + +### ApiResponseFilings + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**filings** | [**List<Filing>**](Filing.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:Filing) + + + + + diff --git a/docs/ApiResponseForexCurrencies.md b/docs/ApiResponseForexCurrencies.md new file mode 100644 index 0000000..4382b8f --- /dev/null +++ b/docs/ApiResponseForexCurrencies.md @@ -0,0 +1,24 @@ + +[//]: # (CLASS:ApiResponseForexCurrencies) + +[//]: # (KIND:object) + +### ApiResponseForexCurrencies + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**currencies** | [**List<ForexCurrency>**](ForexCurrency.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ForexCurrency) + + + + + diff --git a/docs/ApiResponseForexPairs.md b/docs/ApiResponseForexPairs.md new file mode 100644 index 0000000..d7e7fb0 --- /dev/null +++ b/docs/ApiResponseForexPairs.md @@ -0,0 +1,24 @@ + +[//]: # (CLASS:ApiResponseForexPairs) + +[//]: # (KIND:object) + +### ApiResponseForexPairs + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**pairs** | [**List<ForexPair>**](ForexPair.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ForexPair) + + + + + diff --git a/docs/ApiResponseForexPrices.md b/docs/ApiResponseForexPrices.md new file mode 100644 index 0000000..64dbdc8 --- /dev/null +++ b/docs/ApiResponseForexPrices.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseForexPrices) + +[//]: # (KIND:object) + +### ApiResponseForexPrices + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**prices** | [**List<ForexPrice>**](ForexPrice.md) |   +**pair** | [**ForexPair**](ForexPair.md) | The Forex currency pair for which prices were requested   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ForexPrice) + + +[//]: # (CONTAINED_CLASS:ForexPair) + + + + + diff --git a/docs/ApiResponseHistoricalData.md b/docs/ApiResponseHistoricalData.md new file mode 100644 index 0000000..4017d87 --- /dev/null +++ b/docs/ApiResponseHistoricalData.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseHistoricalData) + +[//]: # (KIND:object) + +### ApiResponseHistoricalData + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**historicalData** | [**List<HistoricalData>**](HistoricalData.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:HistoricalData) + + + + + diff --git a/docs/ApiResponseInitialPublicOfferings.md b/docs/ApiResponseInitialPublicOfferings.md new file mode 100644 index 0000000..7d1898c --- /dev/null +++ b/docs/ApiResponseInitialPublicOfferings.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseInitialPublicOfferings) + +[//]: # (KIND:object) + +### ApiResponseInitialPublicOfferings + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**initialPublicOfferings** | [**List<CompanyInitialPublicOffering>**](CompanyInitialPublicOffering.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:CompanyInitialPublicOffering) + + + + + diff --git a/docs/ApiResponseMunicipalities.md b/docs/ApiResponseMunicipalities.md new file mode 100644 index 0000000..31d7215 --- /dev/null +++ b/docs/ApiResponseMunicipalities.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseMunicipalities) + +[//]: # (KIND:object) + +### ApiResponseMunicipalities + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**municipalities** | [**List<Municipality>**](Municipality.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:Municipality) + + + + + diff --git a/docs/ApiResponseMunicipalitiyFinancials.md b/docs/ApiResponseMunicipalitiyFinancials.md new file mode 100644 index 0000000..8313c67 --- /dev/null +++ b/docs/ApiResponseMunicipalitiyFinancials.md @@ -0,0 +1,28 @@ + +[//]: # (CLASS:ApiResponseMunicipalitiyFinancials) + +[//]: # (KIND:object) + +### ApiResponseMunicipalitiyFinancials + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**financials** | [**List<MunicipalityFinancial>**](MunicipalityFinancial.md) |   +**municipality** | [**Municipality**](Municipality.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:MunicipalityFinancial) + + +[//]: # (CONTAINED_CLASS:Municipality) + + + + + diff --git a/docs/ApiResponseNews.md b/docs/ApiResponseNews.md new file mode 100644 index 0000000..1cde1f3 --- /dev/null +++ b/docs/ApiResponseNews.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseNews) + +[//]: # (KIND:object) + +### ApiResponseNews + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**news** | [**List<CompanyNews>**](CompanyNews.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:CompanyNews) + + + + + diff --git a/docs/ApiResponseOptionPrices.md b/docs/ApiResponseOptionPrices.md new file mode 100644 index 0000000..e40fb8f --- /dev/null +++ b/docs/ApiResponseOptionPrices.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseOptionPrices) + +[//]: # (KIND:object) + +### ApiResponseOptionPrices + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**prices** | [**List<OptionPrice>**](OptionPrice.md) | A list of option prices in descending order by date   +**option** | [**Option**](Option.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OptionPrice) + + +[//]: # (CONTAINED_CLASS:Option) + + + + + diff --git a/docs/ApiResponseOptions.md b/docs/ApiResponseOptions.md new file mode 100644 index 0000000..b56162b --- /dev/null +++ b/docs/ApiResponseOptions.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseOptions) + +[//]: # (KIND:object) + +### ApiResponseOptions + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**options** | [**List<Option>**](Option.md) | A list of options contracts with the given symbol   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:Option) + + + + + diff --git a/docs/ApiResponseOptionsChain.md b/docs/ApiResponseOptionsChain.md new file mode 100644 index 0000000..f0a54f8 --- /dev/null +++ b/docs/ApiResponseOptionsChain.md @@ -0,0 +1,24 @@ + +[//]: # (CLASS:ApiResponseOptionsChain) + +[//]: # (KIND:object) + +### ApiResponseOptionsChain + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**chain** | [**List<OptionChain>**](OptionChain.md) | A list of options for the provided expiration date their respective option prices.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OptionChain) + + + + + diff --git a/docs/ApiResponseOptionsExpirations.md b/docs/ApiResponseOptionsExpirations.md new file mode 100644 index 0000000..35e742c --- /dev/null +++ b/docs/ApiResponseOptionsExpirations.md @@ -0,0 +1,21 @@ + +[//]: # (CLASS:ApiResponseOptionsExpirations) + +[//]: # (KIND:object) + +### ApiResponseOptionsExpirations + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**expirations** | List<String> | A list of option expiration dates in descending order   + +[//]: # (END_DEFINITION) + + + + + diff --git a/docs/ApiResponseReportedFinancials.md b/docs/ApiResponseReportedFinancials.md new file mode 100644 index 0000000..884d70a --- /dev/null +++ b/docs/ApiResponseReportedFinancials.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseReportedFinancials) + +[//]: # (KIND:object) + +### ApiResponseReportedFinancials + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**reportedFinancials** | [**List<ReportedFinancial>**](ReportedFinancial.md) |   +**fundamental** | [**Fundamental**](Fundamental.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ReportedFinancial) + + +[//]: # (CONTAINED_CLASS:Fundamental) + + + + + diff --git a/docs/ApiResponseSICIndexHistoricalData.md b/docs/ApiResponseSICIndexHistoricalData.md new file mode 100644 index 0000000..9d964c3 --- /dev/null +++ b/docs/ApiResponseSICIndexHistoricalData.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseSICIndexHistoricalData) + +[//]: # (KIND:object) + +### ApiResponseSICIndexHistoricalData + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**historicalData** | [**List<HistoricalData>**](HistoricalData.md) |   +**index** | [**SICIndex**](SICIndex.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:HistoricalData) + + +[//]: # (CONTAINED_CLASS:SICIndex) + + + + + diff --git a/docs/ApiResponseSICIndices.md b/docs/ApiResponseSICIndices.md new file mode 100644 index 0000000..6b8390a --- /dev/null +++ b/docs/ApiResponseSICIndices.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseSICIndices) + +[//]: # (KIND:object) + +### ApiResponseSICIndices + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**indices** | [**List<SICIndex>**](SICIndex.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:SICIndex) + + + + + diff --git a/docs/ApiResponseSICIndicesSearch.md b/docs/ApiResponseSICIndicesSearch.md new file mode 100644 index 0000000..b5d30b5 --- /dev/null +++ b/docs/ApiResponseSICIndicesSearch.md @@ -0,0 +1,24 @@ + +[//]: # (CLASS:ApiResponseSICIndicesSearch) + +[//]: # (KIND:object) + +### ApiResponseSICIndicesSearch + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**indices** | [**List<SICIndex>**](SICIndex.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:SICIndex) + + + + + diff --git a/docs/ApiResponseSecurities.md b/docs/ApiResponseSecurities.md new file mode 100644 index 0000000..8604c59 --- /dev/null +++ b/docs/ApiResponseSecurities.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseSecurities) + +[//]: # (KIND:object) + +### ApiResponseSecurities + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**securities** | [**List<SecuritySummary>**](SecuritySummary.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecuritiesSearch.md b/docs/ApiResponseSecuritiesSearch.md new file mode 100644 index 0000000..085b66a --- /dev/null +++ b/docs/ApiResponseSecuritiesSearch.md @@ -0,0 +1,24 @@ + +[//]: # (CLASS:ApiResponseSecuritiesSearch) + +[//]: # (KIND:object) + +### ApiResponseSecuritiesSearch + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**securities** | [**List<SecuritySummary>**](SecuritySummary.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityAccumulationDistributionIndex.md b/docs/ApiResponseSecurityAccumulationDistributionIndex.md new file mode 100644 index 0000000..c4dd99f --- /dev/null +++ b/docs/ApiResponseSecurityAccumulationDistributionIndex.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityAccumulationDistributionIndex) + +[//]: # (KIND:object) + +### ApiResponseSecurityAccumulationDistributionIndex + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<AccumulationDistributionIndexTechnicalValue>**](AccumulationDistributionIndexTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:AccumulationDistributionIndexTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityAverageDailyTradingVolume.md b/docs/ApiResponseSecurityAverageDailyTradingVolume.md new file mode 100644 index 0000000..1d87595 --- /dev/null +++ b/docs/ApiResponseSecurityAverageDailyTradingVolume.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityAverageDailyTradingVolume) + +[//]: # (KIND:object) + +### ApiResponseSecurityAverageDailyTradingVolume + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<AverageDailyTradingVolumeTechnicalValue>**](AverageDailyTradingVolumeTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:AverageDailyTradingVolumeTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityAverageDirectionalIndex.md b/docs/ApiResponseSecurityAverageDirectionalIndex.md new file mode 100644 index 0000000..9d17575 --- /dev/null +++ b/docs/ApiResponseSecurityAverageDirectionalIndex.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityAverageDirectionalIndex) + +[//]: # (KIND:object) + +### ApiResponseSecurityAverageDirectionalIndex + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<AverageDirectionalIndexTechnicalValue>**](AverageDirectionalIndexTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:AverageDirectionalIndexTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityAverageTrueRange.md b/docs/ApiResponseSecurityAverageTrueRange.md new file mode 100644 index 0000000..4330ae9 --- /dev/null +++ b/docs/ApiResponseSecurityAverageTrueRange.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityAverageTrueRange) + +[//]: # (KIND:object) + +### ApiResponseSecurityAverageTrueRange + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<AverageTrueRangeTechnicalValue>**](AverageTrueRangeTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:AverageTrueRangeTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityAwesomeOscillator.md b/docs/ApiResponseSecurityAwesomeOscillator.md new file mode 100644 index 0000000..6346b28 --- /dev/null +++ b/docs/ApiResponseSecurityAwesomeOscillator.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityAwesomeOscillator) + +[//]: # (KIND:object) + +### ApiResponseSecurityAwesomeOscillator + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<AwesomeOscillatorTechnicalValue>**](AwesomeOscillatorTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:AwesomeOscillatorTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityBollingerBands.md b/docs/ApiResponseSecurityBollingerBands.md new file mode 100644 index 0000000..1169220 --- /dev/null +++ b/docs/ApiResponseSecurityBollingerBands.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityBollingerBands) + +[//]: # (KIND:object) + +### ApiResponseSecurityBollingerBands + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<BollingerBandsTechnicalValue>**](BollingerBandsTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BollingerBandsTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityChaikinMoneyFlow.md b/docs/ApiResponseSecurityChaikinMoneyFlow.md new file mode 100644 index 0000000..08abcaa --- /dev/null +++ b/docs/ApiResponseSecurityChaikinMoneyFlow.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityChaikinMoneyFlow) + +[//]: # (KIND:object) + +### ApiResponseSecurityChaikinMoneyFlow + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<ChaikinMoneyFlowTechnicalValue>**](ChaikinMoneyFlowTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ChaikinMoneyFlowTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityCommodityChannelIndex.md b/docs/ApiResponseSecurityCommodityChannelIndex.md new file mode 100644 index 0000000..91103dc --- /dev/null +++ b/docs/ApiResponseSecurityCommodityChannelIndex.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityCommodityChannelIndex) + +[//]: # (KIND:object) + +### ApiResponseSecurityCommodityChannelIndex + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<CommodityChannelIndexTechnicalValue>**](CommodityChannelIndexTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:CommodityChannelIndexTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityDetrendedPriceOscillator.md b/docs/ApiResponseSecurityDetrendedPriceOscillator.md new file mode 100644 index 0000000..a6d0cdc --- /dev/null +++ b/docs/ApiResponseSecurityDetrendedPriceOscillator.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityDetrendedPriceOscillator) + +[//]: # (KIND:object) + +### ApiResponseSecurityDetrendedPriceOscillator + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<DetrendedPriceOscillatorTechnicalValue>**](DetrendedPriceOscillatorTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:DetrendedPriceOscillatorTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityDonchianChannel.md b/docs/ApiResponseSecurityDonchianChannel.md new file mode 100644 index 0000000..725b70b --- /dev/null +++ b/docs/ApiResponseSecurityDonchianChannel.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityDonchianChannel) + +[//]: # (KIND:object) + +### ApiResponseSecurityDonchianChannel + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<DonchianChannelTechnicalValue>**](DonchianChannelTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:DonchianChannelTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityEaseOfMovement.md b/docs/ApiResponseSecurityEaseOfMovement.md new file mode 100644 index 0000000..f142027 --- /dev/null +++ b/docs/ApiResponseSecurityEaseOfMovement.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityEaseOfMovement) + +[//]: # (KIND:object) + +### ApiResponseSecurityEaseOfMovement + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<EaseOfMovementTechnicalValue>**](EaseOfMovementTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:EaseOfMovementTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityForceIndex.md b/docs/ApiResponseSecurityForceIndex.md new file mode 100644 index 0000000..a3f57d9 --- /dev/null +++ b/docs/ApiResponseSecurityForceIndex.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityForceIndex) + +[//]: # (KIND:object) + +### ApiResponseSecurityForceIndex + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<ForceIndexTechnicalValue>**](ForceIndexTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ForceIndexTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityHistoricalData.md b/docs/ApiResponseSecurityHistoricalData.md new file mode 100644 index 0000000..8d30a9b --- /dev/null +++ b/docs/ApiResponseSecurityHistoricalData.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseSecurityHistoricalData) + +[//]: # (KIND:object) + +### ApiResponseSecurityHistoricalData + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**historicalData** | [**List<HistoricalData>**](HistoricalData.md) |   +**security** | [**SecuritySummary**](SecuritySummary.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:HistoricalData) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityIchimokuKinkoHyo.md b/docs/ApiResponseSecurityIchimokuKinkoHyo.md new file mode 100644 index 0000000..f32053e --- /dev/null +++ b/docs/ApiResponseSecurityIchimokuKinkoHyo.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityIchimokuKinkoHyo) + +[//]: # (KIND:object) + +### ApiResponseSecurityIchimokuKinkoHyo + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<IchimokuKinkoHyoTechnicalValue>**](IchimokuKinkoHyoTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:IchimokuKinkoHyoTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityIntradayPrices.md b/docs/ApiResponseSecurityIntradayPrices.md new file mode 100644 index 0000000..908c3cf --- /dev/null +++ b/docs/ApiResponseSecurityIntradayPrices.md @@ -0,0 +1,39 @@ + +[//]: # (CLASS:ApiResponseSecurityIntradayPrices) + +[//]: # (KIND:object) + +### ApiResponseSecurityIntradayPrices + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**intradayPrices** | [**List<IntradayStockPrice>**](IntradayStockPrice.md) | The intraday stock prices for the Security   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   +**source** | SourceEnum | The source of the data   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:IntradayStockPrice) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + +
+ +#### Enum: SourceEnum + +Name | Value +---- | ----- +IEX | "iex" +BATS | "bats" + + + diff --git a/docs/ApiResponseSecurityKeltnerChannel.md b/docs/ApiResponseSecurityKeltnerChannel.md new file mode 100644 index 0000000..050ff1e --- /dev/null +++ b/docs/ApiResponseSecurityKeltnerChannel.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityKeltnerChannel) + +[//]: # (KIND:object) + +### ApiResponseSecurityKeltnerChannel + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<KeltnerChannelTechnicalValue>**](KeltnerChannelTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:KeltnerChannelTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityKnowSureThing.md b/docs/ApiResponseSecurityKnowSureThing.md new file mode 100644 index 0000000..180f91f --- /dev/null +++ b/docs/ApiResponseSecurityKnowSureThing.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityKnowSureThing) + +[//]: # (KIND:object) + +### ApiResponseSecurityKnowSureThing + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<KnowSureThingTechnicalValue>**](KnowSureThingTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:KnowSureThingTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityMassIndex.md b/docs/ApiResponseSecurityMassIndex.md new file mode 100644 index 0000000..94fdddb --- /dev/null +++ b/docs/ApiResponseSecurityMassIndex.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityMassIndex) + +[//]: # (KIND:object) + +### ApiResponseSecurityMassIndex + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<MassIndexTechnicalValue>**](MassIndexTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:MassIndexTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityMoneyFlowIndex.md b/docs/ApiResponseSecurityMoneyFlowIndex.md new file mode 100644 index 0000000..d4f7e36 --- /dev/null +++ b/docs/ApiResponseSecurityMoneyFlowIndex.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityMoneyFlowIndex) + +[//]: # (KIND:object) + +### ApiResponseSecurityMoneyFlowIndex + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<MoneyFlowIndexTechnicalValue>**](MoneyFlowIndexTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:MoneyFlowIndexTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityMovingAverageConvergenceDivergence.md b/docs/ApiResponseSecurityMovingAverageConvergenceDivergence.md new file mode 100644 index 0000000..450c7b2 --- /dev/null +++ b/docs/ApiResponseSecurityMovingAverageConvergenceDivergence.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityMovingAverageConvergenceDivergence) + +[//]: # (KIND:object) + +### ApiResponseSecurityMovingAverageConvergenceDivergence + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<MovingAverageConvergenceDivergenceTechnicalValue>**](MovingAverageConvergenceDivergenceTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:MovingAverageConvergenceDivergenceTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityNegativeVolumeIndex.md b/docs/ApiResponseSecurityNegativeVolumeIndex.md new file mode 100644 index 0000000..2ab5ad6 --- /dev/null +++ b/docs/ApiResponseSecurityNegativeVolumeIndex.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityNegativeVolumeIndex) + +[//]: # (KIND:object) + +### ApiResponseSecurityNegativeVolumeIndex + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<NegativeVolumeIndexTechnicalValue>**](NegativeVolumeIndexTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:NegativeVolumeIndexTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityOnBalanceVolume.md b/docs/ApiResponseSecurityOnBalanceVolume.md new file mode 100644 index 0000000..23d11f9 --- /dev/null +++ b/docs/ApiResponseSecurityOnBalanceVolume.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityOnBalanceVolume) + +[//]: # (KIND:object) + +### ApiResponseSecurityOnBalanceVolume + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<OnBalanceVolumeTechnicalValue>**](OnBalanceVolumeTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OnBalanceVolumeTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityOnBalanceVolumeMean.md b/docs/ApiResponseSecurityOnBalanceVolumeMean.md new file mode 100644 index 0000000..b2f4eb8 --- /dev/null +++ b/docs/ApiResponseSecurityOnBalanceVolumeMean.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityOnBalanceVolumeMean) + +[//]: # (KIND:object) + +### ApiResponseSecurityOnBalanceVolumeMean + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<OnBalanceVolumeMeanTechnicalValue>**](OnBalanceVolumeMeanTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OnBalanceVolumeMeanTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityRelativeStrengthIndex.md b/docs/ApiResponseSecurityRelativeStrengthIndex.md new file mode 100644 index 0000000..8aaac56 --- /dev/null +++ b/docs/ApiResponseSecurityRelativeStrengthIndex.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityRelativeStrengthIndex) + +[//]: # (KIND:object) + +### ApiResponseSecurityRelativeStrengthIndex + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<RelativeStrengthIndexTechnicalValue>**](RelativeStrengthIndexTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:RelativeStrengthIndexTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecuritySimpleMovingAverage.md b/docs/ApiResponseSecuritySimpleMovingAverage.md new file mode 100644 index 0000000..120c06a --- /dev/null +++ b/docs/ApiResponseSecuritySimpleMovingAverage.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecuritySimpleMovingAverage) + +[//]: # (KIND:object) + +### ApiResponseSecuritySimpleMovingAverage + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<SimpleMovingAverageTechnicalValue>**](SimpleMovingAverageTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:SimpleMovingAverageTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityStochasticOscillator.md b/docs/ApiResponseSecurityStochasticOscillator.md new file mode 100644 index 0000000..8a2a851 --- /dev/null +++ b/docs/ApiResponseSecurityStochasticOscillator.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityStochasticOscillator) + +[//]: # (KIND:object) + +### ApiResponseSecurityStochasticOscillator + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<StochasticOscillatorTechnicalValue>**](StochasticOscillatorTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:StochasticOscillatorTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityStockPriceAdjustments.md b/docs/ApiResponseSecurityStockPriceAdjustments.md new file mode 100644 index 0000000..d943cb6 --- /dev/null +++ b/docs/ApiResponseSecurityStockPriceAdjustments.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseSecurityStockPriceAdjustments) + +[//]: # (KIND:object) + +### ApiResponseSecurityStockPriceAdjustments + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**stockPriceAdjustments** | [**List<StockPriceAdjustmentSummary>**](StockPriceAdjustmentSummary.md) | The stock price adjustments for the Security   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:StockPriceAdjustmentSummary) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityStockPrices.md b/docs/ApiResponseSecurityStockPrices.md new file mode 100644 index 0000000..c65cb76 --- /dev/null +++ b/docs/ApiResponseSecurityStockPrices.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseSecurityStockPrices) + +[//]: # (KIND:object) + +### ApiResponseSecurityStockPrices + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**stockPrices** | [**List<StockPriceSummary>**](StockPriceSummary.md) | The stock prices for the Security   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:StockPriceSummary) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityTripleExponentialAverage.md b/docs/ApiResponseSecurityTripleExponentialAverage.md new file mode 100644 index 0000000..1857250 --- /dev/null +++ b/docs/ApiResponseSecurityTripleExponentialAverage.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityTripleExponentialAverage) + +[//]: # (KIND:object) + +### ApiResponseSecurityTripleExponentialAverage + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<TripleExponentialAverageTechnicalValue>**](TripleExponentialAverageTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:TripleExponentialAverageTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityTrueStrengthIndex.md b/docs/ApiResponseSecurityTrueStrengthIndex.md new file mode 100644 index 0000000..b8d46e9 --- /dev/null +++ b/docs/ApiResponseSecurityTrueStrengthIndex.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityTrueStrengthIndex) + +[//]: # (KIND:object) + +### ApiResponseSecurityTrueStrengthIndex + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<TrueStrengthIndexTechnicalValue>**](TrueStrengthIndexTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:TrueStrengthIndexTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityUltimateOscillator.md b/docs/ApiResponseSecurityUltimateOscillator.md new file mode 100644 index 0000000..fcb6c53 --- /dev/null +++ b/docs/ApiResponseSecurityUltimateOscillator.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityUltimateOscillator) + +[//]: # (KIND:object) + +### ApiResponseSecurityUltimateOscillator + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<UltimateOscillatorTechnicalValue>**](UltimateOscillatorTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:UltimateOscillatorTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityVolumePriceTrend.md b/docs/ApiResponseSecurityVolumePriceTrend.md new file mode 100644 index 0000000..839417e --- /dev/null +++ b/docs/ApiResponseSecurityVolumePriceTrend.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityVolumePriceTrend) + +[//]: # (KIND:object) + +### ApiResponseSecurityVolumePriceTrend + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<VolumePriceTrendTechnicalValue>**](VolumePriceTrendTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:VolumePriceTrendTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityVolumeWeightedAveragePrice.md b/docs/ApiResponseSecurityVolumeWeightedAveragePrice.md new file mode 100644 index 0000000..3e2e594 --- /dev/null +++ b/docs/ApiResponseSecurityVolumeWeightedAveragePrice.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityVolumeWeightedAveragePrice) + +[//]: # (KIND:object) + +### ApiResponseSecurityVolumeWeightedAveragePrice + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<VolumeWeightedAveragePriceValue>**](VolumeWeightedAveragePriceValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:VolumeWeightedAveragePriceValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityVortexIndicator.md b/docs/ApiResponseSecurityVortexIndicator.md new file mode 100644 index 0000000..53f659f --- /dev/null +++ b/docs/ApiResponseSecurityVortexIndicator.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityVortexIndicator) + +[//]: # (KIND:object) + +### ApiResponseSecurityVortexIndicator + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<VortexIndicatorTechnicalValue>**](VortexIndicatorTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:VortexIndicatorTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityWilliamsR.md b/docs/ApiResponseSecurityWilliamsR.md new file mode 100644 index 0000000..4482ba9 --- /dev/null +++ b/docs/ApiResponseSecurityWilliamsR.md @@ -0,0 +1,33 @@ + +[//]: # (CLASS:ApiResponseSecurityWilliamsR) + +[//]: # (KIND:object) + +### ApiResponseSecurityWilliamsR + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**technicals** | [**List<WilliamsRTechnicalValue>**](WilliamsRTechnicalValue.md) |   +**indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:WilliamsRTechnicalValue) + + +[//]: # (CONTAINED_CLASS:TechnicalIndicator) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityZacksAnalystRatings.md b/docs/ApiResponseSecurityZacksAnalystRatings.md new file mode 100644 index 0000000..5d16735 --- /dev/null +++ b/docs/ApiResponseSecurityZacksAnalystRatings.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseSecurityZacksAnalystRatings) + +[//]: # (KIND:object) + +### ApiResponseSecurityZacksAnalystRatings + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**analystRatings** | [**List<ZacksAnalystRatingSummary>**](ZacksAnalystRatingSummary.md) |   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ZacksAnalystRatingSummary) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityZacksAnalystRatingsSnapshot.md b/docs/ApiResponseSecurityZacksAnalystRatingsSnapshot.md new file mode 100644 index 0000000..877a005 --- /dev/null +++ b/docs/ApiResponseSecurityZacksAnalystRatingsSnapshot.md @@ -0,0 +1,28 @@ + +[//]: # (CLASS:ApiResponseSecurityZacksAnalystRatingsSnapshot) + +[//]: # (KIND:object) + +### ApiResponseSecurityZacksAnalystRatingsSnapshot + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**snapshots** | [**List<ZacksAnalystRatingSnapshot>**](ZacksAnalystRatingSnapshot.md) |   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ZacksAnalystRatingSnapshot) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityZacksEPSSurprises.md b/docs/ApiResponseSecurityZacksEPSSurprises.md new file mode 100644 index 0000000..8fe12a3 --- /dev/null +++ b/docs/ApiResponseSecurityZacksEPSSurprises.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseSecurityZacksEPSSurprises) + +[//]: # (KIND:object) + +### ApiResponseSecurityZacksEPSSurprises + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**epsSurprises** | [**List<ZacksEPSSurpriseSummary>**](ZacksEPSSurpriseSummary.md) |   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ZacksEPSSurpriseSummary) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseSecurityZacksSalesSurprises.md b/docs/ApiResponseSecurityZacksSalesSurprises.md new file mode 100644 index 0000000..7a5c965 --- /dev/null +++ b/docs/ApiResponseSecurityZacksSalesSurprises.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseSecurityZacksSalesSurprises) + +[//]: # (KIND:object) + +### ApiResponseSecurityZacksSalesSurprises + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**salesSurprises** | [**List<ZacksSalesSurpriseSummary>**](ZacksSalesSurpriseSummary.md) |   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ZacksSalesSurpriseSummary) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ApiResponseStandardizedFinancials.md b/docs/ApiResponseStandardizedFinancials.md new file mode 100644 index 0000000..db28de4 --- /dev/null +++ b/docs/ApiResponseStandardizedFinancials.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseStandardizedFinancials) + +[//]: # (KIND:object) + +### ApiResponseStandardizedFinancials + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**standardizedFinancials** | [**List<StandardizedFinancial>**](StandardizedFinancial.md) |   +**fundamental** | [**Fundamental**](Fundamental.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:StandardizedFinancial) + + +[//]: # (CONTAINED_CLASS:Fundamental) + + + + + diff --git a/docs/ApiResponseStockExchangeRealtimeStockPrices.md b/docs/ApiResponseStockExchangeRealtimeStockPrices.md new file mode 100644 index 0000000..b27ec61 --- /dev/null +++ b/docs/ApiResponseStockExchangeRealtimeStockPrices.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseStockExchangeRealtimeStockPrices) + +[//]: # (KIND:object) + +### ApiResponseStockExchangeRealtimeStockPrices + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**stockPrices** | [**List<RealtimeStockPrice>**](RealtimeStockPrice.md) | The realtime stock prices for all Securities traded on the Stock Exchange   +**stockExchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:RealtimeStockPrice) + + +[//]: # (CONTAINED_CLASS:StockExchange) + + + + + diff --git a/docs/ApiResponseStockExchangeSecurities.md b/docs/ApiResponseStockExchangeSecurities.md new file mode 100644 index 0000000..7dea672 --- /dev/null +++ b/docs/ApiResponseStockExchangeSecurities.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseStockExchangeSecurities) + +[//]: # (KIND:object) + +### ApiResponseStockExchangeSecurities + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**securities** | [**List<SecuritySummary>**](SecuritySummary.md) | The securities traded on the Stock Exchange   +**stockExchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + +[//]: # (CONTAINED_CLASS:StockExchange) + + + + + diff --git a/docs/ApiResponseStockExchangeStockPriceAdjustments.md b/docs/ApiResponseStockExchangeStockPriceAdjustments.md new file mode 100644 index 0000000..51fa974 --- /dev/null +++ b/docs/ApiResponseStockExchangeStockPriceAdjustments.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseStockExchangeStockPriceAdjustments) + +[//]: # (KIND:object) + +### ApiResponseStockExchangeStockPriceAdjustments + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**stockPriceAdjustments** | [**List<StockPriceAdjustment>**](StockPriceAdjustment.md) | The stock price adjustments for all Securities traded on the Stock Exchange on the given date   +**stockExchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:StockPriceAdjustment) + + +[//]: # (CONTAINED_CLASS:StockExchange) + + + + + diff --git a/docs/ApiResponseStockExchangeStockPrices.md b/docs/ApiResponseStockExchangeStockPrices.md new file mode 100644 index 0000000..8c8a685 --- /dev/null +++ b/docs/ApiResponseStockExchangeStockPrices.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseStockExchangeStockPrices) + +[//]: # (KIND:object) + +### ApiResponseStockExchangeStockPrices + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**stockPrices** | [**List<StockPrice>**](StockPrice.md) | The stock prices for all Securities traded on the Stock Exchange on the given date   +**stockExchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:StockPrice) + + +[//]: # (CONTAINED_CLASS:StockExchange) + + + + + diff --git a/docs/ApiResponseStockExchanges.md b/docs/ApiResponseStockExchanges.md new file mode 100644 index 0000000..6715314 --- /dev/null +++ b/docs/ApiResponseStockExchanges.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseStockExchanges) + +[//]: # (KIND:object) + +### ApiResponseStockExchanges + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**stockExchanges** | [**List<StockExchange>**](StockExchange.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:StockExchange) + + + + + diff --git a/docs/ApiResponseStockMarketIndexHistoricalData.md b/docs/ApiResponseStockMarketIndexHistoricalData.md new file mode 100644 index 0000000..d49117e --- /dev/null +++ b/docs/ApiResponseStockMarketIndexHistoricalData.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:ApiResponseStockMarketIndexHistoricalData) + +[//]: # (KIND:object) + +### ApiResponseStockMarketIndexHistoricalData + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**historicalData** | [**List<HistoricalData>**](HistoricalData.md) |   +**index** | [**StockMarketIndexSummary**](StockMarketIndexSummary.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:HistoricalData) + + +[//]: # (CONTAINED_CLASS:StockMarketIndexSummary) + + + + + diff --git a/docs/ApiResponseStockMarketIndices.md b/docs/ApiResponseStockMarketIndices.md new file mode 100644 index 0000000..ba8803e --- /dev/null +++ b/docs/ApiResponseStockMarketIndices.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseStockMarketIndices) + +[//]: # (KIND:object) + +### ApiResponseStockMarketIndices + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**indices** | [**List<StockMarketIndexSummary>**](StockMarketIndexSummary.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:StockMarketIndexSummary) + + + + + diff --git a/docs/ApiResponseStockMarketIndicesSearch.md b/docs/ApiResponseStockMarketIndicesSearch.md new file mode 100644 index 0000000..e217ce0 --- /dev/null +++ b/docs/ApiResponseStockMarketIndicesSearch.md @@ -0,0 +1,24 @@ + +[//]: # (CLASS:ApiResponseStockMarketIndicesSearch) + +[//]: # (KIND:object) + +### ApiResponseStockMarketIndicesSearch + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**indices** | [**List<StockMarketIndexSummary>**](StockMarketIndexSummary.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:StockMarketIndexSummary) + + + + + diff --git a/docs/ApiResponseZacksAnalystRatings.md b/docs/ApiResponseZacksAnalystRatings.md new file mode 100644 index 0000000..2408eca --- /dev/null +++ b/docs/ApiResponseZacksAnalystRatings.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseZacksAnalystRatings) + +[//]: # (KIND:object) + +### ApiResponseZacksAnalystRatings + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**analystRatings** | [**List<ZacksAnalystRating>**](ZacksAnalystRating.md) |   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ZacksAnalystRating) + + + + + diff --git a/docs/ApiResponseZacksEPSEstimates.md b/docs/ApiResponseZacksEPSEstimates.md new file mode 100644 index 0000000..5ca4c29 --- /dev/null +++ b/docs/ApiResponseZacksEPSEstimates.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseZacksEPSEstimates) + +[//]: # (KIND:object) + +### ApiResponseZacksEPSEstimates + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**estimates** | [**List<ZacksEPSEstimate>**](ZacksEPSEstimate.md) | Zacks EPS estimate data for a given date range   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ZacksEPSEstimate) + + + + + diff --git a/docs/ApiResponseZacksEPSGrowthRates.md b/docs/ApiResponseZacksEPSGrowthRates.md new file mode 100644 index 0000000..5ac5f94 --- /dev/null +++ b/docs/ApiResponseZacksEPSGrowthRates.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseZacksEPSGrowthRates) + +[//]: # (KIND:object) + +### ApiResponseZacksEPSGrowthRates + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**epsGrowthRates** | [**List<ZacksEPSGrowthRate>**](ZacksEPSGrowthRate.md) | Zacks EPS growth rate for the latest date   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ZacksEPSGrowthRate) + + + + + diff --git a/docs/ApiResponseZacksEPSSurprises.md b/docs/ApiResponseZacksEPSSurprises.md new file mode 100644 index 0000000..20b1b0a --- /dev/null +++ b/docs/ApiResponseZacksEPSSurprises.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseZacksEPSSurprises) + +[//]: # (KIND:object) + +### ApiResponseZacksEPSSurprises + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**epsSurprises** | [**List<ZacksEPSSurprise>**](ZacksEPSSurprise.md) | Zacks EPS Surprise data for a Security in descending order by actual reported date   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ZacksEPSSurprise) + + + + + diff --git a/docs/ApiResponseZacksETFHoldings.md b/docs/ApiResponseZacksETFHoldings.md new file mode 100644 index 0000000..aaa2295 --- /dev/null +++ b/docs/ApiResponseZacksETFHoldings.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseZacksETFHoldings) + +[//]: # (KIND:object) + +### ApiResponseZacksETFHoldings + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**holdings** | [**List<ZacksETFHolding>**](ZacksETFHolding.md) | Zacks ETF holding data   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ZacksETFHolding) + + + + + diff --git a/docs/ApiResponseZacksInstitutionalHoldingCompanies.md b/docs/ApiResponseZacksInstitutionalHoldingCompanies.md new file mode 100644 index 0000000..c02b74b --- /dev/null +++ b/docs/ApiResponseZacksInstitutionalHoldingCompanies.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseZacksInstitutionalHoldingCompanies) + +[//]: # (KIND:object) + +### ApiResponseZacksInstitutionalHoldingCompanies + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**companies** | [**List<ZacksInstitutionalHoldingCompanyDetail>**](ZacksInstitutionalHoldingCompanyDetail.md) | Zacks institutional holding company data   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ZacksInstitutionalHoldingCompanyDetail) + + + + + diff --git a/docs/ApiResponseZacksInstitutionalHoldingOwners.md b/docs/ApiResponseZacksInstitutionalHoldingOwners.md new file mode 100644 index 0000000..ea4f011 --- /dev/null +++ b/docs/ApiResponseZacksInstitutionalHoldingOwners.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseZacksInstitutionalHoldingOwners) + +[//]: # (KIND:object) + +### ApiResponseZacksInstitutionalHoldingOwners + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**owners** | [**List<ZacksInstitutionalHoldingOwnerDetail>**](ZacksInstitutionalHoldingOwnerDetail.md) | Zacks institutional holding owners data   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ZacksInstitutionalHoldingOwnerDetail) + + + + + diff --git a/docs/ApiResponseZacksInstitutionalHoldings.md b/docs/ApiResponseZacksInstitutionalHoldings.md new file mode 100644 index 0000000..836b405 --- /dev/null +++ b/docs/ApiResponseZacksInstitutionalHoldings.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseZacksInstitutionalHoldings) + +[//]: # (KIND:object) + +### ApiResponseZacksInstitutionalHoldings + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**holdings** | [**List<ZacksInstitutionalHolding>**](ZacksInstitutionalHolding.md) | Zacks institutional holding data   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ZacksInstitutionalHolding) + + + + + diff --git a/docs/ApiResponseZacksLongTermGrowthRates.md b/docs/ApiResponseZacksLongTermGrowthRates.md new file mode 100644 index 0000000..9b45dfa --- /dev/null +++ b/docs/ApiResponseZacksLongTermGrowthRates.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseZacksLongTermGrowthRates) + +[//]: # (KIND:object) + +### ApiResponseZacksLongTermGrowthRates + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**longTermGrowthEstimates** | [**List<ZacksLongTermGrowthRate>**](ZacksLongTermGrowthRate.md) | Zacks latest long term growth rates   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ZacksLongTermGrowthRate) + + + + + diff --git a/docs/ApiResponseZacksSalesSurprises.md b/docs/ApiResponseZacksSalesSurprises.md new file mode 100644 index 0000000..aceba44 --- /dev/null +++ b/docs/ApiResponseZacksSalesSurprises.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseZacksSalesSurprises) + +[//]: # (KIND:object) + +### ApiResponseZacksSalesSurprises + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**salesSurprises** | [**List<ZacksSalesSurprise>**](ZacksSalesSurprise.md) | Zacks Sales Surprise data for a Security in descending order by actual reported date   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ZacksSalesSurprise) + + + + + diff --git a/docs/ApiResponseZacksTargetPriceConsensuses.md b/docs/ApiResponseZacksTargetPriceConsensuses.md new file mode 100644 index 0000000..a171ef6 --- /dev/null +++ b/docs/ApiResponseZacksTargetPriceConsensuses.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ApiResponseZacksTargetPriceConsensuses) + +[//]: # (KIND:object) + +### ApiResponseZacksTargetPriceConsensuses + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**targetPriceConsensuses** | [**List<ZacksTargetPriceConsensus>**](ZacksTargetPriceConsensus.md) | Zacks target price consensuses for the latest date   +**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ZacksTargetPriceConsensus) + + + + + diff --git a/docs/AverageDailyTradingVolumeTechnicalValue.md b/docs/AverageDailyTradingVolumeTechnicalValue.md new file mode 100644 index 0000000..9f45ef5 --- /dev/null +++ b/docs/AverageDailyTradingVolumeTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:AverageDailyTradingVolumeTechnicalValue) + +[//]: # (KIND:object) + +### AverageDailyTradingVolumeTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**adtv** | Float | The Average Daily Trading Volume calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/AverageDirectionalIndexTechnicalValue.md b/docs/AverageDirectionalIndexTechnicalValue.md new file mode 100644 index 0000000..4b050b7 --- /dev/null +++ b/docs/AverageDirectionalIndexTechnicalValue.md @@ -0,0 +1,27 @@ + +[//]: # (CLASS:AverageDirectionalIndexTechnicalValue) + +[//]: # (KIND:object) + +### AverageDirectionalIndexTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**adx** | Float | The Average Directional Index value   +**diNeg** | Float | The Minus Directional Indicator value   +**diPos** | Float | The Plus Directional Indicator value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/AverageTrueRangeTechnicalValue.md b/docs/AverageTrueRangeTechnicalValue.md new file mode 100644 index 0000000..64ccf2b --- /dev/null +++ b/docs/AverageTrueRangeTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:AverageTrueRangeTechnicalValue) + +[//]: # (KIND:object) + +### AverageTrueRangeTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**atr** | Float | The Average True Range calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/AwesomeOscillatorTechnicalValue.md b/docs/AwesomeOscillatorTechnicalValue.md new file mode 100644 index 0000000..4185b4e --- /dev/null +++ b/docs/AwesomeOscillatorTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:AwesomeOscillatorTechnicalValue) + +[//]: # (KIND:object) + +### AwesomeOscillatorTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**ao** | Float | The Awesome Oscillator calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/BollingerBandsTechnicalValue.md b/docs/BollingerBandsTechnicalValue.md new file mode 100644 index 0000000..8d963d9 --- /dev/null +++ b/docs/BollingerBandsTechnicalValue.md @@ -0,0 +1,27 @@ + +[//]: # (CLASS:BollingerBandsTechnicalValue) + +[//]: # (KIND:object) + +### BollingerBandsTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**lowerBand** | Float | The lower band value of the Bollinger Bands technical indicator calculation   +**middleBand** | Float | The middle band value of the Bollinger Bands technical indicator calculation   +**upperBand** | Float | The upper band value of the Bollinger Bands technical indicator calculation   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/BulkDownloadLinks.md b/docs/BulkDownloadLinks.md new file mode 100644 index 0000000..bc9ceea --- /dev/null +++ b/docs/BulkDownloadLinks.md @@ -0,0 +1,22 @@ + +[//]: # (CLASS:BulkDownloadLinks) + +[//]: # (KIND:object) + +### BulkDownloadLinks + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**name** | String | The name of the file   +**url** | String | Link for accessing the bulk download. Expires in 24 hours.   + +[//]: # (END_DEFINITION) + + + + + diff --git a/docs/BulkDownloadSummary.md b/docs/BulkDownloadSummary.md new file mode 100644 index 0000000..4583114 --- /dev/null +++ b/docs/BulkDownloadSummary.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:BulkDownloadSummary) + +[//]: # (KIND:object) + +### BulkDownloadSummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID of the bulk download   +**name** | String | The name of the bulk download   +**format** | String | The file format of the bulk download   +**dataLengthBytes** | String | The total length of the bulk download data in bytes   +**updateFrequency** | String | The update frequency for the bulk download   +**links** | [**List<BulkDownloadLinks>**](BulkDownloadLinks.md) | Links to all of the files comprising the bulk download. Links expire in 24 hours.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BulkDownloadLinks) + + + + + diff --git a/docs/BulkDownloadsApi.md b/docs/BulkDownloadsApi.md new file mode 100644 index 0000000..152feca --- /dev/null +++ b/docs/BulkDownloadsApi.md @@ -0,0 +1,95 @@ +# BulkDownloadsApi + +All URIs are relative to *https://api-v2.intrinio.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getBulkDownloadLinks**](BulkDownloadsApi.md#getBulkDownloadLinks) | **GET** /bulk_downloads/links | All Links + + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:BulkDownloadsApi) + +[//]: # (METHOD:getBulkDownloadLinks) + +[//]: # (RETURN_TYPE:ApiResponseBulkDownloadLinks) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseBulkDownloadLinks.md) + +[//]: # (OPERATION:getBulkDownloadLinks_v2) + +[//]: # (ENDPOINT:/bulk_downloads/links) + +[//]: # (DOCUMENT_LINK:BulkDownloadsApi.md#getBulkDownloadLinks) + + +## **getBulkDownloadLinks** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getBulkDownloadLinks_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseBulkDownloadLinks getBulkDownloadLinks() + +#### All Links + + +Returns all active bulk downloads for your account with links to download. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + BulkDownloadsApi bulkDownloadsApi = new BulkDownloadsApi(); + + + try { + ApiResponseBulkDownloadLinks result = bulkDownloadsApi.getBulkDownloadLinks(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling BulkDownloadsApi#getBulkDownloadLinks"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + +This endpoint does not need any parameter. +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseBulkDownloadLinks**](ApiResponseBulkDownloadLinks.md) + +[//]: # (END_OPERATION) + diff --git a/docs/ChaikinMoneyFlowTechnicalValue.md b/docs/ChaikinMoneyFlowTechnicalValue.md new file mode 100644 index 0000000..8f6e7c1 --- /dev/null +++ b/docs/ChaikinMoneyFlowTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ChaikinMoneyFlowTechnicalValue) + +[//]: # (KIND:object) + +### ChaikinMoneyFlowTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**cmf** | Float | The Chaikin Money Flow calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/CommodityChannelIndexTechnicalValue.md b/docs/CommodityChannelIndexTechnicalValue.md new file mode 100644 index 0000000..e26fc4b --- /dev/null +++ b/docs/CommodityChannelIndexTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:CommodityChannelIndexTechnicalValue) + +[//]: # (KIND:object) + +### CommodityChannelIndexTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**cci** | Float | The Commodity Channel Index calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/Company.md b/docs/Company.md new file mode 100644 index 0000000..468f858 --- /dev/null +++ b/docs/Company.md @@ -0,0 +1,71 @@ + +[//]: # (CLASS:Company) + +[//]: # (KIND:object) + +### Company + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID of the company   +**ticker** | String | The stock market ticker symbol associated with the company's common stock securities   +**name** | String | The company's common name   +**lei** | String | The Legal Entity Identifier (LEI) assigned to the company   +**legalName** | String | The company's official legal name   +**stockExchange** | String | The Stock Exchange where the company's common stock is primarily traded   +**sic** | String | The Standard Industrial Classification (SIC) determined by the company and filed with the SEC   +**shortDescription** | String | A one or two sentence description of the company's operations   +**longDescription** | String | A one paragraph description of the company's operations and other corporate actions   +**ceo** | String | The Chief Executive Officer of the company   +**companyUrl** | String | The URL of the company's primary corporate website or primary internet property   +**businessAddress** | String | The company's business address   +**mailingAddress** | String | The mailing address reported by the company   +**businessPhoneNo** | String | The phone number reported by the company   +**hqAddress1** | String | The company's headquarters address - line 1   +**hqAddress2** | String | The company's headquarters address - line 2   +**hqAddressCity** | String | The company's headquarters city   +**hqAddressPostalCode** | String | The company's headquarters postal code   +**entityLegalForm** | String | The company's legal organization form   +**cik** | String | The Central Index Key (CIK) assigned to the company by the SEC as a unique identifier, used in SEC filings   +**latestFilingDate** | [**LocalDate**](LocalDate.md) | The date of the company's last filing with the SEC   +**hqState** | String | The state (US & Canada Only) where the company headquarters are located   +**hqCountry** | String | The country where the company headquarters are located   +**incState** | String | The state (US & Canada Only) where the company is incorporated   +**incCountry** | String | The country where the company is incorporated   +**employees** | Integer | The number of employees working for the company   +**entityStatus** | String |   +**sector** | String | The company's operating sector   +**industryCategory** | String | The company's operating industry category   +**industryGroup** | String | The company's operating industry group   +**template** | String | The financial statement template used by Intrinio to standardize the as reported data   +**standardizedActive** | Boolean | If true, the company has standardized and as reported fundamental data via the Intrinio API; if false, the company has as-reported data only   +**firstFundamentalDate** | [**LocalDate**](LocalDate.md) | The period end date of the company's first reported fundamental   +**lastFundamentalDate** | [**LocalDate**](LocalDate.md) | The period end date of the company's last reported fundamental   +**firstStockPriceDate** | [**LocalDate**](LocalDate.md) | The date of the company's first stock price, based on the company's primary security, which is typically traded on US exchages   +**lastStockPriceDate** | [**LocalDate**](LocalDate.md) | The date of the company's last stock price, based on the company's primary security, which is typically traded on US exchages   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + + + + diff --git a/docs/CompanyApi.md b/docs/CompanyApi.md new file mode 100644 index 0000000..eff9b4b --- /dev/null +++ b/docs/CompanyApi.md @@ -0,0 +1,1289 @@ +# CompanyApi + +All URIs are relative to *https://api-v2.intrinio.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAllCompanies**](CompanyApi.md#getAllCompanies) | **GET** /companies | All Companies +[**getAllCompanyNews**](CompanyApi.md#getAllCompanyNews) | **GET** /companies/news | All News +[**getCompany**](CompanyApi.md#getCompany) | **GET** /companies/{identifier} | Lookup Company +[**getCompanyDataPointNumber**](CompanyApi.md#getCompanyDataPointNumber) | **GET** /companies/{identifier}/data_point/{tag}/number | Data Point (Number) for Company +[**getCompanyDataPointText**](CompanyApi.md#getCompanyDataPointText) | **GET** /companies/{identifier}/data_point/{tag}/text | Data Point (Text) for Company +[**getCompanyFilings**](CompanyApi.md#getCompanyFilings) | **GET** /companies/{identifier}/filings | All Filings by Company +[**getCompanyFundamentals**](CompanyApi.md#getCompanyFundamentals) | **GET** /companies/{identifier}/fundamentals | All Fundamentals by Company +[**getCompanyHistoricalData**](CompanyApi.md#getCompanyHistoricalData) | **GET** /companies/{identifier}/historical_data/{tag} | Historical Data for Company +[**getCompanyIpos**](CompanyApi.md#getCompanyIpos) | **GET** /companies/ipos | IPOs +[**getCompanyNews**](CompanyApi.md#getCompanyNews) | **GET** /companies/{identifier}/news | All News by Company +[**getCompanySecurities**](CompanyApi.md#getCompanySecurities) | **GET** /companies/{identifier}/securities | All Securities by Company +[**lookupCompanyFundamental**](CompanyApi.md#lookupCompanyFundamental) | **GET** /companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental by Company +[**searchCompanies**](CompanyApi.md#searchCompanies) | **GET** /companies/search | Search Companies + + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:CompanyApi) + +[//]: # (METHOD:getAllCompanies) + +[//]: # (RETURN_TYPE:ApiResponseCompanies) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseCompanies.md) + +[//]: # (OPERATION:getAllCompanies_v2) + +[//]: # (ENDPOINT:/companies) + +[//]: # (DOCUMENT_LINK:CompanyApi.md#getAllCompanies) + + +## **getAllCompanies** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getAllCompanies_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseCompanies getAllCompanies(latestFilingDate, sic, template, sector, industryCategory, industryGroup, hasFundamentals, hasStockPrices, pageSize, nextPage) + +#### All Companies + + +Returns all Companies. When parameters are specified, returns matching companies. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + CompanyApi companyApi = new CompanyApi(); + + LocalDate latestFilingDate = LocalDate.now(); // LocalDate | Return companies whose latest 10-Q or 10-K was filed on or after this date + String sic = null; // String | Return companies with the given Standard Industrial Classification code + String template = null; // String | Return companies with the given financial statement template + String sector = null; // String | Return companies in the given industry sector + String industryCategory = null; // String | Return companies in the given industry category + String industryGroup = null; // String | Return companies in the given industry group + Boolean hasFundamentals = true; // Boolean | Return only companies that have fundamentals when true + Boolean hasStockPrices = true; // Boolean | Return only companies that have stock prices when true + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseCompanies result = companyApi.getAllCompanies(latestFilingDate, sic, template, sector, industryCategory, industryGroup, hasFundamentals, hasStockPrices, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling CompanyApi#getAllCompanies"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **latestFilingDate** | LocalDate| Return companies whose latest 10-Q or 10-K was filed on or after this date | [optional]   + **sic** | String| Return companies with the given Standard Industrial Classification code | [optional]   + **template** | String| Return companies with the given financial statement template | [optional] [enum: industrial, financial]   + **sector** | String| Return companies in the given industry sector | [optional]   + **industryCategory** | String| Return companies in the given industry category | [optional]   + **industryGroup** | String| Return companies in the given industry group | [optional]   + **hasFundamentals** | Boolean| Return only companies that have fundamentals when true | [optional]   + **hasStockPrices** | Boolean| Return only companies that have stock prices when true | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseCompanies**](ApiResponseCompanies.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:CompanyApi) + +[//]: # (METHOD:getAllCompanyNews) + +[//]: # (RETURN_TYPE:ApiResponseNews) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseNews.md) + +[//]: # (OPERATION:getAllCompanyNews_v2) + +[//]: # (ENDPOINT:/companies/news) + +[//]: # (DOCUMENT_LINK:CompanyApi.md#getAllCompanyNews) + + +## **getAllCompanyNews** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getAllCompanyNews_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseNews getAllCompanyNews(pageSize, nextPage) + +#### All News + + +Returns all News for all Companies + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + CompanyApi companyApi = new CompanyApi(); + + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseNews result = companyApi.getAllCompanyNews(pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling CompanyApi#getAllCompanyNews"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseNews**](ApiResponseNews.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:CompanyApi) + +[//]: # (METHOD:getCompany) + +[//]: # (RETURN_TYPE:Company) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:Company.md) + +[//]: # (OPERATION:getCompany_v2) + +[//]: # (ENDPOINT:/companies/{identifier}) + +[//]: # (DOCUMENT_LINK:CompanyApi.md#getCompany) + + +## **getCompany** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getCompany_v2) + +[//]: # (START_OVERVIEW) + +> Company getCompany(identifier) + +#### Lookup Company + + +Returns the Company with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + CompanyApi companyApi = new CompanyApi(); + + String identifier = "AAPL"; // String | A Company identifier (Ticker, CIK, LEI, Intrinio ID) + + try { + Company result = companyApi.getCompany(identifier); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling CompanyApi#getCompany"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**Company**](Company.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:CompanyApi) + +[//]: # (METHOD:getCompanyDataPointNumber) + +[//]: # (RETURN_TYPE:BigDecimal) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:BigDecimal.md) + +[//]: # (OPERATION:getCompanyDataPointNumber_v2) + +[//]: # (ENDPOINT:/companies/{identifier}/data_point/{tag}/number) + +[//]: # (DOCUMENT_LINK:CompanyApi.md#getCompanyDataPointNumber) + + +## **getCompanyDataPointNumber** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getCompanyDataPointNumber_v2) + +[//]: # (START_OVERVIEW) + +> BigDecimal getCompanyDataPointNumber(identifier, tag) + +#### Data Point (Number) for Company + + +Returns a numeric value for the given `tag` for the Company with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + CompanyApi companyApi = new CompanyApi(); + + String identifier = "AAPL"; // String | A Company identifier (Ticker, CIK, LEI, Intrinio ID) + String tag = "marketcap"; // String | An Intrinio data tag ID or code (reference) + + try { + BigDecimal result = companyApi.getCompanyDataPointNumber(identifier, tag); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling CompanyApi#getCompanyDataPointNumber"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   + **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**BigDecimal**](BigDecimal.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:CompanyApi) + +[//]: # (METHOD:getCompanyDataPointText) + +[//]: # (RETURN_TYPE:String) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:getCompanyDataPointText_v2) + +[//]: # (ENDPOINT:/companies/{identifier}/data_point/{tag}/text) + +[//]: # (DOCUMENT_LINK:CompanyApi.md#getCompanyDataPointText) + + +## **getCompanyDataPointText** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getCompanyDataPointText_v2) + +[//]: # (START_OVERVIEW) + +> String getCompanyDataPointText(identifier, tag) + +#### Data Point (Text) for Company + + +Returns a text value for the given `tag` for the Company with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + CompanyApi companyApi = new CompanyApi(); + + String identifier = "AAPL"; // String | A Company identifier (Ticker, CIK, LEI, Intrinio ID) + String tag = "ceo"; // String | An Intrinio data tag ID or code (reference) + + try { + String result = companyApi.getCompanyDataPointText(identifier, tag); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling CompanyApi#getCompanyDataPointText"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   + **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +**String** + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:CompanyApi) + +[//]: # (METHOD:getCompanyFilings) + +[//]: # (RETURN_TYPE:ApiResponseCompanyFilings) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseCompanyFilings.md) + +[//]: # (OPERATION:getCompanyFilings_v2) + +[//]: # (ENDPOINT:/companies/{identifier}/filings) + +[//]: # (DOCUMENT_LINK:CompanyApi.md#getCompanyFilings) + + +## **getCompanyFilings** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getCompanyFilings_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseCompanyFilings getCompanyFilings(identifier, reportType, startDate, endDate, pageSize, nextPage) + +#### All Filings by Company + + +Returns a complete list of SEC filings for the Company with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + CompanyApi companyApi = new CompanyApi(); + + String identifier = "AAPL"; // String | A Company identifier (Ticker, CIK, LEI, Intrinio ID) + String reportType = null; // String | Filter by report type. Separate values with commas to return multiple report types. + LocalDate startDate = LocalDate.now(); // LocalDate | Filed on or after the given date + LocalDate endDate = LocalDate.now(); // LocalDate | Filed before or after the given date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseCompanyFilings result = companyApi.getCompanyFilings(identifier, reportType, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling CompanyApi#getCompanyFilings"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   + **reportType** | String| Filter by <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report type</a>. Separate values with commas to return multiple report types. | [optional]   + **startDate** | LocalDate| Filed on or after the given date | [optional]   + **endDate** | LocalDate| Filed before or after the given date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseCompanyFilings**](ApiResponseCompanyFilings.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:CompanyApi) + +[//]: # (METHOD:getCompanyFundamentals) + +[//]: # (RETURN_TYPE:ApiResponseCompanyFundamentals) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseCompanyFundamentals.md) + +[//]: # (OPERATION:getCompanyFundamentals_v2) + +[//]: # (ENDPOINT:/companies/{identifier}/fundamentals) + +[//]: # (DOCUMENT_LINK:CompanyApi.md#getCompanyFundamentals) + + +## **getCompanyFundamentals** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getCompanyFundamentals_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseCompanyFundamentals getCompanyFundamentals(identifier, filedAfter, filedBefore, reportedOnly, fiscalYear, statementCode, type, startDate, endDate, pageSize, nextPage) + +#### All Fundamentals by Company + + +Returns all Fundamentals for the Company with the given `identifier`. Returns Fundamentals matching parameters when supplied. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + CompanyApi companyApi = new CompanyApi(); + + String identifier = "AAPL"; // String | A Company identifier (Ticker, CIK, LEI, Intrinio ID) + LocalDate filedAfter = LocalDate.now(); // LocalDate | Filed on or after this date + LocalDate filedBefore = LocalDate.now(); // LocalDate | Filed on or before this date + Boolean reportedOnly = false; // Boolean | Only as-reported fundamentals + Integer fiscalYear = null; // Integer | Only for the given fiscal year + String statementCode = null; // String | Only of the given statement code + String type = null; // String | Only of the given type + LocalDate startDate = LocalDate.now(); // LocalDate | Only on or after the given date + LocalDate endDate = LocalDate.now(); // LocalDate | Only on or before the given date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseCompanyFundamentals result = companyApi.getCompanyFundamentals(identifier, filedAfter, filedBefore, reportedOnly, fiscalYear, statementCode, type, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling CompanyApi#getCompanyFundamentals"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   + **filedAfter** | LocalDate| Filed on or after this date | [optional]   + **filedBefore** | LocalDate| Filed on or before this date | [optional]   + **reportedOnly** | Boolean| Only as-reported fundamentals | [optional]   + **fiscalYear** | Integer| Only for the given fiscal year | [optional]   + **statementCode** | String| Only of the given statement code | [optional] [enum: income_statement, balance_sheet_statement, cash_flow_statement, calculations]   + **type** | String| Only of the given type | [optional] [enum: QTR, YTD, FY, TTM]   + **startDate** | LocalDate| Only on or after the given date | [optional]   + **endDate** | LocalDate| Only on or before the given date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseCompanyFundamentals**](ApiResponseCompanyFundamentals.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:CompanyApi) + +[//]: # (METHOD:getCompanyHistoricalData) + +[//]: # (RETURN_TYPE:ApiResponseCompanyHistoricalData) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseCompanyHistoricalData.md) + +[//]: # (OPERATION:getCompanyHistoricalData_v2) + +[//]: # (ENDPOINT:/companies/{identifier}/historical_data/{tag}) + +[//]: # (DOCUMENT_LINK:CompanyApi.md#getCompanyHistoricalData) + + +## **getCompanyHistoricalData** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getCompanyHistoricalData_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseCompanyHistoricalData getCompanyHistoricalData(identifier, tag, frequency, type, startDate, endDate, sortOrder, pageSize, nextPage) + +#### Historical Data for Company + + +Returns historical values for the given `tag` and the Company with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + CompanyApi companyApi = new CompanyApi(); + + String identifier = "AAPL"; // String | A Company identifier (Ticker, CIK, LEI, Intrinio ID) + String tag = "marketcap"; // String | An Intrinio data tag ID or code (reference) + String frequency = "daily"; // String | Return historical data in the given frequency + String type = null; // String | Return historical data for given fiscal period type + LocalDate startDate = LocalDate.now(); // LocalDate | Return historical data on or after this date + LocalDate endDate = LocalDate.now(); // LocalDate | Return historical data on or before this date + String sortOrder = "desc"; // String | Sort by date `asc` or `desc` + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseCompanyHistoricalData result = companyApi.getCompanyHistoricalData(identifier, tag, frequency, type, startDate, endDate, sortOrder, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling CompanyApi#getCompanyHistoricalData"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   + **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   + **frequency** | String| Return historical data in the given frequency | [optional] [default to daily] [enum: daily, weekly, monthly, quarterly, yearly]   + **type** | String| Return historical data for given fiscal period type | [optional] [enum: FY, QTR, TTM]   + **startDate** | LocalDate| Return historical data on or after this date | [optional]   + **endDate** | LocalDate| Return historical data on or before this date | [optional]   + **sortOrder** | String| Sort by date `asc` or `desc` | [optional] [default to desc] [enum: asc, desc]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseCompanyHistoricalData**](ApiResponseCompanyHistoricalData.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:CompanyApi) + +[//]: # (METHOD:getCompanyIpos) + +[//]: # (RETURN_TYPE:ApiResponseInitialPublicOfferings) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseInitialPublicOfferings.md) + +[//]: # (OPERATION:getCompanyIpos_v2) + +[//]: # (ENDPOINT:/companies/ipos) + +[//]: # (DOCUMENT_LINK:CompanyApi.md#getCompanyIpos) + + +## **getCompanyIpos** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getCompanyIpos_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseInitialPublicOfferings getCompanyIpos(ticker, status, startDate, endDate, offerAmountGreaterThan, offerAmountLessThan, pageSize, nextPage) + +#### IPOs + + +Returns initial public offerings (IPOs). An IPO is a public offering of private company stock. The act of \"going public\" is initiated by an IPO, at which point the company's stock trades on a major stock exchange (such as NYSE or NASDAQ). Intrinio covers all upcoming and recent IPOs for US exchanges. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + CompanyApi companyApi = new CompanyApi(); + + String ticker = null; // String | Return IPOs with the given ticker (typically the IPO for the company) + String status = null; // String | Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occured and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand + LocalDate startDate = LocalDate.now(); // LocalDate | Return IPOs on or after the given date + LocalDate endDate = LocalDate.now(); // LocalDate | Return IPOs on or before the given date + Integer offerAmountGreaterThan = null; // Integer | Return IPOs with an offer dollar amount greater than the given amount + Integer offerAmountLessThan = null; // Integer | Return IPOs with an offer dollar amount less than the given amount + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseInitialPublicOfferings result = companyApi.getCompanyIpos(ticker, status, startDate, endDate, offerAmountGreaterThan, offerAmountLessThan, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling CompanyApi#getCompanyIpos"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ticker** | String| Return IPOs with the given ticker (typically the IPO for the company) | [optional]   + **status** | String| Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occured and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand | [optional] [enum: upcoming, priced, withdrawn]   + **startDate** | LocalDate| Return IPOs on or after the given date | [optional]   + **endDate** | LocalDate| Return IPOs on or before the given date | [optional]   + **offerAmountGreaterThan** | Integer| Return IPOs with an offer dollar amount greater than the given amount | [optional]   + **offerAmountLessThan** | Integer| Return IPOs with an offer dollar amount less than the given amount | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseInitialPublicOfferings**](ApiResponseInitialPublicOfferings.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:CompanyApi) + +[//]: # (METHOD:getCompanyNews) + +[//]: # (RETURN_TYPE:ApiResponseCompanyNews) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseCompanyNews.md) + +[//]: # (OPERATION:getCompanyNews_v2) + +[//]: # (ENDPOINT:/companies/{identifier}/news) + +[//]: # (DOCUMENT_LINK:CompanyApi.md#getCompanyNews) + + +## **getCompanyNews** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getCompanyNews_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseCompanyNews getCompanyNews(identifier, pageSize, nextPage) + +#### All News by Company + + +Returns news for the Company with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + CompanyApi companyApi = new CompanyApi(); + + String identifier = "AAPL"; // String | A Company identifier (Ticker, CIK, LEI, Intrinio ID) + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseCompanyNews result = companyApi.getCompanyNews(identifier, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling CompanyApi#getCompanyNews"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseCompanyNews**](ApiResponseCompanyNews.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:CompanyApi) + +[//]: # (METHOD:getCompanySecurities) + +[//]: # (RETURN_TYPE:ApiResponseCompanySecurities) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseCompanySecurities.md) + +[//]: # (OPERATION:getCompanySecurities_v2) + +[//]: # (ENDPOINT:/companies/{identifier}/securities) + +[//]: # (DOCUMENT_LINK:CompanyApi.md#getCompanySecurities) + + +## **getCompanySecurities** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getCompanySecurities_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseCompanySecurities getCompanySecurities(identifier, nextPage) + +#### All Securities by Company + + +Returns Securities for the Company with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + CompanyApi companyApi = new CompanyApi(); + + String identifier = "AAPL"; // String | A Company identifier (Ticker, CIK, LEI, Intrinio ID) + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseCompanySecurities result = companyApi.getCompanySecurities(identifier, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling CompanyApi#getCompanySecurities"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseCompanySecurities**](ApiResponseCompanySecurities.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:CompanyApi) + +[//]: # (METHOD:lookupCompanyFundamental) + +[//]: # (RETURN_TYPE:Fundamental) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:Fundamental.md) + +[//]: # (OPERATION:lookupCompanyFundamental_v2) + +[//]: # (ENDPOINT:/companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period}) + +[//]: # (DOCUMENT_LINK:CompanyApi.md#lookupCompanyFundamental) + + +## **lookupCompanyFundamental** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/lookupCompanyFundamental_v2) + +[//]: # (START_OVERVIEW) + +> Fundamental lookupCompanyFundamental(identifier, statementCode, fiscalPeriod, fiscalYear) + +#### Lookup Fundamental by Company + + +Returns the Fundamental for the Company with the given `identifier` and with the given parameters + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + CompanyApi companyApi = new CompanyApi(); + + String identifier = "AAPL"; // String | A Company identifier (Ticker, CIK, LEI, Intrinio ID) + String statementCode = "income_statement"; // String | The statement code + String fiscalPeriod = "FY"; // String | The fiscal period + Integer fiscalYear = 2017; // Integer | The fiscal year + + try { + Fundamental result = companyApi.lookupCompanyFundamental(identifier, statementCode, fiscalPeriod, fiscalYear); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling CompanyApi#lookupCompanyFundamental"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   + **statementCode** | String| The statement code | [enum: income_statement, balance_sheet_statement, cash_flow_statement, calculations]   + **fiscalPeriod** | String| The fiscal period | [enum: Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD]   + **fiscalYear** | Integer| The fiscal year |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**Fundamental**](Fundamental.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:CompanyApi) + +[//]: # (METHOD:searchCompanies) + +[//]: # (RETURN_TYPE:ApiResponseCompaniesSearch) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseCompaniesSearch.md) + +[//]: # (OPERATION:searchCompanies_v2) + +[//]: # (ENDPOINT:/companies/search) + +[//]: # (DOCUMENT_LINK:CompanyApi.md#searchCompanies) + + +## **searchCompanies** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/searchCompanies_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseCompaniesSearch searchCompanies(query, pageSize) + +#### Search Companies + + +Searches for Companies matching the text `query` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + CompanyApi companyApi = new CompanyApi(); + + String query = "Apple"; // String | Search parameters + Integer pageSize = 100; // Integer | The number of results to return + + try { + ApiResponseCompaniesSearch result = companyApi.searchCompanies(query, pageSize); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling CompanyApi#searchCompanies"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | String| Search parameters |   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseCompaniesSearch**](ApiResponseCompaniesSearch.md) + +[//]: # (END_OPERATION) + diff --git a/docs/CompanyFiling.md b/docs/CompanyFiling.md new file mode 100644 index 0000000..88f2ce9 --- /dev/null +++ b/docs/CompanyFiling.md @@ -0,0 +1,42 @@ + +[//]: # (CLASS:CompanyFiling) + +[//]: # (KIND:object) + +### CompanyFiling + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID of the Filing   +**filingDate** | [**LocalDate**](LocalDate.md) | The date when the filing was submitted to the SEC by the company   +**acceptedDate** | [**OffsetDateTime**](OffsetDateTime.md) | The date and time when the filing was accepted by SEC   +**periodEndDate** | [**LocalDate**](LocalDate.md) | The ending date of the fiscal period for the filing   +**reportType** | String | The filing <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report type</a>   +**secUniqueId** | String | A unique identifier for the filing provided by the SEC   +**filingUrl** | String | The URL to the filing page on the SEC site   +**reportUrl** | String | The URL to the actual report on the SEC site   +**instanceUrl** | String | The URL for the XBRL filing for the report   +**company** | [**CompanySummary**](CompanySummary.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:CompanySummary) + + + + + diff --git a/docs/CompanyInitialPublicOffering.md b/docs/CompanyInitialPublicOffering.md new file mode 100644 index 0000000..3c864c7 --- /dev/null +++ b/docs/CompanyInitialPublicOffering.md @@ -0,0 +1,100 @@ + +[//]: # (CLASS:CompanyInitialPublicOffering) + +[//]: # (KIND:object) + +### CompanyInitialPublicOffering + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for the IPO   +**ticker** | String | The ticker under which the Company will be traded after the IPO takes place   +**date** | [**OffsetDateTime**](OffsetDateTime.md) | The date of the IPO, when the stock first trades on a major exchange   +**status** | StatusEnum | The status of the IPO. Upcoming IPOs have not taken place yet but are expected to. Priced IPOs have taken place. Withdrawn IPOs were expected to take place, but were subsequently withdrawn and did not take place   +**exchange** | String | The acronym of the stock exchange that the company is going to trade publicly on. Typically NYSE or NASDAQ   +**offerAmount** | [**BigDecimal**](BigDecimal.md) | The total dollar amount of shares offered in the IPO. Typically this is share price * share count   +**sharePrice** | [**BigDecimal**](BigDecimal.md) | The price per share at which the IPO was offered   +**sharePriceLowest** | [**BigDecimal**](BigDecimal.md) | The expected lowest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs)   +**sharePriceHighest** | [**BigDecimal**](BigDecimal.md) | The expected highest price per share at which the IPO will be offered. Before an IPO is priced, companies typically provide a range of prices per share at which they expect to offer the IPO (typically available for upcoming IPOs)   +**shareCount** | [**BigDecimal**](BigDecimal.md) | The number of shares offered in the IPO   +**shareCountLowest** | [**BigDecimal**](BigDecimal.md) | The expected lowest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs)   +**shareCountHighest** | [**BigDecimal**](BigDecimal.md) | The expected highest number of shares that will be offered in the IPO. Before an IPO is priced, companies typically provide a range of shares that they expect to offer in the IPO (typically available for upcoming IPOs)   +**announcementUrl** | String | The URL to the company's announcement of the IPO   +**secReportUrl** | String | The IRL to the company's S-1, S-1/A, F-1, or F-1/A SEC filing, which is required to be filed before an IPO takes place.   +**openPrice** | [**BigDecimal**](BigDecimal.md) | The opening price at the beginning of the first trading day (only available for priced IPOs)   +**closePrice** | [**BigDecimal**](BigDecimal.md) | The closing price at the end of the first trading day (only available for priced IPOs)   +**volume** | [**BigDecimal**](BigDecimal.md) | The volume at the end of the first trading day (only available for priced IPOs)   +**dayChange** | [**BigDecimal**](BigDecimal.md) | The percentage change between the open price and the close price on the first trading day (only available for priced IPOs)   +**weekChange** | [**BigDecimal**](BigDecimal.md) | The percentage change between the open price on the first trading day and the close price approximately a week after the first trading day (only available for priced IPOs)   +**monthChange** | [**BigDecimal**](BigDecimal.md) | The percentage change between the open price on the first trading day and the close price approximately a month after the first trading day (only available for priced IPOs)   +**company** | [**CompanySummary**](CompanySummary.md) | The Company that is going public via the IPO   +**security** | [**SecuritySummary**](SecuritySummary.md) | The primary Security for the Company that is going public via the IPO   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:CompanySummary) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + +
+ +#### Enum: StatusEnum + +Name | Value +---- | ----- +UPCOMING | "upcoming" +PRICED | "priced" +WITHDRAWN | "withdrawn" + + + diff --git a/docs/CompanyNews.md b/docs/CompanyNews.md new file mode 100644 index 0000000..411cb32 --- /dev/null +++ b/docs/CompanyNews.md @@ -0,0 +1,32 @@ + +[//]: # (CLASS:CompanyNews) + +[//]: # (KIND:object) + +### CompanyNews + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for the news article   +**title** | String | The title of the news article   +**publicationDate** | [**OffsetDateTime**](OffsetDateTime.md) | The publication date of the news article   +**url** | String | The url of the news article   +**summary** | String | A summary of the news article   +**company** | [**CompanySummary**](CompanySummary.md) | The Company to which the new article pertains   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + +[//]: # (CONTAINED_CLASS:CompanySummary) + + + + + diff --git a/docs/CompanyNewsSummary.md b/docs/CompanyNewsSummary.md new file mode 100644 index 0000000..b68e5f4 --- /dev/null +++ b/docs/CompanyNewsSummary.md @@ -0,0 +1,28 @@ + +[//]: # (CLASS:CompanyNewsSummary) + +[//]: # (KIND:object) + +### CompanyNewsSummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for the news article   +**title** | String | The title of the news article   +**publicationDate** | [**OffsetDateTime**](OffsetDateTime.md) | The publication date of the news article   +**url** | String | The url of the news article   +**summary** | String | A summary of the news article   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/CompanySummary.md b/docs/CompanySummary.md new file mode 100644 index 0000000..979cf1c --- /dev/null +++ b/docs/CompanySummary.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:CompanySummary) + +[//]: # (KIND:object) + +### CompanySummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID of the company   +**ticker** | String | The stock market ticker symbol associated with the company's common stock securities   +**name** | String | The company's common name   +**lei** | String | The Legal Entity Identifier (LEI) assigned to the company   +**cik** | String | The Central Index Key (CIK) assigned to the company   + +[//]: # (END_DEFINITION) + + + + + diff --git a/docs/DataPointApi.md b/docs/DataPointApi.md new file mode 100644 index 0000000..955559e --- /dev/null +++ b/docs/DataPointApi.md @@ -0,0 +1,194 @@ +# DataPointApi + +All URIs are relative to *https://api-v2.intrinio.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getDataPointNumber**](DataPointApi.md#getDataPointNumber) | **GET** /data_point/{identifier}/{tag}/number | Data Point (Number) +[**getDataPointText**](DataPointApi.md#getDataPointText) | **GET** /data_point/{identifier}/{tag}/text | Data Point (Text) + + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:DataPointApi) + +[//]: # (METHOD:getDataPointNumber) + +[//]: # (RETURN_TYPE:BigDecimal) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:BigDecimal.md) + +[//]: # (OPERATION:getDataPointNumber_v2) + +[//]: # (ENDPOINT:/data_point/{identifier}/{tag}/number) + +[//]: # (DOCUMENT_LINK:DataPointApi.md#getDataPointNumber) + + +## **getDataPointNumber** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getDataPointNumber_v2) + +[//]: # (START_OVERVIEW) + +> BigDecimal getDataPointNumber(identifier, tag) + +#### Data Point (Number) + + +Returns a numeric value for the given `tag` and the entity with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + DataPointApi dataPointApi = new DataPointApi(); + + String identifier = "AAPL"; // String | An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) + String tag = "marketcap"; // String | An Intrinio data tag ID or code (reference) + + try { + BigDecimal result = dataPointApi.getDataPointNumber(identifier, tag); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DataPointApi#getDataPointNumber"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) |   + **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**BigDecimal**](BigDecimal.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:DataPointApi) + +[//]: # (METHOD:getDataPointText) + +[//]: # (RETURN_TYPE:String) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:getDataPointText_v2) + +[//]: # (ENDPOINT:/data_point/{identifier}/{tag}/text) + +[//]: # (DOCUMENT_LINK:DataPointApi.md#getDataPointText) + + +## **getDataPointText** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getDataPointText_v2) + +[//]: # (START_OVERVIEW) + +> String getDataPointText(identifier, tag) + +#### Data Point (Text) + + +Returns a text value for the given `tag` for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + DataPointApi dataPointApi = new DataPointApi(); + + String identifier = "AAPL"; // String | An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) + String tag = "ceo"; // String | An Intrinio data tag ID or code (reference) + + try { + String result = dataPointApi.getDataPointText(identifier, tag); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DataPointApi#getDataPointText"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) |   + **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +**String** + +[//]: # (END_OPERATION) + diff --git a/docs/DataTag.md b/docs/DataTag.md new file mode 100644 index 0000000..ae2a1c1 --- /dev/null +++ b/docs/DataTag.md @@ -0,0 +1,43 @@ + +[//]: # (CLASS:DataTag) + +[//]: # (KIND:object) + +### DataTag + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for the Data Tag   +**name** | String | The readable name of the Data Tag   +**tag** | String | The code-name of the Data Tag   +**statementCode** | String | The code of the financial statement to which this Data Tag belongs   +**statementType** | StatementTypeEnum | The format of the financial statment to which this Data Tag belongs   +**parent** | String | The parent Data Tag forming the statement relationship with the factor   +**sequence** | [**BigDecimal**](BigDecimal.md) | The order in which the Data Tag appears in its logical group (such as a financial statement)   +**factor** | String | The operator forming the statement relationship between the child Data Tag (or Data Tags) and the parent Data Tag   +**balance** | String | Whether the Data Tag represents a credit or debit   +**type** | String | The nature of the Data Tag, operating or nonoperating   +**unit** | String | The unit of the Data Tag   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + +
+ +#### Enum: StatementTypeEnum + +Name | Value +---- | ----- +FINANCIAL | "financial" +INDUSTRIAL | "industrial" + + + diff --git a/docs/DataTagApi.md b/docs/DataTagApi.md new file mode 100644 index 0000000..16a1459 --- /dev/null +++ b/docs/DataTagApi.md @@ -0,0 +1,295 @@ +# DataTagApi + +All URIs are relative to *https://api-v2.intrinio.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAllDataTags**](DataTagApi.md#getAllDataTags) | **GET** /data_tags | All Data Tags +[**getDataTagById**](DataTagApi.md#getDataTagById) | **GET** /data_tags/{identifier} | Lookup Data Tag +[**searchDataTags**](DataTagApi.md#searchDataTags) | **GET** /data_tags/search | Search Data Tags + + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:DataTagApi) + +[//]: # (METHOD:getAllDataTags) + +[//]: # (RETURN_TYPE:ApiResponseDataTags) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseDataTags.md) + +[//]: # (OPERATION:getAllDataTags_v2) + +[//]: # (ENDPOINT:/data_tags) + +[//]: # (DOCUMENT_LINK:DataTagApi.md#getAllDataTags) + + +## **getAllDataTags** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getAllDataTags_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseDataTags getAllDataTags(tag, type, parent, statementCode, fsTemplate, pageSize, nextPage) + +#### All Data Tags + + +Returns all Data Tags. Returns Data Tags matching parameters when specified. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + DataTagApi dataTagApi = new DataTagApi(); + + String tag = null; // String | Tag + String type = null; // String | Type + String parent = null; // String | ID of tag parent + String statementCode = "income_statement"; // String | Statement Code + String fsTemplate = "industrial"; // String | Template + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseDataTags result = dataTagApi.getAllDataTags(tag, type, parent, statementCode, fsTemplate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DataTagApi#getAllDataTags"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tag** | String| Tag | [optional]   + **type** | String| Type | [optional]   + **parent** | String| ID of tag parent | [optional]   + **statementCode** | String| Statement Code | [optional] [enum: income_statement, balance_sheet_statement, cash_flow_statement, calculations]   + **fsTemplate** | String| Template | [optional] [default to industrial] [enum: industrial, financial]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseDataTags**](ApiResponseDataTags.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:DataTagApi) + +[//]: # (METHOD:getDataTagById) + +[//]: # (RETURN_TYPE:DataTag) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:DataTag.md) + +[//]: # (OPERATION:getDataTagById_v2) + +[//]: # (ENDPOINT:/data_tags/{identifier}) + +[//]: # (DOCUMENT_LINK:DataTagApi.md#getDataTagById) + + +## **getDataTagById** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getDataTagById_v2) + +[//]: # (START_OVERVIEW) + +> DataTag getDataTagById(identifier) + +#### Lookup Data Tag + + +Returns the Data Tag with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + DataTagApi dataTagApi = new DataTagApi(); + + String identifier = "marketcap"; // String | The Intrinio ID or the code-name of the Data Tag + + try { + DataTag result = dataTagApi.getDataTagById(identifier); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DataTagApi#getDataTagById"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| The Intrinio ID or the code-name of the Data Tag |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**DataTag**](DataTag.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:DataTagApi) + +[//]: # (METHOD:searchDataTags) + +[//]: # (RETURN_TYPE:ApiResponseDataTagsSearch) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseDataTagsSearch.md) + +[//]: # (OPERATION:searchDataTags_v2) + +[//]: # (ENDPOINT:/data_tags/search) + +[//]: # (DOCUMENT_LINK:DataTagApi.md#searchDataTags) + + +## **searchDataTags** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/searchDataTags_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseDataTagsSearch searchDataTags(query, pageSize) + +#### Search Data Tags + + +Searches for Data Tags matching the text `query` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + DataTagApi dataTagApi = new DataTagApi(); + + String query = "revenue"; // String | + Integer pageSize = 100; // Integer | The number of results to return + + try { + ApiResponseDataTagsSearch result = dataTagApi.searchDataTags(query, pageSize); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling DataTagApi#searchDataTags"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | String| |   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseDataTagsSearch**](ApiResponseDataTagsSearch.md) + +[//]: # (END_OPERATION) + diff --git a/docs/DataTagSummary.md b/docs/DataTagSummary.md new file mode 100644 index 0000000..e32c591 --- /dev/null +++ b/docs/DataTagSummary.md @@ -0,0 +1,31 @@ + +[//]: # (CLASS:DataTagSummary) + +[//]: # (KIND:object) + +### DataTagSummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for the Data Tag   +**name** | String | The readable name of the Data Tag   +**tag** | String | The code-name of the Data Tag   +**parent** | String | The parent Data Tag forming the statement relationship with the factor   +**sequence** | [**BigDecimal**](BigDecimal.md) | The order in which the Data Tag appears in its logical group (such as a financial statement)   +**factor** | String | The operator forming the statement relationship between the child Data Tag (or Data Tags) and the parent Data Tag   +**balance** | String | Whether the Data Tag represents a credit or debit   +**unit** | String | The unit of the Data Tag   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/DetrendedPriceOscillatorTechnicalValue.md b/docs/DetrendedPriceOscillatorTechnicalValue.md new file mode 100644 index 0000000..c2cf46e --- /dev/null +++ b/docs/DetrendedPriceOscillatorTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:DetrendedPriceOscillatorTechnicalValue) + +[//]: # (KIND:object) + +### DetrendedPriceOscillatorTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**dpo** | Float | The Detrended Price Oscillator calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/DividendRecord.md b/docs/DividendRecord.md new file mode 100644 index 0000000..964dbfc --- /dev/null +++ b/docs/DividendRecord.md @@ -0,0 +1,66 @@ + +[//]: # (CLASS:DividendRecord) + +[//]: # (KIND:object) + +### DividendRecord + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**exDividend** | [**BigDecimal**](BigDecimal.md) | Amount of dividend in US dollars   +**currency** | String | The 3-digit currency code the dividend amount was reported in   +**announcementDate** | [**LocalDate**](LocalDate.md) | Date dividend was announced   +**recordDate** | [**LocalDate**](LocalDate.md) | Date before which holders-of-record will receive the dividend   +**payDate** | [**LocalDate**](LocalDate.md) | Date the divdiend was paid   +**frequency** | String | Identifies payment frequency of announced dividend   +**status** | StatusEnum | Status of the dividend   +**forwardYield** | [**BigDecimal**](BigDecimal.md) | The forward dividend yield   +**forwardRate** | [**BigDecimal**](BigDecimal.md) | The forward dividend rate   +**lastExDividendDate** | [**LocalDate**](LocalDate.md) | The last reported day the stock starts trading without the value of its next dividend payment   +**security** | [**SecuritySummary**](SecuritySummary.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + +
+ +#### Enum: StatusEnum + +Name | Value +---- | ----- +P | "P" +X | "X" +S | "S" +R | "R" + + + diff --git a/docs/DonchianChannelTechnicalValue.md b/docs/DonchianChannelTechnicalValue.md new file mode 100644 index 0000000..dac6f49 --- /dev/null +++ b/docs/DonchianChannelTechnicalValue.md @@ -0,0 +1,26 @@ + +[//]: # (CLASS:DonchianChannelTechnicalValue) + +[//]: # (KIND:object) + +### DonchianChannelTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**lowerBound** | Float | The lower bound value of the Donchian Channel calculation   +**upperBound** | Float | The upper bound value of the Donchian Channel calculation   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/EarningsRecord.md b/docs/EarningsRecord.md new file mode 100644 index 0000000..e376367 --- /dev/null +++ b/docs/EarningsRecord.md @@ -0,0 +1,104 @@ + +[//]: # (CLASS:EarningsRecord) + +[//]: # (KIND:object) + +### EarningsRecord + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**quarter** | String | The letter “Q” followed by the quarter number the earnings information applies to   +**timeOfDay** | TimeOfDayEnum | Indicates the time of the announcement   +**broadcastUrl** | String | Link for Conference Call recording   +**transcriptUrl** | String | Link to the earnings release transcript   +**transcriptQuarter** | String | The letter “Q” followed by the quarter number the earnings transcript applies to   +**transcriptFiscalYear** | String | Fiscal year in YYYY format for the earnings transcript   +**conferenceCallDate** | [**LocalDate**](LocalDate.md) | Date of the conference call   +**conferenceCallTime** | String | Published time of the conference call   +**conferenceCallPhoneNumber** | String | Publicly available phone number for replay conference call   +**conferenceCallPasscode** | String | Passcode for replay conference call   +**lastConfirmationDate** | [**LocalDate**](LocalDate.md) | Date of last earnings date update by a WSH analyst   +**boardOfDirectorsMeetingDate** | [**LocalDate**](LocalDate.md) | Date of Board/Shareholder Meeting   +**boardOfDirectorsMeetingType** | BoardOfDirectorsMeetingTypeEnum | The type of meeting - \"B\" indicates a Board of Directors meeting and \"S\" indicates a Shareholder meeting   +**companyWebsite** | String | Website link for the company   +**q1Date** | [**LocalDate**](LocalDate.md) | Earnings Date for 1st quarter   +**q2Date** | [**LocalDate**](LocalDate.md) | Earnings Date for 2nd quarter   +**q3Date** | [**LocalDate**](LocalDate.md) | Earnings Date for 3rd quarter   +**q4Date** | [**LocalDate**](LocalDate.md) | Earnings Date for 4th quarter   +**type** | TypeEnum | The nature of the next reported earnings date - \"V\" indicates a Verified date, \"T\" indicates that the date was gathered from the company, but is still considered Tentative, and \"I\" indicates that the date is forecased or Inferred   +**nextEarningsDate** | [**LocalDate**](LocalDate.md) | Next earnings date   +**nextEarningsQuarter** | String | The quarter of the next earnings release   +**nextEarningsFiscalYear** | Integer | The fiscal year associated with next earnings date and next earnings quarter   +**preliminaryEarningsDate** | [**LocalDate**](LocalDate.md) | The release date of a preliminary earnings report   +**security** | [**SecuritySummary**](SecuritySummary.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + +
+ +#### Enum: TimeOfDayEnum + +Name | Value +---- | ----- +BEFORE_MARKET | "Before Market" +DURING_MARKET | "During Market" +AFTER_MARKET | "After Market" +UNSPECIFIED | "Unspecified" + +
+ +#### Enum: BoardOfDirectorsMeetingTypeEnum + +Name | Value +---- | ----- +B | "B" +S | "S" + +
+ +#### Enum: TypeEnum + +Name | Value +---- | ----- +V | "V" +T | "T" +I | "I" + + + diff --git a/docs/EaseOfMovementTechnicalValue.md b/docs/EaseOfMovementTechnicalValue.md new file mode 100644 index 0000000..0c29c48 --- /dev/null +++ b/docs/EaseOfMovementTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:EaseOfMovementTechnicalValue) + +[//]: # (KIND:object) + +### EaseOfMovementTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**eom** | Float | The Ease of Movement calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/EconomicIndex.md b/docs/EconomicIndex.md new file mode 100644 index 0000000..2a5ee75 --- /dev/null +++ b/docs/EconomicIndex.md @@ -0,0 +1,41 @@ + +[//]: # (CLASS:EconomicIndex) + +[//]: # (KIND:object) + +### EconomicIndex + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for the Index   +**symbol** | String | The symbol used to identify the Index   +**name** | String | The name of the Index   +**continent** | String | The continent of the country of focus for the Index   +**country** | String | The country of focus for the Index   +**updateFrequency** | String | How often the Index is updated   +**lastUpdated** | [**OffsetDateTime**](OffsetDateTime.md) | When the Index was updated last   +**description** | String | A paragraph describing the index and its scope   +**observationStart** | [**LocalDate**](LocalDate.md) | The earliest date for which data is available   +**observationEnd** | [**LocalDate**](LocalDate.md) | The latest date for which data is available   +**seasonalAdjustment** | String | Whether the data is adjusted to account for seasonality   +**units** | String | The units of the data   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + + + + diff --git a/docs/EconomicIndexSummary.md b/docs/EconomicIndexSummary.md new file mode 100644 index 0000000..b57b822 --- /dev/null +++ b/docs/EconomicIndexSummary.md @@ -0,0 +1,40 @@ + +[//]: # (CLASS:EconomicIndexSummary) + +[//]: # (KIND:object) + +### EconomicIndexSummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for the Index   +**symbol** | String | The symbol used to identify the Index   +**name** | String | The name of the Index   +**continent** | String | The continent of the country of focus for the Index   +**country** | String | The country of focus for the Index   +**updateFrequency** | String | How often the Index is updated   +**lastUpdated** | [**OffsetDateTime**](OffsetDateTime.md) | When the Index was updated last   +**observationStart** | [**LocalDate**](LocalDate.md) | The earliest date for which data is available   +**observationEnd** | [**LocalDate**](LocalDate.md) | The latest date for which data is available   +**seasonalAdjustment** | String | Whether the data is adjusted to account for seasonality   +**units** | String | The units of the data   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + + + + diff --git a/docs/Filing.md b/docs/Filing.md new file mode 100644 index 0000000..4c38cfe --- /dev/null +++ b/docs/Filing.md @@ -0,0 +1,45 @@ + +[//]: # (CLASS:Filing) + +[//]: # (KIND:object) + +### Filing + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID of the Filing   +**filingDate** | [**LocalDate**](LocalDate.md) | The date when the filing was submitted to the SEC by the company   +**acceptedDate** | [**OffsetDateTime**](OffsetDateTime.md) | The date and time when the filing was accepted by SEC   +**periodEndDate** | [**LocalDate**](LocalDate.md) | The ending date of the fiscal period for the filing   +**reportType** | String | The filing <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report type</a>   +**secUniqueId** | String | A unique identifier for the filing provided by the SEC   +**filingUrl** | String | The URL to the filing page on the SEC site   +**reportUrl** | String | The URL to the actual report on the SEC site   +**instanceUrl** | String | The URL for the XBRL filing for the report   +**industryCategory** | String | The company's operating industry category   +**industryGroup** | String | The company's operating industry group   +**wordCount** | Integer | The number of words in the filing   +**company** | [**CompanySummary**](CompanySummary.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:CompanySummary) + + + + + diff --git a/docs/FilingApi.md b/docs/FilingApi.md new file mode 100644 index 0000000..f00e690 --- /dev/null +++ b/docs/FilingApi.md @@ -0,0 +1,963 @@ +# FilingApi + +All URIs are relative to *https://api-v2.intrinio.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAllFilings**](FilingApi.md#getAllFilings) | **GET** /filings | All Filings +[**getAllNotes**](FilingApi.md#getAllNotes) | **GET** /filings/notes | All Filing Notes +[**getFilingById**](FilingApi.md#getFilingById) | **GET** /filings/{id} | Lookup Filing +[**getFilingFundamentals**](FilingApi.md#getFilingFundamentals) | **GET** /filings/{identifier}/fundamentals | All Fundamentals by Filing +[**getFilingHtml**](FilingApi.md#getFilingHtml) | **GET** /filings/{identifier}/html | Filing Html +[**getFilingText**](FilingApi.md#getFilingText) | **GET** /filings/{identifier}/text | Filing Text +[**getNote**](FilingApi.md#getNote) | **GET** /filings/notes/{identifier} | Filing Note by ID +[**getNoteHtml**](FilingApi.md#getNoteHtml) | **GET** /filings/notes/{identifier}/html | Filing Note HTML +[**getNoteText**](FilingApi.md#getNoteText) | **GET** /filings/notes/{identifier}/text | Filing Note Text +[**searchNotes**](FilingApi.md#searchNotes) | **GET** /filings/notes/search | Search Filing Notes + + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:FilingApi) + +[//]: # (METHOD:getAllFilings) + +[//]: # (RETURN_TYPE:ApiResponseFilings) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseFilings.md) + +[//]: # (OPERATION:getAllFilings_v2) + +[//]: # (ENDPOINT:/filings) + +[//]: # (DOCUMENT_LINK:FilingApi.md#getAllFilings) + + +## **getAllFilings** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getAllFilings_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseFilings getAllFilings(company, reportType, startDate, endDate, industryCategory, industryGroup, pageSize, nextPage) + +#### All Filings + + +Returns all Filings. Returns Filings matching parameters when supplied. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + FilingApi filingApi = new FilingApi(); + + String company = "AAPL"; // String | Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID) + String reportType = null; // String | Filter by report type. Separate values with commas to return multiple The filing report types. + LocalDate startDate = LocalDate.now(); // LocalDate | Filed on or after the given date + LocalDate endDate = LocalDate.now(); // LocalDate | Filed before or after the given date + String industryCategory = null; // String | Return companies in the given industry category + String industryGroup = null; // String | Return companies in the given industry group + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseFilings result = filingApi.getAllFilings(company, reportType, startDate, endDate, industryCategory, industryGroup, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FilingApi#getAllFilings"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **company** | String| Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID) |   + **reportType** | String| Filter by report type. Separate values with commas to return multiple The filing <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report types</a>. | [optional]   + **startDate** | LocalDate| Filed on or after the given date | [optional]   + **endDate** | LocalDate| Filed before or after the given date | [optional]   + **industryCategory** | String| Return companies in the given industry category | [optional]   + **industryGroup** | String| Return companies in the given industry group | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseFilings**](ApiResponseFilings.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:FilingApi) + +[//]: # (METHOD:getAllNotes) + +[//]: # (RETURN_TYPE:ApiResponseFilingNotes) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseFilingNotes.md) + +[//]: # (OPERATION:getAllNotes_v2) + +[//]: # (ENDPOINT:/filings/notes) + +[//]: # (DOCUMENT_LINK:FilingApi.md#getAllNotes) + + +## **getAllNotes** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getAllNotes_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseFilingNotes getAllNotes(company, reportType, filingStartDate, filingEndDate, periodEndedStartDate, periodEndedEndDate, pageSize, nextPage) + +#### All Filing Notes + + +Return all Notes from all Filings, most-recent first. Returns notes matching parameters when supplied. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + FilingApi filingApi = new FilingApi(); + + String company = "AAPL"; // String | A Company identifier (Ticker, CIK, LEI, Intrinio ID) + String reportType = "10-Q"; // String | Notes contained in filings that match the given report type + LocalDate filingStartDate = LocalDate.now(); // LocalDate | Limit search to filings on or after this date + LocalDate filingEndDate = LocalDate.now(); // LocalDate | Limit search to filings on or before this date + LocalDate periodEndedStartDate = LocalDate.now(); // LocalDate | Limit search to filings with a period end date on or after this date + LocalDate periodEndedEndDate = LocalDate.now(); // LocalDate | Limit search to filings with a period end date on or before this date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseFilingNotes result = filingApi.getAllNotes(company, reportType, filingStartDate, filingEndDate, periodEndedStartDate, periodEndedEndDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FilingApi#getAllNotes"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **company** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | [optional]   + **reportType** | String| Notes contained in filings that match the given <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report type</a> | [optional] [enum: 10-Q, 10-K]   + **filingStartDate** | LocalDate| Limit search to filings on or after this date | [optional]   + **filingEndDate** | LocalDate| Limit search to filings on or before this date | [optional]   + **periodEndedStartDate** | LocalDate| Limit search to filings with a period end date on or after this date | [optional]   + **periodEndedEndDate** | LocalDate| Limit search to filings with a period end date on or before this date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseFilingNotes**](ApiResponseFilingNotes.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:FilingApi) + +[//]: # (METHOD:getFilingById) + +[//]: # (RETURN_TYPE:Filing) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:Filing.md) + +[//]: # (OPERATION:getFilingById_v2) + +[//]: # (ENDPOINT:/filings/{id}) + +[//]: # (DOCUMENT_LINK:FilingApi.md#getFilingById) + + +## **getFilingById** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getFilingById_v2) + +[//]: # (START_OVERVIEW) + +> Filing getFilingById(id) + +#### Lookup Filing + + +Returns the Filing with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + FilingApi filingApi = new FilingApi(); + + String id = "fil_7Kn2P6"; // String | The Intrinio ID of the Filing + + try { + Filing result = filingApi.getFilingById(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FilingApi#getFilingById"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | String| The Intrinio ID of the Filing |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**Filing**](Filing.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:FilingApi) + +[//]: # (METHOD:getFilingFundamentals) + +[//]: # (RETURN_TYPE:ApiResponseFilingFundamentals) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseFilingFundamentals.md) + +[//]: # (OPERATION:getFilingFundamentals_v2) + +[//]: # (ENDPOINT:/filings/{identifier}/fundamentals) + +[//]: # (DOCUMENT_LINK:FilingApi.md#getFilingFundamentals) + + +## **getFilingFundamentals** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getFilingFundamentals_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseFilingFundamentals getFilingFundamentals(identifier, statementCode, type, fiscalYear, fiscalPeriod, startDate, endDate, nextPage) + +#### All Fundamentals by Filing + + +Returns all Fundamentals for the SEC Filing with the given `identifier`. Returns Fundamentals matching parameters when supplied. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + FilingApi filingApi = new FilingApi(); + + String identifier = "fil_B73xBG"; // String | A Filing identifier + String statementCode = null; // String | Filters fundamentals by statement code + String type = null; // String | Filters fundamentals by type + Integer fiscalYear = null; // Integer | Filters fundamentals by fiscal year + String fiscalPeriod = null; // String | Filters fundamentals by fiscal period + LocalDate startDate = LocalDate.now(); // LocalDate | Returns fundamentals on or after the given date + LocalDate endDate = LocalDate.now(); // LocalDate | Returns fundamentals on or before the given date + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseFilingFundamentals result = filingApi.getFilingFundamentals(identifier, statementCode, type, fiscalYear, fiscalPeriod, startDate, endDate, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FilingApi#getFilingFundamentals"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Filing identifier |   + **statementCode** | String| Filters fundamentals by statement code | [optional] [enum: income_statement, balance_sheet_statement, cash_flow_statement, calculations]   + **type** | String| Filters fundamentals by type | [optional] [enum: QTR, YTD, FY, TTM]   + **fiscalYear** | Integer| Filters fundamentals by fiscal year | [optional]   + **fiscalPeriod** | String| Filters fundamentals by fiscal period | [optional] [enum: FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD, Q1TTM, Q2TTM, Q3TTM]   + **startDate** | LocalDate| Returns fundamentals on or after the given date | [optional]   + **endDate** | LocalDate| Returns fundamentals on or before the given date | [optional]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseFilingFundamentals**](ApiResponseFilingFundamentals.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:FilingApi) + +[//]: # (METHOD:getFilingHtml) + +[//]: # (RETURN_TYPE:String) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:getFilingHtml_v2) + +[//]: # (ENDPOINT:/filings/{identifier}/html) + +[//]: # (DOCUMENT_LINK:FilingApi.md#getFilingHtml) + + +## **getFilingHtml** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getFilingHtml_v2) + +[//]: # (START_OVERVIEW) + +> String getFilingHtml(identifier) + +#### Filing Html + + + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + FilingApi filingApi = new FilingApi(); + + String identifier = "fil_B73xBG"; // String | A Filing identifier + + try { + String result = filingApi.getFilingHtml(identifier); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FilingApi#getFilingHtml"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Filing identifier |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +**String** + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:FilingApi) + +[//]: # (METHOD:getFilingText) + +[//]: # (RETURN_TYPE:String) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:getFilingText_v2) + +[//]: # (ENDPOINT:/filings/{identifier}/text) + +[//]: # (DOCUMENT_LINK:FilingApi.md#getFilingText) + + +## **getFilingText** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getFilingText_v2) + +[//]: # (START_OVERVIEW) + +> String getFilingText(identifier) + +#### Filing Text + + + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + FilingApi filingApi = new FilingApi(); + + String identifier = "fil_B73xBG"; // String | A Filing identifier + + try { + String result = filingApi.getFilingText(identifier); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FilingApi#getFilingText"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Filing identifier |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +**String** + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:FilingApi) + +[//]: # (METHOD:getNote) + +[//]: # (RETURN_TYPE:FilingNote) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:FilingNote.md) + +[//]: # (OPERATION:getNote_v2) + +[//]: # (ENDPOINT:/filings/notes/{identifier}) + +[//]: # (DOCUMENT_LINK:FilingApi.md#getNote) + + +## **getNote** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getNote_v2) + +[//]: # (START_OVERVIEW) + +> FilingNote getNote(identifier, contentFormat) + +#### Filing Note by ID + + + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + FilingApi filingApi = new FilingApi(); + + String identifier = "xbn_ydK3QL"; // String | The Intrinio ID of the filing note + String contentFormat = "text"; // String | Returns content in html (as filed) or plain text + + try { + FilingNote result = filingApi.getNote(identifier, contentFormat); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FilingApi#getNote"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| The Intrinio ID of the filing note |   + **contentFormat** | String| Returns content in html (as filed) or plain text | [optional] [default to text] [enum: text, html]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**FilingNote**](FilingNote.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:FilingApi) + +[//]: # (METHOD:getNoteHtml) + +[//]: # (RETURN_TYPE:String) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:getNoteHtml_v2) + +[//]: # (ENDPOINT:/filings/notes/{identifier}/html) + +[//]: # (DOCUMENT_LINK:FilingApi.md#getNoteHtml) + + +## **getNoteHtml** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getNoteHtml_v2) + +[//]: # (START_OVERVIEW) + +> String getNoteHtml(identifier) + +#### Filing Note HTML + + + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + FilingApi filingApi = new FilingApi(); + + String identifier = "xbn_ydK3QL"; // String | The Intrinio ID of the filing note + + try { + String result = filingApi.getNoteHtml(identifier); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FilingApi#getNoteHtml"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| The Intrinio ID of the filing note |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +**String** + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:FilingApi) + +[//]: # (METHOD:getNoteText) + +[//]: # (RETURN_TYPE:String) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:getNoteText_v2) + +[//]: # (ENDPOINT:/filings/notes/{identifier}/text) + +[//]: # (DOCUMENT_LINK:FilingApi.md#getNoteText) + + +## **getNoteText** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getNoteText_v2) + +[//]: # (START_OVERVIEW) + +> String getNoteText(identifier) + +#### Filing Note Text + + + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + FilingApi filingApi = new FilingApi(); + + String identifier = "xbn_ydK3QL"; // String | The Intrinio ID of the filing note + + try { + String result = filingApi.getNoteText(identifier); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FilingApi#getNoteText"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| The Intrinio ID of the filing note |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +**String** + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:FilingApi) + +[//]: # (METHOD:searchNotes) + +[//]: # (RETURN_TYPE:ApiResponseFilingNotesSearch) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseFilingNotesSearch.md) + +[//]: # (OPERATION:searchNotes_v2) + +[//]: # (ENDPOINT:/filings/notes/search) + +[//]: # (DOCUMENT_LINK:FilingApi.md#searchNotes) + + +## **searchNotes** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/searchNotes_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseFilingNotesSearch searchNotes(query, filingStartDate, filingEndDate, pageSize) + +#### Search Filing Notes + + +Searches for Filing Notes using the `query` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + FilingApi filingApi = new FilingApi(); + + String query = "inflation"; // String | Search for notes that contain all or parts of this text + LocalDate filingStartDate = LocalDate.now(); // LocalDate | Limit search to filings on or after this date + LocalDate filingEndDate = LocalDate.now(); // LocalDate | Limit search to filings on or before this date + Integer pageSize = 100; // Integer | The number of results to return + + try { + ApiResponseFilingNotesSearch result = filingApi.searchNotes(query, filingStartDate, filingEndDate, pageSize); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FilingApi#searchNotes"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | String| Search for notes that contain all or parts of this text |   + **filingStartDate** | LocalDate| Limit search to filings on or after this date | [optional]   + **filingEndDate** | LocalDate| Limit search to filings on or before this date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseFilingNotesSearch**](ApiResponseFilingNotesSearch.md) + +[//]: # (END_OPERATION) + diff --git a/docs/FilingNote.md b/docs/FilingNote.md new file mode 100644 index 0000000..8df2fc8 --- /dev/null +++ b/docs/FilingNote.md @@ -0,0 +1,27 @@ + +[//]: # (CLASS:FilingNote) + +[//]: # (KIND:object) + +### FilingNote + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID of the note   +**xbrlTag** | String | The XBRL Tag used for the note   +**content** | String | The plain text (after html has been removed) of the note, or text including html if the content_format parameter has been set to html   +**filing** | [**FilingNoteFiling**](FilingNoteFiling.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:FilingNoteFiling) + + + + + diff --git a/docs/FilingNoteFiling.md b/docs/FilingNoteFiling.md new file mode 100644 index 0000000..c6f6f17 --- /dev/null +++ b/docs/FilingNoteFiling.md @@ -0,0 +1,30 @@ + +[//]: # (CLASS:FilingNoteFiling) + +[//]: # (KIND:object) + +### FilingNoteFiling + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**cik** | String | The Central Index Key (CIK) assigned to the company   +**reportType** | String | The filing <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report type</a>   +**periodEndDate** | [**LocalDate**](LocalDate.md) | The ending date of the fiscal period for the filing   +**filingDate** | [**LocalDate**](LocalDate.md) | The date the report was filed with the SEC   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + + + + diff --git a/docs/FilingNoteSummary.md b/docs/FilingNoteSummary.md new file mode 100644 index 0000000..13b3b50 --- /dev/null +++ b/docs/FilingNoteSummary.md @@ -0,0 +1,26 @@ + +[//]: # (CLASS:FilingNoteSummary) + +[//]: # (KIND:object) + +### FilingNoteSummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID of the note   +**xbrlTag** | String | The XBRL tag used for the note by the filing entity   +**filing** | [**FilingNoteFiling**](FilingNoteFiling.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:FilingNoteFiling) + + + + + diff --git a/docs/FilingSummary.md b/docs/FilingSummary.md new file mode 100644 index 0000000..1c2e57c --- /dev/null +++ b/docs/FilingSummary.md @@ -0,0 +1,38 @@ + +[//]: # (CLASS:FilingSummary) + +[//]: # (KIND:object) + +### FilingSummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID of the Filing   +**filingDate** | [**LocalDate**](LocalDate.md) | The date when the filing was submitted to the SEC by the company   +**acceptedDate** | [**OffsetDateTime**](OffsetDateTime.md) | The date and time when the filing was accepted by SEC   +**periodEndDate** | [**LocalDate**](LocalDate.md) | The ending date of the fiscal period for the filing   +**reportType** | String | The filing <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report type</a>   +**secUniqueId** | String | A unique identifier for the filing provided by the SEC   +**filingUrl** | String | The URL to the filing page on the SEC site   +**reportUrl** | String | The URL to the actual report on the SEC site   +**instanceUrl** | String | The URL for the XBRL filing for the report   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + + + + diff --git a/docs/ForceIndexTechnicalValue.md b/docs/ForceIndexTechnicalValue.md new file mode 100644 index 0000000..08d23bd --- /dev/null +++ b/docs/ForceIndexTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:ForceIndexTechnicalValue) + +[//]: # (KIND:object) + +### ForceIndexTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**fi** | Float | The Force Index calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/ForexApi.md b/docs/ForexApi.md new file mode 100644 index 0000000..bf84ec4 --- /dev/null +++ b/docs/ForexApi.md @@ -0,0 +1,289 @@ +# ForexApi + +All URIs are relative to *https://api-v2.intrinio.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getForexCurrencies**](ForexApi.md#getForexCurrencies) | **GET** /forex/currencies | Forex Currencies +[**getForexPairs**](ForexApi.md#getForexPairs) | **GET** /forex/pairs | Forex Currency Pairs +[**getForexPrices**](ForexApi.md#getForexPrices) | **GET** /forex/prices/{pair}/{timeframe} | Forex Currency Prices + + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:ForexApi) + +[//]: # (METHOD:getForexCurrencies) + +[//]: # (RETURN_TYPE:ApiResponseForexCurrencies) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseForexCurrencies.md) + +[//]: # (OPERATION:getForexCurrencies_v2) + +[//]: # (ENDPOINT:/forex/currencies) + +[//]: # (DOCUMENT_LINK:ForexApi.md#getForexCurrencies) + + +## **getForexCurrencies** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getForexCurrencies_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseForexCurrencies getForexCurrencies() + +#### Forex Currencies + + +Returns a list of forex currencies for which prices are available. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + ForexApi forexApi = new ForexApi(); + + + try { + ApiResponseForexCurrencies result = forexApi.getForexCurrencies(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ForexApi#getForexCurrencies"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + +This endpoint does not need any parameter. +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseForexCurrencies**](ApiResponseForexCurrencies.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:ForexApi) + +[//]: # (METHOD:getForexPairs) + +[//]: # (RETURN_TYPE:ApiResponseForexPairs) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseForexPairs.md) + +[//]: # (OPERATION:getForexPairs_v2) + +[//]: # (ENDPOINT:/forex/pairs) + +[//]: # (DOCUMENT_LINK:ForexApi.md#getForexPairs) + + +## **getForexPairs** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getForexPairs_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseForexPairs getForexPairs() + +#### Forex Currency Pairs + + +Returns a list of currency pairs used to request foreign exchange (forex) market price data. The currency that is used as the reference is called quote currency and the currency that is quoted in relation is called the base currency. For example, in the pair code “EURGBP” with a price of 0.88, one Euro (base currency) can be exchanged for 0.88 British Pounds (quote currency). + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + ForexApi forexApi = new ForexApi(); + + + try { + ApiResponseForexPairs result = forexApi.getForexPairs(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ForexApi#getForexPairs"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + +This endpoint does not need any parameter. +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseForexPairs**](ApiResponseForexPairs.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:ForexApi) + +[//]: # (METHOD:getForexPrices) + +[//]: # (RETURN_TYPE:ApiResponseForexPrices) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseForexPrices.md) + +[//]: # (OPERATION:getForexPrices_v2) + +[//]: # (ENDPOINT:/forex/prices/{pair}/{timeframe}) + +[//]: # (DOCUMENT_LINK:ForexApi.md#getForexPrices) + + +## **getForexPrices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getForexPrices_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseForexPrices getForexPrices(pair, timeframe, timezone, startDate, startTime, endDate, endTime, pageSize, nextPage) + +#### Forex Currency Prices + + +Provides a list of forex price quotes for a given forex currency pair and timeframe. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + ForexApi forexApi = new ForexApi(); + + String pair = "EURUSD"; // String | The Forex Currency Pair code + String timeframe = "D1"; // String | The time interval for the quotes + String timezone = "UTC"; // String | Returns trading times in this timezone + LocalDate startDate = LocalDate.now(); // LocalDate | Return Forex Prices on or after this date + String startTime = null; // String | Return Forex Prices at or after this time (24-hour) + LocalDate endDate = LocalDate.now(); // LocalDate | Return Forex Prices on or before this date + String endTime = null; // String | Return Forex Prices at or before this time (24-hour) + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseForexPrices result = forexApi.getForexPrices(pair, timeframe, timezone, startDate, startTime, endDate, endTime, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ForexApi#getForexPrices"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pair** | String| The Forex Currency Pair code |   + **timeframe** | String| The time interval for the quotes | [enum: m1, m5, m15, m30, H1, H2, H3, H4, H6, H8, D1, W1, M1]   + **timezone** | String| Returns trading times in this timezone | [optional] [default to UTC] [enum: Africa/Algiers, Africa/Cairo, Africa/Casablanca, Africa/Harare, Africa/Johannesburg, Africa/Monrovia, Africa/Nairobi, America/Argentina/Buenos_Aires, America/Bogota, America/Caracas, America/Chicago, America/Chihuahua, America/Denver, America/Godthab, America/Guatemala, America/Guyana, America/Halifax, America/Indiana/Indianapolis, America/Juneau, America/La_Paz, America/Lima, America/Lima, America/Los_Angeles, America/Mazatlan, America/Mexico_City, America/Mexico_City, America/Monterrey, America/Montevideo, America/New_York, America/Phoenix, America/Regina, America/Santiago, America/Sao_Paulo, America/St_Johns, America/Tijuana, Asia/Almaty, Asia/Baghdad, Asia/Baku, Asia/Bangkok, Asia/Bangkok, Asia/Chongqing, Asia/Colombo, Asia/Dhaka, Asia/Dhaka, Asia/Hong_Kong, Asia/Irkutsk, Asia/Jakarta, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Karachi, Asia/Kathmandu, Asia/Kolkata, Asia/Kolkata, Asia/Kolkata, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuwait, Asia/Magadan, Asia/Muscat, Asia/Muscat, Asia/Novosibirsk, Asia/Rangoon, Asia/Riyadh, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tokyo, Asia/Tokyo, Asia/Tokyo, Asia/Ulaanbaatar, Asia/Urumqi, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Cape_Verde, Atlantic/South_Georgia, Australia/Adelaide, Australia/Brisbane, Australia/Darwin, Australia/Hobart, Australia/Melbourne, Australia/Melbourne, Australia/Perth, Australia/Sydney, Etc/UTC, UTC, Europe/Amsterdam, Europe/Athens, Europe/Belgrade, Europe/Berlin, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Copenhagen, Europe/Dublin, Europe/Helsinki, Europe/Istanbul, Europe/Kaliningrad, Europe/Kiev, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/London, Europe/Madrid, Europe/Minsk, Europe/Moscow, Europe/Moscow, Europe/Paris, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/Sarajevo, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Pacific/Apia, Pacific/Auckland, Pacific/Auckland, Pacific/Chatham, Pacific/Fakaofo, Pacific/Fiji, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Majuro, Pacific/Midway, Pacific/Midway, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Port_Moresby, Pacific/Tongatapu]   + **startDate** | LocalDate| Return Forex Prices on or after this date | [optional]   + **startTime** | String| Return Forex Prices at or after this time (24-hour) | [optional]   + **endDate** | LocalDate| Return Forex Prices on or before this date | [optional]   + **endTime** | String| Return Forex Prices at or before this time (24-hour) | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseForexPrices**](ApiResponseForexPrices.md) + +[//]: # (END_OPERATION) + diff --git a/docs/ForexCurrency.md b/docs/ForexCurrency.md new file mode 100644 index 0000000..982acf9 --- /dev/null +++ b/docs/ForexCurrency.md @@ -0,0 +1,23 @@ + +[//]: # (CLASS:ForexCurrency) + +[//]: # (KIND:object) + +### ForexCurrency + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**code** | String | The ISO 4217 currency code   +**name** | String | The name of the currency   +**country** | String | The country in which the currency is used   + +[//]: # (END_DEFINITION) + + + + + diff --git a/docs/ForexPair.md b/docs/ForexPair.md new file mode 100644 index 0000000..961e0a2 --- /dev/null +++ b/docs/ForexPair.md @@ -0,0 +1,23 @@ + +[//]: # (CLASS:ForexPair) + +[//]: # (KIND:object) + +### ForexPair + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**code** | String | The common code of the currency pair   +**baseCurrency** | String | The ISO 4217 currency code of the base currency   +**quoteCurrency** | String | The ISO 4217 currency code of the quote currency   + +[//]: # (END_DEFINITION) + + + + + diff --git a/docs/ForexPrice.md b/docs/ForexPrice.md new file mode 100644 index 0000000..8493671 --- /dev/null +++ b/docs/ForexPrice.md @@ -0,0 +1,30 @@ + +[//]: # (CLASS:ForexPrice) + +[//]: # (KIND:object) + +### ForexPrice + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**occurredAt** | String | The timestamp of the beginning of the timeframe. The open prices would be at this time, while close prices would be at this time plus the timeframe.   +**openBid** | Float | Open bid   +**highBid** | Float | High bid   +**lowBid** | Float | Low bid   +**closeBid** | Float | Close bid   +**openAsk** | Float | Open ask   +**highAsk** | Float | High ask   +**lowAsk** | Float | Low ask   +**closeAsk** | Float | Close ask   +**totalTicks** | Integer | Total ticks   + +[//]: # (END_DEFINITION) + + + + + diff --git a/docs/Fundamental.md b/docs/Fundamental.md new file mode 100644 index 0000000..9c91f94 --- /dev/null +++ b/docs/Fundamental.md @@ -0,0 +1,55 @@ + +[//]: # (CLASS:Fundamental) + +[//]: # (KIND:object) + +### Fundamental + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID of the Fundamental   +**statementCode** | String | The code of the financial statement that the Fundamental represents   +**fiscalYear** | [**BigDecimal**](BigDecimal.md) | The fiscal year   +**fiscalPeriod** | String | The fiscal period   +**type** | TypeEnum | The type of Fundamental   +**startDate** | [**LocalDate**](LocalDate.md) | The period start date   +**endDate** | [**LocalDate**](LocalDate.md) | The period start date   +**filingDate** | [**OffsetDateTime**](OffsetDateTime.md) | The date and time when the Fundamental was filed with the SEC   +**isLatest** | Boolean | Is this the latest fundamental available based on the company's most recent filings? Use the Lookup Fundamental endpoint to find the latest fundamental (<a href=\"https://docs.intrinio.com/documentation/web_api/lookup_fundamental_v2\" target=\"_blank\">reference</a>)   +**company** | [**CompanySummary**](CompanySummary.md) | The Company that the Fundamental was belongs to   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + +[//]: # (CONTAINED_CLASS:CompanySummary) + + + +
+ +#### Enum: TypeEnum + +Name | Value +---- | ----- +REPORTED | "reported" +RESTATED | "restated" +CALCULATED | "calculated" + + + diff --git a/docs/FundamentalSummary.md b/docs/FundamentalSummary.md new file mode 100644 index 0000000..b6be0a6 --- /dev/null +++ b/docs/FundamentalSummary.md @@ -0,0 +1,50 @@ + +[//]: # (CLASS:FundamentalSummary) + +[//]: # (KIND:object) + +### FundamentalSummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID of the Fundamental   +**statementCode** | String | The code of the financial statement that the Fundamental represents   +**fiscalYear** | [**BigDecimal**](BigDecimal.md) | The fiscal year   +**fiscalPeriod** | String | The fiscal period   +**type** | TypeEnum | The type of Fundamental   +**startDate** | [**LocalDate**](LocalDate.md) | The period start date   +**endDate** | [**LocalDate**](LocalDate.md) | The period start date   +**filingDate** | [**OffsetDateTime**](OffsetDateTime.md) | The date and time when the Fundamental was filed with the SEC   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + +
+ +#### Enum: TypeEnum + +Name | Value +---- | ----- +REPORTED | "reported" +RESTATED | "restated" +CALCULATED | "calculated" + + + diff --git a/docs/FundamentalsApi.md b/docs/FundamentalsApi.md new file mode 100644 index 0000000..72837ea --- /dev/null +++ b/docs/FundamentalsApi.md @@ -0,0 +1,378 @@ +# FundamentalsApi + +All URIs are relative to *https://api-v2.intrinio.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getFundamentalById**](FundamentalsApi.md#getFundamentalById) | **GET** /fundamentals/{id} | Fundamental by ID +[**getFundamentalReportedFinancials**](FundamentalsApi.md#getFundamentalReportedFinancials) | **GET** /fundamentals/{id}/reported_financials | Reported Financials +[**getFundamentalStandardizedFinancials**](FundamentalsApi.md#getFundamentalStandardizedFinancials) | **GET** /fundamentals/{id}/standardized_financials | Standardized Financials +[**lookupFundamental**](FundamentalsApi.md#lookupFundamental) | **GET** /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental + + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:FundamentalsApi) + +[//]: # (METHOD:getFundamentalById) + +[//]: # (RETURN_TYPE:Fundamental) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:Fundamental.md) + +[//]: # (OPERATION:getFundamentalById_v2) + +[//]: # (ENDPOINT:/fundamentals/{id}) + +[//]: # (DOCUMENT_LINK:FundamentalsApi.md#getFundamentalById) + + +## **getFundamentalById** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getFundamentalById_v2) + +[//]: # (START_OVERVIEW) + +> Fundamental getFundamentalById(id) + +#### Fundamental by ID + + +Returns detailed fundamental data for the given `id`. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + FundamentalsApi fundamentalsApi = new FundamentalsApi(); + + String id = "fun_ge9LlE"; // String | The Intrinio ID for the Fundamental + + try { + Fundamental result = fundamentalsApi.getFundamentalById(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FundamentalsApi#getFundamentalById"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | String| The Intrinio ID for the Fundamental |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**Fundamental**](Fundamental.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:FundamentalsApi) + +[//]: # (METHOD:getFundamentalReportedFinancials) + +[//]: # (RETURN_TYPE:ApiResponseReportedFinancials) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseReportedFinancials.md) + +[//]: # (OPERATION:getFundamentalReportedFinancials_v2) + +[//]: # (ENDPOINT:/fundamentals/{id}/reported_financials) + +[//]: # (DOCUMENT_LINK:FundamentalsApi.md#getFundamentalReportedFinancials) + + +## **getFundamentalReportedFinancials** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getFundamentalReportedFinancials_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseReportedFinancials getFundamentalReportedFinancials(id) + +#### Reported Financials + + +Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + FundamentalsApi fundamentalsApi = new FundamentalsApi(); + + String id = "AAPL-income_statement-2018-Q1"; // String | The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental + + try { + ApiResponseReportedFinancials result = fundamentalsApi.getFundamentalReportedFinancials(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FundamentalsApi#getFundamentalReportedFinancials"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | String| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseReportedFinancials**](ApiResponseReportedFinancials.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:FundamentalsApi) + +[//]: # (METHOD:getFundamentalStandardizedFinancials) + +[//]: # (RETURN_TYPE:ApiResponseStandardizedFinancials) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseStandardizedFinancials.md) + +[//]: # (OPERATION:getFundamentalStandardizedFinancials_v2) + +[//]: # (ENDPOINT:/fundamentals/{id}/standardized_financials) + +[//]: # (DOCUMENT_LINK:FundamentalsApi.md#getFundamentalStandardizedFinancials) + + +## **getFundamentalStandardizedFinancials** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getFundamentalStandardizedFinancials_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseStandardizedFinancials getFundamentalStandardizedFinancials(id) + +#### Standardized Financials + + +Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies' fundamentals. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + FundamentalsApi fundamentalsApi = new FundamentalsApi(); + + String id = "AAPL-income_statement-2018-Q1"; // String | The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental + + try { + ApiResponseStandardizedFinancials result = fundamentalsApi.getFundamentalStandardizedFinancials(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FundamentalsApi#getFundamentalStandardizedFinancials"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | String| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseStandardizedFinancials**](ApiResponseStandardizedFinancials.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:FundamentalsApi) + +[//]: # (METHOD:lookupFundamental) + +[//]: # (RETURN_TYPE:Fundamental) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:Fundamental.md) + +[//]: # (OPERATION:lookupFundamental_v2) + +[//]: # (ENDPOINT:/fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period}) + +[//]: # (DOCUMENT_LINK:FundamentalsApi.md#lookupFundamental) + + +## **lookupFundamental** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/lookupFundamental_v2) + +[//]: # (START_OVERVIEW) + +> Fundamental lookupFundamental(identifier, statementCode, fiscalYear, fiscalPeriod) + +#### Lookup Fundamental + + +Returns the Fundamental for the Company with the given `identifier` and with the given parameters + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + FundamentalsApi fundamentalsApi = new FundamentalsApi(); + + String identifier = "AAPL"; // String | A Company identifier (Ticker, CIK, LEI, Intrinio ID) + String statementCode = "income_statement"; // String | The statement code + Integer fiscalYear = 2017; // Integer | The fiscal year + String fiscalPeriod = "FY"; // String | The fiscal period + + try { + Fundamental result = fundamentalsApi.lookupFundamental(identifier, statementCode, fiscalYear, fiscalPeriod); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling FundamentalsApi#lookupFundamental"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   + **statementCode** | String| The statement code | [enum: income_statement, balance_sheet_statement, cash_flow_statement, calculations]   + **fiscalYear** | Integer| The fiscal year |   + **fiscalPeriod** | String| The fiscal period | [enum: Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**Fundamental**](Fundamental.md) + +[//]: # (END_OPERATION) + diff --git a/docs/HistoricalData.md b/docs/HistoricalData.md new file mode 100644 index 0000000..f680117 --- /dev/null +++ b/docs/HistoricalData.md @@ -0,0 +1,28 @@ + +[//]: # (CLASS:HistoricalData) + +[//]: # (KIND:object) + +### HistoricalData + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**date** | [**LocalDate**](LocalDate.md) | The date that the value is present   +**value** | [**BigDecimal**](BigDecimal.md) | The historical value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/HistoricalDataApi.md b/docs/HistoricalDataApi.md new file mode 100644 index 0000000..9dc1b09 --- /dev/null +++ b/docs/HistoricalDataApi.md @@ -0,0 +1,115 @@ +# HistoricalDataApi + +All URIs are relative to *https://api-v2.intrinio.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getHistoricalData**](HistoricalDataApi.md#getHistoricalData) | **GET** /historical_data/{identifier}/{tag} | Historical Data + + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:HistoricalDataApi) + +[//]: # (METHOD:getHistoricalData) + +[//]: # (RETURN_TYPE:ApiResponseHistoricalData) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseHistoricalData.md) + +[//]: # (OPERATION:getHistoricalData_v2) + +[//]: # (ENDPOINT:/historical_data/{identifier}/{tag}) + +[//]: # (DOCUMENT_LINK:HistoricalDataApi.md#getHistoricalData) + + +## **getHistoricalData** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getHistoricalData_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseHistoricalData getHistoricalData(identifier, tag, frequency, type, startDate, endDate, sortOrder, pageSize, nextPage) + +#### Historical Data + + +Returns historical values for the given `tag` and the entity represented by the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + HistoricalDataApi historicalDataApi = new HistoricalDataApi(); + + String identifier = "AAPL"; // String | An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) + String tag = "marketcap"; // String | An Intrinio data tag ID or code (reference) + String frequency = "daily"; // String | Return historical data in the given frequency + String type = null; // String | Filter by type, when applicable + LocalDate startDate = LocalDate.now(); // LocalDate | Get historical data on or after this date + LocalDate endDate = LocalDate.now(); // LocalDate | Get historical date on or before this date + String sortOrder = "desc"; // String | Sort by date `asc` or `desc` + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseHistoricalData result = historicalDataApi.getHistoricalData(identifier, tag, frequency, type, startDate, endDate, sortOrder, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling HistoricalDataApi#getHistoricalData"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) |   + **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   + **frequency** | String| Return historical data in the given frequency | [optional] [default to daily] [enum: daily, weekly, monthly, quarterly, yearly]   + **type** | String| Filter by type, when applicable | [optional]   + **startDate** | LocalDate| Get historical data on or after this date | [optional]   + **endDate** | LocalDate| Get historical date on or before this date | [optional]   + **sortOrder** | String| Sort by date `asc` or `desc` | [optional] [default to desc] [enum: asc, desc]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseHistoricalData**](ApiResponseHistoricalData.md) + +[//]: # (END_OPERATION) + diff --git a/docs/IchimokuKinkoHyoTechnicalValue.md b/docs/IchimokuKinkoHyoTechnicalValue.md new file mode 100644 index 0000000..90fdfd6 --- /dev/null +++ b/docs/IchimokuKinkoHyoTechnicalValue.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:IchimokuKinkoHyoTechnicalValue) + +[//]: # (KIND:object) + +### IchimokuKinkoHyoTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**chikouSpan** | Float | The Chikou Span (Lagging Span) value of the Ichimoku Kinko Hyo calculation   +**kijunSen** | Float | The Kijun-sen (Base Line) value of the Ichimoku Kinko Hyo calculation   +**senkouSpanA** | Float | The Senkou Span A (Leading Span A) value of the Ichimoku Kinko Hyo calculation   +**senkouSpanB** | Float | The Senkou Span B (Leading Span B) value of the Ichimoku Kinko Hyo calculation   +**tenkanSen** | Float | The Tenskan-sen (Conversion Line) value of the Ichimoku Kinko Hyo calculation   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/IndexApi.md b/docs/IndexApi.md new file mode 100644 index 0000000..5cf693c --- /dev/null +++ b/docs/IndexApi.md @@ -0,0 +1,1706 @@ +# IndexApi + +All URIs are relative to *https://api-v2.intrinio.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAllEconomicIndices**](IndexApi.md#getAllEconomicIndices) | **GET** /indices/economic | All Economic Indices +[**getAllSicIndices**](IndexApi.md#getAllSicIndices) | **GET** /indices/sic | All SIC Indices +[**getAllStockMarketIndices**](IndexApi.md#getAllStockMarketIndices) | **GET** /indices/stock_market | All Stock Market Indices +[**getEconomicIndexById**](IndexApi.md#getEconomicIndexById) | **GET** /indices/economic/{identifier} | Lookup Economic Index +[**getEconomicIndexDataPointNumber**](IndexApi.md#getEconomicIndexDataPointNumber) | **GET** /indices/economic/{identifier}/data_point/{tag}/number | Data Point (Number) for an Economic Index +[**getEconomicIndexDataPointText**](IndexApi.md#getEconomicIndexDataPointText) | **GET** /indices/economic/{identifier}/data_point/{tag}/text | Data Point (Text) for an Economic Index +[**getEconomicIndexHistoricalData**](IndexApi.md#getEconomicIndexHistoricalData) | **GET** /indices/economic/{identifier}/historical_data/{tag} | Historical Data for an Economic Index +[**getSicIndexById**](IndexApi.md#getSicIndexById) | **GET** /indices/sic/{identifier} | Lookup SIC Index +[**getSicIndexDataPointNumber**](IndexApi.md#getSicIndexDataPointNumber) | **GET** /indices/sic/{identifier}/data_point/{tag}/number | Data Point (Number) for an SIC Index +[**getSicIndexDataPointText**](IndexApi.md#getSicIndexDataPointText) | **GET** /indices/sic/{identifier}/data_point/{tag}/text | Data Point (Text) for an SIC Index +[**getSicIndexHistoricalData**](IndexApi.md#getSicIndexHistoricalData) | **GET** /indices/sic/{identifier}/historical_data/{tag} | Historical Data for an SIC Index +[**getStockMarketIndexById**](IndexApi.md#getStockMarketIndexById) | **GET** /indices/stock_market/{identifier} | Lookup Stock Market Index +[**getStockMarketIndexDataPointNumber**](IndexApi.md#getStockMarketIndexDataPointNumber) | **GET** /indices/stock_market/{identifier}/data_point/{tag}/number | Data Point (Number) for Stock Market Index +[**getStockMarketIndexDataPointText**](IndexApi.md#getStockMarketIndexDataPointText) | **GET** /indices/stock_market/{identifier}/data_point/{tag}/text | Data Point (Text) for Stock Market Index +[**getStockMarketIndexHistoricalData**](IndexApi.md#getStockMarketIndexHistoricalData) | **GET** /indices/stock_market/{identifier}/historical_data/{tag} | Historical Data for Stock Market Index +[**searchEconomicIndices**](IndexApi.md#searchEconomicIndices) | **GET** /indices/economic/search | Search Economic Indices +[**searchSicIndices**](IndexApi.md#searchSicIndices) | **GET** /indices/sic/search | Search SIC Indices +[**searchStockMarketsIndices**](IndexApi.md#searchStockMarketsIndices) | **GET** /indices/stock_market/search | Search Stock Market Indices + + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:getAllEconomicIndices) + +[//]: # (RETURN_TYPE:ApiResponseEconomicIndices) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseEconomicIndices.md) + +[//]: # (OPERATION:getAllEconomicIndices_v2) + +[//]: # (ENDPOINT:/indices/economic) + +[//]: # (DOCUMENT_LINK:IndexApi.md#getAllEconomicIndices) + + +## **getAllEconomicIndices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getAllEconomicIndices_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseEconomicIndices getAllEconomicIndices(pageSize, nextPage) + +#### All Economic Indices + + + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseEconomicIndices result = indexApi.getAllEconomicIndices(pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#getAllEconomicIndices"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseEconomicIndices**](ApiResponseEconomicIndices.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:getAllSicIndices) + +[//]: # (RETURN_TYPE:ApiResponseSICIndices) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSICIndices.md) + +[//]: # (OPERATION:getAllSicIndices_v2) + +[//]: # (ENDPOINT:/indices/sic) + +[//]: # (DOCUMENT_LINK:IndexApi.md#getAllSicIndices) + + +## **getAllSicIndices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getAllSicIndices_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSICIndices getAllSicIndices(pageSize, nextPage) + +#### All SIC Indices + + + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSICIndices result = indexApi.getAllSicIndices(pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#getAllSicIndices"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSICIndices**](ApiResponseSICIndices.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:getAllStockMarketIndices) + +[//]: # (RETURN_TYPE:ApiResponseStockMarketIndices) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseStockMarketIndices.md) + +[//]: # (OPERATION:getAllStockMarketIndices_v2) + +[//]: # (ENDPOINT:/indices/stock_market) + +[//]: # (DOCUMENT_LINK:IndexApi.md#getAllStockMarketIndices) + + +## **getAllStockMarketIndices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getAllStockMarketIndices_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseStockMarketIndices getAllStockMarketIndices(pageSize, nextPage) + +#### All Stock Market Indices + + + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseStockMarketIndices result = indexApi.getAllStockMarketIndices(pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#getAllStockMarketIndices"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseStockMarketIndices**](ApiResponseStockMarketIndices.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:getEconomicIndexById) + +[//]: # (RETURN_TYPE:EconomicIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:EconomicIndex.md) + +[//]: # (OPERATION:getEconomicIndexById_v2) + +[//]: # (ENDPOINT:/indices/economic/{identifier}) + +[//]: # (DOCUMENT_LINK:IndexApi.md#getEconomicIndexById) + + +## **getEconomicIndexById** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getEconomicIndexById_v2) + +[//]: # (START_OVERVIEW) + +> EconomicIndex getEconomicIndexById(identifier) + +#### Lookup Economic Index + + + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + String identifier = "$GDP"; // String | An Index Identifier (symbol, Intrinio ID) + + try { + EconomicIndex result = indexApi.getEconomicIndexById(identifier); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#getEconomicIndexById"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| An Index Identifier (symbol, Intrinio ID) |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**EconomicIndex**](EconomicIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:getEconomicIndexDataPointNumber) + +[//]: # (RETURN_TYPE:BigDecimal) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:BigDecimal.md) + +[//]: # (OPERATION:getEconomicIndexDataPointNumber_v2) + +[//]: # (ENDPOINT:/indices/economic/{identifier}/data_point/{tag}/number) + +[//]: # (DOCUMENT_LINK:IndexApi.md#getEconomicIndexDataPointNumber) + + +## **getEconomicIndexDataPointNumber** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getEconomicIndexDataPointNumber_v2) + +[//]: # (START_OVERVIEW) + +> BigDecimal getEconomicIndexDataPointNumber(identifier, tag) + +#### Data Point (Number) for an Economic Index + + +Returns a numeric value for the given `tag` for the Economic Index with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + String identifier = "$GDP"; // String | An Index Identifier (symbol, Intrinio ID) + String tag = "level"; // String | An Intrinio data tag reference + + try { + BigDecimal result = indexApi.getEconomicIndexDataPointNumber(identifier, tag); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#getEconomicIndexDataPointNumber"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| An Index Identifier (symbol, Intrinio ID) |   + **tag** | String| An Intrinio data tag <a href='https://data.intrinio.com/data-tags/economic'>reference</a> |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**BigDecimal**](BigDecimal.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:getEconomicIndexDataPointText) + +[//]: # (RETURN_TYPE:String) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:getEconomicIndexDataPointText_v2) + +[//]: # (ENDPOINT:/indices/economic/{identifier}/data_point/{tag}/text) + +[//]: # (DOCUMENT_LINK:IndexApi.md#getEconomicIndexDataPointText) + + +## **getEconomicIndexDataPointText** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getEconomicIndexDataPointText_v2) + +[//]: # (START_OVERVIEW) + +> String getEconomicIndexDataPointText(identifier, tag) + +#### Data Point (Text) for an Economic Index + + +Returns a text value for the given `tag` for the Economic Index with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + String identifier = "$GDP"; // String | An Index Identifier (symbol, Intrinio ID) + String tag = "level"; // String | An Intrinio data tag ID or code-name + + try { + String result = indexApi.getEconomicIndexDataPointText(identifier, tag); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#getEconomicIndexDataPointText"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| An Index Identifier (symbol, Intrinio ID) |   + **tag** | String| An Intrinio data tag ID or code-name |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +**String** + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:getEconomicIndexHistoricalData) + +[//]: # (RETURN_TYPE:ApiResponseEconomicIndexHistoricalData) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseEconomicIndexHistoricalData.md) + +[//]: # (OPERATION:getEconomicIndexHistoricalData_v2) + +[//]: # (ENDPOINT:/indices/economic/{identifier}/historical_data/{tag}) + +[//]: # (DOCUMENT_LINK:IndexApi.md#getEconomicIndexHistoricalData) + + +## **getEconomicIndexHistoricalData** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getEconomicIndexHistoricalData_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseEconomicIndexHistoricalData getEconomicIndexHistoricalData(identifier, tag, type, startDate, endDate, sortOrder, pageSize, nextPage) + +#### Historical Data for an Economic Index + + +Returns historical values for the given `tag` and the Economic Index with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + String identifier = "$GDP"; // String | An Index Identifier (symbol, Intrinio ID) + String tag = "level"; // String | An Intrinio data tag reference + String type = null; // String | Filter by type, when applicable + LocalDate startDate = LocalDate.now(); // LocalDate | Get historical data on or after this date + LocalDate endDate = LocalDate.now(); // LocalDate | Get historical data on or before this date + String sortOrder = "desc"; // String | Sort by date `asc` or `desc` + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseEconomicIndexHistoricalData result = indexApi.getEconomicIndexHistoricalData(identifier, tag, type, startDate, endDate, sortOrder, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#getEconomicIndexHistoricalData"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| An Index Identifier (symbol, Intrinio ID) |   + **tag** | String| An Intrinio data tag <a href='https://data.intrinio.com/data-tags/economic'>reference</a> |   + **type** | String| Filter by type, when applicable | [optional]   + **startDate** | LocalDate| Get historical data on or after this date | [optional]   + **endDate** | LocalDate| Get historical data on or before this date | [optional]   + **sortOrder** | String| Sort by date `asc` or `desc` | [optional] [default to desc] [enum: asc, desc]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseEconomicIndexHistoricalData**](ApiResponseEconomicIndexHistoricalData.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:getSicIndexById) + +[//]: # (RETURN_TYPE:SICIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:SICIndex.md) + +[//]: # (OPERATION:getSicIndexById_v2) + +[//]: # (ENDPOINT:/indices/sic/{identifier}) + +[//]: # (DOCUMENT_LINK:IndexApi.md#getSicIndexById) + + +## **getSicIndexById** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSicIndexById_v2) + +[//]: # (START_OVERVIEW) + +> SICIndex getSicIndexById(identifier) + +#### Lookup SIC Index + + + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + String identifier = "$SIC.1"; // String | An Index Identifier (symbol, Intrinio ID) + + try { + SICIndex result = indexApi.getSicIndexById(identifier); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#getSicIndexById"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| An Index Identifier (symbol, Intrinio ID) |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**SICIndex**](SICIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:getSicIndexDataPointNumber) + +[//]: # (RETURN_TYPE:BigDecimal) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:BigDecimal.md) + +[//]: # (OPERATION:getSicIndexDataPointNumber_v2) + +[//]: # (ENDPOINT:/indices/sic/{identifier}/data_point/{tag}/number) + +[//]: # (DOCUMENT_LINK:IndexApi.md#getSicIndexDataPointNumber) + + +## **getSicIndexDataPointNumber** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSicIndexDataPointNumber_v2) + +[//]: # (START_OVERVIEW) + +> BigDecimal getSicIndexDataPointNumber(identifier, tag) + +#### Data Point (Number) for an SIC Index + + +Returns a numeric value for the given `tag` for the SIC Index with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + String identifier = "$SIC.1"; // String | An Index Identifier (symbol, Intrinio ID) + String tag = "level"; // String | An Intrinio data tag ID or code-name + + try { + BigDecimal result = indexApi.getSicIndexDataPointNumber(identifier, tag); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#getSicIndexDataPointNumber"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| An Index Identifier (symbol, Intrinio ID) |   + **tag** | String| An Intrinio data tag ID or code-name |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**BigDecimal**](BigDecimal.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:getSicIndexDataPointText) + +[//]: # (RETURN_TYPE:String) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:getSicIndexDataPointText_v2) + +[//]: # (ENDPOINT:/indices/sic/{identifier}/data_point/{tag}/text) + +[//]: # (DOCUMENT_LINK:IndexApi.md#getSicIndexDataPointText) + + +## **getSicIndexDataPointText** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSicIndexDataPointText_v2) + +[//]: # (START_OVERVIEW) + +> String getSicIndexDataPointText(identifier, tag) + +#### Data Point (Text) for an SIC Index + + +Returns a text value for the given `tag` for the SIC Index with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + String identifier = "$SIC.1"; // String | An Index Identifier (symbol, Intrinio ID) + String tag = "level"; // String | An Intrinio data tag ID or code-name + + try { + String result = indexApi.getSicIndexDataPointText(identifier, tag); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#getSicIndexDataPointText"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| An Index Identifier (symbol, Intrinio ID) |   + **tag** | String| An Intrinio data tag ID or code-name |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +**String** + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:getSicIndexHistoricalData) + +[//]: # (RETURN_TYPE:ApiResponseSICIndexHistoricalData) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSICIndexHistoricalData.md) + +[//]: # (OPERATION:getSicIndexHistoricalData_v2) + +[//]: # (ENDPOINT:/indices/sic/{identifier}/historical_data/{tag}) + +[//]: # (DOCUMENT_LINK:IndexApi.md#getSicIndexHistoricalData) + + +## **getSicIndexHistoricalData** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSicIndexHistoricalData_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSICIndexHistoricalData getSicIndexHistoricalData(identifier, tag, type, startDate, endDate, sortOrder, pageSize, nextPage) + +#### Historical Data for an SIC Index + + +Returns historical values for the given `tag` and the SIC Index with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + String identifier = "$SIC.1"; // String | An Index Identifier (symbol, Intrinio ID) + String tag = "marketcap"; // String | An Intrinio data tag ID or code-name + String type = null; // String | Filter by type, when applicable + LocalDate startDate = LocalDate.now(); // LocalDate | Get historical data on or after this date + LocalDate endDate = LocalDate.now(); // LocalDate | Get historical data on or before this date + String sortOrder = "desc"; // String | Sort by date `asc` or `desc` + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSICIndexHistoricalData result = indexApi.getSicIndexHistoricalData(identifier, tag, type, startDate, endDate, sortOrder, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#getSicIndexHistoricalData"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| An Index Identifier (symbol, Intrinio ID) |   + **tag** | String| An Intrinio data tag ID or code-name |   + **type** | String| Filter by type, when applicable | [optional]   + **startDate** | LocalDate| Get historical data on or after this date | [optional]   + **endDate** | LocalDate| Get historical data on or before this date | [optional]   + **sortOrder** | String| Sort by date `asc` or `desc` | [optional] [default to desc] [enum: asc, desc]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSICIndexHistoricalData**](ApiResponseSICIndexHistoricalData.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:getStockMarketIndexById) + +[//]: # (RETURN_TYPE:StockMarketIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:StockMarketIndex.md) + +[//]: # (OPERATION:getStockMarketIndexById_v2) + +[//]: # (ENDPOINT:/indices/stock_market/{identifier}) + +[//]: # (DOCUMENT_LINK:IndexApi.md#getStockMarketIndexById) + + +## **getStockMarketIndexById** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getStockMarketIndexById_v2) + +[//]: # (START_OVERVIEW) + +> StockMarketIndex getStockMarketIndexById(identifier) + +#### Lookup Stock Market Index + + + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + String identifier = "$DJI"; // String | An Index Identifier (symbol, Intrinio ID) + + try { + StockMarketIndex result = indexApi.getStockMarketIndexById(identifier); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#getStockMarketIndexById"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| An Index Identifier (symbol, Intrinio ID) |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**StockMarketIndex**](StockMarketIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:getStockMarketIndexDataPointNumber) + +[//]: # (RETURN_TYPE:BigDecimal) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:BigDecimal.md) + +[//]: # (OPERATION:getStockMarketIndexDataPointNumber_v2) + +[//]: # (ENDPOINT:/indices/stock_market/{identifier}/data_point/{tag}/number) + +[//]: # (DOCUMENT_LINK:IndexApi.md#getStockMarketIndexDataPointNumber) + + +## **getStockMarketIndexDataPointNumber** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getStockMarketIndexDataPointNumber_v2) + +[//]: # (START_OVERVIEW) + +> BigDecimal getStockMarketIndexDataPointNumber(identifier, tag) + +#### Data Point (Number) for Stock Market Index + + +Returns a numeric value for the given `tag` for the Stock Market Index with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + String identifier = "$DJI"; // String | An Index Identifier (symbol, Intrinio ID) + String tag = "level"; // String | An Intrinio data tag ID or code-name + + try { + BigDecimal result = indexApi.getStockMarketIndexDataPointNumber(identifier, tag); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#getStockMarketIndexDataPointNumber"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| An Index Identifier (symbol, Intrinio ID) |   + **tag** | String| An Intrinio data tag ID or code-name |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**BigDecimal**](BigDecimal.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:getStockMarketIndexDataPointText) + +[//]: # (RETURN_TYPE:String) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:getStockMarketIndexDataPointText_v2) + +[//]: # (ENDPOINT:/indices/stock_market/{identifier}/data_point/{tag}/text) + +[//]: # (DOCUMENT_LINK:IndexApi.md#getStockMarketIndexDataPointText) + + +## **getStockMarketIndexDataPointText** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getStockMarketIndexDataPointText_v2) + +[//]: # (START_OVERVIEW) + +> String getStockMarketIndexDataPointText(identifier, tag) + +#### Data Point (Text) for Stock Market Index + + +Returns a text value for the given `tag` for the Stock Market Index with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + String identifier = "$DJI"; // String | An Index Identifier (symbol, Intrinio ID) + String tag = "level"; // String | An Intrinio data tag ID or code-name + + try { + String result = indexApi.getStockMarketIndexDataPointText(identifier, tag); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#getStockMarketIndexDataPointText"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| An Index Identifier (symbol, Intrinio ID) |   + **tag** | String| An Intrinio data tag ID or code-name |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +**String** + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:getStockMarketIndexHistoricalData) + +[//]: # (RETURN_TYPE:ApiResponseStockMarketIndexHistoricalData) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseStockMarketIndexHistoricalData.md) + +[//]: # (OPERATION:getStockMarketIndexHistoricalData_v2) + +[//]: # (ENDPOINT:/indices/stock_market/{identifier}/historical_data/{tag}) + +[//]: # (DOCUMENT_LINK:IndexApi.md#getStockMarketIndexHistoricalData) + + +## **getStockMarketIndexHistoricalData** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getStockMarketIndexHistoricalData_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseStockMarketIndexHistoricalData getStockMarketIndexHistoricalData(identifier, tag, type, startDate, endDate, sortOrder, pageSize, nextPage) + +#### Historical Data for Stock Market Index + + +Returns historical values for the given `tag` and the Stock Market Index with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + String identifier = "$DJI"; // String | An Index Identifier (symbol, Intrinio ID) + String tag = "level"; // String | An Intrinio data tag ID or code-name + String type = null; // String | Filter by type, when applicable + LocalDate startDate = LocalDate.now(); // LocalDate | Get historical data on or after this date + LocalDate endDate = LocalDate.now(); // LocalDate | Get historical data on or before this date + String sortOrder = "desc"; // String | Sort by date `asc` or `desc` + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseStockMarketIndexHistoricalData result = indexApi.getStockMarketIndexHistoricalData(identifier, tag, type, startDate, endDate, sortOrder, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#getStockMarketIndexHistoricalData"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| An Index Identifier (symbol, Intrinio ID) |   + **tag** | String| An Intrinio data tag ID or code-name |   + **type** | String| Filter by type, when applicable | [optional]   + **startDate** | LocalDate| Get historical data on or after this date | [optional]   + **endDate** | LocalDate| Get historical data on or before this date | [optional]   + **sortOrder** | String| Sort by date `asc` or `desc` | [optional] [default to desc] [enum: asc, desc]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseStockMarketIndexHistoricalData**](ApiResponseStockMarketIndexHistoricalData.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:searchEconomicIndices) + +[//]: # (RETURN_TYPE:ApiResponseEconomicIndicesSearch) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseEconomicIndicesSearch.md) + +[//]: # (OPERATION:searchEconomicIndices_v2) + +[//]: # (ENDPOINT:/indices/economic/search) + +[//]: # (DOCUMENT_LINK:IndexApi.md#searchEconomicIndices) + + +## **searchEconomicIndices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/searchEconomicIndices_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseEconomicIndicesSearch searchEconomicIndices(query, pageSize) + +#### Search Economic Indices + + +Searches for indices using the text in `query` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + String query = "GDP"; // String | Search query + Integer pageSize = 100; // Integer | The number of results to return + + try { + ApiResponseEconomicIndicesSearch result = indexApi.searchEconomicIndices(query, pageSize); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#searchEconomicIndices"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | String| Search query |   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseEconomicIndicesSearch**](ApiResponseEconomicIndicesSearch.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:searchSicIndices) + +[//]: # (RETURN_TYPE:ApiResponseSICIndicesSearch) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSICIndicesSearch.md) + +[//]: # (OPERATION:searchSicIndices_v2) + +[//]: # (ENDPOINT:/indices/sic/search) + +[//]: # (DOCUMENT_LINK:IndexApi.md#searchSicIndices) + + +## **searchSicIndices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/searchSicIndices_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSICIndicesSearch searchSicIndices(query, pageSize) + +#### Search SIC Indices + + +Searches for indices using the text in `query` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + String query = "agriculture"; // String | Search query + Integer pageSize = 100; // Integer | The number of results to return + + try { + ApiResponseSICIndicesSearch result = indexApi.searchSicIndices(query, pageSize); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#searchSicIndices"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | String| Search query |   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSICIndicesSearch**](ApiResponseSICIndicesSearch.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:IndexApi) + +[//]: # (METHOD:searchStockMarketsIndices) + +[//]: # (RETURN_TYPE:ApiResponseStockMarketIndicesSearch) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseStockMarketIndicesSearch.md) + +[//]: # (OPERATION:searchStockMarketsIndices_v2) + +[//]: # (ENDPOINT:/indices/stock_market/search) + +[//]: # (DOCUMENT_LINK:IndexApi.md#searchStockMarketsIndices) + + +## **searchStockMarketsIndices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/searchStockMarketsIndices_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseStockMarketIndicesSearch searchStockMarketsIndices(query, pageSize) + +#### Search Stock Market Indices + + +Searches for indices using the text in `query` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + IndexApi indexApi = new IndexApi(); + + String query = "dow"; // String | Search query + Integer pageSize = 100; // Integer | The number of results to return + + try { + ApiResponseStockMarketIndicesSearch result = indexApi.searchStockMarketsIndices(query, pageSize); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling IndexApi#searchStockMarketsIndices"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | String| Search query |   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseStockMarketIndicesSearch**](ApiResponseStockMarketIndicesSearch.md) + +[//]: # (END_OPERATION) + diff --git a/docs/IntradayStockPrice.md b/docs/IntradayStockPrice.md new file mode 100644 index 0000000..c3cc827 --- /dev/null +++ b/docs/IntradayStockPrice.md @@ -0,0 +1,49 @@ + +[//]: # (CLASS:IntradayStockPrice) + +[//]: # (KIND:object) + +### IntradayStockPrice + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**time** | [**OffsetDateTime**](OffsetDateTime.md) | The timestamp that the `last_price` represents.   +**lastPrice** | [**BigDecimal**](BigDecimal.md) | The price of the last trade.   +**askPrice** | [**BigDecimal**](BigDecimal.md) | The price of the top ask order.   +**askSize** | [**BigDecimal**](BigDecimal.md) | The size of the top ask order.   +**bidPrice** | [**BigDecimal**](BigDecimal.md) | The price of the top bid order.   +**bidSize** | [**BigDecimal**](BigDecimal.md) | The size of the top bid order.   +**volume** | [**BigDecimal**](BigDecimal.md) | The number of shares exchanged during the trading day on the exchange.   +**source** | String | The source of the data.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/KeltnerChannelTechnicalValue.md b/docs/KeltnerChannelTechnicalValue.md new file mode 100644 index 0000000..f00e420 --- /dev/null +++ b/docs/KeltnerChannelTechnicalValue.md @@ -0,0 +1,27 @@ + +[//]: # (CLASS:KeltnerChannelTechnicalValue) + +[//]: # (KIND:object) + +### KeltnerChannelTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**lowerBand** | Float | The lower band value of the Keltner Channel calculation   +**middleBand** | Float | The middle band value of the Keltner Channel calculation   +**upperBand** | Float | The upper band value of the Keltner Channel calculation   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/KnowSureThingTechnicalValue.md b/docs/KnowSureThingTechnicalValue.md new file mode 100644 index 0000000..5a0545e --- /dev/null +++ b/docs/KnowSureThingTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:KnowSureThingTechnicalValue) + +[//]: # (KIND:object) + +### KnowSureThingTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**kst** | Float | The Know Sure Thing calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/MassIndexTechnicalValue.md b/docs/MassIndexTechnicalValue.md new file mode 100644 index 0000000..84ddb8c --- /dev/null +++ b/docs/MassIndexTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:MassIndexTechnicalValue) + +[//]: # (KIND:object) + +### MassIndexTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**mi** | Float | The Mass Index calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/MoneyFlowIndexTechnicalValue.md b/docs/MoneyFlowIndexTechnicalValue.md new file mode 100644 index 0000000..10d155e --- /dev/null +++ b/docs/MoneyFlowIndexTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:MoneyFlowIndexTechnicalValue) + +[//]: # (KIND:object) + +### MoneyFlowIndexTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**mfi** | Float | The Money Flow Index calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/MovingAverageConvergenceDivergenceTechnicalValue.md b/docs/MovingAverageConvergenceDivergenceTechnicalValue.md new file mode 100644 index 0000000..054e4db --- /dev/null +++ b/docs/MovingAverageConvergenceDivergenceTechnicalValue.md @@ -0,0 +1,27 @@ + +[//]: # (CLASS:MovingAverageConvergenceDivergenceTechnicalValue) + +[//]: # (KIND:object) + +### MovingAverageConvergenceDivergenceTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**macdHistogram** | Float | The histogram value of the Moving Average Convergence Divergence calculation   +**macdLine** | Float | The line value of the Moving Average Convergence Divergence calculation   +**signalLine** | Float | The signal line value of the Moving Average Convergence Divergence calculation   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/Municipality.md b/docs/Municipality.md new file mode 100644 index 0000000..dc4dce2 --- /dev/null +++ b/docs/Municipality.md @@ -0,0 +1,54 @@ + +[//]: # (CLASS:Municipality) + +[//]: # (KIND:object) + +### Municipality + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for Municipality   +**censusId** | [**BigDecimal**](BigDecimal.md) | The ID for the census   +**governmentName** | String | The government name of the Municipality   +**governmentType** | String | The type of government of the Municipality   +**primaryContactType** | String | The primary contact type of the Municipality   +**address1** | String | The first line of the address   +**address2** | String | The second line of the address (i.e. suite number)   +**city** | String | The city in which the Municipality is located in   +**state** | String | The state in which the Municipality is located in   +**zip** | String | The zip code in which the Municipality is located in   +**webSite** | String | The web site of the Municipality   +**population** | [**BigDecimal**](BigDecimal.md) | The population of the Municipality   +**populationAsOfYear** | [**BigDecimal**](BigDecimal.md) | The year from which the population of the Municipality was measured   +**enrollment** | [**BigDecimal**](BigDecimal.md) | The enrollment of the Municipality   +**enrollmentAsOfYear** | [**BigDecimal**](BigDecimal.md) | The year from which the enrollment of the Municipality was measured   +**areaName** | String | The name of the area of the Municipality   +**areaType** | String | The type of area of the Municipality   +**latitude** | Float | The latitude of the location of the Municipality   +**longitude** | Float | The longitude of the location of the Municipality   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/MunicipalityApi.md b/docs/MunicipalityApi.md new file mode 100644 index 0000000..d3b8118 --- /dev/null +++ b/docs/MunicipalityApi.md @@ -0,0 +1,306 @@ +# MunicipalityApi + +All URIs are relative to *https://api-v2.intrinio.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAllMunicipalities**](MunicipalityApi.md#getAllMunicipalities) | **GET** /municipalities | All Municipalities +[**getMunicipalityById**](MunicipalityApi.md#getMunicipalityById) | **GET** /municipalities/{id} | Municipality by ID +[**getMunicipalityFinancials**](MunicipalityApi.md#getMunicipalityFinancials) | **GET** /municipalities/{id}/financials | Financials for a Municipality + + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:MunicipalityApi) + +[//]: # (METHOD:getAllMunicipalities) + +[//]: # (RETURN_TYPE:ApiResponseMunicipalities) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseMunicipalities.md) + +[//]: # (OPERATION:getAllMunicipalities_v2) + +[//]: # (ENDPOINT:/municipalities) + +[//]: # (DOCUMENT_LINK:MunicipalityApi.md#getAllMunicipalities) + + +## **getAllMunicipalities** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getAllMunicipalities_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseMunicipalities getAllMunicipalities(hasFinancials, governmentName, governmentType, areaName, areaType, city, state, zipcode, populationGreaterThan, populationLessThan, enrollmentGreaterThan, enrollmentLessThan, nextPage) + +#### All Municipalities + + + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + MunicipalityApi municipalityApi = new MunicipalityApi(); + + Boolean hasFinancials = true; // Boolean | Return municipalities with financials + String governmentName = null; // String | Return municipalities with a government name matching the given query + String governmentType = null; // String | Return municipalities with the given government type + String areaName = null; // String | Return municipalities with an area name matching the given query + String areaType = null; // String | Return municipalities with the given area type + String city = null; // String | Return municipalities in the given city + String state = null; // String | Return municipalities in the given state + BigDecimal zipcode = null; // BigDecimal | Return municipalities in the given zipcode + BigDecimal populationGreaterThan = null; // BigDecimal | Return municipalities with a population greater than the given number + BigDecimal populationLessThan = null; // BigDecimal | Return municipalities with a population less than the given number + BigDecimal enrollmentGreaterThan = null; // BigDecimal | Return municipalities with an enrollment greater than the given number + BigDecimal enrollmentLessThan = null; // BigDecimal | Return municipalities with an enrollment less than the given number + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseMunicipalities result = municipalityApi.getAllMunicipalities(hasFinancials, governmentName, governmentType, areaName, areaType, city, state, zipcode, populationGreaterThan, populationLessThan, enrollmentGreaterThan, enrollmentLessThan, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling MunicipalityApi#getAllMunicipalities"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **hasFinancials** | Boolean| Return municipalities with financials | [optional]   + **governmentName** | String| Return municipalities with a government name matching the given query | [optional]   + **governmentType** | String| Return municipalities with the given government type | [optional]   + **areaName** | String| Return municipalities with an area name matching the given query | [optional]   + **areaType** | String| Return municipalities with the given area type | [optional] [enum: Borough, Census Borough, Census County, Census Division, Census Parish, City, City And County, County, Municipality, Parish]   + **city** | String| Return municipalities in the given city | [optional]   + **state** | String| Return municipalities in the given state | [optional]   + **zipcode** | BigDecimal| Return municipalities in the given zipcode | [optional]   + **populationGreaterThan** | BigDecimal| Return municipalities with a population greater than the given number | [optional]   + **populationLessThan** | BigDecimal| Return municipalities with a population less than the given number | [optional]   + **enrollmentGreaterThan** | BigDecimal| Return municipalities with an enrollment greater than the given number | [optional]   + **enrollmentLessThan** | BigDecimal| Return municipalities with an enrollment less than the given number | [optional]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseMunicipalities**](ApiResponseMunicipalities.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:MunicipalityApi) + +[//]: # (METHOD:getMunicipalityById) + +[//]: # (RETURN_TYPE:Municipality) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:Municipality.md) + +[//]: # (OPERATION:getMunicipalityById_v2) + +[//]: # (ENDPOINT:/municipalities/{id}) + +[//]: # (DOCUMENT_LINK:MunicipalityApi.md#getMunicipalityById) + + +## **getMunicipalityById** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getMunicipalityById_v2) + +[//]: # (START_OVERVIEW) + +> Municipality getMunicipalityById(id) + +#### Municipality by ID + + +Returns the Municipality with the given ID + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + MunicipalityApi municipalityApi = new MunicipalityApi(); + + String id = "mun_Xn7x4z"; // String | An Intrinio ID of a Municipality + + try { + Municipality result = municipalityApi.getMunicipalityById(id); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling MunicipalityApi#getMunicipalityById"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | String| An Intrinio ID of a Municipality |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**Municipality**](Municipality.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:MunicipalityApi) + +[//]: # (METHOD:getMunicipalityFinancials) + +[//]: # (RETURN_TYPE:ApiResponseMunicipalitiyFinancials) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseMunicipalitiyFinancials.md) + +[//]: # (OPERATION:getMunicipalityFinancials_v2) + +[//]: # (ENDPOINT:/municipalities/{id}/financials) + +[//]: # (DOCUMENT_LINK:MunicipalityApi.md#getMunicipalityFinancials) + + +## **getMunicipalityFinancials** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getMunicipalityFinancials_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseMunicipalitiyFinancials getMunicipalityFinancials(id, fiscalYear) + +#### Financials for a Municipality + + +Returns financial statement data for the Municipality with the given ID + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + MunicipalityApi municipalityApi = new MunicipalityApi(); + + String id = "mun_Xn7x4z"; // String | An Intrinio ID of a Municipality + BigDecimal fiscalYear = null; // BigDecimal | Return financials for the given fiscal year + + try { + ApiResponseMunicipalitiyFinancials result = municipalityApi.getMunicipalityFinancials(id, fiscalYear); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling MunicipalityApi#getMunicipalityFinancials"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | String| An Intrinio ID of a Municipality |   + **fiscalYear** | BigDecimal| Return financials for the given fiscal year | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseMunicipalitiyFinancials**](ApiResponseMunicipalitiyFinancials.md) + +[//]: # (END_OPERATION) + diff --git a/docs/MunicipalityFinancial.md b/docs/MunicipalityFinancial.md new file mode 100644 index 0000000..7f44b15 --- /dev/null +++ b/docs/MunicipalityFinancial.md @@ -0,0 +1,188 @@ + +[//]: # (CLASS:MunicipalityFinancial) + +[//]: # (KIND:object) + +### MunicipalityFinancial + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**fiscalYear** | [**BigDecimal**](BigDecimal.md) | The fiscal year from which the financial data came from   +**currentAssets** | [**BigDecimal**](BigDecimal.md) | Government-wide holdings that can be liquidated on short notice   +**nonCurrentAssets** | [**BigDecimal**](BigDecimal.md) | Government-wide holdings not intended for near-term liquidation   +**deferredOutflows** | [**BigDecimal**](BigDecimal.md) | Government-wide consumptions of net position applicable to a future year   +**totalAssets** | [**BigDecimal**](BigDecimal.md) | Government-wide holdings   +**totalAssetsPlusDeferredOutflows** | [**BigDecimal**](BigDecimal.md) | Sum of government-wide total assets and deferred outflows of resources   +**currentLiabilities** | [**BigDecimal**](BigDecimal.md) | Government-wide liabilities that typically become due within one year   +**currentPortionOfLongTermDebt** | [**BigDecimal**](BigDecimal.md) | Government-wide portion of long term obligations, such as bond and loan debt coming due within the next year   +**netPensionLiability** | [**BigDecimal**](BigDecimal.md) | Government-wide liability for employee pensions net of the fiduciary net position of pension plans in which the government has an interest   +**netOpebLiability** | [**BigDecimal**](BigDecimal.md) | Government-wide liability for other postemployment benefits (OPEB). These are benefits (such as death benefits, life insurance, disability, and long-term care) that are paid in the period after employment and that are provided separately from a pension plan, as well as healthcare benefits paid in the period after employment, regardless of the manner in which they are provided. OPEB does not include termination benefits or termination payments for sick leave. Liability is reported net of any OPEB assets the government may control.   +**allOtherLongTermDebt** | [**BigDecimal**](BigDecimal.md) | Government-wide liabilities not elsewhere classified   +**totalLiabilities** | [**BigDecimal**](BigDecimal.md) | The sum of the Municipality's all other long term debt, net open liability, net pension liability, and current portion of long term debt   +**deferredInflows** | [**BigDecimal**](BigDecimal.md) | Government-wide acquisitions of net position applicable to a future year   +**totalLiabilitiesPlusDeferredInflows** | [**BigDecimal**](BigDecimal.md) | Sum of government-wide liabilities and deferred inflows of resources   +**totalNetPosition** | [**BigDecimal**](BigDecimal.md) | Government-wide assets and deferred outflows less government-wide liabilities and deferred inflows   +**totalUnrestrictedNetPosition** | [**BigDecimal**](BigDecimal.md) | Net amount of government-wide assets, deferred outflows of resources, liabilities, and deferred inflows of resources that are not included in the determination of net investment in capital assets or the restricted components of net position   +**totalExpenses** | [**BigDecimal**](BigDecimal.md) | Decreases in net position that occurred during the past year, government-wide   +**chargesForServices** | [**BigDecimal**](BigDecimal.md) | Charges for services is the term used for a broad category of program revenues that arise from charges to customers, applicants, or others who purchase, use, or directly benefit from the goods, services, or privileges provided, or are otherwise directly affected by the services. Revenues in this category include fees charged for specific services, such as water use or garbage collection; licenses and permits, such as dog licenses, liquor licenses, and building permits; operating special assessments, such as for street cleaning or special street lighting; and any other amounts charged to service recipients. Fines and forfeitures are also included in this category because they result from direct charges to those who are otherwise directly affected by a program or service, even though they receive no benefit. Payments from other governments for goods or services should be reported in this category.   +**operatingGrantsAndContributions** | [**BigDecimal**](BigDecimal.md) | Program-specific grants and contributions - includes revenues arising from mandatory and voluntary nonexchange transactions with other governments, organizations, or individuals that are restricted for use in a particular program. Some grants and contributions consist of capital assets or resources that are restricted for capital purposes—to purchase, construct, or renovate capital assets associated with a specific program. These should be reported separately from grants and contributions that may be used either for operating expenses or for capital expenditures of the program at the discretion of the reporting government. These categories of program revenue are specifically attributable to a program and reduce the net expense of that program to the reporting government. For example, a state may provide an operating grant to a county sheriff's department for a drug-awareness-and-enforcement program.   +**capitalGrantsAndContributions** | [**BigDecimal**](BigDecimal.md) | Program-specific grants and contributions - includes revenues arising from mandatory and voluntary nonexchange transactions with other governments, organizations, or individuals that are restricted for use in a particular program. Some grants and contributions consist of capital assets or resources that are restricted for capital purposes—to purchase, construct, or renovate capital assets associated with a specific program. These should be reported separately from grants and contributions that may be used either for operating expenses or for capital expenditures of the program at the discretion of the reporting government. These categories of program revenue are specifically attributable to a program and reduce the net expense of that program to the reporting government. For example, a state may provide a capital grant to finance construction of a new jail.   +**generalRevenues** | [**BigDecimal**](BigDecimal.md) | All revenues are general revenues unless they are required to be reported as program revenues. All taxes, even those that are levied for a specific purpose, are general revenues and should be reported by type of tax—for example, sales tax, property tax, franchise tax, income tax. All other nontax revenues (including interest, grants, and contributions) that do not meet the criteria to be reported as program revenues should also be reported as general revenues. General revenues should be reported after total net expense of the government's functions.   +**otherRevenues** | [**BigDecimal**](BigDecimal.md) | Government-wide revenues not elsewhere classified   +**totalRevenues** | [**BigDecimal**](BigDecimal.md) | Increases in net position that occurred during the past year, government-wide   +**changeInNetAssets** | [**BigDecimal**](BigDecimal.md) | Difference between the government's net position at the end of the fiscal year and the government's net position at the beginning of the fiscal year   +**nonSpendableGeneralFundBalance** | [**BigDecimal**](BigDecimal.md) | The portion of general fund balance classified as nonspendable. The nonspendable fund balance classification includes amounts that cannot be spent because they are either (a) not in spendable form or (b) legally or contractually required to be maintained intact. The “not in spendable form” criterion includes items that are not expected to be converted to cash, for example, inventories and prepaid amounts. It also includes the long-term amount of loans and notes receivable, as well as property acquired for resale. However, if the use of the proceeds from the collection of those receivables or from the sale of those properties is restricted, committed, or assigned, then they should be included in the appropriate fund balance classification (restricted, committed, or assigned), rather than nonspendable fund balance. The corpus (or principal) of a permanent fund is an example of an amount that is legally or contractually required to be maintained intact.   +**restrictedGeneralFundBalance** | [**BigDecimal**](BigDecimal.md) | The portion of general fund balance classified as restricted. Fund balance should be reported as restricted when constraints placed on the use of resources are either (a) Externally imposed by creditors (such as through debt covenants), grantors, contributors, or laws or regulations of other governments or (b) Imposed by law through constitutional provisions or enabling legislation.   +**committedGeneralFundBalance** | [**BigDecimal**](BigDecimal.md) | The portion of general fund balance classified as committed. Amounts that can only be used for specific purposes pursuant to constraints imposed by formal action of the government’s highest level of decision-making authority should be reported as committed fund balance. Those committed amounts cannot be used for any other purpose unless the government removes or changes the specified use by taking the same type of action (for example, legislation, resolution, ordinance) it employed to previously commit those amounts. The authorization specifying the purposes for which amounts can be used should have the consent of both the legislative and executive branches of the government, if applicable. Committed fund balance also should incorporate contractual obligations to the extent that existing resources in the fund have been specifically committed for use in satisfying those contractual requirements.   +**unassignedGeneralFundBalance** | [**BigDecimal**](BigDecimal.md) | The portion of general fund balance classified as unassigned. Unassigned fund balance is the residual classification for the general fund. This classification represents fund balance that has not been assigned to other funds and that has not been restricted, committed, or assigned to specific purposes within the general fund. The general fund should be the only fund that reports a positive unassigned fund balance amount. In other governmental funds, if expenditures incurred for specific purposes exceeded the amounts restricted, committed, or assigned to those purposes, it may be necessary to report a negative unassigned fund balance.   +**assignedGeneralFundBalance** | [**BigDecimal**](BigDecimal.md) | The portion of general fund balance classified as assigned. Amounts that are constrained by the government’s intent to be used for specific purposes, but are neither restricted nor committed, should be reported as assigned fund balance, except for stabilization arrangements.. Intent should be expressed by (a) the governing body itself or (b) a body (a budget or finance committee, for example) or official to which the governing body has delegated the authority to assign amounts to be used for specific purposes.   +**totalGeneralFundBalance** | [**BigDecimal**](BigDecimal.md) | General fund balance in all classifications. Fund balance is the difference between governmental fund assets and deferred outflows of resources, and liabilities and deferred inflows of resources. It is sometimes referred to as fund equity. The general fund is used to account for and report all financial resources not accounted for and reported in another governmental fund.   +**nonSpendableGovernmentalFundBalance** | [**BigDecimal**](BigDecimal.md) | For all governmental funds, the aggregate of fund balances that are classified as nonspendable. The nonspendable fund balance classification includes amounts that cannot be spent because they are either (a) not in spendable form or (b) legally or contractually required to be maintained intact. The “not in spendable form” criterion includes items that are not expected to be converted to cash, for example, inventories and prepaid amounts. It also includes the long-term amount of loans and notes receivable, as well as property acquired for resale. However, if the use of the proceeds from the collection of those receivables or from the sale of those properties is restricted, committed, or assigned, then they should be included in the appropriate fund balance classification (restricted, committed, or assigned), rather than nonspendable fund balance.   +**restrictedGovernmentalFundBalance** | [**BigDecimal**](BigDecimal.md) | For all governmental funds, the aggregate of fund balances that are classified as restricted. Fund balance should be reported as restricted when constraints placed on the use of resources are either (a) Externally imposed by creditors (such as through debt covenants), grantors, contributors, or laws or regulations of other governments; or (b) Imposed by law through constitutional provisions or enabling legislation.   +**committedGovernmentalFundBalance** | [**BigDecimal**](BigDecimal.md) | For all governmental funds, the aggregate of fund balances that are classified as committed. Amounts that can only be used for specific purposes pursuant to constraints imposed by formal action of the government’s highest level of decision-making authority should be reported as committed fund balance. Those committed amounts cannot be used for any other purpose unless the government removes or changes the specified use by taking the same type of action (for example, legislation, resolution, ordinance) it employed to previously commit those amounts. The authorization specifying the purposes for which amounts can be used should have the consent of both the legislative and executive branches of the government, if applicable. Committed fund balance also should incorporate contractual obligations to the extent that existing resources in the fund have been specifically committed for use in satisfying those contractual requirements.   +**unassignedGovernmentalFundBalance** | [**BigDecimal**](BigDecimal.md) | For all governmental funds, the aggregate of fund balances that are classified as unassigned. Unassigned fund balance is the residual classification for the general fund. This classification represents fund balance that has not been assigned to other funds and that has not been restricted, committed, or assigned to specific purposes within the general fund. The general fund should be the only fund that reports a positive unassigned fund balance amount. In other governmental funds, if expenditures incurred for specific purposes exceeded the amounts restricted, committed, or assigned to those purposes, it may be necessary to report a negative unassigned fund balance.   +**assignedGovernmentalFundBalance** | [**BigDecimal**](BigDecimal.md) | For all governmental funds, the aggregate of fund balances that are classified as assigned. Amounts that are constrained by the government’s intent to be used for specific purposes, but are neither restricted nor committed, should be reported as assigned fund balance, except for stabilization arrangements.. Intent should be expressed by (a) the governing body itself or (b) a body (a budget or finance committee, for example) or official to which the governing body has delegated the authority to assign amounts to be used for specific purposes.   +**totalGovernmentalFundBalance** | [**BigDecimal**](BigDecimal.md) | For all governmental funds, the aggregate of all fund balances in any classification. Fund balance is the difference between governmental fund assets and deferred outflows of resources, and liabilities and deferred inflows of resources. It is sometimes referred to as fund equity. Governmental funds are used to account for general government activities that are financed primarily through taxes, intergovernmental revenues, and other nonexchange revenues.   +**generalFundRevenues** | [**BigDecimal**](BigDecimal.md) | Increases in financial resources attributable to the general fund. The general fund is used to account for and report all financial resources not accounted for and reported in another governmental fund.   +**generalFundExpenditures** | [**BigDecimal**](BigDecimal.md) | Decreases in financial resources attributable to the general fund. The general fund is used to account for and report all financial resources not accounted for and reported in another governmental fund.   +**generalFundRevenuesOverUnderExpenditure** | [**BigDecimal**](BigDecimal.md) | Difference between general fund revenues and expenditures. If positive, this amount is called a surplus. If negative, it represents a deficit. The general fund is used to account for and report all financial resources not accounted for and reported in another governmental fund.   +**governmentalFundRevenues** | [**BigDecimal**](BigDecimal.md) | Increases in financial resources attributable to any governmental fund. Governmental funds are used to account for general government activities that are financed primarily through taxes, intergovernmental revenues, and other nonexchange revenues.   +**governmentalFundExpenditures** | [**BigDecimal**](BigDecimal.md) | Decreases in financial resources attributable to any governmental fund. Governmental funds are used to account for general government activities that are financed primarily through taxes, intergovernmental revenues, and other nonexchange revenues.   +**governmentalFundRevenuesOverUnderExpenditure** | [**BigDecimal**](BigDecimal.md) | Difference between revenues and expenditures attributable to all governmental funds. If positive, this amount is called a surplus. If negative, it represents a deficit. Governmental funds are used to account for general government activities that are financed primarily through taxes, intergovernmental revenues, and other nonexchange revenues.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/NegativeVolumeIndexTechnicalValue.md b/docs/NegativeVolumeIndexTechnicalValue.md new file mode 100644 index 0000000..83d43aa --- /dev/null +++ b/docs/NegativeVolumeIndexTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:NegativeVolumeIndexTechnicalValue) + +[//]: # (KIND:object) + +### NegativeVolumeIndexTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**nvi** | Float | The Negative Volume Index calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/OnBalanceVolumeMeanTechnicalValue.md b/docs/OnBalanceVolumeMeanTechnicalValue.md new file mode 100644 index 0000000..15ffaa2 --- /dev/null +++ b/docs/OnBalanceVolumeMeanTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:OnBalanceVolumeMeanTechnicalValue) + +[//]: # (KIND:object) + +### OnBalanceVolumeMeanTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**obvMean** | Float | The On-balance Volume Mean calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/OnBalanceVolumeTechnicalValue.md b/docs/OnBalanceVolumeTechnicalValue.md new file mode 100644 index 0000000..6869e49 --- /dev/null +++ b/docs/OnBalanceVolumeTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:OnBalanceVolumeTechnicalValue) + +[//]: # (KIND:object) + +### OnBalanceVolumeTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**obv** | Float | The On-balance Volume calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/Option.md b/docs/Option.md new file mode 100644 index 0000000..3064184 --- /dev/null +++ b/docs/Option.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:Option) + +[//]: # (KIND:object) + +### Option + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for the Option.   +**code** | String | The Intrinio Code for the Option.   +**ticker** | String | The ticker symbol of the Security for the Option.   +**expiration** | String | The date on which the Option expires. The Option becomes invalid after this date and cannot be exercised.   +**strike** | [**BigDecimal**](BigDecimal.md) | 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.   +**type** | String | 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.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/OptionChain.md b/docs/OptionChain.md new file mode 100644 index 0000000..f3004c6 --- /dev/null +++ b/docs/OptionChain.md @@ -0,0 +1,28 @@ + +[//]: # (CLASS:OptionChain) + +[//]: # (KIND:object) + +### OptionChain + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**option** | [**Option**](Option.md) |   +**price** | [**OptionPrice**](OptionPrice.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:Option) + + +[//]: # (CONTAINED_CLASS:OptionPrice) + + + + + diff --git a/docs/OptionPrice.md b/docs/OptionPrice.md new file mode 100644 index 0000000..5d6b4f2 --- /dev/null +++ b/docs/OptionPrice.md @@ -0,0 +1,52 @@ + +[//]: # (CLASS:OptionPrice) + +[//]: # (KIND:object) + +### OptionPrice + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**date** | String | The date of the price, in the format YYYY-MM-DD   +**close** | [**BigDecimal**](BigDecimal.md) | The closing price of the options contract.   +**closeBid** | [**BigDecimal**](BigDecimal.md) | The closing bid price of the options contract.   +**closeAsk** | [**BigDecimal**](BigDecimal.md) | The closing ask price of the options contract.   +**volume** | Integer | The cumulative volume of this options contract that traded that day.   +**volumeBid** | Integer | The cumulative volume of this options contract that traded on the bid price that day.   +**volumeAsk** | Integer | The cumulative volume of this options contract that traded on the ask price that day.   +**trades** | Integer | The number of trades executed that for this options contract on that day.   +**openInterest** | Integer | The total number of this options contract that are still open.   +**openInterestChange** | Integer | The change in the total number of this options contract that are still open from the previous day.   +**nextDayOpenInterest** | Integer | The total number of this options contract that are still open at the start of the next day.   +**impliedVolatility** | [**BigDecimal**](BigDecimal.md) | The estimated volatility of the Security's price. Volatility is a statistical measure of dispersion of returns for the Security. Standard deviation of a Security's returns and a market index is an example of a measurement of volatility. Implied volatility approximates the future value of an option, and the option's current value takes this into consideration.   +**impliedVolatilityChange** | [**BigDecimal**](BigDecimal.md) | The change in implied volatility for that day.   +**delta** | [**BigDecimal**](BigDecimal.md) | Delta measures the degree to which an options contract is exposed to shifts in the price of the underlying Security. Values of delta range from 0.0 to 1.0 for call options and -1.0 to 0.0 for put options. For example, if a put option has a delta of -0.50, if the price of the underlying Security increases by $1, the price of the put option will decrease by $0.50.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/OptionsApi.md b/docs/OptionsApi.md new file mode 100644 index 0000000..d5040b5 --- /dev/null +++ b/docs/OptionsApi.md @@ -0,0 +1,418 @@ +# OptionsApi + +All URIs are relative to *https://api-v2.intrinio.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getOptions**](OptionsApi.md#getOptions) | **GET** /options/{symbol} | Options +[**getOptionsChain**](OptionsApi.md#getOptionsChain) | **GET** /options/chain/{symbol}/{expiration} | Options Chain +[**getOptionsExpirations**](OptionsApi.md#getOptionsExpirations) | **GET** /options/expirations/{symbol} | Options Expirations +[**getOptionsPrices**](OptionsApi.md#getOptionsPrices) | **GET** /options/prices/{identifier} | Option Prices + + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:OptionsApi) + +[//]: # (METHOD:getOptions) + +[//]: # (RETURN_TYPE:ApiResponseOptions) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseOptions.md) + +[//]: # (OPERATION:getOptions_v2) + +[//]: # (ENDPOINT:/options/{symbol}) + +[//]: # (DOCUMENT_LINK:OptionsApi.md#getOptions) + + +## **getOptions** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getOptions_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseOptions getOptions(symbol, type, strike, strikeGreaterThan, strikeLessThan, expiration, expirationAfter, expirationBefore, pageSize, nextPage) + +#### Options + + +Returns the master list of option contracts for a given symbol. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + OptionsApi optionsApi = new OptionsApi(); + + String symbol = "MSFT"; // String | The option symbol, corresponding to the underlying security. + String type = "put"; // String | The option contract type. + BigDecimal strike = null; // BigDecimal | The strike price of the option contract. This will return options contracts with strike price equal to this price. + BigDecimal strikeGreaterThan = null; // BigDecimal | The strike price of the option contract. This will return options contracts with strike prices greater than this price. + BigDecimal strikeLessThan = null; // BigDecimal | The strike price of the option contract. This will return options contracts with strike prices less than this price. + String expiration = "2019-03-01"; // String | The expiration date of the option contract. This will return options contracts with expiration dates on this date. + String expirationAfter = "2019-01-01"; // String | The expiration date of the option contract. This will return options contracts with expiration dates after this date. + String expirationBefore = "2019-12-31"; // String | The expiration date of the option contract. This will return options contracts with expiration dates before this date. + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseOptions result = optionsApi.getOptions(symbol, type, strike, strikeGreaterThan, strikeLessThan, expiration, expirationAfter, expirationBefore, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling OptionsApi#getOptions"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **symbol** | String| The option symbol, corresponding to the underlying security. |   + **type** | String| The option contract type. | [optional] [enum: call, put]   + **strike** | BigDecimal| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]   + **strikeGreaterThan** | BigDecimal| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]   + **strikeLessThan** | BigDecimal| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]   + **expiration** | String| The expiration date of the option contract. This will return options contracts with expiration dates on this date. | [optional]   + **expirationAfter** | String| The expiration date of the option contract. This will return options contracts with expiration dates after this date. | [optional]   + **expirationBefore** | String| The expiration date of the option contract. This will return options contracts with expiration dates before this date. | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseOptions**](ApiResponseOptions.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:OptionsApi) + +[//]: # (METHOD:getOptionsChain) + +[//]: # (RETURN_TYPE:ApiResponseOptionsChain) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsChain.md) + +[//]: # (OPERATION:getOptionsChain_v2) + +[//]: # (ENDPOINT:/options/chain/{symbol}/{expiration}) + +[//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsChain) + + +## **getOptionsChain** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getOptionsChain_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseOptionsChain getOptionsChain(symbol, expiration, date, type, strike, strikeGreaterThan, strikeLessThan, moneyness, pageSize) + +#### Options Chain + + +Returns all options contracts and their prices for the given symbol and expiration date. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + OptionsApi optionsApi = new OptionsApi(); + + String symbol = "MSFT"; // String | The option symbol, corresponding to the underlying security. + String expiration = "2019-04-05"; // String | The expiration date of the options contract + LocalDate date = LocalDate.now(); // LocalDate | The date of the option price. Returns option prices on this date. + String type = "put"; // String | The option contract type. + BigDecimal strike = null; // BigDecimal | The strike price of the option contract. This will return options contracts with strike price equal to this price. + BigDecimal strikeGreaterThan = null; // BigDecimal | The strike price of the option contract. This will return options contracts with strike prices greater than this price. + BigDecimal strikeLessThan = null; // BigDecimal | The strike price of the option contract. This will return options contracts with strike prices less than this price. + String moneyness = "in_the_money"; // String | The moneyness of the options contracts to return. 'all' will return all options contracts. 'in_the_money' will return options contracts that are in the money (call options with strike prices below the current price, put options with strike prices above the current price). 'out_of_they_money' will return options contracts that are out of the money (call options with strike prices above the current price, put options with strike prices below the current price). 'near_the_money' will return options contracts that are $0.50 or less away from being in the money. + Integer pageSize = 100; // Integer | The number of results to return + + try { + ApiResponseOptionsChain result = optionsApi.getOptionsChain(symbol, expiration, date, type, strike, strikeGreaterThan, strikeLessThan, moneyness, pageSize); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling OptionsApi#getOptionsChain"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **symbol** | String| The option symbol, corresponding to the underlying security. |   + **expiration** | String| The expiration date of the options contract |   + **date** | LocalDate| The date of the option price. Returns option prices on this date. | [optional]   + **type** | String| The option contract type. | [optional] [enum: call, put]   + **strike** | BigDecimal| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]   + **strikeGreaterThan** | BigDecimal| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]   + **strikeLessThan** | BigDecimal| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]   + **moneyness** | String| The moneyness of the options contracts to return. 'all' will return all options contracts. 'in_the_money' will return options contracts that are in the money (call options with strike prices below the current price, put options with strike prices above the current price). 'out_of_they_money' will return options contracts that are out of the money (call options with strike prices above the current price, put options with strike prices below the current price). 'near_the_money' will return options contracts that are $0.50 or less away from being in the money. | [optional] [enum: all, in_the_money, out_of_the_money, near_the_money]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseOptionsChain**](ApiResponseOptionsChain.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:OptionsApi) + +[//]: # (METHOD:getOptionsExpirations) + +[//]: # (RETURN_TYPE:ApiResponseOptionsExpirations) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsExpirations.md) + +[//]: # (OPERATION:getOptionsExpirations_v2) + +[//]: # (ENDPOINT:/options/expirations/{symbol}) + +[//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsExpirations) + + +## **getOptionsExpirations** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getOptionsExpirations_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseOptionsExpirations getOptionsExpirations(symbol, after, before) + +#### Options Expirations + + +Returns all option contract expiration dates for a given symbol. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + OptionsApi optionsApi = new OptionsApi(); + + String symbol = "MSFT"; // String | The option symbol, corresponding to the underlying security. + String after = "2019-01-01"; // String | Return option contract expiration dates after this date. + String before = "2019-12-31"; // String | Return option contract expiration dates before this date. + + try { + ApiResponseOptionsExpirations result = optionsApi.getOptionsExpirations(symbol, after, before); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling OptionsApi#getOptionsExpirations"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **symbol** | String| The option symbol, corresponding to the underlying security. |   + **after** | String| Return option contract expiration dates after this date. | [optional]   + **before** | String| Return option contract expiration dates before this date. | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseOptionsExpirations**](ApiResponseOptionsExpirations.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:OptionsApi) + +[//]: # (METHOD:getOptionsPrices) + +[//]: # (RETURN_TYPE:ApiResponseOptionPrices) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseOptionPrices.md) + +[//]: # (OPERATION:getOptionsPrices_v2) + +[//]: # (ENDPOINT:/options/prices/{identifier}) + +[//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsPrices) + + +## **getOptionsPrices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getOptionsPrices_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseOptionPrices getOptionsPrices(identifier, startDate, endDate, pageSize, nextPage) + +#### Option Prices + + +Returns all option prices for a given option contract identifier. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + OptionsApi optionsApi = new OptionsApi(); + + String identifier = "identifier_example"; // String | The Intrinio ID or code of the options contract to request prices for. + String startDate = "2019-01-01"; // String | Return option contract prices on or after this date. + String endDate = "2019-12-31"; // String | Return option contract prices on or before this date. + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseOptionPrices result = optionsApi.getOptionsPrices(identifier, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling OptionsApi#getOptionsPrices"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| The Intrinio ID or code of the options contract to request prices for. |   + **startDate** | String| Return option contract prices on or after this date. | [optional]   + **endDate** | String| Return option contract prices on or before this date. | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseOptionPrices**](ApiResponseOptionPrices.md) + +[//]: # (END_OPERATION) + diff --git a/docs/RealtimeStockPrice.md b/docs/RealtimeStockPrice.md new file mode 100644 index 0000000..074efeb --- /dev/null +++ b/docs/RealtimeStockPrice.md @@ -0,0 +1,73 @@ + +[//]: # (CLASS:RealtimeStockPrice) + +[//]: # (KIND:object) + +### RealtimeStockPrice + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**lastPrice** | [**BigDecimal**](BigDecimal.md) | The price of the last trade.   +**lastTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date and time when the last trade occurred.   +**bidPrice** | [**BigDecimal**](BigDecimal.md) | The price of the top bid order.   +**bidSize** | [**BigDecimal**](BigDecimal.md) | The size of the top bid order.   +**askPrice** | [**BigDecimal**](BigDecimal.md) | The price of the top ask order.   +**askSize** | [**BigDecimal**](BigDecimal.md) | The size of the top ask order.   +**openPrice** | [**BigDecimal**](BigDecimal.md) | The price at the open of the trading day.   +**highPrice** | [**BigDecimal**](BigDecimal.md) | The high price for the trading day.   +**lowPrice** | [**BigDecimal**](BigDecimal.md) | The low price for the trading day.   +**exchangeVolume** | [**BigDecimal**](BigDecimal.md) | The number of shares exchanged during the trading day on the exchange.   +**marketVolume** | [**BigDecimal**](BigDecimal.md) | The number of shares exchanged during the trading day for the whole market.   +**updatedOn** | [**OffsetDateTime**](OffsetDateTime.md) | The date and time when the data was last updated.   +**source** | String | The source of the data.   +**security** | [**RealtimeStockPriceSecurity**](RealtimeStockPriceSecurity.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + +[//]: # (CONTAINED_CLASS:RealtimeStockPriceSecurity) + + + + + diff --git a/docs/RealtimeStockPriceSecurity.md b/docs/RealtimeStockPriceSecurity.md new file mode 100644 index 0000000..731420e --- /dev/null +++ b/docs/RealtimeStockPriceSecurity.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:RealtimeStockPriceSecurity) + +[//]: # (KIND:object) + +### RealtimeStockPriceSecurity + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for Security   +**ticker** | String | The common/local ticker of the Security   +**exchangeTicker** | String | The exchange-level ticker   +**figi** | String | The OpenFIGI identifier   +**compositeFigi** | String | The country-composite OpenFIGI identifier   + +[//]: # (END_DEFINITION) + + + + + diff --git a/docs/RelativeStrengthIndexTechnicalValue.md b/docs/RelativeStrengthIndexTechnicalValue.md new file mode 100644 index 0000000..c279fac --- /dev/null +++ b/docs/RelativeStrengthIndexTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:RelativeStrengthIndexTechnicalValue) + +[//]: # (KIND:object) + +### RelativeStrengthIndexTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**rsi** | Float | The Relative Strength Index calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/ReportedFinancial.md b/docs/ReportedFinancial.md new file mode 100644 index 0000000..abb0668 --- /dev/null +++ b/docs/ReportedFinancial.md @@ -0,0 +1,32 @@ + +[//]: # (CLASS:ReportedFinancial) + +[//]: # (KIND:object) + +### ReportedFinancial + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**xbrlTag** | [**ReportedTag**](ReportedTag.md) |   +**value** | [**BigDecimal**](BigDecimal.md) | The value reported for the XBRL Tag within the scope of the Fundamental   +**dimensions** | [**List<ReportedFinancialDimension>**](ReportedFinancialDimension.md) | The combination of XBRL axis and members that defines the dimensionalization of this fact (if any)   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ReportedTag) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:ReportedFinancialDimension) + + + + + diff --git a/docs/ReportedFinancialDimension.md b/docs/ReportedFinancialDimension.md new file mode 100644 index 0000000..5fd87df --- /dev/null +++ b/docs/ReportedFinancialDimension.md @@ -0,0 +1,22 @@ + +[//]: # (CLASS:ReportedFinancialDimension) + +[//]: # (KIND:object) + +### ReportedFinancialDimension + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**axis** | String | The axis of the dimension   +**member** | String | The member of the axis   + +[//]: # (END_DEFINITION) + + + + + diff --git a/docs/ReportedTag.md b/docs/ReportedTag.md new file mode 100644 index 0000000..fdfa49c --- /dev/null +++ b/docs/ReportedTag.md @@ -0,0 +1,27 @@ + +[//]: # (CLASS:ReportedTag) + +[//]: # (KIND:object) + +### ReportedTag + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**tag** | String | The tag code   +**name** | String | The tag name   +**balance** | String | Whether the tag represents a credit or debit   +**unit** | String | The unit of the tag   +**_abstract** | Boolean | If true, the tag is an abstract and does not represent a nominal value   +**sequence** | Integer | The vertical sequence of the tag when displayed in the financial statement   +**depth** | Integer | The horizontal depth of the tag when displayed in the financial statement   + +[//]: # (END_DEFINITION) + + + + + diff --git a/docs/SICIndex.md b/docs/SICIndex.md new file mode 100644 index 0000000..3f44dfc --- /dev/null +++ b/docs/SICIndex.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:SICIndex) + +[//]: # (KIND:object) + +### SICIndex + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | Intrinio ID for the Index   +**symbol** | String | The symbol used to identify the Index   +**name** | String | The name of the Index   +**continent** | String | The continent of the country of focus for the Index   +**country** | String | The country of focus for the Index   + +[//]: # (END_DEFINITION) + + + + + diff --git a/docs/Security.md b/docs/Security.md new file mode 100644 index 0000000..16cc222 --- /dev/null +++ b/docs/Security.md @@ -0,0 +1,63 @@ + +[//]: # (CLASS:Security) + +[//]: # (KIND:object) + +### Security + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for the Security   +**companyId** | String | The Intrinio ID for the company for which the Security is issued   +**name** | String | The name of the Security   +**type** | String | The Security's type   +**code** | String | A 2-3 digit code classifying the Security (<a href=\"https://docs.intrinio.com/documentation/security_codes\" target=\"_blank\">reference</a>)   +**shareClass** | String | The Security's share class (if applicable)   +**currency** | String | The currency in which the Security is traded on the exchange   +**roundLotSize** | [**BigDecimal**](BigDecimal.md) | The normal unit of trading   +**ticker** | String | The common ticker   +**exchangeTicker** | String | The exchange-level ticker   +**compositeTicker** | String | The country-composite ticker   +**alternateTickers** | List<String> | Alternate formats of the common ticker   +**figi** | String | The exchange-level OpenFIGI identifier   +**cik** | String | Central Index Key issued by the SEC, which is the unique identifier for all owner filings   +**compositeFigi** | String | The country-composite OpenFIGI identifier   +**shareClassFigi** | String | The global-composite OpenFIGI identifier   +**figiUniqueid** | String | The OpenFIGI unique ID   +**active** | Boolean | If true, the Security is active and has been recently traded   +**etf** | Boolean | If true, this Security is an ETF   +**delisted** | Boolean | If true, the Security is no longer traded on the exchange   +**primaryListing** | Boolean | If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange   +**primarySecurity** | Boolean | If true, the Security is considered by Intrinio to be the primary Security for its company   +**firstStockPrice** | [**LocalDate**](LocalDate.md) | The date of the first recorded stock price   +**lastStockPrice** | [**LocalDate**](LocalDate.md) | The date of the last recorded stock price (or the most recent trading day)   +**lastStockPriceAdjustment** | [**LocalDate**](LocalDate.md) | The date of the last stock price adjustment (dividend, split, etc)   +**lastCorporateAction** | [**LocalDate**](LocalDate.md) | The date of the last corporate action   +**previousTickers** | List<String> | Previous tickers used by this security   +**listingExchangeMic** | String | The MIC code of the exchange on which this security primarily trades   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + + + + diff --git a/docs/SecurityApi.md b/docs/SecurityApi.md new file mode 100644 index 0000000..2816f67 --- /dev/null +++ b/docs/SecurityApi.md @@ -0,0 +1,4876 @@ +# SecurityApi + +All URIs are relative to *https://api-v2.intrinio.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAllSecurities**](SecurityApi.md#getAllSecurities) | **GET** /securities | All Securities +[**getSecurityById**](SecurityApi.md#getSecurityById) | **GET** /securities/{identifier} | Lookup Security +[**getSecurityDataPointNumber**](SecurityApi.md#getSecurityDataPointNumber) | **GET** /securities/{identifier}/data_point/{tag}/number | Data Point (Number) for Security +[**getSecurityDataPointText**](SecurityApi.md#getSecurityDataPointText) | **GET** /securities/{identifier}/data_point/{tag}/text | Data Point (Text) for Security +[**getSecurityHistoricalData**](SecurityApi.md#getSecurityHistoricalData) | **GET** /securities/{identifier}/historical_data/{tag} | Historical Data for Security +[**getSecurityIntradayPrices**](SecurityApi.md#getSecurityIntradayPrices) | **GET** /securities/{identifier}/prices/intraday | Intraday Stock Prices for Security +[**getSecurityLatestDividendRecord**](SecurityApi.md#getSecurityLatestDividendRecord) | **GET** /securities/{identifier}/dividends/latest | Lastest Dividend Record for Security +[**getSecurityLatestEarningsRecord**](SecurityApi.md#getSecurityLatestEarningsRecord) | **GET** /securities/{identifier}/earnings/latest | Lastest Earnings Record for Security +[**getSecurityPriceTechnicalsAdi**](SecurityApi.md#getSecurityPriceTechnicalsAdi) | **GET** /securities/{identifier}/prices/technicals/adi | Accumulation/Distribution Index +[**getSecurityPriceTechnicalsAdtv**](SecurityApi.md#getSecurityPriceTechnicalsAdtv) | **GET** /securities/{identifier}/prices/technicals/adtv | Average Daily Trading Volume +[**getSecurityPriceTechnicalsAdx**](SecurityApi.md#getSecurityPriceTechnicalsAdx) | **GET** /securities/{identifier}/prices/technicals/adx | Average Directional Index +[**getSecurityPriceTechnicalsAo**](SecurityApi.md#getSecurityPriceTechnicalsAo) | **GET** /securities/{identifier}/prices/technicals/ao | Awesome Oscillator +[**getSecurityPriceTechnicalsAtr**](SecurityApi.md#getSecurityPriceTechnicalsAtr) | **GET** /securities/{identifier}/prices/technicals/atr | Average True Range +[**getSecurityPriceTechnicalsBb**](SecurityApi.md#getSecurityPriceTechnicalsBb) | **GET** /securities/{identifier}/prices/technicals/bb | Bollinger Bands +[**getSecurityPriceTechnicalsCci**](SecurityApi.md#getSecurityPriceTechnicalsCci) | **GET** /securities/{identifier}/prices/technicals/cci | Commodity Channel Index +[**getSecurityPriceTechnicalsCmf**](SecurityApi.md#getSecurityPriceTechnicalsCmf) | **GET** /securities/{identifier}/prices/technicals/cmf | Chaikin Money Flow +[**getSecurityPriceTechnicalsDc**](SecurityApi.md#getSecurityPriceTechnicalsDc) | **GET** /securities/{identifier}/prices/technicals/dc | Donchian Channel +[**getSecurityPriceTechnicalsDpo**](SecurityApi.md#getSecurityPriceTechnicalsDpo) | **GET** /securities/{identifier}/prices/technicals/dpo | Detrended Price Oscillator +[**getSecurityPriceTechnicalsEom**](SecurityApi.md#getSecurityPriceTechnicalsEom) | **GET** /securities/{identifier}/prices/technicals/eom | Ease of Movement +[**getSecurityPriceTechnicalsFi**](SecurityApi.md#getSecurityPriceTechnicalsFi) | **GET** /securities/{identifier}/prices/technicals/fi | Force Index +[**getSecurityPriceTechnicalsIchimoku**](SecurityApi.md#getSecurityPriceTechnicalsIchimoku) | **GET** /securities/{identifier}/prices/technicals/ichimoku | Ichimoku Kinko Hyo +[**getSecurityPriceTechnicalsKc**](SecurityApi.md#getSecurityPriceTechnicalsKc) | **GET** /securities/{identifier}/prices/technicals/kc | Keltner Channel +[**getSecurityPriceTechnicalsKst**](SecurityApi.md#getSecurityPriceTechnicalsKst) | **GET** /securities/{identifier}/prices/technicals/kst | Know Sure Thing +[**getSecurityPriceTechnicalsMacd**](SecurityApi.md#getSecurityPriceTechnicalsMacd) | **GET** /securities/{identifier}/prices/technicals/macd | Moving Average Convergence Divergence +[**getSecurityPriceTechnicalsMfi**](SecurityApi.md#getSecurityPriceTechnicalsMfi) | **GET** /securities/{identifier}/prices/technicals/mfi | Money Flow Index +[**getSecurityPriceTechnicalsMi**](SecurityApi.md#getSecurityPriceTechnicalsMi) | **GET** /securities/{identifier}/prices/technicals/mi | Mass Index +[**getSecurityPriceTechnicalsNvi**](SecurityApi.md#getSecurityPriceTechnicalsNvi) | **GET** /securities/{identifier}/prices/technicals/nvi | Negative Volume Index +[**getSecurityPriceTechnicalsObv**](SecurityApi.md#getSecurityPriceTechnicalsObv) | **GET** /securities/{identifier}/prices/technicals/obv | On-balance Volume +[**getSecurityPriceTechnicalsObvMean**](SecurityApi.md#getSecurityPriceTechnicalsObvMean) | **GET** /securities/{identifier}/prices/technicals/obv_mean | On-balance Volume Mean +[**getSecurityPriceTechnicalsRsi**](SecurityApi.md#getSecurityPriceTechnicalsRsi) | **GET** /securities/{identifier}/prices/technicals/rsi | Relative Strength Index +[**getSecurityPriceTechnicalsSma**](SecurityApi.md#getSecurityPriceTechnicalsSma) | **GET** /securities/{identifier}/prices/technicals/sma | Simple Moving Average +[**getSecurityPriceTechnicalsSr**](SecurityApi.md#getSecurityPriceTechnicalsSr) | **GET** /securities/{identifier}/prices/technicals/sr | Stochastic Oscillator +[**getSecurityPriceTechnicalsTrix**](SecurityApi.md#getSecurityPriceTechnicalsTrix) | **GET** /securities/{identifier}/prices/technicals/trix | Triple Exponential Average +[**getSecurityPriceTechnicalsTsi**](SecurityApi.md#getSecurityPriceTechnicalsTsi) | **GET** /securities/{identifier}/prices/technicals/tsi | True Strength Index +[**getSecurityPriceTechnicalsUo**](SecurityApi.md#getSecurityPriceTechnicalsUo) | **GET** /securities/{identifier}/prices/technicals/uo | Ultimate Oscillator +[**getSecurityPriceTechnicalsVi**](SecurityApi.md#getSecurityPriceTechnicalsVi) | **GET** /securities/{identifier}/prices/technicals/vi | Vortex Indicator +[**getSecurityPriceTechnicalsVpt**](SecurityApi.md#getSecurityPriceTechnicalsVpt) | **GET** /securities/{identifier}/prices/technicals/vpt | Volume-price Trend +[**getSecurityPriceTechnicalsVwap**](SecurityApi.md#getSecurityPriceTechnicalsVwap) | **GET** /securities/{identifier}/prices/technicals/vwap | Volume Weighted Average Price +[**getSecurityPriceTechnicalsWr**](SecurityApi.md#getSecurityPriceTechnicalsWr) | **GET** /securities/{identifier}/prices/technicals/wr | Williams %R +[**getSecurityRealtimePrice**](SecurityApi.md#getSecurityRealtimePrice) | **GET** /securities/{identifier}/prices/realtime | Realtime Stock Price for Security +[**getSecurityStockPriceAdjustments**](SecurityApi.md#getSecurityStockPriceAdjustments) | **GET** /securities/{identifier}/prices/adjustments | Stock Price Adjustments by Security +[**getSecurityStockPrices**](SecurityApi.md#getSecurityStockPrices) | **GET** /securities/{identifier}/prices | Stock Prices by Security +[**getSecurityZacksAnalystRatings**](SecurityApi.md#getSecurityZacksAnalystRatings) | **GET** /securities/{identifier}/zacks/analyst_ratings | Zacks Analyst Ratings +[**getSecurityZacksAnalystRatingsSnapshot**](SecurityApi.md#getSecurityZacksAnalystRatingsSnapshot) | **GET** /securities/{identifier}/zacks/analyst_ratings/snapshot | Zacks Analyst Ratings Snapshot +[**getSecurityZacksEpsSurprises**](SecurityApi.md#getSecurityZacksEpsSurprises) | **GET** /securities/{identifier}/zacks/eps_surprises | Zacks EPS Surprises for Security +[**getSecurityZacksSalesSurprises**](SecurityApi.md#getSecurityZacksSalesSurprises) | **GET** /securities/{identifier}/zacks/sales_surprises | Zacks Sales Surprises for Security +[**screenSecurities**](SecurityApi.md#screenSecurities) | **POST** /securities/screen | Screen Securities +[**searchSecurities**](SecurityApi.md#searchSecurities) | **GET** /securities/search | Search Securities + + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getAllSecurities) + +[//]: # (RETURN_TYPE:ApiResponseSecurities) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurities.md) + +[//]: # (OPERATION:getAllSecurities_v2) + +[//]: # (ENDPOINT:/securities) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getAllSecurities) + + +## **getAllSecurities** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getAllSecurities_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurities getAllSecurities(active, delisted, code, currency, ticker, name, compositeMic, exchangeMic, stockPricesAfter, stockPricesBefore, cik, figi, compositeFigi, shareClassFigi, figiUniqueId, includeNonFigi, pageSize, nextPage) + +#### All Securities + + +Returns all Securities to which you have access. When parameters are specified, returns matching Securities. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + Boolean active = true; // Boolean | When true, return securities that are active. When false, return securities that are not active. A security is considered active if it has traded or has had a corporate action in the past 30 days, and has not been merged into another security (such as due to ticker changes or corporate restructurings). + Boolean delisted = false; // Boolean | When true, return securities that have been delisted from their exchange. Note that there may be a newer security for the same company that has been relisted on a differente exchange. When false, return securities that have not been delisted. + String code = null; // String | Return securities classified with the given code (reference). + String currency = null; // String | Return securities traded in the given 3-digit ISO 4217 currency code (reference). + String ticker = null; // String | Return securities traded with the given ticker. Note that securities across the world (and through time) may trade with the same ticker but represent different companies. Use this in conjuction with other parameters for more specificity. + String name = null; // String | Return securities with the given text in their name (not case sensitive). + String compositeMic = null; // String | Return securities classified under the composite exchange with the given Market Identification Code (MIC). A composite exchange may or may not be a real exchange. For example, the USCOMP exchange (our only composite exchange to date) is a combination of exchanges with the following MICs: ARCX, XASE, XPOR, FINR, XCIS, XNAS, XNYS, BATS. This composite grouping is done for user convenience. At this time, all US securities are classified under the composite exchange with MIC USCOMP. To query for specific US exchanges, use the exchange_mic parameter below. + String exchangeMic = null; // String | The MIC code of the exchange where the security is actually traded. + LocalDate stockPricesAfter = LocalDate.now(); // LocalDate | Return securities with end-of-day stock prices on or after this date. + LocalDate stockPricesBefore = LocalDate.now(); // LocalDate | Return securities with end-of-day stock prices on or before this date. + String cik = null; // String | Return securities belonging to the company with the given Central Index Key (CIK). + String figi = null; // String | Return securities with the given Exchange Level FIGI (reference). + String compositeFigi = null; // String | Return securities with the given Country Composite FIGI (reference). + String shareClassFigi = null; // String | Return securities with the given Global Share Class FIGI (reference). + String figiUniqueId = null; // String | Return securities with the given FIGI Unique ID (reference). + Boolean includeNonFigi = false; // Boolean | When true, include securities that do not have a FIGI. By default, this is false. If this parameter is not specified, only securities with a FIGI are returned. + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurities result = securityApi.getAllSecurities(active, delisted, code, currency, ticker, name, compositeMic, exchangeMic, stockPricesAfter, stockPricesBefore, cik, figi, compositeFigi, shareClassFigi, figiUniqueId, includeNonFigi, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getAllSecurities"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **active** | Boolean| When true, return securities that are active. When false, return securities that are not active. A security is considered active if it has traded or has had a corporate action in the past 30 days, and has not been merged into another security (such as due to ticker changes or corporate restructurings). | [optional]   + **delisted** | Boolean| When true, return securities that have been delisted from their exchange. Note that there may be a newer security for the same company that has been relisted on a differente exchange. When false, return securities that have not been delisted. | [optional]   + **code** | String| Return securities classified with the given code (<a href=\"https://docs.intrinio.com/documentation/security_codes\" target=\"_blank\">reference</a>). | [optional]   + **currency** | String| Return securities traded in the given 3-digit ISO 4217 currency code (<a href=\"https://en.wikipedia.org/wiki/ISO_4217\" target=\"_blank\">reference</a>). | [optional]   + **ticker** | String| Return securities traded with the given ticker. Note that securities across the world (and through time) may trade with the same ticker but represent different companies. Use this in conjuction with other parameters for more specificity. | [optional]   + **name** | String| Return securities with the given text in their name (not case sensitive). | [optional]   + **compositeMic** | String| Return securities classified under the composite exchange with the given Market Identification Code (MIC). A composite exchange may or may not be a real exchange. For example, the USCOMP exchange (our only composite exchange to date) is a combination of exchanges with the following MICs: ARCX, XASE, XPOR, FINR, XCIS, XNAS, XNYS, BATS. This composite grouping is done for user convenience. At this time, all US securities are classified under the composite exchange with MIC USCOMP. To query for specific US exchanges, use the exchange_mic parameter below. | [optional]   + **exchangeMic** | String| The MIC code of the exchange where the security is actually traded. | [optional]   + **stockPricesAfter** | LocalDate| Return securities with end-of-day stock prices on or after this date. | [optional]   + **stockPricesBefore** | LocalDate| Return securities with end-of-day stock prices on or before this date. | [optional]   + **cik** | String| Return securities belonging to the company with the given Central Index Key (CIK). | [optional]   + **figi** | String| Return securities with the given Exchange Level FIGI (<a href=\"https://www.openfigi.com/about\" target=\"_blank\">reference</a>). | [optional]   + **compositeFigi** | String| Return securities with the given Country Composite FIGI (<a href=\"https://www.openfigi.com/about\" target=\"_blank\">reference</a>). | [optional]   + **shareClassFigi** | String| Return securities with the given Global Share Class FIGI (<a href=\"https://www.openfigi.com/about\" target=\"_blank\">reference</a>). | [optional]   + **figiUniqueId** | String| Return securities with the given FIGI Unique ID (<a href=\"https://www.openfigi.com/about\" target=\"_blank\">reference</a>). | [optional]   + **includeNonFigi** | Boolean| When true, include securities that do not have a FIGI. By default, this is false. If this parameter is not specified, only securities with a FIGI are returned. | [optional] [default to false]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurities**](ApiResponseSecurities.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityById) + +[//]: # (RETURN_TYPE:Security) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:Security.md) + +[//]: # (OPERATION:getSecurityById_v2) + +[//]: # (ENDPOINT:/securities/{identifier}) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityById) + + +## **getSecurityById** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityById_v2) + +[//]: # (START_OVERVIEW) + +> Security getSecurityById(identifier) + +#### Lookup Security + + +Returns the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + + try { + Security result = securityApi.getSecurityById(identifier); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityById"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**Security**](Security.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityDataPointNumber) + +[//]: # (RETURN_TYPE:BigDecimal) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:BigDecimal.md) + +[//]: # (OPERATION:getSecurityDataPointNumber_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/data_point/{tag}/number) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityDataPointNumber) + + +## **getSecurityDataPointNumber** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityDataPointNumber_v2) + +[//]: # (START_OVERVIEW) + +> BigDecimal getSecurityDataPointNumber(identifier, tag) + +#### Data Point (Number) for Security + + +Returns a numeric value for the given `tag` for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String tag = "close_price"; // String | An Intrinio data tag ID or code (reference) + + try { + BigDecimal result = securityApi.getSecurityDataPointNumber(identifier, tag); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityDataPointNumber"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**BigDecimal**](BigDecimal.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityDataPointText) + +[//]: # (RETURN_TYPE:String) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:getSecurityDataPointText_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/data_point/{tag}/text) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityDataPointText) + + +## **getSecurityDataPointText** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityDataPointText_v2) + +[//]: # (START_OVERVIEW) + +> String getSecurityDataPointText(identifier, tag) + +#### Data Point (Text) for Security + + +Returns a text value for the given `tag` for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String tag = "figi"; // String | An Intrinio data tag ID or code-name + + try { + String result = securityApi.getSecurityDataPointText(identifier, tag); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityDataPointText"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **tag** | String| An Intrinio data tag ID or code-name |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +**String** + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityHistoricalData) + +[//]: # (RETURN_TYPE:ApiResponseSecurityHistoricalData) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityHistoricalData.md) + +[//]: # (OPERATION:getSecurityHistoricalData_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/historical_data/{tag}) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityHistoricalData) + + +## **getSecurityHistoricalData** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityHistoricalData_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityHistoricalData getSecurityHistoricalData(identifier, tag, frequency, type, startDate, endDate, sortOrder, pageSize, nextPage) + +#### Historical Data for Security + + +Returns historical values for the given `tag` and the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String tag = "adj_close_price"; // String | An Intrinio data tag ID or code (reference) + String frequency = "daily"; // String | Return historical data in the given frequency + String type = null; // String | Filter by type, when applicable + LocalDate startDate = LocalDate.now(); // LocalDate | Get historical data on or after this date + LocalDate endDate = LocalDate.now(); // LocalDate | Get historical date on or before this date + String sortOrder = "desc"; // String | Sort by date `asc` or `desc` + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityHistoricalData result = securityApi.getSecurityHistoricalData(identifier, tag, frequency, type, startDate, endDate, sortOrder, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityHistoricalData"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   + **frequency** | String| Return historical data in the given frequency | [optional] [default to daily] [enum: daily, weekly, monthly, quarterly, yearly]   + **type** | String| Filter by type, when applicable | [optional]   + **startDate** | LocalDate| Get historical data on or after this date | [optional]   + **endDate** | LocalDate| Get historical date on or before this date | [optional]   + **sortOrder** | String| Sort by date `asc` or `desc` | [optional] [default to desc] [enum: asc, desc]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityHistoricalData**](ApiResponseSecurityHistoricalData.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityIntradayPrices) + +[//]: # (RETURN_TYPE:ApiResponseSecurityIntradayPrices) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityIntradayPrices.md) + +[//]: # (OPERATION:getSecurityIntradayPrices_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/intraday) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityIntradayPrices) + + +## **getSecurityIntradayPrices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityIntradayPrices_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityIntradayPrices getSecurityIntradayPrices(identifier, source, startDate, startTime, endDate, endTime, pageSize, nextPage) + +#### Intraday Stock Prices for Security + + +Return intraday stock prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String source = null; // String | Return intraday prices from the specified data source + LocalDate startDate = LocalDate.now(); // LocalDate | Return intraday prices starting at the specified date + String startTime = null; // String | Return intraday prices starting at the specified time on the `start_date` (timezone is UTC) + LocalDate endDate = LocalDate.now(); // LocalDate | Return intraday prices stopping at the specified date + String endTime = null; // String | Return intraday prices stopping at the specified time on the `end_date` (timezone is UTC) + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityIntradayPrices result = securityApi.getSecurityIntradayPrices(identifier, source, startDate, startTime, endDate, endTime, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityIntradayPrices"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **source** | String| Return intraday prices from the specified data source | [optional] [enum: iex, bats]   + **startDate** | LocalDate| Return intraday prices starting at the specified date | [optional]   + **startTime** | String| Return intraday prices starting at the specified time on the `start_date` (timezone is UTC) | [optional]   + **endDate** | LocalDate| Return intraday prices stopping at the specified date | [optional]   + **endTime** | String| Return intraday prices stopping at the specified time on the `end_date` (timezone is UTC) | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityIntradayPrices**](ApiResponseSecurityIntradayPrices.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityLatestDividendRecord) + +[//]: # (RETURN_TYPE:DividendRecord) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:DividendRecord.md) + +[//]: # (OPERATION:getSecurityLatestDividendRecord_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/dividends/latest) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityLatestDividendRecord) + + +## **getSecurityLatestDividendRecord** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityLatestDividendRecord_v2) + +[//]: # (START_OVERVIEW) + +> DividendRecord getSecurityLatestDividendRecord(identifier) + +#### Lastest Dividend Record for Security + + +Returns the latest available dividend information for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + + try { + DividendRecord result = securityApi.getSecurityLatestDividendRecord(identifier); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityLatestDividendRecord"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**DividendRecord**](DividendRecord.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityLatestEarningsRecord) + +[//]: # (RETURN_TYPE:EarningsRecord) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:EarningsRecord.md) + +[//]: # (OPERATION:getSecurityLatestEarningsRecord_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/earnings/latest) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityLatestEarningsRecord) + + +## **getSecurityLatestEarningsRecord** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityLatestEarningsRecord_v2) + +[//]: # (START_OVERVIEW) + +> EarningsRecord getSecurityLatestEarningsRecord(identifier) + +#### Lastest Earnings Record for Security + + +Returns latest available earnings information for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + + try { + EarningsRecord result = securityApi.getSecurityLatestEarningsRecord(identifier); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityLatestEarningsRecord"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**EarningsRecord**](EarningsRecord.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsAdi) + +[//]: # (RETURN_TYPE:ApiResponseSecurityAccumulationDistributionIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAccumulationDistributionIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsAdi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adi) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsAdi) + + +## **getSecurityPriceTechnicalsAdi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsAdi_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityAccumulationDistributionIndex getSecurityPriceTechnicalsAdi(identifier, startDate, endDate, pageSize, nextPage) + +#### Accumulation/Distribution Index + + +Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityAccumulationDistributionIndex result = securityApi.getSecurityPriceTechnicalsAdi(identifier, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsAdi"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityAccumulationDistributionIndex**](ApiResponseSecurityAccumulationDistributionIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsAdtv) + +[//]: # (RETURN_TYPE:ApiResponseSecurityAverageDailyTradingVolume) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAverageDailyTradingVolume.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsAdtv_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adtv) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsAdtv) + + +## **getSecurityPriceTechnicalsAdtv** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsAdtv_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityAverageDailyTradingVolume getSecurityPriceTechnicalsAdtv(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Average Daily Trading Volume + + +Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 22; // Integer | The number of observations, per period, to calculate Average Daily Trading Volume + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityAverageDailyTradingVolume result = securityApi.getSecurityPriceTechnicalsAdtv(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsAdtv"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Average Daily Trading Volume | [optional] [default to 22]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityAverageDailyTradingVolume**](ApiResponseSecurityAverageDailyTradingVolume.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsAdx) + +[//]: # (RETURN_TYPE:ApiResponseSecurityAverageDirectionalIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAverageDirectionalIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsAdx_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adx) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsAdx) + + +## **getSecurityPriceTechnicalsAdx** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsAdx_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityAverageDirectionalIndex getSecurityPriceTechnicalsAdx(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Average Directional Index + + +Returns the Average Directional Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 14; // Integer | The number of observations, per period, to calculate Average Directional Index + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityAverageDirectionalIndex result = securityApi.getSecurityPriceTechnicalsAdx(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsAdx"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Average Directional Index | [optional] [default to 14]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityAverageDirectionalIndex**](ApiResponseSecurityAverageDirectionalIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsAo) + +[//]: # (RETURN_TYPE:ApiResponseSecurityAwesomeOscillator) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAwesomeOscillator.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsAo_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/ao) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsAo) + + +## **getSecurityPriceTechnicalsAo** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsAo_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityAwesomeOscillator getSecurityPriceTechnicalsAo(identifier, shortPeriod, longPeriod, startDate, endDate, pageSize, nextPage) + +#### Awesome Oscillator + + +Returns the Awesome Oscillator values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer shortPeriod = 5; // Integer | The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator + Integer longPeriod = 34; // Integer | The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityAwesomeOscillator result = securityApi.getSecurityPriceTechnicalsAo(identifier, shortPeriod, longPeriod, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsAo"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **shortPeriod** | Integer| The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator | [optional] [default to 5]   + **longPeriod** | Integer| The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator | [optional] [default to 34]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityAwesomeOscillator**](ApiResponseSecurityAwesomeOscillator.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsAtr) + +[//]: # (RETURN_TYPE:ApiResponseSecurityAverageTrueRange) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAverageTrueRange.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsAtr_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/atr) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsAtr) + + +## **getSecurityPriceTechnicalsAtr** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsAtr_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityAverageTrueRange getSecurityPriceTechnicalsAtr(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Average True Range + + +Returns the Average True Range values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 14; // Integer | The number of observations, per period, to calculate Average True Range + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityAverageTrueRange result = securityApi.getSecurityPriceTechnicalsAtr(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsAtr"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Average True Range | [optional] [default to 14]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityAverageTrueRange**](ApiResponseSecurityAverageTrueRange.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsBb) + +[//]: # (RETURN_TYPE:ApiResponseSecurityBollingerBands) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityBollingerBands.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsBb_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/bb) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsBb) + + +## **getSecurityPriceTechnicalsBb** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsBb_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityBollingerBands getSecurityPriceTechnicalsBb(identifier, period, standardDeviations, priceKey, startDate, endDate, pageSize, nextPage) + +#### Bollinger Bands + + +Returns the Bollinger Bands values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 20; // Integer | The number of observations, per period, to calculate Bollinger Bands + Float standardDeviations = 2.0F; // Float | The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands + String priceKey = "close"; // String | The Stock Price field to use when calculating Bollinger Bands + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityBollingerBands result = securityApi.getSecurityPriceTechnicalsBb(identifier, period, standardDeviations, priceKey, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsBb"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Bollinger Bands | [optional] [default to 20]   + **standardDeviations** | Float| The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands | [optional] [default to 2.0]   + **priceKey** | String| The Stock Price field to use when calculating Bollinger Bands | [optional] [default to close] [enum: open, high, low, close, volume]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityBollingerBands**](ApiResponseSecurityBollingerBands.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsCci) + +[//]: # (RETURN_TYPE:ApiResponseSecurityCommodityChannelIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityCommodityChannelIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsCci_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/cci) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsCci) + + +## **getSecurityPriceTechnicalsCci** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsCci_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityCommodityChannelIndex getSecurityPriceTechnicalsCci(identifier, period, constant, startDate, endDate, pageSize, nextPage) + +#### Commodity Channel Index + + +Returns the Commodity Channel Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 20; // Integer | The number of observations, per period, to calculate Commodity Channel Index + Float constant = 0.015F; // Float | The number of observations, per period, to calculate Commodity Channel Index + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityCommodityChannelIndex result = securityApi.getSecurityPriceTechnicalsCci(identifier, period, constant, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsCci"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 20]   + **constant** | Float| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 0.015]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityCommodityChannelIndex**](ApiResponseSecurityCommodityChannelIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsCmf) + +[//]: # (RETURN_TYPE:ApiResponseSecurityChaikinMoneyFlow) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityChaikinMoneyFlow.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsCmf_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/cmf) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsCmf) + + +## **getSecurityPriceTechnicalsCmf** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsCmf_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityChaikinMoneyFlow getSecurityPriceTechnicalsCmf(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Chaikin Money Flow + + +Returns the Chaikin Money Flow values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 20; // Integer | The number of observations, per period, to calculate Chaikin Money Flow + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityChaikinMoneyFlow result = securityApi.getSecurityPriceTechnicalsCmf(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsCmf"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Chaikin Money Flow | [optional] [default to 20]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityChaikinMoneyFlow**](ApiResponseSecurityChaikinMoneyFlow.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsDc) + +[//]: # (RETURN_TYPE:ApiResponseSecurityDonchianChannel) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityDonchianChannel.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsDc_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/dc) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsDc) + + +## **getSecurityPriceTechnicalsDc** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsDc_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityDonchianChannel getSecurityPriceTechnicalsDc(identifier, period, priceKey, startDate, endDate, pageSize, nextPage) + +#### Donchian Channel + + +Returns the Donchian Channel values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 20; // Integer | The number of observations, per period, to calculate Donchian Channel + String priceKey = "close"; // String | The Stock Price field to use when calculating Donchian Channel + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityDonchianChannel result = securityApi.getSecurityPriceTechnicalsDc(identifier, period, priceKey, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsDc"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Donchian Channel | [optional] [default to 20]   + **priceKey** | String| The Stock Price field to use when calculating Donchian Channel | [optional] [default to close] [enum: open, high, low, close, volume]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityDonchianChannel**](ApiResponseSecurityDonchianChannel.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsDpo) + +[//]: # (RETURN_TYPE:ApiResponseSecurityDetrendedPriceOscillator) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityDetrendedPriceOscillator.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsDpo_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/dpo) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsDpo) + + +## **getSecurityPriceTechnicalsDpo** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsDpo_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityDetrendedPriceOscillator getSecurityPriceTechnicalsDpo(identifier, period, priceKey, startDate, endDate, pageSize, nextPage) + +#### Detrended Price Oscillator + + +Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 20; // Integer | The number of observations, per period, to calculate Detrended Price Oscillator + String priceKey = "close"; // String | The Stock Price field to use when calculating Detrended Price Oscillator + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityDetrendedPriceOscillator result = securityApi.getSecurityPriceTechnicalsDpo(identifier, period, priceKey, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsDpo"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Detrended Price Oscillator | [optional] [default to 20]   + **priceKey** | String| The Stock Price field to use when calculating Detrended Price Oscillator | [optional] [default to close] [enum: open, high, low, close, volume]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityDetrendedPriceOscillator**](ApiResponseSecurityDetrendedPriceOscillator.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsEom) + +[//]: # (RETURN_TYPE:ApiResponseSecurityEaseOfMovement) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityEaseOfMovement.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsEom_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/eom) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsEom) + + +## **getSecurityPriceTechnicalsEom** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsEom_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityEaseOfMovement getSecurityPriceTechnicalsEom(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Ease of Movement + + +Returns the Ease of Movement values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 20; // Integer | The number of observations, per period, to calculate Ease of Movement + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityEaseOfMovement result = securityApi.getSecurityPriceTechnicalsEom(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsEom"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Ease of Movement | [optional] [default to 20]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityEaseOfMovement**](ApiResponseSecurityEaseOfMovement.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsFi) + +[//]: # (RETURN_TYPE:ApiResponseSecurityForceIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityForceIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsFi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/fi) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsFi) + + +## **getSecurityPriceTechnicalsFi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsFi_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityForceIndex getSecurityPriceTechnicalsFi(identifier, startDate, endDate, pageSize, nextPage) + +#### Force Index + + +Returns the Force Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityForceIndex result = securityApi.getSecurityPriceTechnicalsFi(identifier, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsFi"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityForceIndex**](ApiResponseSecurityForceIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsIchimoku) + +[//]: # (RETURN_TYPE:ApiResponseSecurityIchimokuKinkoHyo) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityIchimokuKinkoHyo.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsIchimoku_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/ichimoku) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsIchimoku) + + +## **getSecurityPriceTechnicalsIchimoku** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsIchimoku_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityIchimokuKinkoHyo getSecurityPriceTechnicalsIchimoku(identifier, lowPeriod, mediumPeriod, highPeriod, startDate, endDate, pageSize, nextPage) + +#### Ichimoku Kinko Hyo + + +Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer lowPeriod = 9; // Integer | The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo + Integer mediumPeriod = 26; // Integer | The number of observations, per period, to calculate Kijun Sen (Base Line), Senkou Span A (Leading Span A), and Chikou Span (Lagging Span) of Ichimoku Kinko Hyo + Integer highPeriod = 52; // Integer | The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityIchimokuKinkoHyo result = securityApi.getSecurityPriceTechnicalsIchimoku(identifier, lowPeriod, mediumPeriod, highPeriod, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsIchimoku"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **lowPeriod** | Integer| The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo | [optional] [default to 9]   + **mediumPeriod** | Integer| The number of observations, per period, to calculate Kijun Sen (Base Line), Senkou Span A (Leading Span A), and Chikou Span (Lagging Span) of Ichimoku Kinko Hyo | [optional] [default to 26]   + **highPeriod** | Integer| The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo | [optional] [default to 52]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityIchimokuKinkoHyo**](ApiResponseSecurityIchimokuKinkoHyo.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsKc) + +[//]: # (RETURN_TYPE:ApiResponseSecurityKeltnerChannel) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityKeltnerChannel.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsKc_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/kc) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsKc) + + +## **getSecurityPriceTechnicalsKc** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsKc_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityKeltnerChannel getSecurityPriceTechnicalsKc(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Keltner Channel + + +Returns the Keltner Channel values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 10; // Integer | The number of observations, per period, to calculate Kelter Channel + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityKeltnerChannel result = securityApi.getSecurityPriceTechnicalsKc(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsKc"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Kelter Channel | [optional] [default to 10]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityKeltnerChannel**](ApiResponseSecurityKeltnerChannel.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsKst) + +[//]: # (RETURN_TYPE:ApiResponseSecurityKnowSureThing) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityKnowSureThing.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsKst_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/kst) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsKst) + + +## **getSecurityPriceTechnicalsKst** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsKst_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityKnowSureThing getSecurityPriceTechnicalsKst(identifier, roc1, roc2, roc3, roc4, sma1, sma2, sma3, sma4, priceKey, startDate, endDate, pageSize, nextPage) + +#### Know Sure Thing + + +Returns the Know Sure Thing values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer roc1 = 10; // Integer | The number of observations, per period, to calculate the rate-of-change for RCMA1 + Integer roc2 = 15; // Integer | The number of observations, per period, to calculate the rate-of-change for RCMA2 + Integer roc3 = 20; // Integer | The number of observations, per period, to calculate the rate-of-change for RCMA3 + Integer roc4 = 30; // Integer | The number of observations, per period, to calculate the rate-of-change for RCMA4 + Integer sma1 = 10; // Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA1 + Integer sma2 = 10; // Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA2 + Integer sma3 = 10; // Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA3 + Integer sma4 = 15; // Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA4 + String priceKey = "close"; // String | The Stock Price field to use when calculating Know Sure Thing + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityKnowSureThing result = securityApi.getSecurityPriceTechnicalsKst(identifier, roc1, roc2, roc3, roc4, sma1, sma2, sma3, sma4, priceKey, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsKst"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **roc1** | Integer| The number of observations, per period, to calculate the rate-of-change for RCMA1 | [optional] [default to 10]   + **roc2** | Integer| The number of observations, per period, to calculate the rate-of-change for RCMA2 | [optional] [default to 15]   + **roc3** | Integer| The number of observations, per period, to calculate the rate-of-change for RCMA3 | [optional] [default to 20]   + **roc4** | Integer| The number of observations, per period, to calculate the rate-of-change for RCMA4 | [optional] [default to 30]   + **sma1** | Integer| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA1 | [optional] [default to 10]   + **sma2** | Integer| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA2 | [optional] [default to 10]   + **sma3** | Integer| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA3 | [optional] [default to 10]   + **sma4** | Integer| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA4 | [optional] [default to 15]   + **priceKey** | String| The Stock Price field to use when calculating Know Sure Thing | [optional] [default to close] [enum: open, high, low, close, volume]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityKnowSureThing**](ApiResponseSecurityKnowSureThing.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsMacd) + +[//]: # (RETURN_TYPE:ApiResponseSecurityMovingAverageConvergenceDivergence) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityMovingAverageConvergenceDivergence.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsMacd_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/macd) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsMacd) + + +## **getSecurityPriceTechnicalsMacd** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsMacd_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityMovingAverageConvergenceDivergence getSecurityPriceTechnicalsMacd(identifier, fastPeriod, slowPeriod, signalPeriod, priceKey, startDate, endDate, pageSize, nextPage) + +#### Moving Average Convergence Divergence + + +Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer fastPeriod = 12; // Integer | The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence + Integer slowPeriod = 26; // Integer | The number of observations, per period, to calculate the slow moving Exponential Moving Average for Moving Average Convergence Divergence + Integer signalPeriod = 9; // Integer | The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence + String priceKey = "close"; // String | The Stock Price field to use when calculating Moving Average Convergence Divergence + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityMovingAverageConvergenceDivergence result = securityApi.getSecurityPriceTechnicalsMacd(identifier, fastPeriod, slowPeriod, signalPeriod, priceKey, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsMacd"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **fastPeriod** | Integer| The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence | [optional] [default to 12]   + **slowPeriod** | Integer| The number of observations, per period, to calculate the slow moving Exponential Moving Average for Moving Average Convergence Divergence | [optional] [default to 26]   + **signalPeriod** | Integer| The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence | [optional] [default to 9]   + **priceKey** | String| The Stock Price field to use when calculating Moving Average Convergence Divergence | [optional] [default to close] [enum: open, high, low, close, volume]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityMovingAverageConvergenceDivergence**](ApiResponseSecurityMovingAverageConvergenceDivergence.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsMfi) + +[//]: # (RETURN_TYPE:ApiResponseSecurityMoneyFlowIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityMoneyFlowIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsMfi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/mfi) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsMfi) + + +## **getSecurityPriceTechnicalsMfi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsMfi_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityMoneyFlowIndex getSecurityPriceTechnicalsMfi(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Money Flow Index + + +Returns the Money Flow Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 14; // Integer | The number of observations, per period, to calculate Money Flow Index + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityMoneyFlowIndex result = securityApi.getSecurityPriceTechnicalsMfi(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsMfi"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Money Flow Index | [optional] [default to 14]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityMoneyFlowIndex**](ApiResponseSecurityMoneyFlowIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsMi) + +[//]: # (RETURN_TYPE:ApiResponseSecurityMassIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityMassIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsMi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/mi) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsMi) + + +## **getSecurityPriceTechnicalsMi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsMi_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityMassIndex getSecurityPriceTechnicalsMi(identifier, emaPeriod, sumPeriod, startDate, endDate, pageSize, nextPage) + +#### Mass Index + + +Returns the Mass Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer emaPeriod = 9; // Integer | The number of observations, per period, to calculate the single Exponential Moving Average and the Double Exponential Moving Average for Mass Index + Integer sumPeriod = 25; // Integer | The number of observations, per period, to calculate the sum of the Exponetinal Moving Average Ratios for Mass Index + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityMassIndex result = securityApi.getSecurityPriceTechnicalsMi(identifier, emaPeriod, sumPeriod, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsMi"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **emaPeriod** | Integer| The number of observations, per period, to calculate the single Exponential Moving Average and the Double Exponential Moving Average for Mass Index | [optional] [default to 9]   + **sumPeriod** | Integer| The number of observations, per period, to calculate the sum of the Exponetinal Moving Average Ratios for Mass Index | [optional] [default to 25]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityMassIndex**](ApiResponseSecurityMassIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsNvi) + +[//]: # (RETURN_TYPE:ApiResponseSecurityNegativeVolumeIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityNegativeVolumeIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsNvi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/nvi) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsNvi) + + +## **getSecurityPriceTechnicalsNvi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsNvi_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityNegativeVolumeIndex getSecurityPriceTechnicalsNvi(identifier, startDate, endDate, pageSize, nextPage) + +#### Negative Volume Index + + +Returns the Negative Volume Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityNegativeVolumeIndex result = securityApi.getSecurityPriceTechnicalsNvi(identifier, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsNvi"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityNegativeVolumeIndex**](ApiResponseSecurityNegativeVolumeIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsObv) + +[//]: # (RETURN_TYPE:ApiResponseSecurityOnBalanceVolume) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityOnBalanceVolume.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsObv_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/obv) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsObv) + + +## **getSecurityPriceTechnicalsObv** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsObv_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityOnBalanceVolume getSecurityPriceTechnicalsObv(identifier, startDate, endDate, pageSize, nextPage) + +#### On-balance Volume + + +Returns the On-balance Volume values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityOnBalanceVolume result = securityApi.getSecurityPriceTechnicalsObv(identifier, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsObv"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityOnBalanceVolume**](ApiResponseSecurityOnBalanceVolume.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsObvMean) + +[//]: # (RETURN_TYPE:ApiResponseSecurityOnBalanceVolumeMean) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityOnBalanceVolumeMean.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsObvMean_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/obv_mean) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsObvMean) + + +## **getSecurityPriceTechnicalsObvMean** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsObvMean_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityOnBalanceVolumeMean getSecurityPriceTechnicalsObvMean(identifier, period, startDate, endDate, pageSize, nextPage) + +#### On-balance Volume Mean + + +Returns the On-balance Volume Mean values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 10; // Integer | The number of observations, per period, to calculate On-balance Volume Mean + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityOnBalanceVolumeMean result = securityApi.getSecurityPriceTechnicalsObvMean(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsObvMean"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate On-balance Volume Mean | [optional] [default to 10]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityOnBalanceVolumeMean**](ApiResponseSecurityOnBalanceVolumeMean.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsRsi) + +[//]: # (RETURN_TYPE:ApiResponseSecurityRelativeStrengthIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityRelativeStrengthIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsRsi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/rsi) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsRsi) + + +## **getSecurityPriceTechnicalsRsi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsRsi_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityRelativeStrengthIndex getSecurityPriceTechnicalsRsi(identifier, period, priceKey, startDate, endDate, pageSize, nextPage) + +#### Relative Strength Index + + +Returns the Relative Strength Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 14; // Integer | The number of observations, per period, to calculate Relative Strength Index + String priceKey = "close"; // String | The Stock Price field to use when calculating Relative Strength Index + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityRelativeStrengthIndex result = securityApi.getSecurityPriceTechnicalsRsi(identifier, period, priceKey, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsRsi"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Relative Strength Index | [optional] [default to 14]   + **priceKey** | String| The Stock Price field to use when calculating Relative Strength Index | [optional] [default to close] [enum: open, high, low, close, volume]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityRelativeStrengthIndex**](ApiResponseSecurityRelativeStrengthIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsSma) + +[//]: # (RETURN_TYPE:ApiResponseSecuritySimpleMovingAverage) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecuritySimpleMovingAverage.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsSma_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/sma) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsSma) + + +## **getSecurityPriceTechnicalsSma** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsSma_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecuritySimpleMovingAverage getSecurityPriceTechnicalsSma(identifier, period, priceKey, startDate, endDate, pageSize, nextPage) + +#### Simple Moving Average + + +Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 20; // Integer | The number of observations, per period, to calculate Simple Moving Average + String priceKey = "close"; // String | The Stock Price field to use when calculating Simple Moving Average + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecuritySimpleMovingAverage result = securityApi.getSecurityPriceTechnicalsSma(identifier, period, priceKey, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsSma"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Simple Moving Average | [optional] [default to 20]   + **priceKey** | String| The Stock Price field to use when calculating Simple Moving Average | [optional] [default to close] [enum: open, high, low, close, volume]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecuritySimpleMovingAverage**](ApiResponseSecuritySimpleMovingAverage.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsSr) + +[//]: # (RETURN_TYPE:ApiResponseSecurityStochasticOscillator) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityStochasticOscillator.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsSr_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/sr) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsSr) + + +## **getSecurityPriceTechnicalsSr** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsSr_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityStochasticOscillator getSecurityPriceTechnicalsSr(identifier, period, signalPeriod, startDate, endDate, pageSize, nextPage) + +#### Stochastic Oscillator + + +Returns the Stochastic Oscillator values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 14; // Integer | The number of observations, per period, to calculate %K of Stochastic Oscillator + Integer signalPeriod = 3; // Integer | The number of observations, per period, to calculate the %D (the Simple Moving Average of %K) as a signal line for Stochastic Oscillator + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityStochasticOscillator result = securityApi.getSecurityPriceTechnicalsSr(identifier, period, signalPeriod, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsSr"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate %K of Stochastic Oscillator | [optional] [default to 14]   + **signalPeriod** | Integer| The number of observations, per period, to calculate the %D (the Simple Moving Average of %K) as a signal line for Stochastic Oscillator | [optional] [default to 3]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityStochasticOscillator**](ApiResponseSecurityStochasticOscillator.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsTrix) + +[//]: # (RETURN_TYPE:ApiResponseSecurityTripleExponentialAverage) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityTripleExponentialAverage.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsTrix_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/trix) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsTrix) + + +## **getSecurityPriceTechnicalsTrix** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsTrix_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityTripleExponentialAverage getSecurityPriceTechnicalsTrix(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Triple Exponential Average + + +Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 15; // Integer | The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityTripleExponentialAverage result = securityApi.getSecurityPriceTechnicalsTrix(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsTrix"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average | [optional] [default to 15]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityTripleExponentialAverage**](ApiResponseSecurityTripleExponentialAverage.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsTsi) + +[//]: # (RETURN_TYPE:ApiResponseSecurityTrueStrengthIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityTrueStrengthIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsTsi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/tsi) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsTsi) + + +## **getSecurityPriceTechnicalsTsi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsTsi_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityTrueStrengthIndex getSecurityPriceTechnicalsTsi(identifier, lowPeriod, highPeriod, priceKey, startDate, endDate, pageSize, nextPage) + +#### True Strength Index + + +Returns the True Strength Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer lowPeriod = 13; // Integer | The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index + Integer highPeriod = 25; // Integer | The number of observations, per period, to calculate high period Exponential Moving Average for smoothing in True Strength Index + String priceKey = "close"; // String | The Stock Price field to use when calculating True Strength Index + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityTrueStrengthIndex result = securityApi.getSecurityPriceTechnicalsTsi(identifier, lowPeriod, highPeriod, priceKey, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsTsi"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **lowPeriod** | Integer| The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index | [optional] [default to 13]   + **highPeriod** | Integer| The number of observations, per period, to calculate high period Exponential Moving Average for smoothing in True Strength Index | [optional] [default to 25]   + **priceKey** | String| The Stock Price field to use when calculating True Strength Index | [optional] [default to close] [enum: open, high, low, close, volume]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityTrueStrengthIndex**](ApiResponseSecurityTrueStrengthIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsUo) + +[//]: # (RETURN_TYPE:ApiResponseSecurityUltimateOscillator) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityUltimateOscillator.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsUo_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/uo) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsUo) + + +## **getSecurityPriceTechnicalsUo** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsUo_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityUltimateOscillator getSecurityPriceTechnicalsUo(identifier, shortPeriod, mediumPeriod, longPeriod, shortWeight, mediumWeight, longWeight, startDate, endDate, pageSize, nextPage) + +#### Ultimate Oscillator + + +Returns the Ultimate Oscillator values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer shortPeriod = 7; // Integer | The number of observations, per period, to calculate the short period for Ultimate Oscillator + Integer mediumPeriod = 14; // Integer | The number of observations, per period, to calculate the medium period for Ultimate Oscillator + Integer longPeriod = 28; // Integer | The number of observations, per period, to calculate the long period for Ultimate Oscillator + Float shortWeight = 4.0F; // Float | The weight of short Buying Pressure average for Ultimate Oscillator + Float mediumWeight = 2.0F; // Float | The weight of medium Buying Pressure average for Ultimate Oscillator + Float longWeight = 1.0F; // Float | The weight of long Buying Pressure average for Ultimate Oscillator + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityUltimateOscillator result = securityApi.getSecurityPriceTechnicalsUo(identifier, shortPeriod, mediumPeriod, longPeriod, shortWeight, mediumWeight, longWeight, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsUo"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **shortPeriod** | Integer| The number of observations, per period, to calculate the short period for Ultimate Oscillator | [optional] [default to 7]   + **mediumPeriod** | Integer| The number of observations, per period, to calculate the medium period for Ultimate Oscillator | [optional] [default to 14]   + **longPeriod** | Integer| The number of observations, per period, to calculate the long period for Ultimate Oscillator | [optional] [default to 28]   + **shortWeight** | Float| The weight of short Buying Pressure average for Ultimate Oscillator | [optional] [default to 4.0]   + **mediumWeight** | Float| The weight of medium Buying Pressure average for Ultimate Oscillator | [optional] [default to 2.0]   + **longWeight** | Float| The weight of long Buying Pressure average for Ultimate Oscillator | [optional] [default to 1.0]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityUltimateOscillator**](ApiResponseSecurityUltimateOscillator.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsVi) + +[//]: # (RETURN_TYPE:ApiResponseSecurityVortexIndicator) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityVortexIndicator.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsVi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vi) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsVi) + + +## **getSecurityPriceTechnicalsVi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsVi_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityVortexIndicator getSecurityPriceTechnicalsVi(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Vortex Indicator + + +Returns the Vortex Indicator values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 14; // Integer | The number of observations, per period, to calculate Vortex Indicator + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityVortexIndicator result = securityApi.getSecurityPriceTechnicalsVi(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsVi"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Vortex Indicator | [optional] [default to 14]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityVortexIndicator**](ApiResponseSecurityVortexIndicator.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsVpt) + +[//]: # (RETURN_TYPE:ApiResponseSecurityVolumePriceTrend) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityVolumePriceTrend.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsVpt_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vpt) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsVpt) + + +## **getSecurityPriceTechnicalsVpt** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsVpt_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityVolumePriceTrend getSecurityPriceTechnicalsVpt(identifier, startDate, endDate, pageSize, nextPage) + +#### Volume-price Trend + + +Returns the Volume-price Trend values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityVolumePriceTrend result = securityApi.getSecurityPriceTechnicalsVpt(identifier, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsVpt"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityVolumePriceTrend**](ApiResponseSecurityVolumePriceTrend.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsVwap) + +[//]: # (RETURN_TYPE:ApiResponseSecurityVolumeWeightedAveragePrice) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityVolumeWeightedAveragePrice.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsVwap_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vwap) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsVwap) + + +## **getSecurityPriceTechnicalsVwap** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsVwap_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityVolumeWeightedAveragePrice getSecurityPriceTechnicalsVwap(identifier, startDate, endDate, pageSize, nextPage) + +#### Volume Weighted Average Price + + +Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityVolumeWeightedAveragePrice result = securityApi.getSecurityPriceTechnicalsVwap(identifier, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsVwap"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityVolumeWeightedAveragePrice**](ApiResponseSecurityVolumeWeightedAveragePrice.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsWr) + +[//]: # (RETURN_TYPE:ApiResponseSecurityWilliamsR) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityWilliamsR.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsWr_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/wr) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityPriceTechnicalsWr) + + +## **getSecurityPriceTechnicalsWr** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsWr_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityWilliamsR getSecurityPriceTechnicalsWr(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Williams %R + + +Returns the Williams %R values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 14; // Integer | The number of observations, per period, to look-back when calculating Williams %R + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + BigDecimal pageSize = null; // BigDecimal | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityWilliamsR result = securityApi.getSecurityPriceTechnicalsWr(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityPriceTechnicalsWr"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to look-back when calculating Williams %R | [optional] [default to 14]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | BigDecimal| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityWilliamsR**](ApiResponseSecurityWilliamsR.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityRealtimePrice) + +[//]: # (RETURN_TYPE:RealtimeStockPrice) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:RealtimeStockPrice.md) + +[//]: # (OPERATION:getSecurityRealtimePrice_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/realtime) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityRealtimePrice) + + +## **getSecurityRealtimePrice** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityRealtimePrice_v2) + +[//]: # (START_OVERVIEW) + +> RealtimeStockPrice getSecurityRealtimePrice(identifier, source) + +#### Realtime Stock Price for Security + + +Return the realtime stock price for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String source = null; // String | Return the realtime price from the specified data source. If no source is specified, the best source available is used. + + try { + RealtimeStockPrice result = securityApi.getSecurityRealtimePrice(identifier, source); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityRealtimePrice"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **source** | String| Return the realtime price from the specified data source. If no source is specified, the best source available is used. | [optional] [enum: iex, bats, bats_delayed, utp_delayed, cta_a_delayed, cta_b_delayed]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**RealtimeStockPrice**](RealtimeStockPrice.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityStockPriceAdjustments) + +[//]: # (RETURN_TYPE:ApiResponseSecurityStockPriceAdjustments) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityStockPriceAdjustments.md) + +[//]: # (OPERATION:getSecurityStockPriceAdjustments_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/adjustments) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityStockPriceAdjustments) + + +## **getSecurityStockPriceAdjustments** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityStockPriceAdjustments_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityStockPriceAdjustments getSecurityStockPriceAdjustments(identifier, startDate, endDate, pageSize, nextPage) + +#### Stock Price Adjustments by Security + + +Returns stock price adjustments for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + LocalDate startDate = LocalDate.now(); // LocalDate | Return price adjustments on or after the date + LocalDate endDate = LocalDate.now(); // LocalDate | Return price adjustments on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityStockPriceAdjustments result = securityApi.getSecurityStockPriceAdjustments(identifier, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityStockPriceAdjustments"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **startDate** | LocalDate| Return price adjustments on or after the date | [optional]   + **endDate** | LocalDate| Return price adjustments on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityStockPriceAdjustments**](ApiResponseSecurityStockPriceAdjustments.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityStockPrices) + +[//]: # (RETURN_TYPE:ApiResponseSecurityStockPrices) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityStockPrices.md) + +[//]: # (OPERATION:getSecurityStockPrices_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityStockPrices) + + +## **getSecurityStockPrices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityStockPrices_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityStockPrices getSecurityStockPrices(identifier, startDate, endDate, frequency, pageSize, nextPage) + +#### Stock Prices by Security + + +Return end-of-day stock prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + LocalDate startDate = LocalDate.now(); // LocalDate | Return prices on or after the date + LocalDate endDate = LocalDate.now(); // LocalDate | Return prices on or before the date + String frequency = "daily"; // String | Return stock prices in the given frequency + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityStockPrices result = securityApi.getSecurityStockPrices(identifier, startDate, endDate, frequency, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityStockPrices"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **startDate** | LocalDate| Return prices on or after the date | [optional]   + **endDate** | LocalDate| Return prices on or before the date | [optional]   + **frequency** | String| Return stock prices in the given frequency | [optional] [default to daily] [enum: daily, weekly, monthly, quarterly, yearly]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityStockPrices**](ApiResponseSecurityStockPrices.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityZacksAnalystRatings) + +[//]: # (RETURN_TYPE:ApiResponseSecurityZacksAnalystRatings) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityZacksAnalystRatings.md) + +[//]: # (OPERATION:getSecurityZacksAnalystRatings_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/zacks/analyst_ratings) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityZacksAnalystRatings) + + +## **getSecurityZacksAnalystRatings** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityZacksAnalystRatings_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityZacksAnalystRatings getSecurityZacksAnalystRatings(identifier, startDate, endDate, meanGreater, meanLess, strongBuysGreater, strongBuysLess, buysGreater, buysLess, holdsGreater, holdsLess, sellsGreater, sellsLess, strongSellsGreater, strongSellsLess, totalGreater, totalLess, pageSize) + +#### Zacks Analyst Ratings + + +Returns buy, sell, and hold recommendations from analysts at brokerages for the Security with the given `identifier`. Zack’s storied research team aggregates and validates the ratings from professional analysts. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String startDate = null; // String | Limit ratings to those on or after this date + String endDate = null; // String | Limit ratings to those on or before this date + BigDecimal meanGreater = null; // BigDecimal | Return only records with a mean (average) higher than this value + BigDecimal meanLess = null; // BigDecimal | Return only records with a mean (average) lower than this value + Integer strongBuysGreater = null; // Integer | Return only records with more than this many Strong Buy recommendations + Integer strongBuysLess = null; // Integer | Return only records with fewer than this many Strong Buy recommendations + Integer buysGreater = null; // Integer | Return only records with more than this many Buy recommendations + Integer buysLess = null; // Integer | Return only records with fewer than this many Buy recommendations + Integer holdsGreater = null; // Integer | Return only records with more than this many Hold recommendations + Integer holdsLess = null; // Integer | Return only records with fewer than this many Hold recommendations + Integer sellsGreater = null; // Integer | Return only records with more than this many Sell recommendations + Integer sellsLess = null; // Integer | Return only records with fewer than this many Sell recommendations + Integer strongSellsGreater = null; // Integer | Return only records with more than this many Strong Sell recommendations + Integer strongSellsLess = null; // Integer | Return only records with fewer than this many Strong Sell recommendations + Integer totalGreater = null; // Integer | Return only records with more than this many recommendations, regardless of type + Integer totalLess = null; // Integer | Return only records with fewer than this many recommendations, regardless of type + Integer pageSize = 100; // Integer | The number of results to return + + try { + ApiResponseSecurityZacksAnalystRatings result = securityApi.getSecurityZacksAnalystRatings(identifier, startDate, endDate, meanGreater, meanLess, strongBuysGreater, strongBuysLess, buysGreater, buysLess, holdsGreater, holdsLess, sellsGreater, sellsLess, strongSellsGreater, strongSellsLess, totalGreater, totalLess, pageSize); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityZacksAnalystRatings"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **startDate** | String| Limit ratings to those on or after this date | [optional]   + **endDate** | String| Limit ratings to those on or before this date | [optional]   + **meanGreater** | BigDecimal| Return only records with a mean (average) higher than this value | [optional]   + **meanLess** | BigDecimal| Return only records with a mean (average) lower than this value | [optional]   + **strongBuysGreater** | Integer| Return only records with more than this many Strong Buy recommendations | [optional]   + **strongBuysLess** | Integer| Return only records with fewer than this many Strong Buy recommendations | [optional]   + **buysGreater** | Integer| Return only records with more than this many Buy recommendations | [optional]   + **buysLess** | Integer| Return only records with fewer than this many Buy recommendations | [optional]   + **holdsGreater** | Integer| Return only records with more than this many Hold recommendations | [optional]   + **holdsLess** | Integer| Return only records with fewer than this many Hold recommendations | [optional]   + **sellsGreater** | Integer| Return only records with more than this many Sell recommendations | [optional]   + **sellsLess** | Integer| Return only records with fewer than this many Sell recommendations | [optional]   + **strongSellsGreater** | Integer| Return only records with more than this many Strong Sell recommendations | [optional]   + **strongSellsLess** | Integer| Return only records with fewer than this many Strong Sell recommendations | [optional]   + **totalGreater** | Integer| Return only records with more than this many recommendations, regardless of type | [optional]   + **totalLess** | Integer| Return only records with fewer than this many recommendations, regardless of type | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityZacksAnalystRatings**](ApiResponseSecurityZacksAnalystRatings.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityZacksAnalystRatingsSnapshot) + +[//]: # (RETURN_TYPE:ApiResponseSecurityZacksAnalystRatingsSnapshot) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityZacksAnalystRatingsSnapshot.md) + +[//]: # (OPERATION:getSecurityZacksAnalystRatingsSnapshot_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/zacks/analyst_ratings/snapshot) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityZacksAnalystRatingsSnapshot) + + +## **getSecurityZacksAnalystRatingsSnapshot** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityZacksAnalystRatingsSnapshot_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityZacksAnalystRatingsSnapshot getSecurityZacksAnalystRatingsSnapshot(identifier, date) + +#### Zacks Analyst Ratings Snapshot + + +Returns a snapshot of ratings data compared with previous timeframes for the Security with the given `identifier`. Also returns mean percentiles for comparing one security to the universe of securities covered by Zacks analyst ratings, at a specific point in time. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String date = null; // String | Lookup a historical snapshot on the given date + + try { + ApiResponseSecurityZacksAnalystRatingsSnapshot result = securityApi.getSecurityZacksAnalystRatingsSnapshot(identifier, date); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityZacksAnalystRatingsSnapshot"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **date** | String| Lookup a historical snapshot on the given date | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityZacksAnalystRatingsSnapshot**](ApiResponseSecurityZacksAnalystRatingsSnapshot.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityZacksEpsSurprises) + +[//]: # (RETURN_TYPE:ApiResponseSecurityZacksEPSSurprises) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityZacksEPSSurprises.md) + +[//]: # (OPERATION:getSecurityZacksEpsSurprises_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/zacks/eps_surprises) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityZacksEpsSurprises) + + +## **getSecurityZacksEpsSurprises** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityZacksEpsSurprises_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityZacksEPSSurprises getSecurityZacksEpsSurprises(identifier, pageSize, nextPage) + +#### Zacks EPS Surprises for Security + + +Return Zacks EPS surprises for the Security with the given `identifier`. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityZacksEPSSurprises result = securityApi.getSecurityZacksEpsSurprises(identifier, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityZacksEpsSurprises"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityZacksEPSSurprises**](ApiResponseSecurityZacksEPSSurprises.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:getSecurityZacksSalesSurprises) + +[//]: # (RETURN_TYPE:ApiResponseSecurityZacksSalesSurprises) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityZacksSalesSurprises.md) + +[//]: # (OPERATION:getSecurityZacksSalesSurprises_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/zacks/sales_surprises) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecurityZacksSalesSurprises) + + +## **getSecurityZacksSalesSurprises** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityZacksSalesSurprises_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityZacksSalesSurprises getSecurityZacksSalesSurprises(identifier, pageSize, nextPage) + +#### Zacks Sales Surprises for Security + + +Return Zacks sales surprises for the Security with the given `identifier`. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityZacksSalesSurprises result = securityApi.getSecurityZacksSalesSurprises(identifier, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#getSecurityZacksSalesSurprises"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityZacksSalesSurprises**](ApiResponseSecurityZacksSalesSurprises.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:screenSecurities) + +[//]: # (RETURN_TYPE:List) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:SecurityScreenResult.md) + +[//]: # (OPERATION:screenSecurities_v2) + +[//]: # (ENDPOINT:/securities/screen) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#screenSecurities) + + +## **screenSecurities** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/screenSecurities_v2) + +[//]: # (START_OVERVIEW) + +> List<SecurityScreenResult> screenSecurities(logic, orderColumn, orderDirection, primaryOnly, pageSize) + +#### Screen Securities + + +Screen Securities using complex logic + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + SecurityScreenGroup logic = new SecurityScreenGroup(); // SecurityScreenGroup | The logic to screen with, consisting of operators, clauses, and nested groups.
See screener documentation for details on how to construct conditions. + String orderColumn = "marketcap"; // String | Results returned sorted by this column + String orderDirection = "asc"; // String | Sort order to use with the order_column + Boolean primaryOnly = false; // Boolean | Return only primary securities + Integer pageSize = 100; // Integer | The number of results to return. Maximum for this endpoint is 50000. + + try { + List result = securityApi.screenSecurities(logic, orderColumn, orderDirection, primaryOnly, pageSize); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#screenSecurities"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **logic** | [**SecurityScreenGroup**](SecurityScreenGroup.md)| The logic to screen with, consisting of operators, clauses, and nested groups.<br/> See <a href=\"https://docs.intrinio.com/documentation/screener_v2\" target=\"_blank\">screener documentation</a> for details on how to construct conditions. | [optional]   + **orderColumn** | String| Results returned sorted by this column | [optional]   + **orderDirection** | String| Sort order to use with the order_column | [optional] [default to asc] [enum: asc, desc]   + **primaryOnly** | Boolean| Return only primary securities | [optional] [default to false]   + **pageSize** | Integer| The number of results to return. Maximum for this endpoint is 50000. | [optional] [default to 100]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**List<SecurityScreenResult>**](SecurityScreenResult.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:SecurityApi) + +[//]: # (METHOD:searchSecurities) + +[//]: # (RETURN_TYPE:ApiResponseSecuritiesSearch) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecuritiesSearch.md) + +[//]: # (OPERATION:searchSecurities_v2) + +[//]: # (ENDPOINT:/securities/search) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#searchSecurities) + + +## **searchSecurities** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/searchSecurities_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecuritiesSearch searchSecurities(query, pageSize) + +#### Search Securities + + +Searches for Securities matching the text `query` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + SecurityApi securityApi = new SecurityApi(); + + String query = "Apple"; // String | + Integer pageSize = 100; // Integer | The number of results to return + + try { + ApiResponseSecuritiesSearch result = securityApi.searchSecurities(query, pageSize); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling SecurityApi#searchSecurities"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | String| |   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecuritiesSearch**](ApiResponseSecuritiesSearch.md) + +[//]: # (END_OPERATION) + diff --git a/docs/SecurityScreenClause.md b/docs/SecurityScreenClause.md new file mode 100644 index 0000000..6808d13 --- /dev/null +++ b/docs/SecurityScreenClause.md @@ -0,0 +1,36 @@ + +[//]: # (CLASS:SecurityScreenClause) + +[//]: # (KIND:object) + +### SecurityScreenClause + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**field** | String | The field to use when screening, such as an Intrinio Data Tag   +**operator** | OperatorEnum | The logic operator to use when screening   +**value** | String | The value to screen by   + +[//]: # (END_DEFINITION) + + + +
+ +#### Enum: OperatorEnum + +Name | Value +---- | ----- +EQ | "eq" +GT | "gt" +GTE | "gte" +LT | "lt" +LTE | "lte" +CONTAINS | "contains" + + + diff --git a/docs/SecurityScreenGroup.md b/docs/SecurityScreenGroup.md new file mode 100644 index 0000000..c770407 --- /dev/null +++ b/docs/SecurityScreenGroup.md @@ -0,0 +1,29 @@ + +[//]: # (CLASS:SecurityScreenGroup) + +[//]: # (KIND:object) + +### SecurityScreenGroup + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**operator** | String | The logic operator for the group (AND, OR, NOT)   +**clauses** | [**List<SecurityScreenClause>**](SecurityScreenClause.md) | The logic clauses in the group   +**groups** | [**List<SecurityScreenGroup>**](SecurityScreenGroup.md) | The nested groups within the group   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:SecurityScreenClause) + + +[//]: # (CONTAINED_CLASS:SecurityScreenGroup) + + + + + diff --git a/docs/SecurityScreenResult.md b/docs/SecurityScreenResult.md new file mode 100644 index 0000000..a2e4710 --- /dev/null +++ b/docs/SecurityScreenResult.md @@ -0,0 +1,28 @@ + +[//]: # (CLASS:SecurityScreenResult) + +[//]: # (KIND:object) + +### SecurityScreenResult + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**security** | [**SecuritySummary**](SecuritySummary.md) |   +**data** | [**List<SecurityScreenResultData>**](SecurityScreenResultData.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + +[//]: # (CONTAINED_CLASS:SecurityScreenResultData) + + + + + diff --git a/docs/SecurityScreenResultData.md b/docs/SecurityScreenResultData.md new file mode 100644 index 0000000..5ffe191 --- /dev/null +++ b/docs/SecurityScreenResultData.md @@ -0,0 +1,23 @@ + +[//]: # (CLASS:SecurityScreenResultData) + +[//]: # (KIND:object) + +### SecurityScreenResultData + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**tag** | String | The data tag that was screened-for   +**numberValue** | String | The numeric value for the tag   +**textValue** | String | The text value for the tag   + +[//]: # (END_DEFINITION) + + + + + diff --git a/docs/SecuritySummary.md b/docs/SecuritySummary.md new file mode 100644 index 0000000..720753f --- /dev/null +++ b/docs/SecuritySummary.md @@ -0,0 +1,30 @@ + +[//]: # (CLASS:SecuritySummary) + +[//]: # (KIND:object) + +### SecuritySummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for Security   +**companyId** | String | The Intrinio ID for the Company for which the Security is issued   +**name** | String | The name of the Security   +**code** | String | A 2-3 digit code classifying the Security (<a href=\"https://docs.intrinio.com/documentation/security_codes\" target=\"_blank\">reference</a>)   +**currency** | String | The currency in which the Security is traded on the exchange   +**ticker** | String | The common/local ticker of the Security   +**compositeTicker** | String | The country-composite ticker of the Security   +**figi** | String | The OpenFIGI identifier   +**compositeFigi** | String | The country-composite OpenFIGI identifier   +**shareClassFigi** | String | The global-composite OpenFIGI identifier   + +[//]: # (END_DEFINITION) + + + + + diff --git a/docs/SimpleMovingAverageTechnicalValue.md b/docs/SimpleMovingAverageTechnicalValue.md new file mode 100644 index 0000000..2773d5a --- /dev/null +++ b/docs/SimpleMovingAverageTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:SimpleMovingAverageTechnicalValue) + +[//]: # (KIND:object) + +### SimpleMovingAverageTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**sma** | Float | The Simple Moving Average calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/StandardizedFinancial.md b/docs/StandardizedFinancial.md new file mode 100644 index 0000000..a6c395a --- /dev/null +++ b/docs/StandardizedFinancial.md @@ -0,0 +1,28 @@ + +[//]: # (CLASS:StandardizedFinancial) + +[//]: # (KIND:object) + +### StandardizedFinancial + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dataTag** | [**DataTagSummary**](DataTagSummary.md) |   +**value** | [**BigDecimal**](BigDecimal.md) | The value for the Data Tag within the scope of the Fundamental   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:DataTagSummary) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/StochasticOscillatorTechnicalValue.md b/docs/StochasticOscillatorTechnicalValue.md new file mode 100644 index 0000000..90b5afa --- /dev/null +++ b/docs/StochasticOscillatorTechnicalValue.md @@ -0,0 +1,26 @@ + +[//]: # (CLASS:StochasticOscillatorTechnicalValue) + +[//]: # (KIND:object) + +### StochasticOscillatorTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**sr** | Float | The Stochastic Oscillator calculation value   +**srSignal** | Float | The Stochastic Oscillator signal line value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/StockExchange.md b/docs/StockExchange.md new file mode 100644 index 0000000..c1520aa --- /dev/null +++ b/docs/StockExchange.md @@ -0,0 +1,36 @@ + +[//]: # (CLASS:StockExchange) + +[//]: # (KIND:object) + +### StockExchange + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for the Stock Exchange   +**name** | String | The name of the exchange   +**mic** | String | The Market Identifier Code (MIC) of the exchange   +**acronym** | String | The acronym of the exchange's name   +**city** | String | The city in which the exchange is located   +**country** | String | The country in which the exchange is located   +**countryCode** | String | The 2-digit code of the exchange's country   +**website** | String | The website of the exchange   +**firstStockPriceDate** | [**LocalDate**](LocalDate.md) | The earliest date for which Intrinio has stock prices for the exchange   +**lastStockPriceDate** | [**LocalDate**](LocalDate.md) | The latest date for which Intrinio has stock prices for the exchange   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + + + + diff --git a/docs/StockExchangeApi.md b/docs/StockExchangeApi.md new file mode 100644 index 0000000..ab17a3a --- /dev/null +++ b/docs/StockExchangeApi.md @@ -0,0 +1,582 @@ +# StockExchangeApi + +All URIs are relative to *https://api-v2.intrinio.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAllStockExchanges**](StockExchangeApi.md#getAllStockExchanges) | **GET** /stock_exchanges | All Stock Exchanges +[**getStockExchangeById**](StockExchangeApi.md#getStockExchangeById) | **GET** /stock_exchanges/{identifier} | Lookup Stock Exchange +[**getStockExchangePriceAdjustments**](StockExchangeApi.md#getStockExchangePriceAdjustments) | **GET** /stock_exchanges/{identifier}/prices/adjustments | Stock Price Adjustments by Exchange +[**getStockExchangePrices**](StockExchangeApi.md#getStockExchangePrices) | **GET** /stock_exchanges/{identifier}/prices | Stock Prices by Exchange +[**getStockExchangeRealtimePrices**](StockExchangeApi.md#getStockExchangeRealtimePrices) | **GET** /stock_exchanges/{identifier}/prices/realtime | Realtime Stock Prices by Exchange +[**getStockExchangeSecurities**](StockExchangeApi.md#getStockExchangeSecurities) | **GET** /stock_exchanges/{identifier}/securities | Securities by Exchange + + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:StockExchangeApi) + +[//]: # (METHOD:getAllStockExchanges) + +[//]: # (RETURN_TYPE:ApiResponseStockExchanges) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseStockExchanges.md) + +[//]: # (OPERATION:getAllStockExchanges_v2) + +[//]: # (ENDPOINT:/stock_exchanges) + +[//]: # (DOCUMENT_LINK:StockExchangeApi.md#getAllStockExchanges) + + +## **getAllStockExchanges** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getAllStockExchanges_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseStockExchanges getAllStockExchanges(city, country, countryCode, pageSize) + +#### All Stock Exchanges + + +Returns all Stock Exchanges matching the specified parameters + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + StockExchangeApi stockExchangeApi = new StockExchangeApi(); + + String city = "New York"; // String | Filter by city + String country = "UNITED STATES OF AMERICA"; // String | Filter by country + String countryCode = "US"; // String | Filter by ISO country code + Integer pageSize = 100; // Integer | The number of results to return + + try { + ApiResponseStockExchanges result = stockExchangeApi.getAllStockExchanges(city, country, countryCode, pageSize); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling StockExchangeApi#getAllStockExchanges"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **city** | String| Filter by city | [optional]   + **country** | String| Filter by country | [optional]   + **countryCode** | String| Filter by ISO country code | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseStockExchanges**](ApiResponseStockExchanges.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:StockExchangeApi) + +[//]: # (METHOD:getStockExchangeById) + +[//]: # (RETURN_TYPE:StockExchange) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:StockExchange.md) + +[//]: # (OPERATION:getStockExchangeById_v2) + +[//]: # (ENDPOINT:/stock_exchanges/{identifier}) + +[//]: # (DOCUMENT_LINK:StockExchangeApi.md#getStockExchangeById) + + +## **getStockExchangeById** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getStockExchangeById_v2) + +[//]: # (START_OVERVIEW) + +> StockExchange getStockExchangeById(identifier) + +#### Lookup Stock Exchange + + +Returns the Stock Exchange with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + StockExchangeApi stockExchangeApi = new StockExchangeApi(); + + String identifier = "USCOMP"; // String | A Stock Exchange identifier (MIC or Intrinio ID) + + try { + StockExchange result = stockExchangeApi.getStockExchangeById(identifier); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling StockExchangeApi#getStockExchangeById"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Stock Exchange identifier (MIC or Intrinio ID) |   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**StockExchange**](StockExchange.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:StockExchangeApi) + +[//]: # (METHOD:getStockExchangePriceAdjustments) + +[//]: # (RETURN_TYPE:ApiResponseStockExchangeStockPriceAdjustments) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseStockExchangeStockPriceAdjustments.md) + +[//]: # (OPERATION:getStockExchangePriceAdjustments_v2) + +[//]: # (ENDPOINT:/stock_exchanges/{identifier}/prices/adjustments) + +[//]: # (DOCUMENT_LINK:StockExchangeApi.md#getStockExchangePriceAdjustments) + + +## **getStockExchangePriceAdjustments** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getStockExchangePriceAdjustments_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseStockExchangeStockPriceAdjustments getStockExchangePriceAdjustments(identifier, date, pageSize, nextPage) + +#### Stock Price Adjustments by Exchange + + +Returns stock price adjustments for the Stock Exchange with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + StockExchangeApi stockExchangeApi = new StockExchangeApi(); + + String identifier = "USCOMP"; // String | A Stock Exchange identifier (MIC or Intrinio ID) + LocalDate date = LocalDate.now(); // LocalDate | The date for which to return price adjustments + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseStockExchangeStockPriceAdjustments result = stockExchangeApi.getStockExchangePriceAdjustments(identifier, date, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling StockExchangeApi#getStockExchangePriceAdjustments"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Stock Exchange identifier (MIC or Intrinio ID) |   + **date** | LocalDate| The date for which to return price adjustments | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseStockExchangeStockPriceAdjustments**](ApiResponseStockExchangeStockPriceAdjustments.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:StockExchangeApi) + +[//]: # (METHOD:getStockExchangePrices) + +[//]: # (RETURN_TYPE:ApiResponseStockExchangeStockPrices) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseStockExchangeStockPrices.md) + +[//]: # (OPERATION:getStockExchangePrices_v2) + +[//]: # (ENDPOINT:/stock_exchanges/{identifier}/prices) + +[//]: # (DOCUMENT_LINK:StockExchangeApi.md#getStockExchangePrices) + + +## **getStockExchangePrices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getStockExchangePrices_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseStockExchangeStockPrices getStockExchangePrices(identifier, date, pageSize, nextPage) + +#### Stock Prices by Exchange + + +Returns end-of-day stock prices for Securities on the Stock Exchange with `identifier` and on the `price_date` (or the latest date that prices are available) + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + StockExchangeApi stockExchangeApi = new StockExchangeApi(); + + String identifier = "USCOMP"; // String | A Stock Exchange identifier (MIC or Intrinio ID) + LocalDate date = LocalDate.now(); // LocalDate | The date for which to return prices + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseStockExchangeStockPrices result = stockExchangeApi.getStockExchangePrices(identifier, date, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling StockExchangeApi#getStockExchangePrices"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Stock Exchange identifier (MIC or Intrinio ID) |   + **date** | LocalDate| The date for which to return prices | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseStockExchangeStockPrices**](ApiResponseStockExchangeStockPrices.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:StockExchangeApi) + +[//]: # (METHOD:getStockExchangeRealtimePrices) + +[//]: # (RETURN_TYPE:ApiResponseStockExchangeRealtimeStockPrices) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseStockExchangeRealtimeStockPrices.md) + +[//]: # (OPERATION:getStockExchangeRealtimePrices_v2) + +[//]: # (ENDPOINT:/stock_exchanges/{identifier}/prices/realtime) + +[//]: # (DOCUMENT_LINK:StockExchangeApi.md#getStockExchangeRealtimePrices) + + +## **getStockExchangeRealtimePrices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getStockExchangeRealtimePrices_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseStockExchangeRealtimeStockPrices getStockExchangeRealtimePrices(identifier, source, pageSize, nextPage) + +#### Realtime Stock Prices by Exchange + + +Returns realtime stock prices for the Stock Exchange with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + StockExchangeApi stockExchangeApi = new StockExchangeApi(); + + String identifier = "USCOMP"; // String | A Stock Exchange identifier (MIC or Intrinio ID) + String source = null; // String | Return realtime prices from the specified data source. If no source is specified, all sources are used. + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseStockExchangeRealtimeStockPrices result = stockExchangeApi.getStockExchangeRealtimePrices(identifier, source, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling StockExchangeApi#getStockExchangeRealtimePrices"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Stock Exchange identifier (MIC or Intrinio ID) |   + **source** | String| Return realtime prices from the specified data source. If no source is specified, all sources are used. | [optional] [enum: iex, bats, bats_delayed, utp_delayed, cta_a_delayed, cta_b_delayed]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseStockExchangeRealtimeStockPrices**](ApiResponseStockExchangeRealtimeStockPrices.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:StockExchangeApi) + +[//]: # (METHOD:getStockExchangeSecurities) + +[//]: # (RETURN_TYPE:ApiResponseStockExchangeSecurities) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseStockExchangeSecurities.md) + +[//]: # (OPERATION:getStockExchangeSecurities_v2) + +[//]: # (ENDPOINT:/stock_exchanges/{identifier}/securities) + +[//]: # (DOCUMENT_LINK:StockExchangeApi.md#getStockExchangeSecurities) + + +## **getStockExchangeSecurities** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getStockExchangeSecurities_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseStockExchangeSecurities getStockExchangeSecurities(identifier, pageSize, nextPage) + +#### Securities by Exchange + + +Returns Securities traded on the Stock Exchange with `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + StockExchangeApi stockExchangeApi = new StockExchangeApi(); + + String identifier = "USCOMP"; // String | A Stock Exchange identifier (MIC or Intrinio ID) + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseStockExchangeSecurities result = stockExchangeApi.getStockExchangeSecurities(identifier, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling StockExchangeApi#getStockExchangeSecurities"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Stock Exchange identifier (MIC or Intrinio ID) |   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseStockExchangeSecurities**](ApiResponseStockExchangeSecurities.md) + +[//]: # (END_OPERATION) + diff --git a/docs/StockMarketIndex.md b/docs/StockMarketIndex.md new file mode 100644 index 0000000..ea9e74d --- /dev/null +++ b/docs/StockMarketIndex.md @@ -0,0 +1,39 @@ + +[//]: # (CLASS:StockMarketIndex) + +[//]: # (KIND:object) + +### StockMarketIndex + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | Intrinio ID for the Index   +**symbol** | String | The symbol used to identify the Index   +**name** | String | The name of the Index   +**continent** | String | The continent of the country of focus for the Index   +**country** | String | The country of focus for the Index   +**updateFrequency** | String | How often the Index is updated   +**lastUpdated** | [**OffsetDateTime**](OffsetDateTime.md) | When the Index was updated last   +**description** | String | A paragraph describing the index and its scope   +**observationStart** | [**LocalDate**](LocalDate.md) | The earliest date for which data is available   +**observationEnd** | [**LocalDate**](LocalDate.md) | The latest date for which data is available   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + + + + diff --git a/docs/StockMarketIndexSummary.md b/docs/StockMarketIndexSummary.md new file mode 100644 index 0000000..dc5c711 --- /dev/null +++ b/docs/StockMarketIndexSummary.md @@ -0,0 +1,38 @@ + +[//]: # (CLASS:StockMarketIndexSummary) + +[//]: # (KIND:object) + +### StockMarketIndexSummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | Intrinio ID for the Index   +**symbol** | String | The symbol used to identify the Index   +**name** | String | The name of the Index   +**continent** | String | The continent of the country of focus for the Index   +**country** | String | The country of focus for the Index   +**updateFrequency** | String | How often the Index is updated   +**lastUpdated** | [**OffsetDateTime**](OffsetDateTime.md) | When the Index was updated last   +**observationStart** | [**LocalDate**](LocalDate.md) | The earliest date for which data is available   +**observationEnd** | [**LocalDate**](LocalDate.md) | The latest date for which data is available   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + + + + diff --git a/docs/StockPrice.md b/docs/StockPrice.md new file mode 100644 index 0000000..74d6a3a --- /dev/null +++ b/docs/StockPrice.md @@ -0,0 +1,82 @@ + +[//]: # (CLASS:StockPrice) + +[//]: # (KIND:object) + +### StockPrice + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**date** | [**LocalDate**](LocalDate.md) | The calendar date that the stock price represents. For non-daily stock prices, this represents the last day in the period (end of the week, month, quarter, year, etc)   +**intraperiod** | Boolean | If true, the stock price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period   +**frequency** | FrequencyEnum | The type of period that the stock price represents   +**open** | [**BigDecimal**](BigDecimal.md) | The price at the beginning of the period   +**high** | [**BigDecimal**](BigDecimal.md) | The highest price over the span of the period   +**low** | [**BigDecimal**](BigDecimal.md) | The lowest price over the span of the period   +**close** | [**BigDecimal**](BigDecimal.md) | The price at the end of the period   +**volume** | [**BigDecimal**](BigDecimal.md) | The number of shares exchanged during the period   +**adjOpen** | [**BigDecimal**](BigDecimal.md) | The price at the beginning of the period, adjusted for splits and dividends   +**adjHigh** | [**BigDecimal**](BigDecimal.md) | The highest price over the span of the period, adjusted for splits and dividends   +**adjLow** | [**BigDecimal**](BigDecimal.md) | The lowest price over the span of the period, adjusted for splits and dividends   +**adjClose** | [**BigDecimal**](BigDecimal.md) | The price at the end of the period, adjusted for splits and dividends   +**adjVolume** | [**BigDecimal**](BigDecimal.md) | The number of shares exchanged during the period, adjusted for splits and dividends   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the stock price   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + +
+ +#### Enum: FrequencyEnum + +Name | Value +---- | ----- +DAILY | "daily" +WEEKLY | "weekly" +MONTHLY | "monthly" +QUARTERLY | "quarterly" +YEARLY | "yearly" + + + diff --git a/docs/StockPriceAdjustment.md b/docs/StockPriceAdjustment.md new file mode 100644 index 0000000..9331a85 --- /dev/null +++ b/docs/StockPriceAdjustment.md @@ -0,0 +1,41 @@ + +[//]: # (CLASS:StockPriceAdjustment) + +[//]: # (KIND:object) + +### StockPriceAdjustment + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**date** | [**LocalDate**](LocalDate.md) | The date on which the adjustment occurred. The adjustment should be applied to all stock prices before this date.   +**factor** | [**BigDecimal**](BigDecimal.md) | The factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.   +**dividend** | [**BigDecimal**](BigDecimal.md) | The dividend amount, if a dividend was paid.   +**dividendCurrency** | String | The currency of the dividend, if known.   +**splitRatio** | [**BigDecimal**](BigDecimal.md) | The ratio of the stock split, if a stock split occurred.   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the stock price   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/StockPriceAdjustmentSummary.md b/docs/StockPriceAdjustmentSummary.md new file mode 100644 index 0000000..c8bf521 --- /dev/null +++ b/docs/StockPriceAdjustmentSummary.md @@ -0,0 +1,37 @@ + +[//]: # (CLASS:StockPriceAdjustmentSummary) + +[//]: # (KIND:object) + +### StockPriceAdjustmentSummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**date** | [**LocalDate**](LocalDate.md) | The date on which the adjustment occurred. The adjustment should be applied to all stock prices before this date.   +**factor** | [**BigDecimal**](BigDecimal.md) | The factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.   +**dividend** | [**BigDecimal**](BigDecimal.md) | The dividend amount, if a dividend was paid.   +**dividendCurrency** | String | The currency of the dividend, if known.   +**splitRatio** | [**BigDecimal**](BigDecimal.md) | The ratio of the stock split, if a stock split occurred.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/StockPriceSummary.md b/docs/StockPriceSummary.md new file mode 100644 index 0000000..2359cf1 --- /dev/null +++ b/docs/StockPriceSummary.md @@ -0,0 +1,78 @@ + +[//]: # (CLASS:StockPriceSummary) + +[//]: # (KIND:object) + +### StockPriceSummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**date** | [**LocalDate**](LocalDate.md) | The calendar date that the stock price represents. For non-daily stock prices, this represents the last day in the period (end of the week, month, quarter, year, etc)   +**intraperiod** | Boolean | If true, the stock price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period   +**frequency** | FrequencyEnum | The type of period that the stock price represents   +**open** | [**BigDecimal**](BigDecimal.md) | The price at the beginning of the period   +**high** | [**BigDecimal**](BigDecimal.md) | The highest price over the span of the period   +**low** | [**BigDecimal**](BigDecimal.md) | The lowest price over the span of the period   +**close** | [**BigDecimal**](BigDecimal.md) | The price at the end of the period   +**volume** | [**BigDecimal**](BigDecimal.md) | The number of shares exchanged during the period   +**adjOpen** | [**BigDecimal**](BigDecimal.md) | The price at the beginning of the period, adjusted for splits and dividends   +**adjHigh** | [**BigDecimal**](BigDecimal.md) | The highest price over the span of the period, adjusted for splits and dividends   +**adjLow** | [**BigDecimal**](BigDecimal.md) | The lowest price over the span of the period, adjusted for splits and dividends   +**adjClose** | [**BigDecimal**](BigDecimal.md) | The price at the end of the period, adjusted for splits and dividends   +**adjVolume** | [**BigDecimal**](BigDecimal.md) | The number of shares exchanged during the period, adjusted for splits and dividends   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + +
+ +#### Enum: FrequencyEnum + +Name | Value +---- | ----- +DAILY | "daily" +WEEKLY | "weekly" +MONTHLY | "monthly" +QUARTERLY | "quarterly" +YEARLY | "yearly" + + + diff --git a/docs/TechnicalApi.md b/docs/TechnicalApi.md new file mode 100644 index 0000000..3c619c8 --- /dev/null +++ b/docs/TechnicalApi.md @@ -0,0 +1,3187 @@ +# TechnicalApi + +All URIs are relative to *https://api-v2.intrinio.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getSecurityPriceTechnicalsAdi**](TechnicalApi.md#getSecurityPriceTechnicalsAdi) | **GET** /securities/{identifier}/prices/technicals/adi | Accumulation/Distribution Index +[**getSecurityPriceTechnicalsAdtv**](TechnicalApi.md#getSecurityPriceTechnicalsAdtv) | **GET** /securities/{identifier}/prices/technicals/adtv | Average Daily Trading Volume +[**getSecurityPriceTechnicalsAdx**](TechnicalApi.md#getSecurityPriceTechnicalsAdx) | **GET** /securities/{identifier}/prices/technicals/adx | Average Directional Index +[**getSecurityPriceTechnicalsAo**](TechnicalApi.md#getSecurityPriceTechnicalsAo) | **GET** /securities/{identifier}/prices/technicals/ao | Awesome Oscillator +[**getSecurityPriceTechnicalsAtr**](TechnicalApi.md#getSecurityPriceTechnicalsAtr) | **GET** /securities/{identifier}/prices/technicals/atr | Average True Range +[**getSecurityPriceTechnicalsBb**](TechnicalApi.md#getSecurityPriceTechnicalsBb) | **GET** /securities/{identifier}/prices/technicals/bb | Bollinger Bands +[**getSecurityPriceTechnicalsCci**](TechnicalApi.md#getSecurityPriceTechnicalsCci) | **GET** /securities/{identifier}/prices/technicals/cci | Commodity Channel Index +[**getSecurityPriceTechnicalsCmf**](TechnicalApi.md#getSecurityPriceTechnicalsCmf) | **GET** /securities/{identifier}/prices/technicals/cmf | Chaikin Money Flow +[**getSecurityPriceTechnicalsDc**](TechnicalApi.md#getSecurityPriceTechnicalsDc) | **GET** /securities/{identifier}/prices/technicals/dc | Donchian Channel +[**getSecurityPriceTechnicalsDpo**](TechnicalApi.md#getSecurityPriceTechnicalsDpo) | **GET** /securities/{identifier}/prices/technicals/dpo | Detrended Price Oscillator +[**getSecurityPriceTechnicalsEom**](TechnicalApi.md#getSecurityPriceTechnicalsEom) | **GET** /securities/{identifier}/prices/technicals/eom | Ease of Movement +[**getSecurityPriceTechnicalsFi**](TechnicalApi.md#getSecurityPriceTechnicalsFi) | **GET** /securities/{identifier}/prices/technicals/fi | Force Index +[**getSecurityPriceTechnicalsIchimoku**](TechnicalApi.md#getSecurityPriceTechnicalsIchimoku) | **GET** /securities/{identifier}/prices/technicals/ichimoku | Ichimoku Kinko Hyo +[**getSecurityPriceTechnicalsKc**](TechnicalApi.md#getSecurityPriceTechnicalsKc) | **GET** /securities/{identifier}/prices/technicals/kc | Keltner Channel +[**getSecurityPriceTechnicalsKst**](TechnicalApi.md#getSecurityPriceTechnicalsKst) | **GET** /securities/{identifier}/prices/technicals/kst | Know Sure Thing +[**getSecurityPriceTechnicalsMacd**](TechnicalApi.md#getSecurityPriceTechnicalsMacd) | **GET** /securities/{identifier}/prices/technicals/macd | Moving Average Convergence Divergence +[**getSecurityPriceTechnicalsMfi**](TechnicalApi.md#getSecurityPriceTechnicalsMfi) | **GET** /securities/{identifier}/prices/technicals/mfi | Money Flow Index +[**getSecurityPriceTechnicalsMi**](TechnicalApi.md#getSecurityPriceTechnicalsMi) | **GET** /securities/{identifier}/prices/technicals/mi | Mass Index +[**getSecurityPriceTechnicalsNvi**](TechnicalApi.md#getSecurityPriceTechnicalsNvi) | **GET** /securities/{identifier}/prices/technicals/nvi | Negative Volume Index +[**getSecurityPriceTechnicalsObv**](TechnicalApi.md#getSecurityPriceTechnicalsObv) | **GET** /securities/{identifier}/prices/technicals/obv | On-balance Volume +[**getSecurityPriceTechnicalsObvMean**](TechnicalApi.md#getSecurityPriceTechnicalsObvMean) | **GET** /securities/{identifier}/prices/technicals/obv_mean | On-balance Volume Mean +[**getSecurityPriceTechnicalsRsi**](TechnicalApi.md#getSecurityPriceTechnicalsRsi) | **GET** /securities/{identifier}/prices/technicals/rsi | Relative Strength Index +[**getSecurityPriceTechnicalsSma**](TechnicalApi.md#getSecurityPriceTechnicalsSma) | **GET** /securities/{identifier}/prices/technicals/sma | Simple Moving Average +[**getSecurityPriceTechnicalsSr**](TechnicalApi.md#getSecurityPriceTechnicalsSr) | **GET** /securities/{identifier}/prices/technicals/sr | Stochastic Oscillator +[**getSecurityPriceTechnicalsTrix**](TechnicalApi.md#getSecurityPriceTechnicalsTrix) | **GET** /securities/{identifier}/prices/technicals/trix | Triple Exponential Average +[**getSecurityPriceTechnicalsTsi**](TechnicalApi.md#getSecurityPriceTechnicalsTsi) | **GET** /securities/{identifier}/prices/technicals/tsi | True Strength Index +[**getSecurityPriceTechnicalsUo**](TechnicalApi.md#getSecurityPriceTechnicalsUo) | **GET** /securities/{identifier}/prices/technicals/uo | Ultimate Oscillator +[**getSecurityPriceTechnicalsVi**](TechnicalApi.md#getSecurityPriceTechnicalsVi) | **GET** /securities/{identifier}/prices/technicals/vi | Vortex Indicator +[**getSecurityPriceTechnicalsVpt**](TechnicalApi.md#getSecurityPriceTechnicalsVpt) | **GET** /securities/{identifier}/prices/technicals/vpt | Volume-price Trend +[**getSecurityPriceTechnicalsVwap**](TechnicalApi.md#getSecurityPriceTechnicalsVwap) | **GET** /securities/{identifier}/prices/technicals/vwap | Volume Weighted Average Price +[**getSecurityPriceTechnicalsWr**](TechnicalApi.md#getSecurityPriceTechnicalsWr) | **GET** /securities/{identifier}/prices/technicals/wr | Williams %R + + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsAdi) + +[//]: # (RETURN_TYPE:ApiResponseSecurityAccumulationDistributionIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAccumulationDistributionIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsAdi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adi) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsAdi) + + +## **getSecurityPriceTechnicalsAdi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsAdi_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityAccumulationDistributionIndex getSecurityPriceTechnicalsAdi(identifier, startDate, endDate, pageSize, nextPage) + +#### Accumulation/Distribution Index + + +Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityAccumulationDistributionIndex result = technicalApi.getSecurityPriceTechnicalsAdi(identifier, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsAdi"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityAccumulationDistributionIndex**](ApiResponseSecurityAccumulationDistributionIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsAdtv) + +[//]: # (RETURN_TYPE:ApiResponseSecurityAverageDailyTradingVolume) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAverageDailyTradingVolume.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsAdtv_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adtv) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsAdtv) + + +## **getSecurityPriceTechnicalsAdtv** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsAdtv_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityAverageDailyTradingVolume getSecurityPriceTechnicalsAdtv(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Average Daily Trading Volume + + +Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 22; // Integer | The number of observations, per period, to calculate Average Daily Trading Volume + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityAverageDailyTradingVolume result = technicalApi.getSecurityPriceTechnicalsAdtv(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsAdtv"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Average Daily Trading Volume | [optional] [default to 22]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityAverageDailyTradingVolume**](ApiResponseSecurityAverageDailyTradingVolume.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsAdx) + +[//]: # (RETURN_TYPE:ApiResponseSecurityAverageDirectionalIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAverageDirectionalIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsAdx_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adx) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsAdx) + + +## **getSecurityPriceTechnicalsAdx** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsAdx_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityAverageDirectionalIndex getSecurityPriceTechnicalsAdx(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Average Directional Index + + +Returns the Average Directional Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 14; // Integer | The number of observations, per period, to calculate Average Directional Index + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityAverageDirectionalIndex result = technicalApi.getSecurityPriceTechnicalsAdx(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsAdx"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Average Directional Index | [optional] [default to 14]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityAverageDirectionalIndex**](ApiResponseSecurityAverageDirectionalIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsAo) + +[//]: # (RETURN_TYPE:ApiResponseSecurityAwesomeOscillator) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAwesomeOscillator.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsAo_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/ao) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsAo) + + +## **getSecurityPriceTechnicalsAo** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsAo_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityAwesomeOscillator getSecurityPriceTechnicalsAo(identifier, shortPeriod, longPeriod, startDate, endDate, pageSize, nextPage) + +#### Awesome Oscillator + + +Returns the Awesome Oscillator values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer shortPeriod = 5; // Integer | The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator + Integer longPeriod = 34; // Integer | The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityAwesomeOscillator result = technicalApi.getSecurityPriceTechnicalsAo(identifier, shortPeriod, longPeriod, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsAo"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **shortPeriod** | Integer| The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator | [optional] [default to 5]   + **longPeriod** | Integer| The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator | [optional] [default to 34]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityAwesomeOscillator**](ApiResponseSecurityAwesomeOscillator.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsAtr) + +[//]: # (RETURN_TYPE:ApiResponseSecurityAverageTrueRange) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAverageTrueRange.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsAtr_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/atr) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsAtr) + + +## **getSecurityPriceTechnicalsAtr** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsAtr_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityAverageTrueRange getSecurityPriceTechnicalsAtr(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Average True Range + + +Returns the Average True Range values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 14; // Integer | The number of observations, per period, to calculate Average True Range + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityAverageTrueRange result = technicalApi.getSecurityPriceTechnicalsAtr(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsAtr"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Average True Range | [optional] [default to 14]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityAverageTrueRange**](ApiResponseSecurityAverageTrueRange.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsBb) + +[//]: # (RETURN_TYPE:ApiResponseSecurityBollingerBands) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityBollingerBands.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsBb_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/bb) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsBb) + + +## **getSecurityPriceTechnicalsBb** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsBb_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityBollingerBands getSecurityPriceTechnicalsBb(identifier, period, standardDeviations, priceKey, startDate, endDate, pageSize, nextPage) + +#### Bollinger Bands + + +Returns the Bollinger Bands values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 20; // Integer | The number of observations, per period, to calculate Bollinger Bands + Float standardDeviations = 2.0F; // Float | The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands + String priceKey = "close"; // String | The Stock Price field to use when calculating Bollinger Bands + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityBollingerBands result = technicalApi.getSecurityPriceTechnicalsBb(identifier, period, standardDeviations, priceKey, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsBb"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Bollinger Bands | [optional] [default to 20]   + **standardDeviations** | Float| The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands | [optional] [default to 2.0]   + **priceKey** | String| The Stock Price field to use when calculating Bollinger Bands | [optional] [default to close] [enum: open, high, low, close, volume]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityBollingerBands**](ApiResponseSecurityBollingerBands.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsCci) + +[//]: # (RETURN_TYPE:ApiResponseSecurityCommodityChannelIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityCommodityChannelIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsCci_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/cci) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsCci) + + +## **getSecurityPriceTechnicalsCci** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsCci_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityCommodityChannelIndex getSecurityPriceTechnicalsCci(identifier, period, constant, startDate, endDate, pageSize, nextPage) + +#### Commodity Channel Index + + +Returns the Commodity Channel Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 20; // Integer | The number of observations, per period, to calculate Commodity Channel Index + Float constant = 0.015F; // Float | The number of observations, per period, to calculate Commodity Channel Index + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityCommodityChannelIndex result = technicalApi.getSecurityPriceTechnicalsCci(identifier, period, constant, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsCci"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 20]   + **constant** | Float| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 0.015]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityCommodityChannelIndex**](ApiResponseSecurityCommodityChannelIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsCmf) + +[//]: # (RETURN_TYPE:ApiResponseSecurityChaikinMoneyFlow) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityChaikinMoneyFlow.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsCmf_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/cmf) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsCmf) + + +## **getSecurityPriceTechnicalsCmf** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsCmf_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityChaikinMoneyFlow getSecurityPriceTechnicalsCmf(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Chaikin Money Flow + + +Returns the Chaikin Money Flow values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 20; // Integer | The number of observations, per period, to calculate Chaikin Money Flow + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityChaikinMoneyFlow result = technicalApi.getSecurityPriceTechnicalsCmf(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsCmf"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Chaikin Money Flow | [optional] [default to 20]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityChaikinMoneyFlow**](ApiResponseSecurityChaikinMoneyFlow.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsDc) + +[//]: # (RETURN_TYPE:ApiResponseSecurityDonchianChannel) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityDonchianChannel.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsDc_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/dc) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsDc) + + +## **getSecurityPriceTechnicalsDc** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsDc_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityDonchianChannel getSecurityPriceTechnicalsDc(identifier, period, priceKey, startDate, endDate, pageSize, nextPage) + +#### Donchian Channel + + +Returns the Donchian Channel values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 20; // Integer | The number of observations, per period, to calculate Donchian Channel + String priceKey = "close"; // String | The Stock Price field to use when calculating Donchian Channel + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityDonchianChannel result = technicalApi.getSecurityPriceTechnicalsDc(identifier, period, priceKey, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsDc"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Donchian Channel | [optional] [default to 20]   + **priceKey** | String| The Stock Price field to use when calculating Donchian Channel | [optional] [default to close] [enum: open, high, low, close, volume]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityDonchianChannel**](ApiResponseSecurityDonchianChannel.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsDpo) + +[//]: # (RETURN_TYPE:ApiResponseSecurityDetrendedPriceOscillator) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityDetrendedPriceOscillator.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsDpo_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/dpo) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsDpo) + + +## **getSecurityPriceTechnicalsDpo** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsDpo_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityDetrendedPriceOscillator getSecurityPriceTechnicalsDpo(identifier, period, priceKey, startDate, endDate, pageSize, nextPage) + +#### Detrended Price Oscillator + + +Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 20; // Integer | The number of observations, per period, to calculate Detrended Price Oscillator + String priceKey = "close"; // String | The Stock Price field to use when calculating Detrended Price Oscillator + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityDetrendedPriceOscillator result = technicalApi.getSecurityPriceTechnicalsDpo(identifier, period, priceKey, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsDpo"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Detrended Price Oscillator | [optional] [default to 20]   + **priceKey** | String| The Stock Price field to use when calculating Detrended Price Oscillator | [optional] [default to close] [enum: open, high, low, close, volume]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityDetrendedPriceOscillator**](ApiResponseSecurityDetrendedPriceOscillator.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsEom) + +[//]: # (RETURN_TYPE:ApiResponseSecurityEaseOfMovement) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityEaseOfMovement.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsEom_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/eom) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsEom) + + +## **getSecurityPriceTechnicalsEom** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsEom_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityEaseOfMovement getSecurityPriceTechnicalsEom(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Ease of Movement + + +Returns the Ease of Movement values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 20; // Integer | The number of observations, per period, to calculate Ease of Movement + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityEaseOfMovement result = technicalApi.getSecurityPriceTechnicalsEom(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsEom"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Ease of Movement | [optional] [default to 20]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityEaseOfMovement**](ApiResponseSecurityEaseOfMovement.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsFi) + +[//]: # (RETURN_TYPE:ApiResponseSecurityForceIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityForceIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsFi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/fi) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsFi) + + +## **getSecurityPriceTechnicalsFi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsFi_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityForceIndex getSecurityPriceTechnicalsFi(identifier, startDate, endDate, pageSize, nextPage) + +#### Force Index + + +Returns the Force Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityForceIndex result = technicalApi.getSecurityPriceTechnicalsFi(identifier, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsFi"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityForceIndex**](ApiResponseSecurityForceIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsIchimoku) + +[//]: # (RETURN_TYPE:ApiResponseSecurityIchimokuKinkoHyo) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityIchimokuKinkoHyo.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsIchimoku_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/ichimoku) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsIchimoku) + + +## **getSecurityPriceTechnicalsIchimoku** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsIchimoku_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityIchimokuKinkoHyo getSecurityPriceTechnicalsIchimoku(identifier, lowPeriod, mediumPeriod, highPeriod, startDate, endDate, pageSize, nextPage) + +#### Ichimoku Kinko Hyo + + +Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer lowPeriod = 9; // Integer | The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo + Integer mediumPeriod = 26; // Integer | The number of observations, per period, to calculate Kijun Sen (Base Line), Senkou Span A (Leading Span A), and Chikou Span (Lagging Span) of Ichimoku Kinko Hyo + Integer highPeriod = 52; // Integer | The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityIchimokuKinkoHyo result = technicalApi.getSecurityPriceTechnicalsIchimoku(identifier, lowPeriod, mediumPeriod, highPeriod, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsIchimoku"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **lowPeriod** | Integer| The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo | [optional] [default to 9]   + **mediumPeriod** | Integer| The number of observations, per period, to calculate Kijun Sen (Base Line), Senkou Span A (Leading Span A), and Chikou Span (Lagging Span) of Ichimoku Kinko Hyo | [optional] [default to 26]   + **highPeriod** | Integer| The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo | [optional] [default to 52]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityIchimokuKinkoHyo**](ApiResponseSecurityIchimokuKinkoHyo.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsKc) + +[//]: # (RETURN_TYPE:ApiResponseSecurityKeltnerChannel) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityKeltnerChannel.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsKc_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/kc) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsKc) + + +## **getSecurityPriceTechnicalsKc** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsKc_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityKeltnerChannel getSecurityPriceTechnicalsKc(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Keltner Channel + + +Returns the Keltner Channel values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 10; // Integer | The number of observations, per period, to calculate Kelter Channel + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityKeltnerChannel result = technicalApi.getSecurityPriceTechnicalsKc(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsKc"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Kelter Channel | [optional] [default to 10]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityKeltnerChannel**](ApiResponseSecurityKeltnerChannel.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsKst) + +[//]: # (RETURN_TYPE:ApiResponseSecurityKnowSureThing) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityKnowSureThing.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsKst_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/kst) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsKst) + + +## **getSecurityPriceTechnicalsKst** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsKst_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityKnowSureThing getSecurityPriceTechnicalsKst(identifier, roc1, roc2, roc3, roc4, sma1, sma2, sma3, sma4, priceKey, startDate, endDate, pageSize, nextPage) + +#### Know Sure Thing + + +Returns the Know Sure Thing values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer roc1 = 10; // Integer | The number of observations, per period, to calculate the rate-of-change for RCMA1 + Integer roc2 = 15; // Integer | The number of observations, per period, to calculate the rate-of-change for RCMA2 + Integer roc3 = 20; // Integer | The number of observations, per period, to calculate the rate-of-change for RCMA3 + Integer roc4 = 30; // Integer | The number of observations, per period, to calculate the rate-of-change for RCMA4 + Integer sma1 = 10; // Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA1 + Integer sma2 = 10; // Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA2 + Integer sma3 = 10; // Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA3 + Integer sma4 = 15; // Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA4 + String priceKey = "close"; // String | The Stock Price field to use when calculating Know Sure Thing + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityKnowSureThing result = technicalApi.getSecurityPriceTechnicalsKst(identifier, roc1, roc2, roc3, roc4, sma1, sma2, sma3, sma4, priceKey, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsKst"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **roc1** | Integer| The number of observations, per period, to calculate the rate-of-change for RCMA1 | [optional] [default to 10]   + **roc2** | Integer| The number of observations, per period, to calculate the rate-of-change for RCMA2 | [optional] [default to 15]   + **roc3** | Integer| The number of observations, per period, to calculate the rate-of-change for RCMA3 | [optional] [default to 20]   + **roc4** | Integer| The number of observations, per period, to calculate the rate-of-change for RCMA4 | [optional] [default to 30]   + **sma1** | Integer| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA1 | [optional] [default to 10]   + **sma2** | Integer| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA2 | [optional] [default to 10]   + **sma3** | Integer| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA3 | [optional] [default to 10]   + **sma4** | Integer| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA4 | [optional] [default to 15]   + **priceKey** | String| The Stock Price field to use when calculating Know Sure Thing | [optional] [default to close] [enum: open, high, low, close, volume]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityKnowSureThing**](ApiResponseSecurityKnowSureThing.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsMacd) + +[//]: # (RETURN_TYPE:ApiResponseSecurityMovingAverageConvergenceDivergence) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityMovingAverageConvergenceDivergence.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsMacd_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/macd) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsMacd) + + +## **getSecurityPriceTechnicalsMacd** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsMacd_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityMovingAverageConvergenceDivergence getSecurityPriceTechnicalsMacd(identifier, fastPeriod, slowPeriod, signalPeriod, priceKey, startDate, endDate, pageSize, nextPage) + +#### Moving Average Convergence Divergence + + +Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer fastPeriod = 12; // Integer | The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence + Integer slowPeriod = 26; // Integer | The number of observations, per period, to calculate the slow moving Exponential Moving Average for Moving Average Convergence Divergence + Integer signalPeriod = 9; // Integer | The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence + String priceKey = "close"; // String | The Stock Price field to use when calculating Moving Average Convergence Divergence + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityMovingAverageConvergenceDivergence result = technicalApi.getSecurityPriceTechnicalsMacd(identifier, fastPeriod, slowPeriod, signalPeriod, priceKey, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsMacd"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **fastPeriod** | Integer| The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence | [optional] [default to 12]   + **slowPeriod** | Integer| The number of observations, per period, to calculate the slow moving Exponential Moving Average for Moving Average Convergence Divergence | [optional] [default to 26]   + **signalPeriod** | Integer| The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence | [optional] [default to 9]   + **priceKey** | String| The Stock Price field to use when calculating Moving Average Convergence Divergence | [optional] [default to close] [enum: open, high, low, close, volume]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityMovingAverageConvergenceDivergence**](ApiResponseSecurityMovingAverageConvergenceDivergence.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsMfi) + +[//]: # (RETURN_TYPE:ApiResponseSecurityMoneyFlowIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityMoneyFlowIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsMfi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/mfi) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsMfi) + + +## **getSecurityPriceTechnicalsMfi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsMfi_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityMoneyFlowIndex getSecurityPriceTechnicalsMfi(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Money Flow Index + + +Returns the Money Flow Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 14; // Integer | The number of observations, per period, to calculate Money Flow Index + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityMoneyFlowIndex result = technicalApi.getSecurityPriceTechnicalsMfi(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsMfi"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Money Flow Index | [optional] [default to 14]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityMoneyFlowIndex**](ApiResponseSecurityMoneyFlowIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsMi) + +[//]: # (RETURN_TYPE:ApiResponseSecurityMassIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityMassIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsMi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/mi) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsMi) + + +## **getSecurityPriceTechnicalsMi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsMi_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityMassIndex getSecurityPriceTechnicalsMi(identifier, emaPeriod, sumPeriod, startDate, endDate, pageSize, nextPage) + +#### Mass Index + + +Returns the Mass Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer emaPeriod = 9; // Integer | The number of observations, per period, to calculate the single Exponential Moving Average and the Double Exponential Moving Average for Mass Index + Integer sumPeriod = 25; // Integer | The number of observations, per period, to calculate the sum of the Exponetinal Moving Average Ratios for Mass Index + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityMassIndex result = technicalApi.getSecurityPriceTechnicalsMi(identifier, emaPeriod, sumPeriod, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsMi"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **emaPeriod** | Integer| The number of observations, per period, to calculate the single Exponential Moving Average and the Double Exponential Moving Average for Mass Index | [optional] [default to 9]   + **sumPeriod** | Integer| The number of observations, per period, to calculate the sum of the Exponetinal Moving Average Ratios for Mass Index | [optional] [default to 25]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityMassIndex**](ApiResponseSecurityMassIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsNvi) + +[//]: # (RETURN_TYPE:ApiResponseSecurityNegativeVolumeIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityNegativeVolumeIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsNvi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/nvi) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsNvi) + + +## **getSecurityPriceTechnicalsNvi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsNvi_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityNegativeVolumeIndex getSecurityPriceTechnicalsNvi(identifier, startDate, endDate, pageSize, nextPage) + +#### Negative Volume Index + + +Returns the Negative Volume Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityNegativeVolumeIndex result = technicalApi.getSecurityPriceTechnicalsNvi(identifier, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsNvi"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityNegativeVolumeIndex**](ApiResponseSecurityNegativeVolumeIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsObv) + +[//]: # (RETURN_TYPE:ApiResponseSecurityOnBalanceVolume) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityOnBalanceVolume.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsObv_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/obv) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsObv) + + +## **getSecurityPriceTechnicalsObv** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsObv_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityOnBalanceVolume getSecurityPriceTechnicalsObv(identifier, startDate, endDate, pageSize, nextPage) + +#### On-balance Volume + + +Returns the On-balance Volume values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityOnBalanceVolume result = technicalApi.getSecurityPriceTechnicalsObv(identifier, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsObv"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityOnBalanceVolume**](ApiResponseSecurityOnBalanceVolume.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsObvMean) + +[//]: # (RETURN_TYPE:ApiResponseSecurityOnBalanceVolumeMean) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityOnBalanceVolumeMean.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsObvMean_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/obv_mean) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsObvMean) + + +## **getSecurityPriceTechnicalsObvMean** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsObvMean_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityOnBalanceVolumeMean getSecurityPriceTechnicalsObvMean(identifier, period, startDate, endDate, pageSize, nextPage) + +#### On-balance Volume Mean + + +Returns the On-balance Volume Mean values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 10; // Integer | The number of observations, per period, to calculate On-balance Volume Mean + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityOnBalanceVolumeMean result = technicalApi.getSecurityPriceTechnicalsObvMean(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsObvMean"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate On-balance Volume Mean | [optional] [default to 10]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityOnBalanceVolumeMean**](ApiResponseSecurityOnBalanceVolumeMean.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsRsi) + +[//]: # (RETURN_TYPE:ApiResponseSecurityRelativeStrengthIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityRelativeStrengthIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsRsi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/rsi) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsRsi) + + +## **getSecurityPriceTechnicalsRsi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsRsi_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityRelativeStrengthIndex getSecurityPriceTechnicalsRsi(identifier, period, priceKey, startDate, endDate, pageSize, nextPage) + +#### Relative Strength Index + + +Returns the Relative Strength Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 14; // Integer | The number of observations, per period, to calculate Relative Strength Index + String priceKey = "close"; // String | The Stock Price field to use when calculating Relative Strength Index + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityRelativeStrengthIndex result = technicalApi.getSecurityPriceTechnicalsRsi(identifier, period, priceKey, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsRsi"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Relative Strength Index | [optional] [default to 14]   + **priceKey** | String| The Stock Price field to use when calculating Relative Strength Index | [optional] [default to close] [enum: open, high, low, close, volume]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityRelativeStrengthIndex**](ApiResponseSecurityRelativeStrengthIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsSma) + +[//]: # (RETURN_TYPE:ApiResponseSecuritySimpleMovingAverage) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecuritySimpleMovingAverage.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsSma_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/sma) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsSma) + + +## **getSecurityPriceTechnicalsSma** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsSma_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecuritySimpleMovingAverage getSecurityPriceTechnicalsSma(identifier, period, priceKey, startDate, endDate, pageSize, nextPage) + +#### Simple Moving Average + + +Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 20; // Integer | The number of observations, per period, to calculate Simple Moving Average + String priceKey = "close"; // String | The Stock Price field to use when calculating Simple Moving Average + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecuritySimpleMovingAverage result = technicalApi.getSecurityPriceTechnicalsSma(identifier, period, priceKey, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsSma"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Simple Moving Average | [optional] [default to 20]   + **priceKey** | String| The Stock Price field to use when calculating Simple Moving Average | [optional] [default to close] [enum: open, high, low, close, volume]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecuritySimpleMovingAverage**](ApiResponseSecuritySimpleMovingAverage.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsSr) + +[//]: # (RETURN_TYPE:ApiResponseSecurityStochasticOscillator) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityStochasticOscillator.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsSr_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/sr) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsSr) + + +## **getSecurityPriceTechnicalsSr** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsSr_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityStochasticOscillator getSecurityPriceTechnicalsSr(identifier, period, signalPeriod, startDate, endDate, pageSize, nextPage) + +#### Stochastic Oscillator + + +Returns the Stochastic Oscillator values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 14; // Integer | The number of observations, per period, to calculate %K of Stochastic Oscillator + Integer signalPeriod = 3; // Integer | The number of observations, per period, to calculate the %D (the Simple Moving Average of %K) as a signal line for Stochastic Oscillator + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityStochasticOscillator result = technicalApi.getSecurityPriceTechnicalsSr(identifier, period, signalPeriod, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsSr"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate %K of Stochastic Oscillator | [optional] [default to 14]   + **signalPeriod** | Integer| The number of observations, per period, to calculate the %D (the Simple Moving Average of %K) as a signal line for Stochastic Oscillator | [optional] [default to 3]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityStochasticOscillator**](ApiResponseSecurityStochasticOscillator.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsTrix) + +[//]: # (RETURN_TYPE:ApiResponseSecurityTripleExponentialAverage) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityTripleExponentialAverage.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsTrix_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/trix) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsTrix) + + +## **getSecurityPriceTechnicalsTrix** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsTrix_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityTripleExponentialAverage getSecurityPriceTechnicalsTrix(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Triple Exponential Average + + +Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 15; // Integer | The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityTripleExponentialAverage result = technicalApi.getSecurityPriceTechnicalsTrix(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsTrix"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average | [optional] [default to 15]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityTripleExponentialAverage**](ApiResponseSecurityTripleExponentialAverage.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsTsi) + +[//]: # (RETURN_TYPE:ApiResponseSecurityTrueStrengthIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityTrueStrengthIndex.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsTsi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/tsi) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsTsi) + + +## **getSecurityPriceTechnicalsTsi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsTsi_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityTrueStrengthIndex getSecurityPriceTechnicalsTsi(identifier, lowPeriod, highPeriod, priceKey, startDate, endDate, pageSize, nextPage) + +#### True Strength Index + + +Returns the True Strength Index values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer lowPeriod = 13; // Integer | The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index + Integer highPeriod = 25; // Integer | The number of observations, per period, to calculate high period Exponential Moving Average for smoothing in True Strength Index + String priceKey = "close"; // String | The Stock Price field to use when calculating True Strength Index + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityTrueStrengthIndex result = technicalApi.getSecurityPriceTechnicalsTsi(identifier, lowPeriod, highPeriod, priceKey, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsTsi"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **lowPeriod** | Integer| The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index | [optional] [default to 13]   + **highPeriod** | Integer| The number of observations, per period, to calculate high period Exponential Moving Average for smoothing in True Strength Index | [optional] [default to 25]   + **priceKey** | String| The Stock Price field to use when calculating True Strength Index | [optional] [default to close] [enum: open, high, low, close, volume]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityTrueStrengthIndex**](ApiResponseSecurityTrueStrengthIndex.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsUo) + +[//]: # (RETURN_TYPE:ApiResponseSecurityUltimateOscillator) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityUltimateOscillator.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsUo_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/uo) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsUo) + + +## **getSecurityPriceTechnicalsUo** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsUo_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityUltimateOscillator getSecurityPriceTechnicalsUo(identifier, shortPeriod, mediumPeriod, longPeriod, shortWeight, mediumWeight, longWeight, startDate, endDate, pageSize, nextPage) + +#### Ultimate Oscillator + + +Returns the Ultimate Oscillator values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer shortPeriod = 7; // Integer | The number of observations, per period, to calculate the short period for Ultimate Oscillator + Integer mediumPeriod = 14; // Integer | The number of observations, per period, to calculate the medium period for Ultimate Oscillator + Integer longPeriod = 28; // Integer | The number of observations, per period, to calculate the long period for Ultimate Oscillator + Float shortWeight = 4.0F; // Float | The weight of short Buying Pressure average for Ultimate Oscillator + Float mediumWeight = 2.0F; // Float | The weight of medium Buying Pressure average for Ultimate Oscillator + Float longWeight = 1.0F; // Float | The weight of long Buying Pressure average for Ultimate Oscillator + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityUltimateOscillator result = technicalApi.getSecurityPriceTechnicalsUo(identifier, shortPeriod, mediumPeriod, longPeriod, shortWeight, mediumWeight, longWeight, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsUo"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **shortPeriod** | Integer| The number of observations, per period, to calculate the short period for Ultimate Oscillator | [optional] [default to 7]   + **mediumPeriod** | Integer| The number of observations, per period, to calculate the medium period for Ultimate Oscillator | [optional] [default to 14]   + **longPeriod** | Integer| The number of observations, per period, to calculate the long period for Ultimate Oscillator | [optional] [default to 28]   + **shortWeight** | Float| The weight of short Buying Pressure average for Ultimate Oscillator | [optional] [default to 4.0]   + **mediumWeight** | Float| The weight of medium Buying Pressure average for Ultimate Oscillator | [optional] [default to 2.0]   + **longWeight** | Float| The weight of long Buying Pressure average for Ultimate Oscillator | [optional] [default to 1.0]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityUltimateOscillator**](ApiResponseSecurityUltimateOscillator.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsVi) + +[//]: # (RETURN_TYPE:ApiResponseSecurityVortexIndicator) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityVortexIndicator.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsVi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vi) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsVi) + + +## **getSecurityPriceTechnicalsVi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsVi_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityVortexIndicator getSecurityPriceTechnicalsVi(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Vortex Indicator + + +Returns the Vortex Indicator values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 14; // Integer | The number of observations, per period, to calculate Vortex Indicator + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityVortexIndicator result = technicalApi.getSecurityPriceTechnicalsVi(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsVi"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to calculate Vortex Indicator | [optional] [default to 14]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityVortexIndicator**](ApiResponseSecurityVortexIndicator.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsVpt) + +[//]: # (RETURN_TYPE:ApiResponseSecurityVolumePriceTrend) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityVolumePriceTrend.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsVpt_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vpt) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsVpt) + + +## **getSecurityPriceTechnicalsVpt** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsVpt_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityVolumePriceTrend getSecurityPriceTechnicalsVpt(identifier, startDate, endDate, pageSize, nextPage) + +#### Volume-price Trend + + +Returns the Volume-price Trend values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityVolumePriceTrend result = technicalApi.getSecurityPriceTechnicalsVpt(identifier, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsVpt"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityVolumePriceTrend**](ApiResponseSecurityVolumePriceTrend.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsVwap) + +[//]: # (RETURN_TYPE:ApiResponseSecurityVolumeWeightedAveragePrice) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityVolumeWeightedAveragePrice.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsVwap_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vwap) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsVwap) + + +## **getSecurityPriceTechnicalsVwap** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsVwap_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityVolumeWeightedAveragePrice getSecurityPriceTechnicalsVwap(identifier, startDate, endDate, pageSize, nextPage) + +#### Volume Weighted Average Price + + +Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityVolumeWeightedAveragePrice result = technicalApi.getSecurityPriceTechnicalsVwap(identifier, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsVwap"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityVolumeWeightedAveragePrice**](ApiResponseSecurityVolumeWeightedAveragePrice.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:TechnicalApi) + +[//]: # (METHOD:getSecurityPriceTechnicalsWr) + +[//]: # (RETURN_TYPE:ApiResponseSecurityWilliamsR) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityWilliamsR.md) + +[//]: # (OPERATION:getSecurityPriceTechnicalsWr_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/wr) + +[//]: # (DOCUMENT_LINK:TechnicalApi.md#getSecurityPriceTechnicalsWr) + + +## **getSecurityPriceTechnicalsWr** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getSecurityPriceTechnicalsWr_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityWilliamsR getSecurityPriceTechnicalsWr(identifier, period, startDate, endDate, pageSize, nextPage) + +#### Williams %R + + +Returns the Williams %R values of Stock Prices for the Security with the given `identifier` + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + TechnicalApi technicalApi = new TechnicalApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer period = 14; // Integer | The number of observations, per period, to look-back when calculating Williams %R + String startDate = "2018-01-01"; // String | Return technical indicator values on or after the date + String endDate = "2019-01-01"; // String | Return technical indicator values on or before the date + BigDecimal pageSize = null; // BigDecimal | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseSecurityWilliamsR result = technicalApi.getSecurityPriceTechnicalsWr(identifier, period, startDate, endDate, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling TechnicalApi#getSecurityPriceTechnicalsWr"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **period** | Integer| The number of observations, per period, to look-back when calculating Williams %R | [optional] [default to 14]   + **startDate** | String| Return technical indicator values on or after the date | [optional]   + **endDate** | String| Return technical indicator values on or before the date | [optional]   + **pageSize** | BigDecimal| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityWilliamsR**](ApiResponseSecurityWilliamsR.md) + +[//]: # (END_OPERATION) + diff --git a/docs/TechnicalIndicator.md b/docs/TechnicalIndicator.md new file mode 100644 index 0000000..bb7f302 --- /dev/null +++ b/docs/TechnicalIndicator.md @@ -0,0 +1,22 @@ + +[//]: # (CLASS:TechnicalIndicator) + +[//]: # (KIND:object) + +### TechnicalIndicator + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**name** | String | The name of the Technical Indicator   +**symbol** | String | The symbol of the Technical Indicator   + +[//]: # (END_DEFINITION) + + + + + diff --git a/docs/TripleExponentialAverageTechnicalValue.md b/docs/TripleExponentialAverageTechnicalValue.md new file mode 100644 index 0000000..907e6c3 --- /dev/null +++ b/docs/TripleExponentialAverageTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:TripleExponentialAverageTechnicalValue) + +[//]: # (KIND:object) + +### TripleExponentialAverageTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**trix** | Float | The Triple Exponential Average calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/TrueStrengthIndexTechnicalValue.md b/docs/TrueStrengthIndexTechnicalValue.md new file mode 100644 index 0000000..af9d900 --- /dev/null +++ b/docs/TrueStrengthIndexTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:TrueStrengthIndexTechnicalValue) + +[//]: # (KIND:object) + +### TrueStrengthIndexTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**tsi** | Float | The True Strength Index calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/UltimateOscillatorTechnicalValue.md b/docs/UltimateOscillatorTechnicalValue.md new file mode 100644 index 0000000..1025cde --- /dev/null +++ b/docs/UltimateOscillatorTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:UltimateOscillatorTechnicalValue) + +[//]: # (KIND:object) + +### UltimateOscillatorTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**uo** | Float | The Ultimate Oscillator calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/VolumePriceTrendTechnicalValue.md b/docs/VolumePriceTrendTechnicalValue.md new file mode 100644 index 0000000..d9543b3 --- /dev/null +++ b/docs/VolumePriceTrendTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:VolumePriceTrendTechnicalValue) + +[//]: # (KIND:object) + +### VolumePriceTrendTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**vpt** | Float | The Volume-price Trend calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/VolumeWeightedAveragePriceValue.md b/docs/VolumeWeightedAveragePriceValue.md new file mode 100644 index 0000000..eb643df --- /dev/null +++ b/docs/VolumeWeightedAveragePriceValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:VolumeWeightedAveragePriceValue) + +[//]: # (KIND:object) + +### VolumeWeightedAveragePriceValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date and time of the observation   +**vwap** | Float | The Volume Weighted Average Price calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/VortexIndicatorTechnicalValue.md b/docs/VortexIndicatorTechnicalValue.md new file mode 100644 index 0000000..0f8d709 --- /dev/null +++ b/docs/VortexIndicatorTechnicalValue.md @@ -0,0 +1,26 @@ + +[//]: # (CLASS:VortexIndicatorTechnicalValue) + +[//]: # (KIND:object) + +### VortexIndicatorTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**negativeVi** | Float | The negative Vortex Indicator value   +**positiveVi** | Float | The positive Vortex Indicator value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/WilliamsRTechnicalValue.md b/docs/WilliamsRTechnicalValue.md new file mode 100644 index 0000000..b8b41b9 --- /dev/null +++ b/docs/WilliamsRTechnicalValue.md @@ -0,0 +1,25 @@ + +[//]: # (CLASS:WilliamsRTechnicalValue) + +[//]: # (KIND:object) + +### WilliamsRTechnicalValue + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**dateTime** | [**OffsetDateTime**](OffsetDateTime.md) | The date_time of the observation   +**wr** | Float | The Willaims %R calculation value   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:OffsetDateTime) + + + + + diff --git a/docs/ZacksAnalystRating.md b/docs/ZacksAnalystRating.md new file mode 100644 index 0000000..ad851e0 --- /dev/null +++ b/docs/ZacksAnalystRating.md @@ -0,0 +1,39 @@ + +[//]: # (CLASS:ZacksAnalystRating) + +[//]: # (KIND:object) + +### ZacksAnalystRating + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for the record   +**date** | [**LocalDate**](LocalDate.md) | The date of the Zacks Analyst Rating.   +**mean** | [**BigDecimal**](BigDecimal.md) | The mean (average) weighing of analyst recommendations, from 1 (strong buy) to 5 (strong sell).   +**strongBuys** | Integer | The number of analysts recommending Strong Buy.   +**buys** | Integer | The number of analysts recommending Buy.   +**holds** | Integer | The number of analysts recommending Hold.   +**sells** | Integer | The number of analysts recommending Sell.   +**strongSells** | Integer | The number of analysts recommending Strong Sell.   +**total** | Integer | The total number of analyst recommendations.   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Zacks Analyst Rating   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ZacksAnalystRatingSnapshot.md b/docs/ZacksAnalystRatingSnapshot.md new file mode 100644 index 0000000..14f7c18 --- /dev/null +++ b/docs/ZacksAnalystRatingSnapshot.md @@ -0,0 +1,43 @@ + +[//]: # (CLASS:ZacksAnalystRatingSnapshot) + +[//]: # (KIND:object) + +### ZacksAnalystRatingSnapshot + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**type** | String | The snapshot type, signifying the age of the ratings data from the snapshot date.   +**snapshotDate** | [**LocalDate**](LocalDate.md) | The date of the snapshot, when data was recorded.   +**ratingDate** | [**LocalDate**](LocalDate.md) | The date of the latest rating for the snapshot timeframe. This is the effective date of the ratings data.   +**mean** | [**BigDecimal**](BigDecimal.md) | The mean (average) weighing of analyst recommendations, from 1 (strong buy) to 5 (strong sell).   +**percentile** | [**BigDecimal**](BigDecimal.md) | The percentile of the mean, derived by comparing to all securities rated by analysts as of the rating date, ranging 0.0 (strong buy) to 1.0 (strong sell).   +**strongBuys** | Integer | The number of analysts recommending Strong Buy.   +**buys** | Integer | The number of analysts recommending Buy.   +**holds** | Integer | The number of analysts recommending Hold.   +**sells** | Integer | The number of analysts recommending Sell.   +**strongSells** | Integer | The number of analysts recommending Strong Sell.   +**total** | Integer | The total number of analysts recommendations.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/ZacksAnalystRatingSummary.md b/docs/ZacksAnalystRatingSummary.md new file mode 100644 index 0000000..b36f3b0 --- /dev/null +++ b/docs/ZacksAnalystRatingSummary.md @@ -0,0 +1,35 @@ + +[//]: # (CLASS:ZacksAnalystRatingSummary) + +[//]: # (KIND:object) + +### ZacksAnalystRatingSummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for the record   +**date** | [**LocalDate**](LocalDate.md) | The date of the Zacks Analyst Rating.   +**mean** | [**BigDecimal**](BigDecimal.md) | The mean (average) weighing of analyst recommendations, from 1 (strong buy) to 5 (strong sell).   +**strongBuys** | Integer | The number of analysts recommending Strong Buy.   +**buys** | Integer | The number of analysts recommending Buy.   +**holds** | Integer | The number of analysts recommending Hold.   +**sells** | Integer | The number of analysts recommending Sell.   +**strongSells** | Integer | The number of analysts recommending Strong Sell.   +**total** | Integer | The total number of analyst recommendations.   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/ZacksApi.md b/docs/ZacksApi.md new file mode 100644 index 0000000..7f9c10a --- /dev/null +++ b/docs/ZacksApi.md @@ -0,0 +1,1163 @@ +# ZacksApi + +All URIs are relative to *https://api-v2.intrinio.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getZacksAnalystRatings**](ZacksApi.md#getZacksAnalystRatings) | **GET** /zacks/analyst_ratings | Zacks Analyst Ratings +[**getZacksEpsEstimates**](ZacksApi.md#getZacksEpsEstimates) | **GET** /zacks/eps_estimates | Zacks EPS Estimates +[**getZacksEpsGrowthRates**](ZacksApi.md#getZacksEpsGrowthRates) | **GET** /zacks/eps_growth_rates | Zacks EPS Growth Rates +[**getZacksEpsSurprises**](ZacksApi.md#getZacksEpsSurprises) | **GET** /zacks/eps_surprises | Zacks EPS Surprises +[**getZacksEtfHoldings**](ZacksApi.md#getZacksEtfHoldings) | **GET** /zacks/etf_holdings | Zacks ETF Holdings +[**getZacksInstitutionalHoldingCompanies**](ZacksApi.md#getZacksInstitutionalHoldingCompanies) | **GET** /zacks/institutional_holdings/companies | Zacks Institutional Holding Companies +[**getZacksInstitutionalHoldingOwners**](ZacksApi.md#getZacksInstitutionalHoldingOwners) | **GET** /zacks/institutional_holdings/owners | Zacks Institutional Holding Owners +[**getZacksInstitutionalHoldings**](ZacksApi.md#getZacksInstitutionalHoldings) | **GET** /zacks/institutional_holdings | Zacks Institutional Holdings +[**getZacksLongTermGrowthRates**](ZacksApi.md#getZacksLongTermGrowthRates) | **GET** /zacks/long_term_growth_rates | Zacks Long Term Growth Rates +[**getZacksSalesSurprises**](ZacksApi.md#getZacksSalesSurprises) | **GET** /zacks/sales_surprises | Zacks Sales Surprises +[**getZacksTargetPriceConsensuses**](ZacksApi.md#getZacksTargetPriceConsensuses) | **GET** /zacks/target_price_consensuses | Zacks Target Price Consensuses + + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:ZacksApi) + +[//]: # (METHOD:getZacksAnalystRatings) + +[//]: # (RETURN_TYPE:ApiResponseZacksAnalystRatings) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseZacksAnalystRatings.md) + +[//]: # (OPERATION:getZacksAnalystRatings_v2) + +[//]: # (ENDPOINT:/zacks/analyst_ratings) + +[//]: # (DOCUMENT_LINK:ZacksApi.md#getZacksAnalystRatings) + + +## **getZacksAnalystRatings** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getZacksAnalystRatings_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseZacksAnalystRatings getZacksAnalystRatings(identifier, startDate, endDate, meanGreater, meanLess, strongBuysGreater, strongBuysLess, buysGreater, buysLess, holdsGreater, holdsLess, sellsGreater, sellsLess, strongSellsGreater, strongSellsLess, totalGreater, totalLess, pageSize, nextPage) + +#### Zacks Analyst Ratings + + +Returns buy, sell, and hold recommendations from analysts at brokerages for all companies in the Zacks universe. Zack’s storied research team aggregates and validates the ratings from professional analysts. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + ZacksApi zacksApi = new ZacksApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + LocalDate startDate = LocalDate.now(); // LocalDate | Limit ratings to those on or after this date + LocalDate endDate = LocalDate.now(); // LocalDate | Limit ratings to those on or before this date + BigDecimal meanGreater = null; // BigDecimal | Return only records with a mean (average) higher than this value + BigDecimal meanLess = null; // BigDecimal | Return only records with a mean (average) lower than this value + Integer strongBuysGreater = null; // Integer | Return only records with more than this many Strong Buy recommendations + Integer strongBuysLess = null; // Integer | Return only records with fewer than this many Strong Buy recommendations + Integer buysGreater = null; // Integer | Return only records with more than this many Buy recommendations + Integer buysLess = null; // Integer | Return only records with fewer than this many Buy recommendations + Integer holdsGreater = null; // Integer | Return only records with more than this many Hold recommendations + Integer holdsLess = null; // Integer | Return only records with fewer than this many Hold recommendations + Integer sellsGreater = null; // Integer | Return only records with more than this many Sell recommendations + Integer sellsLess = null; // Integer | Return only records with fewer than this many Sell recommendations + Integer strongSellsGreater = null; // Integer | Return only records with more than this many Strong Sell recommendations + Integer strongSellsLess = null; // Integer | Return only records with fewer than this many Strong Sell recommendations + Integer totalGreater = null; // Integer | Return only records with more than this many recommendations, regardless of type + Integer totalLess = null; // Integer | Return only records with fewer than this many recommendations, regardless of type + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseZacksAnalystRatings result = zacksApi.getZacksAnalystRatings(identifier, startDate, endDate, meanGreater, meanLess, strongBuysGreater, strongBuysLess, buysGreater, buysLess, holdsGreater, holdsLess, sellsGreater, sellsLess, strongSellsGreater, strongSellsLess, totalGreater, totalLess, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ZacksApi#getZacksAnalystRatings"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | [optional]   + **startDate** | LocalDate| Limit ratings to those on or after this date | [optional]   + **endDate** | LocalDate| Limit ratings to those on or before this date | [optional]   + **meanGreater** | BigDecimal| Return only records with a mean (average) higher than this value | [optional]   + **meanLess** | BigDecimal| Return only records with a mean (average) lower than this value | [optional]   + **strongBuysGreater** | Integer| Return only records with more than this many Strong Buy recommendations | [optional]   + **strongBuysLess** | Integer| Return only records with fewer than this many Strong Buy recommendations | [optional]   + **buysGreater** | Integer| Return only records with more than this many Buy recommendations | [optional]   + **buysLess** | Integer| Return only records with fewer than this many Buy recommendations | [optional]   + **holdsGreater** | Integer| Return only records with more than this many Hold recommendations | [optional]   + **holdsLess** | Integer| Return only records with fewer than this many Hold recommendations | [optional]   + **sellsGreater** | Integer| Return only records with more than this many Sell recommendations | [optional]   + **sellsLess** | Integer| Return only records with fewer than this many Sell recommendations | [optional]   + **strongSellsGreater** | Integer| Return only records with more than this many Strong Sell recommendations | [optional]   + **strongSellsLess** | Integer| Return only records with fewer than this many Strong Sell recommendations | [optional]   + **totalGreater** | Integer| Return only records with more than this many recommendations, regardless of type | [optional]   + **totalLess** | Integer| Return only records with fewer than this many recommendations, regardless of type | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseZacksAnalystRatings**](ApiResponseZacksAnalystRatings.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:ZacksApi) + +[//]: # (METHOD:getZacksEpsEstimates) + +[//]: # (RETURN_TYPE:ApiResponseZacksEPSEstimates) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseZacksEPSEstimates.md) + +[//]: # (OPERATION:getZacksEpsEstimates_v2) + +[//]: # (ENDPOINT:/zacks/eps_estimates) + +[//]: # (DOCUMENT_LINK:ZacksApi.md#getZacksEpsEstimates) + + +## **getZacksEpsEstimates** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getZacksEpsEstimates_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseZacksEPSEstimates getZacksEpsEstimates(identifier, startDate, endDate, fiscalYear, fiscalPeriod, calendarYear, calendarPeriod, pageSize, nextPage) + +#### Zacks EPS Estimates + + +Returns Zacks consensus earnings-per-share (EPS) data for all Companies. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + ZacksApi zacksApi = new ZacksApi(); + + String identifier = "AAPL"; // String | A Company identifier (Ticker, CIK, LEI, Intrinio ID) + LocalDate startDate = LocalDate.now(); // LocalDate | Limit EPS estimates to those on or after this date + LocalDate endDate = LocalDate.now(); // LocalDate | Limit EPS estimates to those on or before this date + Integer fiscalYear = null; // Integer | Only for the given fiscal year + String fiscalPeriod = null; // String | The fiscal period + Integer calendarYear = null; // Integer | Only for the given calendar year + String calendarPeriod = null; // String | The calendar period + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseZacksEPSEstimates result = zacksApi.getZacksEpsEstimates(identifier, startDate, endDate, fiscalYear, fiscalPeriod, calendarYear, calendarPeriod, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ZacksApi#getZacksEpsEstimates"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | [optional]   + **startDate** | LocalDate| Limit EPS estimates to those on or after this date | [optional]   + **endDate** | LocalDate| Limit EPS estimates to those on or before this date | [optional]   + **fiscalYear** | Integer| Only for the given fiscal year | [optional]   + **fiscalPeriod** | String| The fiscal period | [optional] [enum: Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD]   + **calendarYear** | Integer| Only for the given calendar year | [optional]   + **calendarPeriod** | String| The calendar period | [optional] [enum: Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseZacksEPSEstimates**](ApiResponseZacksEPSEstimates.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:ZacksApi) + +[//]: # (METHOD:getZacksEpsGrowthRates) + +[//]: # (RETURN_TYPE:ApiResponseZacksEPSGrowthRates) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseZacksEPSGrowthRates.md) + +[//]: # (OPERATION:getZacksEpsGrowthRates_v2) + +[//]: # (ENDPOINT:/zacks/eps_growth_rates) + +[//]: # (DOCUMENT_LINK:ZacksApi.md#getZacksEpsGrowthRates) + + +## **getZacksEpsGrowthRates** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getZacksEpsGrowthRates_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseZacksEPSGrowthRates getZacksEpsGrowthRates(company, industryGroupName, industryGroupNumber, pageSize, nextPage) + +#### Zacks EPS Growth Rates + + +Returns the latest Zacks EPS growth rates + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + ZacksApi zacksApi = new ZacksApi(); + + String company = "AAPL"; // String | Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID) + String industryGroupName = null; // String | Return only growth rates for companies in the given Zacks industry group name + String industryGroupNumber = null; // String | Return only growth rates for companies in the given Zacks industry group number + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseZacksEPSGrowthRates result = zacksApi.getZacksEpsGrowthRates(company, industryGroupName, industryGroupNumber, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ZacksApi#getZacksEpsGrowthRates"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **company** | String| Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID) | [optional]   + **industryGroupName** | String| Return only growth rates for companies in the given Zacks industry group name | [optional]   + **industryGroupNumber** | String| Return only growth rates for companies in the given Zacks industry group number | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseZacksEPSGrowthRates**](ApiResponseZacksEPSGrowthRates.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:ZacksApi) + +[//]: # (METHOD:getZacksEpsSurprises) + +[//]: # (RETURN_TYPE:ApiResponseZacksEPSSurprises) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseZacksEPSSurprises.md) + +[//]: # (OPERATION:getZacksEpsSurprises_v2) + +[//]: # (ENDPOINT:/zacks/eps_surprises) + +[//]: # (DOCUMENT_LINK:ZacksApi.md#getZacksEpsSurprises) + + +## **getZacksEpsSurprises** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getZacksEpsSurprises_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseZacksEPSSurprises getZacksEpsSurprises(startDate, endDate, epsActualGreater, epsActualLess, epsMeanEstimateGreater, epsMeanEstimateLess, epsAmountDiffGreater, epsAmountDiffLess, epsPercentDiffGreater, epsPercentDiffLess, epsCountEstimateGreater, epsCountEstimateLess, epsStdDevEstimateGreater, epsStdDevEstimateLess, pageSize, nextPage) + +#### Zacks EPS Surprises + + +Returns Zacks eps surprise data for all Securities. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + ZacksApi zacksApi = new ZacksApi(); + + LocalDate startDate = LocalDate.now(); // LocalDate | Limit EPS surprises to those on or after this date + LocalDate endDate = LocalDate.now(); // LocalDate | Limit EPS surprises to those on or before this date + BigDecimal epsActualGreater = null; // BigDecimal | Return only records with an actual EPS higher than this value + BigDecimal epsActualLess = null; // BigDecimal | Return only records with an actual EPS lower than this value + BigDecimal epsMeanEstimateGreater = null; // BigDecimal | Return only records with an EPS mean estimate greater than this value + BigDecimal epsMeanEstimateLess = null; // BigDecimal | Return only records with an EPS mean estimate lower than this value + BigDecimal epsAmountDiffGreater = null; // BigDecimal | Return only records with an EPS amount difference greater than this value + BigDecimal epsAmountDiffLess = null; // BigDecimal | Return only records with an EPS amount difference less than this value + BigDecimal epsPercentDiffGreater = null; // BigDecimal | Return only records with an EPS percent difference greater than this value + BigDecimal epsPercentDiffLess = null; // BigDecimal | Return only records with an EPS percent difference less than this value + BigDecimal epsCountEstimateGreater = null; // BigDecimal | Return only records with an EPS count estimate greater than this value + BigDecimal epsCountEstimateLess = null; // BigDecimal | Return only records with an EPS count estimate less than this value + BigDecimal epsStdDevEstimateGreater = null; // BigDecimal | Return only records with an EPS standard deviation greater than this value + BigDecimal epsStdDevEstimateLess = null; // BigDecimal | Return only records with an EPS standard deviation less than this value + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseZacksEPSSurprises result = zacksApi.getZacksEpsSurprises(startDate, endDate, epsActualGreater, epsActualLess, epsMeanEstimateGreater, epsMeanEstimateLess, epsAmountDiffGreater, epsAmountDiffLess, epsPercentDiffGreater, epsPercentDiffLess, epsCountEstimateGreater, epsCountEstimateLess, epsStdDevEstimateGreater, epsStdDevEstimateLess, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ZacksApi#getZacksEpsSurprises"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **startDate** | LocalDate| Limit EPS surprises to those on or after this date | [optional]   + **endDate** | LocalDate| Limit EPS surprises to those on or before this date | [optional]   + **epsActualGreater** | BigDecimal| Return only records with an actual EPS higher than this value | [optional]   + **epsActualLess** | BigDecimal| Return only records with an actual EPS lower than this value | [optional]   + **epsMeanEstimateGreater** | BigDecimal| Return only records with an EPS mean estimate greater than this value | [optional]   + **epsMeanEstimateLess** | BigDecimal| Return only records with an EPS mean estimate lower than this value | [optional]   + **epsAmountDiffGreater** | BigDecimal| Return only records with an EPS amount difference greater than this value | [optional]   + **epsAmountDiffLess** | BigDecimal| Return only records with an EPS amount difference less than this value | [optional]   + **epsPercentDiffGreater** | BigDecimal| Return only records with an EPS percent difference greater than this value | [optional]   + **epsPercentDiffLess** | BigDecimal| Return only records with an EPS percent difference less than this value | [optional]   + **epsCountEstimateGreater** | BigDecimal| Return only records with an EPS count estimate greater than this value | [optional]   + **epsCountEstimateLess** | BigDecimal| Return only records with an EPS count estimate less than this value | [optional]   + **epsStdDevEstimateGreater** | BigDecimal| Return only records with an EPS standard deviation greater than this value | [optional]   + **epsStdDevEstimateLess** | BigDecimal| Return only records with an EPS standard deviation less than this value | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseZacksEPSSurprises**](ApiResponseZacksEPSSurprises.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:ZacksApi) + +[//]: # (METHOD:getZacksEtfHoldings) + +[//]: # (RETURN_TYPE:ApiResponseZacksETFHoldings) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseZacksETFHoldings.md) + +[//]: # (OPERATION:getZacksEtfHoldings_v2) + +[//]: # (ENDPOINT:/zacks/etf_holdings) + +[//]: # (DOCUMENT_LINK:ZacksApi.md#getZacksEtfHoldings) + + +## **getZacksEtfHoldings** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getZacksEtfHoldings_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseZacksETFHoldings getZacksEtfHoldings(etfTicker, holdingSymbol, weightGreater, weightLess, pageSize, nextPage) + +#### Zacks ETF Holdings + + +Returns Zacks ETF holdings data + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + ZacksApi zacksApi = new ZacksApi(); + + String etfTicker = null; // String | Return holdings of the ETF with the given ticker + String holdingSymbol = null; // String | Return holdings where the instrument being held has the given trading symbol + BigDecimal weightGreater = null; // BigDecimal | Return on the holdings with a weight greater than + BigDecimal weightLess = null; // BigDecimal | Return on the holdings with a weight less than + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseZacksETFHoldings result = zacksApi.getZacksEtfHoldings(etfTicker, holdingSymbol, weightGreater, weightLess, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ZacksApi#getZacksEtfHoldings"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **etfTicker** | String| Return holdings of the ETF with the given ticker | [optional]   + **holdingSymbol** | String| Return holdings where the instrument being held has the given trading symbol | [optional]   + **weightGreater** | BigDecimal| Return on the holdings with a weight greater than | [optional]   + **weightLess** | BigDecimal| Return on the holdings with a weight less than | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseZacksETFHoldings**](ApiResponseZacksETFHoldings.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:ZacksApi) + +[//]: # (METHOD:getZacksInstitutionalHoldingCompanies) + +[//]: # (RETURN_TYPE:ApiResponseZacksInstitutionalHoldingCompanies) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseZacksInstitutionalHoldingCompanies.md) + +[//]: # (OPERATION:getZacksInstitutionalHoldingCompanies_v2) + +[//]: # (ENDPOINT:/zacks/institutional_holdings/companies) + +[//]: # (DOCUMENT_LINK:ZacksApi.md#getZacksInstitutionalHoldingCompanies) + + +## **getZacksInstitutionalHoldingCompanies** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getZacksInstitutionalHoldingCompanies_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseZacksInstitutionalHoldingCompanies getZacksInstitutionalHoldingCompanies(ticker, pageSize, nextPage) + +#### Zacks Institutional Holding Companies + + +Returns Zacks institutional holding companies data + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + ZacksApi zacksApi = new ZacksApi(); + + String ticker = null; // String | Return companies with the given ticker + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseZacksInstitutionalHoldingCompanies result = zacksApi.getZacksInstitutionalHoldingCompanies(ticker, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ZacksApi#getZacksInstitutionalHoldingCompanies"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ticker** | String| Return companies with the given ticker | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseZacksInstitutionalHoldingCompanies**](ApiResponseZacksInstitutionalHoldingCompanies.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:ZacksApi) + +[//]: # (METHOD:getZacksInstitutionalHoldingOwners) + +[//]: # (RETURN_TYPE:ApiResponseZacksInstitutionalHoldingOwners) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseZacksInstitutionalHoldingOwners.md) + +[//]: # (OPERATION:getZacksInstitutionalHoldingOwners_v2) + +[//]: # (ENDPOINT:/zacks/institutional_holdings/owners) + +[//]: # (DOCUMENT_LINK:ZacksApi.md#getZacksInstitutionalHoldingOwners) + + +## **getZacksInstitutionalHoldingOwners** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getZacksInstitutionalHoldingOwners_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseZacksInstitutionalHoldingOwners getZacksInstitutionalHoldingOwners(cik, pageSize, nextPage) + +#### Zacks Institutional Holding Owners + + +Returns Zacks institutional holding owners data + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + ZacksApi zacksApi = new ZacksApi(); + + String cik = null; // String | Return owners with the given Central Index Key (CIK) + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseZacksInstitutionalHoldingOwners result = zacksApi.getZacksInstitutionalHoldingOwners(cik, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ZacksApi#getZacksInstitutionalHoldingOwners"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cik** | String| Return owners with the given Central Index Key (CIK) | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseZacksInstitutionalHoldingOwners**](ApiResponseZacksInstitutionalHoldingOwners.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:ZacksApi) + +[//]: # (METHOD:getZacksInstitutionalHoldings) + +[//]: # (RETURN_TYPE:ApiResponseZacksInstitutionalHoldings) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseZacksInstitutionalHoldings.md) + +[//]: # (OPERATION:getZacksInstitutionalHoldings_v2) + +[//]: # (ENDPOINT:/zacks/institutional_holdings) + +[//]: # (DOCUMENT_LINK:ZacksApi.md#getZacksInstitutionalHoldings) + + +## **getZacksInstitutionalHoldings** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getZacksInstitutionalHoldings_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseZacksInstitutionalHoldings getZacksInstitutionalHoldings(ticker, ownerCik, pageSize, nextPage) + +#### Zacks Institutional Holdings + + +Returns Zacks institutional holdings data + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + ZacksApi zacksApi = new ZacksApi(); + + String ticker = null; // String | Return holdings where the company being held has the given ticker + String ownerCik = null; // String | Return holdings where the owner/holder has the given Central Index Key (CIK) + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseZacksInstitutionalHoldings result = zacksApi.getZacksInstitutionalHoldings(ticker, ownerCik, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ZacksApi#getZacksInstitutionalHoldings"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ticker** | String| Return holdings where the company being held has the given ticker | [optional]   + **ownerCik** | String| Return holdings where the owner/holder has the given Central Index Key (CIK) | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseZacksInstitutionalHoldings**](ApiResponseZacksInstitutionalHoldings.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:ZacksApi) + +[//]: # (METHOD:getZacksLongTermGrowthRates) + +[//]: # (RETURN_TYPE:ApiResponseZacksLongTermGrowthRates) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseZacksLongTermGrowthRates.md) + +[//]: # (OPERATION:getZacksLongTermGrowthRates_v2) + +[//]: # (ENDPOINT:/zacks/long_term_growth_rates) + +[//]: # (DOCUMENT_LINK:ZacksApi.md#getZacksLongTermGrowthRates) + + +## **getZacksLongTermGrowthRates** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getZacksLongTermGrowthRates_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseZacksLongTermGrowthRates getZacksLongTermGrowthRates(identifier, pageSize, nextPage) + +#### Zacks Long Term Growth Rates + + +Returns the latest Zacks long term growth rates + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + ZacksApi zacksApi = new ZacksApi(); + + String identifier = "AAPL"; // String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseZacksLongTermGrowthRates result = zacksApi.getZacksLongTermGrowthRates(identifier, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ZacksApi#getZacksLongTermGrowthRates"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseZacksLongTermGrowthRates**](ApiResponseZacksLongTermGrowthRates.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:ZacksApi) + +[//]: # (METHOD:getZacksSalesSurprises) + +[//]: # (RETURN_TYPE:ApiResponseZacksSalesSurprises) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseZacksSalesSurprises.md) + +[//]: # (OPERATION:getZacksSalesSurprises_v2) + +[//]: # (ENDPOINT:/zacks/sales_surprises) + +[//]: # (DOCUMENT_LINK:ZacksApi.md#getZacksSalesSurprises) + + +## **getZacksSalesSurprises** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getZacksSalesSurprises_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseZacksSalesSurprises getZacksSalesSurprises(startDate, endDate, salesActualGreater, salesActualLess, salesMeanEstimateGreater, salesMeanEstimateLess, salesAmountDiffGreater, salesAmountDiffLess, salesPercentDiffGreater, salesPercentDiffLess, salesCountEstimateGreater, salesCountEstimateLess, salesStdDevEstimateGreater, salesStdDevEstimateLess, pageSize, nextPage) + +#### Zacks Sales Surprises + + +Returns Zacks sales surprise data for all Securities. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + ZacksApi zacksApi = new ZacksApi(); + + LocalDate startDate = LocalDate.now(); // LocalDate | Limit sales surprises to those on or after this date + LocalDate endDate = LocalDate.now(); // LocalDate | Limit sales surprises to those on or before this date + BigDecimal salesActualGreater = null; // BigDecimal | Return only records with an actual sales higher than this value + BigDecimal salesActualLess = null; // BigDecimal | Return only records with an actual sales lower than this value + BigDecimal salesMeanEstimateGreater = null; // BigDecimal | Return only records with a sales mean estimate greater than this value + BigDecimal salesMeanEstimateLess = null; // BigDecimal | Return only records with a sales mean estimate lower than this value + BigDecimal salesAmountDiffGreater = null; // BigDecimal | Return only records with a sales amount difference greater than this value + BigDecimal salesAmountDiffLess = null; // BigDecimal | Return only records with a sales amount difference less than this value + BigDecimal salesPercentDiffGreater = null; // BigDecimal | Return only records with a sales percent difference greater than this value + BigDecimal salesPercentDiffLess = null; // BigDecimal | Return only records with a sales percent difference less than this value + BigDecimal salesCountEstimateGreater = null; // BigDecimal | Return only records with a sales count estimate greater than this value + BigDecimal salesCountEstimateLess = null; // BigDecimal | Return only records with a sales count estimate less than this value + BigDecimal salesStdDevEstimateGreater = null; // BigDecimal | Return only records with a sales standard deviation greater than this value + BigDecimal salesStdDevEstimateLess = null; // BigDecimal | Return only records with a sales standard deviation less than this value + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseZacksSalesSurprises result = zacksApi.getZacksSalesSurprises(startDate, endDate, salesActualGreater, salesActualLess, salesMeanEstimateGreater, salesMeanEstimateLess, salesAmountDiffGreater, salesAmountDiffLess, salesPercentDiffGreater, salesPercentDiffLess, salesCountEstimateGreater, salesCountEstimateLess, salesStdDevEstimateGreater, salesStdDevEstimateLess, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ZacksApi#getZacksSalesSurprises"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **startDate** | LocalDate| Limit sales surprises to those on or after this date | [optional]   + **endDate** | LocalDate| Limit sales surprises to those on or before this date | [optional]   + **salesActualGreater** | BigDecimal| Return only records with an actual sales higher than this value | [optional]   + **salesActualLess** | BigDecimal| Return only records with an actual sales lower than this value | [optional]   + **salesMeanEstimateGreater** | BigDecimal| Return only records with a sales mean estimate greater than this value | [optional]   + **salesMeanEstimateLess** | BigDecimal| Return only records with a sales mean estimate lower than this value | [optional]   + **salesAmountDiffGreater** | BigDecimal| Return only records with a sales amount difference greater than this value | [optional]   + **salesAmountDiffLess** | BigDecimal| Return only records with a sales amount difference less than this value | [optional]   + **salesPercentDiffGreater** | BigDecimal| Return only records with a sales percent difference greater than this value | [optional]   + **salesPercentDiffLess** | BigDecimal| Return only records with a sales percent difference less than this value | [optional]   + **salesCountEstimateGreater** | BigDecimal| Return only records with a sales count estimate greater than this value | [optional]   + **salesCountEstimateLess** | BigDecimal| Return only records with a sales count estimate less than this value | [optional]   + **salesStdDevEstimateGreater** | BigDecimal| Return only records with a sales standard deviation greater than this value | [optional]   + **salesStdDevEstimateLess** | BigDecimal| Return only records with a sales standard deviation less than this value | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseZacksSalesSurprises**](ApiResponseZacksSalesSurprises.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:ZacksApi) + +[//]: # (METHOD:getZacksTargetPriceConsensuses) + +[//]: # (RETURN_TYPE:ApiResponseZacksTargetPriceConsensuses) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseZacksTargetPriceConsensuses.md) + +[//]: # (OPERATION:getZacksTargetPriceConsensuses_v2) + +[//]: # (ENDPOINT:/zacks/target_price_consensuses) + +[//]: # (DOCUMENT_LINK:ZacksApi.md#getZacksTargetPriceConsensuses) + + +## **getZacksTargetPriceConsensuses** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/java/getZacksTargetPriceConsensuses_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseZacksTargetPriceConsensuses getZacksTargetPriceConsensuses(identifier, industryGroupNumber, pageSize, nextPage) + +#### Zacks Target Price Consensuses + + +Returns the latest Zacks target price consensus data + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```java +import com.intrinio.api.*; +import com.intrinio.models.*; +import com.intrinio.invoker.*; +import com.intrinio.invoker.auth.*; +import org.threeten.bp.*; +import java.math.BigDecimal; + +public class Main { + public static void main(String[] args) { + + ApiClient defaultClient = Configuration.getDefaultApiClient(); + ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + auth.setApiKey("YOUR_API_KEY"); + + ZacksApi zacksApi = new ZacksApi(); + + String identifier = "AAPL"; // String | Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID) + String industryGroupNumber = null; // String | Return only growth rates for companies in the given Zacks industry group number + Integer pageSize = 100; // Integer | The number of results to return + String nextPage = null; // String | Gets the next page of data from a previous API call + + try { + ApiResponseZacksTargetPriceConsensuses result = zacksApi.getZacksTargetPriceConsensuses(identifier, industryGroupNumber, pageSize, nextPage); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling ZacksApi#getZacksTargetPriceConsensuses"); + e.printStackTrace(); + } + + } +} +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID) | [optional]   + **industryGroupNumber** | String| Return only growth rates for companies in the given Zacks industry group number | [optional]   + **pageSize** | Integer| The number of results to return | [optional] [default to 100]   + **nextPage** | String| Gets the next page of data from a previous API call | [optional]   +
+ +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseZacksTargetPriceConsensuses**](ApiResponseZacksTargetPriceConsensuses.md) + +[//]: # (END_OPERATION) + diff --git a/docs/ZacksEPSEstimate.md b/docs/ZacksEPSEstimate.md new file mode 100644 index 0000000..da34536 --- /dev/null +++ b/docs/ZacksEPSEstimate.md @@ -0,0 +1,73 @@ + +[//]: # (CLASS:ZacksEPSEstimate) + +[//]: # (KIND:object) + +### ZacksEPSEstimate + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**company** | [**CompanySummary**](CompanySummary.md) |   +**date** | [**LocalDate**](LocalDate.md) | The period end date   +**fiscalYear** | Integer | The company’s fiscal year for the reported period   +**fiscalQuarter** | String | The company’s fiscal quarter for the reported period   +**calendarYear** | Integer | The closest calendar year for the company’s fiscal year   +**calendarQuarter** | String | The closest calendar quarter for the company’s fiscal year   +**count** | Integer | The number of estimates for the period   +**mean** | [**BigDecimal**](BigDecimal.md) | The earnings per share (EPS) mean estimate for the period   +**median** | [**BigDecimal**](BigDecimal.md) | The earnings per share (EPS) median estimate for the period   +**high** | [**BigDecimal**](BigDecimal.md) | The earnings per share (EPS) high estimate for the period   +**low** | [**BigDecimal**](BigDecimal.md) | The earnings per share (EPS) low estimate for the period   +**standardDeviation** | [**BigDecimal**](BigDecimal.md) | The earnings per share (EPS) standard deviation estimate for the period   +**percentChange** | [**BigDecimal**](BigDecimal.md) | The earnings per share (EPS) percent change in estimate for the period   +**mean7DaysAgo** | [**BigDecimal**](BigDecimal.md) | The long term growth mean estimate - 7 Days Ago   +**mean30DaysAgo** | [**BigDecimal**](BigDecimal.md) | The long term growth mean estimate - 30 Days Ago   +**mean60DaysAgo** | [**BigDecimal**](BigDecimal.md) | The long term growth mean estimate - 60 Days Ago   +**mean90DaysAgo** | [**BigDecimal**](BigDecimal.md) | The long term growth mean estimate - 90 Days Ago   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:CompanySummary) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/ZacksEPSGrowthRate.md b/docs/ZacksEPSGrowthRate.md new file mode 100644 index 0000000..b5ea467 --- /dev/null +++ b/docs/ZacksEPSGrowthRate.md @@ -0,0 +1,91 @@ + +[//]: # (CLASS:ZacksEPSGrowthRate) + +[//]: # (KIND:object) + +### ZacksEPSGrowthRate + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**ticker** | String | The Zacks common exchange ticker   +**companyName** | String | The company name   +**industryGroupNumber** | String | The Zacks industry group number   +**industryGroupName** | String | The Zacks industry group name   +**fiscalYear0** | Integer | The current fiscal year   +**fiscalYear1** | Integer | The next fiscal year   +**fiscalYear2** | Integer | The fiscal year after the next fiscal year   +**companyLast5YearActual** | [**BigDecimal**](BigDecimal.md) | The company's last 5 year actual percentage earnings-per-share (EPS) growth rate   +**companyFiscalYear1VsFiscalYear0** | [**BigDecimal**](BigDecimal.md) | The company's current fiscal year / last fiscal year percentage earnings-per-share (EPS) growth rate   +**companyFiscalYear2VsFiscalYear1** | [**BigDecimal**](BigDecimal.md) | The company's next fiscal year / current fiscal year percentage earnings-per-share (EPS) growth rate   +**companyLongTermGrowthMean** | [**BigDecimal**](BigDecimal.md) | The company's long term growth rate mean estimate   +**companyFiscalYear1ForwardPriceToEarnings** | [**BigDecimal**](BigDecimal.md) | The company's forward (current fiscal year) price-to-earnings (P/E) ratio   +**industryLast5YearActual** | [**BigDecimal**](BigDecimal.md) | The industry's last 5 year actual percentage earnings-per-share (EPS) growth rate   +**industryFiscalYear1VsFiscalYear0** | [**BigDecimal**](BigDecimal.md) | The industry's current fiscal year / last fiscal year percentage earnings-per-share (EPS) growth rate   +**industryFiscalYear2VsFiscalYear1** | [**BigDecimal**](BigDecimal.md) | The industry's next fiscal year / current fiscal year percentage earnings-per-share (EPS) growth rate   +**industryLongTermGrowthMean** | [**BigDecimal**](BigDecimal.md) | The industry's long term growth rate mean estimate   +**industryFiscalYear1ForwardPriceToEarnings** | [**BigDecimal**](BigDecimal.md) | The industry's forward (current fiscal year) price-to-earnings (P/E) ratio   +**sp500Last5YearActual** | [**BigDecimal**](BigDecimal.md) | The S&P 500's last 5 year actual percentage earnings-per-share (EPS) growth rate   +**sp500FiscalYear1VsFiscalYear0** | [**BigDecimal**](BigDecimal.md) | The S&P 500's current fiscal year / last fiscal year percentage earnings-per-share (EPS) growth rate   +**sp500FiscalYear2VsFiscalYear1** | [**BigDecimal**](BigDecimal.md) | The S&P 500's next fiscal year / current fiscal year percentage earnings-per-share (EPS) growth rate   +**sp500LongTermGrowth** | [**BigDecimal**](BigDecimal.md) | The S&P 500's long term growth rate mean estimate   +**sp500FiscalYear1PriceToEarnings** | [**BigDecimal**](BigDecimal.md) | The S&P 500's forward (current fiscal year) price-to-earnings (P/E) ratio   +**company** | [**CompanySummary**](CompanySummary.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:CompanySummary) + + + + + diff --git a/docs/ZacksEPSSurprise.md b/docs/ZacksEPSSurprise.md new file mode 100644 index 0000000..51aa225 --- /dev/null +++ b/docs/ZacksEPSSurprise.md @@ -0,0 +1,70 @@ + +[//]: # (CLASS:ZacksEPSSurprise) + +[//]: # (KIND:object) + +### ZacksEPSSurprise + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for the record   +**fiscalYear** | [**BigDecimal**](BigDecimal.md) | The company’s fiscal year for the reported period   +**fiscalQuarter** | String | The company’s fiscal quarter for the reported period   +**calendarYear** | [**BigDecimal**](BigDecimal.md) | The closest calendar year for the company’s fiscal year   +**calendarQuarter** | String | The closest calendar quarter for the company’s fiscal year   +**actualReportedDate** | [**LocalDate**](LocalDate.md) | The actual report date for the earnings release   +**actualReportedTime** | String | The actual report time for the earnings release   +**actualReportedCode** | String | The code cooresponding to the earnings release BTO = BEFORE THE OPEN | DTM = DURING THE MARKET | AMC = AFTER MARKET CLOSE   +**actualReportedDesc** | String | The description for the type of earnings release   +**epsActual** | [**BigDecimal**](BigDecimal.md) | The actual Non-GAAP EPS figure released by the company, interpreted by Zacks.   +**epsActualZacksAdj** | [**BigDecimal**](BigDecimal.md) | The adjustments Zacks made to get to Non-GAAP EPS to reconcile with GAAP EPS.   +**epsMeanEstimate** | [**BigDecimal**](BigDecimal.md) | The pre-earnings release mean EPS estimate for the company   +**epsAmountDiff** | [**BigDecimal**](BigDecimal.md) | The EPS surprise amount difference   +**epsPercentDiff** | [**BigDecimal**](BigDecimal.md) | The EPS surprise percent difference   +**epsCountEstimate** | [**BigDecimal**](BigDecimal.md) | The pre-earnings release number of estimates by analysts   +**epsStdDevEstimate** | [**BigDecimal**](BigDecimal.md) | The pre-earnings release standard deviation of EPS estimates   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Zacks EPS Surprise   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ZacksEPSSurpriseSummary.md b/docs/ZacksEPSSurpriseSummary.md new file mode 100644 index 0000000..04d0d52 --- /dev/null +++ b/docs/ZacksEPSSurpriseSummary.md @@ -0,0 +1,66 @@ + +[//]: # (CLASS:ZacksEPSSurpriseSummary) + +[//]: # (KIND:object) + +### ZacksEPSSurpriseSummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for the record   +**fiscalYear** | [**BigDecimal**](BigDecimal.md) | The company’s fiscal year for the reported period   +**fiscalQuarter** | String | The company’s fiscal quarter for the reported period   +**calendarYear** | [**BigDecimal**](BigDecimal.md) | The closest calendar year for the company’s fiscal year   +**calendarQuarter** | String | The closest calendar quarter for the company’s fiscal year   +**actualReportedDate** | [**LocalDate**](LocalDate.md) | The actual report date for the earnings release   +**actualReportedTime** | String | The actual report time for the earnings release   +**actualReportedCode** | String | The code cooresponding to the earnings release BTO = BEFORE THE OPEN | DTM = DURING THE MARKET | AMC = AFTER MARKET CLOSE   +**actualReportedDesc** | String | The description for the type of earnings release   +**epsActual** | [**BigDecimal**](BigDecimal.md) | The actual Non-GAAP EPS figure released by the company, interpreted by Zacks.   +**epsActualZacksAdj** | [**BigDecimal**](BigDecimal.md) | The adjustments Zacks made to get to Non-GAAP EPS to reconcile with GAAP EPS.   +**epsMeanEstimate** | [**BigDecimal**](BigDecimal.md) | The pre-earnings release mean EPS estimate for the company   +**epsAmountDiff** | [**BigDecimal**](BigDecimal.md) | The EPS surprise amount difference   +**epsPercentDiff** | [**BigDecimal**](BigDecimal.md) | The EPS surprise percent difference   +**epsCountEstimate** | [**BigDecimal**](BigDecimal.md) | The pre-earnings release number of estimates by analysts   +**epsStdDevEstimate** | [**BigDecimal**](BigDecimal.md) | The pre-earnings release standard deviation of EPS estimates   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/ZacksETFHolding.md b/docs/ZacksETFHolding.md new file mode 100644 index 0000000..844a49f --- /dev/null +++ b/docs/ZacksETFHolding.md @@ -0,0 +1,36 @@ + +[//]: # (CLASS:ZacksETFHolding) + +[//]: # (KIND:object) + +### ZacksETFHolding + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**etfTicker** | String | The ETF's common ticker   +**etfName** | String | The ETF's name   +**holdingSymbol** | String | The holding's common ticker   +**holdingName** | String | The holding's name   +**dateOfHolding** | [**LocalDate**](LocalDate.md) | The date of the holding   +**shares** | [**BigDecimal**](BigDecimal.md) | The number of shares   +**weight** | [**BigDecimal**](BigDecimal.md) | The weight of the holding   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/ZacksInstitutionalHolding.md b/docs/ZacksInstitutionalHolding.md new file mode 100644 index 0000000..a29eedd --- /dev/null +++ b/docs/ZacksInstitutionalHolding.md @@ -0,0 +1,69 @@ + +[//]: # (CLASS:ZacksInstitutionalHolding) + +[//]: # (KIND:object) + +### ZacksInstitutionalHolding + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**company** | [**ZacksInstitutionalHoldingCompanySummary**](ZacksInstitutionalHoldingCompanySummary.md) |   +**owner** | [**ZacksInstitutionalHoldingOwnerSummary**](ZacksInstitutionalHoldingOwnerSummary.md) |   +**asOfDate** | [**LocalDate**](LocalDate.md) | Quarter end date listed in the most recent 13F report filed by the institution   +**sharesHeld** | [**BigDecimal**](BigDecimal.md) | Number of shares of the stock listed   +**sharedHeldPercent** | [**BigDecimal**](BigDecimal.md) | Percent of shares outstanding held of the stock by the institution listed   +**sharesChange** | [**BigDecimal**](BigDecimal.md) | Change in shares of the stock held by the institution listed   +**sharesChangePercent** | [**BigDecimal**](BigDecimal.md) | Percentage change in shares of the stock held by the institution listed   +**marketValue** | [**BigDecimal**](BigDecimal.md) | Market value of shares outstanding held of the stock listed   +**marketValueChange** | [**BigDecimal**](BigDecimal.md) | Change in market value shares of the stock listed   +**lastSecFilingType** | String | The report type of the latest SEC filing   +**lastSecFilingDate** | [**LocalDate**](LocalDate.md) | The date of the latest SEC filing   +**lastSecFilingShares** | [**BigDecimal**](BigDecimal.md) | The   +**historicalHoldings** | [**List<ZacksInstitutionalHoldingHistoricalSummary>**](ZacksInstitutionalHoldingHistoricalSummary.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:ZacksInstitutionalHoldingCompanySummary) + + +[//]: # (CONTAINED_CLASS:ZacksInstitutionalHoldingOwnerSummary) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:ZacksInstitutionalHoldingHistoricalSummary) + + + + + diff --git a/docs/ZacksInstitutionalHoldingCompanyDetail.md b/docs/ZacksInstitutionalHoldingCompanyDetail.md new file mode 100644 index 0000000..ae108a3 --- /dev/null +++ b/docs/ZacksInstitutionalHoldingCompanyDetail.md @@ -0,0 +1,63 @@ + +[//]: # (CLASS:ZacksInstitutionalHoldingCompanyDetail) + +[//]: # (KIND:object) + +### ZacksInstitutionalHoldingCompanyDetail + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**ticker** | String | The Zacks common exchange ticker   +**name** | String | The company name of the stock listed   +**exchange** | String | Exhange where the stock is traded whose shares are held by the institution   +**sharesOutstanding** | [**BigDecimal**](BigDecimal.md) | The number of shares shares outstanding for the stock   +**lastClosePrice** | [**BigDecimal**](BigDecimal.md) | The last close price of the stock listed   +**lastCloseDate** | [**LocalDate**](LocalDate.md) | Last closing price of the stock listed   +**institutionalSharesHeldPercent** | [**BigDecimal**](BigDecimal.md) | Percentage of shares outstanding held by institutions in the stock listed   +**institutionalSharesBuy** | [**BigDecimal**](BigDecimal.md) | Number of shares bought by institutions in the stock listed   +**institutionalSharesSell** | [**BigDecimal**](BigDecimal.md) | Number of shares sold by institutions in the stock listed   +**institutionalPositionsIncrease** | [**BigDecimal**](BigDecimal.md) | Number of institutions who increased their shares held in the stock listed   +**institutionalPositionsDecrease** | [**BigDecimal**](BigDecimal.md) | Number of institutions who decrease their shares held in the stock listed   +**institutionalPositionsUnchanged** | [**BigDecimal**](BigDecimal.md) | Number of institutions who did not change their shares held in the stock listed   +**institutionalPositionsTotal** | [**BigDecimal**](BigDecimal.md) | Total number of institutions who hold shares in the stock listed   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/ZacksInstitutionalHoldingCompanySummary.md b/docs/ZacksInstitutionalHoldingCompanySummary.md new file mode 100644 index 0000000..7b0a5b4 --- /dev/null +++ b/docs/ZacksInstitutionalHoldingCompanySummary.md @@ -0,0 +1,23 @@ + +[//]: # (CLASS:ZacksInstitutionalHoldingCompanySummary) + +[//]: # (KIND:object) + +### ZacksInstitutionalHoldingCompanySummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**ticker** | String | The Zacks common exchange ticker   +**name** | String | The company name of the stock listed   +**exchange** | String | Exhange where the stock is traded whose shares are held by the institution   + +[//]: # (END_DEFINITION) + + + + + diff --git a/docs/ZacksInstitutionalHoldingHistoricalSummary.md b/docs/ZacksInstitutionalHoldingHistoricalSummary.md new file mode 100644 index 0000000..e086d71 --- /dev/null +++ b/docs/ZacksInstitutionalHoldingHistoricalSummary.md @@ -0,0 +1,28 @@ + +[//]: # (CLASS:ZacksInstitutionalHoldingHistoricalSummary) + +[//]: # (KIND:object) + +### ZacksInstitutionalHoldingHistoricalSummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**asOfDate** | [**LocalDate**](LocalDate.md) | The date of the institutional holding   +**sharesHeld** | [**BigDecimal**](BigDecimal.md) | The number of shares held   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/ZacksInstitutionalHoldingOwnerDetail.md b/docs/ZacksInstitutionalHoldingOwnerDetail.md new file mode 100644 index 0000000..1f79651 --- /dev/null +++ b/docs/ZacksInstitutionalHoldingOwnerDetail.md @@ -0,0 +1,53 @@ + +[//]: # (CLASS:ZacksInstitutionalHoldingOwnerDetail) + +[//]: # (KIND:object) + +### ZacksInstitutionalHoldingOwnerDetail + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**name** | String | The owner's name   +**cik** | String | The Central Index Key (CIK) assigned to the company by the SEC as a unique identifier, used in SEC filings   +**address** | String | The owner's address   +**cityState** | String | The owner's city and state (City, ST)   +**locationCode** | String | The owner's location code. ('D' = Domestic, 'C' = Canadian, 'F' = Foreign)   +**phoneNumber** | String | The owner's phone number   +**postalCode** | String | The owner's postal code   +**url** | String | The owner's website url   +**investmentStyle** | String | The owner's investment style ('I' = Income, 'V' = Value, 'G' = Growth, 'B' = Growth at a Reasonable Price, 'A' = Aggressive Growth, 'P' = Passive/Index, 'D' = Deep Value)   +**numberOfHoldings** | [**BigDecimal**](BigDecimal.md) | Count of equity holdings only, doesn't include bonds or other funds held   +**totalHoldingsValue** | [**BigDecimal**](BigDecimal.md) | Market value of equity holdings in 1,000s. Sum of shares held times last close price.   +**portfolioTurnoverPercent** | [**BigDecimal**](BigDecimal.md) | Annual portfolio turnover in terms of percentage of total value.   +**isFund** | String | If 'Y', the owner is a fund? ('Y' = Yes, 'N' = No)   +**fundTicker** | String | Fund ticker if the institution is a fund   +**hasFundManager** | String | Does the fund have a manager. ('Y' = Yes, 'N' = No)   +**fundManagerCity** | String | The fund manager's city   +**fundManagerName** | String | The fund manager's name   +**fundManagerState** | String | The fund manager's state   +**files13f** | String | If 'Y', the company files the SEC 13F report. ('Y' = Yes, 'N' = No)   +**isEtf** | String | If 'Y', the owner is an ETF. ('Y' = Yes, 'N' = No)   +**lastUpdatedOn** | [**LocalDate**](LocalDate.md) | The the last updated date   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + + + + diff --git a/docs/ZacksInstitutionalHoldingOwnerSummary.md b/docs/ZacksInstitutionalHoldingOwnerSummary.md new file mode 100644 index 0000000..08a4b01 --- /dev/null +++ b/docs/ZacksInstitutionalHoldingOwnerSummary.md @@ -0,0 +1,22 @@ + +[//]: # (CLASS:ZacksInstitutionalHoldingOwnerSummary) + +[//]: # (KIND:object) + +### ZacksInstitutionalHoldingOwnerSummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**name** | String | The owner's name   +**cik** | String | The Central Index Key (CIK) assigned to the company by the SEC as a unique identifier, used in SEC filings   + +[//]: # (END_DEFINITION) + + + + + diff --git a/docs/ZacksLongTermGrowthRate.md b/docs/ZacksLongTermGrowthRate.md new file mode 100644 index 0000000..7d8e85b --- /dev/null +++ b/docs/ZacksLongTermGrowthRate.md @@ -0,0 +1,60 @@ + +[//]: # (CLASS:ZacksLongTermGrowthRate) + +[//]: # (KIND:object) + +### ZacksLongTermGrowthRate + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**mean** | [**BigDecimal**](BigDecimal.md) | The mean long term growth estimate   +**median** | [**BigDecimal**](BigDecimal.md) | The median long term growth estimate   +**count** | Integer | The number of long term growth estimates   +**high** | [**BigDecimal**](BigDecimal.md) | The high long term growth estimate   +**low** | [**BigDecimal**](BigDecimal.md) | The low long term growth estimate   +**stdDev** | String | The standard deviation long term growth estimate   +**revisionsUpward** | Integer | The number of long term growth estimate revisions upward   +**revisionsDownward** | Integer | The number of long term growth estimate revisions downward   +**mean7DaysAgo** | String | The mean long term growth estimate 7 days ago   +**mean30DaysAgo** | String | The mean long term growth estimate 30 days ago   +**mean60DaysAgo** | String | The mean long term growth estimate 60 days ago   +**mean90DaysAgo** | String | The mean long term growth estimate 90 days ago   +**revisionsUpwardLast7Days** | String | The number of long term growth estimate revisions upward in the last 7 days   +**revisionsDownwardLast7Days** | String | The number of long term growth estimate revisions downward in the last 7 days   +**revisionsUpwardLast30Days** | String | The number of long term growth estimate revisions upward in the last 30 days   +**revisionsDownwardLast30Days** | String | The number of long term growth estimate revisions downward in the last 30 days   +**revisionsUpwardLast60Days** | String | The number of long term growth estimate revisions upward in the last 60 days   +**revisionsDownwardLast60Days** | String | The number of long term growth estimate revisions downward in the last 60 days   +**revisionsUpwardLast90Days** | String | The number of long term growth estimate revisions upward in the last 90 days   +**revisionsDownwardLast90Days** | String | The number of long term growth estimate revisions downward in the last 90 days   +**revisionsUpwardLast120Days** | String | The number of long term growth estimate revisions upward in the last 120 days   +**revisionsDownwardLast120Days** | String | The number of long term growth estimate revisions downward in the last 120 days   +**revisionsUpwardLast150Days** | String | The number of long term growth estimate revisions upward in the last 150 days   +**revisionsDownwardLast150Days** | String | The number of long term growth estimate revisions downward in the last 150 days   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Zacks long term growth estimate   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ZacksSalesSurprise.md b/docs/ZacksSalesSurprise.md new file mode 100644 index 0000000..1863010 --- /dev/null +++ b/docs/ZacksSalesSurprise.md @@ -0,0 +1,70 @@ + +[//]: # (CLASS:ZacksSalesSurprise) + +[//]: # (KIND:object) + +### ZacksSalesSurprise + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for the record   +**fiscalYear** | [**BigDecimal**](BigDecimal.md) | The company’s fiscal year for the reported period   +**fiscalQuarter** | String | The company’s fiscal quarter for the reported period   +**calendarYear** | [**BigDecimal**](BigDecimal.md) | The closest calendar year for the company’s fiscal year   +**calendarQuarter** | String | The closest calendar quarter for the company’s fiscal year   +**actualReportedDate** | [**LocalDate**](LocalDate.md) | The actual report date for the earnings release   +**actualReportedTime** | String | The actual report time for the earnings release   +**actualReportedCode** | String | The code cooresponding to the earnings release BTO = BEFORE THE OPEN | DTM = DURING THE MARKET | AMC = AFTER MARKET CLOSE   +**actualReportedDesc** | String | The description for the type of earnings release   +**lastRevDate** | [**LocalDate**](LocalDate.md) | The last revision date for the analyst estimates   +**salesActual** | [**BigDecimal**](BigDecimal.md) | The actual Non-GAAP sales figure released by the company, interpreted by Zacks.   +**salesActualZacksAdj** | [**BigDecimal**](BigDecimal.md) | The adjustments Zacks made to get to Non-GAAP sales to reconcile with GAAP sales.   +**salesActualGaap** | [**BigDecimal**](BigDecimal.md) | The actual GAAP sales figured released by the company   +**salesMeanEstimate** | [**BigDecimal**](BigDecimal.md) | The pre-earnings release mean sales estimate for the company sales_count_estimate; the pre-earnings release number of estimates by analysts   +**salesAmountDiff** | [**BigDecimal**](BigDecimal.md) | The sales surprise amount difference   +**salesPercentDiff** | [**BigDecimal**](BigDecimal.md) | The sales surprise percent difference   +**salesStdDevEstimate** | [**BigDecimal**](BigDecimal.md) | The pre-earnings release standard deviation of sales estimates   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + + + + diff --git a/docs/ZacksSalesSurpriseSummary.md b/docs/ZacksSalesSurpriseSummary.md new file mode 100644 index 0000000..06ef674 --- /dev/null +++ b/docs/ZacksSalesSurpriseSummary.md @@ -0,0 +1,74 @@ + +[//]: # (CLASS:ZacksSalesSurpriseSummary) + +[//]: # (KIND:object) + +### ZacksSalesSurpriseSummary + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**id** | String | The Intrinio ID for the record   +**fiscalYear** | [**BigDecimal**](BigDecimal.md) | The company’s fiscal year for the reported period   +**fiscalQuarter** | String | The company’s fiscal quarter for the reported period   +**calendarYear** | [**BigDecimal**](BigDecimal.md) | The closest calendar year for the company’s fiscal year   +**calendarQuarter** | String | The closest calendar quarter for the company’s fiscal year   +**actualReportedDate** | [**LocalDate**](LocalDate.md) | The actual report date for the earnings release   +**actualReportedTime** | String | The actual report time for the earnings release   +**actualReportedCode** | String | The code cooresponding to the earnings release BTO = BEFORE THE OPEN | DTM = DURING THE MARKET | AMC = AFTER MARKET CLOSE   +**actualReportedDesc** | String | The description for the type of earnings release   +**lastRevDate** | [**LocalDate**](LocalDate.md) | The last revision date for the analyst estimates   +**salesActual** | [**BigDecimal**](BigDecimal.md) | The actual Non-GAAP sales figure released by the company, interpreted by Zacks.   +**salesActualZacksAdj** | [**BigDecimal**](BigDecimal.md) | The adjustments Zacks made to get to Non-GAAP sales to reconcile with GAAP sales.   +**salesActualGaap** | [**BigDecimal**](BigDecimal.md) | The actual GAAP sales figured released by the company   +**salesMeanEstimate** | [**BigDecimal**](BigDecimal.md) | The pre-earnings release mean sales estimate for the company sales_count_estimate; the pre-earnings release number of estimates by analysts   +**salesAmountDiff** | [**BigDecimal**](BigDecimal.md) | The sales surprise amount difference   +**salesPercentDiff** | [**BigDecimal**](BigDecimal.md) | The sales surprise percent difference   +**salesStdDevEstimate** | [**BigDecimal**](BigDecimal.md) | The pre-earnings release standard deviation of sales estimates   +**security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Zacks Sales Surprise   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:SecuritySummary) + + + + + diff --git a/docs/ZacksTargetPriceConsensus.md b/docs/ZacksTargetPriceConsensus.md new file mode 100644 index 0000000..9112c13 --- /dev/null +++ b/docs/ZacksTargetPriceConsensus.md @@ -0,0 +1,54 @@ + +[//]: # (CLASS:ZacksTargetPriceConsensus) + +[//]: # (KIND:object) + +### ZacksTargetPriceConsensus + +#### Properties + +[//]: # (START_DEFINITION) + +Name | Type | Description +------------ | ------------- | ------------- +**ticker** | String | The Zacks common exchange ticker   +**companyName** | String | The company name   +**industryGroupNumber** | String | The Zacks industry group number   +**high** | [**BigDecimal**](BigDecimal.md) | The high target price estimate   +**low** | [**BigDecimal**](BigDecimal.md) | The low target price estimate   +**mean** | [**BigDecimal**](BigDecimal.md) | The mean target price estimate   +**standardDeviation** | [**BigDecimal**](BigDecimal.md) | The standard deviation of target price estimates   +**total** | Integer | The number of target price estimates in consensus   +**mostRecentDate** | [**LocalDate**](LocalDate.md) | The date of most recent estimate   +**median** | [**BigDecimal**](BigDecimal.md) | The median target price estimate   +**raised** | Integer | The number of estimates raised   +**lowered** | Integer | The number of estimates lowered   +**company** | [**CompanySummary**](CompanySummary.md) |   + +[//]: # (END_DEFINITION) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:LocalDate) + + +[//]: # (CONTAINED_CLASS:BigDecimal) + + +[//]: # (CONTAINED_CLASS:CompanySummary) + + + + +