finnhub_ruby 1.1.7 → 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 +44 -14
- data/docs/CompanyESG.md +28 -0
- data/docs/DefaultApi.md +72 -0
- data/docs/KeyCustomersSuppliers.md +13 -1
- data/finnhub_ruby-1.1.7.gem +0 -0
- data/finnhub_ruby.gemspec +1 -1
- data/lib/finnhub_ruby.rb +2 -1
- data/lib/finnhub_ruby/api/default_api.rb +65 -1
- 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 +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 +1 -1
- 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 +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 +1 -1
- 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 +1 -1
- data/lib/finnhub_ruby/models/earnings_estimates_info.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/finnhub_ruby/models/revenue_estimates_info.rb +1 -1
- data/lib/finnhub_ruby/models/sec_sentiment_analysis.rb +1 -1
- data/lib/finnhub_ruby/models/sentiment.rb +1 -1
- data/lib/finnhub_ruby/models/similarity_index.rb +1 -1
- data/lib/finnhub_ruby/models/similarity_index_info.rb +1 -1
- 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 +1 -1
- 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/release.sh +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/company_esg_spec.rb +64 -0
- data/spec/spec_helper.rb +1 -1
- metadata +7 -2
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,17 +27,35 @@ end
|
|
27
27
|
|
28
28
|
finnhub_client = FinnhubRuby::DefaultApi.new
|
29
29
|
|
30
|
-
#
|
31
|
-
puts(finnhub_client.
|
30
|
+
# Similarity Index
|
31
|
+
puts(finnhub_client.similarity_index({symbol: 'AAPL'}))
|
32
32
|
|
33
33
|
# Stock symbols
|
34
34
|
puts(finnhub_client.stock_symbols('US'))
|
35
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'}))
|
50
|
+
|
51
|
+
# Stock candles
|
52
|
+
puts(finnhub_client.stock_candles('AAPL', 'D', 1590988249, 1591852249))
|
53
|
+
|
36
54
|
# Aggregate Indicators
|
37
55
|
puts(finnhub_client.aggregate_indicator('AAPL', 'D'))
|
38
56
|
|
39
57
|
# Basic financials
|
40
|
-
puts(finnhub_client.company_basic_financials('AAPL', '
|
58
|
+
puts(finnhub_client.company_basic_financials('AAPL', 'all'))
|
41
59
|
|
42
60
|
# Earnings surprises
|
43
61
|
puts(finnhub_client.company_earnings('TSLA', {limit: 5}))
|
@@ -75,12 +93,24 @@ puts(finnhub_client.crypto_exchanges())
|
|
75
93
|
# Crypto symbols
|
76
94
|
puts(finnhub_client.crypto_symbols('BINANCE'))
|
77
95
|
|
96
|
+
# Economic code
|
97
|
+
puts(finnhub_client.economic_code())
|
98
|
+
|
78
99
|
# Economic data
|
79
100
|
puts(finnhub_client.economic_data('MA-USA-656880'))
|
80
101
|
|
102
|
+
# Economic calendar
|
103
|
+
puts(finnhub_client.economic_calendar())
|
104
|
+
|
81
105
|
# Filings
|
82
106
|
puts(finnhub_client.filings({symbol: 'AAPL', from: "2020-01-01", to: "2020-06-11"}))
|
83
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
|
+
|
84
114
|
# Financials
|
85
115
|
puts(finnhub_client.financials('AAPL', 'bs', 'annual'))
|
86
116
|
|
@@ -90,9 +120,6 @@ puts(finnhub_client.financials_reported({symbol: 'AAPL', freq: 'annual'}))
|
|
90
120
|
# Forex exchanges
|
91
121
|
puts(finnhub_client.forex_exchanges())
|
92
122
|
|
93
|
-
# Forex all pairs
|
94
|
-
puts(finnhub_client.forex_rates({base: 'USD'}))
|
95
|
-
|
96
123
|
# Forex symbols
|
97
124
|
puts(finnhub_client.forex_symbols('OANDA'))
|
98
125
|
|
@@ -129,6 +156,9 @@ puts(finnhub_client.recommendation_trends('AAPL'))
|
|
129
156
|
# Stock dividends
|
130
157
|
puts(finnhub_client.stock_dividends('KO', '2019-01-01', '2020-01-01'))
|
131
158
|
|
159
|
+
# Stock basic dividends
|
160
|
+
puts(finnhub_client.stock_basic_dividends('KO'))
|
161
|
+
|
132
162
|
# Transcripts
|
133
163
|
puts(finnhub_client.transcripts('AAPL_162777'))
|
134
164
|
|
@@ -156,12 +186,6 @@ puts(finnhub_client.forex_candles('OANDA:EUR_USD', 'D', 1590988249, 1591852249))
|
|
156
186
|
# Crypto Candles
|
157
187
|
puts(finnhub_client.crypto_candles('BINANCE:BTCUSDT', 'D', 1590988249, 1591852249))
|
158
188
|
|
159
|
-
# Tick Data
|
160
|
-
puts(finnhub_client.stock_tick('AAPL', '2020-03-25', 500, 0))
|
161
|
-
|
162
|
-
# NBBO
|
163
|
-
puts(finnhub_client.stock_nbbo('NFLX', '2020-03-25', 50, 0))
|
164
|
-
|
165
189
|
# Technical Indicator
|
166
190
|
puts(finnhub_client.technical_indicator("AAPL", 'D', 1583098857, 1584308457, 'rsi', {"timeperiod": 3}))
|
167
191
|
|
@@ -210,6 +234,12 @@ puts(finnhub_client.investment_themes('financialExchangesData'))
|
|
210
234
|
# Supply chain
|
211
235
|
puts(finnhub_client.supply_chain_relationships('AAPL'))
|
212
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
|
+
|
213
243
|
```
|
214
244
|
|
215
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/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 |
|
@@ -371,6 +372,77 @@ end
|
|
371
372
|
- **Accept**: application/json
|
372
373
|
|
373
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
|
+
|
374
446
|
## company_executive
|
375
447
|
|
376
448
|
> <CompanyExecutive> company_executive(symbol)
|
@@ -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
|
|
Binary file
|
data/finnhub_ruby.gemspec
CHANGED
data/lib/finnhub_ruby.rb
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.2.
|
9
|
+
OpenAPI Generator version: 5.2.1
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -21,6 +21,7 @@ require 'finnhub_ruby/models/aggregate_indicators'
|
|
21
21
|
require 'finnhub_ruby/models/basic_financials'
|
22
22
|
require 'finnhub_ruby/models/breakdown_item'
|
23
23
|
require 'finnhub_ruby/models/company'
|
24
|
+
require 'finnhub_ruby/models/company_esg'
|
24
25
|
require 'finnhub_ruby/models/company_executive'
|
25
26
|
require 'finnhub_ruby/models/company_news'
|
26
27
|
require 'finnhub_ruby/models/company_news_statistics'
|
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.2.
|
9
|
+
OpenAPI Generator version: 5.2.1
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -295,6 +295,70 @@ module FinnhubRuby
|
|
295
295
|
return data, status_code, headers
|
296
296
|
end
|
297
297
|
|
298
|
+
# Company ESG Scores
|
299
|
+
# <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>
|
300
|
+
# @param symbol [String] Symbol.
|
301
|
+
# @param [Hash] opts the optional parameters
|
302
|
+
# @return [CompanyESG]
|
303
|
+
def company_esg_score(symbol, opts = {})
|
304
|
+
data, _status_code, _headers = company_esg_score_with_http_info(symbol, opts)
|
305
|
+
data
|
306
|
+
end
|
307
|
+
|
308
|
+
# Company ESG Scores
|
309
|
+
# <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>
|
310
|
+
# @param symbol [String] Symbol.
|
311
|
+
# @param [Hash] opts the optional parameters
|
312
|
+
# @return [Array<(CompanyESG, Integer, Hash)>] CompanyESG data, response status code and response headers
|
313
|
+
def company_esg_score_with_http_info(symbol, opts = {})
|
314
|
+
if @api_client.config.debugging
|
315
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.company_esg_score ...'
|
316
|
+
end
|
317
|
+
# verify the required parameter 'symbol' is set
|
318
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
319
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.company_esg_score"
|
320
|
+
end
|
321
|
+
# resource path
|
322
|
+
local_var_path = '/stock/esg'
|
323
|
+
|
324
|
+
# query parameters
|
325
|
+
query_params = opts[:query_params] || {}
|
326
|
+
query_params[:'symbol'] = symbol
|
327
|
+
|
328
|
+
# header parameters
|
329
|
+
header_params = opts[:header_params] || {}
|
330
|
+
# HTTP header 'Accept' (if needed)
|
331
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
332
|
+
|
333
|
+
# form parameters
|
334
|
+
form_params = opts[:form_params] || {}
|
335
|
+
|
336
|
+
# http body (model)
|
337
|
+
post_body = opts[:debug_body]
|
338
|
+
|
339
|
+
# return_type
|
340
|
+
return_type = opts[:debug_return_type] || 'CompanyESG'
|
341
|
+
|
342
|
+
# auth_names
|
343
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
344
|
+
|
345
|
+
new_options = opts.merge(
|
346
|
+
:operation => :"DefaultApi.company_esg_score",
|
347
|
+
:header_params => header_params,
|
348
|
+
:query_params => query_params,
|
349
|
+
:form_params => form_params,
|
350
|
+
:body => post_body,
|
351
|
+
:auth_names => auth_names,
|
352
|
+
:return_type => return_type
|
353
|
+
)
|
354
|
+
|
355
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
356
|
+
if @api_client.config.debugging
|
357
|
+
@api_client.config.logger.debug "API called: DefaultApi#company_esg_score\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
358
|
+
end
|
359
|
+
return data, status_code, headers
|
360
|
+
end
|
361
|
+
|
298
362
|
# Company Executive
|
299
363
|
# Get a list of company's executives and members of the Board.
|
300
364
|
# @param symbol [String] Symbol of the company: AAPL.
|