finnhub_ruby 1.1.8 → 1.1.12
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 +18 -4
- data/docs/CompanyESG.md +3 -3
- 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 +391 -10
- 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/MutualFundProfileData.md +9 -1
- data/docs/StockSymbol.md +7 -1
- data/docs/Transactions.md +2 -0
- data/docs/UsptoPatent.md +34 -0
- data/docs/UsptoPatentResult.md +20 -0
- data/finnhub_ruby-1.1.10.gem +0 -0
- data/finnhub_ruby-1.1.11.gem +0 -0
- data/finnhub_ruby-1.1.8.gem +0 -0
- data/finnhub_ruby-1.1.9.gem +0 -0
- data/lib/finnhub_ruby/api/default_api.rb +361 -8
- 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 +3 -3
- data/lib/finnhub_ruby/models/company_profile.rb +4 -4
- data/lib/finnhub_ruby/models/country_metadata.rb +24 -4
- data/lib/finnhub_ruby/models/crypto_profile.rb +319 -0
- 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/mutual_fund_profile_data.rb +44 -4
- data/lib/finnhub_ruby/models/stock_symbol.rb +34 -4
- data/lib/finnhub_ruby/models/transactions.rb +11 -1
- data/lib/finnhub_ruby/models/uspto_patent.rb +301 -0
- data/lib/finnhub_ruby/models/uspto_patent_result.rb +231 -0
- data/lib/finnhub_ruby/version.rb +1 -1
- data/lib/finnhub_ruby.rb +9 -0
- 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/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/models/uspto_patent_result_spec.rb +40 -0
- data/spec/models/uspto_patent_spec.rb +82 -0
- metadata +42 -2
data/docs/UsptoPatent.md
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# FinnhubRuby::UsptoPatent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **application_number** | **String** | Application Number. | [optional] |
|
8
|
+
| **company_filing_name** | **Array<String>** | Array of companies' name on the patent. | [optional] |
|
9
|
+
| **filing_date** | **String** | Filing date. | [optional] |
|
10
|
+
| **description** | **String** | Description. | [optional] |
|
11
|
+
| **filing_status** | **String** | Filing status. | [optional] |
|
12
|
+
| **patent_number** | **String** | Patent number. | [optional] |
|
13
|
+
| **publication_date** | **String** | Filing date. | [optional] |
|
14
|
+
| **patent_type** | **String** | Patent's type. | [optional] |
|
15
|
+
| **url** | **String** | URL of the original article. | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'finnhub_ruby'
|
21
|
+
|
22
|
+
instance = FinnhubRuby::UsptoPatent.new(
|
23
|
+
application_number: null,
|
24
|
+
company_filing_name: null,
|
25
|
+
filing_date: null,
|
26
|
+
description: null,
|
27
|
+
filing_status: null,
|
28
|
+
patent_number: null,
|
29
|
+
publication_date: null,
|
30
|
+
patent_type: null,
|
31
|
+
url: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::UsptoPatentResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
8
|
+
| **data** | [**Array<UsptoPatent>**](UsptoPatent.md) | Array of patents. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::UsptoPatentResult.new(
|
16
|
+
symbol: null,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
Binary file
|
Binary file
|
Binary file
|
Binary file
|
@@ -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.
|
@@ -502,7 +707,7 @@ module FinnhubRuby
|
|
502
707
|
end
|
503
708
|
|
504
709
|
# Peers
|
505
|
-
# 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
|
506
711
|
# @param symbol [String] Symbol of the company: AAPL.
|
507
712
|
# @param [Hash] opts the optional parameters
|
508
713
|
# @return [Array<String>]
|
@@ -512,7 +717,7 @@ module FinnhubRuby
|
|
512
717
|
end
|
513
718
|
|
514
719
|
# Peers
|
515
|
-
# 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
|
516
721
|
# @param symbol [String] Symbol of the company: AAPL.
|
517
722
|
# @param [Hash] opts the optional parameters
|
518
723
|
# @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
|
@@ -1020,6 +1225,70 @@ module FinnhubRuby
|
|
1020
1225
|
return data, status_code, headers
|
1021
1226
|
end
|
1022
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
|
+
|
1023
1292
|
# Crypto Symbol
|
1024
1293
|
# List supported crypto symbols by exchange
|
1025
1294
|
# @param exchange [String] Exchange you want to get the list of symbols from.
|
@@ -1156,6 +1425,8 @@ module FinnhubRuby
|
|
1156
1425
|
# Economic Calendar
|
1157
1426
|
# <p>Get recent and upcoming economic releases.</p><p>Historical events and surprises are available for Enterprise clients.</p>
|
1158
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>.
|
1159
1430
|
# @return [EconomicCalendar]
|
1160
1431
|
def economic_calendar(opts = {})
|
1161
1432
|
data, _status_code, _headers = economic_calendar_with_http_info(opts)
|
@@ -1165,6 +1436,8 @@ module FinnhubRuby
|
|
1165
1436
|
# Economic Calendar
|
1166
1437
|
# <p>Get recent and upcoming economic releases.</p><p>Historical events and surprises are available for Enterprise clients.</p>
|
1167
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>.
|
1168
1441
|
# @return [Array<(EconomicCalendar, Integer, Hash)>] EconomicCalendar data, response status code and response headers
|
1169
1442
|
def economic_calendar_with_http_info(opts = {})
|
1170
1443
|
if @api_client.config.debugging
|
@@ -1175,6 +1448,8 @@ module FinnhubRuby
|
|
1175
1448
|
|
1176
1449
|
# query parameters
|
1177
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?
|
1178
1453
|
|
1179
1454
|
# header parameters
|
1180
1455
|
header_params = opts[:header_params] || {}
|
@@ -2394,7 +2669,7 @@ module FinnhubRuby
|
|
2394
2669
|
|
2395
2670
|
# Insider Transactions
|
2396
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.
|
2397
|
-
# @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.
|
2398
2673
|
# @param [Hash] opts the optional parameters
|
2399
2674
|
# @option opts [Date] :from From date: 2020-03-15.
|
2400
2675
|
# @option opts [Date] :to To date: 2020-03-16.
|
@@ -2406,7 +2681,7 @@ module FinnhubRuby
|
|
2406
2681
|
|
2407
2682
|
# Insider Transactions
|
2408
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.
|
2409
|
-
# @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.
|
2410
2685
|
# @param [Hash] opts the optional parameters
|
2411
2686
|
# @option opts [Date] :from From date: 2020-03-15.
|
2412
2687
|
# @option opts [Date] :to To date: 2020-03-16.
|
@@ -2463,7 +2738,7 @@ module FinnhubRuby
|
|
2463
2738
|
end
|
2464
2739
|
|
2465
2740
|
# International Filings
|
2466
|
-
# List filings for international companies
|
2741
|
+
# List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
|
2467
2742
|
# @param [Hash] opts the optional parameters
|
2468
2743
|
# @option opts [String] :symbol Symbol. Leave empty to list latest filings.
|
2469
2744
|
# @option opts [String] :country Filter by country using country's 2-letter code.
|
@@ -2474,7 +2749,7 @@ module FinnhubRuby
|
|
2474
2749
|
end
|
2475
2750
|
|
2476
2751
|
# International Filings
|
2477
|
-
# List filings for international companies
|
2752
|
+
# List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
|
2478
2753
|
# @param [Hash] opts the optional parameters
|
2479
2754
|
# @option opts [String] :symbol Symbol. Leave empty to list latest filings.
|
2480
2755
|
# @option opts [String] :country Filter by country using country's 2-letter code.
|
@@ -4175,7 +4450,7 @@ module FinnhubRuby
|
|
4175
4450
|
end
|
4176
4451
|
|
4177
4452
|
# Tick Data
|
4178
|
-
# <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>
|
4179
4454
|
# @param symbol [String] Symbol.
|
4180
4455
|
# @param date [Date] Date: 2020-04-02.
|
4181
4456
|
# @param limit [Integer] Limit number of ticks returned. Maximum value: <code>25000</code>
|
@@ -4188,7 +4463,7 @@ module FinnhubRuby
|
|
4188
4463
|
end
|
4189
4464
|
|
4190
4465
|
# Tick Data
|
4191
|
-
# <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>
|
4192
4467
|
# @param symbol [String] Symbol.
|
4193
4468
|
# @param date [Date] Date: 2020-04-02.
|
4194
4469
|
# @param limit [Integer] Limit number of ticks returned. Maximum value: <code>25000</code>
|
@@ -4259,6 +4534,84 @@ module FinnhubRuby
|
|
4259
4534
|
return data, status_code, headers
|
4260
4535
|
end
|
4261
4536
|
|
4537
|
+
# USPTO Patents
|
4538
|
+
# List USPTO patents for companies. Limit to 250 records per API call.
|
4539
|
+
# @param symbol [String] Symbol.
|
4540
|
+
# @param from [Date] From date <code>YYYY-MM-DD</code>.
|
4541
|
+
# @param to [Date] To date <code>YYYY-MM-DD</code>.
|
4542
|
+
# @param [Hash] opts the optional parameters
|
4543
|
+
# @return [UsptoPatentResult]
|
4544
|
+
def stock_uspto_patent(symbol, from, to, opts = {})
|
4545
|
+
data, _status_code, _headers = stock_uspto_patent_with_http_info(symbol, from, to, opts)
|
4546
|
+
data
|
4547
|
+
end
|
4548
|
+
|
4549
|
+
# USPTO Patents
|
4550
|
+
# List USPTO patents for companies. Limit to 250 records per API call.
|
4551
|
+
# @param symbol [String] Symbol.
|
4552
|
+
# @param from [Date] From date <code>YYYY-MM-DD</code>.
|
4553
|
+
# @param to [Date] To date <code>YYYY-MM-DD</code>.
|
4554
|
+
# @param [Hash] opts the optional parameters
|
4555
|
+
# @return [Array<(UsptoPatentResult, Integer, Hash)>] UsptoPatentResult data, response status code and response headers
|
4556
|
+
def stock_uspto_patent_with_http_info(symbol, from, to, opts = {})
|
4557
|
+
if @api_client.config.debugging
|
4558
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.stock_uspto_patent ...'
|
4559
|
+
end
|
4560
|
+
# verify the required parameter 'symbol' is set
|
4561
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
4562
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.stock_uspto_patent"
|
4563
|
+
end
|
4564
|
+
# verify the required parameter 'from' is set
|
4565
|
+
if @api_client.config.client_side_validation && from.nil?
|
4566
|
+
fail ArgumentError, "Missing the required parameter 'from' when calling DefaultApi.stock_uspto_patent"
|
4567
|
+
end
|
4568
|
+
# verify the required parameter 'to' is set
|
4569
|
+
if @api_client.config.client_side_validation && to.nil?
|
4570
|
+
fail ArgumentError, "Missing the required parameter 'to' when calling DefaultApi.stock_uspto_patent"
|
4571
|
+
end
|
4572
|
+
# resource path
|
4573
|
+
local_var_path = '/stock/uspto-patent'
|
4574
|
+
|
4575
|
+
# query parameters
|
4576
|
+
query_params = opts[:query_params] || {}
|
4577
|
+
query_params[:'symbol'] = symbol
|
4578
|
+
query_params[:'from'] = from
|
4579
|
+
query_params[:'to'] = to
|
4580
|
+
|
4581
|
+
# header parameters
|
4582
|
+
header_params = opts[:header_params] || {}
|
4583
|
+
# HTTP header 'Accept' (if needed)
|
4584
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4585
|
+
|
4586
|
+
# form parameters
|
4587
|
+
form_params = opts[:form_params] || {}
|
4588
|
+
|
4589
|
+
# http body (model)
|
4590
|
+
post_body = opts[:debug_body]
|
4591
|
+
|
4592
|
+
# return_type
|
4593
|
+
return_type = opts[:debug_return_type] || 'UsptoPatentResult'
|
4594
|
+
|
4595
|
+
# auth_names
|
4596
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
4597
|
+
|
4598
|
+
new_options = opts.merge(
|
4599
|
+
:operation => :"DefaultApi.stock_uspto_patent",
|
4600
|
+
:header_params => header_params,
|
4601
|
+
:query_params => query_params,
|
4602
|
+
:form_params => form_params,
|
4603
|
+
:body => post_body,
|
4604
|
+
:auth_names => auth_names,
|
4605
|
+
:return_type => return_type
|
4606
|
+
)
|
4607
|
+
|
4608
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
4609
|
+
if @api_client.config.debugging
|
4610
|
+
@api_client.config.logger.debug "API called: DefaultApi#stock_uspto_patent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4611
|
+
end
|
4612
|
+
return data, status_code, headers
|
4613
|
+
end
|
4614
|
+
|
4262
4615
|
# Supply Chain Relationships
|
4263
4616
|
# <p>This endpoint provides an overall map of public companies' key customers and suppliers. The data offers a deeper look into a company's supply chain and how products are created. The data will help investors manage risk, limit exposure or generate alpha-generating ideas and trading insights.</p><p>We currently cover data for S&P500 and Nasdaq 100 companies.</p>
|
4264
4617
|
# @param symbol [String] Symbol.
|