intrinio-sdk 6.31.0 → 6.33.0

package/.tool-versions

@@ -1 +1 @@
-nodejs 20.7.0
+nodejs 20.7.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.70.0
-- Package version: 6.31.0
+- API version: 2.75.0
+- Package version: 6.33.0
 
 
 ## Installation
@@ -143,6 +143,7 @@ Class | Method | HTTP request | Description
 *intrinioSDK.IndexApi* | [**getEconomicIndexDataPointText**](docs/IndexApi.md#getEconomicIndexDataPointText) | **GET** /indices/economic/{identifier}/data_point/{tag}/text | Data Point (Text) for an Economic Index
 *intrinioSDK.IndexApi* | [**getEconomicIndexHistoricalData**](docs/IndexApi.md#getEconomicIndexHistoricalData) | **GET** /indices/economic/{identifier}/historical_data/{tag} | Historical Data for an Economic Index
 *intrinioSDK.IndexApi* | [**getEodIndexPriceById**](docs/IndexApi.md#getEodIndexPriceById) | **GET** /indices/{identifier}/eod | End of Day Index Prices By Identifier
+*intrinioSDK.IndexApi* | [**getIndexConstituentsById**](docs/IndexApi.md#getIndexConstituentsById) | **GET** /indices/{identifier}/constituents | Index Constituents By Index Identifier
 *intrinioSDK.IndexApi* | [**getIndexSummaryById**](docs/IndexApi.md#getIndexSummaryById) | **GET** /indices/{identifier} | Index Summary By Identifier
 *intrinioSDK.IndexApi* | [**getRealtimeIndexPriceById**](docs/IndexApi.md#getRealtimeIndexPriceById) | **GET** /indices/{identifier}/realtime | Realtime Index Price By Identifier
 *intrinioSDK.IndexApi* | [**getSicIndexById**](docs/IndexApi.md#getSicIndexById) | **GET** /indices/sic/{identifier} | Lookup SIC Index
@@ -165,6 +166,8 @@ Class | Method | HTTP request | Description
 *intrinioSDK.OptionsApi* | [**getOptionAggregates**](docs/OptionsApi.md#getOptionAggregates) | **GET** /options/aggregates | Total open interest and volume aggregated by ticker
 *intrinioSDK.OptionsApi* | [**getOptionExpirationsRealtime**](docs/OptionsApi.md#getOptionExpirationsRealtime) | **GET** /options/expirations/{symbol}/realtime | Options Expirations
 *intrinioSDK.OptionsApi* | [**getOptionStrikesRealtime**](docs/OptionsApi.md#getOptionStrikesRealtime) | **GET** /options/strikes/{symbol}/{strike}/realtime | Option Strikes Realtime
+*intrinioSDK.OptionsApi* | [**getOptionTrades**](docs/OptionsApi.md#getOptionTrades) | **GET** /options/trades | Option Trades
+*intrinioSDK.OptionsApi* | [**getOptionTradesByContract**](docs/OptionsApi.md#getOptionTradesByContract) | **GET** /options/{identifier}/trades | Option Trades By Contract
 *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
@@ -179,6 +182,7 @@ Class | Method | HTTP request | Description
 *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* | [**getOptionsPricesEodByTicker**](docs/OptionsApi.md#getOptionsPricesEodByTicker) | **GET** /options/prices/by_ticker/{symbol}/eod | Option Prices End of Day By Ticker
 *intrinioSDK.OptionsApi* | [**getOptionsPricesRealtime**](docs/OptionsApi.md#getOptionsPricesRealtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
 *intrinioSDK.OptionsApi* | [**getOptionsPricesRealtimeByTicker**](docs/OptionsApi.md#getOptionsPricesRealtimeByTicker) | **GET** /options/prices/by_ticker/{symbol}/realtime | Option Prices Realtime By Ticker
 *intrinioSDK.OptionsApi* | [**getOptionsSnapshots**](docs/OptionsApi.md#getOptionsSnapshots) | **GET** /options/snapshots | Option Prices Realtime Snapshot
@@ -254,6 +258,8 @@ Class | Method | HTTP request | Description
 *intrinioSDK.SecurityApi* | [**searchSecurities**](docs/SecurityApi.md#searchSecurities) | **GET** /securities/search | Search Securities
 *intrinioSDK.StockExchangeApi* | [**getAllStockExchanges**](docs/StockExchangeApi.md#getAllStockExchanges) | **GET** /stock_exchanges | All Stock Exchanges
 *intrinioSDK.StockExchangeApi* | [**getStockExchangeById**](docs/StockExchangeApi.md#getStockExchangeById) | **GET** /stock_exchanges/{identifier} | Lookup Stock Exchange
+*intrinioSDK.StockExchangeApi* | [**getStockExchangeGainers**](docs/StockExchangeApi.md#getStockExchangeGainers) | **GET** /stock_exchanges/{identifier}/gainers | Top Gainers by Exchange
+*intrinioSDK.StockExchangeApi* | [**getStockExchangeLosers**](docs/StockExchangeApi.md#getStockExchangeLosers) | **GET** /stock_exchanges/{identifier}/losers | Top Losers by Exchange
 *intrinioSDK.StockExchangeApi* | [**getStockExchangePriceAdjustments**](docs/StockExchangeApi.md#getStockExchangePriceAdjustments) | **GET** /stock_exchanges/{identifier}/prices/adjustments | Stock Price Adjustments by Exchange
 *intrinioSDK.StockExchangeApi* | [**getStockExchangePrices**](docs/StockExchangeApi.md#getStockExchangePrices) | **GET** /stock_exchanges/{identifier}/prices | Stock Prices by Exchange
 *intrinioSDK.StockExchangeApi* | [**getStockExchangeQuote**](docs/StockExchangeApi.md#getStockExchangeQuote) | **GET** /stock_exchanges/{identifier}/quote | Realtime Quote Prices by Exchange
@@ -349,6 +355,7 @@ Class | Method | HTTP request | Description
  - [intrinioSDK.ApiResponseForexPrices](docs/ApiResponseForexPrices.md)
  - [intrinioSDK.ApiResponseHistoricalData](docs/ApiResponseHistoricalData.md)
  - [intrinioSDK.ApiResponseIndex](docs/ApiResponseIndex.md)
+ - [intrinioSDK.ApiResponseIndexConstituents](docs/ApiResponseIndexConstituents.md)
  - [intrinioSDK.ApiResponseIndices](docs/ApiResponseIndices.md)
  - [intrinioSDK.ApiResponseInitialPublicOfferings](docs/ApiResponseInitialPublicOfferings.md)
  - [intrinioSDK.ApiResponseInsiderTransactionFilings](docs/ApiResponseInsiderTransactionFilings.md)
@@ -364,6 +371,7 @@ Class | Method | HTTP request | Description
  - [intrinioSDK.ApiResponseOptionsExpirations](docs/ApiResponseOptionsExpirations.md)
  - [intrinioSDK.ApiResponseOptionsPriceRealtime](docs/ApiResponseOptionsPriceRealtime.md)
  - [intrinioSDK.ApiResponseOptionsPricesBatchRealtime](docs/ApiResponseOptionsPricesBatchRealtime.md)
+ - [intrinioSDK.ApiResponseOptionsPricesByTickerEod](docs/ApiResponseOptionsPricesByTickerEod.md)
  - [intrinioSDK.ApiResponseOptionsPricesByTickerRealtime](docs/ApiResponseOptionsPricesByTickerRealtime.md)
  - [intrinioSDK.ApiResponseOptionsPricesEod](docs/ApiResponseOptionsPricesEod.md)
  - [intrinioSDK.ApiResponseOptionsRealtime](docs/ApiResponseOptionsRealtime.md)
@@ -424,6 +432,7 @@ Class | Method | HTTP request | Description
  - [intrinioSDK.ApiResponseSecurityZacksSalesSurprises](docs/ApiResponseSecurityZacksSalesSurprises.md)
  - [intrinioSDK.ApiResponseStandardizedFinancials](docs/ApiResponseStandardizedFinancials.md)
  - [intrinioSDK.ApiResponseStandardizedFinancialsDimensions](docs/ApiResponseStandardizedFinancialsDimensions.md)
+ - [intrinioSDK.ApiResponseStockExchangeMovers](docs/ApiResponseStockExchangeMovers.md)
  - [intrinioSDK.ApiResponseStockExchangeQuote](docs/ApiResponseStockExchangeQuote.md)
  - [intrinioSDK.ApiResponseStockExchangeRealtimeStockPrices](docs/ApiResponseStockExchangeRealtimeStockPrices.md)
  - [intrinioSDK.ApiResponseStockExchangeSecurities](docs/ApiResponseStockExchangeSecurities.md)
@@ -536,8 +545,11 @@ Class | Method | HTTP request | Description
  - [intrinioSDK.OptionSnapshotGroup](docs/OptionSnapshotGroup.md)
  - [intrinioSDK.OptionSnapshotsResult](docs/OptionSnapshotsResult.md)
  - [intrinioSDK.OptionStatsRealtime](docs/OptionStatsRealtime.md)
+ - [intrinioSDK.OptionTrades](docs/OptionTrades.md)
+ - [intrinioSDK.OptionTradesResult](docs/OptionTradesResult.md)
  - [intrinioSDK.OptionUnusualTrade](docs/OptionUnusualTrade.md)
  - [intrinioSDK.OptionsAggregate](docs/OptionsAggregate.md)
+ - [intrinioSDK.OptionsPriceEod](docs/OptionsPriceEod.md)
  - [intrinioSDK.Owner](docs/Owner.md)
  - [intrinioSDK.OwnerSummary](docs/OwnerSummary.md)
  - [intrinioSDK.RealtimeIndexPrice](docs/RealtimeIndexPrice.md)
@@ -569,6 +581,7 @@ Class | Method | HTTP request | Description
  - [intrinioSDK.StandardizedFinancialsDimension](docs/StandardizedFinancialsDimension.md)
  - [intrinioSDK.StochasticOscillatorTechnicalValue](docs/StochasticOscillatorTechnicalValue.md)
  - [intrinioSDK.StockExchange](docs/StockExchange.md)
+ - [intrinioSDK.StockExchangeMover](docs/StockExchangeMover.md)
  - [intrinioSDK.StockMarketIndex](docs/StockMarketIndex.md)
  - [intrinioSDK.StockMarketIndexSummary](docs/StockMarketIndexSummary.md)
  - [intrinioSDK.StockPrice](docs/StockPrice.md)

package/docs/ApiResponseIndexConstituents.md

@@ -0,0 +1,29 @@
+
+[//]: # (CLASS:ApiResponseIndexConstituents)
+
+[//]: # (KIND:object)
+
+### ApiResponseIndexConstituents
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**index** | [**ApiResponseIndex**](ApiResponseIndex.md) | The index  
+**date** | Date | The date when an update was last received for the index constituents  
+**constituents** | [**[SecuritySummary]**](SecuritySummary.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:ApiResponseIndex)
+
+
+[//]: # (CONTAINED_CLASS:SecuritySummary)
+
+
+
+
+

package/docs/ApiResponseOptionsPricesByTickerEod.md

@@ -0,0 +1,25 @@
+
+[//]: # (CLASS:ApiResponseOptionsPricesByTickerEod)
+
+[//]: # (KIND:object)
+
+### ApiResponseOptionsPricesByTickerEod
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.  
+**prices** | [**[OptionsPriceEod]**](OptionsPriceEod.md) | The contracts pricing for this security.  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:OptionsPriceEod)
+
+
+
+
+

package/docs/ApiResponseStockExchangeMovers.md

@@ -0,0 +1,28 @@
+
+[//]: # (CLASS:ApiResponseStockExchangeMovers)
+
+[//]: # (KIND:object)
+
+### ApiResponseStockExchangeMovers
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**movers** | [**[StockExchangeMover]**](StockExchangeMover.md) | The mover security.  
+**stockExchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:StockExchangeMover)
+
+
+[//]: # (CONTAINED_CLASS:StockExchange)
+
+
+
+
+

package/docs/FilingApi.md

@@ -71,6 +71,7 @@ var opts = {
   'industryCategory': null,
   'industryGroup': null,
   'theaEnabled': null,
+  'earningsRelease': null,
   'pageSize': 100,
   'nextPage': null
 };
@@ -99,6 +100,7 @@ Name | Type | Description  | Notes
  **industryCategory** | String| Return companies in the given industry category | [optional]   
  **industryGroup** | String| Return companies in the given industry group | [optional]   
  **theaEnabled** | Boolean| Return filings that have been read by our Thea NLP and are ready for our answers endpoint | [optional]   
+ **earningsRelease** | Boolean| Return filings that have been tagged as having Results of Operations and Financial Conditions | [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/IndexApi.md

@@ -15,6 +15,7 @@ Method | HTTP request | Description
 [**getEconomicIndexDataPointText**](IndexApi.md#getEconomicIndexDataPointText) | **GET** /indices/economic/{identifier}/data_point/{tag}/text | Data Point (Text) for an Economic Index
 [**getEconomicIndexHistoricalData**](IndexApi.md#getEconomicIndexHistoricalData) | **GET** /indices/economic/{identifier}/historical_data/{tag} | Historical Data for an Economic Index
 [**getEodIndexPriceById**](IndexApi.md#getEodIndexPriceById) | **GET** /indices/{identifier}/eod | End of Day Index Prices By Identifier
+[**getIndexConstituentsById**](IndexApi.md#getIndexConstituentsById) | **GET** /indices/{identifier}/constituents | Index Constituents By Index Identifier
 [**getIndexSummaryById**](IndexApi.md#getIndexSummaryById) | **GET** /indices/{identifier} | Index Summary By Identifier
 [**getRealtimeIndexPriceById**](IndexApi.md#getRealtimeIndexPriceById) | **GET** /indices/{identifier}/realtime | Realtime Index Price By Identifier
 [**getSicIndexById**](IndexApi.md#getSicIndexById) | **GET** /indices/sic/{identifier} | Lookup SIC Index
@@ -937,6 +938,84 @@ Name | Type | Description  | Notes
 
 
 
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:IndexApi)
+
+[//]: # (METHOD:getIndexConstituentsById)
+
+[//]: # (RETURN_TYPE:ApiResponseIndexConstituents)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseIndexConstituents.md)
+
+[//]: # (OPERATION:getIndexConstituentsById_v2)
+
+[//]: # (ENDPOINT:/indices/{identifier}/constituents)
+
+[//]: # (DOCUMENT_LINK:IndexApi.md#getIndexConstituentsById)
+
+<a name="getIndexConstituentsById"></a>
+## **getIndexConstituentsById**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getIndexConstituentsById_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseIndexConstituents getIndexConstituentsById(identifier)
+
+#### Index Constituents By Index Identifier
+
+
+
+[//]: # (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 index = new intrinioSDK.IndexApi();
+
+var identifier = "DJI";
+
+
+index.getIndexConstituentsById(identifier).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
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| The index symbol |  &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseIndexConstituents**](ApiResponseIndexConstituents.md)
+
+
+
 [//]: # (END_OPERATION)
 
 

package/docs/OptionTrades.md

@@ -0,0 +1,31 @@
+
+[//]: # (CLASS:OptionTrades)
+
+[//]: # (KIND:object)
+
+### OptionTrades
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**contract** | String | The option contract  
+**underlyingSymbol** | String | The ticker symbol  
+**timestamp** | Date | The UTC timestamp at the time of the trade.  
+**price** | Number | The price of the trade.  
+**size** | Number | The size of the trade.  
+**totalVolume** | Number | The total volume of the symbol for the day up to the timestamp point in time.  
+**askPriceAtExecution** | Number | The price of ask quote at the time of the trade.  
+**bidPriceAtExecution** | Number | The price of bid quote at the time of the trade.  
+**exchange** | String | The exchange for the trade.  
+**conditions** | String | The condition of the trade.  
+**sequenceId** | Number | The sequential ID for the trade, ordered as temporally received from the exchange.  
+
+[//]: # (END_DEFINITION)
+
+
+
+
+

package/docs/OptionTradesResult.md

@@ -0,0 +1,35 @@
+
+[//]: # (CLASS:OptionTradesResult)
+
+[//]: # (KIND:object)
+
+### OptionTradesResult
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**nextPage** | String | The token required to request the next page of the data. If null, no further results are available.  
+**source** | String | The source of the trades.  
+**trades** | [**[OptionTrades]**](OptionTrades.md) | Array of all the trades in this page of the result.  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:OptionTrades)
+
+
+
+<br/>
+
+#### Enum: SourceEnum**
+
+Name | Value
+---- | -----
+realtime | &quot;realtime&quot;
+delayed | &quot;delayed&quot;
+
+
+