finnhub_ruby 1.0.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aef01f3634e7cf621ee5bcea3c31fd2049b4efeb8c4d6a80ddc428430d8306a
-  data.tar.gz: b85bb66c1b1170fbe30e99a5830317c93c80c2fb87f116853ab9c3d1c2d75b1d
+  metadata.gz: 03b4f036da13874d02dce82fe8620103e5ddc8434cac7380fee5a1ab6ead4ee1
+  data.tar.gz: f8cd880646d1b79a97b18007bc1dde08f7cad20efd1f2a61cf8327e2e409c294
 SHA512:
-  metadata.gz: f5263a56242b92564d833ddeb3334505df9641646bf85c89138406448e131c3a257e0d34c3874c23eb04e97bdba8207f6e36bd0d27046a8aaec984fd455ce40c
-  data.tar.gz: 26766f7539395a439c3d39c2c0baf406d90388460f8c7e1d857cb4cd878e88026139fea33d41bfe954abd5541b327bd9cfe8f31e5b6e71953867cdf5181625dd
+  metadata.gz: 30846c760b942085a9f6b825792a02d9f8edf0561ac30bb786d493bf3d030947deaf3433c92fd3d431cd205b510079c8a42413b91c960af1a169b397768c86d4
+  data.tar.gz: 81e20e75a2cadd5da24782ac1b60b9542622be78e536a922b794d8643b67310c9e0c559ccacb28db4015281f5dc2c485c140395c5b70af24ce7929083c54a552

data/README.md

@@ -1,9 +1,10 @@
 # finnhub-python
 - API documentation: https://finnhub.io/docs/api
 - API version: 1.0.0
-- Package version: 1.0.0
+- Package version: 1.1.2
 
 ## Installation
+https://rubygems.org/gems/finnhub_ruby
 
 ```sh
 gem install finnhub_ruby
@@ -12,7 +13,7 @@ gem install finnhub_ruby
 or in your Gemfile
 
 ```ruby
-gem 'finnhub_ruby', '~> 1.0.0'
+gem 'finnhub_ruby', '~> 1.1.2'
 ```
 
 ## Getting Started
@@ -157,6 +158,24 @@ puts(finnhub_client.stock_tick_with_http_info('AAPL', '2020-03-25', 500, 0))
 
 # Technical Indicator
 puts(finnhub_client.technical_indicator("AAPL", 'D', 1583098857, 1584308457, 'rsi', {"timeperiod": 3}))
+
+# Indices Constituents
+puts(finnhub_client.indices_constituents("^GSPC"))
+
+# Indices Historical Constituents
+puts(finnhub_client.indices_historical_constituents("^GSPC"))
+
+# ETFs Profile
+puts(finnhub_client.etfs_profile('SPY'))
+
+# ETFs Holdings
+puts(finnhub_client.etfs_holdings('SPY'))
+
+# ETFs Industry Exposure
+puts(finnhub_client.etfs_industry_exposure('SPY'))
+
+# ETFs Country Exposure
+puts(finnhub_client.etfs_country_exposure('SPY'))
 ```
 
 ## License

data/docs/CompanyProfile.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **country** | **String** | Country of company's headquarter. | [optional] 
 **currency** | **String** | Currency used in company filings. | [optional] 
 **cusip** | **String** | CUSIP number. | [optional] 
-**sedol** | **Integer** | Sedol number. | [optional] 
+**sedol** | **String** | Sedol number. | [optional] 
 **description** | **String** | Company business summary. | [optional] 
 **exchange** | **String** | Listed exchange. | [optional] 
 **ggroup** | **String** | GICS industry group. | [optional] 

data/docs/DefaultApi.md

