finnhub_ruby 1.1.16 → 1.1.18

data/docs/ETFProfileData.md

@@ -10,7 +10,7 @@
 | **aum** | **Float** | AUM. | [optional] |
 | **nav** | **Float** | NAV. | [optional] |
 | **nav_currency** | **String** | NAV currency. | [optional] |
-| **expense_ratio** | **Float** | Expense ratio. | [optional] |
+| **expense_ratio** | **Float** | Expense ratio. For non-US funds, this is the <a href=\"https://www.esma.europa.eu/sites/default/files/library/2015/11/09_1028_final_kid_ongoing_charges_methodology_for_publication_u_2_.pdf\" target=\"_blank\">KID ongoing charges<a/>. | [optional] |
 | **tracking_index** | **String** | Tracking Index. | [optional] |
 | **etf_company** | **String** | ETF issuer. | [optional] |
 | **domicile** | **String** | ETF domicile. | [optional] |
@@ -22,6 +22,9 @@
 | **price_to_book** | **Float** | P/B. | [optional] |
 | **avg_volume** | **Float** | 30-day average volume. | [optional] |
 | **description** | **String** | ETF's description. | [optional] |
+| **is_inverse** | **Boolean** | Whether the ETF is inverse | [optional] |
+| **is_leveraged** | **Boolean** | Whether the ETF is leveraged | [optional] |
+| **leverage_factor** | **Float** | Leverage factor. | [optional] |
 
 ## Example
 
@@ -46,7 +49,10 @@ instance = FinnhubRuby::ETFProfileData.new(
   price_to_earnings: null,
   price_to_book: null,
   avg_volume: null,
-  description: null
+  description: null,
+  is_inverse: null,
+  is_leveraged: null,
+  leverage_factor: null
 )
 ```
 

data/docs/InstitutionalOwnership.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::InstitutionalOwnership
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. | [optional] |
+| **cusip** | **String** | Cusip. | [optional] |
+| **data** | [**Array<InstitutionalOwnershipGroup>**](InstitutionalOwnershipGroup.md) | Array of institutional investors. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InstitutionalOwnership.new(
+  symbol: null,
+  cusip: null,
+  data: null
+)
+```
+

data/docs/InstitutionalOwnershipGroup.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::InstitutionalOwnershipGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **report_date** | **String** | Report date. | [optional] |
+| **ownership** | [**Array<InstitutionalOwnershipInfo>**](InstitutionalOwnershipInfo.md) | Array of institutional investors. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InstitutionalOwnershipGroup.new(
+  report_date: null,
+  ownership: null
+)
+```
+

data/docs/InstitutionalOwnershipInfo.md

@@ -0,0 +1,36 @@
+# FinnhubRuby::InstitutionalOwnershipInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cik** | **String** | Investor's company CIK. | [optional] |
+| **name** | **String** | Firm's name. | [optional] |
+| **put_call** | **String** | <code>put</code> or <code>call</code> for options. | [optional] |
+| **change** | **Float** | Number of shares change. | [optional] |
+| **no_voting** | **Float** | Number of shares with no voting rights. | [optional] |
+| **percentage** | **Float** | Percentage of portfolio. | [optional] |
+| **share** | **Float** | News score. | [optional] |
+| **shared_voting** | **Float** | Number of shares with shared voting rights. | [optional] |
+| **sole_voting** | **Float** | Number of shares with sole voting rights. | [optional] |
+| **value** | **Float** | Position value. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InstitutionalOwnershipInfo.new(
+  cik: null,
+  name: null,
+  put_call: null,
+  change: null,
+  no_voting: null,
+  percentage: null,
+  share: null,
+  shared_voting: null,
+  sole_voting: null,
+  value: null
+)
+```
+

data/docs/InstitutionalPortfolio.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::InstitutionalPortfolio
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Investor's name. | [optional] |
+| **cik** | **String** | CIK. | [optional] |
+| **data** | [**Array<InstitutionalPortfolioGroup>**](InstitutionalPortfolioGroup.md) | Array of positions. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InstitutionalPortfolio.new(
+  name: null,
+  cik: null,
+  data: null
+)
+```
+

data/docs/InstitutionalPortfolioGroup.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::InstitutionalPortfolioGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **report_date** | **String** | Report date. | [optional] |
+| **filing_date** | **String** | Filing date. | [optional] |
+| **portfolio** | [**Array<InstitutionalPortfolioInfo>**](InstitutionalPortfolioInfo.md) | Array of positions. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InstitutionalPortfolioGroup.new(
+  report_date: null,
+  filing_date: null,
+  portfolio: null
+)
+```
+

data/docs/InstitutionalPortfolioInfo.md

@@ -0,0 +1,38 @@
+# FinnhubRuby::InstitutionalPortfolioInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol. | [optional] |
+| **cusip** | **String** | CUSIP. | [optional] |
+| **name** | **String** | Position's name. | [optional] |
+| **put_call** | **String** | <code>put</code> or <code>call</code> for options. | [optional] |
+| **change** | **Float** | Number of shares change. | [optional] |
+| **no_voting** | **Float** | Number of shares with no voting rights. | [optional] |
+| **percentage** | **Float** | Percentage of portfolio. | [optional] |
+| **share** | **Float** | Number of shares. | [optional] |
+| **shared_voting** | **Float** | Number of shares with shared voting rights. | [optional] |
+| **sole_voting** | **Float** | Number of shares with sole voting rights. | [optional] |
+| **value** | **Float** | Position value. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InstitutionalPortfolioInfo.new(
+  symbol: null,
+  cusip: null,
+  name: null,
+  put_call: null,
+  change: null,
+  no_voting: null,
+  percentage: null,
+  share: null,
+  shared_voting: null,
+  sole_voting: null,
+  value: null
+)
+```
+

data/docs/InstitutionalProfile.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::InstitutionalProfile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cik** | **String** | CIK. | [optional] |
+| **data** | [**Array<InstitutionalProfileInfo>**](InstitutionalProfileInfo.md) | Array of investors. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InstitutionalProfile.new(
+  cik: null,
+  data: null
+)
+```
+

