finnhub_ruby 1.1.19 → 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/CompanyESG2.md +28 -0
- data/docs/CompanyProfile.md +6 -0
- data/docs/CountryMetadata.md +9 -1
- data/docs/DefaultApi.md +582 -38
- data/docs/ETFProfileData.md +2 -0
- data/docs/EarningResult.md +2 -2
- 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/FilingResponse.md +1 -1
- data/docs/HistoricalCompanyESG.md +20 -0
- data/docs/HistoricalEmployeeCount.md +20 -0
- data/docs/HistoricalMarketCapData.md +22 -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/MutualFundProfileData.md +2 -0
- data/docs/PriceTarget.md +2 -0
- data/docs/RevenueEstimatesInfo.md +5 -1
- 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 -178
- metadata +29 -521
- 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.18.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 -6370
- 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 -347
- data/lib/finnhub_ruby/models/bond_yield_curve.rb +0 -231
- data/lib/finnhub_ruby/models/bond_yield_curve_info.rb +0 -229
- 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 -509
- data/lib/finnhub_ruby/models/company_profile2.rb +0 -329
- data/lib/finnhub_ruby/models/congressional_trading.rb +0 -231
- data/lib/finnhub_ruby/models/congressional_transaction.rb +0 -309
- 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 -299
- 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/document_response.rb +0 -271
- 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 -289
- 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 -289
- 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/excerpt_response.rb +0 -249
- 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_response.rb +0 -339
- 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/in_filing_response.rb +0 -351
- data/lib/finnhub_ruby/models/in_filing_search_body.rb +0 -239
- 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_eet.rb +0 -228
- data/lib/finnhub_ruby/models/mutual_fund_eet_pai.rb +0 -228
- data/lib/finnhub_ruby/models/mutual_fund_holdings.rb +0 -251
- data/lib/finnhub_ruby/models/mutual_fund_holdings_data.rb +0 -289
- 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 -238
- 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/search_body.rb +0 -434
- data/lib/finnhub_ruby/models/search_filter.rb +0 -229
- data/lib/finnhub_ruby/models/search_response.rb +0 -251
- 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/bond_yield_curve_info_spec.rb +0 -40
- data/spec/models/bond_yield_curve_spec.rb +0 -40
- 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/congressional_trading_spec.rb +0 -40
- data/spec/models/congressional_transaction_spec.rb +0 -88
- 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/document_response_spec.rb +0 -64
- 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/excerpt_response_spec.rb +0 -52
- data/spec/models/fda_comittee_meeting_spec.rb +0 -52
- data/spec/models/filing_response_spec.rb +0 -106
- 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/in_filing_response_spec.rb +0 -112
- data/spec/models/in_filing_search_body_spec.rb +0 -40
- 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_eet_pai_spec.rb +0 -40
- data/spec/models/mutual_fund_eet_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/search_body_spec.rb +0 -160
- data/spec/models/search_filter_spec.rb +0 -40
- data/spec/models/search_response_spec.rb +0 -52
- 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,6 +5,7 @@ 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 |
|
@@ -17,6 +18,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
17
18
|
| [**company_eps_estimates**](DefaultApi.md#company_eps_estimates) | **GET** /stock/eps-estimate | Earnings Estimates |
|
18
19
|
| [**company_esg_score**](DefaultApi.md#company_esg_score) | **GET** /stock/esg | Company ESG Scores |
|
19
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 |
|
20
22
|
| [**company_news**](DefaultApi.md#company_news) | **GET** /company-news | Company News |
|
21
23
|
| [**company_peers**](DefaultApi.md#company_peers) | **GET** /stock/peers | Peers |
|
22
24
|
| [**company_profile**](DefaultApi.md#company_profile) | **GET** /stock/profile | Company Profile |
|
@@ -47,6 +49,8 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
47
49
|
| [**forex_rates**](DefaultApi.md#forex_rates) | **GET** /forex/rates | Forex rates |
|
48
50
|
| [**forex_symbols**](DefaultApi.md#forex_symbols) | **GET** /forex/symbol | Forex Symbol |
|
49
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 |
|
50
54
|
| [**indices_constituents**](DefaultApi.md#indices_constituents) | **GET** /index/constituents | Indices Constituents |
|
51
55
|
| [**indices_historical_constituents**](DefaultApi.md#indices_historical_constituents) | **GET** /index/historical-constituents | Indices Historical Constituents |
|
52
56
|
| [**insider_sentiment**](DefaultApi.md#insider_sentiment) | **GET** /stock/insider-sentiment | Insider Sentiment |
|
@@ -54,10 +58,13 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
54
58
|
| [**institutional_ownership**](DefaultApi.md#institutional_ownership) | **GET** /institutional/ownership | Institutional Ownership |
|
55
59
|
| [**institutional_portfolio**](DefaultApi.md#institutional_portfolio) | **GET** /institutional/portfolio | Institutional Portfolio |
|
56
60
|
| [**institutional_profile**](DefaultApi.md#institutional_profile) | **GET** /institutional/profile | Institutional Profile |
|
61
|
+
| [**international_filings**](DefaultApi.md#international_filings) | **GET** /stock/international-filings | International Filings |
|
57
62
|
| [**investment_themes**](DefaultApi.md#investment_themes) | **GET** /stock/investment-theme | Investment Themes (Thematic Investing) |
|
58
63
|
| [**ipo_calendar**](DefaultApi.md#ipo_calendar) | **GET** /calendar/ipo | IPO Calendar |
|
59
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 |
|
60
66
|
| [**market_news**](DefaultApi.md#market_news) | **GET** /news | Market News |
|
67
|
+
| [**market_status**](DefaultApi.md#market_status) | **GET** /stock/market-status | Market Status |
|
61
68
|
| [**mutual_fund_country_exposure**](DefaultApi.md#mutual_fund_country_exposure) | **GET** /mutual-fund/country | Mutual Funds Country Exposure |
|
62
69
|
| [**mutual_fund_eet**](DefaultApi.md#mutual_fund_eet) | **GET** /mutual-fund/eet | Mutual Funds EET |
|
63
70
|
| [**mutual_fund_eet_pai**](DefaultApi.md#mutual_fund_eet_pai) | **GET** /mutual-fund/eet-pai | Mutual Funds EET PAI |
|
@@ -171,6 +178,81 @@ end
|
|
171
178
|
- **Accept**: application/json
|
172
179
|
|
173
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
|
+
|
174
256
|
## bond_price
|
175
257
|
|
176
258
|
> <BondCandles> bond_price(isin, from, to)
|
@@ -925,7 +1007,7 @@ end
|
|
925
1007
|
|
926
1008
|
Company ESG Scores
|
927
1009
|
|
928
|
-
<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>
|
929
1011
|
|
930
1012
|
### Examples
|
931
1013
|
|
@@ -1061,6 +1143,77 @@ end
|
|
1061
1143
|
- **Accept**: application/json
|
1062
1144
|
|
1063
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
|
+
|
1064
1217
|
## company_news
|
1065
1218
|
|
1066
1219
|
> <Array<CompanyNews>> company_news(symbol, from, to)
|
@@ -2233,7 +2386,7 @@ end
|
|
2233
2386
|
|
2234
2387
|
## etfs_country_exposure
|
2235
2388
|
|
2236
|
-
> <ETFsCountryExposure> etfs_country_exposure(
|
2389
|
+
> <ETFsCountryExposure> etfs_country_exposure(opts)
|
2237
2390
|
|
2238
2391
|
ETFs Country Exposure
|
2239
2392
|
|
@@ -2253,11 +2406,14 @@ FinnhubRuby.configure do |config|
|
|
2253
2406
|
end
|
2254
2407
|
|
2255
2408
|
api_instance = FinnhubRuby::DefaultApi.new
|
2256
|
-
|
2409
|
+
opts = {
|
2410
|
+
symbol: 'symbol_example', # String | ETF symbol.
|
2411
|
+
isin: 'isin_example' # String | ETF isin.
|
2412
|
+
}
|
2257
2413
|
|
2258
2414
|
begin
|
2259
2415
|
# ETFs Country Exposure
|
2260
|
-
result = api_instance.etfs_country_exposure(
|
2416
|
+
result = api_instance.etfs_country_exposure(opts)
|
2261
2417
|
p result
|
2262
2418
|
rescue FinnhubRuby::ApiError => e
|
2263
2419
|
puts "Error when calling DefaultApi->etfs_country_exposure: #{e}"
|
@@ -2268,12 +2424,12 @@ end
|
|
2268
2424
|
|
2269
2425
|
This returns an Array which contains the response data, status code and headers.
|
2270
2426
|
|
2271
|
-
> <Array(<ETFsCountryExposure>, Integer, Hash)> etfs_country_exposure_with_http_info(
|
2427
|
+
> <Array(<ETFsCountryExposure>, Integer, Hash)> etfs_country_exposure_with_http_info(opts)
|
2272
2428
|
|
2273
2429
|
```ruby
|
2274
2430
|
begin
|
2275
2431
|
# ETFs Country Exposure
|
2276
|
-
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)
|
2277
2433
|
p status_code # => 2xx
|
2278
2434
|
p headers # => { ... }
|
2279
2435
|
p data # => <ETFsCountryExposure>
|
@@ -2286,7 +2442,8 @@ end
|
|
2286
2442
|
|
2287
2443
|
| Name | Type | Description | Notes |
|
2288
2444
|
| ---- | ---- | ----------- | ----- |
|
2289
|
-
| **symbol** | **String** | ETF symbol. |
|
2445
|
+
| **symbol** | **String** | ETF symbol. | [optional] |
|
2446
|
+
| **isin** | **String** | ETF isin. | [optional] |
|
2290
2447
|
|
2291
2448
|
### Return type
|
2292
2449
|
|
@@ -2458,7 +2615,7 @@ end
|
|
2458
2615
|
|
2459
2616
|
## etfs_sector_exposure
|
2460
2617
|
|
2461
|
-
> <ETFsSectorExposure> etfs_sector_exposure(
|
2618
|
+
> <ETFsSectorExposure> etfs_sector_exposure(opts)
|
2462
2619
|
|
2463
2620
|
ETFs Sector Exposure
|
2464
2621
|
|
@@ -2478,11 +2635,14 @@ FinnhubRuby.configure do |config|
|
|
2478
2635
|
end
|
2479
2636
|
|
2480
2637
|
api_instance = FinnhubRuby::DefaultApi.new
|
2481
|
-
|
2638
|
+
opts = {
|
2639
|
+
symbol: 'symbol_example', # String | ETF symbol.
|
2640
|
+
isin: 'isin_example' # String | ETF isin.
|
2641
|
+
}
|
2482
2642
|
|
2483
2643
|
begin
|
2484
2644
|
# ETFs Sector Exposure
|
2485
|
-
result = api_instance.etfs_sector_exposure(
|
2645
|
+
result = api_instance.etfs_sector_exposure(opts)
|
2486
2646
|
p result
|
2487
2647
|
rescue FinnhubRuby::ApiError => e
|
2488
2648
|
puts "Error when calling DefaultApi->etfs_sector_exposure: #{e}"
|
@@ -2493,12 +2653,12 @@ end
|
|
2493
2653
|
|
2494
2654
|
This returns an Array which contains the response data, status code and headers.
|
2495
2655
|
|
2496
|
-
> <Array(<ETFsSectorExposure>, Integer, Hash)> etfs_sector_exposure_with_http_info(
|
2656
|
+
> <Array(<ETFsSectorExposure>, Integer, Hash)> etfs_sector_exposure_with_http_info(opts)
|
2497
2657
|
|
2498
2658
|
```ruby
|
2499
2659
|
begin
|
2500
2660
|
# ETFs Sector Exposure
|
2501
|
-
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)
|
2502
2662
|
p status_code # => 2xx
|
2503
2663
|
p headers # => { ... }
|
2504
2664
|
p data # => <ETFsSectorExposure>
|
@@ -2511,7 +2671,8 @@ end
|
|
2511
2671
|
|
2512
2672
|
| Name | Type | Description | Notes |
|
2513
2673
|
| ---- | ---- | ----------- | ----- |
|
2514
|
-
| **symbol** | **String** | ETF symbol. |
|
2674
|
+
| **symbol** | **String** | ETF symbol. | [optional] |
|
2675
|
+
| **isin** | **String** | ETF isin. | [optional] |
|
2515
2676
|
|
2516
2677
|
### Return type
|
2517
2678
|
|
@@ -2622,8 +2783,8 @@ opts = {
|
|
2622
2783
|
cik: 'cik_example', # String | CIK.
|
2623
2784
|
access_number: 'access_number_example', # String | Access number of a specific report you want to retrieve data from.
|
2624
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.
|
2625
|
-
from: Date.parse('2013-10-20'), # Date | From date:
|
2626
|
-
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.
|
2627
2788
|
}
|
2628
2789
|
|
2629
2790
|
begin
|
@@ -2661,8 +2822,8 @@ end
|
|
2661
2822
|
| **cik** | **String** | CIK. | [optional] |
|
2662
2823
|
| **access_number** | **String** | Access number of a specific report you want to retrieve data from. | [optional] |
|
2663
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] |
|
2664
|
-
| **from** | **Date** | From date:
|
2665
|
-
| **to** | **Date** | To date:
|
2825
|
+
| **from** | **Date** | From date: 2023-03-15. | [optional] |
|
2826
|
+
| **to** | **Date** | To date: 2023-03-16. | [optional] |
|
2666
2827
|
|
2667
2828
|
### Return type
|
2668
2829
|
|
@@ -3273,13 +3434,163 @@ end
|
|
3273
3434
|
- **Accept**: application/json
|
3274
3435
|
|
3275
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)
|
3541
|
+
p result
|
3542
|
+
rescue FinnhubRuby::ApiError => e
|
3543
|
+
puts "Error when calling DefaultApi->historical_market_cap: #{e}"
|
3544
|
+
end
|
3545
|
+
```
|
3546
|
+
|
3547
|
+
#### Using the historical_market_cap_with_http_info variant
|
3548
|
+
|
3549
|
+
This returns an Array which contains the response data, status code and headers.
|
3550
|
+
|
3551
|
+
> <Array(<HistoricalMarketCapData>, Integer, Hash)> historical_market_cap_with_http_info(symbol, from, to)
|
3552
|
+
|
3553
|
+
```ruby
|
3554
|
+
begin
|
3555
|
+
# Historical Market Cap
|
3556
|
+
data, status_code, headers = api_instance.historical_market_cap_with_http_info(symbol, from, to)
|
3557
|
+
p status_code # => 2xx
|
3558
|
+
p headers # => { ... }
|
3559
|
+
p data # => <HistoricalMarketCapData>
|
3560
|
+
rescue FinnhubRuby::ApiError => e
|
3561
|
+
puts "Error when calling DefaultApi->historical_market_cap_with_http_info: #{e}"
|
3562
|
+
end
|
3563
|
+
```
|
3564
|
+
|
3565
|
+
### Parameters
|
3566
|
+
|
3567
|
+
| Name | Type | Description | Notes |
|
3568
|
+
| ---- | ---- | ----------- | ----- |
|
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>. | |
|
3572
|
+
|
3573
|
+
### Return type
|
3574
|
+
|
3575
|
+
[**HistoricalMarketCapData**](HistoricalMarketCapData.md)
|
3576
|
+
|
3577
|
+
### Authorization
|
3578
|
+
|
3579
|
+
[api_key](../README.md#api_key)
|
3580
|
+
|
3581
|
+
### HTTP request headers
|
3582
|
+
|
3583
|
+
- **Content-Type**: Not defined
|
3584
|
+
- **Accept**: application/json
|
3585
|
+
|
3586
|
+
|
3276
3587
|
## indices_constituents
|
3277
3588
|
|
3278
3589
|
> <IndicesConstituents> indices_constituents(symbol)
|
3279
3590
|
|
3280
3591
|
Indices Constituents
|
3281
3592
|
|
3282
|
-
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>.
|
3283
3594
|
|
3284
3595
|
### Examples
|
3285
3596
|
|
@@ -3496,7 +3807,7 @@ end
|
|
3496
3807
|
|
3497
3808
|
Insider Transactions
|
3498
3809
|
|
3499
|
-
Company insider transactions data sourced from <code>Form 3,4,5</code>, SEDI and relevant companies' filings. This endpoint covers US, Canada, Australia, and
|
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.
|
3500
3811
|
|
3501
3812
|
### Examples
|
3502
3813
|
|
@@ -3792,6 +4103,85 @@ end
|
|
3792
4103
|
- **Accept**: application/json
|
3793
4104
|
|
3794
4105
|
|
4106
|
+
## international_filings
|
4107
|
+
|
4108
|
+
> <Array<InternationalFiling>> international_filings(opts)
|
4109
|
+
|
4110
|
+
International Filings
|
4111
|
+
|
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.
|
4113
|
+
|
4114
|
+
### Examples
|
4115
|
+
|
4116
|
+
```ruby
|
4117
|
+
require 'time'
|
4118
|
+
require 'finnhub_ruby'
|
4119
|
+
# setup authorization
|
4120
|
+
FinnhubRuby.configure do |config|
|
4121
|
+
# Configure API key authorization: api_key
|
4122
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
4123
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4124
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
4125
|
+
end
|
4126
|
+
|
4127
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
4128
|
+
opts = {
|
4129
|
+
symbol: 'symbol_example', # String | Symbol. Leave empty to list latest filings.
|
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.
|
4133
|
+
}
|
4134
|
+
|
4135
|
+
begin
|
4136
|
+
# International Filings
|
4137
|
+
result = api_instance.international_filings(opts)
|
4138
|
+
p result
|
4139
|
+
rescue FinnhubRuby::ApiError => e
|
4140
|
+
puts "Error when calling DefaultApi->international_filings: #{e}"
|
4141
|
+
end
|
4142
|
+
```
|
4143
|
+
|
4144
|
+
#### Using the international_filings_with_http_info variant
|
4145
|
+
|
4146
|
+
This returns an Array which contains the response data, status code and headers.
|
4147
|
+
|
4148
|
+
> <Array(<Array<InternationalFiling>>, Integer, Hash)> international_filings_with_http_info(opts)
|
4149
|
+
|
4150
|
+
```ruby
|
4151
|
+
begin
|
4152
|
+
# International Filings
|
4153
|
+
data, status_code, headers = api_instance.international_filings_with_http_info(opts)
|
4154
|
+
p status_code # => 2xx
|
4155
|
+
p headers # => { ... }
|
4156
|
+
p data # => <Array<InternationalFiling>>
|
4157
|
+
rescue FinnhubRuby::ApiError => e
|
4158
|
+
puts "Error when calling DefaultApi->international_filings_with_http_info: #{e}"
|
4159
|
+
end
|
4160
|
+
```
|
4161
|
+
|
4162
|
+
### Parameters
|
4163
|
+
|
4164
|
+
| Name | Type | Description | Notes |
|
4165
|
+
| ---- | ---- | ----------- | ----- |
|
4166
|
+
| **symbol** | **String** | Symbol. Leave empty to list latest filings. | [optional] |
|
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] |
|
4170
|
+
|
4171
|
+
### Return type
|
4172
|
+
|
4173
|
+
[**Array<InternationalFiling>**](InternationalFiling.md)
|
4174
|
+
|
4175
|
+
### Authorization
|
4176
|
+
|
4177
|
+
[api_key](../README.md#api_key)
|
4178
|
+
|
4179
|
+
### HTTP request headers
|
4180
|
+
|
4181
|
+
- **Content-Type**: Not defined
|
4182
|
+
- **Accept**: application/json
|
4183
|
+
|
4184
|
+
|
3795
4185
|
## investment_themes
|
3796
4186
|
|
3797
4187
|
> <InvestmentThemes> investment_themes(theme)
|
@@ -4009,6 +4399,77 @@ end
|
|
4009
4399
|
- **Accept**: application/json
|
4010
4400
|
|
4011
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
|
+
|
4012
4473
|
## market_news
|
4013
4474
|
|
4014
4475
|
> <Array<MarketNews>> market_news(category, opts)
|
@@ -4084,9 +4545,80 @@ end
|
|
4084
4545
|
- **Accept**: application/json
|
4085
4546
|
|
4086
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
|
+
|
4087
4619
|
## mutual_fund_country_exposure
|
4088
4620
|
|
4089
|
-
> <MutualFundCountryExposure> mutual_fund_country_exposure(
|
4621
|
+
> <MutualFundCountryExposure> mutual_fund_country_exposure(opts)
|
4090
4622
|
|
4091
4623
|
Mutual Funds Country Exposure
|
4092
4624
|
|
@@ -4106,11 +4638,14 @@ FinnhubRuby.configure do |config|
|
|
4106
4638
|
end
|
4107
4639
|
|
4108
4640
|
api_instance = FinnhubRuby::DefaultApi.new
|
4109
|
-
|
4641
|
+
opts = {
|
4642
|
+
symbol: 'symbol_example', # String | Symbol.
|
4643
|
+
isin: 'isin_example' # String | Fund's isin.
|
4644
|
+
}
|
4110
4645
|
|
4111
4646
|
begin
|
4112
4647
|
# Mutual Funds Country Exposure
|
4113
|
-
result = api_instance.mutual_fund_country_exposure(
|
4648
|
+
result = api_instance.mutual_fund_country_exposure(opts)
|
4114
4649
|
p result
|
4115
4650
|
rescue FinnhubRuby::ApiError => e
|
4116
4651
|
puts "Error when calling DefaultApi->mutual_fund_country_exposure: #{e}"
|
@@ -4121,12 +4656,12 @@ end
|
|
4121
4656
|
|
4122
4657
|
This returns an Array which contains the response data, status code and headers.
|
4123
4658
|
|
4124
|
-
> <Array(<MutualFundCountryExposure>, Integer, Hash)> mutual_fund_country_exposure_with_http_info(
|
4659
|
+
> <Array(<MutualFundCountryExposure>, Integer, Hash)> mutual_fund_country_exposure_with_http_info(opts)
|
4125
4660
|
|
4126
4661
|
```ruby
|
4127
4662
|
begin
|
4128
4663
|
# Mutual Funds Country Exposure
|
4129
|
-
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)
|
4130
4665
|
p status_code # => 2xx
|
4131
4666
|
p headers # => { ... }
|
4132
4667
|
p data # => <MutualFundCountryExposure>
|
@@ -4139,7 +4674,8 @@ end
|
|
4139
4674
|
|
4140
4675
|
| Name | Type | Description | Notes |
|
4141
4676
|
| ---- | ---- | ----------- | ----- |
|
4142
|
-
| **symbol** | **String** | Symbol. |
|
4677
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
4678
|
+
| **isin** | **String** | Fund's isin. | [optional] |
|
4143
4679
|
|
4144
4680
|
### Return type
|
4145
4681
|
|
@@ -4451,7 +4987,7 @@ end
|
|
4451
4987
|
|
4452
4988
|
## mutual_fund_sector_exposure
|
4453
4989
|
|
4454
|
-
> <MutualFundSectorExposure> mutual_fund_sector_exposure(
|
4990
|
+
> <MutualFundSectorExposure> mutual_fund_sector_exposure(opts)
|
4455
4991
|
|
4456
4992
|
Mutual Funds Sector Exposure
|
4457
4993
|
|
@@ -4471,11 +5007,14 @@ FinnhubRuby.configure do |config|
|
|
4471
5007
|
end
|
4472
5008
|
|
4473
5009
|
api_instance = FinnhubRuby::DefaultApi.new
|
4474
|
-
|
5010
|
+
opts = {
|
5011
|
+
symbol: 'symbol_example', # String | Mutual Fund symbol.
|
5012
|
+
isin: 'isin_example' # String | Fund's isin.
|
5013
|
+
}
|
4475
5014
|
|
4476
5015
|
begin
|
4477
5016
|
# Mutual Funds Sector Exposure
|
4478
|
-
result = api_instance.mutual_fund_sector_exposure(
|
5017
|
+
result = api_instance.mutual_fund_sector_exposure(opts)
|
4479
5018
|
p result
|
4480
5019
|
rescue FinnhubRuby::ApiError => e
|
4481
5020
|
puts "Error when calling DefaultApi->mutual_fund_sector_exposure: #{e}"
|
@@ -4486,12 +5025,12 @@ end
|
|
4486
5025
|
|
4487
5026
|
This returns an Array which contains the response data, status code and headers.
|
4488
5027
|
|
4489
|
-
> <Array(<MutualFundSectorExposure>, Integer, Hash)> mutual_fund_sector_exposure_with_http_info(
|
5028
|
+
> <Array(<MutualFundSectorExposure>, Integer, Hash)> mutual_fund_sector_exposure_with_http_info(opts)
|
4490
5029
|
|
4491
5030
|
```ruby
|
4492
5031
|
begin
|
4493
5032
|
# Mutual Funds Sector Exposure
|
4494
|
-
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)
|
4495
5034
|
p status_code # => 2xx
|
4496
5035
|
p headers # => { ... }
|
4497
5036
|
p data # => <MutualFundSectorExposure>
|
@@ -4504,7 +5043,8 @@ end
|
|
4504
5043
|
|
4505
5044
|
| Name | Type | Description | Notes |
|
4506
5045
|
| ---- | ---- | ----------- | ----- |
|
4507
|
-
| **symbol** | **String** | Mutual Fund symbol. |
|
5046
|
+
| **symbol** | **String** | Mutual Fund symbol. | [optional] |
|
5047
|
+
| **isin** | **String** | Fund's isin. | [optional] |
|
4508
5048
|
|
4509
5049
|
### Return type
|
4510
5050
|
|
@@ -5333,7 +5873,7 @@ end
|
|
5333
5873
|
|
5334
5874
|
Social Sentiment
|
5335
5875
|
|
5336
|
-
<p>Get social sentiment for stocks on Reddit and Twitter
|
5876
|
+
<p>Get social sentiment for stocks on Reddit and Twitter.</p>
|
5337
5877
|
|
5338
5878
|
### Examples
|
5339
5879
|
|
@@ -5552,7 +6092,7 @@ end
|
|
5552
6092
|
|
5553
6093
|
Stock Candles
|
5554
6094
|
|
5555
|
-
<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>
|
5556
6096
|
|
5557
6097
|
### Examples
|
5558
6098
|
|
@@ -6010,7 +6550,7 @@ end
|
|
6010
6550
|
|
6011
6551
|
Tick Data
|
6012
6552
|
|
6013
|
-
<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>
|
6014
6554
|
|
6015
6555
|
### Examples
|
6016
6556
|
|
@@ -6525,7 +7065,7 @@ end
|
|
6525
7065
|
|
6526
7066
|
## symbol_search
|
6527
7067
|
|
6528
|
-
> <SymbolLookup> symbol_search(q)
|
7068
|
+
> <SymbolLookup> symbol_search(q, opts)
|
6529
7069
|
|
6530
7070
|
Symbol Lookup
|
6531
7071
|
|
@@ -6546,10 +7086,13 @@ end
|
|
6546
7086
|
|
6547
7087
|
api_instance = FinnhubRuby::DefaultApi.new
|
6548
7088
|
q = 'q_example' # String | Query text can be symbol, name, isin, or cusip.
|
7089
|
+
opts = {
|
7090
|
+
exchange: 'exchange_example' # String | Exchange limit.
|
7091
|
+
}
|
6549
7092
|
|
6550
7093
|
begin
|
6551
7094
|
# Symbol Lookup
|
6552
|
-
result = api_instance.symbol_search(q)
|
7095
|
+
result = api_instance.symbol_search(q, opts)
|
6553
7096
|
p result
|
6554
7097
|
rescue FinnhubRuby::ApiError => e
|
6555
7098
|
puts "Error when calling DefaultApi->symbol_search: #{e}"
|
@@ -6560,12 +7103,12 @@ end
|
|
6560
7103
|
|
6561
7104
|
This returns an Array which contains the response data, status code and headers.
|
6562
7105
|
|
6563
|
-
> <Array(<SymbolLookup>, Integer, Hash)> symbol_search_with_http_info(q)
|
7106
|
+
> <Array(<SymbolLookup>, Integer, Hash)> symbol_search_with_http_info(q, opts)
|
6564
7107
|
|
6565
7108
|
```ruby
|
6566
7109
|
begin
|
6567
7110
|
# Symbol Lookup
|
6568
|
-
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)
|
6569
7112
|
p status_code # => 2xx
|
6570
7113
|
p headers # => { ... }
|
6571
7114
|
p data # => <SymbolLookup>
|
@@ -6579,6 +7122,7 @@ end
|
|
6579
7122
|
| Name | Type | Description | Notes |
|
6580
7123
|
| ---- | ---- | ----------- | ----- |
|
6581
7124
|
| **q** | **String** | Query text can be symbol, name, isin, or cusip. | |
|
7125
|
+
| **exchange** | **String** | Exchange limit. | [optional] |
|
6582
7126
|
|
6583
7127
|
### Return type
|
6584
7128
|
|