intrinio-sdk 5.14.0 → 5.18.0

package/README.md

@@ -4,8 +4,8 @@ To get an API key, [sign up here](https://intrinio.com/).
 
 Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-- API version: 2.25.0
-- Package version: 5.14.0
+- API version: 2.26.12
+- Package version: 5.18.0
 
 
 ## Installation
@@ -119,6 +119,7 @@ Class | Method | HTTP request | Description
 *intrinioSDK.FundamentalsApi* | [**getFundamentalById**](docs/FundamentalsApi.md#getFundamentalById) | **GET** /fundamentals/{id} | Fundamental by ID
 *intrinioSDK.FundamentalsApi* | [**getFundamentalReportedFinancials**](docs/FundamentalsApi.md#getFundamentalReportedFinancials) | **GET** /fundamentals/{id}/reported_financials | Reported Financials
 *intrinioSDK.FundamentalsApi* | [**getFundamentalStandardizedFinancials**](docs/FundamentalsApi.md#getFundamentalStandardizedFinancials) | **GET** /fundamentals/{id}/standardized_financials | Standardized Financials
+*intrinioSDK.FundamentalsApi* | [**getFundamentalStandardizedFinancialsDimensions**](docs/FundamentalsApi.md#getFundamentalStandardizedFinancialsDimensions) | **GET** /fundamentals/{id}/standardized_financials/dimensions/{tag} | Standardized Financials Dimensions
 *intrinioSDK.FundamentalsApi* | [**lookupFundamental**](docs/FundamentalsApi.md#lookupFundamental) | **GET** /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental
 *intrinioSDK.HistoricalDataApi* | [**getHistoricalData**](docs/HistoricalDataApi.md#getHistoricalData) | **GET** /historical_data/{identifier}/{tag} | Historical Data
 *intrinioSDK.IndexApi* | [**getAllEconomicIndices**](docs/IndexApi.md#getAllEconomicIndices) | **GET** /indices/economic | All Economic Indices
@@ -145,16 +146,20 @@ Class | Method | HTTP request | Description
 *intrinioSDK.MunicipalityApi* | [**getMunicipalityFinancials**](docs/MunicipalityApi.md#getMunicipalityFinancials) | **GET** /municipalities/{id}/financials | Financials for a Municipality
 *intrinioSDK.OptionsApi* | [**getAllOptionsTickers**](docs/OptionsApi.md#getAllOptionsTickers) | **GET** /options/tickers | Options Tickers
 *intrinioSDK.OptionsApi* | [**getOptionExpirationsRealtime**](docs/OptionsApi.md#getOptionExpirationsRealtime) | **GET** /options/expirations/{symbol}/realtime | Option Expirations Realtime
+*intrinioSDK.OptionsApi* | [**getOptionStrikesRealtime**](docs/OptionsApi.md#getOptionStrikesRealtime) | **GET** /options/strikes/{symbol}/{strike}/realtime | Option Strikes Realtime
 *intrinioSDK.OptionsApi* | [**getOptions**](docs/OptionsApi.md#getOptions) | **GET** /options/{symbol} | Options
 *intrinioSDK.OptionsApi* | [**getOptionsBySymbolRealtime**](docs/OptionsApi.md#getOptionsBySymbolRealtime) | **GET** /options/{symbol}/realtime | Options by Symbol Realtime
 *intrinioSDK.OptionsApi* | [**getOptionsChain**](docs/OptionsApi.md#getOptionsChain) | **GET** /options/chain/{symbol}/{expiration} | Options Chain
+*intrinioSDK.OptionsApi* | [**getOptionsChainEod**](docs/OptionsApi.md#getOptionsChainEod) | **GET** /options/chain/{symbol}/{expiration}/eod | Options Chain EOD
 *intrinioSDK.OptionsApi* | [**getOptionsChainRealtime**](docs/OptionsApi.md#getOptionsChainRealtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
 *intrinioSDK.OptionsApi* | [**getOptionsExpirations**](docs/OptionsApi.md#getOptionsExpirations) | **GET** /options/expirations/{symbol} | Options Expirations
 *intrinioSDK.OptionsApi* | [**getOptionsPrices**](docs/OptionsApi.md#getOptionsPrices) | **GET** /options/prices/{identifier} | Option Prices
 *intrinioSDK.OptionsApi* | [**getOptionsPricesBatchRealtime**](docs/OptionsApi.md#getOptionsPricesBatchRealtime) | **POST** /options/prices/realtime/batch | Option Prices Batch Realtime
+*intrinioSDK.OptionsApi* | [**getOptionsPricesEod**](docs/OptionsApi.md#getOptionsPricesEod) | **GET** /options/prices/{identifier}/eod | Option Prices EOD
 *intrinioSDK.OptionsApi* | [**getOptionsPricesRealtime**](docs/OptionsApi.md#getOptionsPricesRealtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
 *intrinioSDK.OptionsApi* | [**getOptionsStatsRealtime**](docs/OptionsApi.md#getOptionsStatsRealtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime
 *intrinioSDK.OptionsApi* | [**getUnusualActivity**](docs/OptionsApi.md#getUnusualActivity) | **GET** /options/unusual_activity/{symbol} | Options Unusual Activity
+*intrinioSDK.OptionsApi* | [**getUnusualActivityUniversal**](docs/OptionsApi.md#getUnusualActivityUniversal) | **GET** /options/unusual_activity | Options Unusual Activity Universal
 *intrinioSDK.OwnersApi* | [**getAllOwners**](docs/OwnersApi.md#getAllOwners) | **GET** /owners | All Owners
 *intrinioSDK.OwnersApi* | [**getOwnerById**](docs/OwnersApi.md#getOwnerById) | **GET** /owners/{identifier} | Owner by ID
 *intrinioSDK.OwnersApi* | [**insiderTransactionFilingsByOwner**](docs/OwnersApi.md#insiderTransactionFilingsByOwner) | **GET** /owners/{identifier}/insider_transaction_filings | Insider Transaction Filings by Owner
@@ -299,10 +304,12 @@ Class | Method | HTTP request | Description
  - [intrinioSDK.ApiResponseOptionPrices](docs/ApiResponseOptionPrices.md)
  - [intrinioSDK.ApiResponseOptions](docs/ApiResponseOptions.md)
  - [intrinioSDK.ApiResponseOptionsChain](docs/ApiResponseOptionsChain.md)
+ - [intrinioSDK.ApiResponseOptionsChainEod](docs/ApiResponseOptionsChainEod.md)
  - [intrinioSDK.ApiResponseOptionsChainRealtime](docs/ApiResponseOptionsChainRealtime.md)
  - [intrinioSDK.ApiResponseOptionsExpirations](docs/ApiResponseOptionsExpirations.md)
  - [intrinioSDK.ApiResponseOptionsPriceRealtime](docs/ApiResponseOptionsPriceRealtime.md)
  - [intrinioSDK.ApiResponseOptionsPricesBatchRealtime](docs/ApiResponseOptionsPricesBatchRealtime.md)
+ - [intrinioSDK.ApiResponseOptionsPricesEod](docs/ApiResponseOptionsPricesEod.md)
  - [intrinioSDK.ApiResponseOptionsRealtime](docs/ApiResponseOptionsRealtime.md)
  - [intrinioSDK.ApiResponseOptionsStatsRealtime](docs/ApiResponseOptionsStatsRealtime.md)
  - [intrinioSDK.ApiResponseOptionsTickers](docs/ApiResponseOptionsTickers.md)
@@ -358,6 +365,7 @@ Class | Method | HTTP request | Description
  - [intrinioSDK.ApiResponseSecurityZacksEPSSurprises](docs/ApiResponseSecurityZacksEPSSurprises.md)
  - [intrinioSDK.ApiResponseSecurityZacksSalesSurprises](docs/ApiResponseSecurityZacksSalesSurprises.md)
  - [intrinioSDK.ApiResponseStandardizedFinancials](docs/ApiResponseStandardizedFinancials.md)
+ - [intrinioSDK.ApiResponseStandardizedFinancialsDimensions](docs/ApiResponseStandardizedFinancialsDimensions.md)
  - [intrinioSDK.ApiResponseStockExchangeRealtimeStockPrices](docs/ApiResponseStockExchangeRealtimeStockPrices.md)
  - [intrinioSDK.ApiResponseStockExchangeSecurities](docs/ApiResponseStockExchangeSecurities.md)
  - [intrinioSDK.ApiResponseStockExchangeStockPriceAdjustments](docs/ApiResponseStockExchangeStockPriceAdjustments.md)
@@ -437,11 +445,14 @@ Class | Method | HTTP request | Description
  - [intrinioSDK.OnBalanceVolumeTechnicalValue](docs/OnBalanceVolumeTechnicalValue.md)
  - [intrinioSDK.Option](docs/Option.md)
  - [intrinioSDK.OptionChain](docs/OptionChain.md)
+ - [intrinioSDK.OptionChainEod](docs/OptionChainEod.md)
  - [intrinioSDK.OptionChainRealtime](docs/OptionChainRealtime.md)
  - [intrinioSDK.OptionContractsList](docs/OptionContractsList.md)
+ - [intrinioSDK.OptionEod](docs/OptionEod.md)
  - [intrinioSDK.OptionFactorsRealtime](docs/OptionFactorsRealtime.md)
  - [intrinioSDK.OptionPrice](docs/OptionPrice.md)
  - [intrinioSDK.OptionPriceBatchRealtime](docs/OptionPriceBatchRealtime.md)
+ - [intrinioSDK.OptionPriceEod](docs/OptionPriceEod.md)
  - [intrinioSDK.OptionPriceRealtime](docs/OptionPriceRealtime.md)
  - [intrinioSDK.OptionRealtime](docs/OptionRealtime.md)
  - [intrinioSDK.OptionStatsRealtime](docs/OptionStatsRealtime.md)
@@ -463,6 +474,7 @@ Class | Method | HTTP request | Description
  - [intrinioSDK.SecuritySummary](docs/SecuritySummary.md)
  - [intrinioSDK.SimpleMovingAverageTechnicalValue](docs/SimpleMovingAverageTechnicalValue.md)
  - [intrinioSDK.StandardizedFinancial](docs/StandardizedFinancial.md)
+ - [intrinioSDK.StandardizedFinancialsDimension](docs/StandardizedFinancialsDimension.md)
  - [intrinioSDK.StochasticOscillatorTechnicalValue](docs/StochasticOscillatorTechnicalValue.md)
  - [intrinioSDK.StockExchange](docs/StockExchange.md)
  - [intrinioSDK.StockMarketIndex](docs/StockMarketIndex.md)

package/docs/ApiResponseOptionsChainEod.md

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

package/docs/ApiResponseOptionsPricesEod.md

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

package/docs/ApiResponseStandardizedFinancialsDimensions.md

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

package/docs/CompanyApi.md

@@ -79,6 +79,7 @@ var opts = {
   'industryGroup': null,
   'hasFundamentals': true,
   'hasStockPrices': true,
+  'theaEnabled': null,
   'pageSize': 100,
   'nextPage': null
 };
@@ -108,6 +109,7 @@ Name | Type | Description  | Notes
  **industryGroup** | String| Return companies in the given industry group | [optional]   
  **hasFundamentals** | Boolean| Return only companies that have fundamentals when true | [optional]   
  **hasStockPrices** | Boolean| Return only companies that have stock prices when true | [optional]   
+ **theaEnabled** | Boolean| Return companies whose have been read by our Thea NLP and are ready for our company answers endpoint | [optional]   
  **pageSize** | Number| The number of results to return | [optional] [default to 100]  
  **nextPage** | String| Gets the next page of data from a previous API call | [optional]   
 <br/>

package/docs/FundamentalsApi.md

@@ -7,6 +7,7 @@ Method | HTTP request | Description
 [**getFundamentalById**](FundamentalsApi.md#getFundamentalById) | **GET** /fundamentals/{id} | Fundamental by ID
 [**getFundamentalReportedFinancials**](FundamentalsApi.md#getFundamentalReportedFinancials) | **GET** /fundamentals/{id}/reported_financials | Reported Financials
 [**getFundamentalStandardizedFinancials**](FundamentalsApi.md#getFundamentalStandardizedFinancials) | **GET** /fundamentals/{id}/standardized_financials | Standardized Financials
+[**getFundamentalStandardizedFinancialsDimensions**](FundamentalsApi.md#getFundamentalStandardizedFinancialsDimensions) | **GET** /fundamentals/{id}/standardized_financials/dimensions/{tag} | Standardized Financials Dimensions
 [**lookupFundamental**](FundamentalsApi.md#lookupFundamental) | **GET** /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental
 
 
@@ -245,6 +246,87 @@ Name | Type | Description  | Notes
 
 
 
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:FundamentalsApi)
+
+[//]: # (METHOD:getFundamentalStandardizedFinancialsDimensions)
+
+[//]: # (RETURN_TYPE:ApiResponseStandardizedFinancialsDimensions)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseStandardizedFinancialsDimensions.md)
+
+[//]: # (OPERATION:getFundamentalStandardizedFinancialsDimensions_v2)
+
+[//]: # (ENDPOINT:/fundamentals/{id}/standardized_financials/dimensions/{tag})
+
+[//]: # (DOCUMENT_LINK:FundamentalsApi.md#getFundamentalStandardizedFinancialsDimensions)
+
+<a name="getFundamentalStandardizedFinancialsDimensions"></a>
+## **getFundamentalStandardizedFinancialsDimensions**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getFundamentalStandardizedFinancialsDimensions_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseStandardizedFinancialsDimensions getFundamentalStandardizedFinancialsDimensions(id, tag)
+
+#### Standardized Financials Dimensions
+
+
+Returns as reported dimensionality of a data tag
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
+```javascript
+var intrinioSDK = require('intrinio-sdk');
+intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
+intrinioSDK.ApiClient.instance.enableRetries = true;
+
+var fundamentals = new intrinioSDK.FundamentalsApi();
+
+var id = "AAPL-income_statement-2020-FY";
+var tag = "ceo";
+
+
+fundamentals.getFundamentalStandardizedFinancialsDimensions(id, tag).then(function(data) {
+  data = JSON.stringify(data, null, 2)
+  console.log(data);
+}, function(error) {
+  console.error(error);
+});
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | String| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental |  &nbsp;
+ **tag** | String| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) |  &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseStandardizedFinancialsDimensions**](ApiResponseStandardizedFinancialsDimensions.md)
+
+
+
 [//]: # (END_OPERATION)
 
 

package/docs/OptionChainEod.md

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

package/docs/OptionEod.md

@@ -0,0 +1,25 @@
+
+[//]: # (CLASS:OptionEod)
+
+[//]: # (KIND:object)
+
+### 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** | Number | 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)
+
+
+
+
+

package/docs/OptionPriceEod.md

@@ -0,0 +1,41 @@
+
+[//]: # (CLASS:OptionPriceEod)
+
+[//]: # (KIND:object)
+
+### OptionPriceEod
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**date** | String | The date of the price, in the format YYYY-MM-DD  
+**close** | Number | The closing price of the options contract.  
+**closeBid** | Number | The closing bid price of the options contract.  
+**closeAsk** | Number | The closing ask price of the options contract.  
+**volume** | Number | The cumulative volume of this options contract that traded that day.  
+**open** | Number | The price at the beginning of the period  
+**openAsk** | Number | The ask at the beginning of the period  
+**openBid** | Number | The bid at the beginning of the period  
+**openInterest** | Number | The total number of this options contract that are still open.  
+**high** | Number | The highest price over the span of the period  
+**low** | Number | The highest price over the span of the period  
+**mark** | Number | The mid price between the latest bid and ask spread  
+**askHigh** | Number | The highest ask over the span of the period  
+**askLow** | Number | The lowest ask over the span of the period  
+**bidHigh** | Number | The highest bid over the span of the period  
+**bidLow** | Object | The lowest bid over the span of the period  
+**impliedVolatility** | Number | The implied volatility of the contract calculated using the Black-Scholes Model.  
+**delta** | Number | Delta represents the rate of change between the option's price and a $1 change in the underlying asset's price.  
+**gamma** | Number | Gamma represents the rate of change between an option's delta and the underlying asset's price.  
+**theta** | Number | Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay.  
+**vega** | Number | Vega represents the rate of change between an option's value and the underlying asset's implied volatility.  
+
+[//]: # (END_DEFINITION)
+
+
+
+
+

package/docs/OptionUnusualTrade.md

@@ -14,10 +14,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  
-**totalValue** | Number | The aggregated value of all option contract premiums included in the trade  
-**contractType** | String | The type of Option (put or call)  
-**contractExpiration** | Date | The expiration date for the options contract  
-**contractStrike** | Number | The strike price of the option contract  
+**totalValue** | Number | The aggregated value of all option contract premiums included in the trade\\  
+**totalSize** | Number | The total number of contracts involved in a single transaction  
+**averagePrice** | Number | The average premium paid per option contract  
+**contract** | String | The option contract symbol  
+**askAtExecution** | Number | Ask price at execution  
+**bidAtExecution** | Number | 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.  
+**underlyingPriceAtExecution** | Number | Price of the underlying security at execution of trade  
 
 [//]: # (END_DEFINITION)
 
@@ -25,12 +29,13 @@ Name | Type | Description
 
 <br/>
 
-#### Enum: ContractTypeEnum**
+#### Enum: SentimentEnum**
 
 Name | Value
 ---- | -----
-put | &quot;put&quot;
-call | &quot;call&quot;
+bullish | &quot;bullish&quot;
+bearish | &quot;bearish&quot;
+neutral | &quot;neutral&quot;