data/docs/InstitutionalProfileInfo.md

@@ -0,0 +1,28 @@
+# FinnhubRuby::InstitutionalProfileInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cik** | **String** | Investor's company CIK. | [optional] |
+| **firm_type** | **String** | Firm type. | [optional] |
+| **manager** | **String** | Manager. | [optional] |
+| **philosophy** | **String** | Investing philosophy. | [optional] |
+| **profile** | **String** | Profile info. | [optional] |
+| **profile_img** | **String** | Profile image. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::InstitutionalProfileInfo.new(
+  cik: null,
+  firm_type: null,
+  manager: null,
+  philosophy: null,
+  profile: null,
+  profile_img: null
+)
+```
+

data/docs/IsinChange.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::IsinChange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from_date** | **String** | From date. | [optional] |
+| **to_date** | **String** | To date. | [optional] |
+| **data** | [**Array<IsinChangeInfo>**](IsinChangeInfo.md) | Array of ISIN change events. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::IsinChange.new(
+  from_date: null,
+  to_date: null,
+  data: null
+)
+```
+

data/docs/IsinChangeInfo.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::IsinChangeInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **at_date** | **String** | Event's date. | [optional] |
+| **old_isin** | **String** | Old ISIN. | [optional] |
+| **new_isin** | **String** | New ISIN. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::IsinChangeInfo.new(
+  at_date: null,
+  old_isin: null,
+  new_isin: null
+)
+```
+

data/docs/KeyCustomersSuppliers.md

@@ -6,6 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **symbol** | **String** | Symbol | [optional] |
 | **name** | **String** | Name | [optional] |
+| **country** | **String** | Country | [optional] |
+| **industry** | **String** | Industry | [optional] |
 | **customer** | **Boolean** | Whether the company is a customer. | [optional] |
 | **supplier** | **Boolean** | Whether the company is a supplier | [optional] |
 | **one_month_correlation** | **Float** | 1-month price correlation | [optional] |
@@ -23,6 +25,8 @@ require 'finnhub_ruby'
 instance = FinnhubRuby::KeyCustomersSuppliers.new(
   symbol: null,
   name: null,
+  country: null,
+  industry: null,
   customer: null,
   supplier: null,
   one_month_correlation: null,

data/docs/MutualFundProfileData.md

@@ -29,6 +29,8 @@
 | **series_name** | **String** | Fund's series name. | [optional] |
 | **class_id** | **String** | Class ID. | [optional] |
 | **class_name** | **String** | Class name. | [optional] |
+| **sfdr_classification** | **String** | SFDR classification for EU funds. Under the new classifications, a fund's strategy will labeled under either Article 6, 8 or 9. Article 6 covers funds which do not integrate any kind of sustainability into the investment process. Article 8, also known as ‘environmental and socially promoting’, applies “… where a financial product promotes, among other characteristics, environmental or social characteristics, or a combination of those characteristics, provided that the companies in which the investments are made follow good governance practices.”. Article 9, also known as ‘products targeting sustainable investments’, covers products targeting bespoke sustainable investments and applies “… where a financial product has sustainable investment as its objective and an index has been designated as a reference benchmark.” | [optional] |
+| **currency** | **String** | Fund's currency | [optional] |
 
 ## Example
 
@@ -60,7 +62,9 @@ instance = FinnhubRuby::MutualFundProfileData.new(
   series_id: null,
   series_name: null,
   class_id: null,
-  class_name: null
+  class_name: null,
+  sfdr_classification: null,
+  currency: null
 )
 ```
 

data/docs/PriceMetrics.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::PriceMetrics
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | **String** | Symbol of the company. | [optional] |
+| **data** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::PriceMetrics.new(
+  symbol: null,
+  data: null
+)
+```
+

data/docs/SectorMetric.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::SectorMetric
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **region** | **String** | Region. | [optional] |
+| **data** | [**Array<SectorMetricData>**](SectorMetricData.md) | Metrics for each sector. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SectorMetric.new(
+  region: null,
+  data: null
+)
+```
+

data/docs/SectorMetricData.md

@@ -0,0 +1,20 @@
+# FinnhubRuby::SectorMetricData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sector** | **String** | Sector | [optional] |
+| **metrics** | **Object** | Metrics data in key-value format. <code>a</code> and <code>m</code> fields are for average and median respectively. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SectorMetricData.new(
+  sector: null,
+  metrics: null
+)
+```
+

data/docs/SymbolChange.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::SymbolChange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from_date** | **String** | From date. | [optional] |
+| **to_date** | **String** | To date. | [optional] |
+| **data** | [**Array<SymbolChangeInfo>**](SymbolChangeInfo.md) | Array of symbol change events. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SymbolChange.new(
+  from_date: null,
+  to_date: null,
+  data: null
+)
+```
+

data/docs/SymbolChangeInfo.md

@@ -0,0 +1,22 @@
+# FinnhubRuby::SymbolChangeInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **at_date** | **String** | Event's date. | [optional] |
+| **old_symbol** | **String** | Old symbol. | [optional] |
+| **new_symbol** | **String** | New symbol. | [optional] |
+
+## Example
+
+```ruby
+require 'finnhub_ruby'
+
+instance = FinnhubRuby::SymbolChangeInfo.new(
+  at_date: null,
+  old_symbol: null,
+  new_symbol: null
+)
+```
+