intrinio-sdk 7.0.0 → 7.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -6
- package/docs/AccountApi.md +76 -2
- package/docs/AccountWebsocketStatus.md +38 -0
- package/docs/ApiResponseOptionsSurface.md +29 -0
- package/docs/ApiResponseOptionsSurfaceInterpolatedIv.md +21 -0
- package/docs/ApiResponseSecuritiesDailyShortVolume.md +25 -0
- package/docs/ApiResponseSecuritiesDailyShortVolumeConsolidated.md +24 -0
- package/docs/ApiResponseWebsocketStatuses.md +28 -0
- package/docs/DailyShortVolume.md +28 -0
- package/docs/DailyShortVolumeConsolidated.md +28 -0
- package/docs/EarningsDateEstimateWithCompany.md +6 -0
- package/docs/OptionSurfaceDatum.md +25 -0
- package/docs/OptionSurfaceFace.md +23 -0
- package/docs/OptionsApi.md +291 -4
- package/docs/SecurityApi.md +179 -1
- package/package.json +1 -1
- package/src/ApiClient.js +2 -2
- package/src/api/AccountApi.js +53 -7
- package/src/api/BulkDownloadsApi.js +2 -2
- package/src/api/CompanyApi.js +2 -2
- package/src/api/DataPointApi.js +2 -2
- package/src/api/DataTagApi.js +2 -2
- package/src/api/ESGApi.js +2 -2
- package/src/api/ETFsApi.js +2 -2
- package/src/api/FilingApi.js +2 -2
- package/src/api/ForexApi.js +2 -2
- package/src/api/FundamentalsApi.js +2 -2
- package/src/api/HistoricalDataApi.js +2 -2
- package/src/api/IndexApi.js +2 -2
- package/src/api/InsiderTransactionFilingsApi.js +2 -2
- package/src/api/MarketApi.js +2 -2
- package/src/api/MunicipalityApi.js +2 -2
- package/src/api/OptionsApi.js +261 -8
- package/src/api/OwnersApi.js +2 -2
- package/src/api/SecurityApi.js +140 -6
- package/src/api/StockExchangeApi.js +2 -2
- package/src/api/TechnicalApi.js +2 -2
- package/src/api/ZacksApi.js +2 -2
- package/src/index.js +60 -10
- package/src/model/AccountCurrentUsage.js +2 -2
- package/src/model/AccountWebsocketStatus.js +236 -0
- package/src/model/AccumulationDistributionIndexTechnicalValue.js +2 -2
- package/src/model/ApiResponseAccountUsages.js +2 -2
- package/src/model/ApiResponseAccountUsagesAccount.js +2 -2
- package/src/model/ApiResponseAllExpectedEarningsDates.js +2 -2
- package/src/model/ApiResponseBulkDownloadLinks.js +2 -2
- package/src/model/ApiResponseCompanies.js +2 -2
- package/src/model/ApiResponseCompaniesSearch.js +2 -2
- package/src/model/ApiResponseCompanyDailyMetrics.js +2 -2
- package/src/model/ApiResponseCompanyExpectedEarningsDates.js +2 -2
- package/src/model/ApiResponseCompanyFilings.js +2 -2
- package/src/model/ApiResponseCompanyFundamentals.js +2 -2
- package/src/model/ApiResponseCompanyHistoricalData.js +2 -2
- package/src/model/ApiResponseCompanyInsiderTransactionFilings.js +2 -2
- package/src/model/ApiResponseCompanyNews.js +2 -2
- package/src/model/ApiResponseCompanyNewsBody.js +2 -2
- package/src/model/ApiResponseCompanyPublicFloatResult.js +2 -2
- package/src/model/ApiResponseCompanyRecognize.js +2 -2
- package/src/model/ApiResponseCompanySecurities.js +2 -2
- package/src/model/ApiResponseCompanySharesOutstanding.js +2 -2
- package/src/model/ApiResponseDataTags.js +2 -2
- package/src/model/ApiResponseDataTagsSearch.js +2 -2
- package/src/model/ApiResponseESGCompanies.js +2 -2
- package/src/model/ApiResponseESGCompanyComprehensiveRatingHistory.js +2 -2
- package/src/model/ApiResponseESGCompanyRatingHistory.js +2 -2
- package/src/model/ApiResponseESGLatest.js +2 -2
- package/src/model/ApiResponseESGLatestComprehensive.js +2 -2
- package/src/model/ApiResponseETFHoldings.js +2 -2
- package/src/model/ApiResponseETFs.js +2 -2
- package/src/model/ApiResponseEconomicIndexHistoricalData.js +2 -2
- package/src/model/ApiResponseEconomicIndices.js +2 -2
- package/src/model/ApiResponseEconomicIndicesSearch.js +2 -2
- package/src/model/ApiResponseEodIndexPrices.js +2 -2
- package/src/model/ApiResponseEodIndexPricesAll.js +2 -2
- package/src/model/ApiResponseFilingFundamentals.js +2 -2
- package/src/model/ApiResponseFilingNotes.js +2 -2
- package/src/model/ApiResponseFilingNotesSearch.js +2 -2
- package/src/model/ApiResponseFilings.js +2 -2
- package/src/model/ApiResponseForexCurrencies.js +2 -2
- package/src/model/ApiResponseForexPairs.js +2 -2
- package/src/model/ApiResponseForexPrices.js +2 -2
- package/src/model/ApiResponseHistoricalData.js +2 -2
- package/src/model/ApiResponseIndex.js +2 -2
- package/src/model/ApiResponseIndexConstituents.js +2 -2
- package/src/model/ApiResponseIndexIntervals.js +2 -2
- package/src/model/ApiResponseIndices.js +2 -2
- package/src/model/ApiResponseInitialPublicOfferings.js +2 -2
- package/src/model/ApiResponseInsiderTransactionFilings.js +2 -2
- package/src/model/ApiResponseMunicipalities.js +2 -2
- package/src/model/ApiResponseMunicipalitiyFinancials.js +2 -2
- package/src/model/ApiResponseNews.js +2 -2
- package/src/model/ApiResponseOptionMovers.js +2 -2
- package/src/model/ApiResponseOptionPrices.js +2 -2
- package/src/model/ApiResponseOptions.js +2 -2
- package/src/model/ApiResponseOptionsAggregates.js +2 -2
- package/src/model/ApiResponseOptionsChain.js +2 -2
- package/src/model/ApiResponseOptionsChainEod.js +2 -2
- package/src/model/ApiResponseOptionsChainRealtime.js +2 -2
- package/src/model/ApiResponseOptionsExpirations.js +2 -2
- package/src/model/ApiResponseOptionsGreekContractRealtime.js +2 -2
- package/src/model/ApiResponseOptionsGreeksByTickerRealtime.js +2 -2
- package/src/model/ApiResponseOptionsImpliedMove.js +2 -2
- package/src/model/ApiResponseOptionsPriceRealtime.js +2 -2
- package/src/model/ApiResponseOptionsPricesBatchRealtime.js +2 -2
- package/src/model/ApiResponseOptionsPricesByTickerEod.js +2 -2
- package/src/model/ApiResponseOptionsPricesByTickerRealtime.js +2 -2
- package/src/model/ApiResponseOptionsPricesEod.js +2 -2
- package/src/model/ApiResponseOptionsRealtime.js +2 -2
- package/src/model/ApiResponseOptionsStatsRealtime.js +2 -2
- package/src/model/ApiResponseOptionsSurface.js +100 -0
- package/src/model/ApiResponseOptionsSurfaceInterpolatedIv.js +82 -0
- package/src/model/ApiResponseOptionsTickers.js +2 -2
- package/src/model/ApiResponseOptionsUnusualActivity.js +2 -2
- package/src/model/ApiResponseOwnerInsiderTransactionFilings.js +2 -2
- package/src/model/ApiResponseOwnerInstitutionalHoldings.js +2 -2
- package/src/model/ApiResponseOwners.js +2 -2
- package/src/model/ApiResponseRealtimeIndexPrices.js +2 -2
- package/src/model/ApiResponseReportedFinancials.js +2 -2
- package/src/model/ApiResponseSICIndexHistoricalData.js +2 -2
- package/src/model/ApiResponseSICIndices.js +2 -2
- package/src/model/ApiResponseSICIndicesSearch.js +2 -2
- package/src/model/ApiResponseSecurities.js +2 -2
- package/src/model/ApiResponseSecuritiesDailyShortVolume.js +90 -0
- package/src/model/ApiResponseSecuritiesDailyShortVolumeConsolidated.js +81 -0
- package/src/model/ApiResponseSecuritiesDividendLatest.js +2 -2
- package/src/model/ApiResponseSecuritiesEarningsLatest.js +2 -2
- package/src/model/ApiResponseSecuritiesSearch.js +2 -2
- package/src/model/ApiResponseSecuritiesShortInterest.js +2 -2
- package/src/model/ApiResponseSecurityAccumulationDistributionIndex.js +2 -2
- package/src/model/ApiResponseSecurityAverageDailyTradingVolume.js +2 -2
- package/src/model/ApiResponseSecurityAverageDirectionalIndex.js +2 -2
- package/src/model/ApiResponseSecurityAverageTrueRange.js +2 -2
- package/src/model/ApiResponseSecurityAwesomeOscillator.js +2 -2
- package/src/model/ApiResponseSecurityBollingerBands.js +2 -2
- package/src/model/ApiResponseSecurityChaikinMoneyFlow.js +2 -2
- package/src/model/ApiResponseSecurityCommodityChannelIndex.js +2 -2
- package/src/model/ApiResponseSecurityDetrendedPriceOscillator.js +2 -2
- package/src/model/ApiResponseSecurityDonchianChannel.js +2 -2
- package/src/model/ApiResponseSecurityEaseOfMovement.js +2 -2
- package/src/model/ApiResponseSecurityForceIndex.js +2 -2
- package/src/model/ApiResponseSecurityHistoricalData.js +2 -2
- package/src/model/ApiResponseSecurityIchimokuKinkoHyo.js +2 -2
- package/src/model/ApiResponseSecurityInstitutionalOwnership.js +2 -2
- package/src/model/ApiResponseSecurityIntervalPrices.js +2 -2
- package/src/model/ApiResponseSecurityKeltnerChannel.js +2 -2
- package/src/model/ApiResponseSecurityKnowSureThing.js +2 -2
- package/src/model/ApiResponseSecurityMassIndex.js +2 -2
- package/src/model/ApiResponseSecurityMoneyFlowIndex.js +2 -2
- package/src/model/ApiResponseSecurityMovingAverageConvergenceDivergence.js +2 -2
- package/src/model/ApiResponseSecurityNegativeVolumeIndex.js +2 -2
- package/src/model/ApiResponseSecurityOnBalanceVolume.js +2 -2
- package/src/model/ApiResponseSecurityOnBalanceVolumeMean.js +2 -2
- package/src/model/ApiResponseSecurityQuote.js +2 -2
- package/src/model/ApiResponseSecurityRelativeStrengthIndex.js +2 -2
- package/src/model/ApiResponseSecurityShortInterest.js +2 -2
- package/src/model/ApiResponseSecuritySimpleMovingAverage.js +2 -2
- package/src/model/ApiResponseSecurityStochasticOscillator.js +2 -2
- package/src/model/ApiResponseSecurityStockPriceAdjustments.js +2 -2
- package/src/model/ApiResponseSecurityStockPrices.js +2 -2
- package/src/model/ApiResponseSecurityTradingStatus.js +2 -2
- package/src/model/ApiResponseSecurityTradingStatuses.js +2 -2
- package/src/model/ApiResponseSecurityTripleExponentialAverage.js +2 -2
- package/src/model/ApiResponseSecurityTrueStrengthIndex.js +2 -2
- package/src/model/ApiResponseSecurityUltimateOscillator.js +2 -2
- package/src/model/ApiResponseSecurityVolumePriceTrend.js +2 -2
- package/src/model/ApiResponseSecurityVolumeWeightedAveragePrice.js +2 -2
- package/src/model/ApiResponseSecurityVortexIndicator.js +2 -2
- package/src/model/ApiResponseSecurityWilliamsR.js +2 -2
- package/src/model/ApiResponseSecurityZacksAnalystRatings.js +2 -2
- package/src/model/ApiResponseSecurityZacksAnalystRatingsSnapshot.js +2 -2
- package/src/model/ApiResponseSecurityZacksEPSSurprises.js +2 -2
- package/src/model/ApiResponseSecurityZacksSalesSurprises.js +2 -2
- package/src/model/ApiResponseStandardizedFinancials.js +2 -2
- package/src/model/ApiResponseStandardizedFinancialsDimensions.js +2 -2
- package/src/model/ApiResponseStockExchangeBetas.js +2 -2
- package/src/model/ApiResponseStockExchangeMovers.js +2 -2
- package/src/model/ApiResponseStockExchangeQuote.js +2 -2
- package/src/model/ApiResponseStockExchangeRealtimeStockPrices.js +2 -2
- package/src/model/ApiResponseStockExchangeSecurities.js +2 -2
- package/src/model/ApiResponseStockExchangeStockPriceAdjustments.js +2 -2
- package/src/model/ApiResponseStockExchangeStockPrices.js +2 -2
- package/src/model/ApiResponseStockExchanges.js +2 -2
- package/src/model/ApiResponseStockMarketIndexHistoricalData.js +2 -2
- package/src/model/ApiResponseStockMarketIndices.js +2 -2
- package/src/model/ApiResponseStockMarketIndicesSearch.js +2 -2
- package/src/model/ApiResponseWebsocketStatuses.js +91 -0
- package/src/model/ApiResponseZacksAnalystRatings.js +2 -2
- package/src/model/ApiResponseZacksEBITDAConsensus.js +2 -2
- package/src/model/ApiResponseZacksEPSEstimates.js +2 -2
- package/src/model/ApiResponseZacksEPSGrowthRates.js +2 -2
- package/src/model/ApiResponseZacksEPSSurprises.js +2 -2
- package/src/model/ApiResponseZacksETFHoldings.js +2 -2
- package/src/model/ApiResponseZacksForwardPEs.js +2 -2
- package/src/model/ApiResponseZacksInstitutionalHoldingCompanies.js +2 -2
- package/src/model/ApiResponseZacksInstitutionalHoldingOwners.js +2 -2
- package/src/model/ApiResponseZacksInstitutionalHoldings.js +2 -2
- package/src/model/ApiResponseZacksLongTermGrowthRates.js +2 -2
- package/src/model/ApiResponseZacksSalesEstimates.js +2 -2
- package/src/model/ApiResponseZacksSalesSurprises.js +2 -2
- package/src/model/ApiResponseZacksTargetPriceConsensuses.js +2 -2
- package/src/model/AverageDailyTradingVolumeTechnicalValue.js +2 -2
- package/src/model/AverageDirectionalIndexTechnicalValue.js +2 -2
- package/src/model/AverageTrueRangeTechnicalValue.js +2 -2
- package/src/model/AwesomeOscillatorTechnicalValue.js +2 -2
- package/src/model/Beta.js +2 -2
- package/src/model/BollingerBandsTechnicalValue.js +2 -2
- package/src/model/BulkDownloadLinks.js +2 -2
- package/src/model/BulkDownloadSummary.js +2 -2
- package/src/model/ChaikinMoneyFlowTechnicalValue.js +2 -2
- package/src/model/CommodityChannelIndexTechnicalValue.js +2 -2
- package/src/model/Company.js +2 -2
- package/src/model/CompanyDailyMetric.js +2 -2
- package/src/model/CompanyFiling.js +2 -2
- package/src/model/CompanyInitialPublicOffering.js +2 -2
- package/src/model/CompanyNews.js +2 -2
- package/src/model/CompanyNewsSummary.js +2 -2
- package/src/model/CompanyPublicFloat.js +2 -2
- package/src/model/CompanySharesOutstanding.js +2 -2
- package/src/model/CompanySummary.js +2 -2
- package/src/model/DailyShortVolume.js +146 -0
- package/src/model/DailyShortVolumeConsolidated.js +146 -0
- package/src/model/DataTag.js +2 -2
- package/src/model/DataTagSummary.js +2 -2
- package/src/model/DetrendedPriceOscillatorTechnicalValue.js +2 -2
- package/src/model/DividendRecord.js +2 -2
- package/src/model/DonchianChannelTechnicalValue.js +2 -2
- package/src/model/ESGCompanySummary.js +2 -2
- package/src/model/ESGComprehensiveRating.js +2 -2
- package/src/model/ESGComprehensiveRatingWithCompany.js +2 -2
- package/src/model/ESGRating.js +2 -2
- package/src/model/ESGRatingWithCompany.js +2 -2
- package/src/model/ETF.js +2 -2
- package/src/model/ETFAnalytics.js +2 -2
- package/src/model/ETFHistoricalStats.js +2 -2
- package/src/model/ETFHolding.js +2 -2
- package/src/model/ETFNavFlow.js +2 -2
- package/src/model/ETFNavFlows.js +2 -2
- package/src/model/ETFNavFlowsAll.js +2 -2
- package/src/model/ETFNavFlowsHistorical.js +2 -2
- package/src/model/ETFStats.js +2 -2
- package/src/model/ETFSummary.js +2 -2
- package/src/model/EarningsDateEstimate.js +2 -2
- package/src/model/EarningsDateEstimateConfidenceIntervals.js +2 -2
- package/src/model/EarningsDateEstimateWithCompany.js +37 -28
- package/src/model/EarningsRecord.js +2 -2
- package/src/model/EaseOfMovementTechnicalValue.js +2 -2
- package/src/model/EconomicIndex.js +2 -2
- package/src/model/EconomicIndexSummary.js +2 -2
- package/src/model/EodIndexPrice.js +2 -2
- package/src/model/EodIndexPriceSummary.js +2 -2
- package/src/model/Filing.js +2 -2
- package/src/model/FilingNote.js +2 -2
- package/src/model/FilingNoteFiling.js +2 -2
- package/src/model/FilingNoteSummary.js +2 -2
- package/src/model/FilingSummary.js +2 -2
- package/src/model/ForceIndexTechnicalValue.js +2 -2
- package/src/model/ForexCurrency.js +2 -2
- package/src/model/ForexPair.js +2 -2
- package/src/model/ForexPrice.js +2 -2
- package/src/model/Fundamental.js +2 -2
- package/src/model/FundamentalSummary.js +2 -2
- package/src/model/HistoricalData.js +2 -2
- package/src/model/IchimokuKinkoHyoTechnicalValue.js +2 -2
- package/src/model/IndexInterval.js +2 -2
- package/src/model/InsiderTransaction.js +2 -2
- package/src/model/InsiderTransactionFiling.js +2 -2
- package/src/model/InstitutionalHolding.js +2 -2
- package/src/model/InstitutionalOwnership.js +2 -2
- package/src/model/KeltnerChannelTechnicalValue.js +2 -2
- package/src/model/KnowSureThingTechnicalValue.js +2 -2
- package/src/model/MarketStatusResult.js +2 -2
- package/src/model/MassIndexTechnicalValue.js +2 -2
- package/src/model/MoneyFlowIndexTechnicalValue.js +2 -2
- package/src/model/MovingAverageConvergenceDivergenceTechnicalValue.js +2 -2
- package/src/model/Municipality.js +2 -2
- package/src/model/MunicipalityFinancial.js +2 -2
- package/src/model/NegativeVolumeIndexTechnicalValue.js +2 -2
- package/src/model/NewsTopic.js +2 -2
- package/src/model/OnBalanceVolumeMeanTechnicalValue.js +2 -2
- package/src/model/OnBalanceVolumeTechnicalValue.js +2 -2
- package/src/model/Option.js +2 -2
- package/src/model/OptionChain.js +2 -2
- package/src/model/OptionChainEod.js +2 -2
- package/src/model/OptionChainRealtime.js +2 -2
- package/src/model/OptionContractsList.js +2 -2
- package/src/model/OptionEod.js +2 -2
- package/src/model/OptionFactorsRealtime.js +2 -2
- package/src/model/OptionImpliedMoveData.js +2 -2
- package/src/model/OptionInterval.js +2 -2
- package/src/model/OptionIntervalMover.js +2 -2
- package/src/model/OptionIntervalsMoversResult.js +2 -2
- package/src/model/OptionIntervalsResult.js +2 -2
- package/src/model/OptionMover.js +2 -2
- package/src/model/OptionPrice.js +2 -2
- package/src/model/OptionPriceBatchRealtime.js +2 -2
- package/src/model/OptionPriceEod.js +2 -2
- package/src/model/OptionPriceRealtime.js +2 -2
- package/src/model/OptionPriceRealtimeExtended.js +2 -2
- package/src/model/OptionRealtime.js +2 -2
- package/src/model/OptionSnapshotGroup.js +2 -2
- package/src/model/OptionSnapshotsResult.js +2 -2
- package/src/model/OptionStatsRealtime.js +2 -2
- package/src/model/OptionSurfaceDatum.js +119 -0
- package/src/model/OptionSurfaceFace.js +101 -0
- package/src/model/OptionSyntheticGreeksRealtime.js +2 -2
- package/src/model/OptionTrades.js +2 -2
- package/src/model/OptionTradesResult.js +2 -2
- package/src/model/OptionUnusualTrade.js +2 -2
- package/src/model/OptionsAggregate.js +2 -2
- package/src/model/OptionsPriceEod.js +2 -2
- package/src/model/Owner.js +2 -2
- package/src/model/OwnerSummary.js +2 -2
- package/src/model/RealtimeIndexPrice.js +2 -2
- package/src/model/RealtimeIndexPriceIndex.js +2 -2
- package/src/model/RealtimeStockPrice.js +2 -2
- package/src/model/RealtimeStockPriceSecurity.js +2 -2
- package/src/model/RelativeStrengthIndexTechnicalValue.js +2 -2
- package/src/model/ReportedFinancial.js +2 -2
- package/src/model/ReportedFinancialDimension.js +2 -2
- package/src/model/ReportedTag.js +2 -2
- package/src/model/SICIndex.js +2 -2
- package/src/model/Security.js +2 -2
- package/src/model/SecurityHistory.js +2 -2
- package/src/model/SecurityHistoryListResult.js +2 -2
- package/src/model/SecurityIntervalMover.js +2 -2
- package/src/model/SecurityIntervalsMoversResult.js +2 -2
- package/src/model/SecurityReplayFileResult.js +2 -2
- package/src/model/SecurityScreenClause.js +2 -2
- package/src/model/SecurityScreenGroup.js +2 -2
- package/src/model/SecurityScreenResult.js +2 -2
- package/src/model/SecurityScreenResultData.js +2 -2
- package/src/model/SecuritySnapshotGroup.js +2 -2
- package/src/model/SecuritySnapshotsResult.js +2 -2
- package/src/model/SecuritySummary.js +2 -2
- package/src/model/SecurityTrades.js +2 -2
- package/src/model/SecurityTradesResult.js +2 -2
- package/src/model/SecurityTradingStatusSummary.js +2 -2
- package/src/model/ShortInterest.js +2 -2
- package/src/model/ShortInterestWithSecurity.js +2 -2
- package/src/model/SimpleMovingAverageTechnicalValue.js +2 -2
- package/src/model/StandardizedFinancial.js +2 -2
- package/src/model/StandardizedFinancialsDimension.js +2 -2
- package/src/model/StochasticOscillatorTechnicalValue.js +2 -2
- package/src/model/StockExchange.js +2 -2
- package/src/model/StockExchangeMover.js +2 -2
- package/src/model/StockMarketIndex.js +2 -2
- package/src/model/StockMarketIndexSummary.js +2 -2
- package/src/model/StockPrice.js +2 -2
- package/src/model/StockPriceAdjustment.js +2 -2
- package/src/model/StockPriceAdjustmentSummary.js +2 -2
- package/src/model/StockPriceInterval.js +2 -2
- package/src/model/StockPriceSummary.js +2 -2
- package/src/model/TechnicalIndicator.js +2 -2
- package/src/model/TheaEntityAnswer.js +2 -2
- package/src/model/TheaSourceDocument.js +2 -2
- package/src/model/TripleExponentialAverageTechnicalValue.js +2 -2
- package/src/model/TrueStrengthIndexTechnicalValue.js +2 -2
- package/src/model/UltimateOscillatorTechnicalValue.js +2 -2
- package/src/model/VolumePriceTrendTechnicalValue.js +2 -2
- package/src/model/VolumeWeightedAveragePriceValue.js +2 -2
- package/src/model/VortexIndicatorTechnicalValue.js +2 -2
- package/src/model/WilliamsRTechnicalValue.js +2 -2
- package/src/model/ZacksAnalystRating.js +2 -2
- package/src/model/ZacksAnalystRatingSnapshot.js +2 -2
- package/src/model/ZacksAnalystRatingSummary.js +2 -2
- package/src/model/ZacksEBITDAConsensus.js +2 -2
- package/src/model/ZacksEPSEstimate.js +2 -2
- package/src/model/ZacksEPSGrowthRate.js +2 -2
- package/src/model/ZacksEPSSurprise.js +2 -2
- package/src/model/ZacksEPSSurpriseSummary.js +2 -2
- package/src/model/ZacksETFHolding.js +2 -2
- package/src/model/ZacksForwardPE.js +2 -2
- package/src/model/ZacksInstitutionalHolding.js +2 -2
- package/src/model/ZacksInstitutionalHoldingCompanyDetail.js +2 -2
- package/src/model/ZacksInstitutionalHoldingCompanySummary.js +2 -2
- package/src/model/ZacksInstitutionalHoldingHistoricalSummary.js +2 -2
- package/src/model/ZacksInstitutionalHoldingOwnerDetail.js +2 -2
- package/src/model/ZacksInstitutionalHoldingOwnerSummary.js +2 -2
- package/src/model/ZacksLongTermGrowthRate.js +2 -2
- package/src/model/ZacksSalesEstimate.js +2 -2
- package/src/model/ZacksSalesSurprise.js +2 -2
- package/src/model/ZacksSalesSurpriseSummary.js +2 -2
- package/src/model/ZacksTargetPriceConsensus.js +2 -2
- package/test/api/AccountApi.spec.js +11 -1
- package/test/api/BulkDownloadsApi.spec.js +1 -1
- package/test/api/CompanyApi.spec.js +1 -1
- package/test/api/DataPointApi.spec.js +1 -1
- package/test/api/DataTagApi.spec.js +1 -1
- package/test/api/ESGApi.spec.js +1 -1
- package/test/api/ETFsApi.spec.js +1 -1
- package/test/api/FilingApi.spec.js +1 -1
- package/test/api/ForexApi.spec.js +1 -1
- package/test/api/FundamentalsApi.spec.js +1 -1
- package/test/api/HistoricalDataApi.spec.js +1 -1
- package/test/api/IndexApi.spec.js +1 -1
- package/test/api/InsiderTransactionFilingsApi.spec.js +1 -1
- package/test/api/MarketApi.spec.js +1 -1
- package/test/api/MunicipalityApi.spec.js +1 -1
- package/test/api/OptionsApi.spec.js +31 -1
- package/test/api/OwnersApi.spec.js +1 -1
- package/test/api/SecurityApi.spec.js +21 -1
- package/test/api/StockExchangeApi.spec.js +1 -1
- package/test/api/TechnicalApi.spec.js +1 -1
- package/test/api/ZacksApi.spec.js +1 -1
- package/test/model/AccountCurrentUsage.spec.js +1 -1
- package/test/model/AccountWebsocketStatus.spec.js +169 -0
- package/test/model/AccumulationDistributionIndexTechnicalValue.spec.js +1 -1
- package/test/model/ApiResponseAccountUsages.spec.js +1 -1
- package/test/model/ApiResponseAccountUsagesAccount.spec.js +1 -1
- package/test/model/ApiResponseAllExpectedEarningsDates.spec.js +1 -1
- package/test/model/ApiResponseBulkDownloadLinks.spec.js +1 -1
- package/test/model/ApiResponseCompanies.spec.js +1 -1
- package/test/model/ApiResponseCompaniesSearch.spec.js +1 -1
- package/test/model/ApiResponseCompanyDailyMetrics.spec.js +1 -1
- package/test/model/ApiResponseCompanyExpectedEarningsDates.spec.js +1 -1
- package/test/model/ApiResponseCompanyFilings.spec.js +1 -1
- package/test/model/ApiResponseCompanyFundamentals.spec.js +1 -1
- package/test/model/ApiResponseCompanyHistoricalData.spec.js +1 -1
- package/test/model/ApiResponseCompanyInsiderTransactionFilings.spec.js +1 -1
- package/test/model/ApiResponseCompanyNews.spec.js +1 -1
- package/test/model/ApiResponseCompanyNewsBody.spec.js +1 -1
- package/test/model/ApiResponseCompanyPublicFloatResult.spec.js +1 -1
- package/test/model/ApiResponseCompanyRecognize.spec.js +1 -1
- package/test/model/ApiResponseCompanySecurities.spec.js +1 -1
- package/test/model/ApiResponseCompanySharesOutstanding.spec.js +1 -1
- package/test/model/ApiResponseDataTags.spec.js +1 -1
- package/test/model/ApiResponseDataTagsSearch.spec.js +1 -1
- package/test/model/ApiResponseESGCompanies.spec.js +1 -1
- package/test/model/ApiResponseESGCompanyComprehensiveRatingHistory.spec.js +1 -1
- package/test/model/ApiResponseESGCompanyRatingHistory.spec.js +1 -1
- package/test/model/ApiResponseESGLatest.spec.js +1 -1
- package/test/model/ApiResponseESGLatestComprehensive.spec.js +1 -1
- package/test/model/ApiResponseETFHoldings.spec.js +1 -1
- package/test/model/ApiResponseETFs.spec.js +1 -1
- package/test/model/ApiResponseEconomicIndexHistoricalData.spec.js +1 -1
- package/test/model/ApiResponseEconomicIndices.spec.js +1 -1
- package/test/model/ApiResponseEconomicIndicesSearch.spec.js +1 -1
- package/test/model/ApiResponseEodIndexPrices.spec.js +1 -1
- package/test/model/ApiResponseEodIndexPricesAll.spec.js +1 -1
- package/test/model/ApiResponseFilingFundamentals.spec.js +1 -1
- package/test/model/ApiResponseFilingNotes.spec.js +1 -1
- package/test/model/ApiResponseFilingNotesSearch.spec.js +1 -1
- package/test/model/ApiResponseFilings.spec.js +1 -1
- package/test/model/ApiResponseForexCurrencies.spec.js +1 -1
- package/test/model/ApiResponseForexPairs.spec.js +1 -1
- package/test/model/ApiResponseForexPrices.spec.js +1 -1
- package/test/model/ApiResponseHistoricalData.spec.js +1 -1
- package/test/model/ApiResponseIndex.spec.js +1 -1
- package/test/model/ApiResponseIndexConstituents.spec.js +1 -1
- package/test/model/ApiResponseIndexIntervals.spec.js +1 -1
- package/test/model/ApiResponseIndices.spec.js +1 -1
- package/test/model/ApiResponseInitialPublicOfferings.spec.js +1 -1
- package/test/model/ApiResponseInsiderTransactionFilings.spec.js +1 -1
- package/test/model/ApiResponseMunicipalities.spec.js +1 -1
- package/test/model/ApiResponseMunicipalitiyFinancials.spec.js +1 -1
- package/test/model/ApiResponseNews.spec.js +1 -1
- package/test/model/ApiResponseOptionMovers.spec.js +1 -1
- package/test/model/ApiResponseOptionPrices.spec.js +1 -1
- package/test/model/ApiResponseOptions.spec.js +1 -1
- package/test/model/ApiResponseOptionsAggregates.spec.js +1 -1
- package/test/model/ApiResponseOptionsChain.spec.js +1 -1
- package/test/model/ApiResponseOptionsChainEod.spec.js +1 -1
- package/test/model/ApiResponseOptionsChainRealtime.spec.js +1 -1
- package/test/model/ApiResponseOptionsExpirations.spec.js +1 -1
- package/test/model/ApiResponseOptionsGreekContractRealtime.spec.js +1 -1
- package/test/model/ApiResponseOptionsGreeksByTickerRealtime.spec.js +1 -1
- package/test/model/ApiResponseOptionsImpliedMove.spec.js +1 -1
- package/test/model/ApiResponseOptionsPriceRealtime.spec.js +1 -1
- package/test/model/ApiResponseOptionsPricesBatchRealtime.spec.js +1 -1
- package/test/model/ApiResponseOptionsPricesByTickerEod.spec.js +1 -1
- package/test/model/ApiResponseOptionsPricesByTickerRealtime.spec.js +1 -1
- package/test/model/ApiResponseOptionsPricesEod.spec.js +1 -1
- package/test/model/ApiResponseOptionsRealtime.spec.js +1 -1
- package/test/model/ApiResponseOptionsStatsRealtime.spec.js +1 -1
- package/test/model/ApiResponseOptionsSurface.spec.js +79 -0
- package/test/model/ApiResponseOptionsSurfaceInterpolatedIv.spec.js +67 -0
- package/test/model/ApiResponseOptionsTickers.spec.js +1 -1
- package/test/model/ApiResponseOptionsUnusualActivity.spec.js +1 -1
- package/test/model/ApiResponseOwnerInsiderTransactionFilings.spec.js +1 -1
- package/test/model/ApiResponseOwnerInstitutionalHoldings.spec.js +1 -1
- package/test/model/ApiResponseOwners.spec.js +1 -1
- package/test/model/ApiResponseRealtimeIndexPrices.spec.js +1 -1
- package/test/model/ApiResponseReportedFinancials.spec.js +1 -1
- package/test/model/ApiResponseSICIndexHistoricalData.spec.js +1 -1
- package/test/model/ApiResponseSICIndices.spec.js +1 -1
- package/test/model/ApiResponseSICIndicesSearch.spec.js +1 -1
- package/test/model/ApiResponseSecurities.spec.js +1 -1
- package/test/model/ApiResponseSecuritiesDailyShortVolume.spec.js +73 -0
- package/test/model/ApiResponseSecuritiesDailyShortVolumeConsolidated.spec.js +67 -0
- package/test/model/ApiResponseSecuritiesDividendLatest.spec.js +1 -1
- package/test/model/ApiResponseSecuritiesEarningsLatest.spec.js +1 -1
- package/test/model/ApiResponseSecuritiesSearch.spec.js +1 -1
- package/test/model/ApiResponseSecuritiesShortInterest.spec.js +1 -1
- package/test/model/ApiResponseSecurityAccumulationDistributionIndex.spec.js +1 -1
- package/test/model/ApiResponseSecurityAverageDailyTradingVolume.spec.js +1 -1
- package/test/model/ApiResponseSecurityAverageDirectionalIndex.spec.js +1 -1
- package/test/model/ApiResponseSecurityAverageTrueRange.spec.js +1 -1
- package/test/model/ApiResponseSecurityAwesomeOscillator.spec.js +1 -1
- package/test/model/ApiResponseSecurityBollingerBands.spec.js +1 -1
- package/test/model/ApiResponseSecurityChaikinMoneyFlow.spec.js +1 -1
- package/test/model/ApiResponseSecurityCommodityChannelIndex.spec.js +1 -1
- package/test/model/ApiResponseSecurityDetrendedPriceOscillator.spec.js +1 -1
- package/test/model/ApiResponseSecurityDonchianChannel.spec.js +1 -1
- package/test/model/ApiResponseSecurityEaseOfMovement.spec.js +1 -1
- package/test/model/ApiResponseSecurityForceIndex.spec.js +1 -1
- package/test/model/ApiResponseSecurityHistoricalData.spec.js +1 -1
- package/test/model/ApiResponseSecurityIchimokuKinkoHyo.spec.js +1 -1
- package/test/model/ApiResponseSecurityInstitutionalOwnership.spec.js +1 -1
- package/test/model/ApiResponseSecurityIntervalPrices.spec.js +1 -1
- package/test/model/ApiResponseSecurityKeltnerChannel.spec.js +1 -1
- package/test/model/ApiResponseSecurityKnowSureThing.spec.js +1 -1
- package/test/model/ApiResponseSecurityMassIndex.spec.js +1 -1
- package/test/model/ApiResponseSecurityMoneyFlowIndex.spec.js +1 -1
- package/test/model/ApiResponseSecurityMovingAverageConvergenceDivergence.spec.js +1 -1
- package/test/model/ApiResponseSecurityNegativeVolumeIndex.spec.js +1 -1
- package/test/model/ApiResponseSecurityOnBalanceVolume.spec.js +1 -1
- package/test/model/ApiResponseSecurityOnBalanceVolumeMean.spec.js +1 -1
- package/test/model/ApiResponseSecurityQuote.spec.js +1 -1
- package/test/model/ApiResponseSecurityRelativeStrengthIndex.spec.js +1 -1
- package/test/model/ApiResponseSecurityShortInterest.spec.js +1 -1
- package/test/model/ApiResponseSecuritySimpleMovingAverage.spec.js +1 -1
- package/test/model/ApiResponseSecurityStochasticOscillator.spec.js +1 -1
- package/test/model/ApiResponseSecurityStockPriceAdjustments.spec.js +1 -1
- package/test/model/ApiResponseSecurityStockPrices.spec.js +1 -1
- package/test/model/ApiResponseSecurityTradingStatus.spec.js +1 -1
- package/test/model/ApiResponseSecurityTradingStatuses.spec.js +1 -1
- package/test/model/ApiResponseSecurityTripleExponentialAverage.spec.js +1 -1
- package/test/model/ApiResponseSecurityTrueStrengthIndex.spec.js +1 -1
- package/test/model/ApiResponseSecurityUltimateOscillator.spec.js +1 -1
- package/test/model/ApiResponseSecurityVolumePriceTrend.spec.js +1 -1
- package/test/model/ApiResponseSecurityVolumeWeightedAveragePrice.spec.js +1 -1
- package/test/model/ApiResponseSecurityVortexIndicator.spec.js +1 -1
- package/test/model/ApiResponseSecurityWilliamsR.spec.js +1 -1
- package/test/model/ApiResponseSecurityZacksAnalystRatings.spec.js +1 -1
- package/test/model/ApiResponseSecurityZacksAnalystRatingsSnapshot.spec.js +1 -1
- package/test/model/ApiResponseSecurityZacksEPSSurprises.spec.js +1 -1
- package/test/model/ApiResponseSecurityZacksSalesSurprises.spec.js +1 -1
- package/test/model/ApiResponseStandardizedFinancials.spec.js +1 -1
- package/test/model/ApiResponseStandardizedFinancialsDimensions.spec.js +1 -1
- package/test/model/ApiResponseStockExchangeBetas.spec.js +1 -1
- package/test/model/ApiResponseStockExchangeMovers.spec.js +1 -1
- package/test/model/ApiResponseStockExchangeQuote.spec.js +1 -1
- package/test/model/ApiResponseStockExchangeRealtimeStockPrices.spec.js +1 -1
- package/test/model/ApiResponseStockExchangeSecurities.spec.js +1 -1
- package/test/model/ApiResponseStockExchangeStockPriceAdjustments.spec.js +1 -1
- package/test/model/ApiResponseStockExchangeStockPrices.spec.js +1 -1
- package/test/model/ApiResponseStockExchanges.spec.js +1 -1
- package/test/model/ApiResponseStockMarketIndexHistoricalData.spec.js +1 -1
- package/test/model/ApiResponseStockMarketIndices.spec.js +1 -1
- package/test/model/ApiResponseStockMarketIndicesSearch.spec.js +1 -1
- package/test/model/ApiResponseWebsocketStatuses.spec.js +73 -0
- package/test/model/ApiResponseZacksAnalystRatings.spec.js +1 -1
- package/test/model/ApiResponseZacksEBITDAConsensus.spec.js +1 -1
- package/test/model/ApiResponseZacksEPSEstimates.spec.js +1 -1
- package/test/model/ApiResponseZacksEPSGrowthRates.spec.js +1 -1
- package/test/model/ApiResponseZacksEPSSurprises.spec.js +1 -1
- package/test/model/ApiResponseZacksETFHoldings.spec.js +1 -1
- package/test/model/ApiResponseZacksForwardPEs.spec.js +1 -1
- package/test/model/ApiResponseZacksInstitutionalHoldingCompanies.spec.js +1 -1
- package/test/model/ApiResponseZacksInstitutionalHoldingOwners.spec.js +1 -1
- package/test/model/ApiResponseZacksInstitutionalHoldings.spec.js +1 -1
- package/test/model/ApiResponseZacksLongTermGrowthRates.spec.js +1 -1
- package/test/model/ApiResponseZacksSalesEstimates.spec.js +1 -1
- package/test/model/ApiResponseZacksSalesSurprises.spec.js +1 -1
- package/test/model/ApiResponseZacksTargetPriceConsensuses.spec.js +1 -1
- package/test/model/AverageDailyTradingVolumeTechnicalValue.spec.js +1 -1
- package/test/model/AverageDirectionalIndexTechnicalValue.spec.js +1 -1
- package/test/model/AverageTrueRangeTechnicalValue.spec.js +1 -1
- package/test/model/AwesomeOscillatorTechnicalValue.spec.js +1 -1
- package/test/model/Beta.spec.js +1 -1
- package/test/model/BollingerBandsTechnicalValue.spec.js +1 -1
- package/test/model/BulkDownloadLinks.spec.js +1 -1
- package/test/model/BulkDownloadSummary.spec.js +1 -1
- package/test/model/ChaikinMoneyFlowTechnicalValue.spec.js +1 -1
- package/test/model/CommodityChannelIndexTechnicalValue.spec.js +1 -1
- package/test/model/Company.spec.js +1 -1
- package/test/model/CompanyDailyMetric.spec.js +1 -1
- package/test/model/CompanyFiling.spec.js +1 -1
- package/test/model/CompanyInitialPublicOffering.spec.js +1 -1
- package/test/model/CompanyNews.spec.js +1 -1
- package/test/model/CompanyNewsSummary.spec.js +1 -1
- package/test/model/CompanyPublicFloat.spec.js +1 -1
- package/test/model/CompanySharesOutstanding.spec.js +1 -1
- package/test/model/CompanySummary.spec.js +1 -1
- package/test/model/DailyShortVolume.spec.js +109 -0
- package/test/model/DailyShortVolumeConsolidated.spec.js +109 -0
- package/test/model/DataTag.spec.js +1 -1
- package/test/model/DataTagSummary.spec.js +1 -1
- package/test/model/DetrendedPriceOscillatorTechnicalValue.spec.js +1 -1
- package/test/model/DividendRecord.spec.js +1 -1
- package/test/model/DonchianChannelTechnicalValue.spec.js +1 -1
- package/test/model/ESGCompanySummary.spec.js +1 -1
- package/test/model/ESGComprehensiveRating.spec.js +1 -1
- package/test/model/ESGComprehensiveRatingWithCompany.spec.js +1 -1
- package/test/model/ESGRating.spec.js +1 -1
- package/test/model/ESGRatingWithCompany.spec.js +1 -1
- package/test/model/ETF.spec.js +1 -1
- package/test/model/ETFAnalytics.spec.js +1 -1
- package/test/model/ETFHistoricalStats.spec.js +1 -1
- package/test/model/ETFHolding.spec.js +1 -1
- package/test/model/ETFNavFlow.spec.js +1 -1
- package/test/model/ETFNavFlows.spec.js +1 -1
- package/test/model/ETFNavFlowsAll.spec.js +1 -1
- package/test/model/ETFNavFlowsHistorical.spec.js +1 -1
- package/test/model/ETFStats.spec.js +1 -1
- package/test/model/ETFSummary.spec.js +1 -1
- package/test/model/EarningsDateEstimate.spec.js +1 -1
- package/test/model/EarningsDateEstimateConfidenceIntervals.spec.js +1 -1
- package/test/model/EarningsDateEstimateWithCompany.spec.js +37 -1
- package/test/model/EarningsRecord.spec.js +1 -1
- package/test/model/EaseOfMovementTechnicalValue.spec.js +1 -1
- package/test/model/EconomicIndex.spec.js +1 -1
- package/test/model/EconomicIndexSummary.spec.js +1 -1
- package/test/model/EodIndexPrice.spec.js +1 -1
- package/test/model/EodIndexPriceSummary.spec.js +1 -1
- package/test/model/Filing.spec.js +1 -1
- package/test/model/FilingNote.spec.js +1 -1
- package/test/model/FilingNoteFiling.spec.js +1 -1
- package/test/model/FilingNoteSummary.spec.js +1 -1
- package/test/model/FilingSummary.spec.js +1 -1
- package/test/model/ForceIndexTechnicalValue.spec.js +1 -1
- package/test/model/ForexCurrency.spec.js +1 -1
- package/test/model/ForexPair.spec.js +1 -1
- package/test/model/ForexPrice.spec.js +1 -1
- package/test/model/Fundamental.spec.js +1 -1
- package/test/model/FundamentalSummary.spec.js +1 -1
- package/test/model/HistoricalData.spec.js +1 -1
- package/test/model/IchimokuKinkoHyoTechnicalValue.spec.js +1 -1
- package/test/model/IndexInterval.spec.js +1 -1
- package/test/model/InsiderTransaction.spec.js +1 -1
- package/test/model/InsiderTransactionFiling.spec.js +1 -1
- package/test/model/InstitutionalHolding.spec.js +1 -1
- package/test/model/InstitutionalOwnership.spec.js +1 -1
- package/test/model/KeltnerChannelTechnicalValue.spec.js +1 -1
- package/test/model/KnowSureThingTechnicalValue.spec.js +1 -1
- package/test/model/MarketStatusResult.spec.js +1 -1
- package/test/model/MassIndexTechnicalValue.spec.js +1 -1
- package/test/model/MoneyFlowIndexTechnicalValue.spec.js +1 -1
- package/test/model/MovingAverageConvergenceDivergenceTechnicalValue.spec.js +1 -1
- package/test/model/Municipality.spec.js +1 -1
- package/test/model/MunicipalityFinancial.spec.js +1 -1
- package/test/model/NegativeVolumeIndexTechnicalValue.spec.js +1 -1
- package/test/model/NewsTopic.spec.js +1 -1
- package/test/model/OnBalanceVolumeMeanTechnicalValue.spec.js +1 -1
- package/test/model/OnBalanceVolumeTechnicalValue.spec.js +1 -1
- package/test/model/Option.spec.js +1 -1
- package/test/model/OptionChain.spec.js +1 -1
- package/test/model/OptionChainEod.spec.js +1 -1
- package/test/model/OptionChainRealtime.spec.js +1 -1
- package/test/model/OptionContractsList.spec.js +1 -1
- package/test/model/OptionEod.spec.js +1 -1
- package/test/model/OptionFactorsRealtime.spec.js +1 -1
- package/test/model/OptionImpliedMoveData.spec.js +1 -1
- package/test/model/OptionInterval.spec.js +1 -1
- package/test/model/OptionIntervalMover.spec.js +1 -1
- package/test/model/OptionIntervalsMoversResult.spec.js +1 -1
- package/test/model/OptionIntervalsResult.spec.js +1 -1
- package/test/model/OptionMover.spec.js +1 -1
- package/test/model/OptionPrice.spec.js +1 -1
- package/test/model/OptionPriceBatchRealtime.spec.js +1 -1
- package/test/model/OptionPriceEod.spec.js +1 -1
- package/test/model/OptionPriceRealtime.spec.js +1 -1
- package/test/model/OptionPriceRealtimeExtended.spec.js +1 -1
- package/test/model/OptionRealtime.spec.js +1 -1
- package/test/model/OptionSnapshotGroup.spec.js +1 -1
- package/test/model/OptionSnapshotsResult.spec.js +1 -1
- package/test/model/OptionStatsRealtime.spec.js +1 -1
- package/test/model/OptionSurfaceDatum.spec.js +91 -0
- package/test/model/OptionSurfaceFace.spec.js +79 -0
- package/test/model/OptionSyntheticGreeksRealtime.spec.js +1 -1
- package/test/model/OptionTrades.spec.js +1 -1
- package/test/model/OptionTradesResult.spec.js +1 -1
- package/test/model/OptionUnusualTrade.spec.js +1 -1
- package/test/model/OptionsAggregate.spec.js +1 -1
- package/test/model/OptionsPriceEod.spec.js +1 -1
- package/test/model/Owner.spec.js +1 -1
- package/test/model/OwnerSummary.spec.js +1 -1
- package/test/model/RealtimeIndexPrice.spec.js +1 -1
- package/test/model/RealtimeIndexPriceIndex.spec.js +1 -1
- package/test/model/RealtimeStockPrice.spec.js +1 -1
- package/test/model/RealtimeStockPriceSecurity.spec.js +1 -1
- package/test/model/RelativeStrengthIndexTechnicalValue.spec.js +1 -1
- package/test/model/ReportedFinancial.spec.js +1 -1
- package/test/model/ReportedFinancialDimension.spec.js +1 -1
- package/test/model/ReportedTag.spec.js +1 -1
- package/test/model/SICIndex.spec.js +1 -1
- package/test/model/Security.spec.js +1 -1
- package/test/model/SecurityHistory.spec.js +1 -1
- package/test/model/SecurityHistoryListResult.spec.js +1 -1
- package/test/model/SecurityIntervalMover.spec.js +1 -1
- package/test/model/SecurityIntervalsMoversResult.spec.js +1 -1
- package/test/model/SecurityReplayFileResult.spec.js +1 -1
- package/test/model/SecurityScreenClause.spec.js +1 -1
- package/test/model/SecurityScreenGroup.spec.js +1 -1
- package/test/model/SecurityScreenResult.spec.js +1 -1
- package/test/model/SecurityScreenResultData.spec.js +1 -1
- package/test/model/SecuritySnapshotGroup.spec.js +1 -1
- package/test/model/SecuritySnapshotsResult.spec.js +1 -1
- package/test/model/SecuritySummary.spec.js +1 -1
- package/test/model/SecurityTrades.spec.js +1 -1
- package/test/model/SecurityTradesResult.spec.js +1 -1
- package/test/model/SecurityTradingStatusSummary.spec.js +1 -1
- package/test/model/ShortInterest.spec.js +1 -1
- package/test/model/ShortInterestWithSecurity.spec.js +1 -1
- package/test/model/SimpleMovingAverageTechnicalValue.spec.js +1 -1
- package/test/model/StandardizedFinancial.spec.js +1 -1
- package/test/model/StandardizedFinancialsDimension.spec.js +1 -1
- package/test/model/StochasticOscillatorTechnicalValue.spec.js +1 -1
- package/test/model/StockExchange.spec.js +1 -1
- package/test/model/StockExchangeMover.spec.js +1 -1
- package/test/model/StockMarketIndex.spec.js +1 -1
- package/test/model/StockMarketIndexSummary.spec.js +1 -1
- package/test/model/StockPrice.spec.js +1 -1
- package/test/model/StockPriceAdjustment.spec.js +1 -1
- package/test/model/StockPriceAdjustmentSummary.spec.js +1 -1
- package/test/model/StockPriceInterval.spec.js +1 -1
- package/test/model/StockPriceSummary.spec.js +1 -1
- package/test/model/TechnicalIndicator.spec.js +1 -1
- package/test/model/TheaEntityAnswer.spec.js +1 -1
- package/test/model/TheaSourceDocument.spec.js +1 -1
- package/test/model/TripleExponentialAverageTechnicalValue.spec.js +1 -1
- package/test/model/TrueStrengthIndexTechnicalValue.spec.js +1 -1
- package/test/model/UltimateOscillatorTechnicalValue.spec.js +1 -1
- package/test/model/VolumePriceTrendTechnicalValue.spec.js +1 -1
- package/test/model/VolumeWeightedAveragePriceValue.spec.js +1 -1
- package/test/model/VortexIndicatorTechnicalValue.spec.js +1 -1
- package/test/model/WilliamsRTechnicalValue.spec.js +1 -1
- package/test/model/ZacksAnalystRating.spec.js +1 -1
- package/test/model/ZacksAnalystRatingSnapshot.spec.js +1 -1
- package/test/model/ZacksAnalystRatingSummary.spec.js +1 -1
- package/test/model/ZacksEBITDAConsensus.spec.js +1 -1
- package/test/model/ZacksEPSEstimate.spec.js +1 -1
- package/test/model/ZacksEPSGrowthRate.spec.js +1 -1
- package/test/model/ZacksEPSSurprise.spec.js +1 -1
- package/test/model/ZacksEPSSurpriseSummary.spec.js +1 -1
- package/test/model/ZacksETFHolding.spec.js +1 -1
- package/test/model/ZacksForwardPE.spec.js +1 -1
- package/test/model/ZacksInstitutionalHolding.spec.js +1 -1
- package/test/model/ZacksInstitutionalHoldingCompanyDetail.spec.js +1 -1
- package/test/model/ZacksInstitutionalHoldingCompanySummary.spec.js +1 -1
- package/test/model/ZacksInstitutionalHoldingHistoricalSummary.spec.js +1 -1
- package/test/model/ZacksInstitutionalHoldingOwnerDetail.spec.js +1 -1
- package/test/model/ZacksInstitutionalHoldingOwnerSummary.spec.js +1 -1
- package/test/model/ZacksLongTermGrowthRate.spec.js +1 -1
- package/test/model/ZacksSalesEstimate.spec.js +1 -1
- package/test/model/ZacksSalesSurprise.spec.js +1 -1
- package/test/model/ZacksSalesSurpriseSummary.spec.js +1 -1
- package/test/model/ZacksTargetPriceConsensus.spec.js +1 -1
package/docs/OptionsApi.md
CHANGED
|
@@ -8,6 +8,8 @@ Method | HTTP request | Description
|
|
|
8
8
|
[**getOptionAggregates**](OptionsApi.md#getOptionAggregates) | **GET** /options/aggregates | Total open interest and volume aggregated by ticker
|
|
9
9
|
[**getOptionExpirationsRealtime**](OptionsApi.md#getOptionExpirationsRealtime) | **GET** /options/expirations/{symbol}/realtime | Options Expirations
|
|
10
10
|
[**getOptionStrikesRealtime**](OptionsApi.md#getOptionStrikesRealtime) | **GET** /options/strikes/{symbol}/{strike}/realtime | Option Strikes Realtime
|
|
11
|
+
[**getOptionSurface**](OptionsApi.md#getOptionSurface) | **GET** /options/surface/{identifier} | Option Surface
|
|
12
|
+
[**getOptionSurface_0**](OptionsApi.md#getOptionSurface_0) | **GET** /options/surface/{identifier}/interpolate_iv | Option Surface
|
|
11
13
|
[**getOptionTrades**](OptionsApi.md#getOptionTrades) | **GET** /options/trades | Option Trades
|
|
12
14
|
[**getOptionTradesByContract**](OptionsApi.md#getOptionTradesByContract) | **GET** /options/{identifier}/trades | Option Trades By Contract
|
|
13
15
|
[**getOptions**](OptionsApi.md#getOptions) | **GET** /options/{symbol} | Options
|
|
@@ -20,7 +22,8 @@ Method | HTTP request | Description
|
|
|
20
22
|
[**getOptionsGainers**](OptionsApi.md#getOptionsGainers) | **GET** /options/gainers | Options Top Gainers
|
|
21
23
|
[**getOptionsGreeksByContract**](OptionsApi.md#getOptionsGreeksByContract) | **GET** /options/greeks/{contract}/realtime | Option Greeks & Derived Price by Contract
|
|
22
24
|
[**getOptionsGreeksByTicker**](OptionsApi.md#getOptionsGreeksByTicker) | **GET** /options/greeks/by_ticker/{identifier}/realtime | Options Realtime Greeks & Derived Price by Ticker
|
|
23
|
-
[**getOptionsImpliedMoveBySymbol**](OptionsApi.md#getOptionsImpliedMoveBySymbol) | **GET** /options/implied_move/{symbol}/{expiration_date} | Options Implied Move
|
|
25
|
+
[**getOptionsImpliedMoveBySymbol**](OptionsApi.md#getOptionsImpliedMoveBySymbol) | **GET** /options/implied_move/{symbol}/{expiration_date} | Options Implied Move (Expected) Realtime
|
|
26
|
+
[**getOptionsImpliedMoveHistoricalBySymbol**](OptionsApi.md#getOptionsImpliedMoveHistoricalBySymbol) | **GET** /options/implied_move/{symbol}/{expiration_date}/historical/{as_of_date} | Options Implied Move (Expected) Historical
|
|
24
27
|
[**getOptionsIntervalByContract**](OptionsApi.md#getOptionsIntervalByContract) | **GET** /options/interval/{identifier} | Options Intervals By Contract
|
|
25
28
|
[**getOptionsIntervalMovers**](OptionsApi.md#getOptionsIntervalMovers) | **GET** /options/interval/movers | Options Intervals Movers
|
|
26
29
|
[**getOptionsIntervalMoversChange**](OptionsApi.md#getOptionsIntervalMoversChange) | **GET** /options/interval/movers/change | Options Intervals Movers By Change
|
|
@@ -386,6 +389,182 @@ Name | Type | Description | Notes
|
|
|
386
389
|
|
|
387
390
|
|
|
388
391
|
|
|
392
|
+
[//]: # (END_OPERATION)
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
[//]: # (START_OPERATION)
|
|
396
|
+
|
|
397
|
+
[//]: # (CLASS:OptionsApi)
|
|
398
|
+
|
|
399
|
+
[//]: # (METHOD:getOptionSurface)
|
|
400
|
+
|
|
401
|
+
[//]: # (RETURN_TYPE:ApiResponseOptionsSurface)
|
|
402
|
+
|
|
403
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
404
|
+
|
|
405
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsSurface.md)
|
|
406
|
+
|
|
407
|
+
[//]: # (OPERATION:getOptionSurface_v2)
|
|
408
|
+
|
|
409
|
+
[//]: # (ENDPOINT:/options/surface/{identifier})
|
|
410
|
+
|
|
411
|
+
[//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionSurface)
|
|
412
|
+
|
|
413
|
+
<a name="getOptionSurface"></a>
|
|
414
|
+
## **getOptionSurface**
|
|
415
|
+
|
|
416
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionSurface_v2)
|
|
417
|
+
|
|
418
|
+
[//]: # (START_OVERVIEW)
|
|
419
|
+
|
|
420
|
+
> ApiResponseOptionsSurface getOptionSurface(identifier, surfaceType, opts)
|
|
421
|
+
|
|
422
|
+
#### Option Surface
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
Returns the implied volatility surface for a ticker symbol.
|
|
426
|
+
|
|
427
|
+
[//]: # (END_OVERVIEW)
|
|
428
|
+
|
|
429
|
+
### Example
|
|
430
|
+
|
|
431
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
432
|
+
|
|
433
|
+
```javascript
|
|
434
|
+
var intrinioSDK = require('intrinio-sdk');
|
|
435
|
+
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
|
|
436
|
+
intrinioSDK.ApiClient.instance.enableRetries = true;
|
|
437
|
+
|
|
438
|
+
var options = new intrinioSDK.OptionsApi();
|
|
439
|
+
|
|
440
|
+
var identifier = "AAPL";
|
|
441
|
+
var surfaceType = null;
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
var opts = {
|
|
445
|
+
'source': null
|
|
446
|
+
};
|
|
447
|
+
|
|
448
|
+
options.getOptionSurface(identifier, surfaceType, opts).then(function(data) {
|
|
449
|
+
data = JSON.stringify(data, null, 2)
|
|
450
|
+
console.log(data);
|
|
451
|
+
}, function(error) {
|
|
452
|
+
console.error(error);
|
|
453
|
+
});
|
|
454
|
+
```
|
|
455
|
+
|
|
456
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
457
|
+
|
|
458
|
+
### Parameters
|
|
459
|
+
|
|
460
|
+
[//]: # (START_PARAMETERS)
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
Name | Type | Description | Notes
|
|
464
|
+
------------- | ------------- | ------------- | -------------
|
|
465
|
+
**identifier** | String| The ticker symbol for the surface data being requested. |
|
|
466
|
+
**surfaceType** | String| The form of the surface being requested. |
|
|
467
|
+
**source** | String| The specific source of the data being requested. | [optional]
|
|
468
|
+
<br/>
|
|
469
|
+
|
|
470
|
+
[//]: # (END_PARAMETERS)
|
|
471
|
+
|
|
472
|
+
### Return type
|
|
473
|
+
|
|
474
|
+
[**ApiResponseOptionsSurface**](ApiResponseOptionsSurface.md)
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
[//]: # (END_OPERATION)
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
[//]: # (START_OPERATION)
|
|
482
|
+
|
|
483
|
+
[//]: # (CLASS:OptionsApi)
|
|
484
|
+
|
|
485
|
+
[//]: # (METHOD:getOptionSurface_0)
|
|
486
|
+
|
|
487
|
+
[//]: # (RETURN_TYPE:ApiResponseOptionsSurfaceInterpolatedIv)
|
|
488
|
+
|
|
489
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
490
|
+
|
|
491
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsSurfaceInterpolatedIv.md)
|
|
492
|
+
|
|
493
|
+
[//]: # (OPERATION:getOptionSurface_0_v2)
|
|
494
|
+
|
|
495
|
+
[//]: # (ENDPOINT:/options/surface/{identifier}/interpolate_iv)
|
|
496
|
+
|
|
497
|
+
[//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionSurface_0)
|
|
498
|
+
|
|
499
|
+
<a name="getOptionSurface_0"></a>
|
|
500
|
+
## **getOptionSurface_0**
|
|
501
|
+
|
|
502
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionSurface_0_v2)
|
|
503
|
+
|
|
504
|
+
[//]: # (START_OVERVIEW)
|
|
505
|
+
|
|
506
|
+
> ApiResponseOptionsSurfaceInterpolatedIv getOptionSurface_0(identifier, expiration, strike, opts)
|
|
507
|
+
|
|
508
|
+
#### Option Surface
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
The interpolated implied volatility is the implied volatility calculated from an arbitrary point on the smoothed volatility surface.
|
|
512
|
+
|
|
513
|
+
[//]: # (END_OVERVIEW)
|
|
514
|
+
|
|
515
|
+
### Example
|
|
516
|
+
|
|
517
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
518
|
+
|
|
519
|
+
```javascript
|
|
520
|
+
var intrinioSDK = require('intrinio-sdk');
|
|
521
|
+
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
|
|
522
|
+
intrinioSDK.ApiClient.instance.enableRetries = true;
|
|
523
|
+
|
|
524
|
+
var options = new intrinioSDK.OptionsApi();
|
|
525
|
+
|
|
526
|
+
var identifier = "SPY";
|
|
527
|
+
var expiration = null;
|
|
528
|
+
var strike = 715;
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
var opts = {
|
|
532
|
+
'source': null,
|
|
533
|
+
'asOf': null
|
|
534
|
+
};
|
|
535
|
+
|
|
536
|
+
options.getOptionSurface_0(identifier, expiration, strike, opts).then(function(data) {
|
|
537
|
+
data = JSON.stringify(data, null, 2)
|
|
538
|
+
console.log(data);
|
|
539
|
+
}, function(error) {
|
|
540
|
+
console.error(error);
|
|
541
|
+
});
|
|
542
|
+
```
|
|
543
|
+
|
|
544
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
545
|
+
|
|
546
|
+
### Parameters
|
|
547
|
+
|
|
548
|
+
[//]: # (START_PARAMETERS)
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
Name | Type | Description | Notes
|
|
552
|
+
------------- | ------------- | ------------- | -------------
|
|
553
|
+
**identifier** | String| The ticker symbol for the surface data being requested. |
|
|
554
|
+
**expiration** | Date| The DateTime of the expiration for the contract to calculate implied volatility from the surface. |
|
|
555
|
+
**strike** | Number| The strike for the contract to calculate implied volatility from the surface. |
|
|
556
|
+
**source** | String| The specific source of the data being requested. | [optional]
|
|
557
|
+
**asOf** | Date| The time to use in calculating time until expiration. Defaults to the current time. | [optional]
|
|
558
|
+
<br/>
|
|
559
|
+
|
|
560
|
+
[//]: # (END_PARAMETERS)
|
|
561
|
+
|
|
562
|
+
### Return type
|
|
563
|
+
|
|
564
|
+
[**ApiResponseOptionsSurfaceInterpolatedIv**](ApiResponseOptionsSurfaceInterpolatedIv.md)
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
|
|
389
568
|
[//]: # (END_OPERATION)
|
|
390
569
|
|
|
391
570
|
|
|
@@ -940,7 +1119,10 @@ var opts = {
|
|
|
940
1119
|
'strikeGreaterThan': null,
|
|
941
1120
|
'strikeLessThan': null,
|
|
942
1121
|
'date': null,
|
|
943
|
-
'includeRelatedSymbols': false
|
|
1122
|
+
'includeRelatedSymbols': false,
|
|
1123
|
+
'recalculateStats': false,
|
|
1124
|
+
'model': "black_scholes",
|
|
1125
|
+
'ivMode': "ivMode_example"
|
|
944
1126
|
};
|
|
945
1127
|
|
|
946
1128
|
options.getOptionsChainEod(symbol, expiration, opts).then(function(data) {
|
|
@@ -968,6 +1150,9 @@ Name | Type | Description | Notes
|
|
|
968
1150
|
**strikeLessThan** | Number| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]
|
|
969
1151
|
**date** | Date| The date to retrieve prices for | [optional]
|
|
970
1152
|
**includeRelatedSymbols** | Boolean| Include related symbols that end in a 1 or 2 because of a corporate action. | [optional]
|
|
1153
|
+
**recalculateStats** | Boolean| Recalculate implied volatility and greeks on the fly using end-of-day underlying prices. | [optional] [default to false]
|
|
1154
|
+
**model** | String| The options pricing model to use when recalculating stats. | [optional] [default to black_scholes]
|
|
1155
|
+
**ivMode** | String| The implied volatility calculation mode to use when recalculating stats. | [optional]
|
|
971
1156
|
<br/>
|
|
972
1157
|
|
|
973
1158
|
[//]: # (END_PARAMETERS)
|
|
@@ -1574,7 +1759,7 @@ Name | Type | Description | Notes
|
|
|
1574
1759
|
|
|
1575
1760
|
> ApiResponseOptionsImpliedMove getOptionsImpliedMoveBySymbol(symbol, expirationDate, opts)
|
|
1576
1761
|
|
|
1577
|
-
#### Options Implied Move
|
|
1762
|
+
#### Options Implied Move (Expected) Realtime
|
|
1578
1763
|
|
|
1579
1764
|
|
|
1580
1765
|
Returns the implied move data points for a ticker symbol.
|
|
@@ -1632,6 +1817,96 @@ Name | Type | Description | Notes
|
|
|
1632
1817
|
|
|
1633
1818
|
|
|
1634
1819
|
|
|
1820
|
+
[//]: # (END_OPERATION)
|
|
1821
|
+
|
|
1822
|
+
|
|
1823
|
+
[//]: # (START_OPERATION)
|
|
1824
|
+
|
|
1825
|
+
[//]: # (CLASS:OptionsApi)
|
|
1826
|
+
|
|
1827
|
+
[//]: # (METHOD:getOptionsImpliedMoveHistoricalBySymbol)
|
|
1828
|
+
|
|
1829
|
+
[//]: # (RETURN_TYPE:ApiResponseOptionsImpliedMove)
|
|
1830
|
+
|
|
1831
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
1832
|
+
|
|
1833
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsImpliedMove.md)
|
|
1834
|
+
|
|
1835
|
+
[//]: # (OPERATION:getOptionsImpliedMoveHistoricalBySymbol_v2)
|
|
1836
|
+
|
|
1837
|
+
[//]: # (ENDPOINT:/options/implied_move/{symbol}/{expiration_date}/historical/{as_of_date})
|
|
1838
|
+
|
|
1839
|
+
[//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsImpliedMoveHistoricalBySymbol)
|
|
1840
|
+
|
|
1841
|
+
<a name="getOptionsImpliedMoveHistoricalBySymbol"></a>
|
|
1842
|
+
## **getOptionsImpliedMoveHistoricalBySymbol**
|
|
1843
|
+
|
|
1844
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsImpliedMoveHistoricalBySymbol_v2)
|
|
1845
|
+
|
|
1846
|
+
[//]: # (START_OVERVIEW)
|
|
1847
|
+
|
|
1848
|
+
> ApiResponseOptionsImpliedMove getOptionsImpliedMoveHistoricalBySymbol(symbol, expirationDate, asOfDate, opts)
|
|
1849
|
+
|
|
1850
|
+
#### Options Implied Move (Expected) Historical
|
|
1851
|
+
|
|
1852
|
+
|
|
1853
|
+
Returns historical implied move data points for a ticker symbol on a specific date.
|
|
1854
|
+
|
|
1855
|
+
[//]: # (END_OVERVIEW)
|
|
1856
|
+
|
|
1857
|
+
### Example
|
|
1858
|
+
|
|
1859
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1860
|
+
|
|
1861
|
+
```javascript
|
|
1862
|
+
var intrinioSDK = require('intrinio-sdk');
|
|
1863
|
+
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
|
|
1864
|
+
intrinioSDK.ApiClient.instance.enableRetries = true;
|
|
1865
|
+
|
|
1866
|
+
var options = new intrinioSDK.OptionsApi();
|
|
1867
|
+
|
|
1868
|
+
var symbol = "TSLA";
|
|
1869
|
+
var expirationDate = new Date("2025-05-30");
|
|
1870
|
+
var asOfDate = new Date("2025-05-15");
|
|
1871
|
+
|
|
1872
|
+
|
|
1873
|
+
var opts = {
|
|
1874
|
+
'percentage': 0.85,
|
|
1875
|
+
'source': null
|
|
1876
|
+
};
|
|
1877
|
+
|
|
1878
|
+
options.getOptionsImpliedMoveHistoricalBySymbol(symbol, expirationDate, asOfDate, opts).then(function(data) {
|
|
1879
|
+
data = JSON.stringify(data, null, 2)
|
|
1880
|
+
console.log(data);
|
|
1881
|
+
}, function(error) {
|
|
1882
|
+
console.error(error);
|
|
1883
|
+
});
|
|
1884
|
+
```
|
|
1885
|
+
|
|
1886
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1887
|
+
|
|
1888
|
+
### Parameters
|
|
1889
|
+
|
|
1890
|
+
[//]: # (START_PARAMETERS)
|
|
1891
|
+
|
|
1892
|
+
|
|
1893
|
+
Name | Type | Description | Notes
|
|
1894
|
+
------------- | ------------- | ------------- | -------------
|
|
1895
|
+
**symbol** | String| The ticker symbol for the contracts. |
|
|
1896
|
+
**expirationDate** | Date| The expiration date for the contracts to consider. |
|
|
1897
|
+
**asOfDate** | Date| The historical date to evaluate implied move on. |
|
|
1898
|
+
**percentage** | [**Object**](.md)| Percentage to multiply the straddle by. Defaults to 0.85. | [optional]
|
|
1899
|
+
**source** | String| Realtime or 15-minute delayed contracts used for underlying mapping. | [optional]
|
|
1900
|
+
<br/>
|
|
1901
|
+
|
|
1902
|
+
[//]: # (END_PARAMETERS)
|
|
1903
|
+
|
|
1904
|
+
### Return type
|
|
1905
|
+
|
|
1906
|
+
[**ApiResponseOptionsImpliedMove**](ApiResponseOptionsImpliedMove.md)
|
|
1907
|
+
|
|
1908
|
+
|
|
1909
|
+
|
|
1635
1910
|
[//]: # (END_OPERATION)
|
|
1636
1911
|
|
|
1637
1912
|
|
|
@@ -2294,7 +2569,10 @@ var identifier = "AAPL230616P00190000";
|
|
|
2294
2569
|
var opts = {
|
|
2295
2570
|
'nextPage': null,
|
|
2296
2571
|
'startDate': null,
|
|
2297
|
-
'endDate': null
|
|
2572
|
+
'endDate': null,
|
|
2573
|
+
'recalculateStats': false,
|
|
2574
|
+
'model': "black_scholes",
|
|
2575
|
+
'ivMode': "ivMode_example"
|
|
2298
2576
|
};
|
|
2299
2577
|
|
|
2300
2578
|
options.getOptionsPricesEod(identifier, opts).then(function(data) {
|
|
@@ -2318,6 +2596,9 @@ Name | Type | Description | Notes
|
|
|
2318
2596
|
**nextPage** | String| Gets the next page of data from a previous API call | [optional]
|
|
2319
2597
|
**startDate** | Date| The start date to retrieve prices for | [optional]
|
|
2320
2598
|
**endDate** | Date| The end date to retrieve prices for | [optional]
|
|
2599
|
+
**recalculateStats** | Boolean| Recalculate implied volatility and greeks on the fly using end-of-day underlying prices. | [optional] [default to false]
|
|
2600
|
+
**model** | String| The options pricing model to use when recalculating stats. | [optional] [default to black_scholes]
|
|
2601
|
+
**ivMode** | String| The implied volatility calculation mode to use when recalculating stats. | [optional]
|
|
2321
2602
|
<br/>
|
|
2322
2603
|
|
|
2323
2604
|
[//]: # (END_PARAMETERS)
|
|
@@ -2387,6 +2668,9 @@ var opts = {
|
|
|
2387
2668
|
'strikeGreaterThan': null,
|
|
2388
2669
|
'strikeLessThan': null,
|
|
2389
2670
|
'includeRelatedSymbols': false,
|
|
2671
|
+
'recalculateStats': false,
|
|
2672
|
+
'model': "black_scholes",
|
|
2673
|
+
'ivMode': "ivMode_example",
|
|
2390
2674
|
'nextPage': null
|
|
2391
2675
|
};
|
|
2392
2676
|
|
|
@@ -2415,6 +2699,9 @@ Name | Type | Description | Notes
|
|
|
2415
2699
|
**strikeGreaterThan** | Number| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]
|
|
2416
2700
|
**strikeLessThan** | Number| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]
|
|
2417
2701
|
**includeRelatedSymbols** | Boolean| Include related symbols that end in a 1 or 2 because of a corporate action. | [optional]
|
|
2702
|
+
**recalculateStats** | Boolean| Recalculate implied volatility and greeks on the fly using end-of-day underlying prices. | [optional] [default to false]
|
|
2703
|
+
**model** | String| The options pricing model to use when recalculating stats. | [optional] [default to black_scholes]
|
|
2704
|
+
**ivMode** | String| The implied volatility calculation mode to use when recalculating stats. | [optional]
|
|
2418
2705
|
**nextPage** | String| Gets the next page of data from a previous API call | [optional]
|
|
2419
2706
|
<br/>
|
|
2420
2707
|
|
package/docs/SecurityApi.md
CHANGED
|
@@ -5,6 +5,8 @@ All URIs are relative to *https://api-v2.intrinio.com*
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**getAllSecurities**](SecurityApi.md#getAllSecurities) | **GET** /securities | All Securities
|
|
8
|
+
[**getSecuritiesDailyShortVolume**](SecurityApi.md#getSecuritiesDailyShortVolume) | **GET** /securities/daily_short_volume | Daily Short Volume
|
|
9
|
+
[**getSecuritiesDailyShortVolumeConsolidated**](SecurityApi.md#getSecuritiesDailyShortVolumeConsolidated) | **GET** /securities/daily_short_volume/consolidated | Daily Short Volume Consolidated
|
|
8
10
|
[**getSecuritiesLatestDividendRecords**](SecurityApi.md#getSecuritiesLatestDividendRecords) | **GET** /securities/dividends/latest | Latest Dividend Records for All Securities
|
|
9
11
|
[**getSecuritiesLatestEarningsRecords**](SecurityApi.md#getSecuritiesLatestEarningsRecords) | **GET** /securities/earnings/latest | Latest Earnings Records for All Securities
|
|
10
12
|
[**getSecuritiesShortInterest**](SecurityApi.md#getSecuritiesShortInterest) | **GET** /securities/short_interest | Latest Short Interest
|
|
@@ -189,6 +191,180 @@ Name | Type | Description | Notes
|
|
|
189
191
|
|
|
190
192
|
|
|
191
193
|
|
|
194
|
+
[//]: # (END_OPERATION)
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
[//]: # (START_OPERATION)
|
|
198
|
+
|
|
199
|
+
[//]: # (CLASS:SecurityApi)
|
|
200
|
+
|
|
201
|
+
[//]: # (METHOD:getSecuritiesDailyShortVolume)
|
|
202
|
+
|
|
203
|
+
[//]: # (RETURN_TYPE:ApiResponseSecuritiesDailyShortVolume)
|
|
204
|
+
|
|
205
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
206
|
+
|
|
207
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecuritiesDailyShortVolume.md)
|
|
208
|
+
|
|
209
|
+
[//]: # (OPERATION:getSecuritiesDailyShortVolume_v2)
|
|
210
|
+
|
|
211
|
+
[//]: # (ENDPOINT:/securities/daily_short_volume)
|
|
212
|
+
|
|
213
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecuritiesDailyShortVolume)
|
|
214
|
+
|
|
215
|
+
<a name="getSecuritiesDailyShortVolume"></a>
|
|
216
|
+
## **getSecuritiesDailyShortVolume**
|
|
217
|
+
|
|
218
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getSecuritiesDailyShortVolume_v2)
|
|
219
|
+
|
|
220
|
+
[//]: # (START_OVERVIEW)
|
|
221
|
+
|
|
222
|
+
> ApiResponseSecuritiesDailyShortVolume getSecuritiesDailyShortVolume(opts)
|
|
223
|
+
|
|
224
|
+
#### Daily Short Volume
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
Returns FINRA daily short volume data for securities, reported by individual market centers and reporting facilities. ## Data Coverage This endpoint provides **off-exchange activity** data aggregated from FINRA's Short Sale Volume files. The data represents short selling activity reported by market centers and third-party reporting facilities, including both exchange and off-exchange venues. ## Use as Market Proxy Short volume data can serve as a meaningful proxy for overall market sentiment and activity: - **Market Structure Insight**: Tracks short selling intensity across different trading venues and market centers - **Liquidity Indicator**: Higher short volume often correlates with increased market activity and liquidity - **Sentiment Analysis**: Can indicate bearish positioning, though short volume alone doesn't determine market direction - **Cross-Venue Analysis**: Compare short volume patterns across different reporting facilities to understand how activity varies by venue type ## Data Characteristics - Data is reported at the facility level for granular analysis - Use the `/securities/daily_short_volume/consolidated` endpoint for a single aggregated view across all facilities - Short exempt volume reflects pre-borrow arrangements and other regulated short selling exemptions - Each data point represents a full trading day's accumulated short volume
|
|
228
|
+
|
|
229
|
+
[//]: # (END_OVERVIEW)
|
|
230
|
+
|
|
231
|
+
### Example
|
|
232
|
+
|
|
233
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
234
|
+
|
|
235
|
+
```javascript
|
|
236
|
+
var intrinioSDK = require('intrinio-sdk');
|
|
237
|
+
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
|
|
238
|
+
intrinioSDK.ApiClient.instance.enableRetries = true;
|
|
239
|
+
|
|
240
|
+
var security = new intrinioSDK.SecurityApi();
|
|
241
|
+
|
|
242
|
+
var opts = {
|
|
243
|
+
'tickers': ["[ \"AAPL\", \"MSFT\" ]"],
|
|
244
|
+
'startDate': new Date("2024-01-01"),
|
|
245
|
+
'endDate': new Date("2024-12-31"),
|
|
246
|
+
'sortBy': "date",
|
|
247
|
+
'nextPage': null
|
|
248
|
+
};
|
|
249
|
+
|
|
250
|
+
security.getSecuritiesDailyShortVolume(opts).then(function(data) {
|
|
251
|
+
data = JSON.stringify(data, null, 2)
|
|
252
|
+
console.log(data);
|
|
253
|
+
}, function(error) {
|
|
254
|
+
console.error(error);
|
|
255
|
+
});
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
259
|
+
|
|
260
|
+
### Parameters
|
|
261
|
+
|
|
262
|
+
[//]: # (START_PARAMETERS)
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
Name | Type | Description | Notes
|
|
266
|
+
------------- | ------------- | ------------- | -------------
|
|
267
|
+
**tickers** | [**[String]**](String.md)| A list of one or more security tickers to filter results | [optional]
|
|
268
|
+
**startDate** | Date| The start date for the data (inclusive) in YYYY-MM-DD format | [optional]
|
|
269
|
+
**endDate** | Date| The end date for the data (inclusive) in YYYY-MM-DD format | [optional]
|
|
270
|
+
**sortBy** | String| Specifies how to sort the data. Valid values are \"date\" (default, descending) or \"ticker\" (ascending) | [optional]
|
|
271
|
+
**nextPage** | String| Gets the next page of data from a previous API call | [optional]
|
|
272
|
+
<br/>
|
|
273
|
+
|
|
274
|
+
[//]: # (END_PARAMETERS)
|
|
275
|
+
|
|
276
|
+
### Return type
|
|
277
|
+
|
|
278
|
+
[**ApiResponseSecuritiesDailyShortVolume**](ApiResponseSecuritiesDailyShortVolume.md)
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
[//]: # (END_OPERATION)
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
[//]: # (START_OPERATION)
|
|
286
|
+
|
|
287
|
+
[//]: # (CLASS:SecurityApi)
|
|
288
|
+
|
|
289
|
+
[//]: # (METHOD:getSecuritiesDailyShortVolumeConsolidated)
|
|
290
|
+
|
|
291
|
+
[//]: # (RETURN_TYPE:ApiResponseSecuritiesDailyShortVolumeConsolidated)
|
|
292
|
+
|
|
293
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
294
|
+
|
|
295
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecuritiesDailyShortVolumeConsolidated.md)
|
|
296
|
+
|
|
297
|
+
[//]: # (OPERATION:getSecuritiesDailyShortVolumeConsolidated_v2)
|
|
298
|
+
|
|
299
|
+
[//]: # (ENDPOINT:/securities/daily_short_volume/consolidated)
|
|
300
|
+
|
|
301
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#getSecuritiesDailyShortVolumeConsolidated)
|
|
302
|
+
|
|
303
|
+
<a name="getSecuritiesDailyShortVolumeConsolidated"></a>
|
|
304
|
+
## **getSecuritiesDailyShortVolumeConsolidated**
|
|
305
|
+
|
|
306
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getSecuritiesDailyShortVolumeConsolidated_v2)
|
|
307
|
+
|
|
308
|
+
[//]: # (START_OVERVIEW)
|
|
309
|
+
|
|
310
|
+
> ApiResponseSecuritiesDailyShortVolumeConsolidated getSecuritiesDailyShortVolumeConsolidated(opts)
|
|
311
|
+
|
|
312
|
+
#### Daily Short Volume Consolidated
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
Returns FINRA daily short volume data aggregated across all reporting facilities for each security and date. ## Data Aggregation This endpoint consolidates all short volume activity reported across different market centers and reporting facilities into a single daily view per security: - **Volume Summation**: Total, short, and short exempt volumes are summed across all facilities - **Ratio Recalculation**: The short volume ratio is recalculated on the aggregated totals for accurate market-wide percentages - **Facility Tracking**: Included `sources` field lists all reporting facilities that contributed to each daily aggregate ## Market-Wide Perspective Consolidated short volume serves as an excellent proxy for off-exchange market activity: - **Complete Market View**: Aggregates activity from all FINRA-reporting venues into a single metric - **Comparable Across Securities**: Normalized short volume ratios allow fair comparison between different stocks regardless of absolute trading volume - **Trend Analysis**: Daily consolidated data enables tracking of short selling trends and patterns across the entire market - **Venue-Agnostic**: Eliminates the need to aggregate across multiple facilities manually ## Use Cases - Monitor overall short selling sentiment across your portfolio or watchlist - Identify unusual short volume spikes that may precede price moves - Compare short volume ratios between securities to identify relative short interest positioning - Analyze temporal patterns in short selling behavior across trading days
|
|
316
|
+
|
|
317
|
+
[//]: # (END_OVERVIEW)
|
|
318
|
+
|
|
319
|
+
### Example
|
|
320
|
+
|
|
321
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
322
|
+
|
|
323
|
+
```javascript
|
|
324
|
+
var intrinioSDK = require('intrinio-sdk');
|
|
325
|
+
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
|
|
326
|
+
intrinioSDK.ApiClient.instance.enableRetries = true;
|
|
327
|
+
|
|
328
|
+
var security = new intrinioSDK.SecurityApi();
|
|
329
|
+
|
|
330
|
+
var opts = {
|
|
331
|
+
'tickers': ["[ \"AAPL\", \"MSFT\" ]"],
|
|
332
|
+
'startDate': new Date("2024-01-01"),
|
|
333
|
+
'endDate': new Date("2024-12-31"),
|
|
334
|
+
'nextPage': null
|
|
335
|
+
};
|
|
336
|
+
|
|
337
|
+
security.getSecuritiesDailyShortVolumeConsolidated(opts).then(function(data) {
|
|
338
|
+
data = JSON.stringify(data, null, 2)
|
|
339
|
+
console.log(data);
|
|
340
|
+
}, function(error) {
|
|
341
|
+
console.error(error);
|
|
342
|
+
});
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
346
|
+
|
|
347
|
+
### Parameters
|
|
348
|
+
|
|
349
|
+
[//]: # (START_PARAMETERS)
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
Name | Type | Description | Notes
|
|
353
|
+
------------- | ------------- | ------------- | -------------
|
|
354
|
+
**tickers** | [**[String]**](String.md)| A list of one or more security tickers to filter results | [optional]
|
|
355
|
+
**startDate** | Date| The start date for the data (inclusive) in YYYY-MM-DD format | [optional]
|
|
356
|
+
**endDate** | Date| The end date for the data (inclusive) in YYYY-MM-DD format | [optional]
|
|
357
|
+
**nextPage** | String| Gets the next page of data from a previous API call | [optional]
|
|
358
|
+
<br/>
|
|
359
|
+
|
|
360
|
+
[//]: # (END_PARAMETERS)
|
|
361
|
+
|
|
362
|
+
### Return type
|
|
363
|
+
|
|
364
|
+
[**ApiResponseSecuritiesDailyShortVolumeConsolidated**](ApiResponseSecuritiesDailyShortVolumeConsolidated.md)
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
192
368
|
[//]: # (END_OPERATION)
|
|
193
369
|
|
|
194
370
|
|
|
@@ -4820,7 +4996,8 @@ intrinioSDK.ApiClient.instance.enableRetries = true;
|
|
|
4820
4996
|
var security = new intrinioSDK.SecurityApi();
|
|
4821
4997
|
|
|
4822
4998
|
var opts = {
|
|
4823
|
-
'atDatetime': null
|
|
4999
|
+
'atDatetime': null,
|
|
5000
|
+
'source': "iex_delayed"
|
|
4824
5001
|
};
|
|
4825
5002
|
|
|
4826
5003
|
security.getSecuritySnapshots(opts).then(function(data) {
|
|
@@ -4841,6 +5018,7 @@ security.getSecuritySnapshots(opts).then(function(data) {
|
|
|
4841
5018
|
Name | Type | Description | Notes
|
|
4842
5019
|
------------- | ------------- | ------------- | -------------
|
|
4843
5020
|
**atDatetime** | Date| The UTC date and time (with url-encoded spaces) the snapshot will cover. | [optional]
|
|
5021
|
+
**source** | String| Return the snapshot from the specified source. | [optional]
|
|
4844
5022
|
<br/>
|
|
4845
5023
|
|
|
4846
5024
|
[//]: # (END_PARAMETERS)
|
package/package.json
CHANGED
package/src/ApiClient.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Intrinio API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* OpenAPI spec version: 2.
|
|
5
|
+
* OpenAPI spec version: 2.135.4
|
|
6
6
|
*
|
|
7
7
|
* NOTE: This class is auto generated by the swagger code generator program.
|
|
8
8
|
* https://github.com/swagger-api/swagger-codegen.git
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
|
|
33
33
|
/**
|
|
34
34
|
* @module ApiClient
|
|
35
|
-
* @version 7.
|
|
35
|
+
* @version 7.2.0
|
|
36
36
|
*/
|
|
37
37
|
|
|
38
38
|
/**
|