finnhub_ruby 1.1.7 → 1.1.11

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.
Files changed (151) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +56 -15
  3. data/docs/CompanyESG.md +28 -0
  4. data/docs/CompanyEarningsQualityScore.md +22 -0
  5. data/docs/CompanyEarningsQualityScoreData.md +30 -0
  6. data/docs/CompanyProfile.md +4 -4
  7. data/docs/CountryMetadata.md +5 -1
  8. data/docs/CryptoProfile.md +38 -0
  9. data/docs/DefaultApi.md +386 -9
  10. data/docs/EbitEstimates.md +22 -0
  11. data/docs/EbitEstimatesInfo.md +26 -0
  12. data/docs/EbitdaEstimates.md +22 -0
  13. data/docs/EbitdaEstimatesInfo.md +26 -0
  14. data/docs/KeyCustomersSuppliers.md +13 -1
  15. data/docs/MutualFundProfileData.md +9 -1
  16. data/docs/Transactions.md +2 -0
  17. data/finnhub_ruby-1.1.10.gem +0 -0
  18. data/finnhub_ruby-1.1.7.gem +0 -0
  19. data/finnhub_ruby-1.1.8.gem +0 -0
  20. data/finnhub_ruby-1.1.9.gem +0 -0
  21. data/finnhub_ruby.gemspec +1 -1
  22. data/lib/finnhub_ruby/api/default_api.rb +346 -7
  23. data/lib/finnhub_ruby/api_client.rb +1 -1
  24. data/lib/finnhub_ruby/api_error.rb +1 -1
  25. data/lib/finnhub_ruby/configuration.rb +1 -1
  26. data/lib/finnhub_ruby/models/aggregate_indicators.rb +1 -1
  27. data/lib/finnhub_ruby/models/basic_financials.rb +1 -1
  28. data/lib/finnhub_ruby/models/breakdown_item.rb +1 -1
  29. data/lib/finnhub_ruby/models/company.rb +1 -1
  30. data/lib/finnhub_ruby/models/company_earnings_quality_score.rb +241 -0
  31. data/lib/finnhub_ruby/models/company_earnings_quality_score_data.rb +279 -0
  32. data/lib/finnhub_ruby/models/company_esg.rb +268 -0
  33. data/lib/finnhub_ruby/models/company_executive.rb +1 -1
  34. data/lib/finnhub_ruby/models/company_news.rb +1 -1
  35. data/lib/finnhub_ruby/models/company_news_statistics.rb +1 -1
  36. data/lib/finnhub_ruby/models/company_profile.rb +5 -5
  37. data/lib/finnhub_ruby/models/company_profile2.rb +1 -1
  38. data/lib/finnhub_ruby/models/country_metadata.rb +25 -5
  39. data/lib/finnhub_ruby/models/covid_info.rb +1 -1
  40. data/lib/finnhub_ruby/models/crypto_candles.rb +1 -1
  41. data/lib/finnhub_ruby/models/crypto_profile.rb +319 -0
  42. data/lib/finnhub_ruby/models/crypto_symbol.rb +1 -1
  43. data/lib/finnhub_ruby/models/development.rb +1 -1
  44. data/lib/finnhub_ruby/models/dividends.rb +1 -1
  45. data/lib/finnhub_ruby/models/dividends2.rb +1 -1
  46. data/lib/finnhub_ruby/models/dividends2_info.rb +1 -1
  47. data/lib/finnhub_ruby/models/earning_release.rb +1 -1
  48. data/lib/finnhub_ruby/models/earning_result.rb +1 -1
  49. data/lib/finnhub_ruby/models/earnings_calendar.rb +1 -1
  50. data/lib/finnhub_ruby/models/earnings_call_transcripts.rb +1 -1
  51. data/lib/finnhub_ruby/models/earnings_call_transcripts_list.rb +1 -1
  52. data/lib/finnhub_ruby/models/earnings_estimates.rb +1 -1
  53. data/lib/finnhub_ruby/models/earnings_estimates_info.rb +1 -1
  54. data/lib/finnhub_ruby/models/ebit_estimates.rb +241 -0
  55. data/lib/finnhub_ruby/models/ebit_estimates_info.rb +259 -0
  56. data/lib/finnhub_ruby/models/ebitda_estimates.rb +241 -0
  57. data/lib/finnhub_ruby/models/ebitda_estimates_info.rb +259 -0
  58. data/lib/finnhub_ruby/models/economic_calendar.rb +1 -1
  59. data/lib/finnhub_ruby/models/economic_code.rb +1 -1
  60. data/lib/finnhub_ruby/models/economic_data.rb +1 -1
  61. data/lib/finnhub_ruby/models/economic_data_info.rb +1 -1
  62. data/lib/finnhub_ruby/models/economic_event.rb +1 -1
  63. data/lib/finnhub_ruby/models/etf_country_exposure_data.rb +1 -1
  64. data/lib/finnhub_ruby/models/etf_holdings_data.rb +1 -1
  65. data/lib/finnhub_ruby/models/etf_profile_data.rb +1 -1
  66. data/lib/finnhub_ruby/models/etf_sector_exposure_data.rb +1 -1
  67. data/lib/finnhub_ruby/models/etfs_country_exposure.rb +1 -1
  68. data/lib/finnhub_ruby/models/etfs_holdings.rb +1 -1
  69. data/lib/finnhub_ruby/models/etfs_profile.rb +1 -1
  70. data/lib/finnhub_ruby/models/etfs_sector_exposure.rb +1 -1
  71. data/lib/finnhub_ruby/models/fda_comittee_meeting.rb +1 -1
  72. data/lib/finnhub_ruby/models/filing.rb +1 -1
  73. data/lib/finnhub_ruby/models/filing_sentiment.rb +1 -1
  74. data/lib/finnhub_ruby/models/financial_statements.rb +1 -1
  75. data/lib/finnhub_ruby/models/financials_as_reported.rb +1 -1
  76. data/lib/finnhub_ruby/models/forex_candles.rb +1 -1
  77. data/lib/finnhub_ruby/models/forex_symbol.rb +1 -1
  78. data/lib/finnhub_ruby/models/forexrates.rb +1 -1
  79. data/lib/finnhub_ruby/models/fund_ownership.rb +1 -1
  80. data/lib/finnhub_ruby/models/fund_ownership_info.rb +1 -1
  81. data/lib/finnhub_ruby/models/historical_nbbo.rb +1 -1
  82. data/lib/finnhub_ruby/models/index_historical_constituent.rb +1 -1
  83. data/lib/finnhub_ruby/models/indicator.rb +1 -1
  84. data/lib/finnhub_ruby/models/indices_constituents.rb +1 -1
  85. data/lib/finnhub_ruby/models/indices_historical_constituents.rb +1 -1
  86. data/lib/finnhub_ruby/models/insider_transactions.rb +1 -1
  87. data/lib/finnhub_ruby/models/international_filing.rb +1 -1
  88. data/lib/finnhub_ruby/models/investment_theme_portfolio.rb +1 -1
  89. data/lib/finnhub_ruby/models/investment_themes.rb +1 -1
  90. data/lib/finnhub_ruby/models/ipo_calendar.rb +1 -1
  91. data/lib/finnhub_ruby/models/ipo_event.rb +1 -1
  92. data/lib/finnhub_ruby/models/key_customers_suppliers.rb +65 -5
  93. data/lib/finnhub_ruby/models/last_bid_ask.rb +1 -1
  94. data/lib/finnhub_ruby/models/market_news.rb +1 -1
  95. data/lib/finnhub_ruby/models/mutual_fund_country_exposure.rb +1 -1
  96. data/lib/finnhub_ruby/models/mutual_fund_country_exposure_data.rb +1 -1
  97. data/lib/finnhub_ruby/models/mutual_fund_holdings.rb +1 -1
  98. data/lib/finnhub_ruby/models/mutual_fund_holdings_data.rb +1 -1
  99. data/lib/finnhub_ruby/models/mutual_fund_profile.rb +1 -1
  100. data/lib/finnhub_ruby/models/mutual_fund_profile_data.rb +45 -5
  101. data/lib/finnhub_ruby/models/mutual_fund_sector_exposure.rb +1 -1
  102. data/lib/finnhub_ruby/models/mutual_fund_sector_exposure_data.rb +1 -1
  103. data/lib/finnhub_ruby/models/news_sentiment.rb +1 -1
  104. data/lib/finnhub_ruby/models/ownership.rb +1 -1
  105. data/lib/finnhub_ruby/models/ownership_info.rb +1 -1
  106. data/lib/finnhub_ruby/models/pattern_recognition.rb +1 -1
  107. data/lib/finnhub_ruby/models/press_release.rb +1 -1
  108. data/lib/finnhub_ruby/models/price_target.rb +1 -1
  109. data/lib/finnhub_ruby/models/quote.rb +1 -1
  110. data/lib/finnhub_ruby/models/recommendation_trend.rb +1 -1
  111. data/lib/finnhub_ruby/models/reddit_sentiment_content.rb +1 -1
  112. data/lib/finnhub_ruby/models/report.rb +1 -1
  113. data/lib/finnhub_ruby/models/revenue_breakdown.rb +1 -1
  114. data/lib/finnhub_ruby/models/revenue_estimates.rb +1 -1
  115. data/lib/finnhub_ruby/models/revenue_estimates_info.rb +1 -1
  116. data/lib/finnhub_ruby/models/sec_sentiment_analysis.rb +1 -1
  117. data/lib/finnhub_ruby/models/sentiment.rb +1 -1
  118. data/lib/finnhub_ruby/models/similarity_index.rb +1 -1
  119. data/lib/finnhub_ruby/models/similarity_index_info.rb +1 -1
  120. data/lib/finnhub_ruby/models/social_sentiment.rb +1 -1
  121. data/lib/finnhub_ruby/models/split.rb +1 -1
  122. data/lib/finnhub_ruby/models/stock_candles.rb +1 -1
  123. data/lib/finnhub_ruby/models/stock_symbol.rb +1 -1
  124. data/lib/finnhub_ruby/models/stock_transcripts.rb +1 -1
  125. data/lib/finnhub_ruby/models/supply_chain_relationships.rb +1 -1
  126. data/lib/finnhub_ruby/models/support_resistance.rb +1 -1
  127. data/lib/finnhub_ruby/models/symbol_lookup.rb +1 -1
  128. data/lib/finnhub_ruby/models/symbol_lookup_info.rb +1 -1
  129. data/lib/finnhub_ruby/models/technical_analysis.rb +1 -1
  130. data/lib/finnhub_ruby/models/tick_data.rb +1 -1
  131. data/lib/finnhub_ruby/models/transactions.rb +12 -2
  132. data/lib/finnhub_ruby/models/transcript_content.rb +1 -1
  133. data/lib/finnhub_ruby/models/transcript_participant.rb +1 -1
  134. data/lib/finnhub_ruby/models/trend.rb +1 -1
  135. data/lib/finnhub_ruby/models/twitter_sentiment_content.rb +1 -1
  136. data/lib/finnhub_ruby/models/upgrade_downgrade.rb +1 -1
  137. data/lib/finnhub_ruby/version.rb +2 -2
  138. data/lib/finnhub_ruby.rb +9 -1
  139. data/release.sh +1 -1
  140. data/spec/api_client_spec.rb +1 -1
  141. data/spec/configuration_spec.rb +1 -1
  142. data/spec/models/company_earnings_quality_score_data_spec.rb +70 -0
  143. data/spec/models/company_earnings_quality_score_spec.rb +46 -0
  144. data/spec/models/company_esg_spec.rb +64 -0
  145. data/spec/models/crypto_profile_spec.rb +94 -0
  146. data/spec/models/ebit_estimates_info_spec.rb +58 -0
  147. data/spec/models/ebit_estimates_spec.rb +46 -0
  148. data/spec/models/ebitda_estimates_info_spec.rb +58 -0
  149. data/spec/models/ebitda_estimates_spec.rb +46 -0
  150. data/spec/spec_helper.rb +1 -1
  151. metadata +38 -2
