finnhub_ruby 1.1.17 → 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 +40 -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 +849 -93
- data/docs/Dividends.md +3 -1
- data/docs/DocumentResponse.md +28 -0
- data/docs/ETFHoldingsData.md +3 -1
- data/docs/ETFProfileData.md +8 -2
- 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/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/MutualFundEet.md +20 -0
- data/docs/MutualFundEetPai.md +20 -0
- data/docs/MutualFundHoldingsData.md +3 -1
- data/docs/PriceMetrics.md +22 -0
- data/docs/SearchBody.md +60 -0
- data/docs/SearchFilter.md +20 -0
- data/docs/SearchResponse.md +24 -0
- data/docs/SymbolChange.md +22 -0
- data/docs/SymbolChangeInfo.md +22 -0
- data/finnhub_ruby-1.1.17.gem +0 -0
- data/finnhub_ruby-1.1.18.gem +0 -0
- data/lib/finnhub_ruby/api/default_api.rb +835 -95
- data/lib/finnhub_ruby/models/bond_tick_data.rb +347 -0
- 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/etf_profile_data.rb +35 -5
- 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/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/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 +238 -0
- 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/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 +28 -0
- data/spec/models/bond_tick_data_spec.rb +82 -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/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/mutual_fund_eet_pai_spec.rb +40 -0
- data/spec/models/mutual_fund_eet_spec.rb +40 -0
- data/spec/models/price_metrics_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
- data/spec/models/symbol_change_info_spec.rb +46 -0
- data/spec/models/symbol_change_spec.rb +46 -0
- metadata +117 -3
data/docs/DefaultApi.md
CHANGED
@@ -7,6 +7,8 @@ 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 |
|
11
|
+
| [**bond_yield_curve**](DefaultApi.md#bond_yield_curve) | **GET** /bond/yield-curve | Bond Yield Curve |
|
10
12
|
| [**company_basic_financials**](DefaultApi.md#company_basic_financials) | **GET** /stock/metric | Basic Financials |
|
11
13
|
| [**company_earnings**](DefaultApi.md#company_earnings) | **GET** /stock/earnings | Earnings Surprises |
|
12
14
|
| [**company_earnings_quality_score**](DefaultApi.md#company_earnings_quality_score) | **GET** /stock/earnings-quality-score | Company Earnings Quality Score |
|
@@ -20,6 +22,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
20
22
|
| [**company_profile**](DefaultApi.md#company_profile) | **GET** /stock/profile | Company Profile |
|
21
23
|
| [**company_profile2**](DefaultApi.md#company_profile2) | **GET** /stock/profile2 | Company Profile 2 |
|
22
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 |
|
23
26
|
| [**country**](DefaultApi.md#country) | **GET** /country | Country Metadata |
|
24
27
|
| [**covid19**](DefaultApi.md#covid19) | **GET** /covid19/us | COVID-19 |
|
25
28
|
| [**crypto_candles**](DefaultApi.md#crypto_candles) | **GET** /crypto/candle | Crypto Candles |
|
@@ -48,11 +51,16 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
48
51
|
| [**indices_historical_constituents**](DefaultApi.md#indices_historical_constituents) | **GET** /index/historical-constituents | Indices Historical Constituents |
|
49
52
|
| [**insider_sentiment**](DefaultApi.md#insider_sentiment) | **GET** /stock/insider-sentiment | Insider Sentiment |
|
50
53
|
| [**insider_transactions**](DefaultApi.md#insider_transactions) | **GET** /stock/insider-transactions | Insider Transactions |
|
51
|
-
| [**
|
54
|
+
| [**institutional_ownership**](DefaultApi.md#institutional_ownership) | **GET** /institutional/ownership | Institutional Ownership |
|
55
|
+
| [**institutional_portfolio**](DefaultApi.md#institutional_portfolio) | **GET** /institutional/portfolio | Institutional Portfolio |
|
56
|
+
| [**institutional_profile**](DefaultApi.md#institutional_profile) | **GET** /institutional/profile | Institutional Profile |
|
52
57
|
| [**investment_themes**](DefaultApi.md#investment_themes) | **GET** /stock/investment-theme | Investment Themes (Thematic Investing) |
|
53
58
|
| [**ipo_calendar**](DefaultApi.md#ipo_calendar) | **GET** /calendar/ipo | IPO Calendar |
|
59
|
+
| [**isin_change**](DefaultApi.md#isin_change) | **GET** /ca/isin-change | ISIN Change |
|
54
60
|
| [**market_news**](DefaultApi.md#market_news) | **GET** /news | Market News |
|
55
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 |
|
56
64
|
| [**mutual_fund_holdings**](DefaultApi.md#mutual_fund_holdings) | **GET** /mutual-fund/holdings | Mutual Funds Holdings |
|
57
65
|
| [**mutual_fund_profile**](DefaultApi.md#mutual_fund_profile) | **GET** /mutual-fund/profile | Mutual Funds Profile |
|
58
66
|
| [**mutual_fund_sector_exposure**](DefaultApi.md#mutual_fund_sector_exposure) | **GET** /mutual-fund/sector | Mutual Funds Sector Exposure |
|
@@ -60,6 +68,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
60
68
|
| [**ownership**](DefaultApi.md#ownership) | **GET** /stock/ownership | Ownership |
|
61
69
|
| [**pattern_recognition**](DefaultApi.md#pattern_recognition) | **GET** /scan/pattern | Pattern Recognition |
|
62
70
|
| [**press_releases**](DefaultApi.md#press_releases) | **GET** /press-releases | Major Press Releases |
|
71
|
+
| [**price_metrics**](DefaultApi.md#price_metrics) | **GET** /stock/price-metric | Price Metrics |
|
63
72
|
| [**price_target**](DefaultApi.md#price_target) | **GET** /stock/price-target | Price Target |
|
64
73
|
| [**quote**](DefaultApi.md#quote) | **GET** /quote | Quote |
|
65
74
|
| [**recommendation_trends**](DefaultApi.md#recommendation_trends) | **GET** /stock/recommendation | Recommendation Trends |
|
@@ -81,8 +90,9 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
81
90
|
| [**stock_visa_application**](DefaultApi.md#stock_visa_application) | **GET** /stock/visa-application | H1-B Visa Application |
|
82
91
|
| [**supply_chain_relationships**](DefaultApi.md#supply_chain_relationships) | **GET** /stock/supply-chain | Supply Chain Relationships |
|
83
92
|
| [**support_resistance**](DefaultApi.md#support_resistance) | **GET** /scan/support-resistance | Support/Resistance |
|
93
|
+
| [**symbol_change**](DefaultApi.md#symbol_change) | **GET** /ca/symbol-change | Symbol Change |
|
84
94
|
| [**symbol_search**](DefaultApi.md#symbol_search) | **GET** /search | Symbol Lookup |
|
85
|
-
| [**technical_indicator**](DefaultApi.md#technical_indicator) | **
|
95
|
+
| [**technical_indicator**](DefaultApi.md#technical_indicator) | **GET** /indicator | Technical Indicators |
|
86
96
|
| [**transcripts**](DefaultApi.md#transcripts) | **GET** /stock/transcripts | Earnings Call Transcripts |
|
87
97
|
| [**transcripts_list**](DefaultApi.md#transcripts_list) | **GET** /stock/transcripts/list | Earnings Call Transcripts List |
|
88
98
|
| [**upgrade_downgrade**](DefaultApi.md#upgrade_downgrade) | **GET** /stock/upgrade-downgrade | Stock Upgrade/Downgrade |
|
@@ -94,7 +104,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
94
104
|
|
95
105
|
Aggregate Indicators
|
96
106
|
|
97
|
-
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>.
|
98
108
|
|
99
109
|
### Examples
|
100
110
|
|
@@ -167,7 +177,7 @@ end
|
|
167
177
|
|
168
178
|
Bond price data
|
169
179
|
|
170
|
-
Get
|
180
|
+
<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>
|
171
181
|
|
172
182
|
### Examples
|
173
183
|
|
@@ -242,7 +252,7 @@ end
|
|
242
252
|
|
243
253
|
Bond Profile
|
244
254
|
|
245
|
-
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>.
|
246
256
|
|
247
257
|
### Examples
|
248
258
|
|
@@ -313,6 +323,156 @@ end
|
|
313
323
|
- **Accept**: application/json
|
314
324
|
|
315
325
|
|
326
|
+
## bond_tick
|
327
|
+
|
328
|
+
> <BondTickData> bond_tick(isin, date, limit, skip, exchange)
|
329
|
+
|
330
|
+
Bond Tick Data
|
331
|
+
|
332
|
+
<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>
|
333
|
+
|
334
|
+
### Examples
|
335
|
+
|
336
|
+
```ruby
|
337
|
+
require 'time'
|
338
|
+
require 'finnhub_ruby'
|
339
|
+
# setup authorization
|
340
|
+
FinnhubRuby.configure do |config|
|
341
|
+
# Configure API key authorization: api_key
|
342
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
343
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
344
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
345
|
+
end
|
346
|
+
|
347
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
348
|
+
isin = 'isin_example' # String | ISIN.
|
349
|
+
date = Date.parse('2013-10-20') # Date | Date: 2020-04-02.
|
350
|
+
limit = 789 # Integer | Limit number of ticks returned. Maximum value: <code>25000</code>
|
351
|
+
skip = 789 # Integer | Number of ticks to skip. Use this parameter to loop through the entire data.
|
352
|
+
exchange = 'exchange_example' # String | Currently support the following values: <code>trace</code>.
|
353
|
+
|
354
|
+
begin
|
355
|
+
# Bond Tick Data
|
356
|
+
result = api_instance.bond_tick(isin, date, limit, skip, exchange)
|
357
|
+
p result
|
358
|
+
rescue FinnhubRuby::ApiError => e
|
359
|
+
puts "Error when calling DefaultApi->bond_tick: #{e}"
|
360
|
+
end
|
361
|
+
```
|
362
|
+
|
363
|
+
#### Using the bond_tick_with_http_info variant
|
364
|
+
|
365
|
+
This returns an Array which contains the response data, status code and headers.
|
366
|
+
|
367
|
+
> <Array(<BondTickData>, Integer, Hash)> bond_tick_with_http_info(isin, date, limit, skip, exchange)
|
368
|
+
|
369
|
+
```ruby
|
370
|
+
begin
|
371
|
+
# Bond Tick Data
|
372
|
+
data, status_code, headers = api_instance.bond_tick_with_http_info(isin, date, limit, skip, exchange)
|
373
|
+
p status_code # => 2xx
|
374
|
+
p headers # => { ... }
|
375
|
+
p data # => <BondTickData>
|
376
|
+
rescue FinnhubRuby::ApiError => e
|
377
|
+
puts "Error when calling DefaultApi->bond_tick_with_http_info: #{e}"
|
378
|
+
end
|
379
|
+
```
|
380
|
+
|
381
|
+
### Parameters
|
382
|
+
|
383
|
+
| Name | Type | Description | Notes |
|
384
|
+
| ---- | ---- | ----------- | ----- |
|
385
|
+
| **isin** | **String** | ISIN. | |
|
386
|
+
| **date** | **Date** | Date: 2020-04-02. | |
|
387
|
+
| **limit** | **Integer** | Limit number of ticks returned. Maximum value: <code>25000</code> | |
|
388
|
+
| **skip** | **Integer** | Number of ticks to skip. Use this parameter to loop through the entire data. | |
|
389
|
+
| **exchange** | **String** | Currently support the following values: <code>trace</code>. | |
|
390
|
+
|
391
|
+
### Return type
|
392
|
+
|
393
|
+
[**BondTickData**](BondTickData.md)
|
394
|
+
|
395
|
+
### Authorization
|
396
|
+
|
397
|
+
[api_key](../README.md#api_key)
|
398
|
+
|
399
|
+
### HTTP request headers
|
400
|
+
|
401
|
+
- **Content-Type**: Not defined
|
402
|
+
- **Accept**: application/json
|
403
|
+
|
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
|
+
|
316
476
|
## company_basic_financials
|
317
477
|
|
318
478
|
> <BasicFinancials> company_basic_financials(symbol, metric)
|
@@ -978,11 +1138,11 @@ end
|
|
978
1138
|
|
979
1139
|
## company_peers
|
980
1140
|
|
981
|
-
> Array<String> company_peers(symbol)
|
1141
|
+
> Array<String> company_peers(symbol, opts)
|
982
1142
|
|
983
1143
|
Peers
|
984
1144
|
|
985
|
-
Get company peers. Return a list of peers in the same country and
|
1145
|
+
Get company peers. Return a list of peers operating in the same country and sector/industry.
|
986
1146
|
|
987
1147
|
### Examples
|
988
1148
|
|
@@ -999,10 +1159,13 @@ end
|
|
999
1159
|
|
1000
1160
|
api_instance = FinnhubRuby::DefaultApi.new
|
1001
1161
|
symbol = 'symbol_example' # String | Symbol of the company: AAPL.
|
1162
|
+
opts = {
|
1163
|
+
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>.
|
1164
|
+
}
|
1002
1165
|
|
1003
1166
|
begin
|
1004
1167
|
# Peers
|
1005
|
-
result = api_instance.company_peers(symbol)
|
1168
|
+
result = api_instance.company_peers(symbol, opts)
|
1006
1169
|
p result
|
1007
1170
|
rescue FinnhubRuby::ApiError => e
|
1008
1171
|
puts "Error when calling DefaultApi->company_peers: #{e}"
|
@@ -1013,12 +1176,12 @@ end
|
|
1013
1176
|
|
1014
1177
|
This returns an Array which contains the response data, status code and headers.
|
1015
1178
|
|
1016
|
-
> <Array(Array<String>, Integer, Hash)> company_peers_with_http_info(symbol)
|
1179
|
+
> <Array(Array<String>, Integer, Hash)> company_peers_with_http_info(symbol, opts)
|
1017
1180
|
|
1018
1181
|
```ruby
|
1019
1182
|
begin
|
1020
1183
|
# Peers
|
1021
|
-
data, status_code, headers = api_instance.company_peers_with_http_info(symbol)
|
1184
|
+
data, status_code, headers = api_instance.company_peers_with_http_info(symbol, opts)
|
1022
1185
|
p status_code # => 2xx
|
1023
1186
|
p headers # => { ... }
|
1024
1187
|
p data # => Array<String>
|
@@ -1032,6 +1195,7 @@ end
|
|
1032
1195
|
| Name | Type | Description | Notes |
|
1033
1196
|
| ---- | ---- | ----------- | ----- |
|
1034
1197
|
| **symbol** | **String** | Symbol of the company: AAPL. | |
|
1198
|
+
| **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] |
|
1035
1199
|
|
1036
1200
|
### Return type
|
1037
1201
|
|
@@ -1276,6 +1440,81 @@ end
|
|
1276
1440
|
- **Accept**: application/json
|
1277
1441
|
|
1278
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
|
+
|
1279
1518
|
## country
|
1280
1519
|
|
1281
1520
|
> <Array<CountryMetadata>> country
|
@@ -2069,7 +2308,7 @@ end
|
|
2069
2308
|
|
2070
2309
|
ETFs Holdings
|
2071
2310
|
|
2072
|
-
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>.
|
2073
2312
|
|
2074
2313
|
### Examples
|
2075
2314
|
|
@@ -2148,7 +2387,7 @@ end
|
|
2148
2387
|
|
2149
2388
|
ETFs Profile
|
2150
2389
|
|
2151
|
-
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>.
|
2152
2391
|
|
2153
2392
|
### Examples
|
2154
2393
|
|
@@ -2611,7 +2850,9 @@ opts = {
|
|
2611
2850
|
symbol: 'symbol_example', # String | Symbol.
|
2612
2851
|
cik: 'cik_example', # String | CIK.
|
2613
2852
|
access_number: 'access_number_example', # String | Access number of a specific report you want to retrieve financials from.
|
2614
|
-
freq: 'freq_example' # String | Frequency. Can be either <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>.
|
2853
|
+
freq: 'freq_example', # String | Frequency. Can be either <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>.
|
2854
|
+
from: Date.parse('2013-10-20'), # Date | From date <code>YYYY-MM-DD</code>. Filter for endDate.
|
2855
|
+
to: Date.parse('2013-10-20') # Date | To date <code>YYYY-MM-DD</code>. Filter for endDate.
|
2615
2856
|
}
|
2616
2857
|
|
2617
2858
|
begin
|
@@ -2649,6 +2890,8 @@ end
|
|
2649
2890
|
| **cik** | **String** | CIK. | [optional] |
|
2650
2891
|
| **access_number** | **String** | Access number of a specific report you want to retrieve financials from. | [optional] |
|
2651
2892
|
| **freq** | **String** | Frequency. Can be either <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>. | [optional] |
|
2893
|
+
| **from** | **Date** | From date <code>YYYY-MM-DD</code>. Filter for endDate. | [optional] |
|
2894
|
+
| **to** | **Date** | To date <code>YYYY-MM-DD</code>. Filter for endDate. | [optional] |
|
2652
2895
|
|
2653
2896
|
### Return type
|
2654
2897
|
|
@@ -3253,7 +3496,7 @@ end
|
|
3253
3496
|
|
3254
3497
|
Insider Transactions
|
3255
3498
|
|
3256
|
-
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.
|
3257
3500
|
|
3258
3501
|
### Examples
|
3259
3502
|
|
@@ -3324,13 +3567,13 @@ end
|
|
3324
3567
|
- **Accept**: application/json
|
3325
3568
|
|
3326
3569
|
|
3327
|
-
##
|
3570
|
+
## institutional_ownership
|
3328
3571
|
|
3329
|
-
> <
|
3572
|
+
> <InstitutionalOwnership> institutional_ownership(symbol, cusip, from, to)
|
3330
3573
|
|
3331
|
-
|
3574
|
+
Institutional Ownership
|
3332
3575
|
|
3333
|
-
|
3576
|
+
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.
|
3334
3577
|
|
3335
3578
|
### Examples
|
3336
3579
|
|
@@ -3346,35 +3589,35 @@ FinnhubRuby.configure do |config|
|
|
3346
3589
|
end
|
3347
3590
|
|
3348
3591
|
api_instance = FinnhubRuby::DefaultApi.new
|
3349
|
-
|
3350
|
-
|
3351
|
-
|
3352
|
-
|
3592
|
+
symbol = 'symbol_example' # String | Filter by symbol.
|
3593
|
+
cusip = 'cusip_example' # String | Filter by CUSIP.
|
3594
|
+
from = 'from_example' # String | From date <code>YYYY-MM-DD</code>.
|
3595
|
+
to = 'to_example' # String | To date <code>YYYY-MM-DD</code>.
|
3353
3596
|
|
3354
3597
|
begin
|
3355
|
-
#
|
3356
|
-
result = api_instance.
|
3598
|
+
# Institutional Ownership
|
3599
|
+
result = api_instance.institutional_ownership(symbol, cusip, from, to)
|
3357
3600
|
p result
|
3358
3601
|
rescue FinnhubRuby::ApiError => e
|
3359
|
-
puts "Error when calling DefaultApi->
|
3602
|
+
puts "Error when calling DefaultApi->institutional_ownership: #{e}"
|
3360
3603
|
end
|
3361
3604
|
```
|
3362
3605
|
|
3363
|
-
#### Using the
|
3606
|
+
#### Using the institutional_ownership_with_http_info variant
|
3364
3607
|
|
3365
3608
|
This returns an Array which contains the response data, status code and headers.
|
3366
3609
|
|
3367
|
-
> <Array(<
|
3610
|
+
> <Array(<InstitutionalOwnership>, Integer, Hash)> institutional_ownership_with_http_info(symbol, cusip, from, to)
|
3368
3611
|
|
3369
3612
|
```ruby
|
3370
3613
|
begin
|
3371
|
-
#
|
3372
|
-
data, status_code, headers = api_instance.
|
3614
|
+
# Institutional Ownership
|
3615
|
+
data, status_code, headers = api_instance.institutional_ownership_with_http_info(symbol, cusip, from, to)
|
3373
3616
|
p status_code # => 2xx
|
3374
3617
|
p headers # => { ... }
|
3375
|
-
p data # => <
|
3618
|
+
p data # => <InstitutionalOwnership>
|
3376
3619
|
rescue FinnhubRuby::ApiError => e
|
3377
|
-
puts "Error when calling DefaultApi->
|
3620
|
+
puts "Error when calling DefaultApi->institutional_ownership_with_http_info: #{e}"
|
3378
3621
|
end
|
3379
3622
|
```
|
3380
3623
|
|
@@ -3382,12 +3625,14 @@ end
|
|
3382
3625
|
|
3383
3626
|
| Name | Type | Description | Notes |
|
3384
3627
|
| ---- | ---- | ----------- | ----- |
|
3385
|
-
| **symbol** | **String** |
|
3386
|
-
| **
|
3628
|
+
| **symbol** | **String** | Filter by symbol. | |
|
3629
|
+
| **cusip** | **String** | Filter by CUSIP. | |
|
3630
|
+
| **from** | **String** | From date <code>YYYY-MM-DD</code>. | |
|
3631
|
+
| **to** | **String** | To date <code>YYYY-MM-DD</code>. | |
|
3387
3632
|
|
3388
3633
|
### Return type
|
3389
3634
|
|
3390
|
-
[**
|
3635
|
+
[**InstitutionalOwnership**](InstitutionalOwnership.md)
|
3391
3636
|
|
3392
3637
|
### Authorization
|
3393
3638
|
|
@@ -3399,13 +3644,13 @@ end
|
|
3399
3644
|
- **Accept**: application/json
|
3400
3645
|
|
3401
3646
|
|
3402
|
-
##
|
3647
|
+
## institutional_portfolio
|
3403
3648
|
|
3404
|
-
> <
|
3649
|
+
> <InstitutionalPortfolio> institutional_portfolio(cik, from, to)
|
3405
3650
|
|
3406
|
-
|
3651
|
+
Institutional Portfolio
|
3407
3652
|
|
3408
|
-
|
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>.
|
3409
3654
|
|
3410
3655
|
### Examples
|
3411
3656
|
|
@@ -3421,32 +3666,34 @@ FinnhubRuby.configure do |config|
|
|
3421
3666
|
end
|
3422
3667
|
|
3423
3668
|
api_instance = FinnhubRuby::DefaultApi.new
|
3424
|
-
|
3669
|
+
cik = 'cik_example' # String | Fund's CIK.
|
3670
|
+
from = 'from_example' # String | From date <code>YYYY-MM-DD</code>.
|
3671
|
+
to = 'to_example' # String | To date <code>YYYY-MM-DD</code>.
|
3425
3672
|
|
3426
3673
|
begin
|
3427
|
-
#
|
3428
|
-
result = api_instance.
|
3674
|
+
# Institutional Portfolio
|
3675
|
+
result = api_instance.institutional_portfolio(cik, from, to)
|
3429
3676
|
p result
|
3430
3677
|
rescue FinnhubRuby::ApiError => e
|
3431
|
-
puts "Error when calling DefaultApi->
|
3678
|
+
puts "Error when calling DefaultApi->institutional_portfolio: #{e}"
|
3432
3679
|
end
|
3433
3680
|
```
|
3434
3681
|
|
3435
|
-
#### Using the
|
3682
|
+
#### Using the institutional_portfolio_with_http_info variant
|
3436
3683
|
|
3437
3684
|
This returns an Array which contains the response data, status code and headers.
|
3438
3685
|
|
3439
|
-
> <Array(<
|
3686
|
+
> <Array(<InstitutionalPortfolio>, Integer, Hash)> institutional_portfolio_with_http_info(cik, from, to)
|
3440
3687
|
|
3441
3688
|
```ruby
|
3442
3689
|
begin
|
3443
|
-
#
|
3444
|
-
data, status_code, headers = api_instance.
|
3690
|
+
# Institutional Portfolio
|
3691
|
+
data, status_code, headers = api_instance.institutional_portfolio_with_http_info(cik, from, to)
|
3445
3692
|
p status_code # => 2xx
|
3446
3693
|
p headers # => { ... }
|
3447
|
-
p data # => <
|
3694
|
+
p data # => <InstitutionalPortfolio>
|
3448
3695
|
rescue FinnhubRuby::ApiError => e
|
3449
|
-
puts "Error when calling DefaultApi->
|
3696
|
+
puts "Error when calling DefaultApi->institutional_portfolio_with_http_info: #{e}"
|
3450
3697
|
end
|
3451
3698
|
```
|
3452
3699
|
|
@@ -3454,11 +3701,13 @@ end
|
|
3454
3701
|
|
3455
3702
|
| Name | Type | Description | Notes |
|
3456
3703
|
| ---- | ---- | ----------- | ----- |
|
3457
|
-
| **
|
3704
|
+
| **cik** | **String** | Fund's CIK. | |
|
3705
|
+
| **from** | **String** | From date <code>YYYY-MM-DD</code>. | |
|
3706
|
+
| **to** | **String** | To date <code>YYYY-MM-DD</code>. | |
|
3458
3707
|
|
3459
3708
|
### Return type
|
3460
3709
|
|
3461
|
-
[**
|
3710
|
+
[**InstitutionalPortfolio**](InstitutionalPortfolio.md)
|
3462
3711
|
|
3463
3712
|
### Authorization
|
3464
3713
|
|
@@ -3470,13 +3719,13 @@ end
|
|
3470
3719
|
- **Accept**: application/json
|
3471
3720
|
|
3472
3721
|
|
3473
|
-
##
|
3722
|
+
## institutional_profile
|
3474
3723
|
|
3475
|
-
> <
|
3724
|
+
> <InstitutionalProfile> institutional_profile(opts)
|
3476
3725
|
|
3477
|
-
|
3726
|
+
Institutional Profile
|
3478
3727
|
|
3479
|
-
Get
|
3728
|
+
Get a list of well-known institutional investors. Currently support 60+ profiles.
|
3480
3729
|
|
3481
3730
|
### Examples
|
3482
3731
|
|
@@ -3492,33 +3741,34 @@ FinnhubRuby.configure do |config|
|
|
3492
3741
|
end
|
3493
3742
|
|
3494
3743
|
api_instance = FinnhubRuby::DefaultApi.new
|
3495
|
-
|
3496
|
-
|
3744
|
+
opts = {
|
3745
|
+
cik: 'cik_example' # String | Filter by CIK. Leave blank to get the full list.
|
3746
|
+
}
|
3497
3747
|
|
3498
3748
|
begin
|
3499
|
-
#
|
3500
|
-
result = api_instance.
|
3749
|
+
# Institutional Profile
|
3750
|
+
result = api_instance.institutional_profile(opts)
|
3501
3751
|
p result
|
3502
3752
|
rescue FinnhubRuby::ApiError => e
|
3503
|
-
puts "Error when calling DefaultApi->
|
3753
|
+
puts "Error when calling DefaultApi->institutional_profile: #{e}"
|
3504
3754
|
end
|
3505
3755
|
```
|
3506
3756
|
|
3507
|
-
#### Using the
|
3757
|
+
#### Using the institutional_profile_with_http_info variant
|
3508
3758
|
|
3509
3759
|
This returns an Array which contains the response data, status code and headers.
|
3510
3760
|
|
3511
|
-
> <Array(<
|
3761
|
+
> <Array(<InstitutionalProfile>, Integer, Hash)> institutional_profile_with_http_info(opts)
|
3512
3762
|
|
3513
3763
|
```ruby
|
3514
3764
|
begin
|
3515
|
-
#
|
3516
|
-
data, status_code, headers = api_instance.
|
3765
|
+
# Institutional Profile
|
3766
|
+
data, status_code, headers = api_instance.institutional_profile_with_http_info(opts)
|
3517
3767
|
p status_code # => 2xx
|
3518
3768
|
p headers # => { ... }
|
3519
|
-
p data # => <
|
3769
|
+
p data # => <InstitutionalProfile>
|
3520
3770
|
rescue FinnhubRuby::ApiError => e
|
3521
|
-
puts "Error when calling DefaultApi->
|
3771
|
+
puts "Error when calling DefaultApi->institutional_profile_with_http_info: #{e}"
|
3522
3772
|
end
|
3523
3773
|
```
|
3524
3774
|
|
@@ -3526,12 +3776,11 @@ end
|
|
3526
3776
|
|
3527
3777
|
| Name | Type | Description | Notes |
|
3528
3778
|
| ---- | ---- | ----------- | ----- |
|
3529
|
-
| **
|
3530
|
-
| **to** | **Date** | To date: 2020-03-16. | |
|
3779
|
+
| **cik** | **String** | Filter by CIK. Leave blank to get the full list. | [optional] |
|
3531
3780
|
|
3532
3781
|
### Return type
|
3533
3782
|
|
3534
|
-
[**
|
3783
|
+
[**InstitutionalProfile**](InstitutionalProfile.md)
|
3535
3784
|
|
3536
3785
|
### Authorization
|
3537
3786
|
|
@@ -3543,13 +3792,13 @@ end
|
|
3543
3792
|
- **Accept**: application/json
|
3544
3793
|
|
3545
3794
|
|
3546
|
-
##
|
3795
|
+
## investment_themes
|
3547
3796
|
|
3548
|
-
> <
|
3797
|
+
> <InvestmentThemes> investment_themes(theme)
|
3549
3798
|
|
3550
|
-
|
3799
|
+
Investment Themes (Thematic Investing)
|
3551
3800
|
|
3552
|
-
|
3801
|
+
<p>Thematic investing involves creating a portfolio (or portion of a portfolio) by gathering together a collection of companies involved in certain areas that you predict will generate above-market returns over the long term. Themes can be based on a concept such as ageing populations or a sub-sector such as robotics, and drones. Thematic investing focuses on predicted long-term trends rather than specific companies or sectors, enabling investors to access structural, one-off shifts that can change an entire industry.</p><p>This endpoint will help you get portfolios of different investment themes that are changing our life and are the way of the future.</p><p>A full list of themes supported can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1ULj9xDh4iPoQj279M084adZ2_S852ttRthKKJ7madYc/edit?usp=sharing\">here</a>. The theme coverage and portfolios are updated bi-weekly by our analysts. Our approach excludes penny, super-small cap and illiquid stocks.</p>
|
3553
3802
|
|
3554
3803
|
### Examples
|
3555
3804
|
|
@@ -3565,35 +3814,32 @@ FinnhubRuby.configure do |config|
|
|
3565
3814
|
end
|
3566
3815
|
|
3567
3816
|
api_instance = FinnhubRuby::DefaultApi.new
|
3568
|
-
|
3569
|
-
opts = {
|
3570
|
-
min_id: 789 # Integer | Use this field to get only news after this ID. Default to 0
|
3571
|
-
}
|
3817
|
+
theme = 'theme_example' # String | Investment theme. A full list of themes supported can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1ULj9xDh4iPoQj279M084adZ2_S852ttRthKKJ7madYc/edit?usp=sharing\">here</a>.
|
3572
3818
|
|
3573
3819
|
begin
|
3574
|
-
#
|
3575
|
-
result = api_instance.
|
3820
|
+
# Investment Themes (Thematic Investing)
|
3821
|
+
result = api_instance.investment_themes(theme)
|
3576
3822
|
p result
|
3577
3823
|
rescue FinnhubRuby::ApiError => e
|
3578
|
-
puts "Error when calling DefaultApi->
|
3824
|
+
puts "Error when calling DefaultApi->investment_themes: #{e}"
|
3579
3825
|
end
|
3580
3826
|
```
|
3581
3827
|
|
3582
|
-
#### Using the
|
3828
|
+
#### Using the investment_themes_with_http_info variant
|
3583
3829
|
|
3584
3830
|
This returns an Array which contains the response data, status code and headers.
|
3585
3831
|
|
3586
|
-
> <Array(<
|
3832
|
+
> <Array(<InvestmentThemes>, Integer, Hash)> investment_themes_with_http_info(theme)
|
3587
3833
|
|
3588
3834
|
```ruby
|
3589
3835
|
begin
|
3590
|
-
#
|
3591
|
-
data, status_code, headers = api_instance.
|
3836
|
+
# Investment Themes (Thematic Investing)
|
3837
|
+
data, status_code, headers = api_instance.investment_themes_with_http_info(theme)
|
3592
3838
|
p status_code # => 2xx
|
3593
3839
|
p headers # => { ... }
|
3594
|
-
p data # => <
|
3840
|
+
p data # => <InvestmentThemes>
|
3595
3841
|
rescue FinnhubRuby::ApiError => e
|
3596
|
-
puts "Error when calling DefaultApi->
|
3842
|
+
puts "Error when calling DefaultApi->investment_themes_with_http_info: #{e}"
|
3597
3843
|
end
|
3598
3844
|
```
|
3599
3845
|
|
@@ -3601,12 +3847,11 @@ end
|
|
3601
3847
|
|
3602
3848
|
| Name | Type | Description | Notes |
|
3603
3849
|
| ---- | ---- | ----------- | ----- |
|
3604
|
-
| **
|
3605
|
-
| **min_id** | **Integer** | Use this field to get only news after this ID. Default to 0 | [optional] |
|
3850
|
+
| **theme** | **String** | Investment theme. A full list of themes supported can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1ULj9xDh4iPoQj279M084adZ2_S852ttRthKKJ7madYc/edit?usp=sharing\">here</a>. | |
|
3606
3851
|
|
3607
3852
|
### Return type
|
3608
3853
|
|
3609
|
-
[**
|
3854
|
+
[**InvestmentThemes**](InvestmentThemes.md)
|
3610
3855
|
|
3611
3856
|
### Authorization
|
3612
3857
|
|
@@ -3618,7 +3863,228 @@ end
|
|
3618
3863
|
- **Accept**: application/json
|
3619
3864
|
|
3620
3865
|
|
3621
|
-
##
|
3866
|
+
## ipo_calendar
|
3867
|
+
|
3868
|
+
> <IPOCalendar> ipo_calendar(from, to)
|
3869
|
+
|
3870
|
+
IPO Calendar
|
3871
|
+
|
3872
|
+
Get recent and upcoming IPO.
|
3873
|
+
|
3874
|
+
### Examples
|
3875
|
+
|
3876
|
+
```ruby
|
3877
|
+
require 'time'
|
3878
|
+
require 'finnhub_ruby'
|
3879
|
+
# setup authorization
|
3880
|
+
FinnhubRuby.configure do |config|
|
3881
|
+
# Configure API key authorization: api_key
|
3882
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
3883
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3884
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
3885
|
+
end
|
3886
|
+
|
3887
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
3888
|
+
from = Date.parse('2013-10-20') # Date | From date: 2020-03-15.
|
3889
|
+
to = Date.parse('2013-10-20') # Date | To date: 2020-03-16.
|
3890
|
+
|
3891
|
+
begin
|
3892
|
+
# IPO Calendar
|
3893
|
+
result = api_instance.ipo_calendar(from, to)
|
3894
|
+
p result
|
3895
|
+
rescue FinnhubRuby::ApiError => e
|
3896
|
+
puts "Error when calling DefaultApi->ipo_calendar: #{e}"
|
3897
|
+
end
|
3898
|
+
```
|
3899
|
+
|
3900
|
+
#### Using the ipo_calendar_with_http_info variant
|
3901
|
+
|
3902
|
+
This returns an Array which contains the response data, status code and headers.
|
3903
|
+
|
3904
|
+
> <Array(<IPOCalendar>, Integer, Hash)> ipo_calendar_with_http_info(from, to)
|
3905
|
+
|
3906
|
+
```ruby
|
3907
|
+
begin
|
3908
|
+
# IPO Calendar
|
3909
|
+
data, status_code, headers = api_instance.ipo_calendar_with_http_info(from, to)
|
3910
|
+
p status_code # => 2xx
|
3911
|
+
p headers # => { ... }
|
3912
|
+
p data # => <IPOCalendar>
|
3913
|
+
rescue FinnhubRuby::ApiError => e
|
3914
|
+
puts "Error when calling DefaultApi->ipo_calendar_with_http_info: #{e}"
|
3915
|
+
end
|
3916
|
+
```
|
3917
|
+
|
3918
|
+
### Parameters
|
3919
|
+
|
3920
|
+
| Name | Type | Description | Notes |
|
3921
|
+
| ---- | ---- | ----------- | ----- |
|
3922
|
+
| **from** | **Date** | From date: 2020-03-15. | |
|
3923
|
+
| **to** | **Date** | To date: 2020-03-16. | |
|
3924
|
+
|
3925
|
+
### Return type
|
3926
|
+
|
3927
|
+
[**IPOCalendar**](IPOCalendar.md)
|
3928
|
+
|
3929
|
+
### Authorization
|
3930
|
+
|
3931
|
+
[api_key](../README.md#api_key)
|
3932
|
+
|
3933
|
+
### HTTP request headers
|
3934
|
+
|
3935
|
+
- **Content-Type**: Not defined
|
3936
|
+
- **Accept**: application/json
|
3937
|
+
|
3938
|
+
|
3939
|
+
## isin_change
|
3940
|
+
|
3941
|
+
> <IsinChange> isin_change(from, to)
|
3942
|
+
|
3943
|
+
ISIN Change
|
3944
|
+
|
3945
|
+
Get a list of ISIN changes for EU-listed securities. Limit to 2000 events at a time.
|
3946
|
+
|
3947
|
+
### Examples
|
3948
|
+
|
3949
|
+
```ruby
|
3950
|
+
require 'time'
|
3951
|
+
require 'finnhub_ruby'
|
3952
|
+
# setup authorization
|
3953
|
+
FinnhubRuby.configure do |config|
|
3954
|
+
# Configure API key authorization: api_key
|
3955
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
3956
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3957
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
3958
|
+
end
|
3959
|
+
|
3960
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
3961
|
+
from = 'from_example' # String | From date <code>YYYY-MM-DD</code>.
|
3962
|
+
to = 'to_example' # String | To date <code>YYYY-MM-DD</code>.
|
3963
|
+
|
3964
|
+
begin
|
3965
|
+
# ISIN Change
|
3966
|
+
result = api_instance.isin_change(from, to)
|
3967
|
+
p result
|
3968
|
+
rescue FinnhubRuby::ApiError => e
|
3969
|
+
puts "Error when calling DefaultApi->isin_change: #{e}"
|
3970
|
+
end
|
3971
|
+
```
|
3972
|
+
|
3973
|
+
#### Using the isin_change_with_http_info variant
|
3974
|
+
|
3975
|
+
This returns an Array which contains the response data, status code and headers.
|
3976
|
+
|
3977
|
+
> <Array(<IsinChange>, Integer, Hash)> isin_change_with_http_info(from, to)
|
3978
|
+
|
3979
|
+
```ruby
|
3980
|
+
begin
|
3981
|
+
# ISIN Change
|
3982
|
+
data, status_code, headers = api_instance.isin_change_with_http_info(from, to)
|
3983
|
+
p status_code # => 2xx
|
3984
|
+
p headers # => { ... }
|
3985
|
+
p data # => <IsinChange>
|
3986
|
+
rescue FinnhubRuby::ApiError => e
|
3987
|
+
puts "Error when calling DefaultApi->isin_change_with_http_info: #{e}"
|
3988
|
+
end
|
3989
|
+
```
|
3990
|
+
|
3991
|
+
### Parameters
|
3992
|
+
|
3993
|
+
| Name | Type | Description | Notes |
|
3994
|
+
| ---- | ---- | ----------- | ----- |
|
3995
|
+
| **from** | **String** | From date <code>YYYY-MM-DD</code>. | |
|
3996
|
+
| **to** | **String** | To date <code>YYYY-MM-DD</code>. | |
|
3997
|
+
|
3998
|
+
### Return type
|
3999
|
+
|
4000
|
+
[**IsinChange**](IsinChange.md)
|
4001
|
+
|
4002
|
+
### Authorization
|
4003
|
+
|
4004
|
+
[api_key](../README.md#api_key)
|
4005
|
+
|
4006
|
+
### HTTP request headers
|
4007
|
+
|
4008
|
+
- **Content-Type**: Not defined
|
4009
|
+
- **Accept**: application/json
|
4010
|
+
|
4011
|
+
|
4012
|
+
## market_news
|
4013
|
+
|
4014
|
+
> <Array<MarketNews>> market_news(category, opts)
|
4015
|
+
|
4016
|
+
Market News
|
4017
|
+
|
4018
|
+
Get latest market news.
|
4019
|
+
|
4020
|
+
### Examples
|
4021
|
+
|
4022
|
+
```ruby
|
4023
|
+
require 'time'
|
4024
|
+
require 'finnhub_ruby'
|
4025
|
+
# setup authorization
|
4026
|
+
FinnhubRuby.configure do |config|
|
4027
|
+
# Configure API key authorization: api_key
|
4028
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
4029
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4030
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
4031
|
+
end
|
4032
|
+
|
4033
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
4034
|
+
category = 'category_example' # String | This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>.
|
4035
|
+
opts = {
|
4036
|
+
min_id: 789 # Integer | Use this field to get only news after this ID. Default to 0
|
4037
|
+
}
|
4038
|
+
|
4039
|
+
begin
|
4040
|
+
# Market News
|
4041
|
+
result = api_instance.market_news(category, opts)
|
4042
|
+
p result
|
4043
|
+
rescue FinnhubRuby::ApiError => e
|
4044
|
+
puts "Error when calling DefaultApi->market_news: #{e}"
|
4045
|
+
end
|
4046
|
+
```
|
4047
|
+
|
4048
|
+
#### Using the market_news_with_http_info variant
|
4049
|
+
|
4050
|
+
This returns an Array which contains the response data, status code and headers.
|
4051
|
+
|
4052
|
+
> <Array(<Array<MarketNews>>, Integer, Hash)> market_news_with_http_info(category, opts)
|
4053
|
+
|
4054
|
+
```ruby
|
4055
|
+
begin
|
4056
|
+
# Market News
|
4057
|
+
data, status_code, headers = api_instance.market_news_with_http_info(category, opts)
|
4058
|
+
p status_code # => 2xx
|
4059
|
+
p headers # => { ... }
|
4060
|
+
p data # => <Array<MarketNews>>
|
4061
|
+
rescue FinnhubRuby::ApiError => e
|
4062
|
+
puts "Error when calling DefaultApi->market_news_with_http_info: #{e}"
|
4063
|
+
end
|
4064
|
+
```
|
4065
|
+
|
4066
|
+
### Parameters
|
4067
|
+
|
4068
|
+
| Name | Type | Description | Notes |
|
4069
|
+
| ---- | ---- | ----------- | ----- |
|
4070
|
+
| **category** | **String** | This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>. | |
|
4071
|
+
| **min_id** | **Integer** | Use this field to get only news after this ID. Default to 0 | [optional] |
|
4072
|
+
|
4073
|
+
### Return type
|
4074
|
+
|
4075
|
+
[**Array<MarketNews>**](MarketNews.md)
|
4076
|
+
|
4077
|
+
### Authorization
|
4078
|
+
|
4079
|
+
[api_key](../README.md#api_key)
|
4080
|
+
|
4081
|
+
### HTTP request headers
|
4082
|
+
|
4083
|
+
- **Content-Type**: Not defined
|
4084
|
+
- **Accept**: application/json
|
4085
|
+
|
4086
|
+
|
4087
|
+
## mutual_fund_country_exposure
|
3622
4088
|
|
3623
4089
|
> <MutualFundCountryExposure> mutual_fund_country_exposure(symbol)
|
3624
4090
|
|
@@ -3689,13 +4155,155 @@ end
|
|
3689
4155
|
- **Accept**: application/json
|
3690
4156
|
|
3691
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
|
+
|
3692
4300
|
## mutual_fund_holdings
|
3693
4301
|
|
3694
4302
|
> <MutualFundHoldings> mutual_fund_holdings(opts)
|
3695
4303
|
|
3696
4304
|
Mutual Funds Holdings
|
3697
4305
|
|
3698
|
-
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>.
|
3699
4307
|
|
3700
4308
|
### Examples
|
3701
4309
|
|
@@ -3772,7 +4380,7 @@ end
|
|
3772
4380
|
|
3773
4381
|
Mutual Funds Profile
|
3774
4382
|
|
3775
|
-
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>.
|
3776
4384
|
|
3777
4385
|
### Examples
|
3778
4386
|
|
@@ -4208,6 +4816,81 @@ end
|
|
4208
4816
|
- **Accept**: application/json
|
4209
4817
|
|
4210
4818
|
|
4819
|
+
## price_metrics
|
4820
|
+
|
4821
|
+
> <PriceMetrics> price_metrics(symbol, opts)
|
4822
|
+
|
4823
|
+
Price Metrics
|
4824
|
+
|
4825
|
+
Get company price performance statistics such as 52-week high/low, YTD return and much more.
|
4826
|
+
|
4827
|
+
### Examples
|
4828
|
+
|
4829
|
+
```ruby
|
4830
|
+
require 'time'
|
4831
|
+
require 'finnhub_ruby'
|
4832
|
+
# setup authorization
|
4833
|
+
FinnhubRuby.configure do |config|
|
4834
|
+
# Configure API key authorization: api_key
|
4835
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
4836
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4837
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
4838
|
+
end
|
4839
|
+
|
4840
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
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
|
+
}
|
4845
|
+
|
4846
|
+
begin
|
4847
|
+
# Price Metrics
|
4848
|
+
result = api_instance.price_metrics(symbol, opts)
|
4849
|
+
p result
|
4850
|
+
rescue FinnhubRuby::ApiError => e
|
4851
|
+
puts "Error when calling DefaultApi->price_metrics: #{e}"
|
4852
|
+
end
|
4853
|
+
```
|
4854
|
+
|
4855
|
+
#### Using the price_metrics_with_http_info variant
|
4856
|
+
|
4857
|
+
This returns an Array which contains the response data, status code and headers.
|
4858
|
+
|
4859
|
+
> <Array(<PriceMetrics>, Integer, Hash)> price_metrics_with_http_info(symbol, opts)
|
4860
|
+
|
4861
|
+
```ruby
|
4862
|
+
begin
|
4863
|
+
# Price Metrics
|
4864
|
+
data, status_code, headers = api_instance.price_metrics_with_http_info(symbol, opts)
|
4865
|
+
p status_code # => 2xx
|
4866
|
+
p headers # => { ... }
|
4867
|
+
p data # => <PriceMetrics>
|
4868
|
+
rescue FinnhubRuby::ApiError => e
|
4869
|
+
puts "Error when calling DefaultApi->price_metrics_with_http_info: #{e}"
|
4870
|
+
end
|
4871
|
+
```
|
4872
|
+
|
4873
|
+
### Parameters
|
4874
|
+
|
4875
|
+
| Name | Type | Description | Notes |
|
4876
|
+
| ---- | ---- | ----------- | ----- |
|
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] |
|
4879
|
+
|
4880
|
+
### Return type
|
4881
|
+
|
4882
|
+
[**PriceMetrics**](PriceMetrics.md)
|
4883
|
+
|
4884
|
+
### Authorization
|
4885
|
+
|
4886
|
+
[api_key](../README.md#api_key)
|
4887
|
+
|
4888
|
+
### HTTP request headers
|
4889
|
+
|
4890
|
+
- **Content-Type**: Not defined
|
4891
|
+
- **Accept**: application/json
|
4892
|
+
|
4893
|
+
|
4211
4894
|
## price_target
|
4212
4895
|
|
4213
4896
|
> <PriceTarget> price_target(symbol)
|
@@ -5327,7 +6010,7 @@ end
|
|
5327
6010
|
|
5328
6011
|
Tick Data
|
5329
6012
|
|
5330
|
-
<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>
|
5331
6014
|
|
5332
6015
|
### Examples
|
5333
6016
|
|
@@ -5767,6 +6450,79 @@ end
|
|
5767
6450
|
- **Accept**: application/json
|
5768
6451
|
|
5769
6452
|
|
6453
|
+
## symbol_change
|
6454
|
+
|
6455
|
+
> <SymbolChange> symbol_change(from, to)
|
6456
|
+
|
6457
|
+
Symbol Change
|
6458
|
+
|
6459
|
+
Get a list of symbol changes for US-listed, EU-listed, NSE and ASX securities. Limit to 2000 events at a time.
|
6460
|
+
|
6461
|
+
### Examples
|
6462
|
+
|
6463
|
+
```ruby
|
6464
|
+
require 'time'
|
6465
|
+
require 'finnhub_ruby'
|
6466
|
+
# setup authorization
|
6467
|
+
FinnhubRuby.configure do |config|
|
6468
|
+
# Configure API key authorization: api_key
|
6469
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
6470
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
6471
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
6472
|
+
end
|
6473
|
+
|
6474
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
6475
|
+
from = 'from_example' # String | From date <code>YYYY-MM-DD</code>.
|
6476
|
+
to = 'to_example' # String | To date <code>YYYY-MM-DD</code>.
|
6477
|
+
|
6478
|
+
begin
|
6479
|
+
# Symbol Change
|
6480
|
+
result = api_instance.symbol_change(from, to)
|
6481
|
+
p result
|
6482
|
+
rescue FinnhubRuby::ApiError => e
|
6483
|
+
puts "Error when calling DefaultApi->symbol_change: #{e}"
|
6484
|
+
end
|
6485
|
+
```
|
6486
|
+
|
6487
|
+
#### Using the symbol_change_with_http_info variant
|
6488
|
+
|
6489
|
+
This returns an Array which contains the response data, status code and headers.
|
6490
|
+
|
6491
|
+
> <Array(<SymbolChange>, Integer, Hash)> symbol_change_with_http_info(from, to)
|
6492
|
+
|
6493
|
+
```ruby
|
6494
|
+
begin
|
6495
|
+
# Symbol Change
|
6496
|
+
data, status_code, headers = api_instance.symbol_change_with_http_info(from, to)
|
6497
|
+
p status_code # => 2xx
|
6498
|
+
p headers # => { ... }
|
6499
|
+
p data # => <SymbolChange>
|
6500
|
+
rescue FinnhubRuby::ApiError => e
|
6501
|
+
puts "Error when calling DefaultApi->symbol_change_with_http_info: #{e}"
|
6502
|
+
end
|
6503
|
+
```
|
6504
|
+
|
6505
|
+
### Parameters
|
6506
|
+
|
6507
|
+
| Name | Type | Description | Notes |
|
6508
|
+
| ---- | ---- | ----------- | ----- |
|
6509
|
+
| **from** | **String** | From date <code>YYYY-MM-DD</code>. | |
|
6510
|
+
| **to** | **String** | To date <code>YYYY-MM-DD</code>. | |
|
6511
|
+
|
6512
|
+
### Return type
|
6513
|
+
|
6514
|
+
[**SymbolChange**](SymbolChange.md)
|
6515
|
+
|
6516
|
+
### Authorization
|
6517
|
+
|
6518
|
+
[api_key](../README.md#api_key)
|
6519
|
+
|
6520
|
+
### HTTP request headers
|
6521
|
+
|
6522
|
+
- **Content-Type**: Not defined
|
6523
|
+
- **Accept**: application/json
|
6524
|
+
|
6525
|
+
|
5770
6526
|
## symbol_search
|
5771
6527
|
|
5772
6528
|
> <SymbolLookup> symbol_search(q)
|
@@ -5927,7 +6683,7 @@ end
|
|
5927
6683
|
|
5928
6684
|
Earnings Call Transcripts
|
5929
6685
|
|
5930
|
-
<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>
|
5931
6687
|
|
5932
6688
|
### Examples
|
5933
6689
|
|