intrinio-sdk 5.20.0 → 5.21.0

data/docs/ETFsApi.md

@@ -42,7 +42,7 @@ Method | HTTP request | Description
 #### All ETFs
 
 
-Returns a list of Exchange Traded Funds (ETFs) sourced from FirstBridge
+Returns a list of all currently listed ETFs, with relevant identification information including the ETF Name, Ticker, FIGI Ticker, and Exchange MIC for further usage with our ETF Metadata, Holdings, Stats, and Analytics offerings.
 
 [//]: # (END_OVERVIEW)
 
@@ -126,7 +126,7 @@ Name | Type | Description  | Notes
 #### Lookup ETF
 
 
-Returns the Exchange Traded Fund (ETF) with the given identifier
+Returns classifications and reference data which consists of ~90 columns that give detailed information about an ETF. These granular details include asset class, expense ratio, index name, index weighting scheme, smart beta type and specific investment objectives.
 
 [//]: # (END_OVERVIEW)
 
@@ -203,7 +203,7 @@ Name | Type | Description  | Notes
 #### ETF Analytics
 
 
-Returns analytics for the Exchange Traded Fund (ETF) including volume, market cap, 52 week high, and 52 week low
+Returns latest market analytics for a specified US ETF, including volume, trailing volumen, market cap, 52 week high, and 52 week low.
 
 [//]: # (END_OVERVIEW)
 
@@ -280,7 +280,7 @@ Name | Type | Description  | Notes
 #### ETF Holdings
 
 
-Returns the holdings sorted by weight descending and the Exchange Traded Fund (ETF) summary
+Returns holdings data that details all the constituent securities in each ETF with names, identifiers, and the weights for each security providing granular level transparency.
 
 [//]: # (END_OVERVIEW)
 
@@ -364,7 +364,7 @@ Name | Type | Description  | Notes
 #### Exchange Traded Fund (ETF) stats
 
 
-Returns daily stats for the Exchange Traded Fund (ETF) including net asset value, beta vs spy, returns, and volatility
+Returns comprehensive key US ETF performance statistics, including prices, NAVs, flows, returns, and much more for both trailing and calendar year periods.
 
 [//]: # (END_OVERVIEW)
 
@@ -441,7 +441,7 @@ Name | Type | Description  | Notes
 #### Search ETFs
 
 
-Searches for Exchange Traded Funds (ETFs) matching the text `query`
+Accepts a string of keyword combinations, and searches across the ETF name and ticker and returns a list of ETFs with related keywords.
 
 [//]: # (END_OVERVIEW)
 

data/docs/FilingApi.md

@@ -42,12 +42,12 @@ Method | HTTP request | Description
 
 [//]: # (START_OVERVIEW)
 
-> ApiResponseFilings get_all_filings(company, opts)
+> ApiResponseFilings get_all_filings(opts)
 
 #### All Filings
 
 
-Returns all Filings. Returns Filings matching parameters when supplied.
+Returns pertinent filing reference data for a specific company filing or latest filings for all companies. Useful for tracking the latest filings submitted and updating your database accordingly with the new information.
 
 [//]: # (END_OVERVIEW)
 
@@ -67,9 +67,9 @@ Intrinio.configure do |config|
 end
 
 filing_api = Intrinio::FilingApi.new
-company = "AAPL"
 
 opts = {
+  company: "AAPL",
   report_type: "10-Q",
   start_date: Date.parse("2015-01-01"),
   end_date: nil,
@@ -80,7 +80,7 @@ opts = {
   next_page: nil
 }
 
-result = filing_api.get_all_filings(company, opts)
+result = filing_api.get_all_filings(opts)
 pp result
 ```
 
@@ -95,7 +95,7 @@ pp result
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **company** | String| Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID) |   
+ **company** | String| Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID) | [optional]   
  **report_type** | String| Filter by report type. Separate values with commas to return multiple The filing <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report types</a>. | [optional]   
  **start_date** | Date| Filed on or after the given date | [optional]   
  **end_date** | Date| Filed before or after the given date | [optional]   
@@ -143,7 +143,7 @@ Name | Type | Description  | Notes
 #### All Filing Notes
 
 
-Return all Notes from all Filings, most-recent first. Returns notes matching parameters when supplied.
+Returns a list of the latest XBRL filing note sections from the SEC 10-K and 10-Q statements. The returned Intrinio XBRL filing note ID can then be utilized with the “Filing Note by ID” endpoint to retrieve the contents of the note in HTML or text format.
 
 [//]: # (END_OVERVIEW)
 
@@ -392,7 +392,7 @@ Name | Type | Description  | Notes
 #### All Fundamentals by Filing
 
 
-Returns all Fundamentals for the SEC Filing with the given `identifier`. Returns Fundamentals matching parameters when supplied.
+Returns a list of fundamentals with unique fundamental IDs associated with a particular `Intrinio Filing ID` (if applicable) that have been updated or created as a result of a company`s latest SEC filing. Useful to ensure your database is up to date with the latest fundamentals.
 
 [//]: # (END_OVERVIEW)
 
@@ -486,6 +486,7 @@ Name | Type | Description  | Notes
 #### Filing Html
 
 
+Returns a SEC filing in HTML Format for a specified filing ID.
 
 [//]: # (END_OVERVIEW)
 
@@ -638,6 +639,7 @@ Name | Type | Description  | Notes
 #### Filing Note by ID
 
 
+Returns the XBRL filing note contents in HTML or text format for a specified Intrinio XBRL filing note ID.
 
 [//]: # (END_OVERVIEW)
 
@@ -871,7 +873,7 @@ Name | Type | Description  | Notes
 #### Search Filing Notes
 
 
-Searches for Filing Notes using the `query`
+Search the XBRL note database and return a list of XBRL note sections containing text from the text query parameter passed through.
 
 [//]: # (END_OVERVIEW)
 

data/docs/FundamentalsApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://api-v2.intrinio.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**filter_fundamental**](FundamentalsApi.md#filter_fundamental) | **GET** /fundamentals | Filter Fundamental
 [**get_fundamental_by_id**](FundamentalsApi.md#get_fundamental_by_id) | **GET** /fundamentals/{id} | Fundamental by ID
 [**get_fundamental_reported_financials**](FundamentalsApi.md#get_fundamental_reported_financials) | **GET** /fundamentals/{id}/reported_financials | Reported Financials
 [**get_fundamental_standardized_financials**](FundamentalsApi.md#get_fundamental_standardized_financials) | **GET** /fundamentals/{id}/standardized_financials | Standardized Financials
@@ -12,6 +13,104 @@ Method | HTTP request | Description
 
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::FundamentalsApi)
+
+[//]: # (METHOD:filter_fundamental)
+
+[//]: # (RETURN_TYPE:Intrinio::Fundamental)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:Fundamental.md)
+
+[//]: # (OPERATION:filter_fundamental_v2)
+
+[//]: # (ENDPOINT:/fundamentals)
+
+[//]: # (DOCUMENT_LINK:FundamentalsApi.md#filter_fundamental)
+
+## **filter_fundamental**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/filter_fundamental_v2)
+
+[//]: # (START_OVERVIEW)
+
+> Fundamental filter_fundamental(opts)
+
+#### Filter Fundamental
+
+
+Returns fundamentals that meet the set of filters specified in parameters.
+
+[//]: # (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
+
+fundamentals_api = Intrinio::FundamentalsApi.new
+
+opts = {
+  filed_after: Date.parse("2022-01-01"),
+  filed_before: Date.parse("2022-12-01"),
+  reported_only: false,
+  fiscal_year: 2017,
+  statement_code: nil,
+  type: "false",
+  fiscal_period: "FY",
+  start_date: Date.parse("2022-01-01"),
+  end_date: Date.parse("2022-12-01"),
+  next_page: nil
+}
+
+result = fundamentals_api.filter_fundamental(opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **filed_after** | Date| Only include fundamentals that were filed on or after this date. | [optional]   
+ **filed_before** | Date| Only include fundamentals that were filed on or before this date. | [optional]   
+ **reported_only** | BOOLEAN| Only as-reported fundamentals | [optional]   
+ **fiscal_year** | Integer| Only for the given fiscal year | [optional]   
+ **statement_code** | String| Only of the given statement code | [optional]   
+ **type** | String| Only of the given type | [optional]   
+ **fiscal_period** | String| The fiscal period | [optional]   
+ **start_date** | Date| Only include fundamentals where covered period is on or after this date. | [optional]   
+ **end_date** | Date| Only include fundamentals where covered period is on or before this date. | [optional]   
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**Fundamental**](Fundamental.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::FundamentalsApi)
@@ -41,7 +140,7 @@ Method | HTTP request | Description
 #### Fundamental by ID
 
 
-Returns detailed fundamental data for the given `id`.
+Returns a specific fundamental associated with a particular unique fundamental ID. Useful for pulling reference data for a specific fundamental.
 
 [//]: # (END_OVERVIEW)
 
@@ -118,7 +217,7 @@ Name | Type | Description  | Notes
 #### Reported Financials
 
 
-Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company
+Returns as-reported financial statement data for income statement, balance sheet, and cash flow statement. Data for income statement and cash flow statement is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.
 
 [//]: # (END_OVERVIEW)
 
@@ -195,7 +294,7 @@ Name | Type | Description  | Notes
 #### Standardized Financials
 
 
-Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies' fundamentals.
+Returns standardized financial statement data for income statement, balance sheet, cash flow statement and over 100 associated calculations for a given company. Data for income statement, cash flow statement, and calculations is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.
 
 [//]: # (END_OVERVIEW)
 
@@ -351,7 +450,7 @@ Name | Type | Description  | Notes
 #### Lookup Fundamental
 
 
-Returns the Fundamental for the Company with the given `identifier` and with the given parameters
+Returns a specific fundamental with unique fundamental ID associated with a particular company, year, period and statement. Useful for pulling the unique fundamental ID and reference data for a specific fundamental.
 
 [//]: # (END_OVERVIEW)
 

data/docs/IndexApi.md

@@ -54,6 +54,7 @@ Method | HTTP request | Description
 #### All Economic Indices
 
 
+Returns a list of reference data on more than 200,000 economic indices from the Federal Reserve Economic Data (FRED) database.
 
 [//]: # (END_OVERVIEW)
 
@@ -297,6 +298,7 @@ Name | Type | Description  | Notes
 #### Lookup Economic Index
 
 
+Returns reference data for a specified Federal Reserve Economic Data (FRED) series ID.
 
 [//]: # (END_OVERVIEW)
 
@@ -373,7 +375,7 @@ Name | Type | Description  | Notes
 #### Data Point (Number) for an Economic Index
 
 
-Returns a numeric value for the given `tag` for the Economic Index with the given `identifier`
+Returns latest data for a specified Federal Reserve Economic Data (FRED) ID.
 
 [//]: # (END_OVERVIEW)
 
@@ -531,7 +533,7 @@ Name | Type | Description  | Notes
 #### Historical Data for an Economic Index
 
 
-Returns historical values for the given `tag` and the Economic Index with the given `identifier`
+Returns historical data for a specified Federal Reserve Economic Data (FRED) ID over a period of time.
 
 [//]: # (END_OVERVIEW)
 
@@ -1281,7 +1283,7 @@ Name | Type | Description  | Notes
 #### Search Economic Indices
 
 
-Searches for indices using the text in `query`
+Search the Federal Reserve Economic Data (FRED) database and return a list of economic indices matching the text query parameter passed through.
 
 [//]: # (END_OVERVIEW)
 

data/docs/OptionStatsRealtime.md

@@ -17,6 +17,7 @@ Name | Type | Description
 **gamma** | Float | Gamma represents the rate of change between an option's delta and the underlying asset's price.  
 **theta** | Float | Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay.  
 **vega** | Float | Vega represents the rate of change between an option's value and the underlying asset's implied volatility.  
+**underlying_price** | Float | The most recent trade price of the underlying asset.  
 
 [//]: # (END_DEFINITION)
 

data/docs/OptionsApi.md

@@ -126,7 +126,7 @@ This endpoint does not need any parameter.
 #### Option Expirations Realtime
 
 
-Returns all realtime option contract expiration dates for a given symbol.
+Returns a list of all current and upcoming expiration dates for a particular symbol.
 
 [//]: # (END_OVERVIEW)
 
@@ -212,7 +212,7 @@ Name | Type | Description  | Notes
 #### Option Strikes Realtime
 
 
-Returns all realtime options contracts and their prices for the given symbol and strike.
+Returns a list of the latest top of the order book size and premium (bid / ask), the latest trade size and premium as well as the greeks and implied volatility for all call/put contracts that match the strike and symbol specified.
 
 [//]: # (END_OVERVIEW)
 
@@ -291,7 +291,7 @@ Name | Type | Description  | Notes
 #### Options
 
 
-Returns the master list of option contracts for a given symbol.
+Returns a list of all securities that have options listed and are tradable on a US market exchange. Useful to retrieve the entire universe.
 
 [//]: # (END_OVERVIEW)
 
@@ -389,7 +389,7 @@ Name | Type | Description  | Notes
 #### Options by Symbol Realtime
 
 
-Returns the master list of realtime option contracts for a given symbol.
+Returns a list of all securities that have options listed and are tradable on a US market exchange. Useful to retrieve the entire universe.
 
 [//]: # (END_OVERVIEW)
 
@@ -485,7 +485,7 @@ Name | Type | Description  | Notes
 #### Options Chain
 
 
-Returns all options contracts and their prices for the given symbol and expiration date.
+Returns a list of the historical end-of-day top of the order book size and premium (bid / ask), the latest trade size and premium as well as the greeks and implied volatility for all option contracts currently associated with the option chain.
 
 [//]: # (END_OVERVIEW)
 
@@ -608,7 +608,8 @@ opts = {
   type: nil,
   strike: nil,
   strike_greater_than: nil,
-  strike_less_than: nil
+  strike_less_than: nil,
+  date: nil
 }
 
 result = options_api.get_options_chain_eod(symbol, expiration, opts)
@@ -632,6 +633,7 @@ Name | Type | Description  | Notes
  **strike** | Float| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]   
  **strike_greater_than** | Float| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]   
  **strike_less_than** | Float| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]   
+ **date** | Date| The the date to retrieve prices for | [optional]   
 
 [//]: # (END_PARAMETERS)
 
@@ -671,7 +673,7 @@ Name | Type | Description  | Notes
 #### Options Chain Realtime
 
 
-Returns all realtime options contracts and their prices for the given symbol and expiration date.
+Returns a list of the latest National Best Bid & Offer (NBBO) top of the order book size and premium (bid / ask), the latest trade size and premium as well as the greeks and implied volatility for all option contracts currently associated with the option chain.
 
 [//]: # (END_OVERVIEW)
 
@@ -773,7 +775,7 @@ Name | Type | Description  | Notes
 #### Options Expirations
 
 
-Returns all option contract expiration dates for a given symbol.
+Returns a list of all current and upcoming option contract expiration dates for a particular symbol.
 
 [//]: # (END_OVERVIEW)
 
@@ -857,7 +859,7 @@ Name | Type | Description  | Notes
 #### Option Prices
 
 
-Returns all option prices for a given option contract identifier.
+Returns all price data from inception to expiration for a particular contract.
 
 [//]: # (END_OVERVIEW)
 
@@ -945,7 +947,7 @@ Name | Type | Description  | Notes
 #### Option Prices Batch Realtime
 
 
-Returns options prices for a supplied list of option symbols.
+Returns a list of latest price data for up to 250 option contracts per request.
 
 [//]: # (END_OVERVIEW)
 
@@ -1192,7 +1194,7 @@ Name | Type | Description  | Notes
 #### Option Stats Realtime
 
 
-Returns all option stats (greeks and implied volatility) and factors used to calculate them, for a given option contract identifier.
+Returns all option stats (greeks and implied volatility) as well as the underlying factors used to calculate them, for a particular option contract.
 
 [//]: # (END_OVERVIEW)
 
@@ -1274,7 +1276,7 @@ Name | Type | Description  | Notes
 #### Options Unusual Activity
 
 
-Returns unusual trades for a given identifier.
+Returns unusual options activity for a particular company across all option chains. Unusual options activity includes large trades, sweeps, and block trades.
 
 [//]: # (END_OVERVIEW)
 
@@ -1452,7 +1454,7 @@ Name | Type | Description  | Notes
 #### Options Unusual Activity Universal
 
 
-Returns nusual trades for all underlying security symbols.
+Returns the latest unusual options activity across all US companies with across all option chains. Unusual options activity includes large trades, sweeps, and block trades.
 
 [//]: # (END_OVERVIEW)
 

data/docs/OwnersApi.md

@@ -314,7 +314,7 @@ identifier = 430692
 
 opts = {
   page_size: 100,
-  as_of_date: "2021-01-05",
+  as_of_date: Date.parse("2021-01-05"),
   next_page: nil
 }
 
@@ -335,7 +335,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **identifier** | String| The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under. |   
  **page_size** | Integer| The number of results to return | [optional] [default to 100]  
- **as_of_date** | [**Object**](.md)| Return only holdings filed before this date. | [optional]   
+ **as_of_date** | Date| Return only holdings filed before this date. | [optional]   
  **next_page** | String| Gets the next page of data from a previous API call | [optional]   
 
 [//]: # (END_PARAMETERS)