data/docs/DefaultApi.md CHANGED
@@ -7,7 +7,11 @@ 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 |
11
+ | [**company_ebit_estimates**](DefaultApi.md#company_ebit_estimates) | **GET** /stock/ebit-estimate | EBIT Estimates |
12
+ | [**company_ebitda_estimates**](DefaultApi.md#company_ebitda_estimates) | **GET** /stock/ebitda-estimate | EBITDA Estimates |
10
13
  | [**company_eps_estimates**](DefaultApi.md#company_eps_estimates) | **GET** /stock/eps-estimate | Earnings Estimates |
14
+ | [**company_esg_score**](DefaultApi.md#company_esg_score) | **GET** /stock/esg | Company ESG Scores |
11
15
  | [**company_executive**](DefaultApi.md#company_executive) | **GET** /stock/executive | Company Executive |
12
16
  | [**company_news**](DefaultApi.md#company_news) | **GET** /company-news | Company News |
13
17
  | [**company_peers**](DefaultApi.md#company_peers) | **GET** /stock/peers | Peers |
@@ -18,6 +22,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
18
22
  | [**covid19**](DefaultApi.md#covid19) | **GET** /covid19/us | COVID-19 |
19
23
  | [**crypto_candles**](DefaultApi.md#crypto_candles) | **GET** /crypto/candle | Crypto Candles |
20
24
  | [**crypto_exchanges**](DefaultApi.md#crypto_exchanges) | **GET** /crypto/exchange | Crypto Exchanges |
25
+ | [**crypto_profile**](DefaultApi.md#crypto_profile) | **GET** /crypto/profile | Crypto Profile |
21
26
  | [**crypto_symbols**](DefaultApi.md#crypto_symbols) | **GET** /crypto/symbol | Crypto Symbol |
22
27
  | [**earnings_calendar**](DefaultApi.md#earnings_calendar) | **GET** /calendar/earnings | Earnings Calendar |
23
28
  | [**economic_calendar**](DefaultApi.md#economic_calendar) | **GET** /calendar/economic | Economic Calendar |
@@ -296,6 +301,229 @@ end
296
301
  - **Accept**: application/json
297
302
 
298
303
 
304
+ ## company_earnings_quality_score
305
+
306
+ > <CompanyEarningsQualityScore> company_earnings_quality_score(symbol, freq)
307
+
308
+ Company Earnings Quality Score
309
+
310
+ <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>
311
+
312
+ ### Examples
313
+
314
+ ```ruby
315
+ require 'time'
316
+ require 'finnhub_ruby'
317
+ # setup authorization
318
+ FinnhubRuby.configure do |config|
319
+ # Configure API key authorization: api_key
320
+ config.api_key['api_key'] = 'YOUR API KEY'
321
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
322
+ # config.api_key_prefix['api_key'] = 'Bearer'
323
+ end
324
+
325
+ api_instance = FinnhubRuby::DefaultApi.new
326
+ symbol = 'symbol_example' # String | Symbol.
327
+ freq = 'freq_example' # String | Frequency. Currently support <code>annual</code> and <code>quarterly</code>
328
+
329
+ begin
330
+ # Company Earnings Quality Score
331
+ result = api_instance.company_earnings_quality_score(symbol, freq)
332
+ p result
333
+ rescue FinnhubRuby::ApiError => e
334
+ puts "Error when calling DefaultApi->company_earnings_quality_score: #{e}"
335
+ end
336
+ ```
337
+
338
+ #### Using the company_earnings_quality_score_with_http_info variant
339
+
340
+ This returns an Array which contains the response data, status code and headers.
341
+
342
+ > <Array(<CompanyEarningsQualityScore>, Integer, Hash)> company_earnings_quality_score_with_http_info(symbol, freq)
343
+
344
+ ```ruby
345
+ begin
346
+ # Company Earnings Quality Score
347
+ data, status_code, headers = api_instance.company_earnings_quality_score_with_http_info(symbol, freq)
348
+ p status_code # => 2xx
349
+ p headers # => { ... }
350
+ p data # => <CompanyEarningsQualityScore>
351
+ rescue FinnhubRuby::ApiError => e
352
+ puts "Error when calling DefaultApi->company_earnings_quality_score_with_http_info: #{e}"
353
+ end
354
+ ```
355
+
356
+ ### Parameters
357
+
358
+ | Name | Type | Description | Notes |
359
+ | ---- | ---- | ----------- | ----- |
360
+ | **symbol** | **String** | Symbol. | |
361
+ | **freq** | **String** | Frequency. Currently support &lt;code&gt;annual&lt;/code&gt; and &lt;code&gt;quarterly&lt;/code&gt; | |
362
+
363
+ ### Return type
364
+
365
+ [**CompanyEarningsQualityScore**](CompanyEarningsQualityScore.md)
366
+
367
+ ### Authorization
368
+
369
+ [api_key](../README.md#api_key)
370
+
371
+ ### HTTP request headers
372
+
373
+ - **Content-Type**: Not defined
374
+ - **Accept**: application/json
375
+
376
+
377
+ ## company_ebit_estimates
378
+
379
+ > <EbitEstimates> company_ebit_estimates(symbol, opts)
380
+
381
+ EBIT Estimates
382
+
383
+ Get company's ebit estimates.
384
+
385
+ ### Examples
386
+
387
+ ```ruby
388
+ require 'time'
389
+ require 'finnhub_ruby'
390
+ # setup authorization
391
+ FinnhubRuby.configure do |config|
392
+ # Configure API key authorization: api_key
393
+ config.api_key['api_key'] = 'YOUR API KEY'
394
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
395
+ # config.api_key_prefix['api_key'] = 'Bearer'
396
+ end
397
+
398
+ api_instance = FinnhubRuby::DefaultApi.new
399
+ symbol = 'symbol_example' # String | Symbol of the company: AAPL.
400
+ opts = {
401
+ freq: 'freq_example' # String | Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
402
+ }
403
+
404
+ begin
405
+ # EBIT Estimates
406
+ result = api_instance.company_ebit_estimates(symbol, opts)
407
+ p result
408
+ rescue FinnhubRuby::ApiError => e
409
+ puts "Error when calling DefaultApi->company_ebit_estimates: #{e}"
410
+ end
411
+ ```
412
+
413
+ #### Using the company_ebit_estimates_with_http_info variant
414
+
415
+ This returns an Array which contains the response data, status code and headers.
416
+
417
+ > <Array(<EbitEstimates>, Integer, Hash)> company_ebit_estimates_with_http_info(symbol, opts)
418
+
419
+ ```ruby
420
+ begin
421
+ # EBIT Estimates
422
+ data, status_code, headers = api_instance.company_ebit_estimates_with_http_info(symbol, opts)
423
+ p status_code # => 2xx
424
+ p headers # => { ... }
425
+ p data # => <EbitEstimates>
426
+ rescue FinnhubRuby::ApiError => e
427
+ puts "Error when calling DefaultApi->company_ebit_estimates_with_http_info: #{e}"
428
+ end
429
+ ```
430
+
431
+ ### Parameters
432
+
433
+ | Name | Type | Description | Notes |
434
+ | ---- | ---- | ----------- | ----- |
435
+ | **symbol** | **String** | Symbol of the company: AAPL. | |
436
+ | **freq** | **String** | Can take 1 of the following values: &lt;code&gt;annual, quarterly&lt;/code&gt;. Default to &lt;code&gt;quarterly&lt;/code&gt; | [optional] |
437
+
438
+ ### Return type
439
+
440
+ [**EbitEstimates**](EbitEstimates.md)
441
+
442
+ ### Authorization
443
+
444
+ [api_key](../README.md#api_key)
445
+
446
+ ### HTTP request headers
447
+
448
+ - **Content-Type**: Not defined
449
+ - **Accept**: application/json
450
+
451
+
452
+ ## company_ebitda_estimates
453
+
454
+ > <EbitdaEstimates> company_ebitda_estimates(symbol, opts)
455
+
456
+ EBITDA Estimates
457
+
458
+ Get company's ebitda estimates.
459
+
460
+ ### Examples
461
+
462
+ ```ruby
463
+ require 'time'
464
+ require 'finnhub_ruby'
465
+ # setup authorization
466
+ FinnhubRuby.configure do |config|
467
+ # Configure API key authorization: api_key
468
+ config.api_key['api_key'] = 'YOUR API KEY'
469
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
470
+ # config.api_key_prefix['api_key'] = 'Bearer'
471
+ end
472
+
473
+ api_instance = FinnhubRuby::DefaultApi.new
474
+ symbol = 'symbol_example' # String | Symbol of the company: AAPL.
475
+ opts = {
476
+ freq: 'freq_example' # String | Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
477
+ }
478
+
479
+ begin
480
+ # EBITDA Estimates
481
+ result = api_instance.company_ebitda_estimates(symbol, opts)
482
+ p result
483
+ rescue FinnhubRuby::ApiError => e
484
+ puts "Error when calling DefaultApi->company_ebitda_estimates: #{e}"
485
+ end
486
+ ```
487
+
488
+ #### Using the company_ebitda_estimates_with_http_info variant
489
+
490
+ This returns an Array which contains the response data, status code and headers.
491
+
492
+ > <Array(<EbitdaEstimates>, Integer, Hash)> company_ebitda_estimates_with_http_info(symbol, opts)
493
+
494
+ ```ruby
495
+ begin
496
+ # EBITDA Estimates
497
+ data, status_code, headers = api_instance.company_ebitda_estimates_with_http_info(symbol, opts)
498
+ p status_code # => 2xx
499
+ p headers # => { ... }
500
+ p data # => <EbitdaEstimates>
501
+ rescue FinnhubRuby::ApiError => e
502
+ puts "Error when calling DefaultApi->company_ebitda_estimates_with_http_info: #{e}"
503
+ end
504
+ ```
505
+
506
+ ### Parameters
507
+
508
+ | Name | Type | Description | Notes |
509
+ | ---- | ---- | ----------- | ----- |
510
+ | **symbol** | **String** | Symbol of the company: AAPL. | |
511
+ | **freq** | **String** | Can take 1 of the following values: &lt;code&gt;annual, quarterly&lt;/code&gt;. Default to &lt;code&gt;quarterly&lt;/code&gt; | [optional] |
512
+
513
+ ### Return type
514
+
515
+ [**EbitdaEstimates**](EbitdaEstimates.md)
516
+
517
+ ### Authorization
518
+
519
+ [api_key](../README.md#api_key)
520
+
521
+ ### HTTP request headers
522
+
523
+ - **Content-Type**: Not defined
524
+ - **Accept**: application/json
525
+
526
+
299
527
  ## company_eps_estimates
300
528
 
301
529
  > <EarningsEstimates> company_eps_estimates(symbol, opts)
@@ -371,6 +599,77 @@ end
371
599
  - **Accept**: application/json
372
600
 
373
601
 
602
+ ## company_esg_score
603
+
604
+ > <CompanyESG> company_esg_score(symbol)
605
+
606
+ Company ESG Scores
607
+
608
+ <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>
609
+
610
+ ### Examples
611
+
612
+ ```ruby
613
+ require 'time'
614
+ require 'finnhub_ruby'
615
+ # setup authorization
616
+ FinnhubRuby.configure do |config|
617
+ # Configure API key authorization: api_key
618
+ config.api_key['api_key'] = 'YOUR API KEY'
619
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
620
+ # config.api_key_prefix['api_key'] = 'Bearer'
621
+ end
622
+
623
+ api_instance = FinnhubRuby::DefaultApi.new
624
+ symbol = 'symbol_example' # String | Symbol.
625
+
626
+ begin
627
+ # Company ESG Scores
628
+ result = api_instance.company_esg_score(symbol)
629
+ p result
630
+ rescue FinnhubRuby::ApiError => e
631
+ puts "Error when calling DefaultApi->company_esg_score: #{e}"
632
+ end
633
+ ```
634
+
635
+ #### Using the company_esg_score_with_http_info variant
636
+
637
+ This returns an Array which contains the response data, status code and headers.
638
+
639
+ > <Array(<CompanyESG>, Integer, Hash)> company_esg_score_with_http_info(symbol)
640
+
641
+ ```ruby
642
+ begin
643
+ # Company ESG Scores
644
+ data, status_code, headers = api_instance.company_esg_score_with_http_info(symbol)
645
+ p status_code # => 2xx
646
+ p headers # => { ... }
647
+ p data # => <CompanyESG>
648
+ rescue FinnhubRuby::ApiError => e
649
+ puts "Error when calling DefaultApi->company_esg_score_with_http_info: #{e}"
650
+ end
651
+ ```
652
+
653
+ ### Parameters
654
+
655
+ | Name | Type | Description | Notes |
656
+ | ---- | ---- | ----------- | ----- |
657
+ | **symbol** | **String** | Symbol. | |
658
+
659
+ ### Return type
660
+
661
+ [**CompanyESG**](CompanyESG.md)
662
+
663
+ ### Authorization
664
+
665
+ [api_key](../README.md#api_key)
666
+
667
+ ### HTTP request headers
668
+
669
+ - **Content-Type**: Not defined
670
+ - **Accept**: application/json
671
+
672
+
374
673
  ## company_executive
375
674
 
376
675
  > <CompanyExecutive> company_executive(symbol)
@@ -523,7 +822,7 @@ end
523
822
 
524
823
  Peers
525
824
 
526
- Get company peers. Return a list of peers in the same country and GICS sub-industry
825
+ Get company peers. Return a list of peers in the same country and sub-industry
527
826
 
528
827
  ### Examples
529
828
 
@@ -1098,6 +1397,77 @@ This endpoint does not need any parameter.
1098
1397
  - **Accept**: application/json
1099
1398
 
1100
1399
 
1400
+ ## crypto_profile
1401
+
1402
+ > <CryptoProfile> crypto_profile(symbol)
1403
+
1404
+ Crypto Profile
1405
+
1406
+ Get crypto's profile.
1407
+
1408
+ ### Examples
1409
+
1410
+ ```ruby
1411
+ require 'time'
1412
+ require 'finnhub_ruby'
1413
+ # setup authorization
1414
+ FinnhubRuby.configure do |config|
1415
+ # Configure API key authorization: api_key
1416
+ config.api_key['api_key'] = 'YOUR API KEY'
1417
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1418
+ # config.api_key_prefix['api_key'] = 'Bearer'
1419
+ end
1420
+
1421
+ api_instance = FinnhubRuby::DefaultApi.new
1422
+ symbol = 'symbol_example' # String | Crypto symbol such as BTC or ETH.
1423
+
1424
+ begin
1425
+ # Crypto Profile
1426
+ result = api_instance.crypto_profile(symbol)
1427
+ p result
1428
+ rescue FinnhubRuby::ApiError => e
1429
+ puts "Error when calling DefaultApi->crypto_profile: #{e}"
1430
+ end
1431
+ ```
1432
+
1433
+ #### Using the crypto_profile_with_http_info variant
1434
+
1435
+ This returns an Array which contains the response data, status code and headers.
1436
+
1437
+ > <Array(<CryptoProfile>, Integer, Hash)> crypto_profile_with_http_info(symbol)
1438
+
1439
+ ```ruby
1440
+ begin
1441
+ # Crypto Profile
1442
+ data, status_code, headers = api_instance.crypto_profile_with_http_info(symbol)
1443
+ p status_code # => 2xx
1444
+ p headers # => { ... }
1445
+ p data # => <CryptoProfile>
1446
+ rescue FinnhubRuby::ApiError => e
1447
+ puts "Error when calling DefaultApi->crypto_profile_with_http_info: #{e}"
1448
+ end
1449
+ ```
1450
+
1451
+ ### Parameters
1452
+
1453
+ | Name | Type | Description | Notes |
1454
+ | ---- | ---- | ----------- | ----- |
1455
+ | **symbol** | **String** | Crypto symbol such as BTC or ETH. | |
1456
+
1457
+ ### Return type
1458
+
1459
+ [**CryptoProfile**](CryptoProfile.md)
1460
+
1461
+ ### Authorization
1462
+
1463
+ [api_key](../README.md#api_key)
1464
+
1465
+ ### HTTP request headers
1466
+
1467
+ - **Content-Type**: Not defined
1468
+ - **Accept**: application/json
1469
+
1470
+
1101
1471
  ## crypto_symbols
1102
1472
 
1103
1473
  > <Array<CryptoSymbol>> crypto_symbols(exchange)
@@ -1250,7 +1620,7 @@ end
1250
1620
 
1251
1621
  ## economic_calendar
1252
1622
 
1253
- > <EconomicCalendar> economic_calendar
1623
+ > <EconomicCalendar> economic_calendar(opts)
1254
1624
 
1255
1625
  Economic Calendar
1256
1626
 
@@ -1270,10 +1640,14 @@ FinnhubRuby.configure do |config|
1270
1640
  end
1271
1641
 
1272
1642
  api_instance = FinnhubRuby::DefaultApi.new
1643
+ opts = {
1644
+ from: Date.parse('2013-10-20'), # Date | From date <code>YYYY-MM-DD</code>.
1645
+ to: Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
1646
+ }
1273
1647
 
1274
1648
  begin
1275
1649
  # Economic Calendar
1276
- result = api_instance.economic_calendar
1650
+ result = api_instance.economic_calendar(opts)
1277
1651
  p result
1278
1652
  rescue FinnhubRuby::ApiError => e
1279
1653
  puts "Error when calling DefaultApi->economic_calendar: #{e}"
@@ -1284,12 +1658,12 @@ end
1284
1658
 
1285
1659
  This returns an Array which contains the response data, status code and headers.
1286
1660
 
1287
- > <Array(<EconomicCalendar>, Integer, Hash)> economic_calendar_with_http_info
1661
+ > <Array(<EconomicCalendar>, Integer, Hash)> economic_calendar_with_http_info(opts)
1288
1662
 
1289
1663
  ```ruby
1290
1664
  begin
1291
1665
  # Economic Calendar
1292
- data, status_code, headers = api_instance.economic_calendar_with_http_info
1666
+ data, status_code, headers = api_instance.economic_calendar_with_http_info(opts)
1293
1667
  p status_code # => 2xx
1294
1668
  p headers # => { ... }
1295
1669
  p data # => <EconomicCalendar>
@@ -1300,7 +1674,10 @@ end
1300
1674
 
1301
1675
  ### Parameters
1302
1676
 
1303
- This endpoint does not need any parameter.
1677
+ | Name | Type | Description | Notes |
1678
+ | ---- | ---- | ----------- | ----- |
1679
+ | **from** | **Date** | From date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. | [optional] |
1680
+ | **to** | **Date** | To date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. | [optional] |
1304
1681
 
1305
1682
  ### Return type
1306
1683
 
@@ -2653,7 +3030,7 @@ FinnhubRuby.configure do |config|
2653
3030
  end
2654
3031
 
2655
3032
  api_instance = FinnhubRuby::DefaultApi.new
2656
- symbol = 'symbol_example' # String | Symbol of the company: AAPL.
3033
+ symbol = 'symbol_example' # String | Symbol of the company: AAPL. Leave this param blank to get the latest transactions.
2657
3034
  opts = {
2658
3035
  from: Date.parse('2013-10-20'), # Date | From date: 2020-03-15.
2659
3036
  to: Date.parse('2013-10-20') # Date | To date: 2020-03-16.
@@ -2690,7 +3067,7 @@ end
2690
3067
 
2691
3068
  | Name | Type | Description | Notes |
2692
3069
  | ---- | ---- | ----------- | ----- |
2693
- | **symbol** | **String** | Symbol of the company: AAPL. | |
3070
+ | **symbol** | **String** | Symbol of the company: AAPL. Leave this param blank to get the latest transactions. | |
2694
3071
  | **from** | **Date** | From date: 2020-03-15. | [optional] |
2695
3072
  | **to** | **Date** | To date: 2020-03-16. | [optional] |
2696
3073
 
@@ -4565,7 +4942,7 @@ end
4565
4942
 
4566
4943
  Tick Data
4567
4944
 
4568
- <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><p>Note that for Nasdaq Nordic and Baltic, you need to use ISIN instead of symbol to query tick data. </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>
4945
+ <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>
4569
4946
 
4570
4947
  ### Examples
4571
4948
 
@@ -0,0 +1,22 @@
1
+ # FinnhubRuby::EbitEstimates
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array&lt;EbitEstimatesInfo&gt;**](EbitEstimatesInfo.md) | List of estimates | [optional] |
8
+ | **freq** | **String** | Frequency: annual or quarterly. | [optional] |
9
+ | **symbol** | **String** | Company symbol. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'finnhub_ruby'
15
+
16
+ instance = FinnhubRuby::EbitEstimates.new(
17
+ data: null,
18
+ freq: null,
19
+ symbol: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,26 @@
1
+ # FinnhubRuby::EbitEstimatesInfo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **ebit_avg** | **Float** | Average EBIT estimates including Finnhub&#39;s proprietary estimates. | [optional] |
8
+ | **ebit_high** | **Float** | Highest estimate. | [optional] |
9
+ | **ebit_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::EbitEstimatesInfo.new(
19
+ ebit_avg: null,
20
+ ebit_high: null,
21
+ ebit_low: null,
22
+ number_analysts: null,
23
+ period: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,22 @@
1
+ # FinnhubRuby::EbitdaEstimates
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array&lt;EbitdaEstimatesInfo&gt;**](EbitdaEstimatesInfo.md) | List of estimates | [optional] |
8
+ | **freq** | **String** | Frequency: annual or quarterly. | [optional] |
9
+ | **symbol** | **String** | Company symbol. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'finnhub_ruby'
15
+
16
+ instance = FinnhubRuby::EbitdaEstimates.new(
17
+ data: null,
18
+ freq: null,
19
+ symbol: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,26 @@
1
+ # FinnhubRuby::EbitdaEstimatesInfo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **ebitda_avg** | **Float** | Average EBITDA estimates including Finnhub&#39;s proprietary estimates. | [optional] |
8
+ | **ebitda_high** | **Float** | Highest estimate. | [optional] |
9
+ | **ebitda_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::EbitdaEstimatesInfo.new(
19
+ ebitda_avg: null,
20
+ ebitda_high: null,
21
+ ebitda_low: null,
22
+ number_analysts: null,
23
+ period: null
24
+ )
25
+ ```
26
+
@@ -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
 
@@ -25,6 +25,10 @@
25
25
  | **max_redemption_fee** | **Float** | Max redemption fee. | [optional] |
26
26
  | **standard_min_investment** | **Float** | Minimum investment for standard accounts. | [optional] |
27
27
  | **turnover** | **Float** | Turnover. | [optional] |
28
+ | **series_id** | **String** | Fund&#39;s series ID. This field can be used to group multiple share classes into 1 unique fund. | [optional] |
29
+ | **series_name** | **String** | Fund&#39;s series name. | [optional] |
30
+ | **class_id** | **String** | Class ID. | [optional] |
31
+ | **class_name** | **String** | Class name. | [optional] |
28
32
 
29
33
  ## Example
30
34
 
@@ -52,7 +56,11 @@ instance = FinnhubRuby::MutualFundProfileData.new(
52
56
  cusip: null,
53
57
  max_redemption_fee: null,
54
58
  standard_min_investment: null,
55
- turnover: null
59
+ turnover: null,
60
+ series_id: null,
61
+ series_name: null,
62
+ class_id: null,
63
+ class_name: null
56
64
  )
57
65
  ```
58
66
 
data/docs/Transactions.md CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **symbol** | **String** | Symbol. | [optional] |
7
8
  | **name** | **String** | Insider&#39;s name. | [optional] |
8
9
  | **share** | **Integer** | Number of shares held after the transaction. | [optional] |
9
10
  | **change** | **Integer** | Number of share changed from the last period. A positive value suggests a &lt;code&gt;BUY&lt;/code&gt; transaction. A negative value suggests a &lt;code&gt;SELL&lt;/code&gt; transaction. | [optional] |
@@ -18,6 +19,7 @@
18
19
  require 'finnhub_ruby'
19
20
 
20
21
  instance = FinnhubRuby::Transactions.new(
22
+ symbol: null,
21
23
  name: null,
22
24
  share: null,
23
25
  change: null,
Binary file
Binary file
Binary file
Binary file
data/finnhub_ruby.gemspec CHANGED
@@ -8,7 +8,7 @@
8
8
  The version of the OpenAPI document: 1.0.0
9
9
 
10
10
  Generated by: https://openapi-generator.tech
11
- OpenAPI Generator version: 5.2.0
11
+ OpenAPI Generator version: 5.2.1
12
12
 
13
13
  =end
14
14