finnhub_ruby 1.1.6 → 1.1.10

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 (149) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +51 -14
  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 +5 -5
  7. data/docs/CountryMetadata.md +5 -1
  8. data/docs/CryptoProfile.md +38 -0
  9. data/docs/DefaultApi.md +241 -20
  10. data/docs/EarningRelease.md +2 -2
  11. data/docs/EarningsEstimates.md +1 -1
  12. data/docs/EarningsEstimatesInfo.md +26 -0
  13. data/docs/IPOEvent.md +2 -2
  14. data/docs/KeyCustomersSuppliers.md +13 -1
  15. data/docs/RevenueEstimates.md +1 -1
  16. data/docs/RevenueEstimatesInfo.md +26 -0
  17. data/docs/Sentiment.md +2 -2
  18. data/docs/SimilarityIndex.md +1 -1
  19. data/docs/SimilarityIndexInfo.md +40 -0
  20. data/finnhub_ruby-1.1.7.gem +0 -0
  21. data/finnhub_ruby-1.1.8.gem +0 -0
  22. data/finnhub_ruby-1.1.9.gem +0 -0
  23. data/finnhub_ruby.gemspec +1 -1
  24. data/lib/finnhub_ruby/api/default_api.rb +216 -14
  25. data/lib/finnhub_ruby/api_client.rb +1 -1
  26. data/lib/finnhub_ruby/api_error.rb +1 -1
  27. data/lib/finnhub_ruby/configuration.rb +1 -1
  28. data/lib/finnhub_ruby/models/aggregate_indicators.rb +1 -1
  29. data/lib/finnhub_ruby/models/basic_financials.rb +1 -1
  30. data/lib/finnhub_ruby/models/breakdown_item.rb +1 -1
  31. data/lib/finnhub_ruby/models/company.rb +1 -1
  32. data/lib/finnhub_ruby/models/company_earnings_quality_score.rb +241 -0
  33. data/lib/finnhub_ruby/models/company_earnings_quality_score_data.rb +279 -0
  34. data/lib/finnhub_ruby/models/company_esg.rb +268 -0
  35. data/lib/finnhub_ruby/models/company_executive.rb +1 -1
  36. data/lib/finnhub_ruby/models/company_news.rb +1 -1
  37. data/lib/finnhub_ruby/models/company_news_statistics.rb +1 -1
  38. data/lib/finnhub_ruby/models/company_profile.rb +6 -6
  39. data/lib/finnhub_ruby/models/company_profile2.rb +1 -1
  40. data/lib/finnhub_ruby/models/country_metadata.rb +25 -5
  41. data/lib/finnhub_ruby/models/covid_info.rb +1 -1
  42. data/lib/finnhub_ruby/models/crypto_candles.rb +1 -1
  43. data/lib/finnhub_ruby/models/crypto_profile.rb +319 -0
  44. data/lib/finnhub_ruby/models/crypto_symbol.rb +1 -1
  45. data/lib/finnhub_ruby/models/development.rb +1 -1
  46. data/lib/finnhub_ruby/models/dividends.rb +1 -1
  47. data/lib/finnhub_ruby/models/dividends2.rb +1 -1
  48. data/lib/finnhub_ruby/models/dividends2_info.rb +1 -1
  49. data/lib/finnhub_ruby/models/earning_release.rb +3 -3
  50. data/lib/finnhub_ruby/models/earning_result.rb +1 -1
  51. data/lib/finnhub_ruby/models/earnings_calendar.rb +1 -1
  52. data/lib/finnhub_ruby/models/earnings_call_transcripts.rb +1 -1
  53. data/lib/finnhub_ruby/models/earnings_call_transcripts_list.rb +1 -1
  54. data/lib/finnhub_ruby/models/earnings_estimates.rb +2 -2
  55. data/lib/finnhub_ruby/models/earnings_estimates_info.rb +259 -0
  56. data/lib/finnhub_ruby/models/economic_calendar.rb +1 -1
  57. data/lib/finnhub_ruby/models/economic_code.rb +1 -1
  58. data/lib/finnhub_ruby/models/economic_data.rb +1 -1
  59. data/lib/finnhub_ruby/models/economic_data_info.rb +1 -1
  60. data/lib/finnhub_ruby/models/economic_event.rb +1 -1
  61. data/lib/finnhub_ruby/models/etf_country_exposure_data.rb +1 -1
  62. data/lib/finnhub_ruby/models/etf_holdings_data.rb +1 -1
  63. data/lib/finnhub_ruby/models/etf_profile_data.rb +1 -1
  64. data/lib/finnhub_ruby/models/etf_sector_exposure_data.rb +1 -1
  65. data/lib/finnhub_ruby/models/etfs_country_exposure.rb +1 -1
  66. data/lib/finnhub_ruby/models/etfs_holdings.rb +1 -1
  67. data/lib/finnhub_ruby/models/etfs_profile.rb +1 -1
  68. data/lib/finnhub_ruby/models/etfs_sector_exposure.rb +1 -1
  69. data/lib/finnhub_ruby/models/fda_comittee_meeting.rb +1 -1
  70. data/lib/finnhub_ruby/models/filing.rb +1 -1
  71. data/lib/finnhub_ruby/models/filing_sentiment.rb +1 -1
  72. data/lib/finnhub_ruby/models/financial_statements.rb +1 -1
  73. data/lib/finnhub_ruby/models/financials_as_reported.rb +1 -1
  74. data/lib/finnhub_ruby/models/forex_candles.rb +1 -1
  75. data/lib/finnhub_ruby/models/forex_symbol.rb +1 -1
  76. data/lib/finnhub_ruby/models/forexrates.rb +1 -1
  77. data/lib/finnhub_ruby/models/fund_ownership.rb +1 -1
  78. data/lib/finnhub_ruby/models/fund_ownership_info.rb +1 -1
  79. data/lib/finnhub_ruby/models/historical_nbbo.rb +1 -1
  80. data/lib/finnhub_ruby/models/index_historical_constituent.rb +1 -1
  81. data/lib/finnhub_ruby/models/indicator.rb +1 -1
  82. data/lib/finnhub_ruby/models/indices_constituents.rb +1 -1
  83. data/lib/finnhub_ruby/models/indices_historical_constituents.rb +1 -1
  84. data/lib/finnhub_ruby/models/insider_transactions.rb +1 -1
  85. data/lib/finnhub_ruby/models/international_filing.rb +1 -1
  86. data/lib/finnhub_ruby/models/investment_theme_portfolio.rb +1 -1
  87. data/lib/finnhub_ruby/models/investment_themes.rb +1 -1
  88. data/lib/finnhub_ruby/models/ipo_calendar.rb +1 -1
  89. data/lib/finnhub_ruby/models/ipo_event.rb +3 -3
  90. data/lib/finnhub_ruby/models/key_customers_suppliers.rb +65 -5
  91. data/lib/finnhub_ruby/models/last_bid_ask.rb +1 -1
  92. data/lib/finnhub_ruby/models/market_news.rb +1 -1
  93. data/lib/finnhub_ruby/models/mutual_fund_country_exposure.rb +1 -1
  94. data/lib/finnhub_ruby/models/mutual_fund_country_exposure_data.rb +1 -1
  95. data/lib/finnhub_ruby/models/mutual_fund_holdings.rb +1 -1
  96. data/lib/finnhub_ruby/models/mutual_fund_holdings_data.rb +1 -1
  97. data/lib/finnhub_ruby/models/mutual_fund_profile.rb +1 -1
  98. data/lib/finnhub_ruby/models/mutual_fund_profile_data.rb +1 -1
  99. data/lib/finnhub_ruby/models/mutual_fund_sector_exposure.rb +1 -1
  100. data/lib/finnhub_ruby/models/mutual_fund_sector_exposure_data.rb +1 -1
  101. data/lib/finnhub_ruby/models/news_sentiment.rb +1 -1
  102. data/lib/finnhub_ruby/models/ownership.rb +1 -1
  103. data/lib/finnhub_ruby/models/ownership_info.rb +1 -1
  104. data/lib/finnhub_ruby/models/pattern_recognition.rb +1 -1
  105. data/lib/finnhub_ruby/models/press_release.rb +1 -1
  106. data/lib/finnhub_ruby/models/price_target.rb +1 -1
  107. data/lib/finnhub_ruby/models/quote.rb +1 -1
  108. data/lib/finnhub_ruby/models/recommendation_trend.rb +1 -1
  109. data/lib/finnhub_ruby/models/reddit_sentiment_content.rb +1 -1
  110. data/lib/finnhub_ruby/models/report.rb +1 -1
  111. data/lib/finnhub_ruby/models/revenue_breakdown.rb +1 -1
  112. data/lib/finnhub_ruby/models/revenue_estimates.rb +2 -2
  113. data/lib/finnhub_ruby/models/revenue_estimates_info.rb +259 -0
  114. data/lib/finnhub_ruby/models/sec_sentiment_analysis.rb +1 -1
  115. data/lib/finnhub_ruby/models/sentiment.rb +3 -3
  116. data/lib/finnhub_ruby/models/similarity_index.rb +2 -2
  117. data/lib/finnhub_ruby/models/similarity_index_info.rb +329 -0
  118. data/lib/finnhub_ruby/models/social_sentiment.rb +1 -1
  119. data/lib/finnhub_ruby/models/split.rb +1 -1
  120. data/lib/finnhub_ruby/models/stock_candles.rb +1 -1
  121. data/lib/finnhub_ruby/models/stock_symbol.rb +1 -1
  122. data/lib/finnhub_ruby/models/stock_transcripts.rb +1 -1
  123. data/lib/finnhub_ruby/models/supply_chain_relationships.rb +1 -1
  124. data/lib/finnhub_ruby/models/support_resistance.rb +1 -1
  125. data/lib/finnhub_ruby/models/symbol_lookup.rb +1 -1
  126. data/lib/finnhub_ruby/models/symbol_lookup_info.rb +1 -1
  127. data/lib/finnhub_ruby/models/technical_analysis.rb +1 -1
  128. data/lib/finnhub_ruby/models/tick_data.rb +1 -1
  129. data/lib/finnhub_ruby/models/transactions.rb +1 -1
  130. data/lib/finnhub_ruby/models/transcript_content.rb +1 -1
  131. data/lib/finnhub_ruby/models/transcript_participant.rb +1 -1
  132. data/lib/finnhub_ruby/models/trend.rb +1 -1
  133. data/lib/finnhub_ruby/models/twitter_sentiment_content.rb +1 -1
  134. data/lib/finnhub_ruby/models/upgrade_downgrade.rb +1 -1
  135. data/lib/finnhub_ruby/version.rb +2 -2
  136. data/lib/finnhub_ruby.rb +8 -3
  137. data/release.sh +1 -1
  138. data/spec/api_client_spec.rb +1 -1
  139. data/spec/configuration_spec.rb +1 -1
  140. data/spec/models/company_earnings_quality_score_data_spec.rb +70 -0
  141. data/spec/models/company_earnings_quality_score_spec.rb +46 -0
  142. data/spec/models/company_esg_spec.rb +64 -0
  143. data/spec/models/crypto_profile_spec.rb +94 -0
  144. data/spec/models/earnings_estimates_info_spec.rb +58 -0
  145. data/spec/models/revenue_estimates_info_spec.rb +58 -0
  146. data/spec/models/similarity_index_info_spec.rb +100 -0
  147. data/spec/spec_helper.rb +1 -1
  148. metadata +33 -3
  149. data/finnhub_ruby-1.1.5.gem +0 -0
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 |
@@ -18,6 +20,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
18
20
  | [**covid19**](DefaultApi.md#covid19) | **GET** /covid19/us | COVID-19 |
19
21
  | [**crypto_candles**](DefaultApi.md#crypto_candles) | **GET** /crypto/candle | Crypto Candles |
20
22
  | [**crypto_exchanges**](DefaultApi.md#crypto_exchanges) | **GET** /crypto/exchange | Crypto Exchanges |
23
+ | [**crypto_profile**](DefaultApi.md#crypto_profile) | **GET** /crypto/profile | Crypto Profile |
21
24
  | [**crypto_symbols**](DefaultApi.md#crypto_symbols) | **GET** /crypto/symbol | Crypto Symbol |
22
25
  | [**earnings_calendar**](DefaultApi.md#earnings_calendar) | **GET** /calendar/earnings | Earnings Calendar |
23
26
  | [**economic_calendar**](DefaultApi.md#economic_calendar) | **GET** /calendar/economic | Economic Calendar |
@@ -296,6 +299,79 @@ end
296
299
  - **Accept**: application/json
297
300
 
298
301
 
302
+ ## company_earnings_quality_score
303
+
304
+ > <CompanyEarningsQualityScore> company_earnings_quality_score(symbol, freq)
305
+
306
+ Company Earnings Quality Score
307
+
308
+ <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>
309
+
310
+ ### Examples
311
+
312
+ ```ruby
313
+ require 'time'
314
+ require 'finnhub_ruby'
315
+ # setup authorization
316
+ FinnhubRuby.configure do |config|
317
+ # Configure API key authorization: api_key
318
+ config.api_key['api_key'] = 'YOUR API KEY'
319
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
320
+ # config.api_key_prefix['api_key'] = 'Bearer'
321
+ end
322
+
323
+ api_instance = FinnhubRuby::DefaultApi.new
324
+ symbol = 'symbol_example' # String | Symbol.
325
+ freq = 'freq_example' # String | Frequency. Currently support <code>annual</code> and <code>quarterly</code>
326
+
327
+ begin
328
+ # Company Earnings Quality Score
329
+ result = api_instance.company_earnings_quality_score(symbol, freq)
330
+ p result
331
+ rescue FinnhubRuby::ApiError => e
332
+ puts "Error when calling DefaultApi->company_earnings_quality_score: #{e}"
333
+ end
334
+ ```
335
+
336
+ #### Using the company_earnings_quality_score_with_http_info variant
337
+
338
+ This returns an Array which contains the response data, status code and headers.
339
+
340
+ > <Array(<CompanyEarningsQualityScore>, Integer, Hash)> company_earnings_quality_score_with_http_info(symbol, freq)
341
+
342
+ ```ruby
343
+ begin
344
+ # Company Earnings Quality Score
345
+ data, status_code, headers = api_instance.company_earnings_quality_score_with_http_info(symbol, freq)
346
+ p status_code # => 2xx
347
+ p headers # => { ... }
348
+ p data # => <CompanyEarningsQualityScore>
349
+ rescue FinnhubRuby::ApiError => e
350
+ puts "Error when calling DefaultApi->company_earnings_quality_score_with_http_info: #{e}"
351
+ end
352
+ ```
353
+
354
+ ### Parameters
355
+
356
+ | Name | Type | Description | Notes |
357
+ | ---- | ---- | ----------- | ----- |
358
+ | **symbol** | **String** | Symbol. | |
359
+ | **freq** | **String** | Frequency. Currently support &lt;code&gt;annual&lt;/code&gt; and &lt;code&gt;quarterly&lt;/code&gt; | |
360
+
361
+ ### Return type
362
+
363
+ [**CompanyEarningsQualityScore**](CompanyEarningsQualityScore.md)
364
+
365
+ ### Authorization
366
+
367
+ [api_key](../README.md#api_key)
368
+
369
+ ### HTTP request headers
370
+
371
+ - **Content-Type**: Not defined
372
+ - **Accept**: application/json
373
+
374
+
299
375
  ## company_eps_estimates
300
376
 
301
377
  > <EarningsEstimates> company_eps_estimates(symbol, opts)
@@ -371,6 +447,77 @@ end
371
447
  - **Accept**: application/json
372
448
 
373
449
 
450
+ ## company_esg_score
451
+
452
+ > <CompanyESG> company_esg_score(symbol)
453
+
454
+ Company ESG Scores
455
+
456
+ <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>
457
+
458
+ ### Examples
459
+
460
+ ```ruby
461
+ require 'time'
462
+ require 'finnhub_ruby'
463
+ # setup authorization
464
+ FinnhubRuby.configure do |config|
465
+ # Configure API key authorization: api_key
466
+ config.api_key['api_key'] = 'YOUR API KEY'
467
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
468
+ # config.api_key_prefix['api_key'] = 'Bearer'
469
+ end
470
+
471
+ api_instance = FinnhubRuby::DefaultApi.new
472
+ symbol = 'symbol_example' # String | Symbol.
473
+
474
+ begin
475
+ # Company ESG Scores
476
+ result = api_instance.company_esg_score(symbol)
477
+ p result
478
+ rescue FinnhubRuby::ApiError => e
479
+ puts "Error when calling DefaultApi->company_esg_score: #{e}"
480
+ end
481
+ ```
482
+
483
+ #### Using the company_esg_score_with_http_info variant
484
+
485
+ This returns an Array which contains the response data, status code and headers.
486
+
487
+ > <Array(<CompanyESG>, Integer, Hash)> company_esg_score_with_http_info(symbol)
488
+
489
+ ```ruby
490
+ begin
491
+ # Company ESG Scores
492
+ data, status_code, headers = api_instance.company_esg_score_with_http_info(symbol)
493
+ p status_code # => 2xx
494
+ p headers # => { ... }
495
+ p data # => <CompanyESG>
496
+ rescue FinnhubRuby::ApiError => e
497
+ puts "Error when calling DefaultApi->company_esg_score_with_http_info: #{e}"
498
+ end
499
+ ```
500
+
501
+ ### Parameters
502
+
503
+ | Name | Type | Description | Notes |
504
+ | ---- | ---- | ----------- | ----- |
505
+ | **symbol** | **String** | Symbol. | |
506
+
507
+ ### Return type
508
+
509
+ [**CompanyESG**](CompanyESG.md)
510
+
511
+ ### Authorization
512
+
513
+ [api_key](../README.md#api_key)
514
+
515
+ ### HTTP request headers
516
+
517
+ - **Content-Type**: Not defined
518
+ - **Accept**: application/json
519
+
520
+
374
521
  ## company_executive
375
522
 
376
523
  > <CompanyExecutive> company_executive(symbol)
@@ -523,7 +670,7 @@ end
523
670
 
524
671
  Peers
525
672
 
526
- Get company peers. Return a list of peers in the same country and GICS sub-industry
673
+ Get company peers. Return a list of peers in the same country and sub-industry
527
674
 
528
675
  ### Examples
529
676
 
@@ -1098,6 +1245,77 @@ This endpoint does not need any parameter.
1098
1245
  - **Accept**: application/json
1099
1246
 
1100
1247
 
1248
+ ## crypto_profile
1249
+
1250
+ > <CryptoProfile> crypto_profile(symbol)
1251
+
1252
+ Crypto Profile
1253
+
1254
+ Get crypto's profile.
1255
+
1256
+ ### Examples
1257
+
1258
+ ```ruby
1259
+ require 'time'
1260
+ require 'finnhub_ruby'
1261
+ # setup authorization
1262
+ FinnhubRuby.configure do |config|
1263
+ # Configure API key authorization: api_key
1264
+ config.api_key['api_key'] = 'YOUR API KEY'
1265
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1266
+ # config.api_key_prefix['api_key'] = 'Bearer'
1267
+ end
1268
+
1269
+ api_instance = FinnhubRuby::DefaultApi.new
1270
+ symbol = 'symbol_example' # String | Crypto symbol such as BTC or ETH.
1271
+
1272
+ begin
1273
+ # Crypto Profile
1274
+ result = api_instance.crypto_profile(symbol)
1275
+ p result
1276
+ rescue FinnhubRuby::ApiError => e
1277
+ puts "Error when calling DefaultApi->crypto_profile: #{e}"
1278
+ end
1279
+ ```
1280
+
1281
+ #### Using the crypto_profile_with_http_info variant
1282
+
1283
+ This returns an Array which contains the response data, status code and headers.
1284
+
1285
+ > <Array(<CryptoProfile>, Integer, Hash)> crypto_profile_with_http_info(symbol)
1286
+
1287
+ ```ruby
1288
+ begin
1289
+ # Crypto Profile
1290
+ data, status_code, headers = api_instance.crypto_profile_with_http_info(symbol)
1291
+ p status_code # => 2xx
1292
+ p headers # => { ... }
1293
+ p data # => <CryptoProfile>
1294
+ rescue FinnhubRuby::ApiError => e
1295
+ puts "Error when calling DefaultApi->crypto_profile_with_http_info: #{e}"
1296
+ end
1297
+ ```
1298
+
1299
+ ### Parameters
1300
+
1301
+ | Name | Type | Description | Notes |
1302
+ | ---- | ---- | ----------- | ----- |
1303
+ | **symbol** | **String** | Crypto symbol such as BTC or ETH. | |
1304
+
1305
+ ### Return type
1306
+
1307
+ [**CryptoProfile**](CryptoProfile.md)
1308
+
1309
+ ### Authorization
1310
+
1311
+ [api_key](../README.md#api_key)
1312
+
1313
+ ### HTTP request headers
1314
+
1315
+ - **Content-Type**: Not defined
1316
+ - **Accept**: application/json
1317
+
1318
+
1101
1319
  ## crypto_symbols
1102
1320
 
1103
1321
  > <Array<CryptoSymbol>> crypto_symbols(exchange)
@@ -1250,7 +1468,7 @@ end
1250
1468
 
1251
1469
  ## economic_calendar
1252
1470
 
1253
- > <EconomicCalendar> economic_calendar
1471
+ > <EconomicCalendar> economic_calendar(opts)
1254
1472
 
1255
1473
  Economic Calendar
1256
1474
 
@@ -1270,10 +1488,14 @@ FinnhubRuby.configure do |config|
1270
1488
  end
1271
1489
 
1272
1490
  api_instance = FinnhubRuby::DefaultApi.new
1491
+ opts = {
1492
+ from: Date.parse('2013-10-20'), # Date | From date <code>YYYY-MM-DD</code>.
1493
+ to: Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
1494
+ }
1273
1495
 
1274
1496
  begin
1275
1497
  # Economic Calendar
1276
- result = api_instance.economic_calendar
1498
+ result = api_instance.economic_calendar(opts)
1277
1499
  p result
1278
1500
  rescue FinnhubRuby::ApiError => e
1279
1501
  puts "Error when calling DefaultApi->economic_calendar: #{e}"
@@ -1284,12 +1506,12 @@ end
1284
1506
 
1285
1507
  This returns an Array which contains the response data, status code and headers.
1286
1508
 
1287
- > <Array(<EconomicCalendar>, Integer, Hash)> economic_calendar_with_http_info
1509
+ > <Array(<EconomicCalendar>, Integer, Hash)> economic_calendar_with_http_info(opts)
1288
1510
 
1289
1511
  ```ruby
1290
1512
  begin
1291
1513
  # Economic Calendar
1292
- data, status_code, headers = api_instance.economic_calendar_with_http_info
1514
+ data, status_code, headers = api_instance.economic_calendar_with_http_info(opts)
1293
1515
  p status_code # => 2xx
1294
1516
  p headers # => { ... }
1295
1517
  p data # => <EconomicCalendar>
@@ -1300,7 +1522,10 @@ end
1300
1522
 
1301
1523
  ### Parameters
1302
1524
 
1303
- This endpoint does not need any parameter.
1525
+ | Name | Type | Description | Notes |
1526
+ | ---- | ---- | ----------- | ----- |
1527
+ | **from** | **Date** | From date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. | [optional] |
1528
+ | **to** | **Date** | To date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. | [optional] |
1304
1529
 
1305
1530
  ### Return type
1306
1531
 
@@ -2653,7 +2878,7 @@ FinnhubRuby.configure do |config|
2653
2878
  end
2654
2879
 
2655
2880
  api_instance = FinnhubRuby::DefaultApi.new
2656
- symbol = 'symbol_example' # String | Symbol of the company: AAPL.
2881
+ symbol = 'symbol_example' # String | Symbol of the company: AAPL. Leave this param blank to get the latest transactions.
2657
2882
  opts = {
2658
2883
  from: Date.parse('2013-10-20'), # Date | From date: 2020-03-15.
2659
2884
  to: Date.parse('2013-10-20') # Date | To date: 2020-03-16.
@@ -2690,7 +2915,7 @@ end
2690
2915
 
2691
2916
  | Name | Type | Description | Notes |
2692
2917
  | ---- | ---- | ----------- | ----- |
2693
- | **symbol** | **String** | Symbol of the company: AAPL. | |
2918
+ | **symbol** | **String** | Symbol of the company: AAPL. Leave this param blank to get the latest transactions. | |
2694
2919
  | **from** | **Date** | From date: 2020-03-15. | [optional] |
2695
2920
  | **to** | **Date** | To date: 2020-03-16. | [optional] |
2696
2921
 
@@ -2951,7 +3176,7 @@ end
2951
3176
  api_instance = FinnhubRuby::DefaultApi.new
2952
3177
  category = 'category_example' # String | This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>.
2953
3178
  opts = {
2954
- min_id: 'min_id_example' # String | Use this field to get only news after this ID. Default to 0
3179
+ min_id: 789 # Integer | Use this field to get only news after this ID. Default to 0
2955
3180
  }
2956
3181
 
2957
3182
  begin
@@ -2986,7 +3211,7 @@ end
2986
3211
  | Name | Type | Description | Notes |
2987
3212
  | ---- | ---- | ----------- | ----- |
2988
3213
  | **category** | **String** | This parameter can be 1 of the following values &lt;code&gt;general, forex, crypto, merger&lt;/code&gt;. | |
2989
- | **min_id** | **String** | Use this field to get only news after this ID. Default to 0 | [optional] |
3214
+ | **min_id** | **Integer** | Use this field to get only news after this ID. Default to 0 | [optional] |
2990
3215
 
2991
3216
  ### Return type
2992
3217
 
@@ -4178,11 +4403,11 @@ end
4178
4403
 
4179
4404
  ## stock_candles
4180
4405
 
4181
- > <StockCandles> stock_candles(symbol, resolution, from, to, opts)
4406
+ > <StockCandles> stock_candles(symbol, resolution, from, to)
4182
4407
 
4183
4408
  Stock Candles
4184
4409
 
4185
- <p>Get candlestick data (OHLCV) for stocks
4410
+ <p>Get candlestick data (OHLCV) for stocks.</p><p>Daily data will be adjusted for Splits. Intraday data will remain unadjusted.</p>
4186
4411
 
4187
4412
  ### Examples
4188
4413
 
@@ -4202,13 +4427,10 @@ symbol = 'symbol_example' # String | Symbol.
4202
4427
  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
4428
  from = 789 # Integer | UNIX timestamp. Interval initial value.
4204
4429
  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
4430
 
4209
4431
  begin
4210
4432
  # Stock Candles
4211
- result = api_instance.stock_candles(symbol, resolution, from, to, opts)
4433
+ result = api_instance.stock_candles(symbol, resolution, from, to)
4212
4434
  p result
4213
4435
  rescue FinnhubRuby::ApiError => e
4214
4436
  puts "Error when calling DefaultApi->stock_candles: #{e}"
@@ -4219,12 +4441,12 @@ end
4219
4441
 
4220
4442
  This returns an Array which contains the response data, status code and headers.
4221
4443
 
4222
- > <Array(<StockCandles>, Integer, Hash)> stock_candles_with_http_info(symbol, resolution, from, to, opts)
4444
+ > <Array(<StockCandles>, Integer, Hash)> stock_candles_with_http_info(symbol, resolution, from, to)
4223
4445
 
4224
4446
  ```ruby
4225
4447
  begin
4226
4448
  # Stock Candles
4227
- data, status_code, headers = api_instance.stock_candles_with_http_info(symbol, resolution, from, to, opts)
4449
+ data, status_code, headers = api_instance.stock_candles_with_http_info(symbol, resolution, from, to)
4228
4450
  p status_code # => 2xx
4229
4451
  p headers # => { ... }
4230
4452
  p data # => <StockCandles>
@@ -4241,7 +4463,6 @@ end
4241
4463
  | **resolution** | **String** | Supported resolution includes &lt;code&gt;1, 5, 15, 30, 60, D, W, M &lt;/code&gt;.Some timeframes might not be available depending on the exchange. | |
4242
4464
  | **from** | **Integer** | UNIX timestamp. Interval initial value. | |
4243
4465
  | **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
4466
 
4246
4467
  ### Return type
4247
4468
 
@@ -4569,7 +4790,7 @@ end
4569
4790
 
4570
4791
  Tick Data
4571
4792
 
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><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>
4793
+ <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
4794
 
4574
4795
  ### Examples
4575
4796
 
@@ -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** | **Integer** | Revenue estimate including Finnhub&#39;s proprietary estimates. | [optional] |
15
- | **revenue_actual** | **Integer** | Revenue actual. | [optional] |
14
+ | **revenue_estimate** | **Float** | Revenue estimate including Finnhub&#39;s proprietary estimates. | [optional] |
15
+ | **revenue_actual** | **Float** | Revenue actual. | [optional] |
16
16
 
17
17
  ## Example
18
18
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **data** | [**Array&lt;EarningEstimate&gt;**](EarningEstimate.md) | List of estimates | [optional] |
7
+ | **data** | [**Array&lt;EarningsEstimatesInfo&gt;**](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&#39;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&#39;s name. | [optional] |
11
11
  | **status** | **String** | IPO status. Can take 1 of the following values: &lt;code&gt;expected&lt;/code&gt;,&lt;code&gt;priced&lt;/code&gt;,&lt;code&gt;withdrawn&lt;/code&gt;,&lt;code&gt;filed&lt;/code&gt; | [optional] |
12
12
  | **price** | **String** | Projected price or price range. | [optional] |
13
- | **number_of_shares** | **Integer** | Number of shares offered during the IPO. | [optional] |
14
- | **total_shares_value** | **Integer** | Total shares value. | [optional] |
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
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **data** | [**Array&lt;Estimate&gt;**](Estimate.md) | List of estimates | [optional] |
7
+ | **data** | [**Array&lt;RevenueEstimatesInfo&gt;**](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&#39;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** | **Integer** | | [optional] |
8
- | **bullish_percent** | **Integer** | | [optional] |
7
+ | **bearish_percent** | **Float** | | [optional] |
8
+ | **bullish_percent** | **Float** | | [optional] |
9
9
 
10
10
  ## Example
11
11
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **symbol** | **String** | Symbol. | [optional] |
8
8
  | **cik** | **String** | CIK. | [optional] |
9
- | **similarity** | [**Array&lt;Filing&gt;**](Filing.md) | Array of filings with its cosine similarity compared to the same report of the previous year. | [optional] |
9
+ | **similarity** | [**Array&lt;SimilarityIndexInfo&gt;**](SimilarityIndexInfo.md) | Array of filings with its cosine similarity compared to the same report of the previous year. | [optional] |
10
10
 
11
11
  ## Example
12
12
 
@@ -0,0 +1,40 @@
1
+ # FinnhubRuby::SimilarityIndexInfo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **cik** | **String** | CIK. | [optional] |
8
+ | **item1** | **Float** | Cosine similarity of Item 1 (Business). This number is only available for Annual reports. | [optional] |
9
+ | **item1a** | **Float** | Cosine similarity of Item 1A (Risk Factors). This number is available for both Annual and Quarterly reports. | [optional] |
10
+ | **item2** | **Float** | Cosine similarity of Item 2 (Management’s Discussion and Analysis of Financial Condition and Results of Operations). This number is only available for Quarterly reports. | [optional] |
11
+ | **item7** | **Float** | Cosine similarity of Item 7 (Management’s Discussion and Analysis of Financial Condition and Results of Operations). This number is only available for Annual reports. | [optional] |
12
+ | **item7a** | **Float** | Cosine similarity of Item 7A (Quantitative and Qualitative Disclosures About Market Risk). This number is only available for Annual reports. | [optional] |
13
+ | **access_number** | **String** | Access number. | [optional] |
14
+ | **form** | **String** | Form type. | [optional] |
15
+ | **filed_date** | **String** | Filed date &lt;code&gt;%Y-%m-%d %H:%M:%S&lt;/code&gt;. | [optional] |
16
+ | **accepted_date** | **String** | Accepted date &lt;code&gt;%Y-%m-%d %H:%M:%S&lt;/code&gt;. | [optional] |
17
+ | **report_url** | **String** | Report&#39;s URL. | [optional] |
18
+ | **filing_url** | **String** | Filing&#39;s URL. | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'finnhub_ruby'
24
+
25
+ instance = FinnhubRuby::SimilarityIndexInfo.new(
26
+ cik: null,
27
+ item1: null,
28
+ item1a: null,
29
+ item2: null,
30
+ item7: null,
31
+ item7a: null,
32
+ access_number: null,
33
+ form: null,
34
+ filed_date: null,
35
+ accepted_date: null,
36
+ report_url: null,
37
+ filing_url: null
38
+ )
39
+ ```
40
+
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