finnhub_ruby 1.1.4 → 1.1.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/docs/CompanyExecutive.md +1 -1
- data/docs/CompanyNews.md +34 -0
- data/docs/CovidInfo.md +1 -1
- data/docs/DefaultApi.md +135 -66
- data/docs/Development.md +1 -1
- data/docs/{Dividends2Basic.md → Dividends2.md} +3 -3
- data/docs/Dividends2Info.md +20 -0
- data/docs/ETFsCountryExposure.md +1 -1
- data/docs/ETFsHoldings.md +1 -1
- data/docs/ETFsSectorExposure.md +1 -1
- data/docs/EarningsCalendar.md +1 -1
- data/docs/EarningsCallTranscripts.md +3 -3
- data/docs/EarningsCallTranscriptsList.md +1 -1
- data/docs/EarningsEstimates.md +1 -1
- data/docs/EconomicCalendar.md +1 -1
- data/docs/EconomicData.md +1 -1
- data/docs/EconomicDataInfo.md +20 -0
- data/docs/FDAComitteeMeeting.md +2 -2
- data/docs/Filing.md +2 -2
- data/docs/FinancialsAsReported.md +1 -1
- data/docs/FundOwnership.md +1 -1
- data/docs/FundOwnershipInfo.md +26 -0
- data/docs/HistoricalNBBO.md +1 -1
- data/docs/IPOCalendar.md +1 -1
- data/docs/IndicesHistoricalConstituents.md +1 -1
- data/docs/InsiderTransactions.md +1 -1
- data/docs/InternationalFiling.md +1 -1
- data/docs/{InvestmentThemesThematicInvesting.md → InvestmentThemes.md} +3 -3
- data/docs/{News.md → MarketNews.md} +2 -2
- data/docs/MutualFundCountryExposure.md +20 -0
- data/docs/{MutualFundsHoldings.md → MutualFundHoldings.md} +3 -3
- data/docs/MutualFundHoldingsData.md +30 -0
- data/docs/{MutualFundsProfile.md → MutualFundProfile.md} +3 -3
- data/docs/MutualFundProfileData.md +58 -0
- data/docs/MutualFundSectorExposure.md +1 -1
- data/docs/Ownership.md +1 -1
- data/docs/{Investor.md → OwnershipInfo.md} +2 -2
- data/docs/{MajorPressReleases.md → PressRelease.md} +3 -3
- data/docs/PriceTarget.md +1 -1
- data/docs/RedditSentimentContent.md +1 -1
- data/docs/Report.md +4 -4
- data/docs/RevenueBreakdown.md +1 -1
- data/docs/RevenueEstimates.md +1 -1
- data/docs/SimilarityIndex.md +1 -1
- data/docs/SocialSentiment.md +2 -2
- data/docs/StockSymbol.md +30 -0
- data/docs/StockTranscripts.md +1 -1
- data/docs/SupplyChainRelationships.md +1 -1
- data/docs/SymbolLookup.md +1 -1
- data/docs/{Stock.md → SymbolLookupInfo.md} +2 -2
- data/docs/TickData.md +1 -1
- data/docs/TwitterSentimentContent.md +1 -1
- data/finnhub_ruby-1.1.4.gem +0 -0
- data/lib/finnhub_ruby.rb +16 -9
- data/lib/finnhub_ruby/api/default_api.rb +114 -57
- data/lib/finnhub_ruby/models/company_executive.rb +1 -1
- data/lib/finnhub_ruby/models/company_news.rb +299 -0
- data/lib/finnhub_ruby/models/covid_info.rb +1 -1
- data/lib/finnhub_ruby/models/development.rb +1 -1
- data/lib/finnhub_ruby/models/dividends2.rb +231 -0
- data/lib/finnhub_ruby/models/dividends2_info.rb +229 -0
- data/lib/finnhub_ruby/models/earnings_calendar.rb +1 -1
- data/lib/finnhub_ruby/models/earnings_call_transcripts.rb +3 -3
- data/lib/finnhub_ruby/models/earnings_call_transcripts_list.rb +1 -1
- data/lib/finnhub_ruby/models/earnings_estimates.rb +1 -1
- data/lib/finnhub_ruby/models/economic_calendar.rb +1 -1
- data/lib/finnhub_ruby/models/economic_data.rb +1 -1
- data/lib/finnhub_ruby/models/economic_data_info.rb +229 -0
- data/lib/finnhub_ruby/models/etfs_country_exposure.rb +1 -1
- data/lib/finnhub_ruby/models/etfs_holdings.rb +1 -1
- data/lib/finnhub_ruby/models/etfs_sector_exposure.rb +1 -1
- data/lib/finnhub_ruby/models/fda_comittee_meeting.rb +2 -2
- data/lib/finnhub_ruby/models/filing.rb +2 -2
- data/lib/finnhub_ruby/models/financials_as_reported.rb +1 -1
- data/lib/finnhub_ruby/models/fund_ownership.rb +1 -1
- data/lib/finnhub_ruby/models/fund_ownership_info.rb +259 -0
- data/lib/finnhub_ruby/models/historical_nbbo.rb +1 -1
- data/lib/finnhub_ruby/models/indices_historical_constituents.rb +1 -1
- data/lib/finnhub_ruby/models/insider_transactions.rb +1 -1
- data/lib/finnhub_ruby/models/international_filing.rb +1 -1
- data/lib/finnhub_ruby/models/investment_themes.rb +231 -0
- data/lib/finnhub_ruby/models/ipo_calendar.rb +1 -1
- data/lib/finnhub_ruby/models/market_news.rb +299 -0
- data/lib/finnhub_ruby/models/mutual_fund_country_exposure.rb +231 -0
- data/lib/finnhub_ruby/models/mutual_fund_holdings.rb +251 -0
- data/lib/finnhub_ruby/models/mutual_fund_holdings_data.rb +279 -0
- data/lib/finnhub_ruby/models/mutual_fund_profile.rb +228 -0
- data/lib/finnhub_ruby/models/mutual_fund_profile_data.rb +419 -0
- data/lib/finnhub_ruby/models/mutual_fund_sector_exposure.rb +1 -1
- data/lib/finnhub_ruby/models/ownership.rb +1 -1
- data/lib/finnhub_ruby/models/ownership_info.rb +249 -0
- data/lib/finnhub_ruby/models/press_release.rb +231 -0
- data/lib/finnhub_ruby/models/price_target.rb +1 -1
- data/lib/finnhub_ruby/models/reddit_sentiment_content.rb +1 -1
- data/lib/finnhub_ruby/models/report.rb +4 -4
- data/lib/finnhub_ruby/models/revenue_breakdown.rb +1 -1
- data/lib/finnhub_ruby/models/revenue_estimates.rb +1 -1
- data/lib/finnhub_ruby/models/similarity_index.rb +1 -1
- data/lib/finnhub_ruby/models/social_sentiment.rb +2 -2
- data/lib/finnhub_ruby/models/stock_symbol.rb +279 -0
- data/lib/finnhub_ruby/models/stock_transcripts.rb +1 -1
- data/lib/finnhub_ruby/models/supply_chain_relationships.rb +1 -1
- data/lib/finnhub_ruby/models/symbol_lookup.rb +1 -1
- data/lib/finnhub_ruby/models/symbol_lookup_info.rb +249 -0
- data/lib/finnhub_ruby/models/tick_data.rb +1 -1
- data/lib/finnhub_ruby/models/twitter_sentiment_content.rb +1 -1
- data/lib/finnhub_ruby/version.rb +1 -1
- data/release.sh +7 -2
- data/spec/models/aggregate_indicators_spec.rb +4 -11
- data/spec/models/basic_financials_spec.rb +10 -11
- data/spec/models/company_executive_spec.rb +4 -11
- data/spec/models/{news_spec.rb → company_news_spec.rb} +7 -14
- data/spec/models/company_news_statistics_spec.rb +4 -11
- data/spec/models/company_profile2_spec.rb +4 -11
- data/spec/models/company_profile_spec.rb +4 -11
- data/spec/models/company_spec.rb +4 -11
- data/spec/models/country_metadata_spec.rb +4 -11
- data/spec/models/covid_info_spec.rb +4 -11
- data/spec/models/crypto_candles_spec.rb +4 -11
- data/spec/models/crypto_symbol_spec.rb +4 -11
- data/spec/models/development_spec.rb +10 -11
- data/spec/models/dividends2_info_spec.rb +40 -0
- data/spec/models/{dividends2_basic_spec.rb → dividends2_spec.rb} +6 -6
- data/spec/models/dividends_spec.rb +4 -11
- data/spec/models/earning_estimate_spec.rb +4 -11
- data/spec/models/earning_release_spec.rb +4 -11
- data/spec/models/earning_result_spec.rb +16 -11
- data/spec/models/earnings_calendar_spec.rb +4 -11
- data/spec/models/earnings_call_transcripts_list_spec.rb +4 -11
- data/spec/models/earnings_call_transcripts_spec.rb +4 -11
- data/spec/models/earnings_estimates_spec.rb +4 -11
- data/spec/models/economic_calendar_spec.rb +4 -11
- data/spec/models/economic_code_spec.rb +4 -11
- data/spec/models/economic_data_info_spec.rb +40 -0
- data/spec/models/economic_data_spec.rb +4 -11
- data/spec/models/economic_event_spec.rb +4 -11
- data/spec/models/estimate_spec.rb +4 -11
- data/spec/models/etf_country_exposure_data_spec.rb +4 -11
- data/spec/models/etf_holdings_data_spec.rb +28 -11
- data/spec/models/etf_sector_exposure_data_spec.rb +4 -11
- data/spec/models/filing_spec.rb +4 -11
- data/spec/models/financial_statements_spec.rb +4 -11
- data/spec/models/financials_as_reported_spec.rb +4 -11
- data/spec/models/forex_candles_spec.rb +4 -11
- data/spec/models/forex_symbol_spec.rb +4 -11
- data/spec/models/forexrates_spec.rb +4 -11
- data/spec/models/fund_ownership_info_spec.rb +58 -0
- data/spec/models/fund_ownership_spec.rb +4 -11
- data/spec/models/index_historical_constituent_spec.rb +4 -11
- data/spec/models/indicator_spec.rb +4 -11
- data/spec/models/indices_constituents_spec.rb +4 -11
- data/spec/models/indices_historical_constituents_spec.rb +4 -11
- data/spec/models/{investment_themes_thematic_investing_spec.rb → investment_themes_spec.rb} +6 -6
- data/spec/models/ipo_calendar_spec.rb +4 -11
- data/spec/models/ipo_event_spec.rb +4 -11
- data/spec/models/last_bid_ask_spec.rb +4 -11
- data/spec/models/market_news_spec.rb +82 -0
- data/spec/models/{mutual_funds_country_exposure_spec.rb → mutual_fund_country_exposure_spec.rb} +6 -6
- data/spec/models/mutual_fund_holdings_data_spec.rb +70 -0
- data/spec/models/{mutual_funds_holdings_spec.rb → mutual_fund_holdings_spec.rb} +6 -6
- data/spec/models/mutual_fund_profile_data_spec.rb +154 -0
- data/spec/models/{mutual_funds_profile_spec.rb → mutual_fund_profile_spec.rb} +6 -6
- data/spec/models/news_sentiment_spec.rb +4 -11
- data/spec/models/{investor_spec.rb → ownership_info_spec.rb} +7 -14
- data/spec/models/pattern_recognition_spec.rb +4 -11
- data/spec/models/{major_press_releases_spec.rb → press_release_spec.rb} +6 -6
- data/spec/models/price_target_spec.rb +4 -11
- data/spec/models/quote_spec.rb +16 -11
- data/spec/models/recommendation_trend_spec.rb +4 -11
- data/spec/models/report_spec.rb +4 -11
- data/spec/models/revenue_estimates_spec.rb +4 -11
- data/spec/models/sentiment_spec.rb +4 -11
- data/spec/models/similarity_index_spec.rb +4 -11
- data/spec/models/split_spec.rb +4 -11
- data/spec/models/stock_candles_spec.rb +4 -11
- data/spec/models/stock_symbol_spec.rb +70 -0
- data/spec/models/stock_transcripts_spec.rb +4 -11
- data/spec/models/support_resistance_spec.rb +4 -11
- data/spec/models/{stock_spec.rb → symbol_lookup_info_spec.rb} +7 -20
- data/spec/models/technical_analysis_spec.rb +4 -11
- data/spec/models/tick_data_spec.rb +10 -11
- data/spec/models/transcript_content_spec.rb +10 -11
- data/spec/models/transcript_participant_spec.rb +10 -11
- data/spec/models/trend_spec.rb +4 -11
- data/spec/models/upgrade_downgrade_spec.rb +4 -11
- metadata +67 -44
- data/docs/ETFsIndustryExposure.md +0 -19
- data/docs/InvestorsOwnership.md +0 -19
- data/docs/MajorDevelopments.md +0 -19
- data/docs/MutualFundsCountryExposure.md +0 -20
- data/spec/models/et_fs_country_exposure_spec.rb +0 -47
- data/spec/models/et_fs_holdings_spec.rb +0 -47
- data/spec/models/et_fs_industry_exposure_spec.rb +0 -47
- data/spec/models/et_fs_profile_spec.rb +0 -47
- data/spec/models/investors_ownership_spec.rb +0 -47
- data/spec/models/major_developments_spec.rb +0 -47
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d6df6c66a84be7b48cab570974fd79d1599d5abe935eb4aa6e74999f0e3ad693
|
4
|
+
data.tar.gz: e3ad7ca361ed659a7d3117614d8eaea99b849b9d8c46442332592aba9ed40c41
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 264b20a3c6cebb3aa2a8a1f585135175117854e5626d069e11a614411ac5f92f6faa3e047607d5aff9cd4d20548ec16a0947f0beb2f1ebf389630b572a500a6c
|
7
|
+
data.tar.gz: 392df011ae4bd4bcc681d11561f75f596dc8ce66c5a1af0f54f787d19bd6b4bcf6436fe357ea790ef6285874d4da0023fae3431933bc81f9535ff3b75b35f5a2
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# finnhub-ruby
|
2
2
|
- API documentation: https://finnhub.io/docs/api
|
3
3
|
- API version: 1.0.0
|
4
|
-
- Package version: 1.1.
|
4
|
+
- Package version: 1.1.5
|
5
5
|
|
6
6
|
## Installation
|
7
7
|
https://rubygems.org/gems/finnhub_ruby
|
@@ -129,7 +129,7 @@ puts(finnhub_client.recommendation_trends('AAPL'))
|
|
129
129
|
puts(finnhub_client.stock_dividends('KO', '2019-01-01', '2020-01-01'))
|
130
130
|
|
131
131
|
# Transcripts
|
132
|
-
puts(finnhub_client.
|
132
|
+
puts(finnhub_client.transcripts('AAPL_162777'))
|
133
133
|
|
134
134
|
# Transcripts list
|
135
135
|
puts(finnhub_client.transcripts_list('AAPL'))
|
@@ -201,7 +201,7 @@ puts(finnhub_client.revenue_breakdown({symbol:'AAPL'}))
|
|
201
201
|
puts(finnhub_client.social_sentiment('GME'))
|
202
202
|
|
203
203
|
# Investment theme
|
204
|
-
puts(finnhub_client.
|
204
|
+
puts(finnhub_client.investment_themes('financialExchangesData'))
|
205
205
|
|
206
206
|
# Supply chain
|
207
207
|
puts(finnhub_client.supply_chain_relationships('AAPL'))
|
data/docs/CompanyExecutive.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **symbol** | **String** | Company symbol. | [optional] |
|
8
|
-
| **executive** | **Array<
|
8
|
+
| **executive** | [**Array<Company>**](Company.md) | Array of company's executives and members of the Board. | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
data/docs/CompanyNews.md
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# FinnhubRuby::CompanyNews
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **category** | **String** | News category. | [optional] |
|
8
|
+
| **datetime** | **Integer** | Published time in UNIX timestamp. | [optional] |
|
9
|
+
| **headline** | **String** | News headline. | [optional] |
|
10
|
+
| **id** | **Integer** | News ID. This value can be used for <code>minId</code> params to get the latest news only. | [optional] |
|
11
|
+
| **image** | **String** | Thumbnail image URL. | [optional] |
|
12
|
+
| **related** | **String** | Related stocks and companies mentioned in the article. | [optional] |
|
13
|
+
| **source** | **String** | News source. | [optional] |
|
14
|
+
| **summary** | **String** | News summary. | [optional] |
|
15
|
+
| **url** | **String** | URL of the original article. | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'finnhub_ruby'
|
21
|
+
|
22
|
+
instance = FinnhubRuby::CompanyNews.new(
|
23
|
+
category: null,
|
24
|
+
datetime: null,
|
25
|
+
headline: null,
|
26
|
+
id: null,
|
27
|
+
image: null,
|
28
|
+
related: null,
|
29
|
+
source: null,
|
30
|
+
summary: null,
|
31
|
+
url: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
data/docs/CovidInfo.md
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
| **state** | **String** | State. | [optional] |
|
8
8
|
| **_case** | **Float** | Number of confirmed cases. | [optional] |
|
9
9
|
| **death** | **Float** | Number of confirmed deaths. | [optional] |
|
10
|
-
| **updated** | **
|
10
|
+
| **updated** | **String** | Updated time. | [optional] |
|
11
11
|
|
12
12
|
## Example
|
13
13
|
|
data/docs/DefaultApi.md
CHANGED
@@ -20,7 +20,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
20
20
|
| [**crypto_exchanges**](DefaultApi.md#crypto_exchanges) | **GET** /crypto/exchange | Crypto Exchanges |
|
21
21
|
| [**crypto_symbols**](DefaultApi.md#crypto_symbols) | **GET** /crypto/symbol | Crypto Symbol |
|
22
22
|
| [**earnings_calendar**](DefaultApi.md#earnings_calendar) | **GET** /calendar/earnings | Earnings Calendar |
|
23
|
-
| [**
|
23
|
+
| [**economic_calendar**](DefaultApi.md#economic_calendar) | **GET** /calendar/economic | Economic Calendar |
|
24
24
|
| [**economic_code**](DefaultApi.md#economic_code) | **GET** /economic/code | Economic Code |
|
25
25
|
| [**economic_data**](DefaultApi.md#economic_data) | **GET** /economic | Economic Data |
|
26
26
|
| [**etfs_country_exposure**](DefaultApi.md#etfs_country_exposure) | **GET** /etf/country | ETFs Country Exposure |
|
@@ -41,13 +41,13 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
41
41
|
| [**indices_historical_constituents**](DefaultApi.md#indices_historical_constituents) | **GET** /index/historical-constituents | Indices Historical Constituents |
|
42
42
|
| [**insider_transactions**](DefaultApi.md#insider_transactions) | **GET** /stock/insider-transactions | Insider Transactions |
|
43
43
|
| [**international_filings**](DefaultApi.md#international_filings) | **GET** /stock/international-filings | International Filings |
|
44
|
-
| [**
|
44
|
+
| [**investment_themes**](DefaultApi.md#investment_themes) | **GET** /stock/investment-theme | Investment Themes (Thematic Investing) |
|
45
45
|
| [**ipo_calendar**](DefaultApi.md#ipo_calendar) | **GET** /calendar/ipo | IPO Calendar |
|
46
46
|
| [**market_news**](DefaultApi.md#market_news) | **GET** /news | Market News |
|
47
47
|
| [**mutual_fund_country_exposure**](DefaultApi.md#mutual_fund_country_exposure) | **GET** /mutual-fund/country | Mutual Funds Country Exposure |
|
48
48
|
| [**mutual_fund_holdings**](DefaultApi.md#mutual_fund_holdings) | **GET** /mutual-fund/holdings | Mutual Funds Holdings |
|
49
49
|
| [**mutual_fund_profile**](DefaultApi.md#mutual_fund_profile) | **GET** /mutual-fund/profile | Mutual Funds Profile |
|
50
|
-
| [**mutual_fund_sector_exposure**](DefaultApi.md#mutual_fund_sector_exposure) | **GET** /mutual-fund/sector | Mutual
|
50
|
+
| [**mutual_fund_sector_exposure**](DefaultApi.md#mutual_fund_sector_exposure) | **GET** /mutual-fund/sector | Mutual Funds Sector Exposure |
|
51
51
|
| [**news_sentiment**](DefaultApi.md#news_sentiment) | **GET** /news-sentiment | News Sentiment |
|
52
52
|
| [**ownership**](DefaultApi.md#ownership) | **GET** /stock/ownership | Ownership |
|
53
53
|
| [**pattern_recognition**](DefaultApi.md#pattern_recognition) | **GET** /scan/pattern | Pattern Recognition |
|
@@ -70,6 +70,7 @@ All URIs are relative to *https://finnhub.io/api/v1*
|
|
70
70
|
| [**support_resistance**](DefaultApi.md#support_resistance) | **GET** /scan/support-resistance | Support/Resistance |
|
71
71
|
| [**symbol_search**](DefaultApi.md#symbol_search) | **GET** /search | Symbol Lookup |
|
72
72
|
| [**technical_indicator**](DefaultApi.md#technical_indicator) | **POST** /indicator | Technical Indicators |
|
73
|
+
| [**transcripts**](DefaultApi.md#transcripts) | **GET** /stock/transcripts | Earnings Call Transcripts |
|
73
74
|
| [**transcripts_list**](DefaultApi.md#transcripts_list) | **GET** /stock/transcripts/list | Earnings Call Transcripts List |
|
74
75
|
| [**upgrade_downgrade**](DefaultApi.md#upgrade_downgrade) | **GET** /stock/upgrade-downgrade | Stock Upgrade/Downgrade |
|
75
76
|
|
@@ -443,7 +444,7 @@ end
|
|
443
444
|
|
444
445
|
## company_news
|
445
446
|
|
446
|
-
> <Array<
|
447
|
+
> <Array<CompanyNews>> company_news(symbol, from, to)
|
447
448
|
|
448
449
|
Company News
|
449
450
|
|
@@ -480,7 +481,7 @@ end
|
|
480
481
|
|
481
482
|
This returns an Array which contains the response data, status code and headers.
|
482
483
|
|
483
|
-
> <Array(<Array<
|
484
|
+
> <Array(<Array<CompanyNews>>, Integer, Hash)> company_news_with_http_info(symbol, from, to)
|
484
485
|
|
485
486
|
```ruby
|
486
487
|
begin
|
@@ -488,7 +489,7 @@ begin
|
|
488
489
|
data, status_code, headers = api_instance.company_news_with_http_info(symbol, from, to)
|
489
490
|
p status_code # => 2xx
|
490
491
|
p headers # => { ... }
|
491
|
-
p data # => <Array<
|
492
|
+
p data # => <Array<CompanyNews>>
|
492
493
|
rescue FinnhubRuby::ApiError => e
|
493
494
|
puts "Error when calling DefaultApi->company_news_with_http_info: #{e}"
|
494
495
|
end
|
@@ -504,7 +505,7 @@ end
|
|
504
505
|
|
505
506
|
### Return type
|
506
507
|
|
507
|
-
[**Array<
|
508
|
+
[**Array<CompanyNews>**](CompanyNews.md)
|
508
509
|
|
509
510
|
### Authorization
|
510
511
|
|
@@ -1247,13 +1248,13 @@ end
|
|
1247
1248
|
- **Accept**: application/json
|
1248
1249
|
|
1249
1250
|
|
1250
|
-
##
|
1251
|
+
## economic_calendar
|
1251
1252
|
|
1252
|
-
> <
|
1253
|
+
> <EconomicCalendar> economic_calendar
|
1253
1254
|
|
1254
|
-
|
1255
|
+
Economic Calendar
|
1255
1256
|
|
1256
|
-
<p>Get
|
1257
|
+
<p>Get recent and upcoming economic releases.</p><p>Historical events and surprises are available for Enterprise clients.</p>
|
1257
1258
|
|
1258
1259
|
### Examples
|
1259
1260
|
|
@@ -1269,44 +1270,41 @@ FinnhubRuby.configure do |config|
|
|
1269
1270
|
end
|
1270
1271
|
|
1271
1272
|
api_instance = FinnhubRuby::DefaultApi.new
|
1272
|
-
id = 'id_example' # String | Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>.
|
1273
1273
|
|
1274
1274
|
begin
|
1275
|
-
#
|
1276
|
-
result = api_instance.
|
1275
|
+
# Economic Calendar
|
1276
|
+
result = api_instance.economic_calendar
|
1277
1277
|
p result
|
1278
1278
|
rescue FinnhubRuby::ApiError => e
|
1279
|
-
puts "Error when calling DefaultApi->
|
1279
|
+
puts "Error when calling DefaultApi->economic_calendar: #{e}"
|
1280
1280
|
end
|
1281
1281
|
```
|
1282
1282
|
|
1283
|
-
#### Using the
|
1283
|
+
#### Using the economic_calendar_with_http_info variant
|
1284
1284
|
|
1285
1285
|
This returns an Array which contains the response data, status code and headers.
|
1286
1286
|
|
1287
|
-
> <Array(<
|
1287
|
+
> <Array(<EconomicCalendar>, Integer, Hash)> economic_calendar_with_http_info
|
1288
1288
|
|
1289
1289
|
```ruby
|
1290
1290
|
begin
|
1291
|
-
#
|
1292
|
-
data, status_code, headers = api_instance.
|
1291
|
+
# Economic Calendar
|
1292
|
+
data, status_code, headers = api_instance.economic_calendar_with_http_info
|
1293
1293
|
p status_code # => 2xx
|
1294
1294
|
p headers # => { ... }
|
1295
|
-
p data # => <
|
1295
|
+
p data # => <EconomicCalendar>
|
1296
1296
|
rescue FinnhubRuby::ApiError => e
|
1297
|
-
puts "Error when calling DefaultApi->
|
1297
|
+
puts "Error when calling DefaultApi->economic_calendar_with_http_info: #{e}"
|
1298
1298
|
end
|
1299
1299
|
```
|
1300
1300
|
|
1301
1301
|
### Parameters
|
1302
1302
|
|
1303
|
-
|
1304
|
-
| ---- | ---- | ----------- | ----- |
|
1305
|
-
| **id** | **String** | Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>. | |
|
1303
|
+
This endpoint does not need any parameter.
|
1306
1304
|
|
1307
1305
|
### Return type
|
1308
1306
|
|
1309
|
-
[**
|
1307
|
+
[**EconomicCalendar**](EconomicCalendar.md)
|
1310
1308
|
|
1311
1309
|
### Authorization
|
1312
1310
|
|
@@ -2785,9 +2783,9 @@ end
|
|
2785
2783
|
- **Accept**: application/json
|
2786
2784
|
|
2787
2785
|
|
2788
|
-
##
|
2786
|
+
## investment_themes
|
2789
2787
|
|
2790
|
-
> <
|
2788
|
+
> <InvestmentThemes> investment_themes(theme)
|
2791
2789
|
|
2792
2790
|
Investment Themes (Thematic Investing)
|
2793
2791
|
|
@@ -2811,28 +2809,28 @@ theme = 'theme_example' # String | Investment theme. A full list of themes suppo
|
|
2811
2809
|
|
2812
2810
|
begin
|
2813
2811
|
# Investment Themes (Thematic Investing)
|
2814
|
-
result = api_instance.
|
2812
|
+
result = api_instance.investment_themes(theme)
|
2815
2813
|
p result
|
2816
2814
|
rescue FinnhubRuby::ApiError => e
|
2817
|
-
puts "Error when calling DefaultApi->
|
2815
|
+
puts "Error when calling DefaultApi->investment_themes: #{e}"
|
2818
2816
|
end
|
2819
2817
|
```
|
2820
2818
|
|
2821
|
-
#### Using the
|
2819
|
+
#### Using the investment_themes_with_http_info variant
|
2822
2820
|
|
2823
2821
|
This returns an Array which contains the response data, status code and headers.
|
2824
2822
|
|
2825
|
-
> <Array(<
|
2823
|
+
> <Array(<InvestmentThemes>, Integer, Hash)> investment_themes_with_http_info(theme)
|
2826
2824
|
|
2827
2825
|
```ruby
|
2828
2826
|
begin
|
2829
2827
|
# Investment Themes (Thematic Investing)
|
2830
|
-
data, status_code, headers = api_instance.
|
2828
|
+
data, status_code, headers = api_instance.investment_themes_with_http_info(theme)
|
2831
2829
|
p status_code # => 2xx
|
2832
2830
|
p headers # => { ... }
|
2833
|
-
p data # => <
|
2831
|
+
p data # => <InvestmentThemes>
|
2834
2832
|
rescue FinnhubRuby::ApiError => e
|
2835
|
-
puts "Error when calling DefaultApi->
|
2833
|
+
puts "Error when calling DefaultApi->investment_themes_with_http_info: #{e}"
|
2836
2834
|
end
|
2837
2835
|
```
|
2838
2836
|
|
@@ -2844,7 +2842,7 @@ end
|
|
2844
2842
|
|
2845
2843
|
### Return type
|
2846
2844
|
|
2847
|
-
[**
|
2845
|
+
[**InvestmentThemes**](InvestmentThemes.md)
|
2848
2846
|
|
2849
2847
|
### Authorization
|
2850
2848
|
|
@@ -2931,7 +2929,7 @@ end
|
|
2931
2929
|
|
2932
2930
|
## market_news
|
2933
2931
|
|
2934
|
-
> <Array<
|
2932
|
+
> <Array<MarketNews>> market_news(category, opts)
|
2935
2933
|
|
2936
2934
|
Market News
|
2937
2935
|
|
@@ -2969,7 +2967,7 @@ end
|
|
2969
2967
|
|
2970
2968
|
This returns an Array which contains the response data, status code and headers.
|
2971
2969
|
|
2972
|
-
> <Array(<Array<
|
2970
|
+
> <Array(<Array<MarketNews>>, Integer, Hash)> market_news_with_http_info(category, opts)
|
2973
2971
|
|
2974
2972
|
```ruby
|
2975
2973
|
begin
|
@@ -2977,7 +2975,7 @@ begin
|
|
2977
2975
|
data, status_code, headers = api_instance.market_news_with_http_info(category, opts)
|
2978
2976
|
p status_code # => 2xx
|
2979
2977
|
p headers # => { ... }
|
2980
|
-
p data # => <Array<
|
2978
|
+
p data # => <Array<MarketNews>>
|
2981
2979
|
rescue FinnhubRuby::ApiError => e
|
2982
2980
|
puts "Error when calling DefaultApi->market_news_with_http_info: #{e}"
|
2983
2981
|
end
|
@@ -2992,7 +2990,7 @@ end
|
|
2992
2990
|
|
2993
2991
|
### Return type
|
2994
2992
|
|
2995
|
-
[**Array<
|
2993
|
+
[**Array<MarketNews>**](MarketNews.md)
|
2996
2994
|
|
2997
2995
|
### Authorization
|
2998
2996
|
|
@@ -3006,7 +3004,7 @@ end
|
|
3006
3004
|
|
3007
3005
|
## mutual_fund_country_exposure
|
3008
3006
|
|
3009
|
-
> <
|
3007
|
+
> <MutualFundCountryExposure> mutual_fund_country_exposure(symbol)
|
3010
3008
|
|
3011
3009
|
Mutual Funds Country Exposure
|
3012
3010
|
|
@@ -3041,7 +3039,7 @@ end
|
|
3041
3039
|
|
3042
3040
|
This returns an Array which contains the response data, status code and headers.
|
3043
3041
|
|
3044
|
-
> <Array(<
|
3042
|
+
> <Array(<MutualFundCountryExposure>, Integer, Hash)> mutual_fund_country_exposure_with_http_info(symbol)
|
3045
3043
|
|
3046
3044
|
```ruby
|
3047
3045
|
begin
|
@@ -3049,7 +3047,7 @@ begin
|
|
3049
3047
|
data, status_code, headers = api_instance.mutual_fund_country_exposure_with_http_info(symbol)
|
3050
3048
|
p status_code # => 2xx
|
3051
3049
|
p headers # => { ... }
|
3052
|
-
p data # => <
|
3050
|
+
p data # => <MutualFundCountryExposure>
|
3053
3051
|
rescue FinnhubRuby::ApiError => e
|
3054
3052
|
puts "Error when calling DefaultApi->mutual_fund_country_exposure_with_http_info: #{e}"
|
3055
3053
|
end
|
@@ -3063,7 +3061,7 @@ end
|
|
3063
3061
|
|
3064
3062
|
### Return type
|
3065
3063
|
|
3066
|
-
[**
|
3064
|
+
[**MutualFundCountryExposure**](MutualFundCountryExposure.md)
|
3067
3065
|
|
3068
3066
|
### Authorization
|
3069
3067
|
|
@@ -3077,7 +3075,7 @@ end
|
|
3077
3075
|
|
3078
3076
|
## mutual_fund_holdings
|
3079
3077
|
|
3080
|
-
> <
|
3078
|
+
> <MutualFundHoldings> mutual_fund_holdings(opts)
|
3081
3079
|
|
3082
3080
|
Mutual Funds Holdings
|
3083
3081
|
|
@@ -3116,7 +3114,7 @@ end
|
|
3116
3114
|
|
3117
3115
|
This returns an Array which contains the response data, status code and headers.
|
3118
3116
|
|
3119
|
-
> <Array(<
|
3117
|
+
> <Array(<MutualFundHoldings>, Integer, Hash)> mutual_fund_holdings_with_http_info(opts)
|
3120
3118
|
|
3121
3119
|
```ruby
|
3122
3120
|
begin
|
@@ -3124,7 +3122,7 @@ begin
|
|
3124
3122
|
data, status_code, headers = api_instance.mutual_fund_holdings_with_http_info(opts)
|
3125
3123
|
p status_code # => 2xx
|
3126
3124
|
p headers # => { ... }
|
3127
|
-
p data # => <
|
3125
|
+
p data # => <MutualFundHoldings>
|
3128
3126
|
rescue FinnhubRuby::ApiError => e
|
3129
3127
|
puts "Error when calling DefaultApi->mutual_fund_holdings_with_http_info: #{e}"
|
3130
3128
|
end
|
@@ -3140,7 +3138,7 @@ end
|
|
3140
3138
|
|
3141
3139
|
### Return type
|
3142
3140
|
|
3143
|
-
[**
|
3141
|
+
[**MutualFundHoldings**](MutualFundHoldings.md)
|
3144
3142
|
|
3145
3143
|
### Authorization
|
3146
3144
|
|
@@ -3154,7 +3152,7 @@ end
|
|
3154
3152
|
|
3155
3153
|
## mutual_fund_profile
|
3156
3154
|
|
3157
|
-
> <
|
3155
|
+
> <MutualFundProfile> mutual_fund_profile(opts)
|
3158
3156
|
|
3159
3157
|
Mutual Funds Profile
|
3160
3158
|
|
@@ -3192,7 +3190,7 @@ end
|
|
3192
3190
|
|
3193
3191
|
This returns an Array which contains the response data, status code and headers.
|
3194
3192
|
|
3195
|
-
> <Array(<
|
3193
|
+
> <Array(<MutualFundProfile>, Integer, Hash)> mutual_fund_profile_with_http_info(opts)
|
3196
3194
|
|
3197
3195
|
```ruby
|
3198
3196
|
begin
|
@@ -3200,7 +3198,7 @@ begin
|
|
3200
3198
|
data, status_code, headers = api_instance.mutual_fund_profile_with_http_info(opts)
|
3201
3199
|
p status_code # => 2xx
|
3202
3200
|
p headers # => { ... }
|
3203
|
-
p data # => <
|
3201
|
+
p data # => <MutualFundProfile>
|
3204
3202
|
rescue FinnhubRuby::ApiError => e
|
3205
3203
|
puts "Error when calling DefaultApi->mutual_fund_profile_with_http_info: #{e}"
|
3206
3204
|
end
|
@@ -3215,7 +3213,7 @@ end
|
|
3215
3213
|
|
3216
3214
|
### Return type
|
3217
3215
|
|
3218
|
-
[**
|
3216
|
+
[**MutualFundProfile**](MutualFundProfile.md)
|
3219
3217
|
|
3220
3218
|
### Authorization
|
3221
3219
|
|
@@ -3231,7 +3229,7 @@ end
|
|
3231
3229
|
|
3232
3230
|
> <MutualFundSectorExposure> mutual_fund_sector_exposure(symbol)
|
3233
3231
|
|
3234
|
-
Mutual
|
3232
|
+
Mutual Funds Sector Exposure
|
3235
3233
|
|
3236
3234
|
Get Mutual Funds sector exposure data.
|
3237
3235
|
|
@@ -3252,7 +3250,7 @@ api_instance = FinnhubRuby::DefaultApi.new
|
|
3252
3250
|
symbol = 'symbol_example' # String | Mutual Fund symbol.
|
3253
3251
|
|
3254
3252
|
begin
|
3255
|
-
# Mutual
|
3253
|
+
# Mutual Funds Sector Exposure
|
3256
3254
|
result = api_instance.mutual_fund_sector_exposure(symbol)
|
3257
3255
|
p result
|
3258
3256
|
rescue FinnhubRuby::ApiError => e
|
@@ -3268,7 +3266,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
3268
3266
|
|
3269
3267
|
```ruby
|
3270
3268
|
begin
|
3271
|
-
# Mutual
|
3269
|
+
# Mutual Funds Sector Exposure
|
3272
3270
|
data, status_code, headers = api_instance.mutual_fund_sector_exposure_with_http_info(symbol)
|
3273
3271
|
p status_code # => 2xx
|
3274
3272
|
p headers # => { ... }
|
@@ -3519,7 +3517,7 @@ end
|
|
3519
3517
|
|
3520
3518
|
## press_releases
|
3521
3519
|
|
3522
|
-
> <
|
3520
|
+
> <PressRelease> press_releases(symbol, opts)
|
3523
3521
|
|
3524
3522
|
Major Press Releases
|
3525
3523
|
|
@@ -3558,7 +3556,7 @@ end
|
|
3558
3556
|
|
3559
3557
|
This returns an Array which contains the response data, status code and headers.
|
3560
3558
|
|
3561
|
-
> <Array(<
|
3559
|
+
> <Array(<PressRelease>, Integer, Hash)> press_releases_with_http_info(symbol, opts)
|
3562
3560
|
|
3563
3561
|
```ruby
|
3564
3562
|
begin
|
@@ -3566,7 +3564,7 @@ begin
|
|
3566
3564
|
data, status_code, headers = api_instance.press_releases_with_http_info(symbol, opts)
|
3567
3565
|
p status_code # => 2xx
|
3568
3566
|
p headers # => { ... }
|
3569
|
-
p data # => <
|
3567
|
+
p data # => <PressRelease>
|
3570
3568
|
rescue FinnhubRuby::ApiError => e
|
3571
3569
|
puts "Error when calling DefaultApi->press_releases_with_http_info: #{e}"
|
3572
3570
|
end
|
@@ -3582,7 +3580,7 @@ end
|
|
3582
3580
|
|
3583
3581
|
### Return type
|
3584
3582
|
|
3585
|
-
[**
|
3583
|
+
[**PressRelease**](PressRelease.md)
|
3586
3584
|
|
3587
3585
|
### Authorization
|
3588
3586
|
|
@@ -4038,7 +4036,7 @@ end
|
|
4038
4036
|
|
4039
4037
|
## stock_basic_dividends
|
4040
4038
|
|
4041
|
-
> <
|
4039
|
+
> <Dividends2> stock_basic_dividends(symbol)
|
4042
4040
|
|
4043
4041
|
Dividends 2 (Basic)
|
4044
4042
|
|
@@ -4073,7 +4071,7 @@ end
|
|
4073
4071
|
|
4074
4072
|
This returns an Array which contains the response data, status code and headers.
|
4075
4073
|
|
4076
|
-
> <Array(<
|
4074
|
+
> <Array(<Dividends2>, Integer, Hash)> stock_basic_dividends_with_http_info(symbol)
|
4077
4075
|
|
4078
4076
|
```ruby
|
4079
4077
|
begin
|
@@ -4081,7 +4079,7 @@ begin
|
|
4081
4079
|
data, status_code, headers = api_instance.stock_basic_dividends_with_http_info(symbol)
|
4082
4080
|
p status_code # => 2xx
|
4083
4081
|
p headers # => { ... }
|
4084
|
-
p data # => <
|
4082
|
+
p data # => <Dividends2>
|
4085
4083
|
rescue FinnhubRuby::ApiError => e
|
4086
4084
|
puts "Error when calling DefaultApi->stock_basic_dividends_with_http_info: #{e}"
|
4087
4085
|
end
|
@@ -4095,7 +4093,7 @@ end
|
|
4095
4093
|
|
4096
4094
|
### Return type
|
4097
4095
|
|
4098
|
-
[**
|
4096
|
+
[**Dividends2**](Dividends2.md)
|
4099
4097
|
|
4100
4098
|
### Authorization
|
4101
4099
|
|
@@ -4488,7 +4486,7 @@ end
|
|
4488
4486
|
|
4489
4487
|
## stock_symbols
|
4490
4488
|
|
4491
|
-
> <Array<
|
4489
|
+
> <Array<StockSymbol>> stock_symbols(exchange, opts)
|
4492
4490
|
|
4493
4491
|
Stock Symbol
|
4494
4492
|
|
@@ -4528,7 +4526,7 @@ end
|
|
4528
4526
|
|
4529
4527
|
This returns an Array which contains the response data, status code and headers.
|
4530
4528
|
|
4531
|
-
> <Array(<Array<
|
4529
|
+
> <Array(<Array<StockSymbol>>, Integer, Hash)> stock_symbols_with_http_info(exchange, opts)
|
4532
4530
|
|
4533
4531
|
```ruby
|
4534
4532
|
begin
|
@@ -4536,7 +4534,7 @@ begin
|
|
4536
4534
|
data, status_code, headers = api_instance.stock_symbols_with_http_info(exchange, opts)
|
4537
4535
|
p status_code # => 2xx
|
4538
4536
|
p headers # => { ... }
|
4539
|
-
p data # => <Array<
|
4537
|
+
p data # => <Array<StockSymbol>>
|
4540
4538
|
rescue FinnhubRuby::ApiError => e
|
4541
4539
|
puts "Error when calling DefaultApi->stock_symbols_with_http_info: #{e}"
|
4542
4540
|
end
|
@@ -4553,7 +4551,7 @@ end
|
|
4553
4551
|
|
4554
4552
|
### Return type
|
4555
4553
|
|
4556
|
-
[**Array<
|
4554
|
+
[**Array<StockSymbol>**](StockSymbol.md)
|
4557
4555
|
|
4558
4556
|
### Authorization
|
4559
4557
|
|
@@ -4940,6 +4938,77 @@ end
|
|
4940
4938
|
- **Accept**: application/json
|
4941
4939
|
|
4942
4940
|
|
4941
|
+
## transcripts
|
4942
|
+
|
4943
|
+
> <EarningsCallTranscripts> transcripts(id)
|
4944
|
+
|
4945
|
+
Earnings Call Transcripts
|
4946
|
+
|
4947
|
+
<p>Get earnings call transcripts, audio and participants' list. This endpoint is only available for US, UK, and Candian companies. <p>15+ years of data is available with 220,000+ audio which add up to 7TB in size.</p>
|
4948
|
+
|
4949
|
+
### Examples
|
4950
|
+
|
4951
|
+
```ruby
|
4952
|
+
require 'time'
|
4953
|
+
require 'finnhub_ruby'
|
4954
|
+
# setup authorization
|
4955
|
+
FinnhubRuby.configure do |config|
|
4956
|
+
# Configure API key authorization: api_key
|
4957
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
4958
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4959
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
4960
|
+
end
|
4961
|
+
|
4962
|
+
api_instance = FinnhubRuby::DefaultApi.new
|
4963
|
+
id = 'id_example' # String | Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>.
|
4964
|
+
|
4965
|
+
begin
|
4966
|
+
# Earnings Call Transcripts
|
4967
|
+
result = api_instance.transcripts(id)
|
4968
|
+
p result
|
4969
|
+
rescue FinnhubRuby::ApiError => e
|
4970
|
+
puts "Error when calling DefaultApi->transcripts: #{e}"
|
4971
|
+
end
|
4972
|
+
```
|
4973
|
+
|
4974
|
+
#### Using the transcripts_with_http_info variant
|
4975
|
+
|
4976
|
+
This returns an Array which contains the response data, status code and headers.
|
4977
|
+
|
4978
|
+
> <Array(<EarningsCallTranscripts>, Integer, Hash)> transcripts_with_http_info(id)
|
4979
|
+
|
4980
|
+
```ruby
|
4981
|
+
begin
|
4982
|
+
# Earnings Call Transcripts
|
4983
|
+
data, status_code, headers = api_instance.transcripts_with_http_info(id)
|
4984
|
+
p status_code # => 2xx
|
4985
|
+
p headers # => { ... }
|
4986
|
+
p data # => <EarningsCallTranscripts>
|
4987
|
+
rescue FinnhubRuby::ApiError => e
|
4988
|
+
puts "Error when calling DefaultApi->transcripts_with_http_info: #{e}"
|
4989
|
+
end
|
4990
|
+
```
|
4991
|
+
|
4992
|
+
### Parameters
|
4993
|
+
|
4994
|
+
| Name | Type | Description | Notes |
|
4995
|
+
| ---- | ---- | ----------- | ----- |
|
4996
|
+
| **id** | **String** | Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>. | |
|
4997
|
+
|
4998
|
+
### Return type
|
4999
|
+
|
5000
|
+
[**EarningsCallTranscripts**](EarningsCallTranscripts.md)
|
5001
|
+
|
5002
|
+
### Authorization
|
5003
|
+
|
5004
|
+
[api_key](../README.md#api_key)
|
5005
|
+
|
5006
|
+
### HTTP request headers
|
5007
|
+
|
5008
|
+
- **Content-Type**: Not defined
|
5009
|
+
- **Accept**: application/json
|
5010
|
+
|
5011
|
+
|
4943
5012
|
## transcripts_list
|
4944
5013
|
|
4945
5014
|
> <EarningsCallTranscriptsList> transcripts_list(symbol)
|