finnhub_ruby 1.1.9 → 1.1.13
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +17 -3
- data/docs/CryptoProfile.md +38 -0
- data/docs/DefaultApi.md +396 -11
- 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/docs/VisaApplication.md +62 -0
- data/docs/VisaApplicationResult.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.12.gem +0 -0
- data/finnhub_ruby-1.1.9.gem +0 -0
- data/lib/finnhub_ruby/api/default_api.rb +369 -6
- 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/models/visa_application.rb +439 -0
- data/lib/finnhub_ruby/models/visa_application_result.rb +231 -0
- data/lib/finnhub_ruby/version.rb +1 -1
- data/lib/finnhub_ruby.rb +9 -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
- data/spec/models/visa_application_result_spec.rb +40 -0
- data/spec/models/visa_application_spec.rb +166 -0
- metadata +42 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e36670eda77a8ce542ba847a4d42bd58794eb8fca5bc7d1e7b48fed9a18e1c58
|
4
|
+
data.tar.gz: 826059c874f10b755cf306dad7f9031230008bfaca31a9c0239637022bc1a5b5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9e102598fafad86d9af44c1aed2e16dea8a7fe57d0befa3a50769a4ff94c61f0b439e4350de3d653339514df2c1a9425ece648d5ef56cda1bd39774c51cffd0c
|
7
|
+
data.tar.gz: 7be63933d8e423c86778349f13c843bba4bb6dd4bd860a5932675631069f86aae75b85e78540b43f2d0c83057615e1974cf624ed15a919b959eff2bb44e006fd
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# finnhub-ruby
|
2
2
|
- API documentation: https://finnhub.io/docs/api
|
3
3
|
- API version: 1.0.0
|
4
|
-
- Package version: 1.1.
|
4
|
+
- Package version: 1.1.13
|
5
5
|
|
6
6
|
## Installation
|
7
7
|
https://rubygems.org/gems/finnhub_ruby
|
@@ -13,7 +13,7 @@ gem install finnhub_ruby
|
|
13
13
|
or in your Gemfile
|
14
14
|
|
15
15
|
```ruby
|
16
|
-
gem 'finnhub_ruby', '~> 1.1.
|
16
|
+
gem 'finnhub_ruby', '~> 1.1.13'
|
17
17
|
```
|
18
18
|
|
19
19
|
## Getting Started
|
@@ -67,7 +67,6 @@ puts(finnhub_client.company_eps_estimates('AMZN', {freq: 'quarterly'}))
|
|
67
67
|
puts(finnhub_client.company_executive('AAPL'))
|
68
68
|
|
69
69
|
# Company News
|
70
|
-
# Need to use _from instead of from to avoid conflict
|
71
70
|
puts(finnhub_client.company_news('AAPL', "2020-06-01", "2020-06-10"))
|
72
71
|
|
73
72
|
# Company Peers
|
@@ -243,6 +242,21 @@ puts(finnhub_client.company_esg_score('AAPL'))
|
|
243
242
|
# Company Earnings Quality
|
244
243
|
puts(finnhub_client.company_earnings_quality_score('AAPL', 'quarterly'))
|
245
244
|
|
245
|
+
# Crypto Profile
|
246
|
+
puts(finnhub_client.crypto_profile('BTC'))
|
247
|
+
|
248
|
+
# EBITDA Estimates
|
249
|
+
puts(finnhub_client.company_ebitda_estimates('AAPL', {freq: 'quarterly'}))
|
250
|
+
|
251
|
+
# EBIT Estimates
|
252
|
+
puts(finnhub_client.company_ebit_estimates('TSLA', {freq: 'quarterly'}))
|
253
|
+
|
254
|
+
# USPTO
|
255
|
+
puts(finnhub_client.stock_uspto_patent('NVDA', "2020-06-01", "2021-06-10"))
|
256
|
+
|
257
|
+
# Visa Application
|
258
|
+
puts(finnhub_client.stock_visa_application('AAPL', "2020-06-01", "2021-06-10"))
|
259
|
+
|
246
260
|
```
|
247
261
|
|
248
262
|
## License
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# FinnhubRuby::CryptoProfile
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **long_name** | **String** | Long name. | [optional] |
|
8
|
+
| **name** | **String** | Name. | [optional] |
|
9
|
+
| **description** | **String** | Description. | [optional] |
|
10
|
+
| **website** | **String** | Project's website. | [optional] |
|
11
|
+
| **market_cap** | **Float** | Market capitalization. | [optional] |
|
12
|
+
| **total_supply** | **Float** | Total supply. | [optional] |
|
13
|
+
| **max_supply** | **Float** | Max supply. | [optional] |
|
14
|
+
| **circulating_supply** | **Float** | Circulating supply. | [optional] |
|
15
|
+
| **logo** | **String** | Logo image. | [optional] |
|
16
|
+
| **launch_date** | **String** | Launch date. | [optional] |
|
17
|
+
| **proof_type** | **String** | Proof type. | [optional] |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'finnhub_ruby'
|
23
|
+
|
24
|
+
instance = FinnhubRuby::CryptoProfile.new(
|
25
|
+
long_name: null,
|
26
|
+
name: null,
|
27
|
+
description: null,
|
28
|
+
website: null,
|
29
|
+
market_cap: null,
|
30
|
+
total_supply: null,
|
31
|
+
max_supply: null,
|
32
|
+
circulating_supply: null,
|
33
|
+
logo: null,
|
34
|
+
launch_date: null,
|
35
|
+
proof_type: null
|
36
|
+
)
|
37
|
+
```
|
38
|
+
|
data/docs/DefaultApi.md
CHANGED
@@ -8,6 +8,8 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
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
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 |
|
11
13
|
| [**company_eps_estimates**](DefaultApi.md#company_eps_estimates) | **GET** /stock/eps-estimate | Earnings Estimates |
|
12
14
|
| [**company_esg_score**](DefaultApi.md#company_esg_score) | **GET** /stock/esg | Company ESG Scores |
|
13
15
|
| [**company_executive**](DefaultApi.md#company_executive) | **GET** /stock/executive | Company Executive |
|
@@ -20,6 +22,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
20
22
|
| [**covid19**](DefaultApi.md#covid19) | **GET** /covid19/us | COVID-19 |
|
21
23
|
| [**crypto_candles**](DefaultApi.md#crypto_candles) | **GET** /crypto/candle | Crypto Candles |
|
22
24
|
| [**crypto_exchanges**](DefaultApi.md#crypto_exchanges) | **GET** /crypto/exchange | Crypto Exchanges |
|
25
|
+
| [**crypto_profile**](DefaultApi.md#crypto_profile) | **GET** /crypto/profile | Crypto Profile |
|
23
26
|
| [**crypto_symbols**](DefaultApi.md#crypto_symbols) | **GET** /crypto/symbol | Crypto Symbol |
|
24
27
|
| [**earnings_calendar**](DefaultApi.md#earnings_calendar) | **GET** /calendar/earnings | Earnings Calendar |
|
25
28
|
| [**economic_calendar**](DefaultApi.md#economic_calendar) | **GET** /calendar/economic | Economic Calendar |
|
@@ -68,6 +71,8 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
68
71
|
| [**stock_splits**](DefaultApi.md#stock_splits) | **GET** /stock/split | Splits |
|
69
72
|
| [**stock_symbols**](DefaultApi.md#stock_symbols) | **GET** /stock/symbol | Stock Symbol |
|
70
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 |
|
75
|
+
| [**stock_visa_application**](DefaultApi.md#stock_visa_application) | **GET** /stock/visa-application | H1-B Visa Application |
|
71
76
|
| [**supply_chain_relationships**](DefaultApi.md#supply_chain_relationships) | **GET** /stock/supply-chain | Supply Chain Relationships |
|
72
77
|
| [**support_resistance**](DefaultApi.md#support_resistance) | **GET** /scan/support-resistance | Support/Resistance |
|
73
78
|
| [**symbol_search**](DefaultApi.md#symbol_search) | **GET** /search | Symbol Lookup |
|
@@ -321,7 +326,7 @@ end
|
|
321
326
|
|
322
327
|
api_instance = FinnhubRuby::DefaultApi.new
|
323
328
|
symbol = 'symbol_example' # String | Symbol.
|
324
|
-
freq = 'freq_example' # String | Frequency. Currently
|
329
|
+
freq = 'freq_example' # String | Frequency. Currently support <code>annual</code> and <code>quarterly</code>
|
325
330
|
|
326
331
|
begin
|
327
332
|
# Company Earnings Quality Score
|
@@ -355,7 +360,7 @@ end
|
|
355
360
|
| Name | Type | Description | Notes |
|
356
361
|
| ---- | ---- | ----------- | ----- |
|
357
362
|
| **symbol** | **String** | Symbol. | |
|
358
|
-
| **freq** | **String** | Frequency. Currently
|
363
|
+
| **freq** | **String** | Frequency. Currently support <code>annual</code> and <code>quarterly</code> | |
|
359
364
|
|
360
365
|
### Return type
|
361
366
|
|
@@ -371,6 +376,156 @@ end
|
|
371
376
|
- **Accept**: application/json
|
372
377
|
|
373
378
|
|
379
|
+
## company_ebit_estimates
|
380
|
+
|
381
|
+
> <EbitEstimates> company_ebit_estimates(symbol, opts)
|
382
|
+
|
383
|
+
EBIT Estimates
|
384
|
+
|
385
|
+
Get company's ebit estimates.
|
386
|
+
|
387
|
+
### Examples
|
388
|
+
|
389
|
+
```ruby
|
390
|
+
require 'time'
|
391
|
+
require 'finnhub_ruby'
|
392
|
+
# setup authorization
|
393
|
+
FinnhubRuby.configure do |config|
|
394
|
+
# Configure API key authorization: api_key
|
395
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
396
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
397
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
398
|
+
end
|
399
|
+
|
400
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
401
|
+
symbol = 'symbol_example' # String | Symbol of the company: AAPL.
|
402
|
+
opts = {
|
403
|
+
freq: 'freq_example' # String | Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
|
404
|
+
}
|
405
|
+
|
406
|
+
begin
|
407
|
+
# EBIT Estimates
|
408
|
+
result = api_instance.company_ebit_estimates(symbol, opts)
|
409
|
+
p result
|
410
|
+
rescue FinnhubRuby::ApiError => e
|
411
|
+
puts "Error when calling DefaultApi->company_ebit_estimates: #{e}"
|
412
|
+
end
|
413
|
+
```
|
414
|
+
|
415
|
+
#### Using the company_ebit_estimates_with_http_info variant
|
416
|
+
|
417
|
+
This returns an Array which contains the response data, status code and headers.
|
418
|
+
|
419
|
+
> <Array(<EbitEstimates>, Integer, Hash)> company_ebit_estimates_with_http_info(symbol, opts)
|
420
|
+
|
421
|
+
```ruby
|
422
|
+
begin
|
423
|
+
# EBIT Estimates
|
424
|
+
data, status_code, headers = api_instance.company_ebit_estimates_with_http_info(symbol, opts)
|
425
|
+
p status_code # => 2xx
|
426
|
+
p headers # => { ... }
|
427
|
+
p data # => <EbitEstimates>
|
428
|
+
rescue FinnhubRuby::ApiError => e
|
429
|
+
puts "Error when calling DefaultApi->company_ebit_estimates_with_http_info: #{e}"
|
430
|
+
end
|
431
|
+
```
|
432
|
+
|
433
|
+
### Parameters
|
434
|
+
|
435
|
+
| Name | Type | Description | Notes |
|
436
|
+
| ---- | ---- | ----------- | ----- |
|
437
|
+
| **symbol** | **String** | Symbol of the company: AAPL. | |
|
438
|
+
| **freq** | **String** | Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code> | [optional] |
|
439
|
+
|
440
|
+
### Return type
|
441
|
+
|
442
|
+
[**EbitEstimates**](EbitEstimates.md)
|
443
|
+
|
444
|
+
### Authorization
|
445
|
+
|
446
|
+
[api_key](../README.md#api_key)
|
447
|
+
|
448
|
+
### HTTP request headers
|
449
|
+
|
450
|
+
- **Content-Type**: Not defined
|
451
|
+
- **Accept**: application/json
|
452
|
+
|
453
|
+
|
454
|
+
## company_ebitda_estimates
|
455
|
+
|
456
|
+
> <EbitdaEstimates> company_ebitda_estimates(symbol, opts)
|
457
|
+
|
458
|
+
EBITDA Estimates
|
459
|
+
|
460
|
+
Get company's ebitda estimates.
|
461
|
+
|
462
|
+
### Examples
|
463
|
+
|
464
|
+
```ruby
|
465
|
+
require 'time'
|
466
|
+
require 'finnhub_ruby'
|
467
|
+
# setup authorization
|
468
|
+
FinnhubRuby.configure do |config|
|
469
|
+
# Configure API key authorization: api_key
|
470
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
471
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
472
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
473
|
+
end
|
474
|
+
|
475
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
476
|
+
symbol = 'symbol_example' # String | Symbol of the company: AAPL.
|
477
|
+
opts = {
|
478
|
+
freq: 'freq_example' # String | Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code>
|
479
|
+
}
|
480
|
+
|
481
|
+
begin
|
482
|
+
# EBITDA Estimates
|
483
|
+
result = api_instance.company_ebitda_estimates(symbol, opts)
|
484
|
+
p result
|
485
|
+
rescue FinnhubRuby::ApiError => e
|
486
|
+
puts "Error when calling DefaultApi->company_ebitda_estimates: #{e}"
|
487
|
+
end
|
488
|
+
```
|
489
|
+
|
490
|
+
#### Using the company_ebitda_estimates_with_http_info variant
|
491
|
+
|
492
|
+
This returns an Array which contains the response data, status code and headers.
|
493
|
+
|
494
|
+
> <Array(<EbitdaEstimates>, Integer, Hash)> company_ebitda_estimates_with_http_info(symbol, opts)
|
495
|
+
|
496
|
+
```ruby
|
497
|
+
begin
|
498
|
+
# EBITDA Estimates
|
499
|
+
data, status_code, headers = api_instance.company_ebitda_estimates_with_http_info(symbol, opts)
|
500
|
+
p status_code # => 2xx
|
501
|
+
p headers # => { ... }
|
502
|
+
p data # => <EbitdaEstimates>
|
503
|
+
rescue FinnhubRuby::ApiError => e
|
504
|
+
puts "Error when calling DefaultApi->company_ebitda_estimates_with_http_info: #{e}"
|
505
|
+
end
|
506
|
+
```
|
507
|
+
|
508
|
+
### Parameters
|
509
|
+
|
510
|
+
| Name | Type | Description | Notes |
|
511
|
+
| ---- | ---- | ----------- | ----- |
|
512
|
+
| **symbol** | **String** | Symbol of the company: AAPL. | |
|
513
|
+
| **freq** | **String** | Can take 1 of the following values: <code>annual, quarterly</code>. Default to <code>quarterly</code> | [optional] |
|
514
|
+
|
515
|
+
### Return type
|
516
|
+
|
517
|
+
[**EbitdaEstimates**](EbitdaEstimates.md)
|
518
|
+
|
519
|
+
### Authorization
|
520
|
+
|
521
|
+
[api_key](../README.md#api_key)
|
522
|
+
|
523
|
+
### HTTP request headers
|
524
|
+
|
525
|
+
- **Content-Type**: Not defined
|
526
|
+
- **Accept**: application/json
|
527
|
+
|
528
|
+
|
374
529
|
## company_eps_estimates
|
375
530
|
|
376
531
|
> <EarningsEstimates> company_eps_estimates(symbol, opts)
|
@@ -1244,6 +1399,77 @@ This endpoint does not need any parameter.
|
|
1244
1399
|
- **Accept**: application/json
|
1245
1400
|
|
1246
1401
|
|
1402
|
+
## crypto_profile
|
1403
|
+
|
1404
|
+
> <CryptoProfile> crypto_profile(symbol)
|
1405
|
+
|
1406
|
+
Crypto Profile
|
1407
|
+
|
1408
|
+
Get crypto's profile.
|
1409
|
+
|
1410
|
+
### Examples
|
1411
|
+
|
1412
|
+
```ruby
|
1413
|
+
require 'time'
|
1414
|
+
require 'finnhub_ruby'
|
1415
|
+
# setup authorization
|
1416
|
+
FinnhubRuby.configure do |config|
|
1417
|
+
# Configure API key authorization: api_key
|
1418
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1419
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1420
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
1421
|
+
end
|
1422
|
+
|
1423
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
1424
|
+
symbol = 'symbol_example' # String | Crypto symbol such as BTC or ETH.
|
1425
|
+
|
1426
|
+
begin
|
1427
|
+
# Crypto Profile
|
1428
|
+
result = api_instance.crypto_profile(symbol)
|
1429
|
+
p result
|
1430
|
+
rescue FinnhubRuby::ApiError => e
|
1431
|
+
puts "Error when calling DefaultApi->crypto_profile: #{e}"
|
1432
|
+
end
|
1433
|
+
```
|
1434
|
+
|
1435
|
+
#### Using the crypto_profile_with_http_info variant
|
1436
|
+
|
1437
|
+
This returns an Array which contains the response data, status code and headers.
|
1438
|
+
|
1439
|
+
> <Array(<CryptoProfile>, Integer, Hash)> crypto_profile_with_http_info(symbol)
|
1440
|
+
|
1441
|
+
```ruby
|
1442
|
+
begin
|
1443
|
+
# Crypto Profile
|
1444
|
+
data, status_code, headers = api_instance.crypto_profile_with_http_info(symbol)
|
1445
|
+
p status_code # => 2xx
|
1446
|
+
p headers # => { ... }
|
1447
|
+
p data # => <CryptoProfile>
|
1448
|
+
rescue FinnhubRuby::ApiError => e
|
1449
|
+
puts "Error when calling DefaultApi->crypto_profile_with_http_info: #{e}"
|
1450
|
+
end
|
1451
|
+
```
|
1452
|
+
|
1453
|
+
### Parameters
|
1454
|
+
|
1455
|
+
| Name | Type | Description | Notes |
|
1456
|
+
| ---- | ---- | ----------- | ----- |
|
1457
|
+
| **symbol** | **String** | Crypto symbol such as BTC or ETH. | |
|
1458
|
+
|
1459
|
+
### Return type
|
1460
|
+
|
1461
|
+
[**CryptoProfile**](CryptoProfile.md)
|
1462
|
+
|
1463
|
+
### Authorization
|
1464
|
+
|
1465
|
+
[api_key](../README.md#api_key)
|
1466
|
+
|
1467
|
+
### HTTP request headers
|
1468
|
+
|
1469
|
+
- **Content-Type**: Not defined
|
1470
|
+
- **Accept**: application/json
|
1471
|
+
|
1472
|
+
|
1247
1473
|
## crypto_symbols
|
1248
1474
|
|
1249
1475
|
> <Array<CryptoSymbol>> crypto_symbols(exchange)
|
@@ -1396,7 +1622,7 @@ end
|
|
1396
1622
|
|
1397
1623
|
## economic_calendar
|
1398
1624
|
|
1399
|
-
> <EconomicCalendar> economic_calendar
|
1625
|
+
> <EconomicCalendar> economic_calendar(opts)
|
1400
1626
|
|
1401
1627
|
Economic Calendar
|
1402
1628
|
|
@@ -1416,10 +1642,14 @@ FinnhubRuby.configure do |config|
|
|
1416
1642
|
end
|
1417
1643
|
|
1418
1644
|
api_instance = FinnhubRuby::DefaultApi.new
|
1645
|
+
opts = {
|
1646
|
+
from: Date.parse('2013-10-20'), # Date | From date <code>YYYY-MM-DD</code>.
|
1647
|
+
to: Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
|
1648
|
+
}
|
1419
1649
|
|
1420
1650
|
begin
|
1421
1651
|
# Economic Calendar
|
1422
|
-
result = api_instance.economic_calendar
|
1652
|
+
result = api_instance.economic_calendar(opts)
|
1423
1653
|
p result
|
1424
1654
|
rescue FinnhubRuby::ApiError => e
|
1425
1655
|
puts "Error when calling DefaultApi->economic_calendar: #{e}"
|
@@ -1430,12 +1660,12 @@ end
|
|
1430
1660
|
|
1431
1661
|
This returns an Array which contains the response data, status code and headers.
|
1432
1662
|
|
1433
|
-
> <Array(<EconomicCalendar>, Integer, Hash)> economic_calendar_with_http_info
|
1663
|
+
> <Array(<EconomicCalendar>, Integer, Hash)> economic_calendar_with_http_info(opts)
|
1434
1664
|
|
1435
1665
|
```ruby
|
1436
1666
|
begin
|
1437
1667
|
# Economic Calendar
|
1438
|
-
data, status_code, headers = api_instance.economic_calendar_with_http_info
|
1668
|
+
data, status_code, headers = api_instance.economic_calendar_with_http_info(opts)
|
1439
1669
|
p status_code # => 2xx
|
1440
1670
|
p headers # => { ... }
|
1441
1671
|
p data # => <EconomicCalendar>
|
@@ -1446,7 +1676,10 @@ end
|
|
1446
1676
|
|
1447
1677
|
### Parameters
|
1448
1678
|
|
1449
|
-
|
1679
|
+
| Name | Type | Description | Notes |
|
1680
|
+
| ---- | ---- | ----------- | ----- |
|
1681
|
+
| **from** | **Date** | From date <code>YYYY-MM-DD</code>. | [optional] |
|
1682
|
+
| **to** | **Date** | To date <code>YYYY-MM-DD</code>. | [optional] |
|
1450
1683
|
|
1451
1684
|
### Return type
|
1452
1685
|
|
@@ -2439,7 +2672,8 @@ end
|
|
2439
2672
|
|
2440
2673
|
api_instance = FinnhubRuby::DefaultApi.new
|
2441
2674
|
opts = {
|
2442
|
-
base: 'base_example' # String | Base currency. Default to EUR.
|
2675
|
+
base: 'base_example', # String | Base currency. Default to EUR.
|
2676
|
+
date: 'date_example' # String | Date. Leave blank to get the latest data.
|
2443
2677
|
}
|
2444
2678
|
|
2445
2679
|
begin
|
@@ -2474,6 +2708,7 @@ end
|
|
2474
2708
|
| Name | Type | Description | Notes |
|
2475
2709
|
| ---- | ---- | ----------- | ----- |
|
2476
2710
|
| **base** | **String** | Base currency. Default to EUR. | [optional] |
|
2711
|
+
| **date** | **String** | Date. Leave blank to get the latest data. | [optional] |
|
2477
2712
|
|
2478
2713
|
### Return type
|
2479
2714
|
|
@@ -2799,7 +3034,7 @@ FinnhubRuby.configure do |config|
|
|
2799
3034
|
end
|
2800
3035
|
|
2801
3036
|
api_instance = FinnhubRuby::DefaultApi.new
|
2802
|
-
symbol = 'symbol_example' # String | Symbol of the company: AAPL.
|
3037
|
+
symbol = 'symbol_example' # String | Symbol of the company: AAPL. Leave this param blank to get the latest transactions.
|
2803
3038
|
opts = {
|
2804
3039
|
from: Date.parse('2013-10-20'), # Date | From date: 2020-03-15.
|
2805
3040
|
to: Date.parse('2013-10-20') # Date | To date: 2020-03-16.
|
@@ -2836,7 +3071,7 @@ end
|
|
2836
3071
|
|
2837
3072
|
| Name | Type | Description | Notes |
|
2838
3073
|
| ---- | ---- | ----------- | ----- |
|
2839
|
-
| **symbol** | **String** | Symbol of the company: AAPL. | |
|
3074
|
+
| **symbol** | **String** | Symbol of the company: AAPL. Leave this param blank to get the latest transactions. | |
|
2840
3075
|
| **from** | **Date** | From date: 2020-03-15. | [optional] |
|
2841
3076
|
| **to** | **Date** | To date: 2020-03-16. | [optional] |
|
2842
3077
|
|
@@ -2860,7 +3095,7 @@ end
|
|
2860
3095
|
|
2861
3096
|
International Filings
|
2862
3097
|
|
2863
|
-
List filings for international companies
|
3098
|
+
List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
|
2864
3099
|
|
2865
3100
|
### Examples
|
2866
3101
|
|
@@ -4782,6 +5017,156 @@ end
|
|
4782
5017
|
- **Accept**: application/json
|
4783
5018
|
|
4784
5019
|
|
5020
|
+
## stock_uspto_patent
|
5021
|
+
|
5022
|
+
> <UsptoPatentResult> stock_uspto_patent(symbol, from, to)
|
5023
|
+
|
5024
|
+
USPTO Patents
|
5025
|
+
|
5026
|
+
List USPTO patents for companies. Limit to 250 records per API call.
|
5027
|
+
|
5028
|
+
### Examples
|
5029
|
+
|
5030
|
+
```ruby
|
5031
|
+
require 'time'
|
5032
|
+
require 'finnhub_ruby'
|
5033
|
+
# setup authorization
|
5034
|
+
FinnhubRuby.configure do |config|
|
5035
|
+
# Configure API key authorization: api_key
|
5036
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
5037
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
5038
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
5039
|
+
end
|
5040
|
+
|
5041
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
5042
|
+
symbol = 'symbol_example' # String | Symbol.
|
5043
|
+
from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>.
|
5044
|
+
to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
|
5045
|
+
|
5046
|
+
begin
|
5047
|
+
# USPTO Patents
|
5048
|
+
result = api_instance.stock_uspto_patent(symbol, from, to)
|
5049
|
+
p result
|
5050
|
+
rescue FinnhubRuby::ApiError => e
|
5051
|
+
puts "Error when calling DefaultApi->stock_uspto_patent: #{e}"
|
5052
|
+
end
|
5053
|
+
```
|
5054
|
+
|
5055
|
+
#### Using the stock_uspto_patent_with_http_info variant
|
5056
|
+
|
5057
|
+
This returns an Array which contains the response data, status code and headers.
|
5058
|
+
|
5059
|
+
> <Array(<UsptoPatentResult>, Integer, Hash)> stock_uspto_patent_with_http_info(symbol, from, to)
|
5060
|
+
|
5061
|
+
```ruby
|
5062
|
+
begin
|
5063
|
+
# USPTO Patents
|
5064
|
+
data, status_code, headers = api_instance.stock_uspto_patent_with_http_info(symbol, from, to)
|
5065
|
+
p status_code # => 2xx
|
5066
|
+
p headers # => { ... }
|
5067
|
+
p data # => <UsptoPatentResult>
|
5068
|
+
rescue FinnhubRuby::ApiError => e
|
5069
|
+
puts "Error when calling DefaultApi->stock_uspto_patent_with_http_info: #{e}"
|
5070
|
+
end
|
5071
|
+
```
|
5072
|
+
|
5073
|
+
### Parameters
|
5074
|
+
|
5075
|
+
| Name | Type | Description | Notes |
|
5076
|
+
| ---- | ---- | ----------- | ----- |
|
5077
|
+
| **symbol** | **String** | Symbol. | |
|
5078
|
+
| **from** | **Date** | From date <code>YYYY-MM-DD</code>. | |
|
5079
|
+
| **to** | **Date** | To date <code>YYYY-MM-DD</code>. | |
|
5080
|
+
|
5081
|
+
### Return type
|
5082
|
+
|
5083
|
+
[**UsptoPatentResult**](UsptoPatentResult.md)
|
5084
|
+
|
5085
|
+
### Authorization
|
5086
|
+
|
5087
|
+
[api_key](../README.md#api_key)
|
5088
|
+
|
5089
|
+
### HTTP request headers
|
5090
|
+
|
5091
|
+
- **Content-Type**: Not defined
|
5092
|
+
- **Accept**: application/json
|
5093
|
+
|
5094
|
+
|
5095
|
+
## stock_visa_application
|
5096
|
+
|
5097
|
+
> <VisaApplicationResult> stock_visa_application(symbol, from, to)
|
5098
|
+
|
5099
|
+
H1-B Visa Application
|
5100
|
+
|
5101
|
+
Get a list of H1-B and Permanent visa applications for companies from the DOL. The data is updated quarterly.
|
5102
|
+
|
5103
|
+
### Examples
|
5104
|
+
|
5105
|
+
```ruby
|
5106
|
+
require 'time'
|
5107
|
+
require 'finnhub_ruby'
|
5108
|
+
# setup authorization
|
5109
|
+
FinnhubRuby.configure do |config|
|
5110
|
+
# Configure API key authorization: api_key
|
5111
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
5112
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
5113
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
5114
|
+
end
|
5115
|
+
|
5116
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
5117
|
+
symbol = 'symbol_example' # String | Symbol.
|
5118
|
+
from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>. Filter on the <code>beginDate</code> column.
|
5119
|
+
to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>. Filter on the <code>beginDate</code> column.
|
5120
|
+
|
5121
|
+
begin
|
5122
|
+
# H1-B Visa Application
|
5123
|
+
result = api_instance.stock_visa_application(symbol, from, to)
|
5124
|
+
p result
|
5125
|
+
rescue FinnhubRuby::ApiError => e
|
5126
|
+
puts "Error when calling DefaultApi->stock_visa_application: #{e}"
|
5127
|
+
end
|
5128
|
+
```
|
5129
|
+
|
5130
|
+
#### Using the stock_visa_application_with_http_info variant
|
5131
|
+
|
5132
|
+
This returns an Array which contains the response data, status code and headers.
|
5133
|
+
|
5134
|
+
> <Array(<VisaApplicationResult>, Integer, Hash)> stock_visa_application_with_http_info(symbol, from, to)
|
5135
|
+
|
5136
|
+
```ruby
|
5137
|
+
begin
|
5138
|
+
# H1-B Visa Application
|
5139
|
+
data, status_code, headers = api_instance.stock_visa_application_with_http_info(symbol, from, to)
|
5140
|
+
p status_code # => 2xx
|
5141
|
+
p headers # => { ... }
|
5142
|
+
p data # => <VisaApplicationResult>
|
5143
|
+
rescue FinnhubRuby::ApiError => e
|
5144
|
+
puts "Error when calling DefaultApi->stock_visa_application_with_http_info: #{e}"
|
5145
|
+
end
|
5146
|
+
```
|
5147
|
+
|
5148
|
+
### Parameters
|
5149
|
+
|
5150
|
+
| Name | Type | Description | Notes |
|
5151
|
+
| ---- | ---- | ----------- | ----- |
|
5152
|
+
| **symbol** | **String** | Symbol. | |
|
5153
|
+
| **from** | **Date** | From date <code>YYYY-MM-DD</code>. Filter on the <code>beginDate</code> column. | |
|
5154
|
+
| **to** | **Date** | To date <code>YYYY-MM-DD</code>. Filter on the <code>beginDate</code> column. | |
|
5155
|
+
|
5156
|
+
### Return type
|
5157
|
+
|
5158
|
+
[**VisaApplicationResult**](VisaApplicationResult.md)
|
5159
|
+
|
5160
|
+
### Authorization
|
5161
|
+
|
5162
|
+
[api_key](../README.md#api_key)
|
5163
|
+
|
5164
|
+
### HTTP request headers
|
5165
|
+
|
5166
|
+
- **Content-Type**: Not defined
|
5167
|
+
- **Accept**: application/json
|
5168
|
+
|
5169
|
+
|
4785
5170
|
## supply_chain_relationships
|
4786
5171
|
|
4787
5172
|
> <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
|
+
|