finnhub_ruby 1.0.1 → 1.1.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +60 -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.5.gem +0 -0
- data/finnhub_ruby.gemspec +7 -8
- 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 +12 -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 +211 -45
- 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-1.0.0.gem +0 -0
- data/test.rb +0 -139
@@ -0,0 +1,34 @@
|
|
1
|
+
# FinnhubRuby::FilingSentiment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **negative** | **Float** | % of negative words in the filing. | [optional] |
|
8
|
+
| **positive** | **Float** | % of positive words in the filing. | [optional] |
|
9
|
+
| **polarity** | **Float** | % of polarity words in the filing. | [optional] |
|
10
|
+
| **litigious** | **Float** | % of litigious words in the filing. | [optional] |
|
11
|
+
| **uncertainty** | **Float** | % of uncertainty words in the filing. | [optional] |
|
12
|
+
| **constraining** | **Float** | % of constraining words in the filing. | [optional] |
|
13
|
+
| **modal_weak** | **Float** | % of modal-weak words in the filing. | [optional] |
|
14
|
+
| **modal_strong** | **Float** | % of modal-strong words in the filing. | [optional] |
|
15
|
+
| **modal_moderate** | **Float** | % of modal-moderate words in the filing. | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'finnhub_ruby'
|
21
|
+
|
22
|
+
instance = FinnhubRuby::FilingSentiment.new(
|
23
|
+
negative: null,
|
24
|
+
positive: null,
|
25
|
+
polarity: null,
|
26
|
+
litigious: null,
|
27
|
+
uncertainty: null,
|
28
|
+
constraining: null,
|
29
|
+
modal_weak: null,
|
30
|
+
modal_strong: null,
|
31
|
+
modal_moderate: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
data/docs/FinancialStatements.md
CHANGED
@@ -2,18 +2,19 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**symbol** | **String** | Symbol of the company. | [optional]
|
8
|
-
**financials** | **Array<Object>** | An array of map of key, value pairs containing the data for each period. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol of the company. | [optional] |
|
8
|
+
| **financials** | **Array<Object>** | An array of map of key, value pairs containing the data for each period. | [optional] |
|
9
9
|
|
10
|
-
##
|
10
|
+
## Example
|
11
11
|
|
12
12
|
```ruby
|
13
|
-
require '
|
13
|
+
require 'finnhub_ruby'
|
14
14
|
|
15
|
-
instance = FinnhubRuby::FinancialStatements.new(
|
16
|
-
|
15
|
+
instance = FinnhubRuby::FinancialStatements.new(
|
16
|
+
symbol: null,
|
17
|
+
financials: null
|
18
|
+
)
|
17
19
|
```
|
18
20
|
|
19
|
-
|
@@ -2,20 +2,21 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**symbol** | **String** | Symbol | [optional]
|
8
|
-
**cik** | **String** | CIK | [optional]
|
9
|
-
**data** | **Array<
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol | [optional] |
|
8
|
+
| **cik** | **String** | CIK | [optional] |
|
9
|
+
| **data** | [**Array<Report>**](Report.md) | Array of filings. | [optional] |
|
10
10
|
|
11
|
-
##
|
11
|
+
## Example
|
12
12
|
|
13
13
|
```ruby
|
14
|
-
require '
|
14
|
+
require 'finnhub_ruby'
|
15
15
|
|
16
|
-
instance = FinnhubRuby::FinancialsAsReported.new(
|
17
|
-
|
18
|
-
|
16
|
+
instance = FinnhubRuby::FinancialsAsReported.new(
|
17
|
+
symbol: null,
|
18
|
+
cik: null,
|
19
|
+
data: null
|
20
|
+
)
|
19
21
|
```
|
20
22
|
|
21
|
-
|
data/docs/ForexCandles.md
CHANGED
@@ -2,28 +2,29 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**o** | **Array<Float>** | List of open prices for returned candles. | [optional]
|
8
|
-
**h** | **Array<Float>** | List of high prices for returned candles. | [optional]
|
9
|
-
**l** | **Array<Float>** | List of low prices for returned candles. | [optional]
|
10
|
-
**c** | **Array<Float>** | List of close prices for returned candles. | [optional]
|
11
|
-
**v** | **Array<Float>** | List of volume data for returned candles. | [optional]
|
12
|
-
**t** | **Array<Float>** | List of timestamp for returned candles. | [optional]
|
13
|
-
**s** | **String** | Status of the response. This field can either be ok or no_data. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **o** | **Array<Float>** | List of open prices for returned candles. | [optional] |
|
8
|
+
| **h** | **Array<Float>** | List of high prices for returned candles. | [optional] |
|
9
|
+
| **l** | **Array<Float>** | List of low prices for returned candles. | [optional] |
|
10
|
+
| **c** | **Array<Float>** | List of close prices for returned candles. | [optional] |
|
11
|
+
| **v** | **Array<Float>** | List of volume data for returned candles. | [optional] |
|
12
|
+
| **t** | **Array<Float>** | List of timestamp for returned candles. | [optional] |
|
13
|
+
| **s** | **String** | Status of the response. This field can either be ok or no_data. | [optional] |
|
14
14
|
|
15
|
-
##
|
15
|
+
## Example
|
16
16
|
|
17
17
|
```ruby
|
18
|
-
require '
|
18
|
+
require 'finnhub_ruby'
|
19
19
|
|
20
|
-
instance = FinnhubRuby::ForexCandles.new(
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
20
|
+
instance = FinnhubRuby::ForexCandles.new(
|
21
|
+
o: null,
|
22
|
+
h: null,
|
23
|
+
l: null,
|
24
|
+
c: null,
|
25
|
+
v: null,
|
26
|
+
t: null,
|
27
|
+
s: null
|
28
|
+
)
|
27
29
|
```
|
28
30
|
|
29
|
-
|
data/docs/ForexSymbol.md
CHANGED
@@ -2,20 +2,21 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**description** | **String** | Symbol description | [optional]
|
8
|
-
**display_symbol** | **String** | Display symbol name. | [optional]
|
9
|
-
**symbol** | **String** | Unique symbol used to identify this symbol used in <code>/forex/candle</code> endpoint. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **description** | **String** | Symbol description | [optional] |
|
8
|
+
| **display_symbol** | **String** | Display symbol name. | [optional] |
|
9
|
+
| **symbol** | **String** | Unique symbol used to identify this symbol used in <code>/forex/candle</code> endpoint. | [optional] |
|
10
10
|
|
11
|
-
##
|
11
|
+
## Example
|
12
12
|
|
13
13
|
```ruby
|
14
|
-
require '
|
14
|
+
require 'finnhub_ruby'
|
15
15
|
|
16
|
-
instance = FinnhubRuby::ForexSymbol.new(
|
17
|
-
|
18
|
-
|
16
|
+
instance = FinnhubRuby::ForexSymbol.new(
|
17
|
+
description: null,
|
18
|
+
display_symbol: null,
|
19
|
+
symbol: null
|
20
|
+
)
|
19
21
|
```
|
20
22
|
|
21
|
-
|
data/docs/Forexrates.md
CHANGED
@@ -2,18 +2,19 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**base** | **String** | Base currency. | [optional]
|
8
|
-
**quote** |
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **base** | **String** | Base currency. | [optional] |
|
8
|
+
| **quote** | **Object** | | [optional] |
|
9
9
|
|
10
|
-
##
|
10
|
+
## Example
|
11
11
|
|
12
12
|
```ruby
|
13
|
-
require '
|
13
|
+
require 'finnhub_ruby'
|
14
14
|
|
15
|
-
instance = FinnhubRuby::Forexrates.new(
|
16
|
-
|
15
|
+
instance = FinnhubRuby::Forexrates.new(
|
16
|
+
base: null,
|
17
|
+
quote: null
|
18
|
+
)
|
17
19
|
```
|
18
20
|
|
19
|
-
|
data/docs/FundOwnership.md
CHANGED
@@ -2,18 +2,19 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**symbol** | **String** | Symbol of the company. | [optional]
|
8
|
-
**ownership** | **Array<
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol of the company. | [optional] |
|
8
|
+
| **ownership** | [**Array<FundOwnershipInfo>**](FundOwnershipInfo.md) | Array of investors with detailed information about their holdings. | [optional] |
|
9
9
|
|
10
|
-
##
|
10
|
+
## Example
|
11
11
|
|
12
12
|
```ruby
|
13
|
-
require '
|
13
|
+
require 'finnhub_ruby'
|
14
14
|
|
15
|
-
instance = FinnhubRuby::FundOwnership.new(
|
16
|
-
|
15
|
+
instance = FinnhubRuby::FundOwnership.new(
|
16
|
+
symbol: null,
|
17
|
+
ownership: null
|
18
|
+
)
|
17
19
|
```
|
18
20
|
|
19
|
-
|
@@ -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
|
+
|
@@ -0,0 +1,40 @@
|
|
1
|
+
# FinnhubRuby::HistoricalNBBO
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **s** | **String** | Symbol. | [optional] |
|
8
|
+
| **skip** | **Integer** | Number of ticks skipped. | [optional] |
|
9
|
+
| **count** | **Integer** | Number of ticks returned. If <code>count</code> < <code>limit</code>, all data for that date has been returned. | [optional] |
|
10
|
+
| **total** | **Integer** | Total number of ticks for that date. | [optional] |
|
11
|
+
| **av** | **Array<Float>** | List of Ask volume data. | [optional] |
|
12
|
+
| **a** | **Array<Float>** | List of Ask price data. | [optional] |
|
13
|
+
| **ax** | **Array<String>** | List of venues/exchanges - Ask 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] |
|
14
|
+
| **bv** | **Array<Float>** | List of Bid volume data. | [optional] |
|
15
|
+
| **b** | **Array<Float>** | List of Bid price data. | [optional] |
|
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
|
+
| **t** | **Array<Integer>** | List of timestamp in UNIX ms. | [optional] |
|
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
|
+
|
20
|
+
## Example
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'finnhub_ruby'
|
24
|
+
|
25
|
+
instance = FinnhubRuby::HistoricalNBBO.new(
|
26
|
+
s: null,
|
27
|
+
skip: null,
|
28
|
+
count: null,
|
29
|
+
total: null,
|
30
|
+
av: null,
|
31
|
+
a: null,
|
32
|
+
ax: null,
|
33
|
+
bv: null,
|
34
|
+
b: null,
|
35
|
+
bx: null,
|
36
|
+
t: null,
|
37
|
+
c: null
|
38
|
+
)
|
39
|
+
```
|
40
|
+
|
data/docs/IPOCalendar.md
CHANGED
@@ -2,16 +2,17 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**ipo_calendar** | **Array<
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **ipo_calendar** | [**Array<IPOEvent>**](IPOEvent.md) | Array of IPO events. | [optional] |
|
8
8
|
|
9
|
-
##
|
9
|
+
## Example
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
require '
|
12
|
+
require 'finnhub_ruby'
|
13
13
|
|
14
|
-
instance = FinnhubRuby::IPOCalendar.new(
|
14
|
+
instance = FinnhubRuby::IPOCalendar.new(
|
15
|
+
ipo_calendar: null
|
16
|
+
)
|
15
17
|
```
|
16
18
|
|
17
|
-
|
data/docs/IPOEvent.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** | IPO date. | [optional]
|
9
|
-
**exchange** | **String** | Exchange. | [optional]
|
10
|
-
**name** | **String** | Company's name. | [optional]
|
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
|
-
**price** | **String** | Projected price or price range. | [optional]
|
13
|
-
**number_of_shares** | **Integer** | Number of shares offered during the IPO. | [optional]
|
14
|
-
**total_shares_value** | **Integer** | Total shares value. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol. | [optional] |
|
8
|
+
| **date** | **Date** | IPO date. | [optional] |
|
9
|
+
| **exchange** | **String** | Exchange. | [optional] |
|
10
|
+
| **name** | **String** | Company's name. | [optional] |
|
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
|
+
| **price** | **String** | Projected price or price range. | [optional] |
|
13
|
+
| **number_of_shares** | **Integer** | Number of shares offered during the IPO. | [optional] |
|
14
|
+
| **total_shares_value** | **Integer** | Total shares value. | [optional] |
|
15
15
|
|
16
|
-
##
|
16
|
+
## Example
|
17
17
|
|
18
18
|
```ruby
|
19
|
-
require '
|
19
|
+
require 'finnhub_ruby'
|
20
20
|
|
21
|
-
instance = FinnhubRuby::IPOEvent.new(
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
21
|
+
instance = FinnhubRuby::IPOEvent.new(
|
22
|
+
symbol: null,
|
23
|
+
date: null,
|
24
|
+
exchange: null,
|
25
|
+
name: null,
|
26
|
+
status: null,
|
27
|
+
price: null,
|
28
|
+
number_of_shares: null,
|
29
|
+
total_shares_value: null
|
30
|
+
)
|
29
31
|
```
|
30
32
|
|
31
|
-
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# FinnhubRuby::IndexHistoricalConstituent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Symbol | [optional] |
|
8
|
+
| **action** | **String** | <code>add</code> or <code>remove</code>. | [optional] |
|
9
|
+
| **date** | **Date** | Date of joining or leaving the index. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'finnhub_ruby'
|
15
|
+
|
16
|
+
instance = FinnhubRuby::IndexHistoricalConstituent.new(
|
17
|
+
symbol: null,
|
18
|
+
action: null,
|
19
|
+
date: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/Indicator.md
CHANGED
@@ -2,20 +2,21 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**buy** | **Integer** | Number of buy signals | [optional]
|
8
|
-
**neutral** | **Integer** | Number of neutral signals | [optional]
|
9
|
-
**sell** | **Integer** | Number of sell signals | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **buy** | **Integer** | Number of buy signals | [optional] |
|
8
|
+
| **neutral** | **Integer** | Number of neutral signals | [optional] |
|
9
|
+
| **sell** | **Integer** | Number of sell signals | [optional] |
|
10
10
|
|
11
|
-
##
|
11
|
+
## Example
|
12
12
|
|
13
13
|
```ruby
|
14
|
-
require '
|
14
|
+
require 'finnhub_ruby'
|
15
15
|
|
16
|
-
instance = FinnhubRuby::Indicator.new(
|
17
|
-
|
18
|
-
|
16
|
+
instance = FinnhubRuby::Indicator.new(
|
17
|
+
buy: null,
|
18
|
+
neutral: null,
|
19
|
+
sell: null
|
20
|
+
)
|
19
21
|
```
|
20
22
|
|
21
|
-
|