finnhub_ruby 1.1.4 → 1.1.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +46 -12
- data/docs/CompanyESG.md +28 -0
- data/docs/CompanyExecutive.md +1 -1
- data/docs/CompanyNews.md +34 -0
- data/docs/CompanyProfile.md +1 -1
- data/docs/CovidInfo.md +1 -1
- data/docs/DefaultApi.md +214 -77
- data/docs/Development.md +1 -1
- data/docs/{Dividends2Basic.md → Dividends2.md} +3 -3
- data/docs/Dividends2Info.md +20 -0
- data/docs/ETFsCountryExposure.md +1 -1
- data/docs/ETFsHoldings.md +1 -1
- data/docs/ETFsSectorExposure.md +1 -1
- data/docs/EarningRelease.md +2 -2
- data/docs/EarningsCalendar.md +1 -1
- data/docs/EarningsCallTranscripts.md +3 -3
- data/docs/EarningsCallTranscriptsList.md +1 -1
- data/docs/EarningsEstimates.md +1 -1
- data/docs/EarningsEstimatesInfo.md +26 -0
- data/docs/EconomicCalendar.md +1 -1
- data/docs/EconomicData.md +1 -1
- data/docs/EconomicDataInfo.md +20 -0
- data/docs/FDAComitteeMeeting.md +2 -2
- data/docs/Filing.md +2 -2
- data/docs/FinancialsAsReported.md +1 -1
- data/docs/FundOwnership.md +1 -1
- data/docs/FundOwnershipInfo.md +26 -0
- data/docs/HistoricalNBBO.md +1 -1
- data/docs/IPOCalendar.md +1 -1
- data/docs/IPOEvent.md +2 -2
- data/docs/IndicesHistoricalConstituents.md +1 -1
- data/docs/InsiderTransactions.md +1 -1
- data/docs/InternationalFiling.md +1 -1
- data/docs/{InvestmentThemesThematicInvesting.md → InvestmentThemes.md} +3 -3
- data/docs/KeyCustomersSuppliers.md +13 -1
- data/docs/{News.md → MarketNews.md} +2 -2
- data/docs/MutualFundCountryExposure.md +20 -0
- data/docs/{MutualFundsHoldings.md → MutualFundHoldings.md} +3 -3
- data/docs/MutualFundHoldingsData.md +30 -0
- data/docs/{MutualFundsProfile.md → MutualFundProfile.md} +3 -3
- data/docs/MutualFundProfileData.md +58 -0
- data/docs/MutualFundSectorExposure.md +1 -1
- data/docs/Ownership.md +1 -1
- data/docs/{Investor.md → OwnershipInfo.md} +2 -2
- data/docs/{MajorPressReleases.md → PressRelease.md} +3 -3
- data/docs/PriceTarget.md +1 -1
- data/docs/RedditSentimentContent.md +1 -1
- data/docs/Report.md +4 -4
- data/docs/RevenueBreakdown.md +1 -1
- data/docs/RevenueEstimates.md +1 -1
- data/docs/RevenueEstimatesInfo.md +26 -0
- data/docs/Sentiment.md +2 -2
- data/docs/SimilarityIndex.md +1 -1
- data/docs/SimilarityIndexInfo.md +40 -0
- data/docs/SocialSentiment.md +2 -2
- data/docs/StockSymbol.md +30 -0
- data/docs/StockTranscripts.md +1 -1
- data/docs/SupplyChainRelationships.md +1 -1
- data/docs/SymbolLookup.md +1 -1
- data/docs/{Stock.md → SymbolLookupInfo.md} +2 -2
- data/docs/TickData.md +1 -1
- data/docs/Transactions.md +1 -1
- data/docs/TwitterSentimentContent.md +1 -1
- data/finnhub_ruby-1.1.7.gem +0 -0
- data/finnhub_ruby.gemspec +1 -1
- data/lib/finnhub_ruby.rb +21 -12
- data/lib/finnhub_ruby/api/default_api.rb +183 -65
- data/lib/finnhub_ruby/api_client.rb +1 -1
- data/lib/finnhub_ruby/api_error.rb +1 -1
- data/lib/finnhub_ruby/configuration.rb +1 -1
- data/lib/finnhub_ruby/models/aggregate_indicators.rb +1 -1
- data/lib/finnhub_ruby/models/basic_financials.rb +1 -1
- data/lib/finnhub_ruby/models/breakdown_item.rb +1 -1
- data/lib/finnhub_ruby/models/company.rb +1 -1
- data/lib/finnhub_ruby/models/company_esg.rb +268 -0
- data/lib/finnhub_ruby/models/company_executive.rb +2 -2
- data/lib/finnhub_ruby/models/company_news.rb +299 -0
- data/lib/finnhub_ruby/models/company_news_statistics.rb +1 -1
- data/lib/finnhub_ruby/models/company_profile.rb +2 -2
- data/lib/finnhub_ruby/models/company_profile2.rb +1 -1
- data/lib/finnhub_ruby/models/country_metadata.rb +1 -1
- data/lib/finnhub_ruby/models/covid_info.rb +2 -2
- data/lib/finnhub_ruby/models/crypto_candles.rb +1 -1
- data/lib/finnhub_ruby/models/crypto_symbol.rb +1 -1
- data/lib/finnhub_ruby/models/development.rb +2 -2
- data/lib/finnhub_ruby/models/dividends.rb +1 -1
- data/lib/finnhub_ruby/models/dividends2.rb +231 -0
- data/lib/finnhub_ruby/models/dividends2_info.rb +229 -0
- data/lib/finnhub_ruby/models/earning_release.rb +3 -3
- data/lib/finnhub_ruby/models/earning_result.rb +1 -1
- data/lib/finnhub_ruby/models/earnings_calendar.rb +2 -2
- data/lib/finnhub_ruby/models/earnings_call_transcripts.rb +4 -4
- data/lib/finnhub_ruby/models/earnings_call_transcripts_list.rb +2 -2
- data/lib/finnhub_ruby/models/earnings_estimates.rb +2 -2
- data/lib/finnhub_ruby/models/earnings_estimates_info.rb +259 -0
- data/lib/finnhub_ruby/models/economic_calendar.rb +2 -2
- data/lib/finnhub_ruby/models/economic_code.rb +1 -1
- data/lib/finnhub_ruby/models/economic_data.rb +2 -2
- data/lib/finnhub_ruby/models/economic_data_info.rb +229 -0
- data/lib/finnhub_ruby/models/economic_event.rb +1 -1
- data/lib/finnhub_ruby/models/etf_country_exposure_data.rb +1 -1
- data/lib/finnhub_ruby/models/etf_holdings_data.rb +1 -1
- data/lib/finnhub_ruby/models/etf_profile_data.rb +1 -1
- data/lib/finnhub_ruby/models/etf_sector_exposure_data.rb +1 -1
- data/lib/finnhub_ruby/models/etfs_country_exposure.rb +2 -2
- data/lib/finnhub_ruby/models/etfs_holdings.rb +2 -2
- data/lib/finnhub_ruby/models/etfs_profile.rb +1 -1
- data/lib/finnhub_ruby/models/etfs_sector_exposure.rb +2 -2
- data/lib/finnhub_ruby/models/fda_comittee_meeting.rb +3 -3
- data/lib/finnhub_ruby/models/filing.rb +3 -3
- data/lib/finnhub_ruby/models/filing_sentiment.rb +1 -1
- data/lib/finnhub_ruby/models/financial_statements.rb +1 -1
- data/lib/finnhub_ruby/models/financials_as_reported.rb +2 -2
- data/lib/finnhub_ruby/models/forex_candles.rb +1 -1
- data/lib/finnhub_ruby/models/forex_symbol.rb +1 -1
- data/lib/finnhub_ruby/models/forexrates.rb +1 -1
- data/lib/finnhub_ruby/models/fund_ownership.rb +2 -2
- data/lib/finnhub_ruby/models/fund_ownership_info.rb +259 -0
- data/lib/finnhub_ruby/models/historical_nbbo.rb +2 -2
- data/lib/finnhub_ruby/models/index_historical_constituent.rb +1 -1
- data/lib/finnhub_ruby/models/indicator.rb +1 -1
- data/lib/finnhub_ruby/models/indices_constituents.rb +1 -1
- data/lib/finnhub_ruby/models/indices_historical_constituents.rb +2 -2
- data/lib/finnhub_ruby/models/insider_transactions.rb +2 -2
- data/lib/finnhub_ruby/models/international_filing.rb +2 -2
- data/lib/finnhub_ruby/models/investment_theme_portfolio.rb +1 -1
- data/lib/finnhub_ruby/models/investment_themes.rb +231 -0
- data/lib/finnhub_ruby/models/ipo_calendar.rb +2 -2
- data/lib/finnhub_ruby/models/ipo_event.rb +3 -3
- data/lib/finnhub_ruby/models/key_customers_suppliers.rb +65 -5
- data/lib/finnhub_ruby/models/last_bid_ask.rb +1 -1
- data/lib/finnhub_ruby/models/market_news.rb +299 -0
- data/lib/finnhub_ruby/models/mutual_fund_country_exposure.rb +231 -0
- data/lib/finnhub_ruby/models/mutual_fund_country_exposure_data.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_holdings.rb +251 -0
- data/lib/finnhub_ruby/models/mutual_fund_holdings_data.rb +279 -0
- data/lib/finnhub_ruby/models/mutual_fund_profile.rb +228 -0
- data/lib/finnhub_ruby/models/mutual_fund_profile_data.rb +419 -0
- data/lib/finnhub_ruby/models/mutual_fund_sector_exposure.rb +2 -2
- data/lib/finnhub_ruby/models/mutual_fund_sector_exposure_data.rb +1 -1
- data/lib/finnhub_ruby/models/news_sentiment.rb +1 -1
- data/lib/finnhub_ruby/models/ownership.rb +2 -2
- data/lib/finnhub_ruby/models/ownership_info.rb +249 -0
- data/lib/finnhub_ruby/models/pattern_recognition.rb +1 -1
- data/lib/finnhub_ruby/models/press_release.rb +231 -0
- data/lib/finnhub_ruby/models/price_target.rb +2 -2
- data/lib/finnhub_ruby/models/quote.rb +1 -1
- data/lib/finnhub_ruby/models/recommendation_trend.rb +1 -1
- data/lib/finnhub_ruby/models/reddit_sentiment_content.rb +2 -2
- data/lib/finnhub_ruby/models/report.rb +5 -5
- data/lib/finnhub_ruby/models/revenue_breakdown.rb +2 -2
- data/lib/finnhub_ruby/models/revenue_estimates.rb +2 -2
- data/lib/finnhub_ruby/models/revenue_estimates_info.rb +259 -0
- data/lib/finnhub_ruby/models/sec_sentiment_analysis.rb +1 -1
- data/lib/finnhub_ruby/models/sentiment.rb +3 -3
- data/lib/finnhub_ruby/models/similarity_index.rb +2 -2
- data/lib/finnhub_ruby/models/similarity_index_info.rb +329 -0
- data/lib/finnhub_ruby/models/social_sentiment.rb +3 -3
- data/lib/finnhub_ruby/models/split.rb +1 -1
- data/lib/finnhub_ruby/models/stock_candles.rb +1 -1
- data/lib/finnhub_ruby/models/stock_symbol.rb +279 -0
- data/lib/finnhub_ruby/models/stock_transcripts.rb +2 -2
- data/lib/finnhub_ruby/models/supply_chain_relationships.rb +2 -2
- data/lib/finnhub_ruby/models/support_resistance.rb +1 -1
- data/lib/finnhub_ruby/models/symbol_lookup.rb +2 -2
- data/lib/finnhub_ruby/models/symbol_lookup_info.rb +249 -0
- data/lib/finnhub_ruby/models/technical_analysis.rb +1 -1
- data/lib/finnhub_ruby/models/tick_data.rb +2 -2
- data/lib/finnhub_ruby/models/transactions.rb +2 -2
- data/lib/finnhub_ruby/models/transcript_content.rb +1 -1
- data/lib/finnhub_ruby/models/transcript_participant.rb +1 -1
- data/lib/finnhub_ruby/models/trend.rb +1 -1
- data/lib/finnhub_ruby/models/twitter_sentiment_content.rb +2 -2
- data/lib/finnhub_ruby/models/upgrade_downgrade.rb +1 -1
- data/lib/finnhub_ruby/version.rb +2 -2
- data/release.sh +12 -2
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/aggregate_indicators_spec.rb +4 -11
- data/spec/models/basic_financials_spec.rb +10 -11
- data/spec/models/company_esg_spec.rb +64 -0
- data/spec/models/company_executive_spec.rb +4 -11
- data/spec/models/{news_spec.rb → company_news_spec.rb} +7 -14
- data/spec/models/company_news_statistics_spec.rb +4 -11
- data/spec/models/company_profile2_spec.rb +4 -11
- data/spec/models/company_profile_spec.rb +4 -11
- data/spec/models/company_spec.rb +4 -11
- data/spec/models/country_metadata_spec.rb +4 -11
- data/spec/models/covid_info_spec.rb +4 -11
- data/spec/models/crypto_candles_spec.rb +4 -11
- data/spec/models/crypto_symbol_spec.rb +4 -11
- data/spec/models/development_spec.rb +10 -11
- data/spec/models/dividends2_info_spec.rb +40 -0
- data/spec/models/{dividends2_basic_spec.rb → dividends2_spec.rb} +6 -6
- data/spec/models/dividends_spec.rb +4 -11
- data/spec/models/earning_estimate_spec.rb +4 -11
- data/spec/models/earning_release_spec.rb +4 -11
- data/spec/models/earning_result_spec.rb +16 -11
- data/spec/models/earnings_calendar_spec.rb +4 -11
- data/spec/models/earnings_call_transcripts_list_spec.rb +4 -11
- data/spec/models/earnings_call_transcripts_spec.rb +4 -11
- data/spec/models/earnings_estimates_info_spec.rb +58 -0
- data/spec/models/earnings_estimates_spec.rb +4 -11
- data/spec/models/economic_calendar_spec.rb +4 -11
- data/spec/models/economic_code_spec.rb +4 -11
- data/spec/models/economic_data_info_spec.rb +40 -0
- data/spec/models/economic_data_spec.rb +4 -11
- data/spec/models/economic_event_spec.rb +4 -11
- data/spec/models/estimate_spec.rb +4 -11
- data/spec/models/etf_country_exposure_data_spec.rb +4 -11
- data/spec/models/etf_holdings_data_spec.rb +28 -11
- data/spec/models/etf_sector_exposure_data_spec.rb +4 -11
- data/spec/models/filing_spec.rb +4 -11
- data/spec/models/financial_statements_spec.rb +4 -11
- data/spec/models/financials_as_reported_spec.rb +4 -11
- data/spec/models/forex_candles_spec.rb +4 -11
- data/spec/models/forex_symbol_spec.rb +4 -11
- data/spec/models/forexrates_spec.rb +4 -11
- data/spec/models/fund_ownership_info_spec.rb +58 -0
- data/spec/models/fund_ownership_spec.rb +4 -11
- data/spec/models/index_historical_constituent_spec.rb +4 -11
- data/spec/models/indicator_spec.rb +4 -11
- data/spec/models/indices_constituents_spec.rb +4 -11
- data/spec/models/indices_historical_constituents_spec.rb +4 -11
- data/spec/models/{investment_themes_thematic_investing_spec.rb → investment_themes_spec.rb} +6 -6
- data/spec/models/ipo_calendar_spec.rb +4 -11
- data/spec/models/ipo_event_spec.rb +4 -11
- data/spec/models/last_bid_ask_spec.rb +4 -11
- data/spec/models/market_news_spec.rb +82 -0
- data/spec/models/{mutual_funds_country_exposure_spec.rb → mutual_fund_country_exposure_spec.rb} +6 -6
- data/spec/models/mutual_fund_holdings_data_spec.rb +70 -0
- data/spec/models/{mutual_funds_holdings_spec.rb → mutual_fund_holdings_spec.rb} +6 -6
- data/spec/models/mutual_fund_profile_data_spec.rb +154 -0
- data/spec/models/{mutual_funds_profile_spec.rb → mutual_fund_profile_spec.rb} +6 -6
- data/spec/models/news_sentiment_spec.rb +4 -11
- data/spec/models/{investor_spec.rb → ownership_info_spec.rb} +7 -14
- data/spec/models/pattern_recognition_spec.rb +4 -11
- data/spec/models/{major_press_releases_spec.rb → press_release_spec.rb} +6 -6
- data/spec/models/price_target_spec.rb +4 -11
- data/spec/models/quote_spec.rb +16 -11
- data/spec/models/recommendation_trend_spec.rb +4 -11
- data/spec/models/report_spec.rb +4 -11
- data/spec/models/revenue_estimates_info_spec.rb +58 -0
- data/spec/models/revenue_estimates_spec.rb +4 -11
- data/spec/models/sentiment_spec.rb +4 -11
- data/spec/models/similarity_index_info_spec.rb +100 -0
- data/spec/models/similarity_index_spec.rb +4 -11
- data/spec/models/split_spec.rb +4 -11
- data/spec/models/stock_candles_spec.rb +4 -11
- data/spec/models/stock_symbol_spec.rb +70 -0
- data/spec/models/stock_transcripts_spec.rb +4 -11
- data/spec/models/support_resistance_spec.rb +4 -11
- data/spec/models/{stock_spec.rb → symbol_lookup_info_spec.rb} +7 -20
- data/spec/models/technical_analysis_spec.rb +4 -11
- data/spec/models/tick_data_spec.rb +10 -11
- data/spec/models/transcript_content_spec.rb +10 -11
- data/spec/models/transcript_participant_spec.rb +10 -11
- data/spec/models/trend_spec.rb +4 -11
- data/spec/models/upgrade_downgrade_spec.rb +4 -11
- data/spec/spec_helper.rb +1 -1
- metadata +83 -44
- data/docs/ETFsIndustryExposure.md +0 -19
- data/docs/InvestorsOwnership.md +0 -19
- data/docs/MajorDevelopments.md +0 -19
- data/docs/MutualFundsCountryExposure.md +0 -20
- data/spec/models/et_fs_country_exposure_spec.rb +0 -47
- data/spec/models/et_fs_holdings_spec.rb +0 -47
- data/spec/models/et_fs_industry_exposure_spec.rb +0 -47
- data/spec/models/et_fs_profile_spec.rb +0 -47
- data/spec/models/investors_ownership_spec.rb +0 -47
- data/spec/models/major_developments_spec.rb +0 -47
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 30d3bc7aee90a7d7aa1679fefc232458e9681cb90240381b21cac6851116f8bb
|
4
|
+
data.tar.gz: ead3196677192f69af95c29591faef8aa7e63206389d98565bdddd934dd6c9ae
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bb000372cb7719457c08da2f8488ad6d10503eac8fe3851eba71d8f9a3e3a77f35a4623d2d4a65a19a0c28625b4894ea1b62377fe2daf03825fbab959e40584a
|
7
|
+
data.tar.gz: 00ba23b45e29b9d879be159cdbc355ce48925a185dea9a50c26a5180fa1df839c1480f776bcfcbc511e2f7a19eb885925e2477fabf398cf748150abb51af26d6
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# finnhub-ruby
|
2
2
|
- API documentation: https://finnhub.io/docs/api
|
3
3
|
- API version: 1.0.0
|
4
|
-
- Package version: 1.1.
|
4
|
+
- Package version: 1.1.8
|
5
5
|
|
6
6
|
## Installation
|
7
7
|
https://rubygems.org/gems/finnhub_ruby
|
@@ -13,7 +13,7 @@ gem install finnhub_ruby
|
|
13
13
|
or in your Gemfile
|
14
14
|
|
15
15
|
```ruby
|
16
|
-
gem 'finnhub_ruby', '~> 1.1.
|
16
|
+
gem 'finnhub_ruby', '~> 1.1.8'
|
17
17
|
```
|
18
18
|
|
19
19
|
## Getting Started
|
@@ -27,7 +27,26 @@ end
|
|
27
27
|
|
28
28
|
finnhub_client = FinnhubRuby::DefaultApi.new
|
29
29
|
|
30
|
-
|
30
|
+
# Similarity Index
|
31
|
+
puts(finnhub_client.similarity_index({symbol: 'AAPL'}))
|
32
|
+
|
33
|
+
# Stock symbols
|
34
|
+
puts(finnhub_client.stock_symbols('US'))
|
35
|
+
|
36
|
+
#Symbol search
|
37
|
+
puts(finnhub_client.symbol_search('AAPL'))
|
38
|
+
|
39
|
+
# Tick Data
|
40
|
+
puts(finnhub_client.stock_tick('NFLX', '2020-03-25', 500, 0))
|
41
|
+
|
42
|
+
# NBBO
|
43
|
+
puts(finnhub_client.stock_nbbo('NFLX', '2020-03-25', 500, 0))
|
44
|
+
|
45
|
+
#Bid ask
|
46
|
+
puts(finnhub_client.stock_bidask('AAPL'))
|
47
|
+
|
48
|
+
# Forex all pairs
|
49
|
+
puts(finnhub_client.forex_rates({base: 'USD'}))
|
31
50
|
|
32
51
|
# Stock candles
|
33
52
|
puts(finnhub_client.stock_candles('AAPL', 'D', 1590988249, 1591852249))
|
@@ -36,7 +55,7 @@ puts(finnhub_client.stock_candles('AAPL', 'D', 1590988249, 1591852249))
|
|
36
55
|
puts(finnhub_client.aggregate_indicator('AAPL', 'D'))
|
37
56
|
|
38
57
|
# Basic financials
|
39
|
-
puts(finnhub_client.company_basic_financials('AAPL', '
|
58
|
+
puts(finnhub_client.company_basic_financials('AAPL', 'all'))
|
40
59
|
|
41
60
|
# Earnings surprises
|
42
61
|
puts(finnhub_client.company_earnings('TSLA', {limit: 5}))
|
@@ -74,12 +93,24 @@ puts(finnhub_client.crypto_exchanges())
|
|
74
93
|
# Crypto symbols
|
75
94
|
puts(finnhub_client.crypto_symbols('BINANCE'))
|
76
95
|
|
96
|
+
# Economic code
|
97
|
+
puts(finnhub_client.economic_code())
|
98
|
+
|
77
99
|
# Economic data
|
78
100
|
puts(finnhub_client.economic_data('MA-USA-656880'))
|
79
101
|
|
102
|
+
# Economic calendar
|
103
|
+
puts(finnhub_client.economic_calendar())
|
104
|
+
|
80
105
|
# Filings
|
81
106
|
puts(finnhub_client.filings({symbol: 'AAPL', from: "2020-01-01", to: "2020-06-11"}))
|
82
107
|
|
108
|
+
# International Filings
|
109
|
+
puts(finnhub_client.international_filings({symbol: 'AC.TO'}))
|
110
|
+
|
111
|
+
# Filings Sentiment
|
112
|
+
puts(finnhub_client.filings_sentiment('0000320193-20-000052', {}))
|
113
|
+
|
83
114
|
# Financials
|
84
115
|
puts(finnhub_client.financials('AAPL', 'bs', 'annual'))
|
85
116
|
|
@@ -89,9 +120,6 @@ puts(finnhub_client.financials_reported({symbol: 'AAPL', freq: 'annual'}))
|
|
89
120
|
# Forex exchanges
|
90
121
|
puts(finnhub_client.forex_exchanges())
|
91
122
|
|
92
|
-
# Forex all pairs
|
93
|
-
puts(finnhub_client.forex_rates({base: 'USD'}))
|
94
|
-
|
95
123
|
# Forex symbols
|
96
124
|
puts(finnhub_client.forex_symbols('OANDA'))
|
97
125
|
|
@@ -128,8 +156,11 @@ puts(finnhub_client.recommendation_trends('AAPL'))
|
|
128
156
|
# Stock dividends
|
129
157
|
puts(finnhub_client.stock_dividends('KO', '2019-01-01', '2020-01-01'))
|
130
158
|
|
159
|
+
# Stock basic dividends
|
160
|
+
puts(finnhub_client.stock_basic_dividends('KO'))
|
161
|
+
|
131
162
|
# Transcripts
|
132
|
-
puts(finnhub_client.
|
163
|
+
puts(finnhub_client.transcripts('AAPL_162777'))
|
133
164
|
|
134
165
|
# Transcripts list
|
135
166
|
puts(finnhub_client.transcripts_list('AAPL'))
|
@@ -155,9 +186,6 @@ puts(finnhub_client.forex_candles('OANDA:EUR_USD', 'D', 1590988249, 1591852249))
|
|
155
186
|
# Crypto Candles
|
156
187
|
puts(finnhub_client.crypto_candles('BINANCE:BTCUSDT', 'D', 1590988249, 1591852249))
|
157
188
|
|
158
|
-
# Tick Data
|
159
|
-
puts(finnhub_client.stock_tick_with_http_info('AAPL', '2020-03-25', 500, 0))
|
160
|
-
|
161
189
|
# Technical Indicator
|
162
190
|
puts(finnhub_client.technical_indicator("AAPL", 'D', 1583098857, 1584308457, 'rsi', {"timeperiod": 3}))
|
163
191
|
|
@@ -201,11 +229,17 @@ puts(finnhub_client.revenue_breakdown({symbol:'AAPL'}))
|
|
201
229
|
puts(finnhub_client.social_sentiment('GME'))
|
202
230
|
|
203
231
|
# Investment theme
|
204
|
-
puts(finnhub_client.
|
232
|
+
puts(finnhub_client.investment_themes('financialExchangesData'))
|
205
233
|
|
206
234
|
# Supply chain
|
207
235
|
puts(finnhub_client.supply_chain_relationships('AAPL'))
|
208
236
|
|
237
|
+
# FDA calendar
|
238
|
+
puts(finnhub_client.fda_committee_meeting_calendar())
|
239
|
+
|
240
|
+
# Company ESG
|
241
|
+
puts(finnhub_client.company_esg_score('AAPL'))
|
242
|
+
|
209
243
|
```
|
210
244
|
|
211
245
|
## License
|
data/docs/CompanyESG.md
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
# FinnhubRuby::CompanyESG
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | symbol | [optional] |
|
8
|
+
| **total_esg_score** | **Float** | Total ESG Score | [optional] |
|
9
|
+
| **environment_score** | **Float** | symbol | [optional] |
|
10
|
+
| **governance_score** | **Float** | symbol | [optional] |
|
11
|
+
| **social_score** | **Float** | symbol | [optional] |
|
12
|
+
| **data** | **Object** | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'finnhub_ruby'
|
18
|
+
|
19
|
+
instance = FinnhubRuby::CompanyESG.new(
|
20
|
+
symbol: null,
|
21
|
+
total_esg_score: null,
|
22
|
+
environment_score: null,
|
23
|
+
governance_score: null,
|
24
|
+
social_score: null,
|
25
|
+
data: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
data/docs/CompanyExecutive.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **symbol** | **String** | Company symbol. | [optional] |
|
8
|
-
| **executive** | **Array<
|
8
|
+
| **executive** | [**Array<Company>**](Company.md) | Array of company's executives and members of the Board. | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
data/docs/CompanyNews.md
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# FinnhubRuby::CompanyNews
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **category** | **String** | News category. | [optional] |
|
8
|
+
| **datetime** | **Integer** | Published time in UNIX timestamp. | [optional] |
|
9
|
+
| **headline** | **String** | News headline. | [optional] |
|
10
|
+
| **id** | **Integer** | News ID. This value can be used for <code>minId</code> params to get the latest news only. | [optional] |
|
11
|
+
| **image** | **String** | Thumbnail image URL. | [optional] |
|
12
|
+
| **related** | **String** | Related stocks and companies mentioned in the article. | [optional] |
|
13
|
+
| **source** | **String** | News source. | [optional] |
|
14
|
+
| **summary** | **String** | News summary. | [optional] |
|
15
|
+
| **url** | **String** | URL of the original article. | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'finnhub_ruby'
|
21
|
+
|
22
|
+
instance = FinnhubRuby::CompanyNews.new(
|
23
|
+
category: null,
|
24
|
+
datetime: null,
|
25
|
+
headline: null,
|
26
|
+
id: null,
|
27
|
+
image: null,
|
28
|
+
related: null,
|
29
|
+
source: null,
|
30
|
+
summary: null,
|
31
|
+
url: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
data/docs/CompanyProfile.md
CHANGED
@@ -29,7 +29,7 @@
|
|
29
29
|
| **ipo** | **Date** | IPO date. | [optional] |
|
30
30
|
| **market_capitalization** | **Float** | Market Capitalization. | [optional] |
|
31
31
|
| **share_outstanding** | **Float** | Number of oustanding shares. | [optional] |
|
32
|
-
| **employee_total** | **
|
32
|
+
| **employee_total** | **Float** | Number of employee. | [optional] |
|
33
33
|
| **logo** | **String** | Logo image. | [optional] |
|
34
34
|
| **finnhub_industry** | **String** | Finnhub industry classification. | [optional] |
|
35
35
|
|
data/docs/CovidInfo.md
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
| **state** | **String** | State. | [optional] |
|
8
8
|
| **_case** | **Float** | Number of confirmed cases. | [optional] |
|
9
9
|
| **death** | **Float** | Number of confirmed deaths. | [optional] |
|
10
|
-
| **updated** | **
|
10
|
+
| **updated** | **String** | Updated time. | [optional] |
|
11
11
|
|
12
12
|
## Example
|
13
13
|
|
data/docs/DefaultApi.md
CHANGED
@@ -8,6 +8,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
8
8
|
| [**company_basic_financials**](DefaultApi.md#company_basic_financials) | **GET** /stock/metric | Basic Financials |
|
9
9
|
| [**company_earnings**](DefaultApi.md#company_earnings) | **GET** /stock/earnings | Earnings Surprises |
|
10
10
|
| [**company_eps_estimates**](DefaultApi.md#company_eps_estimates) | **GET** /stock/eps-estimate | Earnings Estimates |
|
11
|
+
| [**company_esg_score**](DefaultApi.md#company_esg_score) | **GET** /stock/esg | Company ESG Scores |
|
11
12
|
| [**company_executive**](DefaultApi.md#company_executive) | **GET** /stock/executive | Company Executive |
|
12
13
|
| [**company_news**](DefaultApi.md#company_news) | **GET** /company-news | Company News |
|
13
14
|
| [**company_peers**](DefaultApi.md#company_peers) | **GET** /stock/peers | Peers |
|
@@ -20,7 +21,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
20
21
|
| [**crypto_exchanges**](DefaultApi.md#crypto_exchanges) | **GET** /crypto/exchange | Crypto Exchanges |
|
21
22
|
| [**crypto_symbols**](DefaultApi.md#crypto_symbols) | **GET** /crypto/symbol | Crypto Symbol |
|
22
23
|
| [**earnings_calendar**](DefaultApi.md#earnings_calendar) | **GET** /calendar/earnings | Earnings Calendar |
|
23
|
-
| [**
|
24
|
+
| [**economic_calendar**](DefaultApi.md#economic_calendar) | **GET** /calendar/economic | Economic Calendar |
|
24
25
|
| [**economic_code**](DefaultApi.md#economic_code) | **GET** /economic/code | Economic Code |
|
25
26
|
| [**economic_data**](DefaultApi.md#economic_data) | **GET** /economic | Economic Data |
|
26
27
|
| [**etfs_country_exposure**](DefaultApi.md#etfs_country_exposure) | **GET** /etf/country | ETFs Country Exposure |
|
@@ -41,13 +42,13 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
41
42
|
| [**indices_historical_constituents**](DefaultApi.md#indices_historical_constituents) | **GET** /index/historical-constituents | Indices Historical Constituents |
|
42
43
|
| [**insider_transactions**](DefaultApi.md#insider_transactions) | **GET** /stock/insider-transactions | Insider Transactions |
|
43
44
|
| [**international_filings**](DefaultApi.md#international_filings) | **GET** /stock/international-filings | International Filings |
|
44
|
-
| [**
|
45
|
+
| [**investment_themes**](DefaultApi.md#investment_themes) | **GET** /stock/investment-theme | Investment Themes (Thematic Investing) |
|
45
46
|
| [**ipo_calendar**](DefaultApi.md#ipo_calendar) | **GET** /calendar/ipo | IPO Calendar |
|
46
47
|
| [**market_news**](DefaultApi.md#market_news) | **GET** /news | Market News |
|
47
48
|
| [**mutual_fund_country_exposure**](DefaultApi.md#mutual_fund_country_exposure) | **GET** /mutual-fund/country | Mutual Funds Country Exposure |
|
48
49
|
| [**mutual_fund_holdings**](DefaultApi.md#mutual_fund_holdings) | **GET** /mutual-fund/holdings | Mutual Funds Holdings |
|
49
50
|
| [**mutual_fund_profile**](DefaultApi.md#mutual_fund_profile) | **GET** /mutual-fund/profile | Mutual Funds Profile |
|
50
|
-
| [**mutual_fund_sector_exposure**](DefaultApi.md#mutual_fund_sector_exposure) | **GET** /mutual-fund/sector | Mutual
|
51
|
+
| [**mutual_fund_sector_exposure**](DefaultApi.md#mutual_fund_sector_exposure) | **GET** /mutual-fund/sector | Mutual Funds Sector Exposure |
|
51
52
|
| [**news_sentiment**](DefaultApi.md#news_sentiment) | **GET** /news-sentiment | News Sentiment |
|
52
53
|
| [**ownership**](DefaultApi.md#ownership) | **GET** /stock/ownership | Ownership |
|
53
54
|
| [**pattern_recognition**](DefaultApi.md#pattern_recognition) | **GET** /scan/pattern | Pattern Recognition |
|
@@ -70,6 +71,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
70
71
|
| [**support_resistance**](DefaultApi.md#support_resistance) | **GET** /scan/support-resistance | Support/Resistance |
|
71
72
|
| [**symbol_search**](DefaultApi.md#symbol_search) | **GET** /search | Symbol Lookup |
|
72
73
|
| [**technical_indicator**](DefaultApi.md#technical_indicator) | **POST** /indicator | Technical Indicators |
|
74
|
+
| [**transcripts**](DefaultApi.md#transcripts) | **GET** /stock/transcripts | Earnings Call Transcripts |
|
73
75
|
| [**transcripts_list**](DefaultApi.md#transcripts_list) | **GET** /stock/transcripts/list | Earnings Call Transcripts List |
|
74
76
|
| [**upgrade_downgrade**](DefaultApi.md#upgrade_downgrade) | **GET** /stock/upgrade-downgrade | Stock Upgrade/Downgrade |
|
75
77
|
|
@@ -370,6 +372,77 @@ end
|
|
370
372
|
- **Accept**: application/json
|
371
373
|
|
372
374
|
|
375
|
+
## company_esg_score
|
376
|
+
|
377
|
+
> <CompanyESG> company_esg_score(symbol)
|
378
|
+
|
379
|
+
Company ESG Scores
|
380
|
+
|
381
|
+
<p>This endpoint provides ESG scores and important indicators for 1000+ 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>
|
382
|
+
|
383
|
+
### Examples
|
384
|
+
|
385
|
+
```ruby
|
386
|
+
require 'time'
|
387
|
+
require 'finnhub_ruby'
|
388
|
+
# setup authorization
|
389
|
+
FinnhubRuby.configure do |config|
|
390
|
+
# Configure API key authorization: api_key
|
391
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
392
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
393
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
394
|
+
end
|
395
|
+
|
396
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
397
|
+
symbol = 'symbol_example' # String | Symbol.
|
398
|
+
|
399
|
+
begin
|
400
|
+
# Company ESG Scores
|
401
|
+
result = api_instance.company_esg_score(symbol)
|
402
|
+
p result
|
403
|
+
rescue FinnhubRuby::ApiError => e
|
404
|
+
puts "Error when calling DefaultApi->company_esg_score: #{e}"
|
405
|
+
end
|
406
|
+
```
|
407
|
+
|
408
|
+
#### Using the company_esg_score_with_http_info variant
|
409
|
+
|
410
|
+
This returns an Array which contains the response data, status code and headers.
|
411
|
+
|
412
|
+
> <Array(<CompanyESG>, Integer, Hash)> company_esg_score_with_http_info(symbol)
|
413
|
+
|
414
|
+
```ruby
|
415
|
+
begin
|
416
|
+
# Company ESG Scores
|
417
|
+
data, status_code, headers = api_instance.company_esg_score_with_http_info(symbol)
|
418
|
+
p status_code # => 2xx
|
419
|
+
p headers # => { ... }
|
420
|
+
p data # => <CompanyESG>
|
421
|
+
rescue FinnhubRuby::ApiError => e
|
422
|
+
puts "Error when calling DefaultApi->company_esg_score_with_http_info: #{e}"
|
423
|
+
end
|
424
|
+
```
|
425
|
+
|
426
|
+
### Parameters
|
427
|
+
|
428
|
+
| Name | Type | Description | Notes |
|
429
|
+
| ---- | ---- | ----------- | ----- |
|
430
|
+
| **symbol** | **String** | Symbol. | |
|
431
|
+
|
432
|
+
### Return type
|
433
|
+
|
434
|
+
[**CompanyESG**](CompanyESG.md)
|
435
|
+
|
436
|
+
### Authorization
|
437
|
+
|
438
|
+
[api_key](../README.md#api_key)
|
439
|
+
|
440
|
+
### HTTP request headers
|
441
|
+
|
442
|
+
- **Content-Type**: Not defined
|
443
|
+
- **Accept**: application/json
|
444
|
+
|
445
|
+
|
373
446
|
## company_executive
|
374
447
|
|
375
448
|
> <CompanyExecutive> company_executive(symbol)
|
@@ -443,7 +516,7 @@ end
|
|
443
516
|
|
444
517
|
## company_news
|
445
518
|
|
446
|
-
> <Array<
|
519
|
+
> <Array<CompanyNews>> company_news(symbol, from, to)
|
447
520
|
|
448
521
|
Company News
|
449
522
|
|
@@ -480,7 +553,7 @@ end
|
|
480
553
|
|
481
554
|
This returns an Array which contains the response data, status code and headers.
|
482
555
|
|
483
|
-
> <Array(<Array<
|
556
|
+
> <Array(<Array<CompanyNews>>, Integer, Hash)> company_news_with_http_info(symbol, from, to)
|
484
557
|
|
485
558
|
```ruby
|
486
559
|
begin
|
@@ -488,7 +561,7 @@ begin
|
|
488
561
|
data, status_code, headers = api_instance.company_news_with_http_info(symbol, from, to)
|
489
562
|
p status_code # => 2xx
|
490
563
|
p headers # => { ... }
|
491
|
-
p data # => <Array<
|
564
|
+
p data # => <Array<CompanyNews>>
|
492
565
|
rescue FinnhubRuby::ApiError => e
|
493
566
|
puts "Error when calling DefaultApi->company_news_with_http_info: #{e}"
|
494
567
|
end
|
@@ -504,7 +577,7 @@ end
|
|
504
577
|
|
505
578
|
### Return type
|
506
579
|
|
507
|
-
[**Array<
|
580
|
+
[**Array<CompanyNews>**](CompanyNews.md)
|
508
581
|
|
509
582
|
### Authorization
|
510
583
|
|
@@ -1247,13 +1320,13 @@ end
|
|
1247
1320
|
- **Accept**: application/json
|
1248
1321
|
|
1249
1322
|
|
1250
|
-
##
|
1323
|
+
## economic_calendar
|
1251
1324
|
|
1252
|
-
> <
|
1325
|
+
> <EconomicCalendar> economic_calendar
|
1253
1326
|
|
1254
|
-
|
1327
|
+
Economic Calendar
|
1255
1328
|
|
1256
|
-
<p>Get
|
1329
|
+
<p>Get recent and upcoming economic releases.</p><p>Historical events and surprises are available for Enterprise clients.</p>
|
1257
1330
|
|
1258
1331
|
### Examples
|
1259
1332
|
|
@@ -1269,44 +1342,41 @@ FinnhubRuby.configure do |config|
|
|
1269
1342
|
end
|
1270
1343
|
|
1271
1344
|
api_instance = FinnhubRuby::DefaultApi.new
|
1272
|
-
id = 'id_example' # String | Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>.
|
1273
1345
|
|
1274
1346
|
begin
|
1275
|
-
#
|
1276
|
-
result = api_instance.
|
1347
|
+
# Economic Calendar
|
1348
|
+
result = api_instance.economic_calendar
|
1277
1349
|
p result
|
1278
1350
|
rescue FinnhubRuby::ApiError => e
|
1279
|
-
puts "Error when calling DefaultApi->
|
1351
|
+
puts "Error when calling DefaultApi->economic_calendar: #{e}"
|
1280
1352
|
end
|
1281
1353
|
```
|
1282
1354
|
|
1283
|
-
#### Using the
|
1355
|
+
#### Using the economic_calendar_with_http_info variant
|
1284
1356
|
|
1285
1357
|
This returns an Array which contains the response data, status code and headers.
|
1286
1358
|
|
1287
|
-
> <Array(<
|
1359
|
+
> <Array(<EconomicCalendar>, Integer, Hash)> economic_calendar_with_http_info
|
1288
1360
|
|
1289
1361
|
```ruby
|
1290
1362
|
begin
|
1291
|
-
#
|
1292
|
-
data, status_code, headers = api_instance.
|
1363
|
+
# Economic Calendar
|
1364
|
+
data, status_code, headers = api_instance.economic_calendar_with_http_info
|
1293
1365
|
p status_code # => 2xx
|
1294
1366
|
p headers # => { ... }
|
1295
|
-
p data # => <
|
1367
|
+
p data # => <EconomicCalendar>
|
1296
1368
|
rescue FinnhubRuby::ApiError => e
|
1297
|
-
puts "Error when calling DefaultApi->
|
1369
|
+
puts "Error when calling DefaultApi->economic_calendar_with_http_info: #{e}"
|
1298
1370
|
end
|
1299
1371
|
```
|
1300
1372
|
|
1301
1373
|
### Parameters
|
1302
1374
|
|
1303
|
-
|
1304
|
-
| ---- | ---- | ----------- | ----- |
|
1305
|
-
| **id** | **String** | Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>. | |
|
1375
|
+
This endpoint does not need any parameter.
|
1306
1376
|
|
1307
1377
|
### Return type
|
1308
1378
|
|
1309
|
-
[**
|
1379
|
+
[**EconomicCalendar**](EconomicCalendar.md)
|
1310
1380
|
|
1311
1381
|
### Authorization
|
1312
1382
|
|
@@ -2785,9 +2855,9 @@ end
|
|
2785
2855
|
- **Accept**: application/json
|
2786
2856
|
|
2787
2857
|
|
2788
|
-
##
|
2858
|
+
## investment_themes
|
2789
2859
|
|
2790
|
-
> <
|
2860
|
+
> <InvestmentThemes> investment_themes(theme)
|
2791
2861
|
|
2792
2862
|
Investment Themes (Thematic Investing)
|
2793
2863
|
|
@@ -2811,28 +2881,28 @@ theme = 'theme_example' # String | Investment theme. A full list of themes suppo
|
|
2811
2881
|
|
2812
2882
|
begin
|
2813
2883
|
# Investment Themes (Thematic Investing)
|
2814
|
-
result = api_instance.
|
2884
|
+
result = api_instance.investment_themes(theme)
|
2815
2885
|
p result
|
2816
2886
|
rescue FinnhubRuby::ApiError => e
|
2817
|
-
puts "Error when calling DefaultApi->
|
2887
|
+
puts "Error when calling DefaultApi->investment_themes: #{e}"
|
2818
2888
|
end
|
2819
2889
|
```
|
2820
2890
|
|
2821
|
-
#### Using the
|
2891
|
+
#### Using the investment_themes_with_http_info variant
|
2822
2892
|
|
2823
2893
|
This returns an Array which contains the response data, status code and headers.
|
2824
2894
|
|
2825
|
-
> <Array(<
|
2895
|
+
> <Array(<InvestmentThemes>, Integer, Hash)> investment_themes_with_http_info(theme)
|
2826
2896
|
|
2827
2897
|
```ruby
|
2828
2898
|
begin
|
2829
2899
|
# Investment Themes (Thematic Investing)
|
2830
|
-
data, status_code, headers = api_instance.
|
2900
|
+
data, status_code, headers = api_instance.investment_themes_with_http_info(theme)
|
2831
2901
|
p status_code # => 2xx
|
2832
2902
|
p headers # => { ... }
|
2833
|
-
p data # => <
|
2903
|
+
p data # => <InvestmentThemes>
|
2834
2904
|
rescue FinnhubRuby::ApiError => e
|
2835
|
-
puts "Error when calling DefaultApi->
|
2905
|
+
puts "Error when calling DefaultApi->investment_themes_with_http_info: #{e}"
|
2836
2906
|
end
|
2837
2907
|
```
|
2838
2908
|
|
@@ -2844,7 +2914,7 @@ end
|
|
2844
2914
|
|
2845
2915
|
### Return type
|
2846
2916
|
|
2847
|
-
[**
|
2917
|
+
[**InvestmentThemes**](InvestmentThemes.md)
|
2848
2918
|
|
2849
2919
|
### Authorization
|
2850
2920
|
|
@@ -2931,7 +3001,7 @@ end
|
|
2931
3001
|
|
2932
3002
|
## market_news
|
2933
3003
|
|
2934
|
-
> <Array<
|
3004
|
+
> <Array<MarketNews>> market_news(category, opts)
|
2935
3005
|
|
2936
3006
|
Market News
|
2937
3007
|
|
@@ -2953,7 +3023,7 @@ end
|
|
2953
3023
|
api_instance = FinnhubRuby::DefaultApi.new
|
2954
3024
|
category = 'category_example' # String | This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>.
|
2955
3025
|
opts = {
|
2956
|
-
min_id:
|
3026
|
+
min_id: 789 # Integer | Use this field to get only news after this ID. Default to 0
|
2957
3027
|
}
|
2958
3028
|
|
2959
3029
|
begin
|
@@ -2969,7 +3039,7 @@ end
|
|
2969
3039
|
|
2970
3040
|
This returns an Array which contains the response data, status code and headers.
|
2971
3041
|
|
2972
|
-
> <Array(<Array<
|
3042
|
+
> <Array(<Array<MarketNews>>, Integer, Hash)> market_news_with_http_info(category, opts)
|
2973
3043
|
|
2974
3044
|
```ruby
|
2975
3045
|
begin
|
@@ -2977,7 +3047,7 @@ begin
|
|
2977
3047
|
data, status_code, headers = api_instance.market_news_with_http_info(category, opts)
|
2978
3048
|
p status_code # => 2xx
|
2979
3049
|
p headers # => { ... }
|
2980
|
-
p data # => <Array<
|
3050
|
+
p data # => <Array<MarketNews>>
|
2981
3051
|
rescue FinnhubRuby::ApiError => e
|
2982
3052
|
puts "Error when calling DefaultApi->market_news_with_http_info: #{e}"
|
2983
3053
|
end
|
@@ -2988,11 +3058,11 @@ end
|
|
2988
3058
|
| Name | Type | Description | Notes |
|
2989
3059
|
| ---- | ---- | ----------- | ----- |
|
2990
3060
|
| **category** | **String** | This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>. | |
|
2991
|
-
| **min_id** | **
|
3061
|
+
| **min_id** | **Integer** | Use this field to get only news after this ID. Default to 0 | [optional] |
|
2992
3062
|
|
2993
3063
|
### Return type
|
2994
3064
|
|
2995
|
-
[**Array<
|
3065
|
+
[**Array<MarketNews>**](MarketNews.md)
|
2996
3066
|
|
2997
3067
|
### Authorization
|
2998
3068
|
|
@@ -3006,7 +3076,7 @@ end
|
|
3006
3076
|
|
3007
3077
|
## mutual_fund_country_exposure
|
3008
3078
|
|
3009
|
-
> <
|
3079
|
+
> <MutualFundCountryExposure> mutual_fund_country_exposure(symbol)
|
3010
3080
|
|
3011
3081
|
Mutual Funds Country Exposure
|
3012
3082
|
|
@@ -3041,7 +3111,7 @@ end
|
|
3041
3111
|
|
3042
3112
|
This returns an Array which contains the response data, status code and headers.
|
3043
3113
|
|
3044
|
-
> <Array(<
|
3114
|
+
> <Array(<MutualFundCountryExposure>, Integer, Hash)> mutual_fund_country_exposure_with_http_info(symbol)
|
3045
3115
|
|
3046
3116
|
```ruby
|
3047
3117
|
begin
|
@@ -3049,7 +3119,7 @@ begin
|
|
3049
3119
|
data, status_code, headers = api_instance.mutual_fund_country_exposure_with_http_info(symbol)
|
3050
3120
|
p status_code # => 2xx
|
3051
3121
|
p headers # => { ... }
|
3052
|
-
p data # => <
|
3122
|
+
p data # => <MutualFundCountryExposure>
|
3053
3123
|
rescue FinnhubRuby::ApiError => e
|
3054
3124
|
puts "Error when calling DefaultApi->mutual_fund_country_exposure_with_http_info: #{e}"
|
3055
3125
|
end
|
@@ -3063,7 +3133,7 @@ end
|
|
3063
3133
|
|
3064
3134
|
### Return type
|
3065
3135
|
|
3066
|
-
[**
|
3136
|
+
[**MutualFundCountryExposure**](MutualFundCountryExposure.md)
|
3067
3137
|
|
3068
3138
|
### Authorization
|
3069
3139
|
|
@@ -3077,7 +3147,7 @@ end
|
|
3077
3147
|
|
3078
3148
|
## mutual_fund_holdings
|
3079
3149
|
|
3080
|
-
> <
|
3150
|
+
> <MutualFundHoldings> mutual_fund_holdings(opts)
|
3081
3151
|
|
3082
3152
|
Mutual Funds Holdings
|
3083
3153
|
|
@@ -3116,7 +3186,7 @@ end
|
|
3116
3186
|
|
3117
3187
|
This returns an Array which contains the response data, status code and headers.
|
3118
3188
|
|
3119
|
-
> <Array(<
|
3189
|
+
> <Array(<MutualFundHoldings>, Integer, Hash)> mutual_fund_holdings_with_http_info(opts)
|
3120
3190
|
|
3121
3191
|
```ruby
|
3122
3192
|
begin
|
@@ -3124,7 +3194,7 @@ begin
|
|
3124
3194
|
data, status_code, headers = api_instance.mutual_fund_holdings_with_http_info(opts)
|
3125
3195
|
p status_code # => 2xx
|
3126
3196
|
p headers # => { ... }
|
3127
|
-
p data # => <
|
3197
|
+
p data # => <MutualFundHoldings>
|
3128
3198
|
rescue FinnhubRuby::ApiError => e
|
3129
3199
|
puts "Error when calling DefaultApi->mutual_fund_holdings_with_http_info: #{e}"
|
3130
3200
|
end
|
@@ -3140,7 +3210,7 @@ end
|
|
3140
3210
|
|
3141
3211
|
### Return type
|
3142
3212
|
|
3143
|
-
[**
|
3213
|
+
[**MutualFundHoldings**](MutualFundHoldings.md)
|
3144
3214
|
|
3145
3215
|
### Authorization
|
3146
3216
|
|
@@ -3154,7 +3224,7 @@ end
|
|
3154
3224
|
|
3155
3225
|
## mutual_fund_profile
|
3156
3226
|
|
3157
|
-
> <
|
3227
|
+
> <MutualFundProfile> mutual_fund_profile(opts)
|
3158
3228
|
|
3159
3229
|
Mutual Funds Profile
|
3160
3230
|
|
@@ -3192,7 +3262,7 @@ end
|
|
3192
3262
|
|
3193
3263
|
This returns an Array which contains the response data, status code and headers.
|
3194
3264
|
|
3195
|
-
> <Array(<
|
3265
|
+
> <Array(<MutualFundProfile>, Integer, Hash)> mutual_fund_profile_with_http_info(opts)
|
3196
3266
|
|
3197
3267
|
```ruby
|
3198
3268
|
begin
|
@@ -3200,7 +3270,7 @@ begin
|
|
3200
3270
|
data, status_code, headers = api_instance.mutual_fund_profile_with_http_info(opts)
|
3201
3271
|
p status_code # => 2xx
|
3202
3272
|
p headers # => { ... }
|
3203
|
-
p data # => <
|
3273
|
+
p data # => <MutualFundProfile>
|
3204
3274
|
rescue FinnhubRuby::ApiError => e
|
3205
3275
|
puts "Error when calling DefaultApi->mutual_fund_profile_with_http_info: #{e}"
|
3206
3276
|
end
|
@@ -3215,7 +3285,7 @@ end
|
|
3215
3285
|
|
3216
3286
|
### Return type
|
3217
3287
|
|
3218
|
-
[**
|
3288
|
+
[**MutualFundProfile**](MutualFundProfile.md)
|
3219
3289
|
|
3220
3290
|
### Authorization
|
3221
3291
|
|
@@ -3231,7 +3301,7 @@ end
|
|
3231
3301
|
|
3232
3302
|
> <MutualFundSectorExposure> mutual_fund_sector_exposure(symbol)
|
3233
3303
|
|
3234
|
-
Mutual
|
3304
|
+
Mutual Funds Sector Exposure
|
3235
3305
|
|
3236
3306
|
Get Mutual Funds sector exposure data.
|
3237
3307
|
|
@@ -3252,7 +3322,7 @@ api_instance = FinnhubRuby::DefaultApi.new
|
|
3252
3322
|
symbol = 'symbol_example' # String | Mutual Fund symbol.
|
3253
3323
|
|
3254
3324
|
begin
|
3255
|
-
# Mutual
|
3325
|
+
# Mutual Funds Sector Exposure
|
3256
3326
|
result = api_instance.mutual_fund_sector_exposure(symbol)
|
3257
3327
|
p result
|
3258
3328
|
rescue FinnhubRuby::ApiError => e
|
@@ -3268,7 +3338,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
3268
3338
|
|
3269
3339
|
```ruby
|
3270
3340
|
begin
|
3271
|
-
# Mutual
|
3341
|
+
# Mutual Funds Sector Exposure
|
3272
3342
|
data, status_code, headers = api_instance.mutual_fund_sector_exposure_with_http_info(symbol)
|
3273
3343
|
p status_code # => 2xx
|
3274
3344
|
p headers # => { ... }
|
@@ -3519,7 +3589,7 @@ end
|
|
3519
3589
|
|
3520
3590
|
## press_releases
|
3521
3591
|
|
3522
|
-
> <
|
3592
|
+
> <PressRelease> press_releases(symbol, opts)
|
3523
3593
|
|
3524
3594
|
Major Press Releases
|
3525
3595
|
|
@@ -3558,7 +3628,7 @@ end
|
|
3558
3628
|
|
3559
3629
|
This returns an Array which contains the response data, status code and headers.
|
3560
3630
|
|
3561
|
-
> <Array(<
|
3631
|
+
> <Array(<PressRelease>, Integer, Hash)> press_releases_with_http_info(symbol, opts)
|
3562
3632
|
|
3563
3633
|
```ruby
|
3564
3634
|
begin
|
@@ -3566,7 +3636,7 @@ begin
|
|
3566
3636
|
data, status_code, headers = api_instance.press_releases_with_http_info(symbol, opts)
|
3567
3637
|
p status_code # => 2xx
|
3568
3638
|
p headers # => { ... }
|
3569
|
-
p data # => <
|
3639
|
+
p data # => <PressRelease>
|
3570
3640
|
rescue FinnhubRuby::ApiError => e
|
3571
3641
|
puts "Error when calling DefaultApi->press_releases_with_http_info: #{e}"
|
3572
3642
|
end
|
@@ -3582,7 +3652,7 @@ end
|
|
3582
3652
|
|
3583
3653
|
### Return type
|
3584
3654
|
|
3585
|
-
[**
|
3655
|
+
[**PressRelease**](PressRelease.md)
|
3586
3656
|
|
3587
3657
|
### Authorization
|
3588
3658
|
|
@@ -4038,7 +4108,7 @@ end
|
|
4038
4108
|
|
4039
4109
|
## stock_basic_dividends
|
4040
4110
|
|
4041
|
-
> <
|
4111
|
+
> <Dividends2> stock_basic_dividends(symbol)
|
4042
4112
|
|
4043
4113
|
Dividends 2 (Basic)
|
4044
4114
|
|
@@ -4073,7 +4143,7 @@ end
|
|
4073
4143
|
|
4074
4144
|
This returns an Array which contains the response data, status code and headers.
|
4075
4145
|
|
4076
|
-
> <Array(<
|
4146
|
+
> <Array(<Dividends2>, Integer, Hash)> stock_basic_dividends_with_http_info(symbol)
|
4077
4147
|
|
4078
4148
|
```ruby
|
4079
4149
|
begin
|
@@ -4081,7 +4151,7 @@ begin
|
|
4081
4151
|
data, status_code, headers = api_instance.stock_basic_dividends_with_http_info(symbol)
|
4082
4152
|
p status_code # => 2xx
|
4083
4153
|
p headers # => { ... }
|
4084
|
-
p data # => <
|
4154
|
+
p data # => <Dividends2>
|
4085
4155
|
rescue FinnhubRuby::ApiError => e
|
4086
4156
|
puts "Error when calling DefaultApi->stock_basic_dividends_with_http_info: #{e}"
|
4087
4157
|
end
|
@@ -4095,7 +4165,7 @@ end
|
|
4095
4165
|
|
4096
4166
|
### Return type
|
4097
4167
|
|
4098
|
-
[**
|
4168
|
+
[**Dividends2**](Dividends2.md)
|
4099
4169
|
|
4100
4170
|
### Authorization
|
4101
4171
|
|
@@ -4180,11 +4250,11 @@ end
|
|
4180
4250
|
|
4181
4251
|
## stock_candles
|
4182
4252
|
|
4183
|
-
> <StockCandles> stock_candles(symbol, resolution, from, to
|
4253
|
+
> <StockCandles> stock_candles(symbol, resolution, from, to)
|
4184
4254
|
|
4185
4255
|
Stock Candles
|
4186
4256
|
|
4187
|
-
<p>Get candlestick data (OHLCV) for stocks
|
4257
|
+
<p>Get candlestick data (OHLCV) for stocks.</p><p>Daily data will be adjusted for Splits. Intraday data will remain unadjusted.</p>
|
4188
4258
|
|
4189
4259
|
### Examples
|
4190
4260
|
|
@@ -4204,13 +4274,10 @@ symbol = 'symbol_example' # String | Symbol.
|
|
4204
4274
|
resolution = 'resolution_example' # String | Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.
|
4205
4275
|
from = 789 # Integer | UNIX timestamp. Interval initial value.
|
4206
4276
|
to = 789 # Integer | UNIX timestamp. Interval end value.
|
4207
|
-
opts = {
|
4208
|
-
adjusted: 'adjusted_example' # String | DEPRECATED: this option has been deprecated. All Daily data will be adjusted for Splits and intraday data will remain unadjusted.
|
4209
|
-
}
|
4210
4277
|
|
4211
4278
|
begin
|
4212
4279
|
# Stock Candles
|
4213
|
-
result = api_instance.stock_candles(symbol, resolution, from, to
|
4280
|
+
result = api_instance.stock_candles(symbol, resolution, from, to)
|
4214
4281
|
p result
|
4215
4282
|
rescue FinnhubRuby::ApiError => e
|
4216
4283
|
puts "Error when calling DefaultApi->stock_candles: #{e}"
|
@@ -4221,12 +4288,12 @@ end
|
|
4221
4288
|
|
4222
4289
|
This returns an Array which contains the response data, status code and headers.
|
4223
4290
|
|
4224
|
-
> <Array(<StockCandles>, Integer, Hash)> stock_candles_with_http_info(symbol, resolution, from, to
|
4291
|
+
> <Array(<StockCandles>, Integer, Hash)> stock_candles_with_http_info(symbol, resolution, from, to)
|
4225
4292
|
|
4226
4293
|
```ruby
|
4227
4294
|
begin
|
4228
4295
|
# Stock Candles
|
4229
|
-
data, status_code, headers = api_instance.stock_candles_with_http_info(symbol, resolution, from, to
|
4296
|
+
data, status_code, headers = api_instance.stock_candles_with_http_info(symbol, resolution, from, to)
|
4230
4297
|
p status_code # => 2xx
|
4231
4298
|
p headers # => { ... }
|
4232
4299
|
p data # => <StockCandles>
|
@@ -4243,7 +4310,6 @@ end
|
|
4243
4310
|
| **resolution** | **String** | Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange. | |
|
4244
4311
|
| **from** | **Integer** | UNIX timestamp. Interval initial value. | |
|
4245
4312
|
| **to** | **Integer** | UNIX timestamp. Interval end value. | |
|
4246
|
-
| **adjusted** | **String** | DEPRECATED: this option has been deprecated. All Daily data will be adjusted for Splits and intraday data will remain unadjusted. | [optional] |
|
4247
4313
|
|
4248
4314
|
### Return type
|
4249
4315
|
|
@@ -4488,7 +4554,7 @@ end
|
|
4488
4554
|
|
4489
4555
|
## stock_symbols
|
4490
4556
|
|
4491
|
-
> <Array<
|
4557
|
+
> <Array<StockSymbol>> stock_symbols(exchange, opts)
|
4492
4558
|
|
4493
4559
|
Stock Symbol
|
4494
4560
|
|
@@ -4528,7 +4594,7 @@ end
|
|
4528
4594
|
|
4529
4595
|
This returns an Array which contains the response data, status code and headers.
|
4530
4596
|
|
4531
|
-
> <Array(<Array<
|
4597
|
+
> <Array(<Array<StockSymbol>>, Integer, Hash)> stock_symbols_with_http_info(exchange, opts)
|
4532
4598
|
|
4533
4599
|
```ruby
|
4534
4600
|
begin
|
@@ -4536,7 +4602,7 @@ begin
|
|
4536
4602
|
data, status_code, headers = api_instance.stock_symbols_with_http_info(exchange, opts)
|
4537
4603
|
p status_code # => 2xx
|
4538
4604
|
p headers # => { ... }
|
4539
|
-
p data # => <Array<
|
4605
|
+
p data # => <Array<StockSymbol>>
|
4540
4606
|
rescue FinnhubRuby::ApiError => e
|
4541
4607
|
puts "Error when calling DefaultApi->stock_symbols_with_http_info: #{e}"
|
4542
4608
|
end
|
@@ -4553,7 +4619,7 @@ end
|
|
4553
4619
|
|
4554
4620
|
### Return type
|
4555
4621
|
|
4556
|
-
[**Array<
|
4622
|
+
[**Array<StockSymbol>**](StockSymbol.md)
|
4557
4623
|
|
4558
4624
|
### Authorization
|
4559
4625
|
|
@@ -4940,6 +5006,77 @@ end
|
|
4940
5006
|
- **Accept**: application/json
|
4941
5007
|
|
4942
5008
|
|
5009
|
+
## transcripts
|
5010
|
+
|
5011
|
+
> <EarningsCallTranscripts> transcripts(id)
|
5012
|
+
|
5013
|
+
Earnings Call Transcripts
|
5014
|
+
|
5015
|
+
<p>Get earnings call transcripts, audio and participants' list. This endpoint is only available for US, UK, and Candian companies. <p>15+ years of data is available with 220,000+ audio which add up to 7TB in size.</p>
|
5016
|
+
|
5017
|
+
### Examples
|
5018
|
+
|
5019
|
+
```ruby
|
5020
|
+
require 'time'
|
5021
|
+
require 'finnhub_ruby'
|
5022
|
+
# setup authorization
|
5023
|
+
FinnhubRuby.configure do |config|
|
5024
|
+
# Configure API key authorization: api_key
|
5025
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
5026
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
5027
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
5028
|
+
end
|
5029
|
+
|
5030
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
5031
|
+
id = 'id_example' # String | Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>.
|
5032
|
+
|
5033
|
+
begin
|
5034
|
+
# Earnings Call Transcripts
|
5035
|
+
result = api_instance.transcripts(id)
|
5036
|
+
p result
|
5037
|
+
rescue FinnhubRuby::ApiError => e
|
5038
|
+
puts "Error when calling DefaultApi->transcripts: #{e}"
|
5039
|
+
end
|
5040
|
+
```
|
5041
|
+
|
5042
|
+
#### Using the transcripts_with_http_info variant
|
5043
|
+
|
5044
|
+
This returns an Array which contains the response data, status code and headers.
|
5045
|
+
|
5046
|
+
> <Array(<EarningsCallTranscripts>, Integer, Hash)> transcripts_with_http_info(id)
|
5047
|
+
|
5048
|
+
```ruby
|
5049
|
+
begin
|
5050
|
+
# Earnings Call Transcripts
|
5051
|
+
data, status_code, headers = api_instance.transcripts_with_http_info(id)
|
5052
|
+
p status_code # => 2xx
|
5053
|
+
p headers # => { ... }
|
5054
|
+
p data # => <EarningsCallTranscripts>
|
5055
|
+
rescue FinnhubRuby::ApiError => e
|
5056
|
+
puts "Error when calling DefaultApi->transcripts_with_http_info: #{e}"
|
5057
|
+
end
|
5058
|
+
```
|
5059
|
+
|
5060
|
+
### Parameters
|
5061
|
+
|
5062
|
+
| Name | Type | Description | Notes |
|
5063
|
+
| ---- | ---- | ----------- | ----- |
|
5064
|
+
| **id** | **String** | Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>. | |
|
5065
|
+
|
5066
|
+
### Return type
|
5067
|
+
|
5068
|
+
[**EarningsCallTranscripts**](EarningsCallTranscripts.md)
|
5069
|
+
|
5070
|
+
### Authorization
|
5071
|
+
|
5072
|
+
[api_key](../README.md#api_key)
|
5073
|
+
|
5074
|
+
### HTTP request headers
|
5075
|
+
|
5076
|
+
- **Content-Type**: Not defined
|
5077
|
+
- **Accept**: application/json
|
5078
|
+
|
5079
|
+
|
4943
5080
|
## transcripts_list
|
4944
5081
|
|
4945
5082
|
> <EarningsCallTranscriptsList> transcripts_list(symbol)
|