finnhub_ruby 1.1.2 → 1.1.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +42 -12
- 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/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 +2927 -891
- data/docs/Development.md +16 -13
- data/docs/Dividends.md +22 -21
- data/docs/Dividends2Basic.md +20 -0
- data/docs/ETFCountryExposureData.md +10 -9
- data/docs/ETFHoldingsData.md +20 -11
- data/docs/ETFProfileData.md +52 -0
- data/docs/ETFSectorExposureData.md +10 -9
- data/docs/ETFsCountryExposure.md +10 -9
- data/docs/ETFsHoldings.md +14 -9
- data/docs/ETFsProfile.md +10 -9
- 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/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/HistoricalNBBO.md +40 -0
- data/docs/IPOCalendar.md +8 -7
- data/docs/IPOEvent.md +22 -21
- data/docs/IndexHistoricalConstituent.md +12 -11
- data/docs/Indicator.md +12 -11
- data/docs/IndicesConstituents.md +10 -9
- data/docs/IndicesHistoricalConstituents.md +10 -9
- data/docs/InsiderTransactions.md +20 -0
- data/docs/InternationalFiling.md +34 -0
- data/docs/InvestmentThemePortfolio.md +18 -0
- data/docs/InvestmentThemesThematicInvesting.md +20 -0
- data/docs/Investor.md +14 -13
- data/docs/KeyCustomersSuppliers.md +24 -0
- data/docs/LastBidAsk.md +16 -15
- data/docs/MajorPressReleases.md +20 -0
- data/docs/MutualFundCountryExposureData.md +20 -0
- data/docs/MutualFundSectorExposure.md +20 -0
- data/docs/MutualFundSectorExposureData.md +20 -0
- data/docs/MutualFundsCountryExposure.md +20 -0
- data/docs/MutualFundsHoldings.md +24 -0
- data/docs/MutualFundsProfile.md +20 -0
- data/docs/News.md +24 -23
- data/docs/NewsSentiment.md +18 -17
- data/docs/Ownership.md +20 -0
- data/docs/PatternRecognition.md +8 -7
- 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 +12 -11
- data/docs/SocialSentiment.md +22 -0
- data/docs/Split.md +14 -13
- data/docs/Stock.md +14 -15
- data/docs/StockCandles.md +20 -19
- 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/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 -9
- data/docs/TwitterSentimentContent.md +30 -0
- data/docs/UpgradeDowngrade.md +18 -17
- data/finnhub_ruby.gemspec +7 -8
- data/lib/finnhub_ruby.rb +32 -7
- data/lib/finnhub_ruby/api/default_api.rb +1514 -466
- data/lib/finnhub_ruby/api_client.rb +52 -49
- 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 +19 -7
- data/lib/finnhub_ruby/models/company_news_statistics.rb +19 -7
- data/lib/finnhub_ruby/models/company_profile.rb +19 -7
- 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_basic.rb +231 -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 +19 -7
- data/lib/finnhub_ruby/models/earnings_call_transcripts.rb +20 -8
- data/lib/finnhub_ruby/models/earnings_call_transcripts_list.rb +19 -7
- data/lib/finnhub_ruby/models/earnings_estimates.rb +19 -7
- data/lib/finnhub_ruby/models/economic_calendar.rb +19 -7
- data/lib/finnhub_ruby/models/economic_code.rb +19 -7
- data/lib/finnhub_ruby/models/economic_data.rb +19 -7
- data/lib/finnhub_ruby/models/economic_event.rb +19 -7
- data/lib/finnhub_ruby/models/estimate.rb +20 -8
- data/lib/finnhub_ruby/models/etf_country_exposure_data.rb +20 -8
- data/lib/finnhub_ruby/models/etf_holdings_data.rb +63 -11
- data/lib/finnhub_ruby/models/etf_profile_data.rb +389 -0
- data/lib/finnhub_ruby/models/etf_sector_exposure_data.rb +20 -8
- 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 +19 -7
- 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 +19 -7
- data/lib/finnhub_ruby/models/historical_nbbo.rb +345 -0
- data/lib/finnhub_ruby/models/index_historical_constituent.rb +19 -7
- data/lib/finnhub_ruby/models/indicator.rb +19 -7
- data/lib/finnhub_ruby/models/indices_constituents.rb +19 -7
- data/lib/finnhub_ruby/models/indices_historical_constituents.rb +19 -7
- 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_thematic_investing.rb +231 -0
- data/lib/finnhub_ruby/models/investor.rb +19 -7
- data/lib/finnhub_ruby/models/ipo_calendar.rb +19 -7
- 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/mutual_fund_country_exposure_data.rb +229 -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/pattern_recognition.rb +19 -7
- 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 +19 -7
- 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 +19 -7
- 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 +23 -21
- data/lib/finnhub_ruby/models/stock_candles.rb +19 -7
- 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/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 +19 -7
- 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 +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/breakdown_item_spec.rb +40 -0
- data/spec/models/dividends2_basic_spec.rb +40 -0
- data/spec/models/etf_profile_data_spec.rb +136 -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/historical_nbbo_spec.rb +100 -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_thematic_investing_spec.rb +40 -0
- data/spec/models/key_customers_suppliers_spec.rb +52 -0
- data/spec/models/major_press_releases_spec.rb +40 -0
- data/spec/models/mutual_fund_country_exposure_data_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/mutual_funds_country_exposure_spec.rb +40 -0
- data/spec/models/mutual_funds_holdings_spec.rb +52 -0
- data/spec/models/mutual_funds_profile_spec.rb +40 -0
- data/spec/models/ownership_spec.rb +40 -0
- data/spec/models/reddit_sentiment_content_spec.rb +70 -0
- data/spec/models/revenue_breakdown_spec.rb +46 -0
- data/spec/models/sec_sentiment_analysis_spec.rb +52 -0
- data/spec/models/social_sentiment_spec.rb +46 -0
- data/spec/models/supply_chain_relationships_spec.rb +40 -0
- data/spec/models/symbol_lookup_spec.rb +40 -0
- data/spec/models/transactions_spec.rb +70 -0
- data/spec/models/twitter_sentiment_content_spec.rb +70 -0
- data/spec/spec_helper.rb +1 -1
- metadata +129 -29
- data/test.rb +0 -157
@@ -0,0 +1,30 @@
|
|
1
|
+
# FinnhubRuby::TwitterSentimentContent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **mention** | **Integer** | Number of mentions | [optional] |
|
8
|
+
| **positive_mention** | **Integer** | Number of positive mentions | [optional] |
|
9
|
+
| **negative_mention** | **Integer** | Number of negative mentions | [optional] |
|
10
|
+
| **positive_score** | **Float** | Positive score. Range 0-1 | [optional] |
|
11
|
+
| **negative_score** | **Float** | Negative score. Range 0-1 | [optional] |
|
12
|
+
| **score** | **Float** | Final score. Range: -1 to 1 with 1 is very positive and -1 is very negative | [optional] |
|
13
|
+
| **at_time** | **Time** | Period. | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'finnhub_ruby'
|
19
|
+
|
20
|
+
instance = FinnhubRuby::TwitterSentimentContent.new(
|
21
|
+
mention: null,
|
22
|
+
positive_mention: null,
|
23
|
+
negative_mention: null,
|
24
|
+
positive_score: null,
|
25
|
+
negative_score: null,
|
26
|
+
score: null,
|
27
|
+
at_time: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
data/docs/UpgradeDowngrade.md
CHANGED
@@ -2,26 +2,27 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**symbol** | **String** | Company symbol. | [optional]
|
8
|
-
**grade_time** | **Integer** | Upgrade/downgrade time in UNIX timestamp. | [optional]
|
9
|
-
**from_grade** | **String** | From grade. | [optional]
|
10
|
-
**to_grade** | **String** | To grade. | [optional]
|
11
|
-
**company** | **String** | Company/analyst who did the upgrade/downgrade. | [optional]
|
12
|
-
**action** | **String** | Action can take any of the following values: <code>up(upgrade), down(downgrade), main(maintains), init(initiate), reit(reiterate)</code>. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **symbol** | **String** | Company symbol. | [optional] |
|
8
|
+
| **grade_time** | **Integer** | Upgrade/downgrade time in UNIX timestamp. | [optional] |
|
9
|
+
| **from_grade** | **String** | From grade. | [optional] |
|
10
|
+
| **to_grade** | **String** | To grade. | [optional] |
|
11
|
+
| **company** | **String** | Company/analyst who did the upgrade/downgrade. | [optional] |
|
12
|
+
| **action** | **String** | Action can take any of the following values: <code>up(upgrade), down(downgrade), main(maintains), init(initiate), reit(reiterate)</code>. | [optional] |
|
13
13
|
|
14
|
-
##
|
14
|
+
## Example
|
15
15
|
|
16
16
|
```ruby
|
17
|
-
require '
|
17
|
+
require 'finnhub_ruby'
|
18
18
|
|
19
|
-
instance = FinnhubRuby::UpgradeDowngrade.new(
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
19
|
+
instance = FinnhubRuby::UpgradeDowngrade.new(
|
20
|
+
symbol: null,
|
21
|
+
grade_time: null,
|
22
|
+
from_grade: null,
|
23
|
+
to_grade: null,
|
24
|
+
company: null,
|
25
|
+
action: null
|
26
|
+
)
|
25
27
|
```
|
26
28
|
|
27
|
-
|
data/finnhub_ruby.gemspec
CHANGED
@@ -8,7 +8,7 @@
|
|
8
8
|
The version of the OpenAPI document: 1.0.0
|
9
9
|
|
10
10
|
Generated by: https://openapi-generator.tech
|
11
|
-
OpenAPI Generator version:
|
11
|
+
OpenAPI Generator version: 5.2.0
|
12
12
|
|
13
13
|
=end
|
14
14
|
|
@@ -19,16 +19,15 @@ Gem::Specification.new do |s|
|
|
19
19
|
s.name = "finnhub_ruby"
|
20
20
|
s.version = FinnhubRuby::VERSION
|
21
21
|
s.platform = Gem::Platform::RUBY
|
22
|
-
s.authors = ["
|
23
|
-
s.email = ["
|
24
|
-
s.homepage = "https://
|
22
|
+
s.authors = ["OpenAPI-Generator"]
|
23
|
+
s.email = [""]
|
24
|
+
s.homepage = "https://openapi-generator.tech"
|
25
25
|
s.summary = "Finnhub API Ruby Gem"
|
26
|
-
s.description = "
|
27
|
-
s.license = "
|
28
|
-
s.required_ruby_version = ">=
|
26
|
+
s.description = "No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)"
|
27
|
+
s.license = "Unlicense"
|
28
|
+
s.required_ruby_version = ">= 2.4"
|
29
29
|
|
30
30
|
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
31
|
-
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
32
31
|
|
33
32
|
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
34
33
|
|
data/lib/finnhub_ruby.rb
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.2.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -19,6 +19,7 @@ require 'finnhub_ruby/configuration'
|
|
19
19
|
# Models
|
20
20
|
require 'finnhub_ruby/models/aggregate_indicators'
|
21
21
|
require 'finnhub_ruby/models/basic_financials'
|
22
|
+
require 'finnhub_ruby/models/breakdown_item'
|
22
23
|
require 'finnhub_ruby/models/company'
|
23
24
|
require 'finnhub_ruby/models/company_executive'
|
24
25
|
require 'finnhub_ruby/models/company_news_statistics'
|
@@ -30,13 +31,15 @@ require 'finnhub_ruby/models/crypto_candles'
|
|
30
31
|
require 'finnhub_ruby/models/crypto_symbol'
|
31
32
|
require 'finnhub_ruby/models/development'
|
32
33
|
require 'finnhub_ruby/models/dividends'
|
34
|
+
require 'finnhub_ruby/models/dividends2_basic'
|
33
35
|
require 'finnhub_ruby/models/etf_country_exposure_data'
|
34
36
|
require 'finnhub_ruby/models/etf_holdings_data'
|
37
|
+
require 'finnhub_ruby/models/etf_profile_data'
|
35
38
|
require 'finnhub_ruby/models/etf_sector_exposure_data'
|
36
|
-
require 'finnhub_ruby/models/
|
37
|
-
require 'finnhub_ruby/models/
|
38
|
-
require 'finnhub_ruby/models/
|
39
|
-
require 'finnhub_ruby/models/
|
39
|
+
require 'finnhub_ruby/models/etfs_country_exposure'
|
40
|
+
require 'finnhub_ruby/models/etfs_holdings'
|
41
|
+
require 'finnhub_ruby/models/etfs_profile'
|
42
|
+
require 'finnhub_ruby/models/etfs_sector_exposure'
|
40
43
|
require 'finnhub_ruby/models/earning_estimate'
|
41
44
|
require 'finnhub_ruby/models/earning_release'
|
42
45
|
require 'finnhub_ruby/models/earning_result'
|
@@ -49,43 +52,65 @@ require 'finnhub_ruby/models/economic_code'
|
|
49
52
|
require 'finnhub_ruby/models/economic_data'
|
50
53
|
require 'finnhub_ruby/models/economic_event'
|
51
54
|
require 'finnhub_ruby/models/estimate'
|
55
|
+
require 'finnhub_ruby/models/fda_comittee_meeting'
|
52
56
|
require 'finnhub_ruby/models/filing'
|
57
|
+
require 'finnhub_ruby/models/filing_sentiment'
|
53
58
|
require 'finnhub_ruby/models/financial_statements'
|
54
59
|
require 'finnhub_ruby/models/financials_as_reported'
|
55
60
|
require 'finnhub_ruby/models/forex_candles'
|
56
61
|
require 'finnhub_ruby/models/forex_symbol'
|
57
62
|
require 'finnhub_ruby/models/forexrates'
|
58
63
|
require 'finnhub_ruby/models/fund_ownership'
|
64
|
+
require 'finnhub_ruby/models/historical_nbbo'
|
59
65
|
require 'finnhub_ruby/models/ipo_calendar'
|
60
66
|
require 'finnhub_ruby/models/ipo_event'
|
61
67
|
require 'finnhub_ruby/models/index_historical_constituent'
|
62
68
|
require 'finnhub_ruby/models/indicator'
|
63
69
|
require 'finnhub_ruby/models/indices_constituents'
|
64
70
|
require 'finnhub_ruby/models/indices_historical_constituents'
|
71
|
+
require 'finnhub_ruby/models/insider_transactions'
|
72
|
+
require 'finnhub_ruby/models/international_filing'
|
73
|
+
require 'finnhub_ruby/models/investment_theme_portfolio'
|
74
|
+
require 'finnhub_ruby/models/investment_themes_thematic_investing'
|
65
75
|
require 'finnhub_ruby/models/investor'
|
66
|
-
require 'finnhub_ruby/models/
|
76
|
+
require 'finnhub_ruby/models/key_customers_suppliers'
|
67
77
|
require 'finnhub_ruby/models/last_bid_ask'
|
68
|
-
require 'finnhub_ruby/models/
|
78
|
+
require 'finnhub_ruby/models/major_press_releases'
|
79
|
+
require 'finnhub_ruby/models/mutual_fund_country_exposure_data'
|
80
|
+
require 'finnhub_ruby/models/mutual_fund_sector_exposure'
|
81
|
+
require 'finnhub_ruby/models/mutual_fund_sector_exposure_data'
|
82
|
+
require 'finnhub_ruby/models/mutual_funds_country_exposure'
|
83
|
+
require 'finnhub_ruby/models/mutual_funds_holdings'
|
84
|
+
require 'finnhub_ruby/models/mutual_funds_profile'
|
69
85
|
require 'finnhub_ruby/models/news'
|
70
86
|
require 'finnhub_ruby/models/news_sentiment'
|
87
|
+
require 'finnhub_ruby/models/ownership'
|
71
88
|
require 'finnhub_ruby/models/pattern_recognition'
|
72
89
|
require 'finnhub_ruby/models/price_target'
|
73
90
|
require 'finnhub_ruby/models/quote'
|
74
91
|
require 'finnhub_ruby/models/recommendation_trend'
|
92
|
+
require 'finnhub_ruby/models/reddit_sentiment_content'
|
75
93
|
require 'finnhub_ruby/models/report'
|
94
|
+
require 'finnhub_ruby/models/revenue_breakdown'
|
76
95
|
require 'finnhub_ruby/models/revenue_estimates'
|
96
|
+
require 'finnhub_ruby/models/sec_sentiment_analysis'
|
77
97
|
require 'finnhub_ruby/models/sentiment'
|
78
98
|
require 'finnhub_ruby/models/similarity_index'
|
99
|
+
require 'finnhub_ruby/models/social_sentiment'
|
79
100
|
require 'finnhub_ruby/models/split'
|
80
101
|
require 'finnhub_ruby/models/stock'
|
81
102
|
require 'finnhub_ruby/models/stock_candles'
|
82
103
|
require 'finnhub_ruby/models/stock_transcripts'
|
104
|
+
require 'finnhub_ruby/models/supply_chain_relationships'
|
83
105
|
require 'finnhub_ruby/models/support_resistance'
|
106
|
+
require 'finnhub_ruby/models/symbol_lookup'
|
84
107
|
require 'finnhub_ruby/models/technical_analysis'
|
85
108
|
require 'finnhub_ruby/models/tick_data'
|
109
|
+
require 'finnhub_ruby/models/transactions'
|
86
110
|
require 'finnhub_ruby/models/transcript_content'
|
87
111
|
require 'finnhub_ruby/models/transcript_participant'
|
88
112
|
require 'finnhub_ruby/models/trend'
|
113
|
+
require 'finnhub_ruby/models/twitter_sentiment_content'
|
89
114
|
require 'finnhub_ruby/models/upgrade_downgrade'
|
90
115
|
|
91
116
|
# APIs
|
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 5.2.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -65,15 +65,16 @@ module FinnhubRuby
|
|
65
65
|
form_params = opts[:form_params] || {}
|
66
66
|
|
67
67
|
# http body (model)
|
68
|
-
post_body = opts[:
|
68
|
+
post_body = opts[:debug_body]
|
69
69
|
|
70
70
|
# return_type
|
71
|
-
return_type = opts[:
|
71
|
+
return_type = opts[:debug_return_type] || 'AggregateIndicators'
|
72
72
|
|
73
73
|
# auth_names
|
74
|
-
auth_names = opts[:
|
74
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
75
75
|
|
76
76
|
new_options = opts.merge(
|
77
|
+
:operation => :"DefaultApi.aggregate_indicator",
|
77
78
|
:header_params => header_params,
|
78
79
|
:query_params => query_params,
|
79
80
|
:form_params => form_params,
|
@@ -92,7 +93,7 @@ module FinnhubRuby
|
|
92
93
|
# Basic Financials
|
93
94
|
# Get company basic financials such as margin, P/E ratio, 52-week high/low etc.
|
94
95
|
# @param symbol [String] Symbol of the company: AAPL.
|
95
|
-
# @param metric [String] Metric type. Can be 1 of the following values <code>all
|
96
|
+
# @param metric [String] Metric type. Can be 1 of the following values <code>all</code>
|
96
97
|
# @param [Hash] opts the optional parameters
|
97
98
|
# @return [BasicFinancials]
|
98
99
|
def company_basic_financials(symbol, metric, opts = {})
|
@@ -103,7 +104,7 @@ module FinnhubRuby
|
|
103
104
|
# Basic Financials
|
104
105
|
# Get company basic financials such as margin, P/E ratio, 52-week high/low etc.
|
105
106
|
# @param symbol [String] Symbol of the company: AAPL.
|
106
|
-
# @param metric [String] Metric type. Can be 1 of the following values <code>all
|
107
|
+
# @param metric [String] Metric type. Can be 1 of the following values <code>all</code>
|
107
108
|
# @param [Hash] opts the optional parameters
|
108
109
|
# @return [Array<(BasicFinancials, Integer, Hash)>] BasicFinancials data, response status code and response headers
|
109
110
|
def company_basic_financials_with_http_info(symbol, metric, opts = {})
|
@@ -135,15 +136,16 @@ module FinnhubRuby
|
|
135
136
|
form_params = opts[:form_params] || {}
|
136
137
|
|
137
138
|
# http body (model)
|
138
|
-
post_body = opts[:
|
139
|
+
post_body = opts[:debug_body]
|
139
140
|
|
140
141
|
# return_type
|
141
|
-
return_type = opts[:
|
142
|
+
return_type = opts[:debug_return_type] || 'BasicFinancials'
|
142
143
|
|
143
144
|
# auth_names
|
144
|
-
auth_names = opts[:
|
145
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
145
146
|
|
146
147
|
new_options = opts.merge(
|
148
|
+
:operation => :"DefaultApi.company_basic_financials",
|
147
149
|
:header_params => header_params,
|
148
150
|
:query_params => query_params,
|
149
151
|
:form_params => form_params,
|
@@ -201,15 +203,16 @@ module FinnhubRuby
|
|
201
203
|
form_params = opts[:form_params] || {}
|
202
204
|
|
203
205
|
# http body (model)
|
204
|
-
post_body = opts[:
|
206
|
+
post_body = opts[:debug_body]
|
205
207
|
|
206
208
|
# return_type
|
207
|
-
return_type = opts[:
|
209
|
+
return_type = opts[:debug_return_type] || 'Array<EarningResult>'
|
208
210
|
|
209
211
|
# auth_names
|
210
|
-
auth_names = opts[:
|
212
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
211
213
|
|
212
214
|
new_options = opts.merge(
|
215
|
+
:operation => :"DefaultApi.company_earnings",
|
213
216
|
:header_params => header_params,
|
214
217
|
:query_params => query_params,
|
215
218
|
:form_params => form_params,
|
@@ -267,15 +270,16 @@ module FinnhubRuby
|
|
267
270
|
form_params = opts[:form_params] || {}
|
268
271
|
|
269
272
|
# http body (model)
|
270
|
-
post_body = opts[:
|
273
|
+
post_body = opts[:debug_body]
|
271
274
|
|
272
275
|
# return_type
|
273
|
-
return_type = opts[:
|
276
|
+
return_type = opts[:debug_return_type] || 'EarningsEstimates'
|
274
277
|
|
275
278
|
# auth_names
|
276
|
-
auth_names = opts[:
|
279
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
277
280
|
|
278
281
|
new_options = opts.merge(
|
282
|
+
:operation => :"DefaultApi.company_eps_estimates",
|
279
283
|
:header_params => header_params,
|
280
284
|
:query_params => query_params,
|
281
285
|
:form_params => form_params,
|
@@ -330,15 +334,16 @@ module FinnhubRuby
|
|
330
334
|
form_params = opts[:form_params] || {}
|
331
335
|
|
332
336
|
# http body (model)
|
333
|
-
post_body = opts[:
|
337
|
+
post_body = opts[:debug_body]
|
334
338
|
|
335
339
|
# return_type
|
336
|
-
return_type = opts[:
|
340
|
+
return_type = opts[:debug_return_type] || 'CompanyExecutive'
|
337
341
|
|
338
342
|
# auth_names
|
339
|
-
auth_names = opts[:
|
343
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
340
344
|
|
341
345
|
new_options = opts.merge(
|
346
|
+
:operation => :"DefaultApi.company_executive",
|
342
347
|
:header_params => header_params,
|
343
348
|
:query_params => query_params,
|
344
349
|
:form_params => form_params,
|
@@ -407,15 +412,16 @@ module FinnhubRuby
|
|
407
412
|
form_params = opts[:form_params] || {}
|
408
413
|
|
409
414
|
# http body (model)
|
410
|
-
post_body = opts[:
|
415
|
+
post_body = opts[:debug_body]
|
411
416
|
|
412
417
|
# return_type
|
413
|
-
return_type = opts[:
|
418
|
+
return_type = opts[:debug_return_type] || 'Array<News>'
|
414
419
|
|
415
420
|
# auth_names
|
416
|
-
auth_names = opts[:
|
421
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
417
422
|
|
418
423
|
new_options = opts.merge(
|
424
|
+
:operation => :"DefaultApi.company_news",
|
419
425
|
:header_params => header_params,
|
420
426
|
:query_params => query_params,
|
421
427
|
:form_params => form_params,
|
@@ -470,15 +476,16 @@ module FinnhubRuby
|
|
470
476
|
form_params = opts[:form_params] || {}
|
471
477
|
|
472
478
|
# http body (model)
|
473
|
-
post_body = opts[:
|
479
|
+
post_body = opts[:debug_body]
|
474
480
|
|
475
481
|
# return_type
|
476
|
-
return_type = opts[:
|
482
|
+
return_type = opts[:debug_return_type] || 'Array<String>'
|
477
483
|
|
478
484
|
# auth_names
|
479
|
-
auth_names = opts[:
|
485
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
480
486
|
|
481
487
|
new_options = opts.merge(
|
488
|
+
:operation => :"DefaultApi.company_peers",
|
482
489
|
:header_params => header_params,
|
483
490
|
:query_params => query_params,
|
484
491
|
:form_params => form_params,
|
@@ -535,15 +542,16 @@ module FinnhubRuby
|
|
535
542
|
form_params = opts[:form_params] || {}
|
536
543
|
|
537
544
|
# http body (model)
|
538
|
-
post_body = opts[:
|
545
|
+
post_body = opts[:debug_body]
|
539
546
|
|
540
547
|
# return_type
|
541
|
-
return_type = opts[:
|
548
|
+
return_type = opts[:debug_return_type] || 'CompanyProfile'
|
542
549
|
|
543
550
|
# auth_names
|
544
|
-
auth_names = opts[:
|
551
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
545
552
|
|
546
553
|
new_options = opts.merge(
|
554
|
+
:operation => :"DefaultApi.company_profile",
|
547
555
|
:header_params => header_params,
|
548
556
|
:query_params => query_params,
|
549
557
|
:form_params => form_params,
|
@@ -600,15 +608,16 @@ module FinnhubRuby
|
|
600
608
|
form_params = opts[:form_params] || {}
|
601
609
|
|
602
610
|
# http body (model)
|
603
|
-
post_body = opts[:
|
611
|
+
post_body = opts[:debug_body]
|
604
612
|
|
605
613
|
# return_type
|
606
|
-
return_type = opts[:
|
614
|
+
return_type = opts[:debug_return_type] || 'CompanyProfile2'
|
607
615
|
|
608
616
|
# auth_names
|
609
|
-
auth_names = opts[:
|
617
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
610
618
|
|
611
619
|
new_options = opts.merge(
|
620
|
+
:operation => :"DefaultApi.company_profile2",
|
612
621
|
:header_params => header_params,
|
613
622
|
:query_params => query_params,
|
614
623
|
:form_params => form_params,
|
@@ -666,15 +675,16 @@ module FinnhubRuby
|
|
666
675
|
form_params = opts[:form_params] || {}
|
667
676
|
|
668
677
|
# http body (model)
|
669
|
-
post_body = opts[:
|
678
|
+
post_body = opts[:debug_body]
|
670
679
|
|
671
680
|
# return_type
|
672
|
-
return_type = opts[:
|
681
|
+
return_type = opts[:debug_return_type] || 'RevenueEstimates'
|
673
682
|
|
674
683
|
# auth_names
|
675
|
-
auth_names = opts[:
|
684
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
676
685
|
|
677
686
|
new_options = opts.merge(
|
687
|
+
:operation => :"DefaultApi.company_revenue_estimates",
|
678
688
|
:header_params => header_params,
|
679
689
|
:query_params => query_params,
|
680
690
|
:form_params => form_params,
|
@@ -722,15 +732,16 @@ module FinnhubRuby
|
|
722
732
|
form_params = opts[:form_params] || {}
|
723
733
|
|
724
734
|
# http body (model)
|
725
|
-
post_body = opts[:
|
735
|
+
post_body = opts[:debug_body]
|
726
736
|
|
727
737
|
# return_type
|
728
|
-
return_type = opts[:
|
738
|
+
return_type = opts[:debug_return_type] || 'Array<CountryMetadata>'
|
729
739
|
|
730
740
|
# auth_names
|
731
|
-
auth_names = opts[:
|
741
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
732
742
|
|
733
743
|
new_options = opts.merge(
|
744
|
+
:operation => :"DefaultApi.country",
|
734
745
|
:header_params => header_params,
|
735
746
|
:query_params => query_params,
|
736
747
|
:form_params => form_params,
|
@@ -778,15 +789,16 @@ module FinnhubRuby
|
|
778
789
|
form_params = opts[:form_params] || {}
|
779
790
|
|
780
791
|
# http body (model)
|
781
|
-
post_body = opts[:
|
792
|
+
post_body = opts[:debug_body]
|
782
793
|
|
783
794
|
# return_type
|
784
|
-
return_type = opts[:
|
795
|
+
return_type = opts[:debug_return_type] || 'Array<CovidInfo>'
|
785
796
|
|
786
797
|
# auth_names
|
787
|
-
auth_names = opts[:
|
798
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
788
799
|
|
789
800
|
new_options = opts.merge(
|
801
|
+
:operation => :"DefaultApi.covid19",
|
790
802
|
:header_params => header_params,
|
791
803
|
:query_params => query_params,
|
792
804
|
:form_params => form_params,
|
@@ -862,15 +874,16 @@ module FinnhubRuby
|
|
862
874
|
form_params = opts[:form_params] || {}
|
863
875
|
|
864
876
|
# http body (model)
|
865
|
-
post_body = opts[:
|
877
|
+
post_body = opts[:debug_body]
|
866
878
|
|
867
879
|
# return_type
|
868
|
-
return_type = opts[:
|
880
|
+
return_type = opts[:debug_return_type] || 'CryptoCandles'
|
869
881
|
|
870
882
|
# auth_names
|
871
|
-
auth_names = opts[:
|
883
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
872
884
|
|
873
885
|
new_options = opts.merge(
|
886
|
+
:operation => :"DefaultApi.crypto_candles",
|
874
887
|
:header_params => header_params,
|
875
888
|
:query_params => query_params,
|
876
889
|
:form_params => form_params,
|
@@ -918,15 +931,16 @@ module FinnhubRuby
|
|
918
931
|
form_params = opts[:form_params] || {}
|
919
932
|
|
920
933
|
# http body (model)
|
921
|
-
post_body = opts[:
|
934
|
+
post_body = opts[:debug_body]
|
922
935
|
|
923
936
|
# return_type
|
924
|
-
return_type = opts[:
|
937
|
+
return_type = opts[:debug_return_type] || 'Array<String>'
|
925
938
|
|
926
939
|
# auth_names
|
927
|
-
auth_names = opts[:
|
940
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
928
941
|
|
929
942
|
new_options = opts.merge(
|
943
|
+
:operation => :"DefaultApi.crypto_exchanges",
|
930
944
|
:header_params => header_params,
|
931
945
|
:query_params => query_params,
|
932
946
|
:form_params => form_params,
|
@@ -981,15 +995,16 @@ module FinnhubRuby
|
|
981
995
|
form_params = opts[:form_params] || {}
|
982
996
|
|
983
997
|
# http body (model)
|
984
|
-
post_body = opts[:
|
998
|
+
post_body = opts[:debug_body]
|
985
999
|
|
986
1000
|
# return_type
|
987
|
-
return_type = opts[:
|
1001
|
+
return_type = opts[:debug_return_type] || 'Array<CryptoSymbol>'
|
988
1002
|
|
989
1003
|
# auth_names
|
990
|
-
auth_names = opts[:
|
1004
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
991
1005
|
|
992
1006
|
new_options = opts.merge(
|
1007
|
+
:operation => :"DefaultApi.crypto_symbols",
|
993
1008
|
:header_params => header_params,
|
994
1009
|
:query_params => query_params,
|
995
1010
|
:form_params => form_params,
|
@@ -1006,7 +1021,7 @@ module FinnhubRuby
|
|
1006
1021
|
end
|
1007
1022
|
|
1008
1023
|
# Earnings Calendar
|
1009
|
-
# Get historical and coming earnings release
|
1024
|
+
# Get historical and coming earnings release. EPS and Revenue in this endpoint are non-GAAP, which means they are adjusted to exclude some one-time or unusual items. This is the same data investors usually react to and talked about on the media. Estimates are sourced from both sell-side and buy-side analysts.
|
1010
1025
|
# @param [Hash] opts the optional parameters
|
1011
1026
|
# @option opts [Date] :from From date: 2020-03-15.
|
1012
1027
|
# @option opts [Date] :to To date: 2020-03-16.
|
@@ -1019,7 +1034,7 @@ module FinnhubRuby
|
|
1019
1034
|
end
|
1020
1035
|
|
1021
1036
|
# Earnings Calendar
|
1022
|
-
# Get historical and coming earnings release
|
1037
|
+
# Get historical and coming earnings release. EPS and Revenue in this endpoint are non-GAAP, which means they are adjusted to exclude some one-time or unusual items. This is the same data investors usually react to and talked about on the media. Estimates are sourced from both sell-side and buy-side analysts.
|
1023
1038
|
# @param [Hash] opts the optional parameters
|
1024
1039
|
# @option opts [Date] :from From date: 2020-03-15.
|
1025
1040
|
# @option opts [Date] :to To date: 2020-03-16.
|
@@ -1049,15 +1064,16 @@ module FinnhubRuby
|
|
1049
1064
|
form_params = opts[:form_params] || {}
|
1050
1065
|
|
1051
1066
|
# http body (model)
|
1052
|
-
post_body = opts[:
|
1067
|
+
post_body = opts[:debug_body]
|
1053
1068
|
|
1054
1069
|
# return_type
|
1055
|
-
return_type = opts[:
|
1070
|
+
return_type = opts[:debug_return_type] || 'EarningsCalendar'
|
1056
1071
|
|
1057
1072
|
# auth_names
|
1058
|
-
auth_names = opts[:
|
1073
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1059
1074
|
|
1060
1075
|
new_options = opts.merge(
|
1076
|
+
:operation => :"DefaultApi.earnings_calendar",
|
1061
1077
|
:header_params => header_params,
|
1062
1078
|
:query_params => query_params,
|
1063
1079
|
:form_params => form_params,
|
@@ -1073,6 +1089,70 @@ module FinnhubRuby
|
|
1073
1089
|
return data, status_code, headers
|
1074
1090
|
end
|
1075
1091
|
|
1092
|
+
# Earnings Call Transcripts
|
1093
|
+
# <p>Get earnings call transcripts, audio and participants' list. This endpoint is only available for US, UK, and Candian companies. <p>15+ years of data is available with 220,000+ audio which add up to 7TB in size.</p>
|
1094
|
+
# @param id [String] Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>.
|
1095
|
+
# @param [Hash] opts the optional parameters
|
1096
|
+
# @return [EarningsCallTranscripts]
|
1097
|
+
def earnings_call_transcripts_api(id, opts = {})
|
1098
|
+
data, _status_code, _headers = earnings_call_transcripts_api_with_http_info(id, opts)
|
1099
|
+
data
|
1100
|
+
end
|
1101
|
+
|
1102
|
+
# Earnings Call Transcripts
|
1103
|
+
# <p>Get earnings call transcripts, audio and participants' list. This endpoint is only available for US, UK, and Candian companies. <p>15+ years of data is available with 220,000+ audio which add up to 7TB in size.</p>
|
1104
|
+
# @param id [String] Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>.
|
1105
|
+
# @param [Hash] opts the optional parameters
|
1106
|
+
# @return [Array<(EarningsCallTranscripts, Integer, Hash)>] EarningsCallTranscripts data, response status code and response headers
|
1107
|
+
def earnings_call_transcripts_api_with_http_info(id, opts = {})
|
1108
|
+
if @api_client.config.debugging
|
1109
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.earnings_call_transcripts_api ...'
|
1110
|
+
end
|
1111
|
+
# verify the required parameter 'id' is set
|
1112
|
+
if @api_client.config.client_side_validation && id.nil?
|
1113
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling DefaultApi.earnings_call_transcripts_api"
|
1114
|
+
end
|
1115
|
+
# resource path
|
1116
|
+
local_var_path = '/stock/transcripts'
|
1117
|
+
|
1118
|
+
# query parameters
|
1119
|
+
query_params = opts[:query_params] || {}
|
1120
|
+
query_params[:'id'] = id
|
1121
|
+
|
1122
|
+
# header parameters
|
1123
|
+
header_params = opts[:header_params] || {}
|
1124
|
+
# HTTP header 'Accept' (if needed)
|
1125
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1126
|
+
|
1127
|
+
# form parameters
|
1128
|
+
form_params = opts[:form_params] || {}
|
1129
|
+
|
1130
|
+
# http body (model)
|
1131
|
+
post_body = opts[:debug_body]
|
1132
|
+
|
1133
|
+
# return_type
|
1134
|
+
return_type = opts[:debug_return_type] || 'EarningsCallTranscripts'
|
1135
|
+
|
1136
|
+
# auth_names
|
1137
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1138
|
+
|
1139
|
+
new_options = opts.merge(
|
1140
|
+
:operation => :"DefaultApi.earnings_call_transcripts_api",
|
1141
|
+
:header_params => header_params,
|
1142
|
+
:query_params => query_params,
|
1143
|
+
:form_params => form_params,
|
1144
|
+
:body => post_body,
|
1145
|
+
:auth_names => auth_names,
|
1146
|
+
:return_type => return_type
|
1147
|
+
)
|
1148
|
+
|
1149
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1150
|
+
if @api_client.config.debugging
|
1151
|
+
@api_client.config.logger.debug "API called: DefaultApi#earnings_call_transcripts_api\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1152
|
+
end
|
1153
|
+
return data, status_code, headers
|
1154
|
+
end
|
1155
|
+
|
1076
1156
|
# Economic Code
|
1077
1157
|
# List codes of supported economic data.
|
1078
1158
|
# @param [Hash] opts the optional parameters
|
@@ -1105,15 +1185,16 @@ module FinnhubRuby
|
|
1105
1185
|
form_params = opts[:form_params] || {}
|
1106
1186
|
|
1107
1187
|
# http body (model)
|
1108
|
-
post_body = opts[:
|
1188
|
+
post_body = opts[:debug_body]
|
1109
1189
|
|
1110
1190
|
# return_type
|
1111
|
-
return_type = opts[:
|
1191
|
+
return_type = opts[:debug_return_type] || 'Array<EconomicCode>'
|
1112
1192
|
|
1113
1193
|
# auth_names
|
1114
|
-
auth_names = opts[:
|
1194
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1115
1195
|
|
1116
1196
|
new_options = opts.merge(
|
1197
|
+
:operation => :"DefaultApi.economic_code",
|
1117
1198
|
:header_params => header_params,
|
1118
1199
|
:query_params => query_params,
|
1119
1200
|
:form_params => form_params,
|
@@ -1168,15 +1249,16 @@ module FinnhubRuby
|
|
1168
1249
|
form_params = opts[:form_params] || {}
|
1169
1250
|
|
1170
1251
|
# http body (model)
|
1171
|
-
post_body = opts[:
|
1252
|
+
post_body = opts[:debug_body]
|
1172
1253
|
|
1173
1254
|
# return_type
|
1174
|
-
return_type = opts[:
|
1255
|
+
return_type = opts[:debug_return_type] || 'EconomicData'
|
1175
1256
|
|
1176
1257
|
# auth_names
|
1177
|
-
auth_names = opts[:
|
1258
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1178
1259
|
|
1179
1260
|
new_options = opts.merge(
|
1261
|
+
:operation => :"DefaultApi.economic_data",
|
1180
1262
|
:header_params => header_params,
|
1181
1263
|
:query_params => query_params,
|
1182
1264
|
:form_params => form_params,
|
@@ -1231,15 +1313,16 @@ module FinnhubRuby
|
|
1231
1313
|
form_params = opts[:form_params] || {}
|
1232
1314
|
|
1233
1315
|
# http body (model)
|
1234
|
-
post_body = opts[:
|
1316
|
+
post_body = opts[:debug_body]
|
1235
1317
|
|
1236
1318
|
# return_type
|
1237
|
-
return_type = opts[:
|
1319
|
+
return_type = opts[:debug_return_type] || 'ETFsCountryExposure'
|
1238
1320
|
|
1239
1321
|
# auth_names
|
1240
|
-
auth_names = opts[:
|
1322
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1241
1323
|
|
1242
1324
|
new_options = opts.merge(
|
1325
|
+
:operation => :"DefaultApi.etfs_country_exposure",
|
1243
1326
|
:header_params => header_params,
|
1244
1327
|
:query_params => query_params,
|
1245
1328
|
:form_params => form_params,
|
@@ -1256,34 +1339,36 @@ module FinnhubRuby
|
|
1256
1339
|
end
|
1257
1340
|
|
1258
1341
|
# ETFs Holdings
|
1259
|
-
# Get
|
1260
|
-
# @param symbol [String] ETF symbol.
|
1342
|
+
# Get full ETF holdings/constituents. This endpoint has global coverage. Widget only shows top 10 holdings.
|
1261
1343
|
# @param [Hash] opts the optional parameters
|
1344
|
+
# @option opts [String] :symbol ETF symbol.
|
1345
|
+
# @option opts [String] :isin ETF isin.
|
1346
|
+
# @option opts [Integer] :skip Skip the first n results. You can use this parameter to query historical constituents data. The latest result is returned if skip=0 or not set.
|
1262
1347
|
# @return [ETFsHoldings]
|
1263
|
-
def etfs_holdings(
|
1264
|
-
data, _status_code, _headers = etfs_holdings_with_http_info(
|
1348
|
+
def etfs_holdings(opts = {})
|
1349
|
+
data, _status_code, _headers = etfs_holdings_with_http_info(opts)
|
1265
1350
|
data
|
1266
1351
|
end
|
1267
1352
|
|
1268
1353
|
# ETFs Holdings
|
1269
|
-
# Get
|
1270
|
-
# @param symbol [String] ETF symbol.
|
1354
|
+
# Get full ETF holdings/constituents. This endpoint has global coverage. Widget only shows top 10 holdings.
|
1271
1355
|
# @param [Hash] opts the optional parameters
|
1356
|
+
# @option opts [String] :symbol ETF symbol.
|
1357
|
+
# @option opts [String] :isin ETF isin.
|
1358
|
+
# @option opts [Integer] :skip Skip the first n results. You can use this parameter to query historical constituents data. The latest result is returned if skip=0 or not set.
|
1272
1359
|
# @return [Array<(ETFsHoldings, Integer, Hash)>] ETFsHoldings data, response status code and response headers
|
1273
|
-
def etfs_holdings_with_http_info(
|
1360
|
+
def etfs_holdings_with_http_info(opts = {})
|
1274
1361
|
if @api_client.config.debugging
|
1275
1362
|
@api_client.config.logger.debug 'Calling API: DefaultApi.etfs_holdings ...'
|
1276
1363
|
end
|
1277
|
-
# verify the required parameter 'symbol' is set
|
1278
|
-
if @api_client.config.client_side_validation && symbol.nil?
|
1279
|
-
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.etfs_holdings"
|
1280
|
-
end
|
1281
1364
|
# resource path
|
1282
1365
|
local_var_path = '/etf/holdings'
|
1283
1366
|
|
1284
1367
|
# query parameters
|
1285
1368
|
query_params = opts[:query_params] || {}
|
1286
|
-
query_params[:'symbol'] = symbol
|
1369
|
+
query_params[:'symbol'] = opts[:'symbol'] if !opts[:'symbol'].nil?
|
1370
|
+
query_params[:'isin'] = opts[:'isin'] if !opts[:'isin'].nil?
|
1371
|
+
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
1287
1372
|
|
1288
1373
|
# header parameters
|
1289
1374
|
header_params = opts[:header_params] || {}
|
@@ -1294,15 +1379,16 @@ module FinnhubRuby
|
|
1294
1379
|
form_params = opts[:form_params] || {}
|
1295
1380
|
|
1296
1381
|
# http body (model)
|
1297
|
-
post_body = opts[:
|
1382
|
+
post_body = opts[:debug_body]
|
1298
1383
|
|
1299
1384
|
# return_type
|
1300
|
-
return_type = opts[:
|
1385
|
+
return_type = opts[:debug_return_type] || 'ETFsHoldings'
|
1301
1386
|
|
1302
1387
|
# auth_names
|
1303
|
-
auth_names = opts[:
|
1388
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1304
1389
|
|
1305
1390
|
new_options = opts.merge(
|
1391
|
+
:operation => :"DefaultApi.etfs_holdings",
|
1306
1392
|
:header_params => header_params,
|
1307
1393
|
:query_params => query_params,
|
1308
1394
|
:form_params => form_params,
|
@@ -1318,28 +1404,91 @@ module FinnhubRuby
|
|
1318
1404
|
return data, status_code, headers
|
1319
1405
|
end
|
1320
1406
|
|
1321
|
-
# ETFs
|
1322
|
-
# Get ETF
|
1407
|
+
# ETFs Profile
|
1408
|
+
# Get ETF profile information. This endpoint has global coverage.
|
1409
|
+
# @param [Hash] opts the optional parameters
|
1410
|
+
# @option opts [String] :symbol ETF symbol.
|
1411
|
+
# @option opts [String] :isin ETF isin.
|
1412
|
+
# @return [ETFsProfile]
|
1413
|
+
def etfs_profile(opts = {})
|
1414
|
+
data, _status_code, _headers = etfs_profile_with_http_info(opts)
|
1415
|
+
data
|
1416
|
+
end
|
1417
|
+
|
1418
|
+
# ETFs Profile
|
1419
|
+
# Get ETF profile information. This endpoint has global coverage.
|
1420
|
+
# @param [Hash] opts the optional parameters
|
1421
|
+
# @option opts [String] :symbol ETF symbol.
|
1422
|
+
# @option opts [String] :isin ETF isin.
|
1423
|
+
# @return [Array<(ETFsProfile, Integer, Hash)>] ETFsProfile data, response status code and response headers
|
1424
|
+
def etfs_profile_with_http_info(opts = {})
|
1425
|
+
if @api_client.config.debugging
|
1426
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.etfs_profile ...'
|
1427
|
+
end
|
1428
|
+
# resource path
|
1429
|
+
local_var_path = '/etf/profile'
|
1430
|
+
|
1431
|
+
# query parameters
|
1432
|
+
query_params = opts[:query_params] || {}
|
1433
|
+
query_params[:'symbol'] = opts[:'symbol'] if !opts[:'symbol'].nil?
|
1434
|
+
query_params[:'isin'] = opts[:'isin'] if !opts[:'isin'].nil?
|
1435
|
+
|
1436
|
+
# header parameters
|
1437
|
+
header_params = opts[:header_params] || {}
|
1438
|
+
# HTTP header 'Accept' (if needed)
|
1439
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1440
|
+
|
1441
|
+
# form parameters
|
1442
|
+
form_params = opts[:form_params] || {}
|
1443
|
+
|
1444
|
+
# http body (model)
|
1445
|
+
post_body = opts[:debug_body]
|
1446
|
+
|
1447
|
+
# return_type
|
1448
|
+
return_type = opts[:debug_return_type] || 'ETFsProfile'
|
1449
|
+
|
1450
|
+
# auth_names
|
1451
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1452
|
+
|
1453
|
+
new_options = opts.merge(
|
1454
|
+
:operation => :"DefaultApi.etfs_profile",
|
1455
|
+
:header_params => header_params,
|
1456
|
+
:query_params => query_params,
|
1457
|
+
:form_params => form_params,
|
1458
|
+
:body => post_body,
|
1459
|
+
:auth_names => auth_names,
|
1460
|
+
:return_type => return_type
|
1461
|
+
)
|
1462
|
+
|
1463
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1464
|
+
if @api_client.config.debugging
|
1465
|
+
@api_client.config.logger.debug "API called: DefaultApi#etfs_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1466
|
+
end
|
1467
|
+
return data, status_code, headers
|
1468
|
+
end
|
1469
|
+
|
1470
|
+
# ETFs Sector Exposure
|
1471
|
+
# Get ETF sector exposure data.
|
1323
1472
|
# @param symbol [String] ETF symbol.
|
1324
1473
|
# @param [Hash] opts the optional parameters
|
1325
|
-
# @return [
|
1326
|
-
def
|
1327
|
-
data, _status_code, _headers =
|
1474
|
+
# @return [ETFsSectorExposure]
|
1475
|
+
def etfs_sector_exposure(symbol, opts = {})
|
1476
|
+
data, _status_code, _headers = etfs_sector_exposure_with_http_info(symbol, opts)
|
1328
1477
|
data
|
1329
1478
|
end
|
1330
1479
|
|
1331
|
-
# ETFs
|
1332
|
-
# Get ETF
|
1480
|
+
# ETFs Sector Exposure
|
1481
|
+
# Get ETF sector exposure data.
|
1333
1482
|
# @param symbol [String] ETF symbol.
|
1334
1483
|
# @param [Hash] opts the optional parameters
|
1335
|
-
# @return [Array<(
|
1336
|
-
def
|
1484
|
+
# @return [Array<(ETFsSectorExposure, Integer, Hash)>] ETFsSectorExposure data, response status code and response headers
|
1485
|
+
def etfs_sector_exposure_with_http_info(symbol, opts = {})
|
1337
1486
|
if @api_client.config.debugging
|
1338
|
-
@api_client.config.logger.debug 'Calling API: DefaultApi.
|
1487
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.etfs_sector_exposure ...'
|
1339
1488
|
end
|
1340
1489
|
# verify the required parameter 'symbol' is set
|
1341
1490
|
if @api_client.config.client_side_validation && symbol.nil?
|
1342
|
-
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.
|
1491
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.etfs_sector_exposure"
|
1343
1492
|
end
|
1344
1493
|
# resource path
|
1345
1494
|
local_var_path = '/etf/sector'
|
@@ -1357,15 +1506,16 @@ module FinnhubRuby
|
|
1357
1506
|
form_params = opts[:form_params] || {}
|
1358
1507
|
|
1359
1508
|
# http body (model)
|
1360
|
-
post_body = opts[:
|
1509
|
+
post_body = opts[:debug_body]
|
1361
1510
|
|
1362
1511
|
# return_type
|
1363
|
-
return_type = opts[:
|
1512
|
+
return_type = opts[:debug_return_type] || 'ETFsSectorExposure'
|
1364
1513
|
|
1365
1514
|
# auth_names
|
1366
|
-
auth_names = opts[:
|
1515
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1367
1516
|
|
1368
1517
|
new_options = opts.merge(
|
1518
|
+
:operation => :"DefaultApi.etfs_sector_exposure",
|
1369
1519
|
:header_params => header_params,
|
1370
1520
|
:query_params => query_params,
|
1371
1521
|
:form_params => form_params,
|
@@ -1376,40 +1526,33 @@ module FinnhubRuby
|
|
1376
1526
|
|
1377
1527
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1378
1528
|
if @api_client.config.debugging
|
1379
|
-
@api_client.config.logger.debug "API called: DefaultApi#
|
1529
|
+
@api_client.config.logger.debug "API called: DefaultApi#etfs_sector_exposure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1380
1530
|
end
|
1381
1531
|
return data, status_code, headers
|
1382
1532
|
end
|
1383
1533
|
|
1384
|
-
#
|
1385
|
-
#
|
1386
|
-
# @param symbol [String] ETF symbol.
|
1534
|
+
# FDA Committee Meeting Calendar
|
1535
|
+
# FDA's advisory committees are established to provide functions which support the agency's mission of protecting and promoting the public health, while meeting the requirements set forth in the Federal Advisory Committee Act. Committees are either mandated by statute or established at the discretion of the Department of Health and Human Services. Each committee is subject to renewal at two-year intervals unless the committee charter states otherwise.
|
1387
1536
|
# @param [Hash] opts the optional parameters
|
1388
|
-
# @return [
|
1389
|
-
def
|
1390
|
-
data, _status_code, _headers =
|
1537
|
+
# @return [Array<FDAComitteeMeeting>]
|
1538
|
+
def fda_committee_meeting_calendar(opts = {})
|
1539
|
+
data, _status_code, _headers = fda_committee_meeting_calendar_with_http_info(opts)
|
1391
1540
|
data
|
1392
1541
|
end
|
1393
1542
|
|
1394
|
-
#
|
1395
|
-
#
|
1396
|
-
# @param symbol [String] ETF symbol.
|
1543
|
+
# FDA Committee Meeting Calendar
|
1544
|
+
# FDA's advisory committees are established to provide functions which support the agency's mission of protecting and promoting the public health, while meeting the requirements set forth in the Federal Advisory Committee Act. Committees are either mandated by statute or established at the discretion of the Department of Health and Human Services. Each committee is subject to renewal at two-year intervals unless the committee charter states otherwise.
|
1397
1545
|
# @param [Hash] opts the optional parameters
|
1398
|
-
# @return [Array<(
|
1399
|
-
def
|
1546
|
+
# @return [Array<(Array<FDAComitteeMeeting>, Integer, Hash)>] Array<FDAComitteeMeeting> data, response status code and response headers
|
1547
|
+
def fda_committee_meeting_calendar_with_http_info(opts = {})
|
1400
1548
|
if @api_client.config.debugging
|
1401
|
-
@api_client.config.logger.debug 'Calling API: DefaultApi.
|
1402
|
-
end
|
1403
|
-
# verify the required parameter 'symbol' is set
|
1404
|
-
if @api_client.config.client_side_validation && symbol.nil?
|
1405
|
-
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.etfs_profile"
|
1549
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.fda_committee_meeting_calendar ...'
|
1406
1550
|
end
|
1407
1551
|
# resource path
|
1408
|
-
local_var_path = '/
|
1552
|
+
local_var_path = '/fda-advisory-committee-calendar'
|
1409
1553
|
|
1410
1554
|
# query parameters
|
1411
1555
|
query_params = opts[:query_params] || {}
|
1412
|
-
query_params[:'symbol'] = symbol
|
1413
1556
|
|
1414
1557
|
# header parameters
|
1415
1558
|
header_params = opts[:header_params] || {}
|
@@ -1420,15 +1563,16 @@ module FinnhubRuby
|
|
1420
1563
|
form_params = opts[:form_params] || {}
|
1421
1564
|
|
1422
1565
|
# http body (model)
|
1423
|
-
post_body = opts[:
|
1566
|
+
post_body = opts[:debug_body]
|
1424
1567
|
|
1425
1568
|
# return_type
|
1426
|
-
return_type = opts[:
|
1569
|
+
return_type = opts[:debug_return_type] || 'Array<FDAComitteeMeeting>'
|
1427
1570
|
|
1428
1571
|
# auth_names
|
1429
|
-
auth_names = opts[:
|
1572
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1430
1573
|
|
1431
1574
|
new_options = opts.merge(
|
1575
|
+
:operation => :"DefaultApi.fda_committee_meeting_calendar",
|
1432
1576
|
:header_params => header_params,
|
1433
1577
|
:query_params => query_params,
|
1434
1578
|
:form_params => form_params,
|
@@ -1439,12 +1583,12 @@ module FinnhubRuby
|
|
1439
1583
|
|
1440
1584
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1441
1585
|
if @api_client.config.debugging
|
1442
|
-
@api_client.config.logger.debug "API called: DefaultApi#
|
1586
|
+
@api_client.config.logger.debug "API called: DefaultApi#fda_committee_meeting_calendar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1443
1587
|
end
|
1444
1588
|
return data, status_code, headers
|
1445
1589
|
end
|
1446
1590
|
|
1447
|
-
# Filings
|
1591
|
+
# SEC Filings
|
1448
1592
|
# List company's filing. Limit to 250 documents at a time. This data is available for bulk download on <a href=\"https://www.kaggle.com/finnhub/sec-filings\" target=\"_blank\">Kaggle SEC Filings database</a>.
|
1449
1593
|
# @param [Hash] opts the optional parameters
|
1450
1594
|
# @option opts [String] :symbol Symbol. Leave <code>symbol</code>,<code>cik</code> and <code>accessNumber</code> empty to list latest filings.
|
@@ -1459,7 +1603,7 @@ module FinnhubRuby
|
|
1459
1603
|
data
|
1460
1604
|
end
|
1461
1605
|
|
1462
|
-
# Filings
|
1606
|
+
# SEC Filings
|
1463
1607
|
# List company's filing. Limit to 250 documents at a time. This data is available for bulk download on <a href=\"https://www.kaggle.com/finnhub/sec-filings\" target=\"_blank\">Kaggle SEC Filings database</a>.
|
1464
1608
|
# @param [Hash] opts the optional parameters
|
1465
1609
|
# @option opts [String] :symbol Symbol. Leave <code>symbol</code>,<code>cik</code> and <code>accessNumber</code> empty to list latest filings.
|
@@ -1494,15 +1638,16 @@ module FinnhubRuby
|
|
1494
1638
|
form_params = opts[:form_params] || {}
|
1495
1639
|
|
1496
1640
|
# http body (model)
|
1497
|
-
post_body = opts[:
|
1641
|
+
post_body = opts[:debug_body]
|
1498
1642
|
|
1499
1643
|
# return_type
|
1500
|
-
return_type = opts[:
|
1644
|
+
return_type = opts[:debug_return_type] || 'Array<Filing>'
|
1501
1645
|
|
1502
1646
|
# auth_names
|
1503
|
-
auth_names = opts[:
|
1647
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1504
1648
|
|
1505
1649
|
new_options = opts.merge(
|
1650
|
+
:operation => :"DefaultApi.filings",
|
1506
1651
|
:header_params => header_params,
|
1507
1652
|
:query_params => query_params,
|
1508
1653
|
:form_params => form_params,
|
@@ -1518,8 +1663,72 @@ module FinnhubRuby
|
|
1518
1663
|
return data, status_code, headers
|
1519
1664
|
end
|
1520
1665
|
|
1666
|
+
# SEC Sentiment Analysis
|
1667
|
+
# Get sentiment analysis of 10-K and 10-Q filings from SEC. An abnormal increase in the number of positive/negative words in filings can signal a significant change in the company's stock price in the upcoming 4 quarters. We make use of <a href= \"https://sraf.nd.edu/textual-analysis/resources/\" target=\"_blank\">Loughran and McDonald Sentiment Word Lists</a> to calculate the sentiment for each filing.
|
1668
|
+
# @param access_number [String] Access number of a specific report you want to retrieve data from.
|
1669
|
+
# @param [Hash] opts the optional parameters
|
1670
|
+
# @return [SECSentimentAnalysis]
|
1671
|
+
def filings_sentiment(access_number, opts = {})
|
1672
|
+
data, _status_code, _headers = filings_sentiment_with_http_info(access_number, opts)
|
1673
|
+
data
|
1674
|
+
end
|
1675
|
+
|
1676
|
+
# SEC Sentiment Analysis
|
1677
|
+
# Get sentiment analysis of 10-K and 10-Q filings from SEC. An abnormal increase in the number of positive/negative words in filings can signal a significant change in the company's stock price in the upcoming 4 quarters. We make use of <a href= \"https://sraf.nd.edu/textual-analysis/resources/\" target=\"_blank\">Loughran and McDonald Sentiment Word Lists</a> to calculate the sentiment for each filing.
|
1678
|
+
# @param access_number [String] Access number of a specific report you want to retrieve data from.
|
1679
|
+
# @param [Hash] opts the optional parameters
|
1680
|
+
# @return [Array<(SECSentimentAnalysis, Integer, Hash)>] SECSentimentAnalysis data, response status code and response headers
|
1681
|
+
def filings_sentiment_with_http_info(access_number, opts = {})
|
1682
|
+
if @api_client.config.debugging
|
1683
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.filings_sentiment ...'
|
1684
|
+
end
|
1685
|
+
# verify the required parameter 'access_number' is set
|
1686
|
+
if @api_client.config.client_side_validation && access_number.nil?
|
1687
|
+
fail ArgumentError, "Missing the required parameter 'access_number' when calling DefaultApi.filings_sentiment"
|
1688
|
+
end
|
1689
|
+
# resource path
|
1690
|
+
local_var_path = '/stock/filings-sentiment'
|
1691
|
+
|
1692
|
+
# query parameters
|
1693
|
+
query_params = opts[:query_params] || {}
|
1694
|
+
query_params[:'accessNumber'] = access_number
|
1695
|
+
|
1696
|
+
# header parameters
|
1697
|
+
header_params = opts[:header_params] || {}
|
1698
|
+
# HTTP header 'Accept' (if needed)
|
1699
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1700
|
+
|
1701
|
+
# form parameters
|
1702
|
+
form_params = opts[:form_params] || {}
|
1703
|
+
|
1704
|
+
# http body (model)
|
1705
|
+
post_body = opts[:debug_body]
|
1706
|
+
|
1707
|
+
# return_type
|
1708
|
+
return_type = opts[:debug_return_type] || 'SECSentimentAnalysis'
|
1709
|
+
|
1710
|
+
# auth_names
|
1711
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1712
|
+
|
1713
|
+
new_options = opts.merge(
|
1714
|
+
:operation => :"DefaultApi.filings_sentiment",
|
1715
|
+
:header_params => header_params,
|
1716
|
+
:query_params => query_params,
|
1717
|
+
:form_params => form_params,
|
1718
|
+
:body => post_body,
|
1719
|
+
:auth_names => auth_names,
|
1720
|
+
:return_type => return_type
|
1721
|
+
)
|
1722
|
+
|
1723
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1724
|
+
if @api_client.config.debugging
|
1725
|
+
@api_client.config.logger.debug "API called: DefaultApi#filings_sentiment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1726
|
+
end
|
1727
|
+
return data, status_code, headers
|
1728
|
+
end
|
1729
|
+
|
1521
1730
|
# Financial Statements
|
1522
|
-
# Get standardized balance sheet, income statement and cash flow for global companies going back 30+ years.
|
1731
|
+
# <p>Get standardized balance sheet, income statement and cash flow for global companies going back 30+ years. Data is sourced from original filings most of which made available through <a href=\"#filings\">SEC Filings</a> and <a href=\"#international-filings\">International Filings</a> endpoints.</p><p><i>Wondering why our standardized data is different from Bloomberg, Reuters, Factset, S&P or Yahoo Finance ? Check out our <a href=\"/faq\">FAQ page</a> to learn more</i></p>
|
1523
1732
|
# @param symbol [String] Symbol of the company: AAPL.
|
1524
1733
|
# @param statement [String] Statement can take 1 of these values <code>bs, ic, cf</code> for Balance Sheet, Income Statement, Cash Flow respectively.
|
1525
1734
|
# @param freq [String] Frequency can take 1 of these values <code>annual, quarterly, ttm, ytd</code>. TTM (Trailing Twelve Months) option is available for Income Statement and Cash Flow. YTD (Year To Date) option is only available for Cash Flow.
|
@@ -1531,7 +1740,7 @@ module FinnhubRuby
|
|
1531
1740
|
end
|
1532
1741
|
|
1533
1742
|
# Financial Statements
|
1534
|
-
# Get standardized balance sheet, income statement and cash flow for global companies going back 30+ years.
|
1743
|
+
# <p>Get standardized balance sheet, income statement and cash flow for global companies going back 30+ years. Data is sourced from original filings most of which made available through <a href=\"#filings\">SEC Filings</a> and <a href=\"#international-filings\">International Filings</a> endpoints.</p><p><i>Wondering why our standardized data is different from Bloomberg, Reuters, Factset, S&P or Yahoo Finance ? Check out our <a href=\"/faq\">FAQ page</a> to learn more</i></p>
|
1535
1744
|
# @param symbol [String] Symbol of the company: AAPL.
|
1536
1745
|
# @param statement [String] Statement can take 1 of these values <code>bs, ic, cf</code> for Balance Sheet, Income Statement, Cash Flow respectively.
|
1537
1746
|
# @param freq [String] Frequency can take 1 of these values <code>annual, quarterly, ttm, ytd</code>. TTM (Trailing Twelve Months) option is available for Income Statement and Cash Flow. YTD (Year To Date) option is only available for Cash Flow.
|
@@ -1571,15 +1780,16 @@ module FinnhubRuby
|
|
1571
1780
|
form_params = opts[:form_params] || {}
|
1572
1781
|
|
1573
1782
|
# http body (model)
|
1574
|
-
post_body = opts[:
|
1783
|
+
post_body = opts[:debug_body]
|
1575
1784
|
|
1576
1785
|
# return_type
|
1577
|
-
return_type = opts[:
|
1786
|
+
return_type = opts[:debug_return_type] || 'FinancialStatements'
|
1578
1787
|
|
1579
1788
|
# auth_names
|
1580
|
-
auth_names = opts[:
|
1789
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1581
1790
|
|
1582
1791
|
new_options = opts.merge(
|
1792
|
+
:operation => :"DefaultApi.financials",
|
1583
1793
|
:header_params => header_params,
|
1584
1794
|
:query_params => query_params,
|
1585
1795
|
:form_params => form_params,
|
@@ -1639,15 +1849,16 @@ module FinnhubRuby
|
|
1639
1849
|
form_params = opts[:form_params] || {}
|
1640
1850
|
|
1641
1851
|
# http body (model)
|
1642
|
-
post_body = opts[:
|
1852
|
+
post_body = opts[:debug_body]
|
1643
1853
|
|
1644
1854
|
# return_type
|
1645
|
-
return_type = opts[:
|
1855
|
+
return_type = opts[:debug_return_type] || 'FinancialsAsReported'
|
1646
1856
|
|
1647
1857
|
# auth_names
|
1648
|
-
auth_names = opts[:
|
1858
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1649
1859
|
|
1650
1860
|
new_options = opts.merge(
|
1861
|
+
:operation => :"DefaultApi.financials_reported",
|
1651
1862
|
:header_params => header_params,
|
1652
1863
|
:query_params => query_params,
|
1653
1864
|
:form_params => form_params,
|
@@ -1723,15 +1934,16 @@ module FinnhubRuby
|
|
1723
1934
|
form_params = opts[:form_params] || {}
|
1724
1935
|
|
1725
1936
|
# http body (model)
|
1726
|
-
post_body = opts[:
|
1937
|
+
post_body = opts[:debug_body]
|
1727
1938
|
|
1728
1939
|
# return_type
|
1729
|
-
return_type = opts[:
|
1940
|
+
return_type = opts[:debug_return_type] || 'ForexCandles'
|
1730
1941
|
|
1731
1942
|
# auth_names
|
1732
|
-
auth_names = opts[:
|
1943
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1733
1944
|
|
1734
1945
|
new_options = opts.merge(
|
1946
|
+
:operation => :"DefaultApi.forex_candles",
|
1735
1947
|
:header_params => header_params,
|
1736
1948
|
:query_params => query_params,
|
1737
1949
|
:form_params => form_params,
|
@@ -1779,15 +1991,16 @@ module FinnhubRuby
|
|
1779
1991
|
form_params = opts[:form_params] || {}
|
1780
1992
|
|
1781
1993
|
# http body (model)
|
1782
|
-
post_body = opts[:
|
1994
|
+
post_body = opts[:debug_body]
|
1783
1995
|
|
1784
1996
|
# return_type
|
1785
|
-
return_type = opts[:
|
1997
|
+
return_type = opts[:debug_return_type] || 'Array<String>'
|
1786
1998
|
|
1787
1999
|
# auth_names
|
1788
|
-
auth_names = opts[:
|
2000
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1789
2001
|
|
1790
2002
|
new_options = opts.merge(
|
2003
|
+
:operation => :"DefaultApi.forex_exchanges",
|
1791
2004
|
:header_params => header_params,
|
1792
2005
|
:query_params => query_params,
|
1793
2006
|
:form_params => form_params,
|
@@ -1838,15 +2051,16 @@ module FinnhubRuby
|
|
1838
2051
|
form_params = opts[:form_params] || {}
|
1839
2052
|
|
1840
2053
|
# http body (model)
|
1841
|
-
post_body = opts[:
|
2054
|
+
post_body = opts[:debug_body]
|
1842
2055
|
|
1843
2056
|
# return_type
|
1844
|
-
return_type = opts[:
|
2057
|
+
return_type = opts[:debug_return_type] || 'Forexrates'
|
1845
2058
|
|
1846
2059
|
# auth_names
|
1847
|
-
auth_names = opts[:
|
2060
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1848
2061
|
|
1849
2062
|
new_options = opts.merge(
|
2063
|
+
:operation => :"DefaultApi.forex_rates",
|
1850
2064
|
:header_params => header_params,
|
1851
2065
|
:query_params => query_params,
|
1852
2066
|
:form_params => form_params,
|
@@ -1901,15 +2115,16 @@ module FinnhubRuby
|
|
1901
2115
|
form_params = opts[:form_params] || {}
|
1902
2116
|
|
1903
2117
|
# http body (model)
|
1904
|
-
post_body = opts[:
|
2118
|
+
post_body = opts[:debug_body]
|
1905
2119
|
|
1906
2120
|
# return_type
|
1907
|
-
return_type = opts[:
|
2121
|
+
return_type = opts[:debug_return_type] || 'Array<ForexSymbol>'
|
1908
2122
|
|
1909
2123
|
# auth_names
|
1910
|
-
auth_names = opts[:
|
2124
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1911
2125
|
|
1912
2126
|
new_options = opts.merge(
|
2127
|
+
:operation => :"DefaultApi.forex_symbols",
|
1913
2128
|
:header_params => header_params,
|
1914
2129
|
:query_params => query_params,
|
1915
2130
|
:form_params => form_params,
|
@@ -1926,7 +2141,7 @@ module FinnhubRuby
|
|
1926
2141
|
end
|
1927
2142
|
|
1928
2143
|
# Fund Ownership
|
1929
|
-
# Get a full list fund and institutional investors of a company in descending order of the number of shares held.
|
2144
|
+
# Get a full list fund and institutional investors of a company in descending order of the number of shares held. Data is sourced from <code>13F form</code>, <code>Schedule 13D</code> and <code>13G</code> for US market, <code>UK Share Register</code> for UK market, <code>SEDI</code> for Canadian market and equivalent filings for other international markets.
|
1930
2145
|
# @param symbol [String] Symbol of the company: AAPL.
|
1931
2146
|
# @param [Hash] opts the optional parameters
|
1932
2147
|
# @option opts [Integer] :limit Limit number of results. Leave empty to get the full list.
|
@@ -1937,7 +2152,7 @@ module FinnhubRuby
|
|
1937
2152
|
end
|
1938
2153
|
|
1939
2154
|
# Fund Ownership
|
1940
|
-
# Get a full list fund and institutional investors of a company in descending order of the number of shares held.
|
2155
|
+
# Get a full list fund and institutional investors of a company in descending order of the number of shares held. Data is sourced from <code>13F form</code>, <code>Schedule 13D</code> and <code>13G</code> for US market, <code>UK Share Register</code> for UK market, <code>SEDI</code> for Canadian market and equivalent filings for other international markets.
|
1941
2156
|
# @param symbol [String] Symbol of the company: AAPL.
|
1942
2157
|
# @param [Hash] opts the optional parameters
|
1943
2158
|
# @option opts [Integer] :limit Limit number of results. Leave empty to get the full list.
|
@@ -1967,15 +2182,16 @@ module FinnhubRuby
|
|
1967
2182
|
form_params = opts[:form_params] || {}
|
1968
2183
|
|
1969
2184
|
# http body (model)
|
1970
|
-
post_body = opts[:
|
2185
|
+
post_body = opts[:debug_body]
|
1971
2186
|
|
1972
2187
|
# return_type
|
1973
|
-
return_type = opts[:
|
2188
|
+
return_type = opts[:debug_return_type] || 'FundOwnership'
|
1974
2189
|
|
1975
2190
|
# auth_names
|
1976
|
-
auth_names = opts[:
|
2191
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
1977
2192
|
|
1978
2193
|
new_options = opts.merge(
|
2194
|
+
:operation => :"DefaultApi.fund_ownership",
|
1979
2195
|
:header_params => header_params,
|
1980
2196
|
:query_params => query_params,
|
1981
2197
|
:form_params => form_params,
|
@@ -1991,74 +2207,8 @@ module FinnhubRuby
|
|
1991
2207
|
return data, status_code, headers
|
1992
2208
|
end
|
1993
2209
|
|
1994
|
-
# General News
|
1995
|
-
# Get latest market news.
|
1996
|
-
# @param category [String] This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>.
|
1997
|
-
# @param [Hash] opts the optional parameters
|
1998
|
-
# @option opts [String] :min_id Use this field to get only news after this ID. Default to 0
|
1999
|
-
# @return [Array<News>]
|
2000
|
-
def general_news(category, opts = {})
|
2001
|
-
data, _status_code, _headers = general_news_with_http_info(category, opts)
|
2002
|
-
data
|
2003
|
-
end
|
2004
|
-
|
2005
|
-
# General News
|
2006
|
-
# Get latest market news.
|
2007
|
-
# @param category [String] This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>.
|
2008
|
-
# @param [Hash] opts the optional parameters
|
2009
|
-
# @option opts [String] :min_id Use this field to get only news after this ID. Default to 0
|
2010
|
-
# @return [Array<(Array<News>, Integer, Hash)>] Array<News> data, response status code and response headers
|
2011
|
-
def general_news_with_http_info(category, opts = {})
|
2012
|
-
if @api_client.config.debugging
|
2013
|
-
@api_client.config.logger.debug 'Calling API: DefaultApi.general_news ...'
|
2014
|
-
end
|
2015
|
-
# verify the required parameter 'category' is set
|
2016
|
-
if @api_client.config.client_side_validation && category.nil?
|
2017
|
-
fail ArgumentError, "Missing the required parameter 'category' when calling DefaultApi.general_news"
|
2018
|
-
end
|
2019
|
-
# resource path
|
2020
|
-
local_var_path = '/news'
|
2021
|
-
|
2022
|
-
# query parameters
|
2023
|
-
query_params = opts[:query_params] || {}
|
2024
|
-
query_params[:'category'] = category
|
2025
|
-
query_params[:'minId'] = opts[:'min_id'] if !opts[:'min_id'].nil?
|
2026
|
-
|
2027
|
-
# header parameters
|
2028
|
-
header_params = opts[:header_params] || {}
|
2029
|
-
# HTTP header 'Accept' (if needed)
|
2030
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2031
|
-
|
2032
|
-
# form parameters
|
2033
|
-
form_params = opts[:form_params] || {}
|
2034
|
-
|
2035
|
-
# http body (model)
|
2036
|
-
post_body = opts[:body]
|
2037
|
-
|
2038
|
-
# return_type
|
2039
|
-
return_type = opts[:return_type] || 'Array<News>'
|
2040
|
-
|
2041
|
-
# auth_names
|
2042
|
-
auth_names = opts[:auth_names] || ['api_key']
|
2043
|
-
|
2044
|
-
new_options = opts.merge(
|
2045
|
-
:header_params => header_params,
|
2046
|
-
:query_params => query_params,
|
2047
|
-
:form_params => form_params,
|
2048
|
-
:body => post_body,
|
2049
|
-
:auth_names => auth_names,
|
2050
|
-
:return_type => return_type
|
2051
|
-
)
|
2052
|
-
|
2053
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2054
|
-
if @api_client.config.debugging
|
2055
|
-
@api_client.config.logger.debug "API called: DefaultApi#general_news\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2056
|
-
end
|
2057
|
-
return data, status_code, headers
|
2058
|
-
end
|
2059
|
-
|
2060
2210
|
# Indices Constituents
|
2061
|
-
# Get a list of index's constituents.
|
2211
|
+
# Get a list of index's constituents. A list of supported indices for this endpoint can be found <a href=\"https://docs.google.com/spreadsheets/d/1Syr2eLielHWsorxkDEZXyc55d6bNx1M3ZeI4vdn7Qzo/edit?usp=sharing\" target=\"_blank\">here</a>.
|
2062
2212
|
# @param symbol [String] symbol
|
2063
2213
|
# @param [Hash] opts the optional parameters
|
2064
2214
|
# @return [IndicesConstituents]
|
@@ -2068,7 +2218,7 @@ module FinnhubRuby
|
|
2068
2218
|
end
|
2069
2219
|
|
2070
2220
|
# Indices Constituents
|
2071
|
-
# Get a list of index's constituents.
|
2221
|
+
# Get a list of index's constituents. A list of supported indices for this endpoint can be found <a href=\"https://docs.google.com/spreadsheets/d/1Syr2eLielHWsorxkDEZXyc55d6bNx1M3ZeI4vdn7Qzo/edit?usp=sharing\" target=\"_blank\">here</a>.
|
2072
2222
|
# @param symbol [String] symbol
|
2073
2223
|
# @param [Hash] opts the optional parameters
|
2074
2224
|
# @return [Array<(IndicesConstituents, Integer, Hash)>] IndicesConstituents data, response status code and response headers
|
@@ -2096,15 +2246,16 @@ module FinnhubRuby
|
|
2096
2246
|
form_params = opts[:form_params] || {}
|
2097
2247
|
|
2098
2248
|
# http body (model)
|
2099
|
-
post_body = opts[:
|
2249
|
+
post_body = opts[:debug_body]
|
2100
2250
|
|
2101
2251
|
# return_type
|
2102
|
-
return_type = opts[:
|
2252
|
+
return_type = opts[:debug_return_type] || 'IndicesConstituents'
|
2103
2253
|
|
2104
2254
|
# auth_names
|
2105
|
-
auth_names = opts[:
|
2255
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2106
2256
|
|
2107
2257
|
new_options = opts.merge(
|
2258
|
+
:operation => :"DefaultApi.indices_constituents",
|
2108
2259
|
:header_params => header_params,
|
2109
2260
|
:query_params => query_params,
|
2110
2261
|
:form_params => form_params,
|
@@ -2159,15 +2310,16 @@ module FinnhubRuby
|
|
2159
2310
|
form_params = opts[:form_params] || {}
|
2160
2311
|
|
2161
2312
|
# http body (model)
|
2162
|
-
post_body = opts[:
|
2313
|
+
post_body = opts[:debug_body]
|
2163
2314
|
|
2164
2315
|
# return_type
|
2165
|
-
return_type = opts[:
|
2316
|
+
return_type = opts[:debug_return_type] || 'IndicesHistoricalConstituents'
|
2166
2317
|
|
2167
2318
|
# auth_names
|
2168
|
-
auth_names = opts[:
|
2319
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2169
2320
|
|
2170
2321
|
new_options = opts.merge(
|
2322
|
+
:operation => :"DefaultApi.indices_historical_constituents",
|
2171
2323
|
:header_params => header_params,
|
2172
2324
|
:query_params => query_params,
|
2173
2325
|
:form_params => form_params,
|
@@ -2183,38 +2335,41 @@ module FinnhubRuby
|
|
2183
2335
|
return data, status_code, headers
|
2184
2336
|
end
|
2185
2337
|
|
2186
|
-
#
|
2187
|
-
#
|
2338
|
+
# Insider Transactions
|
2339
|
+
# Company insider transactions data sourced from <code>Form 3,4,5</code>. This endpoint only covers US companies at the moment. Limit to 100 transactions per API call.
|
2188
2340
|
# @param symbol [String] Symbol of the company: AAPL.
|
2189
2341
|
# @param [Hash] opts the optional parameters
|
2190
|
-
# @option opts [
|
2191
|
-
# @
|
2192
|
-
|
2193
|
-
|
2342
|
+
# @option opts [Date] :from From date: 2020-03-15.
|
2343
|
+
# @option opts [Date] :to To date: 2020-03-16.
|
2344
|
+
# @return [InsiderTransactions]
|
2345
|
+
def insider_transactions(symbol, opts = {})
|
2346
|
+
data, _status_code, _headers = insider_transactions_with_http_info(symbol, opts)
|
2194
2347
|
data
|
2195
2348
|
end
|
2196
2349
|
|
2197
|
-
#
|
2198
|
-
#
|
2350
|
+
# Insider Transactions
|
2351
|
+
# Company insider transactions data sourced from <code>Form 3,4,5</code>. This endpoint only covers US companies at the moment. Limit to 100 transactions per API call.
|
2199
2352
|
# @param symbol [String] Symbol of the company: AAPL.
|
2200
2353
|
# @param [Hash] opts the optional parameters
|
2201
|
-
# @option opts [
|
2202
|
-
# @
|
2203
|
-
|
2354
|
+
# @option opts [Date] :from From date: 2020-03-15.
|
2355
|
+
# @option opts [Date] :to To date: 2020-03-16.
|
2356
|
+
# @return [Array<(InsiderTransactions, Integer, Hash)>] InsiderTransactions data, response status code and response headers
|
2357
|
+
def insider_transactions_with_http_info(symbol, opts = {})
|
2204
2358
|
if @api_client.config.debugging
|
2205
|
-
@api_client.config.logger.debug 'Calling API: DefaultApi.
|
2359
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.insider_transactions ...'
|
2206
2360
|
end
|
2207
2361
|
# verify the required parameter 'symbol' is set
|
2208
2362
|
if @api_client.config.client_side_validation && symbol.nil?
|
2209
|
-
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.
|
2363
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.insider_transactions"
|
2210
2364
|
end
|
2211
2365
|
# resource path
|
2212
|
-
local_var_path = '/stock/
|
2366
|
+
local_var_path = '/stock/insider-transactions'
|
2213
2367
|
|
2214
2368
|
# query parameters
|
2215
2369
|
query_params = opts[:query_params] || {}
|
2216
2370
|
query_params[:'symbol'] = symbol
|
2217
|
-
query_params[:'
|
2371
|
+
query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
|
2372
|
+
query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
|
2218
2373
|
|
2219
2374
|
# header parameters
|
2220
2375
|
header_params = opts[:header_params] || {}
|
@@ -2225,15 +2380,16 @@ module FinnhubRuby
|
|
2225
2380
|
form_params = opts[:form_params] || {}
|
2226
2381
|
|
2227
2382
|
# http body (model)
|
2228
|
-
post_body = opts[:
|
2383
|
+
post_body = opts[:debug_body]
|
2229
2384
|
|
2230
2385
|
# return_type
|
2231
|
-
return_type = opts[:
|
2386
|
+
return_type = opts[:debug_return_type] || 'InsiderTransactions'
|
2232
2387
|
|
2233
2388
|
# auth_names
|
2234
|
-
auth_names = opts[:
|
2389
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2235
2390
|
|
2236
2391
|
new_options = opts.merge(
|
2392
|
+
:operation => :"DefaultApi.insider_transactions",
|
2237
2393
|
:header_params => header_params,
|
2238
2394
|
:query_params => query_params,
|
2239
2395
|
:form_params => form_params,
|
@@ -2244,47 +2400,39 @@ module FinnhubRuby
|
|
2244
2400
|
|
2245
2401
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2246
2402
|
if @api_client.config.debugging
|
2247
|
-
@api_client.config.logger.debug "API called: DefaultApi#
|
2403
|
+
@api_client.config.logger.debug "API called: DefaultApi#insider_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2248
2404
|
end
|
2249
2405
|
return data, status_code, headers
|
2250
2406
|
end
|
2251
2407
|
|
2252
|
-
#
|
2253
|
-
#
|
2254
|
-
# @param from [Date] From date: 2020-03-15.
|
2255
|
-
# @param to [Date] To date: 2020-03-16.
|
2408
|
+
# International Filings
|
2409
|
+
# List filings for international companies which covers 95%+ of global market cap. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
|
2256
2410
|
# @param [Hash] opts the optional parameters
|
2257
|
-
# @
|
2258
|
-
|
2259
|
-
|
2411
|
+
# @option opts [String] :symbol Symbol. Leave empty to list latest filings.
|
2412
|
+
# @option opts [String] :country Filter by country using country's 2-letter code.
|
2413
|
+
# @return [Array<InternationalFiling>]
|
2414
|
+
def international_filings(opts = {})
|
2415
|
+
data, _status_code, _headers = international_filings_with_http_info(opts)
|
2260
2416
|
data
|
2261
2417
|
end
|
2262
2418
|
|
2263
|
-
#
|
2264
|
-
#
|
2265
|
-
# @param from [Date] From date: 2020-03-15.
|
2266
|
-
# @param to [Date] To date: 2020-03-16.
|
2419
|
+
# International Filings
|
2420
|
+
# List filings for international companies which covers 95%+ of global market cap. Limit to 250 documents at a time. These are the documents we use to source our fundamental data.
|
2267
2421
|
# @param [Hash] opts the optional parameters
|
2268
|
-
# @
|
2269
|
-
|
2422
|
+
# @option opts [String] :symbol Symbol. Leave empty to list latest filings.
|
2423
|
+
# @option opts [String] :country Filter by country using country's 2-letter code.
|
2424
|
+
# @return [Array<(Array<InternationalFiling>, Integer, Hash)>] Array<InternationalFiling> data, response status code and response headers
|
2425
|
+
def international_filings_with_http_info(opts = {})
|
2270
2426
|
if @api_client.config.debugging
|
2271
|
-
@api_client.config.logger.debug 'Calling API: DefaultApi.
|
2272
|
-
end
|
2273
|
-
# verify the required parameter 'from' is set
|
2274
|
-
if @api_client.config.client_side_validation && from.nil?
|
2275
|
-
fail ArgumentError, "Missing the required parameter 'from' when calling DefaultApi.ipo_calendar"
|
2276
|
-
end
|
2277
|
-
# verify the required parameter 'to' is set
|
2278
|
-
if @api_client.config.client_side_validation && to.nil?
|
2279
|
-
fail ArgumentError, "Missing the required parameter 'to' when calling DefaultApi.ipo_calendar"
|
2427
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.international_filings ...'
|
2280
2428
|
end
|
2281
2429
|
# resource path
|
2282
|
-
local_var_path = '/
|
2430
|
+
local_var_path = '/stock/international-filings'
|
2283
2431
|
|
2284
2432
|
# query parameters
|
2285
2433
|
query_params = opts[:query_params] || {}
|
2286
|
-
query_params[:'
|
2287
|
-
query_params[:'
|
2434
|
+
query_params[:'symbol'] = opts[:'symbol'] if !opts[:'symbol'].nil?
|
2435
|
+
query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
|
2288
2436
|
|
2289
2437
|
# header parameters
|
2290
2438
|
header_params = opts[:header_params] || {}
|
@@ -2295,15 +2443,16 @@ module FinnhubRuby
|
|
2295
2443
|
form_params = opts[:form_params] || {}
|
2296
2444
|
|
2297
2445
|
# http body (model)
|
2298
|
-
post_body = opts[:
|
2446
|
+
post_body = opts[:debug_body]
|
2299
2447
|
|
2300
2448
|
# return_type
|
2301
|
-
return_type = opts[:
|
2449
|
+
return_type = opts[:debug_return_type] || 'Array<InternationalFiling>'
|
2302
2450
|
|
2303
2451
|
# auth_names
|
2304
|
-
auth_names = opts[:
|
2452
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2305
2453
|
|
2306
2454
|
new_options = opts.merge(
|
2455
|
+
:operation => :"DefaultApi.international_filings",
|
2307
2456
|
:header_params => header_params,
|
2308
2457
|
:query_params => query_params,
|
2309
2458
|
:form_params => form_params,
|
@@ -2314,46 +2463,499 @@ module FinnhubRuby
|
|
2314
2463
|
|
2315
2464
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2316
2465
|
if @api_client.config.debugging
|
2317
|
-
@api_client.config.logger.debug "API called: DefaultApi#
|
2466
|
+
@api_client.config.logger.debug "API called: DefaultApi#international_filings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2318
2467
|
end
|
2319
2468
|
return data, status_code, headers
|
2320
2469
|
end
|
2321
2470
|
|
2322
|
-
#
|
2323
|
-
#
|
2324
|
-
# @param
|
2471
|
+
# Investment Themes (Thematic Investing)
|
2472
|
+
# <p>Thematic investing involves creating a portfolio (or portion of a portfolio) by gathering together a collection of companies involved in certain areas that you predict will generate above-market returns over the long term. Themes can be based on a concept such as ageing populations or a sub-sector such as robotics, and drones. Thematic investing focuses on predicted long-term trends rather than specific companies or sectors, enabling investors to access structural, one-off shifts that can change an entire industry.</p><p>This endpoint will help you get portfolios of different investment themes that are changing our life and are the way of the future.</p><p>A full list of themes supported can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1ULj9xDh4iPoQj279M084adZ2_S852ttRthKKJ7madYc/edit?usp=sharing\">here</a>. The theme coverage and portfolios are updated bi-weekly by our analysts. Our approach excludes penny, super-small cap and illiquid stocks.</p>
|
2473
|
+
# @param theme [String] Investment theme. A full list of themes supported can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1ULj9xDh4iPoQj279M084adZ2_S852ttRthKKJ7madYc/edit?usp=sharing\">here</a>.
|
2325
2474
|
# @param [Hash] opts the optional parameters
|
2326
|
-
# @
|
2327
|
-
|
2328
|
-
|
2329
|
-
|
2330
|
-
|
2475
|
+
# @return [InvestmentThemesThematicInvesting]
|
2476
|
+
def investment_themes_thematic_investing(theme, opts = {})
|
2477
|
+
data, _status_code, _headers = investment_themes_thematic_investing_with_http_info(theme, opts)
|
2478
|
+
data
|
2479
|
+
end
|
2480
|
+
|
2481
|
+
# Investment Themes (Thematic Investing)
|
2482
|
+
# <p>Thematic investing involves creating a portfolio (or portion of a portfolio) by gathering together a collection of companies involved in certain areas that you predict will generate above-market returns over the long term. Themes can be based on a concept such as ageing populations or a sub-sector such as robotics, and drones. Thematic investing focuses on predicted long-term trends rather than specific companies or sectors, enabling investors to access structural, one-off shifts that can change an entire industry.</p><p>This endpoint will help you get portfolios of different investment themes that are changing our life and are the way of the future.</p><p>A full list of themes supported can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1ULj9xDh4iPoQj279M084adZ2_S852ttRthKKJ7madYc/edit?usp=sharing\">here</a>. The theme coverage and portfolios are updated bi-weekly by our analysts. Our approach excludes penny, super-small cap and illiquid stocks.</p>
|
2483
|
+
# @param theme [String] Investment theme. A full list of themes supported can be found <a target=\"_blank\" href=\"https://docs.google.com/spreadsheets/d/1ULj9xDh4iPoQj279M084adZ2_S852ttRthKKJ7madYc/edit?usp=sharing\">here</a>.
|
2484
|
+
# @param [Hash] opts the optional parameters
|
2485
|
+
# @return [Array<(InvestmentThemesThematicInvesting, Integer, Hash)>] InvestmentThemesThematicInvesting data, response status code and response headers
|
2486
|
+
def investment_themes_thematic_investing_with_http_info(theme, opts = {})
|
2487
|
+
if @api_client.config.debugging
|
2488
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.investment_themes_thematic_investing ...'
|
2489
|
+
end
|
2490
|
+
# verify the required parameter 'theme' is set
|
2491
|
+
if @api_client.config.client_side_validation && theme.nil?
|
2492
|
+
fail ArgumentError, "Missing the required parameter 'theme' when calling DefaultApi.investment_themes_thematic_investing"
|
2493
|
+
end
|
2494
|
+
# resource path
|
2495
|
+
local_var_path = '/stock/investment-theme'
|
2496
|
+
|
2497
|
+
# query parameters
|
2498
|
+
query_params = opts[:query_params] || {}
|
2499
|
+
query_params[:'theme'] = theme
|
2500
|
+
|
2501
|
+
# header parameters
|
2502
|
+
header_params = opts[:header_params] || {}
|
2503
|
+
# HTTP header 'Accept' (if needed)
|
2504
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2505
|
+
|
2506
|
+
# form parameters
|
2507
|
+
form_params = opts[:form_params] || {}
|
2508
|
+
|
2509
|
+
# http body (model)
|
2510
|
+
post_body = opts[:debug_body]
|
2511
|
+
|
2512
|
+
# return_type
|
2513
|
+
return_type = opts[:debug_return_type] || 'InvestmentThemesThematicInvesting'
|
2514
|
+
|
2515
|
+
# auth_names
|
2516
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2517
|
+
|
2518
|
+
new_options = opts.merge(
|
2519
|
+
:operation => :"DefaultApi.investment_themes_thematic_investing",
|
2520
|
+
:header_params => header_params,
|
2521
|
+
:query_params => query_params,
|
2522
|
+
:form_params => form_params,
|
2523
|
+
:body => post_body,
|
2524
|
+
:auth_names => auth_names,
|
2525
|
+
:return_type => return_type
|
2526
|
+
)
|
2527
|
+
|
2528
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2529
|
+
if @api_client.config.debugging
|
2530
|
+
@api_client.config.logger.debug "API called: DefaultApi#investment_themes_thematic_investing\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2531
|
+
end
|
2532
|
+
return data, status_code, headers
|
2533
|
+
end
|
2534
|
+
|
2535
|
+
# IPO Calendar
|
2536
|
+
# Get recent and upcoming IPO.
|
2537
|
+
# @param from [Date] From date: 2020-03-15.
|
2538
|
+
# @param to [Date] To date: 2020-03-16.
|
2539
|
+
# @param [Hash] opts the optional parameters
|
2540
|
+
# @return [IPOCalendar]
|
2541
|
+
def ipo_calendar(from, to, opts = {})
|
2542
|
+
data, _status_code, _headers = ipo_calendar_with_http_info(from, to, opts)
|
2543
|
+
data
|
2544
|
+
end
|
2545
|
+
|
2546
|
+
# IPO Calendar
|
2547
|
+
# Get recent and upcoming IPO.
|
2548
|
+
# @param from [Date] From date: 2020-03-15.
|
2549
|
+
# @param to [Date] To date: 2020-03-16.
|
2550
|
+
# @param [Hash] opts the optional parameters
|
2551
|
+
# @return [Array<(IPOCalendar, Integer, Hash)>] IPOCalendar data, response status code and response headers
|
2552
|
+
def ipo_calendar_with_http_info(from, to, opts = {})
|
2553
|
+
if @api_client.config.debugging
|
2554
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.ipo_calendar ...'
|
2555
|
+
end
|
2556
|
+
# verify the required parameter 'from' is set
|
2557
|
+
if @api_client.config.client_side_validation && from.nil?
|
2558
|
+
fail ArgumentError, "Missing the required parameter 'from' when calling DefaultApi.ipo_calendar"
|
2559
|
+
end
|
2560
|
+
# verify the required parameter 'to' is set
|
2561
|
+
if @api_client.config.client_side_validation && to.nil?
|
2562
|
+
fail ArgumentError, "Missing the required parameter 'to' when calling DefaultApi.ipo_calendar"
|
2563
|
+
end
|
2564
|
+
# resource path
|
2565
|
+
local_var_path = '/calendar/ipo'
|
2566
|
+
|
2567
|
+
# query parameters
|
2568
|
+
query_params = opts[:query_params] || {}
|
2569
|
+
query_params[:'from'] = from
|
2570
|
+
query_params[:'to'] = to
|
2571
|
+
|
2572
|
+
# header parameters
|
2573
|
+
header_params = opts[:header_params] || {}
|
2574
|
+
# HTTP header 'Accept' (if needed)
|
2575
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2576
|
+
|
2577
|
+
# form parameters
|
2578
|
+
form_params = opts[:form_params] || {}
|
2579
|
+
|
2580
|
+
# http body (model)
|
2581
|
+
post_body = opts[:debug_body]
|
2582
|
+
|
2583
|
+
# return_type
|
2584
|
+
return_type = opts[:debug_return_type] || 'IPOCalendar'
|
2585
|
+
|
2586
|
+
# auth_names
|
2587
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2588
|
+
|
2589
|
+
new_options = opts.merge(
|
2590
|
+
:operation => :"DefaultApi.ipo_calendar",
|
2591
|
+
:header_params => header_params,
|
2592
|
+
:query_params => query_params,
|
2593
|
+
:form_params => form_params,
|
2594
|
+
:body => post_body,
|
2595
|
+
:auth_names => auth_names,
|
2596
|
+
:return_type => return_type
|
2597
|
+
)
|
2598
|
+
|
2599
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2600
|
+
if @api_client.config.debugging
|
2601
|
+
@api_client.config.logger.debug "API called: DefaultApi#ipo_calendar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2602
|
+
end
|
2603
|
+
return data, status_code, headers
|
2604
|
+
end
|
2605
|
+
|
2606
|
+
# Market News
|
2607
|
+
# Get latest market news.
|
2608
|
+
# @param category [String] This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>.
|
2609
|
+
# @param [Hash] opts the optional parameters
|
2610
|
+
# @option opts [String] :min_id Use this field to get only news after this ID. Default to 0
|
2611
|
+
# @return [Array<News>]
|
2612
|
+
def market_news(category, opts = {})
|
2613
|
+
data, _status_code, _headers = market_news_with_http_info(category, opts)
|
2614
|
+
data
|
2615
|
+
end
|
2616
|
+
|
2617
|
+
# Market News
|
2618
|
+
# Get latest market news.
|
2619
|
+
# @param category [String] This parameter can be 1 of the following values <code>general, forex, crypto, merger</code>.
|
2620
|
+
# @param [Hash] opts the optional parameters
|
2621
|
+
# @option opts [String] :min_id Use this field to get only news after this ID. Default to 0
|
2622
|
+
# @return [Array<(Array<News>, Integer, Hash)>] Array<News> data, response status code and response headers
|
2623
|
+
def market_news_with_http_info(category, opts = {})
|
2624
|
+
if @api_client.config.debugging
|
2625
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.market_news ...'
|
2626
|
+
end
|
2627
|
+
# verify the required parameter 'category' is set
|
2628
|
+
if @api_client.config.client_side_validation && category.nil?
|
2629
|
+
fail ArgumentError, "Missing the required parameter 'category' when calling DefaultApi.market_news"
|
2630
|
+
end
|
2631
|
+
# resource path
|
2632
|
+
local_var_path = '/news'
|
2633
|
+
|
2634
|
+
# query parameters
|
2635
|
+
query_params = opts[:query_params] || {}
|
2636
|
+
query_params[:'category'] = category
|
2637
|
+
query_params[:'minId'] = opts[:'min_id'] if !opts[:'min_id'].nil?
|
2638
|
+
|
2639
|
+
# header parameters
|
2640
|
+
header_params = opts[:header_params] || {}
|
2641
|
+
# HTTP header 'Accept' (if needed)
|
2642
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2643
|
+
|
2644
|
+
# form parameters
|
2645
|
+
form_params = opts[:form_params] || {}
|
2646
|
+
|
2647
|
+
# http body (model)
|
2648
|
+
post_body = opts[:debug_body]
|
2649
|
+
|
2650
|
+
# return_type
|
2651
|
+
return_type = opts[:debug_return_type] || 'Array<News>'
|
2652
|
+
|
2653
|
+
# auth_names
|
2654
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2655
|
+
|
2656
|
+
new_options = opts.merge(
|
2657
|
+
:operation => :"DefaultApi.market_news",
|
2658
|
+
:header_params => header_params,
|
2659
|
+
:query_params => query_params,
|
2660
|
+
:form_params => form_params,
|
2661
|
+
:body => post_body,
|
2662
|
+
:auth_names => auth_names,
|
2663
|
+
:return_type => return_type
|
2664
|
+
)
|
2665
|
+
|
2666
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2667
|
+
if @api_client.config.debugging
|
2668
|
+
@api_client.config.logger.debug "API called: DefaultApi#market_news\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2669
|
+
end
|
2670
|
+
return data, status_code, headers
|
2671
|
+
end
|
2672
|
+
|
2673
|
+
# Mutual Funds Country Exposure
|
2674
|
+
# Get Mutual Funds country exposure data.
|
2675
|
+
# @param symbol [String] Symbol.
|
2676
|
+
# @param [Hash] opts the optional parameters
|
2677
|
+
# @return [MutualFundsCountryExposure]
|
2678
|
+
def mutual_fund_country_exposure(symbol, opts = {})
|
2679
|
+
data, _status_code, _headers = mutual_fund_country_exposure_with_http_info(symbol, opts)
|
2680
|
+
data
|
2681
|
+
end
|
2682
|
+
|
2683
|
+
# Mutual Funds Country Exposure
|
2684
|
+
# Get Mutual Funds country exposure data.
|
2685
|
+
# @param symbol [String] Symbol.
|
2686
|
+
# @param [Hash] opts the optional parameters
|
2687
|
+
# @return [Array<(MutualFundsCountryExposure, Integer, Hash)>] MutualFundsCountryExposure data, response status code and response headers
|
2688
|
+
def mutual_fund_country_exposure_with_http_info(symbol, opts = {})
|
2689
|
+
if @api_client.config.debugging
|
2690
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.mutual_fund_country_exposure ...'
|
2691
|
+
end
|
2692
|
+
# verify the required parameter 'symbol' is set
|
2693
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
2694
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.mutual_fund_country_exposure"
|
2695
|
+
end
|
2696
|
+
# resource path
|
2697
|
+
local_var_path = '/mutual-fund/country'
|
2698
|
+
|
2699
|
+
# query parameters
|
2700
|
+
query_params = opts[:query_params] || {}
|
2701
|
+
query_params[:'symbol'] = symbol
|
2702
|
+
|
2703
|
+
# header parameters
|
2704
|
+
header_params = opts[:header_params] || {}
|
2705
|
+
# HTTP header 'Accept' (if needed)
|
2706
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2707
|
+
|
2708
|
+
# form parameters
|
2709
|
+
form_params = opts[:form_params] || {}
|
2710
|
+
|
2711
|
+
# http body (model)
|
2712
|
+
post_body = opts[:debug_body]
|
2713
|
+
|
2714
|
+
# return_type
|
2715
|
+
return_type = opts[:debug_return_type] || 'MutualFundsCountryExposure'
|
2716
|
+
|
2717
|
+
# auth_names
|
2718
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2719
|
+
|
2720
|
+
new_options = opts.merge(
|
2721
|
+
:operation => :"DefaultApi.mutual_fund_country_exposure",
|
2722
|
+
:header_params => header_params,
|
2723
|
+
:query_params => query_params,
|
2724
|
+
:form_params => form_params,
|
2725
|
+
:body => post_body,
|
2726
|
+
:auth_names => auth_names,
|
2727
|
+
:return_type => return_type
|
2728
|
+
)
|
2729
|
+
|
2730
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2731
|
+
if @api_client.config.debugging
|
2732
|
+
@api_client.config.logger.debug "API called: DefaultApi#mutual_fund_country_exposure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2733
|
+
end
|
2734
|
+
return data, status_code, headers
|
2735
|
+
end
|
2736
|
+
|
2737
|
+
# Mutual Funds Holdings
|
2738
|
+
# Get full Mutual Funds holdings/constituents.
|
2739
|
+
# @param [Hash] opts the optional parameters
|
2740
|
+
# @option opts [String] :symbol Fund's symbol.
|
2741
|
+
# @option opts [String] :isin Fund's isin.
|
2742
|
+
# @option opts [Integer] :skip Skip the first n results. You can use this parameter to query historical constituents data. The latest result is returned if skip=0 or not set.
|
2743
|
+
# @return [MutualFundsHoldings]
|
2744
|
+
def mutual_fund_holdings(opts = {})
|
2745
|
+
data, _status_code, _headers = mutual_fund_holdings_with_http_info(opts)
|
2746
|
+
data
|
2747
|
+
end
|
2748
|
+
|
2749
|
+
# Mutual Funds Holdings
|
2750
|
+
# Get full Mutual Funds holdings/constituents.
|
2751
|
+
# @param [Hash] opts the optional parameters
|
2752
|
+
# @option opts [String] :symbol Fund's symbol.
|
2753
|
+
# @option opts [String] :isin Fund's isin.
|
2754
|
+
# @option opts [Integer] :skip Skip the first n results. You can use this parameter to query historical constituents data. The latest result is returned if skip=0 or not set.
|
2755
|
+
# @return [Array<(MutualFundsHoldings, Integer, Hash)>] MutualFundsHoldings data, response status code and response headers
|
2756
|
+
def mutual_fund_holdings_with_http_info(opts = {})
|
2757
|
+
if @api_client.config.debugging
|
2758
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.mutual_fund_holdings ...'
|
2759
|
+
end
|
2760
|
+
# resource path
|
2761
|
+
local_var_path = '/mutual-fund/holdings'
|
2762
|
+
|
2763
|
+
# query parameters
|
2764
|
+
query_params = opts[:query_params] || {}
|
2765
|
+
query_params[:'symbol'] = opts[:'symbol'] if !opts[:'symbol'].nil?
|
2766
|
+
query_params[:'isin'] = opts[:'isin'] if !opts[:'isin'].nil?
|
2767
|
+
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
2768
|
+
|
2769
|
+
# header parameters
|
2770
|
+
header_params = opts[:header_params] || {}
|
2771
|
+
# HTTP header 'Accept' (if needed)
|
2772
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2773
|
+
|
2774
|
+
# form parameters
|
2775
|
+
form_params = opts[:form_params] || {}
|
2776
|
+
|
2777
|
+
# http body (model)
|
2778
|
+
post_body = opts[:debug_body]
|
2779
|
+
|
2780
|
+
# return_type
|
2781
|
+
return_type = opts[:debug_return_type] || 'MutualFundsHoldings'
|
2782
|
+
|
2783
|
+
# auth_names
|
2784
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2785
|
+
|
2786
|
+
new_options = opts.merge(
|
2787
|
+
:operation => :"DefaultApi.mutual_fund_holdings",
|
2788
|
+
:header_params => header_params,
|
2789
|
+
:query_params => query_params,
|
2790
|
+
:form_params => form_params,
|
2791
|
+
:body => post_body,
|
2792
|
+
:auth_names => auth_names,
|
2793
|
+
:return_type => return_type
|
2794
|
+
)
|
2795
|
+
|
2796
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2797
|
+
if @api_client.config.debugging
|
2798
|
+
@api_client.config.logger.debug "API called: DefaultApi#mutual_fund_holdings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2799
|
+
end
|
2800
|
+
return data, status_code, headers
|
2801
|
+
end
|
2802
|
+
|
2803
|
+
# Mutual Funds Profile
|
2804
|
+
# Get mutual funds profile information. This endpoint covers US mutual funds only.
|
2805
|
+
# @param [Hash] opts the optional parameters
|
2806
|
+
# @option opts [String] :symbol Fund's symbol.
|
2807
|
+
# @option opts [String] :isin Fund's isin.
|
2808
|
+
# @return [MutualFundsProfile]
|
2809
|
+
def mutual_fund_profile(opts = {})
|
2810
|
+
data, _status_code, _headers = mutual_fund_profile_with_http_info(opts)
|
2811
|
+
data
|
2812
|
+
end
|
2813
|
+
|
2814
|
+
# Mutual Funds Profile
|
2815
|
+
# Get mutual funds profile information. This endpoint covers US mutual funds only.
|
2816
|
+
# @param [Hash] opts the optional parameters
|
2817
|
+
# @option opts [String] :symbol Fund's symbol.
|
2818
|
+
# @option opts [String] :isin Fund's isin.
|
2819
|
+
# @return [Array<(MutualFundsProfile, Integer, Hash)>] MutualFundsProfile data, response status code and response headers
|
2820
|
+
def mutual_fund_profile_with_http_info(opts = {})
|
2821
|
+
if @api_client.config.debugging
|
2822
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.mutual_fund_profile ...'
|
2823
|
+
end
|
2824
|
+
# resource path
|
2825
|
+
local_var_path = '/mutual-fund/profile'
|
2826
|
+
|
2827
|
+
# query parameters
|
2828
|
+
query_params = opts[:query_params] || {}
|
2829
|
+
query_params[:'symbol'] = opts[:'symbol'] if !opts[:'symbol'].nil?
|
2830
|
+
query_params[:'isin'] = opts[:'isin'] if !opts[:'isin'].nil?
|
2831
|
+
|
2832
|
+
# header parameters
|
2833
|
+
header_params = opts[:header_params] || {}
|
2834
|
+
# HTTP header 'Accept' (if needed)
|
2835
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2836
|
+
|
2837
|
+
# form parameters
|
2838
|
+
form_params = opts[:form_params] || {}
|
2839
|
+
|
2840
|
+
# http body (model)
|
2841
|
+
post_body = opts[:debug_body]
|
2842
|
+
|
2843
|
+
# return_type
|
2844
|
+
return_type = opts[:debug_return_type] || 'MutualFundsProfile'
|
2845
|
+
|
2846
|
+
# auth_names
|
2847
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2848
|
+
|
2849
|
+
new_options = opts.merge(
|
2850
|
+
:operation => :"DefaultApi.mutual_fund_profile",
|
2851
|
+
:header_params => header_params,
|
2852
|
+
:query_params => query_params,
|
2853
|
+
:form_params => form_params,
|
2854
|
+
:body => post_body,
|
2855
|
+
:auth_names => auth_names,
|
2856
|
+
:return_type => return_type
|
2857
|
+
)
|
2858
|
+
|
2859
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2860
|
+
if @api_client.config.debugging
|
2861
|
+
@api_client.config.logger.debug "API called: DefaultApi#mutual_fund_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2862
|
+
end
|
2863
|
+
return data, status_code, headers
|
2864
|
+
end
|
2865
|
+
|
2866
|
+
# Mutual-fund Sector Exposure
|
2867
|
+
# Get Mutual Funds sector exposure data.
|
2868
|
+
# @param symbol [String] Mutual Fund symbol.
|
2869
|
+
# @param [Hash] opts the optional parameters
|
2870
|
+
# @return [MutualFundSectorExposure]
|
2871
|
+
def mutual_fund_sector_exposure(symbol, opts = {})
|
2872
|
+
data, _status_code, _headers = mutual_fund_sector_exposure_with_http_info(symbol, opts)
|
2873
|
+
data
|
2874
|
+
end
|
2875
|
+
|
2876
|
+
# Mutual-fund Sector Exposure
|
2877
|
+
# Get Mutual Funds sector exposure data.
|
2878
|
+
# @param symbol [String] Mutual Fund symbol.
|
2879
|
+
# @param [Hash] opts the optional parameters
|
2880
|
+
# @return [Array<(MutualFundSectorExposure, Integer, Hash)>] MutualFundSectorExposure data, response status code and response headers
|
2881
|
+
def mutual_fund_sector_exposure_with_http_info(symbol, opts = {})
|
2882
|
+
if @api_client.config.debugging
|
2883
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.mutual_fund_sector_exposure ...'
|
2884
|
+
end
|
2885
|
+
# verify the required parameter 'symbol' is set
|
2886
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
2887
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.mutual_fund_sector_exposure"
|
2888
|
+
end
|
2889
|
+
# resource path
|
2890
|
+
local_var_path = '/mutual-fund/sector'
|
2891
|
+
|
2892
|
+
# query parameters
|
2893
|
+
query_params = opts[:query_params] || {}
|
2894
|
+
query_params[:'symbol'] = symbol
|
2895
|
+
|
2896
|
+
# header parameters
|
2897
|
+
header_params = opts[:header_params] || {}
|
2898
|
+
# HTTP header 'Accept' (if needed)
|
2899
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2900
|
+
|
2901
|
+
# form parameters
|
2902
|
+
form_params = opts[:form_params] || {}
|
2903
|
+
|
2904
|
+
# http body (model)
|
2905
|
+
post_body = opts[:debug_body]
|
2906
|
+
|
2907
|
+
# return_type
|
2908
|
+
return_type = opts[:debug_return_type] || 'MutualFundSectorExposure'
|
2909
|
+
|
2910
|
+
# auth_names
|
2911
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2912
|
+
|
2913
|
+
new_options = opts.merge(
|
2914
|
+
:operation => :"DefaultApi.mutual_fund_sector_exposure",
|
2915
|
+
:header_params => header_params,
|
2916
|
+
:query_params => query_params,
|
2917
|
+
:form_params => form_params,
|
2918
|
+
:body => post_body,
|
2919
|
+
:auth_names => auth_names,
|
2920
|
+
:return_type => return_type
|
2921
|
+
)
|
2922
|
+
|
2923
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2924
|
+
if @api_client.config.debugging
|
2925
|
+
@api_client.config.logger.debug "API called: DefaultApi#mutual_fund_sector_exposure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2926
|
+
end
|
2927
|
+
return data, status_code, headers
|
2928
|
+
end
|
2929
|
+
|
2930
|
+
# News Sentiment
|
2931
|
+
# Get company's news sentiment and statistics. This endpoint is only available for US companies.
|
2932
|
+
# @param symbol [String] Company symbol.
|
2933
|
+
# @param [Hash] opts the optional parameters
|
2934
|
+
# @return [NewsSentiment]
|
2935
|
+
def news_sentiment(symbol, opts = {})
|
2936
|
+
data, _status_code, _headers = news_sentiment_with_http_info(symbol, opts)
|
2331
2937
|
data
|
2332
2938
|
end
|
2333
2939
|
|
2334
|
-
#
|
2335
|
-
#
|
2940
|
+
# News Sentiment
|
2941
|
+
# Get company's news sentiment and statistics. This endpoint is only available for US companies.
|
2336
2942
|
# @param symbol [String] Company symbol.
|
2337
2943
|
# @param [Hash] opts the optional parameters
|
2338
|
-
# @
|
2339
|
-
|
2340
|
-
# @return [Array<(MajorDevelopments, Integer, Hash)>] MajorDevelopments data, response status code and response headers
|
2341
|
-
def major_developments_with_http_info(symbol, opts = {})
|
2944
|
+
# @return [Array<(NewsSentiment, Integer, Hash)>] NewsSentiment data, response status code and response headers
|
2945
|
+
def news_sentiment_with_http_info(symbol, opts = {})
|
2342
2946
|
if @api_client.config.debugging
|
2343
|
-
@api_client.config.logger.debug 'Calling API: DefaultApi.
|
2947
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.news_sentiment ...'
|
2344
2948
|
end
|
2345
2949
|
# verify the required parameter 'symbol' is set
|
2346
2950
|
if @api_client.config.client_side_validation && symbol.nil?
|
2347
|
-
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.
|
2951
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.news_sentiment"
|
2348
2952
|
end
|
2349
2953
|
# resource path
|
2350
|
-
local_var_path = '/
|
2954
|
+
local_var_path = '/news-sentiment'
|
2351
2955
|
|
2352
2956
|
# query parameters
|
2353
2957
|
query_params = opts[:query_params] || {}
|
2354
2958
|
query_params[:'symbol'] = symbol
|
2355
|
-
query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
|
2356
|
-
query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
|
2357
2959
|
|
2358
2960
|
# header parameters
|
2359
2961
|
header_params = opts[:header_params] || {}
|
@@ -2364,15 +2966,16 @@ module FinnhubRuby
|
|
2364
2966
|
form_params = opts[:form_params] || {}
|
2365
2967
|
|
2366
2968
|
# http body (model)
|
2367
|
-
post_body = opts[:
|
2969
|
+
post_body = opts[:debug_body]
|
2368
2970
|
|
2369
2971
|
# return_type
|
2370
|
-
return_type = opts[:
|
2972
|
+
return_type = opts[:debug_return_type] || 'NewsSentiment'
|
2371
2973
|
|
2372
2974
|
# auth_names
|
2373
|
-
auth_names = opts[:
|
2975
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2374
2976
|
|
2375
2977
|
new_options = opts.merge(
|
2978
|
+
:operation => :"DefaultApi.news_sentiment",
|
2376
2979
|
:header_params => header_params,
|
2377
2980
|
:query_params => query_params,
|
2378
2981
|
:form_params => form_params,
|
@@ -2383,40 +2986,43 @@ module FinnhubRuby
|
|
2383
2986
|
|
2384
2987
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2385
2988
|
if @api_client.config.debugging
|
2386
|
-
@api_client.config.logger.debug "API called: DefaultApi#
|
2989
|
+
@api_client.config.logger.debug "API called: DefaultApi#news_sentiment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2387
2990
|
end
|
2388
2991
|
return data, status_code, headers
|
2389
2992
|
end
|
2390
2993
|
|
2391
|
-
#
|
2392
|
-
# Get company
|
2393
|
-
# @param symbol [String]
|
2994
|
+
# Ownership
|
2995
|
+
# Get a full list of shareholders of a company in descending order of the number of shares held. Data is sourced from <code>13F form</code>, <code>Schedule 13D</code> and <code>13G</code> for US market, <code>UK Share Register</code> for UK market, <code>SEDI</code> for Canadian market and equivalent filings for other international markets.
|
2996
|
+
# @param symbol [String] Symbol of the company: AAPL.
|
2394
2997
|
# @param [Hash] opts the optional parameters
|
2395
|
-
# @
|
2396
|
-
|
2397
|
-
|
2998
|
+
# @option opts [Integer] :limit Limit number of results. Leave empty to get the full list.
|
2999
|
+
# @return [Ownership]
|
3000
|
+
def ownership(symbol, opts = {})
|
3001
|
+
data, _status_code, _headers = ownership_with_http_info(symbol, opts)
|
2398
3002
|
data
|
2399
3003
|
end
|
2400
3004
|
|
2401
|
-
#
|
2402
|
-
# Get company
|
2403
|
-
# @param symbol [String]
|
3005
|
+
# Ownership
|
3006
|
+
# Get a full list of shareholders of a company in descending order of the number of shares held. Data is sourced from <code>13F form</code>, <code>Schedule 13D</code> and <code>13G</code> for US market, <code>UK Share Register</code> for UK market, <code>SEDI</code> for Canadian market and equivalent filings for other international markets.
|
3007
|
+
# @param symbol [String] Symbol of the company: AAPL.
|
2404
3008
|
# @param [Hash] opts the optional parameters
|
2405
|
-
# @
|
2406
|
-
|
3009
|
+
# @option opts [Integer] :limit Limit number of results. Leave empty to get the full list.
|
3010
|
+
# @return [Array<(Ownership, Integer, Hash)>] Ownership data, response status code and response headers
|
3011
|
+
def ownership_with_http_info(symbol, opts = {})
|
2407
3012
|
if @api_client.config.debugging
|
2408
|
-
@api_client.config.logger.debug 'Calling API: DefaultApi.
|
3013
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.ownership ...'
|
2409
3014
|
end
|
2410
3015
|
# verify the required parameter 'symbol' is set
|
2411
3016
|
if @api_client.config.client_side_validation && symbol.nil?
|
2412
|
-
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.
|
3017
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.ownership"
|
2413
3018
|
end
|
2414
3019
|
# resource path
|
2415
|
-
local_var_path = '/
|
3020
|
+
local_var_path = '/stock/ownership'
|
2416
3021
|
|
2417
3022
|
# query parameters
|
2418
3023
|
query_params = opts[:query_params] || {}
|
2419
3024
|
query_params[:'symbol'] = symbol
|
3025
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
2420
3026
|
|
2421
3027
|
# header parameters
|
2422
3028
|
header_params = opts[:header_params] || {}
|
@@ -2427,15 +3033,16 @@ module FinnhubRuby
|
|
2427
3033
|
form_params = opts[:form_params] || {}
|
2428
3034
|
|
2429
3035
|
# http body (model)
|
2430
|
-
post_body = opts[:
|
3036
|
+
post_body = opts[:debug_body]
|
2431
3037
|
|
2432
3038
|
# return_type
|
2433
|
-
return_type = opts[:
|
3039
|
+
return_type = opts[:debug_return_type] || 'Ownership'
|
2434
3040
|
|
2435
3041
|
# auth_names
|
2436
|
-
auth_names = opts[:
|
3042
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2437
3043
|
|
2438
3044
|
new_options = opts.merge(
|
3045
|
+
:operation => :"DefaultApi.ownership",
|
2439
3046
|
:header_params => header_params,
|
2440
3047
|
:query_params => query_params,
|
2441
3048
|
:form_params => form_params,
|
@@ -2446,7 +3053,7 @@ module FinnhubRuby
|
|
2446
3053
|
|
2447
3054
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2448
3055
|
if @api_client.config.debugging
|
2449
|
-
@api_client.config.logger.debug "API called: DefaultApi#
|
3056
|
+
@api_client.config.logger.debug "API called: DefaultApi#ownership\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2450
3057
|
end
|
2451
3058
|
return data, status_code, headers
|
2452
3059
|
end
|
@@ -2497,15 +3104,16 @@ module FinnhubRuby
|
|
2497
3104
|
form_params = opts[:form_params] || {}
|
2498
3105
|
|
2499
3106
|
# http body (model)
|
2500
|
-
post_body = opts[:
|
3107
|
+
post_body = opts[:debug_body]
|
2501
3108
|
|
2502
3109
|
# return_type
|
2503
|
-
return_type = opts[:
|
3110
|
+
return_type = opts[:debug_return_type] || 'PatternRecognition'
|
2504
3111
|
|
2505
3112
|
# auth_names
|
2506
|
-
auth_names = opts[:
|
3113
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2507
3114
|
|
2508
3115
|
new_options = opts.merge(
|
3116
|
+
:operation => :"DefaultApi.pattern_recognition",
|
2509
3117
|
:header_params => header_params,
|
2510
3118
|
:query_params => query_params,
|
2511
3119
|
:form_params => form_params,
|
@@ -2521,6 +3129,76 @@ module FinnhubRuby
|
|
2521
3129
|
return data, status_code, headers
|
2522
3130
|
end
|
2523
3131
|
|
3132
|
+
# Major Press Releases
|
3133
|
+
# Get latest major press releases of a company. This data can be used to highlight the most significant events comprised of mostly press releases sourced from the exchanges, BusinessWire, AccessWire, GlobeNewswire, Newsfile, and PRNewswire.
|
3134
|
+
# @param symbol [String] Company symbol.
|
3135
|
+
# @param [Hash] opts the optional parameters
|
3136
|
+
# @option opts [Date] :from From time: 2020-01-01.
|
3137
|
+
# @option opts [Date] :to To time: 2020-01-05.
|
3138
|
+
# @return [MajorPressReleases]
|
3139
|
+
def press_releases(symbol, opts = {})
|
3140
|
+
data, _status_code, _headers = press_releases_with_http_info(symbol, opts)
|
3141
|
+
data
|
3142
|
+
end
|
3143
|
+
|
3144
|
+
# Major Press Releases
|
3145
|
+
# Get latest major press releases of a company. This data can be used to highlight the most significant events comprised of mostly press releases sourced from the exchanges, BusinessWire, AccessWire, GlobeNewswire, Newsfile, and PRNewswire.
|
3146
|
+
# @param symbol [String] Company symbol.
|
3147
|
+
# @param [Hash] opts the optional parameters
|
3148
|
+
# @option opts [Date] :from From time: 2020-01-01.
|
3149
|
+
# @option opts [Date] :to To time: 2020-01-05.
|
3150
|
+
# @return [Array<(MajorPressReleases, Integer, Hash)>] MajorPressReleases data, response status code and response headers
|
3151
|
+
def press_releases_with_http_info(symbol, opts = {})
|
3152
|
+
if @api_client.config.debugging
|
3153
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.press_releases ...'
|
3154
|
+
end
|
3155
|
+
# verify the required parameter 'symbol' is set
|
3156
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
3157
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.press_releases"
|
3158
|
+
end
|
3159
|
+
# resource path
|
3160
|
+
local_var_path = '/press-releases'
|
3161
|
+
|
3162
|
+
# query parameters
|
3163
|
+
query_params = opts[:query_params] || {}
|
3164
|
+
query_params[:'symbol'] = symbol
|
3165
|
+
query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
|
3166
|
+
query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
|
3167
|
+
|
3168
|
+
# header parameters
|
3169
|
+
header_params = opts[:header_params] || {}
|
3170
|
+
# HTTP header 'Accept' (if needed)
|
3171
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3172
|
+
|
3173
|
+
# form parameters
|
3174
|
+
form_params = opts[:form_params] || {}
|
3175
|
+
|
3176
|
+
# http body (model)
|
3177
|
+
post_body = opts[:debug_body]
|
3178
|
+
|
3179
|
+
# return_type
|
3180
|
+
return_type = opts[:debug_return_type] || 'MajorPressReleases'
|
3181
|
+
|
3182
|
+
# auth_names
|
3183
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
3184
|
+
|
3185
|
+
new_options = opts.merge(
|
3186
|
+
:operation => :"DefaultApi.press_releases",
|
3187
|
+
:header_params => header_params,
|
3188
|
+
:query_params => query_params,
|
3189
|
+
:form_params => form_params,
|
3190
|
+
:body => post_body,
|
3191
|
+
:auth_names => auth_names,
|
3192
|
+
:return_type => return_type
|
3193
|
+
)
|
3194
|
+
|
3195
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3196
|
+
if @api_client.config.debugging
|
3197
|
+
@api_client.config.logger.debug "API called: DefaultApi#press_releases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3198
|
+
end
|
3199
|
+
return data, status_code, headers
|
3200
|
+
end
|
3201
|
+
|
2524
3202
|
# Price Target
|
2525
3203
|
# Get latest price target consensus.
|
2526
3204
|
# @param symbol [String] Symbol of the company: AAPL.
|
@@ -2560,15 +3238,16 @@ module FinnhubRuby
|
|
2560
3238
|
form_params = opts[:form_params] || {}
|
2561
3239
|
|
2562
3240
|
# http body (model)
|
2563
|
-
post_body = opts[:
|
3241
|
+
post_body = opts[:debug_body]
|
2564
3242
|
|
2565
3243
|
# return_type
|
2566
|
-
return_type = opts[:
|
3244
|
+
return_type = opts[:debug_return_type] || 'PriceTarget'
|
2567
3245
|
|
2568
3246
|
# auth_names
|
2569
|
-
auth_names = opts[:
|
3247
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2570
3248
|
|
2571
3249
|
new_options = opts.merge(
|
3250
|
+
:operation => :"DefaultApi.price_target",
|
2572
3251
|
:header_params => header_params,
|
2573
3252
|
:query_params => query_params,
|
2574
3253
|
:form_params => form_params,
|
@@ -2585,7 +3264,7 @@ module FinnhubRuby
|
|
2585
3264
|
end
|
2586
3265
|
|
2587
3266
|
# Quote
|
2588
|
-
# <p>Get real-time quote data for US stocks. Constant polling is not recommended. Use websocket if you need real-time
|
3267
|
+
# <p>Get real-time quote data for US stocks. Constant polling is not recommended. Use websocket if you need real-time updates.</p><p>Real-time stock prices for international markets are supported for Enterprise clients via our partner's feed. <a href=\"mailto:support@finnhub.io\">Contact Us</a> to learn more.</p>
|
2589
3268
|
# @param symbol [String] Symbol
|
2590
3269
|
# @param [Hash] opts the optional parameters
|
2591
3270
|
# @return [Quote]
|
@@ -2595,7 +3274,7 @@ module FinnhubRuby
|
|
2595
3274
|
end
|
2596
3275
|
|
2597
3276
|
# Quote
|
2598
|
-
# <p>Get real-time quote data for US stocks. Constant polling is not recommended. Use websocket if you need real-time
|
3277
|
+
# <p>Get real-time quote data for US stocks. Constant polling is not recommended. Use websocket if you need real-time updates.</p><p>Real-time stock prices for international markets are supported for Enterprise clients via our partner's feed. <a href=\"mailto:support@finnhub.io\">Contact Us</a> to learn more.</p>
|
2599
3278
|
# @param symbol [String] Symbol
|
2600
3279
|
# @param [Hash] opts the optional parameters
|
2601
3280
|
# @return [Array<(Quote, Integer, Hash)>] Quote data, response status code and response headers
|
@@ -2623,15 +3302,209 @@ module FinnhubRuby
|
|
2623
3302
|
form_params = opts[:form_params] || {}
|
2624
3303
|
|
2625
3304
|
# http body (model)
|
2626
|
-
post_body = opts[:
|
3305
|
+
post_body = opts[:debug_body]
|
3306
|
+
|
3307
|
+
# return_type
|
3308
|
+
return_type = opts[:debug_return_type] || 'Quote'
|
3309
|
+
|
3310
|
+
# auth_names
|
3311
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
3312
|
+
|
3313
|
+
new_options = opts.merge(
|
3314
|
+
:operation => :"DefaultApi.quote",
|
3315
|
+
:header_params => header_params,
|
3316
|
+
:query_params => query_params,
|
3317
|
+
:form_params => form_params,
|
3318
|
+
:body => post_body,
|
3319
|
+
:auth_names => auth_names,
|
3320
|
+
:return_type => return_type
|
3321
|
+
)
|
3322
|
+
|
3323
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3324
|
+
if @api_client.config.debugging
|
3325
|
+
@api_client.config.logger.debug "API called: DefaultApi#quote\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3326
|
+
end
|
3327
|
+
return data, status_code, headers
|
3328
|
+
end
|
3329
|
+
|
3330
|
+
# Recommendation Trends
|
3331
|
+
# Get latest analyst recommendation trends for a company.
|
3332
|
+
# @param symbol [String] Symbol of the company: AAPL.
|
3333
|
+
# @param [Hash] opts the optional parameters
|
3334
|
+
# @return [Array<RecommendationTrend>]
|
3335
|
+
def recommendation_trends(symbol, opts = {})
|
3336
|
+
data, _status_code, _headers = recommendation_trends_with_http_info(symbol, opts)
|
3337
|
+
data
|
3338
|
+
end
|
3339
|
+
|
3340
|
+
# Recommendation Trends
|
3341
|
+
# Get latest analyst recommendation trends for a company.
|
3342
|
+
# @param symbol [String] Symbol of the company: AAPL.
|
3343
|
+
# @param [Hash] opts the optional parameters
|
3344
|
+
# @return [Array<(Array<RecommendationTrend>, Integer, Hash)>] Array<RecommendationTrend> data, response status code and response headers
|
3345
|
+
def recommendation_trends_with_http_info(symbol, opts = {})
|
3346
|
+
if @api_client.config.debugging
|
3347
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.recommendation_trends ...'
|
3348
|
+
end
|
3349
|
+
# verify the required parameter 'symbol' is set
|
3350
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
3351
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.recommendation_trends"
|
3352
|
+
end
|
3353
|
+
# resource path
|
3354
|
+
local_var_path = '/stock/recommendation'
|
3355
|
+
|
3356
|
+
# query parameters
|
3357
|
+
query_params = opts[:query_params] || {}
|
3358
|
+
query_params[:'symbol'] = symbol
|
3359
|
+
|
3360
|
+
# header parameters
|
3361
|
+
header_params = opts[:header_params] || {}
|
3362
|
+
# HTTP header 'Accept' (if needed)
|
3363
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3364
|
+
|
3365
|
+
# form parameters
|
3366
|
+
form_params = opts[:form_params] || {}
|
3367
|
+
|
3368
|
+
# http body (model)
|
3369
|
+
post_body = opts[:debug_body]
|
3370
|
+
|
3371
|
+
# return_type
|
3372
|
+
return_type = opts[:debug_return_type] || 'Array<RecommendationTrend>'
|
3373
|
+
|
3374
|
+
# auth_names
|
3375
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
3376
|
+
|
3377
|
+
new_options = opts.merge(
|
3378
|
+
:operation => :"DefaultApi.recommendation_trends",
|
3379
|
+
:header_params => header_params,
|
3380
|
+
:query_params => query_params,
|
3381
|
+
:form_params => form_params,
|
3382
|
+
:body => post_body,
|
3383
|
+
:auth_names => auth_names,
|
3384
|
+
:return_type => return_type
|
3385
|
+
)
|
3386
|
+
|
3387
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3388
|
+
if @api_client.config.debugging
|
3389
|
+
@api_client.config.logger.debug "API called: DefaultApi#recommendation_trends\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3390
|
+
end
|
3391
|
+
return data, status_code, headers
|
3392
|
+
end
|
3393
|
+
|
3394
|
+
# Revenue Breakdown
|
3395
|
+
# Get revenue breakdown by product. This dataset is only available for US companies which disclose their revenue breakdown in the annual or quarterly reports.
|
3396
|
+
# @param [Hash] opts the optional parameters
|
3397
|
+
# @option opts [String] :symbol Symbol.
|
3398
|
+
# @option opts [String] :cik CIK.
|
3399
|
+
# @return [RevenueBreakdown]
|
3400
|
+
def revenue_breakdown(opts = {})
|
3401
|
+
data, _status_code, _headers = revenue_breakdown_with_http_info(opts)
|
3402
|
+
data
|
3403
|
+
end
|
3404
|
+
|
3405
|
+
# Revenue Breakdown
|
3406
|
+
# Get revenue breakdown by product. This dataset is only available for US companies which disclose their revenue breakdown in the annual or quarterly reports.
|
3407
|
+
# @param [Hash] opts the optional parameters
|
3408
|
+
# @option opts [String] :symbol Symbol.
|
3409
|
+
# @option opts [String] :cik CIK.
|
3410
|
+
# @return [Array<(RevenueBreakdown, Integer, Hash)>] RevenueBreakdown data, response status code and response headers
|
3411
|
+
def revenue_breakdown_with_http_info(opts = {})
|
3412
|
+
if @api_client.config.debugging
|
3413
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.revenue_breakdown ...'
|
3414
|
+
end
|
3415
|
+
# resource path
|
3416
|
+
local_var_path = '/stock/revenue-breakdown'
|
3417
|
+
|
3418
|
+
# query parameters
|
3419
|
+
query_params = opts[:query_params] || {}
|
3420
|
+
query_params[:'symbol'] = opts[:'symbol'] if !opts[:'symbol'].nil?
|
3421
|
+
query_params[:'cik'] = opts[:'cik'] if !opts[:'cik'].nil?
|
3422
|
+
|
3423
|
+
# header parameters
|
3424
|
+
header_params = opts[:header_params] || {}
|
3425
|
+
# HTTP header 'Accept' (if needed)
|
3426
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3427
|
+
|
3428
|
+
# form parameters
|
3429
|
+
form_params = opts[:form_params] || {}
|
3430
|
+
|
3431
|
+
# http body (model)
|
3432
|
+
post_body = opts[:debug_body]
|
3433
|
+
|
3434
|
+
# return_type
|
3435
|
+
return_type = opts[:debug_return_type] || 'RevenueBreakdown'
|
3436
|
+
|
3437
|
+
# auth_names
|
3438
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
3439
|
+
|
3440
|
+
new_options = opts.merge(
|
3441
|
+
:operation => :"DefaultApi.revenue_breakdown",
|
3442
|
+
:header_params => header_params,
|
3443
|
+
:query_params => query_params,
|
3444
|
+
:form_params => form_params,
|
3445
|
+
:body => post_body,
|
3446
|
+
:auth_names => auth_names,
|
3447
|
+
:return_type => return_type
|
3448
|
+
)
|
3449
|
+
|
3450
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3451
|
+
if @api_client.config.debugging
|
3452
|
+
@api_client.config.logger.debug "API called: DefaultApi#revenue_breakdown\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3453
|
+
end
|
3454
|
+
return data, status_code, headers
|
3455
|
+
end
|
3456
|
+
|
3457
|
+
# Similarity Index
|
3458
|
+
# <p>Calculate the textual difference between a company's 10-K / 10-Q reports and the same type of report in the previous year using Cosine Similarity. For example, this endpoint compares 2019's 10-K with 2018's 10-K. Companies breaking from its routines in disclosure of financial condition and risk analysis section can signal a significant change in the company's stock price in the upcoming 4 quarters.</p>
|
3459
|
+
# @param [Hash] opts the optional parameters
|
3460
|
+
# @option opts [String] :symbol Symbol. Required if cik is empty
|
3461
|
+
# @option opts [String] :cik CIK. Required if symbol is empty
|
3462
|
+
# @option opts [String] :freq <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>
|
3463
|
+
# @return [SimilarityIndex]
|
3464
|
+
def similarity_index(opts = {})
|
3465
|
+
data, _status_code, _headers = similarity_index_with_http_info(opts)
|
3466
|
+
data
|
3467
|
+
end
|
3468
|
+
|
3469
|
+
# Similarity Index
|
3470
|
+
# <p>Calculate the textual difference between a company's 10-K / 10-Q reports and the same type of report in the previous year using Cosine Similarity. For example, this endpoint compares 2019's 10-K with 2018's 10-K. Companies breaking from its routines in disclosure of financial condition and risk analysis section can signal a significant change in the company's stock price in the upcoming 4 quarters.</p>
|
3471
|
+
# @param [Hash] opts the optional parameters
|
3472
|
+
# @option opts [String] :symbol Symbol. Required if cik is empty
|
3473
|
+
# @option opts [String] :cik CIK. Required if symbol is empty
|
3474
|
+
# @option opts [String] :freq <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>
|
3475
|
+
# @return [Array<(SimilarityIndex, Integer, Hash)>] SimilarityIndex data, response status code and response headers
|
3476
|
+
def similarity_index_with_http_info(opts = {})
|
3477
|
+
if @api_client.config.debugging
|
3478
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.similarity_index ...'
|
3479
|
+
end
|
3480
|
+
# resource path
|
3481
|
+
local_var_path = '/stock/similarity-index'
|
3482
|
+
|
3483
|
+
# query parameters
|
3484
|
+
query_params = opts[:query_params] || {}
|
3485
|
+
query_params[:'symbol'] = opts[:'symbol'] if !opts[:'symbol'].nil?
|
3486
|
+
query_params[:'cik'] = opts[:'cik'] if !opts[:'cik'].nil?
|
3487
|
+
query_params[:'freq'] = opts[:'freq'] if !opts[:'freq'].nil?
|
3488
|
+
|
3489
|
+
# header parameters
|
3490
|
+
header_params = opts[:header_params] || {}
|
3491
|
+
# HTTP header 'Accept' (if needed)
|
3492
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3493
|
+
|
3494
|
+
# form parameters
|
3495
|
+
form_params = opts[:form_params] || {}
|
3496
|
+
|
3497
|
+
# http body (model)
|
3498
|
+
post_body = opts[:debug_body]
|
2627
3499
|
|
2628
3500
|
# return_type
|
2629
|
-
return_type = opts[:
|
3501
|
+
return_type = opts[:debug_return_type] || 'SimilarityIndex'
|
2630
3502
|
|
2631
3503
|
# auth_names
|
2632
|
-
auth_names = opts[:
|
3504
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2633
3505
|
|
2634
3506
|
new_options = opts.merge(
|
3507
|
+
:operation => :"DefaultApi.similarity_index",
|
2635
3508
|
:header_params => header_params,
|
2636
3509
|
:query_params => query_params,
|
2637
3510
|
:form_params => form_params,
|
@@ -2642,40 +3515,46 @@ module FinnhubRuby
|
|
2642
3515
|
|
2643
3516
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2644
3517
|
if @api_client.config.debugging
|
2645
|
-
@api_client.config.logger.debug "API called: DefaultApi#
|
3518
|
+
@api_client.config.logger.debug "API called: DefaultApi#similarity_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2646
3519
|
end
|
2647
3520
|
return data, status_code, headers
|
2648
3521
|
end
|
2649
3522
|
|
2650
|
-
#
|
2651
|
-
# Get
|
2652
|
-
# @param symbol [String]
|
3523
|
+
# Social Sentiment
|
3524
|
+
# <p>Get social sentiment for stocks on Reddit and Twitter. This endpoint is currently in Beta.</p>
|
3525
|
+
# @param symbol [String] Company symbol.
|
2653
3526
|
# @param [Hash] opts the optional parameters
|
2654
|
-
# @
|
2655
|
-
|
2656
|
-
|
3527
|
+
# @option opts [Date] :from From date <code>YYYY-MM-DD</code>.
|
3528
|
+
# @option opts [Date] :to To date <code>YYYY-MM-DD</code>.
|
3529
|
+
# @return [SocialSentiment]
|
3530
|
+
def social_sentiment(symbol, opts = {})
|
3531
|
+
data, _status_code, _headers = social_sentiment_with_http_info(symbol, opts)
|
2657
3532
|
data
|
2658
3533
|
end
|
2659
3534
|
|
2660
|
-
#
|
2661
|
-
# Get
|
2662
|
-
# @param symbol [String]
|
3535
|
+
# Social Sentiment
|
3536
|
+
# <p>Get social sentiment for stocks on Reddit and Twitter. This endpoint is currently in Beta.</p>
|
3537
|
+
# @param symbol [String] Company symbol.
|
2663
3538
|
# @param [Hash] opts the optional parameters
|
2664
|
-
# @
|
2665
|
-
|
3539
|
+
# @option opts [Date] :from From date <code>YYYY-MM-DD</code>.
|
3540
|
+
# @option opts [Date] :to To date <code>YYYY-MM-DD</code>.
|
3541
|
+
# @return [Array<(SocialSentiment, Integer, Hash)>] SocialSentiment data, response status code and response headers
|
3542
|
+
def social_sentiment_with_http_info(symbol, opts = {})
|
2666
3543
|
if @api_client.config.debugging
|
2667
|
-
@api_client.config.logger.debug 'Calling API: DefaultApi.
|
3544
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.social_sentiment ...'
|
2668
3545
|
end
|
2669
3546
|
# verify the required parameter 'symbol' is set
|
2670
3547
|
if @api_client.config.client_side_validation && symbol.nil?
|
2671
|
-
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.
|
3548
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.social_sentiment"
|
2672
3549
|
end
|
2673
3550
|
# resource path
|
2674
|
-
local_var_path = '/stock/
|
3551
|
+
local_var_path = '/stock/social-sentiment'
|
2675
3552
|
|
2676
3553
|
# query parameters
|
2677
3554
|
query_params = opts[:query_params] || {}
|
2678
3555
|
query_params[:'symbol'] = symbol
|
3556
|
+
query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
|
3557
|
+
query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
|
2679
3558
|
|
2680
3559
|
# header parameters
|
2681
3560
|
header_params = opts[:header_params] || {}
|
@@ -2686,15 +3565,16 @@ module FinnhubRuby
|
|
2686
3565
|
form_params = opts[:form_params] || {}
|
2687
3566
|
|
2688
3567
|
# http body (model)
|
2689
|
-
post_body = opts[:
|
3568
|
+
post_body = opts[:debug_body]
|
2690
3569
|
|
2691
3570
|
# return_type
|
2692
|
-
return_type = opts[:
|
3571
|
+
return_type = opts[:debug_return_type] || 'SocialSentiment'
|
2693
3572
|
|
2694
3573
|
# auth_names
|
2695
|
-
auth_names = opts[:
|
3574
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2696
3575
|
|
2697
3576
|
new_options = opts.merge(
|
3577
|
+
:operation => :"DefaultApi.social_sentiment",
|
2698
3578
|
:header_params => header_params,
|
2699
3579
|
:query_params => query_params,
|
2700
3580
|
:form_params => form_params,
|
@@ -2705,42 +3585,40 @@ module FinnhubRuby
|
|
2705
3585
|
|
2706
3586
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2707
3587
|
if @api_client.config.debugging
|
2708
|
-
@api_client.config.logger.debug "API called: DefaultApi#
|
3588
|
+
@api_client.config.logger.debug "API called: DefaultApi#social_sentiment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2709
3589
|
end
|
2710
3590
|
return data, status_code, headers
|
2711
3591
|
end
|
2712
3592
|
|
2713
|
-
#
|
2714
|
-
#
|
3593
|
+
# Dividends 2 (Basic)
|
3594
|
+
# Get global dividends data.
|
3595
|
+
# @param symbol [String] Symbol.
|
2715
3596
|
# @param [Hash] opts the optional parameters
|
2716
|
-
# @
|
2717
|
-
|
2718
|
-
|
2719
|
-
# @return [SimilarityIndex]
|
2720
|
-
def similarity_index(opts = {})
|
2721
|
-
data, _status_code, _headers = similarity_index_with_http_info(opts)
|
3597
|
+
# @return [Dividends2Basic]
|
3598
|
+
def stock_basic_dividends(symbol, opts = {})
|
3599
|
+
data, _status_code, _headers = stock_basic_dividends_with_http_info(symbol, opts)
|
2722
3600
|
data
|
2723
3601
|
end
|
2724
3602
|
|
2725
|
-
#
|
2726
|
-
#
|
3603
|
+
# Dividends 2 (Basic)
|
3604
|
+
# Get global dividends data.
|
3605
|
+
# @param symbol [String] Symbol.
|
2727
3606
|
# @param [Hash] opts the optional parameters
|
2728
|
-
# @
|
2729
|
-
|
2730
|
-
# @option opts [String] :freq <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>
|
2731
|
-
# @return [Array<(SimilarityIndex, Integer, Hash)>] SimilarityIndex data, response status code and response headers
|
2732
|
-
def similarity_index_with_http_info(opts = {})
|
3607
|
+
# @return [Array<(Dividends2Basic, Integer, Hash)>] Dividends2Basic data, response status code and response headers
|
3608
|
+
def stock_basic_dividends_with_http_info(symbol, opts = {})
|
2733
3609
|
if @api_client.config.debugging
|
2734
|
-
@api_client.config.logger.debug 'Calling API: DefaultApi.
|
3610
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.stock_basic_dividends ...'
|
3611
|
+
end
|
3612
|
+
# verify the required parameter 'symbol' is set
|
3613
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
3614
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.stock_basic_dividends"
|
2735
3615
|
end
|
2736
3616
|
# resource path
|
2737
|
-
local_var_path = '/stock/
|
3617
|
+
local_var_path = '/stock/dividend2'
|
2738
3618
|
|
2739
3619
|
# query parameters
|
2740
3620
|
query_params = opts[:query_params] || {}
|
2741
|
-
query_params[:'symbol'] =
|
2742
|
-
query_params[:'cik'] = opts[:'cik'] if !opts[:'cik'].nil?
|
2743
|
-
query_params[:'freq'] = opts[:'freq'] if !opts[:'freq'].nil?
|
3621
|
+
query_params[:'symbol'] = symbol
|
2744
3622
|
|
2745
3623
|
# header parameters
|
2746
3624
|
header_params = opts[:header_params] || {}
|
@@ -2751,15 +3629,16 @@ module FinnhubRuby
|
|
2751
3629
|
form_params = opts[:form_params] || {}
|
2752
3630
|
|
2753
3631
|
# http body (model)
|
2754
|
-
post_body = opts[:
|
3632
|
+
post_body = opts[:debug_body]
|
2755
3633
|
|
2756
3634
|
# return_type
|
2757
|
-
return_type = opts[:
|
3635
|
+
return_type = opts[:debug_return_type] || 'Dividends2Basic'
|
2758
3636
|
|
2759
3637
|
# auth_names
|
2760
|
-
auth_names = opts[:
|
3638
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2761
3639
|
|
2762
3640
|
new_options = opts.merge(
|
3641
|
+
:operation => :"DefaultApi.stock_basic_dividends",
|
2763
3642
|
:header_params => header_params,
|
2764
3643
|
:query_params => query_params,
|
2765
3644
|
:form_params => form_params,
|
@@ -2770,7 +3649,7 @@ module FinnhubRuby
|
|
2770
3649
|
|
2771
3650
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2772
3651
|
if @api_client.config.debugging
|
2773
|
-
@api_client.config.logger.debug "API called: DefaultApi#
|
3652
|
+
@api_client.config.logger.debug "API called: DefaultApi#stock_basic_dividends\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2774
3653
|
end
|
2775
3654
|
return data, status_code, headers
|
2776
3655
|
end
|
@@ -2814,15 +3693,16 @@ module FinnhubRuby
|
|
2814
3693
|
form_params = opts[:form_params] || {}
|
2815
3694
|
|
2816
3695
|
# http body (model)
|
2817
|
-
post_body = opts[:
|
3696
|
+
post_body = opts[:debug_body]
|
2818
3697
|
|
2819
3698
|
# return_type
|
2820
|
-
return_type = opts[:
|
3699
|
+
return_type = opts[:debug_return_type] || 'LastBidAsk'
|
2821
3700
|
|
2822
3701
|
# auth_names
|
2823
|
-
auth_names = opts[:
|
3702
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2824
3703
|
|
2825
3704
|
new_options = opts.merge(
|
3705
|
+
:operation => :"DefaultApi.stock_bidask",
|
2826
3706
|
:header_params => header_params,
|
2827
3707
|
:query_params => query_params,
|
2828
3708
|
:form_params => form_params,
|
@@ -2839,13 +3719,13 @@ module FinnhubRuby
|
|
2839
3719
|
end
|
2840
3720
|
|
2841
3721
|
# Stock Candles
|
2842
|
-
# <p>Get candlestick data
|
3722
|
+
# <p>Get candlestick data (OHLCV) for stocks
|
2843
3723
|
# @param symbol [String] Symbol.
|
2844
3724
|
# @param resolution [String] Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.
|
2845
3725
|
# @param from [Integer] UNIX timestamp. Interval initial value.
|
2846
3726
|
# @param to [Integer] UNIX timestamp. Interval end value.
|
2847
3727
|
# @param [Hash] opts the optional parameters
|
2848
|
-
# @option opts [String] :adjusted
|
3728
|
+
# @option opts [String] :adjusted DEPRECATED: this option has been deprecated. All Daily data will be adjusted for Splits and intraday data will remain unadjusted.
|
2849
3729
|
# @return [StockCandles]
|
2850
3730
|
def stock_candles(symbol, resolution, from, to, opts = {})
|
2851
3731
|
data, _status_code, _headers = stock_candles_with_http_info(symbol, resolution, from, to, opts)
|
@@ -2853,13 +3733,13 @@ module FinnhubRuby
|
|
2853
3733
|
end
|
2854
3734
|
|
2855
3735
|
# Stock Candles
|
2856
|
-
# <p>Get candlestick data
|
3736
|
+
# <p>Get candlestick data (OHLCV) for stocks
|
2857
3737
|
# @param symbol [String] Symbol.
|
2858
3738
|
# @param resolution [String] Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.
|
2859
3739
|
# @param from [Integer] UNIX timestamp. Interval initial value.
|
2860
3740
|
# @param to [Integer] UNIX timestamp. Interval end value.
|
2861
3741
|
# @param [Hash] opts the optional parameters
|
2862
|
-
# @option opts [String] :adjusted
|
3742
|
+
# @option opts [String] :adjusted DEPRECATED: this option has been deprecated. All Daily data will be adjusted for Splits and intraday data will remain unadjusted.
|
2863
3743
|
# @return [Array<(StockCandles, Integer, Hash)>] StockCandles data, response status code and response headers
|
2864
3744
|
def stock_candles_with_http_info(symbol, resolution, from, to, opts = {})
|
2865
3745
|
if @api_client.config.debugging
|
@@ -2901,15 +3781,16 @@ module FinnhubRuby
|
|
2901
3781
|
form_params = opts[:form_params] || {}
|
2902
3782
|
|
2903
3783
|
# http body (model)
|
2904
|
-
post_body = opts[:
|
3784
|
+
post_body = opts[:debug_body]
|
2905
3785
|
|
2906
3786
|
# return_type
|
2907
|
-
return_type = opts[:
|
3787
|
+
return_type = opts[:debug_return_type] || 'StockCandles'
|
2908
3788
|
|
2909
3789
|
# auth_names
|
2910
|
-
auth_names = opts[:
|
3790
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2911
3791
|
|
2912
3792
|
new_options = opts.merge(
|
3793
|
+
:operation => :"DefaultApi.stock_candles",
|
2913
3794
|
:header_params => header_params,
|
2914
3795
|
:query_params => query_params,
|
2915
3796
|
:form_params => form_params,
|
@@ -2978,15 +3859,16 @@ module FinnhubRuby
|
|
2978
3859
|
form_params = opts[:form_params] || {}
|
2979
3860
|
|
2980
3861
|
# http body (model)
|
2981
|
-
post_body = opts[:
|
3862
|
+
post_body = opts[:debug_body]
|
2982
3863
|
|
2983
3864
|
# return_type
|
2984
|
-
return_type = opts[:
|
3865
|
+
return_type = opts[:debug_return_type] || 'Array<Dividends>'
|
2985
3866
|
|
2986
3867
|
# auth_names
|
2987
|
-
auth_names = opts[:
|
3868
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
2988
3869
|
|
2989
3870
|
new_options = opts.merge(
|
3871
|
+
:operation => :"DefaultApi.stock_dividends",
|
2990
3872
|
:header_params => header_params,
|
2991
3873
|
:query_params => query_params,
|
2992
3874
|
:form_params => form_params,
|
@@ -3002,6 +3884,91 @@ module FinnhubRuby
|
|
3002
3884
|
return data, status_code, headers
|
3003
3885
|
end
|
3004
3886
|
|
3887
|
+
# Historical NBBO
|
3888
|
+
# <p>Get historical best bid and offer for US stocks, LSE, TSX, Euronext and Deutsche Borse.</p><p>For US market, this endpoint only serves historical NBBO from the beginning of 2020. To download more historical data, please visit our bulk download page in the Dashboard <a target=\"_blank\" href=\"/dashboard/download\",>here</a>.</p>
|
3889
|
+
# @param symbol [String] Symbol.
|
3890
|
+
# @param date [Date] Date: 2020-04-02.
|
3891
|
+
# @param limit [Integer] Limit number of ticks returned. Maximum value: <code>25000</code>
|
3892
|
+
# @param skip [Integer] Number of ticks to skip. Use this parameter to loop through the entire data.
|
3893
|
+
# @param [Hash] opts the optional parameters
|
3894
|
+
# @return [HistoricalNBBO]
|
3895
|
+
def stock_nbbo(symbol, date, limit, skip, opts = {})
|
3896
|
+
data, _status_code, _headers = stock_nbbo_with_http_info(symbol, date, limit, skip, opts)
|
3897
|
+
data
|
3898
|
+
end
|
3899
|
+
|
3900
|
+
# Historical NBBO
|
3901
|
+
# <p>Get historical best bid and offer for US stocks, LSE, TSX, Euronext and Deutsche Borse.</p><p>For US market, this endpoint only serves historical NBBO from the beginning of 2020. To download more historical data, please visit our bulk download page in the Dashboard <a target=\"_blank\" href=\"/dashboard/download\",>here</a>.</p>
|
3902
|
+
# @param symbol [String] Symbol.
|
3903
|
+
# @param date [Date] Date: 2020-04-02.
|
3904
|
+
# @param limit [Integer] Limit number of ticks returned. Maximum value: <code>25000</code>
|
3905
|
+
# @param skip [Integer] Number of ticks to skip. Use this parameter to loop through the entire data.
|
3906
|
+
# @param [Hash] opts the optional parameters
|
3907
|
+
# @return [Array<(HistoricalNBBO, Integer, Hash)>] HistoricalNBBO data, response status code and response headers
|
3908
|
+
def stock_nbbo_with_http_info(symbol, date, limit, skip, opts = {})
|
3909
|
+
if @api_client.config.debugging
|
3910
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.stock_nbbo ...'
|
3911
|
+
end
|
3912
|
+
# verify the required parameter 'symbol' is set
|
3913
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
3914
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.stock_nbbo"
|
3915
|
+
end
|
3916
|
+
# verify the required parameter 'date' is set
|
3917
|
+
if @api_client.config.client_side_validation && date.nil?
|
3918
|
+
fail ArgumentError, "Missing the required parameter 'date' when calling DefaultApi.stock_nbbo"
|
3919
|
+
end
|
3920
|
+
# verify the required parameter 'limit' is set
|
3921
|
+
if @api_client.config.client_side_validation && limit.nil?
|
3922
|
+
fail ArgumentError, "Missing the required parameter 'limit' when calling DefaultApi.stock_nbbo"
|
3923
|
+
end
|
3924
|
+
# verify the required parameter 'skip' is set
|
3925
|
+
if @api_client.config.client_side_validation && skip.nil?
|
3926
|
+
fail ArgumentError, "Missing the required parameter 'skip' when calling DefaultApi.stock_nbbo"
|
3927
|
+
end
|
3928
|
+
# resource path
|
3929
|
+
local_var_path = '/stock/bbo'
|
3930
|
+
|
3931
|
+
# query parameters
|
3932
|
+
query_params = opts[:query_params] || {}
|
3933
|
+
query_params[:'symbol'] = symbol
|
3934
|
+
query_params[:'date'] = date
|
3935
|
+
query_params[:'limit'] = limit
|
3936
|
+
query_params[:'skip'] = skip
|
3937
|
+
|
3938
|
+
# header parameters
|
3939
|
+
header_params = opts[:header_params] || {}
|
3940
|
+
# HTTP header 'Accept' (if needed)
|
3941
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3942
|
+
|
3943
|
+
# form parameters
|
3944
|
+
form_params = opts[:form_params] || {}
|
3945
|
+
|
3946
|
+
# http body (model)
|
3947
|
+
post_body = opts[:debug_body]
|
3948
|
+
|
3949
|
+
# return_type
|
3950
|
+
return_type = opts[:debug_return_type] || 'HistoricalNBBO'
|
3951
|
+
|
3952
|
+
# auth_names
|
3953
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
3954
|
+
|
3955
|
+
new_options = opts.merge(
|
3956
|
+
:operation => :"DefaultApi.stock_nbbo",
|
3957
|
+
:header_params => header_params,
|
3958
|
+
:query_params => query_params,
|
3959
|
+
:form_params => form_params,
|
3960
|
+
:body => post_body,
|
3961
|
+
:auth_names => auth_names,
|
3962
|
+
:return_type => return_type
|
3963
|
+
)
|
3964
|
+
|
3965
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3966
|
+
if @api_client.config.debugging
|
3967
|
+
@api_client.config.logger.debug "API called: DefaultApi#stock_nbbo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3968
|
+
end
|
3969
|
+
return data, status_code, headers
|
3970
|
+
end
|
3971
|
+
|
3005
3972
|
# Splits
|
3006
3973
|
# Get splits data for stocks.
|
3007
3974
|
# @param symbol [String] Symbol.
|
@@ -3055,15 +4022,16 @@ module FinnhubRuby
|
|
3055
4022
|
form_params = opts[:form_params] || {}
|
3056
4023
|
|
3057
4024
|
# http body (model)
|
3058
|
-
post_body = opts[:
|
4025
|
+
post_body = opts[:debug_body]
|
3059
4026
|
|
3060
4027
|
# return_type
|
3061
|
-
return_type = opts[:
|
4028
|
+
return_type = opts[:debug_return_type] || 'Array<Split>'
|
3062
4029
|
|
3063
4030
|
# auth_names
|
3064
|
-
auth_names = opts[:
|
4031
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
3065
4032
|
|
3066
4033
|
new_options = opts.merge(
|
4034
|
+
:operation => :"DefaultApi.stock_splits",
|
3067
4035
|
:header_params => header_params,
|
3068
4036
|
:query_params => query_params,
|
3069
4037
|
:form_params => form_params,
|
@@ -3080,9 +4048,12 @@ module FinnhubRuby
|
|
3080
4048
|
end
|
3081
4049
|
|
3082
4050
|
# Stock Symbol
|
3083
|
-
# List supported stocks. A list of supported CFD Indices can be found <a href=\"https://docs.google.com/spreadsheets/d/1BAbIXBgl405fj0oHeEyRFEu8mW4QD1PhvtaBATLoR14/edit?usp=sharing\" target=\"_blank\">here</a>.
|
3084
|
-
# @param exchange [String] Exchange you want to get the list of symbols from. List of
|
4051
|
+
# List supported stocks. We use the following symbology to identify stocks on Finnhub <code>Exchange_Ticker.Exchange_Code</code>. A list of supported exchange codes can be found <a href=\"https://docs.google.com/spreadsheets/d/1I3pBxjfXB056-g_JYf_6o3Rns3BV2kMGG1nCatb91ls/edit?usp=sharing\" target=\"_blank\">here</a>. A list of supported CFD Indices can be found <a href=\"https://docs.google.com/spreadsheets/d/1BAbIXBgl405fj0oHeEyRFEu8mW4QD1PhvtaBATLoR14/edit?usp=sharing\" target=\"_blank\">here</a>.
|
4052
|
+
# @param exchange [String] Exchange you want to get the list of symbols from. List of exchange codes can be found <a href=\"https://docs.google.com/spreadsheets/d/1I3pBxjfXB056-g_JYf_6o3Rns3BV2kMGG1nCatb91ls/edit?usp=sharing\" target=\"_blank\">here</a>.
|
3085
4053
|
# @param [Hash] opts the optional parameters
|
4054
|
+
# @option opts [String] :mic Filter by MIC code.
|
4055
|
+
# @option opts [String] :security_type Filter by security type used by OpenFigi standard.
|
4056
|
+
# @option opts [String] :currency Filter by currency.
|
3086
4057
|
# @return [Array<Stock>]
|
3087
4058
|
def stock_symbols(exchange, opts = {})
|
3088
4059
|
data, _status_code, _headers = stock_symbols_with_http_info(exchange, opts)
|
@@ -3090,9 +4061,12 @@ module FinnhubRuby
|
|
3090
4061
|
end
|
3091
4062
|
|
3092
4063
|
# Stock Symbol
|
3093
|
-
# List supported stocks. A list of supported CFD Indices can be found <a href=\"https://docs.google.com/spreadsheets/d/1BAbIXBgl405fj0oHeEyRFEu8mW4QD1PhvtaBATLoR14/edit?usp=sharing\" target=\"_blank\">here</a>.
|
3094
|
-
# @param exchange [String] Exchange you want to get the list of symbols from. List of
|
4064
|
+
# List supported stocks. We use the following symbology to identify stocks on Finnhub <code>Exchange_Ticker.Exchange_Code</code>. A list of supported exchange codes can be found <a href=\"https://docs.google.com/spreadsheets/d/1I3pBxjfXB056-g_JYf_6o3Rns3BV2kMGG1nCatb91ls/edit?usp=sharing\" target=\"_blank\">here</a>. A list of supported CFD Indices can be found <a href=\"https://docs.google.com/spreadsheets/d/1BAbIXBgl405fj0oHeEyRFEu8mW4QD1PhvtaBATLoR14/edit?usp=sharing\" target=\"_blank\">here</a>.
|
4065
|
+
# @param exchange [String] Exchange you want to get the list of symbols from. List of exchange codes can be found <a href=\"https://docs.google.com/spreadsheets/d/1I3pBxjfXB056-g_JYf_6o3Rns3BV2kMGG1nCatb91ls/edit?usp=sharing\" target=\"_blank\">here</a>.
|
3095
4066
|
# @param [Hash] opts the optional parameters
|
4067
|
+
# @option opts [String] :mic Filter by MIC code.
|
4068
|
+
# @option opts [String] :security_type Filter by security type used by OpenFigi standard.
|
4069
|
+
# @option opts [String] :currency Filter by currency.
|
3096
4070
|
# @return [Array<(Array<Stock>, Integer, Hash)>] Array<Stock> data, response status code and response headers
|
3097
4071
|
def stock_symbols_with_http_info(exchange, opts = {})
|
3098
4072
|
if @api_client.config.debugging
|
@@ -3108,6 +4082,9 @@ module FinnhubRuby
|
|
3108
4082
|
# query parameters
|
3109
4083
|
query_params = opts[:query_params] || {}
|
3110
4084
|
query_params[:'exchange'] = exchange
|
4085
|
+
query_params[:'mic'] = opts[:'mic'] if !opts[:'mic'].nil?
|
4086
|
+
query_params[:'securityType'] = opts[:'security_type'] if !opts[:'security_type'].nil?
|
4087
|
+
query_params[:'currency'] = opts[:'currency'] if !opts[:'currency'].nil?
|
3111
4088
|
|
3112
4089
|
# header parameters
|
3113
4090
|
header_params = opts[:header_params] || {}
|
@@ -3118,15 +4095,16 @@ module FinnhubRuby
|
|
3118
4095
|
form_params = opts[:form_params] || {}
|
3119
4096
|
|
3120
4097
|
# http body (model)
|
3121
|
-
post_body = opts[:
|
4098
|
+
post_body = opts[:debug_body]
|
3122
4099
|
|
3123
4100
|
# return_type
|
3124
|
-
return_type = opts[:
|
4101
|
+
return_type = opts[:debug_return_type] || 'Array<Stock>'
|
3125
4102
|
|
3126
4103
|
# auth_names
|
3127
|
-
auth_names = opts[:
|
4104
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
3128
4105
|
|
3129
4106
|
new_options = opts.merge(
|
4107
|
+
:operation => :"DefaultApi.stock_symbols",
|
3130
4108
|
:header_params => header_params,
|
3131
4109
|
:query_params => query_params,
|
3132
4110
|
:form_params => form_params,
|
@@ -3143,7 +4121,7 @@ module FinnhubRuby
|
|
3143
4121
|
end
|
3144
4122
|
|
3145
4123
|
# Tick Data
|
3146
|
-
# <p>Get historical tick data for
|
4124
|
+
# <p>Get historical tick data for global exchanges. You can send the request directly to our tick server at <a href=\"https://tick.finnhub.io/\">https://tick.finnhub.io/</a> with the same path and parameters or get redirected there if you call our main server.</p><p>For US market, you can visit our bulk download page in the Dashboard <a target=\"_blank\" href=\"/dashboard/download\",>here</a> to speed up the download process.</p><p>Note that for Nasdaq Nordic and Baltic, you need to use ISIN instead of symbol to query tick data. </p><table class=\"table table-hover\"> <thead> <tr> <th>Exchange</th> <th>Segment</th> <th>Delay</th> </tr> </thead> <tbody> <tr> <td class=\"text-blue\">US CTA/UTP</th> <td>Full SIP</td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">TSX</th> <td><ul><li>TSX</li><li>TSX Venture</li><li>Index</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">LSE</th> <td><ul><li>London Stock Exchange (L)</li><li>LSE International (L)</li><li>LSE European (L)</li></ul></td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">Euronext</th> <td><ul> <li>Euronext Paris (PA)</li> <li>Euronext Amsterdam (AS)</li> <li>Euronext Lisbon (LS)</li> <li>Euronext Brussels (BR)</li> <li>Euronext Oslo (OL)</li> <li>Euronext London (LN)</li> <li>Euronext Dublin (IR)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">Deutsche Börse</th> <td><ul> <li>Frankfurt (F)</li> <li>Xetra (DE)</li> <li>Duesseldorf (DU)</li> <li>Hamburg (HM)</li> <li>Berlin (BE)</li> <li>Hanover (HA)</li> <li>Stoxx (SX)</li> <li>TradeGate (TG)</li> <li>Zertifikate (SC)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">Nasdaq Nordic & Baltic</th> <td> <ul> <li>Copenhagen (CO)</li> <li>Stockholm (ST)</li> <li>Helsinki (HE)</li> <li>Iceland (IC)</li> <li>Riga (RG)</li> <li>Tallinn (TL)</li> <li>Vilnius(VS)</li> <li>Fixed Income</li> <li>Derivatives</li> <li>Commodities</li></ul></td> <td>End-of-day</td> </tr> </tbody> </table>
|
3147
4125
|
# @param symbol [String] Symbol.
|
3148
4126
|
# @param date [Date] Date: 2020-04-02.
|
3149
4127
|
# @param limit [Integer] Limit number of ticks returned. Maximum value: <code>25000</code>
|
@@ -3156,7 +4134,7 @@ module FinnhubRuby
|
|
3156
4134
|
end
|
3157
4135
|
|
3158
4136
|
# Tick Data
|
3159
|
-
# <p>Get historical tick data for
|
4137
|
+
# <p>Get historical tick data for global exchanges. You can send the request directly to our tick server at <a href=\"https://tick.finnhub.io/\">https://tick.finnhub.io/</a> with the same path and parameters or get redirected there if you call our main server.</p><p>For US market, you can visit our bulk download page in the Dashboard <a target=\"_blank\" href=\"/dashboard/download\",>here</a> to speed up the download process.</p><p>Note that for Nasdaq Nordic and Baltic, you need to use ISIN instead of symbol to query tick data. </p><table class=\"table table-hover\"> <thead> <tr> <th>Exchange</th> <th>Segment</th> <th>Delay</th> </tr> </thead> <tbody> <tr> <td class=\"text-blue\">US CTA/UTP</th> <td>Full SIP</td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">TSX</th> <td><ul><li>TSX</li><li>TSX Venture</li><li>Index</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">LSE</th> <td><ul><li>London Stock Exchange (L)</li><li>LSE International (L)</li><li>LSE European (L)</li></ul></td> <td>15 minute</td> </tr> <tr> <td class=\"text-blue\">Euronext</th> <td><ul> <li>Euronext Paris (PA)</li> <li>Euronext Amsterdam (AS)</li> <li>Euronext Lisbon (LS)</li> <li>Euronext Brussels (BR)</li> <li>Euronext Oslo (OL)</li> <li>Euronext London (LN)</li> <li>Euronext Dublin (IR)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">Deutsche Börse</th> <td><ul> <li>Frankfurt (F)</li> <li>Xetra (DE)</li> <li>Duesseldorf (DU)</li> <li>Hamburg (HM)</li> <li>Berlin (BE)</li> <li>Hanover (HA)</li> <li>Stoxx (SX)</li> <li>TradeGate (TG)</li> <li>Zertifikate (SC)</li> <li>Index</li> <li>Warrant</li></ul></td> <td>End-of-day</td> </tr> <tr> <td class=\"text-blue\">Nasdaq Nordic & Baltic</th> <td> <ul> <li>Copenhagen (CO)</li> <li>Stockholm (ST)</li> <li>Helsinki (HE)</li> <li>Iceland (IC)</li> <li>Riga (RG)</li> <li>Tallinn (TL)</li> <li>Vilnius(VS)</li> <li>Fixed Income</li> <li>Derivatives</li> <li>Commodities</li></ul></td> <td>End-of-day</td> </tr> </tbody> </table>
|
3160
4138
|
# @param symbol [String] Symbol.
|
3161
4139
|
# @param date [Date] Date: 2020-04-02.
|
3162
4140
|
# @param limit [Integer] Limit number of ticks returned. Maximum value: <code>25000</code>
|
@@ -3202,15 +4180,16 @@ module FinnhubRuby
|
|
3202
4180
|
form_params = opts[:form_params] || {}
|
3203
4181
|
|
3204
4182
|
# http body (model)
|
3205
|
-
post_body = opts[:
|
4183
|
+
post_body = opts[:debug_body]
|
3206
4184
|
|
3207
4185
|
# return_type
|
3208
|
-
return_type = opts[:
|
4186
|
+
return_type = opts[:debug_return_type] || 'TickData'
|
3209
4187
|
|
3210
4188
|
# auth_names
|
3211
|
-
auth_names = opts[:
|
4189
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
3212
4190
|
|
3213
4191
|
new_options = opts.merge(
|
4192
|
+
:operation => :"DefaultApi.stock_tick",
|
3214
4193
|
:header_params => header_params,
|
3215
4194
|
:query_params => query_params,
|
3216
4195
|
:form_params => form_params,
|
@@ -3226,6 +4205,70 @@ module FinnhubRuby
|
|
3226
4205
|
return data, status_code, headers
|
3227
4206
|
end
|
3228
4207
|
|
4208
|
+
# Supply Chain Relationships
|
4209
|
+
# <p>This endpoint provides an overall map of public companies' key customers and suppliers. The data offers a deeper look into a company's supply chain and how products are created. The data will help investors manage risk, limit exposure or generate alpha-generating ideas and trading insights.</p><p>We currently cover data for S&P500 and Nasdaq 100 companies.</p>
|
4210
|
+
# @param symbol [String] Symbol.
|
4211
|
+
# @param [Hash] opts the optional parameters
|
4212
|
+
# @return [SupplyChainRelationships]
|
4213
|
+
def supply_chain_relationships(symbol, opts = {})
|
4214
|
+
data, _status_code, _headers = supply_chain_relationships_with_http_info(symbol, opts)
|
4215
|
+
data
|
4216
|
+
end
|
4217
|
+
|
4218
|
+
# Supply Chain Relationships
|
4219
|
+
# <p>This endpoint provides an overall map of public companies' key customers and suppliers. The data offers a deeper look into a company's supply chain and how products are created. The data will help investors manage risk, limit exposure or generate alpha-generating ideas and trading insights.</p><p>We currently cover data for S&P500 and Nasdaq 100 companies.</p>
|
4220
|
+
# @param symbol [String] Symbol.
|
4221
|
+
# @param [Hash] opts the optional parameters
|
4222
|
+
# @return [Array<(SupplyChainRelationships, Integer, Hash)>] SupplyChainRelationships data, response status code and response headers
|
4223
|
+
def supply_chain_relationships_with_http_info(symbol, opts = {})
|
4224
|
+
if @api_client.config.debugging
|
4225
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.supply_chain_relationships ...'
|
4226
|
+
end
|
4227
|
+
# verify the required parameter 'symbol' is set
|
4228
|
+
if @api_client.config.client_side_validation && symbol.nil?
|
4229
|
+
fail ArgumentError, "Missing the required parameter 'symbol' when calling DefaultApi.supply_chain_relationships"
|
4230
|
+
end
|
4231
|
+
# resource path
|
4232
|
+
local_var_path = '/stock/supply-chain'
|
4233
|
+
|
4234
|
+
# query parameters
|
4235
|
+
query_params = opts[:query_params] || {}
|
4236
|
+
query_params[:'symbol'] = symbol
|
4237
|
+
|
4238
|
+
# header parameters
|
4239
|
+
header_params = opts[:header_params] || {}
|
4240
|
+
# HTTP header 'Accept' (if needed)
|
4241
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4242
|
+
|
4243
|
+
# form parameters
|
4244
|
+
form_params = opts[:form_params] || {}
|
4245
|
+
|
4246
|
+
# http body (model)
|
4247
|
+
post_body = opts[:debug_body]
|
4248
|
+
|
4249
|
+
# return_type
|
4250
|
+
return_type = opts[:debug_return_type] || 'SupplyChainRelationships'
|
4251
|
+
|
4252
|
+
# auth_names
|
4253
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
4254
|
+
|
4255
|
+
new_options = opts.merge(
|
4256
|
+
:operation => :"DefaultApi.supply_chain_relationships",
|
4257
|
+
:header_params => header_params,
|
4258
|
+
:query_params => query_params,
|
4259
|
+
:form_params => form_params,
|
4260
|
+
:body => post_body,
|
4261
|
+
:auth_names => auth_names,
|
4262
|
+
:return_type => return_type
|
4263
|
+
)
|
4264
|
+
|
4265
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
4266
|
+
if @api_client.config.debugging
|
4267
|
+
@api_client.config.logger.debug "API called: DefaultApi#supply_chain_relationships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4268
|
+
end
|
4269
|
+
return data, status_code, headers
|
4270
|
+
end
|
4271
|
+
|
3229
4272
|
# Support/Resistance
|
3230
4273
|
# Get support and resistance levels for a symbol.
|
3231
4274
|
# @param symbol [String] Symbol
|
@@ -3272,15 +4315,16 @@ module FinnhubRuby
|
|
3272
4315
|
form_params = opts[:form_params] || {}
|
3273
4316
|
|
3274
4317
|
# http body (model)
|
3275
|
-
post_body = opts[:
|
4318
|
+
post_body = opts[:debug_body]
|
3276
4319
|
|
3277
4320
|
# return_type
|
3278
|
-
return_type = opts[:
|
4321
|
+
return_type = opts[:debug_return_type] || 'SupportResistance'
|
3279
4322
|
|
3280
4323
|
# auth_names
|
3281
|
-
auth_names = opts[:
|
4324
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
3282
4325
|
|
3283
4326
|
new_options = opts.merge(
|
4327
|
+
:operation => :"DefaultApi.support_resistance",
|
3284
4328
|
:header_params => header_params,
|
3285
4329
|
:query_params => query_params,
|
3286
4330
|
:form_params => form_params,
|
@@ -3296,6 +4340,70 @@ module FinnhubRuby
|
|
3296
4340
|
return data, status_code, headers
|
3297
4341
|
end
|
3298
4342
|
|
4343
|
+
# Symbol Lookup
|
4344
|
+
# Search for best-matching symbols based on your query. You can input anything from symbol, security's name to ISIN and Cusip.
|
4345
|
+
# @param q [String] Query text can be symbol, name, isin, or cusip.
|
4346
|
+
# @param [Hash] opts the optional parameters
|
4347
|
+
# @return [SymbolLookup]
|
4348
|
+
def symbol_search(q, opts = {})
|
4349
|
+
data, _status_code, _headers = symbol_search_with_http_info(q, opts)
|
4350
|
+
data
|
4351
|
+
end
|
4352
|
+
|
4353
|
+
# Symbol Lookup
|
4354
|
+
# Search for best-matching symbols based on your query. You can input anything from symbol, security's name to ISIN and Cusip.
|
4355
|
+
# @param q [String] Query text can be symbol, name, isin, or cusip.
|
4356
|
+
# @param [Hash] opts the optional parameters
|
4357
|
+
# @return [Array<(SymbolLookup, Integer, Hash)>] SymbolLookup data, response status code and response headers
|
4358
|
+
def symbol_search_with_http_info(q, opts = {})
|
4359
|
+
if @api_client.config.debugging
|
4360
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.symbol_search ...'
|
4361
|
+
end
|
4362
|
+
# verify the required parameter 'q' is set
|
4363
|
+
if @api_client.config.client_side_validation && q.nil?
|
4364
|
+
fail ArgumentError, "Missing the required parameter 'q' when calling DefaultApi.symbol_search"
|
4365
|
+
end
|
4366
|
+
# resource path
|
4367
|
+
local_var_path = '/search'
|
4368
|
+
|
4369
|
+
# query parameters
|
4370
|
+
query_params = opts[:query_params] || {}
|
4371
|
+
query_params[:'q'] = q
|
4372
|
+
|
4373
|
+
# header parameters
|
4374
|
+
header_params = opts[:header_params] || {}
|
4375
|
+
# HTTP header 'Accept' (if needed)
|
4376
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4377
|
+
|
4378
|
+
# form parameters
|
4379
|
+
form_params = opts[:form_params] || {}
|
4380
|
+
|
4381
|
+
# http body (model)
|
4382
|
+
post_body = opts[:debug_body]
|
4383
|
+
|
4384
|
+
# return_type
|
4385
|
+
return_type = opts[:debug_return_type] || 'SymbolLookup'
|
4386
|
+
|
4387
|
+
# auth_names
|
4388
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
4389
|
+
|
4390
|
+
new_options = opts.merge(
|
4391
|
+
:operation => :"DefaultApi.symbol_search",
|
4392
|
+
:header_params => header_params,
|
4393
|
+
:query_params => query_params,
|
4394
|
+
:form_params => form_params,
|
4395
|
+
:body => post_body,
|
4396
|
+
:auth_names => auth_names,
|
4397
|
+
:return_type => return_type
|
4398
|
+
)
|
4399
|
+
|
4400
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
4401
|
+
if @api_client.config.debugging
|
4402
|
+
@api_client.config.logger.debug "API called: DefaultApi#symbol_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4403
|
+
end
|
4404
|
+
return data, status_code, headers
|
4405
|
+
end
|
4406
|
+
|
3299
4407
|
# Technical Indicators
|
3300
4408
|
# Return technical indicator with price data. List of supported indicators can be found <a href=\"https://docs.google.com/spreadsheets/d/1ylUvKHVYN2E87WdwIza8ROaCpd48ggEl1k5i5SgA29k/edit?usp=sharing\" target=\"_blank\">here</a>.
|
3301
4409
|
# @param symbol [String] symbol
|
@@ -3367,15 +4475,16 @@ module FinnhubRuby
|
|
3367
4475
|
form_params = opts[:form_params] || {}
|
3368
4476
|
|
3369
4477
|
# http body (model)
|
3370
|
-
post_body = opts[:
|
4478
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'indicator_fields'])
|
3371
4479
|
|
3372
4480
|
# return_type
|
3373
|
-
return_type = opts[:
|
4481
|
+
return_type = opts[:debug_return_type] || 'Object'
|
3374
4482
|
|
3375
4483
|
# auth_names
|
3376
|
-
auth_names = opts[:
|
4484
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
3377
4485
|
|
3378
4486
|
new_options = opts.merge(
|
4487
|
+
:operation => :"DefaultApi.technical_indicator",
|
3379
4488
|
:header_params => header_params,
|
3380
4489
|
:query_params => query_params,
|
3381
4490
|
:form_params => form_params,
|
@@ -3391,71 +4500,8 @@ module FinnhubRuby
|
|
3391
4500
|
return data, status_code, headers
|
3392
4501
|
end
|
3393
4502
|
|
3394
|
-
# Earnings Call Transcripts
|
3395
|
-
# <p>Get earnings call transcripts, audio and participants' list. This endpoint is only available for US companies. <p>17+ years of data is available with 170,000+ audio which add up to 6TB in size.</p>
|
3396
|
-
# @param id [String] Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>.
|
3397
|
-
# @param [Hash] opts the optional parameters
|
3398
|
-
# @return [EarningsCallTranscripts]
|
3399
|
-
def transcripts(id, opts = {})
|
3400
|
-
data, _status_code, _headers = transcripts_with_http_info(id, opts)
|
3401
|
-
data
|
3402
|
-
end
|
3403
|
-
|
3404
|
-
# Earnings Call Transcripts
|
3405
|
-
# <p>Get earnings call transcripts, audio and participants' list. This endpoint is only available for US companies. <p>17+ years of data is available with 170,000+ audio which add up to 6TB in size.</p>
|
3406
|
-
# @param id [String] Transcript's id obtained with <a href=\"#transcripts-list\">Transcripts List endpoint</a>.
|
3407
|
-
# @param [Hash] opts the optional parameters
|
3408
|
-
# @return [Array<(EarningsCallTranscripts, Integer, Hash)>] EarningsCallTranscripts data, response status code and response headers
|
3409
|
-
def transcripts_with_http_info(id, opts = {})
|
3410
|
-
if @api_client.config.debugging
|
3411
|
-
@api_client.config.logger.debug 'Calling API: DefaultApi.transcripts ...'
|
3412
|
-
end
|
3413
|
-
# verify the required parameter 'id' is set
|
3414
|
-
if @api_client.config.client_side_validation && id.nil?
|
3415
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling DefaultApi.transcripts"
|
3416
|
-
end
|
3417
|
-
# resource path
|
3418
|
-
local_var_path = '/stock/transcripts'
|
3419
|
-
|
3420
|
-
# query parameters
|
3421
|
-
query_params = opts[:query_params] || {}
|
3422
|
-
query_params[:'id'] = id
|
3423
|
-
|
3424
|
-
# header parameters
|
3425
|
-
header_params = opts[:header_params] || {}
|
3426
|
-
# HTTP header 'Accept' (if needed)
|
3427
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3428
|
-
|
3429
|
-
# form parameters
|
3430
|
-
form_params = opts[:form_params] || {}
|
3431
|
-
|
3432
|
-
# http body (model)
|
3433
|
-
post_body = opts[:body]
|
3434
|
-
|
3435
|
-
# return_type
|
3436
|
-
return_type = opts[:return_type] || 'EarningsCallTranscripts'
|
3437
|
-
|
3438
|
-
# auth_names
|
3439
|
-
auth_names = opts[:auth_names] || ['api_key']
|
3440
|
-
|
3441
|
-
new_options = opts.merge(
|
3442
|
-
:header_params => header_params,
|
3443
|
-
:query_params => query_params,
|
3444
|
-
:form_params => form_params,
|
3445
|
-
:body => post_body,
|
3446
|
-
:auth_names => auth_names,
|
3447
|
-
:return_type => return_type
|
3448
|
-
)
|
3449
|
-
|
3450
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
3451
|
-
if @api_client.config.debugging
|
3452
|
-
@api_client.config.logger.debug "API called: DefaultApi#transcripts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3453
|
-
end
|
3454
|
-
return data, status_code, headers
|
3455
|
-
end
|
3456
|
-
|
3457
4503
|
# Earnings Call Transcripts List
|
3458
|
-
# List earnings call transcripts' metadata. This endpoint is
|
4504
|
+
# List earnings call transcripts' metadata. This endpoint is available for US, UK and Canadian companies.
|
3459
4505
|
# @param symbol [String] Company symbol: AAPL. Leave empty to list the latest transcripts
|
3460
4506
|
# @param [Hash] opts the optional parameters
|
3461
4507
|
# @return [EarningsCallTranscriptsList]
|
@@ -3465,7 +4511,7 @@ module FinnhubRuby
|
|
3465
4511
|
end
|
3466
4512
|
|
3467
4513
|
# Earnings Call Transcripts List
|
3468
|
-
# List earnings call transcripts' metadata. This endpoint is
|
4514
|
+
# List earnings call transcripts' metadata. This endpoint is available for US, UK and Canadian companies.
|
3469
4515
|
# @param symbol [String] Company symbol: AAPL. Leave empty to list the latest transcripts
|
3470
4516
|
# @param [Hash] opts the optional parameters
|
3471
4517
|
# @return [Array<(EarningsCallTranscriptsList, Integer, Hash)>] EarningsCallTranscriptsList data, response status code and response headers
|
@@ -3493,15 +4539,16 @@ module FinnhubRuby
|
|
3493
4539
|
form_params = opts[:form_params] || {}
|
3494
4540
|
|
3495
4541
|
# http body (model)
|
3496
|
-
post_body = opts[:
|
4542
|
+
post_body = opts[:debug_body]
|
3497
4543
|
|
3498
4544
|
# return_type
|
3499
|
-
return_type = opts[:
|
4545
|
+
return_type = opts[:debug_return_type] || 'EarningsCallTranscriptsList'
|
3500
4546
|
|
3501
4547
|
# auth_names
|
3502
|
-
auth_names = opts[:
|
4548
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
3503
4549
|
|
3504
4550
|
new_options = opts.merge(
|
4551
|
+
:operation => :"DefaultApi.transcripts_list",
|
3505
4552
|
:header_params => header_params,
|
3506
4553
|
:query_params => query_params,
|
3507
4554
|
:form_params => form_params,
|
@@ -3558,15 +4605,16 @@ module FinnhubRuby
|
|
3558
4605
|
form_params = opts[:form_params] || {}
|
3559
4606
|
|
3560
4607
|
# http body (model)
|
3561
|
-
post_body = opts[:
|
4608
|
+
post_body = opts[:debug_body]
|
3562
4609
|
|
3563
4610
|
# return_type
|
3564
|
-
return_type = opts[:
|
4611
|
+
return_type = opts[:debug_return_type] || 'Array<UpgradeDowngrade>'
|
3565
4612
|
|
3566
4613
|
# auth_names
|
3567
|
-
auth_names = opts[:
|
4614
|
+
auth_names = opts[:debug_auth_names] || ['api_key']
|
3568
4615
|
|
3569
4616
|
new_options = opts.merge(
|
4617
|
+
:operation => :"DefaultApi.upgrade_downgrade",
|
3570
4618
|
:header_params => header_params,
|
3571
4619
|
:query_params => query_params,
|
3572
4620
|
:form_params => form_params,
|