RubyGems - intrinio-sdk - Versions diffs - 5.3.0 → 5.6.3 - Mend

intrinio-sdk 5.3.0 → 5.6.3

Files changed (492) hide show

@@ -54,21 +54,15 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 dataPoint_api = Intrinio::DataPointApi.new
+identifier = "AAPL"
+tag = "marketcap"
-identifier = "AAPL" # String | An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
-tag = "marketcap" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
-begin
-  result = dataPoint_api.get_data_point_number(identifier, tag)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling DataPointApi->get_data_point_number: #{e}"
-end
+result = dataPoint_api.get_data_point_number(identifier, tag)
+pp result
 ```
 [//]: # (END_CODE_EXAMPLE)
@@ -139,21 +133,15 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 dataPoint_api = Intrinio::DataPointApi.new
+identifier = "AAPL"
+tag = "ceo"
-identifier = "AAPL" # String | An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
-tag = "ceo" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
-begin
-  result = dataPoint_api.get_data_point_text(identifier, tag)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling DataPointApi->get_data_point_text: #{e}"
-end
+result = dataPoint_api.get_data_point_text(identifier, tag)
+pp result
 ```
 [//]: # (END_CODE_EXAMPLE)

data/docs/DataTagApi.md CHANGED

@@ -55,26 +55,23 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 dataTag_api = Intrinio::DataTagApi.new
-opts = {
-  tag: nil, # String | Tag
-  type: nil, # String | Type
-  parent: nil, # String | ID of tag parent
-  statement_code: "income_statement", # String | Statement Code
-  fs_template: "industrial", # String | Template
-  page_size: 100, # Integer | The number of results to return
-  next_page: nil # String | Gets the next page of data from a previous API call
+opts = {
+  tag: nil,
+  type: nil,
+  parent: nil,
+  statement_code: "income_statement",
+  fs_template: "industrial",
+  page_size: 100,
+  next_page: nil
 }
-begin
-  result = dataTag_api.get_all_data_tags(opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling DataTagApi->get_all_data_tags: #{e}"
-end
+result = dataTag_api.get_all_data_tags(opts)
+pp result
 ```
 [//]: # (END_CODE_EXAMPLE)
@@ -150,19 +147,14 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 dataTag_api = Intrinio::DataTagApi.new
+identifier = "marketcap"
-identifier = "marketcap" # String | The Intrinio ID or the code-name of the Data Tag
-begin
-  result = dataTag_api.get_data_tag_by_id(identifier)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling DataTagApi->get_data_tag_by_id: #{e}"
-end
+result = dataTag_api.get_data_tag_by_id(identifier)
+pp result
 ```
 [//]: # (END_CODE_EXAMPLE)
@@ -232,22 +224,18 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 dataTag_api = Intrinio::DataTagApi.new
+query = "revenue"
-query = "revenue" # String |
-opts = {
-  page_size: 100 # Integer | The number of results to return
+opts = {
+  page_size: 100
 }
-begin
-  result = dataTag_api.search_data_tags(query, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling DataTagApi->search_data_tags: #{e}"
-end
+result = dataTag_api.search_data_tags(query, opts)
+pp result
 ```
 [//]: # (END_CODE_EXAMPLE)

data/docs/ETF.md ADDED

@@ -0,0 +1,138 @@
+[//]: # (CLASS:Intrinio::ETF)
+[//]: # (KIND:object)
+### Intrinio::ETF
+#### Properties
+[//]: # (START_DEFINITION)
+Name | Type | Description
+------------ | ------------- | -------------
+**id** | String | The Intrinio ID of the ETF &nbsp;
+**name** | String | The common name of the ETF &nbsp;
+**ticker** | String | The common ticker symbol for the ETF &nbsp;
+**figi_ticker** | String | The OpenFIGI ticker for the ETF &nbsp;
+**ric** | String | Reuters Instrument Code (RIC) for the ETF &nbsp;
+**isin** | String | International Securities Identification Number (ISIN) for the ETF &nbsp;
+**sedol** | String | Stock Exchange Daily Official List (SEDOL) for the ETF &nbsp;
+**exchange_mic** | String | The exchange Market Identifier Code (MIC) from the International Standards Organization (ISO) &nbsp;
+**sponsor** | String | The fund manager (ETF) or issuing bank (ETN) &nbsp;
+**type** | String | High-level classification for the ETF based on its intended investment objective &nbsp;
+**description** | String | The ETF description as published by the ETF sponsor &nbsp;
+**inception_date** | Date | Inception Date for the ETF as published by the ETF sponsor &nbsp;
+**data_change_date** | Date | The last date on which there was a change in a classifications data field for this ETF &nbsp;
+**close_date** | Date | The date on which this ETF was de-listed if it is no longer listed &nbsp;
+**is_live_listed** | BOOLEAN | If true, the ETF is still listed on an exchange; if false, the ETF is no longer listed &nbsp;
+**legal_structure** | String | The legal structure as defined in the prospectus &nbsp;
+**intraday_nav_ticker** | String | Intra-day NAV ticker for the Exchange Traded Fund (ETF) &nbsp;
+**primary_ticker** | String | The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes &nbsp;
+**primary_ticker_country_code** | String | 2 letter ISO country code for the country of the primary listing &nbsp;
+**primary_listing_region** | String | Geographic region in the country of the primary listing falls &nbsp;
+**net_expense_ratio** | Float | Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF Sponsor &nbsp;
+**asset_class** | String | Captures the underlying nature of the securities in the Exchanged Traded Product (ETP) &nbsp;
+**other_asset_types** | String | If &#39;asset_class&#39; field is classified as &#39;Other Asset Types&#39; this field captures the specific category of the underlying assets &nbsp;
+**market_cap_range** | String | Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus.  Examples (&#39;Mega Cap&#39;, &#39;Large Cap&#39;, &#39;Mid Cap&#39;, etc.) &nbsp;
+**holds_only_nyse_stocks** | BOOLEAN | If true, the ETF is an equity ETF and holds only stocks listed on NYSE &nbsp;
+**holds_only_nasdaq_stocks** | BOOLEAN | If false, the ETF is an equity ETF and holds only stocks listed on Nasdaq &nbsp;
+**growth_value_tilt** | String | Classifies equity ETFs as either &#39;Growth&#39; or Value&#39; based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as &#39;Core / Blend&#39; &nbsp;
+**growth_type** | String | For ETFs that are classified as &#39;Growth&#39; in &#39;growth_value_tilt&#39;, this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores &nbsp;
+**value_type** | String | For ETFs that are classified as &#39;Value&#39; in &#39;growth_value_tilt&#39;, this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores &nbsp;
+**sector** | String | For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to &nbsp;
+**industry** | String | For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to. &nbsp;
+**sub_industry** | String | For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-industry that it provides the exposure to &nbsp;
+**cross_sector_theme** | String | For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme.  Examples (&#39;Agri-business&#39;, &#39;Natural Resources&#39;, &#39;Green Investing&#39;, etc.) &nbsp;
+**natural_resources_type** | String | For ETFs that are classified as &#39;Natural Resources&#39; in the &#39;cross_sector_theme&#39; field, this field provides further detail on the type of Natural Resources exposure. &nbsp;
+**excludes_financials** | BOOLEAN | For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective &nbsp;
+**excludes_technology** | BOOLEAN | For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective &nbsp;
+**us_or_excludes_us** | String | Takes the value of &#39;Domestic&#39; for US exposure, &#39;International&#39; for non-US exposure and &#39;Global&#39; for exposure that includes all regions including the US &nbsp;
+**developed_emerging** | String | This field identifies the stage of development of the markets that the ETF provides exposure to &nbsp;
+**specialized_region** | String | This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping.  Examples (&#39;BRIC&#39;, &#39;Chindia&#39;, etc.) &nbsp;
+**continent** | String | This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent &nbsp;
+**latin_america_sub_group** | String | For ETFs that are classified as &#39;Latin America&#39; in the &#39;continent&#39; field, this field provides further detail on the type of regional exposure &nbsp;
+**europe_sub_group** | String | For ETFs that are classified as &#39;Europe&#39; in the &#39;continent&#39; field, this field provides further detail on the type of regional exposure &nbsp;
+**asia_sub_group** | String | For ETFs that are classified as &#39;Asia&#39; in the &#39;continent&#39; field, this field provides further detail on the type of regional exposure &nbsp;
+**specific_country** | String | This field is populated if the ETF provides targeted exposure to a specific country &nbsp;
+**china_listing_location** | String | For ETFs that are classified as &#39;China&#39; in the &#39;country&#39; field, this field provides further detail on the type of exposure in the underlying securities &nbsp;
+**us_state** | String | Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies operating in a specific state in the US &nbsp;
+**real_estate** | String | For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market &nbsp;
+**index_weighting_scheme** | String | For ETFs that track an underlying index, this field provides detail on the index weighting type &nbsp;
+**market_cap_weighting_type** | String | For ETFs that take the value &#39;Market Cap Weighted&#39; in the &#39;index_weighting_scheme&#39; field, this field provides detail on the market cap weighting type &nbsp;
+**fundamental_weighting_type** | String | For ETFs that take the value ‘Fundamental Weighted’ in the &#39;index_weighting_scheme&#39; field, this field provides detail on the fundamental weighting methodology &nbsp;
+**dividend_weighting_type** | String | For ETFs that take the value &#39;Dividend Weighted&#39; in the &#39;index_weighting_scheme&#39; field, this field provides detail on the dividend weighting methodology &nbsp;
+**bond_type** | String | For ETFs where &#39;asset_class_type&#39; is &#39;Bonds&#39;, this field provides detail on the type of bonds held in the ETF &nbsp;
+**government_bond_types** | String | For bond ETFs that take the value &#39;Treasury &amp; Government&#39; in &#39;bond_type&#39;, this field provides detail on the exposure &nbsp;
+**municipal_bond_region** | String | For bond ETFs that take the value &#39;Municipal&#39; in &#39;bond_type&#39;, this field provides additional detail on the geographic exposure &nbsp;
+**municipal_vrdo** | BOOLEAN | For bond ETFs that take the value &#39;Municipal&#39; in &#39;bond_type&#39;, this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations &nbsp;
+**mortgage_bond_types** | String | For bond ETFs that take the value &#39;Mortgage&#39; in &#39;bond_type&#39;, this field provides additional detail on the type of underlying securities &nbsp;
+**bond_tax_status** | String | For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities &nbsp;
+**credit_quality** | String | For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range &nbsp;
+**average_maturity** | String | For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range &nbsp;
+**specific_maturity_year** | Integer | For all bond ETFs that take the value &#39;Specific Maturity Year&#39; in the &#39;average_maturity&#39; field, this field specifies the calendar year &nbsp;
+**bond_currency_denomination** | String | For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities &nbsp;
+**laddered** | BOOLEAN | For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure &nbsp;
+**zero_coupon** | BOOLEAN | For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills &nbsp;
+**floating_rate** | BOOLEAN | For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds &nbsp;
+**build_america_bonds** | BOOLEAN | For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds &nbsp;
+**commodity_types** | String | For ETFs where &#39;asset_class_type&#39; is &#39;Commodities&#39;, this field provides detail on the type of commodities held in the ETF &nbsp;
+**energy_type** | String | For ETFs where &#39;commodity_type&#39; is &#39;Energy&#39;, this field provides detail on the type of energy exposure provided by the ETF &nbsp;
+**agricultural_type** | String | For ETFs where &#39;commodity_type&#39; is &#39;Agricultural&#39;, this field provides detail on the type of agricultural exposure provided by the ETF &nbsp;
+**metal_type** | String | For ETFs where &#39;commodity_type&#39; is &#39;Gold &amp; Metals&#39;, this field provides detail on the type of exposure provided by the ETF &nbsp;
+**inverse_leveraged** | String | This field is populated if the ETF provides inverse or leveraged exposure &nbsp;
+**target_date_multi_asset_type** | String | For ETFs where &#39;asset_class_type&#39; is &#39;Target Date / MultiAsset&#39;, this field provides detail on the type of commodities held in the ETF &nbsp;
+**currency_hedged** | BOOLEAN | This field is populated if the ETF’s strategy involves hedging currency exposure &nbsp;
+**currency_pair** | String | This field is populated if the ETF’s strategy involves providing exposure to the movements of a currency or involves hedging currency exposure &nbsp;
+**social_environmental_type** | String | This field is populated if the ETF’s strategy involves providing exposure to a specific social or environmental theme &nbsp;
+**clean_energy_type** | String | This field is populated if the ETF has a value of &#39;Clean Energy&#39; in the &#39;social_environmental_type&#39; field. &nbsp;
+**dividend_type** | String | This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus &nbsp;
+**regular_dividend_payor_type** | String | This field is populated if the ETF has a value of &#39;Dividend – Regular Payors&#39; in the &#39;dividend_type&#39; field &nbsp;
+**holds_ml_ps** | BOOLEAN | If true, the ETF’s investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy &nbsp;
+**holds_preferred_stock** | BOOLEAN | If true, the ETF’s investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy &nbsp;
+**holds_closed_end_funds** | BOOLEAN | IF true, if the ETF’s investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy &nbsp;
+**quant_strategies_type** | String | This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy &nbsp;
+**other_quant_models** | String | For ETFs where &#39;quant_strategies_type&#39; is &#39;Other Quant Model&#39;, this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF &nbsp;
+**hedge_fund_type** | String | For ETFs where &#39;other_asset_types&#39; is &#39;Hedge Fund Replication&#39;, this field provides detail on the type of hedge fund replication strategy &nbsp;
+**derivatives_based** | String | This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio &nbsp;
+**holds_ad_rs** | BOOLEAN | If true, he ETF’s investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy &nbsp;
+**index_linked** | String | This field identifies whether an ETF is index linked or active &nbsp;
+**includes_short_exposure** | BOOLEAN | This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF &nbsp;
+**index_name** | String | This field identifies the name of the underlying index tracked by the ETF, if applicable &nbsp;
+**parent_index** | String | This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable &nbsp;
+**index_family** | String | This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider &nbsp;
+**broader_index_family** | String | This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider &nbsp;
+**index_provider** | String | This field identifies the Index provider for the index underlying the ETF, if applicable &nbsp;
+**fund_family** | String | This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor &nbsp;
+**index_ticker** | String | This field identifies the OpenFIGI ticker for the Index underlying the ETF &nbsp;
+**etn_issuing_bank** | String | If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank &nbsp;
+**etn_maturity_date** | Date | If the product is an ETN, this field identifies the maturity date for the ETN &nbsp;
+**livestock** | String | For ETFs where &#39;commodity_type&#39; is &#39;Livestock&#39;, this field provides detail on the type of livestock exposure provided by the ETF &nbsp;
+**dynamic_futures_roll** | BOOLEAN | If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs &nbsp;
+**index_provider_code** | String | This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable &nbsp;
+**single_category_designation** | String | This categorization is created for those users who want every ETF to be ‘forced’ into a single bucket, so that the assets for all categories will always sum to the total market &nbsp;
+**registered_countries** | String | The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe &nbsp;
+**issuing_entity_country_code** | String | The name of the legal entity that issued the Exchange Traded Product (ETP) &nbsp;
+**ucits** | BOOLEAN | If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant &nbsp;
+**replication_structure** | String | The replication structure of the Exchange Traded Product (ETP) &nbsp;
+**domicile** | String | 2 letter ISO country code for the country where the ETP is domiciled &nbsp;
+**base_currency** | String | Base currency of the Exchange Traded Product (ETP) in which the net asset value (NAV) is calculated. Reported using the 3-digit ISO currency code &nbsp;
+**listing_currency** | String | Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code &nbsp;
+**fund_listing_date** | Date | The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange &nbsp;
+**listing_country_code** | String | 2 letter ISO country code for the country where the Exchange Traded Product (ETP) is listed &nbsp;
+**listing_region** | String | The region in which this specific ETF is listed &nbsp;
+**smartvs_traditional_beta** | String | This field identifies whether an ETF provides &#39;Traditional&#39; beta exposure or &#39;Smart&#39; beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don’t provide indexed exposure to a targeted factor) are classified separately &nbsp;
+**smartvs_traditional_beta_level2** | String | This field provides further detail within the traditional and smart beta categories &nbsp;
+**income_category** | String | Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income &nbsp;
+**etp_structure_type** | String | Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure &nbsp;
+**month_end_assets** | Float | Net assets in millions of dollars as of the most recent month end &nbsp;
+**etf_portfolio_turnover** | Float | The percentage of positions turned over in the last 12 months &nbsp;
+**firstbridge_id** | String | The FirstBridge unique identifier for the Exchange Traded Fund (ETF) &nbsp;
+**firstbridge_parent_id** | String | The FirstBridge unique identifier of the parent Exchange Traded Fund (ETF), if applicable &nbsp;
+**number_of_holdings** | Integer | The number of holdings for this Exchange Traded Fund (ETF) &nbsp;
+[//]: # (END_DEFINITION)

data/docs/ETFAnalytics.md ADDED

@@ -0,0 +1,31 @@
+[//]: # (CLASS:Intrinio::ETFAnalytics)
+[//]: # (KIND:object)
+### Intrinio::ETFAnalytics
+#### Properties
+[//]: # (START_DEFINITION)
+Name | Type | Description
+------------ | ------------- | -------------
+**fifty_two_week_high** | Float | Highest trading price for the security in the preceding 52 weeks &nbsp;
+**fifty_two_week_low** | Float | Lowest trading price for the security in the preceding 52 weeks &nbsp;
+**volume_traded** | Float | The total quantity of shares traded on the latest trading day &nbsp;
+**average_daily_volume_one_month** | Float | The average quantity of shares traded per day for the last month &nbsp;
+**average_daily_volume_three_month** | Float | The average quantity of shares traded per day for the last three months &nbsp;
+**average_daily_volume_six_month** | Float | The average quantity of shares traded per day for the last six months &nbsp;
+**market_cap** | Float | The market capitalization for the Exchange Traded Fund (ETF) &nbsp;
+**shares_outstanding** | Float | The number of shares outstanding for the Exchange Traded Fund (ETF) &nbsp;
+**etf** | [**ETFSummary**](ETFSummary.md) |  &nbsp;
+[//]: # (END_DEFINITION)
+[//]: # (CONTAINED_CLASS:Intrinio::ETFSummary)

data/docs/ETFHolding.md ADDED

@@ -0,0 +1,37 @@
+[//]: # (CLASS:Intrinio::ETFHolding)
+[//]: # (KIND:object)
+### Intrinio::ETFHolding
+#### Properties
+[//]: # (START_DEFINITION)
+Name | Type | Description
+------------ | ------------- | -------------
+**as_of_date** | Date | The date on which the holding and their weights correspond &nbsp;
+**name** | String | The common name for the holding &nbsp;
+**ticker** | String | The common exchange ticker for the holding &nbsp;
+**type** | String | The type of instrument for this holding.  Examples (Bond &#x3D; &#39;BOND&#39;, Equity &#x3D; &#39;EQUI&#39;, Options &#x3D; &#39;OPTN&#39;) &nbsp;
+**composite_figi** | String | The OpenFIGI ticker for the holding &nbsp;
+**isin** | String | International Securities Identification Number (ISIN) for the holding &nbsp;
+**ric** | String | Reuters Instrument Code (RIC) for the holding &nbsp;
+**sedol** | String | Stock Exchange Daily Official List (SEDOL) for the holding &nbsp;
+**face** | Float | Face value of the debt security, if available &nbsp;
+**coupon** | Float | Coupon rate of the debt security, if available &nbsp;
+**market_value_held** | Float | The market value of this holding in the ETF as of the &#x60;as_of_date&#x60; &nbsp;
+**notional_value** | Float | Notional value of derivatives contracts held in the Exchange Traded Fund (ETF) or Exchange Traded Note (ETN) &nbsp;
+**maturity** | Date | Maturity date for the debt security, if available &nbsp;
+**quantity_held** | Float | Number of units of the security held if available &nbsp;
+**weighting** | Float | Fraction of the funds market value held &nbsp;
+**quantity_units** | Float | The unit of the &#x60;quanity_held&#x60; field. Examples (&#39;oz&#39;, &#39;shares&#39;, &#39;contracts&#39;) &nbsp;
+**quantity_per_share** | Float | Number of units of the security held per units of shares outstanding of the Exchange Traded Fund (ETF), if available &nbsp;
+**contract_expiry_date** | Date | Expiry date for the futures contract held in the Exchange Traded Fund (ETF) or Exchange Traded Note (ETN) &nbsp;
+[//]: # (END_DEFINITION)

data/docs/ETFStats.md ADDED

@@ -0,0 +1,53 @@
+[//]: # (CLASS:Intrinio::ETFStats)
+[//]: # (KIND:object)
+### Intrinio::ETFStats
+#### Properties
+[//]: # (START_DEFINITION)
+Name | Type | Description
+------------ | ------------- | -------------
+**date** | Date |  &nbsp;
+**net_asset_value** | Float | The net asset value (NAV &#x3D; Total Assets - Total Liabilities) &nbsp;
+**beta_vs_spy** | Float | Volatility this ETF is versus the SPY ETF &nbsp;
+**trailing_one_month_return_split_and_dividend** | Float | Trailing one month return including dividends &nbsp;
+**trailing_one_month_return_split_only** | Float | Trailing one month return excluding dividends &nbsp;
+**trailing_one_year_return_split_and_dividend** | Float | Trailing one year return including dividends &nbsp;
+**trailing_one_year_return_split_only** | Float | Trailing one year return excluding dividends &nbsp;
+**trailing_one_year_volatility_annualized** | Float | Annualized standard deviation of daily price returns over trailing 252 trading days &nbsp;
+**trailing_three_year_annualized_return_split_and_dividend** | Float | Trailing three year return including dividends &nbsp;
+**trailing_three_year_annualized_return_split_only** | Float | Trailing three year return excluding dividends &nbsp;
+**trailing_three_year_volatility_annualized** | Float | Annualized standard deviation of daily price returns over trailing 756 trading days &nbsp;
+**trailing_five_year_annualized_return_split_and_dividend** | Float | Trailing five year return including dividends &nbsp;
+**trailing_five_year_annualized_return_split_only** | Float | Trailing five year return excluding dividends &nbsp;
+**trailing_five_year_volatility_annualized** | Float | Annualized standard  deviation  of  daily  price  returns  over  trailing 1260 trading days &nbsp;
+**trailing_ten_year_annualized_return_split_and_dividend** | Float | Trailing ten year return including dividends &nbsp;
+**trailing_ten_year_annualized_return_split_only** | Float | Trailing ten year return excluding dividends &nbsp;
+**inception_annualized_return_split_and_dividend** | Float | Annualized return including dividends since inception &nbsp;
+**inception_annualized_return_split_only** | Float | Annualized return excluding dividends since inception &nbsp;
+**calendar_year_5_return_split_and_dividend** | Float | Five years ago calendar year return including dividends &nbsp;
+**calendar_year_5_return_split_only** | Float | Five years ago calendar year return excluding dividends &nbsp;
+**calendar_year_4_return_split_and_dividend** | Float | Four years ago calendar year return including dividends &nbsp;
+**calendar_year_4_return_split_only** | Float | Four years ago calendar year return excluding dividends &nbsp;
+**calendar_year_3_return_split_and_dividend** | Float | Three years ago calendar year return including dividends &nbsp;
+**calendar_year_3_return_split_only** | Float | Three years ago calendar year return excluding dividends &nbsp;
+**calendar_year_2_return_split_and_dividend** | Float | Two years ago calendar year return including dividends &nbsp;
+**calendar_year_2_return_split_only** | Float | Two years ago calendar year return excluding dividends &nbsp;
+**calendar_year_1_return_split_and_dividend** | Float | One year ago calendar year return including dividends &nbsp;
+**calendar_year_1_return_split_only** | Float | One year ago calendar year return excluding dividends &nbsp;
+**calendar_year_to_date_return_split_and_dividend** | Float | Calendar year to date (YTD) return including dividends &nbsp;
+**calendar_year_to_date_return_split_only** | Float | Calendar year to date (YTD) return excluding dividends &nbsp;
+**etf** | [**ETFSummary**](ETFSummary.md) |  &nbsp;
+[//]: # (END_DEFINITION)
+[//]: # (CONTAINED_CLASS:Intrinio::ETFSummary)

data/docs/ETFSummary.md ADDED

@@ -0,0 +1,27 @@
+[//]: # (CLASS:Intrinio::ETFSummary)
+[//]: # (KIND:object)
+### Intrinio::ETFSummary
+#### Properties
+[//]: # (START_DEFINITION)
+Name | Type | Description
+------------ | ------------- | -------------
+**id** | String | The Intrinio ID of the ETF &nbsp;
+**name** | String | The common name of the ETF &nbsp;
+**ticker** | String | The common ticker symbol for the ETF &nbsp;
+**figi_ticker** | String | The OpenFIGI ticker for the ETF &nbsp;
+**ric** | String | Reuters Instrument Code (RIC) for the ETF &nbsp;
+**isin** | String | International Securities Identification Number (ISIN) for the ETF &nbsp;
+**sedol** | String | Stock Exchange Daily Official List (SEDOL) for the ETF &nbsp;
+**exchange_mic** | String | The exchange Market Identifier Code (MIC) from the International Standards Organization (ISO) &nbsp;
+[//]: # (END_DEFINITION)

data/docs/ETFsApi.md ADDED

@@ -0,0 +1,490 @@
+# Intrinio::ETFsApi
+All URIs are relative to *https://api-v2.intrinio.com*
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_all_etfs**](ETFsApi.md#get_all_etfs) | **GET** /etfs | All ETFs
+[**get_etf**](ETFsApi.md#get_etf) | **GET** /etfs/{identifier} | Lookup ETF
+[**get_etf_analytics**](ETFsApi.md#get_etf_analytics) | **GET** /etfs/{identifier}/analytics | ETF Analytics
+[**get_etf_holdings**](ETFsApi.md#get_etf_holdings) | **GET** /etfs/{identifier}/holdings | ETF Holdings
+[**get_etf_stats**](ETFsApi.md#get_etf_stats) | **GET** /etfs/{identifier}/stats | Exchange Traded Fund (ETF) stats
+[**search_etfs**](ETFsApi.md#search_etfs) | **GET** /etfs/search | Search ETFs
+[//]: # (START_OPERATION)
+[//]: # (CLASS:Intrinio::ETFsApi)
+[//]: # (METHOD:get_all_etfs)
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseETFs)
+[//]: # (RETURN_TYPE_KIND:object)
+[//]: # (RETURN_TYPE_DOC:ApiResponseETFs.md)
+[//]: # (OPERATION:get_all_etfs_v2)
+[//]: # (ENDPOINT:/etfs)
+[//]: # (DOCUMENT_LINK:ETFsApi.md#get_all_etfs)
+## **get_all_etfs**
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_etfs_v2)
+[//]: # (START_OVERVIEW)
+> ApiResponseETFs get_all_etfs(opts)
+#### All ETFs
+Returns a list of Exchange Traded Funds (ETFs) sourced from FirstBridge
+[//]: # (END_OVERVIEW)
+### Example
+[//]: # (START_CODE_EXAMPLE)
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
+end
+eTFs_api = Intrinio::ETFsApi.new
+opts = {
+  exchange: "XNAS",
+  page_size: 100,
+  next_page: nil
+}
+result = eTFs_api.get_all_etfs(opts)
+pp result
+```
+[//]: # (END_CODE_EXAMPLE)
+[//]: # (START_DEFINITION)
+### Parameters
+[//]: # (START_PARAMETERS)
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **exchange** | String|  | [optional]  &nbsp;
+ **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp;
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]  &nbsp;
+[//]: # (END_PARAMETERS)
+### Return type
+[**ApiResponseETFs**](ApiResponseETFs.md)
+[//]: # (END_OPERATION)
+[//]: # (START_OPERATION)
+[//]: # (CLASS:Intrinio::ETFsApi)
+[//]: # (METHOD:get_etf)
+[//]: # (RETURN_TYPE:Intrinio::ETF)
+[//]: # (RETURN_TYPE_KIND:object)
+[//]: # (RETURN_TYPE_DOC:ETF.md)
+[//]: # (OPERATION:get_etf_v2)
+[//]: # (ENDPOINT:/etfs/{identifier})
+[//]: # (DOCUMENT_LINK:ETFsApi.md#get_etf)
+## **get_etf**
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_etf_v2)
+[//]: # (START_OVERVIEW)
+> ETF get_etf(identifier)
+#### Lookup ETF
+Returns the Exchange Traded Fund (ETF) with the given identifier
+[//]: # (END_OVERVIEW)
+### Example
+[//]: # (START_CODE_EXAMPLE)
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
+end
+eTFs_api = Intrinio::ETFsApi.new
+identifier = "SPY"
+result = eTFs_api.get_etf(identifier)
+pp result
+```
+[//]: # (END_CODE_EXAMPLE)
+[//]: # (START_DEFINITION)
+### Parameters
+[//]: # (START_PARAMETERS)
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID) |  &nbsp;
+[//]: # (END_PARAMETERS)
+### Return type
+[**ETF**](ETF.md)
+[//]: # (END_OPERATION)
+[//]: # (START_OPERATION)
+[//]: # (CLASS:Intrinio::ETFsApi)
+[//]: # (METHOD:get_etf_analytics)
+[//]: # (RETURN_TYPE:Intrinio::ETFAnalytics)
+[//]: # (RETURN_TYPE_KIND:object)
+[//]: # (RETURN_TYPE_DOC:ETFAnalytics.md)
+[//]: # (OPERATION:get_etf_analytics_v2)
+[//]: # (ENDPOINT:/etfs/{identifier}/analytics)
+[//]: # (DOCUMENT_LINK:ETFsApi.md#get_etf_analytics)
+## **get_etf_analytics**
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_etf_analytics_v2)
+[//]: # (START_OVERVIEW)
+> ETFAnalytics get_etf_analytics(identifier)
+#### ETF Analytics
+Returns analytics for the Exchange Traded Fund (ETF) including volume, market cap, 52 week high, and 52 week low
+[//]: # (END_OVERVIEW)
+### Example
+[//]: # (START_CODE_EXAMPLE)
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
+end
+eTFs_api = Intrinio::ETFsApi.new
+identifier = "SPY"
+result = eTFs_api.get_etf_analytics(identifier)
+pp result
+```
+[//]: # (END_CODE_EXAMPLE)
+[//]: # (START_DEFINITION)
+### Parameters
+[//]: # (START_PARAMETERS)
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID) |  &nbsp;
+[//]: # (END_PARAMETERS)
+### Return type
+[**ETFAnalytics**](ETFAnalytics.md)
+[//]: # (END_OPERATION)
+[//]: # (START_OPERATION)
+[//]: # (CLASS:Intrinio::ETFsApi)
+[//]: # (METHOD:get_etf_holdings)
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseETFHoldings)
+[//]: # (RETURN_TYPE_KIND:object)
+[//]: # (RETURN_TYPE_DOC:ApiResponseETFHoldings.md)
+[//]: # (OPERATION:get_etf_holdings_v2)
+[//]: # (ENDPOINT:/etfs/{identifier}/holdings)
+[//]: # (DOCUMENT_LINK:ETFsApi.md#get_etf_holdings)
+## **get_etf_holdings**
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_etf_holdings_v2)
+[//]: # (START_OVERVIEW)
+> ApiResponseETFHoldings get_etf_holdings(identifier, opts)
+#### ETF Holdings
+Returns the holdings sorted by weight descending and the Exchange Traded Fund (ETF) summary
+[//]: # (END_OVERVIEW)
+### Example
+[//]: # (START_CODE_EXAMPLE)
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
+end
+eTFs_api = Intrinio::ETFsApi.new
+identifier = "SPY"
+opts = {
+  page_size: 100,
+  next_page: nil
+}
+result = eTFs_api.get_etf_holdings(identifier, opts)
+pp result
+```
+[//]: # (END_CODE_EXAMPLE)
+[//]: # (START_DEFINITION)
+### Parameters
+[//]: # (START_PARAMETERS)
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID) |  &nbsp;
+ **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp;
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]  &nbsp;
+[//]: # (END_PARAMETERS)
+### Return type
+[**ApiResponseETFHoldings**](ApiResponseETFHoldings.md)
+[//]: # (END_OPERATION)
+[//]: # (START_OPERATION)
+[//]: # (CLASS:Intrinio::ETFsApi)
+[//]: # (METHOD:get_etf_stats)
+[//]: # (RETURN_TYPE:Intrinio::ETFStats)
+[//]: # (RETURN_TYPE_KIND:object)
+[//]: # (RETURN_TYPE_DOC:ETFStats.md)
+[//]: # (OPERATION:get_etf_stats_v2)
+[//]: # (ENDPOINT:/etfs/{identifier}/stats)
+[//]: # (DOCUMENT_LINK:ETFsApi.md#get_etf_stats)
+## **get_etf_stats**
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_etf_stats_v2)
+[//]: # (START_OVERVIEW)
+> ETFStats get_etf_stats(identifier)
+#### Exchange Traded Fund (ETF) stats
+Returns daily stats for the Exchange Traded Fund (ETF) including net asset value, beta vs spy, returns, and volatility
+[//]: # (END_OVERVIEW)
+### Example
+[//]: # (START_CODE_EXAMPLE)
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
+end
+eTFs_api = Intrinio::ETFsApi.new
+identifier = "SPY"
+result = eTFs_api.get_etf_stats(identifier)
+pp result
+```
+[//]: # (END_CODE_EXAMPLE)
+[//]: # (START_DEFINITION)
+### Parameters
+[//]: # (START_PARAMETERS)
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID) |  &nbsp;
+[//]: # (END_PARAMETERS)
+### Return type
+[**ETFStats**](ETFStats.md)
+[//]: # (END_OPERATION)
+[//]: # (START_OPERATION)
+[//]: # (CLASS:Intrinio::ETFsApi)
+[//]: # (METHOD:search_etfs)
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseETFs)
+[//]: # (RETURN_TYPE_KIND:object)
+[//]: # (RETURN_TYPE_DOC:ApiResponseETFs.md)
+[//]: # (OPERATION:search_etfs_v2)
+[//]: # (ENDPOINT:/etfs/search)
+[//]: # (DOCUMENT_LINK:ETFsApi.md#search_etfs)
+## **search_etfs**
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/search_etfs_v2)
+[//]: # (START_OVERVIEW)
+> ApiResponseETFs search_etfs(query)
+#### Search ETFs
+Searches for Exchange Traded Funds (ETFs) matching the text `query`
+[//]: # (END_OVERVIEW)
+### Example
+[//]: # (START_CODE_EXAMPLE)
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
+end
+eTFs_api = Intrinio::ETFsApi.new
+query = "iShares"
+result = eTFs_api.search_etfs(query)
+pp result
+```
+[//]: # (END_CODE_EXAMPLE)
+[//]: # (START_DEFINITION)
+### Parameters
+[//]: # (START_PARAMETERS)
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | String|  |  &nbsp;
+[//]: # (END_PARAMETERS)
+### Return type
+[**ApiResponseETFs**](ApiResponseETFs.md)
+[//]: # (END_OPERATION)