intrinio-sdk 7.1.0 → 7.2.0

package/README.md

@@ -1,11 +1,11 @@
-# Intrinio JavaScript SDK
+# Intrinio JavaScript SDK 
 
 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.129.0
-- Package version: 7.1.0
+- API version: 2.135.4
+- Package version: 7.2.0
 
 
 ## Installation
@@ -72,7 +72,8 @@ A listing of classes and methods is also provided below:
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*intrinioSDK.AccountApi* | [**getAccountCurrentUsage**](docs/AccountApi.md#getAccountCurrentUsage) | **GET** /account | Account Current Usage
+*intrinioSDK.AccountApi* | [**getAccountCurrentUsage**](docs/AccountApi.md#getAccountCurrentUsage) | **GET** /account/current_usage | Account Current Usage
+*intrinioSDK.AccountApi* | [**getAccountWebsocketStatuses**](docs/AccountApi.md#getAccountWebsocketStatuses) | **GET** /account/websocket_statuses | Account Websocket Statuses
 *intrinioSDK.BulkDownloadsApi* | [**getBulkDownloadLinks**](docs/BulkDownloadsApi.md#getBulkDownloadLinks) | **GET** /bulk_downloads/links | All Links
 *intrinioSDK.CompanyApi* | [**allExpectedEarningsDates**](docs/CompanyApi.md#allExpectedEarningsDates) | **GET** /companies/upcoming_earnings | All Expected Earnings Dates
 *intrinioSDK.CompanyApi* | [**expectedEarningsDatesByCompany**](docs/CompanyApi.md#expectedEarningsDatesByCompany) | **GET** /companies/{identifier}/upcoming_earnings | Expected Earnings Dates by Company
@@ -171,6 +172,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* | [**getOptionSurface**](docs/OptionsApi.md#getOptionSurface) | **GET** /options/surface/{identifier} | Option Surface
+*intrinioSDK.OptionsApi* | [**getOptionSurface_0**](docs/OptionsApi.md#getOptionSurface_0) | **GET** /options/surface/{identifier}/interpolate_iv | Option Surface
 *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
@@ -183,7 +186,8 @@ Class | Method | HTTP request | Description
 *intrinioSDK.OptionsApi* | [**getOptionsGainers**](docs/OptionsApi.md#getOptionsGainers) | **GET** /options/gainers | Options Top Gainers
 *intrinioSDK.OptionsApi* | [**getOptionsGreeksByContract**](docs/OptionsApi.md#getOptionsGreeksByContract) | **GET** /options/greeks/{contract}/realtime | Option Greeks & Derived Price by Contract
 *intrinioSDK.OptionsApi* | [**getOptionsGreeksByTicker**](docs/OptionsApi.md#getOptionsGreeksByTicker) | **GET** /options/greeks/by_ticker/{identifier}/realtime | Options Realtime Greeks & Derived Price by Ticker
-*intrinioSDK.OptionsApi* | [**getOptionsImpliedMoveBySymbol**](docs/OptionsApi.md#getOptionsImpliedMoveBySymbol) | **GET** /options/implied_move/{symbol}/{expiration_date} | Options Implied Move By Symbol
+*intrinioSDK.OptionsApi* | [**getOptionsImpliedMoveBySymbol**](docs/OptionsApi.md#getOptionsImpliedMoveBySymbol) | **GET** /options/implied_move/{symbol}/{expiration_date} | Options Implied Move (Expected) Realtime
+*intrinioSDK.OptionsApi* | [**getOptionsImpliedMoveHistoricalBySymbol**](docs/OptionsApi.md#getOptionsImpliedMoveHistoricalBySymbol) | **GET** /options/implied_move/{symbol}/{expiration_date}/historical/{as_of_date} | Options Implied Move (Expected) Historical
 *intrinioSDK.OptionsApi* | [**getOptionsIntervalByContract**](docs/OptionsApi.md#getOptionsIntervalByContract) | **GET** /options/interval/{identifier} | Options Intervals By Contract
 *intrinioSDK.OptionsApi* | [**getOptionsIntervalMovers**](docs/OptionsApi.md#getOptionsIntervalMovers) | **GET** /options/interval/movers | Options Intervals Movers
 *intrinioSDK.OptionsApi* | [**getOptionsIntervalMoversChange**](docs/OptionsApi.md#getOptionsIntervalMoversChange) | **GET** /options/interval/movers/change | Options Intervals Movers By Change
@@ -207,6 +211,8 @@ Class | Method | HTTP request | Description
 *intrinioSDK.OwnersApi* | [**institutionalHoldingsByOwner**](docs/OwnersApi.md#institutionalHoldingsByOwner) | **GET** /owners/{identifier}/institutional_holdings | Institutional Holdings by Owner
 *intrinioSDK.OwnersApi* | [**searchOwners**](docs/OwnersApi.md#searchOwners) | **GET** /owners/search | Search Owners
 *intrinioSDK.SecurityApi* | [**getAllSecurities**](docs/SecurityApi.md#getAllSecurities) | **GET** /securities | All Securities
+*intrinioSDK.SecurityApi* | [**getSecuritiesDailyShortVolume**](docs/SecurityApi.md#getSecuritiesDailyShortVolume) | **GET** /securities/daily_short_volume | Daily Short Volume
+*intrinioSDK.SecurityApi* | [**getSecuritiesDailyShortVolumeConsolidated**](docs/SecurityApi.md#getSecuritiesDailyShortVolumeConsolidated) | **GET** /securities/daily_short_volume/consolidated | Daily Short Volume Consolidated
 *intrinioSDK.SecurityApi* | [**getSecuritiesLatestDividendRecords**](docs/SecurityApi.md#getSecuritiesLatestDividendRecords) | **GET** /securities/dividends/latest | Latest Dividend Records for All Securities
 *intrinioSDK.SecurityApi* | [**getSecuritiesLatestEarningsRecords**](docs/SecurityApi.md#getSecuritiesLatestEarningsRecords) | **GET** /securities/earnings/latest | Latest Earnings Records for All Securities
 *intrinioSDK.SecurityApi* | [**getSecuritiesShortInterest**](docs/SecurityApi.md#getSecuritiesShortInterest) | **GET** /securities/short_interest | Latest Short Interest
@@ -338,6 +344,7 @@ Class | Method | HTTP request | Description
 ## Documentation for Models
 
  - [intrinioSDK.AccountCurrentUsage](docs/AccountCurrentUsage.md)
+ - [intrinioSDK.AccountWebsocketStatus](docs/AccountWebsocketStatus.md)
  - [intrinioSDK.AccumulationDistributionIndexTechnicalValue](docs/AccumulationDistributionIndexTechnicalValue.md)
  - [intrinioSDK.ApiResponseAccountUsages](docs/ApiResponseAccountUsages.md)
  - [intrinioSDK.ApiResponseAccountUsagesAccount](docs/ApiResponseAccountUsagesAccount.md)
@@ -406,6 +413,8 @@ Class | Method | HTTP request | Description
  - [intrinioSDK.ApiResponseOptionsPricesEod](docs/ApiResponseOptionsPricesEod.md)
  - [intrinioSDK.ApiResponseOptionsRealtime](docs/ApiResponseOptionsRealtime.md)
  - [intrinioSDK.ApiResponseOptionsStatsRealtime](docs/ApiResponseOptionsStatsRealtime.md)
+ - [intrinioSDK.ApiResponseOptionsSurface](docs/ApiResponseOptionsSurface.md)
+ - [intrinioSDK.ApiResponseOptionsSurfaceInterpolatedIv](docs/ApiResponseOptionsSurfaceInterpolatedIv.md)
  - [intrinioSDK.ApiResponseOptionsTickers](docs/ApiResponseOptionsTickers.md)
  - [intrinioSDK.ApiResponseOptionsUnusualActivity](docs/ApiResponseOptionsUnusualActivity.md)
  - [intrinioSDK.ApiResponseOwnerInsiderTransactionFilings](docs/ApiResponseOwnerInsiderTransactionFilings.md)
@@ -417,6 +426,8 @@ Class | Method | HTTP request | Description
  - [intrinioSDK.ApiResponseSICIndices](docs/ApiResponseSICIndices.md)
  - [intrinioSDK.ApiResponseSICIndicesSearch](docs/ApiResponseSICIndicesSearch.md)
  - [intrinioSDK.ApiResponseSecurities](docs/ApiResponseSecurities.md)
+ - [intrinioSDK.ApiResponseSecuritiesDailyShortVolume](docs/ApiResponseSecuritiesDailyShortVolume.md)
+ - [intrinioSDK.ApiResponseSecuritiesDailyShortVolumeConsolidated](docs/ApiResponseSecuritiesDailyShortVolumeConsolidated.md)
  - [intrinioSDK.ApiResponseSecuritiesDividendLatest](docs/ApiResponseSecuritiesDividendLatest.md)
  - [intrinioSDK.ApiResponseSecuritiesEarningsLatest](docs/ApiResponseSecuritiesEarningsLatest.md)
  - [intrinioSDK.ApiResponseSecuritiesSearch](docs/ApiResponseSecuritiesSearch.md)
@@ -478,6 +489,7 @@ Class | Method | HTTP request | Description
  - [intrinioSDK.ApiResponseStockMarketIndexHistoricalData](docs/ApiResponseStockMarketIndexHistoricalData.md)
  - [intrinioSDK.ApiResponseStockMarketIndices](docs/ApiResponseStockMarketIndices.md)
  - [intrinioSDK.ApiResponseStockMarketIndicesSearch](docs/ApiResponseStockMarketIndicesSearch.md)
+ - [intrinioSDK.ApiResponseWebsocketStatuses](docs/ApiResponseWebsocketStatuses.md)
  - [intrinioSDK.ApiResponseZacksAnalystRatings](docs/ApiResponseZacksAnalystRatings.md)
  - [intrinioSDK.ApiResponseZacksEBITDAConsensus](docs/ApiResponseZacksEBITDAConsensus.md)
  - [intrinioSDK.ApiResponseZacksEPSEstimates](docs/ApiResponseZacksEPSEstimates.md)
@@ -511,6 +523,8 @@ Class | Method | HTTP request | Description
  - [intrinioSDK.CompanyPublicFloat](docs/CompanyPublicFloat.md)
  - [intrinioSDK.CompanySharesOutstanding](docs/CompanySharesOutstanding.md)
  - [intrinioSDK.CompanySummary](docs/CompanySummary.md)
+ - [intrinioSDK.DailyShortVolume](docs/DailyShortVolume.md)
+ - [intrinioSDK.DailyShortVolumeConsolidated](docs/DailyShortVolumeConsolidated.md)
  - [intrinioSDK.DataTag](docs/DataTag.md)
  - [intrinioSDK.DataTagSummary](docs/DataTagSummary.md)
  - [intrinioSDK.DetrendedPriceOscillatorTechnicalValue](docs/DetrendedPriceOscillatorTechnicalValue.md)
@@ -591,6 +605,8 @@ Class | Method | HTTP request | Description
  - [intrinioSDK.OptionSnapshotGroup](docs/OptionSnapshotGroup.md)
  - [intrinioSDK.OptionSnapshotsResult](docs/OptionSnapshotsResult.md)
  - [intrinioSDK.OptionStatsRealtime](docs/OptionStatsRealtime.md)
+ - [intrinioSDK.OptionSurfaceDatum](docs/OptionSurfaceDatum.md)
+ - [intrinioSDK.OptionSurfaceFace](docs/OptionSurfaceFace.md)
  - [intrinioSDK.OptionSyntheticGreeksRealtime](docs/OptionSyntheticGreeksRealtime.md)
  - [intrinioSDK.OptionTrades](docs/OptionTrades.md)
  - [intrinioSDK.OptionTradesResult](docs/OptionTradesResult.md)

package/docs/AccountApi.md

@@ -4,7 +4,8 @@ All URIs are relative to *https://api-v2.intrinio.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**getAccountCurrentUsage**](AccountApi.md#getAccountCurrentUsage) | **GET** /account | Account Current Usage
+[**getAccountCurrentUsage**](AccountApi.md#getAccountCurrentUsage) | **GET** /account/current_usage | Account Current Usage
+[**getAccountWebsocketStatuses**](AccountApi.md#getAccountWebsocketStatuses) | **GET** /account/websocket_statuses | Account Websocket Statuses
 
 
 
@@ -22,7 +23,7 @@ Method | HTTP request | Description
 
 [//]: # (OPERATION:getAccountCurrentUsage_v2)
 
-[//]: # (ENDPOINT:/account)
+[//]: # (ENDPOINT:/account/current_usage)
 
 [//]: # (DOCUMENT_LINK:AccountApi.md#getAccountCurrentUsage)
 
@@ -78,5 +79,78 @@ This endpoint does not need any parameter.
 
 
 
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:AccountApi)
+
+[//]: # (METHOD:getAccountWebsocketStatuses)
+
+[//]: # (RETURN_TYPE:ApiResponseWebsocketStatuses)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseWebsocketStatuses.md)
+
+[//]: # (OPERATION:getAccountWebsocketStatuses_v2)
+
+[//]: # (ENDPOINT:/account/websocket_statuses)
+
+[//]: # (DOCUMENT_LINK:AccountApi.md#getAccountWebsocketStatuses)
+
+<a name="getAccountWebsocketStatuses"></a>
+## **getAccountWebsocketStatuses**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getAccountWebsocketStatuses_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseWebsocketStatuses getAccountWebsocketStatuses()
+
+#### Account Websocket Statuses
+
+
+Returns a list of all websocket statuses for the account.
+
+[//]: # (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 account = new intrinioSDK.AccountApi();
+
+account.getAccountWebsocketStatuses().then(function(data) {
+  data = JSON.stringify(data, null, 2)
+  console.log(data);
+}, function(error) {
+  console.error(error);
+});
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+This endpoint does not need any parameter.
+<br/>
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseWebsocketStatuses**](ApiResponseWebsocketStatuses.md)
+
+
+
 [//]: # (END_OPERATION)
 

package/docs/AccountWebsocketStatus.md

@@ -0,0 +1,38 @@
+
+[//]: # (CLASS:AccountWebsocketStatus)
+
+[//]: # (KIND:object)
+
+### AccountWebsocketStatus
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**feed** | String | The feed name for the connection.  
+**feedConnectionNumber** | Number | The connection number for this account within a feed.  
+**ip** | String | The IP address detected for the client connection.  
+**connectedOn** | Date | The UTC time this client connection connected to the server.  
+**statusUpdatedOn** | Date | The UTC time the server updated this client connection status data.  
+**isDelayed** | Boolean | Whether this connection is delayed an extra 15 minutes from the source. Note that the Delayed SIP source is already delayed, so this value will be false for those connections.  
+**isFirehose** | Boolean | The client connection is in firehose mode (all channels subscribed).  
+**tradeSubscriptions** | Number | The count of channel subscriptions for trade events.  
+**quoteSubscriptions** | Number | The count of channel subscriptions for ask and bid events.  
+**refreshSubscriptions** | Number | The count of channel subscriptions for refresh events (OPRA options feed only).  
+**unusualActivitySubscriptions** | Number | The count of channel subscriptions for unusual activity events (OPRA options feed only).  
+**packetsPerSecond** | Number | The packets per second sent since the last status update.  
+**totalPacketsSent** | String | The total packets sent since the beginning of this connection.  A packet is a group of events sent as one message over the websocket.  
+**eventsPerSecond** | Number | The events per second sent since the last status update.  
+**totalEvents** | String | The total events sent to this connection's server-side queue since the beginning of this connection.  An event is an individual occurrence of a trade, quote, etc.  
+**totalSentEvents** | String | The total events sent to the client inside packets. A packet is a group of events sent as one message over the websocket.  
+**totalDrops** | String | The total number of events dropped from the connection's server-side queue.  Event drops happen when the connection's server-side queue is full. The server-side queue fills due to client-side connections not receiving packets fast enough, which can be caused by a slow network, or clients not decoupling processing of packets from the receipt of packets.  
+**queueDepthPercentage** | Number | The percentage that the connection's server-side queue is full. 0-100.  
+
+[//]: # (END_DEFINITION)
+
+
+
+
+

package/docs/ApiResponseOptionsSurface.md

@@ -0,0 +1,29 @@
+
+[//]: # (CLASS:ApiResponseOptionsSurface)
+
+[//]: # (KIND:object)
+
+### ApiResponseOptionsSurface
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**updatedOn** | Date | The date and time when the surface surface data was last updated.  
+**vertices** | [**[OptionSurfaceDatum]**](OptionSurfaceDatum.md) | A list of data points for the options volatility surface.  
+**faces** | [**[OptionSurfaceFace]**](OptionSurfaceFace.md) | A list of triangular faces for the options volatility surface.  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:OptionSurfaceDatum)
+
+
+[//]: # (CONTAINED_CLASS:OptionSurfaceFace)
+
+
+
+
+

package/docs/ApiResponseOptionsSurfaceInterpolatedIv.md

@@ -0,0 +1,21 @@
+
+[//]: # (CLASS:ApiResponseOptionsSurfaceInterpolatedIv)
+
+[//]: # (KIND:object)
+
+### ApiResponseOptionsSurfaceInterpolatedIv
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**impliedVolatility** | Number | The interpolated implied volatility for the given strike and expiration, calculated from the smoothed volatility surface.  
+
+[//]: # (END_DEFINITION)
+
+
+
+
+

package/docs/ApiResponseSecuritiesDailyShortVolume.md

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

package/docs/ApiResponseSecuritiesDailyShortVolumeConsolidated.md

@@ -0,0 +1,24 @@
+
+[//]: # (CLASS:ApiResponseSecuritiesDailyShortVolumeConsolidated)
+
+[//]: # (KIND:object)
+
+### ApiResponseSecuritiesDailyShortVolumeConsolidated
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**dailyShortVolume** | [**[DailyShortVolumeConsolidated]**](DailyShortVolumeConsolidated.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:DailyShortVolumeConsolidated)
+
+
+
+
+

package/docs/ApiResponseWebsocketStatuses.md

@@ -0,0 +1,28 @@
+
+[//]: # (CLASS:ApiResponseWebsocketStatuses)
+
+[//]: # (KIND:object)
+
+### ApiResponseWebsocketStatuses
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**statuses** | [**[AccountWebsocketStatus]**](AccountWebsocketStatus.md) | The websocket statuses on the account.  
+**account** | [**ApiResponseAccountUsagesAccount**](ApiResponseAccountUsagesAccount.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:AccountWebsocketStatus)
+
+
+[//]: # (CONTAINED_CLASS:ApiResponseAccountUsagesAccount)
+
+
+
+
+

package/docs/DailyShortVolume.md

@@ -0,0 +1,28 @@
+
+[//]: # (CLASS:DailyShortVolume)
+
+[//]: # (KIND:object)
+
+### DailyShortVolume
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**securityId** | String | The unique identifier of the security.  
+**symbol** | String | The ticker symbol of the security.  
+**tradeDate** | Date | The date of the reported short volume data in YYYY-MM-DD format.  
+**reportingFacilityCode** | String | The FINRA-assigned facility code identifying which market center or reporting facility reported this short volume. Different facilities may report different short volumes for the same security on the same date.  
+**totalVolume** | Number | The total volume of shares traded at this facility. This includes both long and short sales.  
+**shortVolume** | Number | The volume of shares sold short at this facility. Short sales represent bearish positions or hedging activity.  
+**shortExemptVolume** | Number | The volume of shares sold short with exemptions (e.g., pre-borrow arrangements, market maker activities). These shorts are legally exempt from certain short sale restrictions.  
+**shortVolumeRatio** | Number | The ratio of short volume to total volume at this facility, rounded to 4 decimal places. Ranges from 0.0 to 1.0. A higher ratio indicates more short selling activity relative to overall trading volume.  
+
+[//]: # (END_DEFINITION)
+
+
+
+
+

package/docs/DailyShortVolumeConsolidated.md

@@ -0,0 +1,28 @@
+
+[//]: # (CLASS:DailyShortVolumeConsolidated)
+
+[//]: # (KIND:object)
+
+### DailyShortVolumeConsolidated
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**securityId** | String | The unique identifier of the security.  
+**symbol** | String | The ticker symbol of the security.  
+**tradeDate** | Date | The date of the reported short volume data in YYYY-MM-DD format.  
+**totalVolume** | Number | The aggregated total volume of shares traded across all FINRA reporting facilities combined. Represents the total off-exchange trading volume for the security on this date.  
+**shortVolume** | Number | The aggregated volume of shares sold short across all FINRA reporting facilities combined. Represents the total off-exchange short selling volume for the security on this date.  
+**shortExemptVolume** | Number | The aggregated volume of shares sold short with exemptions across all FINRA reporting facilities combined. Includes pre-borrow arrangements, market maker activities, and other regulated short sale exemptions.  
+**shortVolumeRatio** | Number | The ratio of aggregated short volume to aggregated total volume across all facilities, rounded to 4 decimal places. Ranges from 0.0 to 1.0.  This market-wide metric is useful for: - Comparing short selling intensity between securities - Identifying unusual short volume spikes - Tracking trends in bearish positioning - Assessing relative market sentiment toward a security   
+**sources** | [String] | The list of FINRA reporting facility codes that contributed data to this consolidated aggregate. Multiple facilities typically report on the same security daily, and their volumes are summed here.  
+
+[//]: # (END_DEFINITION)
+
+
+
+
+

package/docs/OptionSurfaceDatum.md

@@ -0,0 +1,25 @@
+
+[//]: # (CLASS:OptionSurfaceDatum)
+
+[//]: # (KIND:object)
+
+### OptionSurfaceDatum
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**strikePrice** | Number | The actual strike price.  Present when the requesting surface type is raw.  
+**unixTimestamp** | Number | The expiration DateTime.  Present when the requesting surface type is raw.  
+**forwardNaturalLogMoneyness** | Number | The natural logarithm of forward moneyness, calculated as ln(F / K), where F is the forward underlying price adjusted for risk-free rate and dividend yield over time to expiration, and K is the option strike. Present when the requesting surface type is something other than raw.  
+**squareRootTau** | Number | The square root of tau, where tau is the option’s time to expiration in years using a 365.25-day year basis. Present when the requesting surface type is something other than raw.  
+**impliedVolatility** | Number | The implied volatility of the contract calculated using the Black-Scholes Model, and smoothed if the requesting surface type was logarithmic_smoothed. Always present.  
+
+[//]: # (END_DEFINITION)
+
+
+
+
+

package/docs/OptionSurfaceFace.md

@@ -0,0 +1,23 @@
+
+[//]: # (CLASS:OptionSurfaceFace)
+
+[//]: # (KIND:object)
+
+### OptionSurfaceFace
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**vertexA** | Number | The index of vertex A in the vertices array.  
+**vertexB** | Number | The index of vertex B in the vertices array.  
+**vertexC** | Number | The index of vertex B in the vertices array.  
+
+[//]: # (END_DEFINITION)
+
+
+
+
+