├── .github └── workflows │ ├── pr.yml │ └── python-publish.yml ├── .gitignore ├── .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 ├── intrinio_sdk ├── __init__.py ├── api │ ├── __init__.py │ ├── bulk_downloads_api.py │ ├── company_api.py │ ├── data_point_api.py │ ├── data_tag_api.py │ ├── esg_api.py │ ├── et_fs_api.py │ ├── filing_api.py │ ├── forex_api.py │ ├── fundamentals_api.py │ ├── historical_data_api.py │ ├── index_api.py │ ├── insider_transaction_filings_api.py │ ├── market_api.py │ ├── municipality_api.py │ ├── options_api.py │ ├── owners_api.py │ ├── security_api.py │ ├── stock_exchange_api.py │ ├── technical_api.py │ └── zacks_api.py ├── api_client.py ├── configuration.py ├── models │ ├── __init__.py │ ├── accumulation_distribution_index_technical_value.py │ ├── api_response_bulk_download_links.py │ ├── api_response_companies.py │ ├── api_response_companies_search.py │ ├── api_response_company_answers.py │ ├── api_response_company_daily_metrics.py │ ├── api_response_company_filings.py │ ├── api_response_company_fundamentals.py │ ├── api_response_company_historical_data.py │ ├── api_response_company_insider_transaction_filings.py │ ├── api_response_company_news.py │ ├── api_response_company_news_body.py │ ├── api_response_company_public_float_result.py │ ├── api_response_company_recognize.py │ ├── api_response_company_securities.py │ ├── api_response_company_shares_outstanding.py │ ├── api_response_data_tags.py │ ├── api_response_data_tags_search.py │ ├── api_response_economic_index_historical_data.py │ ├── api_response_economic_indices.py │ ├── api_response_economic_indices_search.py │ ├── api_response_eod_index_prices.py │ ├── api_response_eod_index_prices_all.py │ ├── api_response_esg_companies.py │ ├── api_response_esg_company_comprehensive_rating_history.py │ ├── api_response_esg_company_rating_history.py │ ├── api_response_esg_latest.py │ ├── api_response_esg_latest_comprehensive.py │ ├── api_response_et_fs.py │ ├── api_response_etf_holdings.py │ ├── api_response_filing_answers.py │ ├── api_response_filing_fundamentals.py │ ├── api_response_filing_notes.py │ ├── api_response_filing_notes_search.py │ ├── api_response_filings.py │ ├── api_response_forex_currencies.py │ ├── api_response_forex_pairs.py │ ├── api_response_forex_prices.py │ ├── api_response_historical_data.py │ ├── api_response_index.py │ ├── api_response_index_constituents.py │ ├── api_response_index_intervals.py │ ├── api_response_indices.py │ ├── api_response_initial_public_offerings.py │ ├── api_response_insider_transaction_filings.py │ ├── api_response_municipalities.py │ ├── api_response_municipalitiy_financials.py │ ├── api_response_news.py │ ├── api_response_option_prices.py │ ├── api_response_options.py │ ├── api_response_options_aggregates.py │ ├── api_response_options_chain.py │ ├── api_response_options_chain_eod.py │ ├── api_response_options_chain_realtime.py │ ├── api_response_options_expirations.py │ ├── api_response_options_greek_contract_realtime.py │ ├── api_response_options_greeks_by_ticker_realtime.py │ ├── api_response_options_implied_move.py │ ├── api_response_options_price_realtime.py │ ├── api_response_options_prices_batch_realtime.py │ ├── api_response_options_prices_by_ticker_eod.py │ ├── api_response_options_prices_by_ticker_realtime.py │ ├── api_response_options_prices_eod.py │ ├── api_response_options_realtime.py │ ├── api_response_options_stats_realtime.py │ ├── api_response_options_tickers.py │ ├── api_response_options_unusual_activity.py │ ├── api_response_owner_insider_transaction_filings.py │ ├── api_response_owner_institutional_holdings.py │ ├── api_response_owners.py │ ├── api_response_realtime_index_prices.py │ ├── api_response_reported_financials.py │ ├── api_response_securities.py │ ├── api_response_securities_search.py │ ├── api_response_security_accumulation_distribution_index.py │ ├── api_response_security_average_daily_trading_volume.py │ ├── api_response_security_average_directional_index.py │ ├── api_response_security_average_true_range.py │ ├── api_response_security_awesome_oscillator.py │ ├── api_response_security_bollinger_bands.py │ ├── api_response_security_chaikin_money_flow.py │ ├── api_response_security_commodity_channel_index.py │ ├── api_response_security_detrended_price_oscillator.py │ ├── api_response_security_donchian_channel.py │ ├── api_response_security_ease_of_movement.py │ ├── api_response_security_force_index.py │ ├── api_response_security_historical_data.py │ ├── api_response_security_ichimoku_kinko_hyo.py │ ├── api_response_security_institutional_ownership.py │ ├── api_response_security_interval_prices.py │ ├── api_response_security_keltner_channel.py │ ├── api_response_security_know_sure_thing.py │ ├── api_response_security_mass_index.py │ ├── api_response_security_money_flow_index.py │ ├── api_response_security_moving_average_convergence_divergence.py │ ├── api_response_security_negative_volume_index.py │ ├── api_response_security_on_balance_volume.py │ ├── api_response_security_on_balance_volume_mean.py │ ├── api_response_security_quote.py │ ├── api_response_security_relative_strength_index.py │ ├── api_response_security_simple_moving_average.py │ ├── api_response_security_stochastic_oscillator.py │ ├── api_response_security_stock_price_adjustments.py │ ├── api_response_security_stock_prices.py │ ├── api_response_security_triple_exponential_average.py │ ├── api_response_security_true_strength_index.py │ ├── api_response_security_ultimate_oscillator.py │ ├── api_response_security_volume_price_trend.py │ ├── api_response_security_volume_weighted_average_price.py │ ├── api_response_security_vortex_indicator.py │ ├── api_response_security_williams_r.py │ ├── api_response_security_zacks_analyst_ratings.py │ ├── api_response_security_zacks_analyst_ratings_snapshot.py │ ├── api_response_security_zacks_eps_surprises.py │ ├── api_response_security_zacks_sales_surprises.py │ ├── api_response_sic_index_historical_data.py │ ├── api_response_sic_indices.py │ ├── api_response_sic_indices_search.py │ ├── api_response_standardized_financials.py │ ├── api_response_standardized_financials_dimensions.py │ ├── api_response_stock_exchange_betas.py │ ├── api_response_stock_exchange_movers.py │ ├── api_response_stock_exchange_quote.py │ ├── api_response_stock_exchange_realtime_stock_prices.py │ ├── api_response_stock_exchange_securities.py │ ├── api_response_stock_exchange_stock_price_adjustments.py │ ├── api_response_stock_exchange_stock_prices.py │ ├── api_response_stock_exchanges.py │ ├── api_response_stock_market_index_historical_data.py │ ├── api_response_stock_market_indices.py │ ├── api_response_stock_market_indices_search.py │ ├── api_response_zacks_analyst_ratings.py │ ├── api_response_zacks_ebitda_consensus.py │ ├── api_response_zacks_eps_estimates.py │ ├── api_response_zacks_eps_growth_rates.py │ ├── api_response_zacks_eps_surprises.py │ ├── api_response_zacks_etf_holdings.py │ ├── api_response_zacks_forward_p_es.py │ ├── api_response_zacks_institutional_holding_companies.py │ ├── api_response_zacks_institutional_holding_owners.py │ ├── api_response_zacks_institutional_holdings.py │ ├── api_response_zacks_long_term_growth_rates.py │ ├── api_response_zacks_sales_estimates.py │ ├── api_response_zacks_sales_surprises.py │ ├── api_response_zacks_target_price_consensuses.py │ ├── average_daily_trading_volume_technical_value.py │ ├── average_directional_index_technical_value.py │ ├── average_true_range_technical_value.py │ ├── awesome_oscillator_technical_value.py │ ├── beta.py │ ├── bollinger_bands_technical_value.py │ ├── bulk_download_links.py │ ├── bulk_download_summary.py │ ├── chaikin_money_flow_technical_value.py │ ├── commodity_channel_index_technical_value.py │ ├── company.py │ ├── company_daily_metric.py │ ├── company_filing.py │ ├── company_initial_public_offering.py │ ├── company_news.py │ ├── company_news_summary.py │ ├── company_public_float.py │ ├── company_shares_outstanding.py │ ├── company_summary.py │ ├── data_tag.py │ ├── data_tag_summary.py │ ├── detrended_price_oscillator_technical_value.py │ ├── dividend_record.py │ ├── donchian_channel_technical_value.py │ ├── earnings_record.py │ ├── ease_of_movement_technical_value.py │ ├── economic_index.py │ ├── economic_index_summary.py │ ├── eod_index_price.py │ ├── eod_index_price_summary.py │ ├── esg_company_summary.py │ ├── esg_comprehensive_rating.py │ ├── esg_comprehensive_rating_with_company.py │ ├── esg_rating.py │ ├── esg_rating_with_company.py │ ├── etf.py │ ├── etf_analytics.py │ ├── etf_holding.py │ ├── etf_stats.py │ ├── etf_summary.py │ ├── filing.py │ ├── filing_note.py │ ├── filing_note_filing.py │ ├── filing_note_summary.py │ ├── filing_summary.py │ ├── force_index_technical_value.py │ ├── forex_currency.py │ ├── forex_pair.py │ ├── forex_price.py │ ├── fundamental.py │ ├── fundamental_summary.py │ ├── historical_data.py │ ├── ichimoku_kinko_hyo_technical_value.py │ ├── index_interval.py │ ├── insider_transaction.py │ ├── insider_transaction_filing.py │ ├── institutional_holding.py │ ├── institutional_ownership.py │ ├── keltner_channel_technical_value.py │ ├── know_sure_thing_technical_value.py │ ├── market_status_result.py │ ├── mass_index_technical_value.py │ ├── money_flow_index_technical_value.py │ ├── moving_average_convergence_divergence_technical_value.py │ ├── municipality.py │ ├── municipality_financial.py │ ├── negative_volume_index_technical_value.py │ ├── news_topic.py │ ├── on_balance_volume_mean_technical_value.py │ ├── on_balance_volume_technical_value.py │ ├── option.py │ ├── option_chain.py │ ├── option_chain_eod.py │ ├── option_chain_realtime.py │ ├── option_contracts_list.py │ ├── option_eod.py │ ├── option_factors_realtime.py │ ├── option_implied_move_data.py │ ├── option_interval.py │ ├── option_interval_mover.py │ ├── option_intervals_movers_result.py │ ├── option_intervals_result.py │ ├── option_price.py │ ├── option_price_batch_realtime.py │ ├── option_price_eod.py │ ├── option_price_realtime.py │ ├── option_price_realtime_extended.py │ ├── option_realtime.py │ ├── option_snapshot_group.py │ ├── option_snapshots_result.py │ ├── option_stats_realtime.py │ ├── option_synthetic_greeks_realtime.py │ ├── option_trades.py │ ├── option_trades_result.py │ ├── option_unusual_trade.py │ ├── options_aggregate.py │ ├── options_price_eod.py │ ├── owner.py │ ├── owner_summary.py │ ├── realtime_index_price.py │ ├── realtime_index_price_index.py │ ├── realtime_stock_price.py │ ├── realtime_stock_price_security.py │ ├── relative_strength_index_technical_value.py │ ├── reported_financial.py │ ├── reported_financial_dimension.py │ ├── reported_tag.py │ ├── security.py │ ├── security_history.py │ ├── security_history_list_result.py │ ├── security_interval_mover.py │ ├── security_intervals_movers_result.py │ ├── security_replay_file_result.py │ ├── security_screen_clause.py │ ├── security_screen_group.py │ ├── security_screen_group.py-- │ ├── security_screen_result.py │ ├── security_screen_result_data.py │ ├── security_snapshot_group.py │ ├── security_snapshots_result.py │ ├── security_summary.py │ ├── security_trades.py │ ├── security_trades_result.py │ ├── sic_index.py │ ├── simple_moving_average_technical_value.py │ ├── standardized_financial.py │ ├── standardized_financials_dimension.py │ ├── stochastic_oscillator_technical_value.py │ ├── stock_exchange.py │ ├── stock_exchange_mover.py │ ├── stock_market_index.py │ ├── stock_market_index_summary.py │ ├── stock_price.py │ ├── stock_price_adjustment.py │ ├── stock_price_adjustment_summary.py │ ├── stock_price_interval.py │ ├── stock_price_summary.py │ ├── technical_indicator.py │ ├── thea_entity_answer.py │ ├── thea_source_document.py │ ├── triple_exponential_average_technical_value.py │ ├── true_strength_index_technical_value.py │ ├── ultimate_oscillator_technical_value.py │ ├── volume_price_trend_technical_value.py │ ├── volume_weighted_average_price_value.py │ ├── vortex_indicator_technical_value.py │ ├── williams_r_technical_value.py │ ├── zacks_analyst_rating.py │ ├── zacks_analyst_rating_snapshot.py │ ├── zacks_analyst_rating_summary.py │ ├── zacks_ebitda_consensus.py │ ├── zacks_eps_estimate.py │ ├── zacks_eps_growth_rate.py │ ├── zacks_eps_surprise.py │ ├── zacks_eps_surprise_summary.py │ ├── zacks_etf_holding.py │ ├── zacks_forward_pe.py │ ├── zacks_institutional_holding.py │ ├── zacks_institutional_holding_company_detail.py │ ├── zacks_institutional_holding_company_summary.py │ ├── zacks_institutional_holding_historical_summary.py │ ├── zacks_institutional_holding_owner_detail.py │ ├── zacks_institutional_holding_owner_summary.py │ ├── zacks_long_term_growth_rate.py │ ├── zacks_sales_estimate.py │ ├── zacks_sales_surprise.py │ ├── zacks_sales_surprise_summary.py │ └── zacks_target_price_consensus.py └── rest.py ├── requirements.txt ├── setup.py ├── test-requirements.txt ├── test ├── __init__.py ├── test_accumulation_distribution_index_technical_value.py ├── test_api_response_bulk_download_links.py ├── test_api_response_companies.py ├── test_api_response_companies_search.py ├── test_api_response_company_answers.py ├── test_api_response_company_daily_metrics.py ├── test_api_response_company_filings.py ├── test_api_response_company_fundamentals.py ├── test_api_response_company_historical_data.py ├── test_api_response_company_insider_transaction_filings.py ├── test_api_response_company_news.py ├── test_api_response_company_news_body.py ├── test_api_response_company_public_float_result.py ├── test_api_response_company_recognize.py ├── test_api_response_company_securities.py ├── test_api_response_company_shares_outstanding.py ├── test_api_response_data_tags.py ├── test_api_response_data_tags_search.py ├── test_api_response_economic_index_historical_data.py ├── test_api_response_economic_indices.py ├── test_api_response_economic_indices_search.py ├── test_api_response_eod_index_prices.py ├── test_api_response_eod_index_prices_all.py ├── test_api_response_esg_companies.py ├── test_api_response_esg_company_comprehensive_rating_history.py ├── test_api_response_esg_company_rating_history.py ├── test_api_response_esg_latest.py ├── test_api_response_esg_latest_comprehensive.py ├── test_api_response_et_fs.py ├── test_api_response_etf_holdings.py ├── test_api_response_filing_answers.py ├── test_api_response_filing_fundamentals.py ├── test_api_response_filing_notes.py ├── test_api_response_filing_notes_search.py ├── test_api_response_filings.py ├── test_api_response_forex_currencies.py ├── test_api_response_forex_pairs.py ├── test_api_response_forex_prices.py ├── test_api_response_historical_data.py ├── test_api_response_index.py ├── test_api_response_index_constituents.py ├── test_api_response_index_intervals.py ├── test_api_response_indices.py ├── test_api_response_initial_public_offerings.py ├── test_api_response_insider_transaction_filings.py ├── test_api_response_municipalities.py ├── test_api_response_municipalitiy_financials.py ├── test_api_response_news.py ├── test_api_response_option_prices.py ├── test_api_response_options.py ├── test_api_response_options_aggregates.py ├── test_api_response_options_chain.py ├── test_api_response_options_chain_eod.py ├── test_api_response_options_chain_realtime.py ├── test_api_response_options_expirations.py ├── test_api_response_options_greek_contract_realtime.py ├── test_api_response_options_greeks_by_ticker_realtime.py ├── test_api_response_options_implied_move.py ├── test_api_response_options_price_realtime.py ├── test_api_response_options_prices_batch_realtime.py ├── test_api_response_options_prices_by_ticker_eod.py ├── test_api_response_options_prices_by_ticker_realtime.py ├── test_api_response_options_prices_eod.py ├── test_api_response_options_realtime.py ├── test_api_response_options_stats_realtime.py ├── test_api_response_options_tickers.py ├── test_api_response_options_unusual_activity.py ├── test_api_response_owner_insider_transaction_filings.py ├── test_api_response_owner_institutional_holdings.py ├── test_api_response_owners.py ├── test_api_response_realtime_index_prices.py ├── test_api_response_reported_financials.py ├── test_api_response_securities.py ├── test_api_response_securities_search.py ├── test_api_response_security_accumulation_distribution_index.py ├── test_api_response_security_average_daily_trading_volume.py ├── test_api_response_security_average_directional_index.py ├── test_api_response_security_average_true_range.py ├── test_api_response_security_awesome_oscillator.py ├── test_api_response_security_bollinger_bands.py ├── test_api_response_security_chaikin_money_flow.py ├── test_api_response_security_commodity_channel_index.py ├── test_api_response_security_detrended_price_oscillator.py ├── test_api_response_security_donchian_channel.py ├── test_api_response_security_ease_of_movement.py ├── test_api_response_security_force_index.py ├── test_api_response_security_historical_data.py ├── test_api_response_security_ichimoku_kinko_hyo.py ├── test_api_response_security_institutional_ownership.py ├── test_api_response_security_interval_prices.py ├── test_api_response_security_keltner_channel.py ├── test_api_response_security_know_sure_thing.py ├── test_api_response_security_mass_index.py ├── test_api_response_security_money_flow_index.py ├── test_api_response_security_moving_average_convergence_divergence.py ├── test_api_response_security_negative_volume_index.py ├── test_api_response_security_on_balance_volume.py ├── test_api_response_security_on_balance_volume_mean.py ├── test_api_response_security_quote.py ├── test_api_response_security_relative_strength_index.py ├── test_api_response_security_simple_moving_average.py ├── test_api_response_security_stochastic_oscillator.py ├── test_api_response_security_stock_price_adjustments.py ├── test_api_response_security_stock_prices.py ├── test_api_response_security_triple_exponential_average.py ├── test_api_response_security_true_strength_index.py ├── test_api_response_security_ultimate_oscillator.py ├── test_api_response_security_volume_price_trend.py ├── test_api_response_security_volume_weighted_average_price.py ├── test_api_response_security_vortex_indicator.py ├── test_api_response_security_williams_r.py ├── test_api_response_security_zacks_analyst_ratings.py ├── test_api_response_security_zacks_analyst_ratings_snapshot.py ├── test_api_response_security_zacks_eps_surprises.py ├── test_api_response_security_zacks_sales_surprises.py ├── test_api_response_sic_index_historical_data.py ├── test_api_response_sic_indices.py ├── test_api_response_sic_indices_search.py ├── test_api_response_standardized_financials.py ├── test_api_response_standardized_financials_dimensions.py ├── test_api_response_stock_exchange_betas.py ├── test_api_response_stock_exchange_movers.py ├── test_api_response_stock_exchange_quote.py ├── test_api_response_stock_exchange_realtime_stock_prices.py ├── test_api_response_stock_exchange_securities.py ├── test_api_response_stock_exchange_stock_price_adjustments.py ├── test_api_response_stock_exchange_stock_prices.py ├── test_api_response_stock_exchanges.py ├── test_api_response_stock_market_index_historical_data.py ├── test_api_response_stock_market_indices.py ├── test_api_response_stock_market_indices_search.py ├── test_api_response_zacks_analyst_ratings.py ├── test_api_response_zacks_ebitda_consensus.py ├── test_api_response_zacks_eps_estimates.py ├── test_api_response_zacks_eps_growth_rates.py ├── test_api_response_zacks_eps_surprises.py ├── test_api_response_zacks_etf_holdings.py ├── test_api_response_zacks_forward_p_es.py ├── test_api_response_zacks_institutional_holding_companies.py ├── test_api_response_zacks_institutional_holding_owners.py ├── test_api_response_zacks_institutional_holdings.py ├── test_api_response_zacks_long_term_growth_rates.py ├── test_api_response_zacks_sales_estimates.py ├── test_api_response_zacks_sales_surprises.py ├── test_api_response_zacks_target_price_consensuses.py ├── test_average_daily_trading_volume_technical_value.py ├── test_average_directional_index_technical_value.py ├── test_average_true_range_technical_value.py ├── test_awesome_oscillator_technical_value.py ├── test_beta.py ├── test_bollinger_bands_technical_value.py ├── test_bulk_download_links.py ├── test_bulk_download_summary.py ├── test_bulk_downloads_api.py ├── test_chaikin_money_flow_technical_value.py ├── test_commodity_channel_index_technical_value.py ├── test_company.py ├── test_company_api.py ├── test_company_daily_metric.py ├── test_company_filing.py ├── test_company_initial_public_offering.py ├── test_company_news.py ├── test_company_news_summary.py ├── test_company_public_float.py ├── test_company_shares_outstanding.py ├── test_company_summary.py ├── test_data_point_api.py ├── test_data_tag.py ├── test_data_tag_api.py ├── test_data_tag_summary.py ├── test_detrended_price_oscillator_technical_value.py ├── test_dividend_record.py ├── test_donchian_channel_technical_value.py ├── test_earnings_record.py ├── test_ease_of_movement_technical_value.py ├── test_economic_index.py ├── test_economic_index_summary.py ├── test_eod_index_price.py ├── test_eod_index_price_summary.py ├── test_esg_api.py ├── test_esg_company_summary.py ├── test_esg_comprehensive_rating.py ├── test_esg_comprehensive_rating_with_company.py ├── test_esg_rating.py ├── test_esg_rating_with_company.py ├── test_et_fs_api.py ├── test_etf.py ├── test_etf_analytics.py ├── test_etf_holding.py ├── test_etf_stats.py ├── test_etf_summary.py ├── test_filing.py ├── test_filing_api.py ├── test_filing_note.py ├── test_filing_note_filing.py ├── test_filing_note_summary.py ├── test_filing_summary.py ├── test_force_index_technical_value.py ├── test_forex_api.py ├── test_forex_currency.py ├── test_forex_pair.py ├── test_forex_price.py ├── test_fundamental.py ├── test_fundamental_summary.py ├── test_fundamentals_api.py ├── test_historical_data.py ├── test_historical_data_api.py ├── test_ichimoku_kinko_hyo_technical_value.py ├── test_index_api.py ├── test_index_interval.py ├── test_insider_transaction.py ├── test_insider_transaction_filing.py ├── test_insider_transaction_filings_api.py ├── test_institutional_holding.py ├── test_institutional_ownership.py ├── test_keltner_channel_technical_value.py ├── test_know_sure_thing_technical_value.py ├── test_market_api.py ├── test_market_status_result.py ├── test_mass_index_technical_value.py ├── test_money_flow_index_technical_value.py ├── test_moving_average_convergence_divergence_technical_value.py ├── test_municipality.py ├── test_municipality_api.py ├── test_municipality_financial.py ├── test_negative_volume_index_technical_value.py ├── test_news_topic.py ├── test_on_balance_volume_mean_technical_value.py ├── test_on_balance_volume_technical_value.py ├── test_option.py ├── test_option_chain.py ├── test_option_chain_eod.py ├── test_option_chain_realtime.py ├── test_option_contracts_list.py ├── test_option_eod.py ├── test_option_factors_realtime.py ├── test_option_implied_move_data.py ├── test_option_interval.py ├── test_option_interval_mover.py ├── test_option_intervals_movers_result.py ├── test_option_intervals_result.py ├── test_option_price.py ├── test_option_price_batch_realtime.py ├── test_option_price_eod.py ├── test_option_price_realtime.py ├── test_option_price_realtime_extended.py ├── test_option_realtime.py ├── test_option_snapshot_group.py ├── test_option_snapshots_result.py ├── test_option_stats_realtime.py ├── test_option_synthetic_greeks_realtime.py ├── test_option_trades.py ├── test_option_trades_result.py ├── test_option_unusual_trade.py ├── test_options_aggregate.py ├── test_options_api.py ├── test_options_price_eod.py ├── test_owner.py ├── test_owner_summary.py ├── test_owners_api.py ├── test_realtime_index_price.py ├── test_realtime_index_price_index.py ├── test_realtime_stock_price.py ├── test_realtime_stock_price_security.py ├── test_relative_strength_index_technical_value.py ├── test_reported_financial.py ├── test_reported_financial_dimension.py ├── test_reported_tag.py ├── test_security.py ├── test_security_api.py ├── test_security_history.py ├── test_security_history_list_result.py ├── test_security_interval_mover.py ├── test_security_intervals_movers_result.py ├── test_security_replay_file_result.py ├── test_security_screen_clause.py ├── test_security_screen_group.py ├── test_security_screen_result.py ├── test_security_screen_result_data.py ├── test_security_snapshot_group.py ├── test_security_snapshots_result.py ├── test_security_summary.py ├── test_security_trades.py ├── test_security_trades_result.py ├── test_sic_index.py ├── test_simple_moving_average_technical_value.py ├── test_standardized_financial.py ├── test_standardized_financials_dimension.py ├── test_stochastic_oscillator_technical_value.py ├── test_stock_exchange.py ├── test_stock_exchange_api.py ├── test_stock_exchange_mover.py ├── test_stock_market_index.py ├── test_stock_market_index_summary.py ├── test_stock_price.py ├── test_stock_price_adjustment.py ├── test_stock_price_adjustment_summary.py ├── test_stock_price_interval.py ├── test_stock_price_summary.py ├── test_technical_api.py ├── test_technical_indicator.py ├── test_thea_entity_answer.py ├── test_thea_source_document.py ├── test_triple_exponential_average_technical_value.py ├── test_true_strength_index_technical_value.py ├── test_ultimate_oscillator_technical_value.py ├── test_volume_price_trend_technical_value.py ├── test_volume_weighted_average_price_value.py ├── test_vortex_indicator_technical_value.py ├── test_williams_r_technical_value.py ├── test_zacks_analyst_rating.py ├── test_zacks_analyst_rating_snapshot.py ├── test_zacks_analyst_rating_summary.py ├── test_zacks_api.py ├── test_zacks_ebitda_consensus.py ├── test_zacks_eps_estimate.py ├── test_zacks_eps_growth_rate.py ├── test_zacks_eps_surprise.py ├── test_zacks_eps_surprise_summary.py ├── test_zacks_etf_holding.py ├── test_zacks_forward_pe.py ├── test_zacks_institutional_holding.py ├── test_zacks_institutional_holding_company_detail.py ├── test_zacks_institutional_holding_company_summary.py ├── test_zacks_institutional_holding_historical_summary.py ├── test_zacks_institutional_holding_owner_detail.py ├── test_zacks_institutional_holding_owner_summary.py ├── test_zacks_long_term_growth_rate.py ├── test_zacks_sales_estimate.py ├── test_zacks_sales_surprise.py ├── test_zacks_sales_surprise_summary.py └── test_zacks_target_price_consensus.py └── tox.ini /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | venv/ 48 | .python-version 49 | 50 | # Translations 51 | *.mo 52 | *.pot 53 | 54 | # Django stuff: 55 | *.log 56 | 57 | # Sphinx documentation 58 | docs/_build/ 59 | 60 | # PyBuilder 61 | target/ 62 | 63 | #Ipython Notebook 64 | .ipynb_checkpoints 65 | -------------------------------------------------------------------------------- /.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 | # ref: https://docs.travis-ci.com/user/languages/python 2 | language: python 3 | python: 4 | - "2.7" 5 | - "3.2" 6 | - "3.3" 7 | - "3.4" 8 | - "3.5" 9 | #- "3.5-dev" # 3.5 development branch 10 | #- "nightly" # points to the latest development branch e.g. 3.6-dev 11 | # command to install dependencies 12 | install: "pip install -r requirements.txt" 13 | # command to run tests 14 | script: nosetests 15 | -------------------------------------------------------------------------------- /docs/AccumulationDistributionIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:AccumulationDistributionIndexTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### AccumulationDistributionIndexTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **adi** | float | The Accumulation/Distribution Index calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/ApiResponseBulkDownloadLinks.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseBulkDownloadLinks) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseBulkDownloadLinks 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **bulk_downloads** | [**list[BulkDownloadSummary]**](BulkDownloadSummary.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:BulkDownloadSummary) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanies.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseCompanies) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseCompanies 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **companies** | [**list[CompanySummary]**](CompanySummary.md) |   16 | **next_page** | str | 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:CompanySummary) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseCompaniesSearch.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseCompaniesSearch) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseCompaniesSearch 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **companies** | [**list[CompanySummary]**](CompanySummary.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:CompanySummary) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyAnswers.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseCompanyAnswers) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseCompanyAnswers 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **source** | str | The organziation the answer data was sourced from   16 | **query** | str | The query posed to the Thea API   17 | **answers** | [**list[TheaEntityAnswer]**](TheaEntityAnswer.md) |   18 | **companies** | [**list[CompanySummary]**](CompanySummary.md) |   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:TheaEntityAnswer) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:CompanySummary) 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyDailyMetrics.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseCompanyDailyMetrics) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseCompanyDailyMetrics 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **daily_metrics** | [**list[CompanyDailyMetric]**](CompanyDailyMetric.md) |   16 | **next_page** | str | 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:CompanyDailyMetric) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyFilings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseCompanyFilings) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseCompanyFilings 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **filings** | [**list[FilingSummary]**](FilingSummary.md) |   16 | **company** | [**CompanySummary**](CompanySummary.md) |   17 | **next_page** | str | 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:FilingSummary) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:CompanySummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyFundamentals.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseCompanyFundamentals) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseCompanyFundamentals 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **fundamentals** | [**list[FundamentalSummary]**](FundamentalSummary.md) |   16 | **company** | [**CompanySummary**](CompanySummary.md) |   17 | **next_page** | str | 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:FundamentalSummary) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:CompanySummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyHistoricalData.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseCompanyHistoricalData) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseCompanyHistoricalData 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **historical_data** | [**list[HistoricalData]**](HistoricalData.md) |   16 | **company** | [**CompanySummary**](CompanySummary.md) |   17 | **next_page** | str | 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:HistoricalData) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:CompanySummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyInsiderTransactionFilings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseCompanyInsiderTransactionFilings) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseCompanyInsiderTransactionFilings 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **transaction_filings** | [**list[InsiderTransactionFiling]**](InsiderTransactionFiling.md) |   16 | **company** | [**CompanySummary**](CompanySummary.md) | The company associated with the transaction filing   17 | **next_page** | str | 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:CompanySummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyNews.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseCompanyNews) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseCompanyNews 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **news** | [**list[CompanyNewsSummary]**](CompanyNewsSummary.md) |   16 | **company** | [**CompanySummary**](CompanySummary.md) |   17 | **next_page** | str | 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:CompanyNewsSummary) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:CompanySummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyNewsBody.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseCompanyNewsBody) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseCompanyNewsBody 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **body** | str | The article body.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyPublicFloatResult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseCompanyPublicFloatResult) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseCompanyPublicFloatResult 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   16 | **company** | [**CompanySummary**](CompanySummary.md) |   17 | **public_floats** | [**list[CompanyPublicFloat]**](CompanyPublicFloat.md) | Array of all the public floats in this page of the result.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:CompanySummary) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:CompanyPublicFloat) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanyRecognize.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseCompanyRecognize) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseCompanyRecognize 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **companies** | [**list[CompanySummary]**](CompanySummary.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:CompanySummary) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanySecurities.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseCompanySecurities) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseCompanySecurities 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **securities** | [**list[SecuritySummary]**](SecuritySummary.md) |   16 | **company** | [**CompanySummary**](CompanySummary.md) |   17 | **next_page** | str | 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:SecuritySummary) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:CompanySummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseCompanySharesOutstanding.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseCompanySharesOutstanding) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseCompanySharesOutstanding 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **shares_outstanding** | [**list[CompanySharesOutstanding]**](CompanySharesOutstanding.md) |   16 | **company** | [**CompanySummary**](CompanySummary.md) |   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:CompanySharesOutstanding) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:CompanySummary) 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/ApiResponseDataTags.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseDataTags) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseDataTags 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **tags** | [**list[DataTag]**](DataTag.md) |   16 | **next_page** | str | 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:DataTag) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseDataTagsSearch.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseDataTagsSearch) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseDataTagsSearch 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **tags** | [**list[DataTag]**](DataTag.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:DataTag) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseESGCompanies.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseESGCompanies) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseESGCompanies 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **companies** | [**list[ESGCompanySummary]**](ESGCompanySummary.md) |   16 | **next_page** | str | 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:ESGCompanySummary) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseESGCompanyComprehensiveRatingHistory.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseESGCompanyComprehensiveRatingHistory) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseESGCompanyComprehensiveRatingHistory 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **ratings** | [**list[ESGComprehensiveRating]**](ESGComprehensiveRating.md) |   16 | **company** | [**ESGCompanySummary**](ESGCompanySummary.md) |   17 | **next_page** | str | 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:ESGComprehensiveRating) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:ESGCompanySummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseESGCompanyRatingHistory.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseESGCompanyRatingHistory) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseESGCompanyRatingHistory 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **ratings** | [**list[ESGRating]**](ESGRating.md) |   16 | **company** | [**ESGCompanySummary**](ESGCompanySummary.md) |   17 | **next_page** | str | 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:ESGRating) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:ESGCompanySummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseESGLatest.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseESGLatest) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseESGLatest 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **ratings** | [**list[ESGRatingWithCompany]**](ESGRatingWithCompany.md) |   16 | **next_page** | str | 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:ESGRatingWithCompany) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseESGLatestComprehensive.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseESGLatestComprehensive) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseESGLatestComprehensive 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **ratings** | [**list[ESGComprehensiveRatingWithCompany]**](ESGComprehensiveRatingWithCompany.md) |   16 | **next_page** | str | 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:ESGComprehensiveRatingWithCompany) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseETFHoldings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseETFHoldings) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseETFHoldings 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **holdings** | [**list[ETFHolding]**](ETFHolding.md) |   16 | **etf** | [**ETFSummary**](ETFSummary.md) |   17 | **next_page** | str | 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:ETFHolding) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:ETFSummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseETFs.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseETFs) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseETFs 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **etfs** | [**list[ETFSummary]**](ETFSummary.md) |   16 | **next_page** | str | 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:ETFSummary) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseEconomicIndexHistoricalData.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseEconomicIndexHistoricalData) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseEconomicIndexHistoricalData 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **historical_data** | [**list[HistoricalData]**](HistoricalData.md) |   16 | **index** | [**EconomicIndexSummary**](EconomicIndexSummary.md) |   17 | **next_page** | str | 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:HistoricalData) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:EconomicIndexSummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseEconomicIndices.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseEconomicIndices) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseEconomicIndices 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **indices** | [**list[EconomicIndexSummary]**](EconomicIndexSummary.md) |   16 | **next_page** | str | 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:EconomicIndexSummary) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseEconomicIndicesSearch.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseEconomicIndicesSearch) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseEconomicIndicesSearch 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **indices** | [**list[EconomicIndexSummary]**](EconomicIndexSummary.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:EconomicIndexSummary) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseEodIndexPrices.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseEodIndexPrices) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseEodIndexPrices 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **prices** | [**list[EodIndexPriceSummary]**](EodIndexPriceSummary.md) |   16 | **index** | [**ApiResponseIndex**](ApiResponseIndex.md) | The index   17 | **next_page** | str | 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:EodIndexPriceSummary) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:ApiResponseIndex) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseEodIndexPricesAll.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseEodIndexPricesAll) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseEodIndexPricesAll 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **prices** | [**list[EodIndexPrice]**](EodIndexPrice.md) |   16 | **next_page** | str | 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:EodIndexPrice) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseFilingAnswers.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseFilingAnswers) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseFilingAnswers 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **source** | str | The organziation the answer data was sourced from   16 | **query** | str | The query posed to the Thea API   17 | **answers** | [**list[TheaEntityAnswer]**](TheaEntityAnswer.md) |   18 | **companies** | [**list[Filing]**](Filing.md) |   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:TheaEntityAnswer) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:Filing) 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseFilingFundamentals.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseFilingFundamentals) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseFilingFundamentals 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **fundamentals** | [**list[FundamentalSummary]**](FundamentalSummary.md) |   16 | **filing** | [**FilingSummary**](FilingSummary.md) |   17 | **next_page** | str | 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:FundamentalSummary) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:FilingSummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseFilingNotes.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseFilingNotes) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseFilingNotes 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **filing_notes** | [**list[FilingNoteSummary]**](FilingNoteSummary.md) |   16 | **next_page** | str | 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:FilingNoteSummary) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseFilingNotesSearch.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseFilingNotesSearch) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseFilingNotesSearch 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **filing_notes** | [**list[FilingNoteSummary]**](FilingNoteSummary.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:FilingNoteSummary) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseFilings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseFilings) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseFilings 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **filings** | [**list[Filing]**](Filing.md) |   16 | **next_page** | str | 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:Filing) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseForexCurrencies.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseForexCurrencies) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseForexCurrencies 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **currencies** | [**list[ForexCurrency]**](ForexCurrency.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ForexCurrency) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseForexPairs.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseForexPairs) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseForexPairs 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **pairs** | [**list[ForexPair]**](ForexPair.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:ForexPair) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseForexPrices.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseForexPrices) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseForexPrices 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **prices** | [**list[ForexPrice]**](ForexPrice.md) |   16 | **pair** | [**ForexPair**](ForexPair.md) | The Forex currency pair for which prices were requested   17 | **next_page** | str | 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:ForexPrice) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:ForexPair) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseHistoricalData.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseHistoricalData) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseHistoricalData 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **historical_data** | [**list[HistoricalData]**](HistoricalData.md) |   16 | **next_page** | str | 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 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseIndex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseIndex) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseIndex 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **symbol** | str | The index symbol   16 | **name** | str | The index name   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/ApiResponseIndexConstituents.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseIndexConstituents) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseIndexConstituents 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **index** | [**ApiResponseIndex**](ApiResponseIndex.md) | The index   16 | **date** | date | The date when an update was last received for the index constituents   17 | **constituents** | [**list[SecuritySummary]**](SecuritySummary.md) |   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:ApiResponseIndex) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:SecuritySummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseIndexIntervals.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseIndexIntervals) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseIndexIntervals 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **intervals** | [**list[IndexInterval]**](IndexInterval.md) | Array of index intervals   16 | **next_page** | str | 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:IndexInterval) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseIndices.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseIndices) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseIndices 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **indices** | [**list[ApiResponseIndex]**](ApiResponseIndex.md) |   16 | **next_page** | str | 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:ApiResponseIndex) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseInitialPublicOfferings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseInitialPublicOfferings) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseInitialPublicOfferings 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **initial_public_offerings** | [**list[CompanyInitialPublicOffering]**](CompanyInitialPublicOffering.md) |   16 | **next_page** | str | 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:CompanyInitialPublicOffering) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseInsiderTransactionFilings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseInsiderTransactionFilings) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseInsiderTransactionFilings 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **transaction_filings** | [**list[InsiderTransactionFiling]**](InsiderTransactionFiling.md) |   16 | **owner** | [**OwnerSummary**](OwnerSummary.md) | The owner associated with the transaction filing   17 | **company** | [**CompanySummary**](CompanySummary.md) | The company associated with the transaction filing   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:InsiderTransactionFiling) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:OwnerSummary) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:CompanySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseMunicipalities.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseMunicipalities) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseMunicipalities 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **municipalities** | [**list[Municipality]**](Municipality.md) |   16 | **next_page** | str | 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:Municipality) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseMunicipalitiyFinancials.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseMunicipalitiyFinancials) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseMunicipalitiyFinancials 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **financials** | [**list[MunicipalityFinancial]**](MunicipalityFinancial.md) |   16 | **municipality** | [**Municipality**](Municipality.md) |   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:MunicipalityFinancial) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:Municipality) 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/ApiResponseNews.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseNews) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseNews 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **news** | [**list[CompanyNews]**](CompanyNews.md) |   16 | **next_page** | str | 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:CompanyNews) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionPrices.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionPrices) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionPrices 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **prices** | [**list[OptionPrice]**](OptionPrice.md) | A list of option prices in descending order by date   16 | **option** | [**Option**](Option.md) |   17 | **next_page** | str | 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:OptionPrice) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:Option) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseOptions.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptions) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptions 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **options** | [**list[Option]**](Option.md) | A list of options contracts with the given symbol   16 | **next_page** | str | 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:Option) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsAggregates.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsAggregates) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsAggregates 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **aggregates** | [**list[OptionsAggregate]**](OptionsAggregate.md) | A list of option expiration dates in descending order   16 | **next_page** | str | 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:OptionsAggregate) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsChain.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsChain) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsChain 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **chain** | [**list[OptionChain]**](OptionChain.md) | A list of options for the provided expiration date their respective option prices.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:OptionChain) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsChainEod.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsChainEod) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsChainEod 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **chain** | [**list[OptionChainEod]**](OptionChainEod.md) | A list of realtime options for the provided expiration date their respective option prices.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:OptionChainEod) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsChainRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsChainRealtime) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsChainRealtime 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **chain** | [**list[OptionChainRealtime]**](OptionChainRealtime.md) | A list of realtime options for the provided expiration date their respective option prices.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:OptionChainRealtime) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsExpirations.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsExpirations) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsExpirations 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **expirations** | list[str] | A list of option expiration dates in descending order   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsGreekContractRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsGreekContractRealtime) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsGreekContractRealtime 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **messages** | list[str] | Any messages or warnings about the data   16 | **option** | [**Option**](Option.md) |   17 | **greeks** | [**OptionSyntheticGreeksRealtime**](OptionSyntheticGreeksRealtime.md) |   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:Option) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:OptionSyntheticGreeksRealtime) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsGreeksByTickerRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsGreeksByTickerRealtime) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsGreeksByTickerRealtime 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   16 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   17 | **messages** | list[str] | Any messages or warnings about the data   18 | **contracts** | [**list[ApiResponseOptionsGreekContractRealtime]**](ApiResponseOptionsGreekContractRealtime.md) | The options greeks data for this security   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:SecuritySummary) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:ApiResponseOptionsGreekContractRealtime) 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsImpliedMove.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsImpliedMove) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsImpliedMove 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **implied_move** | [**OptionImpliedMoveData**](OptionImpliedMoveData.md) | The data pertaining to the implied move.   16 | **messages** | list[str] | Any messages or warnings about the data   17 | **underlying_price** | float | The price of the underlying instrument.   18 | **expiration** | str | The date on which the Option expires. The Option becomes invalid after this date and cannot be exercised.   19 | **atm_strike** | float | The at-the-money strike price for the implied move calculation.   20 | **straddle_price** | float | The straddle price for the implied move calculation.   21 | **symbol** | str | The symbol for the underlying instrument.   22 | 23 | [//]: # (END_DEFINITION) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:OptionImpliedMoveData) 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsPriceRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsPriceRealtime) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsPriceRealtime 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **price** | [**OptionPriceRealtime**](OptionPriceRealtime.md) |   16 | **stats** | [**OptionStatsRealtime**](OptionStatsRealtime.md) |   17 | **option** | [**OptionRealtime**](OptionRealtime.md) |   18 | **extended_price** | [**OptionPriceRealtimeExtended**](OptionPriceRealtimeExtended.md) |   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:OptionPriceRealtime) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:OptionStatsRealtime) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:OptionRealtime) 30 | 31 | 32 | [//]: # (CONTAINED_CLASS:OptionPriceRealtimeExtended) 33 | 34 | 35 | 36 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsPricesBatchRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsPricesBatchRealtime) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsPricesBatchRealtime 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **contracts** | [**list[OptionPriceBatchRealtime]**](OptionPriceBatchRealtime.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:OptionPriceBatchRealtime) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsPricesByTickerEod.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsPricesByTickerEod) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsPricesByTickerEod 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   16 | **prices** | [**list[OptionsPriceEod]**](OptionsPriceEod.md) | The contracts pricing for this security.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:OptionsPriceEod) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsPricesByTickerRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsPricesByTickerRealtime) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsPricesByTickerRealtime 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   16 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   17 | **contracts** | [**list[ApiResponseOptionsPriceRealtime]**](ApiResponseOptionsPriceRealtime.md) | The contracts pricing for this security.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:SecuritySummary) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:ApiResponseOptionsPriceRealtime) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsPricesEod.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsPricesEod) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsPricesEod 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **prices** | [**list[OptionPriceEod]**](OptionPriceEod.md) | A list of options prices with the given symbol   16 | **option** | [**OptionEod**](OptionEod.md) |   17 | **next_page** | str | 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:OptionPriceEod) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:OptionEod) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsRealtime) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsRealtime 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **options** | [**list[OptionRealtime]**](OptionRealtime.md) | A list of options contracts with the given symbol   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:OptionRealtime) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsStatsRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsStatsRealtime) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsStatsRealtime 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **stats** | [**OptionStatsRealtime**](OptionStatsRealtime.md) |   16 | **factors** | [**OptionFactorsRealtime**](OptionFactorsRealtime.md) |   17 | **option** | [**OptionRealtime**](OptionRealtime.md) |   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:OptionStatsRealtime) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:OptionFactorsRealtime) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:OptionRealtime) 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsTickers.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsTickers) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsTickers 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **tickers** | list[str] |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/ApiResponseOptionsUnusualActivity.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOptionsUnusualActivity) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOptionsUnusualActivity 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **trades** | [**list[OptionUnusualTrade]**](OptionUnusualTrade.md) | A list of unusual trades for a given company identifier   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:OptionUnusualTrade) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseOwnerInsiderTransactionFilings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOwnerInsiderTransactionFilings) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOwnerInsiderTransactionFilings 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **transaction_filings** | [**list[InsiderTransactionFiling]**](InsiderTransactionFiling.md) |   16 | **owner** | [**OwnerSummary**](OwnerSummary.md) | The owner associated with the transaction filing   17 | **next_page** | str | 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 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseOwnerInstitutionalHoldings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOwnerInstitutionalHoldings) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOwnerInstitutionalHoldings 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **holdings** | object |   16 | **next_page** | str | 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 | 22 | -------------------------------------------------------------------------------- /docs/ApiResponseOwners.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseOwners) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseOwners 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **owners** | [**list[OwnerSummary]**](OwnerSummary.md) | A list of owners   16 | **next_page** | str | 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:OwnerSummary) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseRealtimeIndexPrices.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseRealtimeIndexPrices) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseRealtimeIndexPrices 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **prices** | [**list[RealtimeIndexPrice]**](RealtimeIndexPrice.md) |   16 | **next_page** | str | 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:RealtimeIndexPrice) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseReportedFinancials.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseReportedFinancials) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseReportedFinancials 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **reported_financials** | [**list[ReportedFinancial]**](ReportedFinancial.md) |   16 | **fundamental** | [**Fundamental**](Fundamental.md) |   17 | **next_page** | str | 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:ReportedFinancial) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:Fundamental) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseSICIndexHistoricalData.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSICIndexHistoricalData) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSICIndexHistoricalData 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **historical_data** | [**list[HistoricalData]**](HistoricalData.md) |   16 | **index** | [**SICIndex**](SICIndex.md) |   17 | **next_page** | str | 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:HistoricalData) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:SICIndex) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseSICIndices.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSICIndices) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSICIndices 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **indices** | [**list[SICIndex]**](SICIndex.md) |   16 | **next_page** | str | 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:SICIndex) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseSICIndicesSearch.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSICIndicesSearch) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSICIndicesSearch 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **indices** | [**list[SICIndex]**](SICIndex.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:SICIndex) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurities.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurities) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurities 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **securities** | [**list[SecuritySummary]**](SecuritySummary.md) |   16 | **next_page** | str | 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 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseSecuritiesSearch.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecuritiesSearch) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecuritiesSearch 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **securities** | [**list[SecuritySummary]**](SecuritySummary.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:SecuritySummary) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityAccumulationDistributionIndex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityAccumulationDistributionIndex) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityAccumulationDistributionIndex 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[AccumulationDistributionIndexTechnicalValue]**](AccumulationDistributionIndexTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:AccumulationDistributionIndexTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityAverageDailyTradingVolume.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityAverageDailyTradingVolume) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityAverageDailyTradingVolume 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[AverageDailyTradingVolumeTechnicalValue]**](AverageDailyTradingVolumeTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:AverageDailyTradingVolumeTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityAverageDirectionalIndex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityAverageDirectionalIndex) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityAverageDirectionalIndex 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[AverageDirectionalIndexTechnicalValue]**](AverageDirectionalIndexTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:AverageDirectionalIndexTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityAverageTrueRange.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityAverageTrueRange) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityAverageTrueRange 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[AverageTrueRangeTechnicalValue]**](AverageTrueRangeTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:AverageTrueRangeTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityAwesomeOscillator.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityAwesomeOscillator) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityAwesomeOscillator 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[AwesomeOscillatorTechnicalValue]**](AwesomeOscillatorTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:AwesomeOscillatorTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityBollingerBands.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityBollingerBands) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityBollingerBands 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[BollingerBandsTechnicalValue]**](BollingerBandsTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:BollingerBandsTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityChaikinMoneyFlow.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityChaikinMoneyFlow) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityChaikinMoneyFlow 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[ChaikinMoneyFlowTechnicalValue]**](ChaikinMoneyFlowTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:ChaikinMoneyFlowTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityCommodityChannelIndex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityCommodityChannelIndex) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityCommodityChannelIndex 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[CommodityChannelIndexTechnicalValue]**](CommodityChannelIndexTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:CommodityChannelIndexTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityDetrendedPriceOscillator.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityDetrendedPriceOscillator) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityDetrendedPriceOscillator 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[DetrendedPriceOscillatorTechnicalValue]**](DetrendedPriceOscillatorTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:DetrendedPriceOscillatorTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityDonchianChannel.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityDonchianChannel) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityDonchianChannel 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[DonchianChannelTechnicalValue]**](DonchianChannelTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:DonchianChannelTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityEaseOfMovement.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityEaseOfMovement) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityEaseOfMovement 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[EaseOfMovementTechnicalValue]**](EaseOfMovementTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:EaseOfMovementTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityForceIndex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityForceIndex) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityForceIndex 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[ForceIndexTechnicalValue]**](ForceIndexTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:ForceIndexTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityHistoricalData.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityHistoricalData) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityHistoricalData 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **historical_data** | [**list[HistoricalData]**](HistoricalData.md) |   16 | **security** | [**SecuritySummary**](SecuritySummary.md) |   17 | **next_page** | str | 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:HistoricalData) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:SecuritySummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityIchimokuKinkoHyo.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityIchimokuKinkoHyo) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityIchimokuKinkoHyo 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[IchimokuKinkoHyoTechnicalValue]**](IchimokuKinkoHyoTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:IchimokuKinkoHyoTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityInstitutionalOwnership.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityInstitutionalOwnership) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityInstitutionalOwnership 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **ownership** | [**list[InstitutionalOwnership]**](InstitutionalOwnership.md) |   16 | **next_page** | str | 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:InstitutionalOwnership) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityIntervalPrices.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityIntervalPrices) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityIntervalPrices 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **intervals** | [**list[StockPriceInterval]**](StockPriceInterval.md) | Open, close, high, low, volume, average price, and change ratio for a particular interval   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   17 | **source** | str | The source of the data   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:StockPriceInterval) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:SecuritySummary) 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityKeltnerChannel.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityKeltnerChannel) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityKeltnerChannel 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[KeltnerChannelTechnicalValue]**](KeltnerChannelTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:KeltnerChannelTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityKnowSureThing.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityKnowSureThing) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityKnowSureThing 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[KnowSureThingTechnicalValue]**](KnowSureThingTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:KnowSureThingTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityMassIndex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityMassIndex) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityMassIndex 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[MassIndexTechnicalValue]**](MassIndexTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:MassIndexTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityMoneyFlowIndex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityMoneyFlowIndex) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityMoneyFlowIndex 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[MoneyFlowIndexTechnicalValue]**](MoneyFlowIndexTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:MoneyFlowIndexTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityMovingAverageConvergenceDivergence.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityMovingAverageConvergenceDivergence) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityMovingAverageConvergenceDivergence 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[MovingAverageConvergenceDivergenceTechnicalValue]**](MovingAverageConvergenceDivergenceTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:MovingAverageConvergenceDivergenceTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityNegativeVolumeIndex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityNegativeVolumeIndex) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityNegativeVolumeIndex 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[NegativeVolumeIndexTechnicalValue]**](NegativeVolumeIndexTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:NegativeVolumeIndexTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityOnBalanceVolume.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityOnBalanceVolume) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityOnBalanceVolume 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[OnBalanceVolumeTechnicalValue]**](OnBalanceVolumeTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:OnBalanceVolumeTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityOnBalanceVolumeMean.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityOnBalanceVolumeMean) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityOnBalanceVolumeMean 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[OnBalanceVolumeMeanTechnicalValue]**](OnBalanceVolumeMeanTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:OnBalanceVolumeMeanTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityRelativeStrengthIndex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityRelativeStrengthIndex) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityRelativeStrengthIndex 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[RelativeStrengthIndexTechnicalValue]**](RelativeStrengthIndexTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:RelativeStrengthIndexTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecuritySimpleMovingAverage.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecuritySimpleMovingAverage) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecuritySimpleMovingAverage 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[SimpleMovingAverageTechnicalValue]**](SimpleMovingAverageTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:SimpleMovingAverageTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityStochasticOscillator.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityStochasticOscillator) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityStochasticOscillator 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[StochasticOscillatorTechnicalValue]**](StochasticOscillatorTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:StochasticOscillatorTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityStockPriceAdjustments.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityStockPriceAdjustments) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityStockPriceAdjustments 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **stock_price_adjustments** | [**list[StockPriceAdjustmentSummary]**](StockPriceAdjustmentSummary.md) | The stock price adjustments for the Security   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   17 | **next_page** | str | 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:StockPriceAdjustmentSummary) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:SecuritySummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityStockPrices.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityStockPrices) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityStockPrices 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **stock_prices** | [**list[StockPriceSummary]**](StockPriceSummary.md) | The stock prices for the Security   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   17 | **next_page** | str | 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:StockPriceSummary) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:SecuritySummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityTripleExponentialAverage.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityTripleExponentialAverage) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityTripleExponentialAverage 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[TripleExponentialAverageTechnicalValue]**](TripleExponentialAverageTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:TripleExponentialAverageTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityTrueStrengthIndex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityTrueStrengthIndex) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityTrueStrengthIndex 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[TrueStrengthIndexTechnicalValue]**](TrueStrengthIndexTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:TrueStrengthIndexTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityUltimateOscillator.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityUltimateOscillator) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityUltimateOscillator 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[UltimateOscillatorTechnicalValue]**](UltimateOscillatorTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:UltimateOscillatorTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityVolumePriceTrend.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityVolumePriceTrend) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityVolumePriceTrend 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[VolumePriceTrendTechnicalValue]**](VolumePriceTrendTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:VolumePriceTrendTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityVolumeWeightedAveragePrice.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityVolumeWeightedAveragePrice) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityVolumeWeightedAveragePrice 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[VolumeWeightedAveragePriceValue]**](VolumeWeightedAveragePriceValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:VolumeWeightedAveragePriceValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityVortexIndicator.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityVortexIndicator) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityVortexIndicator 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[VortexIndicatorTechnicalValue]**](VortexIndicatorTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:VortexIndicatorTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityWilliamsR.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityWilliamsR) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityWilliamsR 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **technicals** | [**list[WilliamsRTechnicalValue]**](WilliamsRTechnicalValue.md) |   16 | **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator   17 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the Stock Price   18 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:WilliamsRTechnicalValue) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:TechnicalIndicator) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:SecuritySummary) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityZacksAnalystRatings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityZacksAnalystRatings) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityZacksAnalystRatings 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **analyst_ratings** | [**list[ZacksAnalystRatingSummary]**](ZacksAnalystRatingSummary.md) |   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   17 | **next_page** | str | 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:ZacksAnalystRatingSummary) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:SecuritySummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityZacksAnalystRatingsSnapshot.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityZacksAnalystRatingsSnapshot) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityZacksAnalystRatingsSnapshot 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **snapshots** | [**list[ZacksAnalystRatingSnapshot]**](ZacksAnalystRatingSnapshot.md) |   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:ZacksAnalystRatingSnapshot) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:SecuritySummary) 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityZacksEPSSurprises.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityZacksEPSSurprises) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityZacksEPSSurprises 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **eps_surprises** | [**list[ZacksEPSSurpriseSummary]**](ZacksEPSSurpriseSummary.md) |   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   17 | **next_page** | str | 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:ZacksEPSSurpriseSummary) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:SecuritySummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseSecurityZacksSalesSurprises.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseSecurityZacksSalesSurprises) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseSecurityZacksSalesSurprises 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **sales_surprises** | [**list[ZacksSalesSurpriseSummary]**](ZacksSalesSurpriseSummary.md) |   16 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier   17 | **next_page** | str | 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:ZacksSalesSurpriseSummary) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:SecuritySummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseStandardizedFinancials.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseStandardizedFinancials) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseStandardizedFinancials 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **standardized_financials** | [**list[StandardizedFinancial]**](StandardizedFinancial.md) |   16 | **fundamental** | [**Fundamental**](Fundamental.md) |   17 | **next_page** | str | 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:StandardizedFinancial) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:Fundamental) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseStandardizedFinancialsDimensions.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseStandardizedFinancialsDimensions) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseStandardizedFinancialsDimensions 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **dimensions** | [**list[StandardizedFinancialsDimension]**](StandardizedFinancialsDimension.md) | The combination of XBRL axis and members that defines the dimensionalization of this fact (if any)   16 | **data_tag** | [**DataTagSummary**](DataTagSummary.md) |   17 | **fundamental** | [**Fundamental**](Fundamental.md) |   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:StandardizedFinancialsDimension) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:DataTagSummary) 26 | 27 | 28 | [//]: # (CONTAINED_CLASS:Fundamental) 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/ApiResponseStockExchangeBetas.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseStockExchangeBetas) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseStockExchangeBetas 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **betas** | [**list[Beta]**](Beta.md) | The mover security.   16 | **stock_exchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   17 | **next_page** | str | 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:Beta) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:StockExchange) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseStockExchangeMovers.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseStockExchangeMovers) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseStockExchangeMovers 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **movers** | [**list[StockExchangeMover]**](StockExchangeMover.md) | The mover security.   16 | **stock_exchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:StockExchangeMover) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:StockExchange) 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/ApiResponseStockExchangeQuote.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseStockExchangeQuote) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseStockExchangeQuote 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **quotes** | [**list[ApiResponseSecurityQuote]**](ApiResponseSecurityQuote.md) | The realtime stock prices for all Securities traded on the Stock Exchange   16 | **stock_exchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:ApiResponseSecurityQuote) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:StockExchange) 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/ApiResponseStockExchangeRealtimeStockPrices.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseStockExchangeRealtimeStockPrices) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseStockExchangeRealtimeStockPrices 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **stock_prices** | [**list[RealtimeStockPrice]**](RealtimeStockPrice.md) | The realtime stock prices for all Securities traded on the Stock Exchange   16 | **stock_exchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   17 | **next_page** | str | 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:RealtimeStockPrice) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:StockExchange) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseStockExchangeSecurities.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseStockExchangeSecurities) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseStockExchangeSecurities 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **securities** | [**list[SecuritySummary]**](SecuritySummary.md) | The securities traded on the Stock Exchange   16 | **stock_exchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   17 | **next_page** | str | 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:SecuritySummary) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:StockExchange) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseStockExchangeStockPriceAdjustments.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseStockExchangeStockPriceAdjustments) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseStockExchangeStockPriceAdjustments 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **stock_price_adjustments** | [**list[StockPriceAdjustment]**](StockPriceAdjustment.md) | The stock price adjustments for all Securities traded on the Stock Exchange on the given date   16 | **stock_exchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   17 | **next_page** | str | 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:StockPriceAdjustment) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:StockExchange) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseStockExchangeStockPrices.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseStockExchangeStockPrices) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseStockExchangeStockPrices 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **stock_prices** | [**list[StockPrice]**](StockPrice.md) | The stock prices for all Securities traded on the Stock Exchange on the given date   16 | **stock_exchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier   17 | **next_page** | str | 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:StockPrice) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:StockExchange) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseStockExchanges.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseStockExchanges) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseStockExchanges 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **stock_exchanges** | [**list[StockExchange]**](StockExchange.md) |   16 | **next_page** | str | 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:StockExchange) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseStockMarketIndexHistoricalData.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseStockMarketIndexHistoricalData) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseStockMarketIndexHistoricalData 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **historical_data** | [**list[HistoricalData]**](HistoricalData.md) |   16 | **index** | [**StockMarketIndexSummary**](StockMarketIndexSummary.md) |   17 | **next_page** | str | 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:HistoricalData) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:StockMarketIndexSummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ApiResponseStockMarketIndices.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseStockMarketIndices) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseStockMarketIndices 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **indices** | [**list[StockMarketIndexSummary]**](StockMarketIndexSummary.md) |   16 | **next_page** | str | 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:StockMarketIndexSummary) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseStockMarketIndicesSearch.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseStockMarketIndicesSearch) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseStockMarketIndicesSearch 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **indices** | [**list[StockMarketIndexSummary]**](StockMarketIndexSummary.md) |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:StockMarketIndexSummary) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksAnalystRatings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseZacksAnalystRatings) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseZacksAnalystRatings 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **analyst_ratings** | [**list[ZacksAnalystRating]**](ZacksAnalystRating.md) |   16 | **next_page** | str | 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:ZacksAnalystRating) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksEBITDAConsensus.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseZacksEBITDAConsensus) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseZacksEBITDAConsensus 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **ebitda_consensuses** | [**list[ZacksEBITDAConsensus]**](ZacksEBITDAConsensus.md) | Zacks target price consensuses for the latest date   16 | **next_page** | str | 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:ZacksEBITDAConsensus) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksEPSEstimates.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseZacksEPSEstimates) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseZacksEPSEstimates 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **estimates** | [**list[ZacksEPSEstimate]**](ZacksEPSEstimate.md) | Zacks EPS estimate data for a given date range   16 | **next_page** | str | 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:ZacksEPSEstimate) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksEPSGrowthRates.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseZacksEPSGrowthRates) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseZacksEPSGrowthRates 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **eps_growth_rates** | [**list[ZacksEPSGrowthRate]**](ZacksEPSGrowthRate.md) | Zacks EPS growth rate for the latest date   16 | **next_page** | str | 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:ZacksEPSGrowthRate) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksEPSSurprises.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseZacksEPSSurprises) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseZacksEPSSurprises 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **eps_surprises** | [**list[ZacksEPSSurprise]**](ZacksEPSSurprise.md) | Zacks EPS Surprise data for a Security in descending order by actual reported date   16 | **next_page** | str | 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:ZacksEPSSurprise) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksETFHoldings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseZacksETFHoldings) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseZacksETFHoldings 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **holdings** | [**list[ZacksETFHolding]**](ZacksETFHolding.md) | Zacks ETF holding data   16 | **next_page** | str | 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:ZacksETFHolding) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksForwardPEs.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseZacksForwardPEs) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseZacksForwardPEs 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **forward_pe** | [**list[ZacksForwardPE]**](ZacksForwardPE.md) | Zacks forward PE ratio estimates   16 | **next_page** | str | 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:ZacksForwardPE) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksInstitutionalHoldingCompanies.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseZacksInstitutionalHoldingCompanies) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseZacksInstitutionalHoldingCompanies 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **companies** | [**list[ZacksInstitutionalHoldingCompanyDetail]**](ZacksInstitutionalHoldingCompanyDetail.md) | Zacks institutional holding company data   16 | **next_page** | str | 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:ZacksInstitutionalHoldingCompanyDetail) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksInstitutionalHoldingOwners.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseZacksInstitutionalHoldingOwners) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseZacksInstitutionalHoldingOwners 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **owners** | [**list[ZacksInstitutionalHoldingOwnerDetail]**](ZacksInstitutionalHoldingOwnerDetail.md) | Zacks institutional holding owners data   16 | **next_page** | str | 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:ZacksInstitutionalHoldingOwnerDetail) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksInstitutionalHoldings.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseZacksInstitutionalHoldings) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseZacksInstitutionalHoldings 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **holdings** | [**list[ZacksInstitutionalHolding]**](ZacksInstitutionalHolding.md) | Zacks institutional holding data   16 | **next_page** | str | 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:ZacksInstitutionalHolding) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksLongTermGrowthRates.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseZacksLongTermGrowthRates) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseZacksLongTermGrowthRates 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **long_term_growth_estimates** | [**list[ZacksLongTermGrowthRate]**](ZacksLongTermGrowthRate.md) | Zacks latest long term growth rates   16 | **next_page** | str | 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:ZacksLongTermGrowthRate) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksSalesEstimates.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseZacksSalesEstimates) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseZacksSalesEstimates 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **estimates** | [**list[ZacksSalesEstimate]**](ZacksSalesEstimate.md) | Zacks Sales estimate data for a given date range   16 | **next_page** | str | 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:ZacksSalesEstimate) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksSalesSurprises.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseZacksSalesSurprises) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseZacksSalesSurprises 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **sales_surprises** | [**list[ZacksSalesSurprise]**](ZacksSalesSurprise.md) | Zacks Sales Surprise data for a Security in descending order by actual reported date   16 | **next_page** | str | 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:ZacksSalesSurprise) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/ApiResponseZacksTargetPriceConsensuses.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ApiResponseZacksTargetPriceConsensuses) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ApiResponseZacksTargetPriceConsensuses 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **target_price_consensuses** | [**list[ZacksTargetPriceConsensus]**](ZacksTargetPriceConsensus.md) | Zacks target price consensuses for the latest date   16 | **next_page** | str | 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:ZacksTargetPriceConsensus) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/AverageDailyTradingVolumeTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:AverageDailyTradingVolumeTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### AverageDailyTradingVolumeTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **adtv** | float | The Average Daily Trading Volume calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/AverageDirectionalIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:AverageDirectionalIndexTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### AverageDirectionalIndexTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **adx** | float | The Average Directional Index value   17 | **di_neg** | float | The Minus Directional Indicator value   18 | **di_pos** | float | The Plus Directional Indicator value   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/AverageTrueRangeTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:AverageTrueRangeTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### AverageTrueRangeTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **atr** | float | The Average True Range calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/AwesomeOscillatorTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:AwesomeOscillatorTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### AwesomeOscillatorTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **ao** | float | The Awesome Oscillator calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/Beta.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:Beta) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### Beta 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **period_type** | str | Type of period for this beta value.   16 | **one_year_beta** | float | The one year beta value for this security.   17 | **three_year_beta** | float | The three year beta value for this security.   18 | **five_year_beta** | float | The five year beta value for this security.   19 | **seven_year_beta** | float | The seven year beta value for this security.   20 | **ten_year_beta** | float | The ten year beta value for this security.   21 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security.   22 | 23 | [//]: # (END_DEFINITION) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:SecuritySummary) 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/BollingerBandsTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:BollingerBandsTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### BollingerBandsTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **lower_band** | float | The lower band value of the Bollinger Bands technical indicator calculation   17 | **middle_band** | float | The middle band value of the Bollinger Bands technical indicator calculation   18 | **upper_band** | float | The upper band value of the Bollinger Bands technical indicator calculation   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/BulkDownloadLinks.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:BulkDownloadLinks) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### BulkDownloadLinks 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **name** | str | The name of the file   16 | **url** | str | Link for accessing the bulk download. Expires in 24 hours.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/BulkDownloadSummary.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:BulkDownloadSummary) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### BulkDownloadSummary 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | The Intrinio ID of the bulk download   16 | **name** | str | The name of the bulk download   17 | **format** | str | The file format of the bulk download   18 | **data_length_bytes** | str | The total length of the bulk download data in bytes   19 | **update_frequency** | str | The update frequency for the bulk download   20 | **last_updated** | date | The date on which the bulk download was last updated   21 | **links** | [**list[BulkDownloadLinks]**](BulkDownloadLinks.md) | Links to all of the files comprising the bulk download. Links expire in 24 hours.   22 | 23 | [//]: # (END_DEFINITION) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:BulkDownloadLinks) 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/ChaikinMoneyFlowTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ChaikinMoneyFlowTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ChaikinMoneyFlowTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **cmf** | float | The Chaikin Money Flow calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/CommodityChannelIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:CommodityChannelIndexTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### CommodityChannelIndexTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **cci** | float | The Commodity Channel Index calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/CompanyPublicFloat.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:CompanyPublicFloat) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### CompanyPublicFloat 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date** | date | The date of the public float.   16 | **filing_date** | date | The filing date of the public float.   17 | **public_float_value** | float | The dollar value for company float.   18 | **public_float_shares** | float | The public shares for the company.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/CompanySharesOutstanding.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:CompanySharesOutstanding) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### CompanySharesOutstanding 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **xbrl_axis** | str | The xbrl concept axis member reported to the SEC.   16 | **xbrl_member** | str | Provides information about the class of stock as reported in XBRL   17 | **end_date** | date | End date of the filing period   18 | **title_of_security** | str | The description of the security type   19 | **trading_symbol** | str | The symbol under which the security is traded in the exchange   20 | **security_exchange_name** | str | The name of the secuirty exchange   21 | **shares_outstanding** | float | The amount of stock currently held by all shareholders   22 | 23 | [//]: # (END_DEFINITION) 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/CompanySummary.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:CompanySummary) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### CompanySummary 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | The Intrinio ID of the company   16 | **ticker** | str | The stock market ticker symbol associated with the company's common stock securities   17 | **name** | str | The company's common name   18 | **lei** | str | The Legal Entity Identifier (LEI) assigned to the company   19 | **cik** | str | The Central Index Key (CIK) assigned to the company   20 | 21 | [//]: # (END_DEFINITION) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/DataTagSummary.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:DataTagSummary) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### DataTagSummary 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | The Intrinio ID for the Data Tag   16 | **name** | str | The readable name of the Data Tag   17 | **tag** | str | The code-name of the Data Tag   18 | **parent** | str | The parent Data Tag forming the statement relationship with the factor   19 | **sequence** | float | The order in which the Data Tag appears in its logical group (such as a financial statement)   20 | **factor** | str | The operator forming the statement relationship between the child Data Tag (or Data Tags) and the parent Data Tag   21 | **balance** | str | Whether the Data Tag represents a credit or debit   22 | **unit** | str | The unit of the Data Tag   23 | 24 | [//]: # (END_DEFINITION) 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/DetrendedPriceOscillatorTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:DetrendedPriceOscillatorTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### DetrendedPriceOscillatorTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **dpo** | float | The Detrended Price Oscillator calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/DonchianChannelTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:DonchianChannelTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### DonchianChannelTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **lower_bound** | float | The lower bound value of the Donchian Channel calculation   17 | **upper_bound** | float | The upper bound value of the Donchian Channel calculation   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/ESGCompanySummary.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ESGCompanySummary) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ESGCompanySummary 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | The Intrinio ID of the company.   16 | **name** | str | The company’s common name.   17 | **ticker** | str | The stock market ticker symbol associated with the company’s common stock security.   18 | **isin** | str | The company's common securities identification 12-digit alphanumeric code.   19 | **primary_industry** | str | The primary industry associated with the company based on their main revenue generating operations.   20 | **country** | str | The country in which the company's headquarters or primary place of business is located.   21 | 22 | [//]: # (END_DEFINITION) 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/ETFSummary.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ETFSummary) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ETFSummary 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | The Intrinio ID of the ETF   16 | **name** | str | The common name of the ETF   17 | **ticker** | str | The common ticker symbol for the ETF   18 | **figi_ticker** | str | The OpenFIGI ticker for the ETF   19 | **ric** | str | Reuters Instrument Code (RIC) for the ETF   20 | **isin** | str | International Securities Identification Number (ISIN) for the ETF   21 | **sedol** | str | Stock Exchange Daily Official List (SEDOL) for the ETF   22 | **exchange_mic** | str | The exchange Market Identifier Code (MIC) from the International Standards Organization (ISO)   23 | 24 | [//]: # (END_DEFINITION) 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/EaseOfMovementTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:EaseOfMovementTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### EaseOfMovementTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **eom** | float | The Ease of Movement calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/EconomicIndex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:EconomicIndex) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### EconomicIndex 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | The Intrinio ID for the Index   16 | **symbol** | str | The symbol used to identify the Index   17 | **name** | str | The name of the Index   18 | **continent** | str | The continent of the country of focus for the Index   19 | **country** | str | The country of focus for the Index   20 | **update_frequency** | str | How often the Index is updated   21 | **last_updated** | datetime | When the Index was updated last   22 | **description** | str | A paragraph describing the index and its scope   23 | **observation_start** | date | The earliest date for which data is available   24 | **observation_end** | date | The latest date for which data is available   25 | **seasonal_adjustment** | str | Whether the data is adjusted to account for seasonality   26 | **units** | str | The units of the data   27 | 28 | [//]: # (END_DEFINITION) 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/EconomicIndexSummary.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:EconomicIndexSummary) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### EconomicIndexSummary 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | The Intrinio ID for the Index   16 | **symbol** | str | The symbol used to identify the Index   17 | **name** | str | The name of the Index   18 | **continent** | str | The continent of the country of focus for the Index   19 | **country** | str | The country of focus for the Index   20 | **update_frequency** | str | How often the Index is updated   21 | **last_updated** | datetime | When the Index was updated last   22 | **observation_start** | date | The earliest date for which data is available   23 | **observation_end** | date | The latest date for which data is available   24 | **seasonal_adjustment** | str | Whether the data is adjusted to account for seasonality   25 | **units** | str | The units of the data   26 | 27 | [//]: # (END_DEFINITION) 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/EodIndexPrice.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:EodIndexPrice) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### EodIndexPrice 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **index** | [**ApiResponseIndex**](ApiResponseIndex.md) | The index   16 | **close** | float | The close price   17 | **open** | float | The open price   18 | **high** | float | The high price   19 | **low** | float | The low price   20 | **volume** | int | The volume   21 | **date** | date | The date of the pricing data.   22 | 23 | [//]: # (END_DEFINITION) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:ApiResponseIndex) 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/EodIndexPriceSummary.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:EodIndexPriceSummary) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### EodIndexPriceSummary 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **close** | float | The close price   16 | **open** | float | The open price   17 | **high** | float | The high price   18 | **low** | float | The low price   19 | **volume** | int | The volume   20 | **date** | date | The date of the pricing data.   21 | 22 | [//]: # (END_DEFINITION) 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/FilingNote.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:FilingNote) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### FilingNote 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | The Intrinio ID of the note   16 | **xbrl_tag** | str | The XBRL Tag used for the note   17 | **content** | str | 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   18 | **filing** | [**FilingNoteFiling**](FilingNoteFiling.md) |   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:FilingNoteFiling) 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/FilingNoteFiling.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:FilingNoteFiling) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### FilingNoteFiling 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **cik** | str | The Central Index Key (CIK) assigned to the company   16 | **report_type** | str | The filing <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report type</a>   17 | **period_end_date** | date | The ending date of the fiscal period for the filing   18 | **filing_date** | date | The date the report was filed with the SEC   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/FilingNoteSummary.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:FilingNoteSummary) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### FilingNoteSummary 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | The Intrinio ID of the note   16 | **xbrl_tag** | str | The XBRL tag used for the note by the filing entity   17 | **filing** | [**FilingNoteFiling**](FilingNoteFiling.md) |   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:FilingNoteFiling) 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/FilingSummary.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:FilingSummary) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### FilingSummary 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | The Intrinio ID of the Filing   16 | **filing_date** | date | The date when the filing was submitted to the SEC by the company   17 | **accepted_date** | datetime | The date and time when the filing was accepted by SEC   18 | **period_end_date** | date | The ending date of the fiscal period for the filing   19 | **report_type** | str | The filing <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report type</a>   20 | **sec_unique_id** | str | A unique identifier for the filing provided by the SEC   21 | **filing_url** | str | The URL to the filing page on the SEC site   22 | **report_url** | str | The URL to the actual report on the SEC site   23 | **instance_url** | str | The URL for the XBRL filing for the report   24 | 25 | [//]: # (END_DEFINITION) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ForceIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ForceIndexTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ForceIndexTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **fi** | float | The Force Index calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/ForexCurrency.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ForexCurrency) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ForexCurrency 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **code** | str | The ISO 4217 currency code   16 | **name** | str | The name of the currency   17 | **country** | str | The country in which the currency is used   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/ForexPair.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ForexPair) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ForexPair 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **code** | str | The common code of the currency pair   16 | **base_currency** | str | The ISO 4217 currency code of the base currency   17 | **quote_currency** | str | The ISO 4217 currency code of the quote currency   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/ForexPrice.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ForexPrice) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ForexPrice 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **occurred_at** | str | 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.   16 | **open_bid** | float | Open bid   17 | **high_bid** | float | High bid   18 | **low_bid** | float | Low bid   19 | **close_bid** | float | Close bid   20 | **open_ask** | float | Open ask   21 | **high_ask** | float | High ask   22 | **low_ask** | float | Low ask   23 | **close_ask** | float | Close ask   24 | **total_ticks** | int | Total ticks   25 | 26 | [//]: # (END_DEFINITION) 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/HistoricalData.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:HistoricalData) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### HistoricalData 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date** | date | The date that the value is present   16 | **value** | float | The historical value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/IchimokuKinkoHyoTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:IchimokuKinkoHyoTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### IchimokuKinkoHyoTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **chikou_span** | float | The Chikou Span (Lagging Span) value of the Ichimoku Kinko Hyo calculation   17 | **kijun_sen** | float | The Kijun-sen (Base Line) value of the Ichimoku Kinko Hyo calculation   18 | **senkou_span_a** | float | The Senkou Span A (Leading Span A) value of the Ichimoku Kinko Hyo calculation   19 | **senkou_span_b** | float | The Senkou Span B (Leading Span B) value of the Ichimoku Kinko Hyo calculation   20 | **tenkan_sen** | float | The Tenskan-sen (Conversion Line) value of the Ichimoku Kinko Hyo calculation   21 | 22 | [//]: # (END_DEFINITION) 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/IndexInterval.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:IndexInterval) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### IndexInterval 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **time** | datetime | The timestamp that represents the start of the interval span.   16 | **open** | float | The first traded price during the period   17 | **close** | float | The last traded price during the period   18 | **high** | float | The highest price over the span of the period   19 | **low** | float | The lowest price over the span of the period   20 | **close_time** | datetime | The timestamp that represents the end of the interval span.   21 | **interval** | str | The size of the interval.   22 | **average** | float | The average trade price of an individual stock during the interval.   23 | **change** | float | The change ratio from open to close. ((Close - Open)/Open).   24 | 25 | [//]: # (END_DEFINITION) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/KeltnerChannelTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:KeltnerChannelTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### KeltnerChannelTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **lower_band** | float | The lower band value of the Keltner Channel calculation   17 | **middle_band** | float | The middle band value of the Keltner Channel calculation   18 | **upper_band** | float | The upper band value of the Keltner Channel calculation   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/KnowSureThingTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:KnowSureThingTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### KnowSureThingTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **kst** | float | The Know Sure Thing calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/MarketStatusResult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:MarketStatusResult) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### MarketStatusResult 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **timestamp** | datetime | The UTC timestamp.   16 | **is_open** | bool | Whether the market is open or not.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/MassIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:MassIndexTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### MassIndexTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **mi** | float | The Mass Index calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/MoneyFlowIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:MoneyFlowIndexTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### MoneyFlowIndexTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **mfi** | float | The Money Flow Index calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/MovingAverageConvergenceDivergenceTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:MovingAverageConvergenceDivergenceTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### MovingAverageConvergenceDivergenceTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **macd_histogram** | float | The histogram value of the Moving Average Convergence Divergence calculation   17 | **macd_line** | float | The line value of the Moving Average Convergence Divergence calculation   18 | **signal_line** | float | The signal line value of the Moving Average Convergence Divergence calculation   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/NegativeVolumeIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:NegativeVolumeIndexTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### NegativeVolumeIndexTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **nvi** | float | The Negative Volume Index calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/NewsTopic.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:NewsTopic) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### NewsTopic 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **name** | str | The description of the topic.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/OnBalanceVolumeMeanTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OnBalanceVolumeMeanTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OnBalanceVolumeMeanTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **obv_mean** | float | The On-balance Volume Mean calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/OnBalanceVolumeTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OnBalanceVolumeTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OnBalanceVolumeTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **obv** | float | The On-balance Volume calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/OptionChain.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionChain) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionChain 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **option** | [**Option**](Option.md) |   16 | **price** | [**OptionPrice**](OptionPrice.md) |   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:Option) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:OptionPrice) 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/OptionChainEod.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionChainEod) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionChainEod 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **option** | [**OptionEod**](OptionEod.md) |   16 | **prices** | [**OptionPriceEod**](OptionPriceEod.md) |   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:OptionEod) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:OptionPriceEod) 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/OptionChainRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionChainRealtime) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionChainRealtime 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **option** | [**OptionRealtime**](OptionRealtime.md) |   16 | **price** | [**OptionPriceRealtime**](OptionPriceRealtime.md) |   17 | **stats** | [**OptionStatsRealtime**](OptionStatsRealtime.md) |   18 | **extended_price** | [**OptionPriceRealtimeExtended**](OptionPriceRealtimeExtended.md) |   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:OptionRealtime) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:OptionPriceRealtime) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:OptionStatsRealtime) 30 | 31 | 32 | [//]: # (CONTAINED_CLASS:OptionPriceRealtimeExtended) 33 | 34 | 35 | 36 | -------------------------------------------------------------------------------- /docs/OptionContractsList.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionContractsList) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionContractsList 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **contracts** | list[str] |   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/OptionFactorsRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionFactorsRealtime) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionFactorsRealtime 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **market_price** | float | The market price of the options contract   16 | **underlying_price** | float | The market price of the underlying asset   17 | **strike_price** | float | The strike price of the options contract   18 | **days_to_expiration** | float | The number of days to expiration   19 | **risk_free_interest_rate** | float | The current risk-free interest rate, as measured by the 3-month Treasury Bill rate   20 | **dividend_yield** | float | The dividend yield of the underlying asset (if applicable)   21 | 22 | [//]: # (END_DEFINITION) 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/OptionImpliedMoveData.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionImpliedMoveData) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionImpliedMoveData 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **amount** | float | The amount of the implied move.   16 | **percentage** | float | The percentage of the implied move.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/OptionInterval.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionInterval) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionInterval 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **open_time** | datetime | The UTC timestamp for the time this interval opened.   16 | **close_time** | datetime | The UTC timestamp for the time this interval closed.   17 | **open** | float | The first traded contract price in this interval.   18 | **high** | float | The highest traded contract price in this interval.   19 | **low** | float | The lowest traded contract price in this interval.   20 | **close** | float | The last traded contract price in this interval.   21 | **volume** | float | The volume of contracts traded in this interval.   22 | **average** | float | The volume weighted average price of contract trades in this interval.   23 | **change** | float | The ratio of Close minus Open to Open.   24 | **trade_count** | float | The number of qualified trades executed during the period   25 | 26 | [//]: # (END_DEFINITION) 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/OptionIntervalMover.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionIntervalMover) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionIntervalMover 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **contract** | str | The option contract for the intervals   16 | **change** | float | The ratio of Close minus Open to Open.   17 | **open** | float | The first traded contract price in this interval.   18 | **high** | float | The highest traded contract price in this interval.   19 | **low** | float | The lowest traded contract price in this interval.   20 | **close** | float | The last traded contract price in this interval.   21 | **volume** | float | The volume of contracts traded in this interval.   22 | **average** | float | The volume weighted average price of contract trades in this interval.   23 | **trade_count** | float | The number of contract trades executed in this interval   24 | 25 | [//]: # (END_DEFINITION) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/OptionIntervalsMoversResult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionIntervalsMoversResult) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionIntervalsMoversResult 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **open_time** | datetime | The UTC timestamp for the time this interval opened.   16 | **close_time** | datetime | The UTC timestamp for the time this interval closed.   17 | **size** | str | The size of the time span for the interval.   18 | **intervals** | [**list[OptionIntervalMover]**](OptionIntervalMover.md) | Array of all the intervals in the result.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:OptionIntervalMover) 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/OptionIntervalsResult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionIntervalsResult) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionIntervalsResult 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **intervals** | [**list[OptionInterval]**](OptionInterval.md) | Array of all the intervals in the result.   16 | **contract** | str | The option contract for the intervals   17 | **size** | str | The size of the time span for the interval.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:OptionInterval) 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/OptionPriceBatchRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionPriceBatchRealtime) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionPriceBatchRealtime 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **price** | [**OptionPriceRealtime**](OptionPriceRealtime.md) |   16 | **stats** | [**OptionStatsRealtime**](OptionStatsRealtime.md) |   17 | **option** | [**OptionRealtime**](OptionRealtime.md) |   18 | **extended_price** | [**OptionPriceRealtimeExtended**](OptionPriceRealtimeExtended.md) |   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:OptionPriceRealtime) 24 | 25 | 26 | [//]: # (CONTAINED_CLASS:OptionStatsRealtime) 27 | 28 | 29 | [//]: # (CONTAINED_CLASS:OptionRealtime) 30 | 31 | 32 | [//]: # (CONTAINED_CLASS:OptionPriceRealtimeExtended) 33 | 34 | 35 | 36 | -------------------------------------------------------------------------------- /docs/OptionPriceRealtimeExtended.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionPriceRealtimeExtended) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionPriceRealtimeExtended 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **bid_open** | float | The price of the bid at open   16 | **bid_high** | float | The high bid so far today   17 | **bid_low** | float | The low bid so far today   18 | **ask_open** | float | The price of the ask at open   19 | **ask_high** | float | The high ask so far today   20 | **ask_low** | float | The low ask so far today   21 | **trade_open** | float | The price of the trade at open   22 | **trade_high** | float | The high trade so far today   23 | **trade_low** | float | The low trade so far today   24 | **ask_close** | float | The price of ask at close today   25 | **bid_close** | float | The price of bid at close today   26 | **trade_close** | float | The price of the last trade of the day   27 | **mark** | float | The mark price   28 | 29 | [//]: # (END_DEFINITION) 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/OptionRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionRealtime) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionRealtime 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **code** | str | The Intrinio Code for the Option.   16 | **ticker** | str | The ticker symbol of the Security for the Option.   17 | **expiration** | date | The date on which the Option expires. The Option becomes invalid after this date and cannot be exercised.   18 | **strike** | float | 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.   19 | **type** | str | The type of Option (put or call).   20 | 21 | [//]: # (END_DEFINITION) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/OptionSnapshotGroup.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionSnapshotGroup) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionSnapshotGroup 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **time** | datetime | The UTC timestamp of this snapshot group.   16 | **files** | list[object] | List of all the snapshot parts of this group.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/OptionSnapshotsResult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionSnapshotsResult) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionSnapshotsResult 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **snapshots** | [**list[OptionSnapshotGroup]**](OptionSnapshotGroup.md) | List of all the snapshot groups comprising the queried result.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:OptionSnapshotGroup) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/OptionStatsRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionStatsRealtime) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionStatsRealtime 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **implied_volatility** | float | The implied volatility of the contract calculated using the Black-Scholes Model.   16 | **delta** | float | Delta represents the rate of change between the option's price and a $1 change in the underlying asset's price.   17 | **gamma** | float | Gamma represents the rate of change between an option's delta and the underlying asset's price.   18 | **theta** | float | Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay.   19 | **vega** | float | Vega represents the rate of change between an option's value and the underlying asset's implied volatility.   20 | **underlying_price** | float | The most recent trade price of the underlying asset.   21 | 22 | [//]: # (END_DEFINITION) 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/OptionSyntheticGreeksRealtime.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionSyntheticGreeksRealtime) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionSyntheticGreeksRealtime 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **implied_volatility** | float | The implied volatility of the contract calculated using the Black-Scholes Model.   16 | **delta** | float | Delta represents the rate of change between the option's price and a $1 change in the underlying asset's price.   17 | **gamma** | float | Gamma represents the rate of change between an option's delta and the underlying asset's price.   18 | **theta** | float | Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay.   19 | **vega** | float | Vega represents the rate of change between an option's value and the underlying asset's implied volatility.   20 | **synthetic_price** | float | The derived synthetic price of the contract.   21 | 22 | [//]: # (END_DEFINITION) 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/OptionTrades.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionTrades) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionTrades 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **contract** | str | The option contract   16 | **underlying_symbol** | str | The ticker symbol   17 | **timestamp** | datetime | The UTC timestamp at the time of the trade.   18 | **price** | float | The price of the trade.   19 | **size** | float | The size of the trade.   20 | **total_volume** | float | The total volume of the symbol for the day up to the timestamp point in time.   21 | **ask_price_at_execution** | float | The price of ask quote at the time of the trade.   22 | **bid_price_at_execution** | float | The price of bid quote at the time of the trade.   23 | **exchange** | str | The exchange for the trade.   24 | **conditions** | str | The condition of the trade.   25 | **sequence_id** | float | The sequential ID for the trade, ordered as temporally received from the exchange.   26 | 27 | [//]: # (END_DEFINITION) 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/OptionTradesResult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionTradesResult) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionTradesResult 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   16 | **source** | str | The source of the trades.   17 | **trades** | [**list[OptionTrades]**](OptionTrades.md) | Array of all the trades in this page of the result.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:OptionTrades) 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/OptionsAggregate.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionsAggregate) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionsAggregate 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **ticker** | str | The ticker symbol of the Security for the Option.   16 | **date** | str | The date of the data.   17 | **total_open_interest** | int | Total open interest for the ticker   18 | **total_volume** | int | Total volume for the ticker   19 | **total_put_volume** | int | Total put volume for the ticker   20 | **total_call_volume** | int | Total call volume for the ticker   21 | **put_call_volume_ratio** | float | Total put volume to total call volume ratio for the ticker   22 | **contract_count** | int | Total number of active contracts for the ticker   23 | 24 | [//]: # (END_DEFINITION) 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/OptionsPriceEod.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OptionsPriceEod) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OptionsPriceEod 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **price** | [**OptionPriceEod**](OptionPriceEod.md) |   16 | **option** | [**OptionEod**](OptionEod.md) |   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:OptionPriceEod) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:OptionEod) 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/OwnerSummary.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:OwnerSummary) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### OwnerSummary 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **owner_cik** | str | The Central Index Key issued by the SEC, which is the unique identifier all owner filings   16 | **owner_name** | str | The name of the owner   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/RealtimeIndexPrice.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:RealtimeIndexPrice) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### RealtimeIndexPrice 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **last_price** | float | The last price   16 | **last_time** | datetime | The timestamp of the last price   17 | **index** | [**RealtimeIndexPriceIndex**](RealtimeIndexPriceIndex.md) |   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:RealtimeIndexPriceIndex) 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/RealtimeIndexPriceIndex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:RealtimeIndexPriceIndex) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### RealtimeIndexPriceIndex 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **symbol** | str | The current ticker of the index   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/RealtimeStockPriceSecurity.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:RealtimeStockPriceSecurity) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### RealtimeStockPriceSecurity 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | The Intrinio ID for Security   16 | **ticker** | str | The common/local ticker of the Security   17 | **exchange_ticker** | str | The exchange-level ticker   18 | **figi** | str | The OpenFIGI identifier   19 | **composite_figi** | str | The country-composite OpenFIGI identifier   20 | 21 | [//]: # (END_DEFINITION) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/RelativeStrengthIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:RelativeStrengthIndexTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### RelativeStrengthIndexTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **rsi** | float | The Relative Strength Index calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/ReportedFinancial.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ReportedFinancial) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ReportedFinancial 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **xbrl_tag** | [**ReportedTag**](ReportedTag.md) |   16 | **value** | float | The value reported for the XBRL Tag within the scope of the Fundamental   17 | **dimensions** | [**list[ReportedFinancialDimension]**](ReportedFinancialDimension.md) | The combination of XBRL axis and members that defines the dimensionalization of this fact (if any)   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:ReportedTag) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:ReportedFinancialDimension) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ReportedFinancialDimension.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ReportedFinancialDimension) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ReportedFinancialDimension 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **axis** | str | The axis of the dimension   16 | **member** | str | The member of the axis   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/ReportedTag.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ReportedTag) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ReportedTag 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **tag** | str | The tag code   16 | **name** | str | The tag name   17 | **balance** | str | Whether the tag represents a credit or debit   18 | **unit** | str | The unit of the tag   19 | **abstract** | bool | If True, the tag is an abstract and does not represent a nominal value   20 | **sequence** | int | The vertical sequence of the tag when displayed in the financial statement   21 | **depth** | int | The horizontal depth of the tag when displayed in the financial statement   22 | 23 | [//]: # (END_DEFINITION) 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/SICIndex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:SICIndex) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### SICIndex 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | Intrinio ID for the Index   16 | **symbol** | str | The symbol used to identify the Index   17 | **name** | str | The name of the Index   18 | **continent** | str | The continent of the country of focus for the Index   19 | **country** | str | The country of focus for the Index   20 | 21 | [//]: # (END_DEFINITION) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/SecurityHistory.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:SecurityHistory) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### SecurityHistory 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | The Intrinio ID for the Security   16 | **ticker** | str | The common ticker   17 | **name** | str | The name of the Security   18 | **security_code** | str | A 2-3 digit code classifying the Security (<a href=\"https://docs.intrinio.com/documentation/security_codes\" target=\"_blank\">reference</a>)   19 | **figi** | str | The exchange-level OpenFIGI identifier   20 | **composite_figi** | str | The country-composite OpenFIGI identifier   21 | **first_price_date** | date | The date of the first recorded stock price   22 | **last_price_date** | date | The date of the last recorded stock price (or the most recent trading day)   23 | 24 | [//]: # (END_DEFINITION) 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/SecurityHistoryListResult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:SecurityHistoryListResult) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### SecurityHistoryListResult 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **securities** | [**list[SecurityHistory]**](SecurityHistory.md) | Array of security ticker history.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:SecurityHistory) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/SecurityIntervalMover.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:SecurityIntervalMover) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### SecurityIntervalMover 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **symbol** | str | The ticker symbol for the interval   16 | **change** | float | The ratio of Close minus Open to Open.   17 | **open** | float | The first traded price in this interval.   18 | **high** | float | The highest traded price in this interval.   19 | **low** | float | The lowest traded price in this interval.   20 | **close** | float | The last traded price in this interval.   21 | **volume** | float | The volume of shares in this interval.   22 | **average** | float | The volume weighted average price of trades in this interval.   23 | **trade_count** | float | The of trades in this interval.   24 | 25 | [//]: # (END_DEFINITION) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/SecurityIntervalsMoversResult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:SecurityIntervalsMoversResult) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### SecurityIntervalsMoversResult 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **open_time** | datetime | The UTC timestamp for the time this interval opened.   16 | **close_time** | datetime | The UTC timestamp for the time this interval closed.   17 | **size** | str | The size of the time span for the interval.   18 | **intervals** | [**list[SecurityIntervalMover]**](SecurityIntervalMover.md) | Array of all the intervals in the result.   19 | 20 | [//]: # (END_DEFINITION) 21 | 22 | 23 | [//]: # (CONTAINED_CLASS:SecurityIntervalMover) 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/SecurityReplayFileResult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:SecurityReplayFileResult) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### SecurityReplayFileResult 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **name** | str | The name of the file.   16 | **url** | str | The url where the file may be downloaded.   17 | **size** | float | The size of the file in bytes.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/SecurityScreenClause.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:SecurityScreenClause) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### SecurityScreenClause 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **field** | str | The field to use when screening, such as an Intrinio Data Tag   16 | **operator** | str | The logic operator to use when screening   17 | **value** | str | The value to screen by   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/SecurityScreenGroup.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:SecurityScreenGroup) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### SecurityScreenGroup 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **operator** | str | The logic operator for the group (AND, OR, NOT)   16 | **clauses** | [**list[SecurityScreenClause]**](SecurityScreenClause.md) | The logic clauses in the group   17 | **groups** | [**list[SecurityScreenGroup]**](SecurityScreenGroup.md) | The nested groups within the group   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:SecurityScreenClause) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:SecurityScreenGroup) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/SecurityScreenResult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:SecurityScreenResult) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### SecurityScreenResult 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **security** | [**SecuritySummary**](SecuritySummary.md) |   16 | **data** | [**list[SecurityScreenResultData]**](SecurityScreenResultData.md) |   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:SecuritySummary) 22 | 23 | 24 | [//]: # (CONTAINED_CLASS:SecurityScreenResultData) 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/SecurityScreenResultData.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:SecurityScreenResultData) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### SecurityScreenResultData 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **tag** | str | The data tag that was screened-for   16 | **number_value** | str | The numeric value for the tag   17 | **text_value** | str | The text value for the tag   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/SecuritySnapshotGroup.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:SecuritySnapshotGroup) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### SecuritySnapshotGroup 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **time** | datetime | The UTC timestamp of this snapshot group.   16 | **files** | list[object] | List of all the snapshot parts of this group.   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/SecuritySnapshotsResult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:SecuritySnapshotsResult) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### SecuritySnapshotsResult 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **snapshots** | [**list[SecuritySnapshotGroup]**](SecuritySnapshotGroup.md) | List of all the snapshot groups comprising the queried result.   16 | 17 | [//]: # (END_DEFINITION) 18 | 19 | 20 | [//]: # (CONTAINED_CLASS:SecuritySnapshotGroup) 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/SecurityTrades.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:SecurityTrades) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### SecurityTrades 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **symbol** | str | The ticker symbol   16 | **timestamp** | datetime | The UTC timestamp at the time of the trade.   17 | **price** | float | The price of the trade.   18 | **size** | float | The size of the trade.   19 | **total_volume** | float | The total volume of the symbol for the day up to the timestamp point in time.   20 | **market_center** | str | The market center for the trade.   21 | **condition** | str | The condition of the trade.   22 | **is_darkpool** | bool | If the trade was darkpool or not.   23 | 24 | [//]: # (END_DEFINITION) 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/SecurityTradesResult.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:SecurityTradesResult) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### SecurityTradesResult 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **next_page** | str | The token required to request the next page of the data. If null, no further results are available.   16 | **source** | str | The source of the trades.   17 | **trades** | [**list[SecurityTrades]**](SecurityTrades.md) | Array of all the trades in this page of the result.   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:SecurityTrades) 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/SimpleMovingAverageTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:SimpleMovingAverageTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### SimpleMovingAverageTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **sma** | float | The Simple Moving Average calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/StandardizedFinancial.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:StandardizedFinancial) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### StandardizedFinancial 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **data_tag** | [**DataTagSummary**](DataTagSummary.md) |   16 | **value** | float | The value for the Data Tag within the scope of the Fundamental   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | [//]: # (CONTAINED_CLASS:DataTagSummary) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/StandardizedFinancialsDimension.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:StandardizedFinancialsDimension) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### StandardizedFinancialsDimension 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **dimension** | str | The title of the dimension   16 | **value** | str | The value of the dimension   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/StochasticOscillatorTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:StochasticOscillatorTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### StochasticOscillatorTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **sr** | float | The Stochastic Oscillator calculation value   17 | **sr_signal** | float | The Stochastic Oscillator signal line value   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/StockExchange.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:StockExchange) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### StockExchange 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | The Intrinio ID for the Stock Exchange   16 | **name** | str | The name of the exchange   17 | **mic** | str | The Market Identifier Code (MIC) of the exchange   18 | **acronym** | str | The acronym of the exchange's name   19 | **city** | str | The city in which the exchange is located   20 | **country** | str | The country in which the exchange is located   21 | **country_code** | str | The 2-digit code of the exchange's country   22 | **website** | str | The website of the exchange   23 | **first_stock_price_date** | date | The earliest date for which Intrinio has stock prices for the exchange   24 | **last_stock_price_date** | date | The latest date for which Intrinio has stock prices for the exchange   25 | 26 | [//]: # (END_DEFINITION) 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/StockExchangeMover.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:StockExchangeMover) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### StockExchangeMover 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **security_id** | str | The Intrinio Identifier for this security.   16 | **ticker** | str | The ticker symbol for this security.   17 | **last_price** | float | The last price of the last trade.   18 | **change** | float | The raw change in price.   19 | **percent_change** | float | The percent change in price.   20 | **market_volume** | float | The market volume for the most recent (today) trading day.   21 | **source** | str | The source of the data.   22 | 23 | [//]: # (END_DEFINITION) 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/StockMarketIndex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:StockMarketIndex) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### StockMarketIndex 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | Intrinio ID for the Index   16 | **symbol** | str | The symbol used to identify the Index   17 | **name** | str | The name of the Index   18 | **continent** | str | The continent of the country of focus for the Index   19 | **country** | str | The country of focus for the Index   20 | **update_frequency** | str | How often the Index is updated   21 | **last_updated** | datetime | When the Index was updated last   22 | **description** | str | A paragraph describing the index and its scope   23 | **observation_start** | date | The earliest date for which data is available   24 | **observation_end** | date | The latest date for which data is available   25 | 26 | [//]: # (END_DEFINITION) 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/StockMarketIndexSummary.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:StockMarketIndexSummary) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### StockMarketIndexSummary 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | Intrinio ID for the Index   16 | **symbol** | str | The symbol used to identify the Index   17 | **name** | str | The name of the Index   18 | **continent** | str | The continent of the country of focus for the Index   19 | **country** | str | The country of focus for the Index   20 | **update_frequency** | str | How often the Index is updated   21 | **last_updated** | datetime | When the Index was updated last   22 | **observation_start** | date | The earliest date for which data is available   23 | **observation_end** | date | The latest date for which data is available   24 | 25 | [//]: # (END_DEFINITION) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/StockPriceAdjustment.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:StockPriceAdjustment) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### StockPriceAdjustment 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date** | date | The date on which the adjustment occurred. The adjustment should be applied to all stock prices before this date.   16 | **factor** | float | The factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.   17 | **dividend** | float | The dividend amount, if a dividend was paid.   18 | **dividend_currency** | str | The currency of the dividend, if known.   19 | **split_ratio** | float | The ratio of the stock split, if a stock split occurred.   20 | **security** | [**SecuritySummary**](SecuritySummary.md) | The Security of the stock price   21 | 22 | [//]: # (END_DEFINITION) 23 | 24 | 25 | [//]: # (CONTAINED_CLASS:SecuritySummary) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/StockPriceAdjustmentSummary.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:StockPriceAdjustmentSummary) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### StockPriceAdjustmentSummary 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date** | date | The date on which the adjustment occurred. The adjustment should be applied to all stock prices before this date.   16 | **factor** | float | The factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.   17 | **dividend** | float | The dividend amount, if a dividend was paid.   18 | **dividend_currency** | str | The currency of the dividend, if known.   19 | **split_ratio** | float | The ratio of the stock split, if a stock split occurred.   20 | 21 | [//]: # (END_DEFINITION) 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/TechnicalIndicator.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:TechnicalIndicator) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### TechnicalIndicator 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **name** | str | The name of the Technical Indicator   16 | **symbol** | str | The symbol of the Technical Indicator   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/TheaEntityAnswer.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:TheaEntityAnswer) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### TheaEntityAnswer 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **answer** | str | The summarized answer returned from Thea   16 | **content** | str | The underlying content the answer was sourced from   17 | **source_documents** | [**list[TheaSourceDocument]**](TheaSourceDocument.md) | The documents from which Thea answer data is sourced   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | [//]: # (CONTAINED_CLASS:TheaSourceDocument) 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /docs/TheaSourceDocument.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:TheaSourceDocument) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### TheaSourceDocument 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | The unique id for the Thea source document   16 | **date_time** | date | The date at which the document was created   17 | **tags** | list[object] | Entity identifying tags associated with the source document   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/TripleExponentialAverageTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:TripleExponentialAverageTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### TripleExponentialAverageTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **trix** | float | The Triple Exponential Average calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/TrueStrengthIndexTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:TrueStrengthIndexTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### TrueStrengthIndexTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **tsi** | float | The True Strength Index calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/UltimateOscillatorTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:UltimateOscillatorTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### UltimateOscillatorTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **uo** | float | The Ultimate Oscillator calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/VolumePriceTrendTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:VolumePriceTrendTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### VolumePriceTrendTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **vpt** | float | The Volume-price Trend calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/VolumeWeightedAveragePriceValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:VolumeWeightedAveragePriceValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### VolumeWeightedAveragePriceValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date and time of the observation   16 | **vwap** | float | The Volume Weighted Average Price calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/VortexIndicatorTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:VortexIndicatorTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### VortexIndicatorTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **negative_vi** | float | The negative Vortex Indicator value   17 | **positive_vi** | float | The positive Vortex Indicator value   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/WilliamsRTechnicalValue.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:WilliamsRTechnicalValue) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### WilliamsRTechnicalValue 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **date_time** | datetime | The date_time of the observation   16 | **wr** | float | The Willaims %R calculation value   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/ZacksAnalystRatingSummary.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ZacksAnalystRatingSummary) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ZacksAnalystRatingSummary 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **id** | str | The Intrinio ID for the record   16 | **date** | date | The date of the Zacks Analyst Rating.   17 | **mean** | float | The mean (average) weighing of analyst recommendations, from 1 (strong buy) to 5 (strong sell).   18 | **strong_buys** | int | The number of analysts recommending Strong Buy.   19 | **buys** | int | The number of analysts recommending Buy.   20 | **holds** | int | The number of analysts recommending Hold.   21 | **sells** | int | The number of analysts recommending Sell.   22 | **strong_sells** | int | The number of analysts recommending Strong Sell.   23 | **total** | int | The total number of analyst recommendations.   24 | 25 | [//]: # (END_DEFINITION) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ZacksEBITDAConsensus.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ZacksEBITDAConsensus) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ZacksEBITDAConsensus 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **ticker** | str | The Zacks common exchange ticker   16 | **company_name** | str | The company name   17 | **estimate_year** | float | Fiscal year of the estimate   18 | **estimate_month** | float | Fiscal month of the estimate   19 | **period** | str | Whether the estimate year and month are fiscal year (fy) or quarter (fq)   20 | **consensus_type** | str | The type of estimate (ebitda, ebitda, ebit, enterprise_value, cash_flow_per_share, pretax_income)   21 | **estimate_count** | float | The number of estimates   22 | **high** | float | The highest estimate   23 | **low** | float | The lowest estimate   24 | **mean** | float | The mean value of all estimates   25 | **std_dev** | float | The standard deviation of all estimates   26 | 27 | [//]: # (END_DEFINITION) 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/ZacksETFHolding.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ZacksETFHolding) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ZacksETFHolding 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **etf_ticker** | str | The ETF's common ticker   16 | **etf_name** | str | The ETF's name   17 | **holding_symbol** | str | The holding's common ticker   18 | **holding_name** | str | The holding's name   19 | **date_of_holding** | date | The date of the holding   20 | **shares** | float | The number of shares   21 | **weight** | float | The weight of the holding   22 | 23 | [//]: # (END_DEFINITION) 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/ZacksForwardPE.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ZacksForwardPE) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ZacksForwardPE 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **ticker** | str | The Zacks common exchange ticker   16 | **company_name** | str | The company name   17 | **forward_pe_year1** | float | The forward PE estimate for the first year   18 | **forward_pe_year2** | float | The forward PE estimate for the second year   19 | **forward_pe_year3** | float | The forward PE estimate for the third year   20 | **forward_pe_year4** | float | The forward PE estimate for the fourth year   21 | **forward_pe_year5** | float | The forward PE estimate for the fifth year   22 | **forward_peg_ratio_year1** | float | The forward PEG ratio for the first year   23 | **last_ttm_eps** | float | Trailing twelve months earnings per share   24 | 25 | [//]: # (END_DEFINITION) 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/ZacksInstitutionalHoldingCompanySummary.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ZacksInstitutionalHoldingCompanySummary) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ZacksInstitutionalHoldingCompanySummary 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **ticker** | str | The Zacks common exchange ticker   16 | **name** | str | The company name of the stock listed   17 | **exchange** | str | Exhange where the stock is traded whose shares are held by the institution   18 | 19 | [//]: # (END_DEFINITION) 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /docs/ZacksInstitutionalHoldingHistoricalSummary.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ZacksInstitutionalHoldingHistoricalSummary) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ZacksInstitutionalHoldingHistoricalSummary 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **as_of_date** | date | The date of the institutional holding   16 | **shares_held** | float | The number of shares held   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/ZacksInstitutionalHoldingOwnerSummary.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [//]: # (CLASS:ZacksInstitutionalHoldingOwnerSummary) 4 | 5 | [//]: # (KIND:object) 6 | 7 | ### ZacksInstitutionalHoldingOwnerSummary 8 | 9 | #### Properties 10 | 11 | [//]: # (START_DEFINITION) 12 | 13 | Name | Type | Description 14 | ------------ | ------------- | ------------- 15 | **name** | str | The owner's name   16 | **cik** | str | The Central Index Key (CIK) assigned to the company by the SEC as a unique identifier, used in SEC filings   17 | 18 | [//]: # (END_DEFINITION) 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | certifi >= 14.05.14 2 | six >= 1.10 3 | python_dateutil >= 2.5.3 4 | setuptools >= 21.0.0 5 | urllib3 >= 1.15.1 6 | retrying >= 1.3.3 7 | -------------------------------------------------------------------------------- /test-requirements.txt: -------------------------------------------------------------------------------- 1 | coverage>=4.0.3 2 | nose>=1.3.7 3 | pluggy>=0.3.1 4 | py>=1.4.31 5 | randomize>=0.13 6 | -------------------------------------------------------------------------------- /test/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/intrinio/python-sdk/95e15169865e8cda9c1d45457a3fe601ee3c26e2/test/__init__.py -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py27, py3 3 | 4 | [testenv] 5 | deps=-r{toxinidir}/requirements.txt 6 | -r{toxinidir}/test-requirements.txt 7 | 8 | commands= 9 | nosetests \ 10 | [] --------------------------------------------------------------------------------