finnhub_ruby 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (200) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/LICENSE +201 -0
  4. data/README.md +164 -0
  5. data/Rakefile +10 -0
  6. data/docs/AggregateIndicators.md +19 -0
  7. data/docs/BasicFinancials.md +21 -0
  8. data/docs/Company.md +29 -0
  9. data/docs/CompanyExecutive.md +19 -0
  10. data/docs/CompanyNewsStatistics.md +21 -0
  11. data/docs/CompanyProfile.md +71 -0
  12. data/docs/CompanyProfile2.md +39 -0
  13. data/docs/CountryMetadata.md +27 -0
  14. data/docs/CovidInfo.md +23 -0
  15. data/docs/CryptoCandles.md +29 -0
  16. data/docs/CryptoSymbol.md +21 -0
  17. data/docs/DefaultApi.md +2662 -0
  18. data/docs/Development.md +23 -0
  19. data/docs/Dividends.md +31 -0
  20. data/docs/EarningEstimate.md +25 -0
  21. data/docs/EarningRelease.md +33 -0
  22. data/docs/EarningResult.md +23 -0
  23. data/docs/EarningsCalendar.md +17 -0
  24. data/docs/EarningsCallTranscripts.md +33 -0
  25. data/docs/EarningsCallTranscriptsList.md +19 -0
  26. data/docs/EarningsEstimates.md +21 -0
  27. data/docs/EconomicCalendar.md +17 -0
  28. data/docs/EconomicCode.md +23 -0
  29. data/docs/EconomicData.md +19 -0
  30. data/docs/EconomicEvent.md +31 -0
  31. data/docs/Estimate.md +25 -0
  32. data/docs/Filing.md +31 -0
  33. data/docs/FinancialStatements.md +19 -0
  34. data/docs/FinancialsAsReported.md +21 -0
  35. data/docs/ForexCandles.md +29 -0
  36. data/docs/ForexSymbol.md +21 -0
  37. data/docs/Forexrates.md +19 -0
  38. data/docs/FundOwnership.md +19 -0
  39. data/docs/IPOCalendar.md +17 -0
  40. data/docs/IPOEvent.md +31 -0
  41. data/docs/Indicator.md +21 -0
  42. data/docs/Investor.md +23 -0
  43. data/docs/InvestorsOwnership.md +19 -0
  44. data/docs/LastBidAsk.md +25 -0
  45. data/docs/MajorDevelopments.md +19 -0
  46. data/docs/News.md +33 -0
  47. data/docs/NewsSentiment.md +27 -0
  48. data/docs/PatternRecognition.md +17 -0
  49. data/docs/PriceTarget.md +27 -0
  50. data/docs/Quote.md +25 -0
  51. data/docs/RecommendationTrend.md +29 -0
  52. data/docs/Report.md +37 -0
  53. data/docs/RevenueEstimates.md +21 -0
  54. data/docs/Sentiment.md +19 -0
  55. data/docs/Split.md +23 -0
  56. data/docs/Stock.md +21 -0
  57. data/docs/StockCandles.md +29 -0
  58. data/docs/StockTranscripts.md +25 -0
  59. data/docs/SupportResistance.md +17 -0
  60. data/docs/TechnicalAnalysis.md +19 -0
  61. data/docs/TickData.md +31 -0
  62. data/docs/TranscriptContent.md +19 -0
  63. data/docs/TranscriptParticipant.md +19 -0
  64. data/docs/Trend.md +17 -0
  65. data/docs/UpgradeDowngrade.md +27 -0
  66. data/finnhub_ruby-0.0.1.gem +0 -0
  67. data/finnhub_ruby-0.0.2.gem +0 -0
  68. data/finnhub_ruby.gemspec +39 -0
  69. data/git_push.sh +58 -0
  70. data/lib/finnhub_ruby.rb +99 -0
  71. data/lib/finnhub_ruby/api/default_api.rb +3142 -0
  72. data/lib/finnhub_ruby/api_client.rb +389 -0
  73. data/lib/finnhub_ruby/api_error.rb +57 -0
  74. data/lib/finnhub_ruby/configuration.rb +248 -0
  75. data/lib/finnhub_ruby/models/aggregate_indicators.rb +215 -0
  76. data/lib/finnhub_ruby/models/basic_financials.rb +226 -0
  77. data/lib/finnhub_ruby/models/company.rb +267 -0
  78. data/lib/finnhub_ruby/models/company_executive.rb +219 -0
  79. data/lib/finnhub_ruby/models/company_news_statistics.rb +227 -0
  80. data/lib/finnhub_ruby/models/company_profile.rb +477 -0
  81. data/lib/finnhub_ruby/models/company_profile2.rb +317 -0
  82. data/lib/finnhub_ruby/models/country_metadata.rb +257 -0
  83. data/lib/finnhub_ruby/models/covid_info.rb +237 -0
  84. data/lib/finnhub_ruby/models/crypto_candles.rb +279 -0
  85. data/lib/finnhub_ruby/models/crypto_symbol.rb +227 -0
  86. data/lib/finnhub_ruby/models/development.rb +237 -0
  87. data/lib/finnhub_ruby/models/dividends.rb +277 -0
  88. data/lib/finnhub_ruby/models/earning_estimate.rb +247 -0
  89. data/lib/finnhub_ruby/models/earning_release.rb +287 -0
  90. data/lib/finnhub_ruby/models/earning_result.rb +237 -0
  91. data/lib/finnhub_ruby/models/earnings_calendar.rb +209 -0
  92. data/lib/finnhub_ruby/models/earnings_call_transcripts.rb +291 -0
  93. data/lib/finnhub_ruby/models/earnings_call_transcripts_list.rb +219 -0
  94. data/lib/finnhub_ruby/models/earnings_estimates.rb +229 -0
  95. data/lib/finnhub_ruby/models/economic_calendar.rb +209 -0
  96. data/lib/finnhub_ruby/models/economic_code.rb +237 -0
  97. data/lib/finnhub_ruby/models/economic_data.rb +219 -0
  98. data/lib/finnhub_ruby/models/economic_event.rb +277 -0
  99. data/lib/finnhub_ruby/models/estimate.rb +247 -0
  100. data/lib/finnhub_ruby/models/filing.rb +277 -0
  101. data/lib/finnhub_ruby/models/financial_statements.rb +219 -0
  102. data/lib/finnhub_ruby/models/financials_as_reported.rb +229 -0
  103. data/lib/finnhub_ruby/models/forex_candles.rb +279 -0
  104. data/lib/finnhub_ruby/models/forex_symbol.rb +227 -0
  105. data/lib/finnhub_ruby/models/forexrates.rb +216 -0
  106. data/lib/finnhub_ruby/models/fund_ownership.rb +219 -0
  107. data/lib/finnhub_ruby/models/indicator.rb +227 -0
  108. data/lib/finnhub_ruby/models/investor.rb +237 -0
  109. data/lib/finnhub_ruby/models/investors_ownership.rb +219 -0
  110. data/lib/finnhub_ruby/models/ipo_calendar.rb +209 -0
  111. data/lib/finnhub_ruby/models/ipo_event.rb +277 -0
  112. data/lib/finnhub_ruby/models/last_bid_ask.rb +247 -0
  113. data/lib/finnhub_ruby/models/major_developments.rb +219 -0
  114. data/lib/finnhub_ruby/models/news.rb +287 -0
  115. data/lib/finnhub_ruby/models/news_sentiment.rb +255 -0
  116. data/lib/finnhub_ruby/models/pattern_recognition.rb +209 -0
  117. data/lib/finnhub_ruby/models/price_target.rb +257 -0
  118. data/lib/finnhub_ruby/models/quote.rb +247 -0
  119. data/lib/finnhub_ruby/models/recommendation_trend.rb +267 -0
  120. data/lib/finnhub_ruby/models/report.rb +306 -0
  121. data/lib/finnhub_ruby/models/revenue_estimates.rb +229 -0
  122. data/lib/finnhub_ruby/models/sentiment.rb +217 -0
  123. data/lib/finnhub_ruby/models/split.rb +237 -0
  124. data/lib/finnhub_ruby/models/stock.rb +227 -0
  125. data/lib/finnhub_ruby/models/stock_candles.rb +279 -0
  126. data/lib/finnhub_ruby/models/stock_transcripts.rb +247 -0
  127. data/lib/finnhub_ruby/models/support_resistance.rb +209 -0
  128. data/lib/finnhub_ruby/models/technical_analysis.rb +216 -0
  129. data/lib/finnhub_ruby/models/tick_data.rb +285 -0
  130. data/lib/finnhub_ruby/models/transcript_content.rb +219 -0
  131. data/lib/finnhub_ruby/models/transcript_participant.rb +217 -0
  132. data/lib/finnhub_ruby/models/trend.rb +207 -0
  133. data/lib/finnhub_ruby/models/upgrade_downgrade.rb +257 -0
  134. data/lib/finnhub_ruby/version.rb +15 -0
  135. data/release.sh +2 -0
  136. data/spec/api/default_api_spec.rb +638 -0
  137. data/spec/api_client_spec.rb +226 -0
  138. data/spec/configuration_spec.rb +42 -0
  139. data/spec/models/aggregate_indicators_spec.rb +47 -0
  140. data/spec/models/basic_financials_spec.rb +53 -0
  141. data/spec/models/company_executive_spec.rb +47 -0
  142. data/spec/models/company_news_statistics_spec.rb +53 -0
  143. data/spec/models/company_profile2_spec.rb +107 -0
  144. data/spec/models/company_profile_spec.rb +203 -0
  145. data/spec/models/company_spec.rb +77 -0
  146. data/spec/models/country_metadata_spec.rb +71 -0
  147. data/spec/models/covid_info_spec.rb +59 -0
  148. data/spec/models/crypto_candles_spec.rb +77 -0
  149. data/spec/models/crypto_symbol_spec.rb +53 -0
  150. data/spec/models/development_spec.rb +59 -0
  151. data/spec/models/dividends_spec.rb +83 -0
  152. data/spec/models/earning_estimate_spec.rb +65 -0
  153. data/spec/models/earning_release_spec.rb +89 -0
  154. data/spec/models/earning_result_spec.rb +59 -0
  155. data/spec/models/earnings_calendar_spec.rb +41 -0
  156. data/spec/models/earnings_call_transcripts_list_spec.rb +47 -0
  157. data/spec/models/earnings_call_transcripts_spec.rb +89 -0
  158. data/spec/models/earnings_estimates_spec.rb +53 -0
  159. data/spec/models/economic_calendar_spec.rb +41 -0
  160. data/spec/models/economic_code_spec.rb +59 -0
  161. data/spec/models/economic_data_spec.rb +47 -0
  162. data/spec/models/economic_event_spec.rb +83 -0
  163. data/spec/models/estimate_spec.rb +65 -0
  164. data/spec/models/filing_spec.rb +83 -0
  165. data/spec/models/financial_statements_spec.rb +47 -0
  166. data/spec/models/financials_as_reported_spec.rb +53 -0
  167. data/spec/models/forex_candles_spec.rb +77 -0
  168. data/spec/models/forex_symbol_spec.rb +53 -0
  169. data/spec/models/forexrates_spec.rb +47 -0
  170. data/spec/models/fund_ownership_spec.rb +47 -0
  171. data/spec/models/indicator_spec.rb +53 -0
  172. data/spec/models/investor_spec.rb +59 -0
  173. data/spec/models/investors_ownership_spec.rb +47 -0
  174. data/spec/models/ipo_calendar_spec.rb +41 -0
  175. data/spec/models/ipo_event_spec.rb +83 -0
  176. data/spec/models/last_bid_ask_spec.rb +65 -0
  177. data/spec/models/major_developments_spec.rb +47 -0
  178. data/spec/models/news_sentiment_spec.rb +71 -0
  179. data/spec/models/news_spec.rb +89 -0
  180. data/spec/models/pattern_recognition_spec.rb +41 -0
  181. data/spec/models/price_target_spec.rb +71 -0
  182. data/spec/models/quote_spec.rb +65 -0
  183. data/spec/models/recommendation_trend_spec.rb +77 -0
  184. data/spec/models/report_spec.rb +101 -0
  185. data/spec/models/revenue_estimates_spec.rb +53 -0
  186. data/spec/models/sentiment_spec.rb +47 -0
  187. data/spec/models/split_spec.rb +59 -0
  188. data/spec/models/stock_candles_spec.rb +77 -0
  189. data/spec/models/stock_spec.rb +53 -0
  190. data/spec/models/stock_transcripts_spec.rb +65 -0
  191. data/spec/models/support_resistance_spec.rb +41 -0
  192. data/spec/models/technical_analysis_spec.rb +47 -0
  193. data/spec/models/tick_data_spec.rb +83 -0
  194. data/spec/models/transcript_content_spec.rb +47 -0
  195. data/spec/models/transcript_participant_spec.rb +47 -0
  196. data/spec/models/trend_spec.rb +41 -0
  197. data/spec/models/upgrade_downgrade_spec.rb +71 -0
  198. data/spec/spec_helper.rb +111 -0
  199. data/test.rb +139 -0
  200. metadata +364 -0
