finnhub_ruby 1.0.0 → 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 +57 -8
- data/docs/AggregateIndicators.md +10 -9
- data/docs/BasicFinancials.md +14 -11
- data/docs/BreakdownItem.md +20 -0
- data/docs/Company.md +20 -19
- data/docs/CompanyExecutive.md +10 -9
- data/docs/CompanyNews.md +34 -0
- data/docs/CompanyNewsStatistics.md +12 -11
- data/docs/CompanyProfile.md +62 -61
- data/docs/CompanyProfile2.md +30 -29
- data/docs/CountryMetadata.md +18 -17
- data/docs/CovidInfo.md +14 -13
- data/docs/CryptoCandles.md +20 -19
- data/docs/CryptoSymbol.md +12 -11
- data/docs/DefaultApi.md +3288 -792
- data/docs/Development.md +16 -13
- data/docs/Dividends.md +22 -21
- data/docs/Dividends2.md +20 -0
- data/docs/Dividends2Info.md +20 -0
- data/docs/ETFCountryExposureData.md +20 -0
- data/docs/ETFHoldingsData.md +30 -0
- data/docs/ETFProfileData.md +52 -0
- data/docs/ETFSectorExposureData.md +20 -0
- data/docs/ETFsCountryExposure.md +20 -0
- data/docs/ETFsHoldings.md +24 -0
- data/docs/ETFsProfile.md +20 -0
- data/docs/ETFsSectorExposure.md +20 -0
- data/docs/EarningEstimate.md +16 -15
- data/docs/EarningRelease.md +24 -23
- data/docs/EarningResult.md +18 -13
- data/docs/EarningsCalendar.md +8 -7
- data/docs/EarningsCallTranscripts.md +24 -23
- data/docs/EarningsCallTranscriptsList.md +10 -9
- data/docs/EarningsEstimates.md +12 -11
- data/docs/EconomicCalendar.md +8 -7
- data/docs/EconomicCode.md +14 -13
- data/docs/EconomicData.md +10 -9
- data/docs/EconomicDataInfo.md +20 -0
- data/docs/EconomicEvent.md +22 -21
- data/docs/Estimate.md +16 -15
- data/docs/FDAComitteeMeeting.md +24 -0
- data/docs/Filing.md +22 -21
- data/docs/FilingSentiment.md +34 -0
- data/docs/FinancialStatements.md +10 -9
- data/docs/FinancialsAsReported.md +12 -11
- data/docs/ForexCandles.md +20 -19
- data/docs/ForexSymbol.md +12 -11
- data/docs/Forexrates.md +10 -9
- data/docs/FundOwnership.md +10 -9
- data/docs/FundOwnershipInfo.md +26 -0
- data/docs/HistoricalNBBO.md +40 -0
- data/docs/IPOCalendar.md +8 -7
- data/docs/IPOEvent.md +22 -21
- data/docs/IndexHistoricalConstituent.md +22 -0
- data/docs/Indicator.md +12 -11
- data/docs/IndicesConstituents.md +20 -0
- data/docs/IndicesHistoricalConstituents.md +20 -0
- data/docs/InsiderTransactions.md +20 -0
- data/docs/InternationalFiling.md +34 -0
- data/docs/InvestmentThemePortfolio.md +18 -0
- data/docs/InvestmentThemes.md +20 -0
- data/docs/KeyCustomersSuppliers.md +24 -0
- data/docs/LastBidAsk.md +16 -15
- data/docs/MarketNews.md +34 -0
- data/docs/MutualFundCountryExposure.md +20 -0
- data/docs/MutualFundCountryExposureData.md +20 -0
- data/docs/MutualFundHoldings.md +24 -0
- data/docs/MutualFundHoldingsData.md +30 -0
- data/docs/MutualFundProfile.md +20 -0
- data/docs/MutualFundProfileData.md +58 -0
- data/docs/MutualFundSectorExposure.md +20 -0
- data/docs/MutualFundSectorExposureData.md +20 -0
- data/docs/NewsSentiment.md +18 -17
- data/docs/Ownership.md +20 -0
- data/docs/OwnershipInfo.md +24 -0
- data/docs/PatternRecognition.md +8 -7
- data/docs/PressRelease.md +20 -0
- data/docs/PriceTarget.md +18 -17
- data/docs/Quote.md +20 -15
- data/docs/RecommendationTrend.md +20 -19
- data/docs/RedditSentimentContent.md +30 -0
- data/docs/Report.md +28 -27
- data/docs/RevenueBreakdown.md +22 -0
- data/docs/RevenueEstimates.md +12 -11
- data/docs/SECSentimentAnalysis.md +24 -0
- data/docs/Sentiment.md +10 -9
- data/docs/SimilarityIndex.md +22 -0
- data/docs/SocialSentiment.md +22 -0
- data/docs/Split.md +14 -13
- data/docs/StockCandles.md +20 -19
- data/docs/StockSymbol.md +30 -0
- data/docs/StockTranscripts.md +16 -15
- data/docs/SupplyChainRelationships.md +20 -0
- data/docs/SupportResistance.md +8 -7
- data/docs/SymbolLookup.md +20 -0
- data/docs/SymbolLookupInfo.md +24 -0
- data/docs/TechnicalAnalysis.md +10 -9
- data/docs/TickData.md +24 -21
- data/docs/Transactions.md +30 -0
- data/docs/TranscriptContent.md +12 -9
- data/docs/TranscriptParticipant.md +12 -9
- data/docs/Trend.md +10 -7
- data/docs/TwitterSentimentContent.md +30 -0
- data/docs/UpgradeDowngrade.md +18 -17
- data/finnhub_ruby-1.1.4.gem +0 -0
- data/finnhub_ruby.gemspec +2 -3
- data/lib/finnhub_ruby.rb +49 -6
- data/lib/finnhub_ruby/api/default_api.rb +2063 -515
- data/lib/finnhub_ruby/api_client.rb +50 -48
- data/lib/finnhub_ruby/api_error.rb +1 -1
- data/lib/finnhub_ruby/configuration.rb +39 -10
- data/lib/finnhub_ruby/models/aggregate_indicators.rb +19 -7
- data/lib/finnhub_ruby/models/basic_financials.rb +29 -8
- data/lib/finnhub_ruby/models/breakdown_item.rb +228 -0
- data/lib/finnhub_ruby/models/company.rb +19 -7
- data/lib/finnhub_ruby/models/company_executive.rb +20 -8
- data/lib/finnhub_ruby/models/company_news.rb +299 -0
- data/lib/finnhub_ruby/models/company_news_statistics.rb +19 -7
- data/lib/finnhub_ruby/models/company_profile.rb +20 -8
- data/lib/finnhub_ruby/models/company_profile2.rb +19 -7
- data/lib/finnhub_ruby/models/country_metadata.rb +19 -7
- data/lib/finnhub_ruby/models/covid_info.rb +20 -8
- data/lib/finnhub_ruby/models/crypto_candles.rb +19 -7
- data/lib/finnhub_ruby/models/crypto_symbol.rb +19 -7
- data/lib/finnhub_ruby/models/development.rb +34 -12
- data/lib/finnhub_ruby/models/dividends.rb +19 -7
- data/lib/finnhub_ruby/models/dividends2.rb +231 -0
- data/lib/finnhub_ruby/models/dividends2_basic.rb +231 -0
- data/lib/finnhub_ruby/models/dividends2_info.rb +229 -0
- data/lib/finnhub_ruby/models/earning_estimate.rb +20 -8
- data/lib/finnhub_ruby/models/earning_release.rb +20 -8
- data/lib/finnhub_ruby/models/earning_result.rb +40 -8
- data/lib/finnhub_ruby/models/earnings_calendar.rb +20 -8
- data/lib/finnhub_ruby/models/earnings_call_transcripts.rb +22 -10
- data/lib/finnhub_ruby/models/earnings_call_transcripts_list.rb +20 -8
- data/lib/finnhub_ruby/models/earnings_estimates.rb +20 -8
- data/lib/finnhub_ruby/models/economic_calendar.rb +20 -8
- data/lib/finnhub_ruby/models/economic_code.rb +19 -7
- data/lib/finnhub_ruby/models/economic_data.rb +20 -8
- data/lib/finnhub_ruby/models/economic_data_info.rb +229 -0
- data/lib/finnhub_ruby/models/economic_event.rb +19 -7
- data/lib/finnhub_ruby/models/estimate.rb +20 -8
- data/lib/finnhub_ruby/models/et_fs_country_exposure.rb +219 -0
- data/lib/finnhub_ruby/models/et_fs_holdings.rb +219 -0
- data/lib/finnhub_ruby/models/et_fs_industry_exposure.rb +219 -0
- data/lib/finnhub_ruby/models/et_fs_profile.rb +216 -0
- data/lib/finnhub_ruby/models/etf_country_exposure_data.rb +229 -0
- data/lib/finnhub_ruby/models/etf_holdings_data.rb +279 -0
- data/lib/finnhub_ruby/models/etf_profile_data.rb +389 -0
- data/lib/finnhub_ruby/models/etf_sector_exposure_data.rb +229 -0
- data/lib/finnhub_ruby/models/etfs_country_exposure.rb +231 -0
- data/lib/finnhub_ruby/models/etfs_holdings.rb +251 -0
- data/lib/finnhub_ruby/models/etfs_profile.rb +228 -0
- data/lib/finnhub_ruby/models/etfs_sector_exposure.rb +231 -0
- data/lib/finnhub_ruby/models/fda_comittee_meeting.rb +249 -0
- data/lib/finnhub_ruby/models/filing.rb +21 -9
- data/lib/finnhub_ruby/models/filing_sentiment.rb +299 -0
- data/lib/finnhub_ruby/models/financial_statements.rb +19 -7
- data/lib/finnhub_ruby/models/financials_as_reported.rb +20 -8
- data/lib/finnhub_ruby/models/forex_candles.rb +19 -7
- data/lib/finnhub_ruby/models/forex_symbol.rb +19 -7
- data/lib/finnhub_ruby/models/forexrates.rb +19 -7
- data/lib/finnhub_ruby/models/fund_ownership.rb +20 -8
- data/lib/finnhub_ruby/models/fund_ownership_info.rb +259 -0
- data/lib/finnhub_ruby/models/historical_nbbo.rb +345 -0
- data/lib/finnhub_ruby/models/index_historical_constituent.rb +239 -0
- data/lib/finnhub_ruby/models/indicator.rb +19 -7
- data/lib/finnhub_ruby/models/indices_constituents.rb +231 -0
- data/lib/finnhub_ruby/models/indices_historical_constituents.rb +231 -0
- data/lib/finnhub_ruby/models/insider_transactions.rb +231 -0
- data/lib/finnhub_ruby/models/international_filing.rb +299 -0
- data/lib/finnhub_ruby/models/investment_theme_portfolio.rb +219 -0
- data/lib/finnhub_ruby/models/investment_themes.rb +231 -0
- data/lib/finnhub_ruby/models/investment_themes_thematic_investing.rb +231 -0
- data/lib/finnhub_ruby/models/investor.rb +19 -7
- data/lib/finnhub_ruby/models/ipo_calendar.rb +20 -8
- data/lib/finnhub_ruby/models/ipo_event.rb +19 -7
- data/lib/finnhub_ruby/models/key_customers_suppliers.rb +249 -0
- data/lib/finnhub_ruby/models/last_bid_ask.rb +19 -7
- data/lib/finnhub_ruby/models/major_press_releases.rb +231 -0
- 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 +229 -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 +231 -0
- data/lib/finnhub_ruby/models/mutual_fund_sector_exposure_data.rb +229 -0
- data/lib/finnhub_ruby/models/mutual_funds_country_exposure.rb +231 -0
- data/lib/finnhub_ruby/models/mutual_funds_holdings.rb +251 -0
- data/lib/finnhub_ruby/models/mutual_funds_profile.rb +228 -0
- data/lib/finnhub_ruby/models/news.rb +19 -7
- data/lib/finnhub_ruby/models/news_sentiment.rb +19 -7
- data/lib/finnhub_ruby/models/ownership.rb +231 -0
- data/lib/finnhub_ruby/models/ownership_info.rb +249 -0
- data/lib/finnhub_ruby/models/pattern_recognition.rb +19 -7
- data/lib/finnhub_ruby/models/press_release.rb +231 -0
- data/lib/finnhub_ruby/models/price_target.rb +20 -8
- data/lib/finnhub_ruby/models/quote.rb +43 -11
- data/lib/finnhub_ruby/models/recommendation_trend.rb +19 -7
- data/lib/finnhub_ruby/models/reddit_sentiment_content.rb +279 -0
- data/lib/finnhub_ruby/models/report.rb +23 -11
- data/lib/finnhub_ruby/models/revenue_breakdown.rb +241 -0
- data/lib/finnhub_ruby/models/revenue_estimates.rb +20 -8
- data/lib/finnhub_ruby/models/sec_sentiment_analysis.rb +248 -0
- data/lib/finnhub_ruby/models/sentiment.rb +19 -7
- data/lib/finnhub_ruby/models/similarity_index.rb +241 -0
- data/lib/finnhub_ruby/models/social_sentiment.rb +243 -0
- data/lib/finnhub_ruby/models/split.rb +19 -7
- data/lib/finnhub_ruby/models/stock.rb +33 -11
- data/lib/finnhub_ruby/models/stock_candles.rb +19 -7
- data/lib/finnhub_ruby/models/stock_symbol.rb +279 -0
- data/lib/finnhub_ruby/models/stock_transcripts.rb +20 -8
- data/lib/finnhub_ruby/models/supply_chain_relationships.rb +231 -0
- data/lib/finnhub_ruby/models/support_resistance.rb +19 -7
- data/lib/finnhub_ruby/models/symbol_lookup.rb +231 -0
- data/lib/finnhub_ruby/models/symbol_lookup_info.rb +249 -0
- data/lib/finnhub_ruby/models/technical_analysis.rb +19 -7
- data/lib/finnhub_ruby/models/tick_data.rb +36 -12
- data/lib/finnhub_ruby/models/transactions.rb +279 -0
- data/lib/finnhub_ruby/models/transcript_content.rb +33 -11
- data/lib/finnhub_ruby/models/transcript_participant.rb +33 -11
- data/lib/finnhub_ruby/models/trend.rb +33 -11
- data/lib/finnhub_ruby/models/twitter_sentiment_content.rb +279 -0
- data/lib/finnhub_ruby/models/upgrade_downgrade.rb +19 -7
- data/lib/finnhub_ruby/version.rb +2 -2
- data/release.sh +7 -2
- data/spec/api/default_api_spec.rb +88 -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/breakdown_item_spec.rb +40 -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_spec.rb +40 -0
- 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 +40 -0
- data/spec/models/etf_holdings_data_spec.rb +70 -0
- data/spec/models/etf_profile_data_spec.rb +136 -0
- data/spec/models/etf_sector_exposure_data_spec.rb +40 -0
- data/spec/models/etfs_country_exposure_spec.rb +40 -0
- data/spec/models/etfs_holdings_spec.rb +52 -0
- data/spec/models/etfs_profile_spec.rb +40 -0
- data/spec/models/etfs_sector_exposure_spec.rb +40 -0
- data/spec/models/fda_comittee_meeting_spec.rb +52 -0
- data/spec/models/filing_sentiment_spec.rb +82 -0
- 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/historical_nbbo_spec.rb +100 -0
- data/spec/models/index_historical_constituent_spec.rb +46 -0
- data/spec/models/indicator_spec.rb +4 -11
- data/spec/models/indices_constituents_spec.rb +40 -0
- data/spec/models/indices_historical_constituents_spec.rb +40 -0
- data/spec/models/insider_transactions_spec.rb +40 -0
- data/spec/models/international_filing_spec.rb +82 -0
- data/spec/models/investment_theme_portfolio_spec.rb +34 -0
- data/spec/models/investment_themes_spec.rb +40 -0
- data/spec/models/ipo_calendar_spec.rb +4 -11
- data/spec/models/ipo_event_spec.rb +4 -11
- data/spec/models/key_customers_suppliers_spec.rb +52 -0
- data/spec/models/last_bid_ask_spec.rb +4 -11
- data/spec/models/market_news_spec.rb +82 -0
- data/spec/models/mutual_fund_country_exposure_data_spec.rb +40 -0
- data/spec/models/mutual_fund_country_exposure_spec.rb +40 -0
- data/spec/models/mutual_fund_holdings_data_spec.rb +70 -0
- data/spec/models/mutual_fund_holdings_spec.rb +52 -0
- data/spec/models/mutual_fund_profile_data_spec.rb +154 -0
- data/spec/models/mutual_fund_profile_spec.rb +40 -0
- data/spec/models/mutual_fund_sector_exposure_data_spec.rb +40 -0
- data/spec/models/mutual_fund_sector_exposure_spec.rb +40 -0
- data/spec/models/news_sentiment_spec.rb +4 -11
- data/spec/models/{investor_spec.rb → ownership_info_spec.rb} +7 -14
- data/spec/models/{investors_ownership_spec.rb → ownership_spec.rb} +7 -14
- data/spec/models/pattern_recognition_spec.rb +4 -11
- data/spec/models/{major_developments_spec.rb → press_release_spec.rb} +7 -14
- 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/reddit_sentiment_content_spec.rb +70 -0
- data/spec/models/report_spec.rb +4 -11
- data/spec/models/{stock_spec.rb → revenue_breakdown_spec.rb} +10 -17
- data/spec/models/revenue_estimates_spec.rb +4 -11
- data/spec/models/sec_sentiment_analysis_spec.rb +52 -0
- data/spec/models/sentiment_spec.rb +4 -11
- data/spec/models/similarity_index_spec.rb +46 -0
- data/spec/models/social_sentiment_spec.rb +46 -0
- 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/supply_chain_relationships_spec.rb +40 -0
- data/spec/models/support_resistance_spec.rb +4 -11
- data/spec/models/symbol_lookup_info_spec.rb +52 -0
- data/spec/models/symbol_lookup_spec.rb +40 -0
- data/spec/models/technical_analysis_spec.rb +4 -11
- data/spec/models/tick_data_spec.rb +10 -11
- data/spec/models/transactions_spec.rb +70 -0
- data/spec/models/transcript_content_spec.rb +10 -11
- data/spec/models/transcript_participant_spec.rb +10 -11
- data/spec/models/trend_spec.rb +10 -11
- data/spec/models/twitter_sentiment_content_spec.rb +70 -0
- data/spec/models/upgrade_downgrade_spec.rb +4 -11
- data/spec/spec_helper.rb +1 -1
- metadata +206 -41
- data/docs/Investor.md +0 -23
- data/docs/InvestorsOwnership.md +0 -19
- data/docs/MajorDevelopments.md +0 -19
- data/docs/News.md +0 -33
- data/docs/Stock.md +0 -21
- data/finnhub_ruby-0.0.1.gem +0 -0
- data/finnhub_ruby-0.0.2.gem +0 -0
- data/test.rb +0 -139
data/docs/Development.md
CHANGED
@@ -2,22 +2,25 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**symbol** | **String** | Company symbol. | [optional]
|
8
|
-
**datetime** | **
|
9
|
-
**headline** | **String** | Development headline. | [optional]
|
10
|
-
**description** | **String** | Development description. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Company symbol. | [optional] |
|
8
|
+
| **datetime** | **String** | Published time in <code>YYYY-MM-DD HH:MM:SS</code> format. | [optional] |
|
9
|
+
| **headline** | **String** | Development headline. | [optional] |
|
10
|
+
| **description** | **String** | Development description. | [optional] |
|
11
|
+
| **url** | **String** | URL. | [optional] |
|
11
12
|
|
12
|
-
##
|
13
|
+
## Example
|
13
14
|
|
14
15
|
```ruby
|
15
|
-
require '
|
16
|
+
require 'finnhub_ruby'
|
16
17
|
|
17
|
-
instance = FinnhubRuby::Development.new(
|
18
|
-
|
19
|
-
|
20
|
-
|
18
|
+
instance = FinnhubRuby::Development.new(
|
19
|
+
symbol: null,
|
20
|
+
datetime: null,
|
21
|
+
headline: null,
|
22
|
+
description: null,
|
23
|
+
url: null
|
24
|
+
)
|
21
25
|
```
|
22
26
|
|
23
|
-
|
data/docs/Dividends.md
CHANGED
@@ -2,30 +2,31 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**symbol** | **String** | Symbol. | [optional]
|
8
|
-
**date** | **Date** | Ex-Dividend date. | [optional]
|
9
|
-
**amount** | **Float** | Amount in local currency. | [optional]
|
10
|
-
**adjusted_amount** | **Float** | Adjusted dividend. | [optional]
|
11
|
-
**pay_date** | **Date** | Pay date. | [optional]
|
12
|
-
**record_date** | **Date** | Record date. | [optional]
|
13
|
-
**declaration_date** | **Date** | Declaration date. | [optional]
|
14
|
-
**currency** | **String** | Currency. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
8
|
+
| **date** | **Date** | Ex-Dividend date. | [optional] |
|
9
|
+
| **amount** | **Float** | Amount in local currency. | [optional] |
|
10
|
+
| **adjusted_amount** | **Float** | Adjusted dividend. | [optional] |
|
11
|
+
| **pay_date** | **Date** | Pay date. | [optional] |
|
12
|
+
| **record_date** | **Date** | Record date. | [optional] |
|
13
|
+
| **declaration_date** | **Date** | Declaration date. | [optional] |
|
14
|
+
| **currency** | **String** | Currency. | [optional] |
|
15
15
|
|
16
|
-
##
|
16
|
+
## Example
|
17
17
|
|
18
18
|
```ruby
|
19
|
-
require '
|
19
|
+
require 'finnhub_ruby'
|
20
20
|
|
21
|
-
instance = FinnhubRuby::Dividends.new(
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
21
|
+
instance = FinnhubRuby::Dividends.new(
|
22
|
+
symbol: null,
|
23
|
+
date: null,
|
24
|
+
amount: null,
|
25
|
+
adjusted_amount: null,
|
26
|
+
pay_date: null,
|
27
|
+
record_date: null,
|
28
|
+
declaration_date: null,
|
29
|
+
currency: null
|
30
|
+
)
|
29
31
|
```
|
30
32
|
|
31
|
-
|
data/docs/Dividends2.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::Dividends2
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol | [optional] |
|
8
|
+
| **data** | [**Array<Dividends2Info>**](Dividends2Info.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::Dividends2.new(
|
16
|
+
symbol: null,
|
17
|
+
data: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -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
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::ETFCountryExposureData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **country** | **String** | Country | [optional] |
|
8
|
+
| **exposure** | **Float** | Percent of exposure. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::ETFCountryExposureData.new(
|
16
|
+
country: null,
|
17
|
+
exposure: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# FinnhubRuby::ETFHoldingsData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol description | [optional] |
|
8
|
+
| **name** | **String** | Security name | [optional] |
|
9
|
+
| **isin** | **String** | ISIN. | [optional] |
|
10
|
+
| **cusip** | **String** | CUSIP. | [optional] |
|
11
|
+
| **share** | **Float** | Number of shares owned by the ETF. | [optional] |
|
12
|
+
| **percent** | **Float** | Portfolio's percent | [optional] |
|
13
|
+
| **value** | **Float** | Market value | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'finnhub_ruby'
|
19
|
+
|
20
|
+
instance = FinnhubRuby::ETFHoldingsData.new(
|
21
|
+
symbol: null,
|
22
|
+
name: null,
|
23
|
+
isin: null,
|
24
|
+
cusip: null,
|
25
|
+
share: null,
|
26
|
+
percent: null,
|
27
|
+
value: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# FinnhubRuby::ETFProfileData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | Name | [optional] |
|
8
|
+
| **asset_class** | **String** | Asset Class. | [optional] |
|
9
|
+
| **investment_segment** | **String** | Investment Segment. | [optional] |
|
10
|
+
| **aum** | **Float** | AUM. | [optional] |
|
11
|
+
| **nav** | **Float** | NAV. | [optional] |
|
12
|
+
| **nav_currency** | **String** | NAV currency. | [optional] |
|
13
|
+
| **expense_ratio** | **Float** | Expense ratio. | [optional] |
|
14
|
+
| **tracking_index** | **String** | Tracking Index. | [optional] |
|
15
|
+
| **etf_company** | **String** | ETF issuer. | [optional] |
|
16
|
+
| **domicile** | **String** | ETF domicile. | [optional] |
|
17
|
+
| **inception_date** | **Date** | Inception date. | [optional] |
|
18
|
+
| **website** | **String** | ETF's website. | [optional] |
|
19
|
+
| **isin** | **String** | ISIN. | [optional] |
|
20
|
+
| **cusip** | **String** | CUSIP. | [optional] |
|
21
|
+
| **price_to_earnings** | **Float** | P/E. | [optional] |
|
22
|
+
| **price_to_book** | **Float** | P/B. | [optional] |
|
23
|
+
| **avg_volume** | **Float** | 30-day average volume. | [optional] |
|
24
|
+
| **description** | **String** | ETF's description. | [optional] |
|
25
|
+
|
26
|
+
## Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'finnhub_ruby'
|
30
|
+
|
31
|
+
instance = FinnhubRuby::ETFProfileData.new(
|
32
|
+
name: null,
|
33
|
+
asset_class: null,
|
34
|
+
investment_segment: null,
|
35
|
+
aum: null,
|
36
|
+
nav: null,
|
37
|
+
nav_currency: null,
|
38
|
+
expense_ratio: null,
|
39
|
+
tracking_index: null,
|
40
|
+
etf_company: null,
|
41
|
+
domicile: null,
|
42
|
+
inception_date: null,
|
43
|
+
website: null,
|
44
|
+
isin: null,
|
45
|
+
cusip: null,
|
46
|
+
price_to_earnings: null,
|
47
|
+
price_to_book: null,
|
48
|
+
avg_volume: null,
|
49
|
+
description: null
|
50
|
+
)
|
51
|
+
```
|
52
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::ETFSectorExposureData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **industry** | **String** | Industry | [optional] |
|
8
|
+
| **exposure** | **Float** | Percent of exposure. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::ETFSectorExposureData.new(
|
16
|
+
industry: null,
|
17
|
+
exposure: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::ETFsCountryExposure
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | ETF symbol. | [optional] |
|
8
|
+
| **country_exposure** | [**Array<ETFCountryExposureData>**](ETFCountryExposureData.md) | Array of countries and and exposure levels. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::ETFsCountryExposure.new(
|
16
|
+
symbol: null,
|
17
|
+
country_exposure: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# FinnhubRuby::ETFsHoldings
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | ETF symbol. | [optional] |
|
8
|
+
| **at_date** | **Date** | Holdings update date. | [optional] |
|
9
|
+
| **number_of_holdings** | **Integer** | Number of holdings. | [optional] |
|
10
|
+
| **holdings** | [**Array<ETFHoldingsData>**](ETFHoldingsData.md) | Array of holdings. | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'finnhub_ruby'
|
16
|
+
|
17
|
+
instance = FinnhubRuby::ETFsHoldings.new(
|
18
|
+
symbol: null,
|
19
|
+
at_date: null,
|
20
|
+
number_of_holdings: null,
|
21
|
+
holdings: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/ETFsProfile.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::ETFsProfile
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
8
|
+
| **profile** | [**ETFProfileData**](ETFProfileData.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::ETFsProfile.new(
|
16
|
+
symbol: null,
|
17
|
+
profile: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# FinnhubRuby::ETFsSectorExposure
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | ETF symbol. | [optional] |
|
8
|
+
| **sector_exposure** | [**Array<ETFSectorExposureData>**](ETFSectorExposureData.md) | Array of industries and exposure levels. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'finnhub_ruby'
|
14
|
+
|
15
|
+
instance = FinnhubRuby::ETFsSectorExposure.new(
|
16
|
+
symbol: null,
|
17
|
+
sector_exposure: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/EarningEstimate.md
CHANGED
@@ -2,24 +2,25 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**eps_avg** | **Float** | Average EPS 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]
|
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
12
|
|
13
|
-
##
|
13
|
+
## Example
|
14
14
|
|
15
15
|
```ruby
|
16
|
-
require '
|
16
|
+
require 'finnhub_ruby'
|
17
17
|
|
18
|
-
instance = FinnhubRuby::EarningEstimate.new(
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
18
|
+
instance = FinnhubRuby::EarningEstimate.new(
|
19
|
+
eps_avg: null,
|
20
|
+
eps_high: null,
|
21
|
+
eps_low: null,
|
22
|
+
number_analysts: null,
|
23
|
+
period: null
|
24
|
+
)
|
23
25
|
```
|
24
26
|
|
25
|
-
|
data/docs/EarningRelease.md
CHANGED
@@ -2,32 +2,33 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**symbol** | **String** | Symbol. | [optional]
|
8
|
-
**date** | **Date** | Date. | [optional]
|
9
|
-
**hour** | **String** | Indicates whether the earnings is announced before market open(<code>bmo</code>), after market close(<code>amc</code>), or during market hour(<code>dmh</code>). | [optional]
|
10
|
-
**year** | **Integer** | Earnings year. | [optional]
|
11
|
-
**quarter** | **Integer** | Earnings quarter. | [optional]
|
12
|
-
**eps_estimate** | **Float** | EPS estimate. | [optional]
|
13
|
-
**eps_actual** | **Float** | EPS actual. | [optional]
|
14
|
-
**revenue_estimate** | **Integer** | Revenue estimate. | [optional]
|
15
|
-
**revenue_actual** | **Integer** | Revenue actual. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
8
|
+
| **date** | **Date** | Date. | [optional] |
|
9
|
+
| **hour** | **String** | Indicates whether the earnings is announced before market open(<code>bmo</code>), after market close(<code>amc</code>), or during market hour(<code>dmh</code>). | [optional] |
|
10
|
+
| **year** | **Integer** | Earnings year. | [optional] |
|
11
|
+
| **quarter** | **Integer** | Earnings quarter. | [optional] |
|
12
|
+
| **eps_estimate** | **Float** | EPS estimate. | [optional] |
|
13
|
+
| **eps_actual** | **Float** | EPS actual. | [optional] |
|
14
|
+
| **revenue_estimate** | **Integer** | Revenue estimate including Finnhub's proprietary estimates. | [optional] |
|
15
|
+
| **revenue_actual** | **Integer** | Revenue actual. | [optional] |
|
16
16
|
|
17
|
-
##
|
17
|
+
## Example
|
18
18
|
|
19
19
|
```ruby
|
20
|
-
require '
|
20
|
+
require 'finnhub_ruby'
|
21
21
|
|
22
|
-
instance = FinnhubRuby::EarningRelease.new(
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
22
|
+
instance = FinnhubRuby::EarningRelease.new(
|
23
|
+
symbol: null,
|
24
|
+
date: null,
|
25
|
+
hour: null,
|
26
|
+
year: null,
|
27
|
+
quarter: null,
|
28
|
+
eps_estimate: null,
|
29
|
+
eps_actual: null,
|
30
|
+
revenue_estimate: null,
|
31
|
+
revenue_actual: null
|
32
|
+
)
|
31
33
|
```
|
32
34
|
|
33
|
-
|