finnhub_ruby 1.1.18 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +39 -0
- data/.rspec +2 -0
- data/.rubocop.yml +148 -0
- data/.travis.yml +14 -0
- data/README.md +4 -4
- data/docs/AirlinePriceIndex.md +22 -0
- data/docs/AirlinePriceIndexData.md +24 -0
- data/docs/BondTickData.md +6 -0
- data/docs/BondYieldCurve.md +20 -0
- data/docs/BondYieldCurveInfo.md +20 -0
- data/docs/CompanyESG2.md +28 -0
- data/docs/CompanyProfile.md +11 -1
- data/docs/CongressionalTrading.md +20 -0
- data/docs/CongressionalTransaction.md +36 -0
- data/docs/CountryMetadata.md +9 -1
- data/docs/DefaultApi.md +830 -66
- data/docs/Dividends.md +3 -1
- data/docs/DocumentResponse.md +28 -0
- data/docs/ETFHoldingsData.md +3 -1
- data/docs/ETFProfileData.md +2 -0
- data/docs/EarningResult.md +5 -1
- data/docs/EarningsEstimatesInfo.md +5 -1
- data/docs/EbitEstimatesInfo.md +5 -1
- data/docs/EbitdaEstimatesInfo.md +5 -1
- data/docs/EmployeeCount.md +20 -0
- data/docs/ExcerptResponse.md +24 -0
- data/docs/FilingResponse.md +42 -0
- data/docs/HistoricalCompanyESG.md +20 -0
- data/docs/HistoricalEmployeeCount.md +20 -0
- data/docs/HistoricalMarketCapData.md +22 -0
- data/docs/InFilingResponse.md +44 -0
- data/docs/InFilingSearchBody.md +20 -0
- data/docs/IndicesConstituents.md +3 -1
- data/docs/IndicesConstituentsBreakdown.md +28 -0
- data/docs/MarketCapData.md +20 -0
- data/docs/MarketHoliday.md +22 -0
- data/docs/MarketHolidayData.md +22 -0
- data/docs/MarketStatus.md +28 -0
- data/docs/MutualFundEet.md +20 -0
- data/docs/MutualFundEetPai.md +20 -0
- data/docs/MutualFundHoldingsData.md +3 -1
- data/docs/MutualFundProfileData.md +2 -0
- data/docs/PriceMetrics.md +2 -0
- data/docs/PriceTarget.md +2 -0
- data/docs/RevenueEstimatesInfo.md +5 -1
- data/docs/SearchBody.md +60 -0
- data/docs/SearchFilter.md +20 -0
- data/docs/SearchResponse.md +24 -0
- data/docs/SentimentContent.md +30 -0
- data/docs/SocialSentiment.md +2 -4
- data/finnhub_ruby.gemspec +9 -9
- data/git_push.sh +0 -0
- data/lib/finnhub_ruby/version.rb +2 -14
- data/lib/finnhub_ruby.rb +519 -164
- metadata +44 -479
- data/finnhub_ruby-1.1.10.gem +0 -0
- data/finnhub_ruby-1.1.11.gem +0 -0
- data/finnhub_ruby-1.1.12.gem +0 -0
- data/finnhub_ruby-1.1.13.gem +0 -0
- data/finnhub_ruby-1.1.14.gem +0 -0
- data/finnhub_ruby-1.1.15.gem +0 -0
- data/finnhub_ruby-1.1.16.gem +0 -0
- data/finnhub_ruby-1.1.17.gem +0 -0
- data/finnhub_ruby-1.1.7.gem +0 -0
- data/finnhub_ruby-1.1.8.gem +0 -0
- data/finnhub_ruby-1.1.9.gem +0 -0
- data/lib/finnhub_ruby/api/default_api.rb +0 -6160
- data/lib/finnhub_ruby/api_client.rb +0 -391
- data/lib/finnhub_ruby/api_error.rb +0 -57
- data/lib/finnhub_ruby/configuration.rb +0 -277
- data/lib/finnhub_ruby/models/aggregate_indicators.rb +0 -227
- data/lib/finnhub_ruby/models/basic_financials.rb +0 -247
- data/lib/finnhub_ruby/models/bond_candles.rb +0 -243
- data/lib/finnhub_ruby/models/bond_profile.rb +0 -419
- data/lib/finnhub_ruby/models/bond_tick_data.rb +0 -311
- data/lib/finnhub_ruby/models/breakdown_item.rb +0 -228
- data/lib/finnhub_ruby/models/company.rb +0 -279
- data/lib/finnhub_ruby/models/company_earnings_quality_score.rb +0 -241
- data/lib/finnhub_ruby/models/company_earnings_quality_score_data.rb +0 -279
- data/lib/finnhub_ruby/models/company_esg.rb +0 -268
- data/lib/finnhub_ruby/models/company_executive.rb +0 -231
- data/lib/finnhub_ruby/models/company_news.rb +0 -299
- data/lib/finnhub_ruby/models/company_news_statistics.rb +0 -239
- data/lib/finnhub_ruby/models/company_profile.rb +0 -489
- data/lib/finnhub_ruby/models/company_profile2.rb +0 -329
- data/lib/finnhub_ruby/models/country_metadata.rb +0 -289
- data/lib/finnhub_ruby/models/covid_info.rb +0 -249
- data/lib/finnhub_ruby/models/crypto_candles.rb +0 -291
- data/lib/finnhub_ruby/models/crypto_profile.rb +0 -319
- data/lib/finnhub_ruby/models/crypto_symbol.rb +0 -239
- data/lib/finnhub_ruby/models/development.rb +0 -259
- data/lib/finnhub_ruby/models/dividends.rb +0 -289
- data/lib/finnhub_ruby/models/dividends2.rb +0 -231
- data/lib/finnhub_ruby/models/dividends2_basic.rb +0 -231
- data/lib/finnhub_ruby/models/dividends2_info.rb +0 -229
- data/lib/finnhub_ruby/models/earning_estimate.rb +0 -259
- data/lib/finnhub_ruby/models/earning_release.rb +0 -299
- data/lib/finnhub_ruby/models/earning_result.rb +0 -269
- data/lib/finnhub_ruby/models/earnings_calendar.rb +0 -221
- data/lib/finnhub_ruby/models/earnings_call_transcripts.rb +0 -303
- data/lib/finnhub_ruby/models/earnings_call_transcripts_list.rb +0 -231
- data/lib/finnhub_ruby/models/earnings_estimates.rb +0 -241
- data/lib/finnhub_ruby/models/earnings_estimates_info.rb +0 -259
- data/lib/finnhub_ruby/models/ebit_estimates.rb +0 -241
- data/lib/finnhub_ruby/models/ebit_estimates_info.rb +0 -259
- data/lib/finnhub_ruby/models/ebitda_estimates.rb +0 -241
- data/lib/finnhub_ruby/models/ebitda_estimates_info.rb +0 -259
- data/lib/finnhub_ruby/models/economic_calendar.rb +0 -221
- data/lib/finnhub_ruby/models/economic_code.rb +0 -249
- data/lib/finnhub_ruby/models/economic_data.rb +0 -231
- data/lib/finnhub_ruby/models/economic_data_info.rb +0 -229
- data/lib/finnhub_ruby/models/economic_event.rb +0 -289
- data/lib/finnhub_ruby/models/estimate.rb +0 -259
- data/lib/finnhub_ruby/models/et_fs_country_exposure.rb +0 -219
- data/lib/finnhub_ruby/models/et_fs_holdings.rb +0 -219
- data/lib/finnhub_ruby/models/et_fs_industry_exposure.rb +0 -219
- data/lib/finnhub_ruby/models/et_fs_profile.rb +0 -216
- data/lib/finnhub_ruby/models/etf_country_exposure_data.rb +0 -229
- data/lib/finnhub_ruby/models/etf_holdings_data.rb +0 -279
- data/lib/finnhub_ruby/models/etf_profile_data.rb +0 -419
- data/lib/finnhub_ruby/models/etf_sector_exposure_data.rb +0 -229
- data/lib/finnhub_ruby/models/etfs_country_exposure.rb +0 -231
- data/lib/finnhub_ruby/models/etfs_holdings.rb +0 -251
- data/lib/finnhub_ruby/models/etfs_profile.rb +0 -228
- data/lib/finnhub_ruby/models/etfs_sector_exposure.rb +0 -231
- data/lib/finnhub_ruby/models/fda_comittee_meeting.rb +0 -249
- data/lib/finnhub_ruby/models/filing.rb +0 -289
- data/lib/finnhub_ruby/models/filing_sentiment.rb +0 -299
- data/lib/finnhub_ruby/models/financial_statements.rb +0 -231
- data/lib/finnhub_ruby/models/financials_as_reported.rb +0 -241
- data/lib/finnhub_ruby/models/forex_candles.rb +0 -291
- data/lib/finnhub_ruby/models/forex_symbol.rb +0 -239
- data/lib/finnhub_ruby/models/forexrates.rb +0 -228
- data/lib/finnhub_ruby/models/fund_ownership.rb +0 -231
- data/lib/finnhub_ruby/models/fund_ownership_info.rb +0 -259
- data/lib/finnhub_ruby/models/historical_nbbo.rb +0 -345
- data/lib/finnhub_ruby/models/index_historical_constituent.rb +0 -239
- data/lib/finnhub_ruby/models/indicator.rb +0 -239
- data/lib/finnhub_ruby/models/indices_constituents.rb +0 -231
- data/lib/finnhub_ruby/models/indices_historical_constituents.rb +0 -231
- data/lib/finnhub_ruby/models/insider_sentiments.rb +0 -231
- data/lib/finnhub_ruby/models/insider_sentiments_data.rb +0 -259
- data/lib/finnhub_ruby/models/insider_transactions.rb +0 -231
- data/lib/finnhub_ruby/models/institutional_ownership.rb +0 -241
- data/lib/finnhub_ruby/models/institutional_ownership_group.rb +0 -231
- data/lib/finnhub_ruby/models/institutional_ownership_info.rb +0 -309
- data/lib/finnhub_ruby/models/institutional_portfolio.rb +0 -241
- data/lib/finnhub_ruby/models/institutional_portfolio_group.rb +0 -241
- data/lib/finnhub_ruby/models/institutional_portfolio_info.rb +0 -319
- data/lib/finnhub_ruby/models/institutional_profile.rb +0 -231
- data/lib/finnhub_ruby/models/institutional_profile_info.rb +0 -269
- data/lib/finnhub_ruby/models/international_filing.rb +0 -299
- data/lib/finnhub_ruby/models/investment_theme_portfolio.rb +0 -219
- data/lib/finnhub_ruby/models/investment_themes.rb +0 -231
- data/lib/finnhub_ruby/models/investment_themes_thematic_investing.rb +0 -231
- data/lib/finnhub_ruby/models/investor.rb +0 -249
- data/lib/finnhub_ruby/models/investors_ownership.rb +0 -219
- data/lib/finnhub_ruby/models/ipo_calendar.rb +0 -221
- data/lib/finnhub_ruby/models/ipo_event.rb +0 -289
- data/lib/finnhub_ruby/models/isin_change.rb +0 -241
- data/lib/finnhub_ruby/models/isin_change_info.rb +0 -239
- data/lib/finnhub_ruby/models/key_customers_suppliers.rb +0 -329
- data/lib/finnhub_ruby/models/last_bid_ask.rb +0 -259
- data/lib/finnhub_ruby/models/lobbying_data.rb +0 -359
- data/lib/finnhub_ruby/models/lobbying_result.rb +0 -231
- data/lib/finnhub_ruby/models/major_developments.rb +0 -219
- data/lib/finnhub_ruby/models/major_press_releases.rb +0 -231
- data/lib/finnhub_ruby/models/market_news.rb +0 -299
- data/lib/finnhub_ruby/models/mutual_fund_country_exposure.rb +0 -231
- data/lib/finnhub_ruby/models/mutual_fund_country_exposure_data.rb +0 -229
- data/lib/finnhub_ruby/models/mutual_fund_holdings.rb +0 -251
- data/lib/finnhub_ruby/models/mutual_fund_holdings_data.rb +0 -279
- data/lib/finnhub_ruby/models/mutual_fund_profile.rb +0 -228
- data/lib/finnhub_ruby/models/mutual_fund_profile_data.rb +0 -479
- data/lib/finnhub_ruby/models/mutual_fund_sector_exposure.rb +0 -231
- data/lib/finnhub_ruby/models/mutual_fund_sector_exposure_data.rb +0 -229
- data/lib/finnhub_ruby/models/mutual_funds_country_exposure.rb +0 -231
- data/lib/finnhub_ruby/models/mutual_funds_holdings.rb +0 -251
- data/lib/finnhub_ruby/models/mutual_funds_profile.rb +0 -228
- data/lib/finnhub_ruby/models/news.rb +0 -299
- data/lib/finnhub_ruby/models/news_sentiment.rb +0 -267
- data/lib/finnhub_ruby/models/ownership.rb +0 -231
- data/lib/finnhub_ruby/models/ownership_info.rb +0 -249
- data/lib/finnhub_ruby/models/pattern_recognition.rb +0 -221
- data/lib/finnhub_ruby/models/press_release.rb +0 -231
- data/lib/finnhub_ruby/models/price_metrics.rb +0 -228
- data/lib/finnhub_ruby/models/price_target.rb +0 -269
- data/lib/finnhub_ruby/models/quote.rb +0 -279
- data/lib/finnhub_ruby/models/recommendation_trend.rb +0 -279
- data/lib/finnhub_ruby/models/reddit_sentiment_content.rb +0 -279
- data/lib/finnhub_ruby/models/report.rb +0 -318
- data/lib/finnhub_ruby/models/revenue_breakdown.rb +0 -241
- data/lib/finnhub_ruby/models/revenue_estimates.rb +0 -241
- data/lib/finnhub_ruby/models/revenue_estimates_info.rb +0 -259
- data/lib/finnhub_ruby/models/sec_sentiment_analysis.rb +0 -248
- data/lib/finnhub_ruby/models/sector_metric.rb +0 -231
- data/lib/finnhub_ruby/models/sector_metric_data.rb +0 -229
- data/lib/finnhub_ruby/models/sentiment.rb +0 -229
- data/lib/finnhub_ruby/models/similarity_index.rb +0 -241
- data/lib/finnhub_ruby/models/similarity_index_info.rb +0 -329
- data/lib/finnhub_ruby/models/social_sentiment.rb +0 -243
- data/lib/finnhub_ruby/models/split.rb +0 -249
- data/lib/finnhub_ruby/models/stock.rb +0 -249
- data/lib/finnhub_ruby/models/stock_candles.rb +0 -291
- data/lib/finnhub_ruby/models/stock_symbol.rb +0 -309
- data/lib/finnhub_ruby/models/stock_transcripts.rb +0 -259
- data/lib/finnhub_ruby/models/supply_chain_relationships.rb +0 -231
- data/lib/finnhub_ruby/models/support_resistance.rb +0 -221
- data/lib/finnhub_ruby/models/symbol_change.rb +0 -241
- data/lib/finnhub_ruby/models/symbol_change_info.rb +0 -239
- data/lib/finnhub_ruby/models/symbol_lookup.rb +0 -231
- data/lib/finnhub_ruby/models/symbol_lookup_info.rb +0 -249
- data/lib/finnhub_ruby/models/technical_analysis.rb +0 -228
- data/lib/finnhub_ruby/models/tick_data.rb +0 -309
- data/lib/finnhub_ruby/models/transactions.rb +0 -289
- data/lib/finnhub_ruby/models/transcript_content.rb +0 -241
- data/lib/finnhub_ruby/models/transcript_participant.rb +0 -239
- data/lib/finnhub_ruby/models/trend.rb +0 -229
- data/lib/finnhub_ruby/models/twitter_sentiment_content.rb +0 -279
- data/lib/finnhub_ruby/models/upgrade_downgrade.rb +0 -269
- data/lib/finnhub_ruby/models/usa_spending.rb +0 -409
- data/lib/finnhub_ruby/models/usa_spending_result.rb +0 -231
- data/lib/finnhub_ruby/models/uspto_patent.rb +0 -301
- data/lib/finnhub_ruby/models/uspto_patent_result.rb +0 -231
- data/lib/finnhub_ruby/models/visa_application.rb +0 -439
- data/lib/finnhub_ruby/models/visa_application_result.rb +0 -231
- data/spec/api/default_api_spec.rb +0 -724
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/aggregate_indicators_spec.rb +0 -40
- data/spec/models/basic_financials_spec.rb +0 -52
- data/spec/models/bond_candles_spec.rb +0 -46
- data/spec/models/bond_profile_spec.rb +0 -154
- data/spec/models/bond_tick_data_spec.rb +0 -82
- data/spec/models/breakdown_item_spec.rb +0 -40
- data/spec/models/company_earnings_quality_score_data_spec.rb +0 -70
- data/spec/models/company_earnings_quality_score_spec.rb +0 -46
- data/spec/models/company_esg_spec.rb +0 -64
- data/spec/models/company_executive_spec.rb +0 -40
- data/spec/models/company_news_spec.rb +0 -82
- data/spec/models/company_news_statistics_spec.rb +0 -46
- data/spec/models/company_profile2_spec.rb +0 -100
- data/spec/models/company_profile_spec.rb +0 -196
- data/spec/models/company_spec.rb +0 -70
- data/spec/models/country_metadata_spec.rb +0 -64
- data/spec/models/covid_info_spec.rb +0 -52
- data/spec/models/crypto_candles_spec.rb +0 -70
- data/spec/models/crypto_profile_spec.rb +0 -94
- data/spec/models/crypto_symbol_spec.rb +0 -46
- data/spec/models/development_spec.rb +0 -58
- data/spec/models/dividends2_info_spec.rb +0 -40
- data/spec/models/dividends2_spec.rb +0 -40
- data/spec/models/dividends_spec.rb +0 -76
- data/spec/models/earning_estimate_spec.rb +0 -58
- data/spec/models/earning_release_spec.rb +0 -82
- data/spec/models/earning_result_spec.rb +0 -64
- data/spec/models/earnings_calendar_spec.rb +0 -34
- data/spec/models/earnings_call_transcripts_list_spec.rb +0 -40
- data/spec/models/earnings_call_transcripts_spec.rb +0 -82
- data/spec/models/earnings_estimates_info_spec.rb +0 -58
- data/spec/models/earnings_estimates_spec.rb +0 -46
- data/spec/models/ebit_estimates_info_spec.rb +0 -58
- data/spec/models/ebit_estimates_spec.rb +0 -46
- data/spec/models/ebitda_estimates_info_spec.rb +0 -58
- data/spec/models/ebitda_estimates_spec.rb +0 -46
- data/spec/models/economic_calendar_spec.rb +0 -34
- data/spec/models/economic_code_spec.rb +0 -52
- data/spec/models/economic_data_info_spec.rb +0 -40
- data/spec/models/economic_data_spec.rb +0 -40
- data/spec/models/economic_event_spec.rb +0 -76
- data/spec/models/estimate_spec.rb +0 -58
- data/spec/models/etf_country_exposure_data_spec.rb +0 -40
- data/spec/models/etf_holdings_data_spec.rb +0 -70
- data/spec/models/etf_profile_data_spec.rb +0 -136
- data/spec/models/etf_sector_exposure_data_spec.rb +0 -40
- data/spec/models/etfs_country_exposure_spec.rb +0 -40
- data/spec/models/etfs_holdings_spec.rb +0 -52
- data/spec/models/etfs_profile_spec.rb +0 -40
- data/spec/models/etfs_sector_exposure_spec.rb +0 -40
- data/spec/models/fda_comittee_meeting_spec.rb +0 -52
- data/spec/models/filing_sentiment_spec.rb +0 -82
- data/spec/models/filing_spec.rb +0 -76
- data/spec/models/financial_statements_spec.rb +0 -40
- data/spec/models/financials_as_reported_spec.rb +0 -46
- data/spec/models/forex_candles_spec.rb +0 -70
- data/spec/models/forex_symbol_spec.rb +0 -46
- data/spec/models/forexrates_spec.rb +0 -40
- data/spec/models/fund_ownership_info_spec.rb +0 -58
- data/spec/models/fund_ownership_spec.rb +0 -40
- data/spec/models/historical_nbbo_spec.rb +0 -100
- data/spec/models/index_historical_constituent_spec.rb +0 -46
- data/spec/models/indicator_spec.rb +0 -46
- data/spec/models/indices_constituents_spec.rb +0 -40
- data/spec/models/indices_historical_constituents_spec.rb +0 -40
- data/spec/models/insider_sentiments_data_spec.rb +0 -58
- data/spec/models/insider_sentiments_spec.rb +0 -40
- data/spec/models/insider_transactions_spec.rb +0 -40
- data/spec/models/institutional_ownership_group_spec.rb +0 -40
- data/spec/models/institutional_ownership_info_spec.rb +0 -88
- data/spec/models/institutional_ownership_spec.rb +0 -46
- data/spec/models/institutional_portfolio_group_spec.rb +0 -46
- data/spec/models/institutional_portfolio_info_spec.rb +0 -94
- data/spec/models/institutional_portfolio_spec.rb +0 -46
- data/spec/models/institutional_profile_info_spec.rb +0 -64
- data/spec/models/institutional_profile_spec.rb +0 -40
- data/spec/models/international_filing_spec.rb +0 -82
- data/spec/models/investment_theme_portfolio_spec.rb +0 -34
- data/spec/models/investment_themes_spec.rb +0 -40
- data/spec/models/ipo_calendar_spec.rb +0 -34
- data/spec/models/ipo_event_spec.rb +0 -76
- data/spec/models/isin_change_info_spec.rb +0 -46
- data/spec/models/isin_change_spec.rb +0 -46
- data/spec/models/key_customers_suppliers_spec.rb +0 -52
- data/spec/models/last_bid_ask_spec.rb +0 -58
- data/spec/models/lobbying_data_spec.rb +0 -118
- data/spec/models/lobbying_result_spec.rb +0 -40
- data/spec/models/market_news_spec.rb +0 -82
- data/spec/models/mutual_fund_country_exposure_data_spec.rb +0 -40
- data/spec/models/mutual_fund_country_exposure_spec.rb +0 -40
- data/spec/models/mutual_fund_holdings_data_spec.rb +0 -70
- data/spec/models/mutual_fund_holdings_spec.rb +0 -52
- data/spec/models/mutual_fund_profile_data_spec.rb +0 -154
- data/spec/models/mutual_fund_profile_spec.rb +0 -40
- data/spec/models/mutual_fund_sector_exposure_data_spec.rb +0 -40
- data/spec/models/mutual_fund_sector_exposure_spec.rb +0 -40
- data/spec/models/news_sentiment_spec.rb +0 -64
- data/spec/models/ownership_info_spec.rb +0 -52
- data/spec/models/ownership_spec.rb +0 -40
- data/spec/models/pattern_recognition_spec.rb +0 -34
- data/spec/models/press_release_spec.rb +0 -40
- data/spec/models/price_metrics_spec.rb +0 -40
- data/spec/models/price_target_spec.rb +0 -64
- data/spec/models/quote_spec.rb +0 -70
- data/spec/models/recommendation_trend_spec.rb +0 -70
- data/spec/models/reddit_sentiment_content_spec.rb +0 -70
- data/spec/models/report_spec.rb +0 -94
- data/spec/models/revenue_breakdown_spec.rb +0 -46
- data/spec/models/revenue_estimates_info_spec.rb +0 -58
- data/spec/models/revenue_estimates_spec.rb +0 -46
- data/spec/models/sec_sentiment_analysis_spec.rb +0 -52
- data/spec/models/sector_metric_data_spec.rb +0 -40
- data/spec/models/sector_metric_spec.rb +0 -40
- data/spec/models/sentiment_spec.rb +0 -40
- data/spec/models/similarity_index_info_spec.rb +0 -100
- data/spec/models/similarity_index_spec.rb +0 -46
- data/spec/models/social_sentiment_spec.rb +0 -46
- data/spec/models/split_spec.rb +0 -52
- data/spec/models/stock_candles_spec.rb +0 -70
- data/spec/models/stock_symbol_spec.rb +0 -70
- data/spec/models/stock_transcripts_spec.rb +0 -58
- data/spec/models/supply_chain_relationships_spec.rb +0 -40
- data/spec/models/support_resistance_spec.rb +0 -34
- data/spec/models/symbol_change_info_spec.rb +0 -46
- data/spec/models/symbol_change_spec.rb +0 -46
- data/spec/models/symbol_lookup_info_spec.rb +0 -52
- data/spec/models/symbol_lookup_spec.rb +0 -40
- data/spec/models/technical_analysis_spec.rb +0 -40
- data/spec/models/tick_data_spec.rb +0 -82
- data/spec/models/transactions_spec.rb +0 -70
- data/spec/models/transcript_content_spec.rb +0 -46
- data/spec/models/transcript_participant_spec.rb +0 -46
- data/spec/models/trend_spec.rb +0 -40
- data/spec/models/twitter_sentiment_content_spec.rb +0 -70
- data/spec/models/upgrade_downgrade_spec.rb +0 -64
- data/spec/models/usa_spending_result_spec.rb +0 -40
- data/spec/models/usa_spending_spec.rb +0 -148
- data/spec/models/uspto_patent_result_spec.rb +0 -40
- data/spec/models/uspto_patent_spec.rb +0 -82
- data/spec/models/visa_application_result_spec.rb +0 -40
- data/spec/models/visa_application_spec.rb +0 -166
- data/spec/spec_helper.rb +0 -111
data/docs/DefaultApi.md
CHANGED
@@ -5,9 +5,11 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**aggregate_indicator**](DefaultApi.md#aggregate_indicator) | **GET** /scan/technical-indicator | Aggregate Indicators |
|
8
|
+
| [**airline_price_index**](DefaultApi.md#airline_price_index) | **GET** /airline/price-index | Airline Price Index |
|
8
9
|
| [**bond_price**](DefaultApi.md#bond_price) | **GET** /bond/price | Bond price data |
|
9
10
|
| [**bond_profile**](DefaultApi.md#bond_profile) | **GET** /bond/profile | Bond Profile |
|
10
11
|
| [**bond_tick**](DefaultApi.md#bond_tick) | **GET** /bond/tick | Bond Tick Data |
|
12
|
+
| [**bond_yield_curve**](DefaultApi.md#bond_yield_curve) | **GET** /bond/yield-curve | Bond Yield Curve |
|
11
13
|
| [**company_basic_financials**](DefaultApi.md#company_basic_financials) | **GET** /stock/metric | Basic Financials |
|
12
14
|
| [**company_earnings**](DefaultApi.md#company_earnings) | **GET** /stock/earnings | Earnings Surprises |
|
13
15
|
| [**company_earnings_quality_score**](DefaultApi.md#company_earnings_quality_score) | **GET** /stock/earnings-quality-score | Company Earnings Quality Score |
|
@@ -16,11 +18,13 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
16
18
|
| [**company_eps_estimates**](DefaultApi.md#company_eps_estimates) | **GET** /stock/eps-estimate | Earnings Estimates |
|
17
19
|
| [**company_esg_score**](DefaultApi.md#company_esg_score) | **GET** /stock/esg | Company ESG Scores |
|
18
20
|
| [**company_executive**](DefaultApi.md#company_executive) | **GET** /stock/executive | Company Executive |
|
21
|
+
| [**company_historical_esg_score**](DefaultApi.md#company_historical_esg_score) | **GET** /stock/historical-esg | Historical ESG Scores |
|
19
22
|
| [**company_news**](DefaultApi.md#company_news) | **GET** /company-news | Company News |
|
20
23
|
| [**company_peers**](DefaultApi.md#company_peers) | **GET** /stock/peers | Peers |
|
21
24
|
| [**company_profile**](DefaultApi.md#company_profile) | **GET** /stock/profile | Company Profile |
|
22
25
|
| [**company_profile2**](DefaultApi.md#company_profile2) | **GET** /stock/profile2 | Company Profile 2 |
|
23
26
|
| [**company_revenue_estimates**](DefaultApi.md#company_revenue_estimates) | **GET** /stock/revenue-estimate | Revenue Estimates |
|
27
|
+
| [**congressional_trading**](DefaultApi.md#congressional_trading) | **GET** /stock/congressional-trading | Congressional Trading |
|
24
28
|
| [**country**](DefaultApi.md#country) | **GET** /country | Country Metadata |
|
25
29
|
| [**covid19**](DefaultApi.md#covid19) | **GET** /covid19/us | COVID-19 |
|
26
30
|
| [**crypto_candles**](DefaultApi.md#crypto_candles) | **GET** /crypto/candle | Crypto Candles |
|
@@ -45,6 +49,8 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
45
49
|
| [**forex_rates**](DefaultApi.md#forex_rates) | **GET** /forex/rates | Forex rates |
|
46
50
|
| [**forex_symbols**](DefaultApi.md#forex_symbols) | **GET** /forex/symbol | Forex Symbol |
|
47
51
|
| [**fund_ownership**](DefaultApi.md#fund_ownership) | **GET** /stock/fund-ownership | Fund Ownership |
|
52
|
+
| [**historical_employee_count**](DefaultApi.md#historical_employee_count) | **GET** /stock/historical-employee-count | Historical Employee Count |
|
53
|
+
| [**historical_market_cap**](DefaultApi.md#historical_market_cap) | **GET** /stock/historical-market-cap | Historical Market Cap |
|
48
54
|
| [**indices_constituents**](DefaultApi.md#indices_constituents) | **GET** /index/constituents | Indices Constituents |
|
49
55
|
| [**indices_historical_constituents**](DefaultApi.md#indices_historical_constituents) | **GET** /index/historical-constituents | Indices Historical Constituents |
|
50
56
|
| [**insider_sentiment**](DefaultApi.md#insider_sentiment) | **GET** /stock/insider-sentiment | Insider Sentiment |
|
@@ -56,8 +62,12 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
56
62
|
| [**investment_themes**](DefaultApi.md#investment_themes) | **GET** /stock/investment-theme | Investment Themes (Thematic Investing) |
|
57
63
|
| [**ipo_calendar**](DefaultApi.md#ipo_calendar) | **GET** /calendar/ipo | IPO Calendar |
|
58
64
|
| [**isin_change**](DefaultApi.md#isin_change) | **GET** /ca/isin-change | ISIN Change |
|
65
|
+
| [**market_holiday**](DefaultApi.md#market_holiday) | **GET** /stock/market-holiday | Market Holiday |
|
59
66
|
| [**market_news**](DefaultApi.md#market_news) | **GET** /news | Market News |
|
67
|
+
| [**market_status**](DefaultApi.md#market_status) | **GET** /stock/market-status | Market Status |
|
60
68
|
| [**mutual_fund_country_exposure**](DefaultApi.md#mutual_fund_country_exposure) | **GET** /mutual-fund/country | Mutual Funds Country Exposure |
|
69
|
+
| [**mutual_fund_eet**](DefaultApi.md#mutual_fund_eet) | **GET** /mutual-fund/eet | Mutual Funds EET |
|
70
|
+
| [**mutual_fund_eet_pai**](DefaultApi.md#mutual_fund_eet_pai) | **GET** /mutual-fund/eet-pai | Mutual Funds EET PAI |
|
61
71
|
| [**mutual_fund_holdings**](DefaultApi.md#mutual_fund_holdings) | **GET** /mutual-fund/holdings | Mutual Funds Holdings |
|
62
72
|
| [**mutual_fund_profile**](DefaultApi.md#mutual_fund_profile) | **GET** /mutual-fund/profile | Mutual Funds Profile |
|
63
73
|
| [**mutual_fund_sector_exposure**](DefaultApi.md#mutual_fund_sector_exposure) | **GET** /mutual-fund/sector | Mutual Funds Sector Exposure |
|
@@ -89,7 +99,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
89
99
|
| [**support_resistance**](DefaultApi.md#support_resistance) | **GET** /scan/support-resistance | Support/Resistance |
|
90
100
|
| [**symbol_change**](DefaultApi.md#symbol_change) | **GET** /ca/symbol-change | Symbol Change |
|
91
101
|
| [**symbol_search**](DefaultApi.md#symbol_search) | **GET** /search | Symbol Lookup |
|
92
|
-
| [**technical_indicator**](DefaultApi.md#technical_indicator) | **
|
102
|
+
| [**technical_indicator**](DefaultApi.md#technical_indicator) | **GET** /indicator | Technical Indicators |
|
93
103
|
| [**transcripts**](DefaultApi.md#transcripts) | **GET** /stock/transcripts | Earnings Call Transcripts |
|
94
104
|
| [**transcripts_list**](DefaultApi.md#transcripts_list) | **GET** /stock/transcripts/list | Earnings Call Transcripts List |
|
95
105
|
| [**upgrade_downgrade**](DefaultApi.md#upgrade_downgrade) | **GET** /stock/upgrade-downgrade | Stock Upgrade/Downgrade |
|
@@ -101,7 +111,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
101
111
|
|
102
112
|
Aggregate Indicators
|
103
113
|
|
104
|
-
Get aggregate signal of multiple technical indicators such as MACD, RSI, Moving Average v.v.
|
114
|
+
Get aggregate signal of multiple technical indicators such as MACD, RSI, Moving Average v.v. A full list of indicators can be found <a href=\"https://docs.google.com/spreadsheets/d/1MWuy0WuT2yVlxr1KbPdggVygMZtJfunDnhe-C0GEXYM/edit?usp=sharing\" target=\"_blank\">here</a>.
|
105
115
|
|
106
116
|
### Examples
|
107
117
|
|
@@ -168,6 +178,81 @@ end
|
|
168
178
|
- **Accept**: application/json
|
169
179
|
|
170
180
|
|
181
|
+
## airline_price_index
|
182
|
+
|
183
|
+
> <AirlinePriceIndexData> airline_price_index(airline, from, to)
|
184
|
+
|
185
|
+
Airline Price Index
|
186
|
+
|
187
|
+
<p>The Flight Ticket Price Index API provides comprehensive data on airline ticket prices, including the average daily ticket price and its percentage change (price index). This data, collected weekly and projected two weeks ahead, aggregates daily prices and indexes from the 50 busiest and largest airports across the USA. The dataset includes detailed information on airlines, dates, and average ticket prices, offering valuable insights for market analysis and pricing strategies.</p><p>The price index is calculated as percentage change of average daily ticket price from the previous weekly reading. Raw ticket prices data is available for Enterprise users. <a href=\"mailto:support@finnhub.io\">Contact us</a> to inquire about the raw price data.</p>
|
188
|
+
|
189
|
+
### Examples
|
190
|
+
|
191
|
+
```ruby
|
192
|
+
require 'time'
|
193
|
+
require 'finnhub_ruby'
|
194
|
+
# setup authorization
|
195
|
+
FinnhubRuby.configure do |config|
|
196
|
+
# Configure API key authorization: api_key
|
197
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
198
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
199
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
200
|
+
end
|
201
|
+
|
202
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
203
|
+
airline = 'airline_example' # String | Filter data by airline. Accepted values: <code>united</code>,<code>delta</code>,<code>american_airlines</code>,<code>southwest</code>,<code>southern_airways_express</code>,<code>alaska_airlines</code>,<code>frontier_airlines</code>,<code>jetblue_airways</code>,<code>spirit_airlines</code>,<code>sun_country_airlines</code>,<code>breeze_airways</code>,<code>hawaiian_airlines</code>
|
204
|
+
from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>.
|
205
|
+
to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
|
206
|
+
|
207
|
+
begin
|
208
|
+
# Airline Price Index
|
209
|
+
result = api_instance.airline_price_index(airline, from, to)
|
210
|
+
p result
|
211
|
+
rescue FinnhubRuby::ApiError => e
|
212
|
+
puts "Error when calling DefaultApi->airline_price_index: #{e}"
|
213
|
+
end
|
214
|
+
```
|
215
|
+
|
216
|
+
#### Using the airline_price_index_with_http_info variant
|
217
|
+
|
218
|
+
This returns an Array which contains the response data, status code and headers.
|
219
|
+
|
220
|
+
> <Array(<AirlinePriceIndexData>, Integer, Hash)> airline_price_index_with_http_info(airline, from, to)
|
221
|
+
|
222
|
+
```ruby
|
223
|
+
begin
|
224
|
+
# Airline Price Index
|
225
|
+
data, status_code, headers = api_instance.airline_price_index_with_http_info(airline, from, to)
|
226
|
+
p status_code # => 2xx
|
227
|
+
p headers # => { ... }
|
228
|
+
p data # => <AirlinePriceIndexData>
|
229
|
+
rescue FinnhubRuby::ApiError => e
|
230
|
+
puts "Error when calling DefaultApi->airline_price_index_with_http_info: #{e}"
|
231
|
+
end
|
232
|
+
```
|
233
|
+
|
234
|
+
### Parameters
|
235
|
+
|
236
|
+
| Name | Type | Description | Notes |
|
237
|
+
| ---- | ---- | ----------- | ----- |
|
238
|
+
| **airline** | **String** | Filter data by airline. Accepted values: <code>united</code>,<code>delta</code>,<code>american_airlines</code>,<code>southwest</code>,<code>southern_airways_express</code>,<code>alaska_airlines</code>,<code>frontier_airlines</code>,<code>jetblue_airways</code>,<code>spirit_airlines</code>,<code>sun_country_airlines</code>,<code>breeze_airways</code>,<code>hawaiian_airlines</code> | |
|
239
|
+
| **from** | **Date** | From date <code>YYYY-MM-DD</code>. | |
|
240
|
+
| **to** | **Date** | To date <code>YYYY-MM-DD</code>. | |
|
241
|
+
|
242
|
+
### Return type
|
243
|
+
|
244
|
+
[**AirlinePriceIndexData**](AirlinePriceIndexData.md)
|
245
|
+
|
246
|
+
### Authorization
|
247
|
+
|
248
|
+
[api_key](../README.md#api_key)
|
249
|
+
|
250
|
+
### HTTP request headers
|
251
|
+
|
252
|
+
- **Content-Type**: Not defined
|
253
|
+
- **Accept**: application/json
|
254
|
+
|
255
|
+
|
171
256
|
## bond_price
|
172
257
|
|
173
258
|
> <BondCandles> bond_price(isin, from, to)
|
@@ -249,7 +334,7 @@ end
|
|
249
334
|
|
250
335
|
Bond Profile
|
251
336
|
|
252
|
-
Get general information of a bond. You can query by FIGI, ISIN or CUSIP
|
337
|
+
Get general information of a bond. You can query by FIGI, ISIN or CUSIP. A list of supported bonds can be found <a href=\"/api/v1/bond/list?token=\" target=\"_blank\">here</a>.
|
253
338
|
|
254
339
|
### Examples
|
255
340
|
|
@@ -399,6 +484,77 @@ end
|
|
399
484
|
- **Accept**: application/json
|
400
485
|
|
401
486
|
|
487
|
+
## bond_yield_curve
|
488
|
+
|
489
|
+
> <BondYieldCurve> bond_yield_curve(code)
|
490
|
+
|
491
|
+
Bond Yield Curve
|
492
|
+
|
493
|
+
Get yield curve data for Treasury bonds.
|
494
|
+
|
495
|
+
### Examples
|
496
|
+
|
497
|
+
```ruby
|
498
|
+
require 'time'
|
499
|
+
require 'finnhub_ruby'
|
500
|
+
# setup authorization
|
501
|
+
FinnhubRuby.configure do |config|
|
502
|
+
# Configure API key authorization: api_key
|
503
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
504
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
505
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
506
|
+
end
|
507
|
+
|
508
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
509
|
+
code = 'code_example' # String | Bond's code. You can find the list of supported code <a href=\"https://docs.google.com/spreadsheets/d/1iA-lM0Kht7lsQZ7Uu_s6r2i1BbQNUNO9eGkO5-zglHg/edit?usp=sharing\" target=\"_blank\" rel=\"noopener\">here</a>.
|
510
|
+
|
511
|
+
begin
|
512
|
+
# Bond Yield Curve
|
513
|
+
result = api_instance.bond_yield_curve(code)
|
514
|
+
p result
|
515
|
+
rescue FinnhubRuby::ApiError => e
|
516
|
+
puts "Error when calling DefaultApi->bond_yield_curve: #{e}"
|
517
|
+
end
|
518
|
+
```
|
519
|
+
|
520
|
+
#### Using the bond_yield_curve_with_http_info variant
|
521
|
+
|
522
|
+
This returns an Array which contains the response data, status code and headers.
|
523
|
+
|
524
|
+
> <Array(<BondYieldCurve>, Integer, Hash)> bond_yield_curve_with_http_info(code)
|
525
|
+
|
526
|
+
```ruby
|
527
|
+
begin
|
528
|
+
# Bond Yield Curve
|
529
|
+
data, status_code, headers = api_instance.bond_yield_curve_with_http_info(code)
|
530
|
+
p status_code # => 2xx
|
531
|
+
p headers # => { ... }
|
532
|
+
p data # => <BondYieldCurve>
|
533
|
+
rescue FinnhubRuby::ApiError => e
|
534
|
+
puts "Error when calling DefaultApi->bond_yield_curve_with_http_info: #{e}"
|
535
|
+
end
|
536
|
+
```
|
537
|
+
|
538
|
+
### Parameters
|
539
|
+
|
540
|
+
| Name | Type | Description | Notes |
|
541
|
+
| ---- | ---- | ----------- | ----- |
|
542
|
+
| **code** | **String** | Bond's code. You can find the list of supported code <a href=\"https://docs.google.com/spreadsheets/d/1iA-lM0Kht7lsQZ7Uu_s6r2i1BbQNUNO9eGkO5-zglHg/edit?usp=sharing\" target=\"_blank\" rel=\"noopener\">here</a>. | |
|
543
|
+
|
544
|
+
### Return type
|
545
|
+
|
546
|
+
[**BondYieldCurve**](BondYieldCurve.md)
|
547
|
+
|
548
|
+
### Authorization
|
549
|
+
|
550
|
+
[api_key](../README.md#api_key)
|
551
|
+
|
552
|
+
### HTTP request headers
|
553
|
+
|
554
|
+
- **Content-Type**: Not defined
|
555
|
+
- **Accept**: application/json
|
556
|
+
|
557
|
+
|
402
558
|
## company_basic_financials
|
403
559
|
|
404
560
|
> <BasicFinancials> company_basic_financials(symbol, metric)
|
@@ -851,7 +1007,7 @@ end
|
|
851
1007
|
|
852
1008
|
Company ESG Scores
|
853
1009
|
|
854
|
-
<p>This endpoint provides ESG scores and important indicators for
|
1010
|
+
<p>This endpoint provides the latest ESG scores and important indicators for 7000+ global companies. The data is collected through company's public ESG disclosure and public sources.</p><p>Our ESG scoring models takes into account more than 150 different inputs to calculate the level of ESG risks and how well a company is managing them. A higher score means lower ESG risk or better ESG management. ESG scores are in the the range of 0-100. Some key indicators might contain letter-grade score from C- to A+ with C- is the lowest score and A+ is the highest score.</p>
|
855
1011
|
|
856
1012
|
### Examples
|
857
1013
|
|
@@ -987,6 +1143,77 @@ end
|
|
987
1143
|
- **Accept**: application/json
|
988
1144
|
|
989
1145
|
|
1146
|
+
## company_historical_esg_score
|
1147
|
+
|
1148
|
+
> <HistoricalCompanyESG> company_historical_esg_score(symbol)
|
1149
|
+
|
1150
|
+
Historical ESG Scores
|
1151
|
+
|
1152
|
+
<p>This endpoint provides historical ESG scores and important indicators for 7000+ global companies. The data is collected through company's public ESG disclosure and public sources.</p><p>Our ESG scoring models takes into account more than 150 different inputs to calculate the level of ESG risks and how well a company is managing them. A higher score means lower ESG risk or better ESG management. ESG scores are in the the range of 0-100. Some key indicators might contain letter-grade score from C- to A+ with C- is the lowest score and A+ is the highest score.</p>
|
1153
|
+
|
1154
|
+
### Examples
|
1155
|
+
|
1156
|
+
```ruby
|
1157
|
+
require 'time'
|
1158
|
+
require 'finnhub_ruby'
|
1159
|
+
# setup authorization
|
1160
|
+
FinnhubRuby.configure do |config|
|
1161
|
+
# Configure API key authorization: api_key
|
1162
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1163
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1164
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
1165
|
+
end
|
1166
|
+
|
1167
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
1168
|
+
symbol = 'symbol_example' # String | Symbol.
|
1169
|
+
|
1170
|
+
begin
|
1171
|
+
# Historical ESG Scores
|
1172
|
+
result = api_instance.company_historical_esg_score(symbol)
|
1173
|
+
p result
|
1174
|
+
rescue FinnhubRuby::ApiError => e
|
1175
|
+
puts "Error when calling DefaultApi->company_historical_esg_score: #{e}"
|
1176
|
+
end
|
1177
|
+
```
|
1178
|
+
|
1179
|
+
#### Using the company_historical_esg_score_with_http_info variant
|
1180
|
+
|
1181
|
+
This returns an Array which contains the response data, status code and headers.
|
1182
|
+
|
1183
|
+
> <Array(<HistoricalCompanyESG>, Integer, Hash)> company_historical_esg_score_with_http_info(symbol)
|
1184
|
+
|
1185
|
+
```ruby
|
1186
|
+
begin
|
1187
|
+
# Historical ESG Scores
|
1188
|
+
data, status_code, headers = api_instance.company_historical_esg_score_with_http_info(symbol)
|
1189
|
+
p status_code # => 2xx
|
1190
|
+
p headers # => { ... }
|
1191
|
+
p data # => <HistoricalCompanyESG>
|
1192
|
+
rescue FinnhubRuby::ApiError => e
|
1193
|
+
puts "Error when calling DefaultApi->company_historical_esg_score_with_http_info: #{e}"
|
1194
|
+
end
|
1195
|
+
```
|
1196
|
+
|
1197
|
+
### Parameters
|
1198
|
+
|
1199
|
+
| Name | Type | Description | Notes |
|
1200
|
+
| ---- | ---- | ----------- | ----- |
|
1201
|
+
| **symbol** | **String** | Symbol. | |
|
1202
|
+
|
1203
|
+
### Return type
|
1204
|
+
|
1205
|
+
[**HistoricalCompanyESG**](HistoricalCompanyESG.md)
|
1206
|
+
|
1207
|
+
### Authorization
|
1208
|
+
|
1209
|
+
[api_key](../README.md#api_key)
|
1210
|
+
|
1211
|
+
### HTTP request headers
|
1212
|
+
|
1213
|
+
- **Content-Type**: Not defined
|
1214
|
+
- **Accept**: application/json
|
1215
|
+
|
1216
|
+
|
990
1217
|
## company_news
|
991
1218
|
|
992
1219
|
> <Array<CompanyNews>> company_news(symbol, from, to)
|
@@ -1366,6 +1593,81 @@ end
|
|
1366
1593
|
- **Accept**: application/json
|
1367
1594
|
|
1368
1595
|
|
1596
|
+
## congressional_trading
|
1597
|
+
|
1598
|
+
> <CongressionalTrading> congressional_trading(symbol, from, to)
|
1599
|
+
|
1600
|
+
Congressional Trading
|
1601
|
+
|
1602
|
+
Get stock trades data disclosed by members of congress.
|
1603
|
+
|
1604
|
+
### Examples
|
1605
|
+
|
1606
|
+
```ruby
|
1607
|
+
require 'time'
|
1608
|
+
require 'finnhub_ruby'
|
1609
|
+
# setup authorization
|
1610
|
+
FinnhubRuby.configure do |config|
|
1611
|
+
# Configure API key authorization: api_key
|
1612
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1613
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1614
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
1615
|
+
end
|
1616
|
+
|
1617
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
1618
|
+
symbol = 'symbol_example' # String | Symbol of the company: AAPL.
|
1619
|
+
from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>.
|
1620
|
+
to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
|
1621
|
+
|
1622
|
+
begin
|
1623
|
+
# Congressional Trading
|
1624
|
+
result = api_instance.congressional_trading(symbol, from, to)
|
1625
|
+
p result
|
1626
|
+
rescue FinnhubRuby::ApiError => e
|
1627
|
+
puts "Error when calling DefaultApi->congressional_trading: #{e}"
|
1628
|
+
end
|
1629
|
+
```
|
1630
|
+
|
1631
|
+
#### Using the congressional_trading_with_http_info variant
|
1632
|
+
|
1633
|
+
This returns an Array which contains the response data, status code and headers.
|
1634
|
+
|
1635
|
+
> <Array(<CongressionalTrading>, Integer, Hash)> congressional_trading_with_http_info(symbol, from, to)
|
1636
|
+
|
1637
|
+
```ruby
|
1638
|
+
begin
|
1639
|
+
# Congressional Trading
|
1640
|
+
data, status_code, headers = api_instance.congressional_trading_with_http_info(symbol, from, to)
|
1641
|
+
p status_code # => 2xx
|
1642
|
+
p headers # => { ... }
|
1643
|
+
p data # => <CongressionalTrading>
|
1644
|
+
rescue FinnhubRuby::ApiError => e
|
1645
|
+
puts "Error when calling DefaultApi->congressional_trading_with_http_info: #{e}"
|
1646
|
+
end
|
1647
|
+
```
|
1648
|
+
|
1649
|
+
### Parameters
|
1650
|
+
|
1651
|
+
| Name | Type | Description | Notes |
|
1652
|
+
| ---- | ---- | ----------- | ----- |
|
1653
|
+
| **symbol** | **String** | Symbol of the company: AAPL. | |
|
1654
|
+
| **from** | **Date** | From date <code>YYYY-MM-DD</code>. | |
|
1655
|
+
| **to** | **Date** | To date <code>YYYY-MM-DD</code>. | |
|
1656
|
+
|
1657
|
+
### Return type
|
1658
|
+
|
1659
|
+
[**CongressionalTrading**](CongressionalTrading.md)
|
1660
|
+
|
1661
|
+
### Authorization
|
1662
|
+
|
1663
|
+
[api_key](../README.md#api_key)
|
1664
|
+
|
1665
|
+
### HTTP request headers
|
1666
|
+
|
1667
|
+
- **Content-Type**: Not defined
|
1668
|
+
- **Accept**: application/json
|
1669
|
+
|
1670
|
+
|
1369
1671
|
## country
|
1370
1672
|
|
1371
1673
|
> <Array<CountryMetadata>> country
|
@@ -2084,7 +2386,7 @@ end
|
|
2084
2386
|
|
2085
2387
|
## etfs_country_exposure
|
2086
2388
|
|
2087
|
-
> <ETFsCountryExposure> etfs_country_exposure(
|
2389
|
+
> <ETFsCountryExposure> etfs_country_exposure(opts)
|
2088
2390
|
|
2089
2391
|
ETFs Country Exposure
|
2090
2392
|
|
@@ -2104,11 +2406,14 @@ FinnhubRuby.configure do |config|
|
|
2104
2406
|
end
|
2105
2407
|
|
2106
2408
|
api_instance = FinnhubRuby::DefaultApi.new
|
2107
|
-
|
2409
|
+
opts = {
|
2410
|
+
symbol: 'symbol_example', # String | ETF symbol.
|
2411
|
+
isin: 'isin_example' # String | ETF isin.
|
2412
|
+
}
|
2108
2413
|
|
2109
2414
|
begin
|
2110
2415
|
# ETFs Country Exposure
|
2111
|
-
result = api_instance.etfs_country_exposure(
|
2416
|
+
result = api_instance.etfs_country_exposure(opts)
|
2112
2417
|
p result
|
2113
2418
|
rescue FinnhubRuby::ApiError => e
|
2114
2419
|
puts "Error when calling DefaultApi->etfs_country_exposure: #{e}"
|
@@ -2119,12 +2424,12 @@ end
|
|
2119
2424
|
|
2120
2425
|
This returns an Array which contains the response data, status code and headers.
|
2121
2426
|
|
2122
|
-
> <Array(<ETFsCountryExposure>, Integer, Hash)> etfs_country_exposure_with_http_info(
|
2427
|
+
> <Array(<ETFsCountryExposure>, Integer, Hash)> etfs_country_exposure_with_http_info(opts)
|
2123
2428
|
|
2124
2429
|
```ruby
|
2125
2430
|
begin
|
2126
2431
|
# ETFs Country Exposure
|
2127
|
-
data, status_code, headers = api_instance.etfs_country_exposure_with_http_info(
|
2432
|
+
data, status_code, headers = api_instance.etfs_country_exposure_with_http_info(opts)
|
2128
2433
|
p status_code # => 2xx
|
2129
2434
|
p headers # => { ... }
|
2130
2435
|
p data # => <ETFsCountryExposure>
|
@@ -2137,7 +2442,8 @@ end
|
|
2137
2442
|
|
2138
2443
|
| Name | Type | Description | Notes |
|
2139
2444
|
| ---- | ---- | ----------- | ----- |
|
2140
|
-
| **symbol** | **String** | ETF symbol. |
|
2445
|
+
| **symbol** | **String** | ETF symbol. | [optional] |
|
2446
|
+
| **isin** | **String** | ETF isin. | [optional] |
|
2141
2447
|
|
2142
2448
|
### Return type
|
2143
2449
|
|
@@ -2159,7 +2465,7 @@ end
|
|
2159
2465
|
|
2160
2466
|
ETFs Holdings
|
2161
2467
|
|
2162
|
-
Get full ETF holdings/constituents. This endpoint has global coverage. Widget only shows top 10 holdings.
|
2468
|
+
Get full ETF holdings/constituents. This endpoint has global coverage. Widget only shows top 10 holdings. A list of supported ETFs can be found <a href=\"/api/v1/etf/list?token=\" target=\"_blank\">here</a>.
|
2163
2469
|
|
2164
2470
|
### Examples
|
2165
2471
|
|
@@ -2238,7 +2544,7 @@ end
|
|
2238
2544
|
|
2239
2545
|
ETFs Profile
|
2240
2546
|
|
2241
|
-
Get ETF profile information. This endpoint has global coverage.
|
2547
|
+
Get ETF profile information. This endpoint has global coverage. A list of supported ETFs can be found <a href=\"/api/v1/etf/list?token=\" target=\"_blank\">here</a>.
|
2242
2548
|
|
2243
2549
|
### Examples
|
2244
2550
|
|
@@ -2309,7 +2615,7 @@ end
|
|
2309
2615
|
|
2310
2616
|
## etfs_sector_exposure
|
2311
2617
|
|
2312
|
-
> <ETFsSectorExposure> etfs_sector_exposure(
|
2618
|
+
> <ETFsSectorExposure> etfs_sector_exposure(opts)
|
2313
2619
|
|
2314
2620
|
ETFs Sector Exposure
|
2315
2621
|
|
@@ -2329,11 +2635,14 @@ FinnhubRuby.configure do |config|
|
|
2329
2635
|
end
|
2330
2636
|
|
2331
2637
|
api_instance = FinnhubRuby::DefaultApi.new
|
2332
|
-
|
2638
|
+
opts = {
|
2639
|
+
symbol: 'symbol_example', # String | ETF symbol.
|
2640
|
+
isin: 'isin_example' # String | ETF isin.
|
2641
|
+
}
|
2333
2642
|
|
2334
2643
|
begin
|
2335
2644
|
# ETFs Sector Exposure
|
2336
|
-
result = api_instance.etfs_sector_exposure(
|
2645
|
+
result = api_instance.etfs_sector_exposure(opts)
|
2337
2646
|
p result
|
2338
2647
|
rescue FinnhubRuby::ApiError => e
|
2339
2648
|
puts "Error when calling DefaultApi->etfs_sector_exposure: #{e}"
|
@@ -2344,12 +2653,12 @@ end
|
|
2344
2653
|
|
2345
2654
|
This returns an Array which contains the response data, status code and headers.
|
2346
2655
|
|
2347
|
-
> <Array(<ETFsSectorExposure>, Integer, Hash)> etfs_sector_exposure_with_http_info(
|
2656
|
+
> <Array(<ETFsSectorExposure>, Integer, Hash)> etfs_sector_exposure_with_http_info(opts)
|
2348
2657
|
|
2349
2658
|
```ruby
|
2350
2659
|
begin
|
2351
2660
|
# ETFs Sector Exposure
|
2352
|
-
data, status_code, headers = api_instance.etfs_sector_exposure_with_http_info(
|
2661
|
+
data, status_code, headers = api_instance.etfs_sector_exposure_with_http_info(opts)
|
2353
2662
|
p status_code # => 2xx
|
2354
2663
|
p headers # => { ... }
|
2355
2664
|
p data # => <ETFsSectorExposure>
|
@@ -2362,7 +2671,8 @@ end
|
|
2362
2671
|
|
2363
2672
|
| Name | Type | Description | Notes |
|
2364
2673
|
| ---- | ---- | ----------- | ----- |
|
2365
|
-
| **symbol** | **String** | ETF symbol. |
|
2674
|
+
| **symbol** | **String** | ETF symbol. | [optional] |
|
2675
|
+
| **isin** | **String** | ETF isin. | [optional] |
|
2366
2676
|
|
2367
2677
|
### Return type
|
2368
2678
|
|
@@ -2473,8 +2783,8 @@ opts = {
|
|
2473
2783
|
cik: 'cik_example', # String | CIK.
|
2474
2784
|
access_number: 'access_number_example', # String | Access number of a specific report you want to retrieve data from.
|
2475
2785
|
form: 'form_example', # String | Filter by form. You can use this value <code>NT 10-K</code> to find non-timely filings for a company.
|
2476
|
-
from: Date.parse('2013-10-20'), # Date | From date:
|
2477
|
-
to: Date.parse('2013-10-20') # Date | To date:
|
2786
|
+
from: Date.parse('2013-10-20'), # Date | From date: 2023-03-15.
|
2787
|
+
to: Date.parse('2013-10-20') # Date | To date: 2023-03-16.
|
2478
2788
|
}
|
2479
2789
|
|
2480
2790
|
begin
|
@@ -2512,8 +2822,8 @@ end
|
|
2512
2822
|
| **cik** | **String** | CIK. | [optional] |
|
2513
2823
|
| **access_number** | **String** | Access number of a specific report you want to retrieve data from. | [optional] |
|
2514
2824
|
| **form** | **String** | Filter by form. You can use this value <code>NT 10-K</code> to find non-timely filings for a company. | [optional] |
|
2515
|
-
| **from** | **Date** | From date:
|
2516
|
-
| **to** | **Date** | To date:
|
2825
|
+
| **from** | **Date** | From date: 2023-03-15. | [optional] |
|
2826
|
+
| **to** | **Date** | To date: 2023-03-16. | [optional] |
|
2517
2827
|
|
2518
2828
|
### Return type
|
2519
2829
|
|
@@ -3077,29 +3387,178 @@ opts = {
|
|
3077
3387
|
}
|
3078
3388
|
|
3079
3389
|
begin
|
3080
|
-
# Fund Ownership
|
3081
|
-
result = api_instance.fund_ownership(symbol, opts)
|
3390
|
+
# Fund Ownership
|
3391
|
+
result = api_instance.fund_ownership(symbol, opts)
|
3392
|
+
p result
|
3393
|
+
rescue FinnhubRuby::ApiError => e
|
3394
|
+
puts "Error when calling DefaultApi->fund_ownership: #{e}"
|
3395
|
+
end
|
3396
|
+
```
|
3397
|
+
|
3398
|
+
#### Using the fund_ownership_with_http_info variant
|
3399
|
+
|
3400
|
+
This returns an Array which contains the response data, status code and headers.
|
3401
|
+
|
3402
|
+
> <Array(<FundOwnership>, Integer, Hash)> fund_ownership_with_http_info(symbol, opts)
|
3403
|
+
|
3404
|
+
```ruby
|
3405
|
+
begin
|
3406
|
+
# Fund Ownership
|
3407
|
+
data, status_code, headers = api_instance.fund_ownership_with_http_info(symbol, opts)
|
3408
|
+
p status_code # => 2xx
|
3409
|
+
p headers # => { ... }
|
3410
|
+
p data # => <FundOwnership>
|
3411
|
+
rescue FinnhubRuby::ApiError => e
|
3412
|
+
puts "Error when calling DefaultApi->fund_ownership_with_http_info: #{e}"
|
3413
|
+
end
|
3414
|
+
```
|
3415
|
+
|
3416
|
+
### Parameters
|
3417
|
+
|
3418
|
+
| Name | Type | Description | Notes |
|
3419
|
+
| ---- | ---- | ----------- | ----- |
|
3420
|
+
| **symbol** | **String** | Symbol of the company: AAPL. | |
|
3421
|
+
| **limit** | **Integer** | Limit number of results. Leave empty to get the full list. | [optional] |
|
3422
|
+
|
3423
|
+
### Return type
|
3424
|
+
|
3425
|
+
[**FundOwnership**](FundOwnership.md)
|
3426
|
+
|
3427
|
+
### Authorization
|
3428
|
+
|
3429
|
+
[api_key](../README.md#api_key)
|
3430
|
+
|
3431
|
+
### HTTP request headers
|
3432
|
+
|
3433
|
+
- **Content-Type**: Not defined
|
3434
|
+
- **Accept**: application/json
|
3435
|
+
|
3436
|
+
|
3437
|
+
## historical_employee_count
|
3438
|
+
|
3439
|
+
> <HistoricalEmployeeCount> historical_employee_count(symbol, from, to)
|
3440
|
+
|
3441
|
+
Historical Employee Count
|
3442
|
+
|
3443
|
+
Get historical employee count for global companies.
|
3444
|
+
|
3445
|
+
### Examples
|
3446
|
+
|
3447
|
+
```ruby
|
3448
|
+
require 'time'
|
3449
|
+
require 'finnhub_ruby'
|
3450
|
+
# setup authorization
|
3451
|
+
FinnhubRuby.configure do |config|
|
3452
|
+
# Configure API key authorization: api_key
|
3453
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
3454
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3455
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
3456
|
+
end
|
3457
|
+
|
3458
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
3459
|
+
symbol = 'symbol_example' # String | Company symbol.
|
3460
|
+
from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>.
|
3461
|
+
to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
|
3462
|
+
|
3463
|
+
begin
|
3464
|
+
# Historical Employee Count
|
3465
|
+
result = api_instance.historical_employee_count(symbol, from, to)
|
3466
|
+
p result
|
3467
|
+
rescue FinnhubRuby::ApiError => e
|
3468
|
+
puts "Error when calling DefaultApi->historical_employee_count: #{e}"
|
3469
|
+
end
|
3470
|
+
```
|
3471
|
+
|
3472
|
+
#### Using the historical_employee_count_with_http_info variant
|
3473
|
+
|
3474
|
+
This returns an Array which contains the response data, status code and headers.
|
3475
|
+
|
3476
|
+
> <Array(<HistoricalEmployeeCount>, Integer, Hash)> historical_employee_count_with_http_info(symbol, from, to)
|
3477
|
+
|
3478
|
+
```ruby
|
3479
|
+
begin
|
3480
|
+
# Historical Employee Count
|
3481
|
+
data, status_code, headers = api_instance.historical_employee_count_with_http_info(symbol, from, to)
|
3482
|
+
p status_code # => 2xx
|
3483
|
+
p headers # => { ... }
|
3484
|
+
p data # => <HistoricalEmployeeCount>
|
3485
|
+
rescue FinnhubRuby::ApiError => e
|
3486
|
+
puts "Error when calling DefaultApi->historical_employee_count_with_http_info: #{e}"
|
3487
|
+
end
|
3488
|
+
```
|
3489
|
+
|
3490
|
+
### Parameters
|
3491
|
+
|
3492
|
+
| Name | Type | Description | Notes |
|
3493
|
+
| ---- | ---- | ----------- | ----- |
|
3494
|
+
| **symbol** | **String** | Company symbol. | |
|
3495
|
+
| **from** | **Date** | From date <code>YYYY-MM-DD</code>. | |
|
3496
|
+
| **to** | **Date** | To date <code>YYYY-MM-DD</code>. | |
|
3497
|
+
|
3498
|
+
### Return type
|
3499
|
+
|
3500
|
+
[**HistoricalEmployeeCount**](HistoricalEmployeeCount.md)
|
3501
|
+
|
3502
|
+
### Authorization
|
3503
|
+
|
3504
|
+
[api_key](../README.md#api_key)
|
3505
|
+
|
3506
|
+
### HTTP request headers
|
3507
|
+
|
3508
|
+
- **Content-Type**: Not defined
|
3509
|
+
- **Accept**: application/json
|
3510
|
+
|
3511
|
+
|
3512
|
+
## historical_market_cap
|
3513
|
+
|
3514
|
+
> <HistoricalMarketCapData> historical_market_cap(symbol, from, to)
|
3515
|
+
|
3516
|
+
Historical Market Cap
|
3517
|
+
|
3518
|
+
Get historical market cap data for global companies.
|
3519
|
+
|
3520
|
+
### Examples
|
3521
|
+
|
3522
|
+
```ruby
|
3523
|
+
require 'time'
|
3524
|
+
require 'finnhub_ruby'
|
3525
|
+
# setup authorization
|
3526
|
+
FinnhubRuby.configure do |config|
|
3527
|
+
# Configure API key authorization: api_key
|
3528
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
3529
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3530
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
3531
|
+
end
|
3532
|
+
|
3533
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
3534
|
+
symbol = 'symbol_example' # String | Company symbol.
|
3535
|
+
from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>.
|
3536
|
+
to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
|
3537
|
+
|
3538
|
+
begin
|
3539
|
+
# Historical Market Cap
|
3540
|
+
result = api_instance.historical_market_cap(symbol, from, to)
|
3082
3541
|
p result
|
3083
3542
|
rescue FinnhubRuby::ApiError => e
|
3084
|
-
puts "Error when calling DefaultApi->
|
3543
|
+
puts "Error when calling DefaultApi->historical_market_cap: #{e}"
|
3085
3544
|
end
|
3086
3545
|
```
|
3087
3546
|
|
3088
|
-
#### Using the
|
3547
|
+
#### Using the historical_market_cap_with_http_info variant
|
3089
3548
|
|
3090
3549
|
This returns an Array which contains the response data, status code and headers.
|
3091
3550
|
|
3092
|
-
> <Array(<
|
3551
|
+
> <Array(<HistoricalMarketCapData>, Integer, Hash)> historical_market_cap_with_http_info(symbol, from, to)
|
3093
3552
|
|
3094
3553
|
```ruby
|
3095
3554
|
begin
|
3096
|
-
#
|
3097
|
-
data, status_code, headers = api_instance.
|
3555
|
+
# Historical Market Cap
|
3556
|
+
data, status_code, headers = api_instance.historical_market_cap_with_http_info(symbol, from, to)
|
3098
3557
|
p status_code # => 2xx
|
3099
3558
|
p headers # => { ... }
|
3100
|
-
p data # => <
|
3559
|
+
p data # => <HistoricalMarketCapData>
|
3101
3560
|
rescue FinnhubRuby::ApiError => e
|
3102
|
-
puts "Error when calling DefaultApi->
|
3561
|
+
puts "Error when calling DefaultApi->historical_market_cap_with_http_info: #{e}"
|
3103
3562
|
end
|
3104
3563
|
```
|
3105
3564
|
|
@@ -3107,12 +3566,13 @@ end
|
|
3107
3566
|
|
3108
3567
|
| Name | Type | Description | Notes |
|
3109
3568
|
| ---- | ---- | ----------- | ----- |
|
3110
|
-
| **symbol** | **String** |
|
3111
|
-
| **
|
3569
|
+
| **symbol** | **String** | Company symbol. | |
|
3570
|
+
| **from** | **Date** | From date <code>YYYY-MM-DD</code>. | |
|
3571
|
+
| **to** | **Date** | To date <code>YYYY-MM-DD</code>. | |
|
3112
3572
|
|
3113
3573
|
### Return type
|
3114
3574
|
|
3115
|
-
[**
|
3575
|
+
[**HistoricalMarketCapData**](HistoricalMarketCapData.md)
|
3116
3576
|
|
3117
3577
|
### Authorization
|
3118
3578
|
|
@@ -3130,7 +3590,7 @@ end
|
|
3130
3590
|
|
3131
3591
|
Indices Constituents
|
3132
3592
|
|
3133
|
-
Get a list of index's constituents. A list of supported indices for this endpoint can be found <a href=\"
|
3593
|
+
Get a list of index's constituents. A list of supported indices for this endpoint can be found <a href=\"/api/v1/index/list?token=\" target=\"_blank\">here</a>.
|
3134
3594
|
|
3135
3595
|
### Examples
|
3136
3596
|
|
@@ -3347,7 +3807,7 @@ end
|
|
3347
3807
|
|
3348
3808
|
Insider Transactions
|
3349
3809
|
|
3350
|
-
Company insider transactions data sourced from <code>Form 3,4,5</code
|
3810
|
+
Company insider transactions data sourced from <code>Form 3,4,5</code>, SEDI and relevant companies' filings. This endpoint covers US, UK, Canada, Australia, India, and all major EU markets. Limit to 100 transactions per API call.
|
3351
3811
|
|
3352
3812
|
### Examples
|
3353
3813
|
|
@@ -3501,7 +3961,7 @@ end
|
|
3501
3961
|
|
3502
3962
|
Institutional Portfolio
|
3503
3963
|
|
3504
|
-
Get the holdings/portfolio data of institutional investors from 13-F filings. Limit to 1 year of data at a time.
|
3964
|
+
Get the holdings/portfolio data of institutional investors from 13-F filings. Limit to 1 year of data at a time. You can get a list of supported CIK <a href=\"/api/v1/institutional/list?token=\" target=\"_blank\">here</a>.
|
3505
3965
|
|
3506
3966
|
### Examples
|
3507
3967
|
|
@@ -3649,7 +4109,7 @@ end
|
|
3649
4109
|
|
3650
4110
|
International Filings
|
3651
4111
|
|
3652
|
-
List filings for international companies. Limit to
|
4112
|
+
List filings for international companies. Limit to 500 documents at a time. These are the documents we use to source our fundamental data. Only support SEDAR and UK Companies House for normal usage. Enterprise clients who need access to the full filings for global markets should contact us for the access.
|
3653
4113
|
|
3654
4114
|
### Examples
|
3655
4115
|
|
@@ -3667,7 +4127,9 @@ end
|
|
3667
4127
|
api_instance = FinnhubRuby::DefaultApi.new
|
3668
4128
|
opts = {
|
3669
4129
|
symbol: 'symbol_example', # String | Symbol. Leave empty to list latest filings.
|
3670
|
-
country: 'country_example' # String | Filter by country using country's 2-letter code.
|
4130
|
+
country: 'country_example', # String | Filter by country using country's 2-letter code.
|
4131
|
+
from: Date.parse('2013-10-20'), # Date | From date: 2023-01-15.
|
4132
|
+
to: Date.parse('2013-10-20') # Date | To date: 2023-12-16.
|
3671
4133
|
}
|
3672
4134
|
|
3673
4135
|
begin
|
@@ -3703,6 +4165,8 @@ end
|
|
3703
4165
|
| ---- | ---- | ----------- | ----- |
|
3704
4166
|
| **symbol** | **String** | Symbol. Leave empty to list latest filings. | [optional] |
|
3705
4167
|
| **country** | **String** | Filter by country using country's 2-letter code. | [optional] |
|
4168
|
+
| **from** | **Date** | From date: 2023-01-15. | [optional] |
|
4169
|
+
| **to** | **Date** | To date: 2023-12-16. | [optional] |
|
3706
4170
|
|
3707
4171
|
### Return type
|
3708
4172
|
|
@@ -3935,6 +4399,77 @@ end
|
|
3935
4399
|
- **Accept**: application/json
|
3936
4400
|
|
3937
4401
|
|
4402
|
+
## market_holiday
|
4403
|
+
|
4404
|
+
> <MarketHoliday> market_holiday(exchange)
|
4405
|
+
|
4406
|
+
Market Holiday
|
4407
|
+
|
4408
|
+
Get a list of holidays for global exchanges.
|
4409
|
+
|
4410
|
+
### Examples
|
4411
|
+
|
4412
|
+
```ruby
|
4413
|
+
require 'time'
|
4414
|
+
require 'finnhub_ruby'
|
4415
|
+
# setup authorization
|
4416
|
+
FinnhubRuby.configure do |config|
|
4417
|
+
# Configure API key authorization: api_key
|
4418
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
4419
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4420
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
4421
|
+
end
|
4422
|
+
|
4423
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
4424
|
+
exchange = 'exchange_example' # String | Exchange code.
|
4425
|
+
|
4426
|
+
begin
|
4427
|
+
# Market Holiday
|
4428
|
+
result = api_instance.market_holiday(exchange)
|
4429
|
+
p result
|
4430
|
+
rescue FinnhubRuby::ApiError => e
|
4431
|
+
puts "Error when calling DefaultApi->market_holiday: #{e}"
|
4432
|
+
end
|
4433
|
+
```
|
4434
|
+
|
4435
|
+
#### Using the market_holiday_with_http_info variant
|
4436
|
+
|
4437
|
+
This returns an Array which contains the response data, status code and headers.
|
4438
|
+
|
4439
|
+
> <Array(<MarketHoliday>, Integer, Hash)> market_holiday_with_http_info(exchange)
|
4440
|
+
|
4441
|
+
```ruby
|
4442
|
+
begin
|
4443
|
+
# Market Holiday
|
4444
|
+
data, status_code, headers = api_instance.market_holiday_with_http_info(exchange)
|
4445
|
+
p status_code # => 2xx
|
4446
|
+
p headers # => { ... }
|
4447
|
+
p data # => <MarketHoliday>
|
4448
|
+
rescue FinnhubRuby::ApiError => e
|
4449
|
+
puts "Error when calling DefaultApi->market_holiday_with_http_info: #{e}"
|
4450
|
+
end
|
4451
|
+
```
|
4452
|
+
|
4453
|
+
### Parameters
|
4454
|
+
|
4455
|
+
| Name | Type | Description | Notes |
|
4456
|
+
| ---- | ---- | ----------- | ----- |
|
4457
|
+
| **exchange** | **String** | Exchange code. | |
|
4458
|
+
|
4459
|
+
### Return type
|
4460
|
+
|
4461
|
+
[**MarketHoliday**](MarketHoliday.md)
|
4462
|
+
|
4463
|
+
### Authorization
|
4464
|
+
|
4465
|
+
[api_key](../README.md#api_key)
|
4466
|
+
|
4467
|
+
### HTTP request headers
|
4468
|
+
|
4469
|
+
- **Content-Type**: Not defined
|
4470
|
+
- **Accept**: application/json
|
4471
|
+
|
4472
|
+
|
3938
4473
|
## market_news
|
3939
4474
|
|
3940
4475
|
> <Array<MarketNews>> market_news(category, opts)
|
@@ -4010,9 +4545,80 @@ end
|
|
4010
4545
|
- **Accept**: application/json
|
4011
4546
|
|
4012
4547
|
|
4548
|
+
## market_status
|
4549
|
+
|
4550
|
+
> <MarketStatus> market_status(exchange)
|
4551
|
+
|
4552
|
+
Market Status
|
4553
|
+
|
4554
|
+
Get current market status for global exchanges (whether exchanges are open or close).
|
4555
|
+
|
4556
|
+
### Examples
|
4557
|
+
|
4558
|
+
```ruby
|
4559
|
+
require 'time'
|
4560
|
+
require 'finnhub_ruby'
|
4561
|
+
# setup authorization
|
4562
|
+
FinnhubRuby.configure do |config|
|
4563
|
+
# Configure API key authorization: api_key
|
4564
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
4565
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4566
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
4567
|
+
end
|
4568
|
+
|
4569
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
4570
|
+
exchange = 'exchange_example' # String | Exchange code.
|
4571
|
+
|
4572
|
+
begin
|
4573
|
+
# Market Status
|
4574
|
+
result = api_instance.market_status(exchange)
|
4575
|
+
p result
|
4576
|
+
rescue FinnhubRuby::ApiError => e
|
4577
|
+
puts "Error when calling DefaultApi->market_status: #{e}"
|
4578
|
+
end
|
4579
|
+
```
|
4580
|
+
|
4581
|
+
#### Using the market_status_with_http_info variant
|
4582
|
+
|
4583
|
+
This returns an Array which contains the response data, status code and headers.
|
4584
|
+
|
4585
|
+
> <Array(<MarketStatus>, Integer, Hash)> market_status_with_http_info(exchange)
|
4586
|
+
|
4587
|
+
```ruby
|
4588
|
+
begin
|
4589
|
+
# Market Status
|
4590
|
+
data, status_code, headers = api_instance.market_status_with_http_info(exchange)
|
4591
|
+
p status_code # => 2xx
|
4592
|
+
p headers # => { ... }
|
4593
|
+
p data # => <MarketStatus>
|
4594
|
+
rescue FinnhubRuby::ApiError => e
|
4595
|
+
puts "Error when calling DefaultApi->market_status_with_http_info: #{e}"
|
4596
|
+
end
|
4597
|
+
```
|
4598
|
+
|
4599
|
+
### Parameters
|
4600
|
+
|
4601
|
+
| Name | Type | Description | Notes |
|
4602
|
+
| ---- | ---- | ----------- | ----- |
|
4603
|
+
| **exchange** | **String** | Exchange code. | |
|
4604
|
+
|
4605
|
+
### Return type
|
4606
|
+
|
4607
|
+
[**MarketStatus**](MarketStatus.md)
|
4608
|
+
|
4609
|
+
### Authorization
|
4610
|
+
|
4611
|
+
[api_key](../README.md#api_key)
|
4612
|
+
|
4613
|
+
### HTTP request headers
|
4614
|
+
|
4615
|
+
- **Content-Type**: Not defined
|
4616
|
+
- **Accept**: application/json
|
4617
|
+
|
4618
|
+
|
4013
4619
|
## mutual_fund_country_exposure
|
4014
4620
|
|
4015
|
-
> <MutualFundCountryExposure> mutual_fund_country_exposure(
|
4621
|
+
> <MutualFundCountryExposure> mutual_fund_country_exposure(opts)
|
4016
4622
|
|
4017
4623
|
Mutual Funds Country Exposure
|
4018
4624
|
|
@@ -4032,11 +4638,14 @@ FinnhubRuby.configure do |config|
|
|
4032
4638
|
end
|
4033
4639
|
|
4034
4640
|
api_instance = FinnhubRuby::DefaultApi.new
|
4035
|
-
|
4641
|
+
opts = {
|
4642
|
+
symbol: 'symbol_example', # String | Symbol.
|
4643
|
+
isin: 'isin_example' # String | Fund's isin.
|
4644
|
+
}
|
4036
4645
|
|
4037
4646
|
begin
|
4038
4647
|
# Mutual Funds Country Exposure
|
4039
|
-
result = api_instance.mutual_fund_country_exposure(
|
4648
|
+
result = api_instance.mutual_fund_country_exposure(opts)
|
4040
4649
|
p result
|
4041
4650
|
rescue FinnhubRuby::ApiError => e
|
4042
4651
|
puts "Error when calling DefaultApi->mutual_fund_country_exposure: #{e}"
|
@@ -4047,12 +4656,12 @@ end
|
|
4047
4656
|
|
4048
4657
|
This returns an Array which contains the response data, status code and headers.
|
4049
4658
|
|
4050
|
-
> <Array(<MutualFundCountryExposure>, Integer, Hash)> mutual_fund_country_exposure_with_http_info(
|
4659
|
+
> <Array(<MutualFundCountryExposure>, Integer, Hash)> mutual_fund_country_exposure_with_http_info(opts)
|
4051
4660
|
|
4052
4661
|
```ruby
|
4053
4662
|
begin
|
4054
4663
|
# Mutual Funds Country Exposure
|
4055
|
-
data, status_code, headers = api_instance.mutual_fund_country_exposure_with_http_info(
|
4664
|
+
data, status_code, headers = api_instance.mutual_fund_country_exposure_with_http_info(opts)
|
4056
4665
|
p status_code # => 2xx
|
4057
4666
|
p headers # => { ... }
|
4058
4667
|
p data # => <MutualFundCountryExposure>
|
@@ -4065,7 +4674,8 @@ end
|
|
4065
4674
|
|
4066
4675
|
| Name | Type | Description | Notes |
|
4067
4676
|
| ---- | ---- | ----------- | ----- |
|
4068
|
-
| **symbol** | **String** | Symbol. |
|
4677
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
4678
|
+
| **isin** | **String** | Fund's isin. | [optional] |
|
4069
4679
|
|
4070
4680
|
### Return type
|
4071
4681
|
|
@@ -4081,13 +4691,155 @@ end
|
|
4081
4691
|
- **Accept**: application/json
|
4082
4692
|
|
4083
4693
|
|
4694
|
+
## mutual_fund_eet
|
4695
|
+
|
4696
|
+
> <MutualFundEet> mutual_fund_eet(isin)
|
4697
|
+
|
4698
|
+
Mutual Funds EET
|
4699
|
+
|
4700
|
+
Get EET data for EU funds. For PAIs data, please see the EET PAI endpoint.
|
4701
|
+
|
4702
|
+
### Examples
|
4703
|
+
|
4704
|
+
```ruby
|
4705
|
+
require 'time'
|
4706
|
+
require 'finnhub_ruby'
|
4707
|
+
# setup authorization
|
4708
|
+
FinnhubRuby.configure do |config|
|
4709
|
+
# Configure API key authorization: api_key
|
4710
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
4711
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4712
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
4713
|
+
end
|
4714
|
+
|
4715
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
4716
|
+
isin = 'isin_example' # String | ISIN.
|
4717
|
+
|
4718
|
+
begin
|
4719
|
+
# Mutual Funds EET
|
4720
|
+
result = api_instance.mutual_fund_eet(isin)
|
4721
|
+
p result
|
4722
|
+
rescue FinnhubRuby::ApiError => e
|
4723
|
+
puts "Error when calling DefaultApi->mutual_fund_eet: #{e}"
|
4724
|
+
end
|
4725
|
+
```
|
4726
|
+
|
4727
|
+
#### Using the mutual_fund_eet_with_http_info variant
|
4728
|
+
|
4729
|
+
This returns an Array which contains the response data, status code and headers.
|
4730
|
+
|
4731
|
+
> <Array(<MutualFundEet>, Integer, Hash)> mutual_fund_eet_with_http_info(isin)
|
4732
|
+
|
4733
|
+
```ruby
|
4734
|
+
begin
|
4735
|
+
# Mutual Funds EET
|
4736
|
+
data, status_code, headers = api_instance.mutual_fund_eet_with_http_info(isin)
|
4737
|
+
p status_code # => 2xx
|
4738
|
+
p headers # => { ... }
|
4739
|
+
p data # => <MutualFundEet>
|
4740
|
+
rescue FinnhubRuby::ApiError => e
|
4741
|
+
puts "Error when calling DefaultApi->mutual_fund_eet_with_http_info: #{e}"
|
4742
|
+
end
|
4743
|
+
```
|
4744
|
+
|
4745
|
+
### Parameters
|
4746
|
+
|
4747
|
+
| Name | Type | Description | Notes |
|
4748
|
+
| ---- | ---- | ----------- | ----- |
|
4749
|
+
| **isin** | **String** | ISIN. | |
|
4750
|
+
|
4751
|
+
### Return type
|
4752
|
+
|
4753
|
+
[**MutualFundEet**](MutualFundEet.md)
|
4754
|
+
|
4755
|
+
### Authorization
|
4756
|
+
|
4757
|
+
[api_key](../README.md#api_key)
|
4758
|
+
|
4759
|
+
### HTTP request headers
|
4760
|
+
|
4761
|
+
- **Content-Type**: Not defined
|
4762
|
+
- **Accept**: application/json
|
4763
|
+
|
4764
|
+
|
4765
|
+
## mutual_fund_eet_pai
|
4766
|
+
|
4767
|
+
> <MutualFundEetPai> mutual_fund_eet_pai(isin)
|
4768
|
+
|
4769
|
+
Mutual Funds EET PAI
|
4770
|
+
|
4771
|
+
Get EET PAI data for EU funds.
|
4772
|
+
|
4773
|
+
### Examples
|
4774
|
+
|
4775
|
+
```ruby
|
4776
|
+
require 'time'
|
4777
|
+
require 'finnhub_ruby'
|
4778
|
+
# setup authorization
|
4779
|
+
FinnhubRuby.configure do |config|
|
4780
|
+
# Configure API key authorization: api_key
|
4781
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
4782
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4783
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
4784
|
+
end
|
4785
|
+
|
4786
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
4787
|
+
isin = 'isin_example' # String | ISIN.
|
4788
|
+
|
4789
|
+
begin
|
4790
|
+
# Mutual Funds EET PAI
|
4791
|
+
result = api_instance.mutual_fund_eet_pai(isin)
|
4792
|
+
p result
|
4793
|
+
rescue FinnhubRuby::ApiError => e
|
4794
|
+
puts "Error when calling DefaultApi->mutual_fund_eet_pai: #{e}"
|
4795
|
+
end
|
4796
|
+
```
|
4797
|
+
|
4798
|
+
#### Using the mutual_fund_eet_pai_with_http_info variant
|
4799
|
+
|
4800
|
+
This returns an Array which contains the response data, status code and headers.
|
4801
|
+
|
4802
|
+
> <Array(<MutualFundEetPai>, Integer, Hash)> mutual_fund_eet_pai_with_http_info(isin)
|
4803
|
+
|
4804
|
+
```ruby
|
4805
|
+
begin
|
4806
|
+
# Mutual Funds EET PAI
|
4807
|
+
data, status_code, headers = api_instance.mutual_fund_eet_pai_with_http_info(isin)
|
4808
|
+
p status_code # => 2xx
|
4809
|
+
p headers # => { ... }
|
4810
|
+
p data # => <MutualFundEetPai>
|
4811
|
+
rescue FinnhubRuby::ApiError => e
|
4812
|
+
puts "Error when calling DefaultApi->mutual_fund_eet_pai_with_http_info: #{e}"
|
4813
|
+
end
|
4814
|
+
```
|
4815
|
+
|
4816
|
+
### Parameters
|
4817
|
+
|
4818
|
+
| Name | Type | Description | Notes |
|
4819
|
+
| ---- | ---- | ----------- | ----- |
|
4820
|
+
| **isin** | **String** | ISIN. | |
|
4821
|
+
|
4822
|
+
### Return type
|
4823
|
+
|
4824
|
+
[**MutualFundEetPai**](MutualFundEetPai.md)
|
4825
|
+
|
4826
|
+
### Authorization
|
4827
|
+
|
4828
|
+
[api_key](../README.md#api_key)
|
4829
|
+
|
4830
|
+
### HTTP request headers
|
4831
|
+
|
4832
|
+
- **Content-Type**: Not defined
|
4833
|
+
- **Accept**: application/json
|
4834
|
+
|
4835
|
+
|
4084
4836
|
## mutual_fund_holdings
|
4085
4837
|
|
4086
4838
|
> <MutualFundHoldings> mutual_fund_holdings(opts)
|
4087
4839
|
|
4088
4840
|
Mutual Funds Holdings
|
4089
4841
|
|
4090
|
-
Get full Mutual Funds holdings/constituents. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN.
|
4842
|
+
Get full Mutual Funds holdings/constituents. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN. A list of supported funds can be found <a href=\"/api/v1/mutual-fund/list?token=\" target=\"_blank\">here</a>.
|
4091
4843
|
|
4092
4844
|
### Examples
|
4093
4845
|
|
@@ -4164,7 +4916,7 @@ end
|
|
4164
4916
|
|
4165
4917
|
Mutual Funds Profile
|
4166
4918
|
|
4167
|
-
Get mutual funds profile information. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN.
|
4919
|
+
Get mutual funds profile information. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN. A list of supported funds can be found <a href=\"/api/v1/mutual-fund/list?token=\" target=\"_blank\">here</a>.
|
4168
4920
|
|
4169
4921
|
### Examples
|
4170
4922
|
|
@@ -4235,7 +4987,7 @@ end
|
|
4235
4987
|
|
4236
4988
|
## mutual_fund_sector_exposure
|
4237
4989
|
|
4238
|
-
> <MutualFundSectorExposure> mutual_fund_sector_exposure(
|
4990
|
+
> <MutualFundSectorExposure> mutual_fund_sector_exposure(opts)
|
4239
4991
|
|
4240
4992
|
Mutual Funds Sector Exposure
|
4241
4993
|
|
@@ -4255,11 +5007,14 @@ FinnhubRuby.configure do |config|
|
|
4255
5007
|
end
|
4256
5008
|
|
4257
5009
|
api_instance = FinnhubRuby::DefaultApi.new
|
4258
|
-
|
5010
|
+
opts = {
|
5011
|
+
symbol: 'symbol_example', # String | Mutual Fund symbol.
|
5012
|
+
isin: 'isin_example' # String | Fund's isin.
|
5013
|
+
}
|
4259
5014
|
|
4260
5015
|
begin
|
4261
5016
|
# Mutual Funds Sector Exposure
|
4262
|
-
result = api_instance.mutual_fund_sector_exposure(
|
5017
|
+
result = api_instance.mutual_fund_sector_exposure(opts)
|
4263
5018
|
p result
|
4264
5019
|
rescue FinnhubRuby::ApiError => e
|
4265
5020
|
puts "Error when calling DefaultApi->mutual_fund_sector_exposure: #{e}"
|
@@ -4270,12 +5025,12 @@ end
|
|
4270
5025
|
|
4271
5026
|
This returns an Array which contains the response data, status code and headers.
|
4272
5027
|
|
4273
|
-
> <Array(<MutualFundSectorExposure>, Integer, Hash)> mutual_fund_sector_exposure_with_http_info(
|
5028
|
+
> <Array(<MutualFundSectorExposure>, Integer, Hash)> mutual_fund_sector_exposure_with_http_info(opts)
|
4274
5029
|
|
4275
5030
|
```ruby
|
4276
5031
|
begin
|
4277
5032
|
# Mutual Funds Sector Exposure
|
4278
|
-
data, status_code, headers = api_instance.mutual_fund_sector_exposure_with_http_info(
|
5033
|
+
data, status_code, headers = api_instance.mutual_fund_sector_exposure_with_http_info(opts)
|
4279
5034
|
p status_code # => 2xx
|
4280
5035
|
p headers # => { ... }
|
4281
5036
|
p data # => <MutualFundSectorExposure>
|
@@ -4288,7 +5043,8 @@ end
|
|
4288
5043
|
|
4289
5044
|
| Name | Type | Description | Notes |
|
4290
5045
|
| ---- | ---- | ----------- | ----- |
|
4291
|
-
| **symbol** | **String** | Mutual Fund symbol. |
|
5046
|
+
| **symbol** | **String** | Mutual Fund symbol. | [optional] |
|
5047
|
+
| **isin** | **String** | Fund's isin. | [optional] |
|
4292
5048
|
|
4293
5049
|
### Return type
|
4294
5050
|
|
@@ -4602,7 +5358,7 @@ end
|
|
4602
5358
|
|
4603
5359
|
## price_metrics
|
4604
5360
|
|
4605
|
-
> <PriceMetrics> price_metrics(symbol)
|
5361
|
+
> <PriceMetrics> price_metrics(symbol, opts)
|
4606
5362
|
|
4607
5363
|
Price Metrics
|
4608
5364
|
|
@@ -4623,10 +5379,13 @@ end
|
|
4623
5379
|
|
4624
5380
|
api_instance = FinnhubRuby::DefaultApi.new
|
4625
5381
|
symbol = 'symbol_example' # String | Symbol of the company: AAPL.
|
5382
|
+
opts = {
|
5383
|
+
date: 'date_example' # String | Get data on a specific date in the past. The data is available weekly so your date will be automatically adjusted to the last day of that week.
|
5384
|
+
}
|
4626
5385
|
|
4627
5386
|
begin
|
4628
5387
|
# Price Metrics
|
4629
|
-
result = api_instance.price_metrics(symbol)
|
5388
|
+
result = api_instance.price_metrics(symbol, opts)
|
4630
5389
|
p result
|
4631
5390
|
rescue FinnhubRuby::ApiError => e
|
4632
5391
|
puts "Error when calling DefaultApi->price_metrics: #{e}"
|
@@ -4637,12 +5396,12 @@ end
|
|
4637
5396
|
|
4638
5397
|
This returns an Array which contains the response data, status code and headers.
|
4639
5398
|
|
4640
|
-
> <Array(<PriceMetrics>, Integer, Hash)> price_metrics_with_http_info(symbol)
|
5399
|
+
> <Array(<PriceMetrics>, Integer, Hash)> price_metrics_with_http_info(symbol, opts)
|
4641
5400
|
|
4642
5401
|
```ruby
|
4643
5402
|
begin
|
4644
5403
|
# Price Metrics
|
4645
|
-
data, status_code, headers = api_instance.price_metrics_with_http_info(symbol)
|
5404
|
+
data, status_code, headers = api_instance.price_metrics_with_http_info(symbol, opts)
|
4646
5405
|
p status_code # => 2xx
|
4647
5406
|
p headers # => { ... }
|
4648
5407
|
p data # => <PriceMetrics>
|
@@ -4656,6 +5415,7 @@ end
|
|
4656
5415
|
| Name | Type | Description | Notes |
|
4657
5416
|
| ---- | ---- | ----------- | ----- |
|
4658
5417
|
| **symbol** | **String** | Symbol of the company: AAPL. | |
|
5418
|
+
| **date** | **String** | Get data on a specific date in the past. The data is available weekly so your date will be automatically adjusted to the last day of that week. | [optional] |
|
4659
5419
|
|
4660
5420
|
### Return type
|
4661
5421
|
|
@@ -5113,7 +5873,7 @@ end
|
|
5113
5873
|
|
5114
5874
|
Social Sentiment
|
5115
5875
|
|
5116
|
-
<p>Get social sentiment for stocks on Reddit and Twitter
|
5876
|
+
<p>Get social sentiment for stocks on Reddit and Twitter.</p>
|
5117
5877
|
|
5118
5878
|
### Examples
|
5119
5879
|
|
@@ -5332,7 +6092,7 @@ end
|
|
5332
6092
|
|
5333
6093
|
Stock Candles
|
5334
6094
|
|
5335
|
-
<p>Get candlestick data (OHLCV) for stocks.</p><p>Daily data will be adjusted for Splits. Intraday data will remain unadjusted.</p>
|
6095
|
+
<p>Get candlestick data (OHLCV) for stocks.</p><p>Daily data will be adjusted for Splits. Intraday data will remain unadjusted. Only 1 month of intraday will be returned at a time. If you need more historical intraday data, please use the from and to params iteratively to request more data.</p>
|
5336
6096
|
|
5337
6097
|
### Examples
|
5338
6098
|
|
@@ -5790,7 +6550,7 @@ end
|
|
5790
6550
|
|
5791
6551
|
Tick Data
|
5792
6552
|
|
5793
|
-
<p>Get historical tick data for global exchanges
|
6553
|
+
<p>Get historical tick data for global exchanges.</p><p>For more historical tick data, you can visit our bulk download page in the Dashboard <a target=\"_blank\" href=\"/dashboard/download\",>here</a> to speed up the download process.</p><table class=\"table table-hover\"> <thead> <tr> <th>Exchange</th> <th>Segment</th> <th>Delay</th> </tr> </thead> <tbody> <tr> <td class=\"text-blue\">US CTA/UTP</th> <td>Full SIP</td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">TSX</th> <td><ul><li>TSX</li><li>TSX Venture</li><li>Index</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">LSE</th> <td><ul><li>London Stock Exchange (L)</li><li>LSE International (L)</li><li>LSE European (L)</li></ul></td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">Euronext</th> <td><ul> <li>Euronext Paris (PA)</li> <li>Euronext Amsterdam (AS)</li> <li>Euronext Lisbon (LS)</li> <li>Euronext Brussels (BR)</li> <li>Euronext Oslo (OL)</li> <li>Euronext London (LN)</li> <li>Euronext Dublin (IR)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">Deutsche Börse</th> <td><ul> <li>Frankfurt (F)</li> <li>Xetra (DE)</li> <li>Duesseldorf (DU)</li> <li>Hamburg (HM)</li> <li>Berlin (BE)</li> <li>Hanover (HA)</li> <li>Stoxx (SX)</li> <li>TradeGate (TG)</li> <li>Zertifikate (SC)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> </tbody> </table>
|
5794
6554
|
|
5795
6555
|
### Examples
|
5796
6556
|
|
@@ -6236,7 +6996,7 @@ end
|
|
6236
6996
|
|
6237
6997
|
Symbol Change
|
6238
6998
|
|
6239
|
-
Get a list of symbol changes for US-listed
|
6999
|
+
Get a list of symbol changes for US-listed, EU-listed, NSE and ASX securities. Limit to 2000 events at a time.
|
6240
7000
|
|
6241
7001
|
### Examples
|
6242
7002
|
|
@@ -6305,7 +7065,7 @@ end
|
|
6305
7065
|
|
6306
7066
|
## symbol_search
|
6307
7067
|
|
6308
|
-
> <SymbolLookup> symbol_search(q)
|
7068
|
+
> <SymbolLookup> symbol_search(q, opts)
|
6309
7069
|
|
6310
7070
|
Symbol Lookup
|
6311
7071
|
|
@@ -6326,10 +7086,13 @@ end
|
|
6326
7086
|
|
6327
7087
|
api_instance = FinnhubRuby::DefaultApi.new
|
6328
7088
|
q = 'q_example' # String | Query text can be symbol, name, isin, or cusip.
|
7089
|
+
opts = {
|
7090
|
+
exchange: 'exchange_example' # String | Exchange limit.
|
7091
|
+
}
|
6329
7092
|
|
6330
7093
|
begin
|
6331
7094
|
# Symbol Lookup
|
6332
|
-
result = api_instance.symbol_search(q)
|
7095
|
+
result = api_instance.symbol_search(q, opts)
|
6333
7096
|
p result
|
6334
7097
|
rescue FinnhubRuby::ApiError => e
|
6335
7098
|
puts "Error when calling DefaultApi->symbol_search: #{e}"
|
@@ -6340,12 +7103,12 @@ end
|
|
6340
7103
|
|
6341
7104
|
This returns an Array which contains the response data, status code and headers.
|
6342
7105
|
|
6343
|
-
> <Array(<SymbolLookup>, Integer, Hash)> symbol_search_with_http_info(q)
|
7106
|
+
> <Array(<SymbolLookup>, Integer, Hash)> symbol_search_with_http_info(q, opts)
|
6344
7107
|
|
6345
7108
|
```ruby
|
6346
7109
|
begin
|
6347
7110
|
# Symbol Lookup
|
6348
|
-
data, status_code, headers = api_instance.symbol_search_with_http_info(q)
|
7111
|
+
data, status_code, headers = api_instance.symbol_search_with_http_info(q, opts)
|
6349
7112
|
p status_code # => 2xx
|
6350
7113
|
p headers # => { ... }
|
6351
7114
|
p data # => <SymbolLookup>
|
@@ -6359,6 +7122,7 @@ end
|
|
6359
7122
|
| Name | Type | Description | Notes |
|
6360
7123
|
| ---- | ---- | ----------- | ----- |
|
6361
7124
|
| **q** | **String** | Query text can be symbol, name, isin, or cusip. | |
|
7125
|
+
| **exchange** | **String** | Exchange limit. | [optional] |
|
6362
7126
|
|
6363
7127
|
### Return type
|
6364
7128
|
|
@@ -6463,7 +7227,7 @@ end
|
|
6463
7227
|
|
6464
7228
|
Earnings Call Transcripts
|
6465
7229
|
|
6466
|
-
<p>Get earnings call transcripts, audio and participants' list.
|
7230
|
+
<p>Get earnings call transcripts, audio and participants' list. Data is available for US, UK, European, Australian and Canadian companies.<p>15+ years of data is available with 220,000+ audio which add up to 7TB in size.</p>
|
6467
7231
|
|
6468
7232
|
### Examples
|
6469
7233
|
|