finnhub_ruby 1.1.6 → 1.1.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +51 -14
- data/docs/CompanyESG.md +28 -0
- data/docs/CompanyEarningsQualityScore.md +22 -0
- data/docs/CompanyEarningsQualityScoreData.md +30 -0
- data/docs/CompanyProfile.md +5 -5
- data/docs/CountryMetadata.md +5 -1
- data/docs/CryptoProfile.md +38 -0
- data/docs/DefaultApi.md +241 -20
- data/docs/EarningRelease.md +2 -2
- data/docs/EarningsEstimates.md +1 -1
- data/docs/EarningsEstimatesInfo.md +26 -0
- data/docs/IPOEvent.md +2 -2
- data/docs/KeyCustomersSuppliers.md +13 -1
- data/docs/RevenueEstimates.md +1 -1
- data/docs/RevenueEstimatesInfo.md +26 -0
- data/docs/Sentiment.md +2 -2
- data/docs/SimilarityIndex.md +1 -1
- data/docs/SimilarityIndexInfo.md +40 -0
- data/finnhub_ruby-1.1.7.gem +0 -0
- data/finnhub_ruby-1.1.8.gem +0 -0
- data/finnhub_ruby-1.1.9.gem +0 -0
- data/finnhub_ruby.gemspec +1 -1
- data/lib/finnhub_ruby/api/default_api.rb +216 -14
- data/lib/finnhub_ruby/api_client.rb +1 -1
- data/lib/finnhub_ruby/api_error.rb +1 -1
- data/lib/finnhub_ruby/configuration.rb +1 -1
- data/lib/finnhub_ruby/models/aggregate_indicators.rb +1 -1
- data/lib/finnhub_ruby/models/basic_financials.rb +1 -1
- data/lib/finnhub_ruby/models/breakdown_item.rb +1 -1
- data/lib/finnhub_ruby/models/company.rb +1 -1
- data/lib/finnhub_ruby/models/company_earnings_quality_score.rb +241 -0
- data/lib/finnhub_ruby/models/company_earnings_quality_score_data.rb +279 -0
- data/lib/finnhub_ruby/models/company_esg.rb +268 -0
- data/lib/finnhub_ruby/models/company_executive.rb +1 -1
- data/lib/finnhub_ruby/models/company_news.rb +1 -1
- data/lib/finnhub_ruby/models/company_news_statistics.rb +1 -1
- data/lib/finnhub_ruby/models/company_profile.rb +6 -6
- data/lib/finnhub_ruby/models/company_profile2.rb +1 -1
- data/lib/finnhub_ruby/models/country_metadata.rb +25 -5
- data/lib/finnhub_ruby/models/covid_info.rb +1 -1
- data/lib/finnhub_ruby/models/crypto_candles.rb +1 -1
- data/lib/finnhub_ruby/models/crypto_profile.rb +319 -0
- data/lib/finnhub_ruby/models/crypto_symbol.rb +1 -1
- data/lib/finnhub_ruby/models/development.rb +1 -1
- data/lib/finnhub_ruby/models/dividends.rb +1 -1
- data/lib/finnhub_ruby/models/dividends2.rb +1 -1
- data/lib/finnhub_ruby/models/dividends2_info.rb +1 -1
- data/lib/finnhub_ruby/models/earning_release.rb +3 -3
- data/lib/finnhub_ruby/models/earning_result.rb +1 -1
- data/lib/finnhub_ruby/models/earnings_calendar.rb +1 -1
- data/lib/finnhub_ruby/models/earnings_call_transcripts.rb +1 -1
- data/lib/finnhub_ruby/models/earnings_call_transcripts_list.rb +1 -1
- data/lib/finnhub_ruby/models/earnings_estimates.rb +2 -2
- data/lib/finnhub_ruby/models/earnings_estimates_info.rb +259 -0
- data/lib/finnhub_ruby/models/economic_calendar.rb +1 -1
- data/lib/finnhub_ruby/models/economic_code.rb +1 -1
- data/lib/finnhub_ruby/models/economic_data.rb +1 -1
- data/lib/finnhub_ruby/models/economic_data_info.rb +1 -1
- data/lib/finnhub_ruby/models/economic_event.rb +1 -1
- data/lib/finnhub_ruby/models/etf_country_exposure_data.rb +1 -1
- data/lib/finnhub_ruby/models/etf_holdings_data.rb +1 -1
- data/lib/finnhub_ruby/models/etf_profile_data.rb +1 -1
- data/lib/finnhub_ruby/models/etf_sector_exposure_data.rb +1 -1
- data/lib/finnhub_ruby/models/etfs_country_exposure.rb +1 -1
- data/lib/finnhub_ruby/models/etfs_holdings.rb +1 -1
- data/lib/finnhub_ruby/models/etfs_profile.rb +1 -1
- data/lib/finnhub_ruby/models/etfs_sector_exposure.rb +1 -1
- data/lib/finnhub_ruby/models/fda_comittee_meeting.rb +1 -1
- data/lib/finnhub_ruby/models/filing.rb +1 -1
- data/lib/finnhub_ruby/models/filing_sentiment.rb +1 -1
- data/lib/finnhub_ruby/models/financial_statements.rb +1 -1
- data/lib/finnhub_ruby/models/financials_as_reported.rb +1 -1
- data/lib/finnhub_ruby/models/forex_candles.rb +1 -1
- data/lib/finnhub_ruby/models/forex_symbol.rb +1 -1
- data/lib/finnhub_ruby/models/forexrates.rb +1 -1
- data/lib/finnhub_ruby/models/fund_ownership.rb +1 -1
- data/lib/finnhub_ruby/models/fund_ownership_info.rb +1 -1
- data/lib/finnhub_ruby/models/historical_nbbo.rb +1 -1
- data/lib/finnhub_ruby/models/index_historical_constituent.rb +1 -1
- data/lib/finnhub_ruby/models/indicator.rb +1 -1
- data/lib/finnhub_ruby/models/indices_constituents.rb +1 -1
- data/lib/finnhub_ruby/models/indices_historical_constituents.rb +1 -1
- data/lib/finnhub_ruby/models/insider_transactions.rb +1 -1
- data/lib/finnhub_ruby/models/international_filing.rb +1 -1
- data/lib/finnhub_ruby/models/investment_theme_portfolio.rb +1 -1
- data/lib/finnhub_ruby/models/investment_themes.rb +1 -1
- data/lib/finnhub_ruby/models/ipo_calendar.rb +1 -1
- data/lib/finnhub_ruby/models/ipo_event.rb +3 -3
- data/lib/finnhub_ruby/models/key_customers_suppliers.rb +65 -5
- data/lib/finnhub_ruby/models/last_bid_ask.rb +1 -1
- data/lib/finnhub_ruby/models/market_news.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_country_exposure.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_country_exposure_data.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_holdings.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_holdings_data.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_profile.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_profile_data.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_sector_exposure.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_sector_exposure_data.rb +1 -1
- data/lib/finnhub_ruby/models/news_sentiment.rb +1 -1
- data/lib/finnhub_ruby/models/ownership.rb +1 -1
- data/lib/finnhub_ruby/models/ownership_info.rb +1 -1
- data/lib/finnhub_ruby/models/pattern_recognition.rb +1 -1
- data/lib/finnhub_ruby/models/press_release.rb +1 -1
- data/lib/finnhub_ruby/models/price_target.rb +1 -1
- data/lib/finnhub_ruby/models/quote.rb +1 -1
- data/lib/finnhub_ruby/models/recommendation_trend.rb +1 -1
- data/lib/finnhub_ruby/models/reddit_sentiment_content.rb +1 -1
- data/lib/finnhub_ruby/models/report.rb +1 -1
- data/lib/finnhub_ruby/models/revenue_breakdown.rb +1 -1
- data/lib/finnhub_ruby/models/revenue_estimates.rb +2 -2
- data/lib/finnhub_ruby/models/revenue_estimates_info.rb +259 -0
- data/lib/finnhub_ruby/models/sec_sentiment_analysis.rb +1 -1
- data/lib/finnhub_ruby/models/sentiment.rb +3 -3
- data/lib/finnhub_ruby/models/similarity_index.rb +2 -2
- data/lib/finnhub_ruby/models/similarity_index_info.rb +329 -0
- data/lib/finnhub_ruby/models/social_sentiment.rb +1 -1
- data/lib/finnhub_ruby/models/split.rb +1 -1
- data/lib/finnhub_ruby/models/stock_candles.rb +1 -1
- data/lib/finnhub_ruby/models/stock_symbol.rb +1 -1
- data/lib/finnhub_ruby/models/stock_transcripts.rb +1 -1
- data/lib/finnhub_ruby/models/supply_chain_relationships.rb +1 -1
- data/lib/finnhub_ruby/models/support_resistance.rb +1 -1
- data/lib/finnhub_ruby/models/symbol_lookup.rb +1 -1
- data/lib/finnhub_ruby/models/symbol_lookup_info.rb +1 -1
- data/lib/finnhub_ruby/models/technical_analysis.rb +1 -1
- data/lib/finnhub_ruby/models/tick_data.rb +1 -1
- data/lib/finnhub_ruby/models/transactions.rb +1 -1
- data/lib/finnhub_ruby/models/transcript_content.rb +1 -1
- data/lib/finnhub_ruby/models/transcript_participant.rb +1 -1
- data/lib/finnhub_ruby/models/trend.rb +1 -1
- data/lib/finnhub_ruby/models/twitter_sentiment_content.rb +1 -1
- data/lib/finnhub_ruby/models/upgrade_downgrade.rb +1 -1
- data/lib/finnhub_ruby/version.rb +2 -2
- data/lib/finnhub_ruby.rb +8 -3
- data/release.sh +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/company_earnings_quality_score_data_spec.rb +70 -0
- data/spec/models/company_earnings_quality_score_spec.rb +46 -0
- data/spec/models/company_esg_spec.rb +64 -0
- data/spec/models/crypto_profile_spec.rb +94 -0
- data/spec/models/earnings_estimates_info_spec.rb +58 -0
- data/spec/models/revenue_estimates_info_spec.rb +58 -0
- data/spec/models/similarity_index_info_spec.rb +100 -0
- data/spec/spec_helper.rb +1 -1
- metadata +33 -3
- data/finnhub_ruby-1.1.5.gem +0 -0
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version: 5.2.
|
|
9
|
+
OpenAPI Generator version: 5.2.1
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -228,6 +228,77 @@ module FinnhubRuby
|
|
|
228
228
|
return data, status_code, headers
|
|
229
229
|
end
|
|
230
230
|
|
|
231
|
+
# Company Earnings Quality Score
|
|
232
|
+
# <p>This endpoint provides Earnings Quality Score for global companies.</p><p> Earnings quality refers to the extent to which current earnings predict future earnings. \"High-quality\" earnings are expected to persist, while \"low-quality\" earnings do not. A higher score means a higher earnings quality</p><p>Finnhub uses a proprietary model which takes into consideration 4 criteria:</p> <ul style=\"list-style-type: unset; margin-left: 30px;\"><li>Profitability</li><li>Growth</li><li>Cash Generation & Capital Allocation</li><li>Leverage</li></ul><br/><p>We then compare the metrics of each company in each category against its peers in the same industry to gauge how quality its earnings is.</p>
|
|
233
|
+
# @param symbol [String] Symbol.
|
|
234
|
+
# @param freq [String] Frequency. Currently support <code>annual</code> and <code>quarterly</code>
|
|
235
|
+
# @param [Hash] opts the optional parameters
|
|
236
|
+
# @return [CompanyEarningsQualityScore]
|
|
237
|
+
def company_earnings_quality_score(symbol, freq, opts = {})
|
|
238
|
+
data, _status_code, _headers = company_earnings_quality_score_with_http_info(symbol, freq, opts)
|
|
239
|
+
data
|
|
240
|
+
end
|
|
241
|
+
|
|
242
|
+
# Company Earnings Quality Score
|
|
243
|
+
# <p>This endpoint provides Earnings Quality Score for global companies.</p><p> Earnings quality refers to the extent to which current earnings predict future earnings. \"High-quality\" earnings are expected to persist, while \"low-quality\" earnings do not. A higher score means a higher earnings quality</p><p>Finnhub uses a proprietary model which takes into consideration 4 criteria:</p> <ul style=\"list-style-type: unset; margin-left: 30px;\"><li>Profitability</li><li>Growth</li><li>Cash Generation & Capital Allocation</li><li>Leverage</li></ul><br/><p>We then compare the metrics of each company in each category against its peers in the same industry to gauge how quality its earnings is.</p>
|
|
244
|
+
# @param symbol [String] Symbol.
|
|
245
|
+
# @param freq [String] Frequency. Currently support <code>annual</code> and <code>quarterly</code>
|
|
246
|
+
# @param [Hash] opts the optional parameters
|
|
247
|
+
# @return [Array<(CompanyEarningsQualityScore, Integer, Hash)>] CompanyEarningsQualityScore data, response status code and response headers
|
|
248
|
+
def company_earnings_quality_score_with_http_info(symbol, freq, opts = {})
|
|
249
|
+
if @api_client.config.debugging
|
|
250
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.company_earnings_quality_score ...'
|
|
251
|
+
end
|
|
252
|
+
# verify the required parameter 'symbol' is set
|
|
253
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
|
254
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.company_earnings_quality_score"
|
|
255
|
+
end
|
|
256
|
+
# verify the required parameter 'freq' is set
|
|
257
|
+
if @api_client.config.client_side_validation && freq.nil?
|
|
258
|
+
fail ArgumentError, "Missing the required parameter 'freq' when calling DefaultApi.company_earnings_quality_score"
|
|
259
|
+
end
|
|
260
|
+
# resource path
|
|
261
|
+
local_var_path = '/stock/earnings-quality-score'
|
|
262
|
+
|
|
263
|
+
# query parameters
|
|
264
|
+
query_params = opts[:query_params] || {}
|
|
265
|
+
query_params[:'symbol'] = symbol
|
|
266
|
+
query_params[:'freq'] = freq
|
|
267
|
+
|
|
268
|
+
# header parameters
|
|
269
|
+
header_params = opts[:header_params] || {}
|
|
270
|
+
# HTTP header 'Accept' (if needed)
|
|
271
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
272
|
+
|
|
273
|
+
# form parameters
|
|
274
|
+
form_params = opts[:form_params] || {}
|
|
275
|
+
|
|
276
|
+
# http body (model)
|
|
277
|
+
post_body = opts[:debug_body]
|
|
278
|
+
|
|
279
|
+
# return_type
|
|
280
|
+
return_type = opts[:debug_return_type] || 'CompanyEarningsQualityScore'
|
|
281
|
+
|
|
282
|
+
# auth_names
|
|
283
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
284
|
+
|
|
285
|
+
new_options = opts.merge(
|
|
286
|
+
:operation => :"DefaultApi.company_earnings_quality_score",
|
|
287
|
+
:header_params => header_params,
|
|
288
|
+
:query_params => query_params,
|
|
289
|
+
:form_params => form_params,
|
|
290
|
+
:body => post_body,
|
|
291
|
+
:auth_names => auth_names,
|
|
292
|
+
:return_type => return_type
|
|
293
|
+
)
|
|
294
|
+
|
|
295
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
296
|
+
if @api_client.config.debugging
|
|
297
|
+
@api_client.config.logger.debug "API called: DefaultApi#company_earnings_quality_score\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
298
|
+
end
|
|
299
|
+
return data, status_code, headers
|
|
300
|
+
end
|
|
301
|
+
|
|
231
302
|
# Earnings Estimates
|
|
232
303
|
# Get company's EPS estimates.
|
|
233
304
|
# @param symbol [String] Symbol of the company: AAPL.
|
|
@@ -295,6 +366,70 @@ module FinnhubRuby
|
|
|
295
366
|
return data, status_code, headers
|
|
296
367
|
end
|
|
297
368
|
|
|
369
|
+
# Company ESG Scores
|
|
370
|
+
# <p>This endpoint provides ESG scores and important indicators for 1000+ global companies. The data is collected through company's public ESG disclosure and public sources.</p><p>Our ESG scoring models takes into account more than 150 different inputs to calculate the level of ESG risks and how well a company is managing them. A higher score means lower ESG risk or better ESG management. ESG scores are in the the range of 0-100. Some key indicators might contain letter-grade score from C- to A+ with C- is the lowest score and A+ is the highest score.</p>
|
|
371
|
+
# @param symbol [String] Symbol.
|
|
372
|
+
# @param [Hash] opts the optional parameters
|
|
373
|
+
# @return [CompanyESG]
|
|
374
|
+
def company_esg_score(symbol, opts = {})
|
|
375
|
+
data, _status_code, _headers = company_esg_score_with_http_info(symbol, opts)
|
|
376
|
+
data
|
|
377
|
+
end
|
|
378
|
+
|
|
379
|
+
# Company ESG Scores
|
|
380
|
+
# <p>This endpoint provides ESG scores and important indicators for 1000+ global companies. The data is collected through company's public ESG disclosure and public sources.</p><p>Our ESG scoring models takes into account more than 150 different inputs to calculate the level of ESG risks and how well a company is managing them. A higher score means lower ESG risk or better ESG management. ESG scores are in the the range of 0-100. Some key indicators might contain letter-grade score from C- to A+ with C- is the lowest score and A+ is the highest score.</p>
|
|
381
|
+
# @param symbol [String] Symbol.
|
|
382
|
+
# @param [Hash] opts the optional parameters
|
|
383
|
+
# @return [Array<(CompanyESG, Integer, Hash)>] CompanyESG data, response status code and response headers
|
|
384
|
+
def company_esg_score_with_http_info(symbol, opts = {})
|
|
385
|
+
if @api_client.config.debugging
|
|
386
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.company_esg_score ...'
|
|
387
|
+
end
|
|
388
|
+
# verify the required parameter 'symbol' is set
|
|
389
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
|
390
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.company_esg_score"
|
|
391
|
+
end
|
|
392
|
+
# resource path
|
|
393
|
+
local_var_path = '/stock/esg'
|
|
394
|
+
|
|
395
|
+
# query parameters
|
|
396
|
+
query_params = opts[:query_params] || {}
|
|
397
|
+
query_params[:'symbol'] = symbol
|
|
398
|
+
|
|
399
|
+
# header parameters
|
|
400
|
+
header_params = opts[:header_params] || {}
|
|
401
|
+
# HTTP header 'Accept' (if needed)
|
|
402
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
403
|
+
|
|
404
|
+
# form parameters
|
|
405
|
+
form_params = opts[:form_params] || {}
|
|
406
|
+
|
|
407
|
+
# http body (model)
|
|
408
|
+
post_body = opts[:debug_body]
|
|
409
|
+
|
|
410
|
+
# return_type
|
|
411
|
+
return_type = opts[:debug_return_type] || 'CompanyESG'
|
|
412
|
+
|
|
413
|
+
# auth_names
|
|
414
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
415
|
+
|
|
416
|
+
new_options = opts.merge(
|
|
417
|
+
:operation => :"DefaultApi.company_esg_score",
|
|
418
|
+
:header_params => header_params,
|
|
419
|
+
:query_params => query_params,
|
|
420
|
+
:form_params => form_params,
|
|
421
|
+
:body => post_body,
|
|
422
|
+
:auth_names => auth_names,
|
|
423
|
+
:return_type => return_type
|
|
424
|
+
)
|
|
425
|
+
|
|
426
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
427
|
+
if @api_client.config.debugging
|
|
428
|
+
@api_client.config.logger.debug "API called: DefaultApi#company_esg_score\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
429
|
+
end
|
|
430
|
+
return data, status_code, headers
|
|
431
|
+
end
|
|
432
|
+
|
|
298
433
|
# Company Executive
|
|
299
434
|
# Get a list of company's executives and members of the Board.
|
|
300
435
|
# @param symbol [String] Symbol of the company: AAPL.
|
|
@@ -438,7 +573,7 @@ module FinnhubRuby
|
|
|
438
573
|
end
|
|
439
574
|
|
|
440
575
|
# Peers
|
|
441
|
-
# Get company peers. Return a list of peers in the same country and
|
|
576
|
+
# Get company peers. Return a list of peers in the same country and sub-industry
|
|
442
577
|
# @param symbol [String] Symbol of the company: AAPL.
|
|
443
578
|
# @param [Hash] opts the optional parameters
|
|
444
579
|
# @return [Array<String>]
|
|
@@ -448,7 +583,7 @@ module FinnhubRuby
|
|
|
448
583
|
end
|
|
449
584
|
|
|
450
585
|
# Peers
|
|
451
|
-
# Get company peers. Return a list of peers in the same country and
|
|
586
|
+
# Get company peers. Return a list of peers in the same country and sub-industry
|
|
452
587
|
# @param symbol [String] Symbol of the company: AAPL.
|
|
453
588
|
# @param [Hash] opts the optional parameters
|
|
454
589
|
# @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
|
|
@@ -956,6 +1091,70 @@ module FinnhubRuby
|
|
|
956
1091
|
return data, status_code, headers
|
|
957
1092
|
end
|
|
958
1093
|
|
|
1094
|
+
# Crypto Profile
|
|
1095
|
+
# Get crypto's profile.
|
|
1096
|
+
# @param symbol [String] Crypto symbol such as BTC or ETH.
|
|
1097
|
+
# @param [Hash] opts the optional parameters
|
|
1098
|
+
# @return [CryptoProfile]
|
|
1099
|
+
def crypto_profile(symbol, opts = {})
|
|
1100
|
+
data, _status_code, _headers = crypto_profile_with_http_info(symbol, opts)
|
|
1101
|
+
data
|
|
1102
|
+
end
|
|
1103
|
+
|
|
1104
|
+
# Crypto Profile
|
|
1105
|
+
# Get crypto's profile.
|
|
1106
|
+
# @param symbol [String] Crypto symbol such as BTC or ETH.
|
|
1107
|
+
# @param [Hash] opts the optional parameters
|
|
1108
|
+
# @return [Array<(CryptoProfile, Integer, Hash)>] CryptoProfile data, response status code and response headers
|
|
1109
|
+
def crypto_profile_with_http_info(symbol, opts = {})
|
|
1110
|
+
if @api_client.config.debugging
|
|
1111
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.crypto_profile ...'
|
|
1112
|
+
end
|
|
1113
|
+
# verify the required parameter 'symbol' is set
|
|
1114
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
|
1115
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.crypto_profile"
|
|
1116
|
+
end
|
|
1117
|
+
# resource path
|
|
1118
|
+
local_var_path = '/crypto/profile'
|
|
1119
|
+
|
|
1120
|
+
# query parameters
|
|
1121
|
+
query_params = opts[:query_params] || {}
|
|
1122
|
+
query_params[:'symbol'] = symbol
|
|
1123
|
+
|
|
1124
|
+
# header parameters
|
|
1125
|
+
header_params = opts[:header_params] || {}
|
|
1126
|
+
# HTTP header 'Accept' (if needed)
|
|
1127
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1128
|
+
|
|
1129
|
+
# form parameters
|
|
1130
|
+
form_params = opts[:form_params] || {}
|
|
1131
|
+
|
|
1132
|
+
# http body (model)
|
|
1133
|
+
post_body = opts[:debug_body]
|
|
1134
|
+
|
|
1135
|
+
# return_type
|
|
1136
|
+
return_type = opts[:debug_return_type] || 'CryptoProfile'
|
|
1137
|
+
|
|
1138
|
+
# auth_names
|
|
1139
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
1140
|
+
|
|
1141
|
+
new_options = opts.merge(
|
|
1142
|
+
:operation => :"DefaultApi.crypto_profile",
|
|
1143
|
+
:header_params => header_params,
|
|
1144
|
+
:query_params => query_params,
|
|
1145
|
+
:form_params => form_params,
|
|
1146
|
+
:body => post_body,
|
|
1147
|
+
:auth_names => auth_names,
|
|
1148
|
+
:return_type => return_type
|
|
1149
|
+
)
|
|
1150
|
+
|
|
1151
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1152
|
+
if @api_client.config.debugging
|
|
1153
|
+
@api_client.config.logger.debug "API called: DefaultApi#crypto_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1154
|
+
end
|
|
1155
|
+
return data, status_code, headers
|
|
1156
|
+
end
|
|
1157
|
+
|
|
959
1158
|
# Crypto Symbol
|
|
960
1159
|
# List supported crypto symbols by exchange
|
|
961
1160
|
# @param exchange [String] Exchange you want to get the list of symbols from.
|
|
@@ -1092,6 +1291,8 @@ module FinnhubRuby
|
|
|
1092
1291
|
# Economic Calendar
|
|
1093
1292
|
# <p>Get recent and upcoming economic releases.</p><p>Historical events and surprises are available for Enterprise clients.</p>
|
|
1094
1293
|
# @param [Hash] opts the optional parameters
|
|
1294
|
+
# @option opts [Date] :from From date <code>YYYY-MM-DD</code>.
|
|
1295
|
+
# @option opts [Date] :to To date <code>YYYY-MM-DD</code>.
|
|
1095
1296
|
# @return [EconomicCalendar]
|
|
1096
1297
|
def economic_calendar(opts = {})
|
|
1097
1298
|
data, _status_code, _headers = economic_calendar_with_http_info(opts)
|
|
@@ -1101,6 +1302,8 @@ module FinnhubRuby
|
|
|
1101
1302
|
# Economic Calendar
|
|
1102
1303
|
# <p>Get recent and upcoming economic releases.</p><p>Historical events and surprises are available for Enterprise clients.</p>
|
|
1103
1304
|
# @param [Hash] opts the optional parameters
|
|
1305
|
+
# @option opts [Date] :from From date <code>YYYY-MM-DD</code>.
|
|
1306
|
+
# @option opts [Date] :to To date <code>YYYY-MM-DD</code>.
|
|
1104
1307
|
# @return [Array<(EconomicCalendar, Integer, Hash)>] EconomicCalendar data, response status code and response headers
|
|
1105
1308
|
def economic_calendar_with_http_info(opts = {})
|
|
1106
1309
|
if @api_client.config.debugging
|
|
@@ -1111,6 +1314,8 @@ module FinnhubRuby
|
|
|
1111
1314
|
|
|
1112
1315
|
# query parameters
|
|
1113
1316
|
query_params = opts[:query_params] || {}
|
|
1317
|
+
query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
|
|
1318
|
+
query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
|
|
1114
1319
|
|
|
1115
1320
|
# header parameters
|
|
1116
1321
|
header_params = opts[:header_params] || {}
|
|
@@ -2330,7 +2535,7 @@ module FinnhubRuby
|
|
|
2330
2535
|
|
|
2331
2536
|
# Insider Transactions
|
|
2332
2537
|
# Company insider transactions data sourced from <code>Form 3,4,5</code>. This endpoint only covers US companies at the moment. Limit to 100 transactions per API call.
|
|
2333
|
-
# @param symbol [String] Symbol of the company: AAPL.
|
|
2538
|
+
# @param symbol [String] Symbol of the company: AAPL. Leave this param blank to get the latest transactions.
|
|
2334
2539
|
# @param [Hash] opts the optional parameters
|
|
2335
2540
|
# @option opts [Date] :from From date: 2020-03-15.
|
|
2336
2541
|
# @option opts [Date] :to To date: 2020-03-16.
|
|
@@ -2342,7 +2547,7 @@ module FinnhubRuby
|
|
|
2342
2547
|
|
|
2343
2548
|
# Insider Transactions
|
|
2344
2549
|
# Company insider transactions data sourced from <code>Form 3,4,5</code>. This endpoint only covers US companies at the moment. Limit to 100 transactions per API call.
|
|
2345
|
-
# @param symbol [String] Symbol of the company: AAPL.
|
|
2550
|
+
# @param symbol [String] Symbol of the company: AAPL. Leave this param blank to get the latest transactions.
|
|
2346
2551
|
# @param [Hash] opts the optional parameters
|
|
2347
2552
|
# @option opts [Date] :from From date: 2020-03-15.
|
|
2348
2553
|
# @option opts [Date] :to To date: 2020-03-16.
|
|
@@ -2600,7 +2805,7 @@ module FinnhubRuby
|
|
|
2600
2805
|
# Get latest market news.
|
|
2601
2806
|
# @param category [String] This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>.
|
|
2602
2807
|
# @param [Hash] opts the optional parameters
|
|
2603
|
-
# @option opts [
|
|
2808
|
+
# @option opts [Integer] :min_id Use this field to get only news after this ID. Default to 0
|
|
2604
2809
|
# @return [Array<MarketNews>]
|
|
2605
2810
|
def market_news(category, opts = {})
|
|
2606
2811
|
data, _status_code, _headers = market_news_with_http_info(category, opts)
|
|
@@ -2611,7 +2816,7 @@ module FinnhubRuby
|
|
|
2611
2816
|
# Get latest market news.
|
|
2612
2817
|
# @param category [String] This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>.
|
|
2613
2818
|
# @param [Hash] opts the optional parameters
|
|
2614
|
-
# @option opts [
|
|
2819
|
+
# @option opts [Integer] :min_id Use this field to get only news after this ID. Default to 0
|
|
2615
2820
|
# @return [Array<(Array<MarketNews>, Integer, Hash)>] Array<MarketNews> data, response status code and response headers
|
|
2616
2821
|
def market_news_with_http_info(category, opts = {})
|
|
2617
2822
|
if @api_client.config.debugging
|
|
@@ -3712,13 +3917,12 @@ module FinnhubRuby
|
|
|
3712
3917
|
end
|
|
3713
3918
|
|
|
3714
3919
|
# Stock Candles
|
|
3715
|
-
# <p>Get candlestick data (OHLCV) for stocks
|
|
3920
|
+
# <p>Get candlestick data (OHLCV) for stocks.</p><p>Daily data will be adjusted for Splits. Intraday data will remain unadjusted.</p>
|
|
3716
3921
|
# @param symbol [String] Symbol.
|
|
3717
3922
|
# @param resolution [String] Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.
|
|
3718
3923
|
# @param from [Integer] UNIX timestamp. Interval initial value.
|
|
3719
3924
|
# @param to [Integer] UNIX timestamp. Interval end value.
|
|
3720
3925
|
# @param [Hash] opts the optional parameters
|
|
3721
|
-
# @option opts [String] :adjusted DEPRECATED: this option has been deprecated. All Daily data will be adjusted for Splits and intraday data will remain unadjusted.
|
|
3722
3926
|
# @return [StockCandles]
|
|
3723
3927
|
def stock_candles(symbol, resolution, from, to, opts = {})
|
|
3724
3928
|
data, _status_code, _headers = stock_candles_with_http_info(symbol, resolution, from, to, opts)
|
|
@@ -3726,13 +3930,12 @@ module FinnhubRuby
|
|
|
3726
3930
|
end
|
|
3727
3931
|
|
|
3728
3932
|
# Stock Candles
|
|
3729
|
-
# <p>Get candlestick data (OHLCV) for stocks
|
|
3933
|
+
# <p>Get candlestick data (OHLCV) for stocks.</p><p>Daily data will be adjusted for Splits. Intraday data will remain unadjusted.</p>
|
|
3730
3934
|
# @param symbol [String] Symbol.
|
|
3731
3935
|
# @param resolution [String] Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.
|
|
3732
3936
|
# @param from [Integer] UNIX timestamp. Interval initial value.
|
|
3733
3937
|
# @param to [Integer] UNIX timestamp. Interval end value.
|
|
3734
3938
|
# @param [Hash] opts the optional parameters
|
|
3735
|
-
# @option opts [String] :adjusted DEPRECATED: this option has been deprecated. All Daily data will be adjusted for Splits and intraday data will remain unadjusted.
|
|
3736
3939
|
# @return [Array<(StockCandles, Integer, Hash)>] StockCandles data, response status code and response headers
|
|
3737
3940
|
def stock_candles_with_http_info(symbol, resolution, from, to, opts = {})
|
|
3738
3941
|
if @api_client.config.debugging
|
|
@@ -3763,7 +3966,6 @@ module FinnhubRuby
|
|
|
3763
3966
|
query_params[:'resolution'] = resolution
|
|
3764
3967
|
query_params[:'from'] = from
|
|
3765
3968
|
query_params[:'to'] = to
|
|
3766
|
-
query_params[:'adjusted'] = opts[:'adjusted'] if !opts[:'adjusted'].nil?
|
|
3767
3969
|
|
|
3768
3970
|
# header parameters
|
|
3769
3971
|
header_params = opts[:header_params] || {}
|
|
@@ -4114,7 +4316,7 @@ module FinnhubRuby
|
|
|
4114
4316
|
end
|
|
4115
4317
|
|
|
4116
4318
|
# Tick Data
|
|
4117
|
-
# <p>Get historical tick data for global exchanges. You can send the request directly to our tick server at <a href=\"https://tick.finnhub.io/\">https://tick.finnhub.io/</a> with the same path and parameters or get redirected there if you call our main server.</p><p>For US market, you can visit our bulk download page in the Dashboard <a target=\"_blank\" href=\"/dashboard/download\",>here</a> to speed up the download process.</p><
|
|
4319
|
+
# <p>Get historical tick data for global exchanges. You can send the request directly to our tick server at <a href=\"https://tick.finnhub.io/\">https://tick.finnhub.io/</a> with the same path and parameters or get redirected there if you call our main server.</p><p>For US market, you can visit our bulk download page in the Dashboard <a target=\"_blank\" href=\"/dashboard/download\",>here</a> to speed up the download process.</p><table class=\"table table-hover\"> <thead> <tr> <th>Exchange</th> <th>Segment</th> <th>Delay</th> </tr> </thead> <tbody> <tr> <td class=\"text-blue\">US CTA/UTP</th> <td>Full SIP</td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">TSX</th> <td><ul><li>TSX</li><li>TSX Venture</li><li>Index</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">LSE</th> <td><ul><li>London Stock Exchange (L)</li><li>LSE International (L)</li><li>LSE European (L)</li></ul></td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">Euronext</th> <td><ul> <li>Euronext Paris (PA)</li> <li>Euronext Amsterdam (AS)</li> <li>Euronext Lisbon (LS)</li> <li>Euronext Brussels (BR)</li> <li>Euronext Oslo (OL)</li> <li>Euronext London (LN)</li> <li>Euronext Dublin (IR)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">Deutsche Börse</th> <td><ul> <li>Frankfurt (F)</li> <li>Xetra (DE)</li> <li>Duesseldorf (DU)</li> <li>Hamburg (HM)</li> <li>Berlin (BE)</li> <li>Hanover (HA)</li> <li>Stoxx (SX)</li> <li>TradeGate (TG)</li> <li>Zertifikate (SC)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">Nasdaq Nordic & Baltic</th> <td> <ul> <li>Copenhagen (CO)</li> <li>Stockholm (ST)</li> <li>Helsinki (HE)</li> <li>Iceland (IC)</li> <li>Riga (RG)</li> <li>Tallinn (TL)</li> <li>Vilnius(VS)</li> <li>Fixed Income</li> <li>Derivatives</li> <li>Commodities</li></ul></td> <td>End-of-day</td> </tr> </tbody> </table>
|
|
4118
4320
|
# @param symbol [String] Symbol.
|
|
4119
4321
|
# @param date [Date] Date: 2020-04-02.
|
|
4120
4322
|
# @param limit [Integer] Limit number of ticks returned. Maximum value: <code>25000</code>
|
|
@@ -4127,7 +4329,7 @@ module FinnhubRuby
|
|
|
4127
4329
|
end
|
|
4128
4330
|
|
|
4129
4331
|
# Tick Data
|
|
4130
|
-
# <p>Get historical tick data for global exchanges. You can send the request directly to our tick server at <a href=\"https://tick.finnhub.io/\">https://tick.finnhub.io/</a> with the same path and parameters or get redirected there if you call our main server.</p><p>For US market, you can visit our bulk download page in the Dashboard <a target=\"_blank\" href=\"/dashboard/download\",>here</a> to speed up the download process.</p><
|
|
4332
|
+
# <p>Get historical tick data for global exchanges. You can send the request directly to our tick server at <a href=\"https://tick.finnhub.io/\">https://tick.finnhub.io/</a> with the same path and parameters or get redirected there if you call our main server.</p><p>For US market, you can visit our bulk download page in the Dashboard <a target=\"_blank\" href=\"/dashboard/download\",>here</a> to speed up the download process.</p><table class=\"table table-hover\"> <thead> <tr> <th>Exchange</th> <th>Segment</th> <th>Delay</th> </tr> </thead> <tbody> <tr> <td class=\"text-blue\">US CTA/UTP</th> <td>Full SIP</td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">TSX</th> <td><ul><li>TSX</li><li>TSX Venture</li><li>Index</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">LSE</th> <td><ul><li>London Stock Exchange (L)</li><li>LSE International (L)</li><li>LSE European (L)</li></ul></td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">Euronext</th> <td><ul> <li>Euronext Paris (PA)</li> <li>Euronext Amsterdam (AS)</li> <li>Euronext Lisbon (LS)</li> <li>Euronext Brussels (BR)</li> <li>Euronext Oslo (OL)</li> <li>Euronext London (LN)</li> <li>Euronext Dublin (IR)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">Deutsche Börse</th> <td><ul> <li>Frankfurt (F)</li> <li>Xetra (DE)</li> <li>Duesseldorf (DU)</li> <li>Hamburg (HM)</li> <li>Berlin (BE)</li> <li>Hanover (HA)</li> <li>Stoxx (SX)</li> <li>TradeGate (TG)</li> <li>Zertifikate (SC)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">Nasdaq Nordic & Baltic</th> <td> <ul> <li>Copenhagen (CO)</li> <li>Stockholm (ST)</li> <li>Helsinki (HE)</li> <li>Iceland (IC)</li> <li>Riga (RG)</li> <li>Tallinn (TL)</li> <li>Vilnius(VS)</li> <li>Fixed Income</li> <li>Derivatives</li> <li>Commodities</li></ul></td> <td>End-of-day</td> </tr> </tbody> </table>
|
|
4131
4333
|
# @param symbol [String] Symbol.
|
|
4132
4334
|
# @param date [Date] Date: 2020-04-02.
|
|
4133
4335
|
# @param limit [Integer] Limit number of ticks returned. Maximum value: <code>25000</code>
|