@@ -0,0 +1,19 @@
1
+ # FinnhubRuby::CompanyExecutive
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **symbol** | **String** | Company symbol. | [optional]
8
+ **executive** | **Array<Object>** | Array of company's executives and members of the Board. | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'FinnhubRuby'
14
+
15
+ instance = FinnhubRuby::CompanyExecutive.new(symbol: null,
16
+ executive: null)
17
+ ```
18
+
19
+
@@ -0,0 +1,21 @@
1
+ # FinnhubRuby::CompanyNewsStatistics
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **articles_in_last_week** | **Integer** | | [optional]
8
+ **buzz** | **Float** | | [optional]
9
+ **weekly_average** | **Float** | | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'FinnhubRuby'
15
+
16
+ instance = FinnhubRuby::CompanyNewsStatistics.new(articles_in_last_week: null,
17
+ buzz: null,
18
+ weekly_average: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,71 @@
1
+ # FinnhubRuby::CompanyProfile
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **address** | **String** | Address of company's headquarter. | [optional]
8
+ **city** | **String** | City of company's headquarter. | [optional]
9
+ **country** | **String** | Country of company's headquarter. | [optional]
10
+ **currency** | **String** | Currency used in company filings. | [optional]
11
+ **cusip** | **String** | CUSIP number. | [optional]
12
+ **sedol** | **Integer** | Sedol number. | [optional]
13
+ **description** | **String** | Company business summary. | [optional]
14
+ **exchange** | **String** | Listed exchange. | [optional]
15
+ **ggroup** | **String** | GICS industry group. | [optional]
16
+ **gind** | **String** | GICS industry. | [optional]
17
+ **gsector** | **String** | GICS sector. | [optional]
18
+ **gsubind** | **String** | GICS sub-industry. | [optional]
19
+ **isin** | **String** | ISIN number. | [optional]
20
+ **naics_national_industry** | **String** | NAICS national industry. | [optional]
21
+ **naics** | **String** | NAICS industry. | [optional]
22
+ **naics_sector** | **String** | NAICS sector. | [optional]
23
+ **naics_subsector** | **String** | NAICS subsector. | [optional]
24
+ **name** | **String** | Company name. | [optional]
25
+ **phone** | **String** | Company phone number. | [optional]
26
+ **state** | **String** | State of company's headquarter. | [optional]
27
+ **ticker** | **String** | Company symbol/ticker as used on the listed exchange. | [optional]
28
+ **weburl** | **String** | Company website. | [optional]
29
+ **ipo** | **Date** | IPO date. | [optional]
30
+ **market_capitalization** | **Float** | Market Capitalization. | [optional]
31
+ **share_outstanding** | **Float** | Number of oustanding shares. | [optional]
32
+ **employee_total** | **Integer** | Number of employee. | [optional]
33
+ **logo** | **String** | Logo image. | [optional]
34
+ **finnhub_industry** | **String** | Finnhub industry classification. | [optional]
35
+
36
+ ## Code Sample
37
+
38
+ ```ruby
39
+ require 'FinnhubRuby'
40
+
41
+ instance = FinnhubRuby::CompanyProfile.new(address: null,
42
+ city: null,
43
+ country: null,
44
+ currency: null,
45
+ cusip: null,
46
+ sedol: null,
47
+ description: null,
48
+ exchange: null,
49
+ ggroup: null,
50
+ gind: null,
51
+ gsector: null,
52
+ gsubind: null,
53
+ isin: null,
54
+ naics_national_industry: null,
55
+ naics: null,
56
+ naics_sector: null,
57
+ naics_subsector: null,
58
+ name: null,
59
+ phone: null,
60
+ state: null,
61
+ ticker: null,
62
+ weburl: null,
63
+ ipo: null,
64
+ market_capitalization: null,
65
+ share_outstanding: null,
66
+ employee_total: null,
67
+ logo: null,
68
+ finnhub_industry: null)
69
+ ```
70
+
71
+
@@ -0,0 +1,39 @@
1
+ # FinnhubRuby::CompanyProfile2
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **country** | **String** | Country of company's headquarter. | [optional]
8
+ **currency** | **String** | Currency used in company filings. | [optional]
9
+ **exchange** | **String** | Listed exchange. | [optional]
10
+ **name** | **String** | Company name. | [optional]
11
+ **ticker** | **String** | Company symbol/ticker as used on the listed exchange. | [optional]
12
+ **ipo** | **Date** | IPO date. | [optional]
13
+ **market_capitalization** | **Float** | Market Capitalization. | [optional]
14
+ **share_outstanding** | **Float** | Number of oustanding shares. | [optional]
15
+ **logo** | **String** | Logo image. | [optional]
16
+ **phone** | **String** | Company phone number. | [optional]
17
+ **weburl** | **String** | Company website. | [optional]
18
+ **finnhub_industry** | **String** | Finnhub industry classification. | [optional]
19
+
20
+ ## Code Sample
21
+
22
+ ```ruby
23
+ require 'FinnhubRuby'
24
+
25
+ instance = FinnhubRuby::CompanyProfile2.new(country: null,
26
+ currency: null,
27
+ exchange: null,
28
+ name: null,
29
+ ticker: null,
30
+ ipo: null,
31
+ market_capitalization: null,
32
+ share_outstanding: null,
33
+ logo: null,
34
+ phone: null,
35
+ weburl: null,
36
+ finnhub_industry: null)
37
+ ```
38
+
39
+
@@ -0,0 +1,27 @@
1
+ # FinnhubRuby::CountryMetadata
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **country** | **String** | Country name | [optional]
8
+ **code2** | **String** | Alpha 2 code | [optional]
9
+ **code3** | **String** | Alpha 3 code | [optional]
10
+ **code_no** | **String** | UN code | [optional]
11
+ **currency** | **String** | Currency name | [optional]
12
+ **currency_code** | **String** | Currency code | [optional]
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'FinnhubRuby'
18
+
19
+ instance = FinnhubRuby::CountryMetadata.new(country: null,
20
+ code2: null,
21
+ code3: null,
22
+ code_no: null,
23
+ currency: null,
24
+ currency_code: null)
25
+ ```
26
+
27
+
@@ -0,0 +1,23 @@
1
+ # FinnhubRuby::CovidInfo
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **state** | **String** | State. | [optional]
8
+ **_case** | **Float** | Number of confirmed cases. | [optional]
9
+ **death** | **Float** | Number of confirmed deaths. | [optional]
10
+ **updated** | **DateTime** | Updated time. | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'FinnhubRuby'
16
+
17
+ instance = FinnhubRuby::CovidInfo.new(state: null,
18
+ _case: null,
19
+ death: null,
20
+ updated: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,29 @@
1
+ # FinnhubRuby::CryptoCandles
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **o** | **Array<Float>** | List of open prices for returned candles. | [optional]
8
+ **h** | **Array<Float>** | List of high prices for returned candles. | [optional]
9
+ **l** | **Array<Float>** | List of low prices for returned candles. | [optional]
10
+ **c** | **Array<Float>** | List of close prices for returned candles. | [optional]
11
+ **v** | **Array<Float>** | List of volume data for returned candles. | [optional]
12
+ **t** | **Array<Integer>** | List of timestamp for returned candles. | [optional]
13
+ **s** | **String** | Status of the response. This field can either be ok or no_data. | [optional]
14
+
15
+ ## Code Sample
16
+
17
+ ```ruby
18
+ require 'FinnhubRuby'
19
+
20
+ instance = FinnhubRuby::CryptoCandles.new(o: null,
21
+ h: null,
22
+ l: null,
23
+ c: null,
24
+ v: null,
25
+ t: null,
26
+ s: null)
27
+ ```
28
+
29
+
@@ -0,0 +1,21 @@
1
+ # FinnhubRuby::CryptoSymbol
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **description** | **String** | Symbol description | [optional]
8
+ **display_symbol** | **String** | Display symbol name. | [optional]
9
+ **symbol** | **String** | Unique symbol used to identify this symbol used in <code>/crypto/candle</code> endpoint. | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'FinnhubRuby'
15
+
16
+ instance = FinnhubRuby::CryptoSymbol.new(description: null,
17
+ display_symbol: null,
18
+ symbol: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,2662 @@
1
+ # FinnhubRuby::DefaultApi
2
+
3
+ All URIs are relative to *https://finnhub.io/api/v1*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**aggregate_indicator**](DefaultApi.md#aggregate_indicator) | **GET** /scan/technical-indicator | Aggregate Indicators
8
+ [**company_basic_financials**](DefaultApi.md#company_basic_financials) | **GET** /stock/metric | Basic Financials
9
+ [**company_earnings**](DefaultApi.md#company_earnings) | **GET** /stock/earnings | Earnings Surprises
10
+ [**company_eps_estimates**](DefaultApi.md#company_eps_estimates) | **GET** /stock/eps-estimate | Earnings Estimates
11
+ [**company_executive**](DefaultApi.md#company_executive) | **GET** /stock/executive | Company Executive
12
+ [**company_news**](DefaultApi.md#company_news) | **GET** /company-news | Company News
13
+ [**company_peers**](DefaultApi.md#company_peers) | **GET** /stock/peers | Peers
14
+ [**company_profile**](DefaultApi.md#company_profile) | **GET** /stock/profile | Company Profile
15
+ [**company_profile2**](DefaultApi.md#company_profile2) | **GET** /stock/profile2 | Company Profile 2
16
+ [**company_revenue_estimates**](DefaultApi.md#company_revenue_estimates) | **GET** /stock/revenue-estimate | Revenue Estimates
17
+ [**country**](DefaultApi.md#country) | **GET** /country | Country Metadata
18
+ [**covid19**](DefaultApi.md#covid19) | **GET** /covid19/us | COVID-19
19
+ [**crypto_candles**](DefaultApi.md#crypto_candles) | **GET** /crypto/candle | Crypto Candles
20
+ [**crypto_exchanges**](DefaultApi.md#crypto_exchanges) | **GET** /crypto/exchange | Crypto Exchanges
21
+ [**crypto_symbols**](DefaultApi.md#crypto_symbols) | **GET** /crypto/symbol | Crypto Symbol
22
+ [**earnings_calendar**](DefaultApi.md#earnings_calendar) | **GET** /calendar/earnings | Earnings Calendar
23
+ [**economic_code**](DefaultApi.md#economic_code) | **GET** /economic/code | Economic Code
24
+ [**economic_data**](DefaultApi.md#economic_data) | **GET** /economic | Economic Data
25
+ [**filings**](DefaultApi.md#filings) | **GET** /stock/filings | Filings
26
+ [**financials**](DefaultApi.md#financials) | **GET** /stock/financials | Financial Statements
27
+ [**financials_reported**](DefaultApi.md#financials_reported) | **GET** /stock/financials-reported | Financials As Reported
28
+ [**forex_candles**](DefaultApi.md#forex_candles) | **GET** /forex/candle | Forex Candles
29
+ [**forex_exchanges**](DefaultApi.md#forex_exchanges) | **GET** /forex/exchange | Forex Exchanges
30
+ [**forex_rates**](DefaultApi.md#forex_rates) | **GET** /forex/rates | Forex rates
31
+ [**forex_symbols**](DefaultApi.md#forex_symbols) | **GET** /forex/symbol | Forex Symbol
32
+ [**fund_ownership**](DefaultApi.md#fund_ownership) | **GET** /stock/fund-ownership | Fund Ownership
33
+ [**general_news**](DefaultApi.md#general_news) | **GET** /news | General News
34
+ [**investors_ownership**](DefaultApi.md#investors_ownership) | **GET** /stock/investor-ownership | Investors Ownership
35
+ [**ipo_calendar**](DefaultApi.md#ipo_calendar) | **GET** /calendar/ipo | IPO Calendar
36
+ [**major_developments**](DefaultApi.md#major_developments) | **GET** /major-development | Major Developments
37
+ [**news_sentiment**](DefaultApi.md#news_sentiment) | **GET** /news-sentiment | News Sentiment
38
+ [**pattern_recognition**](DefaultApi.md#pattern_recognition) | **GET** /scan/pattern | Pattern Recognition
39
+ [**price_target**](DefaultApi.md#price_target) | **GET** /stock/price-target | Price Target
40
+ [**quote**](DefaultApi.md#quote) | **GET** /quote | Quote
41
+ [**recommendation_trends**](DefaultApi.md#recommendation_trends) | **GET** /stock/recommendation | Recommendation Trends
42
+ [**stock_bidask**](DefaultApi.md#stock_bidask) | **GET** /stock/bidask | Last Bid-Ask
43
+ [**stock_candles**](DefaultApi.md#stock_candles) | **GET** /stock/candle | Stock Candles
44
+ [**stock_dividends**](DefaultApi.md#stock_dividends) | **GET** /stock/dividend | Dividends
45
+ [**stock_splits**](DefaultApi.md#stock_splits) | **GET** /stock/split | Splits
46
+ [**stock_symbols**](DefaultApi.md#stock_symbols) | **GET** /stock/symbol | Stock Symbol
47
+ [**stock_tick**](DefaultApi.md#stock_tick) | **GET** /stock/tick | Tick Data
48
+ [**support_resistance**](DefaultApi.md#support_resistance) | **GET** /scan/support-resistance | Support/Resistance
49
+ [**technical_indicator**](DefaultApi.md#technical_indicator) | **POST** /indicator | Technical Indicators
50
+ [**transcripts**](DefaultApi.md#transcripts) | **GET** /stock/transcripts | Earnings Call Transcripts
51
+ [**transcripts_list**](DefaultApi.md#transcripts_list) | **GET** /stock/transcripts/list | Earnings Call Transcripts List
52
+ [**upgrade_downgrade**](DefaultApi.md#upgrade_downgrade) | **GET** /stock/upgrade-downgrade | Stock Upgrade/Downgrade
53
+
54
+
55
+
56
+ ## aggregate_indicator
57
+
58
+ > AggregateIndicators aggregate_indicator(symbol, resolution)
59
+
60
+ Aggregate Indicators
61
+
62
+ Get aggregate signal of multiple technical indicators such as MACD, RSI, Moving Average v.v.
63
+
64
+ ### Example
65
+
66
+ ```ruby
67
+ # load the gem
68
+ require 'finnhub_ruby'
69
+ # setup authorization
70
+ FinnhubRuby.configure do |config|
71
+ # Configure API key authorization: api_key
72
+ config.api_key['token'] = 'YOUR API KEY'
73
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
74
+ #config.api_key_prefix['token'] = 'Bearer'
75
+ end
76
+
77
+ api_instance = FinnhubRuby::DefaultApi.new
78
+ symbol = 'symbol_example' # String | symbol
79
+ 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.
80
+
81
+ begin
82
+ #Aggregate Indicators
83
+ result = api_instance.aggregate_indicator(symbol, resolution)
84
+ p result
85
+ rescue FinnhubRuby::ApiError => e
86
+ puts "Exception when calling DefaultApi->aggregate_indicator: #{e}"
87
+ end
88
+ ```
89
+
90
+ ### Parameters
91
+
92
+
93
+ Name | Type | Description | Notes
94
+ ------------- | ------------- | ------------- | -------------
95
+ **symbol** | **String**| symbol |
96
+ **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. |
97
+
98
+ ### Return type
99
+
100
+ [**AggregateIndicators**](AggregateIndicators.md)
101
+
102
+ ### Authorization
103
+
104
+ [api_key](../README.md#api_key)
105
+
106
+ ### HTTP request headers
107
+
108
+ - **Content-Type**: Not defined
109
+ - **Accept**: application/json
110
+
111
+
112
+ ## company_basic_financials
113
+
114
+ > BasicFinancials company_basic_financials(symbol, metric)
115
+
116
+ Basic Financials
117
+
118
+ Get company basic financials such as margin, P/E ratio, 52-week high/low etc.
119
+
120
+ ### Example
121
+
122
+ ```ruby
123
+ # load the gem
124
+ require 'finnhub_ruby'
125
+ # setup authorization
126
+ FinnhubRuby.configure do |config|
127
+ # Configure API key authorization: api_key
128
+ config.api_key['token'] = 'YOUR API KEY'
129
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
130
+ #config.api_key_prefix['token'] = 'Bearer'
131
+ end
132
+
133
+ api_instance = FinnhubRuby::DefaultApi.new
134
+ symbol = 'symbol_example' # String | Symbol of the company: AAPL.
135
+ metric = 'metric_example' # String | Metric type. Can be 1 of the following values <code>all, price, valuation, margin</code>
136
+
137
+ begin
138
+ #Basic Financials
139
+ result = api_instance.company_basic_financials(symbol, metric)
140
+ p result
141
+ rescue FinnhubRuby::ApiError => e
142
+ puts "Exception when calling DefaultApi->company_basic_financials: #{e}"
143
+ end
144
+ ```
145
+
146
+ ### Parameters
147
+
148
+
149
+ Name | Type | Description | Notes
150
+ ------------- | ------------- | ------------- | -------------
151
+ **symbol** | **String**| Symbol of the company: AAPL. |
152
+ **metric** | **String**| Metric type. Can be 1 of the following values &lt;code&gt;all, price, valuation, margin&lt;/code&gt; |
153
+
154
+ ### Return type
155
+
156
+ [**BasicFinancials**](BasicFinancials.md)
157
+
158
+ ### Authorization
159
+
160
+ [api_key](../README.md#api_key)
161
+
162
+ ### HTTP request headers
163
+
164
+ - **Content-Type**: Not defined
165
+ - **Accept**: application/json
166
+
167
+
168
+ ## company_earnings
169
+
170
+ > Array&lt;EarningResult&gt; company_earnings(symbol, opts)
171
+
172
+ Earnings Surprises
173
+
174
+ Get company historical quarterly earnings surprise going back to 2000.
175
+
176
+ ### Example
177
+
178
+ ```ruby
179
+ # load the gem
180
+ require 'finnhub_ruby'
181
+ # setup authorization
182
+ FinnhubRuby.configure do |config|
183
+ # Configure API key authorization: api_key
184
+ config.api_key['token'] = 'YOUR API KEY'
185
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
186
+ #config.api_key_prefix['token'] = 'Bearer'
187
+ end
188
+
189
+ api_instance = FinnhubRuby::DefaultApi.new
190
+ symbol = 'symbol_example' # String | Symbol of the company: AAPL.
191
+ opts = {
192
+ limit: 56 # Integer | Limit number of period returned. Leave blank to get the full history.
193
+ }
194
+
195
+ begin
196
+ #Earnings Surprises
197
+ result = api_instance.company_earnings(symbol, opts)
198
+ p result
199
+ rescue FinnhubRuby::ApiError => e
200
+ puts "Exception when calling DefaultApi->company_earnings: #{e}"
201
+ end
202
+ ```
203
+
204
+ ### Parameters
205
+
206
+
207
+ Name | Type | Description | Notes
208
+ ------------- | ------------- | ------------- | -------------
209
+ **symbol** | **String**| Symbol of the company: AAPL. |
210
+ **limit** | **Integer**| Limit number of period returned. Leave blank to get the full history. | [optional]
211
+
212
+ ### Return type
213
+
214
+ [**Array&lt;EarningResult&gt;**](EarningResult.md)
215
+
216
+ ### Authorization
217
+
218
+ [api_key](../README.md#api_key)
219
+
220
+ ### HTTP request headers
221
+
222
+ - **Content-Type**: Not defined
223
+ - **Accept**: application/json
224
+
225
+
226
+ ## company_eps_estimates
227
+
228
+ > EarningsEstimates company_eps_estimates(symbol, opts)
229
+
230
+ Earnings Estimates
231
+
232
+ Get company's EPS estimates.
233
+
234
+ ### Example
235
+
236
+ ```ruby
237
+ # load the gem
238
+ require 'finnhub_ruby'
239
+ # setup authorization
240
+ FinnhubRuby.configure do |config|
241
+ # Configure API key authorization: api_key
242
+ config.api_key['token'] = 'YOUR API KEY'
243
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
244
+ #config.api_key_prefix['token'] = 'Bearer'
245
+ end
246
+
247
+ api_instance = FinnhubRuby::DefaultApi.new
248
+ symbol = 'symbol_example' # String | Symbol of the company: AAPL.
249
+ opts = {
250
+ freq: 'freq_example' # String | Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
251
+ }
252
+
253
+ begin
254
+ #Earnings Estimates
255
+ result = api_instance.company_eps_estimates(symbol, opts)
256
+ p result
257
+ rescue FinnhubRuby::ApiError => e
258
+ puts "Exception when calling DefaultApi->company_eps_estimates: #{e}"
259
+ end
260
+ ```
261
+
262
+ ### Parameters
263
+
264
+
265
+ Name | Type | Description | Notes
266
+ ------------- | ------------- | ------------- | -------------
267
+ **symbol** | **String**| Symbol of the company: AAPL. |
268
+ **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]
269
+
270
+ ### Return type
271
+
272
+ [**EarningsEstimates**](EarningsEstimates.md)
273
+
274
+ ### Authorization
275
+
276
+ [api_key](../README.md#api_key)
277
+
278
+ ### HTTP request headers
279
+
280
+ - **Content-Type**: Not defined
281
+ - **Accept**: application/json
282
+
283
+
284
+ ## company_executive
285
+
286
+ > CompanyExecutive company_executive(symbol)
287
+
288
+ Company Executive
289
+
290
+ Get a list of company's executives and members of the Board.
291
+
292
+ ### Example
293
+
294
+ ```ruby
295
+ # load the gem
296
+ require 'finnhub_ruby'
297
+ # setup authorization
298
+ FinnhubRuby.configure do |config|
299
+ # Configure API key authorization: api_key
300
+ config.api_key['token'] = 'YOUR API KEY'
301
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
302
+ #config.api_key_prefix['token'] = 'Bearer'
303
+ end
304
+
305
+ api_instance = FinnhubRuby::DefaultApi.new
306
+ symbol = 'symbol_example' # String | Symbol of the company: AAPL.
307
+
308
+ begin
309
+ #Company Executive
310
+ result = api_instance.company_executive(symbol)
311
+ p result
312
+ rescue FinnhubRuby::ApiError => e
313
+ puts "Exception when calling DefaultApi->company_executive: #{e}"
314
+ end
315
+ ```
316
+
317
+ ### Parameters
318
+
319
+
320
+ Name | Type | Description | Notes
321
+ ------------- | ------------- | ------------- | -------------
322
+ **symbol** | **String**| Symbol of the company: AAPL. |
323
+
324
+ ### Return type
325
+
326
+ [**CompanyExecutive**](CompanyExecutive.md)
327
+
328
+ ### Authorization
329
+
330
+ [api_key](../README.md#api_key)
331
+
332
+ ### HTTP request headers
333
+
334
+ - **Content-Type**: Not defined
335
+ - **Accept**: application/json
336
+
337
+
338
+ ## company_news
339
+
340
+ > Array&lt;News&gt; company_news(symbol, from, to)
341
+
342
+ Company News
343
+
344
+ List latest company news by symbol. This endpoint is only available for North American companies.
345
+
346
+ ### Example
347
+
348
+ ```ruby
349
+ # load the gem
350
+ require 'finnhub_ruby'
351
+ # setup authorization
352
+ FinnhubRuby.configure do |config|
353
+ # Configure API key authorization: api_key
354
+ config.api_key['token'] = 'YOUR API KEY'
355
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
356
+ #config.api_key_prefix['token'] = 'Bearer'
357
+ end
358
+
359
+ api_instance = FinnhubRuby::DefaultApi.new
360
+ symbol = 'symbol_example' # String | Company symbol.
361
+ from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>.
362
+ to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
363
+
364
+ begin
365
+ #Company News
366
+ result = api_instance.company_news(symbol, from, to)
367
+ p result
368
+ rescue FinnhubRuby::ApiError => e
369
+ puts "Exception when calling DefaultApi->company_news: #{e}"
370
+ end
371
+ ```
372
+
373
+ ### Parameters
374
+
375
+
376
+ Name | Type | Description | Notes
377
+ ------------- | ------------- | ------------- | -------------
378
+ **symbol** | **String**| Company symbol. |
379
+ **from** | **Date**| From date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. |
380
+ **to** | **Date**| To date &lt;code&gt;YYYY-MM-DD&lt;/code&gt;. |
381
+
382
+ ### Return type
383
+
384
+ [**Array&lt;News&gt;**](News.md)
385
+
386
+ ### Authorization
387
+
388
+ [api_key](../README.md#api_key)
389
+
390
+ ### HTTP request headers
391
+
392
+ - **Content-Type**: Not defined
393
+ - **Accept**: application/json
394
+
395
+
396
+ ## company_peers
397
+
398
+ > Array&lt;String&gt; company_peers(symbol)
399
+
400
+ Peers
401
+
402
+ Get company peers. Return a list of peers in the same country and GICS sub-industry
403
+
404
+ ### Example
405
+
406
+ ```ruby
407
+ # load the gem
408
+ require 'finnhub_ruby'
409
+ # setup authorization
410
+ FinnhubRuby.configure do |config|
411
+ # Configure API key authorization: api_key
412
+ config.api_key['token'] = 'YOUR API KEY'
413
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
414
+ #config.api_key_prefix['token'] = 'Bearer'
415
+ end
416
+
417
+ api_instance = FinnhubRuby::DefaultApi.new
418
+ symbol = 'symbol_example' # String | Symbol of the company: AAPL.
419
+
420
+ begin
421
+ #Peers
422
+ result = api_instance.company_peers(symbol)
423
+ p result
424
+ rescue FinnhubRuby::ApiError => e
425
+ puts "Exception when calling DefaultApi->company_peers: #{e}"
426
+ end
427
+ ```
428
+
429
+ ### Parameters
430
+
431
+
432
+ Name | Type | Description | Notes
433
+ ------------- | ------------- | ------------- | -------------
434
+ **symbol** | **String**| Symbol of the company: AAPL. |
435
+
436
+ ### Return type
437
+
438
+ **Array&lt;String&gt;**
439
+
440
+ ### Authorization
441
+
442
+ [api_key](../README.md#api_key)
443
+
444
+ ### HTTP request headers
445
+
446
+ - **Content-Type**: Not defined
447
+ - **Accept**: application/json
448
+
449
+
450
+ ## company_profile
451
+
452
+ > CompanyProfile company_profile(opts)
453
+
454
+ Company Profile
455
+
456
+ Get general information of a company. You can query by symbol, ISIN or CUSIP
457
+
458
+ ### Example
459
+
460
+ ```ruby
461
+ # load the gem
462
+ require 'finnhub_ruby'
463
+ # setup authorization
464
+ FinnhubRuby.configure do |config|
465
+ # Configure API key authorization: api_key
466
+ config.api_key['token'] = '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['token'] = 'Bearer'
469
+ end
470
+
471
+ api_instance = FinnhubRuby::DefaultApi.new
472
+ opts = {
473
+ symbol: 'symbol_example', # String | Symbol of the company: AAPL e.g.
474
+ isin: 'isin_example', # String | ISIN
475
+ cusip: 'cusip_example' # String | CUSIP
476
+ }
477
+
478
+ begin
479
+ #Company Profile
480
+ result = api_instance.company_profile(opts)
481
+ p result
482
+ rescue FinnhubRuby::ApiError => e
483
+ puts "Exception when calling DefaultApi->company_profile: #{e}"
484
+ end
485
+ ```
486
+
487
+ ### Parameters
488
+
489
+
490
+ Name | Type | Description | Notes
491
+ ------------- | ------------- | ------------- | -------------
492
+ **symbol** | **String**| Symbol of the company: AAPL e.g. | [optional]
493
+ **isin** | **String**| ISIN | [optional]
494
+ **cusip** | **String**| CUSIP | [optional]
495
+
496
+ ### Return type
497
+
498
+ [**CompanyProfile**](CompanyProfile.md)
499
+
500
+ ### Authorization
501
+
502
+ [api_key](../README.md#api_key)
503
+
504
+ ### HTTP request headers
505
+
506
+ - **Content-Type**: Not defined
507
+ - **Accept**: application/json
508
+
509
+
510
+ ## company_profile2
511
+
512
+ > CompanyProfile2 company_profile2(opts)
513
+
514
+ Company Profile 2
515
+
516
+ Get general information of a company. You can query by symbol, ISIN or CUSIP. This is the free version of <a href=\"#company-profile\">Company Profile</a>.
517
+
518
+ ### Example
519
+
520
+ ```ruby
521
+ # load the gem
522
+ require 'finnhub_ruby'
523
+ # setup authorization
524
+ FinnhubRuby.configure do |config|
525
+ # Configure API key authorization: api_key
526
+ config.api_key['token'] = 'YOUR API KEY'
527
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
528
+ #config.api_key_prefix['token'] = 'Bearer'
529
+ end
530
+
531
+ api_instance = FinnhubRuby::DefaultApi.new
532
+ opts = {
533
+ symbol: 'symbol_example', # String | Symbol of the company: AAPL e.g.
534
+ isin: 'isin_example', # String | ISIN
535
+ cusip: 'cusip_example' # String | CUSIP
536
+ }
537
+
538
+ begin
539
+ #Company Profile 2
540
+ result = api_instance.company_profile2(opts)
541
+ p result
542
+ rescue FinnhubRuby::ApiError => e
543
+ puts "Exception when calling DefaultApi->company_profile2: #{e}"
544
+ end
545
+ ```
546
+
547
+ ### Parameters
548
+
549
+
550
+ Name | Type | Description | Notes
551
+ ------------- | ------------- | ------------- | -------------
552
+ **symbol** | **String**| Symbol of the company: AAPL e.g. | [optional]
553
+ **isin** | **String**| ISIN | [optional]
554
+ **cusip** | **String**| CUSIP | [optional]
555
+
556
+ ### Return type
557
+
558
+ [**CompanyProfile2**](CompanyProfile2.md)
559
+
560
+ ### Authorization
561
+
562
+ [api_key](../README.md#api_key)
563
+
564
+ ### HTTP request headers
565
+
566
+ - **Content-Type**: Not defined
567
+ - **Accept**: application/json
568
+
569
+
570
+ ## company_revenue_estimates
571
+
572
+ > RevenueEstimates company_revenue_estimates(symbol, opts)
573
+
574
+ Revenue Estimates
575
+
576
+ Get company's revenue estimates.
577
+
578
+ ### Example
579
+
580
+ ```ruby
581
+ # load the gem
582
+ require 'finnhub_ruby'
583
+ # setup authorization
584
+ FinnhubRuby.configure do |config|
585
+ # Configure API key authorization: api_key
586
+ config.api_key['token'] = 'YOUR API KEY'
587
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
588
+ #config.api_key_prefix['token'] = 'Bearer'
589
+ end
590
+
591
+ api_instance = FinnhubRuby::DefaultApi.new
592
+ symbol = 'symbol_example' # String | Symbol of the company: AAPL.
593
+ opts = {
594
+ freq: 'freq_example' # String | Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
595
+ }
596
+
597
+ begin
598
+ #Revenue Estimates
599
+ result = api_instance.company_revenue_estimates(symbol, opts)
600
+ p result
601
+ rescue FinnhubRuby::ApiError => e
602
+ puts "Exception when calling DefaultApi->company_revenue_estimates: #{e}"
603
+ end
604
+ ```
605
+
606
+ ### Parameters
607
+
608
+
609
+ Name | Type | Description | Notes
610
+ ------------- | ------------- | ------------- | -------------
611
+ **symbol** | **String**| Symbol of the company: AAPL. |
612
+ **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]
613
+
614
+ ### Return type
615
+
616
+ [**RevenueEstimates**](RevenueEstimates.md)
617
+
618
+ ### Authorization
619
+
620
+ [api_key](../README.md#api_key)
621
+
622
+ ### HTTP request headers
623
+
624
+ - **Content-Type**: Not defined
625
+ - **Accept**: application/json
626
+
627
+
628
+ ## country
629
+
630
+ > Array&lt;CountryMetadata&gt; country
631
+
632
+ Country Metadata
633
+
634
+ List all countries and metadata.
635
+
636
+ ### Example
637
+
638
+ ```ruby
639
+ # load the gem
640
+ require 'finnhub_ruby'
641
+ # setup authorization
642
+ FinnhubRuby.configure do |config|
643
+ # Configure API key authorization: api_key
644
+ config.api_key['token'] = 'YOUR API KEY'
645
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
646
+ #config.api_key_prefix['token'] = 'Bearer'
647
+ end
648
+
649
+ api_instance = FinnhubRuby::DefaultApi.new
650
+
651
+ begin
652
+ #Country Metadata
653
+ result = api_instance.country
654
+ p result
655
+ rescue FinnhubRuby::ApiError => e
656
+ puts "Exception when calling DefaultApi->country: #{e}"
657
+ end
658
+ ```
659
+
660
+ ### Parameters
661
+
662
+ This endpoint does not need any parameter.
663
+
664
+ ### Return type
665
+
666
+ [**Array&lt;CountryMetadata&gt;**](CountryMetadata.md)
667
+
668
+ ### Authorization
669
+
670
+ [api_key](../README.md#api_key)
671
+
672
+ ### HTTP request headers
673
+
674
+ - **Content-Type**: Not defined
675
+ - **Accept**: application/json
676
+
677
+
678
+ ## covid19
679
+
680
+ > Array&lt;CovidInfo&gt; covid19
681
+
682
+ COVID-19
683
+
684
+ Get real-time updates on the number of COVID-19 (Corona virus) cases in the US with a state-by-state breakdown. Data is sourced from CDC and reputable sources. You can also access this API <a href=\"https://rapidapi.com/Finnhub/api/finnhub-real-time-covid-19\" target=\"_blank\" rel=\"nofollow\">here</a>
685
+
686
+ ### Example
687
+
688
+ ```ruby
689
+ # load the gem
690
+ require 'finnhub_ruby'
691
+ # setup authorization
692
+ FinnhubRuby.configure do |config|
693
+ # Configure API key authorization: api_key
694
+ config.api_key['token'] = 'YOUR API KEY'
695
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
696
+ #config.api_key_prefix['token'] = 'Bearer'
697
+ end
698
+
699
+ api_instance = FinnhubRuby::DefaultApi.new
700
+
701
+ begin
702
+ #COVID-19
703
+ result = api_instance.covid19
704
+ p result
705
+ rescue FinnhubRuby::ApiError => e
706
+ puts "Exception when calling DefaultApi->covid19: #{e}"
707
+ end
708
+ ```
709
+
710
+ ### Parameters
711
+
712
+ This endpoint does not need any parameter.
713
+
714
+ ### Return type
715
+
716
+ [**Array&lt;CovidInfo&gt;**](CovidInfo.md)
717
+
718
+ ### Authorization
719
+
720
+ [api_key](../README.md#api_key)
721
+
722
+ ### HTTP request headers
723
+
724
+ - **Content-Type**: Not defined
725
+ - **Accept**: application/json
726
+
727
+
728
+ ## crypto_candles
729
+
730
+ > CryptoCandles crypto_candles(symbol, resolution, from, to)
731
+
732
+ Crypto Candles
733
+
734
+ Get candlestick data for crypto symbols.
735
+
736
+ ### Example
737
+
738
+ ```ruby
739
+ # load the gem
740
+ require 'finnhub_ruby'
741
+ # setup authorization
742
+ FinnhubRuby.configure do |config|
743
+ # Configure API key authorization: api_key
744
+ config.api_key['token'] = 'YOUR API KEY'
745
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
746
+ #config.api_key_prefix['token'] = 'Bearer'
747
+ end
748
+
749
+ api_instance = FinnhubRuby::DefaultApi.new
750
+ symbol = 'symbol_example' # String | Use symbol returned in <code>/crypto/symbol</code> endpoint for this field.
751
+ 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.
752
+ from = 56 # Integer | UNIX timestamp. Interval initial value.
753
+ to = 56 # Integer | UNIX timestamp. Interval end value.
754
+
755
+ begin
756
+ #Crypto Candles
757
+ result = api_instance.crypto_candles(symbol, resolution, from, to)
758
+ p result
759
+ rescue FinnhubRuby::ApiError => e
760
+ puts "Exception when calling DefaultApi->crypto_candles: #{e}"
761
+ end
762
+ ```
763
+
764
+ ### Parameters
765
+
766
+
767
+ Name | Type | Description | Notes
768
+ ------------- | ------------- | ------------- | -------------
769
+ **symbol** | **String**| Use symbol returned in &lt;code&gt;/crypto/symbol&lt;/code&gt; endpoint for this field. |
770
+ **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. |
771
+ **from** | **Integer**| UNIX timestamp. Interval initial value. |
772
+ **to** | **Integer**| UNIX timestamp. Interval end value. |
773
+
774
+ ### Return type
775
+
776
+ [**CryptoCandles**](CryptoCandles.md)
777
+
778
+ ### Authorization
779
+
780
+ [api_key](../README.md#api_key)
781
+
782
+ ### HTTP request headers
783
+
784
+ - **Content-Type**: Not defined
785
+ - **Accept**: application/json
786
+
787
+
788
+ ## crypto_exchanges
789
+
790
+ > Array&lt;String&gt; crypto_exchanges
791
+
792
+ Crypto Exchanges
793
+
794
+ List supported crypto exchanges
795
+
796
+ ### Example
797
+
798
+ ```ruby
799
+ # load the gem
800
+ require 'finnhub_ruby'
801
+ # setup authorization
802
+ FinnhubRuby.configure do |config|
803
+ # Configure API key authorization: api_key
804
+ config.api_key['token'] = 'YOUR API KEY'
805
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
806
+ #config.api_key_prefix['token'] = 'Bearer'
807
+ end
808
+
809
+ api_instance = FinnhubRuby::DefaultApi.new
810
+
811
+ begin
812
+ #Crypto Exchanges
813
+ result = api_instance.crypto_exchanges
814
+ p result
815
+ rescue FinnhubRuby::ApiError => e
816
+ puts "Exception when calling DefaultApi->crypto_exchanges: #{e}"
817
+ end
818
+ ```
819
+
820
+ ### Parameters
821
+
822
+ This endpoint does not need any parameter.
823
+
824
+ ### Return type
825
+
826
+ **Array&lt;String&gt;**
827
+
828
+ ### Authorization
829
+
830
+ [api_key](../README.md#api_key)
831
+
832
+ ### HTTP request headers
833
+
834
+ - **Content-Type**: Not defined
835
+ - **Accept**: application/json
836
+
837
+
838
+ ## crypto_symbols
839
+
840
+ > Array&lt;CryptoSymbol&gt; crypto_symbols(exchange)
841
+
842
+ Crypto Symbol
843
+
844
+ List supported crypto symbols by exchange
845
+
846
+ ### Example
847
+
848
+ ```ruby
849
+ # load the gem
850
+ require 'finnhub_ruby'
851
+ # setup authorization
852
+ FinnhubRuby.configure do |config|
853
+ # Configure API key authorization: api_key
854
+ config.api_key['token'] = 'YOUR API KEY'
855
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
856
+ #config.api_key_prefix['token'] = 'Bearer'
857
+ end
858
+
859
+ api_instance = FinnhubRuby::DefaultApi.new
860
+ exchange = 'exchange_example' # String | Exchange you want to get the list of symbols from.
861
+
862
+ begin
863
+ #Crypto Symbol
864
+ result = api_instance.crypto_symbols(exchange)
865
+ p result
866
+ rescue FinnhubRuby::ApiError => e
867
+ puts "Exception when calling DefaultApi->crypto_symbols: #{e}"
868
+ end
869
+ ```
870
+
871
+ ### Parameters
872
+
873
+
874
+ Name | Type | Description | Notes
875
+ ------------- | ------------- | ------------- | -------------
876
+ **exchange** | **String**| Exchange you want to get the list of symbols from. |
877
+
878
+ ### Return type
879
+
880
+ [**Array&lt;CryptoSymbol&gt;**](CryptoSymbol.md)
881
+
882
+ ### Authorization
883
+
884
+ [api_key](../README.md#api_key)
885
+
886
+ ### HTTP request headers
887
+
888
+ - **Content-Type**: Not defined
889
+ - **Accept**: application/json
890
+
891
+
892
+ ## earnings_calendar
893
+
894
+ > EarningsCalendar earnings_calendar(opts)
895
+
896
+ Earnings Calendar
897
+
898
+ Get historical and coming earnings release dating back to 2003. You can setup <a href=\"#webhook\">webhook</a> to receive real-time earnings update.
899
+
900
+ ### Example
901
+
902
+ ```ruby
903
+ # load the gem
904
+ require 'finnhub_ruby'
905
+ # setup authorization
906
+ FinnhubRuby.configure do |config|
907
+ # Configure API key authorization: api_key
908
+ config.api_key['token'] = 'YOUR API KEY'
909
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
910
+ #config.api_key_prefix['token'] = 'Bearer'
911
+ end
912
+
913
+ api_instance = FinnhubRuby::DefaultApi.new
914
+ opts = {
915
+ from: Date.parse('2013-10-20'), # Date | From date: 2020-03-15.
916
+ to: Date.parse('2013-10-20'), # Date | To date: 2020-03-16.
917
+ symbol: 'symbol_example', # String | Filter by symbol: AAPL.
918
+ international: FinnhubRuby::AnyType.new # AnyType | Set to <code>true</code> to include international markets. Default value is <code>false</code>
919
+ }
920
+
921
+ begin
922
+ #Earnings Calendar
923
+ result = api_instance.earnings_calendar(opts)
924
+ p result
925
+ rescue FinnhubRuby::ApiError => e
926
+ puts "Exception when calling DefaultApi->earnings_calendar: #{e}"
927
+ end
928
+ ```
929
+
930
+ ### Parameters
931
+
932
+
933
+ Name | Type | Description | Notes
934
+ ------------- | ------------- | ------------- | -------------
935
+ **from** | **Date**| From date: 2020-03-15. | [optional]
936
+ **to** | **Date**| To date: 2020-03-16. | [optional]
937
+ **symbol** | **String**| Filter by symbol: AAPL. | [optional]
938
+ **international** | [**AnyType**](.md)| Set to &lt;code&gt;true&lt;/code&gt; to include international markets. Default value is &lt;code&gt;false&lt;/code&gt; | [optional]
939
+
940
+ ### Return type
941
+
942
+ [**EarningsCalendar**](EarningsCalendar.md)
943
+
944
+ ### Authorization
945
+
946
+ [api_key](../README.md#api_key)
947
+
948
+ ### HTTP request headers
949
+
950
+ - **Content-Type**: Not defined
951
+ - **Accept**: application/json
952
+
953
+
954
+ ## economic_code
955
+
956
+ > Array&lt;EconomicCode&gt; economic_code
957
+
958
+ Economic Code
959
+
960
+ List codes of supported economic data.
961
+
962
+ ### Example
963
+
964
+ ```ruby
965
+ # load the gem
966
+ require 'finnhub_ruby'
967
+ # setup authorization
968
+ FinnhubRuby.configure do |config|
969
+ # Configure API key authorization: api_key
970
+ config.api_key['token'] = 'YOUR API KEY'
971
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
972
+ #config.api_key_prefix['token'] = 'Bearer'
973
+ end
974
+
975
+ api_instance = FinnhubRuby::DefaultApi.new
976
+
977
+ begin
978
+ #Economic Code
979
+ result = api_instance.economic_code
980
+ p result
981
+ rescue FinnhubRuby::ApiError => e
982
+ puts "Exception when calling DefaultApi->economic_code: #{e}"
983
+ end
984
+ ```
985
+
986
+ ### Parameters
987
+
988
+ This endpoint does not need any parameter.
989
+
990
+ ### Return type
991
+
992
+ [**Array&lt;EconomicCode&gt;**](EconomicCode.md)
993
+
994
+ ### Authorization
995
+
996
+ [api_key](../README.md#api_key)
997
+
998
+ ### HTTP request headers
999
+
1000
+ - **Content-Type**: Not defined
1001
+ - **Accept**: application/json
1002
+
1003
+
1004
+ ## economic_data
1005
+
1006
+ > EconomicData economic_data(code)
1007
+
1008
+ Economic Data
1009
+
1010
+ Get economic data.
1011
+
1012
+ ### Example
1013
+
1014
+ ```ruby
1015
+ # load the gem
1016
+ require 'finnhub_ruby'
1017
+ # setup authorization
1018
+ FinnhubRuby.configure do |config|
1019
+ # Configure API key authorization: api_key
1020
+ config.api_key['token'] = 'YOUR API KEY'
1021
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1022
+ #config.api_key_prefix['token'] = 'Bearer'
1023
+ end
1024
+
1025
+ api_instance = FinnhubRuby::DefaultApi.new
1026
+ code = 'code_example' # String | Economic code.
1027
+
1028
+ begin
1029
+ #Economic Data
1030
+ result = api_instance.economic_data(code)
1031
+ p result
1032
+ rescue FinnhubRuby::ApiError => e
1033
+ puts "Exception when calling DefaultApi->economic_data: #{e}"
1034
+ end
1035
+ ```
1036
+
1037
+ ### Parameters
1038
+
1039
+
1040
+ Name | Type | Description | Notes
1041
+ ------------- | ------------- | ------------- | -------------
1042
+ **code** | **String**| Economic code. |
1043
+
1044
+ ### Return type
1045
+
1046
+ [**EconomicData**](EconomicData.md)
1047
+
1048
+ ### Authorization
1049
+
1050
+ [api_key](../README.md#api_key)
1051
+
1052
+ ### HTTP request headers
1053
+
1054
+ - **Content-Type**: Not defined
1055
+ - **Accept**: application/json
1056
+
1057
+
1058
+ ## filings
1059
+
1060
+ > Array&lt;Filing&gt; filings(opts)
1061
+
1062
+ Filings
1063
+
1064
+ List company's filing. Limit to 250 documents at a time. This data is available for bulk download on <a href=\"https://www.kaggle.com/finnhub/sec-filings\" target=\"_blank\">Kaggle SEC Filings database</a>.
1065
+
1066
+ ### Example
1067
+
1068
+ ```ruby
1069
+ # load the gem
1070
+ require 'finnhub_ruby'
1071
+ # setup authorization
1072
+ FinnhubRuby.configure do |config|
1073
+ # Configure API key authorization: api_key
1074
+ config.api_key['token'] = 'YOUR API KEY'
1075
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1076
+ #config.api_key_prefix['token'] = 'Bearer'
1077
+ end
1078
+
1079
+ api_instance = FinnhubRuby::DefaultApi.new
1080
+ opts = {
1081
+ symbol: 'symbol_example', # String | Symbol. Leave <code>symbol</code>,<code>cik</code> and <code>accessNumber</code> empty to list latest filings.
1082
+ cik: 'cik_example', # String | CIK.
1083
+ access_number: 'access_number_example', # String | Access number of a specific report you want to retrieve data from.
1084
+ form: 'form_example', # String | Filter by form. You can use this value <code>NT 10-K</code> to find non-timely filings for a company.
1085
+ from: Date.parse('2013-10-20'), # Date | From date: 2020-03-15.
1086
+ to: Date.parse('2013-10-20') # Date | To date: 2020-03-16.
1087
+ }
1088
+
1089
+ begin
1090
+ #Filings
1091
+ result = api_instance.filings(opts)
1092
+ p result
1093
+ rescue FinnhubRuby::ApiError => e
1094
+ puts "Exception when calling DefaultApi->filings: #{e}"
1095
+ end
1096
+ ```
1097
+
1098
+ ### Parameters
1099
+
1100
+
1101
+ Name | Type | Description | Notes
1102
+ ------------- | ------------- | ------------- | -------------
1103
+ **symbol** | **String**| Symbol. Leave &lt;code&gt;symbol&lt;/code&gt;,&lt;code&gt;cik&lt;/code&gt; and &lt;code&gt;accessNumber&lt;/code&gt; empty to list latest filings. | [optional]
1104
+ **cik** | **String**| CIK. | [optional]
1105
+ **access_number** | **String**| Access number of a specific report you want to retrieve data from. | [optional]
1106
+ **form** | **String**| Filter by form. You can use this value &lt;code&gt;NT 10-K&lt;/code&gt; to find non-timely filings for a company. | [optional]
1107
+ **from** | **Date**| From date: 2020-03-15. | [optional]
1108
+ **to** | **Date**| To date: 2020-03-16. | [optional]
1109
+
1110
+ ### Return type
1111
+
1112
+ [**Array&lt;Filing&gt;**](Filing.md)
1113
+
1114
+ ### Authorization
1115
+
1116
+ [api_key](../README.md#api_key)
1117
+
1118
+ ### HTTP request headers
1119
+
1120
+ - **Content-Type**: Not defined
1121
+ - **Accept**: application/json
1122
+
1123
+
1124
+ ## financials
1125
+
1126
+ > FinancialStatements financials(symbol, statement, freq)
1127
+
1128
+ Financial Statements
1129
+
1130
+ Get standardized balance sheet, income statement and cash flow for global companies going back 30+ years.
1131
+
1132
+ ### Example
1133
+
1134
+ ```ruby
1135
+ # load the gem
1136
+ require 'finnhub_ruby'
1137
+ # setup authorization
1138
+ FinnhubRuby.configure do |config|
1139
+ # Configure API key authorization: api_key
1140
+ config.api_key['token'] = 'YOUR API KEY'
1141
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1142
+ #config.api_key_prefix['token'] = 'Bearer'
1143
+ end
1144
+
1145
+ api_instance = FinnhubRuby::DefaultApi.new
1146
+ symbol = 'symbol_example' # String | Symbol of the company: AAPL.
1147
+ statement = 'statement_example' # String | Statement can take 1 of these values <code>bs, ic, cf</code> for Balance Sheet, Income Statement, Cash Flow respectively.
1148
+ freq = 'freq_example' # String | Frequency can take 1 of these values <code>annual, quarterly, ttm, ytd</code>. TTM (Trailing Twelve Months) option is available for Income Statement and Cash Flow. YTD (Year To Date) option is only available for Cash Flow.
1149
+
1150
+ begin
1151
+ #Financial Statements
1152
+ result = api_instance.financials(symbol, statement, freq)
1153
+ p result
1154
+ rescue FinnhubRuby::ApiError => e
1155
+ puts "Exception when calling DefaultApi->financials: #{e}"
1156
+ end
1157
+ ```
1158
+
1159
+ ### Parameters
1160
+
1161
+
1162
+ Name | Type | Description | Notes
1163
+ ------------- | ------------- | ------------- | -------------
1164
+ **symbol** | **String**| Symbol of the company: AAPL. |
1165
+ **statement** | **String**| Statement can take 1 of these values &lt;code&gt;bs, ic, cf&lt;/code&gt; for Balance Sheet, Income Statement, Cash Flow respectively. |
1166
+ **freq** | **String**| Frequency can take 1 of these values &lt;code&gt;annual, quarterly, ttm, ytd&lt;/code&gt;. TTM (Trailing Twelve Months) option is available for Income Statement and Cash Flow. YTD (Year To Date) option is only available for Cash Flow. |
1167
+
1168
+ ### Return type
1169
+
1170
+ [**FinancialStatements**](FinancialStatements.md)
1171
+
1172
+ ### Authorization
1173
+
1174
+ [api_key](../README.md#api_key)
1175
+
1176
+ ### HTTP request headers
1177
+
1178
+ - **Content-Type**: Not defined
1179
+ - **Accept**: application/json
1180
+
1181
+
1182
+ ## financials_reported
1183
+
1184
+ > FinancialsAsReported financials_reported(opts)
1185
+
1186
+ Financials As Reported
1187
+
1188
+ Get financials as reported. This data is available for bulk download on <a href=\"https://www.kaggle.com/finnhub/reported-financials\" target=\"_blank\">Kaggle SEC Financials database</a>.
1189
+
1190
+ ### Example
1191
+
1192
+ ```ruby
1193
+ # load the gem
1194
+ require 'finnhub_ruby'
1195
+ # setup authorization
1196
+ FinnhubRuby.configure do |config|
1197
+ # Configure API key authorization: api_key
1198
+ config.api_key['token'] = 'YOUR API KEY'
1199
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1200
+ #config.api_key_prefix['token'] = 'Bearer'
1201
+ end
1202
+
1203
+ api_instance = FinnhubRuby::DefaultApi.new
1204
+ opts = {
1205
+ symbol: 'symbol_example', # String | Symbol.
1206
+ cik: 'cik_example', # String | CIK.
1207
+ access_number: 'access_number_example', # String | Access number of a specific report you want to retrieve financials from.
1208
+ freq: 'freq_example' # String | Frequency. Can be either <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>.
1209
+ }
1210
+
1211
+ begin
1212
+ #Financials As Reported
1213
+ result = api_instance.financials_reported(opts)
1214
+ p result
1215
+ rescue FinnhubRuby::ApiError => e
1216
+ puts "Exception when calling DefaultApi->financials_reported: #{e}"
1217
+ end
1218
+ ```
1219
+
1220
+ ### Parameters
1221
+
1222
+
1223
+ Name | Type | Description | Notes
1224
+ ------------- | ------------- | ------------- | -------------
1225
+ **symbol** | **String**| Symbol. | [optional]
1226
+ **cik** | **String**| CIK. | [optional]
1227
+ **access_number** | **String**| Access number of a specific report you want to retrieve financials from. | [optional]
1228
+ **freq** | **String**| Frequency. Can be either &lt;code&gt;annual&lt;/code&gt; or &lt;code&gt;quarterly&lt;/code&gt;. Default to &lt;code&gt;annual&lt;/code&gt;. | [optional]
1229
+
1230
+ ### Return type
1231
+
1232
+ [**FinancialsAsReported**](FinancialsAsReported.md)
1233
+
1234
+ ### Authorization
1235
+
1236
+ [api_key](../README.md#api_key)
1237
+
1238
+ ### HTTP request headers
1239
+
1240
+ - **Content-Type**: Not defined
1241
+ - **Accept**: application/json
1242
+
1243
+
1244
+ ## forex_candles
1245
+
1246
+ > ForexCandles forex_candles(symbol, resolution, from, to)
1247
+
1248
+ Forex Candles
1249
+
1250
+ Get candlestick data for forex symbols.
1251
+
1252
+ ### Example
1253
+
1254
+ ```ruby
1255
+ # load the gem
1256
+ require 'finnhub_ruby'
1257
+ # setup authorization
1258
+ FinnhubRuby.configure do |config|
1259
+ # Configure API key authorization: api_key
1260
+ config.api_key['token'] = 'YOUR API KEY'
1261
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1262
+ #config.api_key_prefix['token'] = 'Bearer'
1263
+ end
1264
+
1265
+ api_instance = FinnhubRuby::DefaultApi.new
1266
+ symbol = 'symbol_example' # String | Use symbol returned in <code>/forex/symbol</code> endpoint for this field.
1267
+ 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.
1268
+ from = 56 # Integer | UNIX timestamp. Interval initial value.
1269
+ to = 56 # Integer | UNIX timestamp. Interval end value.
1270
+
1271
+ begin
1272
+ #Forex Candles
1273
+ result = api_instance.forex_candles(symbol, resolution, from, to)
1274
+ p result
1275
+ rescue FinnhubRuby::ApiError => e
1276
+ puts "Exception when calling DefaultApi->forex_candles: #{e}"
1277
+ end
1278
+ ```
1279
+
1280
+ ### Parameters
1281
+
1282
+
1283
+ Name | Type | Description | Notes
1284
+ ------------- | ------------- | ------------- | -------------
1285
+ **symbol** | **String**| Use symbol returned in &lt;code&gt;/forex/symbol&lt;/code&gt; endpoint for this field. |
1286
+ **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. |
1287
+ **from** | **Integer**| UNIX timestamp. Interval initial value. |
1288
+ **to** | **Integer**| UNIX timestamp. Interval end value. |
1289
+
1290
+ ### Return type
1291
+
1292
+ [**ForexCandles**](ForexCandles.md)
1293
+
1294
+ ### Authorization
1295
+
1296
+ [api_key](../README.md#api_key)
1297
+
1298
+ ### HTTP request headers
1299
+
1300
+ - **Content-Type**: Not defined
1301
+ - **Accept**: application/json
1302
+
1303
+
1304
+ ## forex_exchanges
1305
+
1306
+ > Array&lt;String&gt; forex_exchanges
1307
+
1308
+ Forex Exchanges
1309
+
1310
+ List supported forex exchanges
1311
+
1312
+ ### Example
1313
+
1314
+ ```ruby
1315
+ # load the gem
1316
+ require 'finnhub_ruby'
1317
+ # setup authorization
1318
+ FinnhubRuby.configure do |config|
1319
+ # Configure API key authorization: api_key
1320
+ config.api_key['token'] = 'YOUR API KEY'
1321
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1322
+ #config.api_key_prefix['token'] = 'Bearer'
1323
+ end
1324
+
1325
+ api_instance = FinnhubRuby::DefaultApi.new
1326
+
1327
+ begin
1328
+ #Forex Exchanges
1329
+ result = api_instance.forex_exchanges
1330
+ p result
1331
+ rescue FinnhubRuby::ApiError => e
1332
+ puts "Exception when calling DefaultApi->forex_exchanges: #{e}"
1333
+ end
1334
+ ```
1335
+
1336
+ ### Parameters
1337
+
1338
+ This endpoint does not need any parameter.
1339
+
1340
+ ### Return type
1341
+
1342
+ **Array&lt;String&gt;**
1343
+
1344
+ ### Authorization
1345
+
1346
+ [api_key](../README.md#api_key)
1347
+
1348
+ ### HTTP request headers
1349
+
1350
+ - **Content-Type**: Not defined
1351
+ - **Accept**: application/json
1352
+
1353
+
1354
+ ## forex_rates
1355
+
1356
+ > Forexrates forex_rates(opts)
1357
+
1358
+ Forex rates
1359
+
1360
+ Get rates for all forex pairs. Ideal for currency conversion
1361
+
1362
+ ### Example
1363
+
1364
+ ```ruby
1365
+ # load the gem
1366
+ require 'finnhub_ruby'
1367
+ # setup authorization
1368
+ FinnhubRuby.configure do |config|
1369
+ # Configure API key authorization: api_key
1370
+ config.api_key['token'] = 'YOUR API KEY'
1371
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1372
+ #config.api_key_prefix['token'] = 'Bearer'
1373
+ end
1374
+
1375
+ api_instance = FinnhubRuby::DefaultApi.new
1376
+ opts = {
1377
+ base: 'base_example' # String | Base currency. Default to EUR.
1378
+ }
1379
+
1380
+ begin
1381
+ #Forex rates
1382
+ result = api_instance.forex_rates(opts)
1383
+ p result
1384
+ rescue FinnhubRuby::ApiError => e
1385
+ puts "Exception when calling DefaultApi->forex_rates: #{e}"
1386
+ end
1387
+ ```
1388
+
1389
+ ### Parameters
1390
+
1391
+
1392
+ Name | Type | Description | Notes
1393
+ ------------- | ------------- | ------------- | -------------
1394
+ **base** | **String**| Base currency. Default to EUR. | [optional]
1395
+
1396
+ ### Return type
1397
+
1398
+ [**Forexrates**](Forexrates.md)
1399
+
1400
+ ### Authorization
1401
+
1402
+ [api_key](../README.md#api_key)
1403
+
1404
+ ### HTTP request headers
1405
+
1406
+ - **Content-Type**: Not defined
1407
+ - **Accept**: application/json
1408
+
1409
+
1410
+ ## forex_symbols
1411
+
1412
+ > Array&lt;ForexSymbol&gt; forex_symbols(exchange)
1413
+
1414
+ Forex Symbol
1415
+
1416
+ List supported forex symbols.
1417
+
1418
+ ### Example
1419
+
1420
+ ```ruby
1421
+ # load the gem
1422
+ require 'finnhub_ruby'
1423
+ # setup authorization
1424
+ FinnhubRuby.configure do |config|
1425
+ # Configure API key authorization: api_key
1426
+ config.api_key['token'] = 'YOUR API KEY'
1427
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1428
+ #config.api_key_prefix['token'] = 'Bearer'
1429
+ end
1430
+
1431
+ api_instance = FinnhubRuby::DefaultApi.new
1432
+ exchange = 'exchange_example' # String | Exchange you want to get the list of symbols from.
1433
+
1434
+ begin
1435
+ #Forex Symbol
1436
+ result = api_instance.forex_symbols(exchange)
1437
+ p result
1438
+ rescue FinnhubRuby::ApiError => e
1439
+ puts "Exception when calling DefaultApi->forex_symbols: #{e}"
1440
+ end
1441
+ ```
1442
+
1443
+ ### Parameters
1444
+
1445
+
1446
+ Name | Type | Description | Notes
1447
+ ------------- | ------------- | ------------- | -------------
1448
+ **exchange** | **String**| Exchange you want to get the list of symbols from. |
1449
+
1450
+ ### Return type
1451
+
1452
+ [**Array&lt;ForexSymbol&gt;**](ForexSymbol.md)
1453
+
1454
+ ### Authorization
1455
+
1456
+ [api_key](../README.md#api_key)
1457
+
1458
+ ### HTTP request headers
1459
+
1460
+ - **Content-Type**: Not defined
1461
+ - **Accept**: application/json
1462
+
1463
+
1464
+ ## fund_ownership
1465
+
1466
+ > FundOwnership fund_ownership(symbol, opts)
1467
+
1468
+ Fund Ownership
1469
+
1470
+ Get a full list fund and institutional investors of a company in descending order of the number of shares held.
1471
+
1472
+ ### Example
1473
+
1474
+ ```ruby
1475
+ # load the gem
1476
+ require 'finnhub_ruby'
1477
+ # setup authorization
1478
+ FinnhubRuby.configure do |config|
1479
+ # Configure API key authorization: api_key
1480
+ config.api_key['token'] = 'YOUR API KEY'
1481
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1482
+ #config.api_key_prefix['token'] = 'Bearer'
1483
+ end
1484
+
1485
+ api_instance = FinnhubRuby::DefaultApi.new
1486
+ symbol = 'symbol_example' # String | Symbol of the company: AAPL.
1487
+ opts = {
1488
+ limit: 56 # Integer | Limit number of results. Leave empty to get the full list.
1489
+ }
1490
+
1491
+ begin
1492
+ #Fund Ownership
1493
+ result = api_instance.fund_ownership(symbol, opts)
1494
+ p result
1495
+ rescue FinnhubRuby::ApiError => e
1496
+ puts "Exception when calling DefaultApi->fund_ownership: #{e}"
1497
+ end
1498
+ ```
1499
+
1500
+ ### Parameters
1501
+
1502
+
1503
+ Name | Type | Description | Notes
1504
+ ------------- | ------------- | ------------- | -------------
1505
+ **symbol** | **String**| Symbol of the company: AAPL. |
1506
+ **limit** | **Integer**| Limit number of results. Leave empty to get the full list. | [optional]
1507
+
1508
+ ### Return type
1509
+
1510
+ [**FundOwnership**](FundOwnership.md)
1511
+
1512
+ ### Authorization
1513
+
1514
+ [api_key](../README.md#api_key)
1515
+
1516
+ ### HTTP request headers
1517
+
1518
+ - **Content-Type**: Not defined
1519
+ - **Accept**: application/json
1520
+
1521
+
1522
+ ## general_news
1523
+
1524
+ > Array&lt;News&gt; general_news(category, opts)
1525
+
1526
+ General News
1527
+
1528
+ Get latest market news.
1529
+
1530
+ ### Example
1531
+
1532
+ ```ruby
1533
+ # load the gem
1534
+ require 'finnhub_ruby'
1535
+ # setup authorization
1536
+ FinnhubRuby.configure do |config|
1537
+ # Configure API key authorization: api_key
1538
+ config.api_key['token'] = 'YOUR API KEY'
1539
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1540
+ #config.api_key_prefix['token'] = 'Bearer'
1541
+ end
1542
+
1543
+ api_instance = FinnhubRuby::DefaultApi.new
1544
+ category = 'category_example' # String | This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>.
1545
+ opts = {
1546
+ min_id: 'min_id_example' # String | Use this field to get only news after this ID. Default to 0
1547
+ }
1548
+
1549
+ begin
1550
+ #General News
1551
+ result = api_instance.general_news(category, opts)
1552
+ p result
1553
+ rescue FinnhubRuby::ApiError => e
1554
+ puts "Exception when calling DefaultApi->general_news: #{e}"
1555
+ end
1556
+ ```
1557
+
1558
+ ### Parameters
1559
+
1560
+
1561
+ Name | Type | Description | Notes
1562
+ ------------- | ------------- | ------------- | -------------
1563
+ **category** | **String**| This parameter can be 1 of the following values &lt;code&gt;general, forex, crypto, merger&lt;/code&gt;. |
1564
+ **min_id** | **String**| Use this field to get only news after this ID. Default to 0 | [optional]
1565
+
1566
+ ### Return type
1567
+
1568
+ [**Array&lt;News&gt;**](News.md)
1569
+
1570
+ ### Authorization
1571
+
1572
+ [api_key](../README.md#api_key)
1573
+
1574
+ ### HTTP request headers
1575
+
1576
+ - **Content-Type**: Not defined
1577
+ - **Accept**: application/json
1578
+
1579
+
1580
+ ## investors_ownership
1581
+
1582
+ > InvestorsOwnership investors_ownership(symbol, opts)
1583
+
1584
+ Investors Ownership
1585
+
1586
+ Get a full list of shareholders/investors of a company in descending order of the number of shares held.
1587
+
1588
+ ### Example
1589
+
1590
+ ```ruby
1591
+ # load the gem
1592
+ require 'finnhub_ruby'
1593
+ # setup authorization
1594
+ FinnhubRuby.configure do |config|
1595
+ # Configure API key authorization: api_key
1596
+ config.api_key['token'] = 'YOUR API KEY'
1597
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1598
+ #config.api_key_prefix['token'] = 'Bearer'
1599
+ end
1600
+
1601
+ api_instance = FinnhubRuby::DefaultApi.new
1602
+ symbol = 'symbol_example' # String | Symbol of the company: AAPL.
1603
+ opts = {
1604
+ limit: 56 # Integer | Limit number of results. Leave empty to get the full list.
1605
+ }
1606
+
1607
+ begin
1608
+ #Investors Ownership
1609
+ result = api_instance.investors_ownership(symbol, opts)
1610
+ p result
1611
+ rescue FinnhubRuby::ApiError => e
1612
+ puts "Exception when calling DefaultApi->investors_ownership: #{e}"
1613
+ end
1614
+ ```
1615
+
1616
+ ### Parameters
1617
+
1618
+
1619
+ Name | Type | Description | Notes
1620
+ ------------- | ------------- | ------------- | -------------
1621
+ **symbol** | **String**| Symbol of the company: AAPL. |
1622
+ **limit** | **Integer**| Limit number of results. Leave empty to get the full list. | [optional]
1623
+
1624
+ ### Return type
1625
+
1626
+ [**InvestorsOwnership**](InvestorsOwnership.md)
1627
+
1628
+ ### Authorization
1629
+
1630
+ [api_key](../README.md#api_key)
1631
+
1632
+ ### HTTP request headers
1633
+
1634
+ - **Content-Type**: Not defined
1635
+ - **Accept**: application/json
1636
+
1637
+
1638
+ ## ipo_calendar
1639
+
1640
+ > IPOCalendar ipo_calendar(from, to)
1641
+
1642
+ IPO Calendar
1643
+
1644
+ Get recent and coming IPO.
1645
+
1646
+ ### Example
1647
+
1648
+ ```ruby
1649
+ # load the gem
1650
+ require 'finnhub_ruby'
1651
+ # setup authorization
1652
+ FinnhubRuby.configure do |config|
1653
+ # Configure API key authorization: api_key
1654
+ config.api_key['token'] = 'YOUR API KEY'
1655
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1656
+ #config.api_key_prefix['token'] = 'Bearer'
1657
+ end
1658
+
1659
+ api_instance = FinnhubRuby::DefaultApi.new
1660
+ from = Date.parse('2013-10-20') # Date | From date: 2020-03-15.
1661
+ to = Date.parse('2013-10-20') # Date | To date: 2020-03-16.
1662
+
1663
+ begin
1664
+ #IPO Calendar
1665
+ result = api_instance.ipo_calendar(from, to)
1666
+ p result
1667
+ rescue FinnhubRuby::ApiError => e
1668
+ puts "Exception when calling DefaultApi->ipo_calendar: #{e}"
1669
+ end
1670
+ ```
1671
+
1672
+ ### Parameters
1673
+
1674
+
1675
+ Name | Type | Description | Notes
1676
+ ------------- | ------------- | ------------- | -------------
1677
+ **from** | **Date**| From date: 2020-03-15. |
1678
+ **to** | **Date**| To date: 2020-03-16. |
1679
+
1680
+ ### Return type
1681
+
1682
+ [**IPOCalendar**](IPOCalendar.md)
1683
+
1684
+ ### Authorization
1685
+
1686
+ [api_key](../README.md#api_key)
1687
+
1688
+ ### HTTP request headers
1689
+
1690
+ - **Content-Type**: Not defined
1691
+ - **Accept**: application/json
1692
+
1693
+
1694
+ ## major_developments
1695
+
1696
+ > MajorDevelopments major_developments(symbol, opts)
1697
+
1698
+ Major Developments
1699
+
1700
+ List latest major developments of a company going back 20 years with 12M+ data points. This data can be used to highlight the most significant events.
1701
+
1702
+ ### Example
1703
+
1704
+ ```ruby
1705
+ # load the gem
1706
+ require 'finnhub_ruby'
1707
+ # setup authorization
1708
+ FinnhubRuby.configure do |config|
1709
+ # Configure API key authorization: api_key
1710
+ config.api_key['token'] = 'YOUR API KEY'
1711
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1712
+ #config.api_key_prefix['token'] = 'Bearer'
1713
+ end
1714
+
1715
+ api_instance = FinnhubRuby::DefaultApi.new
1716
+ symbol = 'symbol_example' # String | Company symbol.
1717
+ opts = {
1718
+ from: Date.parse('2013-10-20'), # Date | From time: 2020-01-01.
1719
+ to: Date.parse('2013-10-20') # Date | To time: 2020-01-05.
1720
+ }
1721
+
1722
+ begin
1723
+ #Major Developments
1724
+ result = api_instance.major_developments(symbol, opts)
1725
+ p result
1726
+ rescue FinnhubRuby::ApiError => e
1727
+ puts "Exception when calling DefaultApi->major_developments: #{e}"
1728
+ end
1729
+ ```
1730
+
1731
+ ### Parameters
1732
+
1733
+
1734
+ Name | Type | Description | Notes
1735
+ ------------- | ------------- | ------------- | -------------
1736
+ **symbol** | **String**| Company symbol. |
1737
+ **from** | **Date**| From time: 2020-01-01. | [optional]
1738
+ **to** | **Date**| To time: 2020-01-05. | [optional]
1739
+
1740
+ ### Return type
1741
+
1742
+ [**MajorDevelopments**](MajorDevelopments.md)
1743
+
1744
+ ### Authorization
1745
+
1746
+ [api_key](../README.md#api_key)
1747
+
1748
+ ### HTTP request headers
1749
+
1750
+ - **Content-Type**: Not defined
1751
+ - **Accept**: application/json
1752
+
1753
+
1754
+ ## news_sentiment
1755
+
1756
+ > NewsSentiment news_sentiment(symbol)
1757
+
1758
+ News Sentiment
1759
+
1760
+ Get company's news sentiment and statistics. This endpoint is only available for US companies.
1761
+
1762
+ ### Example
1763
+
1764
+ ```ruby
1765
+ # load the gem
1766
+ require 'finnhub_ruby'
1767
+ # setup authorization
1768
+ FinnhubRuby.configure do |config|
1769
+ # Configure API key authorization: api_key
1770
+ config.api_key['token'] = 'YOUR API KEY'
1771
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1772
+ #config.api_key_prefix['token'] = 'Bearer'
1773
+ end
1774
+
1775
+ api_instance = FinnhubRuby::DefaultApi.new
1776
+ symbol = 'symbol_example' # String | Company symbol.
1777
+
1778
+ begin
1779
+ #News Sentiment
1780
+ result = api_instance.news_sentiment(symbol)
1781
+ p result
1782
+ rescue FinnhubRuby::ApiError => e
1783
+ puts "Exception when calling DefaultApi->news_sentiment: #{e}"
1784
+ end
1785
+ ```
1786
+
1787
+ ### Parameters
1788
+
1789
+
1790
+ Name | Type | Description | Notes
1791
+ ------------- | ------------- | ------------- | -------------
1792
+ **symbol** | **String**| Company symbol. |
1793
+
1794
+ ### Return type
1795
+
1796
+ [**NewsSentiment**](NewsSentiment.md)
1797
+
1798
+ ### Authorization
1799
+
1800
+ [api_key](../README.md#api_key)
1801
+
1802
+ ### HTTP request headers
1803
+
1804
+ - **Content-Type**: Not defined
1805
+ - **Accept**: application/json
1806
+
1807
+
1808
+ ## pattern_recognition
1809
+
1810
+ > PatternRecognition pattern_recognition(symbol, resolution)
1811
+
1812
+ Pattern Recognition
1813
+
1814
+ Run pattern recognition algorithm on a symbol. Support double top/bottom, triple top/bottom, head and shoulders, triangle, wedge, channel, flag, and candlestick patterns.
1815
+
1816
+ ### Example
1817
+
1818
+ ```ruby
1819
+ # load the gem
1820
+ require 'finnhub_ruby'
1821
+ # setup authorization
1822
+ FinnhubRuby.configure do |config|
1823
+ # Configure API key authorization: api_key
1824
+ config.api_key['token'] = 'YOUR API KEY'
1825
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1826
+ #config.api_key_prefix['token'] = 'Bearer'
1827
+ end
1828
+
1829
+ api_instance = FinnhubRuby::DefaultApi.new
1830
+ symbol = 'symbol_example' # String | Symbol
1831
+ 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.
1832
+
1833
+ begin
1834
+ #Pattern Recognition
1835
+ result = api_instance.pattern_recognition(symbol, resolution)
1836
+ p result
1837
+ rescue FinnhubRuby::ApiError => e
1838
+ puts "Exception when calling DefaultApi->pattern_recognition: #{e}"
1839
+ end
1840
+ ```
1841
+
1842
+ ### Parameters
1843
+
1844
+
1845
+ Name | Type | Description | Notes
1846
+ ------------- | ------------- | ------------- | -------------
1847
+ **symbol** | **String**| Symbol |
1848
+ **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. |
1849
+
1850
+ ### Return type
1851
+
1852
+ [**PatternRecognition**](PatternRecognition.md)
1853
+
1854
+ ### Authorization
1855
+
1856
+ [api_key](../README.md#api_key)
1857
+
1858
+ ### HTTP request headers
1859
+
1860
+ - **Content-Type**: Not defined
1861
+ - **Accept**: application/json
1862
+
1863
+
1864
+ ## price_target
1865
+
1866
+ > PriceTarget price_target(symbol)
1867
+
1868
+ Price Target
1869
+
1870
+ Get latest price target consensus.
1871
+
1872
+ ### Example
1873
+
1874
+ ```ruby
1875
+ # load the gem
1876
+ require 'finnhub_ruby'
1877
+ # setup authorization
1878
+ FinnhubRuby.configure do |config|
1879
+ # Configure API key authorization: api_key
1880
+ config.api_key['token'] = 'YOUR API KEY'
1881
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1882
+ #config.api_key_prefix['token'] = 'Bearer'
1883
+ end
1884
+
1885
+ api_instance = FinnhubRuby::DefaultApi.new
1886
+ symbol = 'symbol_example' # String | Symbol of the company: AAPL.
1887
+
1888
+ begin
1889
+ #Price Target
1890
+ result = api_instance.price_target(symbol)
1891
+ p result
1892
+ rescue FinnhubRuby::ApiError => e
1893
+ puts "Exception when calling DefaultApi->price_target: #{e}"
1894
+ end
1895
+ ```
1896
+
1897
+ ### Parameters
1898
+
1899
+
1900
+ Name | Type | Description | Notes
1901
+ ------------- | ------------- | ------------- | -------------
1902
+ **symbol** | **String**| Symbol of the company: AAPL. |
1903
+
1904
+ ### Return type
1905
+
1906
+ [**PriceTarget**](PriceTarget.md)
1907
+
1908
+ ### Authorization
1909
+
1910
+ [api_key](../README.md#api_key)
1911
+
1912
+ ### HTTP request headers
1913
+
1914
+ - **Content-Type**: Not defined
1915
+ - **Accept**: application/json
1916
+
1917
+
1918
+ ## quote
1919
+
1920
+ > Quote quote(symbol)
1921
+
1922
+ Quote
1923
+
1924
+ <p>Get real-time quote data for US stocks. Constant polling is not recommended. Use websocket if you need real-time update.</p><p>Real-time stock prices for international markets are supported for Enterprise clients via our partner's feed. <a href=\"mailto:support@finnhub.io\">Contact Us</a> to learn more.</p>
1925
+
1926
+ ### Example
1927
+
1928
+ ```ruby
1929
+ # load the gem
1930
+ require 'finnhub_ruby'
1931
+ # setup authorization
1932
+ FinnhubRuby.configure do |config|
1933
+ # Configure API key authorization: api_key
1934
+ config.api_key['token'] = 'YOUR API KEY'
1935
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1936
+ #config.api_key_prefix['token'] = 'Bearer'
1937
+ end
1938
+
1939
+ api_instance = FinnhubRuby::DefaultApi.new
1940
+ symbol = 'symbol_example' # String | Symbol
1941
+
1942
+ begin
1943
+ #Quote
1944
+ result = api_instance.quote(symbol)
1945
+ p result
1946
+ rescue FinnhubRuby::ApiError => e
1947
+ puts "Exception when calling DefaultApi->quote: #{e}"
1948
+ end
1949
+ ```
1950
+
1951
+ ### Parameters
1952
+
1953
+
1954
+ Name | Type | Description | Notes
1955
+ ------------- | ------------- | ------------- | -------------
1956
+ **symbol** | **String**| Symbol |
1957
+
1958
+ ### Return type
1959
+
1960
+ [**Quote**](Quote.md)
1961
+
1962
+ ### Authorization
1963
+
1964
+ [api_key](../README.md#api_key)
1965
+
1966
+ ### HTTP request headers
1967
+
1968
+ - **Content-Type**: Not defined
1969
+ - **Accept**: application/json
1970
+
1971
+
1972
+ ## recommendation_trends
1973
+
1974
+ > Array&lt;RecommendationTrend&gt; recommendation_trends(symbol)
1975
+
1976
+ Recommendation Trends
1977
+
1978
+ Get latest analyst recommendation trends for a company.
1979
+
1980
+ ### Example
1981
+
1982
+ ```ruby
1983
+ # load the gem
1984
+ require 'finnhub_ruby'
1985
+ # setup authorization
1986
+ FinnhubRuby.configure do |config|
1987
+ # Configure API key authorization: api_key
1988
+ config.api_key['token'] = 'YOUR API KEY'
1989
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1990
+ #config.api_key_prefix['token'] = 'Bearer'
1991
+ end
1992
+
1993
+ api_instance = FinnhubRuby::DefaultApi.new
1994
+ symbol = 'symbol_example' # String | Symbol of the company: AAPL.
1995
+
1996
+ begin
1997
+ #Recommendation Trends
1998
+ result = api_instance.recommendation_trends(symbol)
1999
+ p result
2000
+ rescue FinnhubRuby::ApiError => e
2001
+ puts "Exception when calling DefaultApi->recommendation_trends: #{e}"
2002
+ end
2003
+ ```
2004
+
2005
+ ### Parameters
2006
+
2007
+
2008
+ Name | Type | Description | Notes
2009
+ ------------- | ------------- | ------------- | -------------
2010
+ **symbol** | **String**| Symbol of the company: AAPL. |
2011
+
2012
+ ### Return type
2013
+
2014
+ [**Array&lt;RecommendationTrend&gt;**](RecommendationTrend.md)
2015
+
2016
+ ### Authorization
2017
+
2018
+ [api_key](../README.md#api_key)
2019
+
2020
+ ### HTTP request headers
2021
+
2022
+ - **Content-Type**: Not defined
2023
+ - **Accept**: application/json
2024
+
2025
+
2026
+ ## stock_bidask
2027
+
2028
+ > LastBidAsk stock_bidask(symbol)
2029
+
2030
+ Last Bid-Ask
2031
+
2032
+ Get last bid/ask data for US stocks.
2033
+
2034
+ ### Example
2035
+
2036
+ ```ruby
2037
+ # load the gem
2038
+ require 'finnhub_ruby'
2039
+ # setup authorization
2040
+ FinnhubRuby.configure do |config|
2041
+ # Configure API key authorization: api_key
2042
+ config.api_key['token'] = 'YOUR API KEY'
2043
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2044
+ #config.api_key_prefix['token'] = 'Bearer'
2045
+ end
2046
+
2047
+ api_instance = FinnhubRuby::DefaultApi.new
2048
+ symbol = 'symbol_example' # String | Symbol.
2049
+
2050
+ begin
2051
+ #Last Bid-Ask
2052
+ result = api_instance.stock_bidask(symbol)
2053
+ p result
2054
+ rescue FinnhubRuby::ApiError => e
2055
+ puts "Exception when calling DefaultApi->stock_bidask: #{e}"
2056
+ end
2057
+ ```
2058
+
2059
+ ### Parameters
2060
+
2061
+
2062
+ Name | Type | Description | Notes
2063
+ ------------- | ------------- | ------------- | -------------
2064
+ **symbol** | **String**| Symbol. |
2065
+
2066
+ ### Return type
2067
+
2068
+ [**LastBidAsk**](LastBidAsk.md)
2069
+
2070
+ ### Authorization
2071
+
2072
+ [api_key](../README.md#api_key)
2073
+
2074
+ ### HTTP request headers
2075
+
2076
+ - **Content-Type**: Not defined
2077
+ - **Accept**: application/json
2078
+
2079
+
2080
+ ## stock_candles
2081
+
2082
+ > StockCandles stock_candles(symbol, resolution, from, to, opts)
2083
+
2084
+ Stock Candles
2085
+
2086
+ <p>Get candlestick data for stocks going back 25 years for US stocks.</p><p>Real-time stock prices for international markets are supported for Enterprise clients via our partner's feed. <a href=\"mailto:support@finnhub.io\">Contact Us</a> to learn more.</p>
2087
+
2088
+ ### Example
2089
+
2090
+ ```ruby
2091
+ # load the gem
2092
+ require 'finnhub_ruby'
2093
+ # setup authorization
2094
+ FinnhubRuby.configure do |config|
2095
+ # Configure API key authorization: api_key
2096
+ config.api_key['token'] = 'YOUR API KEY'
2097
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2098
+ #config.api_key_prefix['token'] = 'Bearer'
2099
+ end
2100
+
2101
+ api_instance = FinnhubRuby::DefaultApi.new
2102
+ symbol = 'symbol_example' # String | Symbol.
2103
+ 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.
2104
+ from = 56 # Integer | UNIX timestamp. Interval initial value.
2105
+ to = 56 # Integer | UNIX timestamp. Interval end value.
2106
+ opts = {
2107
+ adjusted: 'adjusted_example' # String | By default, <code>adjusted=false</code>. Use <code>true</code> to get adjusted data.
2108
+ }
2109
+
2110
+ begin
2111
+ #Stock Candles
2112
+ result = api_instance.stock_candles(symbol, resolution, from, to, opts)
2113
+ p result
2114
+ rescue FinnhubRuby::ApiError => e
2115
+ puts "Exception when calling DefaultApi->stock_candles: #{e}"
2116
+ end
2117
+ ```
2118
+
2119
+ ### Parameters
2120
+
2121
+
2122
+ Name | Type | Description | Notes
2123
+ ------------- | ------------- | ------------- | -------------
2124
+ **symbol** | **String**| Symbol. |
2125
+ **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. |
2126
+ **from** | **Integer**| UNIX timestamp. Interval initial value. |
2127
+ **to** | **Integer**| UNIX timestamp. Interval end value. |
2128
+ **adjusted** | **String**| By default, &lt;code&gt;adjusted&#x3D;false&lt;/code&gt;. Use &lt;code&gt;true&lt;/code&gt; to get adjusted data. | [optional]
2129
+
2130
+ ### Return type
2131
+
2132
+ [**StockCandles**](StockCandles.md)
2133
+
2134
+ ### Authorization
2135
+
2136
+ [api_key](../README.md#api_key)
2137
+
2138
+ ### HTTP request headers
2139
+
2140
+ - **Content-Type**: Not defined
2141
+ - **Accept**: application/json
2142
+
2143
+
2144
+ ## stock_dividends
2145
+
2146
+ > Array&lt;Dividends&gt; stock_dividends(symbol, from, to)
2147
+
2148
+ Dividends
2149
+
2150
+ Get dividends data for common stocks going back 30 years.
2151
+
2152
+ ### Example
2153
+
2154
+ ```ruby
2155
+ # load the gem
2156
+ require 'finnhub_ruby'
2157
+ # setup authorization
2158
+ FinnhubRuby.configure do |config|
2159
+ # Configure API key authorization: api_key
2160
+ config.api_key['token'] = 'YOUR API KEY'
2161
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2162
+ #config.api_key_prefix['token'] = 'Bearer'
2163
+ end
2164
+
2165
+ api_instance = FinnhubRuby::DefaultApi.new
2166
+ symbol = 'symbol_example' # String | Symbol.
2167
+ from = Date.parse('2013-10-20') # Date | YYYY-MM-DD.
2168
+ to = Date.parse('2013-10-20') # Date | YYYY-MM-DD.
2169
+
2170
+ begin
2171
+ #Dividends
2172
+ result = api_instance.stock_dividends(symbol, from, to)
2173
+ p result
2174
+ rescue FinnhubRuby::ApiError => e
2175
+ puts "Exception when calling DefaultApi->stock_dividends: #{e}"
2176
+ end
2177
+ ```
2178
+
2179
+ ### Parameters
2180
+
2181
+
2182
+ Name | Type | Description | Notes
2183
+ ------------- | ------------- | ------------- | -------------
2184
+ **symbol** | **String**| Symbol. |
2185
+ **from** | **Date**| YYYY-MM-DD. |
2186
+ **to** | **Date**| YYYY-MM-DD. |
2187
+
2188
+ ### Return type
2189
+
2190
+ [**Array&lt;Dividends&gt;**](Dividends.md)
2191
+
2192
+ ### Authorization
2193
+
2194
+ [api_key](../README.md#api_key)
2195
+
2196
+ ### HTTP request headers
2197
+
2198
+ - **Content-Type**: Not defined
2199
+ - **Accept**: application/json
2200
+
2201
+
2202
+ ## stock_splits
2203
+
2204
+ > Array&lt;Split&gt; stock_splits(symbol, from, to)
2205
+
2206
+ Splits
2207
+
2208
+ Get splits data for stocks.
2209
+
2210
+ ### Example
2211
+
2212
+ ```ruby
2213
+ # load the gem
2214
+ require 'finnhub_ruby'
2215
+ # setup authorization
2216
+ FinnhubRuby.configure do |config|
2217
+ # Configure API key authorization: api_key
2218
+ config.api_key['token'] = 'YOUR API KEY'
2219
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2220
+ #config.api_key_prefix['token'] = 'Bearer'
2221
+ end
2222
+
2223
+ api_instance = FinnhubRuby::DefaultApi.new
2224
+ symbol = 'symbol_example' # String | Symbol.
2225
+ from = Date.parse('2013-10-20') # Date | YYYY-MM-DD.
2226
+ to = Date.parse('2013-10-20') # Date | YYYY-MM-DD.
2227
+
2228
+ begin
2229
+ #Splits
2230
+ result = api_instance.stock_splits(symbol, from, to)
2231
+ p result
2232
+ rescue FinnhubRuby::ApiError => e
2233
+ puts "Exception when calling DefaultApi->stock_splits: #{e}"
2234
+ end
2235
+ ```
2236
+
2237
+ ### Parameters
2238
+
2239
+
2240
+ Name | Type | Description | Notes
2241
+ ------------- | ------------- | ------------- | -------------
2242
+ **symbol** | **String**| Symbol. |
2243
+ **from** | **Date**| YYYY-MM-DD. |
2244
+ **to** | **Date**| YYYY-MM-DD. |
2245
+
2246
+ ### Return type
2247
+
2248
+ [**Array&lt;Split&gt;**](Split.md)
2249
+
2250
+ ### Authorization
2251
+
2252
+ [api_key](../README.md#api_key)
2253
+
2254
+ ### HTTP request headers
2255
+
2256
+ - **Content-Type**: Not defined
2257
+ - **Accept**: application/json
2258
+
2259
+
2260
+ ## stock_symbols
2261
+
2262
+ > Array&lt;Stock&gt; stock_symbols(exchange)
2263
+
2264
+ Stock Symbol
2265
+
2266
+ List supported stocks.
2267
+
2268
+ ### Example
2269
+
2270
+ ```ruby
2271
+ # load the gem
2272
+ require 'finnhub_ruby'
2273
+ # setup authorization
2274
+ FinnhubRuby.configure do |config|
2275
+ # Configure API key authorization: api_key
2276
+ config.api_key['token'] = 'YOUR API KEY'
2277
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2278
+ #config.api_key_prefix['token'] = 'Bearer'
2279
+ end
2280
+
2281
+ api_instance = FinnhubRuby::DefaultApi.new
2282
+ exchange = 'exchange_example' # String | Exchange you want to get the list of symbols from. List of exchanges with fundamental data can be found <a href=\"https://docs.google.com/spreadsheets/d/1I3pBxjfXB056-g_JYf_6o3Rns3BV2kMGG1nCatb91ls/edit?usp=sharing\" target=\"_blank\">here</a>.
2283
+
2284
+ begin
2285
+ #Stock Symbol
2286
+ result = api_instance.stock_symbols(exchange)
2287
+ p result
2288
+ rescue FinnhubRuby::ApiError => e
2289
+ puts "Exception when calling DefaultApi->stock_symbols: #{e}"
2290
+ end
2291
+ ```
2292
+
2293
+ ### Parameters
2294
+
2295
+
2296
+ Name | Type | Description | Notes
2297
+ ------------- | ------------- | ------------- | -------------
2298
+ **exchange** | **String**| Exchange you want to get the list of symbols from. List of exchanges with fundamental data can be found &lt;a href&#x3D;\&quot;https://docs.google.com/spreadsheets/d/1I3pBxjfXB056-g_JYf_6o3Rns3BV2kMGG1nCatb91ls/edit?usp&#x3D;sharing\&quot; target&#x3D;\&quot;_blank\&quot;&gt;here&lt;/a&gt;. |
2299
+
2300
+ ### Return type
2301
+
2302
+ [**Array&lt;Stock&gt;**](Stock.md)
2303
+
2304
+ ### Authorization
2305
+
2306
+ [api_key](../README.md#api_key)
2307
+
2308
+ ### HTTP request headers
2309
+
2310
+ - **Content-Type**: Not defined
2311
+ - **Accept**: application/json
2312
+
2313
+
2314
+ ## stock_tick
2315
+
2316
+ > TickData stock_tick(symbol, date, limit, skip)
2317
+
2318
+ Tick Data
2319
+
2320
+ <p>Get historical tick data for US stocks from all 13 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. Data is updated at the end of each trading day.</p><p>Tick data from 1985 is available for Enterprise clients. <a href=\"mailto:support@finnhub.io\">Contact us</a> to learn more.</p>
2321
+
2322
+ ### Example
2323
+
2324
+ ```ruby
2325
+ # load the gem
2326
+ require 'finnhub_ruby'
2327
+ # setup authorization
2328
+ FinnhubRuby.configure do |config|
2329
+ # Configure API key authorization: api_key
2330
+ config.api_key['token'] = 'YOUR API KEY'
2331
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2332
+ #config.api_key_prefix['token'] = 'Bearer'
2333
+ end
2334
+
2335
+ api_instance = FinnhubRuby::DefaultApi.new
2336
+ symbol = 'symbol_example' # String | Symbol.
2337
+ date = Date.parse('2013-10-20') # Date | Date: 2020-04-02.
2338
+ limit = 56 # Integer | Limit number of ticks returned. Maximum value: <code>25000</code>
2339
+ skip = 56 # Integer | Number of ticks to skip. Use this parameter to loop through the entire data.
2340
+
2341
+ begin
2342
+ #Tick Data
2343
+ result = api_instance.stock_tick(symbol, date, limit, skip)
2344
+ p result
2345
+ rescue FinnhubRuby::ApiError => e
2346
+ puts "Exception when calling DefaultApi->stock_tick: #{e}"
2347
+ end
2348
+ ```
2349
+
2350
+ ### Parameters
2351
+
2352
+
2353
+ Name | Type | Description | Notes
2354
+ ------------- | ------------- | ------------- | -------------
2355
+ **symbol** | **String**| Symbol. |
2356
+ **date** | **Date**| Date: 2020-04-02. |
2357
+ **limit** | **Integer**| Limit number of ticks returned. Maximum value: &lt;code&gt;25000&lt;/code&gt; |
2358
+ **skip** | **Integer**| Number of ticks to skip. Use this parameter to loop through the entire data. |
2359
+
2360
+ ### Return type
2361
+
2362
+ [**TickData**](TickData.md)
2363
+
2364
+ ### Authorization
2365
+
2366
+ [api_key](../README.md#api_key)
2367
+
2368
+ ### HTTP request headers
2369
+
2370
+ - **Content-Type**: Not defined
2371
+ - **Accept**: application/json
2372
+
2373
+
2374
+ ## support_resistance
2375
+
2376
+ > SupportResistance support_resistance(symbol, resolution)
2377
+
2378
+ Support/Resistance
2379
+
2380
+ Get support and resistance levels for a symbol.
2381
+
2382
+ ### Example
2383
+
2384
+ ```ruby
2385
+ # load the gem
2386
+ require 'finnhub_ruby'
2387
+ # setup authorization
2388
+ FinnhubRuby.configure do |config|
2389
+ # Configure API key authorization: api_key
2390
+ config.api_key['token'] = 'YOUR API KEY'
2391
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2392
+ #config.api_key_prefix['token'] = 'Bearer'
2393
+ end
2394
+
2395
+ api_instance = FinnhubRuby::DefaultApi.new
2396
+ symbol = 'symbol_example' # String | Symbol
2397
+ 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.
2398
+
2399
+ begin
2400
+ #Support/Resistance
2401
+ result = api_instance.support_resistance(symbol, resolution)
2402
+ p result
2403
+ rescue FinnhubRuby::ApiError => e
2404
+ puts "Exception when calling DefaultApi->support_resistance: #{e}"
2405
+ end
2406
+ ```
2407
+
2408
+ ### Parameters
2409
+
2410
+
2411
+ Name | Type | Description | Notes
2412
+ ------------- | ------------- | ------------- | -------------
2413
+ **symbol** | **String**| Symbol |
2414
+ **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. |
2415
+
2416
+ ### Return type
2417
+
2418
+ [**SupportResistance**](SupportResistance.md)
2419
+
2420
+ ### Authorization
2421
+
2422
+ [api_key](../README.md#api_key)
2423
+
2424
+ ### HTTP request headers
2425
+
2426
+ - **Content-Type**: Not defined
2427
+ - **Accept**: application/json
2428
+
2429
+
2430
+ ## technical_indicator
2431
+
2432
+ > Object technical_indicator(symbol, resolution, from, to, indicator, opts)
2433
+
2434
+ Technical Indicators
2435
+
2436
+ Return technical indicator with price data. List of supported indicators can be found <a href=\"https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing\" target=\"_blank\">here</a>.
2437
+
2438
+ ### Example
2439
+
2440
+ ```ruby
2441
+ # load the gem
2442
+ require 'finnhub_ruby'
2443
+ # setup authorization
2444
+ FinnhubRuby.configure do |config|
2445
+ # Configure API key authorization: api_key
2446
+ config.api_key['token'] = 'YOUR API KEY'
2447
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2448
+ #config.api_key_prefix['token'] = 'Bearer'
2449
+ end
2450
+
2451
+ api_instance = FinnhubRuby::DefaultApi.new
2452
+ symbol = 'symbol_example' # String | symbol
2453
+ 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.
2454
+ from = 56 # Integer | UNIX timestamp. Interval initial value.
2455
+ to = 56 # Integer | UNIX timestamp. Interval end value.
2456
+ indicator = 'indicator_example' # String | Indicator name. Full list can be found <a href=\"https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing\" target=\"_blank\">here</a>.
2457
+ opts = {
2458
+ indicator_fields: nil # Object | Check out <a href=\"https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing\" target=\"_blank\">this page</a> to see which indicators and params are supported.
2459
+ }
2460
+
2461
+ begin
2462
+ #Technical Indicators
2463
+ result = api_instance.technical_indicator(symbol, resolution, from, to, indicator, opts)
2464
+ p result
2465
+ rescue FinnhubRuby::ApiError => e
2466
+ puts "Exception when calling DefaultApi->technical_indicator: #{e}"
2467
+ end
2468
+ ```
2469
+
2470
+ ### Parameters
2471
+
2472
+
2473
+ Name | Type | Description | Notes
2474
+ ------------- | ------------- | ------------- | -------------
2475
+ **symbol** | **String**| symbol |
2476
+ **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. |
2477
+ **from** | **Integer**| UNIX timestamp. Interval initial value. |
2478
+ **to** | **Integer**| UNIX timestamp. Interval end value. |
2479
+ **indicator** | **String**| Indicator name. Full list can be found &lt;a href&#x3D;\&quot;https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp&#x3D;sharing\&quot; target&#x3D;\&quot;_blank\&quot;&gt;here&lt;/a&gt;. |
2480
+ **indicator_fields** | **Object**| Check out &lt;a href&#x3D;\&quot;https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp&#x3D;sharing\&quot; target&#x3D;\&quot;_blank\&quot;&gt;this page&lt;/a&gt; to see which indicators and params are supported. | [optional]
2481
+
2482
+ ### Return type
2483
+
2484
+ **Object**
2485
+
2486
+ ### Authorization
2487
+
2488
+ [api_key](../README.md#api_key)
2489
+
2490
+ ### HTTP request headers
2491
+
2492
+ - **Content-Type**: application/json
2493
+ - **Accept**: application/json
2494
+
2495
+
2496
+ ## transcripts
2497
+
2498
+ > EarningsCallTranscripts transcripts(id)
2499
+
2500
+ Earnings Call Transcripts
2501
+
2502
+ <p>Get earnings call transcripts, audio and participants' list. This endpoint is only available for US companies. <p>17+ years of data is available with 170,000+ audio which add up to 6TB in size.</p>
2503
+
2504
+ ### Example
2505
+
2506
+ ```ruby
2507
+ # load the gem
2508
+ require 'finnhub_ruby'
2509
+ # setup authorization
2510
+ FinnhubRuby.configure do |config|
2511
+ # Configure API key authorization: api_key
2512
+ config.api_key['token'] = 'YOUR API KEY'
2513
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2514
+ #config.api_key_prefix['token'] = 'Bearer'
2515
+ end
2516
+
2517
+ api_instance = FinnhubRuby::DefaultApi.new
2518
+ id = 'id_example' # String | Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>.
2519
+
2520
+ begin
2521
+ #Earnings Call Transcripts
2522
+ result = api_instance.transcripts(id)
2523
+ p result
2524
+ rescue FinnhubRuby::ApiError => e
2525
+ puts "Exception when calling DefaultApi->transcripts: #{e}"
2526
+ end
2527
+ ```
2528
+
2529
+ ### Parameters
2530
+
2531
+
2532
+ Name | Type | Description | Notes
2533
+ ------------- | ------------- | ------------- | -------------
2534
+ **id** | **String**| Transcript&#39;s id obtained with &lt;a href&#x3D;\&quot;#transcripts-list\&quot;&gt;Transcripts List endpoint&lt;/a&gt;. |
2535
+
2536
+ ### Return type
2537
+
2538
+ [**EarningsCallTranscripts**](EarningsCallTranscripts.md)
2539
+
2540
+ ### Authorization
2541
+
2542
+ [api_key](../README.md#api_key)
2543
+
2544
+ ### HTTP request headers
2545
+
2546
+ - **Content-Type**: Not defined
2547
+ - **Accept**: application/json
2548
+
2549
+
2550
+ ## transcripts_list
2551
+
2552
+ > EarningsCallTranscriptsList transcripts_list(symbol)
2553
+
2554
+ Earnings Call Transcripts List
2555
+
2556
+ List earnings call transcripts' metadata. This endpoint is only available for US companies.
2557
+
2558
+ ### Example
2559
+
2560
+ ```ruby
2561
+ # load the gem
2562
+ require 'finnhub_ruby'
2563
+ # setup authorization
2564
+ FinnhubRuby.configure do |config|
2565
+ # Configure API key authorization: api_key
2566
+ config.api_key['token'] = 'YOUR API KEY'
2567
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2568
+ #config.api_key_prefix['token'] = 'Bearer'
2569
+ end
2570
+
2571
+ api_instance = FinnhubRuby::DefaultApi.new
2572
+ symbol = 'symbol_example' # String | Company symbol: AAPL. Leave empty to list the latest transcripts
2573
+
2574
+ begin
2575
+ #Earnings Call Transcripts List
2576
+ result = api_instance.transcripts_list(symbol)
2577
+ p result
2578
+ rescue FinnhubRuby::ApiError => e
2579
+ puts "Exception when calling DefaultApi->transcripts_list: #{e}"
2580
+ end
2581
+ ```
2582
+
2583
+ ### Parameters
2584
+
2585
+
2586
+ Name | Type | Description | Notes
2587
+ ------------- | ------------- | ------------- | -------------
2588
+ **symbol** | **String**| Company symbol: AAPL. Leave empty to list the latest transcripts |
2589
+
2590
+ ### Return type
2591
+
2592
+ [**EarningsCallTranscriptsList**](EarningsCallTranscriptsList.md)
2593
+
2594
+ ### Authorization
2595
+
2596
+ [api_key](../README.md#api_key)
2597
+
2598
+ ### HTTP request headers
2599
+
2600
+ - **Content-Type**: Not defined
2601
+ - **Accept**: application/json
2602
+
2603
+
2604
+ ## upgrade_downgrade
2605
+
2606
+ > Array&lt;UpgradeDowngrade&gt; upgrade_downgrade(opts)
2607
+
2608
+ Stock Upgrade/Downgrade
2609
+
2610
+ Get latest stock upgrade and downgrade.
2611
+
2612
+ ### Example
2613
+
2614
+ ```ruby
2615
+ # load the gem
2616
+ require 'finnhub_ruby'
2617
+ # setup authorization
2618
+ FinnhubRuby.configure do |config|
2619
+ # Configure API key authorization: api_key
2620
+ config.api_key['token'] = 'YOUR API KEY'
2621
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2622
+ #config.api_key_prefix['token'] = 'Bearer'
2623
+ end
2624
+
2625
+ api_instance = FinnhubRuby::DefaultApi.new
2626
+ opts = {
2627
+ symbol: 'symbol_example', # String | Symbol of the company: AAPL. If left blank, the API will return latest stock upgrades/downgrades.
2628
+ from: Date.parse('2013-10-20'), # Date | From date: 2000-03-15.
2629
+ to: Date.parse('2013-10-20') # Date | To date: 2020-03-16.
2630
+ }
2631
+
2632
+ begin
2633
+ #Stock Upgrade/Downgrade
2634
+ result = api_instance.upgrade_downgrade(opts)
2635
+ p result
2636
+ rescue FinnhubRuby::ApiError => e
2637
+ puts "Exception when calling DefaultApi->upgrade_downgrade: #{e}"
2638
+ end
2639
+ ```
2640
+
2641
+ ### Parameters
2642
+
2643
+
2644
+ Name | Type | Description | Notes
2645
+ ------------- | ------------- | ------------- | -------------
2646
+ **symbol** | **String**| Symbol of the company: AAPL. If left blank, the API will return latest stock upgrades/downgrades. | [optional]
2647
+ **from** | **Date**| From date: 2000-03-15. | [optional]
2648
+ **to** | **Date**| To date: 2020-03-16. | [optional]
2649
+
2650
+ ### Return type
2651
+
2652
+ [**Array&lt;UpgradeDowngrade&gt;**](UpgradeDowngrade.md)
2653
+
2654
+ ### Authorization
2655
+
2656
+ [api_key](../README.md#api_key)
2657
+
2658
+ ### HTTP request headers
2659
+
2660
+ - **Content-Type**: Not defined
2661
+ - **Accept**: application/json
2662
+