@@ -22,6 +22,10 @@ Method | HTTP request | Description
 [**earnings_calendar**](DefaultApi.md#earnings_calendar) | **GET** /calendar/earnings | Earnings Calendar
 [**economic_code**](DefaultApi.md#economic_code) | **GET** /economic/code | Economic Code
 [**economic_data**](DefaultApi.md#economic_data) | **GET** /economic | Economic Data
+[**etfs_country_exposure**](DefaultApi.md#etfs_country_exposure) | **GET** /etf/country | ETFs Country Exposure
+[**etfs_holdings**](DefaultApi.md#etfs_holdings) | **GET** /etf/holdings | ETFs Holdings
+[**etfs_industry_exposure**](DefaultApi.md#etfs_industry_exposure) | **GET** /etf/sector | ETFs Industry Exposure
+[**etfs_profile**](DefaultApi.md#etfs_profile) | **GET** /etf/profile | ETFs Profile
 [**filings**](DefaultApi.md#filings) | **GET** /stock/filings | Filings
 [**financials**](DefaultApi.md#financials) | **GET** /stock/financials | Financial Statements
 [**financials_reported**](DefaultApi.md#financials_reported) | **GET** /stock/financials-reported | Financials As Reported
@@ -31,6 +35,8 @@ Method | HTTP request | Description
 [**forex_symbols**](DefaultApi.md#forex_symbols) | **GET** /forex/symbol | Forex Symbol
 [**fund_ownership**](DefaultApi.md#fund_ownership) | **GET** /stock/fund-ownership | Fund Ownership
 [**general_news**](DefaultApi.md#general_news) | **GET** /news | General News
+[**indices_constituents**](DefaultApi.md#indices_constituents) | **GET** /index/constituents | Indices Constituents
+[**indices_historical_constituents**](DefaultApi.md#indices_historical_constituents) | **GET** /index/historical-constituents | Indices Historical Constituents
 [**investors_ownership**](DefaultApi.md#investors_ownership) | **GET** /stock/investor-ownership | Investors Ownership
 [**ipo_calendar**](DefaultApi.md#ipo_calendar) | **GET** /calendar/ipo | IPO Calendar
 [**major_developments**](DefaultApi.md#major_developments) | **GET** /major-development | Major Developments
@@ -39,6 +45,7 @@ Method | HTTP request | Description
 [**price_target**](DefaultApi.md#price_target) | **GET** /stock/price-target | Price Target
 [**quote**](DefaultApi.md#quote) | **GET** /quote | Quote
 [**recommendation_trends**](DefaultApi.md#recommendation_trends) | **GET** /stock/recommendation | Recommendation Trends
+[**similarity_index**](DefaultApi.md#similarity_index) | **GET** /stock/similarity-index | Similarity Index
 [**stock_bidask**](DefaultApi.md#stock_bidask) | **GET** /stock/bidask | Last Bid-Ask
 [**stock_candles**](DefaultApi.md#stock_candles) | **GET** /stock/candle | Stock Candles
 [**stock_dividends**](DefaultApi.md#stock_dividends) | **GET** /stock/dividend | Dividends
@@ -915,7 +922,7 @@ opts = {
   from: Date.parse('2013-10-20'), # Date | From date: 2020-03-15.
   to: Date.parse('2013-10-20'), # Date | To date: 2020-03-16.
   symbol: 'symbol_example', # String | Filter by symbol: AAPL.
-  international: FinnhubRuby::AnyType.new # AnyType | Set to <code>true</code> to include international markets. Default value is <code>false</code>
+  international: true # Boolean | Set to <code>true</code> to include international markets. Default value is <code>false</code>
 }
 
 begin
@@ -935,7 +942,7 @@ Name | Type | Description  | Notes
  **from** | **Date**| From date: 2020-03-15. | [optional] 
  **to** | **Date**| To date: 2020-03-16. | [optional] 
  **symbol** | **String**| Filter by symbol: AAPL. | [optional] 
- **international** | [**AnyType**](.md)| Set to &lt;code&gt;true&lt;/code&gt; to include international markets. Default value is &lt;code&gt;false&lt;/code&gt; | [optional] 
+ **international** | **Boolean**| Set to &lt;code&gt;true&lt;/code&gt; to include international markets. Default value is &lt;code&gt;false&lt;/code&gt; | [optional] 
 
 ### Return type
 
@@ -1055,6 +1062,222 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## etfs_country_exposure
+
+> ETFsCountryExposure etfs_country_exposure(symbol)
+
+ETFs Country Exposure
+
+Get ETF country exposure data.
+
+### Example
+
+```ruby
+# load the gem
+require 'finnhub_ruby'
+# setup authorization
+FinnhubRuby.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['token'] = 'Bearer'
+end
+
+api_instance = FinnhubRuby::DefaultApi.new
+symbol = 'symbol_example' # String | ETF symbol.
+
+begin
+  #ETFs Country Exposure
+  result = api_instance.etfs_country_exposure(symbol)
+  p result
+rescue FinnhubRuby::ApiError => e
+  puts "Exception when calling DefaultApi->etfs_country_exposure: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **symbol** | **String**| ETF symbol. | 
+
+### Return type
+
+[**ETFsCountryExposure**](ETFsCountryExposure.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## etfs_holdings
+
+> ETFsHoldings etfs_holdings(symbol)
+
+ETFs Holdings
+
+Get current ETF holdings.
+
+### Example
+
+```ruby
+# load the gem
+require 'finnhub_ruby'
+# setup authorization
+FinnhubRuby.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['token'] = 'Bearer'
+end
+
+api_instance = FinnhubRuby::DefaultApi.new
+symbol = 'symbol_example' # String | ETF symbol.
+
+begin
+  #ETFs Holdings
+  result = api_instance.etfs_holdings(symbol)
+  p result
+rescue FinnhubRuby::ApiError => e
+  puts "Exception when calling DefaultApi->etfs_holdings: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **symbol** | **String**| ETF symbol. | 
+
+### Return type
+
+[**ETFsHoldings**](ETFsHoldings.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## etfs_industry_exposure
+
+> ETFsIndustryExposure etfs_industry_exposure(symbol)
+
+ETFs Industry Exposure
+
+Get ETF industry exposure data.
+
+### Example
+
+```ruby
+# load the gem
+require 'finnhub_ruby'
+# setup authorization
+FinnhubRuby.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['token'] = 'Bearer'
+end
+
+api_instance = FinnhubRuby::DefaultApi.new
+symbol = 'symbol_example' # String | ETF symbol.
+
+begin
+  #ETFs Industry Exposure
+  result = api_instance.etfs_industry_exposure(symbol)
+  p result
+rescue FinnhubRuby::ApiError => e
+  puts "Exception when calling DefaultApi->etfs_industry_exposure: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **symbol** | **String**| ETF symbol. | 
+
+### Return type
+
+[**ETFsIndustryExposure**](ETFsIndustryExposure.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## etfs_profile
+
+> ETFsProfile etfs_profile(symbol)
+
+ETFs Profile
+
+Get ETF profile information. Currently support all US ETFs.
+
+### Example
+
+```ruby
+# load the gem
+require 'finnhub_ruby'
+# setup authorization
+FinnhubRuby.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['token'] = 'Bearer'
+end
+
+api_instance = FinnhubRuby::DefaultApi.new
+symbol = 'symbol_example' # String | ETF symbol.
+
+begin
+  #ETFs Profile
+  result = api_instance.etfs_profile(symbol)
+  p result
+rescue FinnhubRuby::ApiError => e
+  puts "Exception when calling DefaultApi->etfs_profile: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **symbol** | **String**| ETF symbol. | 
+
+### Return type
+
+[**ETFsProfile**](ETFsProfile.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## filings
 
 > Array&lt;Filing&gt; filings(opts)
@@ -1577,6 +1800,114 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## indices_constituents
+
+> IndicesConstituents indices_constituents(symbol)
+
+Indices Constituents
+
+Get a list of index's constituents. Currently support <code>^GSPC (S&P 500)</code>, <code>^NDX (Nasdaq 100)</code>, <code>^DJI (Dow Jones)</code>
+
+### Example
+
+```ruby
+# load the gem
+require 'finnhub_ruby'
+# setup authorization
+FinnhubRuby.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['token'] = 'Bearer'
+end
+
+api_instance = FinnhubRuby::DefaultApi.new
+symbol = 'symbol_example' # String | symbol
+
+begin
+  #Indices Constituents
+  result = api_instance.indices_constituents(symbol)
+  p result
+rescue FinnhubRuby::ApiError => e
+  puts "Exception when calling DefaultApi->indices_constituents: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **symbol** | **String**| symbol | 
+
+### Return type
+
+[**IndicesConstituents**](IndicesConstituents.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## indices_historical_constituents
+
+> IndicesHistoricalConstituents indices_historical_constituents(symbol)
+
+Indices Historical Constituents
+
+Get full history of index's constituents including symbols and dates of joining and leaving the Index. Currently support <code>^GSPC (S&P 500)</code>, <code>^NDX (Nasdaq 100)</code>, <code>^DJI (Dow Jones)</code>
+
+### Example
+
+```ruby
+# load the gem
+require 'finnhub_ruby'
+# setup authorization
+FinnhubRuby.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['token'] = 'Bearer'
+end
+
+api_instance = FinnhubRuby::DefaultApi.new
+symbol = 'symbol_example' # String | symbol
+
+begin
+  #Indices Historical Constituents
+  result = api_instance.indices_historical_constituents(symbol)
+  p result
+rescue FinnhubRuby::ApiError => e
+  puts "Exception when calling DefaultApi->indices_historical_constituents: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **symbol** | **String**| symbol | 
+
+### Return type
+
+[**IndicesHistoricalConstituents**](IndicesHistoricalConstituents.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## investors_ownership
 
 > InvestorsOwnership investors_ownership(symbol, opts)
@@ -2023,6 +2354,66 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## similarity_index
+
+> SimilarityIndex similarity_index(opts)
+
+Similarity Index
+
+<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>
+
+### Example
+
+```ruby
+# load the gem
+require 'finnhub_ruby'
+# setup authorization
+FinnhubRuby.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['token'] = 'Bearer'
+end
+
+api_instance = FinnhubRuby::DefaultApi.new
+opts = {
+  symbol: 'symbol_example', # String | Symbol. Required if cik is empty
+  cik: 'cik_example', # String | CIK. Required if symbol is empty
+  freq: 'freq_example' # String | <code>annual</code> or <code>quarterly</code>. Default to <code>annual</code>
+}
+
+begin
+  #Similarity Index
+  result = api_instance.similarity_index(opts)
+  p result
+rescue FinnhubRuby::ApiError => e
+  puts "Exception when calling DefaultApi->similarity_index: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **symbol** | **String**| Symbol. Required if cik is empty | [optional] 
+ **cik** | **String**| CIK. Required if symbol is empty | [optional] 
+ **freq** | **String**| &lt;code&gt;annual&lt;/code&gt; or &lt;code&gt;quarterly&lt;/code&gt;. Default to &lt;code&gt;annual&lt;/code&gt; | [optional] 
+
+### Return type
+
+[**SimilarityIndex**](SimilarityIndex.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## stock_bidask
 
 > LastBidAsk stock_bidask(symbol)
@@ -2263,7 +2654,7 @@ Name | Type | Description  | Notes
 
 Stock Symbol
 
-List supported stocks.
+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>.
 
 ### Example