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/DefaultApi.md
CHANGED
@@ -7,6 +7,9 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
7
7
|
| [**aggregate_indicator**](DefaultApi.md#aggregate_indicator) | **GET** /scan/technical-indicator | Aggregate Indicators |
|
8
8
|
| [**company_basic_financials**](DefaultApi.md#company_basic_financials) | **GET** /stock/metric | Basic Financials |
|
9
9
|
| [**company_earnings**](DefaultApi.md#company_earnings) | **GET** /stock/earnings | Earnings Surprises |
|
10
|
+
| [**company_earnings_quality_score**](DefaultApi.md#company_earnings_quality_score) | **GET** /stock/earnings-quality-score | Company Earnings Quality Score |
|
11
|
+
| [**company_ebit_estimates**](DefaultApi.md#company_ebit_estimates) | **GET** /stock/ebit-estimate | EBIT Estimates |
|
12
|
+
| [**company_ebitda_estimates**](DefaultApi.md#company_ebitda_estimates) | **GET** /stock/ebitda-estimate | EBITDA Estimates |
|
10
13
|
| [**company_eps_estimates**](DefaultApi.md#company_eps_estimates) | **GET** /stock/eps-estimate | Earnings Estimates |
|
11
14
|
| [**company_esg_score**](DefaultApi.md#company_esg_score) | **GET** /stock/esg | Company ESG Scores |
|
12
15
|
| [**company_executive**](DefaultApi.md#company_executive) | **GET** /stock/executive | Company Executive |
|
@@ -19,6 +22,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
19
22
|
| [**covid19**](DefaultApi.md#covid19) | **GET** /covid19/us | COVID-19 |
|
20
23
|
| [**crypto_candles**](DefaultApi.md#crypto_candles) | **GET** /crypto/candle | Crypto Candles |
|
21
24
|
| [**crypto_exchanges**](DefaultApi.md#crypto_exchanges) | **GET** /crypto/exchange | Crypto Exchanges |
|
25
|
+
| [**crypto_profile**](DefaultApi.md#crypto_profile) | **GET** /crypto/profile | Crypto Profile |
|
22
26
|
| [**crypto_symbols**](DefaultApi.md#crypto_symbols) | **GET** /crypto/symbol | Crypto Symbol |
|
23
27
|
| [**earnings_calendar**](DefaultApi.md#earnings_calendar) | **GET** /calendar/earnings | Earnings Calendar |
|
24
28
|
| [**economic_calendar**](DefaultApi.md#economic_calendar) | **GET** /calendar/economic | Economic Calendar |
|
@@ -67,6 +71,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
67
71
|
| [**stock_splits**](DefaultApi.md#stock_splits) | **GET** /stock/split | Splits |
|
68
72
|
| [**stock_symbols**](DefaultApi.md#stock_symbols) | **GET** /stock/symbol | Stock Symbol |
|
69
73
|
| [**stock_tick**](DefaultApi.md#stock_tick) | **GET** /stock/tick | Tick Data |
|
74
|
+
| [**stock_uspto_patent**](DefaultApi.md#stock_uspto_patent) | **GET** /stock/uspto-patent | USPTO Patents |
|
70
75
|
| [**supply_chain_relationships**](DefaultApi.md#supply_chain_relationships) | **GET** /stock/supply-chain | Supply Chain Relationships |
|
71
76
|
| [**support_resistance**](DefaultApi.md#support_resistance) | **GET** /scan/support-resistance | Support/Resistance |
|
72
77
|
| [**symbol_search**](DefaultApi.md#symbol_search) | **GET** /search | Symbol Lookup |
|
@@ -297,6 +302,229 @@ end
|
|
297
302
|
- **Accept**: application/json
|
298
303
|
|
299
304
|
|
305
|
+
## company_earnings_quality_score
|
306
|
+
|
307
|
+
> <CompanyEarningsQualityScore> company_earnings_quality_score(symbol, freq)
|
308
|
+
|
309
|
+
Company Earnings Quality Score
|
310
|
+
|
311
|
+
<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>
|
312
|
+
|
313
|
+
### Examples
|
314
|
+
|
315
|
+
```ruby
|
316
|
+
require 'time'
|
317
|
+
require 'finnhub_ruby'
|
318
|
+
# setup authorization
|
319
|
+
FinnhubRuby.configure do |config|
|
320
|
+
# Configure API key authorization: api_key
|
321
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
322
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
323
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
324
|
+
end
|
325
|
+
|
326
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
327
|
+
symbol = 'symbol_example' # String | Symbol.
|
328
|
+
freq = 'freq_example' # String | Frequency. Currently support <code>annual</code> and <code>quarterly</code>
|
329
|
+
|
330
|
+
begin
|
331
|
+
# Company Earnings Quality Score
|
332
|
+
result = api_instance.company_earnings_quality_score(symbol, freq)
|
333
|
+
p result
|
334
|
+
rescue FinnhubRuby::ApiError => e
|
335
|
+
puts "Error when calling DefaultApi->company_earnings_quality_score: #{e}"
|
336
|
+
end
|
337
|
+
```
|
338
|
+
|
339
|
+
#### Using the company_earnings_quality_score_with_http_info variant
|
340
|
+
|
341
|
+
This returns an Array which contains the response data, status code and headers.
|
342
|
+
|
343
|
+
> <Array(<CompanyEarningsQualityScore>, Integer, Hash)> company_earnings_quality_score_with_http_info(symbol, freq)
|
344
|
+
|
345
|
+
```ruby
|
346
|
+
begin
|
347
|
+
# Company Earnings Quality Score
|
348
|
+
data, status_code, headers = api_instance.company_earnings_quality_score_with_http_info(symbol, freq)
|
349
|
+
p status_code # => 2xx
|
350
|
+
p headers # => { ... }
|
351
|
+
p data # => <CompanyEarningsQualityScore>
|
352
|
+
rescue FinnhubRuby::ApiError => e
|
353
|
+
puts "Error when calling DefaultApi->company_earnings_quality_score_with_http_info: #{e}"
|
354
|
+
end
|
355
|
+
```
|
356
|
+
|
357
|
+
### Parameters
|
358
|
+
|
359
|
+
| Name | Type | Description | Notes |
|
360
|
+
| ---- | ---- | ----------- | ----- |
|
361
|
+
| **symbol** | **String** | Symbol. | |
|
362
|
+
| **freq** | **String** | Frequency. Currently support <code>annual</code> and <code>quarterly</code> | |
|
363
|
+
|
364
|
+
### Return type
|
365
|
+
|
366
|
+
[**CompanyEarningsQualityScore**](CompanyEarningsQualityScore.md)
|
367
|
+
|
368
|
+
### Authorization
|
369
|
+
|
370
|
+
[api_key](../README.md#api_key)
|
371
|
+
|
372
|
+
### HTTP request headers
|
373
|
+
|
374
|
+
- **Content-Type**: Not defined
|
375
|
+
- **Accept**: application/json
|
376
|
+
|
377
|
+
|
378
|
+
## company_ebit_estimates
|
379
|
+
|
380
|
+
> <EbitEstimates> company_ebit_estimates(symbol, opts)
|
381
|
+
|
382
|
+
EBIT Estimates
|
383
|
+
|
384
|
+
Get company's ebit estimates.
|
385
|
+
|
386
|
+
### Examples
|
387
|
+
|
388
|
+
```ruby
|
389
|
+
require 'time'
|
390
|
+
require 'finnhub_ruby'
|
391
|
+
# setup authorization
|
392
|
+
FinnhubRuby.configure do |config|
|
393
|
+
# Configure API key authorization: api_key
|
394
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
395
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
396
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
397
|
+
end
|
398
|
+
|
399
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
400
|
+
symbol = 'symbol_example' # String | Symbol of the company: AAPL.
|
401
|
+
opts = {
|
402
|
+
freq: 'freq_example' # String | Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
|
403
|
+
}
|
404
|
+
|
405
|
+
begin
|
406
|
+
# EBIT Estimates
|
407
|
+
result = api_instance.company_ebit_estimates(symbol, opts)
|
408
|
+
p result
|
409
|
+
rescue FinnhubRuby::ApiError => e
|
410
|
+
puts "Error when calling DefaultApi->company_ebit_estimates: #{e}"
|
411
|
+
end
|
412
|
+
```
|
413
|
+
|
414
|
+
#### Using the company_ebit_estimates_with_http_info variant
|
415
|
+
|
416
|
+
This returns an Array which contains the response data, status code and headers.
|
417
|
+
|
418
|
+
> <Array(<EbitEstimates>, Integer, Hash)> company_ebit_estimates_with_http_info(symbol, opts)
|
419
|
+
|
420
|
+
```ruby
|
421
|
+
begin
|
422
|
+
# EBIT Estimates
|
423
|
+
data, status_code, headers = api_instance.company_ebit_estimates_with_http_info(symbol, opts)
|
424
|
+
p status_code # => 2xx
|
425
|
+
p headers # => { ... }
|
426
|
+
p data # => <EbitEstimates>
|
427
|
+
rescue FinnhubRuby::ApiError => e
|
428
|
+
puts "Error when calling DefaultApi->company_ebit_estimates_with_http_info: #{e}"
|
429
|
+
end
|
430
|
+
```
|
431
|
+
|
432
|
+
### Parameters
|
433
|
+
|
434
|
+
| Name | Type | Description | Notes |
|
435
|
+
| ---- | ---- | ----------- | ----- |
|
436
|
+
| **symbol** | **String** | Symbol of the company: AAPL. | |
|
437
|
+
| **freq** | **String** | Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code> | [optional] |
|
438
|
+
|
439
|
+
### Return type
|
440
|
+
|
441
|
+
[**EbitEstimates**](EbitEstimates.md)
|
442
|
+
|
443
|
+
### Authorization
|
444
|
+
|
445
|
+
[api_key](../README.md#api_key)
|
446
|
+
|
447
|
+
### HTTP request headers
|
448
|
+
|
449
|
+
- **Content-Type**: Not defined
|
450
|
+
- **Accept**: application/json
|
451
|
+
|
452
|
+
|
453
|
+
## company_ebitda_estimates
|
454
|
+
|
455
|
+
> <EbitdaEstimates> company_ebitda_estimates(symbol, opts)
|
456
|
+
|
457
|
+
EBITDA Estimates
|
458
|
+
|
459
|
+
Get company's ebitda estimates.
|
460
|
+
|
461
|
+
### Examples
|
462
|
+
|
463
|
+
```ruby
|
464
|
+
require 'time'
|
465
|
+
require 'finnhub_ruby'
|
466
|
+
# setup authorization
|
467
|
+
FinnhubRuby.configure do |config|
|
468
|
+
# Configure API key authorization: api_key
|
469
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
470
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
471
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
472
|
+
end
|
473
|
+
|
474
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
475
|
+
symbol = 'symbol_example' # String | Symbol of the company: AAPL.
|
476
|
+
opts = {
|
477
|
+
freq: 'freq_example' # String | Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
|
478
|
+
}
|
479
|
+
|
480
|
+
begin
|
481
|
+
# EBITDA Estimates
|
482
|
+
result = api_instance.company_ebitda_estimates(symbol, opts)
|
483
|
+
p result
|
484
|
+
rescue FinnhubRuby::ApiError => e
|
485
|
+
puts "Error when calling DefaultApi->company_ebitda_estimates: #{e}"
|
486
|
+
end
|
487
|
+
```
|
488
|
+
|
489
|
+
#### Using the company_ebitda_estimates_with_http_info variant
|
490
|
+
|
491
|
+
This returns an Array which contains the response data, status code and headers.
|
492
|
+
|
493
|
+
> <Array(<EbitdaEstimates>, Integer, Hash)> company_ebitda_estimates_with_http_info(symbol, opts)
|
494
|
+
|
495
|
+
```ruby
|
496
|
+
begin
|
497
|
+
# EBITDA Estimates
|
498
|
+
data, status_code, headers = api_instance.company_ebitda_estimates_with_http_info(symbol, opts)
|
499
|
+
p status_code # => 2xx
|
500
|
+
p headers # => { ... }
|
501
|
+
p data # => <EbitdaEstimates>
|
502
|
+
rescue FinnhubRuby::ApiError => e
|
503
|
+
puts "Error when calling DefaultApi->company_ebitda_estimates_with_http_info: #{e}"
|
504
|
+
end
|
505
|
+
```
|
506
|
+
|
507
|
+
### Parameters
|
508
|
+
|
509
|
+
| Name | Type | Description | Notes |
|
510
|
+
| ---- | ---- | ----------- | ----- |
|
511
|
+
| **symbol** | **String** | Symbol of the company: AAPL. | |
|
512
|
+
| **freq** | **String** | Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code> | [optional] |
|
513
|
+
|
514
|
+
### Return type
|
515
|
+
|
516
|
+
[**EbitdaEstimates**](EbitdaEstimates.md)
|
517
|
+
|
518
|
+
### Authorization
|
519
|
+
|
520
|
+
[api_key](../README.md#api_key)
|
521
|
+
|
522
|
+
### HTTP request headers
|
523
|
+
|
524
|
+
- **Content-Type**: Not defined
|
525
|
+
- **Accept**: application/json
|
526
|
+
|
527
|
+
|
300
528
|
## company_eps_estimates
|
301
529
|
|
302
530
|
> <EarningsEstimates> company_eps_estimates(symbol, opts)
|
@@ -595,7 +823,7 @@ end
|
|
595
823
|
|
596
824
|
Peers
|
597
825
|
|
598
|
-
Get company peers. Return a list of peers in the same country and
|
826
|
+
Get company peers. Return a list of peers in the same country and sub-industry
|
599
827
|
|
600
828
|
### Examples
|
601
829
|
|
@@ -1170,6 +1398,77 @@ This endpoint does not need any parameter.
|
|
1170
1398
|
- **Accept**: application/json
|
1171
1399
|
|
1172
1400
|
|
1401
|
+
## crypto_profile
|
1402
|
+
|
1403
|
+
> <CryptoProfile> crypto_profile(symbol)
|
1404
|
+
|
1405
|
+
Crypto Profile
|
1406
|
+
|
1407
|
+
Get crypto's profile.
|
1408
|
+
|
1409
|
+
### Examples
|
1410
|
+
|
1411
|
+
```ruby
|
1412
|
+
require 'time'
|
1413
|
+
require 'finnhub_ruby'
|
1414
|
+
# setup authorization
|
1415
|
+
FinnhubRuby.configure do |config|
|
1416
|
+
# Configure API key authorization: api_key
|
1417
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1418
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1419
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
1420
|
+
end
|
1421
|
+
|
1422
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
1423
|
+
symbol = 'symbol_example' # String | Crypto symbol such as BTC or ETH.
|
1424
|
+
|
1425
|
+
begin
|
1426
|
+
# Crypto Profile
|
1427
|
+
result = api_instance.crypto_profile(symbol)
|
1428
|
+
p result
|
1429
|
+
rescue FinnhubRuby::ApiError => e
|
1430
|
+
puts "Error when calling DefaultApi->crypto_profile: #{e}"
|
1431
|
+
end
|
1432
|
+
```
|
1433
|
+
|
1434
|
+
#### Using the crypto_profile_with_http_info variant
|
1435
|
+
|
1436
|
+
This returns an Array which contains the response data, status code and headers.
|
1437
|
+
|
1438
|
+
> <Array(<CryptoProfile>, Integer, Hash)> crypto_profile_with_http_info(symbol)
|
1439
|
+
|
1440
|
+
```ruby
|
1441
|
+
begin
|
1442
|
+
# Crypto Profile
|
1443
|
+
data, status_code, headers = api_instance.crypto_profile_with_http_info(symbol)
|
1444
|
+
p status_code # => 2xx
|
1445
|
+
p headers # => { ... }
|
1446
|
+
p data # => <CryptoProfile>
|
1447
|
+
rescue FinnhubRuby::ApiError => e
|
1448
|
+
puts "Error when calling DefaultApi->crypto_profile_with_http_info: #{e}"
|
1449
|
+
end
|
1450
|
+
```
|
1451
|
+
|
1452
|
+
### Parameters
|
1453
|
+
|
1454
|
+
| Name | Type | Description | Notes |
|
1455
|
+
| ---- | ---- | ----------- | ----- |
|
1456
|
+
| **symbol** | **String** | Crypto symbol such as BTC or ETH. | |
|
1457
|
+
|
1458
|
+
### Return type
|
1459
|
+
|
1460
|
+
[**CryptoProfile**](CryptoProfile.md)
|
1461
|
+
|
1462
|
+
### Authorization
|
1463
|
+
|
1464
|
+
[api_key](../README.md#api_key)
|
1465
|
+
|
1466
|
+
### HTTP request headers
|
1467
|
+
|
1468
|
+
- **Content-Type**: Not defined
|
1469
|
+
- **Accept**: application/json
|
1470
|
+
|
1471
|
+
|
1173
1472
|
## crypto_symbols
|
1174
1473
|
|
1175
1474
|
> <Array<CryptoSymbol>> crypto_symbols(exchange)
|
@@ -1322,7 +1621,7 @@ end
|
|
1322
1621
|
|
1323
1622
|
## economic_calendar
|
1324
1623
|
|
1325
|
-
> <EconomicCalendar> economic_calendar
|
1624
|
+
> <EconomicCalendar> economic_calendar(opts)
|
1326
1625
|
|
1327
1626
|
Economic Calendar
|
1328
1627
|
|
@@ -1342,10 +1641,14 @@ FinnhubRuby.configure do |config|
|
|
1342
1641
|
end
|
1343
1642
|
|
1344
1643
|
api_instance = FinnhubRuby::DefaultApi.new
|
1644
|
+
opts = {
|
1645
|
+
from: Date.parse('2013-10-20'), # Date | From date <code>YYYY-MM-DD</code>.
|
1646
|
+
to: Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
|
1647
|
+
}
|
1345
1648
|
|
1346
1649
|
begin
|
1347
1650
|
# Economic Calendar
|
1348
|
-
result = api_instance.economic_calendar
|
1651
|
+
result = api_instance.economic_calendar(opts)
|
1349
1652
|
p result
|
1350
1653
|
rescue FinnhubRuby::ApiError => e
|
1351
1654
|
puts "Error when calling DefaultApi->economic_calendar: #{e}"
|
@@ -1356,12 +1659,12 @@ end
|
|
1356
1659
|
|
1357
1660
|
This returns an Array which contains the response data, status code and headers.
|
1358
1661
|
|
1359
|
-
> <Array(<EconomicCalendar>, Integer, Hash)> economic_calendar_with_http_info
|
1662
|
+
> <Array(<EconomicCalendar>, Integer, Hash)> economic_calendar_with_http_info(opts)
|
1360
1663
|
|
1361
1664
|
```ruby
|
1362
1665
|
begin
|
1363
1666
|
# Economic Calendar
|
1364
|
-
data, status_code, headers = api_instance.economic_calendar_with_http_info
|
1667
|
+
data, status_code, headers = api_instance.economic_calendar_with_http_info(opts)
|
1365
1668
|
p status_code # => 2xx
|
1366
1669
|
p headers # => { ... }
|
1367
1670
|
p data # => <EconomicCalendar>
|
@@ -1372,7 +1675,10 @@ end
|
|
1372
1675
|
|
1373
1676
|
### Parameters
|
1374
1677
|
|
1375
|
-
|
1678
|
+
| Name | Type | Description | Notes |
|
1679
|
+
| ---- | ---- | ----------- | ----- |
|
1680
|
+
| **from** | **Date** | From date <code>YYYY-MM-DD</code>. | [optional] |
|
1681
|
+
| **to** | **Date** | To date <code>YYYY-MM-DD</code>. | [optional] |
|
1376
1682
|
|
1377
1683
|
### Return type
|
1378
1684
|
|
@@ -2725,7 +3031,7 @@ FinnhubRuby.configure do |config|
|
|
2725
3031
|
end
|
2726
3032
|
|
2727
3033
|
api_instance = FinnhubRuby::DefaultApi.new
|
2728
|
-
symbol = 'symbol_example' # String | Symbol of the company: AAPL.
|
3034
|
+
symbol = 'symbol_example' # String | Symbol of the company: AAPL. Leave this param blank to get the latest transactions.
|
2729
3035
|
opts = {
|
2730
3036
|
from: Date.parse('2013-10-20'), # Date | From date: 2020-03-15.
|
2731
3037
|
to: Date.parse('2013-10-20') # Date | To date: 2020-03-16.
|
@@ -2762,7 +3068,7 @@ end
|
|
2762
3068
|
|
2763
3069
|
| Name | Type | Description | Notes |
|
2764
3070
|
| ---- | ---- | ----------- | ----- |
|
2765
|
-
| **symbol** | **String** | Symbol of the company: AAPL. | |
|
3071
|
+
| **symbol** | **String** | Symbol of the company: AAPL. Leave this param blank to get the latest transactions. | |
|
2766
3072
|
| **from** | **Date** | From date: 2020-03-15. | [optional] |
|
2767
3073
|
| **to** | **Date** | To date: 2020-03-16. | [optional] |
|
2768
3074
|
|
@@ -2786,7 +3092,7 @@ end
|
|
2786
3092
|
|
2787
3093
|
International Filings
|
2788
3094
|
|
2789
|
-
List filings for international companies
|
3095
|
+
List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
|
2790
3096
|
|
2791
3097
|
### Examples
|
2792
3098
|
|
@@ -4637,7 +4943,7 @@ end
|
|
4637
4943
|
|
4638
4944
|
Tick Data
|
4639
4945
|
|
4640
|
-
<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><
|
4946
|
+
<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>
|
4641
4947
|
|
4642
4948
|
### Examples
|
4643
4949
|
|
@@ -4708,6 +5014,81 @@ end
|
|
4708
5014
|
- **Accept**: application/json
|
4709
5015
|
|
4710
5016
|
|
5017
|
+
## stock_uspto_patent
|
5018
|
+
|
5019
|
+
> <UsptoPatentResult> stock_uspto_patent(symbol, from, to)
|
5020
|
+
|
5021
|
+
USPTO Patents
|
5022
|
+
|
5023
|
+
List USPTO patents for companies. Limit to 250 records per API call.
|
5024
|
+
|
5025
|
+
### Examples
|
5026
|
+
|
5027
|
+
```ruby
|
5028
|
+
require 'time'
|
5029
|
+
require 'finnhub_ruby'
|
5030
|
+
# setup authorization
|
5031
|
+
FinnhubRuby.configure do |config|
|
5032
|
+
# Configure API key authorization: api_key
|
5033
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
5034
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
5035
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
5036
|
+
end
|
5037
|
+
|
5038
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
5039
|
+
symbol = 'symbol_example' # String | Symbol.
|
5040
|
+
from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>.
|
5041
|
+
to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
|
5042
|
+
|
5043
|
+
begin
|
5044
|
+
# USPTO Patents
|
5045
|
+
result = api_instance.stock_uspto_patent(symbol, from, to)
|
5046
|
+
p result
|
5047
|
+
rescue FinnhubRuby::ApiError => e
|
5048
|
+
puts "Error when calling DefaultApi->stock_uspto_patent: #{e}"
|
5049
|
+
end
|
5050
|
+
```
|
5051
|
+
|
5052
|
+
#### Using the stock_uspto_patent_with_http_info variant
|
5053
|
+
|
5054
|
+
This returns an Array which contains the response data, status code and headers.
|
5055
|
+
|
5056
|
+
> <Array(<UsptoPatentResult>, Integer, Hash)> stock_uspto_patent_with_http_info(symbol, from, to)
|
5057
|
+
|
5058
|
+
```ruby
|
5059
|
+
begin
|
5060
|
+
# USPTO Patents
|
5061
|
+
data, status_code, headers = api_instance.stock_uspto_patent_with_http_info(symbol, from, to)
|
5062
|
+
p status_code # => 2xx
|
5063
|
+
p headers # => { ... }
|
5064
|
+
p data # => <UsptoPatentResult>
|
5065
|
+
rescue FinnhubRuby::ApiError => e
|
5066
|
+
puts "Error when calling DefaultApi->stock_uspto_patent_with_http_info: #{e}"
|
5067
|
+
end
|
5068
|
+
```
|
5069
|
+
|
5070
|
+
### Parameters
|
5071
|
+
|
5072
|
+
| Name | Type | Description | Notes |
|
5073
|
+
| ---- | ---- | ----------- | ----- |
|
5074
|
+
| **symbol** | **String** | Symbol. | |
|
5075
|
+
| **from** | **Date** | From date <code>YYYY-MM-DD</code>. | |
|
5076
|
+
| **to** | **Date** | To date <code>YYYY-MM-DD</code>. | |
|
5077
|
+
|
5078
|
+
### Return type
|
5079
|
+
|
5080
|
+
[**UsptoPatentResult**](UsptoPatentResult.md)
|
5081
|
+
|
5082
|
+
### Authorization
|
5083
|
+
|
5084
|
+
[api_key](../README.md#api_key)
|
5085
|
+
|
5086
|
+
### HTTP request headers
|
5087
|
+
|
5088
|
+
- **Content-Type**: Not defined
|
5089
|
+
- **Accept**: application/json
|
5090
|
+
|
5091
|
+
|
4711
5092
|
## supply_chain_relationships
|
4712
5093
|
|
4713
5094
|
> <SupplyChainRelationships> supply_chain_relationships(symbol)
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# FinnhubRuby::EbitEstimates
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<EbitEstimatesInfo>**](EbitEstimatesInfo.md) | List of estimates | [optional] |
|
8
|
+
| **freq** | **String** | Frequency: annual or quarterly. | [optional] |
|
9
|
+
| **symbol** | **String** | Company symbol. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'finnhub_ruby'
|
15
|
+
|
16
|
+
instance = FinnhubRuby::EbitEstimates.new(
|
17
|
+
data: null,
|
18
|
+
freq: null,
|
19
|
+
symbol: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# FinnhubRuby::EbitEstimatesInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **ebit_avg** | **Float** | Average EBIT estimates including Finnhub's proprietary estimates. | [optional] |
|
8
|
+
| **ebit_high** | **Float** | Highest estimate. | [optional] |
|
9
|
+
| **ebit_low** | **Float** | Lowest estimate. | [optional] |
|
10
|
+
| **number_analysts** | **Integer** | Number of Analysts. | [optional] |
|
11
|
+
| **period** | **Date** | Period. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'finnhub_ruby'
|
17
|
+
|
18
|
+
instance = FinnhubRuby::EbitEstimatesInfo.new(
|
19
|
+
ebit_avg: null,
|
20
|
+
ebit_high: null,
|
21
|
+
ebit_low: null,
|
22
|
+
number_analysts: null,
|
23
|
+
period: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# FinnhubRuby::EbitdaEstimates
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<EbitdaEstimatesInfo>**](EbitdaEstimatesInfo.md) | List of estimates | [optional] |
|
8
|
+
| **freq** | **String** | Frequency: annual or quarterly. | [optional] |
|
9
|
+
| **symbol** | **String** | Company symbol. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'finnhub_ruby'
|
15
|
+
|
16
|
+
instance = FinnhubRuby::EbitdaEstimates.new(
|
17
|
+
data: null,
|
18
|
+
freq: null,
|
19
|
+
symbol: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# FinnhubRuby::EbitdaEstimatesInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **ebitda_avg** | **Float** | Average EBITDA estimates including Finnhub's proprietary estimates. | [optional] |
|
8
|
+
| **ebitda_high** | **Float** | Highest estimate. | [optional] |
|
9
|
+
| **ebitda_low** | **Float** | Lowest estimate. | [optional] |
|
10
|
+
| **number_analysts** | **Integer** | Number of Analysts. | [optional] |
|
11
|
+
| **period** | **Date** | Period. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'finnhub_ruby'
|
17
|
+
|
18
|
+
instance = FinnhubRuby::EbitdaEstimatesInfo.new(
|
19
|
+
ebitda_avg: null,
|
20
|
+
ebitda_high: null,
|
21
|
+
ebitda_low: null,
|
22
|
+
number_analysts: null,
|
23
|
+
period: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -25,6 +25,10 @@
|
|
25
25
|
| **max_redemption_fee** | **Float** | Max redemption fee. | [optional] |
|
26
26
|
| **standard_min_investment** | **Float** | Minimum investment for standard accounts. | [optional] |
|
27
27
|
| **turnover** | **Float** | Turnover. | [optional] |
|
28
|
+
| **series_id** | **String** | Fund's series ID. This field can be used to group multiple share classes into 1 unique fund. | [optional] |
|
29
|
+
| **series_name** | **String** | Fund's series name. | [optional] |
|
30
|
+
| **class_id** | **String** | Class ID. | [optional] |
|
31
|
+
| **class_name** | **String** | Class name. | [optional] |
|
28
32
|
|
29
33
|
## Example
|
30
34
|
|
@@ -52,7 +56,11 @@ instance = FinnhubRuby::MutualFundProfileData.new(
|
|
52
56
|
cusip: null,
|
53
57
|
max_redemption_fee: null,
|
54
58
|
standard_min_investment: null,
|
55
|
-
turnover: null
|
59
|
+
turnover: null,
|
60
|
+
series_id: null,
|
61
|
+
series_name: null,
|
62
|
+
class_id: null,
|
63
|
+
class_name: null
|
56
64
|
)
|
57
65
|
```
|
58
66
|
|
data/docs/StockSymbol.md
CHANGED
@@ -10,7 +10,10 @@
|
|
10
10
|
| **type** | **String** | Security type. | [optional] |
|
11
11
|
| **mic** | **String** | Primary exchange's MIC. | [optional] |
|
12
12
|
| **figi** | **String** | FIGI identifier. | [optional] |
|
13
|
+
| **share_class_figi** | **String** | Global Share Class FIGI. | [optional] |
|
13
14
|
| **currency** | **String** | Price's currency. This might be different from the reporting currency of fundamental data. | [optional] |
|
15
|
+
| **symbol2** | **String** | Alternative ticker for exchanges with multiple tickers for 1 stock such as BSE. | [optional] |
|
16
|
+
| **isin** | **String** | ISIN. This field is only available for EU stocks and selected Asian markets. Entitlement from Finnhub is required to access this field. | [optional] |
|
14
17
|
|
15
18
|
## Example
|
16
19
|
|
@@ -24,7 +27,10 @@ instance = FinnhubRuby::StockSymbol.new(
|
|
24
27
|
type: null,
|
25
28
|
mic: null,
|
26
29
|
figi: null,
|
27
|
-
|
30
|
+
share_class_figi: null,
|
31
|
+
currency: null,
|
32
|
+
symbol2: null,
|
33
|
+
isin: null
|
28
34
|
)
|
29
35
|
```
|
30
36
|
|
data/docs/Transactions.md
CHANGED
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
7
8
|
| **name** | **String** | Insider's name. | [optional] |
|
8
9
|
| **share** | **Integer** | Number of shares held after the transaction. | [optional] |
|
9
10
|
| **change** | **Integer** | Number of share changed from the last period. A positive value suggests a <code>BUY</code> transaction. A negative value suggests a <code>SELL</code> transaction. | [optional] |
|
@@ -18,6 +19,7 @@
|
|
18
19
|
require 'finnhub_ruby'
|
19
20
|
|
20
21
|
instance = FinnhubRuby::Transactions.new(
|
22
|
+
symbol: null,
|
21
23
|
name: null,
|
22
24
|
share: null,
|
23
25
|
change: null,
|