├── .babelrc
├── .gitignore
├── .openapi-generator-ignore
├── .openapi-generator
├── FILES
└── VERSION
├── .travis.yml
├── LICENSE
├── README.md
├── dist
├── ApiClient.js
├── api
│ └── DefaultApi.js
├── index.js
└── model
│ ├── AggregateIndicators.js
│ ├── AirlinePriceIndex.js
│ ├── AirlinePriceIndexData.js
│ ├── BasicFinancials.js
│ ├── BondCandles.js
│ ├── BondProfile.js
│ ├── BondTickData.js
│ ├── BondYieldCurve.js
│ ├── BondYieldCurveInfo.js
│ ├── BreakdownItem.js
│ ├── Company.js
│ ├── CompanyESG.js
│ ├── CompanyESG2.js
│ ├── CompanyEarningsQualityScore.js
│ ├── CompanyEarningsQualityScoreData.js
│ ├── CompanyExecutive.js
│ ├── CompanyNews.js
│ ├── CompanyNewsStatistics.js
│ ├── CompanyProfile.js
│ ├── CompanyProfile2.js
│ ├── CongressionalTrading.js
│ ├── CongressionalTransaction.js
│ ├── CountryMetadata.js
│ ├── CovidInfo.js
│ ├── CryptoCandles.js
│ ├── CryptoProfile.js
│ ├── CryptoSymbol.js
│ ├── Development.js
│ ├── Dividends.js
│ ├── Dividends2.js
│ ├── Dividends2Basic.js
│ ├── Dividends2Info.js
│ ├── DocumentResponse.js
│ ├── ETFCountryExposureData.js
│ ├── ETFHoldingsData.js
│ ├── ETFProfileData.js
│ ├── ETFSectorExposureData.js
│ ├── ETFsCountryExposure.js
│ ├── ETFsHoldings.js
│ ├── ETFsIndustryExposure.js
│ ├── ETFsProfile.js
│ ├── ETFsSectorExposure.js
│ ├── EarningEstimate.js
│ ├── EarningRelease.js
│ ├── EarningResult.js
│ ├── EarningsCalendar.js
│ ├── EarningsCallTranscripts.js
│ ├── EarningsCallTranscriptsList.js
│ ├── EarningsEstimates.js
│ ├── EarningsEstimatesInfo.js
│ ├── EbitEstimates.js
│ ├── EbitEstimatesInfo.js
│ ├── EbitdaEstimates.js
│ ├── EbitdaEstimatesInfo.js
│ ├── EconomicCalendar.js
│ ├── EconomicCode.js
│ ├── EconomicData.js
│ ├── EconomicDataInfo.js
│ ├── EconomicEvent.js
│ ├── EmployeeCount.js
│ ├── Estimate.js
│ ├── ExcerptResponse.js
│ ├── FDAComitteeMeeting.js
│ ├── Filing.js
│ ├── FilingResponse.js
│ ├── FilingSentiment.js
│ ├── FinancialStatements.js
│ ├── FinancialsAsReported.js
│ ├── ForexCandles.js
│ ├── ForexSymbol.js
│ ├── Forexrates.js
│ ├── FundOwnership.js
│ ├── FundOwnershipInfo.js
│ ├── HistoricalCompanyESG.js
│ ├── HistoricalEmployeeCount.js
│ ├── HistoricalMarketCapData.js
│ ├── HistoricalNBBO.js
│ ├── IPOCalendar.js
│ ├── IPOEvent.js
│ ├── InFilingResponse.js
│ ├── InFilingSearchBody.js
│ ├── IndexHistoricalConstituent.js
│ ├── Indicator.js
│ ├── IndicesConstituents.js
│ ├── IndicesConstituentsBreakdown.js
│ ├── IndicesHistoricalConstituents.js
│ ├── InsiderSentiments.js
│ ├── InsiderSentimentsData.js
│ ├── InsiderTransactions.js
│ ├── InstitutionalOwnership.js
│ ├── InstitutionalOwnershipGroup.js
│ ├── InstitutionalOwnershipInfo.js
│ ├── InstitutionalPortfolio.js
│ ├── InstitutionalPortfolioGroup.js
│ ├── InstitutionalPortfolioInfo.js
│ ├── InstitutionalProfile.js
│ ├── InstitutionalProfileInfo.js
│ ├── InternationalFiling.js
│ ├── InvestmentThemePortfolio.js
│ ├── InvestmentThemes.js
│ ├── InvestmentThemesThematicInvesting.js
│ ├── Investor.js
│ ├── InvestorsOwnership.js
│ ├── IsinChange.js
│ ├── IsinChangeInfo.js
│ ├── KeyCustomersSuppliers.js
│ ├── LastBidAsk.js
│ ├── LobbyingData.js
│ ├── LobbyingResult.js
│ ├── MajorDevelopments.js
│ ├── MajorPressReleases.js
│ ├── MarketCapData.js
│ ├── MarketHoliday.js
│ ├── MarketHolidayData.js
│ ├── MarketNews.js
│ ├── MarketStatus.js
│ ├── MutualFundCountryExposure.js
│ ├── MutualFundCountryExposureData.js
│ ├── MutualFundEet.js
│ ├── MutualFundEetPai.js
│ ├── MutualFundHoldings.js
│ ├── MutualFundHoldingsData.js
│ ├── MutualFundProfile.js
│ ├── MutualFundProfileData.js
│ ├── MutualFundSectorExposure.js
│ ├── MutualFundSectorExposureData.js
│ ├── MutualFundsCountryExposure.js
│ ├── MutualFundsHoldings.js
│ ├── MutualFundsProfile.js
│ ├── News.js
│ ├── NewsSentiment.js
│ ├── Ownership.js
│ ├── OwnershipInfo.js
│ ├── PatternRecognition.js
│ ├── PressRelease.js
│ ├── PriceMetrics.js
│ ├── PriceTarget.js
│ ├── Quote.js
│ ├── RecommendationTrend.js
│ ├── RedditSentimentContent.js
│ ├── Report.js
│ ├── RevenueBreakdown.js
│ ├── RevenueEstimates.js
│ ├── RevenueEstimatesInfo.js
│ ├── SECSentimentAnalysis.js
│ ├── SearchBody.js
│ ├── SearchFilter.js
│ ├── SearchResponse.js
│ ├── SectorMetric.js
│ ├── SectorMetricData.js
│ ├── Sentiment.js
│ ├── SentimentContent.js
│ ├── SimilarityIndex.js
│ ├── SimilarityIndexInfo.js
│ ├── SocialSentiment.js
│ ├── Split.js
│ ├── Stock.js
│ ├── StockCandles.js
│ ├── StockSymbol.js
│ ├── StockTranscripts.js
│ ├── SupplyChainRelationships.js
│ ├── SupportResistance.js
│ ├── SymbolChange.js
│ ├── SymbolChangeInfo.js
│ ├── SymbolLookup.js
│ ├── SymbolLookupInfo.js
│ ├── TechnicalAnalysis.js
│ ├── TickData.js
│ ├── Transactions.js
│ ├── TranscriptContent.js
│ ├── TranscriptParticipant.js
│ ├── Trend.js
│ ├── TwitterSentimentContent.js
│ ├── UpgradeDowngrade.js
│ ├── UsaSpending.js
│ ├── UsaSpendingResult.js
│ ├── UsptoPatent.js
│ ├── UsptoPatentResult.js
│ ├── VisaApplication.js
│ └── VisaApplicationResult.js
├── docs
├── AggregateIndicators.md
├── AirlinePriceIndex.md
├── AirlinePriceIndexData.md
├── BasicFinancials.md
├── BondCandles.md
├── BondProfile.md
├── BondTickData.md
├── BondYieldCurve.md
├── BondYieldCurveInfo.md
├── BreakdownItem.md
├── Company.md
├── CompanyESG.md
├── CompanyESG2.md
├── CompanyEarningsQualityScore.md
├── CompanyEarningsQualityScoreData.md
├── CompanyExecutive.md
├── CompanyNews.md
├── CompanyNewsStatistics.md
├── CompanyProfile.md
├── CompanyProfile2.md
├── CongressionalTrading.md
├── CongressionalTransaction.md
├── CountryMetadata.md
├── CovidInfo.md
├── CryptoCandles.md
├── CryptoProfile.md
├── CryptoSymbol.md
├── DefaultApi.md
├── Development.md
├── Dividends.md
├── Dividends2.md
├── Dividends2Basic.md
├── Dividends2Info.md
├── DocumentResponse.md
├── ETFCountryExposureData.md
├── ETFHoldingsData.md
├── ETFProfileData.md
├── ETFSectorExposureData.md
├── ETFsCountryExposure.md
├── ETFsHoldings.md
├── ETFsIndustryExposure.md
├── ETFsProfile.md
├── ETFsSectorExposure.md
├── EarningEstimate.md
├── EarningRelease.md
├── EarningResult.md
├── EarningsCalendar.md
├── EarningsCallTranscripts.md
├── EarningsCallTranscriptsList.md
├── EarningsEstimates.md
├── EarningsEstimatesInfo.md
├── EbitEstimates.md
├── EbitEstimatesInfo.md
├── EbitdaEstimates.md
├── EbitdaEstimatesInfo.md
├── EconomicCalendar.md
├── EconomicCode.md
├── EconomicData.md
├── EconomicDataInfo.md
├── EconomicEvent.md
├── EmployeeCount.md
├── Estimate.md
├── ExcerptResponse.md
├── FDAComitteeMeeting.md
├── Filing.md
├── FilingResponse.md
├── FilingSentiment.md
├── FinancialStatements.md
├── FinancialsAsReported.md
├── ForexCandles.md
├── ForexSymbol.md
├── Forexrates.md
├── FundOwnership.md
├── FundOwnershipInfo.md
├── HistoricalCompanyESG.md
├── HistoricalEmployeeCount.md
├── HistoricalMarketCapData.md
├── HistoricalNBBO.md
├── IPOCalendar.md
├── IPOEvent.md
├── InFilingResponse.md
├── InFilingSearchBody.md
├── IndexHistoricalConstituent.md
├── Indicator.md
├── IndicesConstituents.md
├── IndicesConstituentsBreakdown.md
├── IndicesHistoricalConstituents.md
├── InsiderSentiments.md
├── InsiderSentimentsData.md
├── InsiderTransactions.md
├── InstitutionalOwnership.md
├── InstitutionalOwnershipGroup.md
├── InstitutionalOwnershipInfo.md
├── InstitutionalPortfolio.md
├── InstitutionalPortfolioGroup.md
├── InstitutionalPortfolioInfo.md
├── InstitutionalProfile.md
├── InstitutionalProfileInfo.md
├── InternationalFiling.md
├── InvestmentThemePortfolio.md
├── InvestmentThemes.md
├── InvestmentThemesThematicInvesting.md
├── Investor.md
├── InvestorsOwnership.md
├── IsinChange.md
├── IsinChangeInfo.md
├── KeyCustomersSuppliers.md
├── LastBidAsk.md
├── LobbyingData.md
├── LobbyingResult.md
├── MajorDevelopments.md
├── MajorPressReleases.md
├── MarketCapData.md
├── MarketHoliday.md
├── MarketHolidayData.md
├── MarketNews.md
├── MarketStatus.md
├── MutualFundCountryExposure.md
├── MutualFundCountryExposureData.md
├── MutualFundEet.md
├── MutualFundEetPai.md
├── MutualFundHoldings.md
├── MutualFundHoldingsData.md
├── MutualFundProfile.md
├── MutualFundProfileData.md
├── MutualFundSectorExposure.md
├── MutualFundSectorExposureData.md
├── MutualFundsCountryExposure.md
├── MutualFundsHoldings.md
├── MutualFundsProfile.md
├── News.md
├── NewsSentiment.md
├── Ownership.md
├── OwnershipInfo.md
├── PatternRecognition.md
├── PressRelease.md
├── PriceMetrics.md
├── PriceTarget.md
├── Quote.md
├── RecommendationTrend.md
├── RedditSentimentContent.md
├── Report.md
├── RevenueBreakdown.md
├── RevenueEstimates.md
├── RevenueEstimatesInfo.md
├── SECSentimentAnalysis.md
├── SearchBody.md
├── SearchFilter.md
├── SearchResponse.md
├── SectorMetric.md
├── SectorMetricData.md
├── Sentiment.md
├── SentimentContent.md
├── SimilarityIndex.md
├── SimilarityIndexInfo.md
├── SocialSentiment.md
├── Split.md
├── Stock.md
├── StockCandles.md
├── StockSymbol.md
├── StockTranscripts.md
├── SupplyChainRelationships.md
├── SupportResistance.md
├── SymbolChange.md
├── SymbolChangeInfo.md
├── SymbolLookup.md
├── SymbolLookupInfo.md
├── TechnicalAnalysis.md
├── TickData.md
├── Transactions.md
├── TranscriptContent.md
├── TranscriptParticipant.md
├── Trend.md
├── TwitterSentimentContent.md
├── UpgradeDowngrade.md
├── UsaSpending.md
├── UsaSpendingResult.md
├── UsptoPatent.md
├── UsptoPatentResult.md
├── VisaApplication.md
└── VisaApplicationResult.md
├── git_push.sh
├── mocha.opts
├── package-lock.json
├── package.json
├── release.sh
├── src
├── ApiClient.js
├── api
│ └── DefaultApi.js
├── index.js
└── model
│ ├── AggregateIndicators.js
│ ├── AirlinePriceIndex.js
│ ├── AirlinePriceIndexData.js
│ ├── BasicFinancials.js
│ ├── BondCandles.js
│ ├── BondProfile.js
│ ├── BondTickData.js
│ ├── BondYieldCurve.js
│ ├── BondYieldCurveInfo.js
│ ├── BreakdownItem.js
│ ├── Company.js
│ ├── CompanyESG.js
│ ├── CompanyESG2.js
│ ├── CompanyEarningsQualityScore.js
│ ├── CompanyEarningsQualityScoreData.js
│ ├── CompanyExecutive.js
│ ├── CompanyNews.js
│ ├── CompanyNewsStatistics.js
│ ├── CompanyProfile.js
│ ├── CompanyProfile2.js
│ ├── CongressionalTrading.js
│ ├── CongressionalTransaction.js
│ ├── CountryMetadata.js
│ ├── CovidInfo.js
│ ├── CryptoCandles.js
│ ├── CryptoProfile.js
│ ├── CryptoSymbol.js
│ ├── Development.js
│ ├── Dividends.js
│ ├── Dividends2.js
│ ├── Dividends2Basic.js
│ ├── Dividends2Info.js
│ ├── DocumentResponse.js
│ ├── ETFCountryExposureData.js
│ ├── ETFHoldingsData.js
│ ├── ETFProfileData.js
│ ├── ETFSectorExposureData.js
│ ├── ETFsCountryExposure.js
│ ├── ETFsHoldings.js
│ ├── ETFsIndustryExposure.js
│ ├── ETFsProfile.js
│ ├── ETFsSectorExposure.js
│ ├── EarningEstimate.js
│ ├── EarningRelease.js
│ ├── EarningResult.js
│ ├── EarningsCalendar.js
│ ├── EarningsCallTranscripts.js
│ ├── EarningsCallTranscriptsList.js
│ ├── EarningsEstimates.js
│ ├── EarningsEstimatesInfo.js
│ ├── EbitEstimates.js
│ ├── EbitEstimatesInfo.js
│ ├── EbitdaEstimates.js
│ ├── EbitdaEstimatesInfo.js
│ ├── EconomicCalendar.js
│ ├── EconomicCode.js
│ ├── EconomicData.js
│ ├── EconomicDataInfo.js
│ ├── EconomicEvent.js
│ ├── EmployeeCount.js
│ ├── Estimate.js
│ ├── ExcerptResponse.js
│ ├── FDAComitteeMeeting.js
│ ├── Filing.js
│ ├── FilingResponse.js
│ ├── FilingSentiment.js
│ ├── FinancialStatements.js
│ ├── FinancialsAsReported.js
│ ├── ForexCandles.js
│ ├── ForexSymbol.js
│ ├── Forexrates.js
│ ├── FundOwnership.js
│ ├── FundOwnershipInfo.js
│ ├── HistoricalCompanyESG.js
│ ├── HistoricalEmployeeCount.js
│ ├── HistoricalMarketCapData.js
│ ├── HistoricalNBBO.js
│ ├── IPOCalendar.js
│ ├── IPOEvent.js
│ ├── InFilingResponse.js
│ ├── InFilingSearchBody.js
│ ├── IndexHistoricalConstituent.js
│ ├── Indicator.js
│ ├── IndicesConstituents.js
│ ├── IndicesConstituentsBreakdown.js
│ ├── IndicesHistoricalConstituents.js
│ ├── InsiderSentiments.js
│ ├── InsiderSentimentsData.js
│ ├── InsiderTransactions.js
│ ├── InstitutionalOwnership.js
│ ├── InstitutionalOwnershipGroup.js
│ ├── InstitutionalOwnershipInfo.js
│ ├── InstitutionalPortfolio.js
│ ├── InstitutionalPortfolioGroup.js
│ ├── InstitutionalPortfolioInfo.js
│ ├── InstitutionalProfile.js
│ ├── InstitutionalProfileInfo.js
│ ├── InternationalFiling.js
│ ├── InvestmentThemePortfolio.js
│ ├── InvestmentThemes.js
│ ├── InvestmentThemesThematicInvesting.js
│ ├── Investor.js
│ ├── InvestorsOwnership.js
│ ├── IsinChange.js
│ ├── IsinChangeInfo.js
│ ├── KeyCustomersSuppliers.js
│ ├── LastBidAsk.js
│ ├── LobbyingData.js
│ ├── LobbyingResult.js
│ ├── MajorDevelopments.js
│ ├── MajorPressReleases.js
│ ├── MarketCapData.js
│ ├── MarketHoliday.js
│ ├── MarketHolidayData.js
│ ├── MarketNews.js
│ ├── MarketStatus.js
│ ├── MutualFundCountryExposure.js
│ ├── MutualFundCountryExposureData.js
│ ├── MutualFundEet.js
│ ├── MutualFundEetPai.js
│ ├── MutualFundHoldings.js
│ ├── MutualFundHoldingsData.js
│ ├── MutualFundProfile.js
│ ├── MutualFundProfileData.js
│ ├── MutualFundSectorExposure.js
│ ├── MutualFundSectorExposureData.js
│ ├── MutualFundsCountryExposure.js
│ ├── MutualFundsHoldings.js
│ ├── MutualFundsProfile.js
│ ├── News.js
│ ├── NewsSentiment.js
│ ├── Ownership.js
│ ├── OwnershipInfo.js
│ ├── PatternRecognition.js
│ ├── PressRelease.js
│ ├── PriceMetrics.js
│ ├── PriceTarget.js
│ ├── Quote.js
│ ├── RecommendationTrend.js
│ ├── RedditSentimentContent.js
│ ├── Report.js
│ ├── RevenueBreakdown.js
│ ├── RevenueEstimates.js
│ ├── RevenueEstimatesInfo.js
│ ├── SECSentimentAnalysis.js
│ ├── SearchBody.js
│ ├── SearchFilter.js
│ ├── SearchResponse.js
│ ├── SectorMetric.js
│ ├── SectorMetricData.js
│ ├── Sentiment.js
│ ├── SentimentContent.js
│ ├── SimilarityIndex.js
│ ├── SimilarityIndexInfo.js
│ ├── SocialSentiment.js
│ ├── Split.js
│ ├── Stock.js
│ ├── StockCandles.js
│ ├── StockSymbol.js
│ ├── StockTranscripts.js
│ ├── SupplyChainRelationships.js
│ ├── SupportResistance.js
│ ├── SymbolChange.js
│ ├── SymbolChangeInfo.js
│ ├── SymbolLookup.js
│ ├── SymbolLookupInfo.js
│ ├── TechnicalAnalysis.js
│ ├── TickData.js
│ ├── Transactions.js
│ ├── TranscriptContent.js
│ ├── TranscriptParticipant.js
│ ├── Trend.js
│ ├── TwitterSentimentContent.js
│ ├── UpgradeDowngrade.js
│ ├── UsaSpending.js
│ ├── UsaSpendingResult.js
│ ├── UsptoPatent.js
│ ├── UsptoPatentResult.js
│ ├── VisaApplication.js
│ └── VisaApplicationResult.js
└── test
├── api
└── DefaultApi.spec.js
└── model
├── AggregateIndicators.spec.js
├── AirlinePriceIndex.spec.js
├── AirlinePriceIndexData.spec.js
├── BasicFinancials.spec.js
├── BondCandles.spec.js
├── BondProfile.spec.js
├── BondTickData.spec.js
├── BondYieldCurve.spec.js
├── BondYieldCurveInfo.spec.js
├── BreakdownItem.spec.js
├── Company.spec.js
├── CompanyESG.spec.js
├── CompanyESG2.spec.js
├── CompanyEarningsQualityScore.spec.js
├── CompanyEarningsQualityScoreData.spec.js
├── CompanyExecutive.spec.js
├── CompanyNews.spec.js
├── CompanyNewsStatistics.spec.js
├── CompanyProfile.spec.js
├── CompanyProfile2.spec.js
├── CongressionalTrading.spec.js
├── CongressionalTransaction.spec.js
├── CountryMetadata.spec.js
├── CovidInfo.spec.js
├── CryptoCandles.spec.js
├── CryptoProfile.spec.js
├── CryptoSymbol.spec.js
├── Development.spec.js
├── Dividends.spec.js
├── Dividends2.spec.js
├── Dividends2Basic.spec.js
├── Dividends2Info.spec.js
├── DocumentResponse.spec.js
├── ETFCountryExposureData.spec.js
├── ETFHoldingsData.spec.js
├── ETFProfileData.spec.js
├── ETFSectorExposureData.spec.js
├── ETFsCountryExposure.spec.js
├── ETFsHoldings.spec.js
├── ETFsIndustryExposure.spec.js
├── ETFsProfile.spec.js
├── ETFsSectorExposure.spec.js
├── EarningEstimate.spec.js
├── EarningRelease.spec.js
├── EarningResult.spec.js
├── EarningsCalendar.spec.js
├── EarningsCallTranscripts.spec.js
├── EarningsCallTranscriptsList.spec.js
├── EarningsEstimates.spec.js
├── EarningsEstimatesInfo.spec.js
├── EbitEstimates.spec.js
├── EbitEstimatesInfo.spec.js
├── EbitdaEstimates.spec.js
├── EbitdaEstimatesInfo.spec.js
├── EconomicCalendar.spec.js
├── EconomicCode.spec.js
├── EconomicData.spec.js
├── EconomicDataInfo.spec.js
├── EconomicEvent.spec.js
├── EmployeeCount.spec.js
├── Estimate.spec.js
├── ExcerptResponse.spec.js
├── FDAComitteeMeeting.spec.js
├── Filing.spec.js
├── FilingResponse.spec.js
├── FilingSentiment.spec.js
├── FinancialStatements.spec.js
├── FinancialsAsReported.spec.js
├── ForexCandles.spec.js
├── ForexSymbol.spec.js
├── Forexrates.spec.js
├── FundOwnership.spec.js
├── FundOwnershipInfo.spec.js
├── HistoricalCompanyESG.spec.js
├── HistoricalEmployeeCount.spec.js
├── HistoricalMarketCapData.spec.js
├── HistoricalNBBO.spec.js
├── IPOCalendar.spec.js
├── IPOEvent.spec.js
├── InFilingResponse.spec.js
├── InFilingSearchBody.spec.js
├── IndexHistoricalConstituent.spec.js
├── Indicator.spec.js
├── IndicesConstituents.spec.js
├── IndicesConstituentsBreakdown.spec.js
├── IndicesHistoricalConstituents.spec.js
├── InsiderSentiments.spec.js
├── InsiderSentimentsData.spec.js
├── InsiderTransactions.spec.js
├── InstitutionalOwnership.spec.js
├── InstitutionalOwnershipGroup.spec.js
├── InstitutionalOwnershipInfo.spec.js
├── InstitutionalPortfolio.spec.js
├── InstitutionalPortfolioGroup.spec.js
├── InstitutionalPortfolioInfo.spec.js
├── InstitutionalProfile.spec.js
├── InstitutionalProfileInfo.spec.js
├── InternationalFiling.spec.js
├── InvestmentThemePortfolio.spec.js
├── InvestmentThemes.spec.js
├── InvestmentThemesThematicInvesting.spec.js
├── Investor.spec.js
├── InvestorsOwnership.spec.js
├── IsinChange.spec.js
├── IsinChangeInfo.spec.js
├── KeyCustomersSuppliers.spec.js
├── LastBidAsk.spec.js
├── LobbyingData.spec.js
├── LobbyingResult.spec.js
├── MajorDevelopments.spec.js
├── MajorPressReleases.spec.js
├── MarketCapData.spec.js
├── MarketHoliday.spec.js
├── MarketHolidayData.spec.js
├── MarketNews.spec.js
├── MarketStatus.spec.js
├── MutualFundCountryExposure.spec.js
├── MutualFundCountryExposureData.spec.js
├── MutualFundEet.spec.js
├── MutualFundEetPai.spec.js
├── MutualFundHoldings.spec.js
├── MutualFundHoldingsData.spec.js
├── MutualFundProfile.spec.js
├── MutualFundProfileData.spec.js
├── MutualFundSectorExposure.spec.js
├── MutualFundSectorExposureData.spec.js
├── MutualFundsCountryExposure.spec.js
├── MutualFundsHoldings.spec.js
├── MutualFundsProfile.spec.js
├── News.spec.js
├── NewsSentiment.spec.js
├── Ownership.spec.js
├── OwnershipInfo.spec.js
├── PatternRecognition.spec.js
├── PressRelease.spec.js
├── PriceMetrics.spec.js
├── PriceTarget.spec.js
├── Quote.spec.js
├── RecommendationTrend.spec.js
├── RedditSentimentContent.spec.js
├── Report.spec.js
├── RevenueBreakdown.spec.js
├── RevenueEstimates.spec.js
├── RevenueEstimatesInfo.spec.js
├── SECSentimentAnalysis.spec.js
├── SearchBody.spec.js
├── SearchFilter.spec.js
├── SearchResponse.spec.js
├── SectorMetric.spec.js
├── SectorMetricData.spec.js
├── Sentiment.spec.js
├── SentimentContent.spec.js
├── SimilarityIndex.spec.js
├── SimilarityIndexInfo.spec.js
├── SocialSentiment.spec.js
├── Split.spec.js
├── Stock.spec.js
├── StockCandles.spec.js
├── StockSymbol.spec.js
├── StockTranscripts.spec.js
├── SupplyChainRelationships.spec.js
├── SupportResistance.spec.js
├── SymbolChange.spec.js
├── SymbolChangeInfo.spec.js
├── SymbolLookup.spec.js
├── SymbolLookupInfo.spec.js
├── TechnicalAnalysis.spec.js
├── TickData.spec.js
├── Transactions.spec.js
├── TranscriptContent.spec.js
├── TranscriptParticipant.spec.js
├── Trend.spec.js
├── TwitterSentimentContent.spec.js
├── UpgradeDowngrade.spec.js
├── UsaSpending.spec.js
├── UsaSpendingResult.spec.js
├── UsptoPatent.spec.js
├── UsptoPatentResult.spec.js
├── VisaApplication.spec.js
└── VisaApplicationResult.spec.js
/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 | "presets": [
3 | "@babel/preset-env"
4 | ],
5 | "plugins": [
6 | "@babel/plugin-syntax-dynamic-import",
7 | "@babel/plugin-syntax-import-meta",
8 | "@babel/plugin-proposal-class-properties",
9 | "@babel/plugin-proposal-json-strings",
10 | [
11 | "@babel/plugin-proposal-decorators",
12 | {
13 | "legacy": true
14 | }
15 | ],
16 | "@babel/plugin-proposal-function-sent",
17 | "@babel/plugin-proposal-export-namespace-from",
18 | "@babel/plugin-proposal-numeric-separator",
19 | "@babel/plugin-proposal-throw-expressions",
20 | "@babel/plugin-proposal-export-default-from",
21 | "@babel/plugin-proposal-logical-assignment-operators",
22 | "@babel/plugin-proposal-optional-chaining",
23 | [
24 | "@babel/plugin-proposal-pipeline-operator",
25 | {
26 | "proposal": "minimal"
27 | }
28 | ],
29 | "@babel/plugin-proposal-nullish-coalescing-operator",
30 | "@babel/plugin-proposal-do-expressions",
31 | "@babel/plugin-proposal-function-bind"
32 | ]
33 | }
34 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Logs
2 | logs
3 | *.log
4 | npm-debug.log*
5 |
6 | # Runtime data
7 | pids
8 | *.pid
9 | *.seed
10 |
11 | # Directory for instrumented libs generated by jscoverage/JSCover
12 | lib-cov
13 |
14 | # Coverage directory used by tools like istanbul
15 | coverage
16 |
17 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
18 | .grunt
19 |
20 | # node-waf configuration
21 | .lock-wscript
22 |
23 | # Compiled binary addons (http://nodejs.org/api/addons.html)
24 | build/Release
25 |
26 | # Dependency directory
27 | node_modules
28 |
29 | # Optional npm cache directory
30 | .npm
31 |
32 | # Optional REPL history
33 | .node_repl_history
34 |
--------------------------------------------------------------------------------
/.openapi-generator-ignore:
--------------------------------------------------------------------------------
1 | # OpenAPI Generator Ignore
2 | # Generated by openapi-generator https://github.com/openapitools/openapi-generator
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 OpenAPI Generator 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 | README.md
25 | release.sh
26 | .openapi-generator-ignore
27 |
--------------------------------------------------------------------------------
/.openapi-generator/VERSION:
--------------------------------------------------------------------------------
1 | 5.2.1
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: node_js
2 | cache: npm
3 | node_js:
4 | - "6"
5 | - "6.1"
6 |
--------------------------------------------------------------------------------
/docs/AggregateIndicators.md:
--------------------------------------------------------------------------------
1 | # finnhub.AggregateIndicators
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **technicalAnalysis** | [**TechnicalAnalysis**](TechnicalAnalysis.md) | | [optional]
8 | **trend** | [**Trend**](Trend.md) | | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/AirlinePriceIndex.md:
--------------------------------------------------------------------------------
1 | # finnhub.AirlinePriceIndex
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **date** | **String** | Date | [optional]
8 | **priceIndex** | **Number** | Price Index | [optional]
9 | **dailyAvgPrice** | **Number** | Daily average ticket price. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/AirlinePriceIndexData.md:
--------------------------------------------------------------------------------
1 | # finnhub.AirlinePriceIndexData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **data** | [**[AirlinePriceIndex]**](AirlinePriceIndex.md) | Array of price index. | [optional]
8 | **airline** | **String** | Airline name | [optional]
9 | **from** | **String** | From date | [optional]
10 | **to** | **String** | To date | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/BasicFinancials.md:
--------------------------------------------------------------------------------
1 | # finnhub.BasicFinancials
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol of the company. | [optional]
8 | **metricType** | **String** | Metric type. | [optional]
9 | **series** | **Object** | | [optional]
10 | **metric** | **Object** | | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/BondCandles.md:
--------------------------------------------------------------------------------
1 | # finnhub.BondCandles
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **c** | **[Number]** | List of close prices for returned candles. | [optional]
8 | **t** | **[Number]** | List of timestamp for returned candles. | [optional]
9 | **s** | **String** | Status of the response. This field can either be ok or no_data. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/BondProfile.md:
--------------------------------------------------------------------------------
1 | # finnhub.BondProfile
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **isin** | **String** | ISIN. | [optional]
8 | **cusip** | **String** | Cusip. | [optional]
9 | **figi** | **String** | FIGI. | [optional]
10 | **coupon** | **Number** | Coupon. | [optional]
11 | **maturityDate** | **String** | Period. | [optional]
12 | **offeringPrice** | **Number** | Offering price. | [optional]
13 | **issueDate** | **String** | Issue date. | [optional]
14 | **bondType** | **String** | Bond type. | [optional]
15 | **debtType** | **String** | Bond type. | [optional]
16 | **industryGroup** | **String** | Industry. | [optional]
17 | **industrySubGroup** | **String** | Sub-Industry. | [optional]
18 | **asset** | **String** | Asset. | [optional]
19 | **assetType** | **String** | Asset. | [optional]
20 | **datedDate** | **String** | Dated date. | [optional]
21 | **firstCouponDate** | **String** | First coupon date. | [optional]
22 | **originalOffering** | **Number** | Offering amount. | [optional]
23 | **amountOutstanding** | **Number** | Outstanding amount. | [optional]
24 | **paymentFrequency** | **String** | Payment frequency. | [optional]
25 | **securityLevel** | **String** | Security level. | [optional]
26 | **callable** | **Boolean** | Callable. | [optional]
27 | **couponType** | **String** | Coupon type. | [optional]
28 |
29 |
30 |
--------------------------------------------------------------------------------
/docs/BondTickData.md:
--------------------------------------------------------------------------------
1 | # finnhub.BondTickData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **skip** | **Number** | Number of ticks skipped. | [optional]
8 | **count** | **Number** | Number of ticks returned. If <code>count</code> < <code>limit</code>, all data for that date has been returned. | [optional]
9 | **total** | **Number** | Total number of ticks for that date. | [optional]
10 | **v** | **[Number]** | List of volume data. | [optional]
11 | **p** | **[Number]** | List of price data. | [optional]
12 | **y** | **[Number]** | List of yield data. | [optional]
13 | **t** | **[Number]** | List of timestamp in UNIX ms. | [optional]
14 | **si** | **[String]** | List of values showing the side (Buy/sell) of each trade. List of supported values: <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\",>here</a> | [optional]
15 | **cp** | **[String]** | List of values showing the counterparty of each trade. List of supported values: <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\",>here</a> | [optional]
16 | **rp** | **[String]** | List of values showing the reporting party of each trade. List of supported values: <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\",>here</a> | [optional]
17 | **ats** | **[String]** | ATS flag. Y or empty | [optional]
18 | **c** | **[[String]]** | List of trade conditions. A comprehensive list of trade conditions code can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1O3aueXSPOqo7Iuyz4PqDG6yZunHsX8BTefZ2kFk5pz4/edit?usp=sharing\">here</a> | [optional]
19 |
20 |
21 |
--------------------------------------------------------------------------------
/docs/BondYieldCurve.md:
--------------------------------------------------------------------------------
1 | # finnhub.BondYieldCurve
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **data** | [**[BondYieldCurveInfo]**](BondYieldCurveInfo.md) | Array of data. | [optional]
8 | **code** | **String** | Bond's code | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/BondYieldCurveInfo.md:
--------------------------------------------------------------------------------
1 | # finnhub.BondYieldCurveInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **d** | **String** | Date of the reading | [optional]
8 | **v** | **Number** | Value | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/BreakdownItem.md:
--------------------------------------------------------------------------------
1 | # finnhub.BreakdownItem
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **accessNumber** | **String** | Access number of the report from which the data is sourced. | [optional]
8 | **breakdown** | **Object** | | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/Company.md:
--------------------------------------------------------------------------------
1 | # finnhub.Company
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **name** | **String** | Executive name | [optional]
8 | **age** | **Number** | Age | [optional]
9 | **title** | **String** | Title | [optional]
10 | **since** | **String** | Year first appointed as executive/director of the company | [optional]
11 | **sex** | **String** | Sex | [optional]
12 | **compensation** | **Number** | Total compensation | [optional]
13 | **currency** | **String** | Compensation currency | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/docs/CompanyESG.md:
--------------------------------------------------------------------------------
1 | # finnhub.CompanyESG
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | symbol | [optional]
8 | **totalESGScore** | **Number** | Total ESG Score | [optional]
9 | **environmentScore** | **Number** | Environment Score | [optional]
10 | **governanceScore** | **Number** | Governance Score | [optional]
11 | **socialScore** | **Number** | Social Score | [optional]
12 | **data** | **Object** | | [optional]
13 |
14 |
15 |
--------------------------------------------------------------------------------
/docs/CompanyESG2.md:
--------------------------------------------------------------------------------
1 | # finnhub.CompanyESG2
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **totalESGScore** | **Number** | Total ESG Score | [optional]
8 | **environmentScore** | **Number** | Environment Score | [optional]
9 | **governanceScore** | **Number** | Governance Score | [optional]
10 | **socialScore** | **Number** | Social Score | [optional]
11 | **data** | **Object** | | [optional]
12 | **period** | **String** | Period | [optional]
13 |
14 |
15 |
--------------------------------------------------------------------------------
/docs/CompanyEarningsQualityScore.md:
--------------------------------------------------------------------------------
1 | # finnhub.CompanyEarningsQualityScore
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol | [optional]
8 | **freq** | **String** | Frequency | [optional]
9 | **data** | [**[CompanyEarningsQualityScoreData]**](CompanyEarningsQualityScoreData.md) | Array of earnings quality score. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/CompanyEarningsQualityScoreData.md:
--------------------------------------------------------------------------------
1 | # finnhub.CompanyEarningsQualityScoreData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **period** | **String** | Period | [optional]
8 | **growth** | **Number** | Growth Score | [optional]
9 | **profitability** | **Number** | Profitability Score | [optional]
10 | **cashGenerationCapitalAllocation** | **Number** | Cash Generation and Capital Allocation | [optional]
11 | **leverage** | **Number** | Leverage Score | [optional]
12 | **score** | **Number** | Total Score | [optional]
13 | **letterScore** | **String** | Letter Score | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/docs/CompanyExecutive.md:
--------------------------------------------------------------------------------
1 | # finnhub.CompanyExecutive
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Company symbol. | [optional]
8 | **executive** | [**[Company]**](Company.md) | Array of company's executives and members of the Board. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/CompanyNews.md:
--------------------------------------------------------------------------------
1 | # finnhub.CompanyNews
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **category** | **String** | News category. | [optional]
8 | **datetime** | **Number** | Published time in UNIX timestamp. | [optional]
9 | **headline** | **String** | News headline. | [optional]
10 | **id** | **Number** | News ID. This value can be used for <code>minId</code> params to get the latest news only. | [optional]
11 | **image** | **String** | Thumbnail image URL. | [optional]
12 | **related** | **String** | Related stocks and companies mentioned in the article. | [optional]
13 | **source** | **String** | News source. | [optional]
14 | **summary** | **String** | News summary. | [optional]
15 | **url** | **String** | URL of the original article. | [optional]
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/CompanyNewsStatistics.md:
--------------------------------------------------------------------------------
1 | # finnhub.CompanyNewsStatistics
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **articlesInLastWeek** | **Number** | | [optional]
8 | **buzz** | **Number** | | [optional]
9 | **weeklyAverage** | **Number** | | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/CompanyProfile.md:
--------------------------------------------------------------------------------
1 | # finnhub.CompanyProfile
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **alias** | **[String]** | Company name alias. | [optional]
8 | **address** | **String** | Address of company's headquarter. | [optional]
9 | **city** | **String** | City of company's headquarter. | [optional]
10 | **country** | **String** | Country of company's headquarter. | [optional]
11 | **currency** | **String** | Currency used in company filings and financials. | [optional]
12 | **estimateCurrency** | **String** | Currency used in Estimates data. | [optional]
13 | **marketCapCurrency** | **String** | Currency used in market capitalization. | [optional]
14 | **cusip** | **String** | CUSIP number. | [optional]
15 | **sedol** | **String** | Sedol number. | [optional]
16 | **description** | **String** | Company business summary. | [optional]
17 | **exchange** | **String** | Listed exchange. | [optional]
18 | **ggroup** | **String** | Industry group. | [optional]
19 | **gind** | **String** | Industry. | [optional]
20 | **gsector** | **String** | Sector. | [optional]
21 | **gsubind** | **String** | Sub-industry. | [optional]
22 | **isin** | **String** | ISIN number. | [optional]
23 | **lei** | **String** | LEI number. | [optional]
24 | **irUrl** | **String** | Investor relations website. | [optional]
25 | **naicsNationalIndustry** | **String** | NAICS national industry. | [optional]
26 | **naics** | **String** | NAICS industry. | [optional]
27 | **naicsSector** | **String** | NAICS sector. | [optional]
28 | **naicsSubsector** | **String** | NAICS subsector. | [optional]
29 | **name** | **String** | Company name. | [optional]
30 | **phone** | **String** | Company phone number. | [optional]
31 | **state** | **String** | State of company's headquarter. | [optional]
32 | **ticker** | **String** | Company symbol/ticker as used on the listed exchange. | [optional]
33 | **weburl** | **String** | Company website. | [optional]
34 | **ipo** | **Date** | IPO date. | [optional]
35 | **marketCapitalization** | **Number** | Market Capitalization. | [optional]
36 | **shareOutstanding** | **Number** | Number of oustanding shares. | [optional]
37 | **employeeTotal** | **Number** | Number of employee. | [optional]
38 | **logo** | **String** | Logo image. | [optional]
39 | **finnhubIndustry** | **String** | Finnhub industry classification. | [optional]
40 |
41 |
42 |
--------------------------------------------------------------------------------
/docs/CompanyProfile2.md:
--------------------------------------------------------------------------------
1 | # finnhub.CompanyProfile2
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **country** | **String** | Country of company's headquarter. | [optional]
8 | **currency** | **String** | Currency used in company filings. | [optional]
9 | **exchange** | **String** | Listed exchange. | [optional]
10 | **name** | **String** | Company name. | [optional]
11 | **ticker** | **String** | Company symbol/ticker as used on the listed exchange. | [optional]
12 | **ipo** | **Date** | IPO date. | [optional]
13 | **marketCapitalization** | **Number** | Market Capitalization. | [optional]
14 | **shareOutstanding** | **Number** | Number of oustanding shares. | [optional]
15 | **logo** | **String** | Logo image. | [optional]
16 | **phone** | **String** | Company phone number. | [optional]
17 | **weburl** | **String** | Company website. | [optional]
18 | **finnhubIndustry** | **String** | Finnhub industry classification. | [optional]
19 |
20 |
21 |
--------------------------------------------------------------------------------
/docs/CongressionalTrading.md:
--------------------------------------------------------------------------------
1 | # finnhub.CongressionalTrading
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol of the company. | [optional]
8 | **data** | [**[CongressionalTransaction]**](CongressionalTransaction.md) | Array of stock trades. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/CongressionalTransaction.md:
--------------------------------------------------------------------------------
1 | # finnhub.CongressionalTransaction
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **amountFrom** | **Number** | Transaction amount from. | [optional]
8 | **amountTo** | **Number** | Transaction amount to. | [optional]
9 | **assetName** | **String** | Asset name. | [optional]
10 | **filingDate** | **String** | Filing date. | [optional]
11 | **name** | **String** | Name of the representative. | [optional]
12 | **ownerType** | **String** | Owner Type. | [optional]
13 | **position** | **String** | Position. | [optional]
14 | **symbol** | **String** | Symbol. | [optional]
15 | **transactionDate** | **String** | Transaction date. | [optional]
16 | **transactionType** | **String** | Transaction type <code>Sale</code> or <code>Purchase</code>. | [optional]
17 |
18 |
19 |
--------------------------------------------------------------------------------
/docs/CountryMetadata.md:
--------------------------------------------------------------------------------
1 | # finnhub.CountryMetadata
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **country** | **String** | Country name | [optional]
8 | **code2** | **String** | Alpha 2 code | [optional]
9 | **code3** | **String** | Alpha 3 code | [optional]
10 | **codeNo** | **String** | UN code | [optional]
11 | **currency** | **String** | Currency name | [optional]
12 | **currencyCode** | **String** | Currency code | [optional]
13 | **region** | **String** | Region | [optional]
14 | **subRegion** | **String** | Sub-Region | [optional]
15 | **rating** | **String** | Moody's credit risk rating. | [optional]
16 | **defaultSpread** | **Number** | Default spread | [optional]
17 | **countryRiskPremium** | **Number** | Country risk premium | [optional]
18 | **equityRiskPremium** | **Number** | Equity risk premium | [optional]
19 |
20 |
21 |
--------------------------------------------------------------------------------
/docs/CovidInfo.md:
--------------------------------------------------------------------------------
1 | # finnhub.CovidInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **state** | **String** | State. | [optional]
8 | **_case** | **Number** | Number of confirmed cases. | [optional]
9 | **death** | **Number** | Number of confirmed deaths. | [optional]
10 | **updated** | **String** | Updated time. | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/CryptoCandles.md:
--------------------------------------------------------------------------------
1 | # finnhub.CryptoCandles
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **o** | **[Number]** | List of open prices for returned candles. | [optional]
8 | **h** | **[Number]** | List of high prices for returned candles. | [optional]
9 | **l** | **[Number]** | List of low prices for returned candles. | [optional]
10 | **c** | **[Number]** | List of close prices for returned candles. | [optional]
11 | **v** | **[Number]** | List of volume data for returned candles. | [optional]
12 | **t** | **[Number]** | List of timestamp for returned candles. | [optional]
13 | **s** | **String** | Status of the response. This field can either be ok or no_data. | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/docs/CryptoProfile.md:
--------------------------------------------------------------------------------
1 | # finnhub.CryptoProfile
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **longName** | **String** | Long name. | [optional]
8 | **name** | **String** | Name. | [optional]
9 | **description** | **String** | Description. | [optional]
10 | **website** | **String** | Project's website. | [optional]
11 | **marketCap** | **Number** | Market capitalization. | [optional]
12 | **totalSupply** | **Number** | Total supply. | [optional]
13 | **maxSupply** | **Number** | Max supply. | [optional]
14 | **circulatingSupply** | **Number** | Circulating supply. | [optional]
15 | **logo** | **String** | Logo image. | [optional]
16 | **launchDate** | **String** | Launch date. | [optional]
17 | **proofType** | **String** | Proof type. | [optional]
18 |
19 |
20 |
--------------------------------------------------------------------------------
/docs/CryptoSymbol.md:
--------------------------------------------------------------------------------
1 | # finnhub.CryptoSymbol
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **description** | **String** | Symbol description | [optional]
8 | **displaySymbol** | **String** | Display symbol name. | [optional]
9 | **symbol** | **String** | Unique symbol used to identify this symbol used in <code>/crypto/candle</code> endpoint. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/Development.md:
--------------------------------------------------------------------------------
1 | # finnhub.Development
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Company symbol. | [optional]
8 | **datetime** | **String** | Published time in <code>YYYY-MM-DD HH:MM:SS</code> format. | [optional]
9 | **headline** | **String** | Development headline. | [optional]
10 | **description** | **String** | Development description. | [optional]
11 | **url** | **String** | URL. | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/docs/Dividends.md:
--------------------------------------------------------------------------------
1 | # finnhub.Dividends
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **date** | **Date** | Ex-Dividend date. | [optional]
9 | **amount** | **Number** | Amount in local currency. | [optional]
10 | **adjustedAmount** | **Number** | Adjusted dividend. | [optional]
11 | **payDate** | **Date** | Pay date. | [optional]
12 | **recordDate** | **Date** | Record date. | [optional]
13 | **declarationDate** | **Date** | Declaration date. | [optional]
14 | **currency** | **String** | Currency. | [optional]
15 | **freq** | **String** | <p>Dividend frequency. Can be 1 of the following values:</p><ul> <li><code>0: Annually</code></li> <li><code>1: Monthly</code></li> <li><code>2: Quarterly</code></li> <li><code>3: Semi-annually</code></li> <li><code>4: Other/Unknown</code></li> <li><code>5: Bimonthly</code></li> <li><code>6: Trimesterly</code></li> <li><code>7: Weekly</code></li> </ul> | [optional]
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/Dividends2.md:
--------------------------------------------------------------------------------
1 | # finnhub.Dividends2
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol | [optional]
8 | **data** | [**[Dividends2Info]**](Dividends2Info.md) | | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/Dividends2Basic.md:
--------------------------------------------------------------------------------
1 | # finnhub.Dividends2Basic
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol | [optional]
8 | **data** | **[Object]** | | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/Dividends2Info.md:
--------------------------------------------------------------------------------
1 | # finnhub.Dividends2Info
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **exDate** | **Date** | Ex-Dividend date. | [optional]
8 | **amount** | **Number** | Amount in local currency. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/DocumentResponse.md:
--------------------------------------------------------------------------------
1 | # finnhub.DocumentResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **documentId** | **String** | AlphaResearch internal document id. | [optional]
8 | **title** | **String** | Title for this document. | [optional]
9 | **hits** | **String** | Number of hit in this document | [optional]
10 | **url** | **String** | Link to render this document | [optional]
11 | **format** | **String** | Format of this document (can be html or pdf) | [optional]
12 | **excerpts** | [**[ExcerptResponse]**](ExcerptResponse.md) | Highlighted excerpts for this document | [optional]
13 |
14 |
15 |
--------------------------------------------------------------------------------
/docs/ETFCountryExposureData.md:
--------------------------------------------------------------------------------
1 | # finnhub.ETFCountryExposureData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **country** | **String** | Country | [optional]
8 | **exposure** | **Number** | Percent of exposure. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/ETFHoldingsData.md:
--------------------------------------------------------------------------------
1 | # finnhub.ETFHoldingsData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol description | [optional]
8 | **name** | **String** | Security name | [optional]
9 | **isin** | **String** | ISIN. | [optional]
10 | **cusip** | **String** | CUSIP. | [optional]
11 | **share** | **Number** | Number of shares owned by the ETF. | [optional]
12 | **percent** | **Number** | Portfolio's percent | [optional]
13 | **value** | **Number** | Market value | [optional]
14 | **assetType** | **String** | Asset type. Can be 1 of the following values: <code>Equity</code>, <code>ETP</code>, <code>Fund</code>, <code>Bond</code>, <code>Other</code> or empty. | [optional]
15 |
16 |
17 |
--------------------------------------------------------------------------------
/docs/ETFProfileData.md:
--------------------------------------------------------------------------------
1 | # finnhub.ETFProfileData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **name** | **String** | Name | [optional]
8 | **assetClass** | **String** | Asset Class. | [optional]
9 | **investmentSegment** | **String** | Investment Segment. | [optional]
10 | **aum** | **Number** | AUM. | [optional]
11 | **nav** | **Number** | NAV. | [optional]
12 | **navCurrency** | **String** | NAV currency. | [optional]
13 | **expenseRatio** | **Number** | Expense ratio. For non-US funds, this is the <a href=\"https://www.esma.europa.eu/sites/default/files/library/2015/11/09_1028_final_kid_ongoing_charges_methodology_for_publication_u_2_.pdf\" target=\"_blank\">KID ongoing charges<a/>. | [optional]
14 | **trackingIndex** | **String** | Tracking Index. | [optional]
15 | **etfCompany** | **String** | ETF issuer. | [optional]
16 | **domicile** | **String** | ETF domicile. | [optional]
17 | **inceptionDate** | **Date** | Inception date. | [optional]
18 | **website** | **String** | ETF's website. | [optional]
19 | **logo** | **String** | Logo. | [optional]
20 | **isin** | **String** | ISIN. | [optional]
21 | **cusip** | **String** | CUSIP. | [optional]
22 | **priceToEarnings** | **Number** | P/E. | [optional]
23 | **priceToBook** | **Number** | P/B. | [optional]
24 | **avgVolume** | **Number** | 30-day average volume. | [optional]
25 | **description** | **String** | ETF's description. | [optional]
26 | **isInverse** | **Boolean** | Whether the ETF is inverse | [optional]
27 | **isLeveraged** | **Boolean** | Whether the ETF is leveraged | [optional]
28 | **leverageFactor** | **Number** | Leverage factor. | [optional]
29 |
30 |
31 |
--------------------------------------------------------------------------------
/docs/ETFSectorExposureData.md:
--------------------------------------------------------------------------------
1 | # finnhub.ETFSectorExposureData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **industry** | **String** | Industry | [optional]
8 | **exposure** | **Number** | Percent of exposure. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/ETFsCountryExposure.md:
--------------------------------------------------------------------------------
1 | # finnhub.ETFsCountryExposure
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | ETF symbol. | [optional]
8 | **countryExposure** | [**[ETFCountryExposureData]**](ETFCountryExposureData.md) | Array of countries and and exposure levels. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/ETFsHoldings.md:
--------------------------------------------------------------------------------
1 | # finnhub.ETFsHoldings
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | ETF symbol. | [optional]
8 | **atDate** | **Date** | Holdings update date. | [optional]
9 | **numberOfHoldings** | **Number** | Number of holdings. | [optional]
10 | **holdings** | [**[ETFHoldingsData]**](ETFHoldingsData.md) | Array of holdings. | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/ETFsIndustryExposure.md:
--------------------------------------------------------------------------------
1 | # finnhub.ETFsIndustryExposure
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | ETF symbol. | [optional]
8 | **sectorExposure** | **[Object]** | Array of industries and exposure levels. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/ETFsProfile.md:
--------------------------------------------------------------------------------
1 | # finnhub.ETFsProfile
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **profile** | [**ETFProfileData**](ETFProfileData.md) | | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/ETFsSectorExposure.md:
--------------------------------------------------------------------------------
1 | # finnhub.ETFsSectorExposure
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | ETF symbol. | [optional]
8 | **sectorExposure** | [**[ETFSectorExposureData]**](ETFSectorExposureData.md) | Array of industries and exposure levels. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/EarningEstimate.md:
--------------------------------------------------------------------------------
1 | # finnhub.EarningEstimate
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **epsAvg** | **Number** | Average EPS estimates including Finnhub's proprietary estimates. | [optional]
8 | **epsHigh** | **Number** | Highest estimate. | [optional]
9 | **epsLow** | **Number** | Lowest estimate. | [optional]
10 | **numberAnalysts** | **Number** | Number of Analysts. | [optional]
11 | **period** | **Date** | Period. | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/docs/EarningRelease.md:
--------------------------------------------------------------------------------
1 | # finnhub.EarningRelease
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **date** | **Date** | Date. | [optional]
9 | **hour** | **String** | Indicates whether the earnings is announced before market open(<code>bmo</code>), after market close(<code>amc</code>), or during market hour(<code>dmh</code>). | [optional]
10 | **year** | **Number** | Earnings year. | [optional]
11 | **quarter** | **Number** | Earnings quarter. | [optional]
12 | **epsEstimate** | **Number** | EPS estimate. | [optional]
13 | **epsActual** | **Number** | EPS actual. | [optional]
14 | **revenueEstimate** | **Number** | Revenue estimate including Finnhub's proprietary estimates. | [optional]
15 | **revenueActual** | **Number** | Revenue actual. | [optional]
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/EarningResult.md:
--------------------------------------------------------------------------------
1 | # finnhub.EarningResult
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **actual** | **Number** | Actual earning result. | [optional]
8 | **estimate** | **Number** | Estimated earning. | [optional]
9 | **surprise** | **Number** | Surprise - The difference between actual and estimate. | [optional]
10 | **surprisePercent** | **Number** | Surprise percent. | [optional]
11 | **period** | **Date** | Reported period. | [optional]
12 | **symbol** | **String** | Company symbol. | [optional]
13 | **year** | **Number** | Fiscal year. | [optional]
14 | **quarter** | **Number** | Fiscal quarter. | [optional]
15 |
16 |
17 |
--------------------------------------------------------------------------------
/docs/EarningsCalendar.md:
--------------------------------------------------------------------------------
1 | # finnhub.EarningsCalendar
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **earningsCalendar** | [**[EarningRelease]**](EarningRelease.md) | Array of earnings release. | [optional]
8 |
9 |
10 |
--------------------------------------------------------------------------------
/docs/EarningsCallTranscripts.md:
--------------------------------------------------------------------------------
1 | # finnhub.EarningsCallTranscripts
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Company symbol. | [optional]
8 | **transcript** | [**[TranscriptContent]**](TranscriptContent.md) | Transcript content. | [optional]
9 | **participant** | [**[TranscriptParticipant]**](TranscriptParticipant.md) | Participant list | [optional]
10 | **audio** | **String** | Audio link. | [optional]
11 | **id** | **String** | Transcript's ID. | [optional]
12 | **title** | **String** | Title. | [optional]
13 | **time** | **String** | Time of the event. | [optional]
14 | **year** | **Number** | Year of earnings result in the case of earnings call transcript. | [optional]
15 | **quarter** | **Number** | Quarter of earnings result in the case of earnings call transcript. | [optional]
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/EarningsCallTranscriptsList.md:
--------------------------------------------------------------------------------
1 | # finnhub.EarningsCallTranscriptsList
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Company symbol. | [optional]
8 | **transcripts** | [**[StockTranscripts]**](StockTranscripts.md) | Array of transcripts' metadata | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/EarningsEstimates.md:
--------------------------------------------------------------------------------
1 | # finnhub.EarningsEstimates
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **data** | [**[EarningsEstimatesInfo]**](EarningsEstimatesInfo.md) | List of estimates | [optional]
8 | **freq** | **String** | Frequency: annual or quarterly. | [optional]
9 | **symbol** | **String** | Company symbol. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/EarningsEstimatesInfo.md:
--------------------------------------------------------------------------------
1 | # finnhub.EarningsEstimatesInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **epsAvg** | **Number** | Average EPS estimates including Finnhub's proprietary estimates. | [optional]
8 | **epsHigh** | **Number** | Highest estimate. | [optional]
9 | **epsLow** | **Number** | Lowest estimate. | [optional]
10 | **numberAnalysts** | **Number** | Number of Analysts. | [optional]
11 | **period** | **Date** | Period. | [optional]
12 | **year** | **Number** | Fiscal year. | [optional]
13 | **quarter** | **Number** | Fiscal quarter. | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/docs/EbitEstimates.md:
--------------------------------------------------------------------------------
1 | # finnhub.EbitEstimates
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **data** | [**[EbitEstimatesInfo]**](EbitEstimatesInfo.md) | List of estimates | [optional]
8 | **freq** | **String** | Frequency: annual or quarterly. | [optional]
9 | **symbol** | **String** | Company symbol. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/EbitEstimatesInfo.md:
--------------------------------------------------------------------------------
1 | # finnhub.EbitEstimatesInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ebitAvg** | **Number** | Average EBIT estimates including Finnhub's proprietary estimates. | [optional]
8 | **ebitHigh** | **Number** | Highest estimate. | [optional]
9 | **ebitLow** | **Number** | Lowest estimate. | [optional]
10 | **numberAnalysts** | **Number** | Number of Analysts. | [optional]
11 | **period** | **Date** | Period. | [optional]
12 | **year** | **Number** | Fiscal year. | [optional]
13 | **quarter** | **Number** | Fiscal quarter. | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/docs/EbitdaEstimates.md:
--------------------------------------------------------------------------------
1 | # finnhub.EbitdaEstimates
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **data** | [**[EbitdaEstimatesInfo]**](EbitdaEstimatesInfo.md) | List of estimates | [optional]
8 | **freq** | **String** | Frequency: annual or quarterly. | [optional]
9 | **symbol** | **String** | Company symbol. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/EbitdaEstimatesInfo.md:
--------------------------------------------------------------------------------
1 | # finnhub.EbitdaEstimatesInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ebitdaAvg** | **Number** | Average EBITDA estimates including Finnhub's proprietary estimates. | [optional]
8 | **ebitdaHigh** | **Number** | Highest estimate. | [optional]
9 | **ebitdaLow** | **Number** | Lowest estimate. | [optional]
10 | **numberAnalysts** | **Number** | Number of Analysts. | [optional]
11 | **period** | **Date** | Period. | [optional]
12 | **year** | **Number** | Fiscal year. | [optional]
13 | **quarter** | **Number** | Fiscal quarter. | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/docs/EconomicCalendar.md:
--------------------------------------------------------------------------------
1 | # finnhub.EconomicCalendar
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **economicCalendar** | [**[EconomicEvent]**](EconomicEvent.md) | Array of economic events. | [optional]
8 |
9 |
10 |
--------------------------------------------------------------------------------
/docs/EconomicCode.md:
--------------------------------------------------------------------------------
1 | # finnhub.EconomicCode
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **code** | **String** | Finnhub economic code used to get historical data | [optional]
8 | **country** | **String** | Country | [optional]
9 | **name** | **String** | Indicator name | [optional]
10 | **unit** | **String** | Unit | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/EconomicData.md:
--------------------------------------------------------------------------------
1 | # finnhub.EconomicData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **data** | [**[EconomicDataInfo]**](EconomicDataInfo.md) | Array of economic data for requested code. | [optional]
8 | **code** | **String** | Finnhub economic code | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/EconomicDataInfo.md:
--------------------------------------------------------------------------------
1 | # finnhub.EconomicDataInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **date** | **String** | Date of the reading | [optional]
8 | **value** | **Number** | Value | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/EconomicEvent.md:
--------------------------------------------------------------------------------
1 | # finnhub.EconomicEvent
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **actual** | **Number** | Actual release | [optional]
8 | **prev** | **Number** | Previous release | [optional]
9 | **country** | **String** | Country | [optional]
10 | **unit** | **String** | Unit | [optional]
11 | **estimate** | **Number** | Estimate | [optional]
12 | **event** | **String** | Event | [optional]
13 | **impact** | **String** | Impact level | [optional]
14 | **time** | **String** | Release time | [optional]
15 |
16 |
17 |
--------------------------------------------------------------------------------
/docs/EmployeeCount.md:
--------------------------------------------------------------------------------
1 | # finnhub.EmployeeCount
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **atDate** | **String** | Date of the reading | [optional]
8 | **employee** | **Number** | Value | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/Estimate.md:
--------------------------------------------------------------------------------
1 | # finnhub.Estimate
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **revenueAvg** | **Number** | Average revenue estimates including Finnhub's proprietary estimates. | [optional]
8 | **revenueHigh** | **Number** | Highest estimate. | [optional]
9 | **revenueLow** | **Number** | Lowest estimate. | [optional]
10 | **numberAnalysts** | **Number** | Number of Analysts. | [optional]
11 | **period** | **Date** | Period. | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/docs/ExcerptResponse.md:
--------------------------------------------------------------------------------
1 | # finnhub.ExcerptResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **content** | **String** | Highlighted content | [optional]
8 | **snippetId** | **String** | Location of the content in the rendered document | [optional]
9 | **startOffset** | **String** | Start offset of highlighted content | [optional]
10 | **endOffset** | **String** | End offset of highlighted content | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/FDAComitteeMeeting.md:
--------------------------------------------------------------------------------
1 | # finnhub.FDAComitteeMeeting
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **fromDate** | **String** | Start time of the event in EST. | [optional]
8 | **toDate** | **String** | End time of the event in EST. | [optional]
9 | **eventDescription** | **String** | Event's description. | [optional]
10 | **url** | **String** | URL. | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/Filing.md:
--------------------------------------------------------------------------------
1 | # finnhub.Filing
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **accessNumber** | **String** | Access number. | [optional]
8 | **symbol** | **String** | Symbol. | [optional]
9 | **cik** | **String** | CIK. | [optional]
10 | **form** | **String** | Form type. | [optional]
11 | **filedDate** | **String** | Filed date <code>%Y-%m-%d %H:%M:%S</code>. | [optional]
12 | **acceptedDate** | **String** | Accepted date <code>%Y-%m-%d %H:%M:%S</code>. | [optional]
13 | **reportUrl** | **String** | Report's URL. | [optional]
14 | **filingUrl** | **String** | Filing's URL. | [optional]
15 |
16 |
17 |
--------------------------------------------------------------------------------
/docs/FilingResponse.md:
--------------------------------------------------------------------------------
1 | # finnhub.FilingResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **filingId** | **String** | Filing Id in Alpharesearch platform | [optional]
8 | **title** | **String** | Filing title | [optional]
9 | **filerId** | **String** | Id of the entity submitted the filing | [optional]
10 | **symbol** | **Object** | List of symbol associate with this filing | [optional]
11 | **name** | **String** | Filer name | [optional]
12 | **acceptanceDate** | **String** | Date the filing is submitted. | [optional]
13 | **filedDate** | **String** | Date the filing is made available to the public | [optional]
14 | **reportDate** | **String** | Date as which the filing is reported | [optional]
15 | **form** | **String** | Filing Form | [optional]
16 | **amend** | **Boolean** | Amendment | [optional]
17 | **source** | **String** | Filing Source | [optional]
18 | **pageCount** | **Number** | Estimate number of page when printing | [optional]
19 | **documentCount** | **Number** | Number of document in this filing | [optional]
20 |
21 |
22 |
--------------------------------------------------------------------------------
/docs/FilingSentiment.md:
--------------------------------------------------------------------------------
1 | # finnhub.FilingSentiment
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **negative** | **Number** | % of negative words in the filing. | [optional]
8 | **positive** | **Number** | % of positive words in the filing. | [optional]
9 | **polarity** | **Number** | % of polarity words in the filing. | [optional]
10 | **litigious** | **Number** | % of litigious words in the filing. | [optional]
11 | **uncertainty** | **Number** | % of uncertainty words in the filing. | [optional]
12 | **constraining** | **Number** | % of constraining words in the filing. | [optional]
13 | **modalWeak** | **Number** | % of modal-weak words in the filing. | [optional]
14 | **modalStrong** | **Number** | % of modal-strong words in the filing. | [optional]
15 | **modalModerate** | **Number** | % of modal-moderate words in the filing. | [optional]
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/FinancialStatements.md:
--------------------------------------------------------------------------------
1 | # finnhub.FinancialStatements
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol of the company. | [optional]
8 | **financials** | **[Object]** | An array of map of key, value pairs containing the data for each period. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/FinancialsAsReported.md:
--------------------------------------------------------------------------------
1 | # finnhub.FinancialsAsReported
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol | [optional]
8 | **cik** | **String** | CIK | [optional]
9 | **data** | [**[Report]**](Report.md) | Array of filings. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/ForexCandles.md:
--------------------------------------------------------------------------------
1 | # finnhub.ForexCandles
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **o** | **[Number]** | List of open prices for returned candles. | [optional]
8 | **h** | **[Number]** | List of high prices for returned candles. | [optional]
9 | **l** | **[Number]** | List of low prices for returned candles. | [optional]
10 | **c** | **[Number]** | List of close prices for returned candles. | [optional]
11 | **v** | **[Number]** | List of volume data for returned candles. | [optional]
12 | **t** | **[Number]** | List of timestamp for returned candles. | [optional]
13 | **s** | **String** | Status of the response. This field can either be ok or no_data. | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/docs/ForexSymbol.md:
--------------------------------------------------------------------------------
1 | # finnhub.ForexSymbol
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **description** | **String** | Symbol description | [optional]
8 | **displaySymbol** | **String** | Display symbol name. | [optional]
9 | **symbol** | **String** | Unique symbol used to identify this symbol used in <code>/forex/candle</code> endpoint. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/Forexrates.md:
--------------------------------------------------------------------------------
1 | # finnhub.Forexrates
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **base** | **String** | Base currency. | [optional]
8 | **quote** | **Object** | | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/FundOwnership.md:
--------------------------------------------------------------------------------
1 | # finnhub.FundOwnership
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol of the company. | [optional]
8 | **ownership** | [**[FundOwnershipInfo]**](FundOwnershipInfo.md) | Array of investors with detailed information about their holdings. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/FundOwnershipInfo.md:
--------------------------------------------------------------------------------
1 | # finnhub.FundOwnershipInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **name** | **String** | Investor's name. | [optional]
8 | **share** | **Number** | Number of shares held by the investor. | [optional]
9 | **change** | **Number** | Number of share changed (net buy or sell) from the last period. | [optional]
10 | **filingDate** | **Date** | Filing date. | [optional]
11 | **portfolioPercent** | **Number** | Percent of the fund's portfolio comprised of the company's share. | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/docs/HistoricalCompanyESG.md:
--------------------------------------------------------------------------------
1 | # finnhub.HistoricalCompanyESG
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | symbol | [optional]
8 | **data** | [**[CompanyESG2]**](CompanyESG2.md) | Historical ESG data points. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/HistoricalEmployeeCount.md:
--------------------------------------------------------------------------------
1 | # finnhub.HistoricalEmployeeCount
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **data** | [**[EmployeeCount]**](EmployeeCount.md) | Array of market data. | [optional]
8 | **symbol** | **String** | Symbol | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/HistoricalMarketCapData.md:
--------------------------------------------------------------------------------
1 | # finnhub.HistoricalMarketCapData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **data** | [**[MarketCapData]**](MarketCapData.md) | Array of market data. | [optional]
8 | **symbol** | **String** | Symbol | [optional]
9 | **currency** | **String** | Currency | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/HistoricalNBBO.md:
--------------------------------------------------------------------------------
1 | # finnhub.HistoricalNBBO
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **s** | **String** | Symbol. | [optional]
8 | **skip** | **Number** | Number of ticks skipped. | [optional]
9 | **count** | **Number** | Number of ticks returned. If <code>count</code> < <code>limit</code>, all data for that date has been returned. | [optional]
10 | **total** | **Number** | Total number of ticks for that date. | [optional]
11 | **av** | **[Number]** | List of Ask volume data. | [optional]
12 | **a** | **[Number]** | List of Ask price data. | [optional]
13 | **ax** | **[String]** | List of venues/exchanges - Ask price. A list of exchange codes can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1Tj53M1svmr-hfEtbk6_NpVR1yAyGLMaH6ByYU6CG0ZY/edit?usp=sharing\",>here</a> | [optional]
14 | **bv** | **[Number]** | List of Bid volume data. | [optional]
15 | **b** | **[Number]** | List of Bid price data. | [optional]
16 | **bx** | **[String]** | List of venues/exchanges - Bid price. A list of exchange codes can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1Tj53M1svmr-hfEtbk6_NpVR1yAyGLMaH6ByYU6CG0ZY/edit?usp=sharing\",>here</a> | [optional]
17 | **t** | **[Number]** | List of timestamp in UNIX ms. | [optional]
18 | **c** | **[[String]]** | List of quote conditions. A comprehensive list of quote conditions code can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1iiA6e7Osdtai0oPMOUzgAIKXCsay89dFDmsegz6OpEg/edit?usp=sharing\">here</a> | [optional]
19 |
20 |
21 |
--------------------------------------------------------------------------------
/docs/IPOCalendar.md:
--------------------------------------------------------------------------------
1 | # finnhub.IPOCalendar
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **ipoCalendar** | [**[IPOEvent]**](IPOEvent.md) | Array of IPO events. | [optional]
8 |
9 |
10 |
--------------------------------------------------------------------------------
/docs/IPOEvent.md:
--------------------------------------------------------------------------------
1 | # finnhub.IPOEvent
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **date** | **Date** | IPO date. | [optional]
9 | **exchange** | **String** | Exchange. | [optional]
10 | **name** | **String** | Company's name. | [optional]
11 | **status** | **String** | IPO status. Can take 1 of the following values: <code>expected</code>,<code>priced</code>,<code>withdrawn</code>,<code>filed</code> | [optional]
12 | **price** | **String** | Projected price or price range. | [optional]
13 | **numberOfShares** | **Number** | Number of shares offered during the IPO. | [optional]
14 | **totalSharesValue** | **Number** | Total shares value. | [optional]
15 |
16 |
17 |
--------------------------------------------------------------------------------
/docs/InFilingResponse.md:
--------------------------------------------------------------------------------
1 | # finnhub.InFilingResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **filingId** | **String** | Filing Id in Alpharesearch platform | [optional]
8 | **title** | **String** | Filing title | [optional]
9 | **filerId** | **String** | Id of the entity submitted the filing | [optional]
10 | **symbol** | **Object** | List of symbol associate with this filing | [optional]
11 | **name** | **String** | Filer name | [optional]
12 | **acceptanceDate** | **String** | Date the filing is submitted. | [optional]
13 | **filedDate** | **String** | Date the filing is make available to the public | [optional]
14 | **reportDate** | **String** | Date as which the filing is reported | [optional]
15 | **form** | **String** | Filing Form | [optional]
16 | **amend** | **Boolean** | Amendment | [optional]
17 | **source** | **String** | Filing Source | [optional]
18 | **pageCount** | **Number** | Estimate number of page when printing | [optional]
19 | **documentCount** | **Number** | Number of document in this filing | [optional]
20 | **documents** | [**[DocumentResponse]**](DocumentResponse.md) | Document for this filing. | [optional]
21 |
22 |
23 |
--------------------------------------------------------------------------------
/docs/InFilingSearchBody.md:
--------------------------------------------------------------------------------
1 | # finnhub.InFilingSearchBody
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **query** | **String** | Search query |
8 | **filingId** | **String** | Filing Id to search |
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/IndexHistoricalConstituent.md:
--------------------------------------------------------------------------------
1 | # finnhub.IndexHistoricalConstituent
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol | [optional]
8 | **action** | **String** | <code>add</code> or <code>remove</code>. | [optional]
9 | **date** | **Date** | Date of joining or leaving the index. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/Indicator.md:
--------------------------------------------------------------------------------
1 | # finnhub.Indicator
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **buy** | **Number** | Number of buy signals | [optional]
8 | **neutral** | **Number** | Number of neutral signals | [optional]
9 | **sell** | **Number** | Number of sell signals | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/IndicesConstituents.md:
--------------------------------------------------------------------------------
1 | # finnhub.IndicesConstituents
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Index's symbol. | [optional]
8 | **constituents** | **[String]** | Array of constituents. | [optional]
9 | **constituentsBreakdown** | [**[IndicesConstituentsBreakdown]**](IndicesConstituentsBreakdown.md) | Array of constituents' details. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/IndicesConstituentsBreakdown.md:
--------------------------------------------------------------------------------
1 | # finnhub.IndicesConstituentsBreakdown
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **name** | **String** | Name. | [optional]
9 | **isin** | **String** | ISIN. | [optional]
10 | **cusip** | **String** | Cusip. | [optional]
11 | **shareClassFIGI** | **String** | Global Share Class FIGI. | [optional]
12 | **weight** | **Number** | Weight. | [optional]
13 |
14 |
15 |
--------------------------------------------------------------------------------
/docs/IndicesHistoricalConstituents.md:
--------------------------------------------------------------------------------
1 | # finnhub.IndicesHistoricalConstituents
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Index's symbol. | [optional]
8 | **historicalConstituents** | [**[IndexHistoricalConstituent]**](IndexHistoricalConstituent.md) | Array of historical constituents. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/InsiderSentiments.md:
--------------------------------------------------------------------------------
1 | # finnhub.InsiderSentiments
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol of the company. | [optional]
8 | **data** | [**[InsiderSentimentsData]**](InsiderSentimentsData.md) | Array of sentiment data. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/InsiderSentimentsData.md:
--------------------------------------------------------------------------------
1 | # finnhub.InsiderSentimentsData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **year** | **Number** | Year. | [optional]
9 | **month** | **Number** | Month. | [optional]
10 | **change** | **Number** | Net buying/selling from all insiders' transactions. | [optional]
11 | **mspr** | **Number** | Monthly share purchase ratio. | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/docs/InsiderTransactions.md:
--------------------------------------------------------------------------------
1 | # finnhub.InsiderTransactions
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol of the company. | [optional]
8 | **data** | [**[Transactions]**](Transactions.md) | Array of insider transactions. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/InstitutionalOwnership.md:
--------------------------------------------------------------------------------
1 | # finnhub.InstitutionalOwnership
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **cusip** | **String** | Cusip. | [optional]
9 | **data** | [**[InstitutionalOwnershipGroup]**](InstitutionalOwnershipGroup.md) | Array of institutional investors. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/InstitutionalOwnershipGroup.md:
--------------------------------------------------------------------------------
1 | # finnhub.InstitutionalOwnershipGroup
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **reportDate** | **String** | Report date. | [optional]
8 | **ownership** | [**[InstitutionalOwnershipInfo]**](InstitutionalOwnershipInfo.md) | Array of institutional investors. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/InstitutionalOwnershipInfo.md:
--------------------------------------------------------------------------------
1 | # finnhub.InstitutionalOwnershipInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **cik** | **String** | Investor's company CIK. | [optional]
8 | **name** | **String** | Firm's name. | [optional]
9 | **putCall** | **String** | <code>put</code> or <code>call</code> for options. | [optional]
10 | **change** | **Number** | Number of shares change. | [optional]
11 | **noVoting** | **Number** | Number of shares with no voting rights. | [optional]
12 | **percentage** | **Number** | Percentage of portfolio. | [optional]
13 | **share** | **Number** | News score. | [optional]
14 | **sharedVoting** | **Number** | Number of shares with shared voting rights. | [optional]
15 | **soleVoting** | **Number** | Number of shares with sole voting rights. | [optional]
16 | **value** | **Number** | Position value. | [optional]
17 |
18 |
19 |
--------------------------------------------------------------------------------
/docs/InstitutionalPortfolio.md:
--------------------------------------------------------------------------------
1 | # finnhub.InstitutionalPortfolio
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **name** | **String** | Investor's name. | [optional]
8 | **cik** | **String** | CIK. | [optional]
9 | **data** | [**[InstitutionalPortfolioGroup]**](InstitutionalPortfolioGroup.md) | Array of positions. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/InstitutionalPortfolioGroup.md:
--------------------------------------------------------------------------------
1 | # finnhub.InstitutionalPortfolioGroup
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **reportDate** | **String** | Report date. | [optional]
8 | **filingDate** | **String** | Filing date. | [optional]
9 | **portfolio** | [**[InstitutionalPortfolioInfo]**](InstitutionalPortfolioInfo.md) | Array of positions. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/InstitutionalPortfolioInfo.md:
--------------------------------------------------------------------------------
1 | # finnhub.InstitutionalPortfolioInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **cusip** | **String** | CUSIP. | [optional]
9 | **name** | **String** | Position's name. | [optional]
10 | **putCall** | **String** | <code>put</code> or <code>call</code> for options. | [optional]
11 | **change** | **Number** | Number of shares change. | [optional]
12 | **noVoting** | **Number** | Number of shares with no voting rights. | [optional]
13 | **percentage** | **Number** | Percentage of portfolio. | [optional]
14 | **share** | **Number** | Number of shares. | [optional]
15 | **sharedVoting** | **Number** | Number of shares with shared voting rights. | [optional]
16 | **soleVoting** | **Number** | Number of shares with sole voting rights. | [optional]
17 | **value** | **Number** | Position value. | [optional]
18 |
19 |
20 |
--------------------------------------------------------------------------------
/docs/InstitutionalProfile.md:
--------------------------------------------------------------------------------
1 | # finnhub.InstitutionalProfile
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **cik** | **String** | CIK. | [optional]
8 | **data** | [**[InstitutionalProfileInfo]**](InstitutionalProfileInfo.md) | Array of investors. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/InstitutionalProfileInfo.md:
--------------------------------------------------------------------------------
1 | # finnhub.InstitutionalProfileInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **cik** | **String** | Investor's company CIK. | [optional]
8 | **firmType** | **String** | Firm type. | [optional]
9 | **manager** | **String** | Manager. | [optional]
10 | **philosophy** | **String** | Investing philosophy. | [optional]
11 | **profile** | **String** | Profile info. | [optional]
12 | **profileImg** | **String** | Profile image. | [optional]
13 |
14 |
15 |
--------------------------------------------------------------------------------
/docs/InternationalFiling.md:
--------------------------------------------------------------------------------
1 | # finnhub.InternationalFiling
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **companyName** | **String** | Company name. | [optional]
9 | **filedDate** | **String** | Filed date <code>%Y-%m-%d %H:%M:%S</code>. | [optional]
10 | **category** | **String** | Category. | [optional]
11 | **title** | **String** | Document's title. | [optional]
12 | **description** | **String** | Document's description. | [optional]
13 | **url** | **String** | Url. | [optional]
14 | **language** | **String** | Language. | [optional]
15 | **country** | **String** | Country. | [optional]
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/InvestmentThemePortfolio.md:
--------------------------------------------------------------------------------
1 | # finnhub.InvestmentThemePortfolio
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol | [optional]
8 |
9 |
10 |
--------------------------------------------------------------------------------
/docs/InvestmentThemes.md:
--------------------------------------------------------------------------------
1 | # finnhub.InvestmentThemes
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **theme** | **String** | Investment theme | [optional]
8 | **data** | [**[InvestmentThemePortfolio]**](InvestmentThemePortfolio.md) | Investment theme portfolio. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/InvestmentThemesThematicInvesting.md:
--------------------------------------------------------------------------------
1 | # finnhub.InvestmentThemesThematicInvesting
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **theme** | **String** | Investment theme | [optional]
8 | **data** | **[Object]** | Investment theme portfolio. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/Investor.md:
--------------------------------------------------------------------------------
1 | # finnhub.Investor
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **name** | **String** | Investor's name. | [optional]
8 | **share** | **Number** | Number of shares held by the investor. | [optional]
9 | **change** | **Number** | Number of share changed (net buy or sell) from the last period. | [optional]
10 | **filingDate** | **Date** | Filing date. | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/InvestorsOwnership.md:
--------------------------------------------------------------------------------
1 | # finnhub.InvestorsOwnership
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol of the company. | [optional]
8 | **ownership** | **[Object]** | Array of investors with detailed information about their holdings. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/IsinChange.md:
--------------------------------------------------------------------------------
1 | # finnhub.IsinChange
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **fromDate** | **String** | From date. | [optional]
8 | **toDate** | **String** | To date. | [optional]
9 | **data** | [**[IsinChangeInfo]**](IsinChangeInfo.md) | Array of ISIN change events. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/IsinChangeInfo.md:
--------------------------------------------------------------------------------
1 | # finnhub.IsinChangeInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **atDate** | **String** | Event's date. | [optional]
8 | **oldIsin** | **String** | Old ISIN. | [optional]
9 | **newIsin** | **String** | New ISIN. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/KeyCustomersSuppliers.md:
--------------------------------------------------------------------------------
1 | # finnhub.KeyCustomersSuppliers
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol | [optional]
8 | **name** | **String** | Name | [optional]
9 | **country** | **String** | Country | [optional]
10 | **industry** | **String** | Industry | [optional]
11 | **customer** | **Boolean** | Whether the company is a customer. | [optional]
12 | **supplier** | **Boolean** | Whether the company is a supplier | [optional]
13 | **oneMonthCorrelation** | **Number** | 1-month price correlation | [optional]
14 | **oneYearCorrelation** | **Number** | 1-year price correlation | [optional]
15 | **sixMonthCorrelation** | **Number** | 6-month price correlation | [optional]
16 | **threeMonthCorrelation** | **Number** | 3-month price correlation | [optional]
17 | **twoWeekCorrelation** | **Number** | 2-week price correlation | [optional]
18 | **twoYearCorrelation** | **Number** | 2-year price correlation | [optional]
19 |
20 |
21 |
--------------------------------------------------------------------------------
/docs/LastBidAsk.md:
--------------------------------------------------------------------------------
1 | # finnhub.LastBidAsk
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **b** | **Number** | Bid price. | [optional]
8 | **a** | **Number** | Ask price. | [optional]
9 | **bv** | **Number** | Bid volume. | [optional]
10 | **av** | **Number** | Ask volume. | [optional]
11 | **t** | **Number** | Reference UNIX timestamp in ms. | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/docs/LobbyingData.md:
--------------------------------------------------------------------------------
1 | # finnhub.LobbyingData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **name** | **String** | Company's name. | [optional]
9 | **description** | **String** | Description. | [optional]
10 | **country** | **String** | Country. | [optional]
11 | **year** | **Number** | Year. | [optional]
12 | **period** | **String** | Period. | [optional]
13 | **income** | **Number** | Income reported by lobbying firms. | [optional]
14 | **expenses** | **Number** | Expenses reported by the company. | [optional]
15 | **documentUrl** | **String** | Document's URL. | [optional]
16 | **postedName** | **String** | Posted name. | [optional]
17 | **date** | **String** | Date. | [optional]
18 | **clientId** | **String** | Client ID. | [optional]
19 | **registrantId** | **String** | Registrant ID. | [optional]
20 | **senateId** | **String** | Senate ID. | [optional]
21 | **houseregistrantId** | **String** | House registrant ID. | [optional]
22 |
23 |
24 |
--------------------------------------------------------------------------------
/docs/LobbyingResult.md:
--------------------------------------------------------------------------------
1 | # finnhub.LobbyingResult
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **data** | [**[LobbyingData]**](LobbyingData.md) | Array of lobbying activities. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/MajorDevelopments.md:
--------------------------------------------------------------------------------
1 | # finnhub.MajorDevelopments
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Company symbol. | [optional]
8 | **majorDevelopment** | **[Object]** | Array of major developments. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/MajorPressReleases.md:
--------------------------------------------------------------------------------
1 | # finnhub.MajorPressReleases
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Company symbol. | [optional]
8 | **majorDevelopment** | **[Object]** | Array of major developments. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/MarketCapData.md:
--------------------------------------------------------------------------------
1 | # finnhub.MarketCapData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **atDate** | **String** | Date of the reading | [optional]
8 | **marketCapitalization** | **Number** | Value | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/MarketHoliday.md:
--------------------------------------------------------------------------------
1 | # finnhub.MarketHoliday
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **timezone** | **String** | Timezone. | [optional]
8 | **exchange** | **String** | Exchange. | [optional]
9 | **data** | [**[MarketHolidayData]**](MarketHolidayData.md) | Array of holidays. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/MarketHolidayData.md:
--------------------------------------------------------------------------------
1 | # finnhub.MarketHolidayData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **eventName** | **String** | Holiday's name. | [optional]
8 | **atDate** | **String** | Date. | [optional]
9 | **tradingHour** | **String** | Trading hours for this day if the market is partially closed only. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/MarketNews.md:
--------------------------------------------------------------------------------
1 | # finnhub.MarketNews
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **category** | **String** | News category. | [optional]
8 | **datetime** | **Number** | Published time in UNIX timestamp. | [optional]
9 | **headline** | **String** | News headline. | [optional]
10 | **id** | **Number** | News ID. This value can be used for <code>minId</code> params to get the latest news only. | [optional]
11 | **image** | **String** | Thumbnail image URL. | [optional]
12 | **related** | **String** | Related stocks and companies mentioned in the article. | [optional]
13 | **source** | **String** | News source. | [optional]
14 | **summary** | **String** | News summary. | [optional]
15 | **url** | **String** | URL of the original article. | [optional]
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/MarketStatus.md:
--------------------------------------------------------------------------------
1 | # finnhub.MarketStatus
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **exchange** | **String** | Exchange. | [optional]
8 | **timezone** | **String** | Timezone. | [optional]
9 | **session** | **String** | Market session. Can be 1 of the following values: <code>pre-market</code>,<code>regular</code>,<code>post-market</code> or <code>null</code> if the market is closed. | [optional]
10 | **holiday** | **String** | Holiday event. | [optional]
11 | **isOpen** | **Boolean** | Whether the market is open at the moment. | [optional]
12 | **t** | **Number** | Current timestamp. | [optional]
13 |
14 |
15 |
--------------------------------------------------------------------------------
/docs/MutualFundCountryExposure.md:
--------------------------------------------------------------------------------
1 | # finnhub.MutualFundCountryExposure
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **countryExposure** | [**[MutualFundCountryExposureData]**](MutualFundCountryExposureData.md) | Array of countries and and exposure levels. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/MutualFundCountryExposureData.md:
--------------------------------------------------------------------------------
1 | # finnhub.MutualFundCountryExposureData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **country** | **String** | Country | [optional]
8 | **exposure** | **Number** | Percent of exposure. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/MutualFundEet.md:
--------------------------------------------------------------------------------
1 | # finnhub.MutualFundEet
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **isin** | **String** | ISIN. | [optional]
8 | **data** | **Object** | | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/MutualFundEetPai.md:
--------------------------------------------------------------------------------
1 | # finnhub.MutualFundEetPai
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **isin** | **String** | ISIN. | [optional]
8 | **data** | **Object** | | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/MutualFundHoldings.md:
--------------------------------------------------------------------------------
1 | # finnhub.MutualFundHoldings
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **atDate** | **Date** | Holdings update date. | [optional]
9 | **numberOfHoldings** | **Number** | Number of holdings. | [optional]
10 | **holdings** | [**[MutualFundHoldingsData]**](MutualFundHoldingsData.md) | Array of holdings. | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/MutualFundHoldingsData.md:
--------------------------------------------------------------------------------
1 | # finnhub.MutualFundHoldingsData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol description | [optional]
8 | **name** | **String** | Security name | [optional]
9 | **isin** | **String** | ISIN. | [optional]
10 | **cusip** | **String** | CUSIP. | [optional]
11 | **share** | **Number** | Number of shares. | [optional]
12 | **percent** | **Number** | Portfolio's percent | [optional]
13 | **value** | **Number** | Market value | [optional]
14 | **assetType** | **String** | Asset type. Can be 1 of the following values: <code>Equity</code>, <code>ETP</code>, <code>Fund</code>, <code>Bond</code>, <code>Other</code> or empty. | [optional]
15 |
16 |
17 |
--------------------------------------------------------------------------------
/docs/MutualFundProfile.md:
--------------------------------------------------------------------------------
1 | # finnhub.MutualFundProfile
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **profile** | [**MutualFundProfileData**](MutualFundProfileData.md) | | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/MutualFundSectorExposure.md:
--------------------------------------------------------------------------------
1 | # finnhub.MutualFundSectorExposure
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Mutual symbol. | [optional]
8 | **sectorExposure** | [**[MutualFundSectorExposureData]**](MutualFundSectorExposureData.md) | Array of sector and exposure levels. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/MutualFundSectorExposureData.md:
--------------------------------------------------------------------------------
1 | # finnhub.MutualFundSectorExposureData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **sector** | **String** | Sector | [optional]
8 | **exposure** | **Number** | Percent of exposure. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/MutualFundsCountryExposure.md:
--------------------------------------------------------------------------------
1 | # finnhub.MutualFundsCountryExposure
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **countryExposure** | **[Object]** | Array of countries and and exposure levels. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/MutualFundsHoldings.md:
--------------------------------------------------------------------------------
1 | # finnhub.MutualFundsHoldings
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **atDate** | **Date** | Holdings update date. | [optional]
9 | **numberOfHoldings** | **Number** | Number of holdings. | [optional]
10 | **holdings** | **[Object]** | Array of holdings. | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/MutualFundsProfile.md:
--------------------------------------------------------------------------------
1 | # finnhub.MutualFundsProfile
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **profile** | [**ETFProfileData**](ETFProfileData.md) | | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/News.md:
--------------------------------------------------------------------------------
1 | # finnhub.News
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **category** | **String** | News category. | [optional]
8 | **datetime** | **Number** | Published time in UNIX timestamp. | [optional]
9 | **headline** | **String** | News headline. | [optional]
10 | **id** | **Number** | News ID. This value can be used for <code>minId</code> params to get the latest news only. | [optional]
11 | **image** | **String** | Thumbnail image URL. | [optional]
12 | **related** | **String** | Related stocks and companies mentioned in the article. | [optional]
13 | **source** | **String** | News source. | [optional]
14 | **summary** | **String** | News summary. | [optional]
15 | **url** | **String** | URL of the original article. | [optional]
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/NewsSentiment.md:
--------------------------------------------------------------------------------
1 | # finnhub.NewsSentiment
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **buzz** | [**CompanyNewsStatistics**](CompanyNewsStatistics.md) | | [optional]
8 | **companyNewsScore** | **Number** | News score. | [optional]
9 | **sectorAverageBullishPercent** | **Number** | Sector average bullish percent. | [optional]
10 | **sectorAverageNewsScore** | **Number** | Sectore average score. | [optional]
11 | **sentiment** | [**Sentiment**](Sentiment.md) | | [optional]
12 | **symbol** | **String** | Requested symbol. | [optional]
13 |
14 |
15 |
--------------------------------------------------------------------------------
/docs/Ownership.md:
--------------------------------------------------------------------------------
1 | # finnhub.Ownership
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol of the company. | [optional]
8 | **ownership** | [**[OwnershipInfo]**](OwnershipInfo.md) | Array of investors with detailed information about their holdings. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/OwnershipInfo.md:
--------------------------------------------------------------------------------
1 | # finnhub.OwnershipInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **name** | **String** | Investor's name. | [optional]
8 | **share** | **Number** | Number of shares held by the investor. | [optional]
9 | **change** | **Number** | Number of share changed (net buy or sell) from the last period. | [optional]
10 | **filingDate** | **Date** | Filing date. | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/PatternRecognition.md:
--------------------------------------------------------------------------------
1 | # finnhub.PatternRecognition
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **points** | **[Object]** | Array of patterns. | [optional]
8 |
9 |
10 |
--------------------------------------------------------------------------------
/docs/PressRelease.md:
--------------------------------------------------------------------------------
1 | # finnhub.PressRelease
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Company symbol. | [optional]
8 | **majorDevelopment** | [**[Development]**](Development.md) | Array of major developments. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/PriceMetrics.md:
--------------------------------------------------------------------------------
1 | # finnhub.PriceMetrics
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol of the company. | [optional]
8 | **atDate** | **String** | Data date. | [optional]
9 | **data** | **Object** | | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/PriceTarget.md:
--------------------------------------------------------------------------------
1 | # finnhub.PriceTarget
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Company symbol. | [optional]
8 | **targetHigh** | **Number** | Highes analysts' target. | [optional]
9 | **targetLow** | **Number** | Lowest analysts' target. | [optional]
10 | **targetMean** | **Number** | Mean of all analysts' targets. | [optional]
11 | **targetMedian** | **Number** | Median of all analysts' targets. | [optional]
12 | **numberAnalysts** | **Number** | Number of Analysts. | [optional]
13 | **lastUpdated** | **String** | Updated time of the data | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/docs/Quote.md:
--------------------------------------------------------------------------------
1 | # finnhub.Quote
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **o** | **Number** | Open price of the day | [optional]
8 | **h** | **Number** | High price of the day | [optional]
9 | **l** | **Number** | Low price of the day | [optional]
10 | **c** | **Number** | Current price | [optional]
11 | **pc** | **Number** | Previous close price | [optional]
12 | **d** | **Number** | Change | [optional]
13 | **dp** | **Number** | Percent change | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/docs/RecommendationTrend.md:
--------------------------------------------------------------------------------
1 | # finnhub.RecommendationTrend
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Company symbol. | [optional]
8 | **buy** | **Number** | Number of recommendations that fall into the Buy category | [optional]
9 | **hold** | **Number** | Number of recommendations that fall into the Hold category | [optional]
10 | **period** | **String** | Updated period | [optional]
11 | **sell** | **Number** | Number of recommendations that fall into the Sell category | [optional]
12 | **strongBuy** | **Number** | Number of recommendations that fall into the Strong Buy category | [optional]
13 | **strongSell** | **Number** | Number of recommendations that fall into the Strong Sell category | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/docs/RedditSentimentContent.md:
--------------------------------------------------------------------------------
1 | # finnhub.RedditSentimentContent
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **mention** | **Number** | Number of mentions | [optional]
8 | **positiveMention** | **Number** | Number of positive mentions | [optional]
9 | **negativeMention** | **Number** | Number of negative mentions | [optional]
10 | **positiveScore** | **Number** | Positive score. Range 0-1 | [optional]
11 | **negativeScore** | **Number** | Negative score. Range 0-1 | [optional]
12 | **score** | **Number** | Final score. Range: -1 to 1 with 1 is very positive and -1 is very negative | [optional]
13 | **atTime** | **String** | Period. | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/docs/Report.md:
--------------------------------------------------------------------------------
1 | # finnhub.Report
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **accessNumber** | **String** | Access number. | [optional]
8 | **symbol** | **String** | Symbol. | [optional]
9 | **cik** | **String** | CIK. | [optional]
10 | **year** | **Number** | Year. | [optional]
11 | **quarter** | **Number** | Quarter. | [optional]
12 | **form** | **String** | Form type. | [optional]
13 | **startDate** | **String** | Period start date <code>%Y-%m-%d %H:%M:%S</code>. | [optional]
14 | **endDate** | **String** | Period end date <code>%Y-%m-%d %H:%M:%S</code>. | [optional]
15 | **filedDate** | **String** | Filed date <code>%Y-%m-%d %H:%M:%S</code>. | [optional]
16 | **acceptedDate** | **String** | Accepted date <code>%Y-%m-%d %H:%M:%S</code>. | [optional]
17 | **report** | **Object** | | [optional]
18 |
19 |
20 |
--------------------------------------------------------------------------------
/docs/RevenueBreakdown.md:
--------------------------------------------------------------------------------
1 | # finnhub.RevenueBreakdown
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol | [optional]
8 | **cik** | **String** | CIK | [optional]
9 | **data** | [**[BreakdownItem]**](BreakdownItem.md) | Array of revenue breakdown over multiple periods. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/RevenueEstimates.md:
--------------------------------------------------------------------------------
1 | # finnhub.RevenueEstimates
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **data** | [**[RevenueEstimatesInfo]**](RevenueEstimatesInfo.md) | List of estimates | [optional]
8 | **freq** | **String** | Frequency: annual or quarterly. | [optional]
9 | **symbol** | **String** | Company symbol. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/RevenueEstimatesInfo.md:
--------------------------------------------------------------------------------
1 | # finnhub.RevenueEstimatesInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **revenueAvg** | **Number** | Average revenue estimates including Finnhub's proprietary estimates. | [optional]
8 | **revenueHigh** | **Number** | Highest estimate. | [optional]
9 | **revenueLow** | **Number** | Lowest estimate. | [optional]
10 | **numberAnalysts** | **Number** | Number of Analysts. | [optional]
11 | **period** | **Date** | Period. | [optional]
12 | **year** | **Number** | Fiscal year. | [optional]
13 | **quarter** | **Number** | Fiscal quarter. | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/docs/SECSentimentAnalysis.md:
--------------------------------------------------------------------------------
1 | # finnhub.SECSentimentAnalysis
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **accessNumber** | **String** | Access number. | [optional]
8 | **symbol** | **String** | Symbol. | [optional]
9 | **cik** | **String** | CIK. | [optional]
10 | **sentiment** | [**FilingSentiment**](FilingSentiment.md) | | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/SearchFilter.md:
--------------------------------------------------------------------------------
1 | # finnhub.SearchFilter
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **id** | **String** | Filter id, use with respective field in search query body. | [optional]
8 | **name** | **String** | Display name. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/SearchResponse.md:
--------------------------------------------------------------------------------
1 | # finnhub.SearchResponse
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **count** | **Number** | Total filing matched your search criteria. | [optional]
8 | **took** | **Number** | Time took to execute your search query on our server, value in ms. | [optional]
9 | **page** | **Number** | Current search page | [optional]
10 | **filings** | [**[FilingResponse]**](FilingResponse.md) | Filing match your search criteria. | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/SectorMetric.md:
--------------------------------------------------------------------------------
1 | # finnhub.SectorMetric
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **region** | **String** | Region. | [optional]
8 | **data** | [**[SectorMetricData]**](SectorMetricData.md) | Metrics for each sector. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/SectorMetricData.md:
--------------------------------------------------------------------------------
1 | # finnhub.SectorMetricData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **sector** | **String** | Sector | [optional]
8 | **metrics** | **Object** | Metrics data in key-value format. <code>a</code> and <code>m</code> fields are for average and median respectively. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/Sentiment.md:
--------------------------------------------------------------------------------
1 | # finnhub.Sentiment
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **bearishPercent** | **Number** | | [optional]
8 | **bullishPercent** | **Number** | | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/SentimentContent.md:
--------------------------------------------------------------------------------
1 | # finnhub.SentimentContent
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **mention** | **Number** | Number of mentions | [optional]
8 | **positiveMention** | **Number** | Number of positive mentions | [optional]
9 | **negativeMention** | **Number** | Number of negative mentions | [optional]
10 | **positiveScore** | **Number** | Positive score. Range 0-1 | [optional]
11 | **negativeScore** | **Number** | Negative score. Range 0-1 | [optional]
12 | **score** | **Number** | Final score. Range: -1 to 1 with 1 is very positive and -1 is very negative | [optional]
13 | **atTime** | **String** | Period. | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/docs/SimilarityIndex.md:
--------------------------------------------------------------------------------
1 | # finnhub.SimilarityIndex
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **cik** | **String** | CIK. | [optional]
9 | **similarity** | [**[SimilarityIndexInfo]**](SimilarityIndexInfo.md) | Array of filings with its cosine similarity compared to the same report of the previous year. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/SimilarityIndexInfo.md:
--------------------------------------------------------------------------------
1 | # finnhub.SimilarityIndexInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **cik** | **String** | CIK. | [optional]
8 | **item1** | **Number** | Cosine similarity of Item 1 (Business). This number is only available for Annual reports. | [optional]
9 | **item1a** | **Number** | Cosine similarity of Item 1A (Risk Factors). This number is available for both Annual and Quarterly reports. | [optional]
10 | **item2** | **Number** | Cosine similarity of Item 2 (Management’s Discussion and Analysis of Financial Condition and Results of Operations). This number is only available for Quarterly reports. | [optional]
11 | **item7** | **Number** | Cosine similarity of Item 7 (Management’s Discussion and Analysis of Financial Condition and Results of Operations). This number is only available for Annual reports. | [optional]
12 | **item7a** | **Number** | Cosine similarity of Item 7A (Quantitative and Qualitative Disclosures About Market Risk). This number is only available for Annual reports. | [optional]
13 | **accessNumber** | **String** | Access number. | [optional]
14 | **form** | **String** | Form type. | [optional]
15 | **filedDate** | **String** | Filed date <code>%Y-%m-%d %H:%M:%S</code>. | [optional]
16 | **acceptedDate** | **String** | Accepted date <code>%Y-%m-%d %H:%M:%S</code>. | [optional]
17 | **reportUrl** | **String** | Report's URL. | [optional]
18 | **filingUrl** | **String** | Filing's URL. | [optional]
19 |
20 |
21 |
--------------------------------------------------------------------------------
/docs/SocialSentiment.md:
--------------------------------------------------------------------------------
1 | # finnhub.SocialSentiment
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Company symbol. | [optional]
8 | **data** | [**[SentimentContent]**](SentimentContent.md) | Sentiment data. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/Split.md:
--------------------------------------------------------------------------------
1 | # finnhub.Split
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **date** | **Date** | Split date. | [optional]
9 | **fromFactor** | **Number** | From factor. | [optional]
10 | **toFactor** | **Number** | To factor. | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/Stock.md:
--------------------------------------------------------------------------------
1 | # finnhub.Stock
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **description** | **String** | Symbol description | [optional]
8 | **displaySymbol** | **String** | Display symbol name. | [optional]
9 | **symbol** | **String** | Unique symbol used to identify this symbol used in <code>/stock/candle</code> endpoint. | [optional]
10 | **type** | **String** | Security type. | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/StockCandles.md:
--------------------------------------------------------------------------------
1 | # finnhub.StockCandles
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **o** | **[Number]** | List of open prices for returned candles. | [optional]
8 | **h** | **[Number]** | List of high prices for returned candles. | [optional]
9 | **l** | **[Number]** | List of low prices for returned candles. | [optional]
10 | **c** | **[Number]** | List of close prices for returned candles. | [optional]
11 | **v** | **[Number]** | List of volume data for returned candles. | [optional]
12 | **t** | **[Number]** | List of timestamp for returned candles. | [optional]
13 | **s** | **String** | Status of the response. This field can either be ok or no_data. | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/docs/StockSymbol.md:
--------------------------------------------------------------------------------
1 | # finnhub.StockSymbol
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **description** | **String** | Symbol description | [optional]
8 | **displaySymbol** | **String** | Display symbol name. | [optional]
9 | **symbol** | **String** | Unique symbol used to identify this symbol used in <code>/stock/candle</code> endpoint. | [optional]
10 | **type** | **String** | Security type. | [optional]
11 | **mic** | **String** | Primary exchange's MIC. | [optional]
12 | **figi** | **String** | FIGI identifier. | [optional]
13 | **shareClassFIGI** | **String** | Global Share Class FIGI. | [optional]
14 | **currency** | **String** | Price's currency. This might be different from the reporting currency of fundamental data. | [optional]
15 | **symbol2** | **String** | Alternative ticker for exchanges with multiple tickers for 1 stock such as BSE. | [optional]
16 | **isin** | **String** | ISIN. This field is only available for EU stocks and selected Asian markets. Entitlement from Finnhub is required to access this field. | [optional]
17 |
18 |
19 |
--------------------------------------------------------------------------------
/docs/StockTranscripts.md:
--------------------------------------------------------------------------------
1 | # finnhub.StockTranscripts
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **id** | **String** | Transcript's ID used to get the <a href=\"#transcripts\">full transcript</a>. | [optional]
8 | **title** | **String** | Title. | [optional]
9 | **time** | **String** | Time of the event. | [optional]
10 | **year** | **Number** | Year of earnings result in the case of earnings call transcript. | [optional]
11 | **quarter** | **Number** | Quarter of earnings result in the case of earnings call transcript. | [optional]
12 |
13 |
14 |
--------------------------------------------------------------------------------
/docs/SupplyChainRelationships.md:
--------------------------------------------------------------------------------
1 | # finnhub.SupplyChainRelationships
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | symbol | [optional]
8 | **data** | [**[KeyCustomersSuppliers]**](KeyCustomersSuppliers.md) | Key customers and suppliers. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/SupportResistance.md:
--------------------------------------------------------------------------------
1 | # finnhub.SupportResistance
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **levels** | **[Number]** | Array of support and resistance levels. | [optional]
8 |
9 |
10 |
--------------------------------------------------------------------------------
/docs/SymbolChange.md:
--------------------------------------------------------------------------------
1 | # finnhub.SymbolChange
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **fromDate** | **String** | From date. | [optional]
8 | **toDate** | **String** | To date. | [optional]
9 | **data** | [**[SymbolChangeInfo]**](SymbolChangeInfo.md) | Array of symbol change events. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/SymbolChangeInfo.md:
--------------------------------------------------------------------------------
1 | # finnhub.SymbolChangeInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **atDate** | **String** | Event's date. | [optional]
8 | **oldSymbol** | **String** | Old symbol. | [optional]
9 | **newSymbol** | **String** | New symbol. | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/SymbolLookup.md:
--------------------------------------------------------------------------------
1 | # finnhub.SymbolLookup
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **result** | [**[SymbolLookupInfo]**](SymbolLookupInfo.md) | Array of search results. | [optional]
8 | **count** | **Number** | Number of results. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/SymbolLookupInfo.md:
--------------------------------------------------------------------------------
1 | # finnhub.SymbolLookupInfo
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **description** | **String** | Symbol description | [optional]
8 | **displaySymbol** | **String** | Display symbol name. | [optional]
9 | **symbol** | **String** | Unique symbol used to identify this symbol used in <code>/stock/candle</code> endpoint. | [optional]
10 | **type** | **String** | Security type. | [optional]
11 |
12 |
13 |
--------------------------------------------------------------------------------
/docs/TechnicalAnalysis.md:
--------------------------------------------------------------------------------
1 | # finnhub.TechnicalAnalysis
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **count** | [**Indicator**](Indicator.md) | | [optional]
8 | **signal** | **String** | Aggregate Signal | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/TickData.md:
--------------------------------------------------------------------------------
1 | # finnhub.TickData
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **s** | **String** | Symbol. | [optional]
8 | **skip** | **Number** | Number of ticks skipped. | [optional]
9 | **count** | **Number** | Number of ticks returned. If <code>count</code> < <code>limit</code>, all data for that date has been returned. | [optional]
10 | **total** | **Number** | Total number of ticks for that date. | [optional]
11 | **v** | **[Number]** | List of volume data. | [optional]
12 | **p** | **[Number]** | List of price data. | [optional]
13 | **t** | **[Number]** | List of timestamp in UNIX ms. | [optional]
14 | **x** | **[String]** | List of venues/exchanges. A list of exchange codes can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1Tj53M1svmr-hfEtbk6_NpVR1yAyGLMaH6ByYU6CG0ZY/edit?usp=sharing\",>here</a> | [optional]
15 | **c** | **[[String]]** | List of trade conditions. A comprehensive list of trade conditions code can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1PUxiSWPHSODbaTaoL2Vef6DgU-yFtlRGZf19oBb9Hp0/edit?usp=sharing\">here</a> | [optional]
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/Transactions.md:
--------------------------------------------------------------------------------
1 | # finnhub.Transactions
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **name** | **String** | Insider's name. | [optional]
9 | **share** | **Number** | Number of shares held after the transaction. | [optional]
10 | **change** | **Number** | Number of share changed from the last period. A positive value suggests a <code>BUY</code> transaction. A negative value suggests a <code>SELL</code> transaction. | [optional]
11 | **filingDate** | **Date** | Filing date. | [optional]
12 | **transactionDate** | **Date** | Transaction date. | [optional]
13 | **transactionPrice** | **Number** | Average transaction price. | [optional]
14 | **transactionCode** | **String** | Transaction code. A list of codes and their meanings can be found <a href=\"https://www.sec.gov/about/forms/form4data.pdf\" target=\"_blank\" rel=\"noopener\">here</a>. | [optional]
15 |
16 |
17 |
--------------------------------------------------------------------------------
/docs/TranscriptContent.md:
--------------------------------------------------------------------------------
1 | # finnhub.TranscriptContent
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **name** | **String** | Speaker's name | [optional]
8 | **speech** | **[String]** | Speaker's speech | [optional]
9 | **session** | **String** | Earnings calls section (management discussion or Q&A) | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/TranscriptParticipant.md:
--------------------------------------------------------------------------------
1 | # finnhub.TranscriptParticipant
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **name** | **String** | Participant's name | [optional]
8 | **description** | **String** | Participant's description | [optional]
9 | **role** | **String** | Whether the speak is a company's executive or an analyst | [optional]
10 |
11 |
12 |
--------------------------------------------------------------------------------
/docs/Trend.md:
--------------------------------------------------------------------------------
1 | # finnhub.Trend
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **adx** | **Number** | ADX reading | [optional]
8 | **trending** | **Boolean** | Whether market is trending or going sideway | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/TwitterSentimentContent.md:
--------------------------------------------------------------------------------
1 | # finnhub.TwitterSentimentContent
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **mention** | **Number** | Number of mentions | [optional]
8 | **positiveMention** | **Number** | Number of positive mentions | [optional]
9 | **negativeMention** | **Number** | Number of negative mentions | [optional]
10 | **positiveScore** | **Number** | Positive score. Range 0-1 | [optional]
11 | **negativeScore** | **Number** | Negative score. Range 0-1 | [optional]
12 | **score** | **Number** | Final score. Range: -1 to 1 with 1 is very positive and -1 is very negative | [optional]
13 | **atTime** | **String** | Period. | [optional]
14 |
15 |
16 |
--------------------------------------------------------------------------------
/docs/UpgradeDowngrade.md:
--------------------------------------------------------------------------------
1 | # finnhub.UpgradeDowngrade
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Company symbol. | [optional]
8 | **gradeTime** | **Number** | Upgrade/downgrade time in UNIX timestamp. | [optional]
9 | **fromGrade** | **String** | From grade. | [optional]
10 | **toGrade** | **String** | To grade. | [optional]
11 | **company** | **String** | Company/analyst who did the upgrade/downgrade. | [optional]
12 | **action** | **String** | Action can take any of the following values: <code>up(upgrade), down(downgrade), main(maintains), init(initiate), reit(reiterate)</code>. | [optional]
13 |
14 |
15 |
--------------------------------------------------------------------------------
/docs/UsaSpending.md:
--------------------------------------------------------------------------------
1 | # finnhub.UsaSpending
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **recipientName** | **String** | Company's name. | [optional]
9 | **recipientParentName** | **String** | Company's name. | [optional]
10 | **awardDescription** | **String** | Description. | [optional]
11 | **country** | **String** | Recipient's country. | [optional]
12 | **actionDate** | **String** | Period. | [optional]
13 | **totalValue** | **Number** | Income reported by lobbying firms. | [optional]
14 | **performanceStartDate** | **String** | Performance start date. | [optional]
15 | **performanceEndDate** | **String** | Performance end date. | [optional]
16 | **awardingAgencyName** | **String** | Award agency. | [optional]
17 | **awardingSubAgencyName** | **String** | Award sub-agency. | [optional]
18 | **awardingOfficeName** | **String** | Award office name. | [optional]
19 | **performanceCountry** | **String** | Performance country. | [optional]
20 | **performanceCity** | **String** | Performance city. | [optional]
21 | **performanceCounty** | **String** | Performance county. | [optional]
22 | **performanceState** | **String** | Performance state. | [optional]
23 | **performanceZipCode** | **String** | Performance zip code. | [optional]
24 | **performanceCongressionalDistrict** | **String** | Performance congressional district. | [optional]
25 | **naicsCode** | **String** | NAICS code. | [optional]
26 | **permalink** | **String** | Permalink. | [optional]
27 |
28 |
29 |
--------------------------------------------------------------------------------
/docs/UsaSpendingResult.md:
--------------------------------------------------------------------------------
1 | # finnhub.UsaSpendingResult
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **data** | [**[UsaSpending]**](UsaSpending.md) | Array of government's spending data points. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/UsptoPatent.md:
--------------------------------------------------------------------------------
1 | # finnhub.UsptoPatent
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **applicationNumber** | **String** | Application Number. | [optional]
8 | **companyFilingName** | **[String]** | Array of companies' name on the patent. | [optional]
9 | **filingDate** | **String** | Filing date. | [optional]
10 | **description** | **String** | Description. | [optional]
11 | **filingStatus** | **String** | Filing status. | [optional]
12 | **patentNumber** | **String** | Patent number. | [optional]
13 | **publicationDate** | **String** | Publication date. | [optional]
14 | **patentType** | **String** | Patent's type. | [optional]
15 | **url** | **String** | URL of the original article. | [optional]
16 |
17 |
18 |
--------------------------------------------------------------------------------
/docs/UsptoPatentResult.md:
--------------------------------------------------------------------------------
1 | # finnhub.UsptoPatentResult
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **data** | [**[UsptoPatent]**](UsptoPatent.md) | Array of patents. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/docs/VisaApplication.md:
--------------------------------------------------------------------------------
1 | # finnhub.VisaApplication
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **year** | **Number** | Year. | [optional]
8 | **quarter** | **Number** | Quarter. | [optional]
9 | **symbol** | **String** | Symbol. | [optional]
10 | **caseNumber** | **String** | Case number. | [optional]
11 | **caseStatus** | **String** | Case status. | [optional]
12 | **receivedDate** | **String** | Received date. | [optional]
13 | **visaClass** | **String** | Visa class. | [optional]
14 | **jobTitle** | **String** | Job Title. | [optional]
15 | **socCode** | **String** | SOC Code. A list of SOC code can be found <a href=\"https://www.bls.gov/oes/current/oes_stru.htm\" target=\"_blank\">here</a>. | [optional]
16 | **fullTimePosition** | **String** | Full-time position flag. | [optional]
17 | **beginDate** | **String** | Job's start date. | [optional]
18 | **endDate** | **String** | Job's end date. | [optional]
19 | **employerName** | **String** | Company's name. | [optional]
20 | **worksiteAddress** | **String** | Worksite address. | [optional]
21 | **worksiteCity** | **String** | Worksite city. | [optional]
22 | **worksiteCounty** | **String** | Worksite county. | [optional]
23 | **worksiteState** | **String** | Worksite state. | [optional]
24 | **worksitePostalCode** | **String** | Worksite postal code. | [optional]
25 | **wageRangeFrom** | **Number** | Wage range from. | [optional]
26 | **wageRangeTo** | **Number** | Wage range to. | [optional]
27 | **wageUnitOfPay** | **String** | Wage unit of pay. | [optional]
28 | **wageLevel** | **String** | Wage level. | [optional]
29 | **h1bDependent** | **String** | H1B dependent flag. | [optional]
30 |
31 |
32 |
--------------------------------------------------------------------------------
/docs/VisaApplicationResult.md:
--------------------------------------------------------------------------------
1 | # finnhub.VisaApplicationResult
2 |
3 | ## Properties
4 |
5 | Name | Type | Description | Notes
6 | ------------ | ------------- | ------------- | -------------
7 | **symbol** | **String** | Symbol. | [optional]
8 | **data** | [**[VisaApplication]**](VisaApplication.md) | Array of H1b and Permanent visa applications. | [optional]
9 |
10 |
11 |
--------------------------------------------------------------------------------
/git_push.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
3 | #
4 | # Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
5 |
6 | git_user_id=$1
7 | git_repo_id=$2
8 | release_note=$3
9 | git_host=$4
10 |
11 | if [ "$git_host" = "" ]; then
12 | git_host="github.com"
13 | echo "[INFO] No command line input provided. Set \$git_host to $git_host"
14 | fi
15 |
16 | if [ "$git_user_id" = "" ]; then
17 | git_user_id="GIT_USER_ID"
18 | echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
19 | fi
20 |
21 | if [ "$git_repo_id" = "" ]; then
22 | git_repo_id="GIT_REPO_ID"
23 | echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
24 | fi
25 |
26 | if [ "$release_note" = "" ]; then
27 | release_note="Minor update"
28 | echo "[INFO] No command line input provided. Set \$release_note to $release_note"
29 | fi
30 |
31 | # Initialize the local directory as a Git repository
32 | git init
33 |
34 | # Adds the files in the local repository and stages them for commit.
35 | git add .
36 |
37 | # Commits the tracked changes and prepares them to be pushed to a remote repository.
38 | git commit -m "$release_note"
39 |
40 | # Sets the new remote
41 | git_remote=`git remote`
42 | if [ "$git_remote" = "" ]; then # git remote not defined
43 |
44 | if [ "$GIT_TOKEN" = "" ]; then
45 | echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
46 | git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
47 | else
48 | git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
49 | fi
50 |
51 | fi
52 |
53 | git pull origin master
54 |
55 | # Pushes (Forces) the changes in the local repository up to the remote repository
56 | echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
57 | git push origin master 2>&1 | grep -v 'To https'
58 |
59 |
--------------------------------------------------------------------------------
/mocha.opts:
--------------------------------------------------------------------------------
1 | --timeout 10000
2 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "finnhub",
3 | "version": "1.2.19",
4 | "description": "JS API client generated by OpenAPI Generator",
5 | "license": "Apache-2.0",
6 | "main": "dist/index.js",
7 | "scripts": {
8 | "build": "babel src -d dist",
9 | "prepare": "npm run build",
10 | "test": "mocha --require @babel/register --recursive"
11 | },
12 | "browser": {
13 | "fs": false
14 | },
15 | "dependencies": {
16 | "@babel/cli": "^7.0.0",
17 | "superagent": "^5.3.0"
18 | },
19 | "devDependencies": {
20 | "@babel/core": "^7.0.0",
21 | "@babel/plugin-proposal-class-properties": "^7.0.0",
22 | "@babel/plugin-proposal-decorators": "^7.0.0",
23 | "@babel/plugin-proposal-do-expressions": "^7.0.0",
24 | "@babel/plugin-proposal-export-default-from": "^7.0.0",
25 | "@babel/plugin-proposal-export-namespace-from": "^7.0.0",
26 | "@babel/plugin-proposal-function-bind": "^7.0.0",
27 | "@babel/plugin-proposal-function-sent": "^7.0.0",
28 | "@babel/plugin-proposal-json-strings": "^7.0.0",
29 | "@babel/plugin-proposal-logical-assignment-operators": "^7.0.0",
30 | "@babel/plugin-proposal-nullish-coalescing-operator": "^7.0.0",
31 | "@babel/plugin-proposal-numeric-separator": "^7.0.0",
32 | "@babel/plugin-proposal-optional-chaining": "^7.0.0",
33 | "@babel/plugin-proposal-pipeline-operator": "^7.0.0",
34 | "@babel/plugin-proposal-throw-expressions": "^7.0.0",
35 | "@babel/plugin-syntax-dynamic-import": "^7.0.0",
36 | "@babel/plugin-syntax-import-meta": "^7.0.0",
37 | "@babel/preset-env": "^7.0.0",
38 | "@babel/register": "^7.0.0",
39 | "expect.js": "^0.3.1",
40 | "mocha": "^8.0.1",
41 | "sinon": "^7.2.0"
42 | },
43 | "files": [
44 | "dist"
45 | ]
46 | }
47 |
--------------------------------------------------------------------------------
/release.sh:
--------------------------------------------------------------------------------
1 | if [ $# -eq 0 ]
2 | then
3 | echo "No arguments supplied"
4 | exit
5 | fi
6 |
7 | rm -rf node_modules
8 | npm install
9 | npm run build
10 | npm publish --access public
11 |
12 | git add -A
13 | git commit -m "update v$1"
14 | git push origin
--------------------------------------------------------------------------------
/src/model/BondYieldCurveInfo.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Finnhub API
3 | * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4 | *
5 | * The version of the OpenAPI document: 1.0.0
6 | *
7 | *
8 | * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9 | * https://openapi-generator.tech
10 | * Do not edit the class manually.
11 | *
12 | */
13 |
14 | import ApiClient from '../ApiClient';
15 |
16 | /**
17 | * The BondYieldCurveInfo model module.
18 | * @module model/BondYieldCurveInfo
19 | * @version 1.2.19
20 | */
21 | class BondYieldCurveInfo {
22 | /**
23 | * Constructs a new BondYieldCurveInfo
.
24 | * @alias module:model/BondYieldCurveInfo
25 | */
26 | constructor() {
27 |
28 | BondYieldCurveInfo.initialize(this);
29 | }
30 |
31 | /**
32 | * Initializes the fields of this object.
33 | * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
34 | * Only for internal use.
35 | */
36 | static initialize(obj) {
37 | }
38 |
39 | /**
40 | * Constructs a BondYieldCurveInfo
from a plain JavaScript object, optionally creating a new instance.
41 | * Copies all relevant properties from data
to obj
if supplied or a new instance if not.
42 | * @param {Object} data The plain JavaScript object bearing properties of interest.
43 | * @param {module:model/BondYieldCurveInfo} obj Optional instance to populate.
44 | * @return {module:model/BondYieldCurveInfo} The populated BondYieldCurveInfo
instance.
45 | */
46 | static constructFromObject(data, obj) {
47 | if (data) {
48 | obj = obj || new BondYieldCurveInfo();
49 |
50 | if (data.hasOwnProperty('d')) {
51 | obj['d'] = ApiClient.convertToType(data['d'], 'String');
52 | }
53 | if (data.hasOwnProperty('v')) {
54 | obj['v'] = ApiClient.convertToType(data['v'], 'Number');
55 | }
56 | }
57 | return obj;
58 | }
59 |
60 |
61 | }
62 |
63 | /**
64 | * Date of the reading
65 | * @member {String} d
66 | */
67 | BondYieldCurveInfo.prototype['d'] = undefined;
68 |
69 | /**
70 | * Value
71 | * @member {Number} v
72 | */
73 | BondYieldCurveInfo.prototype['v'] = undefined;
74 |
75 |
76 |
77 |
78 |
79 |
80 | export default BondYieldCurveInfo;
81 |
82 |
--------------------------------------------------------------------------------
/src/model/BreakdownItem.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Finnhub API
3 | * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4 | *
5 | * The version of the OpenAPI document: 1.0.0
6 | *
7 | *
8 | * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9 | * https://openapi-generator.tech
10 | * Do not edit the class manually.
11 | *
12 | */
13 |
14 | import ApiClient from '../ApiClient';
15 |
16 | /**
17 | * The BreakdownItem model module.
18 | * @module model/BreakdownItem
19 | * @version 1.2.19
20 | */
21 | class BreakdownItem {
22 | /**
23 | * Constructs a new BreakdownItem
.
24 | * @alias module:model/BreakdownItem
25 | */
26 | constructor() {
27 |
28 | BreakdownItem.initialize(this);
29 | }
30 |
31 | /**
32 | * Initializes the fields of this object.
33 | * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
34 | * Only for internal use.
35 | */
36 | static initialize(obj) {
37 | }
38 |
39 | /**
40 | * Constructs a BreakdownItem
from a plain JavaScript object, optionally creating a new instance.
41 | * Copies all relevant properties from data
to obj
if supplied or a new instance if not.
42 | * @param {Object} data The plain JavaScript object bearing properties of interest.
43 | * @param {module:model/BreakdownItem} obj Optional instance to populate.
44 | * @return {module:model/BreakdownItem} The populated BreakdownItem
instance.
45 | */
46 | static constructFromObject(data, obj) {
47 | if (data) {
48 | obj = obj || new BreakdownItem();
49 |
50 | if (data.hasOwnProperty('accessNumber')) {
51 | obj['accessNumber'] = ApiClient.convertToType(data['accessNumber'], 'String');
52 | }
53 | if (data.hasOwnProperty('breakdown')) {
54 | obj['breakdown'] = ApiClient.convertToType(data['breakdown'], Object);
55 | }
56 | }
57 | return obj;
58 | }
59 |
60 |
61 | }
62 |
63 | /**
64 | * Access number of the report from which the data is sourced.
65 | * @member {String} accessNumber
66 | */
67 | BreakdownItem.prototype['accessNumber'] = undefined;
68 |
69 | /**
70 | * @member {Object} breakdown
71 | */
72 | BreakdownItem.prototype['breakdown'] = undefined;
73 |
74 |
75 |
76 |
77 |
78 |
79 | export default BreakdownItem;
80 |
81 |
--------------------------------------------------------------------------------
/src/model/Dividends2.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Finnhub API
3 | * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4 | *
5 | * The version of the OpenAPI document: 1.0.0
6 | *
7 | *
8 | * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9 | * https://openapi-generator.tech
10 | * Do not edit the class manually.
11 | *
12 | */
13 |
14 | import ApiClient from '../ApiClient';
15 | import Dividends2Info from './Dividends2Info';
16 |
17 | /**
18 | * The Dividends2 model module.
19 | * @module model/Dividends2
20 | * @version 1.2.19
21 | */
22 | class Dividends2 {
23 | /**
24 | * Constructs a new Dividends2
.
25 | * @alias module:model/Dividends2
26 | */
27 | constructor() {
28 |
29 | Dividends2.initialize(this);
30 | }
31 |
32 | /**
33 | * Initializes the fields of this object.
34 | * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
35 | * Only for internal use.
36 | */
37 | static initialize(obj) {
38 | }
39 |
40 | /**
41 | * Constructs a Dividends2
from a plain JavaScript object, optionally creating a new instance.
42 | * Copies all relevant properties from data
to obj
if supplied or a new instance if not.
43 | * @param {Object} data The plain JavaScript object bearing properties of interest.
44 | * @param {module:model/Dividends2} obj Optional instance to populate.
45 | * @return {module:model/Dividends2} The populated Dividends2
instance.
46 | */
47 | static constructFromObject(data, obj) {
48 | if (data) {
49 | obj = obj || new Dividends2();
50 |
51 | if (data.hasOwnProperty('symbol')) {
52 | obj['symbol'] = ApiClient.convertToType(data['symbol'], 'String');
53 | }
54 | if (data.hasOwnProperty('data')) {
55 | obj['data'] = ApiClient.convertToType(data['data'], [Dividends2Info]);
56 | }
57 | }
58 | return obj;
59 | }
60 |
61 |
62 | }
63 |
64 | /**
65 | * Symbol
66 | * @member {String} symbol
67 | */
68 | Dividends2.prototype['symbol'] = undefined;
69 |
70 | /**
71 | *
72 | * @member {Array.} data
73 | */
74 | Dividends2.prototype['data'] = undefined;
75 |
76 |
77 |
78 |
79 |
80 |
81 | export default Dividends2;
82 |
83 |
--------------------------------------------------------------------------------
/src/model/Dividends2Basic.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Finnhub API
3 | * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4 | *
5 | * The version of the OpenAPI document: 1.0.0
6 | *
7 | *
8 | * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9 | * https://openapi-generator.tech
10 | * Do not edit the class manually.
11 | *
12 | */
13 |
14 | import ApiClient from '../ApiClient';
15 |
16 | /**
17 | * The Dividends2Basic model module.
18 | * @module model/Dividends2Basic
19 | * @version 1.2.2
20 | */
21 | class Dividends2Basic {
22 | /**
23 | * Constructs a new Dividends2Basic
.
24 | * @alias module:model/Dividends2Basic
25 | */
26 | constructor() {
27 |
28 | Dividends2Basic.initialize(this);
29 | }
30 |
31 | /**
32 | * Initializes the fields of this object.
33 | * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
34 | * Only for internal use.
35 | */
36 | static initialize(obj) {
37 | }
38 |
39 | /**
40 | * Constructs a Dividends2Basic
from a plain JavaScript object, optionally creating a new instance.
41 | * Copies all relevant properties from data
to obj
if supplied or a new instance if not.
42 | * @param {Object} data The plain JavaScript object bearing properties of interest.
43 | * @param {module:model/Dividends2Basic} obj Optional instance to populate.
44 | * @return {module:model/Dividends2Basic} The populated Dividends2Basic
instance.
45 | */
46 | static constructFromObject(data, obj) {
47 | if (data) {
48 | obj = obj || new Dividends2Basic();
49 |
50 | if (data.hasOwnProperty('symbol')) {
51 | obj['symbol'] = ApiClient.convertToType(data['symbol'], 'String');
52 | }
53 | if (data.hasOwnProperty('data')) {
54 | obj['data'] = ApiClient.convertToType(data['data'], [Object]);
55 | }
56 | }
57 | return obj;
58 | }
59 |
60 |
61 | }
62 |
63 | /**
64 | * Symbol
65 | * @member {String} symbol
66 | */
67 | Dividends2Basic.prototype['symbol'] = undefined;
68 |
69 | /**
70 | *
71 | * @member {Array.