intrinio-sdk 5.14.0 → 5.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fedd10a5dec751e24c92bf1f40e6e2e11ea17684b09fdfd3e19804092bb1c8d
-  data.tar.gz: 5e52f1968fc82d59afc8efac99473cff34f9e7d6fe7c7fb68435fa791ae426b6
+  metadata.gz: 442d7e33a17a236571c46356ac428e62770c076300cec19380692fff8dcbc3d9
+  data.tar.gz: a1fa0fb3534f7d2c25d3202e831f73a3a081e45f13d1e3653747bb93e01950b7
 SHA512:
-  metadata.gz: 4c38dc0027aaaab2fb282d6f42b82bee5ff80101b0ca368b897aa068add8616f2af41dca230fd09c6c3f2f3616708792a6676c2b07e0a27d0fe5512383fc2521
-  data.tar.gz: dc063fb50b91ed14d28cb5697993243be96e442ae999af1c0f6313aef009fb334886e19324eb3092e786167cc6395a2fb79d39fd9137278b81075181c46e66b9
+  metadata.gz: 24130daf08f7032f1e082c0304b941caf87f66ee5c5d02c86a5701d08eca0d396603d2226174265ccb6834165929ca2b5eaa9e4e7ffb6482fb73e09373f92667
+  data.tar.gz: dbaf2a436ec05176e8e6a3fd92baaa04e6c1714770eeb6f291efd004da787b650ea7cb07b2ad3c87150611f9977b56bffe89339b41ebd2fc8ce77793645a40b3

data/README.md

@@ -8,8 +8,8 @@ Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 2.25.0
-- Package version: 5.14.0
+- API version: 2.26.12
+- Package version: 5.18.0
 
 
 ## Installation
