├── .github └── workflows │ └── pr.yml ├── .swagger-codegen-ignore ├── .swagger-codegen └── VERSION ├── .travis.yml ├── README.md ├── docs ├── AccumulationDistributionIndexTechnicalValue.md ├── ApiResponseBulkDownloadLinks.md ├── ApiResponseCompanies.md ├── ApiResponseCompaniesSearch.md ├── ApiResponseCompanyAnswers.md ├── ApiResponseCompanyDailyMetrics.md ├── ApiResponseCompanyFilings.md ├── ApiResponseCompanyFundamentals.md ├── ApiResponseCompanyHistoricalData.md ├── ApiResponseCompanyInsiderTransactionFilings.md ├── ApiResponseCompanyNews.md ├── ApiResponseCompanyNewsBody.md ├── ApiResponseCompanyPublicFloatResult.md ├── ApiResponseCompanyRecognize.md ├── ApiResponseCompanySecurities.md ├── ApiResponseCompanySharesOutstanding.md ├── ApiResponseDataTags.md ├── ApiResponseDataTagsSearch.md ├── ApiResponseESGCompanies.md ├── ApiResponseESGCompanyComprehensiveRatingHistory.md ├── ApiResponseESGCompanyRatingHistory.md ├── ApiResponseESGLatest.md ├── ApiResponseESGLatestComprehensive.md ├── ApiResponseETFHoldings.md ├── ApiResponseETFs.md ├── ApiResponseEconomicIndexHistoricalData.md ├── ApiResponseEconomicIndices.md ├── ApiResponseEconomicIndicesSearch.md ├── ApiResponseEodIndexPrices.md ├── ApiResponseEodIndexPricesAll.md ├── ApiResponseFilingAnswers.md ├── ApiResponseFilingFundamentals.md ├── ApiResponseFilingNotes.md ├── ApiResponseFilingNotesSearch.md ├── ApiResponseFilings.md ├── ApiResponseForexCurrencies.md ├── ApiResponseForexPairs.md ├── ApiResponseForexPrices.md ├── ApiResponseHistoricalData.md ├── ApiResponseIndex.md ├── ApiResponseIndexConstituents.md ├── ApiResponseIndexIntervals.md ├── ApiResponseIndices.md ├── ApiResponseInitialPublicOfferings.md ├── ApiResponseInsiderTransactionFilings.md ├── ApiResponseMunicipalities.md ├── ApiResponseMunicipalitiyFinancials.md ├── ApiResponseNews.md ├── ApiResponseOptionPrices.md ├── ApiResponseOptions.md ├── ApiResponseOptionsAggregates.md ├── ApiResponseOptionsChain.md ├── ApiResponseOptionsChainEod.md ├── ApiResponseOptionsChainRealtime.md ├── ApiResponseOptionsExpirations.md ├── ApiResponseOptionsGreekContractRealtime.md ├── ApiResponseOptionsGreeksByTickerRealtime.md ├── ApiResponseOptionsImpliedMove.md ├── ApiResponseOptionsPriceRealtime.md ├── ApiResponseOptionsPricesBatchRealtime.md ├── ApiResponseOptionsPricesByTickerEod.md ├── ApiResponseOptionsPricesByTickerRealtime.md ├── ApiResponseOptionsPricesEod.md ├── ApiResponseOptionsRealtime.md ├── ApiResponseOptionsStatsRealtime.md ├── ApiResponseOptionsTickers.md ├── ApiResponseOptionsUnusualActivity.md ├── ApiResponseOwnerInsiderTransactionFilings.md ├── ApiResponseOwnerInstitutionalHoldings.md ├── ApiResponseOwners.md ├── ApiResponseRealtimeIndexPrices.md ├── ApiResponseReportedFinancials.md ├── ApiResponseSICIndexHistoricalData.md ├── ApiResponseSICIndices.md ├── ApiResponseSICIndicesSearch.md ├── ApiResponseSecurities.md ├── ApiResponseSecuritiesSearch.md ├── ApiResponseSecurityAccumulationDistributionIndex.md ├── ApiResponseSecurityAverageDailyTradingVolume.md ├── ApiResponseSecurityAverageDirectionalIndex.md ├── ApiResponseSecurityAverageTrueRange.md ├── ApiResponseSecurityAwesomeOscillator.md ├── ApiResponseSecurityBollingerBands.md ├── ApiResponseSecurityChaikinMoneyFlow.md ├── ApiResponseSecurityCommodityChannelIndex.md ├── ApiResponseSecurityDetrendedPriceOscillator.md ├── ApiResponseSecurityDonchianChannel.md ├── ApiResponseSecurityEaseOfMovement.md ├── ApiResponseSecurityForceIndex.md ├── ApiResponseSecurityHistoricalData.md ├── ApiResponseSecurityIchimokuKinkoHyo.md ├── ApiResponseSecurityInstitutionalOwnership.md ├── ApiResponseSecurityIntervalPrices.md ├── ApiResponseSecurityKeltnerChannel.md ├── ApiResponseSecurityKnowSureThing.md ├── ApiResponseSecurityMassIndex.md ├── ApiResponseSecurityMoneyFlowIndex.md ├── ApiResponseSecurityMovingAverageConvergenceDivergence.md ├── ApiResponseSecurityNegativeVolumeIndex.md ├── ApiResponseSecurityOnBalanceVolume.md ├── ApiResponseSecurityOnBalanceVolumeMean.md ├── ApiResponseSecurityQuote.md ├── ApiResponseSecurityRelativeStrengthIndex.md ├── ApiResponseSecuritySimpleMovingAverage.md ├── ApiResponseSecurityStochasticOscillator.md ├── ApiResponseSecurityStockPriceAdjustments.md ├── ApiResponseSecurityStockPrices.md ├── ApiResponseSecurityTripleExponentialAverage.md ├── ApiResponseSecurityTrueStrengthIndex.md ├── ApiResponseSecurityUltimateOscillator.md ├── ApiResponseSecurityVolumePriceTrend.md ├── ApiResponseSecurityVolumeWeightedAveragePrice.md ├── ApiResponseSecurityVortexIndicator.md ├── ApiResponseSecurityWilliamsR.md ├── ApiResponseSecurityZacksAnalystRatings.md ├── ApiResponseSecurityZacksAnalystRatingsSnapshot.md ├── ApiResponseSecurityZacksEPSSurprises.md ├── ApiResponseSecurityZacksSalesSurprises.md ├── ApiResponseStandardizedFinancials.md ├── ApiResponseStandardizedFinancialsDimensions.md ├── ApiResponseStockExchangeBetas.md ├── ApiResponseStockExchangeMovers.md ├── ApiResponseStockExchangeQuote.md ├── ApiResponseStockExchangeRealtimeStockPrices.md ├── ApiResponseStockExchangeSecurities.md ├── ApiResponseStockExchangeStockPriceAdjustments.md ├── ApiResponseStockExchangeStockPrices.md ├── ApiResponseStockExchanges.md ├── ApiResponseStockMarketIndexHistoricalData.md ├── ApiResponseStockMarketIndices.md ├── ApiResponseStockMarketIndicesSearch.md ├── ApiResponseZacksAnalystRatings.md ├── ApiResponseZacksEBITDAConsensus.md ├── ApiResponseZacksEPSEstimates.md ├── ApiResponseZacksEPSGrowthRates.md ├── ApiResponseZacksEPSSurprises.md ├── ApiResponseZacksETFHoldings.md ├── ApiResponseZacksForwardPEs.md ├── ApiResponseZacksInstitutionalHoldingCompanies.md ├── ApiResponseZacksInstitutionalHoldingOwners.md ├── ApiResponseZacksInstitutionalHoldings.md ├── ApiResponseZacksLongTermGrowthRates.md ├── ApiResponseZacksSalesEstimates.md ├── ApiResponseZacksSalesSurprises.md ├── ApiResponseZacksTargetPriceConsensuses.md ├── AverageDailyTradingVolumeTechnicalValue.md ├── AverageDirectionalIndexTechnicalValue.md ├── AverageTrueRangeTechnicalValue.md ├── AwesomeOscillatorTechnicalValue.md ├── Beta.md ├── BollingerBandsTechnicalValue.md ├── BulkDownloadLinks.md ├── BulkDownloadSummary.md ├── BulkDownloadsApi.md ├── ChaikinMoneyFlowTechnicalValue.md ├── CommodityChannelIndexTechnicalValue.md ├── Company.md ├── CompanyApi.md ├── CompanyDailyMetric.md ├── CompanyFiling.md ├── CompanyInitialPublicOffering.md ├── CompanyNews.md ├── CompanyNewsSummary.md ├── CompanyPublicFloat.md ├── CompanySharesOutstanding.md ├── CompanySummary.md ├── DataPointApi.md ├── DataTag.md ├── DataTagApi.md ├── DataTagSummary.md ├── DetrendedPriceOscillatorTechnicalValue.md ├── DividendRecord.md ├── DonchianChannelTechnicalValue.md ├── ESGApi.md ├── ESGCompanySummary.md ├── ESGComprehensiveRating.md ├── ESGComprehensiveRatingWithCompany.md ├── ESGRating.md ├── ESGRatingWithCompany.md ├── ETF.md ├── ETFAnalytics.md ├── ETFHolding.md ├── ETFStats.md ├── ETFSummary.md ├── ETFsApi.md ├── EarningsRecord.md ├── EaseOfMovementTechnicalValue.md ├── EconomicIndex.md ├── EconomicIndexSummary.md ├── EodIndexPrice.md ├── EodIndexPriceSummary.md ├── Filing.md ├── FilingApi.md ├── FilingNote.md ├── FilingNoteFiling.md ├── FilingNoteSummary.md ├── FilingSummary.md ├── ForceIndexTechnicalValue.md ├── ForexApi.md ├── ForexCurrency.md ├── ForexPair.md ├── ForexPrice.md ├── Fundamental.md ├── FundamentalSummary.md ├── FundamentalsApi.md ├── HistoricalData.md ├── HistoricalDataApi.md ├── IchimokuKinkoHyoTechnicalValue.md ├── IndexApi.md ├── IndexInterval.md ├── InsiderTransaction.md ├── InsiderTransactionFiling.md ├── InsiderTransactionFilingsApi.md ├── InstitutionalHolding.md ├── InstitutionalOwnership.md ├── KeltnerChannelTechnicalValue.md ├── KnowSureThingTechnicalValue.md ├── MarketApi.md ├── MarketStatusResult.md ├── MassIndexTechnicalValue.md ├── MoneyFlowIndexTechnicalValue.md ├── MovingAverageConvergenceDivergenceTechnicalValue.md ├── Municipality.md ├── MunicipalityApi.md ├── MunicipalityFinancial.md ├── NegativeVolumeIndexTechnicalValue.md ├── NewsTopic.md ├── OnBalanceVolumeMeanTechnicalValue.md ├── OnBalanceVolumeTechnicalValue.md ├── Option.md ├── OptionChain.md ├── OptionChainEod.md ├── OptionChainRealtime.md ├── OptionContractsList.md ├── OptionEod.md ├── OptionFactorsRealtime.md ├── OptionImpliedMoveData.md ├── OptionInterval.md ├── OptionIntervalMover.md ├── OptionIntervalsMoversResult.md ├── OptionIntervalsResult.md ├── OptionPrice.md ├── OptionPriceBatchRealtime.md ├── OptionPriceEod.md ├── OptionPriceRealtime.md ├── OptionPriceRealtimeExtended.md ├── OptionRealtime.md ├── OptionSnapshotGroup.md ├── OptionSnapshotsResult.md ├── OptionStatsRealtime.md ├── OptionSyntheticGreeksRealtime.md ├── OptionTrades.md ├── OptionTradesResult.md ├── OptionUnusualTrade.md ├── OptionsAggregate.md ├── OptionsApi.md ├── OptionsPriceEod.md ├── Owner.md ├── OwnerSummary.md ├── OwnersApi.md ├── RealtimeIndexPrice.md ├── RealtimeIndexPriceIndex.md ├── RealtimeStockPrice.md ├── RealtimeStockPriceSecurity.md ├── RelativeStrengthIndexTechnicalValue.md ├── ReportedFinancial.md ├── ReportedFinancialDimension.md ├── ReportedTag.md ├── SICIndex.md ├── Security.md ├── SecurityApi.md ├── SecurityHistory.md ├── SecurityHistoryListResult.md ├── SecurityIntervalMover.md ├── SecurityIntervalsMoversResult.md ├── SecurityReplayFileResult.md ├── SecurityScreenClause.md ├── SecurityScreenGroup.md ├── SecurityScreenResult.md ├── SecurityScreenResultData.md ├── SecuritySnapshotGroup.md ├── SecuritySnapshotsResult.md ├── SecuritySummary.md ├── SecurityTrades.md ├── SecurityTradesResult.md ├── SimpleMovingAverageTechnicalValue.md ├── StandardizedFinancial.md ├── StandardizedFinancialsDimension.md ├── StochasticOscillatorTechnicalValue.md ├── StockExchange.md ├── StockExchangeApi.md ├── StockExchangeMover.md ├── StockMarketIndex.md ├── StockMarketIndexSummary.md ├── StockPrice.md ├── StockPriceAdjustment.md ├── StockPriceAdjustmentSummary.md ├── StockPriceInterval.md ├── StockPriceSummary.md ├── TechnicalApi.md ├── TechnicalIndicator.md ├── TheaEntityAnswer.md ├── TheaSourceDocument.md ├── TripleExponentialAverageTechnicalValue.md ├── TrueStrengthIndexTechnicalValue.md ├── UltimateOscillatorTechnicalValue.md ├── VolumePriceTrendTechnicalValue.md ├── VolumeWeightedAveragePriceValue.md ├── VortexIndicatorTechnicalValue.md ├── WilliamsRTechnicalValue.md ├── ZacksAnalystRating.md ├── ZacksAnalystRatingSnapshot.md ├── ZacksAnalystRatingSummary.md ├── ZacksApi.md ├── ZacksEBITDAConsensus.md ├── ZacksEPSEstimate.md ├── ZacksEPSGrowthRate.md ├── ZacksEPSSurprise.md ├── ZacksEPSSurpriseSummary.md ├── ZacksETFHolding.md ├── ZacksForwardPE.md ├── ZacksInstitutionalHolding.md ├── ZacksInstitutionalHoldingCompanyDetail.md ├── ZacksInstitutionalHoldingCompanySummary.md ├── ZacksInstitutionalHoldingHistoricalSummary.md ├── ZacksInstitutionalHoldingOwnerDetail.md ├── ZacksInstitutionalHoldingOwnerSummary.md ├── ZacksLongTermGrowthRate.md ├── ZacksSalesEstimate.md ├── ZacksSalesSurprise.md ├── ZacksSalesSurpriseSummary.md └── ZacksTargetPriceConsensus.md ├── git_push.sh ├── mocha.opts ├── package.json ├── src ├── ApiClient.js ├── api │ ├── BulkDownloadsApi.js │ ├── CompanyApi.js │ ├── DataPointApi.js │ ├── DataTagApi.js │ ├── ESGApi.js │ ├── ETFsApi.js │ ├── FilingApi.js │ ├── ForexApi.js │ ├── FundamentalsApi.js │ ├── HistoricalDataApi.js │ ├── IndexApi.js │ ├── InsiderTransactionFilingsApi.js │ ├── MarketApi.js │ ├── MunicipalityApi.js │ ├── OptionsApi.js │ ├── OwnersApi.js │ ├── SecurityApi.js │ ├── StockExchangeApi.js │ ├── TechnicalApi.js │ └── ZacksApi.js ├── index.js └── model │ ├── AccumulationDistributionIndexTechnicalValue.js │ ├── ApiResponseBulkDownloadLinks.js │ ├── ApiResponseCompanies.js │ ├── ApiResponseCompaniesSearch.js │ ├── ApiResponseCompanyAnswers.js │ ├── ApiResponseCompanyDailyMetrics.js │ ├── ApiResponseCompanyFilings.js │ ├── ApiResponseCompanyFundamentals.js │ ├── ApiResponseCompanyHistoricalData.js │ ├── ApiResponseCompanyInsiderTransactionFilings.js │ ├── ApiResponseCompanyNews.js │ ├── ApiResponseCompanyNewsBody.js │ ├── ApiResponseCompanyPublicFloatResult.js │ ├── ApiResponseCompanyRecognize.js │ ├── ApiResponseCompanySecurities.js │ ├── ApiResponseCompanySharesOutstanding.js │ ├── ApiResponseDataTags.js │ ├── ApiResponseDataTagsSearch.js │ ├── ApiResponseESGCompanies.js │ ├── ApiResponseESGCompanyComprehensiveRatingHistory.js │ ├── ApiResponseESGCompanyRatingHistory.js │ ├── ApiResponseESGLatest.js │ ├── ApiResponseESGLatestComprehensive.js │ ├── ApiResponseETFHoldings.js │ ├── ApiResponseETFs.js │ ├── ApiResponseEconomicIndexHistoricalData.js │ ├── ApiResponseEconomicIndices.js │ ├── ApiResponseEconomicIndicesSearch.js │ ├── ApiResponseEodIndexPrices.js │ ├── ApiResponseEodIndexPricesAll.js │ ├── ApiResponseFilingAnswers.js │ ├── ApiResponseFilingFundamentals.js │ ├── ApiResponseFilingNotes.js │ ├── ApiResponseFilingNotesSearch.js │ ├── ApiResponseFilings.js │ ├── ApiResponseForexCurrencies.js │ ├── ApiResponseForexPairs.js │ ├── ApiResponseForexPrices.js │ ├── ApiResponseHistoricalData.js │ ├── ApiResponseIndex.js │ ├── ApiResponseIndexConstituents.js │ ├── ApiResponseIndexIntervals.js │ ├── ApiResponseIndices.js │ ├── ApiResponseInitialPublicOfferings.js │ ├── ApiResponseInsiderTransactionFilings.js │ ├── ApiResponseMunicipalities.js │ ├── ApiResponseMunicipalitiyFinancials.js │ ├── ApiResponseNews.js │ ├── ApiResponseOptionPrices.js │ ├── ApiResponseOptions.js │ ├── ApiResponseOptionsAggregates.js │ ├── ApiResponseOptionsChain.js │ ├── ApiResponseOptionsChainEod.js │ ├── ApiResponseOptionsChainRealtime.js │ ├── ApiResponseOptionsExpirations.js │ ├── ApiResponseOptionsGreekContractRealtime.js │ ├── ApiResponseOptionsGreeksByTickerRealtime.js │ ├── ApiResponseOptionsImpliedMove.js │ ├── ApiResponseOptionsPriceRealtime.js │ ├── ApiResponseOptionsPricesBatchRealtime.js │ ├── ApiResponseOptionsPricesByTickerEod.js │ ├── ApiResponseOptionsPricesByTickerRealtime.js │ ├── ApiResponseOptionsPricesEod.js │ ├── ApiResponseOptionsRealtime.js │ ├── ApiResponseOptionsStatsRealtime.js │ ├── ApiResponseOptionsTickers.js │ ├── ApiResponseOptionsUnusualActivity.js │ ├── ApiResponseOwnerInsiderTransactionFilings.js │ ├── ApiResponseOwnerInstitutionalHoldings.js │ ├── ApiResponseOwners.js │ ├── ApiResponseRealtimeIndexPrices.js │ ├── ApiResponseReportedFinancials.js │ ├── ApiResponseSICIndexHistoricalData.js │ ├── ApiResponseSICIndices.js │ ├── ApiResponseSICIndicesSearch.js │ ├── ApiResponseSecurities.js │ ├── ApiResponseSecuritiesSearch.js │ ├── ApiResponseSecurityAccumulationDistributionIndex.js │ ├── ApiResponseSecurityAverageDailyTradingVolume.js │ ├── ApiResponseSecurityAverageDirectionalIndex.js │ ├── ApiResponseSecurityAverageTrueRange.js │ ├── ApiResponseSecurityAwesomeOscillator.js │ ├── ApiResponseSecurityBollingerBands.js │ ├── ApiResponseSecurityChaikinMoneyFlow.js │ ├── ApiResponseSecurityCommodityChannelIndex.js │ ├── ApiResponseSecurityDetrendedPriceOscillator.js │ ├── ApiResponseSecurityDonchianChannel.js │ ├── ApiResponseSecurityEaseOfMovement.js │ ├── ApiResponseSecurityForceIndex.js │ ├── ApiResponseSecurityHistoricalData.js │ ├── ApiResponseSecurityIchimokuKinkoHyo.js │ ├── ApiResponseSecurityInstitutionalOwnership.js │ ├── ApiResponseSecurityIntervalPrices.js │ ├── ApiResponseSecurityKeltnerChannel.js │ ├── ApiResponseSecurityKnowSureThing.js │ ├── ApiResponseSecurityMassIndex.js │ ├── ApiResponseSecurityMoneyFlowIndex.js │ ├── ApiResponseSecurityMovingAverageConvergenceDivergence.js │ ├── ApiResponseSecurityNegativeVolumeIndex.js │ ├── ApiResponseSecurityOnBalanceVolume.js │ ├── ApiResponseSecurityOnBalanceVolumeMean.js │ ├── ApiResponseSecurityQuote.js │ ├── ApiResponseSecurityRelativeStrengthIndex.js │ ├── ApiResponseSecuritySimpleMovingAverage.js │ ├── ApiResponseSecurityStochasticOscillator.js │ ├── ApiResponseSecurityStockPriceAdjustments.js │ ├── ApiResponseSecurityStockPrices.js │ ├── ApiResponseSecurityTripleExponentialAverage.js │ ├── ApiResponseSecurityTrueStrengthIndex.js │ ├── ApiResponseSecurityUltimateOscillator.js │ ├── ApiResponseSecurityVolumePriceTrend.js │ ├── ApiResponseSecurityVolumeWeightedAveragePrice.js │ ├── ApiResponseSecurityVortexIndicator.js │ ├── ApiResponseSecurityWilliamsR.js │ ├── ApiResponseSecurityZacksAnalystRatings.js │ ├── ApiResponseSecurityZacksAnalystRatingsSnapshot.js │ ├── ApiResponseSecurityZacksEPSSurprises.js │ ├── ApiResponseSecurityZacksSalesSurprises.js │ ├── ApiResponseStandardizedFinancials.js │ ├── ApiResponseStandardizedFinancialsDimensions.js │ ├── ApiResponseStockExchangeBetas.js │ ├── ApiResponseStockExchangeMovers.js │ ├── ApiResponseStockExchangeQuote.js │ ├── ApiResponseStockExchangeRealtimeStockPrices.js │ ├── ApiResponseStockExchangeSecurities.js │ ├── ApiResponseStockExchangeStockPriceAdjustments.js │ ├── ApiResponseStockExchangeStockPrices.js │ ├── ApiResponseStockExchanges.js │ ├── ApiResponseStockMarketIndexHistoricalData.js │ ├── ApiResponseStockMarketIndices.js │ ├── ApiResponseStockMarketIndicesSearch.js │ ├── ApiResponseZacksAnalystRatings.js │ ├── ApiResponseZacksEBITDAConsensus.js │ ├── ApiResponseZacksEPSEstimates.js │ ├── ApiResponseZacksEPSGrowthRates.js │ ├── ApiResponseZacksEPSSurprises.js │ ├── ApiResponseZacksETFHoldings.js │ ├── ApiResponseZacksForwardPEs.js │ ├── ApiResponseZacksInstitutionalHoldingCompanies.js │ ├── ApiResponseZacksInstitutionalHoldingOwners.js │ ├── ApiResponseZacksInstitutionalHoldings.js │ ├── ApiResponseZacksLongTermGrowthRates.js │ ├── ApiResponseZacksSalesEstimates.js │ ├── ApiResponseZacksSalesSurprises.js │ ├── ApiResponseZacksTargetPriceConsensuses.js │ ├── AverageDailyTradingVolumeTechnicalValue.js │ ├── AverageDirectionalIndexTechnicalValue.js │ ├── AverageTrueRangeTechnicalValue.js │ ├── AwesomeOscillatorTechnicalValue.js │ ├── Beta.js │ ├── BollingerBandsTechnicalValue.js │ ├── BulkDownloadLinks.js │ ├── BulkDownloadSummary.js │ ├── ChaikinMoneyFlowTechnicalValue.js │ ├── CommodityChannelIndexTechnicalValue.js │ ├── Company.js │ ├── CompanyDailyMetric.js │ ├── CompanyFiling.js │ ├── CompanyInitialPublicOffering.js │ ├── CompanyNews.js │ ├── CompanyNewsSummary.js │ ├── CompanyPublicFloat.js │ ├── CompanySharesOutstanding.js │ ├── CompanySummary.js │ ├── DataTag.js │ ├── DataTagSummary.js │ ├── DetrendedPriceOscillatorTechnicalValue.js │ ├── DividendRecord.js │ ├── DonchianChannelTechnicalValue.js │ ├── ESGCompanySummary.js │ ├── ESGComprehensiveRating.js │ ├── ESGComprehensiveRatingWithCompany.js │ ├── ESGRating.js │ ├── ESGRatingWithCompany.js │ ├── ETF.js │ ├── ETFAnalytics.js │ ├── ETFHolding.js │ ├── ETFStats.js │ ├── ETFSummary.js │ ├── EarningsRecord.js │ ├── EaseOfMovementTechnicalValue.js │ ├── EconomicIndex.js │ ├── EconomicIndexSummary.js │ ├── EodIndexPrice.js │ ├── EodIndexPriceSummary.js │ ├── Filing.js │ ├── FilingNote.js │ ├── FilingNoteFiling.js │ ├── FilingNoteSummary.js │ ├── FilingSummary.js │ ├── ForceIndexTechnicalValue.js │ ├── ForexCurrency.js │ ├── ForexPair.js │ ├── ForexPrice.js │ ├── Fundamental.js │ ├── FundamentalSummary.js │ ├── HistoricalData.js │ ├── IchimokuKinkoHyoTechnicalValue.js │ ├── IndexInterval.js │ ├── InsiderTransaction.js │ ├── InsiderTransactionFiling.js │ ├── InstitutionalHolding.js │ ├── InstitutionalOwnership.js │ ├── KeltnerChannelTechnicalValue.js │ ├── KnowSureThingTechnicalValue.js │ ├── MarketStatusResult.js │ ├── MassIndexTechnicalValue.js │ ├── MoneyFlowIndexTechnicalValue.js │ ├── MovingAverageConvergenceDivergenceTechnicalValue.js │ ├── Municipality.js │ ├── MunicipalityFinancial.js │ ├── NegativeVolumeIndexTechnicalValue.js │ ├── NewsTopic.js │ ├── OnBalanceVolumeMeanTechnicalValue.js │ ├── OnBalanceVolumeTechnicalValue.js │ ├── Option.js │ ├── OptionChain.js │ ├── OptionChainEod.js │ ├── OptionChainRealtime.js │ ├── OptionContractsList.js │ ├── OptionEod.js │ ├── OptionFactorsRealtime.js │ ├── OptionImpliedMoveData.js │ ├── OptionInterval.js │ ├── OptionIntervalMover.js │ ├── OptionIntervalsMoversResult.js │ ├── OptionIntervalsResult.js │ ├── OptionPrice.js │ ├── OptionPriceBatchRealtime.js │ ├── OptionPriceEod.js │ ├── OptionPriceRealtime.js │ ├── OptionPriceRealtimeExtended.js │ ├── OptionRealtime.js │ ├── OptionSnapshotGroup.js │ ├── OptionSnapshotsResult.js │ ├── OptionStatsRealtime.js │ ├── OptionSyntheticGreeksRealtime.js │ ├── OptionTrades.js │ ├── OptionTradesResult.js │ ├── OptionUnusualTrade.js │ ├── OptionsAggregate.js │ ├── OptionsPriceEod.js │ ├── Owner.js │ ├── OwnerSummary.js │ ├── RealtimeIndexPrice.js │ ├── RealtimeIndexPriceIndex.js │ ├── RealtimeStockPrice.js │ ├── RealtimeStockPriceSecurity.js │ ├── RelativeStrengthIndexTechnicalValue.js │ ├── ReportedFinancial.js │ ├── ReportedFinancialDimension.js │ ├── ReportedTag.js │ ├── SICIndex.js │ ├── Security.js │ ├── SecurityHistory.js │ ├── SecurityHistoryListResult.js │ ├── SecurityIntervalMover.js │ ├── SecurityIntervalsMoversResult.js │ ├── SecurityReplayFileResult.js │ ├── SecurityScreenClause.js │ ├── SecurityScreenGroup.js │ ├── SecurityScreenResult.js │ ├── SecurityScreenResultData.js │ ├── SecuritySnapshotGroup.js │ ├── SecuritySnapshotsResult.js │ ├── SecuritySummary.js │ ├── SecurityTrades.js │ ├── SecurityTradesResult.js │ ├── SimpleMovingAverageTechnicalValue.js │ ├── StandardizedFinancial.js │ ├── StandardizedFinancialsDimension.js │ ├── StochasticOscillatorTechnicalValue.js │ ├── StockExchange.js │ ├── StockExchangeMover.js │ ├── StockMarketIndex.js │ ├── StockMarketIndexSummary.js │ ├── StockPrice.js │ ├── StockPriceAdjustment.js │ ├── StockPriceAdjustmentSummary.js │ ├── StockPriceInterval.js │ ├── StockPriceSummary.js │ ├── TechnicalIndicator.js │ ├── TheaEntityAnswer.js │ ├── TheaSourceDocument.js │ ├── TripleExponentialAverageTechnicalValue.js │ ├── TrueStrengthIndexTechnicalValue.js │ ├── UltimateOscillatorTechnicalValue.js │ ├── VolumePriceTrendTechnicalValue.js │ ├── VolumeWeightedAveragePriceValue.js │ ├── VortexIndicatorTechnicalValue.js │ ├── WilliamsRTechnicalValue.js │ ├── ZacksAnalystRating.js │ ├── ZacksAnalystRatingSnapshot.js │ ├── ZacksAnalystRatingSummary.js │ ├── ZacksEBITDAConsensus.js │ ├── ZacksEPSEstimate.js │ ├── ZacksEPSGrowthRate.js │ ├── ZacksEPSSurprise.js │ ├── ZacksEPSSurpriseSummary.js │ ├── ZacksETFHolding.js │ ├── ZacksForwardPE.js │ ├── ZacksInstitutionalHolding.js │ ├── ZacksInstitutionalHoldingCompanyDetail.js │ ├── ZacksInstitutionalHoldingCompanySummary.js │ ├── ZacksInstitutionalHoldingHistoricalSummary.js │ ├── ZacksInstitutionalHoldingOwnerDetail.js │ ├── ZacksInstitutionalHoldingOwnerSummary.js │ ├── ZacksLongTermGrowthRate.js │ ├── ZacksSalesEstimate.js │ ├── ZacksSalesSurprise.js │ ├── ZacksSalesSurpriseSummary.js │ └── ZacksTargetPriceConsensus.js └── test ├── api ├── BulkDownloadsApi.spec.js ├── CompanyApi.spec.js ├── DataPointApi.spec.js ├── DataTagApi.spec.js ├── ESGApi.spec.js ├── ETFsApi.spec.js ├── FilingApi.spec.js ├── ForexApi.spec.js ├── FundamentalsApi.spec.js ├── HistoricalDataApi.spec.js ├── IndexApi.spec.js ├── InsiderTransactionFilingsApi.spec.js ├── MarketApi.spec.js ├── MunicipalityApi.spec.js ├── OptionsApi.spec.js ├── OwnersApi.spec.js ├── SecurityApi.spec.js ├── StockExchangeApi.spec.js ├── TechnicalApi.spec.js └── ZacksApi.spec.js └── model ├── AccumulationDistributionIndexTechnicalValue.spec.js ├── ApiResponseBulkDownloadLinks.spec.js ├── ApiResponseCompanies.spec.js ├── ApiResponseCompaniesSearch.spec.js ├── ApiResponseCompanyAnswers.spec.js ├── ApiResponseCompanyDailyMetrics.spec.js ├── ApiResponseCompanyFilings.spec.js ├── ApiResponseCompanyFundamentals.spec.js ├── ApiResponseCompanyHistoricalData.spec.js ├── ApiResponseCompanyInsiderTransactionFilings.spec.js ├── ApiResponseCompanyNews.spec.js ├── ApiResponseCompanyNewsBody.spec.js ├── ApiResponseCompanyPublicFloatResult.spec.js ├── ApiResponseCompanyRecognize.spec.js ├── ApiResponseCompanySecurities.spec.js ├── ApiResponseCompanySharesOutstanding.spec.js ├── ApiResponseDataTags.spec.js ├── ApiResponseDataTagsSearch.spec.js ├── ApiResponseESGCompanies.spec.js ├── ApiResponseESGCompanyComprehensiveRatingHistory.spec.js ├── ApiResponseESGCompanyRatingHistory.spec.js ├── ApiResponseESGLatest.spec.js ├── ApiResponseESGLatestComprehensive.spec.js ├── ApiResponseETFHoldings.spec.js ├── ApiResponseETFs.spec.js ├── ApiResponseEconomicIndexHistoricalData.spec.js ├── ApiResponseEconomicIndices.spec.js ├── ApiResponseEconomicIndicesSearch.spec.js ├── ApiResponseEodIndexPrices.spec.js ├── ApiResponseEodIndexPricesAll.spec.js ├── ApiResponseFilingAnswers.spec.js ├── ApiResponseFilingFundamentals.spec.js ├── ApiResponseFilingNotes.spec.js ├── ApiResponseFilingNotesSearch.spec.js ├── ApiResponseFilings.spec.js ├── ApiResponseForexCurrencies.spec.js ├── ApiResponseForexPairs.spec.js ├── ApiResponseForexPrices.spec.js ├── ApiResponseHistoricalData.spec.js ├── ApiResponseIndex.spec.js ├── ApiResponseIndexConstituents.spec.js ├── ApiResponseIndexIntervals.spec.js ├── ApiResponseIndices.spec.js ├── ApiResponseInitialPublicOfferings.spec.js ├── ApiResponseInsiderTransactionFilings.spec.js ├── ApiResponseMunicipalities.spec.js ├── ApiResponseMunicipalitiyFinancials.spec.js ├── ApiResponseNews.spec.js ├── ApiResponseOptionPrices.spec.js ├── ApiResponseOptions.spec.js ├── ApiResponseOptionsAggregates.spec.js ├── ApiResponseOptionsChain.spec.js ├── ApiResponseOptionsChainEod.spec.js ├── ApiResponseOptionsChainRealtime.spec.js ├── ApiResponseOptionsExpirations.spec.js ├── ApiResponseOptionsGreekContractRealtime.spec.js ├── ApiResponseOptionsGreeksByTickerRealtime.spec.js ├── ApiResponseOptionsImpliedMove.spec.js ├── ApiResponseOptionsPriceRealtime.spec.js ├── ApiResponseOptionsPricesBatchRealtime.spec.js ├── ApiResponseOptionsPricesByTickerEod.spec.js ├── ApiResponseOptionsPricesByTickerRealtime.spec.js ├── ApiResponseOptionsPricesEod.spec.js ├── ApiResponseOptionsRealtime.spec.js ├── ApiResponseOptionsStatsRealtime.spec.js ├── ApiResponseOptionsTickers.spec.js ├── ApiResponseOptionsUnusualActivity.spec.js ├── ApiResponseOwnerInsiderTransactionFilings.spec.js ├── ApiResponseOwnerInstitutionalHoldings.spec.js ├── ApiResponseOwners.spec.js ├── ApiResponseRealtimeIndexPrices.spec.js ├── ApiResponseReportedFinancials.spec.js ├── ApiResponseSICIndexHistoricalData.spec.js ├── ApiResponseSICIndices.spec.js ├── ApiResponseSICIndicesSearch.spec.js ├── ApiResponseSecurities.spec.js ├── ApiResponseSecuritiesSearch.spec.js ├── ApiResponseSecurityAccumulationDistributionIndex.spec.js ├── ApiResponseSecurityAverageDailyTradingVolume.spec.js ├── ApiResponseSecurityAverageDirectionalIndex.spec.js ├── ApiResponseSecurityAverageTrueRange.spec.js ├── ApiResponseSecurityAwesomeOscillator.spec.js ├── ApiResponseSecurityBollingerBands.spec.js ├── ApiResponseSecurityChaikinMoneyFlow.spec.js ├── ApiResponseSecurityCommodityChannelIndex.spec.js ├── ApiResponseSecurityDetrendedPriceOscillator.spec.js ├── ApiResponseSecurityDonchianChannel.spec.js ├── ApiResponseSecurityEaseOfMovement.spec.js ├── ApiResponseSecurityForceIndex.spec.js ├── ApiResponseSecurityHistoricalData.spec.js ├── ApiResponseSecurityIchimokuKinkoHyo.spec.js ├── ApiResponseSecurityInstitutionalOwnership.spec.js ├── ApiResponseSecurityIntervalPrices.spec.js ├── ApiResponseSecurityKeltnerChannel.spec.js ├── ApiResponseSecurityKnowSureThing.spec.js ├── ApiResponseSecurityMassIndex.spec.js ├── ApiResponseSecurityMoneyFlowIndex.spec.js ├── ApiResponseSecurityMovingAverageConvergenceDivergence.spec.js ├── ApiResponseSecurityNegativeVolumeIndex.spec.js ├── ApiResponseSecurityOnBalanceVolume.spec.js ├── ApiResponseSecurityOnBalanceVolumeMean.spec.js ├── ApiResponseSecurityQuote.spec.js ├── ApiResponseSecurityRelativeStrengthIndex.spec.js ├── ApiResponseSecuritySimpleMovingAverage.spec.js ├── ApiResponseSecurityStochasticOscillator.spec.js ├── ApiResponseSecurityStockPriceAdjustments.spec.js ├── ApiResponseSecurityStockPrices.spec.js ├── ApiResponseSecurityTripleExponentialAverage.spec.js ├── ApiResponseSecurityTrueStrengthIndex.spec.js ├── ApiResponseSecurityUltimateOscillator.spec.js ├── ApiResponseSecurityVolumePriceTrend.spec.js ├── ApiResponseSecurityVolumeWeightedAveragePrice.spec.js ├── ApiResponseSecurityVortexIndicator.spec.js ├── ApiResponseSecurityWilliamsR.spec.js ├── ApiResponseSecurityZacksAnalystRatings.spec.js ├── ApiResponseSecurityZacksAnalystRatingsSnapshot.spec.js ├── ApiResponseSecurityZacksEPSSurprises.spec.js ├── ApiResponseSecurityZacksSalesSurprises.spec.js ├── ApiResponseStandardizedFinancials.spec.js ├── ApiResponseStandardizedFinancialsDimensions.spec.js ├── ApiResponseStockExchangeBetas.spec.js ├── ApiResponseStockExchangeMovers.spec.js ├── ApiResponseStockExchangeQuote.spec.js ├── ApiResponseStockExchangeRealtimeStockPrices.spec.js ├── ApiResponseStockExchangeSecurities.spec.js ├── ApiResponseStockExchangeStockPriceAdjustments.spec.js ├── ApiResponseStockExchangeStockPrices.spec.js ├── ApiResponseStockExchanges.spec.js ├── ApiResponseStockMarketIndexHistoricalData.spec.js ├── ApiResponseStockMarketIndices.spec.js ├── ApiResponseStockMarketIndicesSearch.spec.js ├── ApiResponseZacksAnalystRatings.spec.js ├── ApiResponseZacksEBITDAConsensus.spec.js ├── ApiResponseZacksEPSEstimates.spec.js ├── ApiResponseZacksEPSGrowthRates.spec.js ├── ApiResponseZacksEPSSurprises.spec.js ├── ApiResponseZacksETFHoldings.spec.js ├── ApiResponseZacksForwardPEs.spec.js ├── ApiResponseZacksInstitutionalHoldingCompanies.spec.js ├── ApiResponseZacksInstitutionalHoldingOwners.spec.js ├── ApiResponseZacksInstitutionalHoldings.spec.js ├── ApiResponseZacksLongTermGrowthRates.spec.js ├── ApiResponseZacksSalesEstimates.spec.js ├── ApiResponseZacksSalesSurprises.spec.js ├── ApiResponseZacksTargetPriceConsensuses.spec.js ├── AverageDailyTradingVolumeTechnicalValue.spec.js ├── AverageDirectionalIndexTechnicalValue.spec.js ├── AverageTrueRangeTechnicalValue.spec.js ├── AwesomeOscillatorTechnicalValue.spec.js ├── Beta.spec.js ├── BollingerBandsTechnicalValue.spec.js ├── BulkDownloadLinks.spec.js ├── BulkDownloadSummary.spec.js ├── ChaikinMoneyFlowTechnicalValue.spec.js ├── CommodityChannelIndexTechnicalValue.spec.js ├── Company.spec.js ├── CompanyDailyMetric.spec.js ├── CompanyFiling.spec.js ├── CompanyInitialPublicOffering.spec.js ├── CompanyNews.spec.js ├── CompanyNewsSummary.spec.js ├── CompanyPublicFloat.spec.js ├── CompanySharesOutstanding.spec.js ├── CompanySummary.spec.js ├── DataTag.spec.js ├── DataTagSummary.spec.js ├── DetrendedPriceOscillatorTechnicalValue.spec.js ├── DividendRecord.spec.js ├── DonchianChannelTechnicalValue.spec.js ├── ESGCompanySummary.spec.js ├── ESGComprehensiveRating.spec.js ├── ESGComprehensiveRatingWithCompany.spec.js ├── ESGRating.spec.js ├── ESGRatingWithCompany.spec.js ├── ETF.spec.js ├── ETFAnalytics.spec.js ├── ETFHolding.spec.js ├── ETFStats.spec.js ├── ETFSummary.spec.js ├── EarningsRecord.spec.js ├── EaseOfMovementTechnicalValue.spec.js ├── EconomicIndex.spec.js ├── EconomicIndexSummary.spec.js ├── EodIndexPrice.spec.js ├── EodIndexPriceSummary.spec.js ├── Filing.spec.js ├── FilingNote.spec.js ├── FilingNoteFiling.spec.js ├── FilingNoteSummary.spec.js ├── FilingSummary.spec.js ├── ForceIndexTechnicalValue.spec.js ├── ForexCurrency.spec.js ├── ForexPair.spec.js ├── ForexPrice.spec.js ├── Fundamental.spec.js ├── FundamentalSummary.spec.js ├── HistoricalData.spec.js ├── IchimokuKinkoHyoTechnicalValue.spec.js ├── IndexInterval.spec.js ├── InsiderTransaction.spec.js ├── InsiderTransactionFiling.spec.js ├── InstitutionalHolding.spec.js ├── InstitutionalOwnership.spec.js ├── KeltnerChannelTechnicalValue.spec.js ├── KnowSureThingTechnicalValue.spec.js ├── MarketStatusResult.spec.js ├── MassIndexTechnicalValue.spec.js ├── MoneyFlowIndexTechnicalValue.spec.js ├── MovingAverageConvergenceDivergenceTechnicalValue.spec.js ├── Municipality.spec.js ├── MunicipalityFinancial.spec.js ├── NegativeVolumeIndexTechnicalValue.spec.js ├── NewsTopic.spec.js ├── OnBalanceVolumeMeanTechnicalValue.spec.js ├── OnBalanceVolumeTechnicalValue.spec.js ├── Option.spec.js ├── OptionChain.spec.js ├── OptionChainEod.spec.js ├── OptionChainRealtime.spec.js ├── OptionContractsList.spec.js ├── OptionEod.spec.js ├── OptionFactorsRealtime.spec.js ├── OptionImpliedMoveData.spec.js ├── OptionInterval.spec.js ├── OptionIntervalMover.spec.js ├── OptionIntervalsMoversResult.spec.js ├── OptionIntervalsResult.spec.js ├── OptionPrice.spec.js ├── OptionPriceBatchRealtime.spec.js ├── OptionPriceEod.spec.js ├── OptionPriceRealtime.spec.js ├── OptionPriceRealtimeExtended.spec.js ├── OptionRealtime.spec.js ├── OptionSnapshotGroup.spec.js ├── OptionSnapshotsResult.spec.js ├── OptionStatsRealtime.spec.js ├── OptionSyntheticGreeksRealtime.spec.js ├── OptionTrades.spec.js ├── OptionTradesResult.spec.js ├── OptionUnusualTrade.spec.js ├── OptionsAggregate.spec.js ├── OptionsPriceEod.spec.js ├── Owner.spec.js ├── OwnerSummary.spec.js ├── RealtimeIndexPrice.spec.js ├── RealtimeIndexPriceIndex.spec.js ├── RealtimeStockPrice.spec.js ├── RealtimeStockPriceSecurity.spec.js ├── RelativeStrengthIndexTechnicalValue.spec.js ├── ReportedFinancial.spec.js ├── ReportedFinancialDimension.spec.js ├── ReportedTag.spec.js ├── SICIndex.spec.js ├── Security.spec.js ├── SecurityHistory.spec.js ├── SecurityHistoryListResult.spec.js ├── SecurityIntervalMover.spec.js ├── SecurityIntervalsMoversResult.spec.js ├── SecurityReplayFileResult.spec.js ├── SecurityScreenClause.spec.js ├── SecurityScreenGroup.spec.js ├── SecurityScreenResult.spec.js ├── SecurityScreenResultData.spec.js ├── SecuritySnapshotGroup.spec.js ├── SecuritySnapshotsResult.spec.js ├── SecuritySummary.spec.js ├── SecurityTrades.spec.js ├── SecurityTradesResult.spec.js ├── SimpleMovingAverageTechnicalValue.spec.js ├── StandardizedFinancial.spec.js ├── StandardizedFinancialsDimension.spec.js ├── StochasticOscillatorTechnicalValue.spec.js ├── StockExchange.spec.js ├── StockExchangeMover.spec.js ├── StockMarketIndex.spec.js ├── StockMarketIndexSummary.spec.js ├── StockPrice.spec.js ├── StockPriceAdjustment.spec.js ├── StockPriceAdjustmentSummary.spec.js ├── StockPriceInterval.spec.js ├── StockPriceSummary.spec.js ├── TechnicalIndicator.spec.js ├── TheaEntityAnswer.spec.js ├── TheaSourceDocument.spec.js ├── TripleExponentialAverageTechnicalValue.spec.js ├── TrueStrengthIndexTechnicalValue.spec.js ├── UltimateOscillatorTechnicalValue.spec.js ├── VolumePriceTrendTechnicalValue.spec.js ├── VolumeWeightedAveragePriceValue.spec.js ├── VortexIndicatorTechnicalValue.spec.js ├── WilliamsRTechnicalValue.spec.js ├── ZacksAnalystRating.spec.js ├── ZacksAnalystRatingSnapshot.spec.js ├── ZacksAnalystRatingSummary.spec.js ├── ZacksEBITDAConsensus.spec.js ├── ZacksEPSEstimate.spec.js ├── ZacksEPSGrowthRate.spec.js ├── ZacksEPSSurprise.spec.js ├── ZacksEPSSurpriseSummary.spec.js ├── ZacksETFHolding.spec.js ├── ZacksForwardPE.spec.js ├── ZacksInstitutionalHolding.spec.js ├── ZacksInstitutionalHoldingCompanyDetail.spec.js ├── ZacksInstitutionalHoldingCompanySummary.spec.js ├── ZacksInstitutionalHoldingHistoricalSummary.spec.js ├── ZacksInstitutionalHoldingOwnerDetail.spec.js ├── ZacksInstitutionalHoldingOwnerSummary.spec.js ├── ZacksLongTermGrowthRate.spec.js ├── ZacksSalesEstimate.spec.js ├── ZacksSalesSurprise.spec.js ├── ZacksSalesSurpriseSummary.spec.js └── ZacksTargetPriceConsensus.spec.js /.swagger-codegen-ignore: -------------------------------------------------------------------------------- 1 | # Swagger Codegen Ignore 2 | # Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen 3 | 4 | # Use this file to prevent files from being overwritten by the generator. 5 | # The patterns follow closely to .gitignore or .dockerignore. 6 | 7 | # As an example, the C# client generator defines ApiClient.cs. 8 | # You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line: 9 | #ApiClient.cs 10 | 11 | # You can match any string of characters against a directory, file or extension with a single asterisk (*): 12 | #foo/*/qux 13 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux 14 | 15 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**): 16 | #foo/**/qux 17 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux 18 | 19 | # You can also negate patterns with an exclamation (!). 20 | # For example, you can ignore all files in a docs folder with the file extension .md: 21 | #docs/*.md 22 | # Then explicitly reverse the ignore rule for a single file: 23 | #!docs/README.md 24 | -------------------------------------------------------------------------------- /.swagger-codegen/VERSION: -------------------------------------------------------------------------------- 1 | unset -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | node_js: 3 | - "6" 4 | - "6.1" 5 | - "5" 6 | - "5.11" 7 | 8 | -------------------------------------------------------------------------------- /docs/AccumulationDistributionIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:AccumulationDistributionIndexTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### AccumulationDistributionIndexTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **adi** | Number | The Accumulation/Distribution Index calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/ApiResponseBulkDownloadLinks.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseBulkDownloadLinks) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseBulkDownloadLinks 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **bulkDownloads** | [**[BulkDownloadSummary]**](BulkDownloadSummary.md) |   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:BulkDownloadSummary) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanies.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseCompanies) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseCompanies 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **companies** | [**[CompanySummary]**](CompanySummary.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:CompanySummary) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseCompaniesSearch.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseCompaniesSearch) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseCompaniesSearch 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **companies** | [**[CompanySummary]**](CompanySummary.md) |   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:CompanySummary) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyAnswers.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseCompanyAnswers) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseCompanyAnswers 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **source** | String | The organziation the answer data was sourced from   15 | **query** | String | The query posed to the Thea API   16 | **answers** | [**[TheaEntityAnswer]**](TheaEntityAnswer.md) |   17 | **companies** | [**[CompanySummary]**](CompanySummary.md) |   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:TheaEntityAnswer) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:CompanySummary) 26 | 27 | 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyDailyMetrics.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseCompanyDailyMetrics) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseCompanyDailyMetrics 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dailyMetrics** | [**[CompanyDailyMetric]**](CompanyDailyMetric.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:CompanyDailyMetric) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyFilings.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseCompanyFilings) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseCompanyFilings 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **filings** | [**[FilingSummary]**](FilingSummary.md) |   15 | **company** | [**CompanySummary**](CompanySummary.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:FilingSummary) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:CompanySummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyFundamentals.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseCompanyFundamentals) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseCompanyFundamentals 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **fundamentals** | [**[FundamentalSummary]**](FundamentalSummary.md) |   15 | **company** | [**CompanySummary**](CompanySummary.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:FundamentalSummary) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:CompanySummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyHistoricalData.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseCompanyHistoricalData) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseCompanyHistoricalData 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **historicalData** | [**[HistoricalData]**](HistoricalData.md) |   15 | **company** | [**CompanySummary**](CompanySummary.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:HistoricalData) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:CompanySummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyInsiderTransactionFilings.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseCompanyInsiderTransactionFilings) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseCompanyInsiderTransactionFilings 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **transactionFilings** | [**[InsiderTransactionFiling]**](InsiderTransactionFiling.md) |   15 | **company** | [**CompanySummary**](CompanySummary.md) | The company associated with the transaction filing   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:InsiderTransactionFiling) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:CompanySummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyNews.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseCompanyNews) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseCompanyNews 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **news** | [**[CompanyNewsSummary]**](CompanyNewsSummary.md) |   15 | **company** | [**CompanySummary**](CompanySummary.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:CompanyNewsSummary) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:CompanySummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyNewsBody.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseCompanyNewsBody) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseCompanyNewsBody 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **body** | String | The article body.   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyPublicFloatResult.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseCompanyPublicFloatResult) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseCompanyPublicFloatResult 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   15 | **company** | [**CompanySummary**](CompanySummary.md) |   16 | **publicFloats** | [**[CompanyPublicFloat]**](CompanyPublicFloat.md) | Array of all the public floats in this page of the result.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:CompanySummary) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:CompanyPublicFloat) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyRecognize.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseCompanyRecognize) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseCompanyRecognize 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **companies** | [**[CompanySummary]**](CompanySummary.md) |   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:CompanySummary) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanySecurities.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseCompanySecurities) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseCompanySecurities 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **securities** | [**[SecuritySummary]**](SecuritySummary.md) |   15 | **company** | [**CompanySummary**](CompanySummary.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:SecuritySummary) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:CompanySummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanySharesOutstanding.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseCompanySharesOutstanding) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseCompanySharesOutstanding 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **sharesOutstanding** | [**[CompanySharesOutstanding]**](CompanySharesOutstanding.md) |   15 | **company** | [**CompanySummary**](CompanySummary.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:CompanySharesOutstanding) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:CompanySummary) 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseDataTags.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseDataTags) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseDataTags 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **tags** | [**[DataTag]**](DataTag.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:DataTag) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseDataTagsSearch.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseDataTagsSearch) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseDataTagsSearch 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **tags** | [**[DataTag]**](DataTag.md) |   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:DataTag) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseESGCompanies.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseESGCompanies) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseESGCompanies 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **companies** | [**[ESGCompanySummary]**](ESGCompanySummary.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ESGCompanySummary) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseESGCompanyComprehensiveRatingHistory.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseESGCompanyComprehensiveRatingHistory) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseESGCompanyComprehensiveRatingHistory 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **ratings** | [**[ESGComprehensiveRating]**](ESGComprehensiveRating.md) |   15 | **company** | [**ESGCompanySummary**](ESGCompanySummary.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:ESGComprehensiveRating) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:ESGCompanySummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseESGCompanyRatingHistory.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseESGCompanyRatingHistory) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseESGCompanyRatingHistory 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **ratings** | [**[ESGRating]**](ESGRating.md) |   15 | **company** | [**ESGCompanySummary**](ESGCompanySummary.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:ESGRating) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:ESGCompanySummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseESGLatest.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseESGLatest) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseESGLatest 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **ratings** | [**[ESGRatingWithCompany]**](ESGRatingWithCompany.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ESGRatingWithCompany) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseESGLatestComprehensive.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseESGLatestComprehensive) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseESGLatestComprehensive 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **ratings** | [**[ESGComprehensiveRatingWithCompany]**](ESGComprehensiveRatingWithCompany.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ESGComprehensiveRatingWithCompany) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseETFHoldings.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseETFHoldings) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseETFHoldings 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **holdings** | [**[ETFHolding]**](ETFHolding.md) |   15 | **etf** | [**ETFSummary**](ETFSummary.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:ETFHolding) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:ETFSummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseETFs.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseETFs) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseETFs 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **etfs** | [**[ETFSummary]**](ETFSummary.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ETFSummary) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseEconomicIndexHistoricalData.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseEconomicIndexHistoricalData) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseEconomicIndexHistoricalData 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **historicalData** | [**[HistoricalData]**](HistoricalData.md) |   15 | **index** | [**EconomicIndexSummary**](EconomicIndexSummary.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:HistoricalData) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:EconomicIndexSummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseEconomicIndices.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseEconomicIndices) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseEconomicIndices 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **indices** | [**[EconomicIndexSummary]**](EconomicIndexSummary.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:EconomicIndexSummary) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseEconomicIndicesSearch.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseEconomicIndicesSearch) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseEconomicIndicesSearch 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **indices** | [**[EconomicIndexSummary]**](EconomicIndexSummary.md) |   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:EconomicIndexSummary) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseEodIndexPrices.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseEodIndexPrices) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseEodIndexPrices 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **prices** | [**[EodIndexPriceSummary]**](EodIndexPriceSummary.md) |   15 | **index** | [**ApiResponseIndex**](ApiResponseIndex.md) | The index   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:EodIndexPriceSummary) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:ApiResponseIndex) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseEodIndexPricesAll.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseEodIndexPricesAll) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseEodIndexPricesAll 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **prices** | [**[EodIndexPrice]**](EodIndexPrice.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:EodIndexPrice) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseFilingAnswers.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseFilingAnswers) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseFilingAnswers 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **source** | String | The organziation the answer data was sourced from   15 | **query** | String | The query posed to the Thea API   16 | **answers** | [**[TheaEntityAnswer]**](TheaEntityAnswer.md) |   17 | **companies** | [**[Filing]**](Filing.md) |   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:TheaEntityAnswer) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:Filing) 26 | 27 | 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/ApiResponseFilingFundamentals.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseFilingFundamentals) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseFilingFundamentals 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **fundamentals** | [**[FundamentalSummary]**](FundamentalSummary.md) |   15 | **filing** | [**FilingSummary**](FilingSummary.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:FundamentalSummary) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:FilingSummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseFilingNotes.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseFilingNotes) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseFilingNotes 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **filingNotes** | [**[FilingNoteSummary]**](FilingNoteSummary.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:FilingNoteSummary) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseFilingNotesSearch.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseFilingNotesSearch) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseFilingNotesSearch 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **filingNotes** | [**[FilingNoteSummary]**](FilingNoteSummary.md) |   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:FilingNoteSummary) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseFilings.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseFilings) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseFilings 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **filings** | [**[Filing]**](Filing.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:Filing) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseForexCurrencies.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseForexCurrencies) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseForexCurrencies 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **currencies** | [**[ForexCurrency]**](ForexCurrency.md) |   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:ForexCurrency) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseForexPairs.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseForexPairs) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseForexPairs 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **pairs** | [**[ForexPair]**](ForexPair.md) |   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:ForexPair) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseForexPrices.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseForexPrices) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseForexPrices 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **prices** | [**[ForexPrice]**](ForexPrice.md) |   15 | **pair** | [**ForexPair**](ForexPair.md) | The Forex currency pair for which prices were requested   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:ForexPrice) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:ForexPair) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseHistoricalData.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseHistoricalData) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseHistoricalData 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **historicalData** | [**[HistoricalData]**](HistoricalData.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:HistoricalData) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseIndex.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseIndex) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseIndex 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **symbol** | String | The index symbol   15 | **name** | String | The index name   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/ApiResponseIndexConstituents.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseIndexConstituents) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseIndexConstituents 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **index** | [**ApiResponseIndex**](ApiResponseIndex.md) | The index   15 | **date** | Date | The date when an update was last received for the index constituents   16 | **constituents** | [**[SecuritySummary]**](SecuritySummary.md) |   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:ApiResponseIndex) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:SecuritySummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseIndexIntervals.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseIndexIntervals) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseIndexIntervals 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **intervals** | [**[IndexInterval]**](IndexInterval.md) | Array of index intervals   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:IndexInterval) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseIndices.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseIndices) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseIndices 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **indices** | [**[ApiResponseIndex]**](ApiResponseIndex.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ApiResponseIndex) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseInitialPublicOfferings.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseInitialPublicOfferings) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseInitialPublicOfferings 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **initialPublicOfferings** | [**[CompanyInitialPublicOffering]**](CompanyInitialPublicOffering.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:CompanyInitialPublicOffering) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseInsiderTransactionFilings.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseInsiderTransactionFilings) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseInsiderTransactionFilings 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **transactionFilings** | [**[InsiderTransactionFiling]**](InsiderTransactionFiling.md) |   15 | **owner** | [**OwnerSummary**](OwnerSummary.md) | The owner associated with the transaction filing   16 | **company** | [**CompanySummary**](CompanySummary.md) | The company associated with the transaction filing   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:InsiderTransactionFiling) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:OwnerSummary) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:CompanySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseMunicipalities.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseMunicipalities) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseMunicipalities 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **municipalities** | [**[Municipality]**](Municipality.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:Municipality) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseMunicipalitiyFinancials.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseMunicipalitiyFinancials) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseMunicipalitiyFinancials 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **financials** | [**[MunicipalityFinancial]**](MunicipalityFinancial.md) |   15 | **municipality** | [**Municipality**](Municipality.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:MunicipalityFinancial) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:Municipality) 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseNews.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseNews) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseNews 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **news** | [**[CompanyNews]**](CompanyNews.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:CompanyNews) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionPrices.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionPrices) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionPrices 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **prices** | [**[OptionPrice]**](OptionPrice.md) | A list of option prices in descending order by date   15 | **option** | [**Option**](Option.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:OptionPrice) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:Option) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseOptions.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptions) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptions 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **options** | [**[Option]**](Option.md) | A list of options contracts with the given symbol   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:Option) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsAggregates.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsAggregates) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsAggregates 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **aggregates** | [**[OptionsAggregate]**](OptionsAggregate.md) | A list of option expiration dates in descending order   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:OptionsAggregate) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsChain.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsChain) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsChain 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **chain** | [**[OptionChain]**](OptionChain.md) | A list of options for the provided expiration date their respective option prices.   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:OptionChain) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsChainEod.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsChainEod) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsChainEod 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **chain** | [**[OptionChainEod]**](OptionChainEod.md) | A list of realtime options for the provided expiration date their respective option prices.   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:OptionChainEod) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsChainRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsChainRealtime) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsChainRealtime 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **chain** | [**[OptionChainRealtime]**](OptionChainRealtime.md) | A list of realtime options for the provided expiration date their respective option prices.   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:OptionChainRealtime) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsExpirations.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsExpirations) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsExpirations 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **expirations** | [String] | A list of option expiration dates in descending order   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsGreekContractRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsGreekContractRealtime) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsGreekContractRealtime 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **messages** | [String] | Any messages or warnings about the data   15 | **option** | [**Option**](Option.md) |   16 | **greeks** | [**OptionSyntheticGreeksRealtime**](OptionSyntheticGreeksRealtime.md) |   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:Option) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:OptionSyntheticGreeksRealtime) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsGreeksByTickerRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsGreeksByTickerRealtime) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsGreeksByTickerRealtime 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | **messages** | [String] | Any messages or warnings about the data   17 | **contracts** | [**[ApiResponseOptionsGreekContractRealtime]**](ApiResponseOptionsGreekContractRealtime.md) | The options greeks data for this security   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:SecuritySummary) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:ApiResponseOptionsGreekContractRealtime) 26 | 27 | 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsImpliedMove.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsImpliedMove) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsImpliedMove 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **impliedMove** | [**OptionImpliedMoveData**](OptionImpliedMoveData.md) | The data pertaining to the implied move.   15 | **messages** | [String] | Any messages or warnings about the data   16 | **underlyingPrice** | Number | The price of the underlying instrument.   17 | **expiration** | String | The date on which the Option expires. The Option becomes invalid after this date and cannot be exercised.   18 | **atmStrike** | Number | The at-the-money strike price for the implied move calculation.   19 | **straddlePrice** | Number | The straddle price for the implied move calculation.   20 | **symbol** | String | The symbol for the underlying instrument.   21 | 22 | [//]: # (END_DEFINITION) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:OptionImpliedMoveData) 26 | 27 | 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsPriceRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsPriceRealtime) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsPriceRealtime 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **price** | [**OptionPriceRealtime**](OptionPriceRealtime.md) |   15 | **stats** | [**OptionStatsRealtime**](OptionStatsRealtime.md) |   16 | **option** | [**OptionRealtime**](OptionRealtime.md) |   17 | **extendedPrice** | [**OptionPriceRealtimeExtended**](OptionPriceRealtimeExtended.md) |   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:OptionPriceRealtime) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:OptionStatsRealtime) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:OptionRealtime) 29 | 30 | 31 | [//]: # (CONTAINED_CLASS:OptionPriceRealtimeExtended) 32 | 33 | 34 | 35 | 36 | 37 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsPricesBatchRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsPricesBatchRealtime) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsPricesBatchRealtime 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **contracts** | [**[OptionPriceBatchRealtime]**](OptionPriceBatchRealtime.md) |   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:OptionPriceBatchRealtime) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsPricesByTickerEod.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsPricesByTickerEod) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsPricesByTickerEod 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   15 | **prices** | [**[OptionsPriceEod]**](OptionsPriceEod.md) | The contracts pricing for this security.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:OptionsPriceEod) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsPricesByTickerRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsPricesByTickerRealtime) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsPricesByTickerRealtime 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | **contracts** | [**[ApiResponseOptionsPriceRealtime]**](ApiResponseOptionsPriceRealtime.md) | The contracts pricing for this security.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:SecuritySummary) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:ApiResponseOptionsPriceRealtime) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsPricesEod.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsPricesEod) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsPricesEod 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **prices** | [**[OptionPriceEod]**](OptionPriceEod.md) | A list of options prices with the given symbol   15 | **option** | [**OptionEod**](OptionEod.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:OptionPriceEod) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:OptionEod) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsRealtime) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsRealtime 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **options** | [**[OptionRealtime]**](OptionRealtime.md) | A list of options contracts with the given symbol   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:OptionRealtime) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsStatsRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsStatsRealtime) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsStatsRealtime 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **stats** | [**OptionStatsRealtime**](OptionStatsRealtime.md) |   15 | **factors** | [**OptionFactorsRealtime**](OptionFactorsRealtime.md) |   16 | **option** | [**OptionRealtime**](OptionRealtime.md) |   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:OptionStatsRealtime) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:OptionFactorsRealtime) 25 | 26 | 27 | [//]: # (CONTAINED_CLASS:OptionRealtime) 28 | 29 | 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsTickers.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsTickers) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsTickers 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **tickers** | [String] |   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsUnusualActivity.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOptionsUnusualActivity) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOptionsUnusualActivity 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **trades** | [**[OptionUnusualTrade]**](OptionUnusualTrade.md) | A list of unusual trades for a given company identifier   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:OptionUnusualTrade) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseOwnerInsiderTransactionFilings.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOwnerInsiderTransactionFilings) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOwnerInsiderTransactionFilings 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **transactionFilings** | [**[InsiderTransactionFiling]**](InsiderTransactionFiling.md) |   15 | **owner** | [**OwnerSummary**](OwnerSummary.md) | The owner associated with the transaction filing   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:InsiderTransactionFiling) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:OwnerSummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseOwnerInstitutionalHoldings.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOwnerInstitutionalHoldings) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOwnerInstitutionalHoldings 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **holdings** | Object |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/ApiResponseOwners.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseOwners) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseOwners 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **owners** | [**[OwnerSummary]**](OwnerSummary.md) | A list of owners   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:OwnerSummary) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseRealtimeIndexPrices.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseRealtimeIndexPrices) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseRealtimeIndexPrices 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **prices** | [**[RealtimeIndexPrice]**](RealtimeIndexPrice.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:RealtimeIndexPrice) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseReportedFinancials.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseReportedFinancials) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseReportedFinancials 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **reportedFinancials** | [**[ReportedFinancial]**](ReportedFinancial.md) |   15 | **fundamental** | [**Fundamental**](Fundamental.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:ReportedFinancial) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:Fundamental) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseSICIndexHistoricalData.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSICIndexHistoricalData) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSICIndexHistoricalData 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **historicalData** | [**[HistoricalData]**](HistoricalData.md) |   15 | **index** | [**SICIndex**](SICIndex.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:HistoricalData) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:SICIndex) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseSICIndices.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSICIndices) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSICIndices 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **indices** | [**[SICIndex]**](SICIndex.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:SICIndex) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseSICIndicesSearch.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSICIndicesSearch) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSICIndicesSearch 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **indices** | [**[SICIndex]**](SICIndex.md) |   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:SICIndex) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurities.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurities) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurities 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **securities** | [**[SecuritySummary]**](SecuritySummary.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:SecuritySummary) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseSecuritiesSearch.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecuritiesSearch) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecuritiesSearch 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **securities** | [**[SecuritySummary]**](SecuritySummary.md) |   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:SecuritySummary) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityAccumulationDistributionIndex.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityAccumulationDistributionIndex) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityAccumulationDistributionIndex 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[AccumulationDistributionIndexTechnicalValue]**](AccumulationDistributionIndexTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:AccumulationDistributionIndexTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityAverageDailyTradingVolume.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityAverageDailyTradingVolume) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityAverageDailyTradingVolume 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[AverageDailyTradingVolumeTechnicalValue]**](AverageDailyTradingVolumeTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:AverageDailyTradingVolumeTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityAverageDirectionalIndex.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityAverageDirectionalIndex) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityAverageDirectionalIndex 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[AverageDirectionalIndexTechnicalValue]**](AverageDirectionalIndexTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:AverageDirectionalIndexTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityAverageTrueRange.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityAverageTrueRange) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityAverageTrueRange 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[AverageTrueRangeTechnicalValue]**](AverageTrueRangeTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:AverageTrueRangeTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityAwesomeOscillator.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityAwesomeOscillator) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityAwesomeOscillator 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[AwesomeOscillatorTechnicalValue]**](AwesomeOscillatorTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:AwesomeOscillatorTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityBollingerBands.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityBollingerBands) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityBollingerBands 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[BollingerBandsTechnicalValue]**](BollingerBandsTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:BollingerBandsTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityChaikinMoneyFlow.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityChaikinMoneyFlow) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityChaikinMoneyFlow 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[ChaikinMoneyFlowTechnicalValue]**](ChaikinMoneyFlowTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:ChaikinMoneyFlowTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityCommodityChannelIndex.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityCommodityChannelIndex) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityCommodityChannelIndex 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[CommodityChannelIndexTechnicalValue]**](CommodityChannelIndexTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:CommodityChannelIndexTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityDetrendedPriceOscillator.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityDetrendedPriceOscillator) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityDetrendedPriceOscillator 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[DetrendedPriceOscillatorTechnicalValue]**](DetrendedPriceOscillatorTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:DetrendedPriceOscillatorTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityDonchianChannel.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityDonchianChannel) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityDonchianChannel 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[DonchianChannelTechnicalValue]**](DonchianChannelTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:DonchianChannelTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityEaseOfMovement.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityEaseOfMovement) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityEaseOfMovement 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[EaseOfMovementTechnicalValue]**](EaseOfMovementTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:EaseOfMovementTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityForceIndex.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityForceIndex) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityForceIndex 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[ForceIndexTechnicalValue]**](ForceIndexTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:ForceIndexTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityHistoricalData.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityHistoricalData) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityHistoricalData 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **historicalData** | [**[HistoricalData]**](HistoricalData.md) |   15 | **security** | [**SecuritySummary**](SecuritySummary.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:HistoricalData) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:SecuritySummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityIchimokuKinkoHyo.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityIchimokuKinkoHyo) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityIchimokuKinkoHyo 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[IchimokuKinkoHyoTechnicalValue]**](IchimokuKinkoHyoTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:IchimokuKinkoHyoTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityInstitutionalOwnership.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityInstitutionalOwnership) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityInstitutionalOwnership 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **ownership** | [**[InstitutionalOwnership]**](InstitutionalOwnership.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:InstitutionalOwnership) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityKeltnerChannel.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityKeltnerChannel) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityKeltnerChannel 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[KeltnerChannelTechnicalValue]**](KeltnerChannelTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:KeltnerChannelTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityKnowSureThing.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityKnowSureThing) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityKnowSureThing 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[KnowSureThingTechnicalValue]**](KnowSureThingTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:KnowSureThingTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityMassIndex.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityMassIndex) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityMassIndex 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[MassIndexTechnicalValue]**](MassIndexTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:MassIndexTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityMoneyFlowIndex.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityMoneyFlowIndex) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityMoneyFlowIndex 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[MoneyFlowIndexTechnicalValue]**](MoneyFlowIndexTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:MoneyFlowIndexTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityMovingAverageConvergenceDivergence.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityMovingAverageConvergenceDivergence) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityMovingAverageConvergenceDivergence 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[MovingAverageConvergenceDivergenceTechnicalValue]**](MovingAverageConvergenceDivergenceTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:MovingAverageConvergenceDivergenceTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityNegativeVolumeIndex.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityNegativeVolumeIndex) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityNegativeVolumeIndex 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[NegativeVolumeIndexTechnicalValue]**](NegativeVolumeIndexTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:NegativeVolumeIndexTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityOnBalanceVolume.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityOnBalanceVolume) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityOnBalanceVolume 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[OnBalanceVolumeTechnicalValue]**](OnBalanceVolumeTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:OnBalanceVolumeTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityOnBalanceVolumeMean.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityOnBalanceVolumeMean) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityOnBalanceVolumeMean 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[OnBalanceVolumeMeanTechnicalValue]**](OnBalanceVolumeMeanTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:OnBalanceVolumeMeanTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityRelativeStrengthIndex.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityRelativeStrengthIndex) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityRelativeStrengthIndex 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[RelativeStrengthIndexTechnicalValue]**](RelativeStrengthIndexTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:RelativeStrengthIndexTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecuritySimpleMovingAverage.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecuritySimpleMovingAverage) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecuritySimpleMovingAverage 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[SimpleMovingAverageTechnicalValue]**](SimpleMovingAverageTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:SimpleMovingAverageTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityStochasticOscillator.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityStochasticOscillator) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityStochasticOscillator 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[StochasticOscillatorTechnicalValue]**](StochasticOscillatorTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:StochasticOscillatorTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityStockPriceAdjustments.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityStockPriceAdjustments) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityStockPriceAdjustments 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **stockPriceAdjustments** | [**[StockPriceAdjustmentSummary]**](StockPriceAdjustmentSummary.md) | The stock price adjustments for the Security   15 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:StockPriceAdjustmentSummary) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:SecuritySummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityStockPrices.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityStockPrices) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityStockPrices 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **stockPrices** | [**[StockPriceSummary]**](StockPriceSummary.md) | The stock prices for the Security   15 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:StockPriceSummary) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:SecuritySummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityTripleExponentialAverage.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityTripleExponentialAverage) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityTripleExponentialAverage 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[TripleExponentialAverageTechnicalValue]**](TripleExponentialAverageTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:TripleExponentialAverageTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityTrueStrengthIndex.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityTrueStrengthIndex) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityTrueStrengthIndex 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[TrueStrengthIndexTechnicalValue]**](TrueStrengthIndexTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:TrueStrengthIndexTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityUltimateOscillator.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityUltimateOscillator) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityUltimateOscillator 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[UltimateOscillatorTechnicalValue]**](UltimateOscillatorTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:UltimateOscillatorTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityVolumePriceTrend.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityVolumePriceTrend) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityVolumePriceTrend 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[VolumePriceTrendTechnicalValue]**](VolumePriceTrendTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:VolumePriceTrendTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityVolumeWeightedAveragePrice.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityVolumeWeightedAveragePrice) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityVolumeWeightedAveragePrice 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[VolumeWeightedAveragePriceValue]**](VolumeWeightedAveragePriceValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:VolumeWeightedAveragePriceValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityVortexIndicator.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityVortexIndicator) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityVortexIndicator 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[VortexIndicatorTechnicalValue]**](VortexIndicatorTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:VortexIndicatorTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityWilliamsR.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityWilliamsR) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityWilliamsR 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **technicals** | [**[WilliamsRTechnicalValue]**](WilliamsRTechnicalValue.md) |   15 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   17 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:WilliamsRTechnicalValue) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityZacksAnalystRatings.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityZacksAnalystRatings) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityZacksAnalystRatings 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **analystRatings** | [**[ZacksAnalystRatingSummary]**](ZacksAnalystRatingSummary.md) |   15 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:ZacksAnalystRatingSummary) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:SecuritySummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityZacksAnalystRatingsSnapshot.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityZacksAnalystRatingsSnapshot) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityZacksAnalystRatingsSnapshot 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **snapshots** | [**[ZacksAnalystRatingSnapshot]**](ZacksAnalystRatingSnapshot.md) |   15 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ZacksAnalystRatingSnapshot) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:SecuritySummary) 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityZacksEPSSurprises.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityZacksEPSSurprises) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityZacksEPSSurprises 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **epsSurprises** | [**[ZacksEPSSurpriseSummary]**](ZacksEPSSurpriseSummary.md) |   15 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:ZacksEPSSurpriseSummary) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:SecuritySummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityZacksSalesSurprises.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseSecurityZacksSalesSurprises) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseSecurityZacksSalesSurprises 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **salesSurprises** | [**[ZacksSalesSurpriseSummary]**](ZacksSalesSurpriseSummary.md) |   15 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:ZacksSalesSurpriseSummary) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:SecuritySummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseStandardizedFinancials.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseStandardizedFinancials) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseStandardizedFinancials 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **standardizedFinancials** | [**[StandardizedFinancial]**](StandardizedFinancial.md) |   15 | **fundamental** | [**Fundamental**](Fundamental.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:StandardizedFinancial) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:Fundamental) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseStandardizedFinancialsDimensions.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseStandardizedFinancialsDimensions) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseStandardizedFinancialsDimensions 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dimensions** | [**[StandardizedFinancialsDimension]**](StandardizedFinancialsDimension.md) | The combination of XBRL axis and members that defines the dimensionalization of this fact (if any)   15 | **dataTag** | [**DataTagSummary**](DataTagSummary.md) |   16 | **fundamental** | [**Fundamental**](Fundamental.md) |   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:StandardizedFinancialsDimension) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:DataTagSummary) 25 | 26 | 27 | [//]: # (CONTAINED_CLASS:Fundamental) 28 | 29 | 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseStockExchangeBetas.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseStockExchangeBetas) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseStockExchangeBetas 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **betas** | [**[Beta]**](Beta.md) | The mover security.   15 | **stockExchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:Beta) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:StockExchange) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseStockExchangeMovers.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseStockExchangeMovers) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseStockExchangeMovers 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **movers** | [**[StockExchangeMover]**](StockExchangeMover.md) | The mover security.   15 | **stockExchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:StockExchangeMover) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:StockExchange) 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseStockExchangeQuote.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseStockExchangeQuote) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseStockExchangeQuote 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **quotes** | [**[ApiResponseSecurityQuote]**](ApiResponseSecurityQuote.md) | The realtime stock prices for all Securities traded on the Stock Exchange   15 | **stockExchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ApiResponseSecurityQuote) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:StockExchange) 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseStockExchangeRealtimeStockPrices.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseStockExchangeRealtimeStockPrices) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseStockExchangeRealtimeStockPrices 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **stockPrices** | [**[RealtimeStockPrice]**](RealtimeStockPrice.md) | The realtime stock prices for all Securities traded on the Stock Exchange   15 | **stockExchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:RealtimeStockPrice) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:StockExchange) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseStockExchangeSecurities.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseStockExchangeSecurities) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseStockExchangeSecurities 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **securities** | [**[SecuritySummary]**](SecuritySummary.md) | The securities traded on the Stock Exchange   15 | **stockExchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:SecuritySummary) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:StockExchange) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseStockExchangeStockPriceAdjustments.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseStockExchangeStockPriceAdjustments) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseStockExchangeStockPriceAdjustments 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **stockPriceAdjustments** | [**[StockPriceAdjustment]**](StockPriceAdjustment.md) | The stock price adjustments for all Securities traded on the Stock Exchange on the given date   15 | **stockExchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:StockPriceAdjustment) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:StockExchange) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseStockExchangeStockPrices.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseStockExchangeStockPrices) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseStockExchangeStockPrices 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **stockPrices** | [**[StockPrice]**](StockPrice.md) | The stock prices for all Securities traded on the Stock Exchange on the given date   15 | **stockExchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:StockPrice) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:StockExchange) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseStockExchanges.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseStockExchanges) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseStockExchanges 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **stockExchanges** | [**[StockExchange]**](StockExchange.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:StockExchange) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseStockMarketIndexHistoricalData.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseStockMarketIndexHistoricalData) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseStockMarketIndexHistoricalData 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **historicalData** | [**[HistoricalData]**](HistoricalData.md) |   15 | **index** | [**StockMarketIndexSummary**](StockMarketIndexSummary.md) |   16 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:HistoricalData) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:StockMarketIndexSummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseStockMarketIndices.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseStockMarketIndices) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseStockMarketIndices 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **indices** | [**[StockMarketIndexSummary]**](StockMarketIndexSummary.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:StockMarketIndexSummary) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseStockMarketIndicesSearch.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseStockMarketIndicesSearch) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseStockMarketIndicesSearch 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **indices** | [**[StockMarketIndexSummary]**](StockMarketIndexSummary.md) |   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:StockMarketIndexSummary) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksAnalystRatings.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseZacksAnalystRatings) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseZacksAnalystRatings 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **analystRatings** | [**[ZacksAnalystRating]**](ZacksAnalystRating.md) |   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ZacksAnalystRating) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksEBITDAConsensus.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseZacksEBITDAConsensus) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseZacksEBITDAConsensus 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **ebitdaConsensuses** | [**[ZacksEBITDAConsensus]**](ZacksEBITDAConsensus.md) | Zacks target price consensuses for the latest date   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ZacksEBITDAConsensus) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksEPSEstimates.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseZacksEPSEstimates) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseZacksEPSEstimates 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **estimates** | [**[ZacksEPSEstimate]**](ZacksEPSEstimate.md) | Zacks EPS estimate data for a given date range   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ZacksEPSEstimate) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksEPSGrowthRates.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseZacksEPSGrowthRates) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseZacksEPSGrowthRates 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **epsGrowthRates** | [**[ZacksEPSGrowthRate]**](ZacksEPSGrowthRate.md) | Zacks EPS growth rate for the latest date   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ZacksEPSGrowthRate) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksEPSSurprises.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseZacksEPSSurprises) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseZacksEPSSurprises 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **epsSurprises** | [**[ZacksEPSSurprise]**](ZacksEPSSurprise.md) | Zacks EPS Surprise data for a Security in descending order by actual reported date   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ZacksEPSSurprise) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksETFHoldings.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseZacksETFHoldings) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseZacksETFHoldings 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **holdings** | [**[ZacksETFHolding]**](ZacksETFHolding.md) | Zacks ETF holding data   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ZacksETFHolding) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksForwardPEs.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseZacksForwardPEs) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseZacksForwardPEs 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **forwardPe** | [**[ZacksForwardPE]**](ZacksForwardPE.md) | Zacks forward PE ratio estimates   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ZacksForwardPE) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksInstitutionalHoldingCompanies.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseZacksInstitutionalHoldingCompanies) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseZacksInstitutionalHoldingCompanies 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **companies** | [**[ZacksInstitutionalHoldingCompanyDetail]**](ZacksInstitutionalHoldingCompanyDetail.md) | Zacks institutional holding company data   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ZacksInstitutionalHoldingCompanyDetail) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksInstitutionalHoldingOwners.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseZacksInstitutionalHoldingOwners) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseZacksInstitutionalHoldingOwners 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **owners** | [**[ZacksInstitutionalHoldingOwnerDetail]**](ZacksInstitutionalHoldingOwnerDetail.md) | Zacks institutional holding owners data   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ZacksInstitutionalHoldingOwnerDetail) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksInstitutionalHoldings.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseZacksInstitutionalHoldings) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseZacksInstitutionalHoldings 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **holdings** | [**[ZacksInstitutionalHolding]**](ZacksInstitutionalHolding.md) | Zacks institutional holding data   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ZacksInstitutionalHolding) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksLongTermGrowthRates.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseZacksLongTermGrowthRates) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseZacksLongTermGrowthRates 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **longTermGrowthEstimates** | [**[ZacksLongTermGrowthRate]**](ZacksLongTermGrowthRate.md) | Zacks latest long term growth rates   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ZacksLongTermGrowthRate) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksSalesEstimates.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseZacksSalesEstimates) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseZacksSalesEstimates 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **estimates** | [**[ZacksSalesEstimate]**](ZacksSalesEstimate.md) | Zacks Sales estimate data for a given date range   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ZacksSalesEstimate) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksSalesSurprises.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseZacksSalesSurprises) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseZacksSalesSurprises 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **salesSurprises** | [**[ZacksSalesSurprise]**](ZacksSalesSurprise.md) | Zacks Sales Surprise data for a Security in descending order by actual reported date   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ZacksSalesSurprise) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksTargetPriceConsensuses.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ApiResponseZacksTargetPriceConsensuses) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ApiResponseZacksTargetPriceConsensuses 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **targetPriceConsensuses** | [**[ZacksTargetPriceConsensus]**](ZacksTargetPriceConsensus.md) | Zacks target price consensuses for the latest date   15 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ZacksTargetPriceConsensus) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/AverageDailyTradingVolumeTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:AverageDailyTradingVolumeTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### AverageDailyTradingVolumeTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **adtv** | Number | The Average Daily Trading Volume calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/AverageDirectionalIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:AverageDirectionalIndexTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### AverageDirectionalIndexTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **adx** | Number | The Average Directional Index value   16 | **diNeg** | Number | The Minus Directional Indicator value   17 | **diPos** | Number | The Plus Directional Indicator value   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/AverageTrueRangeTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:AverageTrueRangeTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### AverageTrueRangeTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **atr** | Number | The Average True Range calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/AwesomeOscillatorTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:AwesomeOscillatorTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### AwesomeOscillatorTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **ao** | Number | The Awesome Oscillator calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/Beta.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:Beta) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### Beta 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **periodType** | String | Type of period for this beta value.   15 | **oneYearBeta** | Number | The one year beta value for this security.   16 | **threeYearBeta** | Number | The three year beta value for this security.   17 | **fiveYearBeta** | Number | The five year beta value for this security.   18 | **sevenYearBeta** | Number | The seven year beta value for this security.   19 | **tenYearBeta** | Number | The ten year beta value for this security.   20 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security.   21 | 22 | [//]: # (END_DEFINITION) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:SecuritySummary) 26 | 27 | 28 | 29 |
30 | 31 | #### Enum: PeriodTypeEnum** 32 | 33 | Name | Value 34 | ---- | ----- 35 | weekly | "weekly" 36 | monthly | "monthly" 37 | 38 | 39 | 40 | -------------------------------------------------------------------------------- /docs/BollingerBandsTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:BollingerBandsTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### BollingerBandsTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **lowerBand** | Number | The lower band value of the Bollinger Bands technical indicator calculation   16 | **middleBand** | Number | The middle band value of the Bollinger Bands technical indicator calculation   17 | **upperBand** | Number | The upper band value of the Bollinger Bands technical indicator calculation   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/BulkDownloadLinks.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:BulkDownloadLinks) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### BulkDownloadLinks 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **name** | String | The name of the file   15 | **url** | String | Link for accessing the bulk download. Expires in 24 hours.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/BulkDownloadSummary.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:BulkDownloadSummary) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### BulkDownloadSummary 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | The Intrinio ID of the bulk download   15 | **name** | String | The name of the bulk download   16 | **format** | String | The file format of the bulk download   17 | **dataLengthBytes** | String | The total length of the bulk download data in bytes   18 | **updateFrequency** | String | The update frequency for the bulk download   19 | **lastUpdated** | Date | The date on which the bulk download was last updated   20 | **links** | [**[BulkDownloadLinks]**](BulkDownloadLinks.md) | Links to all of the files comprising the bulk download. Links expire in 24 hours.   21 | 22 | [//]: # (END_DEFINITION) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:BulkDownloadLinks) 26 | 27 | 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/ChaikinMoneyFlowTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ChaikinMoneyFlowTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ChaikinMoneyFlowTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **cmf** | Number | The Chaikin Money Flow calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/CommodityChannelIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:CommodityChannelIndexTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### CommodityChannelIndexTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **cci** | Number | The Commodity Channel Index calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/CompanyPublicFloat.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:CompanyPublicFloat) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### CompanyPublicFloat 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **date** | Date | The date of the public float.   15 | **filingDate** | Date | The filing date of the public float.   16 | **publicFloatValue** | Number | The dollar value for company float.   17 | **publicFloatShares** | Number | The public shares for the company.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/CompanySharesOutstanding.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:CompanySharesOutstanding) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### CompanySharesOutstanding 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **xbrlAxis** | String | The xbrl concept axis member reported to the SEC.   15 | **xbrlMember** | String | Provides information about the class of stock as reported in XBRL   16 | **endDate** | Date | End date of the filing period   17 | **titleOfSecurity** | String | The description of the security type   18 | **tradingSymbol** | String | The symbol under which the security is traded in the exchange   19 | **securityExchangeName** | String | The name of the secuirty exchange   20 | **sharesOutstanding** | Number | The amount of stock currently held by all shareholders   21 | 22 | [//]: # (END_DEFINITION) 23 | 24 | 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/CompanySummary.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:CompanySummary) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### CompanySummary 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | The Intrinio ID of the company   15 | **ticker** | String | The stock market ticker symbol associated with the company's common stock securities   16 | **name** | String | The company's common name   17 | **lei** | String | The Legal Entity Identifier (LEI) assigned to the company   18 | **cik** | String | The Central Index Key (CIK) assigned to the company   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/DataTagSummary.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:DataTagSummary) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### DataTagSummary 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | The Intrinio ID for the Data Tag   15 | **name** | String | The readable name of the Data Tag   16 | **tag** | String | The code-name of the Data Tag   17 | **parent** | String | The parent Data Tag forming the statement relationship with the factor   18 | **sequence** | Number | The order in which the Data Tag appears in its logical group (such as a financial statement)   19 | **factor** | String | The operator forming the statement relationship between the child Data Tag (or Data Tags) and the parent Data Tag   20 | **balance** | String | Whether the Data Tag represents a credit or debit   21 | **unit** | String | The unit of the Data Tag   22 | 23 | [//]: # (END_DEFINITION) 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/DetrendedPriceOscillatorTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:DetrendedPriceOscillatorTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### DetrendedPriceOscillatorTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **dpo** | Number | The Detrended Price Oscillator calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/DonchianChannelTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:DonchianChannelTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### DonchianChannelTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **lowerBound** | Number | The lower bound value of the Donchian Channel calculation   16 | **upperBound** | Number | The upper bound value of the Donchian Channel calculation   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ESGCompanySummary.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ESGCompanySummary) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ESGCompanySummary 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | The Intrinio ID of the company.   15 | **name** | String | The company’s common name.   16 | **ticker** | String | The stock market ticker symbol associated with the company’s common stock security.   17 | **isin** | String | The company's common securities identification 12-digit alphanumeric code.   18 | **primaryIndustry** | String | The primary industry associated with the company based on their main revenue generating operations.   19 | **country** | String | The country in which the company's headquarters or primary place of business is located.   20 | 21 | [//]: # (END_DEFINITION) 22 | 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/ETFSummary.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ETFSummary) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ETFSummary 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | The Intrinio ID of the ETF   15 | **name** | String | The common name of the ETF   16 | **ticker** | String | The common ticker symbol for the ETF   17 | **figiTicker** | String | The OpenFIGI ticker for the ETF   18 | **ric** | String | Reuters Instrument Code (RIC) for the ETF   19 | **isin** | String | International Securities Identification Number (ISIN) for the ETF   20 | **sedol** | String | Stock Exchange Daily Official List (SEDOL) for the ETF   21 | **exchangeMic** | String | The exchange Market Identifier Code (MIC) from the International Standards Organization (ISO)   22 | 23 | [//]: # (END_DEFINITION) 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/EaseOfMovementTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:EaseOfMovementTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### EaseOfMovementTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **eom** | Number | The Ease of Movement calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/EconomicIndex.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:EconomicIndex) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### EconomicIndex 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | The Intrinio ID for the Index   15 | **symbol** | String | The symbol used to identify the Index   16 | **name** | String | The name of the Index   17 | **continent** | String | The continent of the country of focus for the Index   18 | **country** | String | The country of focus for the Index   19 | **updateFrequency** | String | How often the Index is updated   20 | **lastUpdated** | Date | When the Index was updated last   21 | **description** | String | A paragraph describing the index and its scope   22 | **observationStart** | Date | The earliest date for which data is available   23 | **observationEnd** | Date | The latest date for which data is available   24 | **seasonalAdjustment** | String | Whether the data is adjusted to account for seasonality   25 | **units** | String | The units of the data   26 | 27 | [//]: # (END_DEFINITION) 28 | 29 | 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/EconomicIndexSummary.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:EconomicIndexSummary) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### EconomicIndexSummary 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | The Intrinio ID for the Index   15 | **symbol** | String | The symbol used to identify the Index   16 | **name** | String | The name of the Index   17 | **continent** | String | The continent of the country of focus for the Index   18 | **country** | String | The country of focus for the Index   19 | **updateFrequency** | String | How often the Index is updated   20 | **lastUpdated** | Date | When the Index was updated last   21 | **observationStart** | Date | The earliest date for which data is available   22 | **observationEnd** | Date | The latest date for which data is available   23 | **seasonalAdjustment** | String | Whether the data is adjusted to account for seasonality   24 | **units** | String | The units of the data   25 | 26 | [//]: # (END_DEFINITION) 27 | 28 | 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/EodIndexPrice.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:EodIndexPrice) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### EodIndexPrice 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **index** | [**ApiResponseIndex**](ApiResponseIndex.md) | The index   15 | **close** | Number | The close price   16 | **open** | Number | The open price   17 | **high** | Number | The high price   18 | **low** | Number | The low price   19 | **volume** | Number | The volume   20 | **date** | Date | The date of the pricing data.   21 | 22 | [//]: # (END_DEFINITION) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:ApiResponseIndex) 26 | 27 | 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/EodIndexPriceSummary.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:EodIndexPriceSummary) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### EodIndexPriceSummary 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **close** | Number | The close price   15 | **open** | Number | The open price   16 | **high** | Number | The high price   17 | **low** | Number | The low price   18 | **volume** | Number | The volume   19 | **date** | Date | The date of the pricing data.   20 | 21 | [//]: # (END_DEFINITION) 22 | 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/FilingNote.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:FilingNote) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### FilingNote 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | The Intrinio ID of the note   15 | **xbrlTag** | String | The XBRL Tag used for the note   16 | **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   17 | **filing** | [**FilingNoteFiling**](FilingNoteFiling.md) |   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:FilingNoteFiling) 23 | 24 | 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/FilingNoteFiling.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:FilingNoteFiling) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### FilingNoteFiling 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **cik** | String | The Central Index Key (CIK) assigned to the company   15 | **reportType** | String | The filing <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report type</a>   16 | **periodEndDate** | Date | The ending date of the fiscal period for the filing   17 | **filingDate** | Date | The date the report was filed with the SEC   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/FilingNoteSummary.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:FilingNoteSummary) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### FilingNoteSummary 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | The Intrinio ID of the note   15 | **xbrlTag** | String | The XBRL tag used for the note by the filing entity   16 | **filing** | [**FilingNoteFiling**](FilingNoteFiling.md) |   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:FilingNoteFiling) 22 | 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/FilingSummary.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:FilingSummary) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### FilingSummary 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | The Intrinio ID of the Filing   15 | **filingDate** | Date | The date when the filing was submitted to the SEC by the company   16 | **acceptedDate** | Date | The date and time when the filing was accepted by SEC   17 | **periodEndDate** | Date | The ending date of the fiscal period for the filing   18 | **reportType** | String | The filing <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report type</a>   19 | **secUniqueId** | String | A unique identifier for the filing provided by the SEC   20 | **filingUrl** | String | The URL to the filing page on the SEC site   21 | **reportUrl** | String | The URL to the actual report on the SEC site   22 | **instanceUrl** | String | The URL for the XBRL filing for the report   23 | 24 | [//]: # (END_DEFINITION) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ForceIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ForceIndexTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ForceIndexTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **fi** | Number | The Force Index calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/ForexCurrency.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ForexCurrency) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ForexCurrency 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **code** | String | The ISO 4217 currency code   15 | **name** | String | The name of the currency   16 | **country** | String | The country in which the currency is used   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ForexPair.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ForexPair) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ForexPair 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **code** | String | The common code of the currency pair   15 | **baseCurrency** | String | The ISO 4217 currency code of the base currency   16 | **quoteCurrency** | String | The ISO 4217 currency code of the quote currency   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ForexPrice.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ForexPrice) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ForexPrice 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **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.   15 | **openBid** | Number | Open bid   16 | **highBid** | Number | High bid   17 | **lowBid** | Number | Low bid   18 | **closeBid** | Number | Close bid   19 | **openAsk** | Number | Open ask   20 | **highAsk** | Number | High ask   21 | **lowAsk** | Number | Low ask   22 | **closeAsk** | Number | Close ask   23 | **totalTicks** | Number | Total ticks   24 | 25 | [//]: # (END_DEFINITION) 26 | 27 | 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/HistoricalData.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:HistoricalData) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### HistoricalData 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **date** | Date | The date that the value is present   15 | **value** | Number | The historical value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/IchimokuKinkoHyoTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:IchimokuKinkoHyoTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### IchimokuKinkoHyoTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **chikouSpan** | Number | The Chikou Span (Lagging Span) value of the Ichimoku Kinko Hyo calculation   16 | **kijunSen** | Number | The Kijun-sen (Base Line) value of the Ichimoku Kinko Hyo calculation   17 | **senkouSpanA** | Number | The Senkou Span A (Leading Span A) value of the Ichimoku Kinko Hyo calculation   18 | **senkouSpanB** | Number | The Senkou Span B (Leading Span B) value of the Ichimoku Kinko Hyo calculation   19 | **tenkanSen** | Number | The Tenskan-sen (Conversion Line) value of the Ichimoku Kinko Hyo calculation   20 | 21 | [//]: # (END_DEFINITION) 22 | 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/KeltnerChannelTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:KeltnerChannelTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### KeltnerChannelTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **lowerBand** | Number | The lower band value of the Keltner Channel calculation   16 | **middleBand** | Number | The middle band value of the Keltner Channel calculation   17 | **upperBand** | Number | The upper band value of the Keltner Channel calculation   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/KnowSureThingTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:KnowSureThingTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### KnowSureThingTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **kst** | Number | The Know Sure Thing calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/MarketStatusResult.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:MarketStatusResult) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### MarketStatusResult 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **timestamp** | Date | The UTC timestamp.   15 | **isOpen** | Boolean | Whether the market is open or not.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/MassIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:MassIndexTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### MassIndexTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **mi** | Number | The Mass Index calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/MoneyFlowIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:MoneyFlowIndexTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### MoneyFlowIndexTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **mfi** | Number | The Money Flow Index calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/MovingAverageConvergenceDivergenceTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:MovingAverageConvergenceDivergenceTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### MovingAverageConvergenceDivergenceTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **macdHistogram** | Number | The histogram value of the Moving Average Convergence Divergence calculation   16 | **macdLine** | Number | The line value of the Moving Average Convergence Divergence calculation   17 | **signalLine** | Number | The signal line value of the Moving Average Convergence Divergence calculation   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/NegativeVolumeIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:NegativeVolumeIndexTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### NegativeVolumeIndexTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **nvi** | Number | The Negative Volume Index calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/NewsTopic.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:NewsTopic) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### NewsTopic 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **name** | String | The description of the topic.   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/OnBalanceVolumeMeanTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OnBalanceVolumeMeanTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OnBalanceVolumeMeanTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **obvMean** | Number | The On-balance Volume Mean calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/OnBalanceVolumeTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OnBalanceVolumeTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OnBalanceVolumeTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **obv** | Number | The On-balance Volume calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/OptionChain.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionChain) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionChain 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **option** | [**Option**](Option.md) |   15 | **price** | [**OptionPrice**](OptionPrice.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:Option) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:OptionPrice) 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/OptionChainEod.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionChainEod) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionChainEod 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **option** | [**OptionEod**](OptionEod.md) |   15 | **prices** | [**OptionPriceEod**](OptionPriceEod.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:OptionEod) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:OptionPriceEod) 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/OptionChainRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionChainRealtime) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionChainRealtime 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **option** | [**OptionRealtime**](OptionRealtime.md) |   15 | **price** | [**OptionPriceRealtime**](OptionPriceRealtime.md) |   16 | **stats** | [**OptionStatsRealtime**](OptionStatsRealtime.md) |   17 | **extendedPrice** | [**OptionPriceRealtimeExtended**](OptionPriceRealtimeExtended.md) |   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:OptionRealtime) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:OptionPriceRealtime) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:OptionStatsRealtime) 29 | 30 | 31 | [//]: # (CONTAINED_CLASS:OptionPriceRealtimeExtended) 32 | 33 | 34 | 35 | 36 | 37 | -------------------------------------------------------------------------------- /docs/OptionContractsList.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionContractsList) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionContractsList 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **contracts** | [String] |   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/OptionFactorsRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionFactorsRealtime) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionFactorsRealtime 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **marketPrice** | Number | The market price of the options contract   15 | **underlyingPrice** | Number | The market price of the underlying asset   16 | **strikePrice** | Number | The strike price of the options contract   17 | **daysToExpiration** | Number | The number of days to expiration   18 | **riskFreeInterestRate** | Number | The current risk-free interest rate, as measured by the 3-month Treasury Bill rate   19 | **dividendYield** | Number | The dividend yield of the underlying asset (if applicable)   20 | 21 | [//]: # (END_DEFINITION) 22 | 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/OptionImpliedMoveData.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionImpliedMoveData) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionImpliedMoveData 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **amount** | Number | The amount of the implied move.   15 | **percentage** | Number | The percentage of the implied move.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/OptionInterval.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionInterval) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionInterval 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **openTime** | Date | The UTC timestamp for the time this interval opened.   15 | **closeTime** | Date | The UTC timestamp for the time this interval closed.   16 | **open** | Number | The first traded contract price in this interval.   17 | **high** | Number | The highest traded contract price in this interval.   18 | **low** | Number | The lowest traded contract price in this interval.   19 | **close** | Number | The last traded contract price in this interval.   20 | **volume** | Number | The volume of contracts traded in this interval.   21 | **average** | Number | The volume weighted average price of contract trades in this interval.   22 | **change** | Number | The ratio of Close minus Open to Open.   23 | **tradeCount** | Number | The number of qualified trades executed during the period   24 | 25 | [//]: # (END_DEFINITION) 26 | 27 | 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/OptionIntervalMover.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionIntervalMover) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionIntervalMover 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **contract** | String | The option contract for the intervals   15 | **change** | Number | The ratio of Close minus Open to Open.   16 | **open** | Number | The first traded contract price in this interval.   17 | **high** | Number | The highest traded contract price in this interval.   18 | **low** | Number | The lowest traded contract price in this interval.   19 | **close** | Number | The last traded contract price in this interval.   20 | **volume** | Number | The volume of contracts traded in this interval.   21 | **average** | Number | The volume weighted average price of contract trades in this interval.   22 | **tradeCount** | Number | The number of contract trades executed in this interval   23 | 24 | [//]: # (END_DEFINITION) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/OptionIntervalsMoversResult.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionIntervalsMoversResult) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionIntervalsMoversResult 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **openTime** | Date | The UTC timestamp for the time this interval opened.   15 | **closeTime** | Date | The UTC timestamp for the time this interval closed.   16 | **size** | String | The size of the time span for the interval.   17 | **intervals** | [**[OptionIntervalMover]**](OptionIntervalMover.md) | Array of all the intervals in the result.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:OptionIntervalMover) 23 | 24 | 25 | 26 |
27 | 28 | #### Enum: SizeEnum** 29 | 30 | Name | Value 31 | ---- | ----- 32 | SixtyMinute | "SixtyMinute" 33 | ThirtyMinute | "ThirtyMinute" 34 | FifteenMinute | "FifteenMinute" 35 | TenMinute | "TenMinute" 36 | FiveMinute | "FiveMinute" 37 | OneMinute | "OneMinute" 38 | 39 | 40 | 41 | -------------------------------------------------------------------------------- /docs/OptionIntervalsResult.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionIntervalsResult) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionIntervalsResult 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **intervals** | [**[OptionInterval]**](OptionInterval.md) | Array of all the intervals in the result.   15 | **contract** | String | The option contract for the intervals   16 | **size** | String | The size of the time span for the interval.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:OptionInterval) 22 | 23 | 24 | 25 |
26 | 27 | #### Enum: SizeEnum** 28 | 29 | Name | Value 30 | ---- | ----- 31 | SixtyMinute | "SixtyMinute" 32 | ThirtyMinute | "ThirtyMinute" 33 | FifteenMinute | "FifteenMinute" 34 | TenMinute | "TenMinute" 35 | FiveMinute | "FiveMinute" 36 | OneMinute | "OneMinute" 37 | 38 | 39 | 40 | -------------------------------------------------------------------------------- /docs/OptionPriceBatchRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionPriceBatchRealtime) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionPriceBatchRealtime 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **price** | [**OptionPriceRealtime**](OptionPriceRealtime.md) |   15 | **stats** | [**OptionStatsRealtime**](OptionStatsRealtime.md) |   16 | **option** | [**OptionRealtime**](OptionRealtime.md) |   17 | **extendedPrice** | [**OptionPriceRealtimeExtended**](OptionPriceRealtimeExtended.md) |   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:OptionPriceRealtime) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:OptionStatsRealtime) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:OptionRealtime) 29 | 30 | 31 | [//]: # (CONTAINED_CLASS:OptionPriceRealtimeExtended) 32 | 33 | 34 | 35 | 36 | 37 | -------------------------------------------------------------------------------- /docs/OptionPriceRealtimeExtended.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionPriceRealtimeExtended) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionPriceRealtimeExtended 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **bidOpen** | Number | The price of the bid at open   15 | **bidHigh** | Number | The high bid so far today   16 | **bidLow** | Number | The low bid so far today   17 | **askOpen** | Number | The price of the ask at open   18 | **askHigh** | Number | The high ask so far today   19 | **askLow** | Number | The low ask so far today   20 | **tradeOpen** | Number | The price of the trade at open   21 | **tradeHigh** | Number | The high trade so far today   22 | **tradeLow** | Number | The low trade so far today   23 | **askClose** | Number | The price of ask at close today   24 | **bidClose** | Number | The price of bid at close today   25 | **tradeClose** | Number | The price of the last trade of the day   26 | **mark** | Number | The mark price   27 | 28 | [//]: # (END_DEFINITION) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/OptionRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionRealtime) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionRealtime 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **code** | String | The Intrinio Code for the Option.   15 | **ticker** | String | The ticker symbol of the Security for the Option.   16 | **expiration** | Date | The date on which the Option expires. The Option becomes invalid after this date and cannot be exercised.   17 | **strike** | Number | 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.   18 | **type** | String | The type of Option (put or call).   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | 24 |
25 | 26 | #### Enum: TypeEnum** 27 | 28 | Name | Value 29 | ---- | ----- 30 | put | "put" 31 | call | "call" 32 | 33 | 34 | 35 | -------------------------------------------------------------------------------- /docs/OptionSnapshotGroup.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionSnapshotGroup) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionSnapshotGroup 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **time** | Date | The UTC timestamp of this snapshot group.   15 | **files** | [Object] | List of all the snapshot parts of this group.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/OptionSnapshotsResult.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionSnapshotsResult) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionSnapshotsResult 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **snapshots** | [**[OptionSnapshotGroup]**](OptionSnapshotGroup.md) | List of all the snapshot groups comprising the queried result.   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:OptionSnapshotGroup) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/OptionStatsRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionStatsRealtime) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionStatsRealtime 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **impliedVolatility** | Number | The implied volatility of the contract calculated using the Black-Scholes Model.   15 | **delta** | Number | Delta represents the rate of change between the option's price and a $1 change in the underlying asset's price.   16 | **gamma** | Number | Gamma represents the rate of change between an option's delta and the underlying asset's price.   17 | **theta** | Number | Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay.   18 | **vega** | Number | Vega represents the rate of change between an option's value and the underlying asset's implied volatility.   19 | **underlyingPrice** | Number | The most recent trade price of the underlying asset.   20 | 21 | [//]: # (END_DEFINITION) 22 | 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/OptionSyntheticGreeksRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionSyntheticGreeksRealtime) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionSyntheticGreeksRealtime 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **impliedVolatility** | Number | The implied volatility of the contract calculated using the Black-Scholes Model.   15 | **delta** | Number | Delta represents the rate of change between the option's price and a $1 change in the underlying asset's price.   16 | **gamma** | Number | Gamma represents the rate of change between an option's delta and the underlying asset's price.   17 | **theta** | Number | Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay.   18 | **vega** | Number | Vega represents the rate of change between an option's value and the underlying asset's implied volatility.   19 | **syntheticPrice** | Number | The derived synthetic price of the contract.   20 | 21 | [//]: # (END_DEFINITION) 22 | 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/OptionTrades.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionTrades) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionTrades 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **contract** | String | The option contract   15 | **underlyingSymbol** | String | The ticker symbol   16 | **timestamp** | Date | The UTC timestamp at the time of the trade.   17 | **price** | Number | The price of the trade.   18 | **size** | Number | The size of the trade.   19 | **totalVolume** | Number | The total volume of the symbol for the day up to the timestamp point in time.   20 | **askPriceAtExecution** | Number | The price of ask quote at the time of the trade.   21 | **bidPriceAtExecution** | Number | The price of bid quote at the time of the trade.   22 | **exchange** | String | The exchange for the trade.   23 | **conditions** | String | The condition of the trade.   24 | **sequenceId** | Number | The sequential ID for the trade, ordered as temporally received from the exchange.   25 | 26 | [//]: # (END_DEFINITION) 27 | 28 | 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/OptionTradesResult.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionTradesResult) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionTradesResult 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   15 | **source** | String | The source of the trades.   16 | **trades** | [**[OptionTrades]**](OptionTrades.md) | Array of all the trades in this page of the result.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:OptionTrades) 22 | 23 | 24 | 25 |
26 | 27 | #### Enum: SourceEnum** 28 | 29 | Name | Value 30 | ---- | ----- 31 | realtime | "realtime" 32 | delayed | "delayed" 33 | 34 | 35 | 36 | -------------------------------------------------------------------------------- /docs/OptionsAggregate.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionsAggregate) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionsAggregate 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **ticker** | String | The ticker symbol of the Security for the Option.   15 | **date** | String | The date of the data.   16 | **totalOpenInterest** | Number | Total open interest for the ticker   17 | **totalVolume** | Number | Total volume for the ticker   18 | **totalPutVolume** | Number | Total put volume for the ticker   19 | **totalCallVolume** | Number | Total call volume for the ticker   20 | **putCallVolumeRatio** | Number | Total put volume to total call volume ratio for the ticker   21 | **contractCount** | Number | Total number of active contracts for the ticker   22 | 23 | [//]: # (END_DEFINITION) 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/OptionsPriceEod.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OptionsPriceEod) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OptionsPriceEod 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **price** | [**OptionPriceEod**](OptionPriceEod.md) |   15 | **option** | [**OptionEod**](OptionEod.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:OptionPriceEod) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:OptionEod) 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/OwnerSummary.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:OwnerSummary) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### OwnerSummary 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **ownerCik** | String | The Central Index Key issued by the SEC, which is the unique identifier all owner filings   15 | **ownerName** | String | The name of the owner   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/RealtimeIndexPrice.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:RealtimeIndexPrice) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### RealtimeIndexPrice 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **lastPrice** | Number | The last price   15 | **lastTime** | Date | The timestamp of the last price   16 | **index** | [**RealtimeIndexPriceIndex**](RealtimeIndexPriceIndex.md) |   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:RealtimeIndexPriceIndex) 22 | 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/RealtimeIndexPriceIndex.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:RealtimeIndexPriceIndex) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### RealtimeIndexPriceIndex 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **symbol** | String | The current ticker of the index   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/RealtimeStockPriceSecurity.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:RealtimeStockPriceSecurity) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### RealtimeStockPriceSecurity 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | The Intrinio ID for Security   15 | **ticker** | String | The common/local ticker of the Security   16 | **exchangeTicker** | String | The exchange-level ticker   17 | **figi** | String | The OpenFIGI identifier   18 | **compositeFigi** | String | The country-composite OpenFIGI identifier   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/RelativeStrengthIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:RelativeStrengthIndexTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### RelativeStrengthIndexTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **rsi** | Number | The Relative Strength Index calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/ReportedFinancial.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ReportedFinancial) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ReportedFinancial 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **xbrlTag** | [**ReportedTag**](ReportedTag.md) |   15 | **value** | Number | The value reported for the XBRL Tag within the scope of the Fundamental   16 | **dimensions** | [**[ReportedFinancialDimension]**](ReportedFinancialDimension.md) | The combination of XBRL axis and members that defines the dimensionalization of this fact (if any)   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:ReportedTag) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:ReportedFinancialDimension) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ReportedFinancialDimension.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ReportedFinancialDimension) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ReportedFinancialDimension 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **axis** | String | The axis of the dimension   15 | **member** | String | The member of the axis   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/ReportedTag.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ReportedTag) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ReportedTag 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **tag** | String | The tag code   15 | **name** | String | The tag name   16 | **balance** | String | Whether the tag represents a credit or debit   17 | **unit** | String | The unit of the tag   18 | **_abstract** | Boolean | If true, the tag is an abstract and does not represent a nominal value   19 | **sequence** | Number | The vertical sequence of the tag when displayed in the financial statement   20 | **depth** | Number | The horizontal depth of the tag when displayed in the financial statement   21 | 22 | [//]: # (END_DEFINITION) 23 | 24 | 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/SICIndex.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:SICIndex) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### SICIndex 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | Intrinio ID for the Index   15 | **symbol** | String | The symbol used to identify the Index   16 | **name** | String | The name of the Index   17 | **continent** | String | The continent of the country of focus for the Index   18 | **country** | String | The country of focus for the Index   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/SecurityHistory.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:SecurityHistory) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### SecurityHistory 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | The Intrinio ID for the Security   15 | **ticker** | String | The common ticker   16 | **name** | String | The name of the Security   17 | **securityCode** | String | A 2-3 digit code classifying the Security (<a href=\"https://docs.intrinio.com/documentation/security_codes\" target=\"_blank\">reference</a>)   18 | **figi** | String | The exchange-level OpenFIGI identifier   19 | **compositeFigi** | String | The country-composite OpenFIGI identifier   20 | **firstPriceDate** | Date | The date of the first recorded stock price   21 | **lastPriceDate** | Date | The date of the last recorded stock price (or the most recent trading day)   22 | 23 | [//]: # (END_DEFINITION) 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/SecurityHistoryListResult.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:SecurityHistoryListResult) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### SecurityHistoryListResult 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **securities** | [**[SecurityHistory]**](SecurityHistory.md) | Array of security ticker history.   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:SecurityHistory) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/SecurityIntervalMover.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:SecurityIntervalMover) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### SecurityIntervalMover 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **symbol** | String | The ticker symbol for the interval   15 | **change** | Number | The ratio of Close minus Open to Open.   16 | **open** | Number | The first traded price in this interval.   17 | **high** | Number | The highest traded price in this interval.   18 | **low** | Number | The lowest traded price in this interval.   19 | **close** | Number | The last traded price in this interval.   20 | **volume** | Number | The volume of shares in this interval.   21 | **average** | Number | The volume weighted average price of trades in this interval.   22 | **tradeCount** | Number | The of trades in this interval.   23 | 24 | [//]: # (END_DEFINITION) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/SecurityIntervalsMoversResult.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:SecurityIntervalsMoversResult) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### SecurityIntervalsMoversResult 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **openTime** | Date | The UTC timestamp for the time this interval opened.   15 | **closeTime** | Date | The UTC timestamp for the time this interval closed.   16 | **size** | String | The size of the time span for the interval.   17 | **intervals** | [**[SecurityIntervalMover]**](SecurityIntervalMover.md) | Array of all the intervals in the result.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:SecurityIntervalMover) 23 | 24 | 25 | 26 |
27 | 28 | #### Enum: SizeEnum** 29 | 30 | Name | Value 31 | ---- | ----- 32 | SixtyMinute | "SixtyMinute" 33 | ThirtyMinute | "ThirtyMinute" 34 | FifteenMinute | "FifteenMinute" 35 | TenMinute | "TenMinute" 36 | FiveMinute | "FiveMinute" 37 | OneMinute | "OneMinute" 38 | 39 | 40 | 41 | -------------------------------------------------------------------------------- /docs/SecurityReplayFileResult.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:SecurityReplayFileResult) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### SecurityReplayFileResult 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **name** | String | The name of the file.   15 | **url** | String | The url where the file may be downloaded.   16 | **size** | Number | The size of the file in bytes.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/SecurityScreenClause.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:SecurityScreenClause) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### SecurityScreenClause 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **field** | String | The field to use when screening, such as an Intrinio Data Tag   15 | **operator** | String | The logic operator to use when screening   16 | **value** | String | The value to screen by   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 |
23 | 24 | #### Enum: OperatorEnum** 25 | 26 | Name | Value 27 | ---- | ----- 28 | eq | "eq" 29 | gt | "gt" 30 | gte | "gte" 31 | lt | "lt" 32 | lte | "lte" 33 | contains | "contains" 34 | 35 | 36 | 37 | -------------------------------------------------------------------------------- /docs/SecurityScreenGroup.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:SecurityScreenGroup) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### SecurityScreenGroup 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **operator** | String | The logic operator for the group (AND, OR, NOT)   15 | **clauses** | [**[SecurityScreenClause]**](SecurityScreenClause.md) | The logic clauses in the group   16 | **groups** | [**[SecurityScreenGroup]**](SecurityScreenGroup.md) | The nested groups within the group   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:SecurityScreenClause) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:SecurityScreenGroup) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/SecurityScreenResult.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:SecurityScreenResult) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### SecurityScreenResult 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **security** | [**SecuritySummary**](SecuritySummary.md) |   15 | **data** | [**[SecurityScreenResultData]**](SecurityScreenResultData.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:SecuritySummary) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:SecurityScreenResultData) 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/SecurityScreenResultData.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:SecurityScreenResultData) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### SecurityScreenResultData 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **tag** | String | The data tag that was screened-for   15 | **numberValue** | String | The numeric value for the tag   16 | **textValue** | String | The text value for the tag   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/SecuritySnapshotGroup.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:SecuritySnapshotGroup) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### SecuritySnapshotGroup 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **time** | Date | The UTC timestamp of this snapshot group.   15 | **files** | [Object] | List of all the snapshot parts of this group.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/SecuritySnapshotsResult.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:SecuritySnapshotsResult) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### SecuritySnapshotsResult 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **snapshots** | [**[SecuritySnapshotGroup]**](SecuritySnapshotGroup.md) | List of all the snapshot groups comprising the queried result.   15 | 16 | [//]: # (END_DEFINITION) 17 | 18 | 19 | [//]: # (CONTAINED_CLASS:SecuritySnapshotGroup) 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/SecurityTrades.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:SecurityTrades) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### SecurityTrades 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **symbol** | String | The ticker symbol   15 | **timestamp** | Date | The UTC timestamp at the time of the trade.   16 | **price** | Number | The price of the trade.   17 | **size** | Number | The size of the trade.   18 | **totalVolume** | Number | The total volume of the symbol for the day up to the timestamp point in time.   19 | **marketCenter** | String | The market center for the trade.   20 | **condition** | String | The condition of the trade.   21 | **isDarkpool** | Boolean | If the trade was darkpool or not.   22 | 23 | [//]: # (END_DEFINITION) 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/SecurityTradesResult.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:SecurityTradesResult) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### SecurityTradesResult 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **nextPage** | String | The token required to request the next page of the data. If null, no further results are available.   15 | **source** | String | The source of the trades.   16 | **trades** | [**[SecurityTrades]**](SecurityTrades.md) | Array of all the trades in this page of the result.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:SecurityTrades) 22 | 23 | 24 | 25 |
26 | 27 | #### Enum: SourceEnum** 28 | 29 | Name | Value 30 | ---- | ----- 31 | iex | "iex" 32 | delayed_sip | "delayed_sip" 33 | utp_delayed | "utp_delayed" 34 | cta_a_delayed | "cta_a_delayed" 35 | cta_b_delayed | "cta_b_delayed" 36 | otc_delayed | "otc_delayed" 37 | nasdaq_basic | "nasdaq_basic" 38 | 39 | 40 | 41 | -------------------------------------------------------------------------------- /docs/SimpleMovingAverageTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:SimpleMovingAverageTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### SimpleMovingAverageTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **sma** | Number | The Simple Moving Average calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/StandardizedFinancial.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:StandardizedFinancial) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### StandardizedFinancial 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dataTag** | [**DataTagSummary**](DataTagSummary.md) |   15 | **value** | Number | The value for the Data Tag within the scope of the Fundamental   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:DataTagSummary) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/StandardizedFinancialsDimension.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:StandardizedFinancialsDimension) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### StandardizedFinancialsDimension 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dimension** | String | The title of the dimension   15 | **value** | String | The value of the dimension   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/StochasticOscillatorTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:StochasticOscillatorTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### StochasticOscillatorTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **sr** | Number | The Stochastic Oscillator calculation value   16 | **srSignal** | Number | The Stochastic Oscillator signal line value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/StockExchange.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:StockExchange) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### StockExchange 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | The Intrinio ID for the Stock Exchange   15 | **name** | String | The name of the exchange   16 | **mic** | String | The Market Identifier Code (MIC) of the exchange   17 | **acronym** | String | The acronym of the exchange's name   18 | **city** | String | The city in which the exchange is located   19 | **country** | String | The country in which the exchange is located   20 | **countryCode** | String | The 2-digit code of the exchange's country   21 | **website** | String | The website of the exchange   22 | **firstStockPriceDate** | Date | The earliest date for which Intrinio has stock prices for the exchange   23 | **lastStockPriceDate** | Date | The latest date for which Intrinio has stock prices for the exchange   24 | 25 | [//]: # (END_DEFINITION) 26 | 27 | 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/StockExchangeMover.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:StockExchangeMover) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### StockExchangeMover 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **securityId** | String | The Intrinio Identifier for this security.   15 | **ticker** | String | The ticker symbol for this security.   16 | **lastPrice** | Number | The last price of the last trade.   17 | **change** | Number | The raw change in price.   18 | **percentChange** | Number | The percent change in price.   19 | **marketVolume** | Number | The market volume for the most recent (today) trading day.   20 | **source** | String | The source of the data.   21 | 22 | [//]: # (END_DEFINITION) 23 | 24 | 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/StockMarketIndex.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:StockMarketIndex) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### StockMarketIndex 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | Intrinio ID for the Index   15 | **symbol** | String | The symbol used to identify the Index   16 | **name** | String | The name of the Index   17 | **continent** | String | The continent of the country of focus for the Index   18 | **country** | String | The country of focus for the Index   19 | **updateFrequency** | String | How often the Index is updated   20 | **lastUpdated** | Date | When the Index was updated last   21 | **description** | String | A paragraph describing the index and its scope   22 | **observationStart** | Date | The earliest date for which data is available   23 | **observationEnd** | Date | The latest date for which data is available   24 | 25 | [//]: # (END_DEFINITION) 26 | 27 | 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/StockMarketIndexSummary.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:StockMarketIndexSummary) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### StockMarketIndexSummary 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | Intrinio ID for the Index   15 | **symbol** | String | The symbol used to identify the Index   16 | **name** | String | The name of the Index   17 | **continent** | String | The continent of the country of focus for the Index   18 | **country** | String | The country of focus for the Index   19 | **updateFrequency** | String | How often the Index is updated   20 | **lastUpdated** | Date | When the Index was updated last   21 | **observationStart** | Date | The earliest date for which data is available   22 | **observationEnd** | Date | The latest date for which data is available   23 | 24 | [//]: # (END_DEFINITION) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/StockPriceAdjustment.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:StockPriceAdjustment) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### StockPriceAdjustment 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **date** | Date | The date on which the adjustment occurred. The adjustment should be applied to all stock prices before this date.   15 | **factor** | Number | The factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.   16 | **dividend** | Number | The dividend amount, if a dividend was paid.   17 | **dividendCurrency** | String | The currency of the dividend, if known.   18 | **splitRatio** | Number | The ratio of the stock split, if a stock split occurred.   19 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the stock price   20 | 21 | [//]: # (END_DEFINITION) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:SecuritySummary) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/StockPriceAdjustmentSummary.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:StockPriceAdjustmentSummary) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### StockPriceAdjustmentSummary 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **date** | Date | The date on which the adjustment occurred. The adjustment should be applied to all stock prices before this date.   15 | **factor** | Number | The factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.   16 | **dividend** | Number | The dividend amount, if a dividend was paid.   17 | **dividendCurrency** | String | The currency of the dividend, if known.   18 | **splitRatio** | Number | The ratio of the stock split, if a stock split occurred.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/TechnicalIndicator.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:TechnicalIndicator) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### TechnicalIndicator 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **name** | String | The name of the Technical Indicator   15 | **symbol** | String | The symbol of the Technical Indicator   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/TheaEntityAnswer.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:TheaEntityAnswer) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### TheaEntityAnswer 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **answer** | String | The summarized answer returned from Thea   15 | **content** | String | The underlying content the answer was sourced from   16 | **sourceDocuments** | [**[TheaSourceDocument]**](TheaSourceDocument.md) | The documents from which Thea answer data is sourced   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:TheaSourceDocument) 22 | 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/TheaSourceDocument.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:TheaSourceDocument) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### TheaSourceDocument 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | The unique id for the Thea source document   15 | **dateTime** | Date | The date at which the document was created   16 | **tags** | [Object] | Entity identifying tags associated with the source document   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/TripleExponentialAverageTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:TripleExponentialAverageTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### TripleExponentialAverageTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **trix** | Number | The Triple Exponential Average calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/TrueStrengthIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:TrueStrengthIndexTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### TrueStrengthIndexTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **tsi** | Number | The True Strength Index calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/UltimateOscillatorTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:UltimateOscillatorTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### UltimateOscillatorTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **uo** | Number | The Ultimate Oscillator calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/VolumePriceTrendTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:VolumePriceTrendTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### VolumePriceTrendTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **vpt** | Number | The Volume-price Trend calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/VolumeWeightedAveragePriceValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:VolumeWeightedAveragePriceValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### VolumeWeightedAveragePriceValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date and time of the observation   15 | **vwap** | Number | The Volume Weighted Average Price calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/VortexIndicatorTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:VortexIndicatorTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### VortexIndicatorTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **negativeVi** | Number | The negative Vortex Indicator value   16 | **positiveVi** | Number | The positive Vortex Indicator value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/WilliamsRTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:WilliamsRTechnicalValue) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### WilliamsRTechnicalValue 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **dateTime** | Date | The date_time of the observation   15 | **wr** | Number | The Willaims %R calculation value   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/ZacksAnalystRating.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ZacksAnalystRating) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ZacksAnalystRating 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | The Intrinio ID for the record   15 | **date** | Date | The date of the Zacks Analyst Rating.   16 | **mean** | Number | The mean (average) weighing of analyst recommendations, from 1 (strong buy) to 5 (strong sell).   17 | **strongBuys** | Number | The number of analysts recommending Strong Buy.   18 | **buys** | Number | The number of analysts recommending Buy.   19 | **holds** | Number | The number of analysts recommending Hold.   20 | **sells** | Number | The number of analysts recommending Sell.   21 | **strongSells** | Number | The number of analysts recommending Strong Sell.   22 | **total** | Number | The total number of analyst recommendations.   23 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Zacks Analyst Rating   24 | 25 | [//]: # (END_DEFINITION) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:SecuritySummary) 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ZacksAnalystRatingSummary.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ZacksAnalystRatingSummary) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ZacksAnalystRatingSummary 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **id** | String | The Intrinio ID for the record   15 | **date** | Date | The date of the Zacks Analyst Rating.   16 | **mean** | Number | The mean (average) weighing of analyst recommendations, from 1 (strong buy) to 5 (strong sell).   17 | **strongBuys** | Number | The number of analysts recommending Strong Buy.   18 | **buys** | Number | The number of analysts recommending Buy.   19 | **holds** | Number | The number of analysts recommending Hold.   20 | **sells** | Number | The number of analysts recommending Sell.   21 | **strongSells** | Number | The number of analysts recommending Strong Sell.   22 | **total** | Number | The total number of analyst recommendations.   23 | 24 | [//]: # (END_DEFINITION) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ZacksEBITDAConsensus.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ZacksEBITDAConsensus) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ZacksEBITDAConsensus 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **ticker** | String | The Zacks common exchange ticker   15 | **companyName** | String | The company name   16 | **estimateYear** | Number | Fiscal year of the estimate   17 | **estimateMonth** | Number | Fiscal month of the estimate   18 | **period** | String | Whether the estimate year and month are fiscal year (fy) or quarter (fq)   19 | **consensusType** | String | The type of estimate (ebitda, ebitda, ebit, enterprise_value, cash_flow_per_share, pretax_income)   20 | **estimateCount** | Number | The number of estimates   21 | **high** | Number | The highest estimate   22 | **low** | Number | The lowest estimate   23 | **mean** | Number | The mean value of all estimates   24 | **stdDev** | Number | The standard deviation of all estimates   25 | 26 | [//]: # (END_DEFINITION) 27 | 28 | 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/ZacksETFHolding.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ZacksETFHolding) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ZacksETFHolding 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **etfTicker** | String | The ETF's common ticker   15 | **etfName** | String | The ETF's name   16 | **holdingSymbol** | String | The holding's common ticker   17 | **holdingName** | String | The holding's name   18 | **dateOfHolding** | Date | The date of the holding   19 | **shares** | Number | The number of shares   20 | **weight** | Number | The weight of the holding   21 | 22 | [//]: # (END_DEFINITION) 23 | 24 | 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/ZacksForwardPE.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ZacksForwardPE) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ZacksForwardPE 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **ticker** | String | The Zacks common exchange ticker   15 | **companyName** | String | The company name   16 | **forwardPeYear1** | Number | The forward PE estimate for the first year   17 | **forwardPeYear2** | Number | The forward PE estimate for the second year   18 | **forwardPeYear3** | Number | The forward PE estimate for the third year   19 | **forwardPeYear4** | Number | The forward PE estimate for the fourth year   20 | **forwardPeYear5** | Number | The forward PE estimate for the fifth year   21 | **forwardPegRatioYear1** | Number | The forward PEG ratio for the first year   22 | **lastTtmEps** | Number | Trailing twelve months earnings per share   23 | 24 | [//]: # (END_DEFINITION) 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ZacksInstitutionalHoldingCompanySummary.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ZacksInstitutionalHoldingCompanySummary) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ZacksInstitutionalHoldingCompanySummary 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **ticker** | String | The Zacks common exchange ticker   15 | **name** | String | The company name of the stock listed   16 | **exchange** | String | Exhange where the stock is traded whose shares are held by the institution   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ZacksInstitutionalHoldingHistoricalSummary.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ZacksInstitutionalHoldingHistoricalSummary) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ZacksInstitutionalHoldingHistoricalSummary 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **asOfDate** | Date | The date of the institutional holding   15 | **sharesHeld** | Number | The number of shares held   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/ZacksInstitutionalHoldingOwnerSummary.md: -------------------------------------------------------------------------------- 1 | 2 | [//]: # (CLASS:ZacksInstitutionalHoldingOwnerSummary) 3 | 4 | [//]: # (KIND:object) 5 | 6 | ### ZacksInstitutionalHoldingOwnerSummary 7 | 8 | #### Properties 9 | 10 | [//]: # (START_DEFINITION) 11 | 12 | Name | Type | Description 13 | ------------ | ------------- | ------------- 14 | **name** | String | The owner's name   15 | **cik** | String | The Central Index Key (CIK) assigned to the company by the SEC as a unique identifier, used in SEC filings   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /mocha.opts: -------------------------------------------------------------------------------- 1 | --timeout 10000 2 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "intrinio-sdk", 3 | "version": "6.38.0", 4 | "description": "Access the Intrinio API", 5 | "license": "GPLv3", 6 | "main": "src/index.js", 7 | "scripts": { 8 | "test": "./node_modules/mocha/bin/mocha --recursive" 9 | }, 10 | "browser": { 11 | "fs": false 12 | }, 13 | "dependencies": { 14 | "async-retry": "^1.3.1", 15 | "superagent": "3.7.0" 16 | }, 17 | "devDependencies": { 18 | "mocha": "~2.3.4", 19 | "sinon": "1.17.3", 20 | "expect.js": "~0.3.1" 21 | } 22 | } 23 | --------------------------------------------------------------------------------