finnhub_ruby 1.1.16 → 1.1.18
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 +2 -2
- data/docs/BondTickData.md +34 -0
- data/docs/Company.md +1 -1
- data/docs/DefaultApi.md +617 -9
- data/docs/ETFProfileData.md +8 -2
- data/docs/InstitutionalOwnership.md +22 -0
- data/docs/InstitutionalOwnershipGroup.md +20 -0
- data/docs/InstitutionalOwnershipInfo.md +36 -0
- data/docs/InstitutionalPortfolio.md +22 -0
- data/docs/InstitutionalPortfolioGroup.md +22 -0
- data/docs/InstitutionalPortfolioInfo.md +38 -0
- data/docs/InstitutionalProfile.md +20 -0
- data/docs/InstitutionalProfileInfo.md +28 -0
- data/docs/IsinChange.md +22 -0
- data/docs/IsinChangeInfo.md +22 -0
- data/docs/KeyCustomersSuppliers.md +4 -0
- data/docs/MutualFundProfileData.md +5 -1
- data/docs/PriceMetrics.md +20 -0
- data/docs/SectorMetric.md +20 -0
- data/docs/SectorMetricData.md +20 -0
- data/docs/SymbolChange.md +22 -0
- data/docs/SymbolChangeInfo.md +22 -0
- data/finnhub_ruby-1.1.16.gem +0 -0
- data/finnhub_ruby-1.1.17.gem +0 -0
- data/lib/finnhub_ruby/api/default_api.rb +602 -8
- data/lib/finnhub_ruby/models/bond_tick_data.rb +311 -0
- data/lib/finnhub_ruby/models/company.rb +1 -1
- data/lib/finnhub_ruby/models/etf_profile_data.rb +35 -5
- data/lib/finnhub_ruby/models/institutional_ownership.rb +241 -0
- data/lib/finnhub_ruby/models/institutional_ownership_group.rb +231 -0
- data/lib/finnhub_ruby/models/institutional_ownership_info.rb +309 -0
- data/lib/finnhub_ruby/models/institutional_portfolio.rb +241 -0
- data/lib/finnhub_ruby/models/institutional_portfolio_group.rb +241 -0
- data/lib/finnhub_ruby/models/institutional_portfolio_info.rb +319 -0
- data/lib/finnhub_ruby/models/institutional_profile.rb +231 -0
- data/lib/finnhub_ruby/models/institutional_profile_info.rb +269 -0
- data/lib/finnhub_ruby/models/isin_change.rb +241 -0
- data/lib/finnhub_ruby/models/isin_change_info.rb +239 -0
- data/lib/finnhub_ruby/models/key_customers_suppliers.rb +21 -1
- data/lib/finnhub_ruby/models/mutual_fund_profile_data.rb +24 -4
- data/lib/finnhub_ruby/models/price_metrics.rb +228 -0
- data/lib/finnhub_ruby/models/sector_metric.rb +231 -0
- data/lib/finnhub_ruby/models/sector_metric_data.rb +229 -0
- data/lib/finnhub_ruby/models/symbol_change.rb +241 -0
- data/lib/finnhub_ruby/models/symbol_change_info.rb +239 -0
- data/lib/finnhub_ruby/version.rb +1 -1
- data/lib/finnhub_ruby.rb +16 -0
- data/spec/models/bond_tick_data_spec.rb +82 -0
- data/spec/models/institutional_ownership_group_spec.rb +40 -0
- data/spec/models/institutional_ownership_info_spec.rb +88 -0
- data/spec/models/institutional_ownership_spec.rb +46 -0
- data/spec/models/institutional_portfolio_group_spec.rb +46 -0
- data/spec/models/institutional_portfolio_info_spec.rb +94 -0
- data/spec/models/institutional_portfolio_spec.rb +46 -0
- data/spec/models/institutional_profile_info_spec.rb +64 -0
- data/spec/models/institutional_profile_spec.rb +40 -0
- data/spec/models/isin_change_info_spec.rb +46 -0
- data/spec/models/isin_change_spec.rb +46 -0
- data/spec/models/price_metrics_spec.rb +40 -0
- data/spec/models/sector_metric_data_spec.rb +40 -0
- data/spec/models/sector_metric_spec.rb +40 -0
- data/spec/models/symbol_change_info_spec.rb +46 -0
- data/spec/models/symbol_change_spec.rb +46 -0
- metadata +68 -2
data/docs/DefaultApi.md
CHANGED
@@ -7,6 +7,7 @@ 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
|
| [**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
|
+
| [**bond_tick**](DefaultApi.md#bond_tick) | **GET** /bond/tick | Bond Tick Data |
|
10
11
|
| [**company_basic_financials**](DefaultApi.md#company_basic_financials) | **GET** /stock/metric | Basic Financials |
|
11
12
|
| [**company_earnings**](DefaultApi.md#company_earnings) | **GET** /stock/earnings | Earnings Surprises |
|
12
13
|
| [**company_earnings_quality_score**](DefaultApi.md#company_earnings_quality_score) | **GET** /stock/earnings-quality-score | Company Earnings Quality Score |
|
@@ -48,9 +49,13 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
48
49
|
| [**indices_historical_constituents**](DefaultApi.md#indices_historical_constituents) | **GET** /index/historical-constituents | Indices Historical Constituents |
|
49
50
|
| [**insider_sentiment**](DefaultApi.md#insider_sentiment) | **GET** /stock/insider-sentiment | Insider Sentiment |
|
50
51
|
| [**insider_transactions**](DefaultApi.md#insider_transactions) | **GET** /stock/insider-transactions | Insider Transactions |
|
52
|
+
| [**institutional_ownership**](DefaultApi.md#institutional_ownership) | **GET** /institutional/ownership | Institutional Ownership |
|
53
|
+
| [**institutional_portfolio**](DefaultApi.md#institutional_portfolio) | **GET** /institutional/portfolio | Institutional Portfolio |
|
54
|
+
| [**institutional_profile**](DefaultApi.md#institutional_profile) | **GET** /institutional/profile | Institutional Profile |
|
51
55
|
| [**international_filings**](DefaultApi.md#international_filings) | **GET** /stock/international-filings | International Filings |
|
52
56
|
| [**investment_themes**](DefaultApi.md#investment_themes) | **GET** /stock/investment-theme | Investment Themes (Thematic Investing) |
|
53
57
|
| [**ipo_calendar**](DefaultApi.md#ipo_calendar) | **GET** /calendar/ipo | IPO Calendar |
|
58
|
+
| [**isin_change**](DefaultApi.md#isin_change) | **GET** /ca/isin-change | ISIN Change |
|
54
59
|
| [**market_news**](DefaultApi.md#market_news) | **GET** /news | Market News |
|
55
60
|
| [**mutual_fund_country_exposure**](DefaultApi.md#mutual_fund_country_exposure) | **GET** /mutual-fund/country | Mutual Funds Country Exposure |
|
56
61
|
| [**mutual_fund_holdings**](DefaultApi.md#mutual_fund_holdings) | **GET** /mutual-fund/holdings | Mutual Funds Holdings |
|
@@ -60,10 +65,12 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
60
65
|
| [**ownership**](DefaultApi.md#ownership) | **GET** /stock/ownership | Ownership |
|
61
66
|
| [**pattern_recognition**](DefaultApi.md#pattern_recognition) | **GET** /scan/pattern | Pattern Recognition |
|
62
67
|
| [**press_releases**](DefaultApi.md#press_releases) | **GET** /press-releases | Major Press Releases |
|
68
|
+
| [**price_metrics**](DefaultApi.md#price_metrics) | **GET** /stock/price-metric | Price Metrics |
|
63
69
|
| [**price_target**](DefaultApi.md#price_target) | **GET** /stock/price-target | Price Target |
|
64
70
|
| [**quote**](DefaultApi.md#quote) | **GET** /quote | Quote |
|
65
71
|
| [**recommendation_trends**](DefaultApi.md#recommendation_trends) | **GET** /stock/recommendation | Recommendation Trends |
|
66
72
|
| [**revenue_breakdown**](DefaultApi.md#revenue_breakdown) | **GET** /stock/revenue-breakdown | Revenue Breakdown |
|
73
|
+
| [**sector_metric**](DefaultApi.md#sector_metric) | **GET** /sector/metrics | Sector Metrics |
|
67
74
|
| [**similarity_index**](DefaultApi.md#similarity_index) | **GET** /stock/similarity-index | Similarity Index |
|
68
75
|
| [**social_sentiment**](DefaultApi.md#social_sentiment) | **GET** /stock/social-sentiment | Social Sentiment |
|
69
76
|
| [**stock_basic_dividends**](DefaultApi.md#stock_basic_dividends) | **GET** /stock/dividend2 | Dividends 2 (Basic) |
|
@@ -80,6 +87,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
80
87
|
| [**stock_visa_application**](DefaultApi.md#stock_visa_application) | **GET** /stock/visa-application | H1-B Visa Application |
|
81
88
|
| [**supply_chain_relationships**](DefaultApi.md#supply_chain_relationships) | **GET** /stock/supply-chain | Supply Chain Relationships |
|
82
89
|
| [**support_resistance**](DefaultApi.md#support_resistance) | **GET** /scan/support-resistance | Support/Resistance |
|
90
|
+
| [**symbol_change**](DefaultApi.md#symbol_change) | **GET** /ca/symbol-change | Symbol Change |
|
83
91
|
| [**symbol_search**](DefaultApi.md#symbol_search) | **GET** /search | Symbol Lookup |
|
84
92
|
| [**technical_indicator**](DefaultApi.md#technical_indicator) | **POST** /indicator | Technical Indicators |
|
85
93
|
| [**transcripts**](DefaultApi.md#transcripts) | **GET** /stock/transcripts | Earnings Call Transcripts |
|
@@ -166,7 +174,7 @@ end
|
|
166
174
|
|
167
175
|
Bond price data
|
168
176
|
|
169
|
-
Get
|
177
|
+
<p>Get bond's price data. The following datasets are supported:</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 Government Bonds</th> <td>Government Bonds</td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">FINRA Trace</th> <td>BTDS: US Corporate Bonds</td> <td>Delayed 4h</td> </tr> <tr> <td class=\"text-blue\">FINRA Trace</th> <td>144A Bonds</td> <td>Delayed 4h</td> </tr> </tbody> </table>
|
170
178
|
|
171
179
|
### Examples
|
172
180
|
|
@@ -312,6 +320,85 @@ end
|
|
312
320
|
- **Accept**: application/json
|
313
321
|
|
314
322
|
|
323
|
+
## bond_tick
|
324
|
+
|
325
|
+
> <BondTickData> bond_tick(isin, date, limit, skip, exchange)
|
326
|
+
|
327
|
+
Bond Tick Data
|
328
|
+
|
329
|
+
<p>Get trade-level data for bonds. The following datasets are supported:</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\">FINRA Trace</th> <td>BTDS: US Corporate Bonds</td> <td>Delayed 4h</td> </tr> <tr> <td class=\"text-blue\">FINRA Trace</th> <td>144A Bonds</td> <td>Delayed 4h</td> </tr> </tbody> </table>
|
330
|
+
|
331
|
+
### Examples
|
332
|
+
|
333
|
+
```ruby
|
334
|
+
require 'time'
|
335
|
+
require 'finnhub_ruby'
|
336
|
+
# setup authorization
|
337
|
+
FinnhubRuby.configure do |config|
|
338
|
+
# Configure API key authorization: api_key
|
339
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
340
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
341
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
342
|
+
end
|
343
|
+
|
344
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
345
|
+
isin = 'isin_example' # String | ISIN.
|
346
|
+
date = Date.parse('2013-10-20') # Date | Date: 2020-04-02.
|
347
|
+
limit = 789 # Integer | Limit number of ticks returned. Maximum value: <code>25000</code>
|
348
|
+
skip = 789 # Integer | Number of ticks to skip. Use this parameter to loop through the entire data.
|
349
|
+
exchange = 'exchange_example' # String | Currently support the following values: <code>trace</code>.
|
350
|
+
|
351
|
+
begin
|
352
|
+
# Bond Tick Data
|
353
|
+
result = api_instance.bond_tick(isin, date, limit, skip, exchange)
|
354
|
+
p result
|
355
|
+
rescue FinnhubRuby::ApiError => e
|
356
|
+
puts "Error when calling DefaultApi->bond_tick: #{e}"
|
357
|
+
end
|
358
|
+
```
|
359
|
+
|
360
|
+
#### Using the bond_tick_with_http_info variant
|
361
|
+
|
362
|
+
This returns an Array which contains the response data, status code and headers.
|
363
|
+
|
364
|
+
> <Array(<BondTickData>, Integer, Hash)> bond_tick_with_http_info(isin, date, limit, skip, exchange)
|
365
|
+
|
366
|
+
```ruby
|
367
|
+
begin
|
368
|
+
# Bond Tick Data
|
369
|
+
data, status_code, headers = api_instance.bond_tick_with_http_info(isin, date, limit, skip, exchange)
|
370
|
+
p status_code # => 2xx
|
371
|
+
p headers # => { ... }
|
372
|
+
p data # => <BondTickData>
|
373
|
+
rescue FinnhubRuby::ApiError => e
|
374
|
+
puts "Error when calling DefaultApi->bond_tick_with_http_info: #{e}"
|
375
|
+
end
|
376
|
+
```
|
377
|
+
|
378
|
+
### Parameters
|
379
|
+
|
380
|
+
| Name | Type | Description | Notes |
|
381
|
+
| ---- | ---- | ----------- | ----- |
|
382
|
+
| **isin** | **String** | ISIN. | |
|
383
|
+
| **date** | **Date** | Date: 2020-04-02. | |
|
384
|
+
| **limit** | **Integer** | Limit number of ticks returned. Maximum value: <code>25000</code> | |
|
385
|
+
| **skip** | **Integer** | Number of ticks to skip. Use this parameter to loop through the entire data. | |
|
386
|
+
| **exchange** | **String** | Currently support the following values: <code>trace</code>. | |
|
387
|
+
|
388
|
+
### Return type
|
389
|
+
|
390
|
+
[**BondTickData**](BondTickData.md)
|
391
|
+
|
392
|
+
### Authorization
|
393
|
+
|
394
|
+
[api_key](../README.md#api_key)
|
395
|
+
|
396
|
+
### HTTP request headers
|
397
|
+
|
398
|
+
- **Content-Type**: Not defined
|
399
|
+
- **Accept**: application/json
|
400
|
+
|
401
|
+
|
315
402
|
## company_basic_financials
|
316
403
|
|
317
404
|
> <BasicFinancials> company_basic_financials(symbol, metric)
|
@@ -977,11 +1064,11 @@ end
|
|
977
1064
|
|
978
1065
|
## company_peers
|
979
1066
|
|
980
|
-
> Array<String> company_peers(symbol)
|
1067
|
+
> Array<String> company_peers(symbol, opts)
|
981
1068
|
|
982
1069
|
Peers
|
983
1070
|
|
984
|
-
Get company peers. Return a list of peers in the same country and
|
1071
|
+
Get company peers. Return a list of peers operating in the same country and sector/industry.
|
985
1072
|
|
986
1073
|
### Examples
|
987
1074
|
|
@@ -998,10 +1085,13 @@ end
|
|
998
1085
|
|
999
1086
|
api_instance = FinnhubRuby::DefaultApi.new
|
1000
1087
|
symbol = 'symbol_example' # String | Symbol of the company: AAPL.
|
1088
|
+
opts = {
|
1089
|
+
grouping: 'grouping_example' # String | Specify the grouping criteria for choosing peers.Supporter values: <code>sector</code>, <code>industry</code>, <code>subIndustry</code>. Default to <code>subIndustry</code>.
|
1090
|
+
}
|
1001
1091
|
|
1002
1092
|
begin
|
1003
1093
|
# Peers
|
1004
|
-
result = api_instance.company_peers(symbol)
|
1094
|
+
result = api_instance.company_peers(symbol, opts)
|
1005
1095
|
p result
|
1006
1096
|
rescue FinnhubRuby::ApiError => e
|
1007
1097
|
puts "Error when calling DefaultApi->company_peers: #{e}"
|
@@ -1012,12 +1102,12 @@ end
|
|
1012
1102
|
|
1013
1103
|
This returns an Array which contains the response data, status code and headers.
|
1014
1104
|
|
1015
|
-
> <Array(Array<String>, Integer, Hash)> company_peers_with_http_info(symbol)
|
1105
|
+
> <Array(Array<String>, Integer, Hash)> company_peers_with_http_info(symbol, opts)
|
1016
1106
|
|
1017
1107
|
```ruby
|
1018
1108
|
begin
|
1019
1109
|
# Peers
|
1020
|
-
data, status_code, headers = api_instance.company_peers_with_http_info(symbol)
|
1110
|
+
data, status_code, headers = api_instance.company_peers_with_http_info(symbol, opts)
|
1021
1111
|
p status_code # => 2xx
|
1022
1112
|
p headers # => { ... }
|
1023
1113
|
p data # => Array<String>
|
@@ -1031,6 +1121,7 @@ end
|
|
1031
1121
|
| Name | Type | Description | Notes |
|
1032
1122
|
| ---- | ---- | ----------- | ----- |
|
1033
1123
|
| **symbol** | **String** | Symbol of the company: AAPL. | |
|
1124
|
+
| **grouping** | **String** | Specify the grouping criteria for choosing peers.Supporter values: <code>sector</code>, <code>industry</code>, <code>subIndustry</code>. Default to <code>subIndustry</code>. | [optional] |
|
1034
1125
|
|
1035
1126
|
### Return type
|
1036
1127
|
|
@@ -2610,7 +2701,9 @@ opts = {
|
|
2610
2701
|
symbol: 'symbol_example', # String | Symbol.
|
2611
2702
|
cik: 'cik_example', # String | CIK.
|
2612
2703
|
access_number: 'access_number_example', # String | Access number of a specific report you want to retrieve financials from.
|
2613
|
-
freq: 'freq_example' # String | Frequency. Can be either <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>.
|
2704
|
+
freq: 'freq_example', # String | Frequency. Can be either <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>.
|
2705
|
+
from: Date.parse('2013-10-20'), # Date | From date <code>YYYY-MM-DD</code>. Filter for endDate.
|
2706
|
+
to: Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>. Filter for endDate.
|
2614
2707
|
}
|
2615
2708
|
|
2616
2709
|
begin
|
@@ -2648,6 +2741,8 @@ end
|
|
2648
2741
|
| **cik** | **String** | CIK. | [optional] |
|
2649
2742
|
| **access_number** | **String** | Access number of a specific report you want to retrieve financials from. | [optional] |
|
2650
2743
|
| **freq** | **String** | Frequency. Can be either <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>. | [optional] |
|
2744
|
+
| **from** | **Date** | From date <code>YYYY-MM-DD</code>. Filter for endDate. | [optional] |
|
2745
|
+
| **to** | **Date** | To date <code>YYYY-MM-DD</code>. Filter for endDate. | [optional] |
|
2651
2746
|
|
2652
2747
|
### Return type
|
2653
2748
|
|
@@ -3323,13 +3418,238 @@ end
|
|
3323
3418
|
- **Accept**: application/json
|
3324
3419
|
|
3325
3420
|
|
3421
|
+
## institutional_ownership
|
3422
|
+
|
3423
|
+
> <InstitutionalOwnership> institutional_ownership(symbol, cusip, from, to)
|
3424
|
+
|
3425
|
+
Institutional Ownership
|
3426
|
+
|
3427
|
+
Get a list institutional investors' positions for a particular stock overtime. Data from 13-F filings. Limit to 1 year of data at a time.
|
3428
|
+
|
3429
|
+
### Examples
|
3430
|
+
|
3431
|
+
```ruby
|
3432
|
+
require 'time'
|
3433
|
+
require 'finnhub_ruby'
|
3434
|
+
# setup authorization
|
3435
|
+
FinnhubRuby.configure do |config|
|
3436
|
+
# Configure API key authorization: api_key
|
3437
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
3438
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3439
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
3440
|
+
end
|
3441
|
+
|
3442
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
3443
|
+
symbol = 'symbol_example' # String | Filter by symbol.
|
3444
|
+
cusip = 'cusip_example' # String | Filter by CUSIP.
|
3445
|
+
from = 'from_example' # String | From date <code>YYYY-MM-DD</code>.
|
3446
|
+
to = 'to_example' # String | To date <code>YYYY-MM-DD</code>.
|
3447
|
+
|
3448
|
+
begin
|
3449
|
+
# Institutional Ownership
|
3450
|
+
result = api_instance.institutional_ownership(symbol, cusip, from, to)
|
3451
|
+
p result
|
3452
|
+
rescue FinnhubRuby::ApiError => e
|
3453
|
+
puts "Error when calling DefaultApi->institutional_ownership: #{e}"
|
3454
|
+
end
|
3455
|
+
```
|
3456
|
+
|
3457
|
+
#### Using the institutional_ownership_with_http_info variant
|
3458
|
+
|
3459
|
+
This returns an Array which contains the response data, status code and headers.
|
3460
|
+
|
3461
|
+
> <Array(<InstitutionalOwnership>, Integer, Hash)> institutional_ownership_with_http_info(symbol, cusip, from, to)
|
3462
|
+
|
3463
|
+
```ruby
|
3464
|
+
begin
|
3465
|
+
# Institutional Ownership
|
3466
|
+
data, status_code, headers = api_instance.institutional_ownership_with_http_info(symbol, cusip, from, to)
|
3467
|
+
p status_code # => 2xx
|
3468
|
+
p headers # => { ... }
|
3469
|
+
p data # => <InstitutionalOwnership>
|
3470
|
+
rescue FinnhubRuby::ApiError => e
|
3471
|
+
puts "Error when calling DefaultApi->institutional_ownership_with_http_info: #{e}"
|
3472
|
+
end
|
3473
|
+
```
|
3474
|
+
|
3475
|
+
### Parameters
|
3476
|
+
|
3477
|
+
| Name | Type | Description | Notes |
|
3478
|
+
| ---- | ---- | ----------- | ----- |
|
3479
|
+
| **symbol** | **String** | Filter by symbol. | |
|
3480
|
+
| **cusip** | **String** | Filter by CUSIP. | |
|
3481
|
+
| **from** | **String** | From date <code>YYYY-MM-DD</code>. | |
|
3482
|
+
| **to** | **String** | To date <code>YYYY-MM-DD</code>. | |
|
3483
|
+
|
3484
|
+
### Return type
|
3485
|
+
|
3486
|
+
[**InstitutionalOwnership**](InstitutionalOwnership.md)
|
3487
|
+
|
3488
|
+
### Authorization
|
3489
|
+
|
3490
|
+
[api_key](../README.md#api_key)
|
3491
|
+
|
3492
|
+
### HTTP request headers
|
3493
|
+
|
3494
|
+
- **Content-Type**: Not defined
|
3495
|
+
- **Accept**: application/json
|
3496
|
+
|
3497
|
+
|
3498
|
+
## institutional_portfolio
|
3499
|
+
|
3500
|
+
> <InstitutionalPortfolio> institutional_portfolio(cik, from, to)
|
3501
|
+
|
3502
|
+
Institutional Portfolio
|
3503
|
+
|
3504
|
+
Get the holdings/portfolio data of institutional investors from 13-F filings. Limit to 1 year of data at a time.
|
3505
|
+
|
3506
|
+
### Examples
|
3507
|
+
|
3508
|
+
```ruby
|
3509
|
+
require 'time'
|
3510
|
+
require 'finnhub_ruby'
|
3511
|
+
# setup authorization
|
3512
|
+
FinnhubRuby.configure do |config|
|
3513
|
+
# Configure API key authorization: api_key
|
3514
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
3515
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3516
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
3517
|
+
end
|
3518
|
+
|
3519
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
3520
|
+
cik = 'cik_example' # String | Fund's CIK.
|
3521
|
+
from = 'from_example' # String | From date <code>YYYY-MM-DD</code>.
|
3522
|
+
to = 'to_example' # String | To date <code>YYYY-MM-DD</code>.
|
3523
|
+
|
3524
|
+
begin
|
3525
|
+
# Institutional Portfolio
|
3526
|
+
result = api_instance.institutional_portfolio(cik, from, to)
|
3527
|
+
p result
|
3528
|
+
rescue FinnhubRuby::ApiError => e
|
3529
|
+
puts "Error when calling DefaultApi->institutional_portfolio: #{e}"
|
3530
|
+
end
|
3531
|
+
```
|
3532
|
+
|
3533
|
+
#### Using the institutional_portfolio_with_http_info variant
|
3534
|
+
|
3535
|
+
This returns an Array which contains the response data, status code and headers.
|
3536
|
+
|
3537
|
+
> <Array(<InstitutionalPortfolio>, Integer, Hash)> institutional_portfolio_with_http_info(cik, from, to)
|
3538
|
+
|
3539
|
+
```ruby
|
3540
|
+
begin
|
3541
|
+
# Institutional Portfolio
|
3542
|
+
data, status_code, headers = api_instance.institutional_portfolio_with_http_info(cik, from, to)
|
3543
|
+
p status_code # => 2xx
|
3544
|
+
p headers # => { ... }
|
3545
|
+
p data # => <InstitutionalPortfolio>
|
3546
|
+
rescue FinnhubRuby::ApiError => e
|
3547
|
+
puts "Error when calling DefaultApi->institutional_portfolio_with_http_info: #{e}"
|
3548
|
+
end
|
3549
|
+
```
|
3550
|
+
|
3551
|
+
### Parameters
|
3552
|
+
|
3553
|
+
| Name | Type | Description | Notes |
|
3554
|
+
| ---- | ---- | ----------- | ----- |
|
3555
|
+
| **cik** | **String** | Fund's CIK. | |
|
3556
|
+
| **from** | **String** | From date <code>YYYY-MM-DD</code>. | |
|
3557
|
+
| **to** | **String** | To date <code>YYYY-MM-DD</code>. | |
|
3558
|
+
|
3559
|
+
### Return type
|
3560
|
+
|
3561
|
+
[**InstitutionalPortfolio**](InstitutionalPortfolio.md)
|
3562
|
+
|
3563
|
+
### Authorization
|
3564
|
+
|
3565
|
+
[api_key](../README.md#api_key)
|
3566
|
+
|
3567
|
+
### HTTP request headers
|
3568
|
+
|
3569
|
+
- **Content-Type**: Not defined
|
3570
|
+
- **Accept**: application/json
|
3571
|
+
|
3572
|
+
|
3573
|
+
## institutional_profile
|
3574
|
+
|
3575
|
+
> <InstitutionalProfile> institutional_profile(opts)
|
3576
|
+
|
3577
|
+
Institutional Profile
|
3578
|
+
|
3579
|
+
Get a list of well-known institutional investors. Currently support 60+ profiles.
|
3580
|
+
|
3581
|
+
### Examples
|
3582
|
+
|
3583
|
+
```ruby
|
3584
|
+
require 'time'
|
3585
|
+
require 'finnhub_ruby'
|
3586
|
+
# setup authorization
|
3587
|
+
FinnhubRuby.configure do |config|
|
3588
|
+
# Configure API key authorization: api_key
|
3589
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
3590
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3591
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
3592
|
+
end
|
3593
|
+
|
3594
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
3595
|
+
opts = {
|
3596
|
+
cik: 'cik_example' # String | Filter by CIK. Leave blank to get the full list.
|
3597
|
+
}
|
3598
|
+
|
3599
|
+
begin
|
3600
|
+
# Institutional Profile
|
3601
|
+
result = api_instance.institutional_profile(opts)
|
3602
|
+
p result
|
3603
|
+
rescue FinnhubRuby::ApiError => e
|
3604
|
+
puts "Error when calling DefaultApi->institutional_profile: #{e}"
|
3605
|
+
end
|
3606
|
+
```
|
3607
|
+
|
3608
|
+
#### Using the institutional_profile_with_http_info variant
|
3609
|
+
|
3610
|
+
This returns an Array which contains the response data, status code and headers.
|
3611
|
+
|
3612
|
+
> <Array(<InstitutionalProfile>, Integer, Hash)> institutional_profile_with_http_info(opts)
|
3613
|
+
|
3614
|
+
```ruby
|
3615
|
+
begin
|
3616
|
+
# Institutional Profile
|
3617
|
+
data, status_code, headers = api_instance.institutional_profile_with_http_info(opts)
|
3618
|
+
p status_code # => 2xx
|
3619
|
+
p headers # => { ... }
|
3620
|
+
p data # => <InstitutionalProfile>
|
3621
|
+
rescue FinnhubRuby::ApiError => e
|
3622
|
+
puts "Error when calling DefaultApi->institutional_profile_with_http_info: #{e}"
|
3623
|
+
end
|
3624
|
+
```
|
3625
|
+
|
3626
|
+
### Parameters
|
3627
|
+
|
3628
|
+
| Name | Type | Description | Notes |
|
3629
|
+
| ---- | ---- | ----------- | ----- |
|
3630
|
+
| **cik** | **String** | Filter by CIK. Leave blank to get the full list. | [optional] |
|
3631
|
+
|
3632
|
+
### Return type
|
3633
|
+
|
3634
|
+
[**InstitutionalProfile**](InstitutionalProfile.md)
|
3635
|
+
|
3636
|
+
### Authorization
|
3637
|
+
|
3638
|
+
[api_key](../README.md#api_key)
|
3639
|
+
|
3640
|
+
### HTTP request headers
|
3641
|
+
|
3642
|
+
- **Content-Type**: Not defined
|
3643
|
+
- **Accept**: application/json
|
3644
|
+
|
3645
|
+
|
3326
3646
|
## international_filings
|
3327
3647
|
|
3328
3648
|
> <Array<InternationalFiling>> international_filings(opts)
|
3329
3649
|
|
3330
3650
|
International Filings
|
3331
3651
|
|
3332
|
-
List filings for international companies. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
|
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.
|
3333
3653
|
|
3334
3654
|
### Examples
|
3335
3655
|
|
@@ -3542,6 +3862,79 @@ end
|
|
3542
3862
|
- **Accept**: application/json
|
3543
3863
|
|
3544
3864
|
|
3865
|
+
## isin_change
|
3866
|
+
|
3867
|
+
> <IsinChange> isin_change(from, to)
|
3868
|
+
|
3869
|
+
ISIN Change
|
3870
|
+
|
3871
|
+
Get a list of ISIN changes for EU-listed securities. Limit to 2000 events at a time.
|
3872
|
+
|
3873
|
+
### Examples
|
3874
|
+
|
3875
|
+
```ruby
|
3876
|
+
require 'time'
|
3877
|
+
require 'finnhub_ruby'
|
3878
|
+
# setup authorization
|
3879
|
+
FinnhubRuby.configure do |config|
|
3880
|
+
# Configure API key authorization: api_key
|
3881
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
3882
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3883
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
3884
|
+
end
|
3885
|
+
|
3886
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
3887
|
+
from = 'from_example' # String | From date <code>YYYY-MM-DD</code>.
|
3888
|
+
to = 'to_example' # String | To date <code>YYYY-MM-DD</code>.
|
3889
|
+
|
3890
|
+
begin
|
3891
|
+
# ISIN Change
|
3892
|
+
result = api_instance.isin_change(from, to)
|
3893
|
+
p result
|
3894
|
+
rescue FinnhubRuby::ApiError => e
|
3895
|
+
puts "Error when calling DefaultApi->isin_change: #{e}"
|
3896
|
+
end
|
3897
|
+
```
|
3898
|
+
|
3899
|
+
#### Using the isin_change_with_http_info variant
|
3900
|
+
|
3901
|
+
This returns an Array which contains the response data, status code and headers.
|
3902
|
+
|
3903
|
+
> <Array(<IsinChange>, Integer, Hash)> isin_change_with_http_info(from, to)
|
3904
|
+
|
3905
|
+
```ruby
|
3906
|
+
begin
|
3907
|
+
# ISIN Change
|
3908
|
+
data, status_code, headers = api_instance.isin_change_with_http_info(from, to)
|
3909
|
+
p status_code # => 2xx
|
3910
|
+
p headers # => { ... }
|
3911
|
+
p data # => <IsinChange>
|
3912
|
+
rescue FinnhubRuby::ApiError => e
|
3913
|
+
puts "Error when calling DefaultApi->isin_change_with_http_info: #{e}"
|
3914
|
+
end
|
3915
|
+
```
|
3916
|
+
|
3917
|
+
### Parameters
|
3918
|
+
|
3919
|
+
| Name | Type | Description | Notes |
|
3920
|
+
| ---- | ---- | ----------- | ----- |
|
3921
|
+
| **from** | **String** | From date <code>YYYY-MM-DD</code>. | |
|
3922
|
+
| **to** | **String** | To date <code>YYYY-MM-DD</code>. | |
|
3923
|
+
|
3924
|
+
### Return type
|
3925
|
+
|
3926
|
+
[**IsinChange**](IsinChange.md)
|
3927
|
+
|
3928
|
+
### Authorization
|
3929
|
+
|
3930
|
+
[api_key](../README.md#api_key)
|
3931
|
+
|
3932
|
+
### HTTP request headers
|
3933
|
+
|
3934
|
+
- **Content-Type**: Not defined
|
3935
|
+
- **Accept**: application/json
|
3936
|
+
|
3937
|
+
|
3545
3938
|
## market_news
|
3546
3939
|
|
3547
3940
|
> <Array<MarketNews>> market_news(category, opts)
|
@@ -4136,7 +4529,7 @@ end
|
|
4136
4529
|
|
4137
4530
|
Major Press Releases
|
4138
4531
|
|
4139
|
-
Get latest major press releases of a company. This data can be used to highlight the most significant events comprised of mostly press releases sourced from the exchanges, BusinessWire, AccessWire, GlobeNewswire, Newsfile, and PRNewswire.
|
4532
|
+
<p>Get latest major press releases of a company. This data can be used to highlight the most significant events comprised of mostly press releases sourced from the exchanges, BusinessWire, AccessWire, GlobeNewswire, Newsfile, and PRNewswire.</p><p>Full-text press releases data is available for Enterprise clients. <a href=\"mailto:support@finnhub.io\">Contact Us</a> to learn more.</p>
|
4140
4533
|
|
4141
4534
|
### Examples
|
4142
4535
|
|
@@ -4207,6 +4600,77 @@ end
|
|
4207
4600
|
- **Accept**: application/json
|
4208
4601
|
|
4209
4602
|
|
4603
|
+
## price_metrics
|
4604
|
+
|
4605
|
+
> <PriceMetrics> price_metrics(symbol)
|
4606
|
+
|
4607
|
+
Price Metrics
|
4608
|
+
|
4609
|
+
Get company price performance statistics such as 52-week high/low, YTD return and much more.
|
4610
|
+
|
4611
|
+
### Examples
|
4612
|
+
|
4613
|
+
```ruby
|
4614
|
+
require 'time'
|
4615
|
+
require 'finnhub_ruby'
|
4616
|
+
# setup authorization
|
4617
|
+
FinnhubRuby.configure do |config|
|
4618
|
+
# Configure API key authorization: api_key
|
4619
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
4620
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4621
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
4622
|
+
end
|
4623
|
+
|
4624
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
4625
|
+
symbol = 'symbol_example' # String | Symbol of the company: AAPL.
|
4626
|
+
|
4627
|
+
begin
|
4628
|
+
# Price Metrics
|
4629
|
+
result = api_instance.price_metrics(symbol)
|
4630
|
+
p result
|
4631
|
+
rescue FinnhubRuby::ApiError => e
|
4632
|
+
puts "Error when calling DefaultApi->price_metrics: #{e}"
|
4633
|
+
end
|
4634
|
+
```
|
4635
|
+
|
4636
|
+
#### Using the price_metrics_with_http_info variant
|
4637
|
+
|
4638
|
+
This returns an Array which contains the response data, status code and headers.
|
4639
|
+
|
4640
|
+
> <Array(<PriceMetrics>, Integer, Hash)> price_metrics_with_http_info(symbol)
|
4641
|
+
|
4642
|
+
```ruby
|
4643
|
+
begin
|
4644
|
+
# Price Metrics
|
4645
|
+
data, status_code, headers = api_instance.price_metrics_with_http_info(symbol)
|
4646
|
+
p status_code # => 2xx
|
4647
|
+
p headers # => { ... }
|
4648
|
+
p data # => <PriceMetrics>
|
4649
|
+
rescue FinnhubRuby::ApiError => e
|
4650
|
+
puts "Error when calling DefaultApi->price_metrics_with_http_info: #{e}"
|
4651
|
+
end
|
4652
|
+
```
|
4653
|
+
|
4654
|
+
### Parameters
|
4655
|
+
|
4656
|
+
| Name | Type | Description | Notes |
|
4657
|
+
| ---- | ---- | ----------- | ----- |
|
4658
|
+
| **symbol** | **String** | Symbol of the company: AAPL. | |
|
4659
|
+
|
4660
|
+
### Return type
|
4661
|
+
|
4662
|
+
[**PriceMetrics**](PriceMetrics.md)
|
4663
|
+
|
4664
|
+
### Authorization
|
4665
|
+
|
4666
|
+
[api_key](../README.md#api_key)
|
4667
|
+
|
4668
|
+
### HTTP request headers
|
4669
|
+
|
4670
|
+
- **Content-Type**: Not defined
|
4671
|
+
- **Accept**: application/json
|
4672
|
+
|
4673
|
+
|
4210
4674
|
## price_target
|
4211
4675
|
|
4212
4676
|
> <PriceTarget> price_target(symbol)
|
@@ -4495,6 +4959,77 @@ end
|
|
4495
4959
|
- **Accept**: application/json
|
4496
4960
|
|
4497
4961
|
|
4962
|
+
## sector_metric
|
4963
|
+
|
4964
|
+
> <SectorMetric> sector_metric(region)
|
4965
|
+
|
4966
|
+
Sector Metrics
|
4967
|
+
|
4968
|
+
Get ratios for different sectors and regions/indices.
|
4969
|
+
|
4970
|
+
### Examples
|
4971
|
+
|
4972
|
+
```ruby
|
4973
|
+
require 'time'
|
4974
|
+
require 'finnhub_ruby'
|
4975
|
+
# setup authorization
|
4976
|
+
FinnhubRuby.configure do |config|
|
4977
|
+
# Configure API key authorization: api_key
|
4978
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
4979
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4980
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
4981
|
+
end
|
4982
|
+
|
4983
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
4984
|
+
region = 'region_example' # String | Region. A list of supported values for this field can be found <a href=\"https://docs.google.com/spreadsheets/d/1afedyv7yWJ-z7pMjaAZK-f6ENY3mI3EBCk95QffpoHw/edit?usp=sharing\" target=\"_blank\">here</a>.
|
4985
|
+
|
4986
|
+
begin
|
4987
|
+
# Sector Metrics
|
4988
|
+
result = api_instance.sector_metric(region)
|
4989
|
+
p result
|
4990
|
+
rescue FinnhubRuby::ApiError => e
|
4991
|
+
puts "Error when calling DefaultApi->sector_metric: #{e}"
|
4992
|
+
end
|
4993
|
+
```
|
4994
|
+
|
4995
|
+
#### Using the sector_metric_with_http_info variant
|
4996
|
+
|
4997
|
+
This returns an Array which contains the response data, status code and headers.
|
4998
|
+
|
4999
|
+
> <Array(<SectorMetric>, Integer, Hash)> sector_metric_with_http_info(region)
|
5000
|
+
|
5001
|
+
```ruby
|
5002
|
+
begin
|
5003
|
+
# Sector Metrics
|
5004
|
+
data, status_code, headers = api_instance.sector_metric_with_http_info(region)
|
5005
|
+
p status_code # => 2xx
|
5006
|
+
p headers # => { ... }
|
5007
|
+
p data # => <SectorMetric>
|
5008
|
+
rescue FinnhubRuby::ApiError => e
|
5009
|
+
puts "Error when calling DefaultApi->sector_metric_with_http_info: #{e}"
|
5010
|
+
end
|
5011
|
+
```
|
5012
|
+
|
5013
|
+
### Parameters
|
5014
|
+
|
5015
|
+
| Name | Type | Description | Notes |
|
5016
|
+
| ---- | ---- | ----------- | ----- |
|
5017
|
+
| **region** | **String** | Region. A list of supported values for this field can be found <a href=\"https://docs.google.com/spreadsheets/d/1afedyv7yWJ-z7pMjaAZK-f6ENY3mI3EBCk95QffpoHw/edit?usp=sharing\" target=\"_blank\">here</a>. | |
|
5018
|
+
|
5019
|
+
### Return type
|
5020
|
+
|
5021
|
+
[**SectorMetric**](SectorMetric.md)
|
5022
|
+
|
5023
|
+
### Authorization
|
5024
|
+
|
5025
|
+
[api_key](../README.md#api_key)
|
5026
|
+
|
5027
|
+
### HTTP request headers
|
5028
|
+
|
5029
|
+
- **Content-Type**: Not defined
|
5030
|
+
- **Accept**: application/json
|
5031
|
+
|
5032
|
+
|
4498
5033
|
## similarity_index
|
4499
5034
|
|
4500
5035
|
> <SimilarityIndex> similarity_index(opts)
|
@@ -5695,6 +6230,79 @@ end
|
|
5695
6230
|
- **Accept**: application/json
|
5696
6231
|
|
5697
6232
|
|
6233
|
+
## symbol_change
|
6234
|
+
|
6235
|
+
> <SymbolChange> symbol_change(from, to)
|
6236
|
+
|
6237
|
+
Symbol Change
|
6238
|
+
|
6239
|
+
Get a list of symbol changes for US-listed and EU-listed securities. Limit to 2000 events at a time.
|
6240
|
+
|
6241
|
+
### Examples
|
6242
|
+
|
6243
|
+
```ruby
|
6244
|
+
require 'time'
|
6245
|
+
require 'finnhub_ruby'
|
6246
|
+
# setup authorization
|
6247
|
+
FinnhubRuby.configure do |config|
|
6248
|
+
# Configure API key authorization: api_key
|
6249
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
6250
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
6251
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
6252
|
+
end
|
6253
|
+
|
6254
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
6255
|
+
from = 'from_example' # String | From date <code>YYYY-MM-DD</code>.
|
6256
|
+
to = 'to_example' # String | To date <code>YYYY-MM-DD</code>.
|
6257
|
+
|
6258
|
+
begin
|
6259
|
+
# Symbol Change
|
6260
|
+
result = api_instance.symbol_change(from, to)
|
6261
|
+
p result
|
6262
|
+
rescue FinnhubRuby::ApiError => e
|
6263
|
+
puts "Error when calling DefaultApi->symbol_change: #{e}"
|
6264
|
+
end
|
6265
|
+
```
|
6266
|
+
|
6267
|
+
#### Using the symbol_change_with_http_info variant
|
6268
|
+
|
6269
|
+
This returns an Array which contains the response data, status code and headers.
|
6270
|
+
|
6271
|
+
> <Array(<SymbolChange>, Integer, Hash)> symbol_change_with_http_info(from, to)
|
6272
|
+
|
6273
|
+
```ruby
|
6274
|
+
begin
|
6275
|
+
# Symbol Change
|
6276
|
+
data, status_code, headers = api_instance.symbol_change_with_http_info(from, to)
|
6277
|
+
p status_code # => 2xx
|
6278
|
+
p headers # => { ... }
|
6279
|
+
p data # => <SymbolChange>
|
6280
|
+
rescue FinnhubRuby::ApiError => e
|
6281
|
+
puts "Error when calling DefaultApi->symbol_change_with_http_info: #{e}"
|
6282
|
+
end
|
6283
|
+
```
|
6284
|
+
|
6285
|
+
### Parameters
|
6286
|
+
|
6287
|
+
| Name | Type | Description | Notes |
|
6288
|
+
| ---- | ---- | ----------- | ----- |
|
6289
|
+
| **from** | **String** | From date <code>YYYY-MM-DD</code>. | |
|
6290
|
+
| **to** | **String** | To date <code>YYYY-MM-DD</code>. | |
|
6291
|
+
|
6292
|
+
### Return type
|
6293
|
+
|
6294
|
+
[**SymbolChange**](SymbolChange.md)
|
6295
|
+
|
6296
|
+
### Authorization
|
6297
|
+
|
6298
|
+
[api_key](../README.md#api_key)
|
6299
|
+
|
6300
|
+
### HTTP request headers
|
6301
|
+
|
6302
|
+
- **Content-Type**: Not defined
|
6303
|
+
- **Accept**: application/json
|
6304
|
+
|
6305
|
+
|
5698
6306
|
## symbol_search
|
5699
6307
|
|
5700
6308
|
> <SymbolLookup> symbol_search(q)
|