finnhub_ruby 1.1.5 → 1.1.9
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/README.md +48 -11
- data/docs/CompanyESG.md +28 -0
- data/docs/CompanyEarningsQualityScore.md +22 -0
- data/docs/CompanyEarningsQualityScoreData.md +30 -0
- data/docs/CompanyProfile.md +5 -5
- data/docs/CountryMetadata.md +5 -1
- data/docs/DefaultApi.md +155 -13
- data/docs/EarningRelease.md +2 -2
- data/docs/EarningsEstimates.md +1 -1
- data/docs/EarningsEstimatesInfo.md +26 -0
- data/docs/IPOEvent.md +2 -2
- data/docs/KeyCustomersSuppliers.md +13 -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/Transactions.md +1 -1
- data/finnhub_ruby-1.1.7.gem +0 -0
- data/finnhub_ruby-1.1.8.gem +0 -0
- data/finnhub_ruby.gemspec +1 -1
- data/lib/finnhub_ruby/api/default_api.rb +144 -12
- 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_earnings_quality_score.rb +241 -0
- data/lib/finnhub_ruby/models/company_earnings_quality_score_data.rb +279 -0
- data/lib/finnhub_ruby/models/company_esg.rb +268 -0
- data/lib/finnhub_ruby/models/company_executive.rb +1 -1
- data/lib/finnhub_ruby/models/company_news.rb +1 -1
- data/lib/finnhub_ruby/models/company_news_statistics.rb +1 -1
- data/lib/finnhub_ruby/models/company_profile.rb +6 -6
- data/lib/finnhub_ruby/models/company_profile2.rb +1 -1
- data/lib/finnhub_ruby/models/country_metadata.rb +25 -5
- data/lib/finnhub_ruby/models/covid_info.rb +1 -1
- 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 +1 -1
- data/lib/finnhub_ruby/models/dividends.rb +1 -1
- data/lib/finnhub_ruby/models/dividends2.rb +1 -1
- data/lib/finnhub_ruby/models/dividends2_info.rb +1 -1
- 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 +1 -1
- data/lib/finnhub_ruby/models/earnings_call_transcripts.rb +1 -1
- data/lib/finnhub_ruby/models/earnings_call_transcripts_list.rb +1 -1
- 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 +1 -1
- data/lib/finnhub_ruby/models/economic_code.rb +1 -1
- data/lib/finnhub_ruby/models/economic_data.rb +1 -1
- data/lib/finnhub_ruby/models/economic_data_info.rb +1 -1
- 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 +1 -1
- data/lib/finnhub_ruby/models/etfs_holdings.rb +1 -1
- data/lib/finnhub_ruby/models/etfs_profile.rb +1 -1
- data/lib/finnhub_ruby/models/etfs_sector_exposure.rb +1 -1
- data/lib/finnhub_ruby/models/fda_comittee_meeting.rb +1 -1
- data/lib/finnhub_ruby/models/filing.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/finnhub_ruby/models/fund_ownership_info.rb +1 -1
- data/lib/finnhub_ruby/models/historical_nbbo.rb +1 -1
- 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 +1 -1
- data/lib/finnhub_ruby/models/insider_transactions.rb +1 -1
- data/lib/finnhub_ruby/models/international_filing.rb +1 -1
- data/lib/finnhub_ruby/models/investment_theme_portfolio.rb +1 -1
- data/lib/finnhub_ruby/models/investment_themes.rb +1 -1
- data/lib/finnhub_ruby/models/ipo_calendar.rb +1 -1
- 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 +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_country_exposure.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_country_exposure_data.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_holdings.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_holdings_data.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_profile.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_profile_data.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_sector_exposure.rb +1 -1
- 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 +1 -1
- data/lib/finnhub_ruby/models/ownership_info.rb +1 -1
- data/lib/finnhub_ruby/models/pattern_recognition.rb +1 -1
- data/lib/finnhub_ruby/models/press_release.rb +1 -1
- data/lib/finnhub_ruby/models/price_target.rb +1 -1
- 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 +1 -1
- data/lib/finnhub_ruby/models/report.rb +1 -1
- data/lib/finnhub_ruby/models/revenue_breakdown.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/finnhub_ruby/models/stock_transcripts.rb +1 -1
- data/lib/finnhub_ruby/models/supply_chain_relationships.rb +1 -1
- data/lib/finnhub_ruby/models/support_resistance.rb +1 -1
- data/lib/finnhub_ruby/models/symbol_lookup.rb +1 -1
- data/lib/finnhub_ruby/models/symbol_lookup_info.rb +1 -1
- data/lib/finnhub_ruby/models/technical_analysis.rb +1 -1
- data/lib/finnhub_ruby/models/tick_data.rb +1 -1
- 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 +1 -1
- data/lib/finnhub_ruby/models/upgrade_downgrade.rb +1 -1
- data/lib/finnhub_ruby/version.rb +2 -2
- data/lib/finnhub_ruby.rb +7 -3
- data/release.sh +12 -7
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/company_earnings_quality_score_data_spec.rb +70 -0
- data/spec/models/company_earnings_quality_score_spec.rb +46 -0
- data/spec/models/company_esg_spec.rb +64 -0
- data/spec/models/earnings_estimates_info_spec.rb +58 -0
- data/spec/models/revenue_estimates_info_spec.rb +58 -0
- data/spec/models/similarity_index_info_spec.rb +100 -0
- data/spec/spec_helper.rb +1 -1
- metadata +28 -3
- data/finnhub_ruby-1.1.4.gem +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e61bc02c6ad4fbcb4354238607808bb403d237028a9ae13e52ec45f652510739
|
|
4
|
+
data.tar.gz: 2a894f9f4786fcd8cf97a1f3a22357945903a224c2b2cb8a81aafd3ff4d34aa8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4aa8ab5823abb0dfbfe9958da04514bdbe7d75c53dd95b8ad07664a63aa7ac66f594b9fcd6b74c6d89fbd0e31430f5c5d0bbe90bbe1c5d07c130e16e8615d79d
|
|
7
|
+
data.tar.gz: ebe8c18cbedbbcc0c88ab6b85dca6419bb893cdcf58c166e73e3fea2b23c3330a1b487a74c6047e2c3c9f60aab6e6bc2b3573418260ce87fc54e2e24d1878570
|
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.9
|
|
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.9'
|
|
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,6 +156,9 @@ 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
163
|
puts(finnhub_client.transcripts('AAPL_162777'))
|
|
133
164
|
|
|
@@ -155,11 +186,8 @@ 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
|
-
puts(finnhub_client.technical_indicator("AAPL", 'D', 1583098857, 1584308457, 'rsi', {
|
|
190
|
+
puts(finnhub_client.technical_indicator("AAPL", 'D', 1583098857, 1584308457, 'rsi', {indicator_fields:{'timeperiod': 3}}))
|
|
163
191
|
|
|
164
192
|
# Indices Constituents
|
|
165
193
|
puts(finnhub_client.indices_constituents("^GSPC"))
|
|
@@ -206,6 +234,15 @@ puts(finnhub_client.investment_themes('financialExchangesData'))
|
|
|
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
|
+
|
|
243
|
+
# Company Earnings Quality
|
|
244
|
+
puts(finnhub_client.company_earnings_quality_score('AAPL', 'quarterly'))
|
|
245
|
+
|
|
209
246
|
```
|
|
210
247
|
|
|
211
248
|
## 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** | Environment Score | [optional] |
|
|
10
|
+
| **governance_score** | **Float** | Governance Score | [optional] |
|
|
11
|
+
| **social_score** | **Float** | Social Score | [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
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FinnhubRuby::CompanyEarningsQualityScore
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **symbol** | **String** | Symbol | [optional] |
|
|
8
|
+
| **freq** | **String** | Frequency | [optional] |
|
|
9
|
+
| **data** | [**Array<CompanyEarningsQualityScoreData>**](CompanyEarningsQualityScoreData.md) | Array of earnings quality score. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'finnhub_ruby'
|
|
15
|
+
|
|
16
|
+
instance = FinnhubRuby::CompanyEarningsQualityScore.new(
|
|
17
|
+
symbol: null,
|
|
18
|
+
freq: null,
|
|
19
|
+
data: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# FinnhubRuby::CompanyEarningsQualityScoreData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **period** | **String** | Period | [optional] |
|
|
8
|
+
| **growth** | **Float** | Growth Score | [optional] |
|
|
9
|
+
| **profitability** | **Float** | Profitability Score | [optional] |
|
|
10
|
+
| **cash_generation_capital_allocation** | **Float** | Cash Generation and Capital Allocation | [optional] |
|
|
11
|
+
| **leverage** | **Float** | Leverage Score | [optional] |
|
|
12
|
+
| **score** | **Float** | Total Score | [optional] |
|
|
13
|
+
| **letter_score** | **String** | Letter Score | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'finnhub_ruby'
|
|
19
|
+
|
|
20
|
+
instance = FinnhubRuby::CompanyEarningsQualityScoreData.new(
|
|
21
|
+
period: null,
|
|
22
|
+
growth: null,
|
|
23
|
+
profitability: null,
|
|
24
|
+
cash_generation_capital_allocation: null,
|
|
25
|
+
leverage: null,
|
|
26
|
+
score: null,
|
|
27
|
+
letter_score: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
data/docs/CompanyProfile.md
CHANGED
|
@@ -12,10 +12,10 @@
|
|
|
12
12
|
| **sedol** | **String** | Sedol number. | [optional] |
|
|
13
13
|
| **description** | **String** | Company business summary. | [optional] |
|
|
14
14
|
| **exchange** | **String** | Listed exchange. | [optional] |
|
|
15
|
-
| **ggroup** | **String** |
|
|
16
|
-
| **gind** | **String** |
|
|
17
|
-
| **gsector** | **String** |
|
|
18
|
-
| **gsubind** | **String** |
|
|
15
|
+
| **ggroup** | **String** | Industry group. | [optional] |
|
|
16
|
+
| **gind** | **String** | Industry. | [optional] |
|
|
17
|
+
| **gsector** | **String** | Sector. | [optional] |
|
|
18
|
+
| **gsubind** | **String** | Sub-industry. | [optional] |
|
|
19
19
|
| **isin** | **String** | ISIN number. | [optional] |
|
|
20
20
|
| **naics_national_industry** | **String** | NAICS national industry. | [optional] |
|
|
21
21
|
| **naics** | **String** | NAICS industry. | [optional] |
|
|
@@ -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/CountryMetadata.md
CHANGED
|
@@ -10,6 +10,8 @@
|
|
|
10
10
|
| **code_no** | **String** | UN code | [optional] |
|
|
11
11
|
| **currency** | **String** | Currency name | [optional] |
|
|
12
12
|
| **currency_code** | **String** | Currency code | [optional] |
|
|
13
|
+
| **region** | **String** | Region | [optional] |
|
|
14
|
+
| **sub_region** | **String** | Sub-Region | [optional] |
|
|
13
15
|
|
|
14
16
|
## Example
|
|
15
17
|
|
|
@@ -22,7 +24,9 @@ instance = FinnhubRuby::CountryMetadata.new(
|
|
|
22
24
|
code3: null,
|
|
23
25
|
code_no: null,
|
|
24
26
|
currency: null,
|
|
25
|
-
currency_code: null
|
|
27
|
+
currency_code: null,
|
|
28
|
+
region: null,
|
|
29
|
+
sub_region: null
|
|
26
30
|
)
|
|
27
31
|
```
|
|
28
32
|
|
data/docs/DefaultApi.md
CHANGED
|
@@ -7,7 +7,9 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
|
7
7
|
| [**aggregate_indicator**](DefaultApi.md#aggregate_indicator) | **GET** /scan/technical-indicator | Aggregate Indicators |
|
|
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
|
+
| [**company_earnings_quality_score**](DefaultApi.md#company_earnings_quality_score) | **GET** /stock/earnings-quality-score | Company Earnings Quality Score |
|
|
10
11
|
| [**company_eps_estimates**](DefaultApi.md#company_eps_estimates) | **GET** /stock/eps-estimate | Earnings Estimates |
|
|
12
|
+
| [**company_esg_score**](DefaultApi.md#company_esg_score) | **GET** /stock/esg | Company ESG Scores |
|
|
11
13
|
| [**company_executive**](DefaultApi.md#company_executive) | **GET** /stock/executive | Company Executive |
|
|
12
14
|
| [**company_news**](DefaultApi.md#company_news) | **GET** /company-news | Company News |
|
|
13
15
|
| [**company_peers**](DefaultApi.md#company_peers) | **GET** /stock/peers | Peers |
|
|
@@ -296,6 +298,79 @@ end
|
|
|
296
298
|
- **Accept**: application/json
|
|
297
299
|
|
|
298
300
|
|
|
301
|
+
## company_earnings_quality_score
|
|
302
|
+
|
|
303
|
+
> <CompanyEarningsQualityScore> company_earnings_quality_score(symbol, freq)
|
|
304
|
+
|
|
305
|
+
Company Earnings Quality Score
|
|
306
|
+
|
|
307
|
+
<p>This endpoint provides Earnings Quality Score for global companies.</p><p> Earnings quality refers to the extent to which current earnings predict future earnings. \"High-quality\" earnings are expected to persist, while \"low-quality\" earnings do not. A higher score means a higher earnings quality</p><p>Finnhub uses a proprietary model which takes into consideration 4 criteria:</p> <ul style=\"list-style-type: unset; margin-left: 30px;\"><li>Profitability</li><li>Growth</li><li>Cash Generation & Capital Allocation</li><li>Leverage</li></ul><br/><p>We then compare the metrics of each company in each category against its peers in the same industry to gauge how quality its earnings is.</p>
|
|
308
|
+
|
|
309
|
+
### Examples
|
|
310
|
+
|
|
311
|
+
```ruby
|
|
312
|
+
require 'time'
|
|
313
|
+
require 'finnhub_ruby'
|
|
314
|
+
# setup authorization
|
|
315
|
+
FinnhubRuby.configure do |config|
|
|
316
|
+
# Configure API key authorization: api_key
|
|
317
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
318
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
319
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
|
320
|
+
end
|
|
321
|
+
|
|
322
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
|
323
|
+
symbol = 'symbol_example' # String | Symbol.
|
|
324
|
+
freq = 'freq_example' # String | Frequency. Currently only support <code>quarterly</code>
|
|
325
|
+
|
|
326
|
+
begin
|
|
327
|
+
# Company Earnings Quality Score
|
|
328
|
+
result = api_instance.company_earnings_quality_score(symbol, freq)
|
|
329
|
+
p result
|
|
330
|
+
rescue FinnhubRuby::ApiError => e
|
|
331
|
+
puts "Error when calling DefaultApi->company_earnings_quality_score: #{e}"
|
|
332
|
+
end
|
|
333
|
+
```
|
|
334
|
+
|
|
335
|
+
#### Using the company_earnings_quality_score_with_http_info variant
|
|
336
|
+
|
|
337
|
+
This returns an Array which contains the response data, status code and headers.
|
|
338
|
+
|
|
339
|
+
> <Array(<CompanyEarningsQualityScore>, Integer, Hash)> company_earnings_quality_score_with_http_info(symbol, freq)
|
|
340
|
+
|
|
341
|
+
```ruby
|
|
342
|
+
begin
|
|
343
|
+
# Company Earnings Quality Score
|
|
344
|
+
data, status_code, headers = api_instance.company_earnings_quality_score_with_http_info(symbol, freq)
|
|
345
|
+
p status_code # => 2xx
|
|
346
|
+
p headers # => { ... }
|
|
347
|
+
p data # => <CompanyEarningsQualityScore>
|
|
348
|
+
rescue FinnhubRuby::ApiError => e
|
|
349
|
+
puts "Error when calling DefaultApi->company_earnings_quality_score_with_http_info: #{e}"
|
|
350
|
+
end
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
### Parameters
|
|
354
|
+
|
|
355
|
+
| Name | Type | Description | Notes |
|
|
356
|
+
| ---- | ---- | ----------- | ----- |
|
|
357
|
+
| **symbol** | **String** | Symbol. | |
|
|
358
|
+
| **freq** | **String** | Frequency. Currently only support <code>quarterly</code> | |
|
|
359
|
+
|
|
360
|
+
### Return type
|
|
361
|
+
|
|
362
|
+
[**CompanyEarningsQualityScore**](CompanyEarningsQualityScore.md)
|
|
363
|
+
|
|
364
|
+
### Authorization
|
|
365
|
+
|
|
366
|
+
[api_key](../README.md#api_key)
|
|
367
|
+
|
|
368
|
+
### HTTP request headers
|
|
369
|
+
|
|
370
|
+
- **Content-Type**: Not defined
|
|
371
|
+
- **Accept**: application/json
|
|
372
|
+
|
|
373
|
+
|
|
299
374
|
## company_eps_estimates
|
|
300
375
|
|
|
301
376
|
> <EarningsEstimates> company_eps_estimates(symbol, opts)
|
|
@@ -371,6 +446,77 @@ end
|
|
|
371
446
|
- **Accept**: application/json
|
|
372
447
|
|
|
373
448
|
|
|
449
|
+
## company_esg_score
|
|
450
|
+
|
|
451
|
+
> <CompanyESG> company_esg_score(symbol)
|
|
452
|
+
|
|
453
|
+
Company ESG Scores
|
|
454
|
+
|
|
455
|
+
<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>
|
|
456
|
+
|
|
457
|
+
### Examples
|
|
458
|
+
|
|
459
|
+
```ruby
|
|
460
|
+
require 'time'
|
|
461
|
+
require 'finnhub_ruby'
|
|
462
|
+
# setup authorization
|
|
463
|
+
FinnhubRuby.configure do |config|
|
|
464
|
+
# Configure API key authorization: api_key
|
|
465
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
466
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
467
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
|
468
|
+
end
|
|
469
|
+
|
|
470
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
|
471
|
+
symbol = 'symbol_example' # String | Symbol.
|
|
472
|
+
|
|
473
|
+
begin
|
|
474
|
+
# Company ESG Scores
|
|
475
|
+
result = api_instance.company_esg_score(symbol)
|
|
476
|
+
p result
|
|
477
|
+
rescue FinnhubRuby::ApiError => e
|
|
478
|
+
puts "Error when calling DefaultApi->company_esg_score: #{e}"
|
|
479
|
+
end
|
|
480
|
+
```
|
|
481
|
+
|
|
482
|
+
#### Using the company_esg_score_with_http_info variant
|
|
483
|
+
|
|
484
|
+
This returns an Array which contains the response data, status code and headers.
|
|
485
|
+
|
|
486
|
+
> <Array(<CompanyESG>, Integer, Hash)> company_esg_score_with_http_info(symbol)
|
|
487
|
+
|
|
488
|
+
```ruby
|
|
489
|
+
begin
|
|
490
|
+
# Company ESG Scores
|
|
491
|
+
data, status_code, headers = api_instance.company_esg_score_with_http_info(symbol)
|
|
492
|
+
p status_code # => 2xx
|
|
493
|
+
p headers # => { ... }
|
|
494
|
+
p data # => <CompanyESG>
|
|
495
|
+
rescue FinnhubRuby::ApiError => e
|
|
496
|
+
puts "Error when calling DefaultApi->company_esg_score_with_http_info: #{e}"
|
|
497
|
+
end
|
|
498
|
+
```
|
|
499
|
+
|
|
500
|
+
### Parameters
|
|
501
|
+
|
|
502
|
+
| Name | Type | Description | Notes |
|
|
503
|
+
| ---- | ---- | ----------- | ----- |
|
|
504
|
+
| **symbol** | **String** | Symbol. | |
|
|
505
|
+
|
|
506
|
+
### Return type
|
|
507
|
+
|
|
508
|
+
[**CompanyESG**](CompanyESG.md)
|
|
509
|
+
|
|
510
|
+
### Authorization
|
|
511
|
+
|
|
512
|
+
[api_key](../README.md#api_key)
|
|
513
|
+
|
|
514
|
+
### HTTP request headers
|
|
515
|
+
|
|
516
|
+
- **Content-Type**: Not defined
|
|
517
|
+
- **Accept**: application/json
|
|
518
|
+
|
|
519
|
+
|
|
374
520
|
## company_executive
|
|
375
521
|
|
|
376
522
|
> <CompanyExecutive> company_executive(symbol)
|
|
@@ -523,7 +669,7 @@ end
|
|
|
523
669
|
|
|
524
670
|
Peers
|
|
525
671
|
|
|
526
|
-
Get company peers. Return a list of peers in the same country and
|
|
672
|
+
Get company peers. Return a list of peers in the same country and sub-industry
|
|
527
673
|
|
|
528
674
|
### Examples
|
|
529
675
|
|
|
@@ -2951,7 +3097,7 @@ end
|
|
|
2951
3097
|
api_instance = FinnhubRuby::DefaultApi.new
|
|
2952
3098
|
category = 'category_example' # String | This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>.
|
|
2953
3099
|
opts = {
|
|
2954
|
-
min_id:
|
|
3100
|
+
min_id: 789 # Integer | Use this field to get only news after this ID. Default to 0
|
|
2955
3101
|
}
|
|
2956
3102
|
|
|
2957
3103
|
begin
|
|
@@ -2986,7 +3132,7 @@ end
|
|
|
2986
3132
|
| Name | Type | Description | Notes |
|
|
2987
3133
|
| ---- | ---- | ----------- | ----- |
|
|
2988
3134
|
| **category** | **String** | This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>. | |
|
|
2989
|
-
| **min_id** | **
|
|
3135
|
+
| **min_id** | **Integer** | Use this field to get only news after this ID. Default to 0 | [optional] |
|
|
2990
3136
|
|
|
2991
3137
|
### Return type
|
|
2992
3138
|
|
|
@@ -4178,11 +4324,11 @@ end
|
|
|
4178
4324
|
|
|
4179
4325
|
## stock_candles
|
|
4180
4326
|
|
|
4181
|
-
> <StockCandles> stock_candles(symbol, resolution, from, to
|
|
4327
|
+
> <StockCandles> stock_candles(symbol, resolution, from, to)
|
|
4182
4328
|
|
|
4183
4329
|
Stock Candles
|
|
4184
4330
|
|
|
4185
|
-
<p>Get candlestick data (OHLCV) for stocks
|
|
4331
|
+
<p>Get candlestick data (OHLCV) for stocks.</p><p>Daily data will be adjusted for Splits. Intraday data will remain unadjusted.</p>
|
|
4186
4332
|
|
|
4187
4333
|
### Examples
|
|
4188
4334
|
|
|
@@ -4202,13 +4348,10 @@ symbol = 'symbol_example' # String | Symbol.
|
|
|
4202
4348
|
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.
|
|
4203
4349
|
from = 789 # Integer | UNIX timestamp. Interval initial value.
|
|
4204
4350
|
to = 789 # Integer | UNIX timestamp. Interval end value.
|
|
4205
|
-
opts = {
|
|
4206
|
-
adjusted: 'adjusted_example' # String | DEPRECATED: this option has been deprecated. All Daily data will be adjusted for Splits and intraday data will remain unadjusted.
|
|
4207
|
-
}
|
|
4208
4351
|
|
|
4209
4352
|
begin
|
|
4210
4353
|
# Stock Candles
|
|
4211
|
-
result = api_instance.stock_candles(symbol, resolution, from, to
|
|
4354
|
+
result = api_instance.stock_candles(symbol, resolution, from, to)
|
|
4212
4355
|
p result
|
|
4213
4356
|
rescue FinnhubRuby::ApiError => e
|
|
4214
4357
|
puts "Error when calling DefaultApi->stock_candles: #{e}"
|
|
@@ -4219,12 +4362,12 @@ end
|
|
|
4219
4362
|
|
|
4220
4363
|
This returns an Array which contains the response data, status code and headers.
|
|
4221
4364
|
|
|
4222
|
-
> <Array(<StockCandles>, Integer, Hash)> stock_candles_with_http_info(symbol, resolution, from, to
|
|
4365
|
+
> <Array(<StockCandles>, Integer, Hash)> stock_candles_with_http_info(symbol, resolution, from, to)
|
|
4223
4366
|
|
|
4224
4367
|
```ruby
|
|
4225
4368
|
begin
|
|
4226
4369
|
# Stock Candles
|
|
4227
|
-
data, status_code, headers = api_instance.stock_candles_with_http_info(symbol, resolution, from, to
|
|
4370
|
+
data, status_code, headers = api_instance.stock_candles_with_http_info(symbol, resolution, from, to)
|
|
4228
4371
|
p status_code # => 2xx
|
|
4229
4372
|
p headers # => { ... }
|
|
4230
4373
|
p data # => <StockCandles>
|
|
@@ -4241,7 +4384,6 @@ end
|
|
|
4241
4384
|
| **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. | |
|
|
4242
4385
|
| **from** | **Integer** | UNIX timestamp. Interval initial value. | |
|
|
4243
4386
|
| **to** | **Integer** | UNIX timestamp. Interval end value. | |
|
|
4244
|
-
| **adjusted** | **String** | DEPRECATED: this option has been deprecated. All Daily data will be adjusted for Splits and intraday data will remain unadjusted. | [optional] |
|
|
4245
4387
|
|
|
4246
4388
|
### Return type
|
|
4247
4389
|
|
|
@@ -4569,7 +4711,7 @@ end
|
|
|
4569
4711
|
|
|
4570
4712
|
Tick Data
|
|
4571
4713
|
|
|
4572
|
-
<p>Get historical tick data for global exchanges. You can send the request directly to our tick server at <a href=\"https://tick.finnhub.io/\">https://tick.finnhub.io/</a> with the same path and parameters or get redirected there if you call our main server.</p><p>For US market, 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><
|
|
4714
|
+
<p>Get historical tick data for global exchanges. You can send the request directly to our tick server at <a href=\"https://tick.finnhub.io/\">https://tick.finnhub.io/</a> with the same path and parameters or get redirected there if you call our main server.</p><p>For US market, 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>15 minute</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> <tr> <td class=\"text-blue\">Nasdaq Nordic & Baltic</th> <td> <ul> <li>Copenhagen (CO)</li> <li>Stockholm (ST)</li> <li>Helsinki (HE)</li> <li>Iceland (IC)</li> <li>Riga (RG)</li> <li>Tallinn (TL)</li> <li>Vilnius(VS)</li> <li>Fixed Income</li> <li>Derivatives</li> <li>Commodities</li></ul></td> <td>End-of-day</td> </tr> </tbody> </table>
|
|
4573
4715
|
|
|
4574
4716
|
### Examples
|
|
4575
4717
|
|
data/docs/EarningRelease.md
CHANGED
|
@@ -11,8 +11,8 @@
|
|
|
11
11
|
| **quarter** | **Integer** | Earnings quarter. | [optional] |
|
|
12
12
|
| **eps_estimate** | **Float** | EPS estimate. | [optional] |
|
|
13
13
|
| **eps_actual** | **Float** | EPS actual. | [optional] |
|
|
14
|
-
| **revenue_estimate** | **
|
|
15
|
-
| **revenue_actual** | **
|
|
14
|
+
| **revenue_estimate** | **Float** | Revenue estimate including Finnhub's proprietary estimates. | [optional] |
|
|
15
|
+
| **revenue_actual** | **Float** | Revenue actual. | [optional] |
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
data/docs/EarningsEstimates.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **data** | [**Array<
|
|
7
|
+
| **data** | [**Array<EarningsEstimatesInfo>**](EarningsEstimatesInfo.md) | List of estimates | [optional] |
|
|
8
8
|
| **freq** | **String** | Frequency: annual or quarterly. | [optional] |
|
|
9
9
|
| **symbol** | **String** | Company symbol. | [optional] |
|
|
10
10
|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# FinnhubRuby::EarningsEstimatesInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **eps_avg** | **Float** | Average EPS estimates including Finnhub's proprietary estimates. | [optional] |
|
|
8
|
+
| **eps_high** | **Float** | Highest estimate. | [optional] |
|
|
9
|
+
| **eps_low** | **Float** | Lowest estimate. | [optional] |
|
|
10
|
+
| **number_analysts** | **Integer** | Number of Analysts. | [optional] |
|
|
11
|
+
| **period** | **Date** | Period. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'finnhub_ruby'
|
|
17
|
+
|
|
18
|
+
instance = FinnhubRuby::EarningsEstimatesInfo.new(
|
|
19
|
+
eps_avg: null,
|
|
20
|
+
eps_high: null,
|
|
21
|
+
eps_low: null,
|
|
22
|
+
number_analysts: null,
|
|
23
|
+
period: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/IPOEvent.md
CHANGED
|
@@ -10,8 +10,8 @@
|
|
|
10
10
|
| **name** | **String** | Company's name. | [optional] |
|
|
11
11
|
| **status** | **String** | IPO status. Can take 1 of the following values: <code>expected</code>,<code>priced</code>,<code>withdrawn</code>,<code>filed</code> | [optional] |
|
|
12
12
|
| **price** | **String** | Projected price or price range. | [optional] |
|
|
13
|
-
| **number_of_shares** | **
|
|
14
|
-
| **total_shares_value** | **
|
|
13
|
+
| **number_of_shares** | **Float** | Number of shares offered during the IPO. | [optional] |
|
|
14
|
+
| **total_shares_value** | **Float** | Total shares value. | [optional] |
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -8,6 +8,12 @@
|
|
|
8
8
|
| **name** | **String** | Name | [optional] |
|
|
9
9
|
| **customer** | **Boolean** | Whether the company is a customer. | [optional] |
|
|
10
10
|
| **supplier** | **Boolean** | Whether the company is a supplier | [optional] |
|
|
11
|
+
| **one_month_correlation** | **Float** | 1-month price correlation | [optional] |
|
|
12
|
+
| **one_year_correlation** | **Float** | 1-year price correlation | [optional] |
|
|
13
|
+
| **six_month_correlation** | **Float** | 6-month price correlation | [optional] |
|
|
14
|
+
| **three_month_correlation** | **Float** | 3-month price correlation | [optional] |
|
|
15
|
+
| **two_week_correlation** | **Float** | 2-week price correlation | [optional] |
|
|
16
|
+
| **two_year_correlation** | **Float** | 2-year price correlation | [optional] |
|
|
11
17
|
|
|
12
18
|
## Example
|
|
13
19
|
|
|
@@ -18,7 +24,13 @@ instance = FinnhubRuby::KeyCustomersSuppliers.new(
|
|
|
18
24
|
symbol: null,
|
|
19
25
|
name: null,
|
|
20
26
|
customer: null,
|
|
21
|
-
supplier: null
|
|
27
|
+
supplier: null,
|
|
28
|
+
one_month_correlation: null,
|
|
29
|
+
one_year_correlation: null,
|
|
30
|
+
six_month_correlation: null,
|
|
31
|
+
three_month_correlation: null,
|
|
32
|
+
two_week_correlation: null,
|
|
33
|
+
two_year_correlation: null
|
|
22
34
|
)
|
|
23
35
|
```
|
|
24
36
|
|
data/docs/RevenueEstimates.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **data** | [**Array<
|
|
7
|
+
| **data** | [**Array<RevenueEstimatesInfo>**](RevenueEstimatesInfo.md) | List of estimates | [optional] |
|
|
8
8
|
| **freq** | **String** | Frequency: annual or quarterly. | [optional] |
|
|
9
9
|
| **symbol** | **String** | Company symbol. | [optional] |
|
|
10
10
|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# FinnhubRuby::RevenueEstimatesInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **revenue_avg** | **Float** | Average revenue estimates including Finnhub's proprietary estimates. | [optional] |
|
|
8
|
+
| **revenue_high** | **Float** | Highest estimate. | [optional] |
|
|
9
|
+
| **revenue_low** | **Float** | Lowest estimate. | [optional] |
|
|
10
|
+
| **number_analysts** | **Integer** | Number of Analysts. | [optional] |
|
|
11
|
+
| **period** | **Date** | Period. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'finnhub_ruby'
|
|
17
|
+
|
|
18
|
+
instance = FinnhubRuby::RevenueEstimatesInfo.new(
|
|
19
|
+
revenue_avg: null,
|
|
20
|
+
revenue_high: null,
|
|
21
|
+
revenue_low: null,
|
|
22
|
+
number_analysts: null,
|
|
23
|
+
period: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/Sentiment.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **bearish_percent** | **
|
|
8
|
-
| **bullish_percent** | **
|
|
7
|
+
| **bearish_percent** | **Float** | | [optional] |
|
|
8
|
+
| **bullish_percent** | **Float** | | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|