finnhub_ruby 1.1.18 → 1.1.19
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/BondTickData.md +6 -0
- data/docs/BondYieldCurve.md +20 -0
- data/docs/BondYieldCurveInfo.md +20 -0
- data/docs/CompanyProfile.md +5 -1
- data/docs/CongressionalTrading.md +20 -0
- data/docs/CongressionalTransaction.md +36 -0
- data/docs/DefaultApi.md +312 -92
- data/docs/Dividends.md +3 -1
- data/docs/DocumentResponse.md +28 -0
- data/docs/ETFHoldingsData.md +3 -1
- data/docs/EarningResult.md +5 -1
- data/docs/ExcerptResponse.md +24 -0
- data/docs/FilingResponse.md +42 -0
- data/docs/InFilingResponse.md +44 -0
- data/docs/InFilingSearchBody.md +20 -0
- data/docs/MutualFundEet.md +20 -0
- data/docs/MutualFundEetPai.md +20 -0
- data/docs/MutualFundHoldingsData.md +3 -1
- data/docs/PriceMetrics.md +2 -0
- data/docs/SearchBody.md +60 -0
- data/docs/SearchFilter.md +20 -0
- data/docs/SearchResponse.md +24 -0
- data/finnhub_ruby-1.1.18.gem +0 -0
- data/lib/finnhub_ruby/api/default_api.rb +296 -86
- data/lib/finnhub_ruby/models/bond_tick_data.rb +37 -1
- data/lib/finnhub_ruby/models/bond_yield_curve.rb +231 -0
- data/lib/finnhub_ruby/models/bond_yield_curve_info.rb +229 -0
- data/lib/finnhub_ruby/models/company_profile.rb +22 -2
- data/lib/finnhub_ruby/models/congressional_trading.rb +231 -0
- data/lib/finnhub_ruby/models/congressional_transaction.rb +309 -0
- data/lib/finnhub_ruby/models/dividends.rb +14 -4
- data/lib/finnhub_ruby/models/document_response.rb +271 -0
- data/lib/finnhub_ruby/models/earning_result.rb +24 -4
- data/lib/finnhub_ruby/models/etf_holdings_data.rb +14 -4
- data/lib/finnhub_ruby/models/excerpt_response.rb +249 -0
- data/lib/finnhub_ruby/models/filing_response.rb +339 -0
- data/lib/finnhub_ruby/models/in_filing_response.rb +351 -0
- data/lib/finnhub_ruby/models/in_filing_search_body.rb +239 -0
- data/lib/finnhub_ruby/models/mutual_fund_eet.rb +228 -0
- data/lib/finnhub_ruby/models/mutual_fund_eet_pai.rb +228 -0
- data/lib/finnhub_ruby/models/mutual_fund_holdings_data.rb +14 -4
- data/lib/finnhub_ruby/models/price_metrics.rb +11 -1
- data/lib/finnhub_ruby/models/search_body.rb +434 -0
- data/lib/finnhub_ruby/models/search_filter.rb +229 -0
- data/lib/finnhub_ruby/models/search_response.rb +251 -0
- data/lib/finnhub_ruby/version.rb +1 -1
- data/lib/finnhub_ruby.rb +14 -0
- data/spec/models/bond_yield_curve_info_spec.rb +40 -0
- data/spec/models/bond_yield_curve_spec.rb +40 -0
- data/spec/models/congressional_trading_spec.rb +40 -0
- data/spec/models/congressional_transaction_spec.rb +88 -0
- data/spec/models/document_response_spec.rb +64 -0
- data/spec/models/excerpt_response_spec.rb +52 -0
- data/spec/models/filing_response_spec.rb +106 -0
- data/spec/models/in_filing_response_spec.rb +112 -0
- data/spec/models/in_filing_search_body_spec.rb +40 -0
- data/spec/models/mutual_fund_eet_pai_spec.rb +40 -0
- data/spec/models/mutual_fund_eet_spec.rb +40 -0
- data/spec/models/search_body_spec.rb +160 -0
- data/spec/models/search_filter_spec.rb +40 -0
- data/spec/models/search_response_spec.rb +52 -0
- metadata +60 -3
data/docs/DefaultApi.md
CHANGED
@@ -8,6 +8,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
8
8
|
| [**bond_price**](DefaultApi.md#bond_price) | **GET** /bond/price | Bond price data |
|
9
9
|
| [**bond_profile**](DefaultApi.md#bond_profile) | **GET** /bond/profile | Bond Profile |
|
10
10
|
| [**bond_tick**](DefaultApi.md#bond_tick) | **GET** /bond/tick | Bond Tick Data |
|
11
|
+
| [**bond_yield_curve**](DefaultApi.md#bond_yield_curve) | **GET** /bond/yield-curve | Bond Yield Curve |
|
11
12
|
| [**company_basic_financials**](DefaultApi.md#company_basic_financials) | **GET** /stock/metric | Basic Financials |
|
12
13
|
| [**company_earnings**](DefaultApi.md#company_earnings) | **GET** /stock/earnings | Earnings Surprises |
|
13
14
|
| [**company_earnings_quality_score**](DefaultApi.md#company_earnings_quality_score) | **GET** /stock/earnings-quality-score | Company Earnings Quality Score |
|
@@ -21,6 +22,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
21
22
|
| [**company_profile**](DefaultApi.md#company_profile) | **GET** /stock/profile | Company Profile |
|
22
23
|
| [**company_profile2**](DefaultApi.md#company_profile2) | **GET** /stock/profile2 | Company Profile 2 |
|
23
24
|
| [**company_revenue_estimates**](DefaultApi.md#company_revenue_estimates) | **GET** /stock/revenue-estimate | Revenue Estimates |
|
25
|
+
| [**congressional_trading**](DefaultApi.md#congressional_trading) | **GET** /stock/congressional-trading | Congressional Trading |
|
24
26
|
| [**country**](DefaultApi.md#country) | **GET** /country | Country Metadata |
|
25
27
|
| [**covid19**](DefaultApi.md#covid19) | **GET** /covid19/us | COVID-19 |
|
26
28
|
| [**crypto_candles**](DefaultApi.md#crypto_candles) | **GET** /crypto/candle | Crypto Candles |
|
@@ -52,12 +54,13 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
52
54
|
| [**institutional_ownership**](DefaultApi.md#institutional_ownership) | **GET** /institutional/ownership | Institutional Ownership |
|
53
55
|
| [**institutional_portfolio**](DefaultApi.md#institutional_portfolio) | **GET** /institutional/portfolio | Institutional Portfolio |
|
54
56
|
| [**institutional_profile**](DefaultApi.md#institutional_profile) | **GET** /institutional/profile | Institutional Profile |
|
55
|
-
| [**international_filings**](DefaultApi.md#international_filings) | **GET** /stock/international-filings | International Filings |
|
56
57
|
| [**investment_themes**](DefaultApi.md#investment_themes) | **GET** /stock/investment-theme | Investment Themes (Thematic Investing) |
|
57
58
|
| [**ipo_calendar**](DefaultApi.md#ipo_calendar) | **GET** /calendar/ipo | IPO Calendar |
|
58
59
|
| [**isin_change**](DefaultApi.md#isin_change) | **GET** /ca/isin-change | ISIN Change |
|
59
60
|
| [**market_news**](DefaultApi.md#market_news) | **GET** /news | Market News |
|
60
61
|
| [**mutual_fund_country_exposure**](DefaultApi.md#mutual_fund_country_exposure) | **GET** /mutual-fund/country | Mutual Funds Country Exposure |
|
62
|
+
| [**mutual_fund_eet**](DefaultApi.md#mutual_fund_eet) | **GET** /mutual-fund/eet | Mutual Funds EET |
|
63
|
+
| [**mutual_fund_eet_pai**](DefaultApi.md#mutual_fund_eet_pai) | **GET** /mutual-fund/eet-pai | Mutual Funds EET PAI |
|
61
64
|
| [**mutual_fund_holdings**](DefaultApi.md#mutual_fund_holdings) | **GET** /mutual-fund/holdings | Mutual Funds Holdings |
|
62
65
|
| [**mutual_fund_profile**](DefaultApi.md#mutual_fund_profile) | **GET** /mutual-fund/profile | Mutual Funds Profile |
|
63
66
|
| [**mutual_fund_sector_exposure**](DefaultApi.md#mutual_fund_sector_exposure) | **GET** /mutual-fund/sector | Mutual Funds Sector Exposure |
|
@@ -89,7 +92,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
89
92
|
| [**support_resistance**](DefaultApi.md#support_resistance) | **GET** /scan/support-resistance | Support/Resistance |
|
90
93
|
| [**symbol_change**](DefaultApi.md#symbol_change) | **GET** /ca/symbol-change | Symbol Change |
|
91
94
|
| [**symbol_search**](DefaultApi.md#symbol_search) | **GET** /search | Symbol Lookup |
|
92
|
-
| [**technical_indicator**](DefaultApi.md#technical_indicator) | **
|
95
|
+
| [**technical_indicator**](DefaultApi.md#technical_indicator) | **GET** /indicator | Technical Indicators |
|
93
96
|
| [**transcripts**](DefaultApi.md#transcripts) | **GET** /stock/transcripts | Earnings Call Transcripts |
|
94
97
|
| [**transcripts_list**](DefaultApi.md#transcripts_list) | **GET** /stock/transcripts/list | Earnings Call Transcripts List |
|
95
98
|
| [**upgrade_downgrade**](DefaultApi.md#upgrade_downgrade) | **GET** /stock/upgrade-downgrade | Stock Upgrade/Downgrade |
|
@@ -101,7 +104,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
101
104
|
|
102
105
|
Aggregate Indicators
|
103
106
|
|
104
|
-
Get aggregate signal of multiple technical indicators such as MACD, RSI, Moving Average v.v.
|
107
|
+
Get aggregate signal of multiple technical indicators such as MACD, RSI, Moving Average v.v. A full list of indicators can be found <a href=\"https://docs.google.com/spreadsheets/d/1MWuy0WuT2yVlxr1KbPdggVygMZtJfunDnhe-C0GEXYM/edit?usp=sharing\" target=\"_blank\">here</a>.
|
105
108
|
|
106
109
|
### Examples
|
107
110
|
|
@@ -249,7 +252,7 @@ end
|
|
249
252
|
|
250
253
|
Bond Profile
|
251
254
|
|
252
|
-
Get general information of a bond. You can query by FIGI, ISIN or CUSIP
|
255
|
+
Get general information of a bond. You can query by FIGI, ISIN or CUSIP. A list of supported bonds can be found <a href=\"/api/v1/bond/list?token=\" target=\"_blank\">here</a>.
|
253
256
|
|
254
257
|
### Examples
|
255
258
|
|
@@ -399,6 +402,77 @@ end
|
|
399
402
|
- **Accept**: application/json
|
400
403
|
|
401
404
|
|
405
|
+
## bond_yield_curve
|
406
|
+
|
407
|
+
> <BondYieldCurve> bond_yield_curve(code)
|
408
|
+
|
409
|
+
Bond Yield Curve
|
410
|
+
|
411
|
+
Get yield curve data for Treasury bonds.
|
412
|
+
|
413
|
+
### Examples
|
414
|
+
|
415
|
+
```ruby
|
416
|
+
require 'time'
|
417
|
+
require 'finnhub_ruby'
|
418
|
+
# setup authorization
|
419
|
+
FinnhubRuby.configure do |config|
|
420
|
+
# Configure API key authorization: api_key
|
421
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
422
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
423
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
424
|
+
end
|
425
|
+
|
426
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
427
|
+
code = 'code_example' # String | Bond's code. You can find the list of supported code <a href=\"https://docs.google.com/spreadsheets/d/1iA-lM0Kht7lsQZ7Uu_s6r2i1BbQNUNO9eGkO5-zglHg/edit?usp=sharing\" target=\"_blank\" rel=\"noopener\">here</a>.
|
428
|
+
|
429
|
+
begin
|
430
|
+
# Bond Yield Curve
|
431
|
+
result = api_instance.bond_yield_curve(code)
|
432
|
+
p result
|
433
|
+
rescue FinnhubRuby::ApiError => e
|
434
|
+
puts "Error when calling DefaultApi->bond_yield_curve: #{e}"
|
435
|
+
end
|
436
|
+
```
|
437
|
+
|
438
|
+
#### Using the bond_yield_curve_with_http_info variant
|
439
|
+
|
440
|
+
This returns an Array which contains the response data, status code and headers.
|
441
|
+
|
442
|
+
> <Array(<BondYieldCurve>, Integer, Hash)> bond_yield_curve_with_http_info(code)
|
443
|
+
|
444
|
+
```ruby
|
445
|
+
begin
|
446
|
+
# Bond Yield Curve
|
447
|
+
data, status_code, headers = api_instance.bond_yield_curve_with_http_info(code)
|
448
|
+
p status_code # => 2xx
|
449
|
+
p headers # => { ... }
|
450
|
+
p data # => <BondYieldCurve>
|
451
|
+
rescue FinnhubRuby::ApiError => e
|
452
|
+
puts "Error when calling DefaultApi->bond_yield_curve_with_http_info: #{e}"
|
453
|
+
end
|
454
|
+
```
|
455
|
+
|
456
|
+
### Parameters
|
457
|
+
|
458
|
+
| Name | Type | Description | Notes |
|
459
|
+
| ---- | ---- | ----------- | ----- |
|
460
|
+
| **code** | **String** | Bond's code. You can find the list of supported code <a href=\"https://docs.google.com/spreadsheets/d/1iA-lM0Kht7lsQZ7Uu_s6r2i1BbQNUNO9eGkO5-zglHg/edit?usp=sharing\" target=\"_blank\" rel=\"noopener\">here</a>. | |
|
461
|
+
|
462
|
+
### Return type
|
463
|
+
|
464
|
+
[**BondYieldCurve**](BondYieldCurve.md)
|
465
|
+
|
466
|
+
### Authorization
|
467
|
+
|
468
|
+
[api_key](../README.md#api_key)
|
469
|
+
|
470
|
+
### HTTP request headers
|
471
|
+
|
472
|
+
- **Content-Type**: Not defined
|
473
|
+
- **Accept**: application/json
|
474
|
+
|
475
|
+
|
402
476
|
## company_basic_financials
|
403
477
|
|
404
478
|
> <BasicFinancials> company_basic_financials(symbol, metric)
|
@@ -1366,6 +1440,81 @@ end
|
|
1366
1440
|
- **Accept**: application/json
|
1367
1441
|
|
1368
1442
|
|
1443
|
+
## congressional_trading
|
1444
|
+
|
1445
|
+
> <CongressionalTrading> congressional_trading(symbol, from, to)
|
1446
|
+
|
1447
|
+
Congressional Trading
|
1448
|
+
|
1449
|
+
Get stock trades data disclosed by members of congress.
|
1450
|
+
|
1451
|
+
### Examples
|
1452
|
+
|
1453
|
+
```ruby
|
1454
|
+
require 'time'
|
1455
|
+
require 'finnhub_ruby'
|
1456
|
+
# setup authorization
|
1457
|
+
FinnhubRuby.configure do |config|
|
1458
|
+
# Configure API key authorization: api_key
|
1459
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1460
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1461
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
1462
|
+
end
|
1463
|
+
|
1464
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
1465
|
+
symbol = 'symbol_example' # String | Symbol of the company: AAPL.
|
1466
|
+
from = Date.parse('2013-10-20') # Date | From date <code>YYYY-MM-DD</code>.
|
1467
|
+
to = Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>.
|
1468
|
+
|
1469
|
+
begin
|
1470
|
+
# Congressional Trading
|
1471
|
+
result = api_instance.congressional_trading(symbol, from, to)
|
1472
|
+
p result
|
1473
|
+
rescue FinnhubRuby::ApiError => e
|
1474
|
+
puts "Error when calling DefaultApi->congressional_trading: #{e}"
|
1475
|
+
end
|
1476
|
+
```
|
1477
|
+
|
1478
|
+
#### Using the congressional_trading_with_http_info variant
|
1479
|
+
|
1480
|
+
This returns an Array which contains the response data, status code and headers.
|
1481
|
+
|
1482
|
+
> <Array(<CongressionalTrading>, Integer, Hash)> congressional_trading_with_http_info(symbol, from, to)
|
1483
|
+
|
1484
|
+
```ruby
|
1485
|
+
begin
|
1486
|
+
# Congressional Trading
|
1487
|
+
data, status_code, headers = api_instance.congressional_trading_with_http_info(symbol, from, to)
|
1488
|
+
p status_code # => 2xx
|
1489
|
+
p headers # => { ... }
|
1490
|
+
p data # => <CongressionalTrading>
|
1491
|
+
rescue FinnhubRuby::ApiError => e
|
1492
|
+
puts "Error when calling DefaultApi->congressional_trading_with_http_info: #{e}"
|
1493
|
+
end
|
1494
|
+
```
|
1495
|
+
|
1496
|
+
### Parameters
|
1497
|
+
|
1498
|
+
| Name | Type | Description | Notes |
|
1499
|
+
| ---- | ---- | ----------- | ----- |
|
1500
|
+
| **symbol** | **String** | Symbol of the company: AAPL. | |
|
1501
|
+
| **from** | **Date** | From date <code>YYYY-MM-DD</code>. | |
|
1502
|
+
| **to** | **Date** | To date <code>YYYY-MM-DD</code>. | |
|
1503
|
+
|
1504
|
+
### Return type
|
1505
|
+
|
1506
|
+
[**CongressionalTrading**](CongressionalTrading.md)
|
1507
|
+
|
1508
|
+
### Authorization
|
1509
|
+
|
1510
|
+
[api_key](../README.md#api_key)
|
1511
|
+
|
1512
|
+
### HTTP request headers
|
1513
|
+
|
1514
|
+
- **Content-Type**: Not defined
|
1515
|
+
- **Accept**: application/json
|
1516
|
+
|
1517
|
+
|
1369
1518
|
## country
|
1370
1519
|
|
1371
1520
|
> <Array<CountryMetadata>> country
|
@@ -2159,7 +2308,7 @@ end
|
|
2159
2308
|
|
2160
2309
|
ETFs Holdings
|
2161
2310
|
|
2162
|
-
Get full ETF holdings/constituents. This endpoint has global coverage. Widget only shows top 10 holdings.
|
2311
|
+
Get full ETF holdings/constituents. This endpoint has global coverage. Widget only shows top 10 holdings. A list of supported ETFs can be found <a href=\"/api/v1/etf/list?token=\" target=\"_blank\">here</a>.
|
2163
2312
|
|
2164
2313
|
### Examples
|
2165
2314
|
|
@@ -2238,7 +2387,7 @@ end
|
|
2238
2387
|
|
2239
2388
|
ETFs Profile
|
2240
2389
|
|
2241
|
-
Get ETF profile information. This endpoint has global coverage.
|
2390
|
+
Get ETF profile information. This endpoint has global coverage. A list of supported ETFs can be found <a href=\"/api/v1/etf/list?token=\" target=\"_blank\">here</a>.
|
2242
2391
|
|
2243
2392
|
### Examples
|
2244
2393
|
|
@@ -3347,7 +3496,7 @@ end
|
|
3347
3496
|
|
3348
3497
|
Insider Transactions
|
3349
3498
|
|
3350
|
-
Company insider transactions data sourced from <code>Form 3,4,5</code
|
3499
|
+
Company insider transactions data sourced from <code>Form 3,4,5</code>, SEDI and relevant companies' filings. This endpoint covers US, Canada, Australia, and selected EU companies. Limit to 100 transactions per API call.
|
3351
3500
|
|
3352
3501
|
### Examples
|
3353
3502
|
|
@@ -3501,7 +3650,7 @@ end
|
|
3501
3650
|
|
3502
3651
|
Institutional Portfolio
|
3503
3652
|
|
3504
|
-
Get the holdings/portfolio data of institutional investors from 13-F filings. Limit to 1 year of data at a time.
|
3653
|
+
Get the holdings/portfolio data of institutional investors from 13-F filings. Limit to 1 year of data at a time. You can get a list of supported CIK <a href=\"/api/v1/institutional/list?token=\" target=\"_blank\">here</a>.
|
3505
3654
|
|
3506
3655
|
### Examples
|
3507
3656
|
|
@@ -3643,81 +3792,6 @@ end
|
|
3643
3792
|
- **Accept**: application/json
|
3644
3793
|
|
3645
3794
|
|
3646
|
-
## international_filings
|
3647
|
-
|
3648
|
-
> <Array<InternationalFiling>> international_filings(opts)
|
3649
|
-
|
3650
|
-
International Filings
|
3651
|
-
|
3652
|
-
List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data. Only support SEDAR and UK Companies House for normal usage. Enterprise clients who need access to the full filings for global markets should contact us for the access.
|
3653
|
-
|
3654
|
-
### Examples
|
3655
|
-
|
3656
|
-
```ruby
|
3657
|
-
require 'time'
|
3658
|
-
require 'finnhub_ruby'
|
3659
|
-
# setup authorization
|
3660
|
-
FinnhubRuby.configure do |config|
|
3661
|
-
# Configure API key authorization: api_key
|
3662
|
-
config.api_key['api_key'] = 'YOUR API KEY'
|
3663
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3664
|
-
# config.api_key_prefix['api_key'] = 'Bearer'
|
3665
|
-
end
|
3666
|
-
|
3667
|
-
api_instance = FinnhubRuby::DefaultApi.new
|
3668
|
-
opts = {
|
3669
|
-
symbol: 'symbol_example', # String | Symbol. Leave empty to list latest filings.
|
3670
|
-
country: 'country_example' # String | Filter by country using country's 2-letter code.
|
3671
|
-
}
|
3672
|
-
|
3673
|
-
begin
|
3674
|
-
# International Filings
|
3675
|
-
result = api_instance.international_filings(opts)
|
3676
|
-
p result
|
3677
|
-
rescue FinnhubRuby::ApiError => e
|
3678
|
-
puts "Error when calling DefaultApi->international_filings: #{e}"
|
3679
|
-
end
|
3680
|
-
```
|
3681
|
-
|
3682
|
-
#### Using the international_filings_with_http_info variant
|
3683
|
-
|
3684
|
-
This returns an Array which contains the response data, status code and headers.
|
3685
|
-
|
3686
|
-
> <Array(<Array<InternationalFiling>>, Integer, Hash)> international_filings_with_http_info(opts)
|
3687
|
-
|
3688
|
-
```ruby
|
3689
|
-
begin
|
3690
|
-
# International Filings
|
3691
|
-
data, status_code, headers = api_instance.international_filings_with_http_info(opts)
|
3692
|
-
p status_code # => 2xx
|
3693
|
-
p headers # => { ... }
|
3694
|
-
p data # => <Array<InternationalFiling>>
|
3695
|
-
rescue FinnhubRuby::ApiError => e
|
3696
|
-
puts "Error when calling DefaultApi->international_filings_with_http_info: #{e}"
|
3697
|
-
end
|
3698
|
-
```
|
3699
|
-
|
3700
|
-
### Parameters
|
3701
|
-
|
3702
|
-
| Name | Type | Description | Notes |
|
3703
|
-
| ---- | ---- | ----------- | ----- |
|
3704
|
-
| **symbol** | **String** | Symbol. Leave empty to list latest filings. | [optional] |
|
3705
|
-
| **country** | **String** | Filter by country using country's 2-letter code. | [optional] |
|
3706
|
-
|
3707
|
-
### Return type
|
3708
|
-
|
3709
|
-
[**Array<InternationalFiling>**](InternationalFiling.md)
|
3710
|
-
|
3711
|
-
### Authorization
|
3712
|
-
|
3713
|
-
[api_key](../README.md#api_key)
|
3714
|
-
|
3715
|
-
### HTTP request headers
|
3716
|
-
|
3717
|
-
- **Content-Type**: Not defined
|
3718
|
-
- **Accept**: application/json
|
3719
|
-
|
3720
|
-
|
3721
3795
|
## investment_themes
|
3722
3796
|
|
3723
3797
|
> <InvestmentThemes> investment_themes(theme)
|
@@ -4081,13 +4155,155 @@ end
|
|
4081
4155
|
- **Accept**: application/json
|
4082
4156
|
|
4083
4157
|
|
4158
|
+
## mutual_fund_eet
|
4159
|
+
|
4160
|
+
> <MutualFundEet> mutual_fund_eet(isin)
|
4161
|
+
|
4162
|
+
Mutual Funds EET
|
4163
|
+
|
4164
|
+
Get EET data for EU funds. For PAIs data, please see the EET PAI endpoint.
|
4165
|
+
|
4166
|
+
### Examples
|
4167
|
+
|
4168
|
+
```ruby
|
4169
|
+
require 'time'
|
4170
|
+
require 'finnhub_ruby'
|
4171
|
+
# setup authorization
|
4172
|
+
FinnhubRuby.configure do |config|
|
4173
|
+
# Configure API key authorization: api_key
|
4174
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
4175
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4176
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
4177
|
+
end
|
4178
|
+
|
4179
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
4180
|
+
isin = 'isin_example' # String | ISIN.
|
4181
|
+
|
4182
|
+
begin
|
4183
|
+
# Mutual Funds EET
|
4184
|
+
result = api_instance.mutual_fund_eet(isin)
|
4185
|
+
p result
|
4186
|
+
rescue FinnhubRuby::ApiError => e
|
4187
|
+
puts "Error when calling DefaultApi->mutual_fund_eet: #{e}"
|
4188
|
+
end
|
4189
|
+
```
|
4190
|
+
|
4191
|
+
#### Using the mutual_fund_eet_with_http_info variant
|
4192
|
+
|
4193
|
+
This returns an Array which contains the response data, status code and headers.
|
4194
|
+
|
4195
|
+
> <Array(<MutualFundEet>, Integer, Hash)> mutual_fund_eet_with_http_info(isin)
|
4196
|
+
|
4197
|
+
```ruby
|
4198
|
+
begin
|
4199
|
+
# Mutual Funds EET
|
4200
|
+
data, status_code, headers = api_instance.mutual_fund_eet_with_http_info(isin)
|
4201
|
+
p status_code # => 2xx
|
4202
|
+
p headers # => { ... }
|
4203
|
+
p data # => <MutualFundEet>
|
4204
|
+
rescue FinnhubRuby::ApiError => e
|
4205
|
+
puts "Error when calling DefaultApi->mutual_fund_eet_with_http_info: #{e}"
|
4206
|
+
end
|
4207
|
+
```
|
4208
|
+
|
4209
|
+
### Parameters
|
4210
|
+
|
4211
|
+
| Name | Type | Description | Notes |
|
4212
|
+
| ---- | ---- | ----------- | ----- |
|
4213
|
+
| **isin** | **String** | ISIN. | |
|
4214
|
+
|
4215
|
+
### Return type
|
4216
|
+
|
4217
|
+
[**MutualFundEet**](MutualFundEet.md)
|
4218
|
+
|
4219
|
+
### Authorization
|
4220
|
+
|
4221
|
+
[api_key](../README.md#api_key)
|
4222
|
+
|
4223
|
+
### HTTP request headers
|
4224
|
+
|
4225
|
+
- **Content-Type**: Not defined
|
4226
|
+
- **Accept**: application/json
|
4227
|
+
|
4228
|
+
|
4229
|
+
## mutual_fund_eet_pai
|
4230
|
+
|
4231
|
+
> <MutualFundEetPai> mutual_fund_eet_pai(isin)
|
4232
|
+
|
4233
|
+
Mutual Funds EET PAI
|
4234
|
+
|
4235
|
+
Get EET PAI data for EU funds.
|
4236
|
+
|
4237
|
+
### Examples
|
4238
|
+
|
4239
|
+
```ruby
|
4240
|
+
require 'time'
|
4241
|
+
require 'finnhub_ruby'
|
4242
|
+
# setup authorization
|
4243
|
+
FinnhubRuby.configure do |config|
|
4244
|
+
# Configure API key authorization: api_key
|
4245
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
4246
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4247
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
4248
|
+
end
|
4249
|
+
|
4250
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
4251
|
+
isin = 'isin_example' # String | ISIN.
|
4252
|
+
|
4253
|
+
begin
|
4254
|
+
# Mutual Funds EET PAI
|
4255
|
+
result = api_instance.mutual_fund_eet_pai(isin)
|
4256
|
+
p result
|
4257
|
+
rescue FinnhubRuby::ApiError => e
|
4258
|
+
puts "Error when calling DefaultApi->mutual_fund_eet_pai: #{e}"
|
4259
|
+
end
|
4260
|
+
```
|
4261
|
+
|
4262
|
+
#### Using the mutual_fund_eet_pai_with_http_info variant
|
4263
|
+
|
4264
|
+
This returns an Array which contains the response data, status code and headers.
|
4265
|
+
|
4266
|
+
> <Array(<MutualFundEetPai>, Integer, Hash)> mutual_fund_eet_pai_with_http_info(isin)
|
4267
|
+
|
4268
|
+
```ruby
|
4269
|
+
begin
|
4270
|
+
# Mutual Funds EET PAI
|
4271
|
+
data, status_code, headers = api_instance.mutual_fund_eet_pai_with_http_info(isin)
|
4272
|
+
p status_code # => 2xx
|
4273
|
+
p headers # => { ... }
|
4274
|
+
p data # => <MutualFundEetPai>
|
4275
|
+
rescue FinnhubRuby::ApiError => e
|
4276
|
+
puts "Error when calling DefaultApi->mutual_fund_eet_pai_with_http_info: #{e}"
|
4277
|
+
end
|
4278
|
+
```
|
4279
|
+
|
4280
|
+
### Parameters
|
4281
|
+
|
4282
|
+
| Name | Type | Description | Notes |
|
4283
|
+
| ---- | ---- | ----------- | ----- |
|
4284
|
+
| **isin** | **String** | ISIN. | |
|
4285
|
+
|
4286
|
+
### Return type
|
4287
|
+
|
4288
|
+
[**MutualFundEetPai**](MutualFundEetPai.md)
|
4289
|
+
|
4290
|
+
### Authorization
|
4291
|
+
|
4292
|
+
[api_key](../README.md#api_key)
|
4293
|
+
|
4294
|
+
### HTTP request headers
|
4295
|
+
|
4296
|
+
- **Content-Type**: Not defined
|
4297
|
+
- **Accept**: application/json
|
4298
|
+
|
4299
|
+
|
4084
4300
|
## mutual_fund_holdings
|
4085
4301
|
|
4086
4302
|
> <MutualFundHoldings> mutual_fund_holdings(opts)
|
4087
4303
|
|
4088
4304
|
Mutual Funds Holdings
|
4089
4305
|
|
4090
|
-
Get full Mutual Funds holdings/constituents. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN.
|
4306
|
+
Get full Mutual Funds holdings/constituents. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN. A list of supported funds can be found <a href=\"/api/v1/mutual-fund/list?token=\" target=\"_blank\">here</a>.
|
4091
4307
|
|
4092
4308
|
### Examples
|
4093
4309
|
|
@@ -4164,7 +4380,7 @@ end
|
|
4164
4380
|
|
4165
4381
|
Mutual Funds Profile
|
4166
4382
|
|
4167
|
-
Get mutual funds profile information. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN.
|
4383
|
+
Get mutual funds profile information. This endpoint covers both US and global mutual funds. For international funds, you must query the data using ISIN. A list of supported funds can be found <a href=\"/api/v1/mutual-fund/list?token=\" target=\"_blank\">here</a>.
|
4168
4384
|
|
4169
4385
|
### Examples
|
4170
4386
|
|
@@ -4602,7 +4818,7 @@ end
|
|
4602
4818
|
|
4603
4819
|
## price_metrics
|
4604
4820
|
|
4605
|
-
> <PriceMetrics> price_metrics(symbol)
|
4821
|
+
> <PriceMetrics> price_metrics(symbol, opts)
|
4606
4822
|
|
4607
4823
|
Price Metrics
|
4608
4824
|
|
@@ -4623,10 +4839,13 @@ end
|
|
4623
4839
|
|
4624
4840
|
api_instance = FinnhubRuby::DefaultApi.new
|
4625
4841
|
symbol = 'symbol_example' # String | Symbol of the company: AAPL.
|
4842
|
+
opts = {
|
4843
|
+
date: 'date_example' # String | Get data on a specific date in the past. The data is available weekly so your date will be automatically adjusted to the last day of that week.
|
4844
|
+
}
|
4626
4845
|
|
4627
4846
|
begin
|
4628
4847
|
# Price Metrics
|
4629
|
-
result = api_instance.price_metrics(symbol)
|
4848
|
+
result = api_instance.price_metrics(symbol, opts)
|
4630
4849
|
p result
|
4631
4850
|
rescue FinnhubRuby::ApiError => e
|
4632
4851
|
puts "Error when calling DefaultApi->price_metrics: #{e}"
|
@@ -4637,12 +4856,12 @@ end
|
|
4637
4856
|
|
4638
4857
|
This returns an Array which contains the response data, status code and headers.
|
4639
4858
|
|
4640
|
-
> <Array(<PriceMetrics>, Integer, Hash)> price_metrics_with_http_info(symbol)
|
4859
|
+
> <Array(<PriceMetrics>, Integer, Hash)> price_metrics_with_http_info(symbol, opts)
|
4641
4860
|
|
4642
4861
|
```ruby
|
4643
4862
|
begin
|
4644
4863
|
# Price Metrics
|
4645
|
-
data, status_code, headers = api_instance.price_metrics_with_http_info(symbol)
|
4864
|
+
data, status_code, headers = api_instance.price_metrics_with_http_info(symbol, opts)
|
4646
4865
|
p status_code # => 2xx
|
4647
4866
|
p headers # => { ... }
|
4648
4867
|
p data # => <PriceMetrics>
|
@@ -4656,6 +4875,7 @@ end
|
|
4656
4875
|
| Name | Type | Description | Notes |
|
4657
4876
|
| ---- | ---- | ----------- | ----- |
|
4658
4877
|
| **symbol** | **String** | Symbol of the company: AAPL. | |
|
4878
|
+
| **date** | **String** | Get data on a specific date in the past. The data is available weekly so your date will be automatically adjusted to the last day of that week. | [optional] |
|
4659
4879
|
|
4660
4880
|
### Return type
|
4661
4881
|
|
@@ -5790,7 +6010,7 @@ end
|
|
5790
6010
|
|
5791
6011
|
Tick Data
|
5792
6012
|
|
5793
|
-
<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>
|
6013
|
+
<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>End-of-day</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> </tbody> </table>
|
5794
6014
|
|
5795
6015
|
### Examples
|
5796
6016
|
|
@@ -6236,7 +6456,7 @@ end
|
|
6236
6456
|
|
6237
6457
|
Symbol Change
|
6238
6458
|
|
6239
|
-
Get a list of symbol changes for US-listed
|
6459
|
+
Get a list of symbol changes for US-listed, EU-listed, NSE and ASX securities. Limit to 2000 events at a time.
|
6240
6460
|
|
6241
6461
|
### Examples
|
6242
6462
|
|
@@ -6463,7 +6683,7 @@ end
|
|
6463
6683
|
|
6464
6684
|
Earnings Call Transcripts
|
6465
6685
|
|
6466
|
-
<p>Get earnings call transcripts, audio and participants' list.
|
6686
|
+
<p>Get earnings call transcripts, audio and participants' list. Data is available for US, UK, European, Australian and Canadian companies.<p>15+ years of data is available with 220,000+ audio which add up to 7TB in size.</p>
|
6467
6687
|
|
6468
6688
|
### Examples
|
6469
6689
|
|
data/docs/Dividends.md
CHANGED
@@ -12,6 +12,7 @@
|
|
12
12
|
| **record_date** | **Date** | Record date. | [optional] |
|
13
13
|
| **declaration_date** | **Date** | Declaration date. | [optional] |
|
14
14
|
| **currency** | **String** | Currency. | [optional] |
|
15
|
+
| **freq** | **String** | <p>Dividend frequency. Can be 1 of the following values:</p><ul> <li><code>0: Annually</code></li> <li><code>1: Monthly</code></li> <li><code>2: Quarterly</code></li> <li><code>3: Semi-annually</code></li> <li><code>4: Other/Unknown</code></li> <li><code>5: Bimonthly</code></li> <li><code>6: Trimesterly</code></li> <li><code>7: Weekly</code></li> </ul> | [optional] |
|
15
16
|
|
16
17
|
## Example
|
17
18
|
|
@@ -26,7 +27,8 @@ instance = FinnhubRuby::Dividends.new(
|
|
26
27
|
pay_date: null,
|
27
28
|
record_date: null,
|
28
29
|
declaration_date: null,
|
29
|
-
currency: null
|
30
|
+
currency: null,
|
31
|
+
freq: null
|
30
32
|
)
|
31
33
|
```
|
32
34
|
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# FinnhubRuby::DocumentResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **document_id** | **String** | AlphaResearch internal document id. | [optional] |
|
8
|
+
| **title** | **String** | Title for this document. | [optional] |
|
9
|
+
| **hits** | **String** | Number of hit in this document | [optional] |
|
10
|
+
| **url** | **String** | Link to render this document | [optional] |
|
11
|
+
| **format** | **String** | Format of this document (can be html or pdf) | [optional] |
|
12
|
+
| **excerpts** | [**Array<ExcerptResponse>**](ExcerptResponse.md) | Highlighted excerpts for this document | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'finnhub_ruby'
|
18
|
+
|
19
|
+
instance = FinnhubRuby::DocumentResponse.new(
|
20
|
+
document_id: null,
|
21
|
+
title: null,
|
22
|
+
hits: null,
|
23
|
+
url: null,
|
24
|
+
format: null,
|
25
|
+
excerpts: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
data/docs/ETFHoldingsData.md
CHANGED
@@ -11,6 +11,7 @@
|
|
11
11
|
| **share** | **Float** | Number of shares owned by the ETF. | [optional] |
|
12
12
|
| **percent** | **Float** | Portfolio's percent | [optional] |
|
13
13
|
| **value** | **Float** | Market value | [optional] |
|
14
|
+
| **asset_type** | **String** | Asset type. Can be 1 of the following values: <code>Equity</code>, <code>ETP</code>, <code>Fund</code>, <code>Bond</code>, <code>Other</code> or empty. | [optional] |
|
14
15
|
|
15
16
|
## Example
|
16
17
|
|
@@ -24,7 +25,8 @@ instance = FinnhubRuby::ETFHoldingsData.new(
|
|
24
25
|
cusip: null,
|
25
26
|
share: null,
|
26
27
|
percent: null,
|
27
|
-
value: null
|
28
|
+
value: null,
|
29
|
+
asset_type: null
|
28
30
|
)
|
29
31
|
```
|
30
32
|
|
data/docs/EarningResult.md
CHANGED
@@ -10,6 +10,8 @@
|
|
10
10
|
| **surprise_percent** | **Float** | Surprise percent. | [optional] |
|
11
11
|
| **period** | **Date** | Reported period. | [optional] |
|
12
12
|
| **symbol** | **String** | Company symbol. | [optional] |
|
13
|
+
| **year** | **Integer** | Earnings year. | [optional] |
|
14
|
+
| **quarter** | **Integer** | Earnings quarter. | [optional] |
|
13
15
|
|
14
16
|
## Example
|
15
17
|
|
@@ -22,7 +24,9 @@ instance = FinnhubRuby::EarningResult.new(
|
|
22
24
|
surprise: null,
|
23
25
|
surprise_percent: null,
|
24
26
|
period: null,
|
25
|
-
symbol: null
|
27
|
+
symbol: null,
|
28
|
+
year: null,
|
29
|
+
quarter: null
|
26
30
|
)
|
27
31
|
```
|
28
32
|
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# FinnhubRuby::ExcerptResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **content** | **String** | Highlighted content | [optional] |
|
8
|
+
| **snippet_id** | **String** | Location of the content in the rendered document | [optional] |
|
9
|
+
| **start_offset** | **String** | Start offset of highlighted content | [optional] |
|
10
|
+
| **end_offset** | **String** | End offset of highlighted content | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'finnhub_ruby'
|
16
|
+
|
17
|
+
instance = FinnhubRuby::ExcerptResponse.new(
|
18
|
+
content: null,
|
19
|
+
snippet_id: null,
|
20
|
+
start_offset: null,
|
21
|
+
end_offset: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|