finnhub_ruby 1.1.7 → 1.1.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +56 -15
- data/docs/CompanyESG.md +28 -0
- data/docs/CompanyEarningsQualityScore.md +22 -0
- data/docs/CompanyEarningsQualityScoreData.md +30 -0
- data/docs/CompanyProfile.md +4 -4
- data/docs/CountryMetadata.md +5 -1
- data/docs/CryptoProfile.md +38 -0
- data/docs/DefaultApi.md +386 -9
- data/docs/EbitEstimates.md +22 -0
- data/docs/EbitEstimatesInfo.md +26 -0
- data/docs/EbitdaEstimates.md +22 -0
- data/docs/EbitdaEstimatesInfo.md +26 -0
- data/docs/KeyCustomersSuppliers.md +13 -1
- data/docs/MutualFundProfileData.md +9 -1
- data/docs/Transactions.md +2 -0
- data/finnhub_ruby-1.1.10.gem +0 -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 +346 -7
- 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 +5 -5
- 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 +1 -1
- data/lib/finnhub_ruby/models/earning_result.rb +1 -1
- data/lib/finnhub_ruby/models/earnings_calendar.rb +1 -1
- data/lib/finnhub_ruby/models/earnings_call_transcripts.rb +1 -1
- data/lib/finnhub_ruby/models/earnings_call_transcripts_list.rb +1 -1
- data/lib/finnhub_ruby/models/earnings_estimates.rb +1 -1
- data/lib/finnhub_ruby/models/earnings_estimates_info.rb +1 -1
- data/lib/finnhub_ruby/models/ebit_estimates.rb +241 -0
- data/lib/finnhub_ruby/models/ebit_estimates_info.rb +259 -0
- data/lib/finnhub_ruby/models/ebitda_estimates.rb +241 -0
- data/lib/finnhub_ruby/models/ebitda_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 +1 -1
- data/lib/finnhub_ruby/models/key_customers_suppliers.rb +65 -5
- data/lib/finnhub_ruby/models/last_bid_ask.rb +1 -1
- data/lib/finnhub_ruby/models/market_news.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_country_exposure.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_country_exposure_data.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_holdings.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_holdings_data.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_profile.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_profile_data.rb +45 -5
- data/lib/finnhub_ruby/models/mutual_fund_sector_exposure.rb +1 -1
- data/lib/finnhub_ruby/models/mutual_fund_sector_exposure_data.rb +1 -1
- data/lib/finnhub_ruby/models/news_sentiment.rb +1 -1
- data/lib/finnhub_ruby/models/ownership.rb +1 -1
- data/lib/finnhub_ruby/models/ownership_info.rb +1 -1
- data/lib/finnhub_ruby/models/pattern_recognition.rb +1 -1
- data/lib/finnhub_ruby/models/press_release.rb +1 -1
- data/lib/finnhub_ruby/models/price_target.rb +1 -1
- data/lib/finnhub_ruby/models/quote.rb +1 -1
- data/lib/finnhub_ruby/models/recommendation_trend.rb +1 -1
- data/lib/finnhub_ruby/models/reddit_sentiment_content.rb +1 -1
- data/lib/finnhub_ruby/models/report.rb +1 -1
- data/lib/finnhub_ruby/models/revenue_breakdown.rb +1 -1
- data/lib/finnhub_ruby/models/revenue_estimates.rb +1 -1
- data/lib/finnhub_ruby/models/revenue_estimates_info.rb +1 -1
- data/lib/finnhub_ruby/models/sec_sentiment_analysis.rb +1 -1
- data/lib/finnhub_ruby/models/sentiment.rb +1 -1
- data/lib/finnhub_ruby/models/similarity_index.rb +1 -1
- data/lib/finnhub_ruby/models/similarity_index_info.rb +1 -1
- data/lib/finnhub_ruby/models/social_sentiment.rb +1 -1
- data/lib/finnhub_ruby/models/split.rb +1 -1
- data/lib/finnhub_ruby/models/stock_candles.rb +1 -1
- data/lib/finnhub_ruby/models/stock_symbol.rb +1 -1
- data/lib/finnhub_ruby/models/stock_transcripts.rb +1 -1
- data/lib/finnhub_ruby/models/supply_chain_relationships.rb +1 -1
- data/lib/finnhub_ruby/models/support_resistance.rb +1 -1
- data/lib/finnhub_ruby/models/symbol_lookup.rb +1 -1
- data/lib/finnhub_ruby/models/symbol_lookup_info.rb +1 -1
- data/lib/finnhub_ruby/models/technical_analysis.rb +1 -1
- data/lib/finnhub_ruby/models/tick_data.rb +1 -1
- data/lib/finnhub_ruby/models/transactions.rb +12 -2
- 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 +9 -1
- 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/ebit_estimates_info_spec.rb +58 -0
- data/spec/models/ebit_estimates_spec.rb +46 -0
- data/spec/models/ebitda_estimates_info_spec.rb +58 -0
- data/spec/models/ebitda_estimates_spec.rb +46 -0
- data/spec/spec_helper.rb +1 -1
- metadata +38 -2
|
@@ -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,211 @@ 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
|
+
|
|
302
|
+
# EBIT Estimates
|
|
303
|
+
# Get company's ebit estimates.
|
|
304
|
+
# @param symbol [String] Symbol of the company: AAPL.
|
|
305
|
+
# @param [Hash] opts the optional parameters
|
|
306
|
+
# @option opts [String] :freq Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
|
|
307
|
+
# @return [EbitEstimates]
|
|
308
|
+
def company_ebit_estimates(symbol, opts = {})
|
|
309
|
+
data, _status_code, _headers = company_ebit_estimates_with_http_info(symbol, opts)
|
|
310
|
+
data
|
|
311
|
+
end
|
|
312
|
+
|
|
313
|
+
# EBIT Estimates
|
|
314
|
+
# Get company's ebit estimates.
|
|
315
|
+
# @param symbol [String] Symbol of the company: AAPL.
|
|
316
|
+
# @param [Hash] opts the optional parameters
|
|
317
|
+
# @option opts [String] :freq Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
|
|
318
|
+
# @return [Array<(EbitEstimates, Integer, Hash)>] EbitEstimates data, response status code and response headers
|
|
319
|
+
def company_ebit_estimates_with_http_info(symbol, opts = {})
|
|
320
|
+
if @api_client.config.debugging
|
|
321
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.company_ebit_estimates ...'
|
|
322
|
+
end
|
|
323
|
+
# verify the required parameter 'symbol' is set
|
|
324
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
|
325
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.company_ebit_estimates"
|
|
326
|
+
end
|
|
327
|
+
# resource path
|
|
328
|
+
local_var_path = '/stock/ebit-estimate'
|
|
329
|
+
|
|
330
|
+
# query parameters
|
|
331
|
+
query_params = opts[:query_params] || {}
|
|
332
|
+
query_params[:'symbol'] = symbol
|
|
333
|
+
query_params[:'freq'] = opts[:'freq'] if !opts[:'freq'].nil?
|
|
334
|
+
|
|
335
|
+
# header parameters
|
|
336
|
+
header_params = opts[:header_params] || {}
|
|
337
|
+
# HTTP header 'Accept' (if needed)
|
|
338
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
339
|
+
|
|
340
|
+
# form parameters
|
|
341
|
+
form_params = opts[:form_params] || {}
|
|
342
|
+
|
|
343
|
+
# http body (model)
|
|
344
|
+
post_body = opts[:debug_body]
|
|
345
|
+
|
|
346
|
+
# return_type
|
|
347
|
+
return_type = opts[:debug_return_type] || 'EbitEstimates'
|
|
348
|
+
|
|
349
|
+
# auth_names
|
|
350
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
351
|
+
|
|
352
|
+
new_options = opts.merge(
|
|
353
|
+
:operation => :"DefaultApi.company_ebit_estimates",
|
|
354
|
+
:header_params => header_params,
|
|
355
|
+
:query_params => query_params,
|
|
356
|
+
:form_params => form_params,
|
|
357
|
+
:body => post_body,
|
|
358
|
+
:auth_names => auth_names,
|
|
359
|
+
:return_type => return_type
|
|
360
|
+
)
|
|
361
|
+
|
|
362
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
363
|
+
if @api_client.config.debugging
|
|
364
|
+
@api_client.config.logger.debug "API called: DefaultApi#company_ebit_estimates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
365
|
+
end
|
|
366
|
+
return data, status_code, headers
|
|
367
|
+
end
|
|
368
|
+
|
|
369
|
+
# EBITDA Estimates
|
|
370
|
+
# Get company's ebitda estimates.
|
|
371
|
+
# @param symbol [String] Symbol of the company: AAPL.
|
|
372
|
+
# @param [Hash] opts the optional parameters
|
|
373
|
+
# @option opts [String] :freq Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
|
|
374
|
+
# @return [EbitdaEstimates]
|
|
375
|
+
def company_ebitda_estimates(symbol, opts = {})
|
|
376
|
+
data, _status_code, _headers = company_ebitda_estimates_with_http_info(symbol, opts)
|
|
377
|
+
data
|
|
378
|
+
end
|
|
379
|
+
|
|
380
|
+
# EBITDA Estimates
|
|
381
|
+
# Get company's ebitda estimates.
|
|
382
|
+
# @param symbol [String] Symbol of the company: AAPL.
|
|
383
|
+
# @param [Hash] opts the optional parameters
|
|
384
|
+
# @option opts [String] :freq Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
|
|
385
|
+
# @return [Array<(EbitdaEstimates, Integer, Hash)>] EbitdaEstimates data, response status code and response headers
|
|
386
|
+
def company_ebitda_estimates_with_http_info(symbol, opts = {})
|
|
387
|
+
if @api_client.config.debugging
|
|
388
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.company_ebitda_estimates ...'
|
|
389
|
+
end
|
|
390
|
+
# verify the required parameter 'symbol' is set
|
|
391
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
|
392
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.company_ebitda_estimates"
|
|
393
|
+
end
|
|
394
|
+
# resource path
|
|
395
|
+
local_var_path = '/stock/ebitda-estimate'
|
|
396
|
+
|
|
397
|
+
# query parameters
|
|
398
|
+
query_params = opts[:query_params] || {}
|
|
399
|
+
query_params[:'symbol'] = symbol
|
|
400
|
+
query_params[:'freq'] = opts[:'freq'] if !opts[:'freq'].nil?
|
|
401
|
+
|
|
402
|
+
# header parameters
|
|
403
|
+
header_params = opts[:header_params] || {}
|
|
404
|
+
# HTTP header 'Accept' (if needed)
|
|
405
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
406
|
+
|
|
407
|
+
# form parameters
|
|
408
|
+
form_params = opts[:form_params] || {}
|
|
409
|
+
|
|
410
|
+
# http body (model)
|
|
411
|
+
post_body = opts[:debug_body]
|
|
412
|
+
|
|
413
|
+
# return_type
|
|
414
|
+
return_type = opts[:debug_return_type] || 'EbitdaEstimates'
|
|
415
|
+
|
|
416
|
+
# auth_names
|
|
417
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
418
|
+
|
|
419
|
+
new_options = opts.merge(
|
|
420
|
+
:operation => :"DefaultApi.company_ebitda_estimates",
|
|
421
|
+
:header_params => header_params,
|
|
422
|
+
:query_params => query_params,
|
|
423
|
+
:form_params => form_params,
|
|
424
|
+
:body => post_body,
|
|
425
|
+
:auth_names => auth_names,
|
|
426
|
+
:return_type => return_type
|
|
427
|
+
)
|
|
428
|
+
|
|
429
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
430
|
+
if @api_client.config.debugging
|
|
431
|
+
@api_client.config.logger.debug "API called: DefaultApi#company_ebitda_estimates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
432
|
+
end
|
|
433
|
+
return data, status_code, headers
|
|
434
|
+
end
|
|
435
|
+
|
|
231
436
|
# Earnings Estimates
|
|
232
437
|
# Get company's EPS estimates.
|
|
233
438
|
# @param symbol [String] Symbol of the company: AAPL.
|
|
@@ -295,6 +500,70 @@ module FinnhubRuby
|
|
|
295
500
|
return data, status_code, headers
|
|
296
501
|
end
|
|
297
502
|
|
|
503
|
+
# Company ESG Scores
|
|
504
|
+
# <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>
|
|
505
|
+
# @param symbol [String] Symbol.
|
|
506
|
+
# @param [Hash] opts the optional parameters
|
|
507
|
+
# @return [CompanyESG]
|
|
508
|
+
def company_esg_score(symbol, opts = {})
|
|
509
|
+
data, _status_code, _headers = company_esg_score_with_http_info(symbol, opts)
|
|
510
|
+
data
|
|
511
|
+
end
|
|
512
|
+
|
|
513
|
+
# Company ESG Scores
|
|
514
|
+
# <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>
|
|
515
|
+
# @param symbol [String] Symbol.
|
|
516
|
+
# @param [Hash] opts the optional parameters
|
|
517
|
+
# @return [Array<(CompanyESG, Integer, Hash)>] CompanyESG data, response status code and response headers
|
|
518
|
+
def company_esg_score_with_http_info(symbol, opts = {})
|
|
519
|
+
if @api_client.config.debugging
|
|
520
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.company_esg_score ...'
|
|
521
|
+
end
|
|
522
|
+
# verify the required parameter 'symbol' is set
|
|
523
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
|
524
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.company_esg_score"
|
|
525
|
+
end
|
|
526
|
+
# resource path
|
|
527
|
+
local_var_path = '/stock/esg'
|
|
528
|
+
|
|
529
|
+
# query parameters
|
|
530
|
+
query_params = opts[:query_params] || {}
|
|
531
|
+
query_params[:'symbol'] = symbol
|
|
532
|
+
|
|
533
|
+
# header parameters
|
|
534
|
+
header_params = opts[:header_params] || {}
|
|
535
|
+
# HTTP header 'Accept' (if needed)
|
|
536
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
537
|
+
|
|
538
|
+
# form parameters
|
|
539
|
+
form_params = opts[:form_params] || {}
|
|
540
|
+
|
|
541
|
+
# http body (model)
|
|
542
|
+
post_body = opts[:debug_body]
|
|
543
|
+
|
|
544
|
+
# return_type
|
|
545
|
+
return_type = opts[:debug_return_type] || 'CompanyESG'
|
|
546
|
+
|
|
547
|
+
# auth_names
|
|
548
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
549
|
+
|
|
550
|
+
new_options = opts.merge(
|
|
551
|
+
:operation => :"DefaultApi.company_esg_score",
|
|
552
|
+
:header_params => header_params,
|
|
553
|
+
:query_params => query_params,
|
|
554
|
+
:form_params => form_params,
|
|
555
|
+
:body => post_body,
|
|
556
|
+
:auth_names => auth_names,
|
|
557
|
+
:return_type => return_type
|
|
558
|
+
)
|
|
559
|
+
|
|
560
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
561
|
+
if @api_client.config.debugging
|
|
562
|
+
@api_client.config.logger.debug "API called: DefaultApi#company_esg_score\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
563
|
+
end
|
|
564
|
+
return data, status_code, headers
|
|
565
|
+
end
|
|
566
|
+
|
|
298
567
|
# Company Executive
|
|
299
568
|
# Get a list of company's executives and members of the Board.
|
|
300
569
|
# @param symbol [String] Symbol of the company: AAPL.
|
|
@@ -438,7 +707,7 @@ module FinnhubRuby
|
|
|
438
707
|
end
|
|
439
708
|
|
|
440
709
|
# Peers
|
|
441
|
-
# Get company peers. Return a list of peers in the same country and
|
|
710
|
+
# Get company peers. Return a list of peers in the same country and sub-industry
|
|
442
711
|
# @param symbol [String] Symbol of the company: AAPL.
|
|
443
712
|
# @param [Hash] opts the optional parameters
|
|
444
713
|
# @return [Array<String>]
|
|
@@ -448,7 +717,7 @@ module FinnhubRuby
|
|
|
448
717
|
end
|
|
449
718
|
|
|
450
719
|
# Peers
|
|
451
|
-
# Get company peers. Return a list of peers in the same country and
|
|
720
|
+
# Get company peers. Return a list of peers in the same country and sub-industry
|
|
452
721
|
# @param symbol [String] Symbol of the company: AAPL.
|
|
453
722
|
# @param [Hash] opts the optional parameters
|
|
454
723
|
# @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
|
|
@@ -956,6 +1225,70 @@ module FinnhubRuby
|
|
|
956
1225
|
return data, status_code, headers
|
|
957
1226
|
end
|
|
958
1227
|
|
|
1228
|
+
# Crypto Profile
|
|
1229
|
+
# Get crypto's profile.
|
|
1230
|
+
# @param symbol [String] Crypto symbol such as BTC or ETH.
|
|
1231
|
+
# @param [Hash] opts the optional parameters
|
|
1232
|
+
# @return [CryptoProfile]
|
|
1233
|
+
def crypto_profile(symbol, opts = {})
|
|
1234
|
+
data, _status_code, _headers = crypto_profile_with_http_info(symbol, opts)
|
|
1235
|
+
data
|
|
1236
|
+
end
|
|
1237
|
+
|
|
1238
|
+
# Crypto Profile
|
|
1239
|
+
# Get crypto's profile.
|
|
1240
|
+
# @param symbol [String] Crypto symbol such as BTC or ETH.
|
|
1241
|
+
# @param [Hash] opts the optional parameters
|
|
1242
|
+
# @return [Array<(CryptoProfile, Integer, Hash)>] CryptoProfile data, response status code and response headers
|
|
1243
|
+
def crypto_profile_with_http_info(symbol, opts = {})
|
|
1244
|
+
if @api_client.config.debugging
|
|
1245
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.crypto_profile ...'
|
|
1246
|
+
end
|
|
1247
|
+
# verify the required parameter 'symbol' is set
|
|
1248
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
|
1249
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.crypto_profile"
|
|
1250
|
+
end
|
|
1251
|
+
# resource path
|
|
1252
|
+
local_var_path = '/crypto/profile'
|
|
1253
|
+
|
|
1254
|
+
# query parameters
|
|
1255
|
+
query_params = opts[:query_params] || {}
|
|
1256
|
+
query_params[:'symbol'] = symbol
|
|
1257
|
+
|
|
1258
|
+
# header parameters
|
|
1259
|
+
header_params = opts[:header_params] || {}
|
|
1260
|
+
# HTTP header 'Accept' (if needed)
|
|
1261
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1262
|
+
|
|
1263
|
+
# form parameters
|
|
1264
|
+
form_params = opts[:form_params] || {}
|
|
1265
|
+
|
|
1266
|
+
# http body (model)
|
|
1267
|
+
post_body = opts[:debug_body]
|
|
1268
|
+
|
|
1269
|
+
# return_type
|
|
1270
|
+
return_type = opts[:debug_return_type] || 'CryptoProfile'
|
|
1271
|
+
|
|
1272
|
+
# auth_names
|
|
1273
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
|
1274
|
+
|
|
1275
|
+
new_options = opts.merge(
|
|
1276
|
+
:operation => :"DefaultApi.crypto_profile",
|
|
1277
|
+
:header_params => header_params,
|
|
1278
|
+
:query_params => query_params,
|
|
1279
|
+
:form_params => form_params,
|
|
1280
|
+
:body => post_body,
|
|
1281
|
+
:auth_names => auth_names,
|
|
1282
|
+
:return_type => return_type
|
|
1283
|
+
)
|
|
1284
|
+
|
|
1285
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1286
|
+
if @api_client.config.debugging
|
|
1287
|
+
@api_client.config.logger.debug "API called: DefaultApi#crypto_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1288
|
+
end
|
|
1289
|
+
return data, status_code, headers
|
|
1290
|
+
end
|
|
1291
|
+
|
|
959
1292
|
# Crypto Symbol
|
|
960
1293
|
# List supported crypto symbols by exchange
|
|
961
1294
|
# @param exchange [String] Exchange you want to get the list of symbols from.
|
|
@@ -1092,6 +1425,8 @@ module FinnhubRuby
|
|
|
1092
1425
|
# Economic Calendar
|
|
1093
1426
|
# <p>Get recent and upcoming economic releases.</p><p>Historical events and surprises are available for Enterprise clients.</p>
|
|
1094
1427
|
# @param [Hash] opts the optional parameters
|
|
1428
|
+
# @option opts [Date] :from From date <code>YYYY-MM-DD</code>.
|
|
1429
|
+
# @option opts [Date] :to To date <code>YYYY-MM-DD</code>.
|
|
1095
1430
|
# @return [EconomicCalendar]
|
|
1096
1431
|
def economic_calendar(opts = {})
|
|
1097
1432
|
data, _status_code, _headers = economic_calendar_with_http_info(opts)
|
|
@@ -1101,6 +1436,8 @@ module FinnhubRuby
|
|
|
1101
1436
|
# Economic Calendar
|
|
1102
1437
|
# <p>Get recent and upcoming economic releases.</p><p>Historical events and surprises are available for Enterprise clients.</p>
|
|
1103
1438
|
# @param [Hash] opts the optional parameters
|
|
1439
|
+
# @option opts [Date] :from From date <code>YYYY-MM-DD</code>.
|
|
1440
|
+
# @option opts [Date] :to To date <code>YYYY-MM-DD</code>.
|
|
1104
1441
|
# @return [Array<(EconomicCalendar, Integer, Hash)>] EconomicCalendar data, response status code and response headers
|
|
1105
1442
|
def economic_calendar_with_http_info(opts = {})
|
|
1106
1443
|
if @api_client.config.debugging
|
|
@@ -1111,6 +1448,8 @@ module FinnhubRuby
|
|
|
1111
1448
|
|
|
1112
1449
|
# query parameters
|
|
1113
1450
|
query_params = opts[:query_params] || {}
|
|
1451
|
+
query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
|
|
1452
|
+
query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
|
|
1114
1453
|
|
|
1115
1454
|
# header parameters
|
|
1116
1455
|
header_params = opts[:header_params] || {}
|
|
@@ -2330,7 +2669,7 @@ module FinnhubRuby
|
|
|
2330
2669
|
|
|
2331
2670
|
# Insider Transactions
|
|
2332
2671
|
# 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.
|
|
2672
|
+
# @param symbol [String] Symbol of the company: AAPL. Leave this param blank to get the latest transactions.
|
|
2334
2673
|
# @param [Hash] opts the optional parameters
|
|
2335
2674
|
# @option opts [Date] :from From date: 2020-03-15.
|
|
2336
2675
|
# @option opts [Date] :to To date: 2020-03-16.
|
|
@@ -2342,7 +2681,7 @@ module FinnhubRuby
|
|
|
2342
2681
|
|
|
2343
2682
|
# Insider Transactions
|
|
2344
2683
|
# 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.
|
|
2684
|
+
# @param symbol [String] Symbol of the company: AAPL. Leave this param blank to get the latest transactions.
|
|
2346
2685
|
# @param [Hash] opts the optional parameters
|
|
2347
2686
|
# @option opts [Date] :from From date: 2020-03-15.
|
|
2348
2687
|
# @option opts [Date] :to To date: 2020-03-16.
|
|
@@ -4111,7 +4450,7 @@ module FinnhubRuby
|
|
|
4111
4450
|
end
|
|
4112
4451
|
|
|
4113
4452
|
# Tick Data
|
|
4114
|
-
# <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><
|
|
4453
|
+
# <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>
|
|
4115
4454
|
# @param symbol [String] Symbol.
|
|
4116
4455
|
# @param date [Date] Date: 2020-04-02.
|
|
4117
4456
|
# @param limit [Integer] Limit number of ticks returned. Maximum value: <code>25000</code>
|
|
@@ -4124,7 +4463,7 @@ module FinnhubRuby
|
|
|
4124
4463
|
end
|
|
4125
4464
|
|
|
4126
4465
|
# Tick Data
|
|
4127
|
-
# <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><
|
|
4466
|
+
# <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>
|
|
4128
4467
|
# @param symbol [String] Symbol.
|
|
4129
4468
|
# @param date [Date] Date: 2020-04-02.
|
|
4130
4469
|
# @param limit [Integer] Limit number of ticks returned. Maximum value: <code>25000</code>
|