finnhub_ruby 1.1.4 → 1.1.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +46 -12
- data/docs/CompanyESG.md +28 -0
- data/docs/CompanyExecutive.md +1 -1
- data/docs/CompanyNews.md +34 -0
- data/docs/CompanyProfile.md +1 -1
- data/docs/CovidInfo.md +1 -1
- data/docs/DefaultApi.md +214 -77
- 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/EarningRelease.md +2 -2
- 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/EarningsEstimatesInfo.md +26 -0
- 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/IPOEvent.md +2 -2
- 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/KeyCustomersSuppliers.md +13 -1
- 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/RevenueEstimatesInfo.md +26 -0
- data/docs/Sentiment.md +2 -2
- data/docs/SimilarityIndex.md +1 -1
- data/docs/SimilarityIndexInfo.md +40 -0
- 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/Transactions.md +1 -1
- data/docs/TwitterSentimentContent.md +1 -1
- data/finnhub_ruby-1.1.7.gem +0 -0
- data/finnhub_ruby.gemspec +1 -1
- data/lib/finnhub_ruby.rb +21 -12
- data/lib/finnhub_ruby/api/default_api.rb +183 -65
- data/lib/finnhub_ruby/api_client.rb +1 -1
- data/lib/finnhub_ruby/api_error.rb +1 -1
- data/lib/finnhub_ruby/configuration.rb +1 -1
- data/lib/finnhub_ruby/models/aggregate_indicators.rb +1 -1
- data/lib/finnhub_ruby/models/basic_financials.rb +1 -1
- data/lib/finnhub_ruby/models/breakdown_item.rb +1 -1
- data/lib/finnhub_ruby/models/company.rb +1 -1
- data/lib/finnhub_ruby/models/company_esg.rb +268 -0
- data/lib/finnhub_ruby/models/company_executive.rb +2 -2
- data/lib/finnhub_ruby/models/company_news.rb +299 -0
- data/lib/finnhub_ruby/models/company_news_statistics.rb +1 -1
- data/lib/finnhub_ruby/models/company_profile.rb +2 -2
- data/lib/finnhub_ruby/models/company_profile2.rb +1 -1
- data/lib/finnhub_ruby/models/country_metadata.rb +1 -1
- data/lib/finnhub_ruby/models/covid_info.rb +2 -2
- data/lib/finnhub_ruby/models/crypto_candles.rb +1 -1
- data/lib/finnhub_ruby/models/crypto_symbol.rb +1 -1
- data/lib/finnhub_ruby/models/development.rb +2 -2
- data/lib/finnhub_ruby/models/dividends.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/earning_release.rb +3 -3
- data/lib/finnhub_ruby/models/earning_result.rb +1 -1
- data/lib/finnhub_ruby/models/earnings_calendar.rb +2 -2
- data/lib/finnhub_ruby/models/earnings_call_transcripts.rb +4 -4
- data/lib/finnhub_ruby/models/earnings_call_transcripts_list.rb +2 -2
- data/lib/finnhub_ruby/models/earnings_estimates.rb +2 -2
- data/lib/finnhub_ruby/models/earnings_estimates_info.rb +259 -0
- data/lib/finnhub_ruby/models/economic_calendar.rb +2 -2
- data/lib/finnhub_ruby/models/economic_code.rb +1 -1
- data/lib/finnhub_ruby/models/economic_data.rb +2 -2
- data/lib/finnhub_ruby/models/economic_data_info.rb +229 -0
- data/lib/finnhub_ruby/models/economic_event.rb +1 -1
- data/lib/finnhub_ruby/models/etf_country_exposure_data.rb +1 -1
- data/lib/finnhub_ruby/models/etf_holdings_data.rb +1 -1
- data/lib/finnhub_ruby/models/etf_profile_data.rb +1 -1
- data/lib/finnhub_ruby/models/etf_sector_exposure_data.rb +1 -1
- data/lib/finnhub_ruby/models/etfs_country_exposure.rb +2 -2
- data/lib/finnhub_ruby/models/etfs_holdings.rb +2 -2
- data/lib/finnhub_ruby/models/etfs_profile.rb +1 -1
- data/lib/finnhub_ruby/models/etfs_sector_exposure.rb +2 -2
- data/lib/finnhub_ruby/models/fda_comittee_meeting.rb +3 -3
- data/lib/finnhub_ruby/models/filing.rb +3 -3
- data/lib/finnhub_ruby/models/filing_sentiment.rb +1 -1
- data/lib/finnhub_ruby/models/financial_statements.rb +1 -1
- data/lib/finnhub_ruby/models/financials_as_reported.rb +2 -2
- data/lib/finnhub_ruby/models/forex_candles.rb +1 -1
- data/lib/finnhub_ruby/models/forex_symbol.rb +1 -1
- data/lib/finnhub_ruby/models/forexrates.rb +1 -1
- data/lib/finnhub_ruby/models/fund_ownership.rb +2 -2
- data/lib/finnhub_ruby/models/fund_ownership_info.rb +259 -0
- data/lib/finnhub_ruby/models/historical_nbbo.rb +2 -2
- data/lib/finnhub_ruby/models/index_historical_constituent.rb +1 -1
- data/lib/finnhub_ruby/models/indicator.rb +1 -1
- data/lib/finnhub_ruby/models/indices_constituents.rb +1 -1
- data/lib/finnhub_ruby/models/indices_historical_constituents.rb +2 -2
- data/lib/finnhub_ruby/models/insider_transactions.rb +2 -2
- data/lib/finnhub_ruby/models/international_filing.rb +2 -2
- data/lib/finnhub_ruby/models/investment_theme_portfolio.rb +1 -1
- data/lib/finnhub_ruby/models/investment_themes.rb +231 -0
- data/lib/finnhub_ruby/models/ipo_calendar.rb +2 -2
- data/lib/finnhub_ruby/models/ipo_event.rb +3 -3
- data/lib/finnhub_ruby/models/key_customers_suppliers.rb +65 -5
- data/lib/finnhub_ruby/models/last_bid_ask.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_country_exposure_data.rb +1 -1
- 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 +2 -2
- data/lib/finnhub_ruby/models/mutual_fund_sector_exposure_data.rb +1 -1
- data/lib/finnhub_ruby/models/news_sentiment.rb +1 -1
- data/lib/finnhub_ruby/models/ownership.rb +2 -2
- data/lib/finnhub_ruby/models/ownership_info.rb +249 -0
- data/lib/finnhub_ruby/models/pattern_recognition.rb +1 -1
- data/lib/finnhub_ruby/models/press_release.rb +231 -0
- data/lib/finnhub_ruby/models/price_target.rb +2 -2
- data/lib/finnhub_ruby/models/quote.rb +1 -1
- data/lib/finnhub_ruby/models/recommendation_trend.rb +1 -1
- data/lib/finnhub_ruby/models/reddit_sentiment_content.rb +2 -2
- data/lib/finnhub_ruby/models/report.rb +5 -5
- data/lib/finnhub_ruby/models/revenue_breakdown.rb +2 -2
- data/lib/finnhub_ruby/models/revenue_estimates.rb +2 -2
- data/lib/finnhub_ruby/models/revenue_estimates_info.rb +259 -0
- data/lib/finnhub_ruby/models/sec_sentiment_analysis.rb +1 -1
- data/lib/finnhub_ruby/models/sentiment.rb +3 -3
- data/lib/finnhub_ruby/models/similarity_index.rb +2 -2
- data/lib/finnhub_ruby/models/similarity_index_info.rb +329 -0
- data/lib/finnhub_ruby/models/social_sentiment.rb +3 -3
- data/lib/finnhub_ruby/models/split.rb +1 -1
- data/lib/finnhub_ruby/models/stock_candles.rb +1 -1
- data/lib/finnhub_ruby/models/stock_symbol.rb +279 -0
- data/lib/finnhub_ruby/models/stock_transcripts.rb +2 -2
- data/lib/finnhub_ruby/models/supply_chain_relationships.rb +2 -2
- data/lib/finnhub_ruby/models/support_resistance.rb +1 -1
- data/lib/finnhub_ruby/models/symbol_lookup.rb +2 -2
- data/lib/finnhub_ruby/models/symbol_lookup_info.rb +249 -0
- data/lib/finnhub_ruby/models/technical_analysis.rb +1 -1
- data/lib/finnhub_ruby/models/tick_data.rb +2 -2
- data/lib/finnhub_ruby/models/transactions.rb +2 -2
- data/lib/finnhub_ruby/models/transcript_content.rb +1 -1
- data/lib/finnhub_ruby/models/transcript_participant.rb +1 -1
- data/lib/finnhub_ruby/models/trend.rb +1 -1
- data/lib/finnhub_ruby/models/twitter_sentiment_content.rb +2 -2
- data/lib/finnhub_ruby/models/upgrade_downgrade.rb +1 -1
- data/lib/finnhub_ruby/version.rb +2 -2
- data/release.sh +12 -2
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/aggregate_indicators_spec.rb +4 -11
- data/spec/models/basic_financials_spec.rb +10 -11
- data/spec/models/company_esg_spec.rb +64 -0
- 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_info_spec.rb +58 -0
- 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_info_spec.rb +58 -0
- data/spec/models/revenue_estimates_spec.rb +4 -11
- data/spec/models/sentiment_spec.rb +4 -11
- data/spec/models/similarity_index_info_spec.rb +100 -0
- 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
- data/spec/spec_helper.rb +1 -1
- metadata +83 -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
data/docs/Development.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **symbol** | **String** | Company symbol. | [optional] |
|
8
|
-
| **datetime** | **
|
8
|
+
| **datetime** | **String** | Published time in <code>YYYY-MM-DD HH:MM:SS</code> format. | [optional] |
|
9
9
|
| **headline** | **String** | Development headline. | [optional] |
|
10
10
|
| **description** | **String** | Development description. | [optional] |
|
11
11
|
| **url** | **String** | URL. | [optional] |
|
@@ -1,18 +1,18 @@
|
|
1
|
-
# FinnhubRuby::
|
1
|
+
# FinnhubRuby::Dividends2
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **symbol** | **String** | Symbol | [optional] |
|
8
|
-
| **data** | **Array<
|
8
|
+
| **data** | [**Array<Dividends2Info>**](Dividends2Info.md) | | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
12
12
|
```ruby
|
13
13
|
require 'finnhub_ruby'
|
14
14
|
|
15
|
-
instance = FinnhubRuby::
|
15
|
+
instance = FinnhubRuby::Dividends2.new(
|
16
16
|
symbol: null,
|
17
17
|
data: null
|
18
18
|
)
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::Dividends2Info
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **ex_date** | **Date** | Ex-Dividend date. | [optional] |
|
8
|
+
| **amount** | **Float** | Amount in local currency. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::Dividends2Info.new(
|
16
|
+
ex_date: null,
|
17
|
+
amount: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/ETFsCountryExposure.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **symbol** | **String** | ETF symbol. | [optional] |
|
8
|
-
| **country_exposure** | **Array<
|
8
|
+
| **country_exposure** | [**Array<ETFCountryExposureData>**](ETFCountryExposureData.md) | Array of countries and and exposure levels. | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
data/docs/ETFsHoldings.md
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
| **symbol** | **String** | ETF symbol. | [optional] |
|
8
8
|
| **at_date** | **Date** | Holdings update date. | [optional] |
|
9
9
|
| **number_of_holdings** | **Integer** | Number of holdings. | [optional] |
|
10
|
-
| **holdings** | **Array<
|
10
|
+
| **holdings** | [**Array<ETFHoldingsData>**](ETFHoldingsData.md) | Array of holdings. | [optional] |
|
11
11
|
|
12
12
|
## Example
|
13
13
|
|
data/docs/ETFsSectorExposure.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **symbol** | **String** | ETF symbol. | [optional] |
|
8
|
-
| **sector_exposure** | **Array<
|
8
|
+
| **sector_exposure** | [**Array<ETFSectorExposureData>**](ETFSectorExposureData.md) | Array of industries and exposure levels. | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
data/docs/EarningRelease.md
CHANGED
@@ -11,8 +11,8 @@
|
|
11
11
|
| **quarter** | **Integer** | Earnings quarter. | [optional] |
|
12
12
|
| **eps_estimate** | **Float** | EPS estimate. | [optional] |
|
13
13
|
| **eps_actual** | **Float** | EPS actual. | [optional] |
|
14
|
-
| **revenue_estimate** | **
|
15
|
-
| **revenue_actual** | **
|
14
|
+
| **revenue_estimate** | **Float** | Revenue estimate including Finnhub's proprietary estimates. | [optional] |
|
15
|
+
| **revenue_actual** | **Float** | Revenue actual. | [optional] |
|
16
16
|
|
17
17
|
## Example
|
18
18
|
|
data/docs/EarningsCalendar.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **earnings_calendar** | **Array<
|
7
|
+
| **earnings_calendar** | [**Array<EarningRelease>**](EarningRelease.md) | Array of earnings release. | [optional] |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
@@ -5,12 +5,12 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **symbol** | **String** | Company symbol. | [optional] |
|
8
|
-
| **transcript** | **Array<
|
9
|
-
| **participant** | **Array<
|
8
|
+
| **transcript** | [**Array<TranscriptContent>**](TranscriptContent.md) | Transcript content. | [optional] |
|
9
|
+
| **participant** | [**Array<TranscriptParticipant>**](TranscriptParticipant.md) | Participant list | [optional] |
|
10
10
|
| **audio** | **String** | Audio link. | [optional] |
|
11
11
|
| **id** | **String** | Transcript's ID. | [optional] |
|
12
12
|
| **title** | **String** | Title. | [optional] |
|
13
|
-
| **time** | **
|
13
|
+
| **time** | **String** | Time of the event. | [optional] |
|
14
14
|
| **year** | **Integer** | Year of earnings result in the case of earnings call transcript. | [optional] |
|
15
15
|
| **quarter** | **Integer** | Quarter of earnings result in the case of earnings call transcript. | [optional] |
|
16
16
|
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **symbol** | **String** | Company symbol. | [optional] |
|
8
|
-
| **transcripts** | **Array<
|
8
|
+
| **transcripts** | [**Array<StockTranscripts>**](StockTranscripts.md) | Array of transcripts' metadata | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
data/docs/EarningsEstimates.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | **Array<
|
7
|
+
| **data** | [**Array<EarningsEstimatesInfo>**](EarningsEstimatesInfo.md) | List of estimates | [optional] |
|
8
8
|
| **freq** | **String** | Frequency: annual or quarterly. | [optional] |
|
9
9
|
| **symbol** | **String** | Company symbol. | [optional] |
|
10
10
|
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# FinnhubRuby::EarningsEstimatesInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **eps_avg** | **Float** | Average EPS estimates including Finnhub's proprietary estimates. | [optional] |
|
8
|
+
| **eps_high** | **Float** | Highest estimate. | [optional] |
|
9
|
+
| **eps_low** | **Float** | Lowest estimate. | [optional] |
|
10
|
+
| **number_analysts** | **Integer** | Number of Analysts. | [optional] |
|
11
|
+
| **period** | **Date** | Period. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'finnhub_ruby'
|
17
|
+
|
18
|
+
instance = FinnhubRuby::EarningsEstimatesInfo.new(
|
19
|
+
eps_avg: null,
|
20
|
+
eps_high: null,
|
21
|
+
eps_low: null,
|
22
|
+
number_analysts: null,
|
23
|
+
period: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/EconomicCalendar.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **economic_calendar** | **Array<
|
7
|
+
| **economic_calendar** | [**Array<EconomicEvent>**](EconomicEvent.md) | Array of economic events. | [optional] |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
data/docs/EconomicData.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **data** | **Array<
|
7
|
+
| **data** | [**Array<EconomicDataInfo>**](EconomicDataInfo.md) | Array of economic data for requested code. | [optional] |
|
8
8
|
| **code** | **String** | Finnhub economic code | [optional] |
|
9
9
|
|
10
10
|
## Example
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::EconomicDataInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **date** | **String** | Date of the reading | [optional] |
|
8
|
+
| **value** | **Float** | Value | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::EconomicDataInfo.new(
|
16
|
+
date: null,
|
17
|
+
value: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/FDAComitteeMeeting.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **from_date** | **
|
8
|
-
| **to_date** | **
|
7
|
+
| **from_date** | **String** | Start time of the event in EST. | [optional] |
|
8
|
+
| **to_date** | **String** | End time of the event in EST. | [optional] |
|
9
9
|
| **event_description** | **String** | Event's description. | [optional] |
|
10
10
|
| **url** | **String** | URL. | [optional] |
|
11
11
|
|
data/docs/Filing.md
CHANGED
@@ -8,8 +8,8 @@
|
|
8
8
|
| **symbol** | **String** | Symbol. | [optional] |
|
9
9
|
| **cik** | **String** | CIK. | [optional] |
|
10
10
|
| **form** | **String** | Form type. | [optional] |
|
11
|
-
| **filed_date** | **
|
12
|
-
| **accepted_date** | **
|
11
|
+
| **filed_date** | **String** | Filed date <code>%Y-%m-%d %H:%M:%S</code>. | [optional] |
|
12
|
+
| **accepted_date** | **String** | Accepted date <code>%Y-%m-%d %H:%M:%S</code>. | [optional] |
|
13
13
|
| **report_url** | **String** | Report's URL. | [optional] |
|
14
14
|
| **filing_url** | **String** | Filing's URL. | [optional] |
|
15
15
|
|
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **symbol** | **String** | Symbol | [optional] |
|
8
8
|
| **cik** | **String** | CIK | [optional] |
|
9
|
-
| **data** | **Array<
|
9
|
+
| **data** | [**Array<Report>**](Report.md) | Array of filings. | [optional] |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
data/docs/FundOwnership.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **symbol** | **String** | Symbol of the company. | [optional] |
|
8
|
-
| **ownership** | **Array<
|
8
|
+
| **ownership** | [**Array<FundOwnershipInfo>**](FundOwnershipInfo.md) | Array of investors with detailed information about their holdings. | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# FinnhubRuby::FundOwnershipInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | Investor's name. | [optional] |
|
8
|
+
| **share** | **Integer** | Number of shares held by the investor. | [optional] |
|
9
|
+
| **change** | **Integer** | Number of share changed (net buy or sell) from the last period. | [optional] |
|
10
|
+
| **filing_date** | **Date** | Filing date. | [optional] |
|
11
|
+
| **portfolio_percent** | **Float** | Percent of the fund's portfolio comprised of the company's share. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'finnhub_ruby'
|
17
|
+
|
18
|
+
instance = FinnhubRuby::FundOwnershipInfo.new(
|
19
|
+
name: null,
|
20
|
+
share: null,
|
21
|
+
change: null,
|
22
|
+
filing_date: null,
|
23
|
+
portfolio_percent: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/HistoricalNBBO.md
CHANGED
@@ -15,7 +15,7 @@
|
|
15
15
|
| **b** | **Array<Float>** | List of Bid price data. | [optional] |
|
16
16
|
| **bx** | **Array<String>** | List of venues/exchanges - Bid price. A list of exchange codes can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1Tj53M1svmr-hfEtbk6_NpVR1yAyGLMaH6ByYU6CG0ZY/edit?usp=sharing\",>here</a> | [optional] |
|
17
17
|
| **t** | **Array<Integer>** | List of timestamp in UNIX ms. | [optional] |
|
18
|
-
| **c** | **Array<Array<
|
18
|
+
| **c** | **Array<Array<String>>** | List of quote conditions. A comprehensive list of quote conditions code can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1iiA6e7Osdtai0oPMOUzgAIKXCsay89dFDmsegz6OpEg/edit?usp=sharing\">here</a> | [optional] |
|
19
19
|
|
20
20
|
## Example
|
21
21
|
|
data/docs/IPOCalendar.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **ipo_calendar** | **Array<
|
7
|
+
| **ipo_calendar** | [**Array<IPOEvent>**](IPOEvent.md) | Array of IPO events. | [optional] |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
data/docs/IPOEvent.md
CHANGED
@@ -10,8 +10,8 @@
|
|
10
10
|
| **name** | **String** | Company's name. | [optional] |
|
11
11
|
| **status** | **String** | IPO status. Can take 1 of the following values: <code>expected</code>,<code>priced</code>,<code>withdrawn</code>,<code>filed</code> | [optional] |
|
12
12
|
| **price** | **String** | Projected price or price range. | [optional] |
|
13
|
-
| **number_of_shares** | **
|
14
|
-
| **total_shares_value** | **
|
13
|
+
| **number_of_shares** | **Float** | Number of shares offered during the IPO. | [optional] |
|
14
|
+
| **total_shares_value** | **Float** | Total shares value. | [optional] |
|
15
15
|
|
16
16
|
## Example
|
17
17
|
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **symbol** | **String** | Index's symbol. | [optional] |
|
8
|
-
| **historical_constituents** | **Array<
|
8
|
+
| **historical_constituents** | [**Array<IndexHistoricalConstituent>**](IndexHistoricalConstituent.md) | Array of historical constituents. | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
data/docs/InsiderTransactions.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **symbol** | **String** | Symbol of the company. | [optional] |
|
8
|
-
| **data** | **Array<
|
8
|
+
| **data** | [**Array<Transactions>**](Transactions.md) | Array of insider transactions. | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
data/docs/InternationalFiling.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **symbol** | **String** | Symbol. | [optional] |
|
8
8
|
| **company_name** | **String** | Company name. | [optional] |
|
9
|
-
| **filed_date** | **
|
9
|
+
| **filed_date** | **String** | Filed date <code>%Y-%m-%d %H:%M:%S</code>. | [optional] |
|
10
10
|
| **category** | **String** | Category. | [optional] |
|
11
11
|
| **title** | **String** | Document's title. | [optional] |
|
12
12
|
| **description** | **String** | Document's description. | [optional] |
|
@@ -1,18 +1,18 @@
|
|
1
|
-
# FinnhubRuby::
|
1
|
+
# FinnhubRuby::InvestmentThemes
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **theme** | **String** | Investment theme | [optional] |
|
8
|
-
| **data** | **Array<
|
8
|
+
| **data** | [**Array<InvestmentThemePortfolio>**](InvestmentThemePortfolio.md) | Investment theme portfolio. | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
12
12
|
```ruby
|
13
13
|
require 'finnhub_ruby'
|
14
14
|
|
15
|
-
instance = FinnhubRuby::
|
15
|
+
instance = FinnhubRuby::InvestmentThemes.new(
|
16
16
|
theme: null,
|
17
17
|
data: null
|
18
18
|
)
|
@@ -8,6 +8,12 @@
|
|
8
8
|
| **name** | **String** | Name | [optional] |
|
9
9
|
| **customer** | **Boolean** | Whether the company is a customer. | [optional] |
|
10
10
|
| **supplier** | **Boolean** | Whether the company is a supplier | [optional] |
|
11
|
+
| **one_month_correlation** | **Float** | 1-month price correlation | [optional] |
|
12
|
+
| **one_year_correlation** | **Float** | 1-year price correlation | [optional] |
|
13
|
+
| **six_month_correlation** | **Float** | 6-month price correlation | [optional] |
|
14
|
+
| **three_month_correlation** | **Float** | 3-month price correlation | [optional] |
|
15
|
+
| **two_week_correlation** | **Float** | 2-week price correlation | [optional] |
|
16
|
+
| **two_year_correlation** | **Float** | 2-year price correlation | [optional] |
|
11
17
|
|
12
18
|
## Example
|
13
19
|
|
@@ -18,7 +24,13 @@ instance = FinnhubRuby::KeyCustomersSuppliers.new(
|
|
18
24
|
symbol: null,
|
19
25
|
name: null,
|
20
26
|
customer: null,
|
21
|
-
supplier: null
|
27
|
+
supplier: null,
|
28
|
+
one_month_correlation: null,
|
29
|
+
one_year_correlation: null,
|
30
|
+
six_month_correlation: null,
|
31
|
+
three_month_correlation: null,
|
32
|
+
two_week_correlation: null,
|
33
|
+
two_year_correlation: null
|
22
34
|
)
|
23
35
|
```
|
24
36
|
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# FinnhubRuby::
|
1
|
+
# FinnhubRuby::MarketNews
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -19,7 +19,7 @@
|
|
19
19
|
```ruby
|
20
20
|
require 'finnhub_ruby'
|
21
21
|
|
22
|
-
instance = FinnhubRuby::
|
22
|
+
instance = FinnhubRuby::MarketNews.new(
|
23
23
|
category: null,
|
24
24
|
datetime: null,
|
25
25
|
headline: null,
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::MutualFundCountryExposure
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
8
|
+
| **country_exposure** | [**Array<MutualFundCountryExposureData>**](MutualFundCountryExposureData.md) | Array of countries and and exposure levels. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::MutualFundCountryExposure.new(
|
16
|
+
symbol: null,
|
17
|
+
country_exposure: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# FinnhubRuby::
|
1
|
+
# FinnhubRuby::MutualFundHoldings
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -7,14 +7,14 @@
|
|
7
7
|
| **symbol** | **String** | Symbol. | [optional] |
|
8
8
|
| **at_date** | **Date** | Holdings update date. | [optional] |
|
9
9
|
| **number_of_holdings** | **Integer** | Number of holdings. | [optional] |
|
10
|
-
| **holdings** | **Array<
|
10
|
+
| **holdings** | [**Array<MutualFundHoldingsData>**](MutualFundHoldingsData.md) | Array of holdings. | [optional] |
|
11
11
|
|
12
12
|
## Example
|
13
13
|
|
14
14
|
```ruby
|
15
15
|
require 'finnhub_ruby'
|
16
16
|
|
17
|
-
instance = FinnhubRuby::
|
17
|
+
instance = FinnhubRuby::MutualFundHoldings.new(
|
18
18
|
symbol: null,
|
19
19
|
at_date: null,
|
20
20
|
number_of_holdings: null,
|