@@ -108,6 +108,7 @@ Class | Method | HTTP request | Description
 *Intrinio::FundamentalsApi* | [**get_fundamental_by_id**](docs/FundamentalsApi.md#get_fundamental_by_id) | **GET** /fundamentals/{id} | Fundamental by ID
 *Intrinio::FundamentalsApi* | [**get_fundamental_reported_financials**](docs/FundamentalsApi.md#get_fundamental_reported_financials) | **GET** /fundamentals/{id}/reported_financials | Reported Financials
 *Intrinio::FundamentalsApi* | [**get_fundamental_standardized_financials**](docs/FundamentalsApi.md#get_fundamental_standardized_financials) | **GET** /fundamentals/{id}/standardized_financials | Standardized Financials
+*Intrinio::FundamentalsApi* | [**get_fundamental_standardized_financials_dimensions**](docs/FundamentalsApi.md#get_fundamental_standardized_financials_dimensions) | **GET** /fundamentals/{id}/standardized_financials/dimensions/{tag} | Standardized Financials Dimensions
 *Intrinio::FundamentalsApi* | [**lookup_fundamental**](docs/FundamentalsApi.md#lookup_fundamental) | **GET** /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental
 *Intrinio::HistoricalDataApi* | [**get_historical_data**](docs/HistoricalDataApi.md#get_historical_data) | **GET** /historical_data/{identifier}/{tag} | Historical Data
 *Intrinio::IndexApi* | [**get_all_economic_indices**](docs/IndexApi.md#get_all_economic_indices) | **GET** /indices/economic | All Economic Indices
@@ -134,16 +135,20 @@ Class | Method | HTTP request | Description
 *Intrinio::MunicipalityApi* | [**get_municipality_financials**](docs/MunicipalityApi.md#get_municipality_financials) | **GET** /municipalities/{id}/financials | Financials for a Municipality
 *Intrinio::OptionsApi* | [**get_all_options_tickers**](docs/OptionsApi.md#get_all_options_tickers) | **GET** /options/tickers | Options Tickers
 *Intrinio::OptionsApi* | [**get_option_expirations_realtime**](docs/OptionsApi.md#get_option_expirations_realtime) | **GET** /options/expirations/{symbol}/realtime | Option Expirations Realtime
+*Intrinio::OptionsApi* | [**get_option_strikes_realtime**](docs/OptionsApi.md#get_option_strikes_realtime) | **GET** /options/strikes/{symbol}/{strike}/realtime | Option Strikes Realtime
 *Intrinio::OptionsApi* | [**get_options**](docs/OptionsApi.md#get_options) | **GET** /options/{symbol} | Options
 *Intrinio::OptionsApi* | [**get_options_by_symbol_realtime**](docs/OptionsApi.md#get_options_by_symbol_realtime) | **GET** /options/{symbol}/realtime | Options by Symbol Realtime
 *Intrinio::OptionsApi* | [**get_options_chain**](docs/OptionsApi.md#get_options_chain) | **GET** /options/chain/{symbol}/{expiration} | Options Chain
+*Intrinio::OptionsApi* | [**get_options_chain_eod**](docs/OptionsApi.md#get_options_chain_eod) | **GET** /options/chain/{symbol}/{expiration}/eod | Options Chain EOD
 *Intrinio::OptionsApi* | [**get_options_chain_realtime**](docs/OptionsApi.md#get_options_chain_realtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
 *Intrinio::OptionsApi* | [**get_options_expirations**](docs/OptionsApi.md#get_options_expirations) | **GET** /options/expirations/{symbol} | Options Expirations
 *Intrinio::OptionsApi* | [**get_options_prices**](docs/OptionsApi.md#get_options_prices) | **GET** /options/prices/{identifier} | Option Prices
 *Intrinio::OptionsApi* | [**get_options_prices_batch_realtime**](docs/OptionsApi.md#get_options_prices_batch_realtime) | **POST** /options/prices/realtime/batch | Option Prices Batch Realtime
+*Intrinio::OptionsApi* | [**get_options_prices_eod**](docs/OptionsApi.md#get_options_prices_eod) | **GET** /options/prices/{identifier}/eod | Option Prices EOD
 *Intrinio::OptionsApi* | [**get_options_prices_realtime**](docs/OptionsApi.md#get_options_prices_realtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
 *Intrinio::OptionsApi* | [**get_options_stats_realtime**](docs/OptionsApi.md#get_options_stats_realtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime
 *Intrinio::OptionsApi* | [**get_unusual_activity**](docs/OptionsApi.md#get_unusual_activity) | **GET** /options/unusual_activity/{symbol} | Options Unusual Activity
+*Intrinio::OptionsApi* | [**get_unusual_activity_universal**](docs/OptionsApi.md#get_unusual_activity_universal) | **GET** /options/unusual_activity | Options Unusual Activity Universal
 *Intrinio::OwnersApi* | [**get_all_owners**](docs/OwnersApi.md#get_all_owners) | **GET** /owners | All Owners
 *Intrinio::OwnersApi* | [**get_owner_by_id**](docs/OwnersApi.md#get_owner_by_id) | **GET** /owners/{identifier} | Owner by ID
 *Intrinio::OwnersApi* | [**insider_transaction_filings_by_owner**](docs/OwnersApi.md#insider_transaction_filings_by_owner) | **GET** /owners/{identifier}/insider_transaction_filings | Insider Transaction Filings by Owner
@@ -288,10 +293,12 @@ Class | Method | HTTP request | Description
  - [Intrinio::ApiResponseOptionPrices](docs/ApiResponseOptionPrices.md)
  - [Intrinio::ApiResponseOptions](docs/ApiResponseOptions.md)
  - [Intrinio::ApiResponseOptionsChain](docs/ApiResponseOptionsChain.md)
+ - [Intrinio::ApiResponseOptionsChainEod](docs/ApiResponseOptionsChainEod.md)
  - [Intrinio::ApiResponseOptionsChainRealtime](docs/ApiResponseOptionsChainRealtime.md)
  - [Intrinio::ApiResponseOptionsExpirations](docs/ApiResponseOptionsExpirations.md)
  - [Intrinio::ApiResponseOptionsPriceRealtime](docs/ApiResponseOptionsPriceRealtime.md)
  - [Intrinio::ApiResponseOptionsPricesBatchRealtime](docs/ApiResponseOptionsPricesBatchRealtime.md)
+ - [Intrinio::ApiResponseOptionsPricesEod](docs/ApiResponseOptionsPricesEod.md)
  - [Intrinio::ApiResponseOptionsRealtime](docs/ApiResponseOptionsRealtime.md)
  - [Intrinio::ApiResponseOptionsStatsRealtime](docs/ApiResponseOptionsStatsRealtime.md)
  - [Intrinio::ApiResponseOptionsTickers](docs/ApiResponseOptionsTickers.md)
@@ -347,6 +354,7 @@ Class | Method | HTTP request | Description
  - [Intrinio::ApiResponseSecurityZacksEPSSurprises](docs/ApiResponseSecurityZacksEPSSurprises.md)
  - [Intrinio::ApiResponseSecurityZacksSalesSurprises](docs/ApiResponseSecurityZacksSalesSurprises.md)
  - [Intrinio::ApiResponseStandardizedFinancials](docs/ApiResponseStandardizedFinancials.md)
+ - [Intrinio::ApiResponseStandardizedFinancialsDimensions](docs/ApiResponseStandardizedFinancialsDimensions.md)
  - [Intrinio::ApiResponseStockExchangeRealtimeStockPrices](docs/ApiResponseStockExchangeRealtimeStockPrices.md)
  - [Intrinio::ApiResponseStockExchangeSecurities](docs/ApiResponseStockExchangeSecurities.md)
  - [Intrinio::ApiResponseStockExchangeStockPriceAdjustments](docs/ApiResponseStockExchangeStockPriceAdjustments.md)
@@ -426,11 +434,14 @@ Class | Method | HTTP request | Description
  - [Intrinio::OnBalanceVolumeTechnicalValue](docs/OnBalanceVolumeTechnicalValue.md)
  - [Intrinio::Option](docs/Option.md)
  - [Intrinio::OptionChain](docs/OptionChain.md)
+ - [Intrinio::OptionChainEod](docs/OptionChainEod.md)
  - [Intrinio::OptionChainRealtime](docs/OptionChainRealtime.md)
  - [Intrinio::OptionContractsList](docs/OptionContractsList.md)
+ - [Intrinio::OptionEod](docs/OptionEod.md)
  - [Intrinio::OptionFactorsRealtime](docs/OptionFactorsRealtime.md)
  - [Intrinio::OptionPrice](docs/OptionPrice.md)
  - [Intrinio::OptionPriceBatchRealtime](docs/OptionPriceBatchRealtime.md)
+ - [Intrinio::OptionPriceEod](docs/OptionPriceEod.md)
  - [Intrinio::OptionPriceRealtime](docs/OptionPriceRealtime.md)
  - [Intrinio::OptionRealtime](docs/OptionRealtime.md)
  - [Intrinio::OptionStatsRealtime](docs/OptionStatsRealtime.md)
@@ -452,6 +463,7 @@ Class | Method | HTTP request | Description
  - [Intrinio::SecuritySummary](docs/SecuritySummary.md)
  - [Intrinio::SimpleMovingAverageTechnicalValue](docs/SimpleMovingAverageTechnicalValue.md)
  - [Intrinio::StandardizedFinancial](docs/StandardizedFinancial.md)
+ - [Intrinio::StandardizedFinancialsDimension](docs/StandardizedFinancialsDimension.md)
  - [Intrinio::StochasticOscillatorTechnicalValue](docs/StochasticOscillatorTechnicalValue.md)
  - [Intrinio::StockExchange](docs/StockExchange.md)
  - [Intrinio::StockMarketIndex](docs/StockMarketIndex.md)

data/docs/ApiResponseOptionsChainEod.md

@@ -0,0 +1,23 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseOptionsChainEod)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseOptionsChainEod
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**chain** | [**Array<OptionChainEod>**](OptionChainEod.md) | A list of realtime options for the provided expiration date their respective option prices.  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionChainEod)
+
+
+

data/docs/ApiResponseOptionsPricesEod.md

@@ -0,0 +1,27 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseOptionsPricesEod)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseOptionsPricesEod
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**prices** | [**Array<OptionPriceEod>**](OptionPriceEod.md) | A list of options prices with the given symbol  
+**option** | [**OptionEod**](OptionEod.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionPriceEod)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionEod)
+
+
+

data/docs/ApiResponseStandardizedFinancialsDimensions.md

@@ -0,0 +1,31 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseStandardizedFinancialsDimensions)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseStandardizedFinancialsDimensions
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**dimensions** | [**Array<StandardizedFinancialsDimension>**](StandardizedFinancialsDimension.md) | The combination of XBRL axis and members that defines the dimensionalization of this fact (if any)  
+**data_tag** | [**DataTagSummary**](DataTagSummary.md) |   
+**fundamental** | [**Fundamental**](Fundamental.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::StandardizedFinancialsDimension)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::DataTagSummary)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::Fundamental)
+
+
+

data/docs/CompanyApi.md

@@ -84,6 +84,7 @@ opts = {
   industry_group: nil,
   has_fundamentals: true,
   has_stock_prices: true,
+  thea_enabled: nil,
   page_size: 100,
   next_page: nil
 }
@@ -111,6 +112,7 @@ Name | Type | Description  | Notes
  **industry_group** | String| Return companies in the given industry group | [optional]   
  **has_fundamentals** | BOOLEAN| Return only companies that have fundamentals when true | [optional]   
  **has_stock_prices** | BOOLEAN| Return only companies that have stock prices when true | [optional]   
+ **thea_enabled** | BOOLEAN| Return companies whose have been read by our Thea NLP and are ready for our company answers endpoint | [optional]   
  **page_size** | Integer| The number of results to return | [optional] [default to 100]  
  **next_page** | String| Gets the next page of data from a previous API call | [optional]   
 

data/docs/FundamentalsApi.md

@@ -7,6 +7,7 @@ Method | HTTP request | Description
 [**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
+[**get_fundamental_standardized_financials_dimensions**](FundamentalsApi.md#get_fundamental_standardized_financials_dimensions) | **GET** /fundamentals/{id}/standardized_financials/dimensions/{tag} | Standardized Financials Dimensions
 [**lookup_fundamental**](FundamentalsApi.md#lookup_fundamental) | **GET** /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental
 
 
@@ -242,6 +243,85 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::FundamentalsApi)
+
+[//]: # (METHOD:get_fundamental_standardized_financials_dimensions)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseStandardizedFinancialsDimensions)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseStandardizedFinancialsDimensions.md)
+
+[//]: # (OPERATION:get_fundamental_standardized_financials_dimensions_v2)
+
+[//]: # (ENDPOINT:/fundamentals/{id}/standardized_financials/dimensions/{tag})
+
+[//]: # (DOCUMENT_LINK:FundamentalsApi.md#get_fundamental_standardized_financials_dimensions)
+
+## **get_fundamental_standardized_financials_dimensions**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_fundamental_standardized_financials_dimensions_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseStandardizedFinancialsDimensions get_fundamental_standardized_financials_dimensions(id, tag)
+
+#### Standardized Financials Dimensions
+
+
+Returns as reported dimensionality of a data tag
+
+[//]: # (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
+id = "AAPL-income_statement-2020-FY"
+tag = "ceo"
+
+result = fundamentals_api.get_fundamental_standardized_financials_dimensions(id, tag)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | String| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental |   
+ **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseStandardizedFinancialsDimensions**](ApiResponseStandardizedFinancialsDimensions.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::FundamentalsApi)

data/docs/OptionChainEod.md

@@ -0,0 +1,27 @@
+
+
+[//]: # (CLASS:Intrinio::OptionChainEod)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionChainEod
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**option** | [**OptionEod**](OptionEod.md) |   
+**prices** | [**OptionPriceEod**](OptionPriceEod.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionEod)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionPriceEod)
+
+
+

data/docs/OptionEod.md

@@ -0,0 +1,24 @@
+
+
+[//]: # (CLASS:Intrinio::OptionEod)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionEod
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**code** | String | The Intrinio Code for the Option.  
+**ticker** | String | The ticker symbol of the Security for the Option.  
+**expiration** | String | The date on which the Option expires. The Option becomes invalid after this date and cannot be exercised.  
+**strike** | Float | The strike price is the fixed price at which a derivative can be exercised, and refers to the price of the derivative’s underlying asset.  In a call option, the strike price is the price at which the option holder can purchase the underlying security.  For a put option, the strike price is the price at which the option holder can sell the underlying security.  
+**type** | String | The type of Option (put or call). A put option is an option contract giving the owner the right, but not the obligation, to sell a specified amount of an underlying asset at a specified price before the option's expiration date. A call option gives the holder the right to buy an underlying asset at a specified price, before the option's expiration date.  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OptionPriceEod.md

@@ -0,0 +1,40 @@
+
+
+[//]: # (CLASS:Intrinio::OptionPriceEod)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionPriceEod
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**date** | String | The date of the price, in the format YYYY-MM-DD  
+**close** | Float | The closing price of the options contract.  
+**close_bid** | Float | The closing bid price of the options contract.  
+**close_ask** | Float | The closing ask price of the options contract.  
+**volume** | Integer | The cumulative volume of this options contract that traded that day.  
+**open** | Float | The price at the beginning of the period  
+**open_ask** | Float | The ask at the beginning of the period  
+**open_bid** | Float | The bid at the beginning of the period  
+**open_interest** | Integer | The total number of this options contract that are still open.  
+**high** | Float | The highest price over the span of the period  
+**low** | Float | The highest price over the span of the period  
+**mark** | Float | The mid price between the latest bid and ask spread  
+**ask_high** | Float | The highest ask over the span of the period  
+**ask_low** | Float | The lowest ask over the span of the period  
+**bid_high** | Float | The highest bid over the span of the period  
+**bid_low** | Object | The lowest bid over the span of the period  
+**implied_volatility** | Float | The implied volatility of the contract calculated using the Black-Scholes Model.  
+**delta** | Float | Delta represents the rate of change between the option's price and a $1 change in the underlying asset's price.  
+**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.  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OptionUnusualTrade.md

@@ -15,10 +15,14 @@ Name | Type | Description
 **symbol** | String | The underlying option security symbol for the trade  
 **timestamp** | Date | The UTC timestamp of order placement  
 **type** | String | The type of unusual trade  
-**total_value** | Float | The aggregated value of all option contract premiums included in the trade  
-**contract_type** | String | The type of Option (put or call)  
-**contract_expiration** | Date | The expiration date for the options contract  
-**contract_strike** | Float | The strike price of the option contract  
+**total_value** | Float | The aggregated value of all option contract premiums included in the trade\\  
+**total_size** | Float | The total number of contracts involved in a single transaction  
+**average_price** | Float | The average premium paid per option contract  
+**contract** | String | The option contract symbol  
+**ask_at_execution** | Float | Ask price at execution  
+**bid_at_execution** | Float | Bid price at execution  
+**sentiment** | String | Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price.  
+**underlying_price_at_execution** | Float | Price of the underlying security at execution of trade  
 
 [//]: # (END_DEFINITION)