[{"title":"Price a European option","url":"/learn/price-an-option","description":"Change a sample market input. Price and Greeks use Black–Scholes–Merton, with explicit decimal rates and years to expiry.","category":"Runnable task","keywords":"price-an-option","kind":"task"},{"title":"Analyze an option strategy","url":"/learn/analyze-a-strategy","description":"Edit the legs or start from a preset. The chart is net profit or loss at expiration, not option value before expiry. Premiums are per share; the option contract multiplier is 100.","category":"Runnable task","keywords":"analyze-a-strategy","kind":"task"},{"title":"Track profit, not deposits","url":"/learn/track-portfolio-pnl","description":"A sample ledger holds one equity position. Change the closing mark or add a deposit: new cash changes account value, but it is not investment profit. USD throughout.","category":"Runnable task","keywords":"track-portfolio-pnl","kind":"task"},{"title":"Value a company’s cash flows","url":"/learn/value-a-company","description":"A five-year sample FCFF forecast produces enterprise value. A discount rate is a stated assumption—not a market fact. No debt/cash bridge or share count is silently invented.","category":"Runnable task","keywords":"value-a-company","kind":"task"},{"title":"Backtest a moving-average rule","url":"/learn/backtest-a-strategy","description":"Hold the asset while a moving-average rule is on. Signals execute on the next bar, commissions are charged on every fill, and every input is yours to change, including the price data. A research demonstration, not evidence of an investable edge.","category":"Runnable task","keywords":"backtest-a-strategy","kind":"task"},{"title":"Explore price and volatility scenarios","url":"/learn/explore-scenarios","description":"Revalue a sample 100/110 bull call spread before expiry across underlying prices and volatility shocks. This is mark-to-market P&L, not an expiration payoff or a forecast.","category":"Runnable task","keywords":"explore-scenarios","kind":"task"},{"title":"Chart technical indicators","url":"/learn/chart-technical-indicators","description":"Overlay a moving average or Bollinger Bands on your own price bars and add an RSI or MACD pane. Warmup values stay NaN: an indicator never invents a value before it has enough history.","category":"Runnable task","keywords":"chart-technical-indicators","kind":"task"},{"title":"Measure value at risk","url":"/learn/measure-risk","description":"Estimate one-period value at risk and expected shortfall from a return series, then see where those losses sit in the distribution and how deep the drawdowns ran. Paste daily returns, or closing prices and they become simple returns.","category":"Runnable task","keywords":"measure-risk","kind":"task"},{"title":"Price a fixed-rate bond","url":"/learn/price-a-bond","description":"Price a newly issued fixed-rate bond from its yield, read its duration, convexity and DV01, and see how price responds as yields move. Prices are per 100 of face value; day count is 30/360.","category":"Runnable task","keywords":"price-a-bond","kind":"task"},{"title":"Fit a volatility smile","url":"/learn/fit-a-volatility-smile","description":"Enter implied volatilities by strike for one expiry and fit a smooth smile with SVI, SABR or monotone interpolation. Read off the at-the-money level and wings, and check the fit for butterfly arbitrage.","category":"Runnable task","keywords":"fit-a-volatility-smile","kind":"task"},{"title":"Connect an AI agent","url":"/agents","description":"Give Claude, Cursor, VS Code, Codex, ChatGPT or any MCP client real financial calculations and the real API, in one step.","category":"Guide","keywords":"Language models are unreliable at arithmetic and guess at APIs they have not read. TotalFinance gives your agent both missing pieces: a calculator it can call, with the units, assumptions and diagnostics of every answer, and these docs as tools, so the code it writes uses functions that exist. Both speak the Model Context Protocol (MCP). Connect in one step Pick what to connect and your client, then copy one command or one config block. Calculations run on your machine, so your positions, prices and data never leave it. The calculation server is read-only by default and never fetches quotes or places orders. The docs server is hosted: nothing to install, and it only reads these pages. What your agent can do <Card title=\"Calculate\" href=\"/agents/operations\" description=\"Option prices and Greeks, implied volatility, strategy payoffs, expected moves, volatility surfaces, technical indicators, dealer exposures, VaR, performance, bonds, calendars and crypto basis, each with its assumptions.\" / <Card title=\"Read the real API\" href=\"/agents/docs-mcp\" description=\"searchdocs, readpage, getreference and listcalculators: the agent looks up exact signatures, units and defaults before it writes code.\" / <Card title=\"Load whole domains\" href=\"/agents/llms\" description=\"llms.txt, per-domain bundles sized for a context window, and a Markdown version of every page.\" / <Card title=\"Drive the calculators\" href=\"/agents/browser-tools\" description=\"In a browser with WebMCP, each calculator on these docs registers itself as a tool.\" / The calculation server registers read-only tools by default, out of operations. Every calculator on these docs also has an Ask your AI agent panel with a prompt built from your inputs. Try these prompts - “Price a 3-month 105 call on a 100 stock at 20% volatility and a 4% rate, then show the Greeks and the assumptions.” - “Analyze an iron condor on a 100 stock: long 90 put, short 95 put, short 105 call, long 110 call. What are the breakevens and the maximum loss?” - “Fit an SVI smile to these implied volatilities by strike and check it for arbitrage: …” - “Here is my daily OHLCV CSV. Compute 14-day RSI and 20-day Bollinger Bands and tell me how many warm-up bars have no value.” - “Search the TotalFinance docs for value at risk, then write TypeScript that computes 99% historical VaR and expected shortfall from my returns.” Choose more tools with a profile Profiles add task-specific tools to the calculation server. Add --profile to the server command, for example --profile backtesting for backtests or --profile portfolio for ledgers and P&L explanation: A profile never grants write authority. The optional paper-trading tools need explicit capabilities, and no live brokerage connection exists. The agent handbook explains permissions, datasets, errors and long-running jobs. Bring the data Compute tools calculate on the numbers you or your agent supply; they never fetch quotes, chains or account history. For options flow, dark pool prints and market data, use InsiderFinance. Go deeper - Agent handbook: permissions, handles, errors, paper trading and jobs. - MCP server reference: every flag, profile, budget and the worker-backed job path. - Operation catalog: every tool with its schema, profile and cost class.","kind":"guide"},{"title":"Browser agent tools","url":"/agents/browser-tools","description":"Every calculator registers a page-scoped tool that a browser agent can call with the same inputs a person uses.","category":"Guide","keywords":"In browsers that implement the proposed WebMCP document.modelContext API, each calculator page registers one tool, such as calculatepriceanoption. Its input schema is generated from the calculator's own controls, so an agent and a person are validated by the same rules, and calling it updates the visible inputs, results, charts and copyable TypeScript. What the tools can and cannot do - They compute only on the inputs supplied, in the page. They never fetch data, store a portfolio or place an order. - Datasets are accepted as explicit values. An agent must supply real observations or label sample data as synthetic; it must never invent market data. - Browsers without the API keep the complete interface; nothing depends on the tools. Schemas The tool's input schema mirrors the panel: numbers carry their unit, minimum and maximum; options are enumerations; tables are arrays of typed rows; datasets are OHLC bars or numeric series with an origin and a source label.","kind":"guide"},{"title":"Docs MCP server","url":"/agents/docs-mcp","description":"Give an AI agent searchable, citable access to these docs over the Model Context Protocol.","category":"Guide","keywords":"These docs are also an MCP server. An agent connected to it can search the documentation, read any page as Markdown and fetch the complete contract of any export, so it writes code against the real API instead of guessing. It is read-only and stateless, and it never computes finance: for calculations, connect the TotalFinance MCP server, which runs the library locally. Tools Tool What it returns ------------------ ------------------------------------------------------------------------------------------------------------------------------------- searchdocs Ranked pages, functions, types, calculators and operations for a query, with URLs. readpage The Markdown of one docs page (the same text as its .md twin). getreference The full generated contract of an export or entry point: signature, members with units and declared defaults, examples and stability. listcalculators The live calculators, their inputs and the APIs they call. Connect The endpoint speaks MCP over Streamable HTTP at /docs/totalfinance/mcp on the host that serves these docs. Nothing to install: pick your client. When you preview the site locally with pnpm site:dev, the same endpoint is served at http://127.0.0.1:4173/docs/totalfinance/mcp. A static host without functions serves every page and Markdown twin but not this endpoint; agents can still use LLM-ready docs. Good prompts - \"Search the TotalFinance docs for how to price an American put, then write the call.\" - \"Read the reference for valueAtRiskReport and explain each option and its default.\" - \"Using only exports that getreference confirms, write a backtest of an RSI rule.\"","kind":"guide"},{"title":"LLM-ready docs","url":"/agents/llms","description":"Markdown twins, llms.txt and per-domain bundles sized for an agent's context window.","category":"Guide","keywords":"Everything on this site is available as plain text an agent can read without a browser. Every page as Markdown Append .md to any page path: /learn/price-an-option becomes /learn/price-an-option.md, and the home page is /index.md. Hosts that support content negotiation also return Markdown for a request with Accept: text/markdown. Every page header has Copy page, View as Markdown, Open in Claude and Open in ChatGPT actions. Index and bundles File Use it for ---------------------------------- ---------------------------------------------------------------------------------------------------------------------------------- /llms.txt The index: what TotalFinance is, and links to every page's Markdown, every bundle and the machine-readable catalogs. Start here. /llms/ .txt One domain's guide pages plus a compact reference of its exports (signatures, units, descriptions), sized to fit a context window. /llms-full.txt The complete generated reference of every entry point, type and operation. Large; prefer a domain bundle. Machine-readable catalogs - /search-index.json: the same index the search dialog uses. - /reference/totalfinance/ .json: the full contract of every export of one entry point. - /operation-catalog.json: every registered operation with input and output schemas, permissions and cost. - /openapi.json: the local HTTP server's OpenAPI document. - /reference-coverage.json: every public export path and its reference URL. Honesty for agents Pages state units and assumptions in words, and examples print their real output. The calculators use synthetic sample data that is labelled as such; an agent should never present it as market data.","kind":"guide"},{"title":"Library","url":"/domains","description":"Explore the finance library, common APIs, and the complete reference for every module.","category":"Guide","keywords":"TotalFinance brings its finance modules together in one package. Import from @insiderfinance/totalfinance/ for the smallest bundles, or from a feature subpath to narrow further.","kind":"guide"},{"title":"Backtesting","url":"/domains/backtest","description":"Vectorized and event-driven backtests, costs, execution and tear sheets.","category":"Guide","keywords":"Choose the engine that fits the question: vectorized for fast signal research, event-driven for order-level realism, cross-sectional for universes and portfolio backtests for allocations. Every engine forbids lookahead, charges explicit costs and reports its assumptions. Try it live - Backtest a strategy Common APIs <KeyExports domain=\"backtest\" names={[ 'vectorized', 'eventDriven', 'crossSectionalBacktest', 'portfolioBacktest', 'walkForward', 'fees', 'slippage', 'tearSheet', 'monteCarloResample', 'createTradingEnvironment', ]} / Guides - Backtesting - Trading environment Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Calendars","url":"/domains/calendars","description":"Exchange calendars (NYSE, Cboe, 24×7 crypto), holidays and option expirations.","category":"Guide","keywords":"Know when markets are open and when options expire: NYSE and Cboe holiday and half-day rules, a 24×7 crypto calendar and expiration helpers that count trading days. Common APIs <KeyExports domain=\"calendars\" names={[ 'NYSE', 'CBOE', 'crypto24x7', 'expirations', 'nextExpiry', 'tradingDaysToExpiry', 'usMarketHolidayRules', ]} / Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"CLI","url":"/domains/cli","description":"The command-line interface over the operation registry.","category":"Guide","keywords":"Run any registered operation from a shell, with profiles, a file-backed artifact store and local background jobs. Common APIs <KeyExports domain=\"cli\" names={[ 'CLICOMMANDS', 'REGISTRYPROFILES', 'packsForProfile', 'registryForProfile', 'createFileArtifactStore', 'createLocalJobRunner', ]} / Guides - Command line Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Commodities","url":"/domains/commodities","description":"Forwards, carry, convenience yield, roll yield, spreads and term structure.","category":"Guide","keywords":"Price commodity forwards from storage and convenience yield, infer either from the curve, decompose roll returns and classify the term structure as contango or backwardation. Common APIs <KeyExports domain=\"commodities\" names={[ 'commodityForwardPrice', 'commodityCarry', 'impliedConvenienceYield', 'rollYield', 'rollReturnDecomposition', 'calendarSpread', 'termStructureState', 'futuresHedgeRatio', ]} / Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Core","url":"/domains/core","description":"Shared errors, conventions, validation, dates, formatting, OCC symbols and artifacts.","category":"Guide","keywords":"Types and utilities every domain shares: the typed error hierarchy, conventions and defaults that are always echoed, validation helpers, date handling without the machine clock, formatting and OCC option symbols. Common APIs <KeyExports domain=\"core\" names={[ 'QuantError', 'InputError', 'isQuantError', 'parseOccSymbol', 'formatOccSymbol', 'discountFactor', 'resolveAsOf', 'resolvedExpiry', 'formatMoney', ]} / Guides - Errors and diagnostics - Results and the explain envelope Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Crypto","url":"/domains/crypto","description":"Perpetual funding, futures basis, carry curves, inverse contracts and liquidation prices.","category":"Guide","keywords":"Model the instruments crypto venues actually trade: perpetual funding and its predicted rate, futures basis and carry curves, inverse (coin-margined) contracts and liquidation prices. Common APIs <KeyExports domain=\"crypto\" names={[ 'perpetualFunding', 'predictedFunding', 'futuresBasis', 'carryCurve', 'inverseFuture', 'inverseHedge', 'liquidationPrice', 'fundingBasisSpread', ]} / Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Research data","url":"/domains/data","description":"Connect independently maintained providers to normalized research data and existing calculations.","category":"Guide","keywords":"Bind an independently installed connector with data.connect(provider), fetch a bounded research window, and pass its named arrays to existing calculations. Pure calculations still accept caller data without a provider or credential. This connector preview is unreleased. Build and install the local SDK and provider packs described in the no-key guide; registry version 0.1.4 does not include these exports. The reference connector supports daily/minute bars and incomplete option-chain research. Pagination completion does not prove continuous history, point-in-time availability or executable liquidity. Common APIs Guides - No-key first success and author journey - Community connectors, manual resume and data quality Complete API reference","kind":"guide"},{"title":"Fixed income","url":"/domains/fixed-income","description":"Bonds, yields, duration and convexity, curves, swaps, caps, swaptions and futures.","category":"Guide","keywords":"Construct bonds with full schedules, price them from yields or curves, and read duration, convexity and key-rate risk. Curves bootstrap from market quotes; swaps, caps, floors, swaptions, short-rate models, credit and inflation products build on them. Try it live - Price a bond Common APIs <KeyExports domain=\"fixed-income\" names={[ 'bonds', 'priceFromYield', 'yieldMetrics', 'yieldToMaturity', 'curves', 'curveMetrics', 'swapRate', 'swaptionPrice', 'capFloorPrice', 'hullWhite', 'cdsParSpread', 'bondFuture', ]} / Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Foreign exchange","url":"/domains/foreign-exchange","description":"Conversion, cross rates, forwards, swaps, non-deliverable forwards and hedging.","category":"Guide","keywords":"Convert and cross currencies with explicit quote conventions, price forwards from covered interest parity, value FX swaps and NDFs, and decompose hedged P&L. Common APIs <KeyExports domain=\"foreign-exchange\" names={[ 'convertCurrency', 'crossRate', 'coveredInterestParityForward', 'foreignExchangeForwardValue', 'foreignExchangeSwapValue', 'nonDeliverableForwardValue', 'hedgeRatio', 'spotForwardHedgedProfitAndLoss', ]} / Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Fundamentals","url":"/domains/fundamentals","description":"Statement ratios, quality scores (Piotroski, Altman, Beneish), growth and point-in-time availability.","category":"Guide","keywords":"Compute ratios and scores from financial statements you supply, with explicit point-in-time availability so research never uses a statement before it was public. analyzeFundamentals returns the whole picture at once. Common APIs <KeyExports domain=\"fundamentals\" names={[ 'analyzeFundamentals', 'piotroskiFScore', 'altmanZScore', 'beneishMScore', 'returnOnInvestedCapital', 'freeCashFlowYield', 'fundamentalGrowth', 'trailingTwelveMonthStatements', 'isPeriodAvailableAt', ]} / Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"HTTP server","url":"/domains/http","description":"A local HTTP/OpenAPI server over the operation registry.","category":"Guide","keywords":"Serve the operation registry over local HTTP with a generated OpenAPI document. Common APIs Guides - Local HTTP server Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Math","url":"/domains/math","description":"Distributions, statistics, linear algebra, optimization, root finding and Monte Carlo.","category":"Guide","keywords":"The numerical foundation the rest of the library uses, exposed for your own models: normal and other distributions, descriptive statistics and time-series tests, matrix decompositions, optimizers, root finders, interpolation, Kalman filtering and quasi-random sequences. Common APIs <KeyExports domain=\"math\" names={[ 'normalCdf', 'normalInverseCdf', 'quantile', 'correlation', 'cholesky', 'nearestCorrelation', 'findRoot', 'brent', 'nelderMead', 'makePchipInterpolator', 'kalmanFilter', 'monteCarlo', ]} / Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"MCP server","url":"/domains/mcp","description":"The optional @insiderfinance/totalfinance-mcp package for AI agents.","category":"Guide","keywords":"Expose TotalFinance to AI agents over the Model Context Protocol, read-only by default, with task profiles, exact pack selection and explicit capabilities for paper-trading workflows. Common APIs <KeyExports domain=\"mcp\" entrypoint=\"reference/mcp\" names={[ 'createTotalFinanceMcpServer', 'defaultTools', 'defaultPacks', 'toolFromOperation', 'toolNameFor', ]} / Guides - Connect an agent - MCP server reference Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Options","url":"/domains/options","description":"Black–Scholes, Black-76, Bachelier, American, Heston, SABR and exotic pricing; Greeks; implied volatility; chain health.","category":"Guide","keywords":"Price a single option or a whole chain. Facades such as blackScholes return plain numbers and explain themselves on request; option and engines select a model explicitly; impliedVolatility inverts a price. Exotic payoffs (barriers, digitals, Asians, lookbacks, cliquets, autocallables and more) are included, each with the same explicit units. Try it live - Price an option Common APIs <KeyExports domain=\"options\" names={[ 'blackScholes', 'black76', 'bachelier', 'impliedVolatility', 'option', 'engines', 'americanExercise', 'barrier', 'digital', 'heston', 'chainGreeks', 'optionChainHealth', ]} / Guides - Selective Greeks and exposure - Assumptions and conventions Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Performance","url":"/domains/performance","description":"Returns, risk-adjusted ratios, drawdowns, benchmarks and sector performance.","category":"Guide","keywords":"Turn prices or equity into returns and measure them: time- and money-weighted returns, Sharpe, Sortino, Calmar and Omega ratios, drawdowns, benchmark-relative statistics and contribution by group. analyze produces a full summary in one call. Try it live - Measure value at risk Common APIs <KeyExports domain=\"performance\" names={[ 'analyze', 'simpleReturns', 'equityCurve', 'sharpe', 'sortino', 'maxDrawdown', 'underwater', 'timeWeightedReturn', 'moneyWeightedReturn', 'informationRatio', 'rollingSharpe', 'sectorPerformance', ]} / Guides - Sector performance Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Portfolio","url":"/domains/portfolio","description":"Event-sourced ledgers, positions, lots, cash, P&L attribution and timelines.","category":"Guide","keywords":"Record what happened as dated events (fills, deposits, income, costs, corporate actions) and derive everything else: positions, lots, cash, P&L between any two marks and a valuation timeline. The trade-lifecycle tools propose, preflight and reconcile rebalances without ever placing an order. Try it live - Track portfolio P&L Common APIs <KeyExports domain=\"portfolio\" names={[ 'createPortfolioLedger', 'portfolioPnl', 'portfolioTimeline', 'portfolioSnapshot', 'applyPortfolioEvents', 'reconcilePortfolio', 'proposePortfolioRebalance', 'preflightTradePlan', 'monitorPortfolio', 'compareDisclosedHoldings', ]} / Guides - End to end - Trade lifecycle - Disclosed holdings Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Research","url":"/domains/research","description":"Screens, factors, event studies and research hygiene.","category":"Guide","keywords":"Screen and rank universes with point-in-time membership, build and evaluate factors (information coefficient, decay, turnover) and run event studies, without survivorship or lookahead. Common APIs <KeyExports domain=\"research\" names={[ 'screenUniverse', 'rankUniverse', 'informationCoefficient', 'factorDecay', 'formQuantilePortfolios', 'eventStudy', 'winsorizeFactor', 'neutralizeFactor', ]} / Guides - Research hygiene Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Risk","url":"/domains/risk","description":"Value at risk, expected shortfall, covariance, drawdown risk and portfolio optimization.","category":"Guide","keywords":"Measure tail risk with historical, parametric and Monte Carlo VaR and expected shortfall, explain P&L with Taylor expansions, and construct portfolios with mean-variance, risk parity, hierarchical risk parity and Black–Litterman. Research-hygiene tools guard against overfitting. Try it live - Measure value at risk Common APIs <KeyExports domain=\"risk\" names={[ 'valueAtRisk', 'valueAtRiskReport', 'expectedShortfall', 'portfolioVaR', 'stressTest', 'taylorPnl', 'meanVariance', 'riskParity', 'hrp', 'blackLitterman', 'deflatedSharpeRatio', 'kelly', ]} / Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Scenarios","url":"/domains/scenarios","description":"Scenario runs across priced positions and portfolio scenario targets.","category":"Guide","keywords":"Run named shocks across positions that know how to price themselves, and bind scenarios to a portfolio's holdings. Try it live - Explore scenarios Common APIs <KeyExports domain=\"scenarios\" names={[ 'runScenarios', 'scenarioTarget', 'scenarioTargetsFromPortfolio', 'scenarioPortfolioBinding', 'spotAssetPricer', ]} / Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Strategies","url":"/domains/strategy","description":"Multi-leg option positions: payoff, break-evens, scenarios and a named strategy catalogue.","category":"Guide","keywords":"Compose positions from legs, or start from one of the named presets, then ask the position for its expiration payoff, scenario table, Greeks or a classification. scanStrategies and optimizeStrategy search a chain for candidates under explicit objectives. Try it live - Analyze a strategy - Explore scenarios Common APIs <KeyExports domain=\"strategy\" names={[ 'strategy', 'legs', 'listStrategies', 'bullCallSpread', 'ironCondor', 'coveredCall', 'classifyStrategy', 'scanStrategies', 'explainPosition', 'payoffSvg', ]} / Guides - Strategy catalogue Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Exposure & flow","url":"/domains/structure","description":"Dealer Greek exposure (gamma, vanna, charm and more), option flow and unusual activity.","category":"Guide","keywords":"Aggregate Greeks across an option chain into dealer exposure profiles (gamma, vanna, charm, vomma and more), measure delta-adjusted premium and flow, and score unusual activity, from Greeks and positioning you supply. Common APIs <KeyExports domain=\"structure\" names={[ 'exposure', 'gammaExposure', 'vannaExposure', 'charmExposure', 'exposureFromGreeks', 'flow', 'deltaAdjustedPremium', 'unusualness', ]} / Guides - Selective Greeks and exposure Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Technical analysis","url":"/domains/technical-analysis","description":"Hundreds of registered indicators with explicit warmup, streaming state, snapshots and a TA-Lib compatibility matrix.","category":"Guide","keywords":"Every indicator is a function over an array that returns an aligned array, with NaN during warmup. The same indicators stream bar by bar, snapshot and restore their state, and compose into signals and feature pipelines. Candlestick patterns, pivots, Fibonacci levels and alternative bar types are included. Try it live - Chart technical indicators Common APIs <KeyExports domain=\"technical-analysis\" names={[ 'sma', 'ema', 'rsi', 'macd', 'bbands', 'atr', 'adx', 'vwap', 'stoch', 'ichimoku', 'supertrend', 'SignalBuilder', ]} / Guides - Indicator registry - Warmup and lookahead - Live charts - Compatibility Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Valuation","url":"/domains/valuation","description":"DCF, NPV and IRR, WACC, comparables, dividend and residual-income models, loans and price-level conversion.","category":"Guide","keywords":"Value cash flows and companies with explicit bases: a firm-basis DCF yields enterprise value, not equity value, unless you supply the bridge. Sensitivity tables re-run full valuations, and the time-value toolkit covers NPV, IRR, annuities, loans and depreciation. Try it live - Value a company Common APIs <KeyExports domain=\"valuation\" names={[ 'discountedCashFlow', 'discountedCashFlowSensitivityTable', 'weightedAverageCostOfCapital', 'netPresentValue', 'internalRateOfReturn', 'terminalValue', 'comparableCompanyValuation', 'dividendDiscountValuation', 'reverseDiscountedCashFlow', 'convertPriceLevel', ]} / Guides - Price-level conversion Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Volatility","url":"/domains/volatility","description":"Realized and implied volatility, smiles and surfaces (SVI, SSVI, SABR, Heston), GARCH.","category":"Guide","keywords":"Build implied-volatility surfaces from quotes with a choice of models and arbitrage checks, read skew and term structure, and estimate realized volatility with GARCH and HAR-RV. Event-volatility tools separate an earnings move from base volatility. Try it live - Fit a volatility smile Common APIs <KeyExports domain=\"volatility\" names={[ 'volatilitySurface', 'calibrateSvi', 'calibrateSabrSmile', 'calibrateSsvi', 'checkButterfly', 'atmTermStructure', 'fitGarch', 'garchForecast', 'expectedMoveFromImpliedVolatility', 'impliedVolatilityRank', 'eventVolatilityDecomposition', 'volatilityCone', ]} / Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Workflows","url":"/domains/workflows","description":"The operation registry behind the CLI, HTTP server and MCP tools.","category":"Guide","keywords":"Operations are serializable, permissioned, budgeted descriptions of library calls. One registry drives the CLI, the local HTTP server and the MCP server, with explicit capabilities for anything that writes. Common APIs <KeyExports domain=\"workflows\" names={[ 'createOperationRegistry', 'defineOperation', 'describeOperation', 'runOperation', 'defaultOperations', 'defaultPacks', ]} / Guides - Levels Complete API reference Browse all public exports, types, and feature imports below.","kind":"guide"},{"title":"Guides","url":"/guides","description":"Conventions, workflows and deep dives, generated from the guides in the repository.","category":"Guide","keywords":"Every guide below is the same Markdown file that lives in the repository's docs/guides folder, so the docs and the source never drift. Code in these guides is executed in CI.","kind":"guide"},{"title":"All calculators","url":"/playgrounds","description":"Ten live calculators that run TotalFinance in your browser, with your inputs and your data.","category":"Guide","keywords":"Each calculator calls the public library in a Web Worker in your browser. Change an input and the results, charts and copyable TypeScript update together. Bring your own price data to the backtest, indicator and risk calculators. Nothing you enter leaves the page. Under Use it in your project, choose Edit and run to change the first call and run it right there. It runs only when you press Run (or ⌘/Ctrl + Enter), in a sandbox with no network and no access to the page, against the same package build as the calculator, and stops after 10 seconds. Any @insiderfinance/totalfinance import that works in a browser is available; the Node-only CLI, HTTP and local-workflow entry points are not.","kind":"guide"},{"title":"TotalFinance","url":"/start","description":"Open-source TypeScript finance with explicit units, honest assumptions and diagnostics you can read. Built by InsiderFinance.","category":"Guide","keywords":"TotalFinance is a TypeScript library for financial computation: options and strategies, volatility, technical analysis, portfolios and performance, risk, valuation, fixed income, FX, commodities, crypto and backtesting. It runs in Node.js and in the browser, has no runtime dependencies, and never fetches market data on its own. You supply the data; it computes, and tells you exactly how. What makes it different - Units are explicit. Rates and volatilities are decimals, times are year fractions or epoch milliseconds, and field names say which. No percent-or-decimal guessing. - Answers explain themselves. Add .explain() to a facade and the result carries its assumptions (day count, compounding, model) and diagnostics (method, convergence, warnings). - Errors teach. Invalid input throws a typed error that names the field and the fix, never a stray TypeError or a silent NaN. - Nothing is invented. No hidden market data, no silent financial defaults, no lookahead in backtests, no warmup values pretending to be signals. - Built for agents too. Every operation in the registry is available to AI agents through an MCP server, the CLI and a local HTTP API, and every page of these docs has a Markdown twin. Where to go next <Card title=\"Install\" href=\"/start/installation\" description=\"One package, every domain, tree-shakeable subpaths.\" / <Card title=\"Quickstart\" href=\"/start/quickstart\" description=\"The first calls, and what comes back.\" / <Card title=\"Core concepts\" href=\"/start/concepts\" description=\"Units, explain envelopes, errors and API levels.\" / <Card title=\"Calculators\" href=\"/playgrounds\" description=\"Ten live calculators that run the library in your browser.\" / <Card title=\"API reference\" href=\"/reference\" description=\"Every entry point and export, generated from the source.\" / <Card title=\"For agents\" href=\"/agents\" description=\"MCP server, operation catalog and LLM-ready docs.\" / Library","kind":"guide"},{"title":"Core concepts","url":"/start/concepts","description":"The few conventions that make every TotalFinance answer readable, checkable and safe to compose.","category":"Guide","keywords":"Units are part of the name Rates and ordinary volatility are decimals: 0.04 is 4%, 0.2 is 20%. A field ending in Years is a year fraction; a field ending in Ms is epoch milliseconds. Prices are per unit in the currency you supply. Greeks use stated units (theta per calendar day, vega per volatility point) and the result echoes them. The assumptions guide lists every convention. Plain answers, explained on request Facades return the plain value you asked for. Add .explain() and the same call returns the value with the assumptions it used and its diagnostics: Read more in Results and the explain envelope. Errors that teach Invalid input throws a typed error with a machine-readable code and a message that names the field and the fix. A calculation that cannot converge says so in its diagnostics instead of returning an invented number. See Errors and diagnostics. Levels: from a formula to a workflow The same capability is available at the level you need: a raw function, a facade with .explain(), a rich analysis result, a versioned artifact, a batch over typed columns, or a workflow exposed through the CLI, HTTP and MCP. Layers are additive; a workflow never replaces the small function under it. See Levels. Your data, never invented data TotalFinance does not fetch quotes, chains, statements or calendars from the network. Every calculation uses the observations you pass in, and timestamps are explicit. That makes results reproducible: keep the inputs and the package version with a saved answer and anyone can rerun it.","kind":"guide"},{"title":"Installation","url":"/start/installation","description":"Add one package, import from domain subpaths, and keep bundles small.","category":"Guide","keywords":"TotalFinance publishes two packages: Package What it is ---------------------------------- --------------------------------------------------------------------------------------- @insiderfinance/totalfinance The whole toolkit: every domain, with tree-shakeable subpaths. No runtime dependencies. @insiderfinance/totalfinance-mcp An optional MCP server that exposes the operation registry to AI agents. Install Node.js 22.13 or newer is supported. The package is ESM-first and also loads from CommonJS. Check the Versions page for the release this documentation describes; until a release is verified there, build the source checkout. Import from a domain Named imports from a domain subpath are the portable default for browsers and bundlers: Feature subpaths such as @insiderfinance/totalfinance/math/normal narrow an import further. The umbrella import (@insiderfinance/totalfinance) exposes every domain as a namespace for convenience; whether a bundler can drop unused namespace members depends on the bundler. The imports and bundles guide has the measured budgets. The MCP server (optional) doctor reports the effective tool set, budgets and store configuration. See Connect an agent for client configuration and profiles.","kind":"guide"},{"title":"Quickstart","url":"/start/quickstart","description":"You do not need to construct a portfolio, register an operation, start a server, or connect a data provider to calculate an option price. Install one domain package and call the function that answers your question.","category":"Guide","keywords":"You do not need to construct a portfolio, register an operation, start a server, or connect a data provider to calculate an option price. Install one domain package and call the function that answers your question.\n\nTotalFinance is an unpublished preview. The examples describe its supported imports; they do not\nclaim that an npm installation has been verified. Use the version page to check release availability.\n\n## Small input, direct answer\n\n\n\nFor a series, supply the observations you actually have:\n\n\n\nThat is already an ordinary array. The first two entries are warmup values, not zeros or signals.\nNo `Array.from` is needed to use it. Creating a sample series is different from converting an output.\n\n## What comes back?\n\n| Task                                 | Return shape                                       | Use it directly                                   |\n| ------------------------------------ | -------------------------------------------------- | ------------------------------------------------- |\n| Price one option                     | `number`                                           | `price`                                           |\n| Compute Greeks                       | Named `Greeks` object                              | `greeks.delta`, `greeks.vega`                     |\n| Calculate a moving average           | Ordinary `number[]`                                | `averages[index]`                                 |\n| Analyze a strategy payoff            | Report with summary fields and a points array      | `report.maxLoss`, `report.points`                 |\n| Track portfolio P&L                  | Report separating investment return and cash flows | `report.investmentReturn`, `report.externalFlows` |\n| Run an expert columnar options batch | Object containing `Float64Array` columns           | `batch.price[index]`                              |\n\nIn TypeScript, `SomeType[]` means an ordinary array with typed elements. `Float64Array` is a\nspecialized numeric buffer, intentionally used by expert batch APIs. Both support indexing and\niteration. Convert a buffer only when a consumer explicitly requires an ordinary array; you do not\nneed to convert it just to read a price. Do not assume JSON serialization preserves typed buffers,\n`NaN` or infinity: use the documented transport/artifact contract when saving or sending results.\n\nA chart may need `{ x, y }` points. Mapping a report's named fields into those coordinates is chart\nintegration, not a repair to the financial answer. The task pages separate the first useful call\nfrom the code needed to reproduce a whole chart.\n\n## Custom legs without strategy-name constraints\n\nUse `legs.call({ strike: 100, premium: 6, quantity: 2 })` for two long calls, or the same\nconstructor with `quantity: -2` for two short calls. `legs.put` follows the same rule;\n`legs.stock({ price: 100, quantity: -50 })` means 50 short shares. Quantity is required and\nnonzero. The constructors return ordinary leg records accepted by `strategy([...])`, so your app\ncan also supply raw records and rebuild a position after edits. Named whole-position presets\nremain available; their names do not constrain a custom combination of legs.\n\n## Pick your level\n\n- **Raw function:** direct formula or numerical primitive, with its documented input contract.\n- **Facade:** a small named request and a plain answer. Add `.explain()` to inspect assumptions and diagnostics.\n- **Analysis:** a rich result when uncertainty, convergence, warnings, or multiple outputs are integral to the answer.\n- **Artifact:** reusable, versioned state such as a curve, market snapshot, portfolio ledger, or research run.\n- **Batch:** rows or typed columns for throughput; do not wrap thousands of scalar calls in a transport loop.\n- **Workflow:** a useful composition over the same functions, exposed through SDK, CLI, HTTP, or MCP where supported.\n\nThese layers are additive. A workflow never replaces the underlying small functions, and a deep import does not excuse ambiguous positional financial arguments.\n\n## Conventions worth knowing first\n\nRates and ordinary volatility are decimals, not percentages. Timestamps ending in `Ms` are epoch milliseconds; durations ending in `Years` are year fractions. Calendar labels and instants are different concepts. Read the assumptions for day count, compounding, option exercise, expiration resolution, currency, and contract multiplier.\n\nNo professional discount rate, investment objective, or exercise style should be inferred from an unlabeled demo default. Playground values are explicit sample assumptions. They are not recommended market inputs.\n\n## Read the whole answer\n\nA facade's plain value is useful when you already know its contract. Its explained answer carries assumptions and diagnostics. Analysis results carry those details directly. Invalid inputs produce typed errors. Non-convergence and undefined quantities must not be presented as successful invented numbers.\n\nTechnical indicators have aligned warmup periods. Leading warmup values are not signals or zero observations. A backtest must not use a future observation to trade earlier. A portfolio deposit changes account value but is not P&L. A firm-basis DCF produces enterprise value, not automatically equity or per-share value.\n\n## Choose imports deliberately\n\nFor portable browser tree shaking, use named imports from `@insiderfinance/totalfinance/<domain>`,\nas above, or supported feature subpaths such as `@insiderfinance/totalfinance/math/normal`.\nThe umbrella keeps domain namespaces and the five flagship option exports (`blackScholes`, `option`,\n`market`, `engines`, `impliedVolatility`) for convenience.\n\nThe tradeoff is bundler-dependent: `import { math } from '@insiderfinance/totalfinance'` followed by\n`math.normalCdf(0)` retains the whole math namespace in esbuild\n([issue #1420](https://github.com/evanw/esbuild/issues/1420)); Rollup shakes this static use.\nDirect `import * as math from '@insiderfinance/totalfinance/math'` with static member use also shakes. Dynamic\nnamespace access and registries retain the implementations they can reach.\n\nInstallation size is not final bundle size, and plain Node ESM performs no automatic dead-code\nelimination. Facades include validation and `.explain()` services; indicators also carry streaming\nsupport. Type-only imports add no runtime code. Browser-safe calculations remain separate from\nNode-only CLI, HTTP, MCP, and filesystem helpers. Read\n[Imports and bundles](/guides/imports-and-bundles) for examples and measured budgets.\n\n## Reproduce before extending\n\nRun a task page with the sample inputs, read **Use it in your project** and its output, then change\none assumption. Small sample arrays show literal values. Larger sample ledgers and synthetic\nbacktest data have a preview and expandable setup; **Copy setup + call** includes that setup with\nthe calculation, so no hidden variables or data downloads are required. Expand **Reproduce this\nentire playground** only when you want the complete charts and all their sample points. Both copies\nare tested against installed package artifacts at default and edited inputs. These are illustrative\ndatasets, not real quotes, historical feeds or recommendations.\n\nKeep the exact package version with saved results. Use the version page to distinguish an unreleased\nsource build from verified preview or stable registry artifacts.\n","kind":"guide"},{"title":"Agent handbook","url":"/agents/handbook","description":"TotalFinance gives an agent financial calculations, not permission to invent market observations or place live orders. The same operation definition drives the SDK runtime, CLI, local HTTP/OpenAPI, and MCP. Begin with…","category":"Guide","keywords":"TotalFinance gives an agent financial calculations, not permission to invent market observations or place live orders. The same operation definition drives the SDK runtime, CLI, local HTTP/OpenAPI, and MCP. Begin with a narrow, read-only profile.\n\n## 1. Build the local server\n\nUntil a public release is verified on the Versions page, use a source checkout. In the `@insiderfinance/totalfinance` directory, install with the pinned pnpm version and build:\n\n\n\nNode 22.13.0 or newer is required. Help and doctor exit normally. Once protocol mode begins, stdout is reserved for JSON-RPC; application logging belongs on stderr.\n\n## 2. Add the server to your MCP client\n\nUse your client's local/stdio MCP configuration. Replace the two absolute paths below with your checkout and a directory you control. This example exposes portfolio analysis and artifact tools, not the full catalog:\n\n\n\nRun the same command with `doctor` appended to diagnose the selected packs, effective tool count, budgets, and store configuration. Restart the client connection after changing configuration.\n\nAfter publication, use the exact versioned package command displayed on the Versions page. Pin that version in shared agent configuration; an unpinned `npx -y` invocation can change behavior on the next launch.\n\n## 3. Choose the smallest useful tool set\n\nThe [profile table](/agents#choose-more-tools-with-a-profile) is generated from the actual registry. `--packs` narrows a profile to exactly the named packs. It does not append implicit defaults. An omitted profile uses the established read-only compute default.\n\nFor embedding, `packs` is also exact selection. Select public operation packs and pass them to `createTotalFinanceMcpServer`. Use `--help` for the current executable flags; use the capability resource to discover the server you actually connected to, rather than assuming another installation has the same packs.\n\n## 4. Supply evidence, not guesses\n\nGood instruction: “Use this supplied ledger and these timestamped market observations to explain the P&L between these two dates. Separate deposits from profit and disclose stale or missing observations.”\n\nBad instruction: “Tell me my current portfolio profit” without a portfolio, prices, currency conventions, or valuation dates. The correct agent response is to request the missing inputs. Compute tools do not fetch quotes, chains, statements, account history, or economic events.\n\nRates and ordinary implied volatility are decimal fractions: 0.20 means 20%. Time-to-expiry fields ending in `Years` are year fractions. The date-aware option tools also accept `expiry` plus `asOf`; do not supply both the dates and a year fraction. Date-only US-equity expiry resolution is disclosed in assumptions.\n\n## Datasets, artifacts, and handles\n\nSmall inputs can be supplied inline. A `totalfinance://` handle is a store-scoped reference, not a URL to arbitrary remote data. Only operation fields declared in `handleFields` accept handles. The attached store must contain the immutable resource with its declared schema, version, provenance, and content identity.\n\nCreate/import reusable data through the local SDK or CLI artifact workflow, then pass the resulting handle to an eligible operation. Do not fabricate a handle from a symbol or file name. Missing, incompatible, or unresolved handles must be corrected before computation. A large result may be stored with a bounded preview and a handle instead of returning the entire table through model context.\n\nReports are available as MCP resources when a store is attached. Keep ledger, market, and scenario identities with any saved conclusion so another run can reproduce it. Stores are local filesystem capabilities, not a hosted multi-tenant workspace or a broker account connection.\n\n## Errors are part of the workflow\n\n- Unknown tools/resources/prompts are protocol errors: refresh discovery and use a real identifier.\n- Invalid arguments and computation failures return `isError: true` with machine-readable error JSON in a text block. Success-shaped `structuredContent` is not used for errors.\n- Inspect the error code, field/path context, and teaching message. Correct the named problem; do not keep changing unrelated inputs until a call happens to succeed.\n- A valid numerical problem may not converge. Check diagnostics and convergence, and never replace an absent answer with an invented value.\n- Read assumptions and warnings before presenting a number. A deterministic default seed is injected only for stochastic operations and is echoed in the result.\n\n## Permissions and paper trading\n\nRead-only is the default. Selecting the full catalog does not grant a write capability or prove that a request was approved. Runtime capabilities, policy checks, and trusted authorization/journal stores remain the authority; MCP annotations are descriptive hints, not a security boundary.\n\nThe optional paper workflow is proposal → preflight → trusted authorization → paper submission → reconciliation. An inline authorization object or hash is not trusted approval. Idempotent retries use the authoritative local journal, and callers must retain the original request identity.\n\nPaper execution is simulated execution. No live broker adapter is included. Approval for a paper operation is not approval for a future live order. Local file-store guarantees apply to one coherent filesystem host, not distributed account-wide authorization.\n\nThe local HTTP interface is a separate transport. A local HTTP API with an OpenAPI document is not automatically a hosted remote MCP server, and a bearer token for local writes is not a complete multi-user identity system.\n\nThe [HTTP setup guide](/guides/http) and [downloadable OpenAPI document](/openapi.json) describe\nthat local API. This documentation website does not host those endpoints. Use the local server's\nown capabilities and OpenAPI response for its actual selected profile and permissions.\n\n## Long-running work\n\nUse the explicitly configured worker-backed job path for large backtests. Retain job identities, read status/result, and cancel work that is no longer useful. Inline deadlines are elapsed-time verdicts unless a worker path is active; a deadline label alone does not imply interruptible computation. The generated server help and capabilities distinguish these modes.\n\nThe [MCP transport guide](/guides/mcp) gives the exact worker flags, typed job submission, status,\nresult, cancellation, and paging contracts. Read `totalfinance://capabilities` before choosing a path:\nonly eligible job-class operations use workers. Lifecycle states are not measured progress percentages.\nAn explicitly attached store/runner may write local reports and job records even when financial\noperations remain read-only. Profiles do not grant financial write authority.\n\n## What remains SDK-only?\n\nThe operation catalog is a curated task surface, not the complete TypeScript API. The basic `totalfinance.option.price` tool is European Black–Scholes–Merton pricing; American, exotic, and additional pricing-engine families are available through the SDK rather than silently selected by this tool. Fixed-income operations likewise cover less than the full curves/rates/credit package.\n\nCustom callbacks, custom pricers, user-defined expected-return functions, and other executable extensions stay SDK-only. Use their documented APIs in your own trusted program. There is deliberately no MCP tool for executing arbitrary supplied code.\n\n## Assessing agent quality\n\nDeterministic protocol, parity, and trading-environment tests are necessary but do not measure natural-language tool selection. The maintained evaluation corpus records task selection, first-call arguments, recovery, missing-data handling, and authorization behavior separately. Model-dependent scores require real recorded runs; no score is implied by the unit-test count.\n\nKeep operational correctness separate from profitability. A profitable agent that ignores permissions, invents market data, or breaks ledger reconciliation fails operational evaluation.\n\nThe source checkout includes 110 maintained cases and an offline scorer. To score a real recording,\nrun `pnpm agents:score /absolute/path/to/recorded-runs.json` in the TotalFinance directory. Recording schema,\nprovenance requirements, and reviewer criteria are in `tools/agent-experience/README.md`. The scorer\ndoes not run a model, replay calls, or place trades. Missing executions stay in the denominator.\n","kind":"guide"},{"title":"Getting Started","url":"/guides/getting-started","description":"TotalFinance is an unpublished preview. Until npm publication, use a source checkout; the install commands below describe the planned published experience, not a completed registry installation.","category":"Guide","keywords":"TotalFinance is an unpublished preview. Until npm publication, use a\n[source checkout](https://github.com/InsiderFinance/totalfinance#develop); the install commands below describe the planned published\nexperience, not a completed registry installation.\n\nThe `@insiderfinance/totalfinance` umbrella provides one install for the whole toolkit. For portable browser tree\nshaking, use named imports from its domain subpaths:\n\n\n\n\n\nThe root keeps its convenience API: domain namespaces (`math`, `technicalAnalysis`, `risk`,\n`options`, …) and only five hoisted option gestures (`blackScholes`, `option`, `market`, `engines`,\n`impliedVolatility`), not the entire options API flat. There is a bundler tradeoff:\n`import { math } from '@insiderfinance/totalfinance'; math.normalCdf(0)` retains the whole math namespace with\nesbuild ([issue #1420](https://github.com/evanw/esbuild/issues/1420)); Rollup shakes this static use.\nDirect `import * as math from '@insiderfinance/totalfinance/math'` with static member use also shakes.\n\nAll domains and feature subpaths come in the main package with no runtime dependencies.\nMCP is the only optional separate package (after publication):\n\n\n\nInstallation size and final bundle size are different: installing the umbrella does not require\nshipping every domain. Plain Node ESM does no automatic dead-code elimination. Dynamic namespace\naccess and registries retain reachable implementations; type-only imports add no runtime code.\nSee [Imports and bundles](/guides/imports-and-bundles) for import examples, facade costs, and\ngenerated measurements.\n\n## Facade API\n\nFacade APIs accept flat object inputs and return plain values. Use them for notebooks, dashboards, quick calculations, and hot paths where you want minimal ceremony.\n\n\n\nEvery facade function also has an `.explain()` companion that returns the same value with assumptions and diagnostics.\n\n\n\n## Pro API\n\nThe pro API separates contracts from markets and always returns a rich envelope.\n\n\n\n## Runtime Schemas\n\nRuntime schemas live behind explicit schema entrypoints so the compute path stays small.\n\n\n\n## Current scope & limits\n\nImplemented today (phases 0–5 are complete): European pricing (Black–Scholes–Merton, Black-76,\nBachelier) with first- and higher-order Greeks and a multi-method implied-vol suite\n(`auto`/`brent`/`newton`/`halley`/`householder`); American/exotic engines (Barone–Adesi–Whaley,\nBjerksund–Stensland 1993 & 2002, binomial CRR/JR/Tian/Leisen–Reimer, trinomial, Crank–Nicolson) with\ndiscrete-dividend handling and `option.compareEngines`; stochastic-vol models (Heston, SABR, Dupire\nlocal vol) and seeded Monte-Carlo/QMC pricing with barrier/Asian/lookback exotics; the\n`@insiderfinance/totalfinance/math` numerical foundation; implied-vol surfaces with SVI/SABR calibration, skew/smile\nmetrics and event vol (`@insiderfinance/totalfinance/volatility`); options market structure — GEX/DEX/vanna/charm exposure,\nwalls, max pain, scenario maps, flow (`@insiderfinance/totalfinance/structure`); exchange calendars; 335 registered\ntechnical indicators (batch + streaming); performance metrics; risk & portfolio analytics —\nVaR/CVaR, stress/scenario testing, factor/PCA, optimization and research hygiene (`@insiderfinance/totalfinance/risk`);\nan options strategy/payoff calculator; backtesting — a vectorized research engine and an\nevent-driven execution simulator with walk-forward and tear sheets (`@insiderfinance/totalfinance/backtest`); and fixed\nincome — bonds + analytics, yield-curve bootstrapping, rates derivatives, short-rate models, and\ncredit (`@insiderfinance/totalfinance/fixed-income`).\n\nBoundaries that still hold:\n\n- `riskFreeRate` and `volatility` are scalar market inputs on the options market object (yield curves live\n  in `@insiderfinance/totalfinance/fixed-income`; the scalar vol feeds the `@insiderfinance/totalfinance/volatility` surface as fitted IVs).\n- Discrete dividends use the documented escrowed-spot approximation across BSM and the American\n  engines; the textbook `engines.blackScholes()` ignores dividends by design.\n- Date-only expiries resolve to the named instrument convention — `usEquityCall`/`usEquityPut`\n  stamp the 16:00 ET close (`expiryConvention: 'us-equity-close'`); the generic `european()`\n  builder requires the convention (or a zoned datetime) explicitly.\n- No data fetching, brokerage integration, trading, persistence, or system-clock access exists in\n  compute packages — `asOf` is always injected.\n","kind":"guide"},{"title":"Assumptions and Conventions","url":"/guides/assumptions","description":"TotalFinance does not hide finance conventions. Pro APIs return a Computed<T envelope with value, assumptions, and diagnostics; facade APIs return plain values but expose the same envelope through .explain().","category":"Guide","keywords":"TotalFinance does not hide finance conventions. Pro APIs return a `Computed<T>` envelope with `value`, `assumptions`, and `diagnostics`; facade APIs return plain values but expose the same envelope through `.explain()`.\n\n## 0.1.0 Defaults\n\n- Day count: `ACT/365F`\n- Compounding: continuous\n- Dividend model: `none` when `dividendYield` is omitted or zero; `continuousYield` when provided\n  (every pricing door, including `optionChainHealth`, echoes the yield it used and warns when it\n  defaulted)\n- Model: `black-scholes-merton`\n- Contract multiplier: a share is 1 by construction; a registered option carries its own. An\n  instrument known only from a market spot is a share, and an OCC option symbol never takes that\n  share default — a plan, preflight, paper broker, or rebalance refuses it (or leaves the target\n  unresolved) until `contractMultiplier` is declared, because the default of 1 would value a\n  100-share contract at 1% of its cash. Every fill carries the multiplier it was valued at\n  (`Trade.multiplier`, `TradePlanTrade.contractMultiplier`).\n- Greek units:\n  - `theta`: per calendar day\n  - `vega`: per one volatility point\n  - `rho`: per one percent rate change\n\n## Time\n\nCompute packages never read the system clock. The pro API requires `market.asOf`; facade APIs accept `t` directly.\n\n**Expiries name their instant.** A date-only expiry (`'2026-09-18'`) resolves to the US equity/options close under the `us-equity-close` convention: 16:00 America/New_York, or 13:00 on an early-close day (the day after Thanksgiving, and 3 July / 24 December when they are trading days). Both are DST-aware. A zoned datetime (`'2026-09-18T16:00:00-04:00'`) is taken as written. The generic contract builders refuse a bare date unless the convention is named; `usEquityCall`/`usEquityPut` carry it in their names. `exerciseTime: 'AM'` is settlement metadata and does not move `expiresAt`.\n\n**Valuation instants name their time of day.** Every option-pricing path (`market()`, `option.price`, implied volatility, strategy positions, volatility surfaces and events, structure exposure, scenarios, book marking) takes `asOf` as epoch milliseconds or a zoned ISO datetime. A bare `'YYYY-MM-DD'` is refused with the fix: a same-day option's value depends on the time of day, and a bare date resolved to UTC midnight is 20:00 ET the previous evening. `usEquitySessionInstant('2026-09-18', 'close')` is the one-call form for an end-of-day mark; `'open'` gives 09:30 ET. Date-granular consumers (ledgers, calendars, fundamentals, performance and research windows) still accept a bare date, meaning that calendar date. A market snapshot created from a bare date records `conventions.asOfConvention: 'date-midnight-utc'`; a scenario or pricer that needs the valuation instant refuses such a snapshot with the fix, while dated ledger marks use it as designed.\n\n**Field forms.** Instants (`expiresAt`, every `*TimestampMs`, `asOf` once resolved) are integer epoch milliseconds. Labels (`expiry`, `eventDate`, `exDate`) are `YYYY-MM-DD` strings or zoned datetimes. A JavaScript `Date` is accepted nowhere; pass `date.getTime()`. Time to expiry is `ACT/365F` years everywhere it is echoed; 252 appears only in realized-volatility annualization.\n\n## Why This Matters\n\nThe same numeric result can differ across desks because of day count, dividend treatment, compounding, expiry timestamp, and Greek unit conventions. TotalFinance makes those choices inspectable so results are easier to audit, reproduce, and explain.\n","kind":"guide"},{"title":"Backtesting","url":"/guides/backtesting","description":"TotalFinance ships three simulation engines and one accounting law. Every engine emits the portfolio ledger's events for what it did, and the equity it reports is the ledger's net asset value — a result that cannot re…","category":"Guide","keywords":"TotalFinance ships three simulation engines and one accounting law. Every engine emits the portfolio\nledger's events for what it did, and the equity it reports is the ledger's net asset value — a\nresult that cannot reconcile is a refusal (`backtest.ledger_reconciliation_failed`), never a number.\n\n| Engine          | Call                     | Decides over                                 | Holds                                      | Fills through                            |\n| --------------- | ------------------------ | -------------------------------------------- | ------------------------------------------ | ---------------------------------------- |\n| Cross-sectional | `crossSectionalBacktest` | a returns dataset + a point-in-time universe | a long/short book of weights per rebalance | the execution policy on a session bar    |\n| Options book    | `optionsBacktest`        | option-chain snapshots                       | one or several structures, leg by leg      | the execution-policy costs; combo/legged |\n| Portfolio       | `portfolioBacktest`      | every observation of every instrument        | any mix of the eight instrument kinds      | the execution policy on the observation  |\n\n`vectorized` and `eventDriven` (single-instrument bars) are unchanged and remain the fastest way to\ntest a bar-level signal.\n\n### Portfolio timing and funding\n\n`portfolioBacktest` calls the strategy after the observation is complete and prior orders have\nfilled. A decision made from observation 0 first executes on observation 1; a market order uses\nthat later bar's open, and a limit/stop uses that later bar's range. It never trades on the open\nof the bar whose close the strategy just read. The last observation values the book without\nasking for another decision. The stepper and trading environment obey the same single-delay law.\nAn order cannot execute against an unchanged, already-seen bar just because another instrument\nadvanced the clock. Standalone callback orders get one execution attempt; use the trading\nenvironment when you need persistent open-order, cancellation, and replacement semantics.\n\nPre-open entitlements and external flows precede queued fills. Derivative settlement, funding,\nand rolls that use the completed observation follow those fills: a closing gain cannot finance\nan earlier opening purchase, and a derivative bought at the open still settles at that close.\n\nEntry orders must fit the declared initial-margin/buying-power budget after fees and existing\nexposure. The cash default reserves unsettled payables and does not spend unsettled receivables;\nfund each trading currency explicitly (there is no automatic FX conversion). An unaffordable\norder gets a `backtest.limit_rejected` row, not a hidden loan or resized fill. Risk-reducing exits\nremain possible. Maintenance liquidations are a declared contemporaneous-close assumption and\ncannot execute retroactively at an earlier open.\n\nFX rates are dated point quotes available at their stated timestamps, not OHLC closing fields.\nConversions use the latest supplied quote at or before the current instant; a later quote is\nexcluded. Timestamp a published fixing when it becomes available if it is not known at the open.\n\n## Which engine\n\n- **A factor, a screen, or a score over a universe** — `crossSectionalBacktest`. The signal is one\n  research verb (`FactorRecipe`, `scoreUniverse`, `screenUniverse`), the selection is\n  `formQuantilePortfolios`, the quantities are `allocatePortfolio`. `crossSectionalBacktestGrid` runs a\n  cartesian product of variations and composes the hygiene verdicts (`researchProtocol`,\n  `deflatedSharpeRatio`, `probabilityOfBacktestOverfitting`) verbatim.\n- **A rules-based options program** — `optionsBacktest`. Declarative entries (spreads, condors,\n  strangles, straddles, covered calls, protective puts, calendars, diagonals, double diagonals), exits\n  and rolls, a book of rules with pre-trade limits, combo or legged fills, corporate-action lineage,\n  dividend evidence, the surface summary.\n- **A multi-asset portfolio with lifecycle** — `portfolioBacktest`. Equities, ETFs, options, futures,\n  FX forwards, crypto spot and perpetuals, bonds, or a custom adapter; a model on a schedule\n  (`proposePortfolioRebalance`) or a direct callback; settlement lags, external flows, a calendar,\n  the margin check with forced liquidation.\n\n## The laws every engine keeps\n\n1. **No look-ahead.** A decision instant sees only what was available at that instant: a feature by\n   its `availableTimestampMs`, a chain by its snapshot, an observation by its timestamp, universe\n   membership by its history. A later restatement never reaches an earlier decision.\n2. **Ordering invariance.** Shuffle the input rows and the result is byte-identical.\n3. **The ledger is the truth.** Fills are `NormalizedFill`s from `@insiderfinance/totalfinance/portfolio`; the engine\n   defines no fill, cash, lot, or P&L shape of its own. `result.ledger` folds to `finalValue`.\n4. **Execution is declared.** The default policy is `execution.simplified()` and every result names\n   it in `assumptions.execution`; `execution.declared({...})` is a claim the caller signs.\n5. **Bounded work.** Rows, positions, grid variations, and books have ceilings with typed refusals.\n6. **Determinism.** No engine reads a clock; a `seed` only seeds the bootstrap confidence intervals.\n\n## Artifacts and operations\n\n`@insiderfinance/totalfinance/backtest/artifacts` saves any run as a content-addressed artifact (`backtestRunArtifact`),\nrestores it (`readBacktestRun`), replays it to the same run hash (`replayBacktestRun` — live models\nare taken back and verified against their recorded descriptions), and compares two runs\n(`compareBacktestRuns`). Over the wire, the opt-in `backtestPack` exposes\n`totalfinance.backtest.vectorized_run`, `options_run`, `cross_sectional_run`, and `portfolio_run` with\ndeclarative inputs only; callbacks are SDK-only.\n\nCross-sectional `runId` identifies the full declarative signal/configuration and session span,\nincluding component directions, weights, screening predicates, costs, and report settings.\nIt is not a digest of the dataset rows: the stored artifact's `runHash` is the separate complete\nresult identity. Custom callable cost/fill models retain their declared label/version identity;\ncallers must change those identifiers when behavior changes. Callback runs remain explicitly\nnon-replayable.\n\n## Out of sample\n\nA cross-sectional strategy fits nothing, so \"training\" means choosing a variation.\n`crossSectionalWalkForward({ request, variations, trainSessions, testSessions })` runs the grid on every training\nspan, lets its selection metric choose, runs the choice once on the following held-out span, and\nstitches the held-out returns in order (rolling or anchored spans). `crossSectionalPurgedFolds({ request, variations,\nfolds, purgeGap, embargo })` takes its folds from `purgedKFold` over the session index, pools a fold's\ntwo training segments into one return series, and evaluates the choice on the held-out block. Both\nreport every window's training sweep ids and held-out run id, the train-versus-test degradation, and\nthe stitched held-out performance; the grid's own hygiene verdicts (`researchProtocol`,\n`deflatedSharpeRatio`, `probabilityOfBacktestOverfitting`) remain the in-sample story.\n\n## A first call\n\n\n\nSee `docs/specs/portfolio-scale-backtesting.md` for the contract and its decisions.\n","kind":"guide"},{"title":"Adopt TotalFinance without guessing why the numbers changed","url":"/guides/calculation-adoption","description":"Keep the old result, the new result, and their actual assumptions together. A close price is not proof that two calculations used the same dividend treatment, expiry instant, day count, contract multiplier, price sour…","category":"Guide","keywords":"Keep the old result, the new result, and their actual assumptions together. A close price is not\nproof that two calculations used the same dividend treatment, expiry instant, day count, contract\nmultiplier, price source, or Greek source.\n\nRaw functions still take ordinary named inputs. Saved artifacts are optional tools for comparisons\nand replay, not a prerequisite for calculating a price.\n\n## Record, replay, and compare a calculation\n\nThis self-contained example uses hypothetical inputs and reruns the same calculator. It demonstrates\nthe adoption workflow, not an independent numerical oracle. When integrating another library,\nrecord that producer's real input parameters and assumptions instead of copying TotalFinance's labels.\n\n\n\nThe metric paths are explicit own-property components relative to each saved result. Different result\nschemas can use different paths. A literal dotted key is one string component; array positions are\nnumeric components. Give premiums, P&L and each Greek their own tolerance and unit. Units are\ncaller-declared labels, not a currency-conversion or dimensional-analysis engine. Normalize deliberately\nbefore saving when one producer returns dollars per share and another returns dollars per contract.\n\nThe status is deliberately conservative:\n\n- `match`: the selected metrics meet their stated tolerances under matching recorded context.\n- `mismatch`: context matches, but at least one selected value exceeds its tolerance.\n- `not-comparable`: recorded inputs, assumptions, conventions or units differ. The report still\n  shows numeric agreement separately, so a definition difference is not hidden as a formula bug.\n- `insufficient-evidence`: input identity/assumptions or a selected value is unavailable, or retained\n  context differences were truncated, or a producer reported non-convergence/error diagnostics.\n  Two null values are not a successful numeric match.\n\nProducer operations must match by default. An intentional comparison of different operations uses\n`operationPolicy: 'compare-declared-metrics'`; the report still discloses both operation identities,\nall source diagnostics and any input/assumption differences. This opt-in never waives failed source\ncalculations, unavailable data or mismatched units. Inspect `context.sourceDiagnostics` even when\nnumeric agreement is true.\n\nExact replay has no tolerance. Migration comparison has explicit tolerances. Neither operation\nexecutes an engine, fetches a snapshot, attributes causality, certifies a vendor, or proves that the\ncaller recorded every economically meaningful assumption.\n\n## Use observed data as observed data\n\n`observedSkew` uses supplied quotes and deltas rather than silently substituting fitted wings.\n`optionFlowDrift` accounts for trading premium within a supplied session; it is not the dealer\ngamma/charm/vanna hedging estimate. Check coverage and exclusions before interpreting either result.\n\n### Calculate exposure from supplied Greeks\n\n\n\nDelta is signed delta per share; gamma is the supplied delta derivative per underlying-price point.\nThe selected gamma exposure unit above multiplies gamma × open interest × multiplier × spot² × 0.01.\nDelta exposure multiplies signed delta × open interest × multiplier × spot. Both apply the explicitly\nselected call/put convention. No dealer-position sign convention is inferred. Provenance and age\nchecks distinguish the spot, quote and Greeks. Inspect included/excluded contributions and coverage;\na missing or stale observation is not a zero exposure. This snapshot cannot reprice a spot or\nvolatility scenario: use a pricing model for that separate task.\n\n### Inspect a chain without inventing model inputs\n\n\n\nChain health reports staleness, missing timestamps, crossed/wide markets, selected-price availability,\nduplicates and expiry/strike coverage. It does not mutate or filter your chain. An optional explicit\n`expectedContracts` universe makes missing-contract coverage meaningful; the library does not infer\nwhat an exchange lists. The default/hard quote budget is 10,000, and callers can request a smaller\n`maximumQuotes`. Quote-only use needs no made-up spot, interest rate or dividend yield.\n\nTo request model bounds and IV diagnostics, explicitly select `config.model: 'black-scholes-merton'`\nand supply `market.spot`, `riskFreeRate` and `dividendYield` (including an explicit zero yield when\nappropriate). American exercise, nonempty discrete-dividend schedules and adjusted deliverables are\nreported as unsupported, not silently treated as European vanilla contracts. A quote outside this\nmodel's bounds is model-incompatible, not proof that the market observation is bad. Failed solves\nretain their reason and never receive a guessed IV.\n\nThese are direct SDK capabilities. The CLI/OpenAPI/MCP operation list is deliberately curated;\nan exported function is not automatically a transport operation.\n","kind":"guide"},{"title":"Command line","url":"/guides/cli","description":"@insiderfinance/totalfinance ships the totalfinance binary (embedded API at /cli): the local, machine-first front door to the same operation registry every transport adapts (@insiderfinance/totalfinance/workflows). It…","category":"Guide","keywords":"`@insiderfinance/totalfinance` ships the `totalfinance` binary (embedded API at `/cli`): the local, machine-first front door to the same operation\nregistry every transport adapts (`@insiderfinance/totalfinance/workflows`). It owns no schema and no compute — every\ncommand renders `describeOperation`, calls `runOperation`, or drives the file-backed stores and the\nworker-terminated job runner. JSON goes to stdout, logs and prompts to stderr, and the exit code is a\ncontract.\n\n## Quickstart\n\n\n\n## Commands\n\n| Command                                                     | What it prints                                                                                     |\n| ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |\n| `totalfinance operations list`                              | every registered operation's description (id, version, schemas, effect metadata, annotations)      |\n| `totalfinance schema <id> [--output]`                       | the operation's input JSON Schema (or its output schema with `--output`)                           |\n| `totalfinance run <id> --input <file\\|->`                   | the `OperationResult` of an inline run (`-` reads stdin)                                           |\n| `totalfinance job submit <id> --input <file\\|-> [--follow]` | the terminal job record; a job-class operation runs in a worker, anything else runs inline         |\n| `totalfinance job status <jobId> [--follow]`                | the job record; with `--follow`, one NDJSON line per change until the record is terminal           |\n| `totalfinance job result <jobId>`                           | the stored `OperationResult` of a completed job                                                    |\n| `totalfinance job cancel <jobId>`                           | the cancelled record — from ANY process: the running runner terminates its worker on the next poll |\n| `totalfinance artifacts get <uri>`                          | `{ handle, value }` for a `totalfinance://…` handle                                                |\n| `totalfinance serve --http [--port] [--host] [--openapi]`   | the exact `totalfinance-http` invocation, then exit 2 — this binary never serves HTTP              |\n| `totalfinance doctor`                                       | the Node floor, the registry summary, the store directory state, the resolved budgets              |\n| `totalfinance --help` · `totalfinance --version`            | help on stderr · `{ totalfinance, workflows, node }` on stdout                                     |\n\n## Global flags\n\n| Flag                                         | Meaning                                                                                                      |\n| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |\n| `--profile default\\|options\\|research\\|full` | the registry profile (`default` = the ten domain packs; `full` adds the journey and backtest packs)          |\n| `--packs a,b`                                | narrow the profile to named packs — an exact selection                                                       |\n| `--seed <int>`                               | the default seed injected into a stochastic call that omits its own (echoed in `assumptions.seed`)           |\n| `--max-input-bytes <n>`                      | the wire byte budget (default 65,536; maximum 16,777,216)                                                    |\n| `--deadline-ms <n>`                          | the post-hoc deadline of an inline run                                                                       |\n| `--store <dir>`                              | the artifact and job store directory (default `~/.totalfinance/store`; an absolute path is resolved for you) |\n| `--pretty`                                   | human mode: indented JSON on stdout and a one-line summary on stderr                                         |\n\n## Exit codes\n\n| Code | Meaning                                                                                                     |\n| ---- | ----------------------------------------------------------------------------------------------------------- |\n| `0`  | success — stdout carries one JSON document                                                                  |\n| `2`  | usage — an unknown command or flag, a missing argument, malformed `--input`, an environment below the floor |\n| `3`  | the input was refused — an `OperationError` with an `input.*` code                                          |\n| `4`  | the operation failed — any other `OperationError`                                                           |\n| `5`  | the job was cancelled before it produced a result                                                           |\n| `70` | an internal error — a bug or a missing worker build, never an input problem                                 |\n\nThe error document on stdout is the `OperationError` JSON (`{ code, message, context, operation }`),\nthe same document the HTTP server and the MCP server return for the same refusal.\n\n## Jobs and handles\n\nA `costClass: 'job'` operation (`totalfinance.backtest.options_run`, `totalfinance.backtest.vectorized_run`,\n`totalfinance.backtest.cross_sectional_run`, `totalfinance.backtest.portfolio_run`) runs in a `worker_threads` Worker that rebuilds your profile's registry and writes the whole\n`OperationResult` into the store as a `totalfinance://reports/<hash>` handle. `job submit` stays attached\nuntil the record is terminal (`--follow` streams each transition); `job cancel` from another shell\nmarks the record `cancelled` and the running process terminates its worker — the work actually stops.\nEvery store is a directory two processes can share; nothing is kept in a session.\n\nAn input field that accepts a handle (`handleFields` in the operation's description) takes a\n`totalfinance://…` uri or a handle object in place of inline data; the runtime resolves it through the\nstore before validation. A result whose canonical bytes exceed 256 KiB is stored and returned as\n`{ spilled: true, handle, preview }` — never silently truncated.\n","kind":"guide"},{"title":"First success: synthetic data to ordinary calculations","url":"/guides/community-connector-first-success","description":"SDK 0.1.5 includes the provider-neutral preview research protocol. This source-checkout walkthrough builds the exact local SDK and an independent synthetic provider, so no key, market-data request or public provider p…","category":"Guide","keywords":"SDK 0.1.5 includes the provider-neutral preview research protocol. This source-checkout walkthrough\nbuilds the exact local SDK and an independent synthetic provider, so no key, market-data request or\npublic provider package is needed. The SDK understands a finite set of provider-declared research\ntimeframes; it is not a universal provider registry. Pure calculations stay ordinary; provider\npackages translate source facts once.\n\nUse Node22.23.2 and pnpm10.32.0 (the versions in .nvmrc and package.json). Install that toolchain\nfirst if missing. From a clean checkout at repository root, run:\n\n\n\nThe preparation step copies the exact local SDK tarball and refreshes its file integrity in the\nstarter's lock before frozen installation. The starter is an independent pnpm project at\nexamples/community-connectors/starter, outside the\nSDK's workspace glob, with its own project boundary and lock. It uses public SDK imports only.\nPacking an independently installable example is not npm publication. No SDK binary is committed.\nUse the SDK pack from this checkout so the installed example and contract match. Older registry SDK 0.1.4 does not supply the connector contract.\n\nThe runner installs both packs into a new temporary consumer and repeats frozen installation.\nIts synthetic JSON has cents-based OHLC fields, session labels and actual share volume. The source\nmaps cents to dollars/share once, retains actual source identity and unknown clocks, then the\nconsumer uses the same path as any provider:\n\n\n\nExpected values are **103** and **102**. The retained pages contain the observed-only/gapped\ncoverage warning, provenance, original time facts and limitations. They are not automatically\ncopied into a pure indicator result. Keep that context beside any displayed number.\n\nFor SMA(20), three rows are insufficient even when pagination is terminal:\n\n\n\nNo bang assertion, fake warmup row, automatic extra request or filled gap. Missing actual volume\nblocks OHLCV/VWAP selection only; known closes can still support SMA. Partial quality alone does\nnot forbid valid closes. Zero is a real value. Midnight daily timestamps label sessions, not source\nobservation instants. Terminal pagination proves neither continuous history nor trade eligibility.\n\n## Write and repair one mapping\n\nRead the small independent source and\nits expected-page test. A daily-only raw\nquery receives the original DataQuery on every page and returns Promise<SourcePriceBarsPage> naturally, without conditional return assertions.\nIt explicitly refuses unsupported kinds/intervals; the consumer retains generic request inference.\n\nThe runner copies this author package, intentionally changes only `close: row.closeCents / 100`\nto `close: Number.NaN`, and rebuilds. Its actual refusal is:\n\n\n\nThe error also carries phase=page, validationCode=input.not_finite and rowIndex=0. Repair that\none line to `close: row.closeCents / 100`; the expected pages and ordinary calculations pass again.\nThe error identifies the field and rule; it never echoes the broken value or arbitrary source text.\nThe runner separately omits cents scaling from all OHLC fields. Those prices are finite and\ninternally consistent, so schema validation cannot infer the unit mistake: the independently\nexpected literal pages reject it under the kit's expected-facts law. Both proofs matter.\n\n## Use compatible real data later\n\nThe InsiderFinance provider and API integration remain private, without public onboarding. After separately arranging access and an allowance, replace only the provider binding with\n`createInsiderFinanceProvider(apiKey)` from the independently installed reference connector.\nThe same `data.connect(provider).priceBars(request)` and existing calculations remain. Follow the\n[connector guide](/guides/community-connectors) for explicit symbol/interval/dates and the exact root\nexample. Never treat the preview staging origin as an access grant. No real request is part of\nthis recipe. The reference chain remains EOD research with incomplete terms and unknown clocks;\nthere is no automatic conversion into pricing or fills.\n","kind":"guide"},{"title":"Community data connectors","url":"/guides/community-connectors","description":"No-key first success and connector author journey.","category":"Guide","keywords":"[No-key first success and connector author journey](/guides/community-connector-first-success).\n\nTotalFinance's opt-in research contract lets independently maintained provider packages supply price\nbars and option-chain research. Provider authors own their packages, releases and support. No\nTotalFinance inclusion PR, central allowlist or listing is required. Ordinary calculations still\naccept caller data and load no provider, network client or credential.\n\nSDK 0.1.5 includes this provider-neutral **preview** contract. Earlier SDK 0.1.4 does not contain\nthese subpaths. The independent InsiderFinance provider and its API integration remain private and\nare not publicly launched; this SDK release does not provide public onboarding or an API key.\nStart with the [no-key source-checkout journey](/guides/community-connector-first-success), which\nbuilds the local SDK and an independently packed cents-based provider without internal receipts,\nmaintainer paths or credentials. Private reference-provider use requires separately arranged access.\nAn external provider's provisional peer version alone never proves registry compatibility.\n\n## Fetch data and calculate\n\nInstall SDK 0.1.5 and a separately available compatible provider in the same application. The\n[no-key source-checkout journey](/guides/community-connector-first-success) builds and verifies a\nsynthetic provider without a public provider package or API access.\n\n### Private reference-provider example\n\nThe following example is for separately arranged private access. The named InsiderFinance provider\npackage is not publicly distributed and its API integration has not launched publicly; this is not\na public npm-install or API-key onboarding flow. Once a compatible provider is available,\nTotalFinance binds it once, fetches a bounded window and supplies named arrays to existing calculations:\n\n\n\nThe environment variable is read by your application, never by TotalFinance. The private connector\npreview defaults to the documented staging origin, native fetch and response-receipt clock;\nfetch/now/baseUrl overrides remain optional. Construction and local discovery cause no HTTP reads.\nConfigure access and a new request allowance before real reads. The\nexact installed example is verified with synthetic\none/multiple-page HTTP facts, not a live-data receipt. There is no MCP/server/pack prerequisite.\n\n`priceBars` returns only after terminal pagination, or throws a typed refusal. Defaults are\npageSize1000, maxPages20, maxReads21 (including one capability discovery) and maxRecords20000.\nThese are HOST work ceilings, not financial assumptions, provider maxima or paid request credits.\nThe host hard limits are10000 rows/page,100 pages,101 invoked reads and100000 records, with bounded\ncanonical work/bytes. Call options may lower connection ceilings. There are no automatic retries,\nbackground reads, fallback query or cache. An exhausted window is never a partial success.\n\nThe ordinary named arrays are frozen native arrays. `closePrices` feeds existing SMA/SMA.explain.\n`ohlcvBars` supplies OHLCV for VWAP; `bars` supplies canonical timestamped Bar records with actual\nvolume, source adjusted flags and supplied vwap. Unknown volume blocks strict OHLCV/bars only,\nnever zero-fills or needlessly blocks valid closes. Partial quality is not a blanket refusal.\n`selections` lists these choices without evaluating lazy getters; JSON serialization is safe even\nwhen volume is unknown. For an engine that takes ownership of a mutable array, use an ordinary copy:\n\n\n\nSource pages stay in **prices.window.pages**, with every timestamp, warning, quality/coverage,\nidentity and basis fact. Store `prices.window` and, after any explicit decision, `prices.selection`.\n`data.createPriceBarsWindowView(savedWindow, savedSelection)` restores without a provider. Terminal\npaging does not certify continuous history, point-in-time availability, live liquidity or enough\nrows for a chosen period. Pure engine results do not automatically inherit source metadata.\n\n## Author a minimal source, use one common SDK normalization\n\nThe no-key starter maps a genuinely\ndifferent cents-based vendor schema using public imports. The copied independent\nAlpaca-style example keeps actual\n04Z daily timestamps and passes vendor page tokens directly. Both have their own install boundary,\nlock and independently expected records/pages. Original independent review observations are unchanged.\n\nA factory returns **DataProviderSource**, protocol `totalfinance-data-source`, contractVersion2.\n`data.connect(source)` is the consumer handoff; `defineDataProvider(source)` from `/core/data` is\nan advanced one-page consumer binding. Do not return a consumer wrapper from a source factory.\nConstruction performs no discovery/network work. The SDK owns common metadata/provenance stamping,\nunknown clocks and immutable projections; the external package owns auth, HTTP, cancellation and\nsource mapping, with at most one vendor request per source query and no hidden retries.\n\nThe raw source implements:\n\n\n\nEvery query call receives the **same original financial query** plus separate\n`{limit,cursor:string|null,pins:DataPins|null,signal?}`. Authors supply actual rows and per-page\nfacts: dataset id/version, receipt time, adjustment, consistency and bar timestamp convention.\nDataset/basis/consistency may differ between queries; they are not global provider defaults.\nOptional absent clocks/freshness/coverage remain unknown. No rates, IV, roots, multipliers or\nfinancial adjustments are invented. Unsupported capabilities refuse explicitly.\n\nDiscovery declares finite understood intervals:1m,5m,15m,30m,1h,4h,1d,1w,1mo. Intraday bounds\nare inclusive zoned instants; day/week/month bounds are inclusive session labels. Unknown safe\nfuture tokens such as1s are ignored with counts while supported ones remain available. Malformed\nknown declarations still refuse. Provider ceilings may exceed host limits. InsiderFinance currently\nsupports daily/minute bars with its own2000-row and minute31-day restrictions; those are not\nuniversal SDK vendor laws. Its chains remain incomplete EOD research.\n\nAdvanced `marketData.query(originalQuery,{limit,cursor?,signal?})` is one page, zero discovery.\nFor manual continuation pass its `view.continuation`, never construct a cursor-only financial query.\nA v2 canonical page stores exact original query and provider id/version so JSON restoration can\nrecreate the continuation. A legacy v1 restored nonterminal page explicitly cannot reconstruct it.\nAll original bounds/filters/pins/identities/order and temporal conventions remain validated.\nThe public fixture and common kit use the same boundary.\n\n## Deliberately resume failed work\n\n\n\nCheckpoints are separate private storage, never serialized into public error text/context. They\nretain validated accepted pages, original binding/query/cursor/pins, paging policy and consumed\nreads/pages/records. Resume validates these before I/O, negotiates one fresh discovery and never\nrefetches accepted pages. Failed/aborted invoked reads remain consumed; pre-dispatch abort costs0.\nAccepted zero-row nonterminal pages retain their cursor and pins. No crash-atomic or upstream\nidempotency guarantee is made; a repeated failed page can incur another vendor charge.\n\nA new connection's larger DEFAULT does not raise saved budgets. Only explicit permissible\nconstructor/resume increases authorize more HOST work, never provider credit. Resolved page size\nstays pinned and must fit current connection/provider/hard ceilings. Automatic unresolved sizing\nnegotiates min(saved base1000,current connection ceiling,provider maximum). A smaller ceiling or\nexpired source pin can refuse; no cursor restart, hidden counter reset or new allowance is granted.\n\n## Explicit choices for suspect finite observations\n\nFinite contradictory OHLC is acquired unchanged with controlled `issues` (page/row/rule/fields).\nA selector stops with `data.suspect_observations` only when an unresolved issue affects a field it\nuses. For high<close, the SDK cannot know which operand is wrong. Valid closes with an unrelated\nopen-only issue stay usable. Essential identity, nonfinite required data, adjustment/filter/pin\ncontradictions and negative normalized option premiums remain hard refusals.\n\n\n\n`resolve({action:'use',reason})` deliberately retains questionable inputs; existing pure leaves\nstill enforce their own validations. `correct` requires explicit finite OHLC replacements and a\nreason; it never changes raw source rows or invents volume/identity/time. Selections retain ordered\nsource-row correspondence and explicit decisions; exclusion does not imply continuous history or\nsufficient lookback. Persist source and selection separately to revalidate/replay them on restore.\n\n## Read the metadata before computing\n\nA daily source timestamp can be04Z/session-start, or midnight UTC can be a **session-date label**. Keep its declared convention and explicit session label; neither is observation or availability. A minute bar's interval start\nis separate from source receive/observation time. Source storage, API generation, host receipt and\nfirst public availability are separate facts. Null means unknown; fetching now never supplies the\nmissing historical instant. The existing Provenance record carries only clocks actually known.\n\nSource quality `complete` does not prove continuous historical coverage. Bounds can enclose a long\ngap; missing sessions/minutes are not filled. Keep the returned source issues, observed-only\ncoverage and adjustment basis with any analysis. Split-only prices are not dividend-adjusted total\nreturns. Every protocol2 capability is research-oriented: `pointInTime: false` and\n`executionEligibility: 'research-only'` grant no liquidity or trade eligibility guarantee.\n\nAn incomplete chain acquisition record is deliberately different from a complete `OptionQuote`.\nIt retains source IDs, missing terms, quotes, supplied Greeks and diagnostics. It does not invent\nlisted roots/OCC symbols, multipliers, exercise/settlement style, exact expiry or valuation time,\nrates or volatility. Source model price remains separate from observed quote fields. Obtain missing\ninputs independently and validate them through the existing public builders before pricing; this\ncontract offers no automatic pricing, market-snapshot or fill conversion.\n\n## Verify an external package\n\nProvider implementations import the public SDK just like any application. Keep credentials and\nHTTP mappings in the independent provider package. The maintained InsiderFinance package uses this\nsame route; it is not an exception or an internal workspace advertised as installable.\n\nRun the framework-independent kit against hand-authored expected pages and error/abort probes.\nPin receipt clocks, provider identity and opaque cursor constants explicitly. Test capability\ntruthfulness, ordering/identity within and across pages, source pins, finite/null/zero handling,\ninput immutability, bounded walks, cancellation, access/rate-limit errors and error redaction.\nExpected metadata may differ by provider; do not erase financial, temporal or quality differences\nto make a comparison pass. A kit that cannot reject one-defect provider mutants proves little.\n\nPack and install both SDK and provider in a clean consumer with no workspace aliases. Compile with\nNodeNext and Bundler resolution, execute ordinary ESM, verify the registered safe error contract across separately installed SDK copies and run the\nsame research workflow against fixture and HTTP implementations. The explicit local rehearsal is\n`tools/community-connectors-provider-smoke.ts`; its inputs are two supplied tarballs and synthetic\ntests, never credentials. Offline fixtures establish mapping behavior, not upstream deployment,\nactual entitlements, historical completeness, licensed redistribution or a real-agent result.\n\nAuthentication, entitlement, throttles, exhausted allowance, snapshot expiry, cancellation and\nservice/data failures have distinct registered codes. Retry advice is metadata; the connector does\nnot issue a second request. API-01's published pagination instructions remain a separate app/API\ntask. API-02–05 coverage, temporal model, freshness and methodology findings remain source-qualified\nlimits rather than an invitation to rewrite the server or invent missing inputs.\n\nPortable provider refusals preserve the registered data/access codes and only these existing general\ninput codes: input.wrong_type, input.missing_field, input.not_finite, input.out_of_range and\ninput.invalid_enum. The SDK rebuilds its own error text/class and retains the original cause locally.\nUse DataProviderError with explicit controlled guidance for public field/rule teaching; arbitrary\nprovider messages, contexts and causes are never forwarded as public diagnostics. Unknown codes and\nnetwork throws remain data.provider_failure. The kit checks the same protocol across SDK copies.\n","kind":"guide"},{"title":"Compare reported holding partitions","url":"/guides/disclosed-holding-partitions","description":"Use compareDisclosedHoldingPartitions to compare common-stock disclosure lines while keeping their investment-discretion categories and report-local manager references separate. You supply the selected reports and aut…","category":"Guide","keywords":"Use `compareDisclosedHoldingPartitions` to compare common-stock disclosure lines while keeping\ntheir investment-discretion categories and report-local manager references separate. You supply\nthe selected reports and authenticated mappings; the library calculates reported changes, weights\nand concentration. It does not establish trades, ownership or assets under management.\n\n## Compare two complete reports\n\nThis hypothetical example has two reporting partitions for one stock: sole (`SOLE`) and other\n(`OTR`) discretion. Both reports have already passed the [caller checklist](#caller-checklist).\nAmounts and quantities are exact decimal strings; `'0.7'` as a weight means 70%.\n\n\n\nThose are differences in the disclosures, not assertions that the manager bought those shares.\nThe same function is also available from the portfolio domain and root `portfolio` namespace;\nyou only need one import. The dedicated subpath above keeps this task easy to locate.\n\n## Caller checklist\n\nThe three flags are independent **caller attestations**, not requests for the SDK to fetch or\nverify source evidence. Set a flag to `true` only when your upstream process has established it.\nUse `false` when unknown and record known issues in snapshot or row `reviewReasons`.\n\n| Flag                 | What you must establish before setting it to `true`                                                                                                                                                            |\n| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `reportComplete`     | All holdings in the selected reported universe are supplied: no remaining pages, filtering, or known withheld/missing rows. This does **not** mean the disclosure covers all of the manager's economic assets. |\n| `mappingComplete`    | Every supplied row has an authenticated issuer/security/class mapping. Retain unresolved rows; never remove them to produce a complete-looking mapped subset.                                                  |\n| `comparisonEligible` | Source and report-selection review permits using this snapshot in the requested comparison, including amendment selection and known disclosure limitations. This is separate from having all rows or mappings. |\n\nThe SDK validates the consumed fields and detects supported-profile, duplicate and identity\nconflicts, but it cannot authenticate your evidence IDs or discover omitted source rows. Setting\nall flags to `true` never overrides a row review, unsupported instrument, mixed currencies,\nreport-local reference ambiguity or changed partition basis.\n\nIf any flag is `false`, that snapshot's denominator and weights are unavailable. If either\nsnapshot fails these gates, comparisons do not infer absence, substitute zero for missing\nholdings, or calculate deltas. Supplied facts stay visible with typed reasons. Complete empty or\nzero-value reports are different: their total is exactly zero and they can establish absence,\nbut ratios remain unavailable because their denominator is zero.\n\n## Read the reporting basis and unavailable results\n\n`SOLE`, `DFND` and `OTR` are supported discretion labels. The library consumes exact opaque\n`otherManagerReferences`; the SEC consumer checks positive sequence grammar and membership in the\nspecific source report's included-manager evidence. References are never global manager identities.\nA reference-bearing key includes its sourceReportId. A no-reference key omits it, so repeated lines\nfrom separately selected amendments still receive duplicate review instead of being summed.\n\n`partitionWeight`, `largestPartitionWeight` and `partitionHerfindahlIndex` describe reported lines\nin the full supplied universe. All rows must be supported, review-free and in one currency, and\nall three independent gates must pass. A missing mapping or reviewed row withholds the denominator;\nthere is no mapped-subset fallback. Empty and zero-value universes have exact total zero and null\nratios. Rounding happens once, half away from zero, at the explicit 0–18 places; amounts and signed\ndifferences stay exact base-ten strings. Herfindahl uses unrounded operands.\n\nReferences or changed no-reference discretion sets on either side withhold the entire security/class\ngroup, including an otherwise matched SOLE row. These facts appear in side-specific\n`uncomparedPartitions` with unknown classification and explicit reasons. Every keyed partition is\naccounted for exactly once per present side through a change or an uncompared record; unkeyed rows\nremain visible among holding outcomes. Already-reviewed duplicated reference tokens are retained\nonly as unkeyed outcomes and cannot supply a partition or denominator; unreviewed duplicates refuse.\n\nUse `same-period-revision` only for the same report date with distinct selected report sets.\nNew/removed classifications describe source presence, and require complete supported evidence on\nboth sides. No quantity difference is a purchase/sale assertion. Broader instruments, aggregation,\nmanager overlap and ownership percentages need separate methodology. The existing\n[`compareDisclosedHoldings`](./disclosed-holdings.md) API retains its v1 policy and output.\n\n## Optional: save the analysis\n\nIf you need a reproducible analysis artifact, store the same input and result from the example:\n\n\n\nArtifact storage is optional; it does not change the calculation or verify source authenticity.\n","kind":"guide"},{"title":"Compare reported holdings","url":"/guides/disclosed-holdings","description":"compareDisclosedHoldings compares two supplied disclosure snapshots. It reports what changed in those disclosures; a quantity difference does not prove a purchase or sale. The library does not retrieve filings, select…","category":"Guide","keywords":"`compareDisclosedHoldings` compares two supplied disclosure snapshots. It reports what changed in\nthose disclosures; a quantity difference does not prove a purchase or sale. The library does not\nretrieve filings, select amendments, resolve security mappings, or manufacture a trading ledger.\n\n\n\nAll financial amounts are exact decimal strings. The API multiplies reported values by their\nexplicit source scale (`1` or `1000`) before calculation. It preserves the original values beside\nthe normalized amounts. Ratios are decimal fractions, rounded once half away from zero at the\nrequested precision; `0.25` means 25%. Concentration includes the largest position weight and\nHerfindahl index, calculated from unrounded values.\n\nRead `report.assumptions.policy` for the exact selected profile, discretion rule and ratio\nprecision; the adjacent prose explains their meaning. `valueScale` accepts only the string literals\n`'1'` and `'1000'` in TypeScript as well as at runtime.\n\nLibrary-generated `reasons` are typed codes, so editors autocomplete values such as\n`'unresolved_identity'`, `'zero_denominator'` or `'baseline_report_incomplete'`. A change's\nsnapshot-level reasons identify the affected side (`baseline_` / `current_`). Caller-provided\n`reviewReasons` remain separate, free-form source explanations. Use the codes for application\nlogic; do not parse warning messages or assumptions prose.\n\nThe denominator is all supplied reported holdings in a complete supported universe. This version\nsupports mapped common stock with share quantities, no option side, and sole discretion without\nother-manager references. Unresolved mappings, unsupported securities, shared discretion and\npossible duplicated security/class rows stay visible with review reasons. They prevent a partial\nsubset from being presented as the complete portfolio. It is neither total manager assets nor\nissuer ownership percentage.\n\n`reportComplete`, `mappingComplete` and `comparisonEligible` have separate meanings. Incomplete or\nconfidential reporting cannot establish that an absent position was sold. New/no-longer disclosed\nclassifications and deltas require complete comparable evidence. A matched supported row can still\nbe described as disclosed in both periods while its total difference is withheld. Complete empty\nor all-zero reports can establish absence, although their weights remain null because division by\nzero is undefined. A zero-quantity reported row remains disclosed.\n\nUse `same-period-revision` with the same report date and different selected report IDs when comparing\nrevised disclosures. No corporate-action adjustment or amendment ancestry is inferred. Distinct\nclasses never combine; identity conflicts, changed currency and missing evidence remain explicit.\n\nThe report carries assumptions and warnings and can be passed directly to\n`createAnalysisArtifact({ artifactType, producedBy, inputs, result: report })`. Put independent\nsource/system cutoffs, selected receipt hashes and provider lineage in the caller's input envelope.\nRoot `portfolio.compareDisclosedHoldings`, the portfolio domain import and the dedicated subpath\ncall the same implementation. No provider credentials or Node process is needed for the pure SDK.\n","kind":"guide"},{"title":"First useful results and first-failure recovery","url":"/guides/dogfood-journeys","description":"These synthetic examples use the public SDK and its existing operation registry. Install @insiderfinance/totalfinance with your package manager, put the TypeScript blocks below in one journeys.mts file in order, and r…","category":"Guide","keywords":"These synthetic examples use the public SDK and its existing operation registry. Install\n`@insiderfinance/totalfinance` with your package manager, put the TypeScript blocks below in one\n`journeys.mts` file in order, and run `pnpm exec tsx journeys.mts` (add `tsx` as a development\ndependency if needed). They require no provider or key. The packed-consumer test compiles and runs\nthese exact blocks. A prepared workspace version is not evidence that it is already on npm.\n\n## Compute from the statement you actually have\n\nIncome-only ratios accept `{ income }`; balance-only ratios accept `{ balance }`. Each direct\nrequest requires its period and the monetary lines its formula needs; unrelated income/balance\nlines and other statements are not prerequisites. Other supplied canonical fields remain validated. Complete\n`{ statements }` calls remain supported and validate the complete corresponding set. EBITDA,\nmarket multiples and cross-statement/average-balance ratios still require their stated inputs.\nDo not invent a cash-flow table or call cumulative nine-month flows a quarter. A full-set report's\nperiod availability is the latest publication instant of its three statements; a direct statement\nreports its own availability. Paired reports expose both current and prior period availability;\npoint-in-time use must respect both (including a later prior-period restatement).\n\n\n\nThe direct family also includes operating/net margins, interest/debt-service coverage, earnings/\nrevenue per share, quick/cash ratios and debt/equity or debt/assets. Per-share inputs retain\nabsolute diluted share counts and convert reported monetary scales explicitly. A missing optional\nnumerator or zero denominator yields `null` with its reason in `.explain()`.\n\n## Create, open and inspect a portfolio\n\nEnable both the `trade` and `portfolio` packs for create → inspect: creation and the event writer\nlive in `trade`, while inspection lives in `portfolio` and requires `portfolio:read`.\nCLI/MCP `--profile full` includes both. A trade-only configuration must enable `portfolio` before\ncalling the returned inspection operation. Creation requires\n`portfolio:write`, a writable artifact store, durable identity, currency and explicit initial events.\nAn empty event array creates an unfunded ledger. To fund it, supply actual explicit `cash.deposit`\nevents through creation or `portfolio.record_events`—there is no implicit deposit.\n\n\n\nSave the returned URI; the same store resolves it on the next process. For durable local use,\nreplace `createMemoryArtifactStore()` with\n`createFileArtifactStore({ directory: '/absolute/path/to/your-store' })` from\n`@insiderfinance/totalfinance/workflows/local`. CLI/MCP use `--store` for that same store.\nMCP uses `--profile full --capability portfolio:write` and the tools\n`totalfinance_portfolio_create`, `totalfinance_portfolio_inspect`, and\n`totalfinance_portfolio_record_events`. HTTP also requires its configured mutation bearer credential;\na client capability does not enlarge the server's ceiling.\n\nInspection opens inline serialized ledgers too. `section` is `summary` (default), `events`,\n`positions` or `cash`; `offset` defaults to 0 and `limit` to 20 (maximum 100). Rows are bounded\npreviews with container counts; `total` and `nextOffset` make continuation explicit. Use\n`portfolio.snapshot` with actual market observations to value holdings. Event writes return new\ncontent-addressed handles; prior handles retain their original meaning. Portfolio handles are\nopened through this operation, rather than MCP `resources/read`.\n\n## Project bars without losing their source\n\nTA rows contain financial OHLCV fields. Core Bar records also identify symbol and observation time.\nMake that projection explicit; retain the originals and their source/revision/receipt context next\nto the result. No adapter infers volume, price adjustments, availability or a newer observation.\n\n\n\nMCP `technical_analysis.calculate` accepts canonical `sourceBars` directly under `bars`, including\n`symbol`, `timestampMs` and optional `vwap`/`adjusted`; no SDK preprocessing or field stripping is\nneeded. When source metadata is present, every row must have the canonical source fields, one\nsymbol and strictly increasing unique timestamps. Neither the tool nor the SDK projection sorts,\ndeduplicates, changes adjustment flags or relabels times. Bare OHLCV rows and columns under `series`\nremain supported. Source context stays with the caller, and the operation's input hash covers the\noriginal canonical input.\n\n\n\nWire errors report exact total issue counts and at most ten representative indexed issues; fix the\nnamed fields and retry the original data. All rows are still validated. TA discovery distinguishes\nname search from category browsing: use `{ category: 'momentum' }` with\n`totalfinance_technical_analysis_list` (SDK `searchIndicators` uses `query` for name search).\n\n## Screen only available facts with the finite predicate grammar\n\nThe recursive grammar is `all: Filter[]`, `any: Filter[]`, `not: Filter`, or a field condition:\n\n| Operators                                                          | Additional fields                                                 |\n| ------------------------------------------------------------------ | ----------------------------------------------------------------- |\n| `greaterThan`, `greaterThanOrEqual`, `lessThan`, `lessThanOrEqual` | numeric `value`                                                   |\n| `equals`, `notEquals`                                              | number/string/boolean `value`, compatible with the declared field |\n| `between`                                                          | numeric `from`, `to`                                              |\n| `in`, `notIn`                                                      | number/string `values` array                                      |\n| `isPresent`, `isMissing`                                           | none                                                              |\n\nGroups are nonempty and keys are closed. There are no `gt`/`gte` aliases or expression strings.\nThe same grammar appears in MCP/OpenAPI discovery; declared field kinds and availability are\nvalidated by the shared SDK.\n\n\n\n## Model lag and monthly sampling explicitly\n\nVectorized fills use closes. On a rebalance bar `i`, the engine samples `signal[i - executionLag]`.\nIncreasing lag does not postpone a missed monthly sample to the next day. In this five-session\nexample lag 1 first buys February 2, while lag 2 misses that sample and first buys March 2.\n\n\n\n`totalfinance_backtest_vectorized_run` now accepts `executionLag`, `rebalance`, `slippageBps`,\n`periodsPerYear`, `riskFreeRate`, and `maxLeverage` alongside existing `feeBps`. They delegate to\nthese SDK controls. Defaults remain the SDK's declared defaults; lag 0 produces a look-ahead warning.\nPortfolio backtests use their own next-observation execution law: do not claim cross-engine\nnumerical equality. A one-bar lag does not prove source arrival before the next interval opened.\n\n## Count every attempted configuration and keep evaluation separate\n\nFreeze hypotheses and the split before viewing held-out outcomes. Select using training data only;\nevaluate that same selected rule on the untouched holdout. Keep every attempt, including a rule\nthat made no trades. Undefined Sharpe is not zero and must not be fabricated into `trialSharpes`.\nThe count-plus-variance route below uses a separately declared synthetic null-model variance,\nnot an invented Sharpe for the flat rule. If that variance is unavailable, retain the gap rather\nthan claim a selection-adjusted result.\n\n\n\nThis is SDK guidance, not a new MCP research-verdict operation. See the\n[backtesting guide](/guides/backtesting) for existing grid/out-of-sample operations and the\nresearch-hygiene examples. Attractive simulated returns or\none short paper interval do not establish skill.\n\n## Recover orders and distinguish estimated from charged costs\n\n`trade.submit.currentOrders` is the receipt-scoped journal-derived current state, including\ncumulative `filledQuantity`, `remainingQuantity` and `terminal`. `receipt` stays the original\nimmutable submission receipt. Top-level `fills`/`events` are new deltas; `recovery.fills/events` are\ncumulative. After a lost response retain the original source, journal store, approved grant and\nidempotency key; apply `recovery.events` idempotently to the latest portfolio handle. See the\nexecutable recovery examples and\n[recovery guide](/guides/trade-lifecycle#recovering-a-lost-submission-response).\n\nWhen restoring, omit `instruments` to reuse authoritative persisted terms, or repeat the exact\noriginal mapping. Adding explicit share/settlement defaults to an older mapping is a changed\npersisted identity even when it appears economically equivalent. Do not edit the journal or\nretry with a new key to bypass that check. Real term changes require a separate supported lifecycle.\n\nProposal commissions and preflight `costs` are estimates. `maximumEstimatedCost: 0` and\n`maximumSlippageBps: 0` now mean real zero ceilings: any positive estimate fails. Omitting a ceiling\nmeans it is not supplied; zero never disables it. The MCP paper broker still uses its disclosed\nsimplified zero-cost policy. Estimates do not charge the ledger. Only actual normalized fill costs\nand corresponding `cost.charge` events charge execution fees. For a declared nonzero execution\npolicy, use SDK `createPaperBroker({ ..., execution })` from\n`@insiderfinance/totalfinance/backtest/paper`, with factories from `/backtest/execution`—the\n[safe trade guide](/guides/trade-lifecycle) explains authority and recovery. This patch adds no\nwire paper-cost argument or cost-policy bypass.\n\nCalendar discovery includes `US_EQUITY_CALENDAR_COVERAGE`: NYSE/CBOE one-off closures before\n2001-01-01 are incomplete; earlier operation ranges carry `calendar.outside_historical_coverage`.\nRules do not predict future emergency closures, and `verifiedThrough: null` explicitly declines to\ninvent a certified endpoint. Session answers remain unchanged; independently verify old schedules.\n\nSeparate financial/time designs remain necessary for intraday P&L marks, availability-aware\nresearch composition, and cumulative interim/YTD statements/quarter derivation. Do not relabel\nsource times or periods to force those unsupported compositions.\n","kind":"guide"},{"title":"End to end: fundamentals → valuation → screen → portfolio → backtest → performance","url":"/guides/end-to-end","description":"One journey across six packages, on committed numbers, with no provider, network, credential, clock, database, MCP server, or UI. Every step's output feeds the next through public types only, and every step is reconci…","category":"Guide","keywords":"One journey across six packages, on committed numbers, with no provider, network, credential,\nclock, database, MCP server, or UI. Every step's output feeds the next through public types only,\nand every step is reconciled to a primitive the library already proves. The executable twin is\n`docs/examples/end-to-end-journey.test.ts`; this page's blocks run in CI too.\n\n## 1. Fundamentals\n\nTyped statements in, point-in-time ratios out. A statement is visible only from its\n`availableTimestampMs`; nothing is inferred from a period end.\n\n\n\n## 2. Valuation\n\nA DCF from the statements under explicit conventions. The discount rate is required — a\nconvention is a goal, never a default — and the composition equals the direct DCF of the flows it\nprojected.\n\n\n\n## 3. Research\n\nThe fundamentals and the valuation become declared fields of a universe, and a score ranks the\nnames — point in time, by each observation's availability.\n\n\n\n## 4. Portfolio\n\nA ledger with cash, a market snapshot, and a proposal that buys the two best names to weight —\na proposal, never an order.\n\n\n\n## 5. Backtest\n\nThe same score as a cross-sectional signal over a returns dataset. The engine's equity is its\nledger's net asset value, and the execution policy is named.\n\n\n\n## 6. Performance\n\nThe run's performance block is `analyze` of its equity curve — the same function anyone can call\non any equity or return series.\n\n\n\nSix packages, one journey, every step reconciled. The workflow form of each step —\n`totalfinance.valuation.company`, `totalfinance.research.score`, `totalfinance.portfolio.rebalance_proposal`,\n`totalfinance.backtest.cross_sectional_run`, `totalfinance.performance.analyze` — runs the same functions\nover a wire; see [the MCP guide](/guides/mcp) and [the CLI guide](/guides/cli).\n","kind":"guide"},{"title":"Results & the .explain() envelope","url":"/guides/envelope","description":"Every runtime operation in TotalFinance is exactly one of four roles, and each role has ONE result grammar (alignment spec Law 2 — settled by both PR-303 reviews):","category":"Guide","keywords":"## The four public roles (one grammar per role)\n\nEvery runtime operation in TotalFinance is exactly one of four roles, and each role has ONE result\ngrammar (alignment spec Law 2 — settled by both PR-303 reviews):\n\n| Role         | Who it's for                                                                                             | Call shape → result                                                                                    |\n| ------------ | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |\n| **Facade**   | most users                                                                                               | one input object (or series + options) → **plain value**; the same call's `.explain()` → `Computed<T>` |\n| **Analysis** | results whose diagnostics are inseparable (calibration, optimization, exposure, backtests, crypto carry) | one input object → **`Computed<T>` directly** — no plain form, nothing to forget                       |\n| **Artifact** | reusable calibrated/stateful values (surfaces, curves, positions, streams)                               | factory config → immutable object with methods + versioned `toJSON`/`fromJSON`                         |\n| **Kernel**   | experts & internal composition                                                                           | one named object for confusable finance inputs on expert subpaths; direct numeric result               |\n\nAfter learning one domain you can predict every other: `probabilityInTheMoney({...})` is a facade (plain\nnumber, `.explain()` when the risk-neutral caveat matters); `calibrateSvi(...)` is an analysis\n(envelope always); a `VolatilitySurface` is an artifact; `blackScholesPrice({ type, spot, strike, timeToExpiryYears, riskFreeRate,\ndividendYield, volatility })` is a kernel behind `@insiderfinance/totalfinance/options/black-scholes`.\n\nTotalFinance has one rule for the shape of every result, and it never varies:\n\n- **Plain call → plain value.** `blackScholes.call({ … })` → a number. `sharpe(returns)` → a number.\n  `rsi(closes)` → a number array. No wrapper, no ceremony — the value you asked for.\n- **`.explain()` → the envelope.** The same call with `.explain()` returns the rich `Computed<T>`\n  envelope: `{ value, assumptions, diagnostics }`. `assumptions` echoes every convention that was\n  applied — so a defaulted `periodsPerYear: 252` or `riskFreeRate: 0` is **disclosed, never hidden**;\n  `diagnostics.warnings` carries any caveats. For example:\n\n  \n\n- **Pro API → the envelope always.** `option.price({ contract: contract, market: market, engine: engine })`,\n  `exposure(chain, market, config)`, `calibrateSsvi(surface)` and the other analysis-role `f(subject, market, config?)`\n  functions return `Computed<T>` directly — there is no plain form, because a professional result must\n  always carry the assumptions it was computed under.\n\n**One envelope type.** `Computed<T>` is used for every rich result across every package, so a\nserialized result is self-interpreting and MCP / serialization consumers treat all results the same\nway. (Warnings always live under `diagnostics.warnings` — never hoisted to a top-level `warnings`.)\n\n**Technical indicators fit the same envelope.** `@insiderfinance/totalfinance/technical-analysis`'s `.explain()` returns the ordinary\n`{ value, assumptions, diagnostics }` envelope too — there is no separate `SeriesResult` type. Its\n`value` is the aligned, NaN-padded series (each output lined up with its input bar), and the length of\nthe leading NaN warmup is reported as `diagnostics.warmup` — the index of the first finite bar, exactly\nwhat a chart needs to line an indicator up with price:\n\n\n","kind":"guide"},{"title":"Errors and Diagnostics","url":"/guides/errors","description":"TotalFinance separates programmer/input failures from quantitative failures.","category":"Guide","keywords":"TotalFinance separates programmer/input failures from quantitative failures.\n\n## Facades\n\nFacade functions return plain values and throw typed `QuantError` subclasses for invalid inputs or failed solves.\n\n\n\nFor solver details without throwing on quantitative non-convergence, use `.explain()`.\n\n\n\n## Pro APIs\n\nPro APIs already return explained results, so quantitative failures are reported through diagnostics instead of guessed values. Invalid inputs and unsupported contracts still throw typed errors.\n\n## MCP\n\nThe MCP server converts validation and compute errors into structured tool errors. Quantitative non-convergence is returned as structured content with `converged: false` so agents can reason about the failed solve instead of treating it as infrastructure failure.\n","kind":"guide"},{"title":"Local HTTP server","url":"/guides/http","description":"@insiderfinance/totalfinance ships totalfinance-http (embedded API at /http): a loopback, read-only-by-default HTTP server over the same operation registry every transport adapts (@insiderfinance/totalfinance/workflow…","category":"Guide","keywords":"`@insiderfinance/totalfinance` ships `totalfinance-http` (embedded API at `/http`): a loopback, read-only-by-default HTTP server over the same\noperation registry every transport adapts (`@insiderfinance/totalfinance/workflows`), and `openApiDocument`, the OpenAPI\n3.1 document generated from that registry. The server owns no schema and no compute — every request body\nis the operation's own input schema, every success body is the `OperationResult`, and every error body is\none `OperationError` (the same document the CLI prints and the MCP server returns).\n\n## Quickstart\n\n\n\nThe server binds `127.0.0.1` by default. `localhost` and IPv6 `::1` / `[::1]` are also loopback;\nIPv6 URLs use brackets, such as `http://[::1]:8787`. A non-loopback bind needs\n`--allow-non-loopback` and your own network/TLS boundary: read endpoints remain public, and this\nserver does not provide TLS or remote multi-user access control.\n\n## Authentication and enabled writes\n\nConfigure a server-owned token before enabling any write operation. This includes `trade:approve`:\napproval persists a grant even though its operation metadata says `sideEffect: none`. Authentication\ndoes not grant capabilities; the server's explicit capability list remains the ceiling.\n\nThe SDK option is `authenticationToken: string`. Use at least 32 cryptographically random characters\nfrom the bearer alphabet (`A–Z`, `a–z`, `0–9`, `-._~+/`, optionally followed by `=` padding).\n`randomBytes(32).toString('hex')` supplies 64 suitable characters. Length validation cannot prove\nrandomness; use a secure generator, not a memorable password.\n\nFor the CLI, use `--token-file <path>` or a protected `TOTALFINANCE_HTTP_TOKEN` environment variable.\nThe file wins when both are supplied. The file reader removes one trailing LF or CRLF; the\nenvironment variable and SDK value are used exactly, without trimming. Empty or invalid tokens are\nrefused. There is no secret-valued `--token` argument. Do not put tokens in URLs, shell history,\ncommand-line arguments, logs, or version control.\n\nCreate a new owner-readable token file, without printing the credential or overwriting an existing\none, then start a server with the default analytics capabilities and the three write capabilities:\n\n\n\nOnly enable the capabilities you need. Repeated `--capability` flags **replace**, rather than extend,\nthe defaults. For authenticated analytics jobs alone, omit all `--capability` flags and keep the\ntoken. When using the environment instead, have your secret manager or process launcher supply\n`TOTALFINANCE_HTTP_TOKEN` and omit `--token-file`.\n\nIn another terminal, this client reads the same protected file and submits an analytics job. The\nsecret never becomes a process argument. The same headers protect an enabled write's inline run:\n\n\n\nEvery enabled write and `POST /jobs` / `POST /jobs/{id}/cancel` requires\n`Authorization: Bearer <token>`. Bearer values are compared with `timingSafeEqual`. JSON POSTs need\n`Content-Type: application/json` (a charset parameter is accepted). Cancellation needs no body or\ncontent-type header. Host, Origin, capability, and bearer refusals precede JSON parsing for inline\nwrites; job creation authenticates before parsing its envelope.\n\nJob submission/cancellation mutate persisted state even when the job computes read-only analytics,\nso without a configured token they return 403. Job reads and inline analytics stay unauthenticated.\nAn attached artifact store may still cache/spill public analytics results: `readOnly` describes\nenabled operation effects and job lifecycle mutations, not result caching.\n\n`GET /capabilities` reports `authentication.configured`, `jobMutations`, and `readOnly`; no secret is\nreturned. `readOnly` is false when a write operation is enabled or authenticated job mutations are\navailable. OpenAPI declares the HTTP bearer scheme `localBearer` on write and job-mutation routes,\nincluding approval; it does not require authentication on read-only analytics/discovery. Neither\nOpenAPI, capabilities, the CLI listening line, nor server logs publish the token. Restart with a new\ntoken to rotate it, and update trusted clients.\n\n## Request boundary\n\nEvery request needs a Host naming the configured server (or its bound local address) and its actual\nbound port. On loopback binds, `127.0.0.1`, `localhost`, and `[::1]` are accepted aliases; an ephemeral\nport must match the address returned by `start()` or the CLI listening line. Arbitrary hostnames and\nforwarded-host headers do not bypass this check.\n\nOrdinary non-browser clients should omit Origin. If present, it must be this server's `http://` origin\nwith a trusted host and the same port. Foreign origins, different ports, `Origin: null`, and duplicate\nsecurity headers are refused; a correct bearer token does not bypass these checks. Missing permissive\nCORS headers are not the safety boundary.\n\nMalformed targets or percent encodings receive a structured 400, and the server keeps serving.\nEncoded separators are refused in operation/job route segments; URL-encoded artifact URIs remain\nsupported, including their embedded slashes.\n\n## Routes\n\n| Route                       | What it does                                                                                         |\n| --------------------------- | ---------------------------------------------------------------------------------------------------- |\n| `GET /openapi.json`         | this document, generated from the running registry                                                   |\n| `GET /capabilities`         | packs and operation count, the resolved budgets, the seed policy, which stores are attached          |\n| `GET /operations`           | every operation's description (`describeOperation`)                                                  |\n| `GET /operations/{id}`      | one description                                                                                      |\n| `POST /operations/{id}/run` | run inline; the body is the operation's input; the response is the `OperationResult`                 |\n| `POST /jobs`                | `{ id, input, seed? }` — a job-class operation runs in a worker (202 with the record), others inline |\n| `GET /jobs/{id}`            | the job record (poll it; there is no streaming in this stage)                                        |\n| `POST /jobs/{id}/cancel`    | cancel — the worker is terminated and the record moves to `cancelled`                                |\n| `GET /jobs/{id}/result`     | the stored `OperationResult` of a completed job                                                      |\n| `GET /artifacts/{uri}`      | `{ handle, value }` for a url-encoded `totalfinance://…` handle                                      |\n\nThe CLI attaches jobs and artifacts through its store directory (`--store`, default `~/.totalfinance/store`).\nAn in-process server needs the corresponding injected store/runner; without one the server answers\nthose routes with a teaching instead of pretending. A token is additionally required for job mutations.\n\n## Status codes\n\n| Status | When                                                                                                                                                     |\n| ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `200`  | success (`202` for an accepted job)                                                                                                                      |\n| `400`  | the input was refused — an `input.*` code                                                                                                                |\n| `401`  | a configured mutation credential is missing or invalid (`operation.capability_missing`; `WWW-Authenticate: Bearer realm=\"@insiderfinance/totalfinance\"`) |\n| `403`  | Host/Origin refused (`input.wrong_shape`), missing server capability, or job mutations disabled without a token (`operation.capability_missing`)         |\n| `404`  | unknown operation, job, handle, or route (`operation.unknown`, `operation.handle_unknown`)                                                               |\n| `409`  | the job was cancelled, or has no result yet (`operation.cancelled`)                                                                                      |\n| `413`  | the body exceeds the wire byte budget (`operation.input_too_large`; default 65,536 bytes)                                                                |\n| `415`  | a JSON POST lacks `Content-Type: application/json` (`input.wrong_shape`)                                                                                 |\n| `422`  | any other operation error (the compute's own typed refusal)                                                                                              |\n| `500`  | internal (`operation.internal`)                                                                                                                          |\n\nEvery response carries `X-Request-Id` (yours, echoed, or a generated one) and the result's\n`trace.requestId` matches it.\n\nThese HTTP boundary statuses are chosen by the transport. `statusForError` remains the mapper for\nordinary operation failures; an error code alone cannot distinguish 401 from 403, or 400 from 415.\n\n## Flags\n\n| Flag                                                           | Meaning                                                                                    |\n| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |\n| `--port <n>` · `--host <name>`                                 | where to bind (default `127.0.0.1:8787`)                                                   |\n| `--openapi`                                                    | print the OpenAPI document and exit                                                        |\n| `--profile default\\|options\\|research\\|full`                   | the registry profile; `--packs a,b` narrows it                                             |\n| `--store <dir>`                                                | the artifact and job store directory (attaches handles and jobs)                           |\n| `--token-file <path>`                                          | protected bearer-token file; overrides `TOTALFINANCE_HTTP_TOKEN`                           |\n| `--capability <name>`                                          | repeatable server capability; explicit lists replace defaults; writes also require a token |\n| `--max-input-bytes <n>` · `--seed <int>` · `--deadline-ms <n>` | the transport budgets and the default seed                                                 |\n| `--allow-non-loopback`                                         | bind a non-loopback host                                                                   |\n\n## In process\n\n\n\nPass `artifacts` (a store) and `jobs` (a `JobRunner` — `createLocalJobRunner` from\n`@insiderfinance/totalfinance/workflows/local`, or your own) to attach handles and jobs. Add `authenticationToken` to\nenable job mutations. To enable approval in process:\n\n\n\nThe memory store is illustrative; inject durable lifecycle stores for approval across restarts.\nThe SDK token is explicit: `createLocalHttpServer` does not read environment variables for you.\n","kind":"guide"},{"title":"Imports and bundles","url":"/guides/imports-and-bundles","description":"Use named imports from @insiderfinance/totalfinance/<domain as the portable browser default. The main package includes every domain and feature subpath with no runtime dependencies; only @insiderfinance/totalfinance-m…","category":"Guide","keywords":"Use named imports from `@insiderfinance/totalfinance/<domain>` as the portable browser\ndefault. The main package includes every domain and feature subpath with no runtime dependencies;\nonly `@insiderfinance/totalfinance-mcp` is a separate optional install. TotalFinance is an unpublished preview: these are supported import\nshapes for a built checkout, not evidence of a completed npm installation.\n\n## Start with a domain\n\nWith the umbrella installed:\n\n\n\nSupported feature subpaths are another explicit choice:\n\n\n\nOther examples include `@insiderfinance/totalfinance/technical-analysis/rsi` and\n`@insiderfinance/totalfinance/options/black-scholes`. Use the package's public export map, never private `dist`\npaths. Domain and feature paths are exports of the same main package; they are not separate installs.\nDomain named imports need no consumer-specific plugin.\n\n## Namespace convenience has a tradeoff\n\nDirect namespace imports with static member access can tree-shake in both esbuild and Rollup:\n\n\n\nThat is different from the root's namespace re-export:\n\n\n\nIn the tested esbuild configuration, this second form retains the whole math namespace because of\n[esbuild issue #1420](https://github.com/evanw/esbuild/issues/1420). Rollup shakes this static use.\nThe braces in `import { math }` select a namespace object, not a named calculation. Prefer named\ndomain imports when the same code must stay small across bundlers.\n\nThe root namespace API remains supported for convenience and discovery. It also hoists exactly five\noption gestures: `blackScholes`, `option`, `market`, `engines`, and `impliedVolatility`. Other option\nexports live under `options` or their supported domain/feature entrypoints, not flat on the root.\n\nRuntime-selected access such as `math[name]`, namespace enumeration such as `Object.values(math)`,\nand registries that dispatch to many calculations inherently retain the implementations they can\nreach. Tree shaking cannot remove functionality your program may select at runtime. This applies\neven to a direct namespace import; it is distinct from the esbuild re-export limitation.\n\n## Three different sizes\n\n- **Installation size:** package files and dependencies on disk. The main package includes all domains;\n  MCP adds its SDK dependency and depends on the exact main version. Tree shaking does not shrink an install.\n- **Final bundle size:** code retained by the production bundler for the imports and calls you use.\n  ESM and `sideEffects: false` enable removal of unused code, but access patterns and bundler behavior\n  still matter. Installing the umbrella does not require delivering every domain to the browser.\n- **Plain Node ESM loading:** Node loads the imported module graph; it performs no automatic dead-code\n  elimination. A named import from a broad barrel is not a promise to load only one function. Use a\n  supported feature subpath when you want a narrower unbundled module graph.\n\nType-only imports, such as `import type { BlackScholesKernelInput } from\n'@insiderfinance/totalfinance/options/black-scholes'`, are erased from emitted JavaScript and add no runtime code.\nBrowser-safe compute entrypoints remain separate from Node-only transports and filesystem helpers.\n\n## A facade is more than a formula\n\n`blackScholes` includes input validation, typed errors, and `.explain()` assumptions and diagnostics.\nAn indicator such as `rsi` also carries its streaming and serialization services. Importing one of\nthese public objects is not the cost of a bare formula, even when you call just one method.\nThe expert `blackScholesPrice` export on `@insiderfinance/totalfinance/options/black-scholes` offers a different,\ndocumented contract; choose it for that contract, not to bypass validation.\n\nSee the generated [bundle size report](/guides/bundle-size) for enforced measurements. Whole-entrypoint\nbudgets and used-function consumer budgets answer different questions: keeping an entire entrypoint\nis not the cost of one selected calculation. Compare matching import forms and bundlers, and measure\nyour own production build; neither set of bundle measurements describes installation size or plain\nNode loading.\n","kind":"guide"},{"title":"Levels: raw, facade, analysis, artifact, batch, workflow","url":"/guides/levels","description":"TotalFinance is one library at six levels, and no level is the only route. The same instrument — a three-month call struck at 105 on a 100 spot, 20% volatility, 4% rate — is priced below at every level so the reader s…","category":"Guide","keywords":"TotalFinance is one library at six levels, and no level is the only route. The same instrument — a\nthree-month call struck at 105 on a 100 spot, 20% volatility, 4% rate — is priced below at every\nlevel so the reader sees the same number move up the stack. Every block runs in CI\n(`docs/examples/guides.test.ts`); pick the level that fits the job and drop down whenever a\nhigher level hides something you need.\n\n| Level        | You get                                                    | Reach for it when                                   |\n| ------------ | ---------------------------------------------------------- | --------------------------------------------------- |\n| **raw**      | a kernel: numbers in, a number out, nothing else           | hot paths, your own composition, audits             |\n| **facade**   | a flat call plus `.explain()` with assumptions/diagnostics | notebooks, dashboards, a quick answer with its why  |\n| **analysis** | a contract + a market snapshot → a rich envelope           | pricing engines, Greeks, conventions you must name  |\n| **artifact** | a saved, restorable, replayable, content-addressed result  | anything you keep, compare, or hand to someone      |\n| **batch**    | ordinary result rows or expert typed-array columns         | many contracts at once                              |\n| **workflow** | an operation with a schema, a budget, and a teaching error | agents, CLIs, HTTP, MCP — the same call over a wire |\n\n## Raw\n\nThe kernel takes the inputs and returns the price. `normalCdf` beneath it is a plain function too.\n\n\n\n## Facade\n\nThe facade is the same number behind a flat call, and `.explain()` is the same number with the\nconventions it applied and the diagnostics it observed.\n\n\n\n## Analysis\n\nThe analysis level separates the contract from the market and returns an envelope: the value, the\nGreeks, the assumptions (exercise style, conventions, engine), and the diagnostics. Nothing is\ndefaulted silently — an exercise style is required.\n\n\n\n## Artifact\n\nAn artifact is a result you keep: content-addressed, serializable, restorable, replayable, and\ncomparable. Here a volatility smile around the same strike is calibrated and saved; the restore\nreproduces the report byte for byte and the replay reproduces the fit.\n\n\n\n## Batch\n\nFor convenient row-based pricing, `priceMany({ contracts, market, engine })` returns an ordinary\n`PriceResult[]`. Each entry is a named pricing report; no array conversion is needed. Choose that\nsurface when it matches your data. `SomeType[]` is TypeScript's notation for an ordinary array,\nnot a specialized numeric buffer.\n\nThe expert columnar kernel below accepts typed arrays and returns an object of typed-array columns.\nIt is useful when throughput and numeric memory layout matter. Five explicitly listed contracts\nmake each input visible; these buffers are not required preprocessing for every options call. The\nfirst contract is the one above, so `price[0]` is the raw price. Read or iterate the output directly;\nonly convert it when a downstream consumer specifically requires an ordinary array.\n\n\n\nWhen only some outputs matter — gamma alone for a spot sweep, price and delta for a hedge —\n`blackScholesEvaluateMany(columns, { outputs: ['gamma'] })` on the same entrypoint computes just\nthose, with the same values bit for bit, and `blackScholesEvaluateManyInto` writes them into storage\nyou reuse. [Compute only what you need](/guides/selective-greeks-and-exposure) walks through both.\n\n## Workflow\n\nAn operation is the same call with a JSON schema, an effect class, a budget, a seed policy, and a\nteaching error — the form an agent, the CLI, the HTTP server, and the MCP adapter all share. The\nregistry runs it locally; nothing leaves the process.\n\n\n\n## The rule\n\nEvery level above raw is a thin composition of the level below: the facade calls the kernel, the\nanalysis envelope wraps the facade's conventions, the artifact stores the analysis, the batch runs\nthe kernel over columns, the workflow validates and runs the facade. A guide that shows only the\nworkflow is incomplete; the direct call is always public, tested, and documented — the field\nreference (`docs/reference/fields.md`) lists every one of its fields.\n","kind":"guide"},{"title":"MCP Server","url":"/guides/mcp","description":"@insiderfinance/totalfinance-mcp exposes TotalFinance computations to AI agents through the Model Context Protocol. The server is read-only by default and wraps the same public TotalFinance APIs used by application code.","category":"Guide","keywords":"`@insiderfinance/totalfinance-mcp` exposes TotalFinance computations to AI agents through the Model Context Protocol. The server is read-only by default and wraps the same public TotalFinance APIs used by application code.\n\n## Quickstart\n\nThe optional MCP package remains an **unpublished preview**. SDK 0.1.5 publication does not publish\nthis separate server package. From a built source checkout (Node ≥22.13), run the local binary;\nthis does not require an MCP registry release:\n\n\n\n**Claude Desktop** — add to `claude_desktop_config.json`:\n\n\n\n**Claude Code**:\n\n\n\n**Cursor** — add to `.cursor/mcp.json` (project) or `~/.cursor/mcp.json` (global):\n\n\n\n## Source installation\n\nUse the source checkout rather than an npm install of the unpublished MCP package:\n\n\n\nInstalling the SDK alone does not install or start an MCP server. Optional MCP metadata moves with\nthe SDK for local builds and verified tarball tests; that is not evidence of an MCP npm release.\n\nOmitting `--profile` keeps the 23-tool default. The examples above deliberately select only the\noptions task. The server supplies no quotes or other live data: ask it to list tools, inspect\n`totalfinance://capabilities`, then provide inputs matching the chosen tool's schema.\n\n## Task profiles and permissions\n\nProfiles are shared with the local CLI/worker registry. Read `totalfinance://profiles` for names,\npack selections, and descriptions derived from operation titles.\n\n| Profile       | Selected packs                                                                                                                      |\n| ------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `default`     | `options`, `technical_analysis`, `strategy`, `volatility`, `structure`, `risk`, `performance`, `calendar`, `crypto`, `fixed_income` |\n| `options`     | `options`, `volatility`                                                                                                             |\n| `research`    | `research`                                                                                                                          |\n| `strategies`  | `options`, `strategy`, `volatility`                                                                                                 |\n| `portfolio`   | `portfolio`, `risk`, `performance`, `artifact`                                                                                      |\n| `valuation`   | `valuation`                                                                                                                         |\n| `backtesting` | `backtest`, `performance`, `artifact`                                                                                               |\n| `scenarios`   | `scenario`, `artifact`                                                                                                              |\n| `full`        | All default packs plus `portfolio`, `scenario`, `research`, `artifact`, `valuation`, `backtest`, `trade`                            |\n\n`--packs options,volatility` narrows the chosen profile exactly; an unknown or repeated pack is a\nconfiguration error. Embedders can pass `profile`, or explicit `tools`/`packs`:\nexplicit selections suppress implicit profile tools, and `packs: []` or `tools: []` is empty.\nIf both explicit arrays are provided their union is used. No profile grants capabilities.\n\nDefault capabilities are `portfolio:read`, `analytics:run`, and `trade:propose`. A supplied\n`capabilities` array (or repeated binary `--capability`) is an **exact replacement**, not an addition\nto the defaults. Tools lacking required grants are excluded from listing, schemas, prompts, and calls.\nFinancial `readOnly: true` also excludes writes and approval, including `trade:approve` even though\nauthorization has `sideEffect: 'none'`. The binary lifts this filter only when explicitly given a\nwrite/approval capability (`trade:approve`, `trade:paper`, or `portfolio:write`).\n\nAn enabled operation can still need its authorization or journal store and a valid plan-bound human\ngrant. Attaching a store or selecting `full` supplies neither that grant nor live-order permission.\nThe capability ceiling is server configuration; callers cannot enlarge it in tool arguments.\n\n## Tools\n\nA tool's name is its operation id with every dot replaced by an underscore: the operation\n`totalfinance.option.price` is the tool `totalfinance_option_price` (`toolNameFor(id)` in `@insiderfinance/totalfinance-mcp`\nis the one rule). The dotted id stays the operation's identity everywhere else — in\n`_meta['totalfinance/operation'].id`, `totalfinance://operations/<id>`, the HTTP paths and the CLI — and\njob submission takes the dotted id in its `id` argument.\n\nThe default server exposes 23 read-only tools, grouped into ten domain packs (`options`, `technical_analysis`,\n`strategy`, `volatility`, `structure`, `risk`, `performance`, `calendar`, `crypto`, `fixed_income`):\n\n**Options** — `totalfinance_option_price`, `totalfinance_option_greeks`, `totalfinance_option_implied_volatility`\n\n**Strategy** — `totalfinance_strategy_analyze` (raw signed-quantity legs, or a named builder via\n`strategy` + `input`; model-priced premiums from strikes alone; PoP; structural `classification`),\n`totalfinance_strategy_list` (the ~58-builder catalog with a canonical example input per builder)\n\n**Volatility** — `totalfinance_volatility_expected_move`, `totalfinance_volatility_probability_in_the_money`,\n`totalfinance_volatility_probability_of_touch`, `totalfinance_volatility_surface` (fit + arbitrage report),\n`totalfinance_volatility_metrics` (IV rank/percentile/stats), `totalfinance_volatility_event` (earnings-move\ndecomposition + variance risk premium)\n\n**Structure** — `totalfinance_structure_exposures` (GEX/DEX, walls, zero-gamma, max pain),\n`totalfinance_structure_flow` (sweeps/blocks/spreads with honest NBBO-estimation caveats)\n\n**TA** — `totalfinance_technical_analysis_calculate` (any of the ~300 registered indicators; the structured output is\nthe explain envelope — `assumptions.params` echoes the parameters actually used),\n`totalfinance_technical_analysis_list`,\n`totalfinance_technical_analysis_describe` (one indicator's full metadata card: category, inputs,\nparameters, defaults, warmup)\n\n**Performance & risk** — `totalfinance_performance_analyze` (the full summary as a `Computed`\nenvelope), `totalfinance_risk_value_at_risk` (stochastic: the Monte-Carlo method is governed by the\nseed policy), `totalfinance_risk_optimize` (minVariance / maxSharpe / meanVariance / riskParity /\nhrp / kelly)\n\n**Calendars** — `totalfinance_calendar_sessions` (trading days, holidays, half days, and\nholiday-shifted weekly/OPEX/quarterly option expirations)\n\n**Crypto** — `totalfinance_crypto_perpetual_funding` (funding-rate → annualized implied carry with the\nmark/index premium and extreme-funding flag), `totalfinance_crypto_futures_basis` (dated-futures\ncash-and-carry: annualized basis, contango/backwardation, arbitrage flag)\n\n**Fixed income** — `totalfinance_fixed_income_bond_analytics` (fixed-rate bond price↔yield with\nclean/dirty price, accrued interest, Macaulay/modified duration, convexity, and DV01)\n\n**Enabling a subset.** The ten domain packs above are exported (`optionsPack()`, `technicalAnalysisPack()`, …,\n`defaultPacks()`); pass a subset to expose only those domains — `createTotalFinanceMcpServer({ packs:\n[optionsPack(), technicalAnalysisPack()] })` hands an agent only the option and TA tools instead of all 23.\n\n**Opt-in packs:** `packs` is an exact selection, so expanding the defaults is explicit —\n`createTotalFinanceMcpServer({ packs: [...defaultPacks(), backtestPack()] })` adds\n`totalfinance_backtest_vectorized_run`, `totalfinance_backtest_options_run`,\n`totalfinance_backtest_cross_sectional_run`, `totalfinance_backtest_portfolio_run`, and\n`totalfinance_backtest_environment_episode` (payload/runtime\nheavy, deliberately not defaults) on top of the standard 23.\n\n**Journey packs:** five\nopt-in packs compose whole workflows from the same public functions — `portfolioPack()`\n(`totalfinance_portfolio_inspect`, `totalfinance_portfolio_snapshot`, `totalfinance_portfolio_explain_pnl`, `totalfinance_portfolio_analyze`,\n`totalfinance_portfolio_rebalance_proposal`), `scenarioPack()` (`totalfinance_scenario_run`),\n`researchPack()` (`totalfinance_research_screen`, `totalfinance_research_rank`, `totalfinance_research_score`,\n`totalfinance_research_event_study`), `artifactPack()` (`totalfinance_artifact_read`,\n`totalfinance_artifact_compare`), and `valuationPack()` (`totalfinance_valuation_company`); `journeyPacks()`\nreturns all five. Their inputs are the serialized\nversioned envelopes (a portfolio ledger, a market snapshot, a scenario set, an analysis artifact) and\neach result is the direct function's result verbatim — nothing is aggregated by the tool.\nWire-only restrictions are narrower schemas, never different meanings: a caller predicate, a custom\nexpected-return function, a callback entry/exit rule, or a custom pricer target is SDK-only.\n\n**Trade lifecycle:** the opt-in `trade` pack (from `@insiderfinance/totalfinance/workflows`, also in `full`) contains\n`totalfinance_trade_preflight`, `totalfinance_trade_authorize`, `totalfinance_trade_submit`,\n`totalfinance_trade_cancel`, `totalfinance_trade_reconcile`, `totalfinance_portfolio_create`, and `totalfinance_portfolio_record_events`.\nStart an unfunded or explicitly funded ledger with `totalfinance_portfolio_create`, then open its\nreturned handle with `totalfinance_portfolio_inspect` in the portfolio pack. Creation requires\nportfolio:write and explicit identity/currency/events; inspection uses bounded section pages. See\n[the executable first-use and recovery guide](/guides/dogfood-journeys).\nThese support preflight, explicit grants, paper execution, reconciliation, and ledger writes—not\nlive brokerage routing. Use the effective capability report to see required grants and exclusions.\n\nInput schemas are generated from the TotalFinance schema facade with `toJSONSchema()`. The same schemas validate tool calls before computation runs, and every numeric field's description states its unit convention (`decimal, e.g. 0.22`; `years, e.g. 30/365`).\n\n## Resources, prompts, and bounded discovery\n\nTools carry their complete input/output schemas and operation-derived annotations and metadata.\nThe `_meta` entries `totalfinance/operation`, `totalfinance/execution`,\n`totalfinance/supportsCancellation`, and `totalfinance/descriptionUri` describe the financial contract\nand the effective execution path. Schemas are not replaced by prose summaries.\n\n| Resource                                                                                                   | Contents                                                                                                                                                                |\n| ---------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `totalfinance://capabilities`                                                                              | Effective profile/explicit selection, packs, tool ids, exclusion reasons, held/required grants, read/write stores, budgets, seed policy, and optional job configuration |\n| `totalfinance://profiles`                                                                                  | All task profile names, descriptions, and selected packs; this is discovery, not permission to call excluded tools                                                      |\n| `totalfinance://operations/<operation-id>`                                                                 | Full description and schemas for an enabled operation                                                                                                                   |\n| `totalfinance://schema/tool/<name>/input`                                                                  | Complete strict input schema                                                                                                                                            |\n| `totalfinance://schema/tool/<name>/output`                                                                 | Structured output schema, when declared                                                                                                                                 |\n| `totalfinance://schema/bar`, `totalfinance://schema/option-contract`, `totalfinance://schema/option-quote` | Canonical payload schemas                                                                                                                                               |\n| `totalfinance://policy/seed`                                                                               | Deterministic seed policy                                                                                                                                               |\n| `totalfinance://reports/<hash>`                                                                            | Permitted report in the attached artifact store                                                                                                                         |\n| `totalfinance://jobs/<jobId>`                                                                              | Job status and progress, only with a runner attached                                                                                                                    |\n| `totalfinance://jobs/<jobId>/result`                                                                       | Completed job's unchanged OperationResult, only with a runner attached                                                                                                  |\n\nBoth `tools/list` and `resources/list` return at most `pageSize` entries (default 100, allowed 1–100).\nSend the returned `nextCursor` as the next request's `cursor`; stop when `nextCursor` is absent.\nAn empty catalog returns an empty array without a cursor. Cursors are opaque, signed, and bound to\nthis server instance, catalog, and catalog snapshot. Empty, malformed, modified, cross-server,\ncross-catalog, and stale cursors are JSON-RPC `InvalidParams` (`-32602`), not an empty page.\nRestart without a cursor after a catalog changes (for example, a new stored report).\n\nPrompts are listed and callable only when their required tools are available:\n\n| Prompt                  | Required tool(s)                                                                             |\n| ----------------------- | -------------------------------------------------------------------------------------------- |\n| `analyze-option-trade`  | Option price and Greeks; implied volatility is mentioned only when that tool is also enabled |\n| `analyze-strategy`      | Strategy analysis                                                                            |\n| `explain-portfolio-pnl` | Portfolio P&L explanation                                                                    |\n| `value-company`         | Company valuation                                                                            |\n| `run-backtest`          | Options backtest                                                                             |\n| `explore-scenarios`     | Scenario run                                                                                 |\n| `screen-research`       | Research screen                                                                              |\n\nSupply the listed non-empty required prompt arguments and no unknown keys. Prompts ask for missing\ninputs instead of inventing prices, rates, or market data, and direct the client to report returned\n`assumptions` and `diagnostics.warnings`. A reduced profile never advertises an unavailable prompt.\n\n## Local jobs without experimental MCP tasks\n\nEnable the existing local worker runner explicitly:\n\n\n\n`--store` alone does not enable jobs. Without a runner the job controls are absent.\nWith a runner attached, the existing `costClass: 'job'` tools await worker completion asynchronously\nand keep their original financial input/output schemas. Other cost classes remain inline:\nthe current registry classifies `totalfinance.backtest.vectorized_run` as inline. There is no inferred\noffloading from a tool's name and no silent inline fallback on a configured job path.\n\nFor fetch-later work, use the four opt-in tools:\n\n| Tool                      | Arguments       | Result                                                                 |\n| ------------------------- | --------------- | ---------------------------------------------------------------------- |\n| `totalfinance_job_submit` | `{ id, input }` | Job record, progress, `statusUri`, `resultUri`, and next-step guidance |\n| `totalfinance_job_status` | `{ jobId }`     | Current job record and progress                                        |\n| `totalfinance_job_result` | `{ jobId }`     | `{ result: OperationResult }` when completed                           |\n| `totalfinance_job_cancel` | `{ jobId }`     | Cancelled or already-terminal job record                               |\n\nSubmission is a discriminated union of the **effective eligible operations**, each with its original\ninput schema. It is not an arbitrary execution tool. There is no capability, store, seed-policy, or\nbudget override in this control request. The outer request also counts toward the input byte budget.\nUse the returned job id verbatim: job controls accept 1–200 characters from `[A-Za-z0-9:._-]`.\n\nStatus preserves the runner's actual `progress` when provided. Otherwise it reports lifecycle state\n(`accepted`, `queued`, `running`, `completed`, `failed`, `cancelled`) with an unknown fraction;\ncompletion has fraction 1. This is not an invented calculation percentage. Awaited heavy calls also\nsend ordinary MCP `notifications/progress` when the client requests progress. Standard MCP request\ncancellation stops an awaited worker; explicit job cancellation stops fetch-later work through the\nsame runner. Cancelling a terminal job is idempotent.\nCancellation does not undo reports already persisted. They retain the ownership/profile visibility\ndescribed below, but a retained report is not a successful result for a cancelled job. Read the job's\nterminal state before treating its work as completed.\n\nResults retain `structured`, `assumptions`, `diagnostics`, `identity`, and artifact handles.\nThe result resource returns the OperationResult directly; the result tool wraps it under `result`.\nA failed job returns the original operation error. Accepted, queued, or running result reads return\n`input.wrong_shape` with the actual state: poll status and fetch again when completed. A genuinely\ncancelled job returns `operation.cancelled`; polling early never claims cancellation.\n\nWith jobs attached, report **resources** are visible only when attributed to an enabled operation,\nan allowed job (its result handle or matching `handle.provenance.requestId === job.id`), or a report\ndescendant reached through their `OperationResult.artifacts` handles. The shared runner stamps\nspill ownership before the outer result exists; it applies to unfinished, failed and cancelled\njobs too. Disallowed job/operation roots and their report descendants stay hidden from both listing\nand direct URI reads; denial wins if a child has allowed and disallowed parents. Traversal is\ntransitive and cycle-safe. Unattributed/orphan reports are hidden, including spills whose outer\nresult is missing and no matching owner is recorded. Input datasets, arbitrary payload URI strings, and non-report handles do not\nestablish report ownership.","kind":"guide"},{"title":"Convert futures/index levels to ETF levels","url":"/guides/price-level-conversion","description":"Start with a named helper when your pair is listed below. Supply the level to translate and comparable reference prices for both instruments; the helper supplies the method and unit labels. These examples use illustra…","category":"Guide","keywords":"Start with a named helper when your pair is listed below. Supply the level to translate and\ncomparable reference prices for both instruments; the helper supplies the method and unit labels.\nThese examples use illustrative prices, not current quotes.\n\n\n\n## Named pairs, both directions\n\n| Pair       | To ETF           | From ETF         |\n| ---------- | ---------------- | ---------------- |\n| ES ↔ SPY   | `esToSpyLevel`   | `spyToEsLevel`   |\n| NQ ↔ QQQ   | `nqToQqqLevel`   | `qqqToNqLevel`   |\n| YM ↔ DIA   | `ymToDiaLevel`   | `diaToYmLevel`   |\n| RTY ↔ IWM  | `rtyToIwmLevel`  | `iwmToRtyLevel`  |\n| SPX ↔ SPY  | `spxToSpyLevel`  | `spyToSpxLevel`  |\n| NDX ↔ QQQ  | `ndxToQqqLevel`  | `qqqToNdxLevel`  |\n| RUT ↔ IWM  | `rutToIwmLevel`  | `iwmToRutLevel`  |\n| DJIA ↔ DIA | `djiaToDiaLevel` | `diaToDjiaLevel` |\n\nEvery helper takes exactly three fields with the same naming pattern:\n`<source>PriceLevel`, `reference<Source>Price`, and `reference<Target>Price`.\nFor example, `ymToDiaLevel` takes `ymPriceLevel`, `referenceYmPrice`, and\n`referenceDiaPrice`. Autocomplete and the generated reference show each exact input type.\n\nFutures and cash-index levels are different inputs: ES is not SPX, NQ is not NDX, RTY is not\nRUT, and YM is not DJIA. **DJIA here means the full Dow Jones Industrial Average, not DJX.**\nReference contract selection and provider ticker normalization belong to your application.\nContract multipliers and micro-contract size differences do not enter this price-level math.\nThese helpers do not calculate option premiums, contract exposure or position size.\n\n## How the math works\n\nThe same proportional calculation powers every named helper and the generic primitive:\n\n\n\nA source level 0.5% above its reference maps to a target level 0.5% above its reference.\nThere are no fixed ES/SPY, SPX/SPY, or other ticker ratios. Changing either reference changes\nthe mapping. Always supply comparable reference prices—for example, references from the same\nchosen valuation instant—and decide their freshness policy in your application.\n\n## Any other pair, or an explicit ratio\n\nUse `convertPriceLevel` for arbitrary instruments. `method` remains required; descriptive\nunit labels are independently optional and never change the arithmetic.\n\n\n\nRatio mode takes **target price units per one source price unit**. Reverse reference mode by\nswapping the two references and passing a level in the new source unit, or supply the reciprocal\nratio for a reverse ratio call. The generic function never infers the method or direction.\n\nFor generic `.explain()`, `resultUnit: null` means the caller did not supply a target unit label;\nthe calculation still uses the units of the supplied target reference (or directed ratio).\nOmitted/undefined optional labels are omitted from the echoed request. Provided labels must be\nnonblank strings; they document your inputs but do not authenticate instruments or convert units.\n\n## Validation and imports\n\nAll three numeric coordinates of a named helper are required. References and ratios must be\npositive finite numbers; requested levels must be nonnegative and finite. Zero maps to zero.\nBoth the plain call and `.explain()` reject malformed inputs and unknown fields. Named helpers\ndo not accept `method`, unit labels, ratios or contract multipliers; use the generic primitive\nfor other mappings. Errors identify the function and coordinate that need correction.\n\n`input.out_of_range` refuses output overflow and positive underflow that rounds to zero.\nNonzero subnormal results are supported; range-boundary arithmetic rounds the supplied binary\ninputs correctly. No cents or tick rounding occurs.\n\nThe domain import `@insiderfinance/totalfinance/valuation` exposes the same functions; the root\npackage exposes them under `valuation`. Prefer the focused `valuation/price-levels` import for\na single helper. Unused siblings can be removed by tree shaking.\n\nFor form validation/JSON Schema, import `EsToSpyLevelInputSchema`, `SpyToEsLevelInputSchema`,\netc. from `@insiderfinance/totalfinance/valuation/schemas`. Each helper has a matching named\ninput type, such as `EsToSpyLevelInput`, exported alongside the function. The generic schema is\n`ConvertPriceLevelInputSchema`. Schemas validate requests; calculators also enforce representable\nresults. Compute imports do not include schema machinery.\n\n## What this does not promise\n\nThe supplied proportional relationship is assumed to remain valid at the requested level.\nThis is not a live quote, predicted ETF open, arbitrage/fair value, option premium or\nnotional/delta hedge. Futures basis, dividends, ETF tracking differences and market sessions can\nchange the relationship. Your application owns comparability, timestamps, contract selection,\ncurrency/unit consistency and freshness. No fixed ratios, data acquisition or provider calls\nare hidden in the library.\n\nThe pair identities follow [CME's equity-index products](https://www.cmegroup.com/markets/products)\nand issuer benchmark descriptions for [SPY](https://www.ssga.com/us/en/individual/etfs/state-street-spdr-sp-500-etf-trust-spy),\n[QQQ](https://www.invesco.com/qqq-etf/en/home.html),\n[DIA](https://www.ssga.com/us/en/individual/capabilities/spdr-core-equity-etfs/dia-djia) and\n[IWM](https://www.ishares.com/us/products/239710/ishares-russell-2000-etf).\nThese identities are not promises of an exact price ratio or identical returns.\n","kind":"guide"},{"title":"Calculate sector performance","url":"/guides/sector-performance","description":"Use sectorPerformance when you already have comparable returns for each security. Use sectorPerformanceSnapshot when you need to select historical closes and classifications under explicit information cutoffs. Both ar…","category":"Guide","keywords":"Use `sectorPerformance` when you already have comparable returns for each security. Use\n`sectorPerformanceSnapshot` when you need to select historical closes and classifications under\nexplicit information cutoffs. Both are pure calculations: no API keys, network, cache or clock.\n\n## Start with same-period returns\n\n\n\nReturns are decimals: `0.01` means +1%. All rows must cover the **same period and comparable return\nbasis**, which the caller owns. The calculator cannot infer whether your inputs are daily, monthly,\nprice-only, total-return or currency-converted. Security IDs are stable identities, not ticker\naliases. Duplicate security IDs and inconsistent names for one sector ID are errors.\n\nThe report orders sectors by descending return, with stable identity tie-breaking and competition\nranks (`1, 1, 3`). It rounds the sector mean once to eight decimal-return places. Members retain\ntheir original unrounded returns. Empty input produces an explicitly empty report with a warning,\nnot a successful zero return. No classification, price or provider lineage is fabricated.\n\n## Audit a completed-session snapshot\n\nThe following hypothetical data demonstrates the required provenance. Supply real observations,\nsession-completion records and effective-dated classifications in production. A completed-session\ntable is input data, not a built-in exchange calendar.\n\n\n\nThe snapshot path uses equal-security **split-adjusted price returns**, not dividend-reinvested\ntotal returns, market-cap weighting, FX conversion or intraday estimates. It selects observations\navailable by both source and knowledge cutoffs. Effective classification intervals include their\nstart date and exclude their end date. The previous session is the latest supplied completed\nsession before the target, not “the prior calendar day.”\n\nRead `diagnostics.status`, `diagnostics.warnings`, `diagnostics.blockers` and `exclusions` before\nusing the headline values. Missing, late, stale, unclassified, currency-mismatched and\nadjustment-version-mismatched inputs are disclosed rather than silently filled. Selected member\nlineage retains the exact classification and both closes. A partial sector result is calculated\nfrom the included members, not from an implied fully covered universe.\n\n## Contract and integration boundaries\n\nBoth functions accept named request objects and return assumptions plus `diagnostics.warnings`.\nTheir reports can be saved directly with `createAnalysisArtifact` from `@insiderfinance/totalfinance/core/artifacts`.\nThe neutral `sector-performance-v1` calculation policy is stamped in results; callers do not pass\na magic vendor policy string. This is a calculation-policy revision, not a second package version.\n\nRequest/control objects reject unknown keys. Observation rows accept extra metadata but only\nconsumed fields are copied into results. Arrays must be dense. The simple path accepts at most\n1,000,000 member rows; the snapshot path caps the combined rows across its four input arrays at\n1,000,000 before walking them. Malformed requests throw typed TotalFinance errors with field paths.\n\nThe caller remains responsible for universe eligibility, security/listing identity, classification\nand calendar accuracy, provider acquisition and licensing, caching, endpoint field projection and\nproduction rollout. These exports do not replace an application endpoint or claim equality with a\nvendor's undocumented universe and methodology. They are SDK exports, not additional MCP tools.\n","kind":"guide"},{"title":"Compute only what you need: selective Greeks and exposure","url":"/guides/selective-greeks-and-exposure","description":"A dashboard that charts gamma exposure needs gamma. It does not need option prices, theta or rho, and it does not need them 7,800 times on every refresh. TotalFinance lets every Black–Scholes and exposure call say wha…","category":"Guide","keywords":"A dashboard that charts gamma exposure needs gamma. It does not need option prices, theta or rho,\nand it does not need them 7,800 times on every refresh. TotalFinance lets every Black–Scholes and\nexposure call say what it wants, and then computes exactly that — the requested outputs and the\nintermediate terms they depend on, nothing else. A selected value is bit-for-bit the value the full\ncalculation returns; only the unrequested work disappears. Every block below runs in CI\n(`docs/examples/guides.test.ts`).\n\n| Need                               | Call                                                               |\n| ---------------------------------- | ------------------------------------------------------------------ |\n| One Black–Scholes result           | `blackScholes.delta(input)`, `.gamma`, `.theta`, `.vega`, `.rho`   |\n| Several Black–Scholes results      | `blackScholes.evaluate({ ...input, outputs: ['price', 'gamma'] })` |\n| A chain of rows                    | `blackScholesEvaluateMany(columns, { outputs })`                   |\n| Reusable output buffers (advanced) | `blackScholesEvaluateManyInto(columns, { gamma: buffer })`         |\n| One exposure                       | `gammaExposure(...)`, `deltaExposure(...)`, … one per metric       |\n| Several exposures                  | `exposure({ quotes, market, config, metrics: ['gex', 'dex'] })`    |\n| Supplied (vendor) Greeks           | `exposureFromGreeks({ quotes, market, config, metrics: ['gex'] })` |\n\n## One Greek\n\nEach named method takes the ordinary Black–Scholes input and returns one number in the library's\ndisplay units: delta per $1 of spot, gamma per $1², theta per calendar day, vega and rho per 1%.\n`.explain` returns the same number with its assumptions and diagnostics. `blackScholes.gamma`\nevaluates `d1`, the dividend discount and one normal density — no cumulative normal at all.\n\n\n\n## Several outputs\n\n`blackScholes.evaluate` takes the same input plus an explicit `outputs` list, and returns exactly\nthose keys, in that order. The selection can be any of `price`, `delta`, `gamma`, `theta`, `vega`,\n`rho` and the higher-order `vanna`, `charm`, `vomma`, `speed`, `color` (in the raw units of\n`blackScholes.extendedGreeks`). Shared terms are computed once.\n\n\n\nA literal list types the result exactly: `selected.vega` is a compile error because vega was not\nrequested. A list held in a variable (`BlackScholesOutput[]`) types every output as optional, since\nthe compiler cannot know which ones it holds. The same goes for a choice between lists: with\n`c ? ['gamma'] : ['delta']`, both are optional, and only a name every branch requests stays\nrequired. An empty, repeated or misspelled entry is refused with\na typed error (`input.out_of_range`, `input.duplicate_entry`, `input.invalid_enum` with a\ndid-you-mean).\n\n## A chain of rows\n\n`blackScholesEvaluateMany` runs the same selection over struct-of-arrays columns and returns one\n`Float64Array` per selected output. Every column and every row's values are validated once, before\nanything is computed; the rows then run without per-row validation or per-row objects.\n\n\n\n## Reusing buffers (advanced)\n\nA hot loop that re-evaluates the same chain — a spot sweep, a per-tick refresh — can write into\nstorage it owns. The property names of the buffer object _are_ the selection. Reusable storage is\nnot unchecked input: the call validates the columns, every row and every buffer (a `Float64Array`\nwith at least one element per row) before the first write, so a refused call never half-updates a\nbuffer. It writes rows `[0, rows)` and leaves anything past them untouched. A buffer may not share\nmemory with an input column or with another output buffer.\n\n\n\n## Exposure: start with GEX and DEX\n\nModel exposure takes an option chain, a market snapshot and a sign convention. The common case —\ngamma exposure — has its own function, and it computes gamma alone. Delta exposure has its own too.\nNeed both? Select them together and they share one pass.\n\n\n\nA selective profile still answers every analysis: `levels()`, `netDrift()` and `scenarioMap()`\ncompute the inputs they need when you call them, and return what the full profile returns.\n`byStrike()` and `byExpiry()` default to the selected metrics and refuse one that was not computed.\n`atSpot` re-evaluates the selected `gex` and/or `dex`; a profile that selected neither refuses it.\n\n## Higher-order exposures\n\nThe rest of the exposure family follows the same pattern, one descriptive function per metric:\n`vegaExposure` and `thetaExposure` (dollar value per 1% of volatility and per calendar day), then\nthe higher-order `vannaExposure` (dollar delta per +1% volatility), `charmExposure` (dollar delta as\na day elapses), `vommaExposure` (vega exposure per +1% volatility), `speedExposure` (the change in\nGEX for a +1% spot move, in the GEX unit) and `colorExposure` (the change in GEX as a day elapses,\nalso in the GEX unit). Each is the corresponding one-metric `exposure(...)` selection; combinations\nbelong in `metrics`.\n\n\n\n## Supplied Greeks\n\n`exposureFromGreeks` accounts for Greeks a vendor already supplied, without recomputing anything.\nA GEX-only report needs only the supplied gamma, the GEX sign convention and the GEX unit — a feed\nwithout delta is fine. A DEX-only report needs only delta and the DEX convention. Omitting\n`metrics` keeps today's report, which requires both Greeks on every row that supplies Greeks so the\ntwo metrics always cover the same rows.\n\n\n\nThe report also totals every metric per strike (`byStrike`) and per expiry (`byExpiry`). A caller\nthat builds its own strike and expiry views from `contributions` can pass `breakdowns: false` to\nleave both out. That skips the grouping and two thirds of the exact summation; every other field is\nunchanged, and `assumptions.breakdowns` records the choice. The report's type follows the flag, so\nreading `byStrike` from a `breakdowns: false` report is a compile error.\n\n## What does not change\n\nSelection removes work, never meaning. Pricing model, units, sign conventions, time conventions,\nexclusions, assumptions and diagnostics are those of the full calculation, and every selected\nnumber equals the full calculation's number exactly. Omitting `metrics` returns exactly what it\nalways has.\n","kind":"guide"},{"title":"Strategy catalogue (@insiderfinance/totalfinance/strategy)","url":"/guides/strategies","description":"The strategy package builds an option position from legs and computes the full profit-calculator surface: expiration payoff, breakevens, max profit/loss, mark-to-market value + Greeks, probability of profit / expected…","category":"Guide","keywords":"The strategy package builds an option **position** from legs and computes the full profit-calculator\nsurface: expiration payoff, breakevens, max profit/loss, mark-to-market value + Greeks, probability of\nprofit / expected value (closed-form and Monte-Carlo, optionally smile-aware), and a scanner that ranks\nstructures. Start with instrument-first legs for custom positions, or use a named whole-position\npreset when you already know the structure you want.\n\n## Custom positions: instrument plus signed quantity\n\n`legs.call`, `legs.put` and `legs.stock` return plain leg records. Quantity is required: positive\nmeans long, negative means short. Options use contracts; stocks use shares. No size or direction\nis silently assumed, and no strategy name is required for calculation.\n\n\n\nThe same request shape works for puts: `legs.put({ strike: 90, premium: 3, quantity: -2 })`.\nStock uses its entry price: `legs.stock({ price: 100, quantity: -50 })`. Premiums and stock prices\nare per share; the Position's option multiplier defaults to 100 and never scales stock shares.\nOptional `expiry` and `impliedVolatility` on call/put legs preserve per-leg inputs for calendars,\ndiagonals and observed volatility skew. Omit `premium` with explicit model-pricing configuration\nwhen you have strikes but no entry fills.\n\nRaw records are equally supported. In an editor, keep these in your own state and rebuild after\nedits; a constructed Position is an immutable snapshot. Zero quantity is rejected, so remove an\ninactive row before calculating. Signed position quantity is not a trade instruction: a buy to\nclose reduces an existing short, rather than necessarily creating a long.\n\n\n\nThese constructors replace the pre-release direction-specific leg helpers. A named **Position**\npreset such as `strategy.longCall(...)` remains distinct: it returns a ready-to-calculate Position,\nnot a leg, and its positive quantity scales the named structure. Use the three leg constructors\nfor custom compositions; presets are optional starting points, not an alternative leg model.\n\n## Named position presets\n\nEvery builder is **pure and data-agnostic**: it takes explicit strikes and premiums (not a live chain)\nand returns a `Position`. Leg compositions mirror the InsiderFinance option profit calculator 1:1. The\nexample below is bundled against the package source and executed in CI (`docs/examples/guides.test.ts`),\nso it can never rot; a fuller runnable walkthrough lives in [`docs/examples/strategies.test.ts`](../examples/strategies.test.ts).\n\n\n\nConventions: **long = positive quantity, short = negative**; option `quantity` is contracts (× the 100\nmultiplier); stock legs are in shares (100 shares per contract of cover). Every builder accepts an\noptional positive `quantity` (number of structures, default 1) that scales all legs, and an optional\n`PositionConfig`. Unlike a signed custom leg, a negative preset size is rejected so it cannot invert\nthe named strategy.\n\n## Directional & vertical\n\n| Builder                                           | Legs                                                              |\n| ------------------------------------------------- | ----------------------------------------------------------------- |\n| `longCall` / `shortCall` / `longPut` / `shortPut` | single option leg                                                 |\n| `cashSecuredPut`                                  | short put (same payoff; \"secured\" is a margin distinction)        |\n| `bullCallSpread` / `bearCallSpread`               | call debit / credit vertical                                      |\n| `bullPutSpread` / `bearPutSpread`                 | put credit / debit vertical                                       |\n| `longCombo` / `shortCombo`                        | long call + short put / short call + long put (different strikes) |\n\n## Ladders (3 strikes, one type)\n\n| Builder          | Legs                                              |\n| ---------------- | ------------------------------------------------- |\n| `bullCallLadder` | long lower call, short middle + short upper calls |\n| `bearCallLadder` | short lower call, long middle + long upper calls  |\n| `bullPutLadder`  | short upper put, long middle + long lower puts    |\n| `bearPutLadder`  | long upper put, short middle + short lower puts   |\n\n## Ratio spreads & backspreads\n\n| Builder                                      | Legs (default ratio 1×2, configurable)            |\n| -------------------------------------------- | ------------------------------------------------- |\n| `callRatioSpread` / `putRatioSpread`         | long 1 near option, short `ratio` further options |\n| `callRatioBackspread` / `putRatioBackspread` | short 1 near option, long `ratio` further options |\n\n## Butterflies & condors (one type)\n\n| Builder                                          | Legs                                                   |\n| ------------------------------------------------ | ------------------------------------------------------ |\n| `longCallButterfly` / `longPutButterfly`         | long / short×2 / long                                  |\n| `shortCallButterfly` / `shortPutButterfly`       | short / long×2 / short                                 |\n| `callBrokenWing` / `putBrokenWing`               | broken-wing (skip-strike) butterfly, long/short×2/long |\n| `inverseCallBrokenWing` / `inversePutBrokenWing` | short/long×2/short                                     |\n| `longCallCondor` / `longPutCondor`               | long / short / short / long (4 strikes)                |\n| `shortCallCondor` / `shortPutCondor`             | short / long / long / short                            |\n\n## Iron & volatility\n\n| Builder                      | Legs                                                      |\n| ---------------------------- | --------------------------------------------------------- |\n| `ironCondor`                 | long put / short put / short call / long call             |\n| `inverseIronCondor`          | short outer / long inner                                  |\n| `ironButterfly`              | long put wing / short body put + call / long call wing    |\n| `inverseIronButterfly`       | short wings / long ATM straddle                           |\n| `straddle` / `shortStraddle` | long / short call + put at one strike                     |\n| `strangle` / `shortStrangle` | long / short call + put at separate strikes               |\n| `guts` / `shortGuts`         | long / short ITM call (lower) + ITM put (upper)           |\n| `strip` / `strap`            | long 1 call + 2 puts / long 2 calls + 1 put (same strike) |\n| `jadeLizard`                 | short put + short call + long higher call                 |\n| `reverseJadeLizard`          | short call + short put + long lower put                   |\n\n## Synthetics & stock combinations\n\n| Builder                                         | Legs                                                        |\n| ----------------------------------------------- | ----------------------------------------------------------- |\n| `longSyntheticFuture` / `shortSyntheticFuture`  | long call + short put / short call + long put (same strike) |\n| `syntheticPut`                                  | short stock + long call                                     |\n| `coveredCall`                                   | long 100·q shares + short q calls                           |\n| `protectivePut`                                 | long 100·q shares + long q puts                             |\n| `collar`                                        | long stock + long protective put + short covered call       |\n| `coveredShortStraddle` / `coveredShortStrangle` | long stock + short call + short put                         |\n\n## Multi-expiry (calendars & diagonals)\n\nThese carry a **per-leg `expiry`** (short = near, long = far). Value them with `Position.value()` **at the\nnear expiry**, where the short leg expires to intrinsic while the long leg still holds time value — the\nclassic calendar \"tent\". The static expiration `metrics()` assumes a single terminal and is not\nmeaningful for these; use `value()` / `scenarioTable()` at the near-expiry date instead.\n\n| Builder                                    | Legs                                     |\n| ------------------------------------------ | ---------------------------------------- |\n| `calendarCallSpread` / `calendarPutSpread` | short near + long far, same strike       |\n| `diagonalCallSpread` / `diagonalPutSpread` | short near + long far, different strikes |\n| `doubleDiagonal`                           | short near strangle + long far strangle  |\n\n## Scanner\n\n`scanStrategies(opts)` enumerates the defined-risk single-expiry structures over a strike grid, scores\neach with the payoff/probability metrics plus a bid/ask liquidity score, filters (`minProbabilityOfProfit`, `maxRisk`,\n`maxWidth`), and ranks by `pop | ev | return | expectedValuePerRisk`. Missing premiums are priced from a `volatility` or\nper-strike `smile` via Black–Scholes. See the example test for a runnable call.\n","kind":"guide"},{"title":"TotalFinance indicator compatibility matrix","url":"/guides/ta-compatibility","description":"Cross-reference of TotalFinance canonical names against TA-Lib, pandas-ta and TradingView. Any name below resolves via resolveIndicator (case-insensitive). 225 of 335 registered indicators are mapped.","category":"Guide","keywords":"Cross-reference of TotalFinance canonical names against TA-Lib, pandas-ta and TradingView. Any name below resolves via `resolveIndicator` (case-insensitive). 225 of 335 registered indicators are mapped.\n\n## transform (8)\n\n| TotalFinance    | TA-Lib     | pandas-ta           | TradingView    |\n| --------------- | ---------- | ------------------- | -------------- |\n| `averagePrice`  | `AVGPRICE` | `avgprice`, `ohlc4` | Average Price  |\n| `heikinAshi`    | —          | `ha`                | Heikin Ashi    |\n| `logReturns`    | —          | `log_return`        | —              |\n| `medianPrice`   | `MEDPRICE` | `hl2`, `medprice`   | Median Price   |\n| `returns`       | —          | `percent_return`    | —              |\n| `trueRange`     | `TRANGE`   | `true_range`        | —              |\n| `typicalPrice`  | `TYPPRICE` | `hlc3`, `typprice`  | Typical Price  |\n| `weightedClose` | `WCLPRICE` | `wcp`               | Weighted Close |\n\n## moving-average (29)\n\n| TotalFinance              | TA-Lib     | pandas-ta  | TradingView         |\n| ------------------------- | ---------- | ---------- | ------------------- |\n| `alma`                    | —          | `alma`     | ALMA                |\n| `dema`                    | `DEMA`     | `dema`     | —                   |\n| `ema`                     | `EMA`      | `ema`      | EMA                 |\n| `fwma`                    | —          | `fwma`     | —                   |\n| `gannHighLowActivator`    | —          | `hilo`     | Gann HiLo Activator |\n| `hma`                     | —          | `hma`      | HMA                 |\n| `holtWinterMovingAverage` | —          | `hwma`     | —                   |\n| `jma`                     | —          | `jma`      | —                   |\n| `kama`                    | `KAMA`     | `kama`     | —                   |\n| `mama`                    | `MAMA`     | `mama`     | —                   |\n| `mcginley`                | —          | `mcgd`     | McGinley Dynamic    |\n| `midpoint`                | `MIDPOINT` | `midpoint` | —                   |\n| `midprice`                | `MIDPRICE` | `midprice` | —                   |\n| `movingAverage`           | `MA`       | `ma`       | —                   |\n| `movingAverageRibbon`     | —          | `mmar`     | —                   |\n| `pascalWma`               | —          | `pwma`     | —                   |\n| `rainbowMovingAverage`    | —          | `rainbow`  | —                   |\n| `rma`                     | —          | `rma`      | RMA                 |\n| `sineWma`                 | —          | `sinwma`   | —                   |\n| `sma`                     | `SMA`      | `sma`      | SMA                 |\n| `superSmoother`           | —          | `ssf`      | —                   |\n| `symmetricWma`            | —          | `swma`     | —                   |\n| `t3`                      | `T3`       | `t3`       | —                   |\n| `tema`                    | `TEMA`     | `tema`     | —                   |\n| `trima`                   | `TRIMA`    | `trima`    | —                   |\n| `vidya`                   | —          | `vidya`    | VIDYA               |\n| `vwma`                    | —          | `vwma`     | VWMA                |\n| `wma`                     | `WMA`      | `wma`      | WMA                 |\n| `zlema`                   | —          | `zlma`     | ZLEMA               |\n\n## momentum (53)\n\n| TotalFinance           | TA-Lib     | pandas-ta     | TradingView        |\n| ---------------------- | ---------- | ------------- | ------------------ |\n| `apo`                  | `APO`      | `apo`         | —                  |\n| `awesomeOscillator`    | —          | `ao`          | Awesome Oscillator |\n| `bias`                 | —          | `bias`        | —                  |\n| `bop`                  | `BOP`      | `bop`         | —                  |\n| `brar`                 | —          | `brar`        | —                  |\n| `cci`                  | `CCI`      | `cci`         | CCI                |\n| `centerOfGravity`      | —          | `cg`          | —                  |\n| `cfo`                  | —          | `cfo`         | —                  |\n| `cmo`                  | `CMO`      | `cmo`         | —                  |\n| `coppock`              | —          | `coppock`     | Coppock Curve      |\n| `cti`                  | —          | `cti`         | —                  |\n| `dpo`                  | —          | `dpo`         | —                  |\n| `efficiencyRatio`      | —          | `er`          | —                  |\n| `elderRay`             | —          | `eri`         | Elder Ray          |\n| `fisherTransform`      | —          | `fisher`      | Fisher Transform   |\n| `forecastOscillator`   | —          | `fosc`        | —                  |\n| `inertia`              | —          | `inertia`     | —                  |\n| `kdj`                  | —          | `kdj`         | KDJ                |\n| `kst`                  | —          | `kst`         | KST                |\n| `laguerreRsi`          | —          | `lrsi`        | —                  |\n| `macd`                 | `MACD`     | `macd`        | MACD               |\n| `macdExt`              | `MACDEXT`  | `macdext`     | —                  |\n| `macdFix`              | `MACDFIX`  | `macdfix`     | —                  |\n| `momentum`             | `MOM`      | `mom`         | —                  |\n| `pgo`                  | —          | `pgo`         | —                  |\n| `ppo`                  | `PPO`      | `ppo`         | —                  |\n| `projectionOscillator` | —          | `po`          | —                  |\n| `psychologicalLine`    | —          | `psl`         | —                  |\n| `pvo`                  | —          | `pvo`         | —                  |\n| `qqe`                  | —          | `qqe`         | QQE                |\n| `relativeVigorIndex`   | —          | `rvgi`        | RVGI               |\n| `roc`                  | `ROC`      | `roc`         | —                  |\n| `rocp`                 | `ROCP`     | `rocp`        | —                  |\n| `rocr`                 | `ROCR`     | `rocr`        | —                  |\n| `rocr100`              | `ROCR100`  | `rocr100`     | —                  |\n| `rsi`                  | `RSI`      | `rsi`         | RSI                |\n| `rsx`                  | —          | `rsx`         | —                  |\n| `schaffTrendCycle`     | —          | `stc`         | Schaff Trend Cycle |\n| `slope`                | —          | `slope`       | —                  |\n| `smcSweep`             | —          | `smc_sweep`   | —                  |\n| `smiErgodic`           | —          | `smi`         | SMI Ergodic        |\n| `squeeze`              | —          | `squeeze`     | TTM Squeeze        |\n| `squeezePro`           | —          | `squeeze_pro` | —                  |\n| `stochastic`           | `STOCH`    | `stoch`       | Stochastic         |\n| `stochFast`            | `STOCHF`   | `stochf`      | —                  |\n| `stochRsi`             | `STOCHRSI` | `stochrsi`    | Stochastic RSI     |\n| `tdSequential`         | —          | `td_seq`      | TD Sequential      |\n| `trix`                 | `TRIX`     | `trix`        | —                  |\n| `trixHistogram`        | —          | `trixh`       | —                  |\n| `tsi`                  | —          | `tsi`         | TSI                |\n| `ultimateOscillator`   | `ULTOSC`   | `uo`          | —                  |\n| `volumeWeightedMacd`   | —          | `vwmacd`      | —                  |\n| `williamsR`            | `WILLR`    | `willr`       | Williams %R        |\n\n## trend (37)\n\n| TotalFinance               | TA-Lib                | pandas-ta               | TradingView         |\n| -------------------------- | --------------------- | ----------------------- | ------------------- |\n| `adx`                      | `ADX`                 | `adx`                   | ADX                 |\n| `adxr`                     | `ADXR`                | `adxr`                  | —                   |\n| `amat`                     | —                     | `amat`                  | —                   |\n| `aroon`                    | `AROON`               | `aroon`                 | Aroon               |\n| `aroonOscillator`          | `AROONOSC`            | `aroonosc`              | —                   |\n| `centralPivotRange`        | —                     | `cpr`, `cpr_option`     | Central Pivot Range |\n| `chandeKrollStop`          | —                     | `cksp`                  | Chande Kroll Stop   |\n| `chandelierExit`           | —                     | `ce`                    | Chandelier Exit     |\n| `choppinessIndex`          | —                     | `chop`                  | Choppiness Index    |\n| `crossSignals`             | —                     | `xsignals`              | —                   |\n| `decreasing`               | —                     | `decreasing`            | —                   |\n| `dmi`                      | —                     | `dm`                    | —                   |\n| `dx`                       | `DX`                  | `dx`                    | —                   |\n| `exponentialDecay`         | —                     | `edecay`                | —                   |\n| `ichimoku`                 | —                     | `ichimoku`              | Ichimoku Cloud      |\n| `increasing`               | —                     | `increasing`            | —                   |\n| `linearDecay`              | —                     | `decay`, `linear_decay` | —                   |\n| `linreg`                   | `LINEARREG`           | `linreg`                | —                   |\n| `linregAngle`              | `LINEARREG_ANGLE`     | `linregangle`           | —                   |\n| `linregIntercept`          | `LINEARREG_INTERCEPT` | `linregintercept`       | —                   |\n| `linregSlope`              | `LINEARREG_SLOPE`     | `linregslope`           | —                   |\n| `longRun`                  | —                     | `long_run`              | —                   |\n| `minusDI`                  | `MINUS_DI`            | —                       | —                   |\n| `minusDM`                  | `MINUS_DM`            | `minus_dm`              | —                   |\n| `plusDI`                   | `PLUS_DI`             | —                       | —                   |\n| `plusDM`                   | `PLUS_DM`             | `plus_dm`               | —                   |\n| `pMax`                     | —                     | `pmax`                  | PMax                |\n| `psar`                     | `SAR`                 | `psar`                  | Parabolic SAR       |\n| `psarExt`                  | `SAREXT`              | `sarext`                | —                   |\n| `qstick`                   | —                     | `qstick`                | —                   |\n| `shortRun`                 | —                     | `short_run`             | —                   |\n| `supertrend`               | —                     | `supertrend`            | Supertrend          |\n| `trendSignals`             | —                     | `tsignals`              | —                   |\n| `tsf`                      | `TSF`                 | `tsf`                   | —                   |\n| `ttmTrend`                 | —                     | `ttm_trend`             | TTM Trend           |\n| `verticalHorizontalFilter` | —                     | `vhf`                   | —                   |\n| `vortex`                   | —                     | `vortex`                | Vortex              |\n\n## volatility (17)\n\n| TotalFinance              | TA-Lib   | pandas-ta         | TradingView               |\n| ------------------------- | -------- | ----------------- | ------------------------- |\n| `aberration`              | —        | `aberration`      | —                         |\n| `accelerationBands`       | —        | `accbands`        | Acceleration Bands        |\n| `atr`                     | `ATR`    | `atr`             | ATR                       |\n| `bbands`                  | `BBANDS` | `bbands`          | Bollinger Bands           |\n| `chaikinVolatility`       | —        | `cvi`             | —                         |\n| `donchian`                | —        | `donchian`        | Donchian Channels         |\n| `elderThermometer`        | —        | `thermo`          | —                         |\n| `historicalVolatility`    | —        | `hvol`, `avolume` | —                         |\n| `holtWinterChannel`       | —        | `hwc`             | —                         |\n| `keltner`                 | —        | `kc`              | Keltner Channels          |\n| `massIndex`               | —        | `massi`           | Mass Index                |\n| `natr`                    | `NATR`   | `natr`            | —                         |\n| `priceDistance`           | —        | `pdist`           | —                         |\n| `relativeVolatilityIndex` | —        | `rvi`             | Relative Volatility Index |\n| `standardDeviation`       | `STDDEV` | `stdev`           | —                         |\n| `ulcerIndex`              | —        | `ui`              | Ulcer Index               |\n| `variance`                | `VAR`    | `variance`        | —                         |\n\n## volume (18)\n\n| TotalFinance              | TA-Lib  | pandas-ta  | TradingView               |\n| ------------------------- | ------- | ---------- | ------------------------- |\n| `adLine`                  | `AD`    | `ad`       | Accumulation/Distribution |\n| `archerObv`               | —       | `aobv`     | —                         |\n| `chaikinMoneyFlow`        | —       | `cmf`      | CMF                       |\n| `chaikinOscillator`       | `ADOSC` | `adosc`    | —                         |\n| `easeOfMovement`          | —       | `eom`      | Ease of Movement          |\n| `forceIndex`              | —       | `efi`      | Force Index               |\n| `klinger`                 | —       | `kvo`      | Klinger Oscillator        |\n| `marketFacilitationIndex` | —       | `marketfi` | Market Facilitation Index |\n| `mfi`                     | `MFI`   | `mfi`      | Money Flow Index          |\n| `nvi`                     | —       | `nvi`      | —                         |\n| `obv`                     | `OBV`   | `obv`      | OBV                       |\n| `priceVolume`             | —       | `pvol`     | —                         |\n| `priceVolumeRank`         | —       | `pvr`      | —                         |\n| `pvi`                     | —       | `pvi`      | —                         |\n| `pvt`                     | —       | `pvt`      | Price Volume Trend        |\n| `volumeOscillator`        | —       | `vosc`     | Volume Oscillator         |\n| `vwap`                    | —       | `vwap`     | VWAP                      |\n| `williamsAd`              | —       | `wad`      | Williams A/D              |\n\n## cycle (9)\n\n| TotalFinance  | TA-Lib         | pandas-ta      | TradingView |\n| ------------- | -------------- | -------------- | ----------- |\n| `dsp`         | —              | `dsp`          | —           |\n| `ebsw`        | —              | `ebsw`         | —           |\n| `htDcPeriod`  | `HT_DCPERIOD`  | `ht_dcperiod`  | —           |\n| `htDcPhase`   | `HT_DCPHASE`   | `ht_dcphase`   | —           |\n| `htPhasor`    | `HT_PHASOR`    | `ht_phasor`    | —           |\n| `htSine`      | `HT_SINE`      | `ht_sine`      | —           |\n| `htTrendline` | `HT_TRENDLINE` | `ht_trendline` | —           |\n| `htTrendMode` | `HT_TRENDMODE` | `ht_trendmode` | —           |\n| `msw`         | —              | `msw`          | —           |\n\n## math (21)\n\n| TotalFinance | TA-Lib  | pandas-ta   | TradingView |\n| ------------ | ------- | ----------- | ----------- |\n| `acos`       | `ACOS`  | `acos`      | —           |\n| `add`        | `ADD`   | `add`       | —           |\n| `asin`       | `ASIN`  | `asin`      | —           |\n| `atan`       | `ATAN`  | `atan`      | —           |\n| `ceil`       | `CEIL`  | `ceil`      | —           |\n| `cos`        | `COS`   | `cos`       | —           |\n| `cosh`       | `COSH`  | `cosh`      | —           |\n| `crossany`   | —       | `crossany`  | —           |\n| `crossover`  | —       | `crossover` | —           |\n| `div`        | `DIV`   | `div`       | —           |\n| `exp`        | `EXP`   | `exp`       | —           |\n| `floor`      | `FLOOR` | `floor`     | —           |\n| `ln`         | `LN`    | `ln`        | —           |\n| `log10`      | `LOG10` | `log10`     | —           |\n| `mult`       | `MULT`  | `mult`      | —           |\n| `sin`        | `SIN`   | `sin`       | —           |\n| `sinh`       | `SINH`  | `sinh`      | —           |\n| `sqrt`       | `SQRT`  | `sqrt`      | —           |\n| `sub`        | `SUB`   | `sub`       | —           |\n| `tan`        | `TAN`   | `tan`       | —           |\n| `tanh`       | `TANH`  | `tanh`      | —           |\n\n## performance (1)\n\n| TotalFinance | TA-Lib | pandas-ta  | TradingView |\n| ------------ | ------ | ---------- | ----------- |\n| `drawdown`   | —      | `drawdown` | —           |\n\n## statistic (22)\n\n| TotalFinance         | TA-Lib        | pandas-ta      | TradingView |\n| -------------------- | ------------- | -------------- | ----------- |\n| `barSince`           | —             | —              | BarsSince   |\n| `beta`               | `BETA`        | `beta`         | —           |\n| `correl`             | `CORREL`      | `correl`       | —           |\n| `entropy`            | —             | `entropy`      | —           |\n| `highestBars`        | —             | —              | HighestBars |\n| `kurtosis`           | —             | `kurtosis`     | —           |\n| `lowestBars`         | —             | —              | LowestBars  |\n| `mad`                | —             | `mad`, `md`    | —           |\n| `rollingMax`         | `MAX`         | `rolling_max`  | —           |\n| `rollingMaxIndex`    | `MAXINDEX`    | —              | —           |\n| `rollingMedian`      | —             | `median`       | —           |\n| `rollingMin`         | `MIN`         | `rolling_min`  | —           |\n| `rollingMinIndex`    | `MININDEX`    | —              | —           |\n| `rollingMinMax`      | `MINMAX`      | —              | —           |\n| `rollingMinMaxIndex` | `MINMAXINDEX` | —              | —           |\n| `rollingQuantile`    | —             | `quantile`     | —           |\n| `rollingSum`         | `SUM`         | `rolling_sum`  | —           |\n| `skew`               | —             | `skew`         | —           |\n| `standardError`      | —             | —              | —           |\n| `tosStdevAll`        | —             | `tos_stdevall` | —           |\n| `valueWhen`          | —             | —              | ValueWhen   |\n| `zScore`             | —             | `zscore`       | —           |\n\n## candlestick (3)\n\n| TotalFinance | TA-Lib | pandas-ta    | TradingView |\n| ------------ | ------ | ------------ | ----------- |\n| `cdlDoji`    | —      | `cdl_doji`   | —           |\n| `cdlInside`  | —      | `cdl_inside` | —           |\n| `cdlZ`       | —      | `cdl_z`      | —           |\n\n## price-action (7)\n\n| TotalFinance        | TA-Lib | pandas-ta | TradingView         |\n| ------------------- | ------ | --------- | ------------------- |\n| `atrTrailingStop`   | —      | —         | ATR Trailing Stop   |\n| `equalHighs`        | —      | —         | Equal Highs         |\n| `equalLows`         | —      | —         | Equal Lows          |\n| `fairValueGaps`     | —      | —         | Fair Value Gap      |\n| `liquiditySweeps`   | —      | —         | Liquidity Sweep     |\n| `orderBlocks`       | —      | —         | Order Block         |\n| `swingTrailingStop` | —      | —         | Swing Trailing Stop |\n","kind":"guide"},{"title":"TotalFinance indicator registry","url":"/guides/ta-indicators","description":"Auto-generated from @insiderfinance/totalfinance/technical-analysis — 335 registered indicators.","category":"Guide","keywords":"Auto-generated from `@insiderfinance/totalfinance/technical-analysis` — 335 registered indicators.\n\n## transform (14)\n\n| Indicator           | Inputs | Parameters                | Output                         |\n| ------------------- | ------ | ------------------------- | ------------------------------ |\n| `averagePrice`      | bars   | —                         | number                         |\n| `candleRange`       | bars   | —                         | number                         |\n| `gap`               | bars   | —                         | number                         |\n| `heikinAshi`        | bars   | —                         | record{close, high, low, open} |\n| `logReturns`        | series | —                         | number                         |\n| `lowerShadow`       | bars   | —                         | number                         |\n| `medianPrice`       | bars   | —                         | number                         |\n| `realBody`          | bars   | —                         | number                         |\n| `returns`           | series | —                         | number                         |\n| `rollingVolatility` | series | `period`, `annualization` | number                         |\n| `trueRange`         | bars   | —                         | number                         |\n| `typicalPrice`      | bars   | —                         | number                         |\n| `upperShadow`       | bars   | —                         | number                         |\n| `weightedClose`     | bars   | —                         | number                         |\n\n## moving-average (35)\n\n| Indicator                 | Inputs | Parameters                                                  | Output                      |\n| ------------------------- | ------ | ----------------------------------------------------------- | --------------------------- |\n| `alma`                    | series | `period`, `offset`, `sigma`                                 | number                      |\n| `anchoredVwap`            | bars   | `anchor`                                                    | number                      |\n| `dema`                    | series | `period`                                                    | number                      |\n| `ema`                     | series | `period`                                                    | number                      |\n| `frama`                   | bars   | `period`                                                    | number                      |\n| `fwma`                    | series | `period`                                                    | number                      |\n| `gannHighLowActivator`    | bars   | `period`                                                    | record{trend, value}        |\n| `hma`                     | series | `period`                                                    | number                      |\n| `holtWinterMovingAverage` | series | `levelSmoothing`, `trendSmoothing`, `accelerationSmoothing` | number                      |\n| `jma`                     | series | `period`, `phase`, `power`                                  | number                      |\n| `kama`                    | series | `period`, `fast`, `slow`                                    | number                      |\n| `mama`                    | bars   | `fastLimit`, `slowLimit`                                    | record{fama, mama}          |\n| `mcginley`                | series | `period`                                                    | number                      |\n| `midpoint`                | series | `period`                                                    | number                      |\n| `midprice`                | bars   | `period`                                                    | number                      |\n| `movingAverage`           | series | `period`, `movingAverageType`                               | number                      |\n| `movingAverageRibbon`     | series | `periods`                                                   | number[]                    |\n| `pascalWma`               | series | `period`                                                    | number                      |\n| `rainbowMovingAverage`    | series | `period`, `levels`                                          | number                      |\n| `rma`                     | series | `period`                                                    | number                      |\n| `rollingAnchoredVwap`     | bars   | `lookback`, `anchor`                                        | record{anchorBarsAgo, vwap} |\n| `rollingVwap`             | bars   | `period`                                                    | number                      |\n| `sessionVwap`             | bars   | `resetEvery`                                                | number                      |\n| `sineWma`                 | series | `period`                                                    | number                      |\n| `sma`                     | series | `period`                                                    | number                      |\n| `superSmoother`           | series | `period`                                                    | number                      |\n| `symmetricWma`            | series | `period`                                                    | number                      |\n| `t3`                      | series | `period`, `volumeFactor`                                    | number                      |\n| `tema`                    | series | `period`                                                    | number                      |\n| `trima`                   | series | `period`                                                    | number                      |\n| `vidya`                   | series | `period`, `cmoPeriod`                                       | number                      |\n| `vwapBands`               | bars   | `multiplier`                                                | record{lower, upper, vwap}  |\n| `vwma`                    | bars   | `period`                                                    | number                      |\n| `wma`                     | series | `period`                                                    | number                      |\n| `zlema`                   | series | `period`                                                    | number                      |\n\n## momentum (54)\n\n| Indicator              | Inputs | Parameters                                                                                                                                                                       | Output                                                               |\n| ---------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |\n| `apo`                  | series | `fast`, `slow`                                                                                                                                                                   | number                                                               |\n| `awesomeOscillator`    | bars   | `fast`, `slow`                                                                                                                                                                   | number                                                               |\n| `bias`                 | series | `period`                                                                                                                                                                         | number                                                               |\n| `bop`                  | bars   | —                                                                                                                                                                                | number                                                               |\n| `brar`                 | bars   | `period`                                                                                                                                                                         | record{popularityIndex, willingnessIndex}                            |\n| `cci`                  | bars   | `period`                                                                                                                                                                         | number                                                               |\n| `centerOfGravity`      | series | `period`                                                                                                                                                                         | number                                                               |\n| `cfo`                  | series | `period`                                                                                                                                                                         | number                                                               |\n| `cmo`                  | series | `period`, `talib`                                                                                                                                                                | number                                                               |\n| `connorsRsi`           | series | `rsiPeriod`, `streakPeriod`, `rankPeriod`                                                                                                                                        | number                                                               |\n| `coppock`              | series | `longRoc`, `shortRoc`, `wma`                                                                                                                                                     | number                                                               |\n| `cti`                  | series | `period`                                                                                                                                                                         | number                                                               |\n| `dpo`                  | series | `period`                                                                                                                                                                         | number                                                               |\n| `efficiencyRatio`      | series | `period`                                                                                                                                                                         | number                                                               |\n| `elderRay`             | bars   | `period`                                                                                                                                                                         | record{bear, bull}                                                   |\n| `fisherTransform`      | bars   | `period`                                                                                                                                                                         | record{fisher, trigger}                                              |\n| `forecastOscillator`   | series | `period`                                                                                                                                                                         | number                                                               |\n| `inertia`              | series | `period`, `rviPeriod`                                                                                                                                                            | number                                                               |\n| `kdj`                  | bars   | `period`, `signal`                                                                                                                                                               | record{d, j, k}                                                      |\n| `kst`                  | series | `rocPeriods`, `smaPeriods`, `signal`                                                                                                                                             | record{kst, signal}                                                  |\n| `laguerreRsi`          | series | `gamma`                                                                                                                                                                          | number                                                               |\n| `macd`                 | series | `fast`, `slow`, `signal`                                                                                                                                                         | record{histogram, macd, signal}                                      |\n| `macdExt`              | series | `fast`, `slow`, `signal`, `fastMovingAverageType`, `slowMovingAverageType`, `signalMovingAverageType`                                                                            | record{histogram, macd, signal}                                      |\n| `macdFix`              | series | `signal`                                                                                                                                                                         | record{histogram, macd, signal}                                      |\n| `momentum`             | series | `period`                                                                                                                                                                         | number                                                               |\n| `pgo`                  | bars   | `period`                                                                                                                                                                         | number                                                               |\n| `ppo`                  | series | `fast`, `slow`, `signal`                                                                                                                                                         | record{histogram, ppo, signal}                                       |\n| `projectionOscillator` | bars   | `period`                                                                                                                                                                         | record{lower, po, upper}                                             |\n| `psychologicalLine`    | series | `period`                                                                                                                                                                         | number                                                               |\n| `pvo`                  | bars   | `fast`, `slow`, `signal`                                                                                                                                                         | record{histogram, pvo, signal}                                       |\n| `qqe`                  | series | `rsiPeriod`, `smooth`, `factor`                                                                                                                                                  | record{longBand, rsiMovingAverage, shortBand}                        |\n| `relativeVigorIndex`   | bars   | `period`                                                                                                                                                                         | record{rvi, signal}                                                  |\n| `roc`                  | series | `period`                                                                                                                                                                         | number                                                               |\n| `rocp`                 | series | `period`                                                                                                                                                                         | number                                                               |\n| `rocr`                 | series | `period`                                                                                                                                                                         | number                                                               |\n| `rocr100`              | series | `period`                                                                                                                                                                         | number                                                               |\n| `rsi`                  | series | `period`                                                                                                                                                                         | number                                                               |\n| `rsx`                  | series | `period`                                                                                                                                                                         | number                                                               |\n| `schaffTrendCycle`     | series | `fast`, `slow`, `cycle`                                                                                                                                                          | number                                                               |\n| `slope`                | series | `period`                                                                                                                                                                         | number                                                               |\n| `smcSweep`             | bars   | `period`, `wickMultiplier`                                                                                                                                                       | number                                                               |\n| `smiErgodic`           | series | `long`, `short`, `signal`                                                                                                                                                        | record{oscillator, signal, smi}                                      |\n| `squeeze`              | bars   | `bollingerBandPeriod`, `bollingerStandardDeviations`, `keltnerChannelPeriod`, `keltnerChannelMultiplier`                                                                         | record{momentum, on}                                                 |\n| `squeezePro`           | bars   | `bollingerBandPeriod`, `bollingerStandardDeviations`, `keltnerChannelPeriod`, `wideKeltnerChannelMultiplier`, `normalKeltnerChannelMultiplier`, `narrowKeltnerChannelMultiplier` | record{highCompression, lowCompression, momentum, normalCompression} |\n| `stochastic`           | bars   | `kPeriod`, `dPeriod`, `smoothK`                                                                                                                                                  | record{d, k}                                                         |\n| `stochFast`            | bars   | `kPeriod","kind":"guide"},{"title":"TotalFinance TA — the live tier (charting workflows)","url":"/guides/ta-live-charts","description":"The technical-analysis package (@insiderfinance/totalfinance/technical-analysis) is built for live, charting-product use, not just end-of-day batch runs. Three pieces make that work: forming-bar peek(), multi-timefram…","category":"Guide","keywords":"The technical-analysis package (`@insiderfinance/totalfinance/technical-analysis`) is built for live, charting-product use, not just\nend-of-day batch runs. Three pieces make that work: forming-bar `peek()`, multi-timeframe\n`resample`/`alignToBars`, and `divergences`. All are pure (no clock reads) and streaming-first — batch\noutput is always derived from the same stream, so what you see live is what a backtest sees.\n\n## 1. Forming bars: `peek()` vs `next()`\n\nEvery indicator stream (`indicator.stream(params)`) is a **live stream** with two methods:\n\n- `next(value)` — apply `value` and **commit** it. Call this once, when a bar closes.\n- `peek(value)` — return the value that _would_ result from `next(value)`, **without** committing.\n  Call it as often as you like while a bar is still forming; the committed history is never touched, so\n  closed bars never repaint.\n\n\n\n`peek()` works for **every** indicator (all 300+), because it is supplied by the framework wrapper:\nit snapshots the committed state once per commit and applies the tick to a throwaway clone. The default\ncost is O(snapshot) per call — fine for a chart's tick rate.\n\n## 2. Multi-timeframe: `resample` + `alignToBars`\n\nShow a 1-hour indicator on a 1-minute chart **without** the `request.security` lookahead trap. Buckets\nare epoch-aligned (`floor(ts / intervalMs) * intervalMs`); only **closed** higher-timeframe (HTF) bars\nare ever projected onto the lower-timeframe (LTF) index.\n\n\n\nEach resampled bar carries OHLC (first/max/min/last), summed `volume`, and a volume-weighted `vwap`.\n_Limitation:_ only epoch-aligned buckets are supported — session-anchored resampling (buckets anchored\nto an exchange's session open) is intentionally not included.\n\n## 3. Divergences\n\nRegular and hidden price/indicator divergences, confirmed causally: an event is emitted at the bar\nwhere the second swing's fractal window completes, and the two swings reference earlier bars.\n\n\n\nThe streaming form is the registered `divergence` indicator (`divergence.stream(...)`), which yields a\nnumeric `DivergencePoint` per bar (`code: 0` when nothing confirms); `divergences(...)` is the\nconvenient event-list view with a string `kind`.\n","kind":"guide"},{"title":"Saving and restoring a streaming indicator","url":"/guides/ta-snapshots","description":"Every indicator in @insiderfinance/totalfinance/technical-analysis has a streaming form, and every streaming form is serializable. You feed it bars, save it, load it a week later, and keep feeding it — the output is i…","category":"Guide","keywords":"Every indicator in `@insiderfinance/totalfinance/technical-analysis` has a streaming form, and every streaming form is\nserializable. You feed it bars, save it, load it a week later, and keep feeding it — the output is\nidentical to a stream that never stopped.\n\n\n\nThat is the whole API. The rest of this page is what the library guarantees about the thing you\nstored, and what it does when that thing is wrong — because a snapshot is the one input to this\npackage that does **not** come from your code. It comes from a disk, a cache, or a wire.\n\n## The envelope\n\n`toJSON()` returns a `TechnicalAnalysisSnapshot`:\n\n\n\n`kind` and `schemaVersion` are yours to read. **`state` is opaque.** Round-trip it; never branch on\nwhat is inside it. Those keys are indicator-private, they are allowed to be terse, and they change\nwithout a major version — the envelope around them is the contract.\n\n## What a restore checks\n\n`fromJSON` validates the envelope before it touches a single field. In order:\n\n| Check                                                        | Rejected with                                                                       |\n| ------------------------------------------------------------ | ----------------------------------------------------------------------------------- |\n| It is an envelope at all                                     | `snapshot.wrong_shape`                                                              |\n| It is not a pre-envelope (flat, v1) snapshot                 | `snapshot.wrong_shape`                                                              |\n| It carries no field outside `{ kind, schemaVersion, state }` | `input.unknown_field`                                                               |\n| `schemaVersion` is one this build reads                      | `snapshot.unsupported_version`                                                      |\n| **`kind` is this indicator**                                 | `snapshot.kind_mismatch`                                                            |\n| `state` is an object                                         | `snapshot.wrong_shape`                                                              |\n| every field it reads has the right type and shape            | `input.wrong_type`, `input.missing_field`, `input.not_finite`, `input.out_of_range` |\n\nEvery one is an `InputError` carrying a `code` and a `context`, so a loader can branch:\n\n\n\nThe identity check is the one worth dwelling on. Before it existed, handing an EMA snapshot to\n`atr.fromJSON` produced an **ATR stream seeded with EMA numbers** — no error, no NaN, just a\nconfidently wrong indicator. A cache-key collision or a schema-less blob store is all it takes.\n\n## Non-finite values survive the round trip\n\n`JSON.stringify(NaN)` is `null`. That matters here more than it looks, because NaN is a _legitimate_\nvalue in this package: fed a zero price series, every log-return is NaN, so `realizedVolatility`'s\nwindow is NaN-filled from perfectly valid input; `acos` outside `[-1, 1]` caches NaN as its last\noutput. Measured across all 335 indicators, 38 distinct state paths can hold one.\n\nSo `snapshotOf` — the single point every `toJSON` goes through — encodes them:\n\n\n\nYou never write or read that form; the accessors decode it. What it buys you is that after\nserialization **no raw non-finite number exists in `state`** — which is what makes the reverse\nmeaningful. A raw `NaN` arriving at a restore cannot have come from this library, so it is treated as\ndamage and rejected, instead of being silently absorbed into a running sum that never recovers.\n\nThis is what `schemaVersion: 3` marks. A snapshot written by an earlier build is rejected with a\ntyped error rather than misread; re-serialize from a live stream to migrate.\n\n## Two independent restores are independent\n\nRestoring twice from the same snapshot object gives two streams that share nothing:\n\n\n\nBuffers are copied out on the way in, not aliased. This is load-bearing for `peek()`, the forming-bar\naffordance described in [live charts](/guides/ta-live-charts), which restores a throwaway clone on every\ntick.\n\n## Writing your own indicator\n\nIf you register an indicator with `defineIndicator`, its restorer uses the same door:\n\n\n\n`readSnapshot`'s second argument is not optional and has no default: it _is_ the identity guard. One\nclass that backs several public indicators passes the family instead, and the returned `state.kind`\nis narrowed to a member of it:\n\n\n\nThe accessors on `SnapshotState`:\n\n|                                                                     |                                                 |\n| ------------------------------------------------------------------- | ----------------------------------------------- |\n| `number` `numberOrNull` `optionalNumber`                            | a number, decoding the non-finite form          |\n| `integer` `lookback`                                                | a whole number ≥ 0, and a window ≥ 1            |\n| `boolean` `text` `literal(field, allowed)`                          | flags, strings, and closed sets                 |\n| `numbers` `numbersOrNull` `optionalNumbers` `numberRows` `literals` | arrays, always returned fresh                   |\n| `child` `children`                                                  | nested envelopes, for a composed indicator      |\n| `record` `recordOrNull` `records`                                   | structured state the indicator persists whole   |\n| `cached<T>`                                                         | the last emitted output; absent reads as `null` |\n\nThere is no accessor that returns `unknown`. A restorer that cannot say what it needs is a restorer\nthat is not checking — which is the defect the whole envelope exists to make impossible.\n","kind":"guide"},{"title":"TotalFinance indicator warmup / lookahead / displacement","url":"/guides/ta-warmup","description":"Warmup is the number of leading bars before the first real value, measured at the canonical parameters shown (via indicator.explain(...).diagnostics.warmup). 335 indicators.","category":"Guide","keywords":"Warmup is the number of leading bars before the first real value, measured at the canonical parameters shown (via `indicator.explain(...).diagnostics.warmup`). 335 indicators.\n\n**Lookahead: none.** Batch output is derived from a left-to-right stream, so no value depends on a future bar — causality is structural across the whole catalog.\n\n**Displacement: none.** Each value is aligned to the bar it is computed on. Charting platforms plot some indicators shifted (Ichimoku's leading spans 26 bars ahead, the classic DPO shifted back); TotalFinance never plot-shifts — apply any display offset downstream.\n\n## transform (14)\n\n| Indicator           | Inputs | Warmup | Canonical parameters           |\n| ------------------- | ------ | ------ | ------------------------------ |\n| `averagePrice`      | bars   | 0      | —                              |\n| `candleRange`       | bars   | 0      | —                              |\n| `gap`               | bars   | 1      | —                              |\n| `heikinAshi`        | bars   | 0      | —                              |\n| `logReturns`        | series | 1      | —                              |\n| `lowerShadow`       | bars   | 0      | —                              |\n| `medianPrice`       | bars   | 0      | —                              |\n| `realBody`          | bars   | 0      | —                              |\n| `returns`           | series | 1      | —                              |\n| `rollingVolatility` | series | 14     | `period=14, annualization=252` |\n| `trueRange`         | bars   | 0      | —                              |\n| `typicalPrice`      | bars   | 0      | —                              |\n| `upperShadow`       | bars   | 0      | —                              |\n| `weightedClose`     | bars   | 0      | —                              |\n\n## moving-average (35)\n\n| Indicator                 | Inputs | Warmup | Canonical parameters                                                |\n| ------------------------- | ------ | ------ | ------------------------------------------------------------------- |\n| `alma`                    | series | 13     | `period=14, offset=0.85, sigma=6`                                   |\n| `anchoredVwap`            | bars   | 0      | `anchor=0`                                                          |\n| `dema`                    | series | 26     | `period=14`                                                         |\n| `ema`                     | series | 13     | `period=14`                                                         |\n| `frama`                   | bars   | 13     | `period=14`                                                         |\n| `fwma`                    | series | 13     | `period=14`                                                         |\n| `gannHighLowActivator`    | bars   | 13     | `period=14`                                                         |\n| `hma`                     | series | 16     | `period=14`                                                         |\n| `holtWinterMovingAverage` | series | 0      | `levelSmoothing=0.2, trendSmoothing=0.1, accelerationSmoothing=0.1` |\n| `jma`                     | series | 0      | `period=14, phase=0, power=1`                                       |\n| `kama`                    | series | 14     | `period=14, fast=12, slow=26`                                       |\n| `mama`                    | bars   | 6      | `fastLimit=0.5, slowLimit=0.05`                                     |\n| `mcginley`                | series | 0      | `period=14`                                                         |\n| `midpoint`                | series | 13     | `period=14`                                                         |\n| `midprice`                | bars   | 13     | `period=14`                                                         |\n| `movingAverage`           | series | 13     | `period=14, movingAverageType=\"ema\"`                                |\n| `movingAverageRibbon`     | series | 19     | `periods=[5,10,20]`                                                 |\n| `pascalWma`               | series | 13     | `period=14`                                                         |\n| `rainbowMovingAverage`    | series | 130    | `period=14, levels=10`                                              |\n| `rma`                     | series | 13     | `period=14`                                                         |\n| `rollingAnchoredVwap`     | bars   | 19     | `lookback=20, anchor=\"high\"`                                        |\n| `rollingVwap`             | bars   | 13     | `period=14`                                                         |\n| `sessionVwap`             | bars   | 0      | `resetEvery=20`                                                     |\n| `sineWma`                 | series | 13     | `period=14`                                                         |\n| `sma`                     | series | 13     | `period=14`                                                         |\n| `superSmoother`           | series | 0      | `period=14`                                                         |\n| `symmetricWma`            | series | 13     | `period=14`                                                         |\n| `t3`                      | series | 78     | `period=14, volumeFactor=0.7`                                       |\n| `tema`                    | series | 39     | `period=14`                                                         |\n| `trima`                   | series | 13     | `period=14`                                                         |\n| `vidya`                   | series | 9      | `period=14, cmoPeriod=9`                                            |\n| `vwapBands`               | bars   | 0      | `multiplier=2`                                                      |\n| `vwma`                    | bars   | 13     | `period=14`                                                         |\n| `wma`                     | series | 13     | `period=14`                                                         |\n| `zlema`                   | series | 13     | `period=14`                                                         |\n\n## momentum (54)\n\n| Indicator              | Inputs | Warmup | Canonical parameters                                                                                                                                                                   |\n| ---------------------- | ------ | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `apo`                  | series | 25     | `fast=12, slow=26`                                                                                                                                                                     |\n| `awesomeOscillator`    | bars   | 25     | `fast=12, slow=26`                                                                                                                                                                     |\n| `bias`                 | series | 13     | `period=14`                                                                                                                                                                            |\n| `bop`                  | bars   | 0      | —                                                                                                                                                                                      |\n| `brar`                 | bars   | 14     | `period=14`                                                                                                                                                                            |\n| `cci`                  | bars   | 13     | `period=14`                                                                                                                                                                            |\n| `centerOfGravity`      | series | 13     | `period=14`                                                                                                                                                                            |\n| `cfo`                  | series | 13     | `period=14`                                                                                                                                                                            |\n| `cmo`                  | series | 14     | `period=14, talib=false`                                                                                                                                                               |\n| `connorsRsi`           | series | 101    | `rsiPeriod=14, streakPeriod=2, rankPeriod=100`                                                                                                                                         |\n| `coppock`              | series | 23     | `longRoc=14, shortRoc=11, wma=10`                                                                                                                                                      |\n| `cti`                  | series | 13     | `period=14`                                                                                                                                                                            |\n| `dpo`                  | series | 13     | `period=14`                                                                                                                                                                            |\n| `efficiencyRatio`      | series | 14     | `period=14`                                                                                                                                                                            |\n| `elderRay`             | bars   | 13     | `period=14`                                                                                                                                                                            |\n| `fisherTransform`      | bars   | 13     | `period=14`                                                                                                                                                                            |\n| `forecastOscillator`   | series | 13     | `period=14`                                                                                                                                                                            |\n| `inertia`              | series | 39     | `period=14, rviPeriod=14`                                                                                                                                                              |\n| `kdj`                  | bars   | 13     | `period=14, signal=9`                                                                                                                                                                  |\n| `kst`                  | series | 52     | `rocPeriods=[10,15,20,30], smaPeriods=[10,10,10,15], signal=9`                                                                                                                         |\n| `laguerreRsi`          | series | 0      | `gamma=0.5`                                                                                                                                                                            |\n| `macd`                 | series | 33     | `fast=12, slow=26, signal=9`                                                                                                                                                           |\n| `macdExt`              | series | 33     | `fast=12, slow=26, signal=9, fastMovingAverageType=\"ema\", slowMovingAverageType=\"ema\", signalMovingAverageType=\"ema\"`                                                                  |\n| `macdFix`              | series | 33     | `signal=9`                                                                                                                                                                             |\n| `momentum`             | series | 14     | `period=14`                                                                                                                                                                            |\n| `pgo`                  | bars   | 13     | `period=14`                                                                                                                                                                            |\n| `ppo`                  | series | 33     | `fast=12, slow=26, signal=9`                                                                                                                                                           |\n| `projectionOscillator` | bars   | 13     | `period=14`                                                                                                                                                                            |\n| `psychologicalLine`    | series | 14     | `period=14`                                                                                                                                                                            |\n| `pvo`                  | bars   | 33     | `fast=12, slow=26, signal=9`                                                                                                                                                           |\n| `qqe`                  | series | 71     | `rsiPeriod=14, smooth=5, factor=4.236`                                                                                                                                                 |\n| `relativeVigorIndex`   | bars   | 19     | `period=14`                                                                                                                                                                            |\n| `roc`                  | series | 14     | `period=14`                                                                                                                                                                            |\n| `rocp`                 | series | 14     | `period=14`                                                                                                                                                                            |\n| `rocr`                 | series | 14     | `period=14`                                                                                                                                                                            |\n| `rocr100`              | series | 14     | `period=14`                                                                                                                                                                            |\n| `rsi`                  | series | 14     | `period=14`                                                                                                                                                                            |\n| `rsx`                  | series | 14     | `period=14`                                                                                                                                                                            |\n| `schaffTrendCycle`     | series | 43     | `fast=12, slow=26, cycle=10`                                                                                                                                                           |\n| `slope`                | series | 14     | `period=14`                                                                                                                                                                            |\n| `smcSweep`             | bars   | 0      | `period=14, wickMultiplier=1.5`                                                                                                                                                        |\n| `smiErgodic`           | series | 45     | `long=25, short=13, signal=9`                                                                                                                                                          |\n| `squeeze`              | bars   | 38     | `bollingerBandPeriod=20, bollingerStandardDeviations=2, keltnerChannelPeriod=20, keltnerChannelMultiplier=1.5`                                                                         |\n| `squeezePro`           | bars   | 38     | `bollingerBandPeriod=20, bollingerStandardDeviations=2, keltnerChannelPeriod=20, wideKeltnerChannelMultiplier=2, normalKeltnerChannelMultiplier=1.5, narrowKeltnerChannelMultiplier=1` |\n| `stochastic`           | bars   | 15     | `kPeriod=14, dPeriod=3, smoothK=1`                                                                                                                                                     |\n| `stochFast`            | bars   | 15     | `kPeriod=14, dPeriod=3, smoothK=1`                                                                                                                                                     |\n| `stochRsi`             | series | 42     | `rsiPeriod=14, stochPeriod=14, kPeriod=14, dPeriod=3`                                                                                                                                  |\n| `tdSequential`         | bars   | 20     | `lookback=20`                                                                                                                                                                          |\n| `trix`                 | series | 40     | `period=14`                                                                                                                                                                            |\n| `trixHistogram`        | series | 48     | `period=14, signal=9`                                                                                                                                                                  |\n| `tsi`                  | series | 45     | `long=25, short=13, signal=9`                                                                                                                                                          |\n| `ultimateOscillator`   | bars   | 25     | `short=13, medium=14, long=25`                                                                                                                                                         |\n| `volumeWeightedMacd`   | bars   | 33     | `fast=12, slow=26, signal=9`                                                                                                                                                           |\n| `williamsR`            | bars   | 13     | `period=14`                                                                                                                                                                            |\n\n## trend (38)\n\n| Indicator                  | Inputs | Warmup | Canonical parameters                                                                                                                             |\n| -------------------------- | ------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `adx`                      | bars   | 27     | `period=14`                                                                                                                                      |\n| `adxr`                     | bars   | 41     | `period=14`                                                                                                                                      |\n| `amat`                     | series | 45     | `fast=12, slow=26, lookback=20, mov","kind":"guide"},{"title":"The safe trade lifecycle","url":"/guides/trade-lifecycle","description":"TotalFinance gives an agent — coded, learned, or an LLM — one lifecycle through which a decision may become an order, and no other: observe → analyze → propose → preflight → authorize → execute → reconcile. Every stag…","category":"Guide","keywords":"TotalFinance gives an agent — coded, learned, or an LLM — one lifecycle through which a decision may\nbecome an order, and no other: `observe → analyze → propose → preflight → authorize → execute →\nreconcile`. Every stage is an explicit, content-addressed artifact; every write is an explicit,\ncapability-gated operation; free text never executes a trade. This stage ships the paper adapter;\nlive execution is a later stage behind the same lifecycle (`mode: 'live'` is a typed refusal today).\n\n| Verb                                                    | What it does                                                                                                                   |\n| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `normalizeTradePlan`                                    | a trade intent (quantities or target weights) or a rebalance proposal → one execution plan, priced at the mark, hashed         |\n| `preflightTradePlan`                                    | the plan against the ledger, the market, and the policy: before/after through the ledger's own fold, every check, one decision |\n| `createAuthorizationGrant` / `verifyAuthorizationGrant` | human authority bound to the plan, the preflight, the snapshots, the account, a variance envelope, an expiry, a key set        |\n| `createPaperBroker`                                     | the first execution adapter: submit, step (fills through the engines' own fill path), cancel, deliver, halt                    |\n| `applyJournalEvents` / `journalOrderStates`             | the execution journal folded to per-order states with the transition table enforced                                            |\n| `reconcileExecution`                                    | the journal joined to the ledger's fills and, with an external snapshot, `reconcilePortfolio` verbatim                         |\n| `tradePack`                                             | the six operations — preflight, authorize, submit, cancel, reconcile, record_events — on every transport                       |\n\n## The laws the lifecycle keeps\n\n- **Preflight never upgrades missing information.** Every check has a verdict; an unverifiable\n  check is `require-approval` (or `deny` under the stricter policy); a failed check is `deny`; an\n  allow comes only from evidence, never from silence. The before and after states are the\n  ledger's own fold of the hypothetical fills and the monitor's judgment of the result.\n- **A grant binds what preflight saw.** The plan hash, the preflight hash, the portfolio and\n  market hashes, the market instant and an age allowance, the mode, the account, a variance\n  envelope, an expiry, the approver, and a closed set of idempotency keys. The broker checks those\n  bindings at first submission acceptance and lists every failed one; a changed plan needs new\n  authority. It does not re-check grant expiry on each fill or when returning an existing receipt.\n  Supplied `orders` must retain every authorized order exactly once: omitting an independent\n  hedge is material too. Quantity/notional variance is not permission to remove orders or change\n  their execution type, time-in-force or stop. To trade a subset, preflight and authorize that plan.\n- **A hash is integrity, not approval authority.** Workflow submission requires an unchanged\n  approved grant in the configured trusted authorization store, whether supplied by `grantHash`\n  or inline as `grant`. Only the approval path needs `trade:approve`; `trade:paper` cannot mint\n  its own authority by editing and rehashing a grant.\n- **Idempotency belongs to a journal and its authoritative store.** Retain both `sourceId` and\n  the store on retries: the same key and plan returns the same receipt without another order;\n  the same key with another plan is `trade.idempotency_conflict`. Order identities include the\n  intent's economic-body hash within that simulation.\n- **A grant licenses one durably prepared submission.** Before committing its journal, the authorization\n  store atomically records the storage identity, journal, receipt, key and exact validated events;\n  a retry with that key into that original store/journal recovers the\n  same receipt, and any other use — a second licensed key, another `sourceId`, another store —\n  is `trade.grant_consumed`. New authority means a new grant. (Pre-publish repairs B6.)\n- **An order fills only against a market it has seen.** The plan stamps `plannedTimestampMs`;\n  the broker stamps `submittedTimestampMs` at submission, journals it on the `submitted` event,\n  and never fills an order against an observation older than that stamp\n  (`observation-before-submission` in `unfilled`).\n- **A multi-leg order is one order.** Intent lines that share a `comboId` are legs of a combo;\n  the plan lists each combo with its legs in plan order and, when the intent gave one, its\n  `netLimitPrice` per combo unit (net debit positive, net credit negative; a combo unit is the\n  legs' quantities divided by their greatest common divisor for integer quantities, or by the\n  smallest leg quantity otherwise). When allowed quantity scaling changes that unit size, the\n  broker translates the limit to the submitted unit and persists it: the authorized economics\n  remain unchanged, including after restart. Preflight judges undefined risk on\n  the combo's after-state — a short call beside its longer-or-equal-dated long call is defined\n  risk — the grant binds the combo ids, and the paper broker fills a combo all-or-none against one\n  observation instant, only within the net limit (`combo-leg-unfilled`, `combo-net-limit`). A hedge\n  is allocated once across existing and proposed positions; removing a hedge is also checked.\n  Submit every authorized order, preserving each combo's quantity ratios even within a variance\n  allowance. Cancelling one leg cancels all remaining legs. Labels are plan-local: two plans can\n  both call their combo `vertical` without sharing limits or cancellation. External partial fills\n  or a closed leg block further simulated combo fills until reconciled/cancelled.\n- **The journal is not the ledger.** The execution journal is an append-only story of each order\n  (`submitted`, `acknowledged`, `partially-filled`, `filled`, `cancelled`, …) with its transition\n  table enforced; the ledger's `trade.fill` events are the accounting truth. A fill after a\n  cancellation is a late fill: journaled, ledgered, and the order left `unresolved` until\n  reconciliation says otherwise. A duplicate delivery is recorded once.\n- **Paper, backtest, and replay share one fill path.** `fillOrderWithPolicy` is the engine's fill\n  sequence — the fill model, slippage, the half-spread, impact, commission, the ledger's fill — and\n  the paper broker calls the same function; the difference is who supplies the observations.\n  Slippage, spread and impact already included in `pricePerUnit` are not charged again.\n  `executionPriceAdjustment` reports their absolute cash-equivalent deviation for attribution;\n  `costs` holds only additional cash charges. The ledger does not debit attribution fields.\n- **Writes are capabilities.** `trade.preflight` and `portfolio.rebalance_proposal` need\n  `trade:propose` (held by default); `trade.authorize` needs `trade:approve`; `trade.submit`,\n  `trade.cancel`, and `trade.reconcile` need `trade:paper`; `portfolio.record_events` needs\n  `portfolio:write`. The runtime refuses a missing capability with `operation.capability_missing`\n  before it parses the input.\n- **One order vocabulary.** Every order on the surface spells `side` as core `OrderSide`, `type`\n  as core `OrderType` (kebab-case: `market`, `limit`, `stop`, `stop-limit`, `market-on-open`,\n  `market-on-close`) and `timeInForce` as core `TimeInForce`; `sideOf` and `signOf` are the one\n  bridge between a signed exposure and a sided order. An intent line sizes a `quantity` or a\n  `notionalWeight` (a fraction of NAV at the mark); market data is keyed by `symbol`, ledger and\n  trade objects by `instrumentId`.\n\n## A first paper trade, directly\n\nThis is the pure SDK path: the application owns approval and supplies the domain grant itself.\n`createAuthorizationGrant` creates a representation; it does not establish trusted runtime approval.\nFor registry/CLI/HTTP/MCP execution, use `totalfinance.trade.authorize` against the same authorization\nstore that submission will use, as in the transport example below.\n\n\n\nA retry of `broker.submit` with `run:1` returns `receipt` itself; `run:1` with another plan is\n`trade.idempotency_conflict`; `broker.cancel`, `broker.deliver` (a late fill, a duplicate delivery,\nan asynchronous rejection), and `broker.halt` are the hazard surface, and every one of them leaves\nthe journal consistent and the unresolved state visible.\n\n## The same lifecycle on every transport\n\nThe six operations of `tradePack` run through the registry, the CLI, the HTTP server, and the MCP\nserver with one result. The runtime holds the caller's capabilities and the lifecycle's stores as\nexplicit parameters:\n\n\n\nOn the CLI, select `--profile full` to include `tradePack`. First run\n`totalfinance run totalfinance.trade.authorize --profile full --input authorize.json --capability trade:approve --store ~/.totalfinance/store`,\nthen use that approved grant's hash in\n`totalfinance run totalfinance.trade.submit --profile full --input submit.json --capability trade:paper --store ~/.totalfinance/store`.\nThe same store directory holds the artifacts, authorizations, and journals. Without the required\ncapability the CLI exits with `operation.capability_missing` before reading the input. These local\nCLI calls do not use HTTP bearer authentication.\n\nThe HTTP server additionally requires `authenticationToken` when write operations are enabled,\nincluding approval even though its operation declares `sideEffect: 'none'`. Configure the server's\n`capabilities` and `stores` explicitly; generate a token with at least 32 cryptographically random\nbearer-token characters and share it privately with trusted clients. The server CLI reads\n`--token-file <path>` or `TOTALFINANCE_HTTP_TOKEN`, never a secret CLI argument. Clients send\n`Authorization: Bearer <token>` and `Content-Type: application/json` on JSON POSTs. A token does\nnot grant capabilities or replace stored approval. Job creation/cancellation also requires the\ntoken; unauthenticated inline read-only analytics remain available. See the\n[HTTP guide](/guides/http) for executable setup, Host/Origin restrictions, and status codes.\n\nThe MCP server takes `capabilities`, `stores`, and `readOnly: false` to list the write tools.\nTool annotations (`readOnlyHint`, `destructiveHint`, `idempotentHint`, `openWorldHint`) derive from\nthe operation's effect fields; those annotations do not replace capability or approval checks.\n\n## Continuing a paper order and upgrading stores\n\nA workflow call rebuilds its broker from the authoritative journal store at `<sourceId>:journal`.\nTo advance an unmatched or partially filled order, retry `totalfinance.trade.submit` with the same\nsource, account, plan, idempotency key, and stores, and provide later `observations` and `asOf`.\nChanging `sourceId` or switching the authoritative store requires fresh approval; replaying a\nconsumed grant there refuses with `trade.grant_consumed`, even when the key is unchanged.\nThe workflow still checks `trade:paper` and matching approval in the trusted store on each submission\ncall. Grant expiry is checked at first acceptance, not on a same-key receipt retry or subsequent\n`step`. Expiry does not cancel already-accepted orders: an accepted GTC order can continue filling.\nUse `totalfinance.trade.cancel` or the SDK broker's `halt` to stop outstanding orders; order time-in-force\nexpiry rules still apply. This is not per-fill reauthorization or an account-wide revocation model.\nThe receipt stays the same, but the response can contain new fills,\nledger events, expiries, and the current `open` set. Top-level `fills`/`events` are current-call\ndeltas; `recovery` is cumulative for that receipt, as explained below. Journal restoration\npreserves fill identities across calls.\nUse `totalfinance.trade.cancel` with `trade:paper` and the same authoritative journal to cancel outstanding\norders. Cancellation uses the persisted order context and has no grant input; it does not require\na new grant or `trade:approve`. It does require the original authorization store as well as the\njournal, so any durably prepared submission is recovered before cancellation allocates event IDs.\nHTTP cancellation still requires the server's bearer credential.\nThe pure broker also supports restoring `journal: broker.journal()` and then calling `step`,\n`cancel`, or `deliver`.\n\n### Recovering a lost submission response\n\nA journal commit can succeed even when its HTTP/CLI response is lost. Retry the original submission\nwith the same source, authoritative store, plan, and key. Capability and trusted-store approval\nchecks still apply; grant expiry was checked at first acceptance. Receipt recovery remains possible\nafter grant expiry. Do not treat an empty current-call delta as proof that nothing previously filled.\n\nThe same retry also recovers a failure **between** the authorization claim and journal commit.\nThe authorization store retains the exact prepared event batch; every submit or cancel into the\noriginal journal recovers all its pending batches before allocating new identities. The journal\nappends them idempotently before reconstructing receipts. No prices, quantities or identities are\nrecalculated. An authorization-write failure before the claim leaves no journal effects. An\nambiguous persistence failure keeps authority claimed and fails closed until the original stores\ncan recover it; never delete the claim to retry. Memory stores survive only within their process.\n\n| Submission field                    | Meaning                                                                                                  |\n| ----------------------------------- | -------------------------------------------------------------------------------------------------------- |\n| `receipt`                           | immutable submission identity; the same receipt on retry                                                 |\n| `fills`, `events`                   | only the new fills and ledger events produced by this call                                               |\n| `recovery.fills`, `recovery.events` | cumulative persisted fills and reproducible ledger events for this receipt's orders, including this call |\n\nApply `recovery.events` with `totalfinance.portfolio.record_events` against the latest ledger handle,\nas in the example above. Reapplying an identical event ID and body is idempotent in the ledger,\nso this recovers committed-but-lost fills without recording already-applied economics twice.\nUse `recovery.fills` for reconciliation of those same orders. Recovery grows with later fills;\nit neither re-runs the fill engine nor includes unrelated receipts from the journal. Preserve\nthe returned event IDs and bodies: do not generate replacement IDs or modify timestamps on retry.\n\n### Authoritative stores and legacy upgrades\n\nSubmit and cancel require `stores.journal` and `stores.authorization`; an optional inline `journal` is an exact snapshot\nassertion, not a way to import or replace persisted history. Custom `ExecutionJournalStore`\nimplementations must provide a stable, non-empty `storeId` and `transact`: one synchronous transaction serializes restoration,\nidempotency checks, identity allocation, and the appended event batch, committing before returning\nthe result. Use the supplied memory/file stores unless implementing that contract deliberately.\nCustom authorization stores must atomically compare-and-set `consume`, persist its exact\n`journalEvents` before returning, and return detached consumption snapshots. A different claim\nmust fail before it can commit journal effects. The file store's `journals/store-id` belongs to\nthe backup together with authorization records and journal history: do not delete, edit, or copy\nit into an independent simulation. Do not run a restored backup and its original as independent\nactive stores. This is one-host local persistence, not distributed fencing or live-broker exactly-once delivery.\n\nBefore upgrading file stores, stop all old-version writers. Journals now use an identity-checked\nenvelope in `journals/v2/<sha256-of-exact-id>.json`; `list()` returns original journal IDs. A legacy\nsanitized file is readable only when every embedded ID matches the exact requested journal ID.\nThe next successful transaction migrates it and retains the old file. Do not rename a foreign or\ncolliding file to force adoption. Malformed JSON, invalid event bodies, mixed identities, and\nfilename/identity mismatches fail closed; corruption is not treated as an empty journal and does\nnot trigger migration or a replacement write. A valid foreign collision can be ignored only after\nits full body and identity have been validated. Incomplete legacy paper-order context refuses restoration:\nrecover the original order/instrument/account/execution facts, rather than inventing them or\nsilently discarding open orders. File transactions require a coherent local filesystem on one host,\nnot a distributed/shared-network lock service.\nPre-preview consumption records lacking storage identity or write-ahead events fail closed;\nrecover the original facts explicitly or start a separately approved simulation. An empty\nreplacement store never silently inherits an earlier grant.\n\n## What is deferred, and why\n\n- **Live execution** (`AT8`): the lifecycle is the same; the adapter is not written, and a `mode`\n  of `'live'` is `trade.live_unavailable` everywhere.\n- **Declared execution policies on the wire**: the paper broker on a transport runs the simplified\n  policy; a declared policy (fill models, cost models) is SDK-only, as it is for the environment.\n\nRead next: [`trading-environment.md`](./trading-environment.md) for the environment the lifecycle\ncomposes with, and the contract\n[`trade-lifecycle-and-paper-execution.md`](../specs/trade-lifecycle-and-paper-execution.md) for every\ndecision and its evidence.\n","kind":"guide"},{"title":"The trading-agent environment","url":"/guides/trading-environment","description":"TotalFinance ships a deterministic environment in which coded policies, learned policies, and LLM agents are developed and evaluated without broker risk. It is portfolioBacktest's own per-instant loop driven from outs…","category":"Guide","keywords":"TotalFinance ships a deterministic environment in which coded policies, learned policies, and LLM agents\nare developed and evaluated without broker risk. It is `portfolioBacktest`'s own per-instant loop\ndriven from outside — the same accounting, execution policy, lifecycle, marks, and margin — with the\norders decided by whoever holds the observation. The contract is the familiar `reset` / `step` one;\na thin adapter can implement Gymnasium later without moving any finance logic.\n\n| Verb                       | What it does                                                                                              |\n| -------------------------- | --------------------------------------------------------------------------------------------------------- |\n| `createTradingEnvironment` | a definition (the stepper's request plus `maximumSteps`, `limits`, `reward`, `features`) → an environment |\n| `environment.reset`        | the first decision instant's observation and the episode's identity; an optional seed                     |\n| `environment.step`         | an action in — hold, orders, cancellations — the next observation, the reward, and the flags out          |\n| `environment.finish`       | the engine's own result over the episode, the same shape `portfolioBacktest` returns                      |\n| `runEnvironmentEpisode`    | a recorded action trace driven to the end — the `environment` run kind's verb                             |\n| `environmentEpisode`       | one of twenty maintained scenarios built from a seed                                                      |\n| `runAgentBench`            | a policy over the library: operational conformance apart from strategy quality                            |\n| `scoreAgentTranscript`     | a recorded transport transcript scored against the operations, arguments, parity, and refusals expected   |\n\n## The laws every episode keeps\n\n- **Next-observation.** An order decided on observation `k` meets the market at instant `k + 1`\n  through the declared fill model; it is never filled on the bar that produced it.\n- **No leak.** The observation holds only what was published at or before its instant — the latest\n  observations, the marks, the features over the bar prefix — and it is deeply frozen.\n- **Rejections are rows.** A malformed action, an unknown instrument, a disallowed side, a projected\n  limit breach, a repeated order id: each is a typed row in `rejections`, never a throw, and the\n  step proceeds. A repeated order id is an idempotent retry, not a second order.\n- **The mask is a promise.** `observation.actionMask` says per instrument and side whether an\n  order is allowed and why not; an allowed order is never rejected for a mask reason.\n- **The reward never touches the accounting.** It is a declared composition over the step's frame,\n  every component returned with its value, weight, and contribution — weight 0 when the composition\n  omits it — so two rewards over the same trace leave identical fills, events, and equity.\n- **Identity is a chain.** `runId` identifies the environment and the seed; the trace hash chains\n  every canonical action, so identical policies leave identical traces and an episode replays to\n  the same run hash.\n\n## A first episode\n\n\n\n## Limits, the mask, and the reward\n\n`limits` is FC7's `PolicyLimits` verbatim — `maximumPositionWeight`, `maximumGrossLeverage`,\n`maximumDrawdown`, `maximumDailyLoss`, `minimumSettledCash`, … — plus `allowUndefinedRiskOptions`\n(default false: a sell that leaves an option net short is disallowed, a covered call excepted),\n`maximumPositionNotional`, and `onBreach` (`'terminate'` by default, or `'reject-and-continue'`).\nPre-trade, each queued order is projected at the current marks and a breach is\n`environment.limit_breach` naming the limit; post-trade, `monitorPortfolio` is the judge and the\nobservation's `limits.breaches` are its alerts. A projection is not a guarantee: a fill at a worse\nprice can overshoot, and then the monitor says so.\n\nThe reward composition names weights on `pnl`, `drawdown` (the increase from the running peak),\n`turnover`, `cost`, `concentration`, `leverage`, `riskViolation`, a `benchmark` instrument's excess,\nand `goal` terms from a callback (which makes the definition non-replayable). Every component is\nin `reward.components` regardless of what the composition paid for.\n\n## Episodes, artifacts, and the bench\n\n\n\nThe six baselines — `holdCash`, `buyAndHold`, `periodicRebalance`, `randomValidAction` (draws\nonly from the mask), `riskParity`, `momentumCrossover` — are policies like any other; each is itself\nbenched in the suite. `scoreAgentTranscript` scores a recorded transport transcript (the operations\ncalled, their arguments and results, the teaching errors received, the answer and the artifacts it\ncites) against what a journey expected — deterministically, so the same transcript always scores the\nsame. The model that produced the transcript is the caller's; the library holds none.\n","kind":"guide"},{"title":"Stability tiers","url":"/guides/stability","description":"TotalFinance 0.1.0 is pre-1.0 software, not a 1.0 stability guarantee. The main toolkit and optional MCP server are the two public packages; the 25 source workspaces remain private. The main package includes preview w…","category":"Guide","keywords":"TotalFinance `0.1.0` is **pre-1.0 software**, not a 1.0 stability guarantee. The main toolkit\nand optional MCP server are the two public packages; the 25 source workspaces remain private.\nThe main package includes preview workflows and transports: one install does not mean one maturity tier.\nA checkout version is not proof of publication. The short form of\nthis page, [`STABILITY.md`](../STABILITY.md), is copied into every published package so the promise\ntravels with the artifact; this page is the long form and the two never disagree (the preview surface\naudit checks that every package carries the identical file).\n\n## The three tiers\n\n| Tier              | What it covers                                                                                                                                                                      | The promise                                                                                                                                                                                                                                         |\n| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **stable-by-law** | every public function, type, and result envelope of the domain calculation entry points and root calculation namespaces                                                             | it passes the public-API laws and their gates (naming, signature policy, closed-door enforcement, generated contracts, API reports) at every commit; a change lands with a changeset entry. The semantic-versioning promise itself begins at `1.0`. |\n| **preview**       | the operation registry (`@insiderfinance/totalfinance/workflows`) and the transports over it — the `totalfinance` CLI, `totalfinance-http` and its OpenAPI document, the MCP server | the wire ids, input and output schemas, exit codes, status codes, and error documents are held through the preview series; a change ships as a new preview minor with a changeset entry, never silently.                                            |\n| **experimental**  | any export whose API report marks it `@experimental`                                                                                                                                | may change or disappear between previews without a deprecation cycle. The list is generated from the API reports under `packages/*/etc`, never authored by hand; consult those reports for the current list.                                        |\n\nWhat every tier shares, because the public-API laws require it: results\ncarry their `assumptions` and `diagnostics`; refusals are typed `QuantError`s with registered codes;\nnothing computes from data you did not pass in; a warning never licenses a non-finite number.\n\n## Tier by public entry point\n\nAll paths below except MCP belong to `@insiderfinance/totalfinance`; they are not separate installs.\n\n| Package                                                                         | Tier                                                       |\n| ------------------------------------------------------------------------------- | ---------------------------------------------------------- |\n| `@insiderfinance/totalfinance/core`                                             | stable-by-law                                              |\n| `@insiderfinance/totalfinance/math`                                             | stable-by-law                                              |\n| `@insiderfinance/totalfinance/calendars`                                        | stable-by-law                                              |\n| `@insiderfinance/totalfinance/options`                                          | stable-by-law                                              |\n| `@insiderfinance/totalfinance/volatility`                                       | stable-by-law                                              |\n| `@insiderfinance/totalfinance/structure`                                        | stable-by-law                                              |\n| `@insiderfinance/totalfinance/technical-analysis`                               | stable-by-law                                              |\n| `@insiderfinance/totalfinance/performance`                                      | stable-by-law                                              |\n| `@insiderfinance/totalfinance/risk`                                             | stable-by-law                                              |\n| `@insiderfinance/totalfinance/strategy`                                         | stable-by-law                                              |\n| `@insiderfinance/totalfinance/backtest`                                         | stable-by-law                                              |\n| `@insiderfinance/totalfinance/fixed-income`                                     | stable-by-law                                              |\n| `@insiderfinance/totalfinance/crypto`                                           | stable-by-law                                              |\n| `@insiderfinance/totalfinance/fundamentals`                                     | stable-by-law                                              |\n| `@insiderfinance/totalfinance/valuation`                                        | stable-by-law                                              |\n| `@insiderfinance/totalfinance/research`                                         | stable-by-law                                              |\n| `@insiderfinance/totalfinance/foreign-exchange`                                 | stable-by-law                                              |\n| `@insiderfinance/totalfinance/commodities`                                      | stable-by-law                                              |\n| `@insiderfinance/totalfinance/portfolio`                                        | stable-by-law                                              |\n| `@insiderfinance/totalfinance/scenarios`                                        | stable-by-law                                              |\n| `@insiderfinance/totalfinance` (root calculations)                              | stable-by-law — each namespace inherits its source package |\n| `@insiderfinance/totalfinance/workflows` (registry, runtime, `./local`)         | preview                                                    |\n| `@insiderfinance/totalfinance/cli` (`totalfinance`)                             | preview                                                    |\n| `@insiderfinance/totalfinance/http` (`totalfinance-http`, the OpenAPI document) | preview                                                    |\n| `@insiderfinance/totalfinance-mcp` (`totalfinance-mcp`)                         | preview                                                    |\n\n## What \"stable-by-law\" means before 1.0\n\nThe domain packages are not frozen by a version number; they are held by executable laws. Every export\nis classified in the manifest, its argument shape is checked by the signature policy, its refusals are\nproven by the enforcement probe, and its public contract is regenerated into the API reports and the\ngenerated docs on every commit. A change to any of them is therefore visible in the diff of a generated\nartifact and must carry a changeset entry, so a preview consumer reads the changelog rather than\ndiscovering a change at runtime. What the tier does **not** promise before `1.0` is that a name or shape\nwill never change: the pre-1.0 series exists so that corrections can land with a changelog\nentry instead of a major-version bump.\n\n## How a tier changes\n\n- An export becomes **experimental** by carrying the `@experimental` TSDoc tag; the API report records\n  it and the generated list updates. It leaves the tier the same way.\n- The **preview** surfaces become **stable-by-law** when the registry's wire contracts join the\n  same gates the domain packages pass (the Stage 7B/connected-transport work), not by a date.\n- **Deprecation** before `1.0` is a changeset entry plus a `@deprecated` tag that names the\n  replacement and the release that removes it; nothing is removed silently.\n\nSee [`SECURITY.md`](../SECURITY.md) for how to report a problem and the per-package `CHANGELOG.md` for\nwhat changed in each preview.\n","kind":"guide"},{"title":"Bundle size report","url":"/guides/bundle-size","description":"TotalFinance treats bundle size as a public contract (spec §21.5). Two different measurements below answer different questions. Both are generated from the same fixture/budget records CI enforces. Sizes use 1024 bytes…","category":"Guide","keywords":"<!-- Generated by tools/bundle-size-doc.ts — do not edit by hand. Run `pnpm run bundle:update`. -->\n\nTotalFinance treats bundle size as a public contract (spec §21.5). Two different measurements below\nanswer different questions. Both are generated from the same fixture/budget records CI enforces.\nSizes use 1024 bytes per KiB (the historical whole-entrypoint table labels these units KB).\n\n## Small installed consumers\n\nThese measurements pack exactly the two built distribution artifacts,\n`@insiderfinance/totalfinance` and `@insiderfinance/totalfinance-mcp`, install them outside the workspace, and bundle a\nconsumer that uses only the named calculation. No source aliases, forced side-effect overrides,\nor injected pure annotations are used. esbuild 0.25.12 and Rollup\n4.62.2 perform tree shaking; esbuild minifies Rollup's finished\noutput without rebundling. The fixtures expose a callable with runtime inputs so a constant answer\ncannot replace the calculation. This is a local package-artifact measurement, not an npm publication\nreceipt or a promise for every bundler version/configuration.\n\nThe main artifact has no runtime dependencies. MCP is an optional, separate artifact; no MCP SDK,\nCLI, HTTP, or Node-only workflow module may enter these browser consumers. Private source\nworkspaces are never installed. Dependency metadata is checked before installation, and retained\nmodule evidence comes from `@insiderfinance/totalfinance/modules/<domain>/dist/` inside the tarball.\n\n| Used-function fixture      | Public import                                         |   esbuild gzip / budget |   Rollup gzip / budget |\n| -------------------------- | ----------------------------------------------------- | ----------------------: | ---------------------: |\n| `data-named`               | `@insiderfinance/totalfinance/data`                   |   20.3 KiB / < 20.5 KiB |  18.3 KiB / < 18.5 KiB |\n| `data-root`                | `@insiderfinance/totalfinance`                        |  21.0 KiB / < 21.25 KiB |  18.3 KiB / < 18.5 KiB |\n| `data-restore`             | `@insiderfinance/totalfinance/data`                   |  15.6 KiB / < 15.75 KiB | 13.4 KiB / < 13.75 KiB |\n| `normal-feature`           | `@insiderfinance/totalfinance/math/normal`            |     0.5 KiB / < 0.6 KiB |    0.5 KiB / < 0.6 KiB |\n| `normal-root-namespace`    | `@insiderfinance/totalfinance`                        |     40.4 KiB / < 42 KiB |    0.5 KiB / < 0.6 KiB |\n| `rsi-feature`              | `@insiderfinance/totalfinance/technical-analysis/rsi` |       8.7 KiB / < 9 KiB |      8.6 KiB / < 9 KiB |\n| `rsi-root-namespace`       | `@insiderfinance/totalfinance`                        | 103.3 KiB / < 103.5 KiB |      8.5 KiB / < 9 KiB |\n| `facade-feature`           | `@insiderfinance/totalfinance/options/black-scholes`  | 15.0 KiB / < 15.375 KiB |    10.7 KiB / < 11 KiB |\n| `facade-root-namespace`    | `@insiderfinance/totalfinance`                        |  97.4 KiB / < 97.75 KiB |    10.7 KiB / < 11 KiB |\n| `facade-root-hoist`        | `@insiderfinance/totalfinance`                        | 15.0 KiB / < 15.375 KiB |    10.7 KiB / < 11 KiB |\n| `expert-feature`           | `@insiderfinance/totalfinance/options/black-scholes`  |     5.5 KiB / < 5.5 KiB |   3.0 KiB / < 3.25 KiB |\n| `expert-black76-feature`   | `@insiderfinance/totalfinance/options/black76`        |     5.4 KiB / < 5.5 KiB |  2.9 KiB / < 3.125 KiB |\n| `expert-bachelier-feature` | `@insiderfinance/totalfinance/options/bachelier`      |     2.1 KiB / < 2.5 KiB |    2.1 KiB / < 2.5 KiB |\n\n`normal` means `normalCdf`; `rsi` means the RSI indicator; `facade` means\n`blackScholes.call`; expert fixtures name their model's standalone price function.\nThe source fixture record is `tools/bundle-size/consumer-fixtures.ts`. The installed-package\nmatrix also checks domain subpaths, direct static domain and feature namespace imports,\nunused-library removal, dynamic-namespace retention, numerical outputs, and typed malformed-input\nrefusals. Portable import spellings must stay within 96 gzip bytes\nof their feature fixture and retain the same allowed implementation modules.\n\nRoot namespace re-exports such as `import { math } from '@insiderfinance/totalfinance'` can retain the whole\ndomain in esbuild ([upstream limitation](https://github.com/evanw/esbuild/issues/1420)); Rollup's\ncorresponding fixtures must remain lean. Use `import { normalCdf } from '@insiderfinance/totalfinance/math'`\nor `import { normalCdf } from '@insiderfinance/totalfinance/math/normal'` for the portable small-bundle path.\nThe direct hoist `import { blackScholes } from '@insiderfinance/totalfinance'` is tested separately from\n`options.blackScholes`. Dynamic property selection and enumeration legitimately retain more code.\nSee [imports and bundles](/guides/imports-and-bundles) for installation, browser, and Node guidance.\n\n## Whole-entrypoint ceilings\n\nThese older budgets bundle an entire source entrypoint, preserving ALL of its exports, with\nworkspace-source aliases. They protect package/feature ceilings and structural boundaries; they\nare **not** the cost of importing one function. A facade includes its callable/explain methods,\nruntime guards and diagnostics; an indicator includes its streaming/serialization support.\n\nThe `gzip` column is a measurement taken when this page was generated; it moves with the code and is\nallowed to. The `Budget` column is the contract.\n\n| Entrypoint                                                            |     gzip |       Budget | Notes                                                                                                                                                                                                                                                                                                    |\n| --------------------------------------------------------------------- | -------: | -----------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `@insiderfinance/totalfinance/valuation/price-levels`                 |   9.2 KB |   < 9.625 KB | reference-price conversion with typed validation, finite postconditions and explanations; no schema or provider machinery                                                                                                                                                                                |\n| `@insiderfinance/totalfinance/options/black-scholes`                  |  15.0 KB |  < 15.375 KB | all model exports; runtime guards included, schema/JSON-Schema machinery excluded                                                                                                                                                                                                                        |\n| `@insiderfinance/totalfinance/core`                                   |  19.3 KB |      < 20 KB | types, errors, conventions, dates, symbology, calendar engine; no exchange datasets                                                                                                                                                                                                                      |\n| `@insiderfinance/totalfinance/core/artifacts`                         |  31.2 KB |      < 32 KB | the Gate B artifact spine: canonical JSON, SHA-256 identity, snapshot/artifact/scenario envelopes — its own entrypoint so pricing bundles never pay for it                                                                                                                                               |\n| `@insiderfinance/totalfinance/core/pricing`                           |  15.2 KB |   < 15.25 KB | the Gate C Pricer/requirements protocol and conformance kit — contract types and probes, zero pricing mathematics                                                                                                                                                                                        |\n| `@insiderfinance/totalfinance/math`                                   |  40.3 KB |   < 40.75 KB | the whole numerical suite; consumers tree-shake to far less via deep entrypoints                                                                                                                                                                                                                         |\n| `@insiderfinance/totalfinance/math/montecarlo`                        |   7.4 KB |  < 7.4375 KB | Sobol direction numbers are generated, not a vendored table                                                                                                                                                                                                                                              |\n| `@insiderfinance/totalfinance/math/normal`                            |   1.1 KB |       < 3 KB | standard normal only — the canonical lean deep entrypoint                                                                                                                                                                                                                                                |\n| `@insiderfinance/totalfinance/calendars/nyse`                         |   5.8 KB |       < 8 KB | rules-based — no giant holiday tables                                                                                                                                                                                                                                                                    |\n| `@insiderfinance/totalfinance/calendars/crypto`                       |   4.9 KB |  < 4.9375 KB | aliases alwaysOpen and pulls in no exchange-holiday dataset                                                                                                                                                                                                                                              |\n| `@insiderfinance/totalfinance/performance/sector-performance`         |  10.5 KB | < 10.5312 KB | simple and audited sector returns; no option pricing or schema machinery                                                                                                                                                                                                                                 |\n| `@insiderfinance/totalfinance/performance/sharpe`                     |   8.8 KB |    < 9.25 KB | verified to pull in no option pricing                                                                                                                                                                                                                                                                    |\n| `@insiderfinance/totalfinance/technical-analysis/rsi`                 |   8.7 KB |    < 8.75 KB | single indicator, deep entrypoint                                                                                                                                                                                                                                                                        |\n| `@insiderfinance/totalfinance/fixed-income/lattice`                   |  12.9 KB | < 12.9062 KB | short-rate lattice; pulls the option/BSM kernel for the equity leg                                                                                                                                                                                                                                       |\n| `@insiderfinance/totalfinance/fixed-income/convertible`               |   8.8 KB |  < 8.8125 KB | convertible bond pricing, reported separately so a consumer sees what it pays                                                                                                                                                                                                                            |\n| `@insiderfinance/totalfinance/fixed-income/xva`                       |  11.7 KB |   < 11.75 KB | CVA/DVA/FVA valuation adjustments, reported separately                                                                                                                                                                                                                                                   |\n| `@insiderfinance/totalfinance/volatility/artifacts`                   |  87.1 KB |      < 88 KB | Stage 4.5 fitted-model artifacts for the twelve volatility families: save/restore/evaluate/replay/compare, warm starts, stability, holdout — a subpath so calibration bundles never pay for the spine                                                                                                    |\n| `@insiderfinance/totalfinance/fixed-income/artifacts`                 |  44.5 KB |    < 45.5 KB | Stage 4.5 fitted-model artifacts for the four curve families: save/restore/evaluate/replay/compare and the repricing-residual holdout — a subpath so bootstrap bundles never pay for the spine                                                                                                           |\n| `@insiderfinance/totalfinance/backtest/portfolio`                     | 113.8 KB |     < 114 KB | Stage 4.6 portfolioBacktest: the ledger-backed multi-asset simulator with its eight instrument adapters and the conformance suite — a subpath so a single-instrument backtest never pays for the ledger fold or the adapters                                                                             |\n| `@insiderfinance/totalfinance/portfolio/trade`                        |  77.5 KB | < 77.5625 KB | Stage 7B.2 the safe trade lifecycle: intents and execution plans, the structured policy, and preflight through the ledger fold and the monitor — a subpath so a ledger consumer never pays for the lifecycle                                                                                             |\n| `@insiderfinance/totalfinance/backtest/environment`                   | 142.2 KB |   < 142.5 KB | Stage 7B.1 createTradingEnvironment: the deterministic trading-agent environment over the portfolio engine — reset/step, open orders, typed rejections, the trace identity — a subpath so a backtest never pays for the environment and the environment pays only for the engine it drives               |\n| `@insiderfinance/totalfinance/backtest/paper`                         |  37.1 KB | < 37.1562 KB | Stage 7B.2 createPaperBroker: the first execution adapter over the engines’ own fill path — submit (grant verification, idempotency, the receipt), step (fills through fillOrderWithPolicy and the ledger events), cancel, deliver, halt; its own entrypoint so the engines never pay for the broker     |\n| `@insiderfinance/totalfinance/backtest/artifacts`                     | 234.9 KB |   < 235.5 KB | Stage 4.6 backtest-run artifacts over the cross-sectional engine and its grid: save/read/replay/compare with embedded or referenced rows of the request and the run, models by description, the run hash, and the FC8 identity list — a subpath so a bundle that only backtests never pays for the spine |\n| `@insiderfinance/totalfinance/research/artifacts`                     |  43.0 KB |      < 44 KB | Stage 4.5 research-run artifacts over the eleven FC3 operations: save/read/replay/compare with embedded or referenced rows, the verbatim hygiene block, and the recipe — a subpath so screening bundles never pay for the spine                                                                          |\n| `@insiderfinance/totalfinance/workflows`                              | 509.0 KB |   < 509.5 KB | Stage 7A: the protocol-neutral operation registry and the curated operations every transport adapts — bundles the compute it composes; a transport imports it, an application imports the domain packages directly                                                                                       |\n| `@insiderfinance/totalfinance/research`                               |  25.2 KB |   < 25.25 KB | point-in-time screening, style factors, and event studies                                                                                                                                                                                                                                                |\n| `@insiderfinance/totalfinance/foreign-exchange`                       |  10.7 KB |   < 10.75 KB | currency pairs, conversion, forwards and parity, currency exposure                                                                                                                                                                                                                                       |\n| `@insiderfinance/totalfinance/portfolio/disclosed-holdings`           |  10.3 KB |    < 10.5 KB | exact disclosed quantity/value changes, complete-universe weights and concentration; no ledger or provider integration                                                                                                                                                                                   |\n| `@insiderfinance/totalfinance/portfolio/disclosed-holding-partitions` |  11.0 KB |  < 11.375 KB | exact reported line partitions, complete-universe partition weights and conservative basis comparisons                                                                                                                                                                                                   |\n| `@insiderfinance/totalfinance/portfolio`                              | 110.4 KB |  < 110.75 KB | the FC7 event-derived ledger and independent disclosed-holdings comparison; events, reducer, serialization, valuation, FC4 seam                                                                                                                                                                          |\n| `@insiderfinance/totalfinance/commodities`                            |  11.0 KB |      < 11 KB | cost-of-carry forwards, implied carry inputs, roll analytics, curve state                                                                                                                                                                                                                                |\n| `@insiderfinance/totalfinance/scenarios`                              |  71.5 KB |      < 72 KB | shared deterministic scenario execution: full revaluation, Taylor approximation, aggregation, FX conversion, and exact replay                                                                                                                                                                            |\n| `@insiderfinance/totalfinance/data`                                   |  21.0 KB |      < 21 KB | provider-neutral bounded research windows and canonical restoration; explicit provider binding                                                                                                                                                                                                           |\n| `@insiderfinance/totalfinance`                                        | 715.2 KB |   < 715.5 KB | the deliberately-everything umbrella import; tree-shakes or use totalfinance/<domain>                                                                                                                                                                                                                    |\n\n## Structural guarantees\n\nThese are enforced, not merely measured — the byte count is the lesser half of the claim.\n\n- **`@insiderfinance/totalfinance/valuation/price-levels` bundles no `toJSONSchema`.** Runt","kind":"guide"},{"title":"Security policy","url":"/guides/security","description":"TotalFinance computes from the data you pass in. Compute entry points open no network connection and hold no provider key. The optional HTTP server binds to loopback by default; MCP uses stdio. Transports are read-onl…","category":"Guide","keywords":"TotalFinance computes from the data you pass in. Compute entry points open no network connection and\nhold no provider key. The optional HTTP server binds to loopback by default; MCP uses stdio.\nTransports are read-only by default. Paper-execution and other write operations require explicit\ncapabilities, stores and authorization; no live brokerage integration is supplied.\nA vulnerability may include a refusal that does not happen (an input a\ndoor should reject but does not), a resource bound that can be exceeded (input bytes, result bytes,\nJSON depth, a job that does not stop when cancelled), or a path a file-backed store follows that it\nshould not. Those are exactly the reports we want.\n\n## Supported versions\n\n| Version                                  | Supported                                                                |\n| ---------------------------------------- | ------------------------------------------------------------------------ |\n| `0.1.5`                                  | yes — SDK fixes ship in patch releases; optional MCP remains source-only |\n| earlier development or preview artifacts | no — use the current supported release                                   |\n\nThis policy covers `@insiderfinance/totalfinance` and `@insiderfinance/totalfinance-mcp`.\nVersion 0.1.5 remains pre-1.0 software, with preview workflow and transport components.\nOptional MCP metadata follows the SDK for local builds; this SDK-only release does not publish it.\nThe version in a source checkout does not establish that a public npm release exists.\n\n## Reporting a vulnerability\n\nReport privately through GitHub's **Security → Report a vulnerability** on the TotalFinance repository\n(`https://github.com/InsiderFinance/totalfinance/security/advisories/new`). Please do not open a public\nissue for anything you believe is exploitable. Include the package and version, the smallest input\nthat reproduces the behaviour, and what you expected the door to do instead; a failing test is the\nbest report.\n\n## What to expect\n\n- **Acknowledgement within 3 business days** of the report.\n- **Assessment within 10 business days**: confirmed, not a vulnerability (with the reasoning), or\n  a request for more detail.\n- **A fix or a documented mitigation within 30 days** of confirmation for anything rated high or\n  critical, shipped as a new release of the public pair with a changeset entry that credits\n  the reporter (unless they prefer otherwise), plus a GitHub security advisory.\n- **Coordinated disclosure**: we ask for 90 days from the report before public disclosure, or the\n  release date of the fix, whichever comes first.\n\n## Scope notes\n\n- Authorized releases must carry `provenance` attestations; verify a tarball against\n  `RELEASE_HASHES.json` on the release before trusting it.\n- The `totalfinance` CLI's default store lives under `~/.totalfinance/store`; a report that a store can be\n  made to read or write outside its directory is in scope.\n- Findings in the private InsiderFinance application that hosts this monorepo are out of scope\n  here; report those to InsiderFinance directly.\n","kind":"guide"},{"title":"AlignToBarsInput","url":"/reference/totalfinance/technical-analysis/resample#AlignToBarsInput","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/technical-analysis/resample","kind":"interface","keywords":"@insiderfinance/totalfinance interface  higherBars higherSeries lowerBars options options.intervalMs @insiderfinance/totalfinance/technical-analysis/resample"},{"title":"BoxSpreadRateInput","url":"/reference/totalfinance/options/parity#BoxSpreadRateInput","description":"One cohesive request for a box-spread-implied financing rate.","category":"@insiderfinance/totalfinance/options/parity","kind":"interface","keywords":"@insiderfinance/totalfinance interface  expiry lowerStrike options options.asOf options.source quotes upperStrike @insiderfinance/totalfinance/options/parity"},{"title":"CdsBasisInput","url":"/reference/totalfinance/fixed-income/credit#CdsBasisInput","description":"CDS-bond basis: the CDS par spread minus the bond-implied credit spread (positive = CDS rich).","category":"@insiderfinance/totalfinance/fixed-income/credit","kind":"interface","keywords":"@insiderfinance/totalfinance interface  bondImpliedSpread cdsParSpread @insiderfinance/totalfinance/fixed-income/credit"},{"title":"CommonPageFacts","url":"/reference/totalfinance/core/data#CommonPageFacts","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  access adjustment consistency coverage coverage.end coverage.start coverage.status dataset dataset.id dataset.version freshness freshness.co @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"ConnectedData","url":"/reference/totalfinance/core/data#ConnectedData","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  capabilities capabilities(options) capabilities(options).signal contractVersion id priceBars priceBars(options) priceBars(options).maxPages  @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"CreditTriangleHazardInput","url":"/reference/totalfinance/fixed-income/credit#CreditTriangleHazardInput","description":"The credit-triangle approximation of the hazard rate implied by a flat par spread:\n`λ ≈ spread / (1 − recovery)`. Exact only in the continuous-premium, flat-cur","category":"@insiderfinance/totalfinance/fixed-income/credit","kind":"interface","keywords":"@insiderfinance/totalfinance interface  recovery spread @insiderfinance/totalfinance/fixed-income/credit"},{"title":"DataCallOptions","url":"/reference/totalfinance/core/data#DataCallOptions","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  signal @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataCapabilities","url":"/reference/totalfinance/core/data#DataCapabilities","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  capabilities contractVersion ignored ignored.intervals ignored.kinds providerId providerVersion @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataCapability","url":"/reference/totalfinance/core/data#DataCapability","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  access consistency intervals kind maxPageSize maxSessionDays maxWindowMs pointInTime @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataCapabilityDeclaration","url":"/reference/totalfinance/core/data#DataCapabilityDeclaration","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  access consistency intervals kind maxPageSize maxSessionDays maxWindowMs pointInTime @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataConnectionOptions","url":"/reference/totalfinance/core/data#DataConnectionOptions","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  maxPages maxReads maxRecords pageSize @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataContinuation","url":"/reference/totalfinance/core/data#DataContinuation","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  binding binding.provider binding.provider.id binding.provider.version binding.query binding.query.expirationFrom binding.query.expirationTo  @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataFor","url":"/reference/totalfinance/core/data#DataFor","description":"type from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"type","keywords":"@insiderfinance/totalfinance type   @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataGuidanceRule","url":"/reference/totalfinance/core/data#DataGuidanceRule","description":"type from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"type","keywords":"@insiderfinance/totalfinance type   @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataInterval","url":"/reference/totalfinance/core/data#DataInterval","description":"type from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"type","keywords":"@insiderfinance/totalfinance type   @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataKind","url":"/reference/totalfinance/core/data#DataKind","description":"type from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"type","keywords":"@insiderfinance/totalfinance type   @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataPage","url":"/reference/totalfinance/core/data#DataPage","description":"Version1 remains a canonical restore format, never a live source protocol.","category":"@insiderfinance/totalfinance/core/data","kind":"type","keywords":"@insiderfinance/totalfinance type   @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataPageMetadata","url":"/reference/totalfinance/core/data#DataPageMetadata","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  access adjustment consistency coverage coverage.end coverage.start coverage.status datasetId datasetVersion executionEligibility freshness f @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataPageOptions","url":"/reference/totalfinance/core/data#DataPageOptions","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  cursor limit pins pins.adjustment pins.consistency pins.datasetId pins.datasetVersion pins.sessionDate pins.snapshotId pins.temporal pins.te @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataPins","url":"/reference/totalfinance/core/data#DataPins","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  adjustment consistency datasetId datasetVersion sessionDate snapshotId temporal temporal.interval temporal.kind temporal.timestampConvention @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataProvider","url":"/reference/totalfinance/core/data#DataProvider","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  capabilities capabilities(options) capabilities(options).signal contractVersion id query query(options) query(options).cursor query(options) @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataProviderErrorOptions","url":"/reference/totalfinance/core/data#DataProviderErrorOptions","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  cause code guidance guidance.field guidance.rule retryAfterMs retryable status @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataProviderFailure","url":"/reference/totalfinance/core/data/page-2#DataProviderFailure","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  code guidance guidance.field guidance.rule retryAfterMs retryable status version @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataProviderSource","url":"/reference/totalfinance/core/data/page-2#DataProviderSource","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  capabilities capabilities(options) capabilities(options).signal contractVersion id protocol query query(page) query(page).cursor query(page) @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataQuery","url":"/reference/totalfinance/core/data/page-2#DataQuery","description":"type from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"type","keywords":"@insiderfinance/totalfinance type  expirationFrom expirationTo from interval kind maxStrike minStrike rights snapshot snapshot.kind snapshot.sessionDate snapshot.snapshotId sy @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataQueryBinding","url":"/reference/totalfinance/core/data/page-2#DataQueryBinding","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  provider provider.id provider.version query query.expirationFrom query.expirationTo query.from query.interval query.kind query.maxStrike que @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataQueryOptions","url":"/reference/totalfinance/core/data/page-2#DataQueryOptions","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  cursor cursor.binding cursor.binding.provider cursor.binding.provider.id cursor.binding.provider.version cursor.binding.query cursor.binding @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataView","url":"/reference/totalfinance/core/data/page-2#DataView","description":"type from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"type","keywords":"@insiderfinance/totalfinance type  bars closePrices continuation continuation.binding continuation.binding.provider continuation.binding.provider.id continuation.binding.provi @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DataViewFor","url":"/reference/totalfinance/core/data/page-2#DataViewFor","description":"type from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"type","keywords":"@insiderfinance/totalfinance type   @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"DivergencesInput","url":"/reference/totalfinance/technical-analysis/divergence#DivergencesInput","description":"Detect regular & hidden divergences between a `price` series and an `indicator` series, returning\nthe confirmed events as a list (batch derived from the stream)","category":"@insiderfinance/totalfinance/technical-analysis/divergence","kind":"interface","keywords":"@insiderfinance/totalfinance interface  indicator parameters parameters.kinds parameters.swing parameters.swing.left parameters.swing.right price @insiderfinance/totalfinance/technical-analysis/divergence"},{"title":"DupireLocalVolatilityInput","url":"/reference/totalfinance/options/local-volatility#DupireLocalVolatilityInput","description":"One cohesive request for construction of a Dupire local-volatility function.","category":"@insiderfinance/totalfinance/options/local-volatility","kind":"interface","keywords":"@insiderfinance/totalfinance interface  impliedVolatility impliedVolatility(strike) impliedVolatility(timeToExpiryYears) market market.dividendYield market.riskFreeRate market.spot @insiderfinance/totalfinance/options/local-volatility"},{"title":"ExposureInput","url":"/reference/totalfinance/structure#ExposureInput","description":"Input for {@link exposure}: the chain, market and convention, plus an optional metric selection.","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance interface  config config.convention config.convention.calls config.convention.puts config.defaultMultiplier config.gammaUnit config.minTimeToExpiry con @insiderfinance/totalfinance/structure @insiderfinance/totalfinance/structure/exposure"},{"title":"FibExtensionInput","url":"/reference/totalfinance/technical-analysis/price-action#FibExtensionInput","description":"Trend-based Fibonacci extension: project the `start → end` move from `projectFrom`:\n`price(r) = projectFrom + (end − start)·r`. Targets at r ≥ 1 lie beyond the ","category":"@insiderfinance/totalfinance/technical-analysis/price-action","kind":"interface","keywords":"@insiderfinance/totalfinance interface  end levels projectFrom start @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"FlatCurveInput","url":"/reference/totalfinance/fixed-income/curves#FlatCurveInput","description":"One cohesive request for a flat continuously compounded zero curve.","category":"@insiderfinance/totalfinance/fixed-income/curves","kind":"interface","keywords":"@insiderfinance/totalfinance interface  options options.compounding options.compounding.periodsPerYear options.compounding.type options.dayCount options.extrapolation options.inter @insiderfinance/totalfinance/fixed-income/curves"},{"title":"FlatHazardInput","url":"/reference/totalfinance/fixed-income/credit#FlatHazardInput","description":"A flat-hazard survival curve (constant default intensity).","category":"@insiderfinance/totalfinance/fixed-income/credit","kind":"interface","keywords":"@insiderfinance/totalfinance interface  hazardRate options options.dayCount referenceDate @insiderfinance/totalfinance/fixed-income/credit"},{"title":"GarchForecastInput","url":"/reference/totalfinance/volatility/forecast#GarchForecastInput","description":"Multi-step GARCH(1,1) variance forecast. The `h`-step-ahead conditional variance mean-reverts\ngeometrically to the long-run variance: `σ²ₜ₊ₕ = LRV + (α+β)^h · (","category":"@insiderfinance/totalfinance/volatility/forecast","kind":"interface","keywords":"@insiderfinance/totalfinance interface  fit fit.alpha fit.assumptions fit.assumptions.conventionsVersion fit.assumptions.initialParameters fit.assumptions.mean fit.assumptions.obse @insiderfinance/totalfinance/volatility/forecast"},{"title":"HestonCosineExpansionPriceInput","url":"/reference/totalfinance/options/heston#HestonCosineExpansionPriceInput","description":"Complete, assumption-light inputs for the raw Heston COS kernel.","category":"@insiderfinance/totalfinance/options/heston","kind":"interface","keywords":"@insiderfinance/totalfinance interface  dividendYield parameters parameters.kappa parameters.rho parameters.sigma parameters.theta parameters.v0 riskFreeRate spot strike terms time @insiderfinance/totalfinance/options/heston"},{"title":"HestonMonteCarloEstimateInput","url":"/reference/totalfinance/options/heston#HestonMonteCarloEstimateInput","description":"Complete inputs for one raw Heston QE Monte-Carlo estimate.","category":"@insiderfinance/totalfinance/options/heston","kind":"interface","keywords":"@insiderfinance/totalfinance interface  dividendYield options options.antithetic options.brownianBridge options.confidence options.greeks options.method options.paths options.rando @insiderfinance/totalfinance/options/heston"},{"title":"HestonPriceMonteCarloRequest","url":"/reference/totalfinance/options/heston#HestonPriceMonteCarloRequest","description":"One cohesive request for the validated Heston QE Monte-Carlo pricer.","category":"@insiderfinance/totalfinance/options/heston","kind":"interface","keywords":"@insiderfinance/totalfinance interface  input input.dividendYield input.riskFreeRate input.spot input.strike input.timeToExpiryYears options options.antithetic options.brownianBrid @insiderfinance/totalfinance/options/heston"},{"title":"HestonPriceRequest","url":"/reference/totalfinance/options/heston#HestonPriceRequest","description":"One cohesive request for the validated Heston COS pricer or IV bridge.","category":"@insiderfinance/totalfinance/options/heston","kind":"interface","keywords":"@insiderfinance/totalfinance interface  input input.dividendYield input.riskFreeRate input.spot input.strike input.timeToExpiryYears options options.extendedGreeks options.greeks o @insiderfinance/totalfinance/options/heston"},{"title":"HestonSurfaceCalibrationInput","url":"/reference/totalfinance/volatility/heston-surface#HestonSurfaceCalibrationInput","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/volatility/heston-surface","kind":"interface","keywords":"@insiderfinance/totalfinance interface  market market.dividendYield market.riskFreeRate market.spot options options.initialParameters options.initialParameters.kappa options.initia @insiderfinance/totalfinance/volatility/heston-surface"},{"title":"ImpliedBorrowInput","url":"/reference/totalfinance/options/parity#ImpliedBorrowInput","description":"One cohesive request for borrow-spread inference from put-call parity.","category":"@insiderfinance/totalfinance/options/parity","kind":"interface","keywords":"@insiderfinance/totalfinance interface  expiry options options.asOf options.outlierThreshold options.riskFreeRate options.source options.spot quotes @insiderfinance/totalfinance/options/parity"},{"title":"ImpliedDividendYieldInput","url":"/reference/totalfinance/options/parity#ImpliedDividendYieldInput","description":"One cohesive request for dividend-yield inference from put-call parity.","category":"@insiderfinance/totalfinance/options/parity","kind":"interface","keywords":"@insiderfinance/totalfinance interface  expiry options options.asOf options.outlierThreshold options.riskFreeRate options.source options.spot quotes @insiderfinance/totalfinance/options/parity"},{"title":"ImpliedForwardInput","url":"/reference/totalfinance/options/parity#ImpliedForwardInput","description":"One cohesive request for put-call-parity forward inference.","category":"@insiderfinance/totalfinance/options/parity","kind":"interface","keywords":"@insiderfinance/totalfinance interface  expiry options options.asOf options.outlierThreshold options.riskFreeRate options.source quotes @insiderfinance/totalfinance/options/parity"},{"title":"ImpliedVolatilityMetricInput","url":"/reference/totalfinance/volatility/metrics#ImpliedVolatilityMetricInput","description":"Input for {@link impliedVolatilityRank}/{@link impliedVolatilityPercentile}/{@link impliedVolatilityStatistics}: current IV vs its history.","category":"@insiderfinance/totalfinance/volatility/metrics","kind":"interface","keywords":"@insiderfinance/totalfinance interface  current history @insiderfinance/totalfinance/volatility/metrics"},{"title":"KellyInput","url":"/reference/totalfinance/risk/optimize#KellyInput","description":"Kelly-optimal weights (`Σ⁻¹μ`, optionally fractional/normalized).","category":"@insiderfinance/totalfinance/risk/optimize","kind":"interface","keywords":"@insiderfinance/totalfinance interface  covariance mean options options.bounds options.budget options.fraction options.groups options.longOnly options.maximumIterations options.nor @insiderfinance/totalfinance/risk/optimize"},{"title":"KnownDataField","url":"/reference/totalfinance/core/data/page-2#KnownDataField","description":"Only finite canonical SDK schema paths or the explicit financial request fields.","category":"@insiderfinance/totalfinance/core/data","kind":"type","keywords":"@insiderfinance/totalfinance type   @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"LocalVolatilityMonteCarloEstimateInput","url":"/reference/totalfinance/options/local-volatility#LocalVolatilityMonteCarloEstimateInput","description":"Complete, assumption-light inputs for one raw local-volatility Monte-Carlo estimate.","category":"@insiderfinance/totalfinance/options/local-volatility","kind":"interface","keywords":"@insiderfinance/totalfinance interface  dividendYield localVolatility localVolatility(level) localVolatility(timeToExpiryYears) options options.antithetic options.brownianBridge op @insiderfinance/totalfinance/options/local-volatility"},{"title":"LocalVolatilityPriceMonteCarloRequest","url":"/reference/totalfinance/options/local-volatility#LocalVolatilityPriceMonteCarloRequest","description":"One cohesive request for the validated local-volatility Monte-Carlo pricer.","category":"@insiderfinance/totalfinance/options/local-volatility","kind":"interface","keywords":"@insiderfinance/totalfinance interface  input input.dividendYield input.riskFreeRate input.spot input.strike input.timeToExpiryYears localVolatility localVolatility(level) localVol @insiderfinance/totalfinance/options/local-volatility"},{"title":"LocalVolatilitySurfaceInput","url":"/reference/totalfinance/volatility/local-volatility#LocalVolatilitySurfaceInput","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/volatility/local-volatility","kind":"interface","keywords":"@insiderfinance/totalfinance interface  impliedVolatility impliedVolatility(strike) impliedVolatility(timeToExpiryYears) market market.dividendYield market.riskFreeRate market.spot @insiderfinance/totalfinance/volatility/local-volatility"},{"title":"MavpInput","url":"/reference/totalfinance/technical-analysis/statistics#MavpInput","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/technical-analysis/statistics","kind":"interface","keywords":"@insiderfinance/totalfinance interface  parameters parameters.maxPeriod parameters.minPeriod parameters.movingAverageType periods series @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"MaxSharpeInput","url":"/reference/totalfinance/risk/optimize#MaxSharpeInput","description":"Tangency (max-Sharpe) portfolio. `value.objective` is the Sharpe ratio at the solution.","category":"@insiderfinance/totalfinance/risk/optimize","kind":"interface","keywords":"@insiderfinance/totalfinance interface  covariance mean options options.bounds options.budget options.groups options.longOnly options.maximumIterations options.riskFreeRatePerPerio @insiderfinance/totalfinance/risk/optimize"},{"title":"MeanVarianceInput","url":"/reference/totalfinance/risk/optimize#MeanVarianceInput","description":"Mean-variance utility portfolio (`μᵀw − λ/2·wᵀΣw`). `value.objective` is the utility.","category":"@insiderfinance/totalfinance/risk/optimize","kind":"interface","keywords":"@insiderfinance/totalfinance interface  covariance mean options options.bounds options.budget options.groups options.longOnly options.maximumIterations options.riskAversion options @insiderfinance/totalfinance/risk/optimize"},{"title":"MonteCarloPortfolioVaRInput","url":"/reference/totalfinance/risk/page-5#MonteCarloPortfolioVaRInput","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance interface  covariance options options.confidence options.horizonPeriods options.mean options.samples options.seed weights @insiderfinance/totalfinance/risk @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"OHLCField","url":"/reference/totalfinance/core/data/page-2#OHLCField","description":"type from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"type","keywords":"@insiderfinance/totalfinance type   @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"ObservationTimes","url":"/reference/totalfinance/core/data/page-2#ObservationTimes","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  availableTimestampMs observedTimestampMs sourceStoredTimestampMs @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"OhlcvInput","url":"/reference/totalfinance/core/data/page-2#OhlcvInput","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  close high low open volume @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"OpeningRangeParameters","url":"/reference/totalfinance/technical-analysis/price-action/page-2#OpeningRangeParameters","description":"The opening-range knobs: `periods` is the number of leading bars that define the range.","category":"@insiderfinance/totalfinance/technical-analysis/price-action","kind":"interface","keywords":"@insiderfinance/totalfinance interface  periods @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"OptionChainResearchQuery","url":"/reference/totalfinance/core/data/page-2#OptionChainResearchQuery","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  expirationFrom expirationTo kind maxStrike minStrike rights snapshot snapshot.kind snapshot.sessionDate snapshot.snapshotId symbol @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"OptionChainResearchRecord","url":"/reference/totalfinance/core/data/page-2#OptionChainResearchRecord","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  diagnostics diagnostics.autoReason diagnostics.converged diagnostics.decomposition diagnostics.engine diagnostics.finiteDifferenceBumps diag @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"OptionChainResearchView","url":"/reference/totalfinance/core/data/page-2#OptionChainResearchView","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  continuation continuation.binding continuation.binding.provider continuation.binding.provider.id continuation.binding.provider.version conti @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"OptionResearchTerms","url":"/reference/totalfinance/core/data/page-2#OptionResearchTerms","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  currency expiresAt expiry multiplier occSymbol root settlement strike style termsStatus type underlying @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"ParametricPortfolioVaRInput","url":"/reference/totalfinance/risk/page-5#ParametricPortfolioVaRInput","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance interface  covariance options options.confidence options.horizonPeriods options.mean weights @insiderfinance/totalfinance/risk @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"PriceBarRecord","url":"/reference/totalfinance/core/data/page-2#PriceBarRecord","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  bar bar.adjusted bar.close bar.high bar.low bar.open bar.symbol bar.timestampMs bar.volume bar.vwap diagnostics diagnostics.autoReason diagn @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"PriceBarsCheckpoint","url":"/reference/totalfinance/core/data/page-2#PriceBarsCheckpoint","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  binding binding.provider binding.provider.id binding.provider.version binding.query binding.query.expirationFrom binding.query.expirationTo  @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"PriceBarsPageFacts","url":"/reference/totalfinance/core/data/page-2#PriceBarsPageFacts","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  access adjustment consistency coverage coverage.end coverage.start coverage.status dataset dataset.id dataset.version freshness freshness.co @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"PriceBarsPaging","url":"/reference/totalfinance/core/data/page-2#PriceBarsPaging","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  requested requested.mode requested.size state state.effectiveSize state.status @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"PriceBarsQuery","url":"/reference/totalfinance/core/data/page-2#PriceBarsQuery","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  from interval kind symbol to @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"PriceBarsSelections","url":"/reference/totalfinance/core/data/page-3#PriceBarsSelections","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  bars closePrices issues ohlcvBars selection selection.decisions selection.sourceRows selection.version selections @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"PriceBarsView","url":"/reference/totalfinance/core/data/page-3#PriceBarsView","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  bars closePrices continuation continuation.binding continuation.binding.provider continuation.binding.provider.id continuation.binding.provi @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"PriceBarsWindow","url":"/reference/totalfinance/core/data/page-3#PriceBarsWindow","description":"type from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"type","keywords":"@insiderfinance/totalfinance type  binding binding.provider binding.provider.id binding.provider.version binding.query binding.query.expirationFrom binding.query.expirationTo  @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"PriceBarsWindowOptions","url":"/reference/totalfinance/core/data/page-3#PriceBarsWindowOptions","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  maxPages maxReads maxRecords pageSize signal @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"PriceBarsWindowRequest","url":"/reference/totalfinance/core/data/page-3#PriceBarsWindowRequest","description":"Financial query without the source protocol discriminator.","category":"@insiderfinance/totalfinance/core/data","kind":"type","keywords":"@insiderfinance/totalfinance type  from interval symbol to @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"PriceBarsWindowView","url":"/reference/totalfinance/core/data/page-3#PriceBarsWindowView","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  bars closePrices issues kind ohlcvBars resolve resolve(choice) resolve(choice).action resolve(choice).corrections resolve(choice).reason res @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"RealizedImpliedInput","url":"/reference/totalfinance/volatility/event#RealizedImpliedInput","description":"Realized-vs-implied spread: `impliedVolatility − realizedVolatility` in volatility points (positive ⇒\nvol premium). BOTH inputs are ANNUALIZED decimals (0.20 = ","category":"@insiderfinance/totalfinance/volatility/event","kind":"interface","keywords":"@insiderfinance/totalfinance interface  impliedVolatility realizedVolatility @insiderfinance/totalfinance/volatility/event"},{"title":"ResearchBarChoice","url":"/reference/totalfinance/core/data/page-3#ResearchBarChoice","description":"type from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"type","keywords":"@insiderfinance/totalfinance type  action corrections reason rows @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"ResearchBarIssue","url":"/reference/totalfinance/core/data/page-3#ResearchBarIssue","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  fields pageIndex rowIndex rule @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"ResearchBarSelection","url":"/reference/totalfinance/core/data/page-3#ResearchBarSelection","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  decisions sourceRows version @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"RowReference","url":"/reference/totalfinance/core/data/page-3#RowReference","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  pageIndex rowIndex @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"SabrBartlettGreeksInput","url":"/reference/totalfinance/volatility/sabr-delta#SabrBartlettGreeksInput","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/volatility/sabr-delta","kind":"interface","keywords":"@insiderfinance/totalfinance interface  input input.dividendYield input.forward input.riskFreeRate input.spot input.strike input.timeToExpiryYears options options.volatilityType pa @insiderfinance/totalfinance/volatility/sabr-delta"},{"title":"SabrMonteCarloEstimateInput","url":"/reference/totalfinance/options/sabr#SabrMonteCarloEstimateInput","description":"Complete, assumption-light inputs for one raw SABR Monte-Carlo estimate.","category":"@insiderfinance/totalfinance/options/sabr","kind":"interface","keywords":"@insiderfinance/totalfinance interface  forward options options.antithetic options.brownianBridge options.confidence options.method options.paths options.randomNumberGenerator opti @insiderfinance/totalfinance/options/sabr"},{"title":"SabrPriceMonteCarloRequest","url":"/reference/totalfinance/options/sabr#SabrPriceMonteCarloRequest","description":"One cohesive request for the validated SABR Monte-Carlo pricer.","category":"@insiderfinance/totalfinance/options/sabr","kind":"interface","keywords":"@insiderfinance/totalfinance interface  input input.dividendYield input.forward input.riskFreeRate input.spot input.strike input.timeToExpiryYears options options.antithetic option @insiderfinance/totalfinance/options/sabr"},{"title":"SabrPriceRequest","url":"/reference/totalfinance/options/sabr#SabrPriceRequest","description":"One cohesive request for the validated Hagan SABR pricer.","category":"@insiderfinance/totalfinance/options/sabr","kind":"interface","keywords":"@insiderfinance/totalfinance interface  input input.dividendYield input.forward input.riskFreeRate input.spot input.strike input.timeToExpiryYears options options.extendedGreeks op @insiderfinance/totalfinance/options/sabr"},{"title":"SabrVolatilityRequest","url":"/reference/totalfinance/options/sabr#SabrVolatilityRequest","description":"One cohesive request for a Hagan SABR volatility evaluation.","category":"@insiderfinance/totalfinance/options/sabr","kind":"interface","keywords":"@insiderfinance/totalfinance interface  input input.forward input.strike input.timeToExpiryYears options options.volatilityType parameters parameters.alpha parameters.beta paramete @insiderfinance/totalfinance/options/sabr"},{"title":"ScenarioGridInput","url":"/reference/totalfinance/risk/scenario#ScenarioGridInput","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/risk/scenario","kind":"interface","keywords":"@insiderfinance/totalfinance interface  greeks greeks.charm greeks.color greeks.delta greeks.deltaRate greeks.gamma greeks.lambda greeks.phi greeks.rho greeks.rhoConvexity greeks.s @insiderfinance/totalfinance/risk/scenario"},{"title":"SchemaCheckContext","url":"/reference/totalfinance/core/schema/page-2#SchemaCheckContext","description":"The validation context threaded through every schema's `_check` — exported so a consumer\nsubclassing {@link Schema} can NAME the parameter of the method they mu","category":"@insiderfinance/totalfinance/core/schema","kind":"interface","keywords":"@insiderfinance/totalfinance interface  mode path @insiderfinance/totalfinance/core/schema"},{"title":"SkewInput","url":"/reference/totalfinance/volatility/skew#SkewInput","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/volatility/skew","kind":"interface","keywords":"@insiderfinance/totalfinance interface  config config.expiry config.model config.priceSource config.riskReversalConvention market market.asOf market.dividendYield market.riskFreeRa @insiderfinance/totalfinance/volatility/skew"},{"title":"SourceOptionChainPage","url":"/reference/totalfinance/core/data/page-3#SourceOptionChainPage","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  data diagnostics diagnostics.autoReason diagnostics.converged diagnostics.decomposition diagnostics.engine diagnostics.finiteDifferenceBumps @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"SourcePriceBarRecord","url":"/reference/totalfinance/core/data/page-3#SourcePriceBarRecord","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  bar bar.adjusted bar.close bar.high bar.low bar.open bar.timestampMs bar.volume bar.vwap diagnostics diagnostics.autoReason diagnostics.conv @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"SourcePriceBarsPage","url":"/reference/totalfinance/core/data/page-3#SourcePriceBarsPage","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"interface","keywords":"@insiderfinance/totalfinance interface  data diagnostics diagnostics.autoReason diagnostics.converged diagnostics.decomposition diagnostics.engine diagnostics.finiteDifferenceBumps @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"SurfaceLocalVolatilityInput","url":"/reference/totalfinance/volatility/local-volatility#SurfaceLocalVolatilityInput","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/volatility/local-volatility","kind":"interface","keywords":"@insiderfinance/totalfinance interface  market market.dividendYield market.riskFreeRate market.spot options options.floorVolatility options.logMoneynessStep options.timeStepYears s @insiderfinance/totalfinance/volatility/local-volatility"},{"title":"TimestampedOhlcvInput","url":"/reference/totalfinance/core/data/page-3#TimestampedOhlcvInput","description":"type from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/core/data","kind":"type","keywords":"@insiderfinance/totalfinance type  adjusted close high low open symbol timestampMs volume vwap @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"VolatilitySurfaceInput","url":"/reference/totalfinance/volatility/surface#VolatilitySurfaceInput","description":"interface from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/volatility/surface","kind":"interface","keywords":"@insiderfinance/totalfinance interface  config config.cosineExpansionTerms config.essviPhi config.essviWeight config.hestonInitialParameters config.hestonInitialParameters.kappa co @insiderfinance/totalfinance/volatility/surface"},{"title":"backtest","url":"/reference/totalfinance/page-5#backtest","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  BENCHMARK_FIXTURE_VERSION SimulatedBroker SimulatedBroker().return.cancel SimulatedBroker().return.cash SimulatedBroker().return.equity Simu"},{"title":"blackScholes","url":"/reference/totalfinance/options/page-10#blackScholes","description":"The Black–Scholes facade namespace. Flat object arguments in, plain values out; `.explain()` on\neach function returns the assumptions/diagnostics envelope.","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance value ```ts\nimport { blackScholes } from '@insiderfinance/totalfinance/options';\n\nblackScholes.price({ spo call call(input) call(input).dividendYield call(input).riskFreeRate call(input).spot call(input).strike call(input).timeToExpiryYears call(i @insiderfinance/totalfinance/options/black-scholes"},{"title":"calendars","url":"/reference/totalfinance/page-5#calendars","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  CALENDAR_DATA_VERSION CBOE CBOE.addBusinessDays CBOE.addBusinessDays(date) CBOE.addBusinessDays(days) CBOE.businessDaysBetween CBOE.business"},{"title":"commodities","url":"/reference/totalfinance/page-5#commodities","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  calendarSpread calendarSpread().return.annualizedSpreadRate calendarSpread().return.assumptions calendarSpread().return.assumptions.annualiz"},{"title":"connect","url":"/reference/totalfinance/core/data/page-3#connect","description":"Bind only protocol2 sources. Construction performs no discovery or network work.","category":"@insiderfinance/totalfinance/core/data","kind":"function","keywords":"@insiderfinance/totalfinance function  (options) (options).maxPages (options).maxReads (options).maxRecords (options).pageSize (source) (source).capabilities (source).contractVers @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"core","url":"/reference/totalfinance/page-5#core","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  ArbitrageError ArbitrageError().return.code ArbitrageError().return.context ArbitrageError().return.toJSON ArbitrageError(message) Arbitrage"},{"title":"createPriceBarsWindowView","url":"/reference/totalfinance/core/data/page-3#createPriceBarsWindowView","description":"Restore full terminal state and explicit research choices; no source calls or clocks.","category":"@insiderfinance/totalfinance/core/data","kind":"function","keywords":"@insiderfinance/totalfinance function  (input) (selection) return.bars return.closePrices return.issues return.kind return.ohlcvBars return.resolve return.selection return.selecti @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"crypto","url":"/reference/totalfinance/page-6#crypto","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  carryCurve carryCurve().return.assumptions carryCurve().return.diagnostics carryCurve().return.provenance carryCurve().return.value carryCur"},{"title":"data","url":"/reference/totalfinance/page-6#data","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  connect connect().return.capabilities connect().return.contractVersion connect().return.id connect().return.priceBars connect().return.query"},{"title":"engines","url":"/reference/totalfinance/options/page-10#engines","description":"Built-in pricing engines (analytical, lattice, closed-form American approximations, and FDM) —\nevery factory returns an {@link OptionPricingEngine} usable where","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance value ```ts\nimport { engines, market, option } from '@insiderfinance/totalfinance/options';\n\nconst contrac auto auto().return.capabilities auto().return.capabilities.deterministic auto().return.capabilities.dividends auto().return.capabilities.ext"},{"title":"fixedIncome","url":"/reference/totalfinance/page-6#fixedIncome","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  addMonths addMonths(date) addMonths(endOfMonth) addMonths(months) adjustDate adjustDate(calendar) adjustDate(calendar).addBusinessDays adjus"},{"title":"foreignExchange","url":"/reference/totalfinance/page-6#foreignExchange","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  HEDGED_PROFIT_AND_LOSS_DECOMPOSITION convertCurrency convertCurrency().return.assumptions convertCurrency().return.assumptions.fromCurrency "},{"title":"fundamentals","url":"/reference/totalfinance/page-6#fundamentals","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  accrualRatio accrualRatio(input) accrualRatio(input).current accrualRatio(input).prior accrualRatio.explain accrualRatio.explain().return.as"},{"title":"impliedVolatility","url":"/reference/totalfinance/options/page-11#impliedVolatility","description":"Solve BSM implied volatility with the chosen method, reporting rich diagnostics — quantitative\nfailure (price outside no-arbitrage bounds, no convergence) repor","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance function ```ts\nimport { impliedVolatility } from '@insiderfinance/totalfinance/options';\n\nconst solved = impl (input) (input).dividendYield (input).price (input).riskFreeRate (input).spot (input).strike (input).timeToExpiryYears (input).type (options"},{"title":"market","url":"/reference/totalfinance/options/page-11#market","description":"function from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance function  (input) (input).asOf (input).dividendYield (input).dividends (input).forward (input).price (input).riskFreeRate (input).spot (input).volatil @insiderfinance/totalfinance/options"},{"title":"math","url":"/reference/totalfinance/page-6#math","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  SOBOL_MAX_DIMENSIONS acf acf(maxLag) acf(series) adaptiveSimpson adaptiveSimpson(integrand) adaptiveSimpson(lowerBound) adaptiveSimpson(opti"},{"title":"option","url":"/reference/totalfinance/options/page-11#option","description":"The `option` namespace combines contract builders with pro pricing:\n  - `option.call(...)` / `option.put(...)` build contracts,\n  - `option.price({ contract, ma","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance value ```ts\nimport { market, option } from '@insiderfinance/totalfinance/options';\n\nconst contract = optio call call().return.adjusted call().return.currency call().return.deliverable call().return.exerciseTime call().return.expiresAt call().retur"},{"title":"options","url":"/reference/totalfinance/page-6#options","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  BlackScholesImpliedVolatilityInputSchema BlackScholesImpliedVolatilityInputSchema._check BlackScholesImpliedVolatilityInputSchema._check().r"},{"title":"performance","url":"/reference/totalfinance/page-6#performance","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  alpha alpha(callArguments) alpha.explain alpha.explain().return.assumptions alpha.explain().return.diagnostics alpha.explain().return.proven"},{"title":"portfolio","url":"/reference/totalfinance/page-6#portfolio","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  MODEL_PORTFOLIO_KIND MODEL_PORTFOLIO_SCHEMA_VERSION MONITOR_ALERT_FAMILIES MONITOR_LIQUIDITY_PARTICIPATION_RATE NORMALIZED_FILL_KEYS PORTFOL"},{"title":"priceBarsCheckpoint","url":"/reference/totalfinance/core/data/page-3#priceBarsCheckpoint","description":"Explicit accessor; serialized public errors never contain licensed pages or cursors.","category":"@insiderfinance/totalfinance/core/data","kind":"function","keywords":"@insiderfinance/totalfinance function  (error) return.binding return.bytes return.contractVersion return.kind return.limits return.limits.maxPages return.limits.maxReads return.li @insiderfinance/totalfinance/core/data @insiderfinance/totalfinance/data"},{"title":"research","url":"/reference/totalfinance/page-6#research","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  CANONICAL_FACTOR_RECIPES aggregateEventStudies aggregateEventStudies().return.assumptions aggregateEventStudies().return.averageAbnormalRetu"},{"title":"risk","url":"/reference/totalfinance/page-6#risk","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  adjustPValues adjustPValues().return.adjusted adjustPValues().return.alpha adjustPValues().return.method adjustPValues().return.rejected adj"},{"title":"scenarios","url":"/reference/totalfinance/page-6#scenarios","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  runScenarios runScenarios().return.aggregates runScenarios().return.aggregates.base runScenarios().return.aggregates.scenarios runScenarios("},{"title":"strategy","url":"/reference/totalfinance/page-6#strategy","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  Position Position().return.assumptions Position().return.chartData Position().return.constructedAs Position().return.legs Position().return."},{"title":"structure","url":"/reference/totalfinance/page-6#structure","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  ExposureProfile ExposureProfile().return.aggregate ExposureProfile().return.assumptions ExposureProfile().return.atSpot ExposureProfile().re"},{"title":"technicalAnalysis","url":"/reference/totalfinance/page-6#technicalAnalysis","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  ALIAS_TABLE BarAggregator BarAggregator().return.flush BarAggregator().return.next BarAggregator().return.restore BarAggregator().return.toJ"},{"title":"valuation","url":"/reference/totalfinance/page-7#valuation","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  adjustedPresentValue adjustedPresentValue().return.adjustedPresentValue adjustedPresentValue().return.assumptions adjustedPresentValue().ret"},{"title":"volatility","url":"/reference/totalfinance/page-7#volatility","description":"namespace from @insiderfinance/totalfinance","category":"@insiderfinance/totalfinance","kind":"namespace","keywords":"@insiderfinance/totalfinance namespace  RISK_NEUTRAL_ESTIMATE RISK_NEUTRAL_ESTIMATE.code RISK_NEUTRAL_ESTIMATE.context RISK_NEUTRAL_ESTIMATE.message RISK_NEUTRAL_ESTIMATE.severity "},{"title":"McpServerOptions","url":"/reference/mcp#McpServerOptions","description":"interface from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"interface","keywords":"@insiderfinance/totalfinance-mcp interface  artifacts artifacts.get artifacts.get().return.handle artifacts.get().return.value artifacts.get(uri) artifacts.list artifacts.list(filter) "},{"title":"ToolPack","url":"/reference/mcp#ToolPack","description":"interface from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"interface","keywords":"@insiderfinance/totalfinance-mcp interface  name tools"},{"title":"ToolResult","url":"/reference/mcp#ToolResult","description":"interface from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"interface","keywords":"@insiderfinance/totalfinance-mcp interface  structured summary"},{"title":"TotalFinanceTool","url":"/reference/mcp#TotalFinanceTool","description":"interface from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"interface","keywords":"@insiderfinance/totalfinance-mcp interface  description mutates name outputSchema outputSchema.$id outputSchema.$schema outputSchema.additionalProperties outputSchema.additionalPropert"},{"title":"analysisTools","url":"/reference/mcp#analysisTools","description":"The analysis-role tools beyond the compute defaults, as MCP tools.","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  "},{"title":"artifactPack","url":"/reference/mcp#artifactPack","description":"function from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  return.name return.tools"},{"title":"backtestPack","url":"/reference/mcp#backtestPack","description":"The opt-in backtest pack (payload/runtime heavy — deliberately not a default).","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  return.name return.tools"},{"title":"calendarPack","url":"/reference/mcp#calendarPack","description":"function from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  return.name return.tools"},{"title":"createTotalFinanceMcpServer","url":"/reference/mcp#createTotalFinanceMcpServer","description":"Build (but do not connect) a TotalFinance MCP server.","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  (options) (options).artifacts (options).capabilities (options).clock (options).deadlineMs (options).defaultSeed (options).jobs (options).max"},{"title":"cryptoPack","url":"/reference/mcp#cryptoPack","description":"function from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  return.name return.tools"},{"title":"defaultPacks","url":"/reference/mcp#defaultPacks","description":"The ten domain packs that make up the default read-only server, in tool-list order.","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  "},{"title":"defaultTools","url":"/reference/mcp#defaultTools","description":"The default read-only tool set — every domain pack flattened (dx §WS-5).","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  "},{"title":"defineTool","url":"/reference/mcp#defineTool","description":"Define a caller's own tool (the escape hatch for a custom server); validated on every run.","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  (definition) (definition).description (definition).mutates (definition).name (definition).outputSchema (definition).run (definition).schema "},{"title":"fixedIncomePack","url":"/reference/mcp#fixedIncomePack","description":"function from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  return.name return.tools"},{"title":"journeyPacks","url":"/reference/mcp#journeyPacks","description":"The five journey packs as tool packs (the valuation pack joined in Stage 4.7): `createTotalFinanceMcpServer({ packs: [...defaultPacks(), ...journeyPacks()] })`.","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  "},{"title":"optionsPack","url":"/reference/mcp#optionsPack","description":"function from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  return.name return.tools"},{"title":"performancePack","url":"/reference/mcp#performancePack","description":"function from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  return.name return.tools"},{"title":"portfolioPack","url":"/reference/mcp#portfolioPack","description":"function from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  return.name return.tools"},{"title":"researchPack","url":"/reference/mcp#researchPack","description":"function from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  return.name return.tools"},{"title":"riskPack","url":"/reference/mcp#riskPack","description":"function from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  return.name return.tools"},{"title":"scenarioPack","url":"/reference/mcp/page-2#scenarioPack","description":"function from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  return.name return.tools"},{"title":"strategyPack","url":"/reference/mcp/page-2#strategyPack","description":"function from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  return.name return.tools"},{"title":"structurePack","url":"/reference/mcp/page-2#structurePack","description":"function from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  return.name return.tools"},{"title":"technicalAnalysisPack","url":"/reference/mcp/page-2#technicalAnalysisPack","description":"function from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  return.name return.tools"},{"title":"toolFromOperation","url":"/reference/mcp/page-2#toolFromOperation","description":"Render a registry operation as an MCP tool — the shipped tools are exactly these.","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  (operation) (operation).authorization (operation).costClass (operation).description (operation).deterministic (operation).handleFields (oper"},{"title":"toolNameFor","url":"/reference/mcp/page-2#toolNameFor","description":"The MCP tool name of an operation: the dotted operation id with every dot replaced by an\nunderscore (`totalfinance.option.price` → `totalfinance_option_price`).","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  (operationId)"},{"title":"valuationPack","url":"/reference/mcp/page-2#valuationPack","description":"The company-valuation journey pack (Stage 4.7 slice 2): `totalfinance.valuation.company`.","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  return.name return.tools"},{"title":"volatilityPack","url":"/reference/mcp/page-2#volatilityPack","description":"function from @insiderfinance/totalfinance-mcp","category":"@insiderfinance/totalfinance-mcp","kind":"function","keywords":"@insiderfinance/totalfinance-mcp function  return.name return.tools"},{"title":"AgentBenchReport","url":"/reference/totalfinance/backtest#AgentBenchReport","description":"Operational conformance and strategy quality, reported separately — no single score by design.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  assumptions assumptions.dimensions assumptions.episodes assumptions.leakageProbe assumptions.retrySuite assumptions.runs assumptions.seeds d @insiderfinance/totalfinance/backtest/environment"},{"title":"AgentTranscriptScore","url":"/reference/totalfinance/backtest#AgentTranscriptScore","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  argumentValidity assumptions assumptions.deterministic assumptions.scoring bytes calls diagnostics diagnostics.autoReason diagnostics.conver @insiderfinance/totalfinance/backtest/environment"},{"title":"AttributionReport","url":"/reference/totalfinance/backtest#AttributionReport","description":"{@link attribution} as a report: per-symbol rows carrying `assumptions` + `diagnostics` inline.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  assumptions assumptions.conventionsVersion bySymbol diagnostics diagnostics.warnings @insiderfinance/totalfinance/backtest/tearsheet"},{"title":"AttributionRow","url":"/reference/totalfinance/backtest#AttributionRow","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  breadth coverage informationCoefficient rankInformationCoefficient rebalanceIndex selectionTurnover sessionDate spreadReturn @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"BENCHMARK_FIXTURE_VERSION","url":"/reference/totalfinance/backtest#BENCHMARK_FIXTURE_VERSION","description":"Version tag of the golden benchmark fixtures the engines are validated against (spec §16.3).","category":"@insiderfinance/totalfinance/backtest","kind":"value","keywords":"@insiderfinance/totalfinance/backtest value  "},{"title":"BacktestAssumptions","url":"/reference/totalfinance/backtest#BacktestAssumptions","description":"The modelling assumptions a backtest makes, echoed on every result's `assumptions` slot so they are\nnever hidden (spec §16.3 / dx §2.5). Each policy is a short,","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  assignment calendar cashSettlement conventionsVersion corporateAction cost fill initialCapital margin oco slippage"},{"title":"BacktestResult","url":"/reference/totalfinance/backtest#BacktestResult","description":"The common result shape returned by both engines.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  assumptions assumptions.assignment assumptions.calendar assumptions.cashSettlement assumptions.conventionsVersion assumptions.corporateActio"},{"title":"Bar","url":"/reference/totalfinance/backtest#Bar","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  adjusted close high low open symbol timestampMs volume vwap @insiderfinance/totalfinance/core"},{"title":"BarField","url":"/reference/totalfinance/backtest#BarField","description":"Field of a bar to feed an indicator, or a custom extractor.","category":"@insiderfinance/totalfinance/backtest","kind":"type","keywords":"@insiderfinance/totalfinance/backtest type   @insiderfinance/totalfinance/backtest/event-driven"},{"title":"BenchmarkComparison","url":"/reference/totalfinance/backtest#BenchmarkComparison","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  activeReturn alpha beta informationRatio instrumentId returns trackingError @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"BorrowModel","url":"/reference/totalfinance/backtest#BorrowModel","description":"A borrow-fee model for short positions: an annualized financing rate on the short market value.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  annualRate label @insiderfinance/totalfinance/backtest/costs"},{"title":"BrokerConfig","url":"/reference/totalfinance/backtest#BrokerConfig","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  assignment assignmentThreshold borrow borrow.annualRate borrow.label cash commission commission.commission commission.commission(input) comm"},{"title":"CorporateAction","url":"/reference/totalfinance/backtest#CorporateAction","description":"A corporate action effective on a bar.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  dividend split"},{"title":"CostModel","url":"/reference/totalfinance/backtest#CostModel","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  commission commission(input) commission(input).price commission(input).quantity label @insiderfinance/totalfinance/backtest/costs"},{"title":"CrossSectionalAssumptions","url":"/reference/totalfinance/backtest#CrossSectionalAssumptions","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  baseCurrency conventionsVersion costs costs.commission costs.slippage execution execution.ambiguity execution.costs execution.costs.borrow e @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"CrossSectionalAttribution","url":"/reference/totalfinance/backtest#CrossSectionalAttribution","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  decay meanInformationCoefficient meanRankInformationCoefficient meanSpreadReturn perRebalance @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"CrossSectionalBacktestGridRequest","url":"/reference/totalfinance/backtest#CrossSectionalBacktestGridRequest","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  hygiene hygiene.confidence hygiene.splits maximumVariations request request.baseCurrency request.dataset request.dataset.averageDailyVolumes @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"CrossSectionalBacktestGridResult","url":"/reference/totalfinance/backtest#CrossSectionalBacktestGridResult","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  assumptions assumptions.conventionsVersion assumptions.hygiene assumptions.hygiene.confidence assumptions.hygiene.degenerateTrialSharpe assu @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"CrossSectionalBacktestRequest","url":"/reference/totalfinance/backtest#CrossSectionalBacktestRequest","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  baseCurrency dataset dataset.averageDailyVolumes dataset.benchmarkReturns dataset.betas dataset.classification dataset.fieldDefinitions data @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"CrossSectionalBacktestResult","url":"/reference/totalfinance/backtest#CrossSectionalBacktestResult","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  assumptions assumptions.baseCurrency assumptions.conventionsVersion assumptions.costs assumptions.costs.commission assumptions.costs.slippag @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"CrossSectionalDataset","url":"/reference/totalfinance/backtest/page-2#CrossSectionalDataset","description":"The point-in-time inputs a cross-sectional strategy reads. Prices are return-index levels.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  averageDailyVolumes benchmarkReturns betas classification fieldDefinitions groups observations returns sizeField @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"CrossSectionalDiagnostics","url":"/reference/totalfinance/backtest/page-2#CrossSectionalDiagnostics","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  autoReason cappedGoalCount converged decomposition delistingCount engine exitCount fillCount finiteDifferenceBumps iterations method rebalan @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"CrossSectionalOutOfSampleResult","url":"/reference/totalfinance/backtest/page-2#CrossSectionalOutOfSampleResult","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  assumptions assumptions.conventionsVersion assumptions.periodsPerYear assumptions.selectionMetric assumptions.sessionCount assumptions.stitc @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"CrossSectionalPurgedFoldsRequest","url":"/reference/totalfinance/backtest/page-2#CrossSectionalPurgedFoldsRequest","description":"The grid's members inline plus the fold plan (see {@link CrossSectionalWalkForwardRequest}).","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  embargo folds hygiene hygiene.confidence hygiene.splits maximumVariations purgeGap request request.baseCurrency request.dataset request.data @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"CrossSectionalSignal","url":"/reference/totalfinance/backtest/page-2#CrossSectionalSignal","description":"type from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"type","keywords":"@insiderfinance/totalfinance/backtest type  callback callback(context) callback(context).asOf callback(context).eligible callback(context).fieldDefinitions callback(context).held callb @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"CrossSectionalWalkForwardRequest","url":"/reference/totalfinance/backtest/page-2#CrossSectionalWalkForwardRequest","description":"The grid's members inline (`request`, `variations`, `maximumVariations`, `selectionMetric`,\n`hygiene`) plus the walk-forward plan — one object, the same shape a","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  hygiene hygiene.confidence hygiene.splits maximumVariations mode request request.baseCurrency request.dataset request.dataset.averageDailyVo @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"EnvelopeSignal","url":"/reference/totalfinance/backtest/page-2#EnvelopeSignal","description":"A TA explain envelope used directly as a signal: warmup rides in `diagnostics.warmup`.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  diagnostics diagnostics.warmup value"},{"title":"EnvironmentAction","url":"/reference/totalfinance/backtest/page-2#EnvironmentAction","description":"Hold, or submit orders and cancel open ones. `rationale` is recorded, never read.","category":"@insiderfinance/totalfinance/backtest","kind":"type","keywords":"@insiderfinance/totalfinance/backtest type  cancel kind orders rationale @insiderfinance/totalfinance/backtest/environment"},{"title":"EnvironmentEpisode","url":"/reference/totalfinance/backtest/page-2#EnvironmentEpisode","description":"One maintained scenario: a complete definition, its seed, and the expectations its suite asserts.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  definition definition.accounting definition.accounting.baseCurrency definition.accounting.initialCash definition.accounting.lotRelief defini @insiderfinance/totalfinance/backtest/environment"},{"title":"EnvironmentEpisodeInput","url":"/reference/totalfinance/backtest/page-2#EnvironmentEpisodeInput","description":"A recorded episode: the definition, the seed, and the actions in order — the artifact spine's input.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  actions definition definition.accounting definition.accounting.baseCurrency definition.accounting.initialCash definition.accounting.lotRelie @insiderfinance/totalfinance/backtest/environment"},{"title":"EnvironmentEpisodeResult","url":"/reference/totalfinance/backtest/page-2#EnvironmentEpisodeResult","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  assumptions assumptions.conventionsVersion assumptions.executionPolicy assumptions.instantCount assumptions.maximumSteps assumptions.nextObs @insiderfinance/totalfinance/backtest/environment"},{"title":"EnvironmentObservation","url":"/reference/totalfinance/backtest/page-2#EnvironmentObservation","description":"Only what was published at or before `asOf` — the no-leak law (Decision 4).","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  actionMask asOf features features.drawdown features.lookbackReturns features.realizedVolatility freshness index instruments limits limits.br @insiderfinance/totalfinance/backtest/environment"},{"title":"EnvironmentStepResult","url":"/reference/totalfinance/backtest/page-2#EnvironmentStepResult","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  diagnostics diagnostics.acceptedCount diagnostics.cancelledCount diagnostics.carriedCount diagnostics.openOrderCount diagnostics.rationaleTr @insiderfinance/totalfinance/backtest/environment"},{"title":"EquityPoint","url":"/reference/totalfinance/backtest/page-2#EquityPoint","description":"One point on the equity curve: a timestamp paired unambiguously with the portfolio value at that\ninstant (WS2.8). `points[0]` stamps the opening capital at the ","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  equity timestampMs"},{"title":"EventDrivenOptions","url":"/reference/totalfinance/backtest/page-2#EventDrivenOptions","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  broker broker.assignment broker.assignmentThreshold broker.borrow broker.borrow.annualRate broker.borrow.label broker.cancel broker.cancel(i @insiderfinance/totalfinance/backtest/event-driven"},{"title":"ExerciseOptionInput","url":"/reference/totalfinance/backtest/page-2#ExerciseOptionInput","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  quantity symbol timestampMs underlierMarks"},{"title":"GridVariation","url":"/reference/totalfinance/backtest/page-2#GridVariation","description":"One axis of the grid: a dotted path into the request and the values it takes.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  path values @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"GridVariationRow","url":"/reference/totalfinance/backtest/page-2#GridVariationRow","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  index metrics metrics.annualizedReturn metrics.annualizedVolatility metrics.calmar metrics.cappedGoalCount metrics.fillCount metrics.finalVa @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"HoldingReason","url":"/reference/totalfinance/backtest/page-2#HoldingReason","description":"type from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"type","keywords":"@insiderfinance/totalfinance/backtest type   @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"HoldingRow","url":"/reference/totalfinance/backtest/page-2#HoldingRow","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  instrumentId quantity rank reason rebalanceIndex score side weight @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"ImplementationRisk","url":"/reference/totalfinance/backtest/page-3#ImplementationRisk","description":"The implementation-risk diagnostics attached to every {@link BacktestResult} (spec §16.3): core\n{@link Diagnostics} (look-ahead / leakage checks and data-alignm","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  autoReason benchmarkFixtureVersion converged decomposition engine finiteDifferenceBumps iterations method selection selection.candidates sel"},{"title":"Indicator","url":"/reference/totalfinance/backtest/page-3#Indicator","description":"A minimal streaming indicator (structurally compatible with `@insiderfinance/totalfinance/technical-analysis` streams).","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  next next(input) @insiderfinance/totalfinance/backtest/event-driven"},{"title":"IndicatorHandle","url":"/reference/totalfinance/backtest/page-3#IndicatorHandle","description":"A live indicator value the engine refreshes each bar, exposing the current and previous reading.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  previous value @insiderfinance/totalfinance/backtest/event-driven"},{"title":"InstrumentAdapter","url":"/reference/totalfinance/backtest/page-3#InstrumentAdapter","description":"An instrument adapter: how the instrument marks, which lifecycle facts it emits (as FC7 event\nPAYLOADS — the engine envelopes them with ids, the source, and the","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  accrued accrued(input) accrued(input).asOf accrued(input).specification fillTerms fillTerms().return.contract fillTerms().return.contractMul @insiderfinance/totalfinance/backtest/portfolio"},{"title":"InstrumentSpecification","url":"/reference/totalfinance/backtest/page-3#InstrumentSpecification","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  adapter adapter.accrued adapter.accrued(input) adapter.accrued(input).asOf adapter.accrued(input).specification adapter.fillTerms adapter.fi @insiderfinance/totalfinance/backtest/portfolio"},{"title":"MonteCarloResampleReport","url":"/reference/totalfinance/backtest/page-3#MonteCarloResampleReport","description":"{@link monteCarloResample} as a report: the resample stats + `assumptions` + `diagnostics`.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  assumptions assumptions.conventionsVersion confidenceInterval95 diagnostics diagnostics.warnings iterations meanTotalReturn seed standardDev @insiderfinance/totalfinance/backtest/tearsheet"},{"title":"MonteCarloResampleResult","url":"/reference/totalfinance/backtest/page-3#MonteCarloResampleResult","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  confidenceInterval95 iterations meanTotalReturn seed standardDeviation @insiderfinance/totalfinance/backtest/tearsheet"},{"title":"Neutrality","url":"/reference/totalfinance/backtest/page-3#Neutrality","description":"type from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"type","keywords":"@insiderfinance/totalfinance/backtest type   @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"OptionContractSpecification","url":"/reference/totalfinance/backtest/page-3#OptionContractSpecification","description":"Registration of an option symbol so the broker can mark and settle it (spec §16.2).","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  expiresAt multiplier settlement strike style type underlying"},{"title":"OptionSettlement","url":"/reference/totalfinance/backtest/page-3#OptionSettlement","description":"The record of an option position settled at expiry.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  action cashFlow contracts early intrinsic multiplier reason settlement shares strike symbol timestampMs type underlierPrice underlying"},{"title":"OptionSettlementStyle","url":"/reference/totalfinance/backtest/page-3#OptionSettlementStyle","description":"type from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"type","keywords":"@insiderfinance/totalfinance/backtest type  "},{"title":"Order","url":"/reference/totalfinance/backtest/page-3#Order","description":"A live order tracked by the broker.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  filledNotional filledQuantity id limitPrice notional ocoGroup quantity side status stopLoss stopPrice submittedTimestampMs symbol takeProfit"},{"title":"OrderRequest","url":"/reference/totalfinance/backtest/page-3#OrderRequest","description":"A request to trade, passed to {@link SimulatedBroker.submit}. Provide `quantity` *or* `notional`.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  limitPrice notional ocoGroup quantity side stopLoss stopPrice symbol takeProfit timeInForce type"},{"title":"OrderSide","url":"/reference/totalfinance/backtest/page-3#OrderSide","description":"type from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"type","keywords":"@insiderfinance/totalfinance/backtest type   @insiderfinance/totalfinance/backtest/execution @insiderfinance/totalfinance/core @insiderfinance/totalfinance/portfolio @insiderfinance/totalfinance/portfolio/trade"},{"title":"OrderStatus","url":"/reference/totalfinance/backtest/page-3#OrderStatus","description":"Kebab-case like every other enum on the surface (B6).","category":"@insiderfinance/totalfinance/backtest","kind":"type","keywords":"@insiderfinance/totalfinance/backtest type  "},{"title":"OrderType","url":"/reference/totalfinance/backtest/page-3#OrderType","description":"Kebab-case everywhere; a simulator that supports a subset says so at its door.","category":"@insiderfinance/totalfinance/backtest","kind":"type","keywords":"@insiderfinance/totalfinance/backtest type   @insiderfinance/totalfinance/backtest/execution @insiderfinance/totalfinance/core @insiderfinance/totalfinance/portfolio @insiderfinance/totalfinance/portfolio/trade"},{"title":"OutOfSampleAssumptions","url":"/reference/totalfinance/backtest/page-3#OutOfSampleAssumptions","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  conventionsVersion periodsPerYear selectionMetric sessionCount stitching visibility @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"OutOfSampleDiagnostics","url":"/reference/totalfinance/backtest/page-3#OutOfSampleDiagnostics","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  skippedWindowCount warnings @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"OutOfSampleHygiene","url":"/reference/totalfinance/backtest/page-3#OutOfSampleHygiene","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  degradation evaluatedWindowCount meanTestMetric meanTrainMetric negativeTestFraction windowCount @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"OutOfSampleWindowRow","url":"/reference/totalfinance/backtest/page-3#OutOfSampleWindowRow","description":"One out-of-sample window: the choice made on the training span and how it fared on the test span.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  chosen chosen.parameters chosen.trainMetric chosen.variationIndex index test test.fromSessionDate test.fromSessionIndex test.sessionCount te @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"PortfolioBacktestRequest","url":"/reference/totalfinance/backtest/page-4#PortfolioBacktestRequest","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  accounting accounting.baseCurrency accounting.initialCash accounting.lotRelief accounting.settlement calendar execution execution.ambiguity  @insiderfinance/totalfinance/backtest/portfolio"},{"title":"PortfolioBacktestResult","url":"/reference/totalfinance/backtest/page-4#PortfolioBacktestResult","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  assumptions assumptions.baseCurrency assumptions.calendar assumptions.conventionsVersion assumptions.execution assumptions.execution.ambigui @insiderfinance/totalfinance/backtest/portfolio"},{"title":"PortfolioConstruction","url":"/reference/totalfinance/backtest/page-4#PortfolioConstruction","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  long long.count long.fraction long.topQuantile maximumParticipation maximumPositionWeight maximumPositions maximumTurnover method minimumPos @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"PortfolioStepFrame","url":"/reference/totalfinance/backtest/page-4#PortfolioStepFrame","description":"The rows one closed instant appended (Stage 7B.1): what the step did, in the engine's own grammar.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  asOf events fills index liquidations netAssetValue orders rejections warnings @insiderfinance/totalfinance/backtest/portfolio"},{"title":"PortfolioStepper","url":"/reference/totalfinance/backtest/page-4#PortfolioStepper","description":"`portfolioBacktest`'s loop driven from outside (Stage 7B.1, Decision 2).","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  close close().return.asOf close().return.events close().return.fills close().return.index close().return.liquidations close().return.netAsse @insiderfinance/totalfinance/backtest/portfolio"},{"title":"PortfolioStepperRequest","url":"/reference/totalfinance/backtest/page-4#PortfolioStepperRequest","description":"Everything a run needs except who decides the orders — the stepper's request (Stage 7B.1).","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  accounting accounting.baseCurrency accounting.initialCash accounting.lotRelief accounting.settlement calendar execution execution.ambiguity  @insiderfinance/totalfinance/backtest/portfolio"},{"title":"Position","url":"/reference/totalfinance/backtest/page-4#Position","description":"An open position snapshot.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  averagePrice quantity symbol"},{"title":"RebalanceFrequency","url":"/reference/totalfinance/backtest/page-4#RebalanceFrequency","description":"type from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"type","keywords":"@insiderfinance/totalfinance/backtest type   @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"RebalanceGoal","url":"/reference/totalfinance/backtest/page-4#RebalanceGoal","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  detail goal status @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"RebalanceRow","url":"/reference/totalfinance/backtest/page-4#RebalanceRow","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  asOf costs eligibleCount exits goals longCount memberCount netAssetValue rebalanceIndex scoredCount sessionDate shortCount turnover @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"RebalanceRule","url":"/reference/totalfinance/backtest/page-4#RebalanceRule","description":"Rebalance calendar: every bar, on a date/week/month boundary, or every `N` bars.","category":"@insiderfinance/totalfinance/backtest","kind":"type","keywords":"@insiderfinance/totalfinance/backtest type   @insiderfinance/totalfinance/backtest/vectorized"},{"title":"RebalanceSchedule","url":"/reference/totalfinance/backtest/page-4#RebalanceSchedule","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  bufferBand frequency session @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"ReturnStatistics","url":"/reference/totalfinance/backtest/page-4#ReturnStatistics","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  averageLoss averageWin bestPeriod expectancy hitRate profitFactor worstPeriod @insiderfinance/totalfinance/backtest/tearsheet"},{"title":"ReturnStatisticsReport","url":"/reference/totalfinance/backtest/page-4#ReturnStatisticsReport","description":"{@link returnStatistics} as a report: the stats carrying `assumptions` + `diagnostics` inline.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  assumptions assumptions.conventionsVersion averageLoss averageWin bestPeriod diagnostics diagnostics.warnings expectancy hitRate profitFacto @insiderfinance/totalfinance/backtest/tearsheet"},{"title":"SeriesSignal","url":"/reference/totalfinance/backtest/page-4#SeriesSignal","description":"A warmup-aware signal: `{ value, warmup }` hand-built, or any `technicalAnalysis.*.explain(...)` envelope\n(`{ value, diagnostics: { warmup } }`) — `vectorized` ","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  value warmup"},{"title":"SessionSpan","url":"/reference/totalfinance/backtest/page-4#SessionSpan","description":"A contiguous run of dataset sessions, inclusive on both ends, in session-index space.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  fromSessionDate fromSessionIndex sessionCount toSessionDate toSessionIndex @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"ShortSideSelection","url":"/reference/totalfinance/backtest/page-4#ShortSideSelection","description":"type from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"type","keywords":"@insiderfinance/totalfinance/backtest type  bottomQuantile count fraction @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"SideSelection","url":"/reference/totalfinance/backtest/page-4#SideSelection","description":"type from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"type","keywords":"@insiderfinance/totalfinance/backtest type  count fraction topQuantile @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"SignalContext","url":"/reference/totalfinance/backtest/page-4#SignalContext","description":"What a direct callback signal sees at a decision instant.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  asOf eligible fieldDefinitions held members sessionDate @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"SignalRow","url":"/reference/totalfinance/backtest/page-4#SignalRow","description":"One scored name a signal produced at a decision instant; higher is better.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  instrumentId score @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"SimulatedBroker","url":"/reference/totalfinance/backtest/page-5#SimulatedBroker","description":"A deterministic simulated broker.","category":"@insiderfinance/totalfinance/backtest","kind":"class","keywords":"@insiderfinance/totalfinance/backtest class  (config) (config).assignment (config).assignmentThreshold (config).borrow (config).cash (config).commission (config).maxLeverage (config).ma"},{"title":"SlippageModel","url":"/reference/totalfinance/backtest/page-5#SlippageModel","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  fill fill(input) fill(input).quantity fill(input).referencePrice fill(input).side label @insiderfinance/totalfinance/backtest/costs"},{"title":"StrategyContext","url":"/reference/totalfinance/backtest/page-5#StrategyContext","description":"The strategy's view of the world on the current bar.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  bar bar.adjusted bar.close bar.high bar.low bar.open bar.symbol bar.timestampMs bar.volume bar.vwap buy buy(options) buy(options).limitPrice @insiderfinance/totalfinance/backtest/event-driven"},{"title":"SymbolAttribution","url":"/reference/totalfinance/backtest/page-5#SymbolAttribution","description":"Realized P&L (and costs) attributed to one symbol.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  commission realizedPnl slippage symbol tradedNotional @insiderfinance/totalfinance/backtest/tearsheet"},{"title":"TearSheet","url":"/reference/totalfinance/backtest/page-5#TearSheet","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  assumptions assumptions.assignment assumptions.calendar assumptions.cashSettlement assumptions.conventionsVersion assumptions.corporateActio @insiderfinance/totalfinance/backtest/tearsheet"},{"title":"TearSheetOptions","url":"/reference/totalfinance/backtest/page-5#TearSheetOptions","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  monteCarlo monteCarlo.iterations monteCarlo.seed @insiderfinance/totalfinance/backtest/tearsheet"},{"title":"TimeInForce","url":"/reference/totalfinance/backtest/page-5#TimeInForce","description":"type from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"type","keywords":"@insiderfinance/totalfinance/backtest type   @insiderfinance/totalfinance/backtest/execution @insiderfinance/totalfinance/core @insiderfinance/totalfinance/portfolio @insiderfinance/totalfinance/portfolio/trade"},{"title":"Trade","url":"/reference/totalfinance/backtest/page-5#Trade","description":"A filled trade. `quantity` is always positive; `side` carries the direction (core `OrderSide`, B6).","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  commission multiplier price quantity side slippage symbol timestampMs"},{"title":"TradeOptions","url":"/reference/totalfinance/backtest/page-5#TradeOptions","description":"Sizing + order parameters for `context.buy` / `context.sell`.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  limitPrice percent quantity stopLoss stopPrice takeProfit timeInForce type value @insiderfinance/totalfinance/backtest/event-driven"},{"title":"TradeStatistics","url":"/reference/totalfinance/backtest/page-5#TradeStatistics","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  count totalCommission totalSlippage turnover @insiderfinance/totalfinance/backtest/tearsheet"},{"title":"TradingEnvironment","url":"/reference/totalfinance/backtest/page-5#TradingEnvironment","description":"The familiar `reset` / `step` contract over the frozen simulator.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  definitionHash finish finish().return.assumptions finish().return.diagnostics finish().return.events finish().return.fills finish().return.f @insiderfinance/totalfinance/backtest/environment"},{"title":"TradingEnvironmentDefinition","url":"/reference/totalfinance/backtest/page-5#TradingEnvironmentDefinition","description":"What an environment simulates: the stepper's request plus the episode bound, the limits, the reward, the features.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  accounting accounting.baseCurrency accounting.initialCash accounting.lotRelief accounting.settlement calendar execution execution.ambiguity  @insiderfinance/totalfinance/backtest/environment"},{"title":"VectorizedOptions","url":"/reference/totalfinance/backtest/page-5#VectorizedOptions","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  borrow borrow.annualRate borrow.label data executionLag fees fees.commission fees.commission(input) fees.commission(input).price fees.commis @insiderfinance/totalfinance/backtest/vectorized"},{"title":"WalkForwardOptions","url":"/reference/totalfinance/backtest/page-5#WalkForwardOptions","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  data mode periodsPerYear run run().return.assumptions run().return.diagnostics run().return.finalValue run().return.performance run().return"},{"title":"WalkForwardResult","url":"/reference/totalfinance/backtest/page-5#WalkForwardResult","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  assumptions assumptions.assignment assumptions.calendar assumptions.cashSettlement assumptions.conventionsVersion assumptions.corporateActio"},{"title":"WalkForwardWindow","url":"/reference/totalfinance/backtest/page-5#WalkForwardWindow","description":"interface from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  test train"},{"title":"WalkForwardWindowResult","url":"/reference/totalfinance/backtest/page-5#WalkForwardWindowResult","description":"A per-window out-of-sample result, tagged with the train/test time ranges it covered (WS2.8).","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  assumptions assumptions.assignment assumptions.calendar assumptions.cashSettlement assumptions.conventionsVersion assumptions.corporateActio"},{"title":"WeightContext","url":"/reference/totalfinance/backtest/page-5#WeightContext","description":"What a supplied-weights callback sees.","category":"@insiderfinance/totalfinance/backtest","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest interface  asOf long sessionDate short trailingReturns @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"WeightingMethod","url":"/reference/totalfinance/backtest/page-5#WeightingMethod","description":"type from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"type","keywords":"@insiderfinance/totalfinance/backtest type   @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"agentBaselines","url":"/reference/totalfinance/backtest/page-5#agentBaselines","description":"value from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"value","keywords":"@insiderfinance/totalfinance/backtest value  buyAndHold buyAndHold().return.decide buyAndHold().return.label buyAndHold().return.requires buyAndHold().return.requires.drawdown buyAndHol @insiderfinance/totalfinance/backtest/environment"},{"title":"attribution","url":"/reference/totalfinance/backtest/page-6#attribution","description":"Per-symbol realized P&L attribution (average-cost matched) from a trade blotter (report-shaped).","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (trades) return.assumptions return.assumptions.conventionsVersion return.bySymbol return.diagnostics return.diagnostics.warnings @insiderfinance/totalfinance/backtest/tearsheet"},{"title":"borrow","url":"/reference/totalfinance/backtest/page-6#borrow","description":"Borrow-fee models for shorts.","category":"@insiderfinance/totalfinance/backtest","kind":"value","keywords":"@insiderfinance/totalfinance/backtest value  annualRate annualRate().return.annualRate annualRate().return.label annualRate(annualRate) none none().return.annualRate none().return.label @insiderfinance/totalfinance/backtest/costs @insiderfinance/totalfinance/backtest/execution"},{"title":"brokers","url":"/reference/totalfinance/backtest/page-6#brokers","description":"Broker factory (spec §16.2: `brokers.simulated({ cash, commission, slippage })`).","category":"@insiderfinance/totalfinance/backtest","kind":"value","keywords":"@insiderfinance/totalfinance/backtest value  simulated simulated().return.cancel simulated().return.cash simulated().return.equity simulated().return.exerciseOption simulated().return.o"},{"title":"checkDataAlignment","url":"/reference/totalfinance/backtest/page-6#checkDataAlignment","description":"Check that each symbol's bars are strictly time-ascending with finite positive prices. Returns\nstructured warnings for out-of-order timestamps, duplicate timest","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (bars)"},{"title":"createPortfolioStepper","url":"/reference/totalfinance/backtest/page-6#createPortfolioStepper","description":"The engine's seam (Stage 7B.1, Decision 2): the same per-instant loop `portfolioBacktest` runs,\ndriven from outside. `open(index)` stamps the clock, folds pre-o","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (request) (request).accounting (request).calendar (request).execution (request).externalFlows (request).instruments (request).marketData (re @insiderfinance/totalfinance/backtest/portfolio"},{"title":"createTradingEnvironment","url":"/reference/totalfinance/backtest/page-6#createTradingEnvironment","description":"function from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (definition) (definition).accounting (definition).calendar (definition).execution (definition).externalFlows (definition).features (definiti @insiderfinance/totalfinance/backtest/environment"},{"title":"crossOver","url":"/reference/totalfinance/backtest/page-6#crossOver","description":"True when series `a` crosses from at-or-below `b` to above it on the latest bar.","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (first) (first).previous (first).value (second) (second).previous (second).value @insiderfinance/totalfinance/backtest/event-driven"},{"title":"crossOverSeries","url":"/reference/totalfinance/backtest/page-6#crossOverSeries","description":"`1` on the bar where `a` crosses from at-or-below `b` to above it (`a[i-1] ≤ b[i-1] && a[i] > b[i]`),\nelse `0`. `NaN` where any of the four inputs (`a`/`b` at `","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (first) (second)"},{"title":"crossSectionalBacktest","url":"/reference/totalfinance/backtest/page-6#crossSectionalBacktest","description":"function from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (request) (request).baseCurrency (request).dataset (request).execution (request).initialCapital (request).periodsPerYear (request).portfolio @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"crossSectionalBacktestGrid","url":"/reference/totalfinance/backtest/page-6#crossSectionalBacktestGrid","description":"Run the cartesian product of `variations` over `request` — each point one `crossSectionalBacktest`\ncall — and compose the research-hygiene verdicts. Every child","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (gridRequest) (gridRequest).hygiene (gridRequest).hygiene.confidence (gridRequest).hygiene.splits (gridRequest).maximumVariations (gridReque @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"crossSectionalPurgedFolds","url":"/reference/totalfinance/backtest/page-6#crossSectionalPurgedFolds","description":"Purged k-fold evaluation of a cross-sectional grid: `purgedKFold` over the session index gives\nevery fold a held-out block, a purge gap on each side, and an emb","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (request) (request).embargo (request).folds (request).hygiene (request).hygiene.confidence (request).hygiene.splits (request).maximumVariati @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"crossSectionalWalkForward","url":"/reference/totalfinance/backtest/page-6#crossSectionalWalkForward","description":"Walk a cross-sectional grid forward: on every training span the grid picks a variation by its\nselection metric; that variation runs once on the following held-o","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (request) (request).hygiene (request).hygiene.confidence (request).hygiene.splits (request).maximumVariations (request).mode (request).reque @insiderfinance/totalfinance/backtest/cross-sectional"},{"title":"crossUnder","url":"/reference/totalfinance/backtest/page-6#crossUnder","description":"True when series `a` crosses from at-or-above `b` to below it on the latest bar.","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (first) (first).previous (first).value (second) (second).previous (second).value @insiderfinance/totalfinance/backtest/event-driven"},{"title":"crossUnderSeries","url":"/reference/totalfinance/backtest/page-6#crossUnderSeries","description":"`1` on the bar where `a` crosses from at-or-above `b` to below it (`a[i-1] ≥ b[i-1] && a[i] < b[i]`),\nelse `0`. `NaN` where any of the four inputs (`a`/`b` at `","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (first) (second)"},{"title":"environmentEpisode","url":"/reference/totalfinance/backtest/page-6#environmentEpisode","description":"Build one maintained episode from its seed — the definition, the seed, its session count, and its expectations.","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (input) (input).id (input).seed return.definition return.description return.expectations return.id return.seed return.sessions return.title @insiderfinance/totalfinance/backtest/environment"},{"title":"equityToReturns","url":"/reference/totalfinance/backtest/page-6#equityToReturns","description":"Per-step simple returns of an equity curve.","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (equity) @insiderfinance/totalfinance/backtest/vectorized"},{"title":"eventDriven","url":"/reference/totalfinance/backtest/page-6#eventDriven","description":"Run an event-driven backtest.","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (options) (options).broker (options).broker.assignment (options).broker.assignmentThreshold (options).broker.borrow (options).broker.cancel  @insiderfinance/totalfinance/backtest/event-driven"},{"title":"fees","url":"/reference/totalfinance/backtest/page-6#fees","description":"Commission models.","category":"@insiderfinance/totalfinance/backtest","kind":"value","keywords":"@insiderfinance/totalfinance/backtest value  bps bps().return.commission bps().return.label bps(bps) fixed fixed().return.commission fixed().return.label fixed(amount) none none().retur @insiderfinance/totalfinance/backtest/costs @insiderfinance/totalfinance/backtest/execution"},{"title":"gtSeries","url":"/reference/totalfinance/backtest/page-6#gtSeries","description":"`1` where `a[i] > b[i]`, else `0`; `NaN` where either input is `NaN` at `i` (missing data). `b` may\nbe a scalar level (e.g. `gtSeries(rsi, 70)`) or an aligned s","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (first) (second)"},{"title":"latchSeries","url":"/reference/totalfinance/backtest/page-6#latchSeries","description":"Turn discrete **entry/exit events** into a held `{0,1}` **position** series: latch to `1` on an entry\nevent and hold it until an exit event flips it back to `0`","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function Enter long on a 10/30 SMA golden cross, exit on the death cross, hold in between:\n```ts\nconst entrie (entries) (exits)"},{"title":"ltSeries","url":"/reference/totalfinance/backtest/page-7#ltSeries","description":"`1` where `a[i] < b[i]`, else `0`; `NaN` where either input is `NaN` at `i` (missing data). `b` may\nbe a scalar level (e.g. `ltSeries(rsi, 30)`) or an aligned s","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (first) (second)"},{"title":"monteCarloResample","url":"/reference/totalfinance/backtest/page-7#monteCarloResample","description":"Seeded bootstrap of bar returns → confidence bands on the compounded total return (report-shaped).","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (options) (options).iterations (options).seed (returns) return.assumptions return.assumptions.conventionsVersion return.confidenceInterval95 @insiderfinance/totalfinance/backtest/tearsheet"},{"title":"portfolioBacktest","url":"/reference/totalfinance/backtest/page-7#portfolioBacktest","description":"Run a ledger-backed multi-asset backtest. See `docs/specs/portfolio-scale-backtesting.md`\n(Decision 6).","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (request) (request).accounting (request).calendar (request).execution (request).externalFlows (request).instruments (request).marketData (re @insiderfinance/totalfinance/backtest/portfolio"},{"title":"returnStatistics","url":"/reference/totalfinance/backtest/page-7#returnStatistics","description":"Return-distribution statistics from a series of per-bar returns (report-shaped, Law 2).","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (returns) return.assumptions return.assumptions.conventionsVersion return.averageLoss return.averageWin return.bestPeriod return.diagnostics @insiderfinance/totalfinance/backtest/tearsheet"},{"title":"runAgentBench","url":"/reference/totalfinance/backtest/page-7#runAgentBench","description":"function from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (input) (input).episodes (input).limits (input).limits.maximumRuns (input).policy (input).policy.decide (input).policy.label (input).policy. @insiderfinance/totalfinance/backtest/environment"},{"title":"runEnvironmentEpisode","url":"/reference/totalfinance/backtest/page-7#runEnvironmentEpisode","description":"function from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (input) (input).actions (input).definition (input).seed return.assumptions return.assumptions.conventionsVersion return.assumptions.executio @insiderfinance/totalfinance/backtest/environment"},{"title":"scoreAgentTranscript","url":"/reference/totalfinance/backtest/page-7#scoreAgentTranscript","description":"function from @insiderfinance/totalfinance/backtest","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (input) (input).expected (input).transcript return.argumentValidity return.assumptions return.assumptions.deterministic return.assumptions.s @insiderfinance/totalfinance/backtest/environment"},{"title":"slippage","url":"/reference/totalfinance/backtest/page-7#slippage","description":"Slippage models — all worsen the fill price *against* the order's side.","category":"@insiderfinance/totalfinance/backtest","kind":"value","keywords":"@insiderfinance/totalfinance/backtest value  bps bps().return.fill bps().return.label bps(bps) fixed fixed().return.fill fixed().return.label fixed(perShare) none none().return.fill non @insiderfinance/totalfinance/backtest/costs @insiderfinance/totalfinance/backtest/execution"},{"title":"tearSheet","url":"/reference/totalfinance/backtest/page-7#tearSheet","description":"Build a structured tear sheet from a backtest result.","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (options) (options).monteCarlo (options).monteCarlo.iterations (options).monteCarlo.seed (result) (result).assumptions (result).diagnostics  @insiderfinance/totalfinance/backtest/tearsheet"},{"title":"toEquityPoints","url":"/reference/totalfinance/backtest/page-7#toEquityPoints","description":"Build the {@link EquityPoint} series from an engine's internal `equityCurve` (length n+1, index 0 =\nopening capital) and `timestamps` (length n, one per bar).","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (equityCurve) (timestamps)"},{"title":"vectorized","url":"/reference/totalfinance/backtest/page-7#vectorized","description":"Run a single-asset vectorized backtest.","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (options) (options).borrow (options).data (options).executionLag (options).fees (options).initialCapital (options).maxLeverage (options).per @insiderfinance/totalfinance/backtest/vectorized"},{"title":"walkForward","url":"/reference/totalfinance/backtest/page-7#walkForward","description":"Run a walk-forward evaluation.","category":"@insiderfinance/totalfinance/backtest","kind":"function","keywords":"@insiderfinance/totalfinance/backtest function  (options) (options).data (options).mode (options).periodsPerYear (options).run (options).step (options).testSize (options).trainSize return."},{"title":"BACKTEST_RUN_ARTIFACT_TYPE","url":"/reference/totalfinance/backtest/artifacts#BACKTEST_RUN_ARTIFACT_TYPE","description":"value from @insiderfinance/totalfinance/backtest/artifacts","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/artifacts value  "},{"title":"BACKTEST_RUN_KINDS","url":"/reference/totalfinance/backtest/artifacts#BACKTEST_RUN_KINDS","description":"The frozen data projection of the kind table — what an agent reads before choosing a kind.","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/artifacts value  "},{"title":"BACKTEST_RUN_KIND_LIST","url":"/reference/totalfinance/backtest/artifacts#BACKTEST_RUN_KIND_LIST","description":"value from @insiderfinance/totalfinance/backtest/artifacts","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/artifacts value  "},{"title":"BACKTEST_RUN_LIMITS","url":"/reference/totalfinance/backtest/artifacts#BACKTEST_RUN_LIMITS","description":"Decision 9's bounded-work table (core's `ARTIFACT_WORK_LIMITS`, re-exported for this subpath's callers).","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/artifacts value  embeddedRowLimit embeddedRowLimit.default embeddedRowLimit.maximum gridPoints gridPoints.default gridPoints.maximum holdoutEvaluations holdo"},{"title":"BacktestHygieneBlock","url":"/reference/totalfinance/backtest/artifacts#BacktestHygieneBlock","description":"The research-hygiene verdicts a caller attaches to a single run — verbatim `@insiderfinance/totalfinance/risk` results.","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  backtestOverfitting deflatedSharpe researchProtocol"},{"title":"BacktestRunArtifactInput","url":"/reference/totalfinance/backtest/artifacts#BacktestRunArtifactInput","description":"interface from @insiderfinance/totalfinance/backtest/artifacts","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  createdFrom hygiene hygiene.backtestOverfitting hygiene.deflatedSharpe hygiene.researchProtocol input kind libraryVersion limits limits.embe"},{"title":"BacktestRunArtifactLimits","url":"/reference/totalfinance/backtest/artifacts#BacktestRunArtifactLimits","description":"interface from @insiderfinance/totalfinance/backtest/artifacts","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  embeddedRowLimit maximumEmbeddedBytes"},{"title":"BacktestRunComparison","url":"/reference/totalfinance/backtest/artifacts#BacktestRunComparison","description":"interface from @insiderfinance/totalfinance/backtest/artifacts","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  artifactIds artifactIds.baseline artifactIds.candidate assumptions assumptions.conventionsVersion assumptions.kind assumptions.limits assump"},{"title":"BacktestRunIdentity","url":"/reference/totalfinance/backtest/artifacts#BacktestRunIdentity","description":"The FC8 identity list, read from the run's assumptions and the request — never recomputed.","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  annualization annualization.periodsPerYear annualization.riskFreeRate baseCurrency benchmark calendar calendar.firstMarkTimestampMs calendar"},{"title":"BacktestRunInputs","url":"/reference/totalfinance/backtest/artifacts#BacktestRunInputs","description":"interface from @insiderfinance/totalfinance/backtest/artifacts","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  cross-sectional cross-sectional-grid cross-sectional-grid.hygiene cross-sectional-grid.hygiene.confidence cross-sectional-grid.hygiene.split"},{"title":"BacktestRunKind","url":"/reference/totalfinance/backtest/artifacts#BacktestRunKind","description":"The run kinds this subpath records.","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/artifacts type  "},{"title":"BacktestRunKindDescriptor","url":"/reference/totalfinance/backtest/artifacts#BacktestRunKindDescriptor","description":"The frozen, data-only description of one run kind.","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  callbackFields inputRowSets kind modelFields operation resultRowSets runVersion"},{"title":"BacktestRunReplay","url":"/reference/totalfinance/backtest/artifacts#BacktestRunReplay","description":"interface from @insiderfinance/totalfinance/backtest/artifacts","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  artifactId assumptions assumptions.conventionsVersion assumptions.kind assumptions.libraryVersion assumptions.libraryVersion.current assumpt"},{"title":"BacktestRunReport","url":"/reference/totalfinance/backtest/artifacts#BacktestRunReport","description":"The typed report every verb reads and writes — the artifact's `result`, verbatim.","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/artifacts type  assumptions assumptions.conventionsVersion assumptions.embeddedRowLimit assumptions.inputPolicy assumptions.kind assumptions.modelPolicy ass"},{"title":"BacktestRunResults","url":"/reference/totalfinance/backtest/artifacts#BacktestRunResults","description":"interface from @insiderfinance/totalfinance/backtest/artifacts","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  cross-sectional cross-sectional-grid cross-sectional-grid.assumptions cross-sectional-grid.assumptions.conventionsVersion cross-sectional-gr"},{"title":"IdListSection","url":"/reference/totalfinance/backtest/artifacts#IdListSection","description":"interface from @insiderfinance/totalfinance/backtest/artifacts","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  count ids remainderCount"},{"title":"InputOf","url":"/reference/totalfinance/backtest/artifacts#InputOf","description":"type from @insiderfinance/totalfinance/backtest/artifacts","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/artifacts type  "},{"title":"MembershipSection","url":"/reference/totalfinance/backtest/artifacts#MembershipSection","description":"interface from @insiderfinance/totalfinance/backtest/artifacts","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  entered entered.count entered.ids entered.remainderCount exited exited.count exited.ids exited.remainderCount kept kept.count kept.ids kept. @insiderfinance/totalfinance/research/artifacts"},{"title":"NamedDelta","url":"/reference/totalfinance/backtest/artifacts#NamedDelta","description":"interface from @insiderfinance/totalfinance/backtest/artifacts","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  absoluteDelta baselineValue candidateValue name withinTolerance"},{"title":"ReadBacktestRunResult","url":"/reference/totalfinance/backtest/artifacts#ReadBacktestRunResult","description":"interface from @insiderfinance/totalfinance/backtest/artifacts","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  artifact artifact.artifactType artifact.conventionsVersion artifact.createdFrom artifact.id artifact.inputs artifact.inputs.inputsHash artif"},{"title":"RebalanceDelta","url":"/reference/totalfinance/backtest/artifacts/page-2#RebalanceDelta","description":"interface from @insiderfinance/totalfinance/backtest/artifacts","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  costs costs.absoluteDelta costs.baseline costs.candidate longCount longCount.baseline longCount.candidate rebalanceIndex sessionDate session"},{"title":"RecordedModels","url":"/reference/totalfinance/backtest/artifacts/page-2#RecordedModels","description":"The recorded models of a run: descriptions and labels, never functions.","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  commission execution execution.ambiguity execution.costs execution.costs.borrow execution.costs.commission execution.costs.latencySessions e"},{"title":"ReplayModels","url":"/reference/totalfinance/backtest/artifacts/page-2#ReplayModels","description":"The models a replay takes back, each verified against the recorded description before the run.","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  execution execution.ambiguity execution.costs execution.costs.borrow execution.costs.borrow.annualRate execution.costs.borrow.label executio"},{"title":"RunOf","url":"/reference/totalfinance/backtest/artifacts/page-2#RunOf","description":"type from @insiderfinance/totalfinance/backtest/artifacts","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/artifacts type  "},{"title":"VariationDelta","url":"/reference/totalfinance/backtest/artifacts/page-2#VariationDelta","description":"interface from @insiderfinance/totalfinance/backtest/artifacts","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/artifacts interface  absoluteDelta baselineValue candidateValue metric parameters"},{"title":"backtestRunArtifact","url":"/reference/totalfinance/backtest/artifacts/page-2#backtestRunArtifact","description":"Describe a run and save it as an identified, immutable artifact.","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/artifacts function ```ts\nconst run = crossSectionalBacktest(request);\nconst artifact = backtestRunArtifact({\n  kind: 'c (input) (input).createdFrom (input).hygiene (input).input (input).kind (input).libraryVersion (input).limits (input).locators (input).proven"},{"title":"compareBacktestRuns","url":"/reference/totalfinance/backtest/artifacts/page-2#compareBacktestRuns","description":"Compare two runs of one kind: metric deltas, holdings membership, rebalance-by-rebalance turnover and cost deltas, grid variation deltas, the hygiene verdict, a","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/artifacts function  (input) (input).baseline (input).baseline.artifactType (input).baseline.conventionsVersion (input).baseline.createdFrom (input).baseline.id "},{"title":"readBacktestRun","url":"/reference/totalfinance/backtest/artifacts/page-2#readBacktestRun","description":"Restore a run artifact: Gate B's read door, a foreign-type refusal, the run-level migration policy,\nthe report re-validated (its run hash recomputed), and any s","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/artifacts function  (input) (input).artifact (input).migrations (input).referencedData return.artifact return.migrationsApplied return.modelMigrationsApplied re"},{"title":"replayBacktestRun","url":"/reference/totalfinance/backtest/artifacts/page-2#replayBacktestRun","description":"Re-issue the run's verb from the stored request (referenced rows supplied and re-verified, models\ntaken back and verified against their recorded descriptions) a","category":"@insiderfinance/totalfinance/backtest/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/artifacts function  (input) (input).artifact (input).libraryVersion (input).limits (input).migrations (input).models (input).referencedData return.artifactId re"},{"title":"CommissionInput","url":"/reference/totalfinance/backtest/costs#CommissionInput","description":"A commission model: the cash cost of a fill of `quantity` shares at `price`.","category":"@insiderfinance/totalfinance/backtest/costs","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/costs interface  price quantity"},{"title":"SlippageFillInput","url":"/reference/totalfinance/backtest/costs#SlippageFillInput","description":"A slippage model: the effective fill price, worsened against the trader from a reference price.\n`quantity` is the INTENDED order size (both engines pass the rea","category":"@insiderfinance/totalfinance/backtest/costs","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/costs interface  quantity referencePrice side"},{"title":"CROSS_SECTIONAL_GRID_CEILING","url":"/reference/totalfinance/backtest/cross-sectional#CROSS_SECTIONAL_GRID_CEILING","description":"Decision 9: the hard ceiling on variations one synchronous sweep may run.","category":"@insiderfinance/totalfinance/backtest/cross-sectional","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/cross-sectional value  "},{"title":"CROSS_SECTIONAL_GRID_DEFAULT_MAXIMUM","url":"/reference/totalfinance/backtest/cross-sectional#CROSS_SECTIONAL_GRID_DEFAULT_MAXIMUM","description":"Decision 9: variations one synchronous sweep runs unless the caller raises the ceiling.","category":"@insiderfinance/totalfinance/backtest/cross-sectional","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/cross-sectional value  "},{"title":"CROSS_SECTIONAL_POSITION_CEILING","url":"/reference/totalfinance/backtest/cross-sectional#CROSS_SECTIONAL_POSITION_CEILING","description":"Decision 9: open positions one construction may hold.","category":"@insiderfinance/totalfinance/backtest/cross-sectional","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/cross-sectional value  "},{"title":"CROSS_SECTIONAL_ROW_CEILING","url":"/reference/totalfinance/backtest/cross-sectional#CROSS_SECTIONAL_ROW_CEILING","description":"Decision 9: rows one run may read; larger inputs travel by handle to the job runner.","category":"@insiderfinance/totalfinance/backtest/cross-sectional","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/cross-sectional value  "},{"title":"CROSS_SECTIONAL_WINDOW_CEILING","url":"/reference/totalfinance/backtest/cross-sectional#CROSS_SECTIONAL_WINDOW_CEILING","description":"Ceiling on windows one call may run — each window is a grid run plus a held-out run.","category":"@insiderfinance/totalfinance/backtest/cross-sectional","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/cross-sectional value  "},{"title":"GridAssumptions","url":"/reference/totalfinance/backtest/cross-sectional#GridAssumptions","description":"interface from @insiderfinance/totalfinance/backtest/cross-sectional","category":"@insiderfinance/totalfinance/backtest/cross-sectional","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/cross-sectional interface  conventionsVersion hygiene hygiene.confidence hygiene.degenerateTrialSharpe hygiene.splits maximumVariations paths periodsPerYear riskFreeRa"},{"title":"GridDiagnostics","url":"/reference/totalfinance/backtest/cross-sectional/page-2#GridDiagnostics","description":"interface from @insiderfinance/totalfinance/backtest/cross-sectional","category":"@insiderfinance/totalfinance/backtest/cross-sectional","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/cross-sectional interface  autoReason converged decomposition degenerateTrialCount engine finiteDifferenceBumps iterations method selection selection.candidates select"},{"title":"GridHygiene","url":"/reference/totalfinance/backtest/cross-sectional/page-2#GridHygiene","description":"interface from @insiderfinance/totalfinance/backtest/cross-sectional","category":"@insiderfinance/totalfinance/backtest/cross-sectional","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/cross-sectional interface  backtestOverfitting backtestOverfitting.assumptions backtestOverfitting.assumptions.conventionsVersion backtestOverfitting.backtestOverfitti"},{"title":"GridSelectionMetric","url":"/reference/totalfinance/backtest/cross-sectional/page-2#GridSelectionMetric","description":"The performance-block metric that ranks the variations.","category":"@insiderfinance/totalfinance/backtest/cross-sectional","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/cross-sectional type  "},{"title":"GridSummaryMetrics","url":"/reference/totalfinance/backtest/cross-sectional/page-2#GridSummaryMetrics","description":"The summary metrics of one variation, read from the run's performance block and diagnostics.","category":"@insiderfinance/totalfinance/backtest/cross-sectional","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/cross-sectional interface  annualizedReturn annualizedVolatility calmar cappedGoalCount fillCount finalValue hitRate maxDrawdown meanTurnover periods rebalanceCount sh"},{"title":"requireCrossSectionalBacktestGridRequest","url":"/reference/totalfinance/backtest/cross-sectional/page-3#requireCrossSectionalBacktestGridRequest","description":"The closed guard for the grid request; the base request is validated by the engine's own guard.","category":"@insiderfinance/totalfinance/backtest/cross-sectional","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/cross-sectional function  (functionName) (label) (value) return.hygiene return.hygiene.confidence return.hygiene.splits return.maximumVariations return.request return"},{"title":"requireCrossSectionalBacktestRequest","url":"/reference/totalfinance/backtest/cross-sectional/page-3#requireCrossSectionalBacktestRequest","description":"Validate the whole request; returns the declared field definitions for the engine's reuse.","category":"@insiderfinance/totalfinance/backtest/cross-sectional","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/cross-sectional function  (functionName) (label) (value)"},{"title":"requireCrossSectionalPurgedFoldsRequest","url":"/reference/totalfinance/backtest/cross-sectional/page-3#requireCrossSectionalPurgedFoldsRequest","description":"The boundary guard for {@link crossSectionalPurgedFolds}.","category":"@insiderfinance/totalfinance/backtest/cross-sectional","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/cross-sectional function  (functionName) (label) (value) return.embargo return.folds return.hygiene return.hygiene.confidence return.hygiene.splits return.maximumVari"},{"title":"requireCrossSectionalWalkForwardRequest","url":"/reference/totalfinance/backtest/cross-sectional/page-3#requireCrossSectionalWalkForwardRequest","description":"The boundary guard for {@link crossSectionalWalkForward}; the grid is validated by the grid's own guard.","category":"@insiderfinance/totalfinance/backtest/cross-sectional","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/cross-sectional function  (functionName) (label) (value) return.hygiene return.hygiene.confidence return.hygiene.splits return.maximumVariations return.mode return.re"},{"title":"AGENT_BENCH_RUN_CEILING","url":"/reference/totalfinance/backtest/environment#AGENT_BENCH_RUN_CEILING","description":"The most episode × seed runs one bench call may take (Decision 11).","category":"@insiderfinance/totalfinance/backtest/environment","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/environment value  "},{"title":"ActionMask","url":"/reference/totalfinance/backtest/environment#ActionMask","description":"type from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/environment type  "},{"title":"ActionMaskEntry","url":"/reference/totalfinance/backtest/environment#ActionMaskEntry","description":"Whether a buy or a sell of the instrument is allowed at the observation, and why not (Decision 6).","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  buy instrumentId reasons reasons.buy reasons.sell sell"},{"title":"AgentBenchEpisodeReport","url":"/reference/totalfinance/backtest/environment#AgentBenchEpisodeReport","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  id operational operational.duplicateOrders operational.externalOrderAttempts operational.limitBreaches operational.lookAhead operational.mas"},{"title":"AgentBenchInput","url":"/reference/totalfinance/backtest/environment#AgentBenchInput","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  episodes limits limits.maximumRuns policy policy.decide policy.decide().return.cancel policy.decide().return.kind policy.decide().return.ord"},{"title":"AgentBenchOperational","url":"/reference/totalfinance/backtest/environment#AgentBenchOperational","description":"The absolute gates and the counts, per episode.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  duplicateOrders externalOrderAttempts limitBreaches lookAhead maskViolations passes reconciled replayEquality"},{"title":"AgentBenchStrategy","url":"/reference/totalfinance/backtest/environment#AgentBenchStrategy","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  annualizedVolatility cost finalValue maxDrawdown meanGrossExposure rewardTotal sharpe sortino steps totalReturn turnover violations"},{"title":"AgentTranscript","url":"/reference/totalfinance/backtest/environment#AgentTranscript","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  answer answer.citedArtifactIds answer.refused answer.text calls"},{"title":"AgentTranscriptCall","url":"/reference/totalfinance/backtest/environment#AgentTranscriptCall","description":"One transport call as a harness recorded it.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  arguments bytes error error.code error.message ok operation result"},{"title":"AgentTranscriptExpectation","url":"/reference/totalfinance/backtest/environment#AgentTranscriptExpectation","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  argumentPredicates artifactIds budget budget.maximumBytes budget.maximumCalls mustRefuse operations parity parity.direct parity.operation"},{"title":"BaselinePolicy","url":"/reference/totalfinance/backtest/environment#BaselinePolicy","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  decide decide().return.cancel decide().return.kind decide().return.orders decide().return.rationale decide(observation) decide(observation)."},{"title":"ENVIRONMENT_EPISODE_IDS","url":"/reference/totalfinance/backtest/environment#ENVIRONMENT_EPISODE_IDS","description":"value from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/environment value  "},{"title":"EnvironmentEpisodeId","url":"/reference/totalfinance/backtest/environment#EnvironmentEpisodeId","description":"The catalogue's episode ids (Decision 8).","category":"@insiderfinance/totalfinance/backtest/environment","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/environment type  "},{"title":"EnvironmentEpisodeStep","url":"/reference/totalfinance/backtest/environment#EnvironmentEpisodeStep","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  action action.cancel action.kind action.orders action.rationale asOf breaches fills netAssetValue rejections reward reward.components reward"},{"title":"EnvironmentFeatures","url":"/reference/totalfinance/backtest/environment/page-2#EnvironmentFeatures","description":"The evaluated features, keyed by lookback then instrument; null where the prefix is too short.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  drawdown lookbackReturns realizedVolatility"},{"title":"EnvironmentIdentity","url":"/reference/totalfinance/backtest/environment/page-2#EnvironmentIdentity","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  runId step traceHash"},{"title":"EnvironmentLimits","url":"/reference/totalfinance/backtest/environment/page-2#EnvironmentLimits","description":"FC7's `PolicyLimits` verbatim plus three environment-only members (Decision 5).","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  allowUndefinedRiskOptions maximumDailyLoss maximumDaysToLiquidate maximumDrawdown maximumGrossLeverage maximumGroupWeights maximumPositionNo"},{"title":"EnvironmentLimitsView","url":"/reference/totalfinance/backtest/environment/page-2#EnvironmentLimitsView","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  breaches utilization"},{"title":"EnvironmentOrder","url":"/reference/totalfinance/backtest/environment/page-2#EnvironmentOrder","description":"One order an action submits — the execution grammar without the fields the environment stamps.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  instrumentId limitPrice orderId quantity side stopPrice timeInForce type"},{"title":"EnvironmentPortfolioView","url":"/reference/totalfinance/backtest/environment/page-2#EnvironmentPortfolioView","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  buyingPower cash grossExposure netAssetValue netExposure openOrders positions"},{"title":"EnvironmentProvenance","url":"/reference/totalfinance/backtest/environment/page-2#EnvironmentProvenance","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  adapters conventionsVersion definitionHash engineRunId executionPolicy runId seed"},{"title":"EnvironmentRejection","url":"/reference/totalfinance/backtest/environment/page-2#EnvironmentRejection","description":"A typed rejection: never thrown, always a row with the step it happened at.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  code detail instrumentId orderId source step"},{"title":"EnvironmentRejectionCode","url":"/reference/totalfinance/backtest/environment/page-2#EnvironmentRejectionCode","description":"The environment's own rejection codes — registered in `ErrorCode`, never thrown (the engine's `backtest.*` codes pass through unchanged).","category":"@insiderfinance/totalfinance/backtest/environment","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/environment type  "},{"title":"EnvironmentResetOptions","url":"/reference/totalfinance/backtest/environment/page-2#EnvironmentResetOptions","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  seed"},{"title":"EnvironmentResetResult","url":"/reference/totalfinance/backtest/environment/page-2#EnvironmentResetResult","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  episode episode.definitionHash episode.engineRunId episode.instantCount episode.maximumSteps episode.runId episode.seed episode.window episo"},{"title":"EnvironmentStepOutcome","url":"/reference/totalfinance/backtest/environment/page-2#EnvironmentStepOutcome","description":"The outcome of one action — what the previous step did, as the next observation reports it.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  action action.cancel action.kind action.orders action.rationale events fills liquidations rejections reward reward.components reward.total s"},{"title":"EpisodeInformation","url":"/reference/totalfinance/backtest/environment/page-2#EpisodeInformation","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  definitionHash engineRunId instantCount maximumSteps runId seed window window.fromTimestampMs window.toTimestampMs"},{"title":"FeatureRecipes","url":"/reference/totalfinance/backtest/environment/page-2#FeatureRecipes","description":"Feature recipes evaluated over the bar closes at or before the instant only.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  drawdown lookbackReturns realizedVolatility realizedVolatility.annualization realizedVolatility.lookbacks"},{"title":"InstrumentFreshness","url":"/reference/totalfinance/backtest/environment/page-2#InstrumentFreshness","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  ageMs kinds latestTimestampMs stale"},{"title":"LimitBreach","url":"/reference/totalfinance/backtest/environment/page-2#LimitBreach","description":"A breach the FC7 monitor raised at the instant (`monitorPortfolio`, state raised or active).","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  family message subject threshold value"},{"title":"LimitUtilization","url":"/reference/totalfinance/backtest/environment/page-2#LimitUtilization","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  bound fraction limit subject value"},{"title":"MAXIMUM_ENVIRONMENT_STEPS","url":"/reference/totalfinance/backtest/environment/page-2#MAXIMUM_ENVIRONMENT_STEPS","description":"The most steps one episode may take (Decision 11).","category":"@insiderfinance/totalfinance/backtest/environment","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/environment value  "},{"title":"MaskReason","url":"/reference/totalfinance/backtest/environment/page-3#MaskReason","description":"type from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/environment type  "},{"title":"OpenOrder","url":"/reference/totalfinance/backtest/environment/page-3#OpenOrder","description":"An order accepted and not yet resolved — it meets the market at the next instant.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  attempts instrumentId limitPrice orderId quantity reason side stopPrice submittedStep submittedTimestampMs timeInForce type"},{"title":"OpenOrderReason","url":"/reference/totalfinance/backtest/environment/page-3#OpenOrderReason","description":"Why an order is still open: submitted this step, or the market reason it did not fill.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/environment type  "},{"title":"RATIONALE_BYTE_LIMIT","url":"/reference/totalfinance/backtest/environment/page-3#RATIONALE_BYTE_LIMIT","description":"Bytes of `rationale` kept per action; longer text is truncated with a diagnostic, never refused.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/environment value  "},{"title":"RewardBreakdown","url":"/reference/totalfinance/backtest/environment/page-3#RewardBreakdown","description":"Every component separately, plus the weighted total.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  components total"},{"title":"RewardComponent","url":"/reference/totalfinance/backtest/environment/page-3#RewardComponent","description":"interface from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  contribution value weight"},{"title":"RewardComposition","url":"/reference/totalfinance/backtest/environment/page-3#RewardComposition","description":"The declared reward composition — weights on the components below; absent components are reported with weight 0.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  benchmark benchmark.instrumentId benchmark.weight concentration cost drawdown goal goal(frame) goal(frame).asOf goal(frame).benchmarkReturn "},{"title":"RewardFrame","url":"/reference/totalfinance/backtest/environment/page-3#RewardFrame","description":"What one step did, as the reward reads it — from the engine's frame, never from the ledger.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/environment interface  asOf benchmarkReturn costs drawdownAfter drawdownBefore fills grossExposure largestPositionWeight netAssetValueAfter netAssetValueBefore pos"},{"title":"TradingPolicy","url":"/reference/totalfinance/backtest/environment/page-3#TradingPolicy","description":"A coded policy: the observation in, the action out.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/environment type  (observation) (observation).actionMask (observation).asOf (observation).features (observation).freshness (observation).index (observation).i"},{"title":"listEnvironmentEpisodes","url":"/reference/totalfinance/backtest/environment/page-3#listEnvironmentEpisodes","description":"Every maintained episode at its default seed, in catalogue order.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/environment function  "},{"title":"requireEnvironmentAction","url":"/reference/totalfinance/backtest/environment/page-3#requireEnvironmentAction","description":"An action, refused outright — for callers who want the teaching error rather than a rejection row.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/environment function  (functionName) (label) (value) return.cancel return.kind return.orders return.rationale"},{"title":"requireEnvironmentEpisodeInput","url":"/reference/totalfinance/backtest/environment/page-3#requireEnvironmentEpisodeInput","description":"function from @insiderfinance/totalfinance/backtest/environment","category":"@insiderfinance/totalfinance/backtest/environment","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/environment function  (functionName) (label) (value) return.actions return.definition return.seed"},{"title":"requireEnvironmentLimits","url":"/reference/totalfinance/backtest/environment/page-3#requireEnvironmentLimits","description":"FC7's `PolicyLimits` members plus the three environment-only ones (Decision 5).","category":"@insiderfinance/totalfinance/backtest/environment","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/environment function  (functionName) (label) (value) return.allowUndefinedRiskOptions return.maximumDailyLoss return.maximumDaysToLiquidate return.maximumDrawdown"},{"title":"requireEnvironmentOrder","url":"/reference/totalfinance/backtest/environment/page-3#requireEnvironmentOrder","description":"One environment order, validated through the execution grammar it extends.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/environment function  (functionName) (label) (value) return.instrumentId return.limitPrice return.orderId return.quantity return.side return.stopPrice return.time"},{"title":"requireFeatureRecipes","url":"/reference/totalfinance/backtest/environment/page-3#requireFeatureRecipes","description":"The feature recipes: positive integer lookbacks, a positive annualization, a boolean drawdown flag.","category":"@insiderfinance/totalfinance/backtest/environment","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/environment function  (functionName) (label) (value) return.drawdown return.lookbackReturns return.realizedVolatility return.realizedVolatility.annualization retu"},{"title":"requireRewardComposition","url":"/reference/totalfinance/backtest/environment/page-4#requireRewardComposition","description":"The reward composition: finite weights, a benchmark with a weight and an instrument, an optional goal callback (Decision 7).","category":"@insiderfinance/totalfinance/backtest/environment","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/environment function  (functionName) (label) (value) return.benchmark return.benchmark.instrumentId return.benchmark.weight return.concentration return.cost retur"},{"title":"requireTradingEnvironmentDefinition","url":"/reference/totalfinance/backtest/environment/page-4#requireTradingEnvironmentDefinition","description":"The environment definition (Stage 7B.1): the stepper's request plus `maximumSteps`. A `strategy`\nmember teaches which verb wants it — the environment's orders c","category":"@insiderfinance/totalfinance/backtest/environment","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/environment function  (functionName) (label) (value) return.accounting return.calendar return.execution return.externalFlows return.features return.instruments re"},{"title":"AmbiguityPolicy","url":"/reference/totalfinance/backtest/execution#AmbiguityPolicy","description":"How an intrabar sequence of touches is resolved when the bar alone cannot say.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/execution type  "},{"title":"AssertFillModelConformanceInput","url":"/reference/totalfinance/backtest/execution#AssertFillModelConformanceInput","description":"interface from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  fillModel fillModel.fill fillModel.fill().return.clampedToPriceLimit fillModel.fill().return.detail fillModel.fill().return.levelsConsumed f"},{"title":"DeclaredExecutionPolicy","url":"/reference/totalfinance/backtest/execution#DeclaredExecutionPolicy","description":"The members `execution.declared` accepts — every one optional except the label.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  ambiguity costs costs.borrow costs.borrow.annualRate costs.borrow.label costs.commission costs.commission.commission costs.commission.commis"},{"title":"ExecutionCosts","url":"/reference/totalfinance/backtest/execution#ExecutionCosts","description":"interface from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  borrow borrow.annualRate borrow.label commission commission.commission commission.commission(input) commission.commission(input).price commi"},{"title":"ExecutionPolicy","url":"/reference/totalfinance/backtest/execution#ExecutionPolicy","description":"The whole declared execution reality of one run.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  ambiguity costs costs.borrow costs.borrow.annualRate costs.borrow.label costs.commission costs.commission.commission costs.commission.commis"},{"title":"ExecutionPolicyDescription","url":"/reference/totalfinance/backtest/execution#ExecutionPolicyDescription","description":"The JSON-safe projection of a policy that goes into a result's assumptions.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  ambiguity costs costs.borrow costs.commission costs.latencySessions costs.marketImpact costs.participation costs.slippage costs.spread fill "},{"title":"FillContext","url":"/reference/totalfinance/backtest/execution#FillContext","description":"The per-decision context a fill model receives beside the order and the observation.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  asOf lockedCrossed partialFills participation queue queue.model sessions sessions.auction sessions.halts sessions.priceLimits staleQuotes st"},{"title":"FillDecision","url":"/reference/totalfinance/backtest/execution#FillDecision","description":"type from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/execution type  clampedToPriceLimit detail levelsConsumed outcome partial pricePerUnit quantity reason reference"},{"title":"FillModel","url":"/reference/totalfinance/backtest/execution#FillModel","description":"A fill model: pure, deterministic, and closed over the observation it declares.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  fill fill().return.clampedToPriceLimit fill().return.detail fill().return.levelsConsumed fill().return.outcome fill().return.partial fill()."},{"title":"FillModelConformanceResult","url":"/reference/totalfinance/backtest/execution#FillModelConformanceResult","description":"interface from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  checks conformant fixturesRun label observation version"},{"title":"FillModelFixture","url":"/reference/totalfinance/backtest/execution#FillModelFixture","description":"interface from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  context context.asOf context.lockedCrossed context.partialFills context.participation context.queue context.queue.model context.sessions con"},{"title":"FillOrderWithPolicyInput","url":"/reference/totalfinance/backtest/execution#FillOrderWithPolicyInput","description":"interface from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  accountId accruedPerUnit asOf currency fillId filledTimestampMs observation observation.bar observation.bar.adjusted observation.bar.close o"},{"title":"FillOrderWithPolicyResult","url":"/reference/totalfinance/backtest/execution#FillOrderWithPolicyResult","description":"type from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/execution type  commission decision decision.clampedToPriceLimit decision.levelsConsumed decision.outcome decision.partial decision.pricePerUnit decision.qu"},{"title":"FillRequest","url":"/reference/totalfinance/backtest/execution#FillRequest","description":"What a fill model decides on: one order, one observation, the decision context.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  context context.asOf context.lockedCrossed context.partialFills context.participation context.queue context.queue.model context.sessions con"},{"title":"ForcedLiquidationPolicy","url":"/reference/totalfinance/backtest/execution#ForcedLiquidationPolicy","description":"type from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/execution type  "},{"title":"HaltWindow","url":"/reference/totalfinance/backtest/execution#HaltWindow","description":"No fills for the instrument (or every instrument when `instrumentId` is omitted) in the window.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  fromTimestampMs instrumentId toTimestampMs"},{"title":"IntrabarPath","url":"/reference/totalfinance/backtest/execution#IntrabarPath","description":"type from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/execution type  "},{"title":"IntrabarTouch","url":"/reference/totalfinance/backtest/execution#IntrabarTouch","description":"One order that touched inside the bar.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  favorable orderId triggerPrice"},{"title":"LatencyModel","url":"/reference/totalfinance/backtest/execution#LatencyModel","description":"The order is worked `sessions` observations after submission (0 = the same observation).","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  label sessions"},{"title":"LockedCrossedPolicy","url":"/reference/totalfinance/backtest/execution#LockedCrossedPolicy","description":"type from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/execution type  "},{"title":"MarginPolicy","url":"/reference/totalfinance/backtest/execution/page-2#MarginPolicy","description":"interface from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  buyingPowerMultiplier forcedLiquidation initialMarginRate maintenanceMarginRate"},{"title":"MarketImpactModel","url":"/reference/totalfinance/backtest/execution/page-2#MarketImpactModel","description":"Price impact of a quantity as a FRACTION of the reference price (≥ 0), by side.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  impact impact(input) impact(input).averageDailyVolume impact(input).quantity impact(input).referencePrice label"},{"title":"MarketObservation","url":"/reference/totalfinance/backtest/execution/page-2#MarketObservation","description":"What a fill model observes at the decision instant.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/execution type  bar bar.adjusted bar.close bar.high bar.low bar.open bar.symbol bar.timestampMs bar.volume bar.vwap book book.asks book.bids book.symbol boo"},{"title":"MarketObservationKind","url":"/reference/totalfinance/backtest/execution/page-2#MarketObservationKind","description":"type from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/execution type  "},{"title":"NormalizedFillFromDecisionInput","url":"/reference/totalfinance/backtest/execution/page-2#NormalizedFillFromDecisionInput","description":"interface from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  accountId accruedInterest contract contract.expiryTimestampMs contract.kind contract.strikePricePerUnit contract.type contract.underlyingIns"},{"title":"NormalizedFillsFromBacktestInput","url":"/reference/totalfinance/backtest/execution/page-2#NormalizedFillsFromBacktestInput","description":"Input for {@link normalizedFillsFromBacktest}: the trades a backtest reported, and the account they book to.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  accountId currency instruments sourceId trades"},{"title":"OrderIntent","url":"/reference/totalfinance/backtest/execution/page-2#OrderIntent","description":"One order a simulator wants filled — the intent, not the journey.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  instrumentId limitPrice orderId quantity side stopPrice submittedTimestampMs timeInForce type"},{"title":"OrderTouchSequenceInput","url":"/reference/totalfinance/backtest/execution/page-2#OrderTouchSequenceInput","description":"interface from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  bar bar.close bar.high bar.low bar.open policy touches"},{"title":"OrderTouchSequenceResult","url":"/reference/totalfinance/backtest/execution/page-2#OrderTouchSequenceResult","description":"interface from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  ambiguous path policy sequence"},{"title":"PartialFillPolicy","url":"/reference/totalfinance/backtest/execution/page-2#PartialFillPolicy","description":"type from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/execution type  "},{"title":"PriceLimitWindow","url":"/reference/totalfinance/backtest/execution/page-2#PriceLimitWindow","description":"Fills for the instrument are clamped into `[low, high]` in the window (limit-up / limit-down).","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  fromTimestampMs high instrumentId low toTimestampMs"},{"title":"QueueModel","url":"/reference/totalfinance/backtest/execution/page-2#QueueModel","description":"type from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/execution type  "},{"title":"SessionRules","url":"/reference/totalfinance/backtest/execution/page-2#SessionRules","description":"interface from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  auction halts priceLimits"},{"title":"SpreadModel","url":"/reference/totalfinance/backtest/execution/page-2#SpreadModel","description":"Half-spread paid by an aggressor, as a price adjustment per unit (≥ 0).","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  halfSpread halfSpread(input) halfSpread(input).referencePrice halfSpread(input).side label"},{"title":"StaleQuotePolicy","url":"/reference/totalfinance/backtest/execution/page-2#StaleQuotePolicy","description":"interface from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/execution interface  behavior maximumAgeMs"},{"title":"UnfilledReason","url":"/reference/totalfinance/backtest/execution/page-2#UnfilledReason","description":"type from @insiderfinance/totalfinance/backtest/execution","category":"@insiderfinance/totalfinance/backtest/execution","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/execution type  "},{"title":"assertFillModelConformance","url":"/reference/totalfinance/backtest/execution/page-2#assertFillModelConformance","description":"Run the conformance suite over the built-in fixtures for the model's observation kind and any\ncaller fixtures. Returns the checks that passed; throws `backtest.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/execution function  (input) (input).fillModel (input).fixtures return.checks return.conformant return.fixturesRun return.label return.observation return.version"},{"title":"barTriggerPrice","url":"/reference/totalfinance/backtest/execution/page-3#barTriggerPrice","description":"Where a bar fills an order, or `null` when the bar never touched it. Market and market-on-open\nfill at the open; market-on-close at the close; a limit fills at ","category":"@insiderfinance/totalfinance/backtest/execution","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/execution function  (input) (input).bar (input).bar.close (input).bar.high (input).bar.low (input).bar.open (input).order return.price return.reference"},{"title":"describeExecutionPolicy","url":"/reference/totalfinance/backtest/execution/page-3#describeExecutionPolicy","description":"The JSON-safe projection of a policy every result carries under `assumptions.execution`.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/execution function  (policy) (policy).ambiguity (policy).costs (policy).fill (policy).label (policy).lockedCrossed (policy).margin (policy).observation (policy)"},{"title":"execution","url":"/reference/totalfinance/backtest/execution/page-3#execution","description":"The execution policies a run may declare.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/execution value  declared declared().return.ambiguity declared().return.costs declared().return.fill declared().return.label declared().return.lockedCrossed "},{"title":"fillModels","url":"/reference/totalfinance/backtest/execution/page-3#fillModels","description":"The built-in fill models, one per observation kind. Each factory returns the frozen singleton.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/execution value  bar bar().return.fill bar().return.label bar().return.observation bar().return.version orderBook orderBook().return.fill orderBook().return."},{"title":"fillOrderWithPolicy","url":"/reference/totalfinance/backtest/execution/page-3#fillOrderWithPolicy","description":"Meet one order with one observation through the policy: the fill model decides; a filled decision\npays slippage, the half-spread, and impact on the price, commi","category":"@insiderfinance/totalfinance/backtest/execution","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/execution function  (input) (input).accountId (input).accruedPerUnit (input).asOf (input).currency (input).fillId (input).filledTimestampMs (input).observation "},{"title":"impactModels","url":"/reference/totalfinance/backtest/execution/page-3#impactModels","description":"Market-impact models: the fraction of the reference price a quantity moves against itself.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/execution value  none none().return.impact none().return.label squareRoot squareRoot().return.impact squareRoot().return.label squareRoot(input) squareRoot(i"},{"title":"latencyModels","url":"/reference/totalfinance/backtest/execution/page-3#latencyModels","description":"Latency models: how many observations after submission an order is first worked.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/execution value  sessions sessions().return.label sessions().return.sessions sessions(sessions)"},{"title":"maintenanceMarginBreached","url":"/reference/totalfinance/backtest/execution/page-3#maintenanceMarginBreached","description":"Whether equity has fallen below the maintenance requirement on the gross notional held.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/execution function  (input) (input).equity (input).grossNotional (input).policy return.breached return.requiredEquity return.shortfall"},{"title":"normalizedFillFromDecision","url":"/reference/totalfinance/backtest/execution/page-3#normalizedFillFromDecision","description":"Build the portfolio-owned fill for a filled decision; an unfilled decision is a teaching refusal.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/execution function  (input) (input).accountId (input).accruedInterest (input).contract (input).contract.expiryTimestampMs (input).contract.kind (input).contract"},{"title":"normalizedFillsFromBacktest","url":"/reference/totalfinance/backtest/execution/page-3#normalizedFillsFromBacktest","description":"B6 — the bridge from a backtest's trades to the ledger's fills: one `NormalizedFill` per trade,\nkeyed by `instrumentId = symbol`, the contract multiplier the en","category":"@insiderfinance/totalfinance/backtest/execution","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/execution function  (input) (input).accountId (input).currency (input).instruments (input).sourceId (input).trades"},{"title":"orderTouchSequence","url":"/reference/totalfinance/backtest/execution/page-3#orderTouchSequence","description":"Resolve the fill sequence of the orders a bar touched. Touches on one side of the open are\nnever ambiguous (nearer the open fills first). Touches on both sides ","category":"@insiderfinance/totalfinance/backtest/execution","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/execution function  (input) (input).bar (input).bar.close (input).bar.high (input).bar.low (input).bar.open (input).policy (input).touches return.ambiguous retu"},{"title":"requireExecutionPolicy","url":"/reference/totalfinance/backtest/execution/page-3#requireExecutionPolicy","description":"Validate a whole {@link ExecutionPolicy} — what `execution.declared` builds and every engine echoes.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/execution function  (functionName) (label) (value)"},{"title":"requireFillContext","url":"/reference/totalfinance/backtest/execution/page-3#requireFillContext","description":"Validate a {@link FillContext}.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/execution function  (functionName) (label) (value)"},{"title":"requireFillDecision","url":"/reference/totalfinance/backtest/execution/page-3#requireFillDecision","description":"Validate a {@link FillDecision}: the closed `filled | unfilled` union.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/execution function  (functionName) (label) (value)"},{"title":"requireMarginPolicy","url":"/reference/totalfinance/backtest/execution/page-3#requireMarginPolicy","description":"Validate a {@link MarginPolicy}: rates in [0, 1], maintenance ≤ initial, a buying power ≥ 1.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/execution function  (functionName) (label) (value)"},{"title":"requireMarketObservation","url":"/reference/totalfinance/backtest/execution/page-3#requireMarketObservation","description":"Validate a {@link MarketObservation}: the closed union over bar, quote, trade, and order book.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/execution function  (functionName) (label) (value)"},{"title":"requireOrderIntent","url":"/reference/totalfinance/backtest/execution/page-3#requireOrderIntent","description":"Validate an {@link OrderIntent}: a closed record whose prices match its order type.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/execution function  (functionName) (label) (value)"},{"title":"requiredInitialMargin","url":"/reference/totalfinance/backtest/execution/page-3#requiredInitialMargin","description":"Equity a new position of `notional` requires at entry under the policy.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/execution function  (input) (input).notional (input).policy"},{"title":"spreadModels","url":"/reference/totalfinance/backtest/execution/page-4#spreadModels","description":"Spread models: an aggressor pays half the quoted spread on top of the reference price.","category":"@insiderfinance/totalfinance/backtest/execution","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/execution value  halfSpreadBps halfSpreadBps().return.halfSpread halfSpreadBps().return.label halfSpreadBps(bps) none none().return.halfSpread none().return."},{"title":"AppliedMarkingPolicy","url":"/reference/totalfinance/backtest/options#AppliedMarkingPolicy","description":"The applied marking policy, echoed in the assumptions.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  maximumQuoteAgeMs missingMark volatility"},{"title":"BookPolicy","url":"/reference/totalfinance/backtest/options#BookPolicy","description":"How many trades the book may hold (Stage 4.6).","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  maximumOpenPositions maximumPerUnderlying"},{"title":"ChainSnapshot","url":"/reference/totalfinance/backtest/options#ChainSnapshot","description":"One dated option chain: every listed quote at a single point in time (the backtest's tick).","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  asOf quotes underlyingPrice"},{"title":"DaysToExpiryTarget","url":"/reference/totalfinance/backtest/options#DaysToExpiryTarget","description":"Which listed expiry to trade: the one whose days-to-expiry is nearest `target`, within `[min,max]`.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  max min target"},{"title":"DeltaHedgeRule","url":"/reference/totalfinance/backtest/options#DeltaHedgeRule","description":"Keep the portfolio delta-neutral by trading the underlying whenever |net delta| exceeds the band.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  commission commission.commission commission.commission(input) commission.commission(input).price commission.commission(input).quantity commi"},{"title":"DividendRecord","url":"/reference/totalfinance/backtest/options#DividendRecord","description":"A cash dividend on an underlying — early-assignment and dividend-risk evidence.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  amount exDate underlying"},{"title":"DividendRiskRow","url":"/reference/totalfinance/backtest/options#DividendRiskRow","description":"Dividend-risk evidence for one open short call at a snapshot before an ex-date.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  atRisk dividend exDate extrinsic legIndex tradeId underlying"},{"title":"EntryContext","url":"/reference/totalfinance/backtest/options#EntryContext","description":"Context passed to entry callbacks (`when` / `build`).","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  asOf cash equity flat openTrades snapshot snapshot.asOf snapshot.quotes snapshot.underlyingPrice"},{"title":"EntryRule","url":"/reference/totalfinance/backtest/options#EntryRule","description":"The entry rule — a discriminated union over `structure`, mirroring `strategyFromChain`'s option\ngrammar so the declarative form maps 1:1 onto the library. The `","category":"@insiderfinance/totalfinance/backtest/options","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/options type  "},{"title":"EntryStructure","url":"/reference/totalfinance/backtest/options#EntryStructure","description":"The declarative single-expiry `structure` values (a subset of {@link FromChainType}).","category":"@insiderfinance/totalfinance/backtest/options","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/options type  "},{"title":"EntryWhen","url":"/reference/totalfinance/backtest/options#EntryWhen","description":"When to open a position: only when this rule is flat (default), whenever the book has room, or a caller predicate.","category":"@insiderfinance/totalfinance/backtest/options","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/options type  "},{"title":"ExitContext","url":"/reference/totalfinance/backtest/options#ExitContext","description":"Context passed to exit / roll callbacks.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  asOf daysToExpiry entryPremium greeks greeks.delta greeks.gamma greeks.rho greeks.theta greeks.vega markToMarket netDelta pnlFraction positi"},{"title":"ExitReason","url":"/reference/totalfinance/backtest/options#ExitReason","description":"Why a trade closed.","category":"@insiderfinance/totalfinance/backtest/options","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/options type  "},{"title":"ExitRule","url":"/reference/totalfinance/backtest/options#ExitRule","description":"When to close a position. Declarative triggers OR-combine with the `when` callback; the first to\nfire closes the trade (its name is recorded as the exit reason)","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  daysToExpiry profitTarget stopLoss when when(context) when(context).asOf when(context).daysToExpiry when(context).entryPremium when(context)"},{"title":"FillPolicy","url":"/reference/totalfinance/backtest/options#FillPolicy","description":"How a structure's legs fill at entry (Stage 4.6).","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  mode partialFill price"},{"title":"FillRejection","url":"/reference/totalfinance/backtest/options#FillRejection","description":"An entry the fill policy rejected (Stage 4.6): the legs that could not fill and why.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  asOf code mode ruleId structure unfilledLegs"},{"title":"GreekAttribution","url":"/reference/totalfinance/backtest/options#GreekAttribution","description":"Strategy-level greek P&L attribution — the per-trade `TradePnlExplain`s summed across every trade.\nAnswers \"where did the P&L come from\": how much of the realiz","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  charm delta deltaRate gamma phi rho rhoConvexity theta thetaConvexity thetaRate total trades unexplained vanna vega vera veta vomma"},{"title":"LegAttribution","url":"/reference/totalfinance/backtest/options#LegAttribution","description":"Per-leg realized P&L attribution for a closed (or marked-at-end) options trade.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  leg leg.expiry leg.impliedVolatility leg.kind leg.premium leg.price leg.quantity leg.strike realizedPnl"},{"title":"LegRoleAttribution","url":"/reference/totalfinance/backtest/options#LegRoleAttribution","description":"Realized P&L grouped by leg role (`short put`, `long call`, `stock`, …) across every trade.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  legs realizedPnl role"},{"title":"LimitRejection","url":"/reference/totalfinance/backtest/options#LimitRejection","description":"An entry a limit rejected (Stage 4.6): the limit, the value the book would have had, the bound.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  asOf bound code limit ruleId structure value"},{"title":"MarkSource","url":"/reference/totalfinance/backtest/options/page-2#MarkSource","description":"Where one open option leg's volatility came from at one snapshot (Preview P1).","category":"@insiderfinance/totalfinance/backtest/options","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/options type  "},{"title":"MarkingPolicy","url":"/reference/totalfinance/backtest/options/page-2#MarkingPolicy","description":"How open option legs are marked at every snapshot (Preview P1 — `docs/specs/options-backtest.md`,\n\"Preview P1 amendment\"). Every member is optional; the default","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  maximumQuoteAgeMs missingMark volatility"},{"title":"MissingMarkCause","url":"/reference/totalfinance/backtest/options/page-2#MissingMarkCause","description":"Why a current contract quote could not mark a leg (Preview P1).","category":"@insiderfinance/totalfinance/backtest/options","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/options type  "},{"title":"MultiExpirySelection","url":"/reference/totalfinance/backtest/options/page-2#MultiExpirySelection","description":"Multi-expiry selection for calendars and diagonals: the near leg by delta, the far leg by days.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  farDaysToExpiry farDaysToExpiry.max farDaysToExpiry.min farDaysToExpiry.target nearDaysToExpiry nearDaysToExpiry.max nearDaysToExpiry.min ne"},{"title":"MultiExpiryStructure","url":"/reference/totalfinance/backtest/options/page-2#MultiExpiryStructure","description":"The declarative multi-expiry structures (Stage 4.6), built through `@insiderfinance/totalfinance/strategy`'s constructors.","category":"@insiderfinance/totalfinance/backtest/options","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/options type  "},{"title":"OPTIONS_BOOK_CEILING","url":"/reference/totalfinance/backtest/options/page-2#OPTIONS_BOOK_CEILING","description":"Decision 9: open positions one book may hold.","category":"@insiderfinance/totalfinance/backtest/options","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/options value  "},{"title":"OpenTradeView","url":"/reference/totalfinance/backtest/options/page-2#OpenTradeView","description":"What a callback may see of an open trade: identity, structure, and the current mark.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  entryAsOf entryPremium legs markToMarket ruleId structure tradeId underlying"},{"title":"OptionsBacktestAssumptions","url":"/reference/totalfinance/backtest/options/page-2#OptionsBacktestAssumptions","description":"Applied conventions, echoed (the envelope law).","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  assignment baseCurrency book book.maximumOpenPositions book.maximumPerUnderlying commission conventionsVersion corporateActions dividendYiel"},{"title":"OptionsBacktestConfig","url":"/reference/totalfinance/backtest/options/page-2#OptionsBacktestConfig","description":"interface from @insiderfinance/totalfinance/backtest/options","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  assignment baseCurrency book book.maximumOpenPositions book.maximumPerUnderlying chains commission commission.commission commission.commissi"},{"title":"OptionsBacktestDiagnostics","url":"/reference/totalfinance/backtest/options/page-2#OptionsBacktestDiagnostics","description":"interface from @insiderfinance/totalfinance/backtest/options","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  autoReason converged corporateActionsApplied decomposition earlyAssignmentCount engine fillRejectionCount finiteDifferenceBumps iterations l"},{"title":"OptionsBacktestResult","url":"/reference/totalfinance/backtest/options/page-2#OptionsBacktestResult","description":"The result of an options backtest.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  assumptions assumptions.assignment assumptions.baseCurrency assumptions.book assumptions.book.maximumOpenPositions assumptions.book.maximumP"},{"title":"OptionsTearSheet","url":"/reference/totalfinance/backtest/options/page-2#OptionsTearSheet","description":"interface from @insiderfinance/totalfinance/backtest/options","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  assumptions assumptions.assignment assumptions.baseCurrency assumptions.book assumptions.book.maximumOpenPositions assumptions.book.maximumP"},{"title":"OptionsTrade","url":"/reference/totalfinance/backtest/options/page-2#OptionsTrade","description":"One round-trip options trade in the backtest.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  contracts costs entryAsOf entryPremium exitAsOf exitReason exitVolatilities expiry legInstrumentIds legSettlements legs lineage marks marks."},{"title":"OptionsTradeStatistics","url":"/reference/totalfinance/backtest/options/page-2#OptionsTradeStatistics","description":"Options-strategy summary stats over the closed trades.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  assignments averageCredit averageDaysHeld averagePnl closed losses totalCosts winRate wins"},{"title":"PortfolioLimits","url":"/reference/totalfinance/backtest/options/page-2#PortfolioLimits","description":"Pre-trade limits evaluated on the post-trade book; a breach rejects the entry with a row.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  maximumConcentration maximumMarginFraction maximumNetDelta maximumNetVega scenarioLoss scenarioLoss.maximumLossFraction scenarioLoss.spotSho"},{"title":"QuoteFreshnessPolicy","url":"/reference/totalfinance/backtest/options/page-2#QuoteFreshnessPolicy","description":"A quote older than this at the decision instant cannot fill (the fill-side twin of `marking.maximumQuoteAgeMs`).","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  maximumQuoteAgeMs"},{"title":"RollRule","url":"/reference/totalfinance/backtest/options/page-2#RollRule","description":"Roll instead of closing flat: when the rule fires, close and immediately re-enter via `entry`.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  when when.daysToExpiry when.profitTarget when.stopLoss when.when when.when(context) when.when(context).asOf when.when(context).daysToExpiry "},{"title":"Sizing","url":"/reference/totalfinance/backtest/options/page-2#Sizing","description":"How to size a position: a fixed contract count, or margin-aware (largest count within a budget).","category":"@insiderfinance/totalfinance/backtest/options","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/options type  maxMarginFraction quantity"},{"title":"StructureAttribution","url":"/reference/totalfinance/backtest/options/page-2#StructureAttribution","description":"Realized P&L grouped by the constructed structure (e.g. `bullPutSpread`).","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  realizedPnl structure trades winRate"},{"title":"SurfaceRow","url":"/reference/totalfinance/backtest/options/page-2#SurfaceRow","description":"The volatility surface's evolution, one row per snapshot (bounded by the snapshot count).","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  asOf atTheMoneyVolatilityByExpiry dividendRisk markSources markSources.carried markSources.currentQuote markSources.entryVolatility markSour"},{"title":"TradeLineage","url":"/reference/totalfinance/backtest/options/page-3#TradeLineage","description":"A corporate action applied to an open trade's legs, with what changed.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  action adjusted adjusted.multiplier adjusted.strikes adjusted.underlying asOf effectiveDate lineageId previous previous.multiplier previous."},{"title":"TradeMarkCounts","url":"/reference/totalfinance/backtest/options/page-3#TradeMarkCounts","description":"How many leg-snapshot marks of a trade came from each source (Preview P1 evidence).","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  carried currentQuote entryVolatility impliedFromPrice snapshots"},{"title":"TradePnlExplain","url":"/reference/totalfinance/backtest/options/page-3#TradePnlExplain","description":"A closed trade's **greek P&L explain** (entry → exit): the realized gross mark P&L decomposed into\ngreek contributions (the full 2nd-order Taylor + dividend car","category":"@insiderfinance/totalfinance/backtest/options","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/options type  charm delta deltaRate gamma phi rho rhoConvexity theta thetaConvexity thetaRate total unexplained vanna vega vera veta vomma"},{"title":"UnfilledLeg","url":"/reference/totalfinance/backtest/options/page-3#UnfilledLeg","description":"A leg a legged fill could not fill, with why.","category":"@insiderfinance/totalfinance/backtest/options","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/options interface  cause leg leg.expiry leg.impliedVolatility leg.kind leg.premium leg.price leg.quantity leg.strike"},{"title":"optionsBacktest","url":"/reference/totalfinance/backtest/options/page-3#optionsBacktest","description":"function from @insiderfinance/totalfinance/backtest/options","category":"@insiderfinance/totalfinance/backtest/options","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/options function  (config) (config).assignment (config).baseCurrency (config).book (config).chains (config).commission (config).corporateActions (config).divi"},{"title":"optionsTearSheet","url":"/reference/totalfinance/backtest/options/page-3#optionsTearSheet","description":"Build the options tear sheet from an {@link OptionsBacktestResult}.","category":"@insiderfinance/totalfinance/backtest/options","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/options function  (result) (result).assumptions (result).diagnostics (result).fillRejections (result).fills (result).finalValue (result).ledger (result).limit"},{"title":"requireOptionsBacktestConfig","url":"/reference/totalfinance/backtest/options/page-3#requireOptionsBacktestConfig","description":"The closed guard for `optionsBacktest` (Stage 4.6): the generated closed-request spec over the\nwhole declaration, then the hand laws — the iterable `chains`, th","category":"@insiderfinance/totalfinance/backtest/options","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/options function  (functionName) (label) (value)"},{"title":"CreatePaperBrokerInput","url":"/reference/totalfinance/backtest/paper#CreatePaperBrokerInput","description":"interface from @insiderfinance/totalfinance/backtest/paper","category":"@insiderfinance/totalfinance/backtest/paper","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/paper interface  accountId baseCurrency execution execution.ambiguity execution.costs execution.costs.borrow execution.costs.borrow.annualRate execution.cost"},{"title":"EXECUTION_RECEIPT_KIND","url":"/reference/totalfinance/backtest/paper#EXECUTION_RECEIPT_KIND","description":"value from @insiderfinance/totalfinance/backtest/paper","category":"@insiderfinance/totalfinance/backtest/paper","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/paper value  "},{"title":"EXECUTION_RECEIPT_SCHEMA_VERSION","url":"/reference/totalfinance/backtest/paper#EXECUTION_RECEIPT_SCHEMA_VERSION","description":"value from @insiderfinance/totalfinance/backtest/paper","category":"@insiderfinance/totalfinance/backtest/paper","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/paper value  "},{"title":"ExecutionReceipt","url":"/reference/totalfinance/backtest/paper#ExecutionReceipt","description":"The receipt of one submission — the same object for a retry with the same key and plan.","category":"@insiderfinance/totalfinance/backtest/paper","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/paper interface  accountId adapter assumptions assumptions.conventionsVersion assumptions.execution assumptions.execution.ambiguity assumptions.execution.cos"},{"title":"PaperBroker","url":"/reference/totalfinance/backtest/paper#PaperBroker","description":"interface from @insiderfinance/totalfinance/backtest/paper","category":"@insiderfinance/totalfinance/backtest/paper","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/paper interface  cancel cancel().return.accepted cancel().return.journal cancel().return.orderId cancel().return.state cancel(input) cancel(input).now cancel"},{"title":"PaperBrokerDescription","url":"/reference/totalfinance/backtest/paper#PaperBrokerDescription","description":"interface from @insiderfinance/totalfinance/backtest/paper","category":"@insiderfinance/totalfinance/backtest/paper","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/paper interface  accountId adapter eventCount execution execution.ambiguity execution.costs execution.costs.borrow execution.costs.commission execution.costs"},{"title":"PaperCancelInput","url":"/reference/totalfinance/backtest/paper#PaperCancelInput","description":"interface from @insiderfinance/totalfinance/backtest/paper","category":"@insiderfinance/totalfinance/backtest/paper","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/paper interface  now orderId"},{"title":"PaperCancelResult","url":"/reference/totalfinance/backtest/paper#PaperCancelResult","description":"interface from @insiderfinance/totalfinance/backtest/paper","category":"@insiderfinance/totalfinance/backtest/paper","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/paper interface  accepted journal orderId state state.averageFillPrice state.cancelRequested state.fillIds state.filledQuantity state.lastEventId state.lastT"},{"title":"PaperDeliverInput","url":"/reference/totalfinance/backtest/paper#PaperDeliverInput","description":"interface from @insiderfinance/totalfinance/backtest/paper","category":"@insiderfinance/totalfinance/backtest/paper","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/paper interface  event event.detail event.detail.accountId event.detail.artifactHash event.detail.baseCurrency event.detail.comboId event.detail.executionPol"},{"title":"PaperDeliverResult","url":"/reference/totalfinance/backtest/paper#PaperDeliverResult","description":"interface from @insiderfinance/totalfinance/backtest/paper","category":"@insiderfinance/totalfinance/backtest/paper","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/paper interface  applied duplicate events fill fill.accountId fill.accruedInterest fill.contract fill.contract.expiryTimestampMs fill.contract.kind fill.cont"},{"title":"PaperHaltInput","url":"/reference/totalfinance/backtest/paper#PaperHaltInput","description":"interface from @insiderfinance/totalfinance/backtest/paper","category":"@insiderfinance/totalfinance/backtest/paper","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/paper interface  now reason"},{"title":"PaperHaltResult","url":"/reference/totalfinance/backtest/paper#PaperHaltResult","description":"interface from @insiderfinance/totalfinance/backtest/paper","category":"@insiderfinance/totalfinance/backtest/paper","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/paper interface  cancelled halted journal reason"},{"title":"PaperInstrument","url":"/reference/totalfinance/backtest/paper#PaperInstrument","description":"What the broker needs to know about an instrument to write a ledger fill for it.","category":"@insiderfinance/totalfinance/backtest/paper","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/paper interface  contract contract.expiryTimestampMs contract.kind contract.strikePricePerUnit contract.type contract.underlyingInstrumentId contractMultipli"},{"title":"PaperStepInput","url":"/reference/totalfinance/backtest/paper#PaperStepInput","description":"interface from @insiderfinance/totalfinance/backtest/paper","category":"@insiderfinance/totalfinance/backtest/paper","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/paper interface  asOf observations"},{"title":"PaperStepResult","url":"/reference/totalfinance/backtest/paper#PaperStepResult","description":"interface from @insiderfinance/totalfinance/backtest/paper","category":"@insiderfinance/totalfinance/backtest/paper","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/paper interface  asOf events expired fills journal open unfilled"},{"title":"PaperSubmitInput","url":"/reference/totalfinance/backtest/paper#PaperSubmitInput","description":"interface from @insiderfinance/totalfinance/backtest/paper","category":"@insiderfinance/totalfinance/backtest/paper","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/paper interface  grant grant.accountId grant.approvedBy grant.baseCurrency grant.comboIds grant.contentHash grant.expiresAt grant.grantId grant.idempotencyKe"},{"title":"createPaperBroker","url":"/reference/totalfinance/backtest/paper#createPaperBroker","description":"Build the paper broker over a declared execution policy and a ledger's account. Every method is\nexplicit about time (`now` / `asOf`), every journal write folds ","category":"@insiderfinance/totalfinance/backtest/paper","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/paper function  (input) (input).accountId (input).baseCurrency (input).execution (input).instruments (input).journal (input).sourceId return.cancel return.d"},{"title":"requireCreatePaperBrokerInput","url":"/reference/totalfinance/backtest/paper#requireCreatePaperBrokerInput","description":"function from @insiderfinance/totalfinance/backtest/paper","category":"@insiderfinance/totalfinance/backtest/paper","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/paper function  (functionName) (label) (value) return.accountId return.baseCurrency return.execution return.instruments return.journal return.sourceId"},{"title":"requirePaperInstrument","url":"/reference/totalfinance/backtest/paper#requirePaperInstrument","description":"function from @insiderfinance/totalfinance/backtest/paper","category":"@insiderfinance/totalfinance/backtest/paper","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/paper function  (functionName) (label) (value) return.contract return.contractMultiplier return.currency return.settlementLag return.settlementStyle"},{"title":"AccountingPolicy","url":"/reference/totalfinance/backtest/portfolio#AccountingPolicy","description":"interface from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  baseCurrency initialCash lotRelief settlement"},{"title":"AssetClass","url":"/reference/totalfinance/backtest/portfolio#AssetClass","description":"The asset classes the accounting's settlement table and the classifications name.","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/portfolio type  "},{"title":"CouponRecord","url":"/reference/totalfinance/backtest/portfolio#CouponRecord","description":"interface from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  amountPerUnit instrumentId paymentDate"},{"title":"CouponTerms","url":"/reference/totalfinance/backtest/portfolio#CouponTerms","description":"A bond's coupon terms — accrued interest is computed from these, never fetched.","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  annualRate dayCount faceValuePerUnit issueDate maturityDate paymentsPerYear"},{"title":"DatedCurrencyPairQuote","url":"/reference/totalfinance/backtest/portfolio#DatedCurrencyPairQuote","description":"A dated FX quote to the base currency.","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  baseCurrency quoteCurrency quotePerBase timestampMs"},{"title":"DividendRecord","url":"/reference/totalfinance/backtest/portfolio#DividendRecord","description":"interface from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  amount exDate instrumentId payDate"},{"title":"ExternalFlowRecord","url":"/reference/totalfinance/backtest/portfolio#ExternalFlowRecord","description":"interface from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  amount currency timestampMs"},{"title":"FillTerms","url":"/reference/totalfinance/backtest/portfolio#FillTerms","description":"The fill terms an adapter stamps on every fill of its instrument.","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/portfolio type  contract contract.expiryTimestampMs contract.kind contract.strikePricePerUnit contract.type contract.underlyingInstrumentId contractMultipli"},{"title":"ForwardRateRecord","url":"/reference/totalfinance/backtest/portfolio#ForwardRateRecord","description":"interface from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  forwardRate instrumentId timestampMs"},{"title":"ForwardTerms","url":"/reference/totalfinance/backtest/portfolio#ForwardTerms","description":"A forward contract on a currency pair, marked from a caller-supplied forward-rate series.","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  baseCurrency contractRate maturityTimestampMs quoteCurrency"},{"title":"FundingRateRecord","url":"/reference/totalfinance/backtest/portfolio#FundingRateRecord","description":"interface from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  fundingRate instrumentId timestampMs"},{"title":"InstrumentKind","url":"/reference/totalfinance/backtest/portfolio#InstrumentKind","description":"The instrument kinds with a built-in adapter, plus `custom`.","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/portfolio type  "},{"title":"LatestObservations","url":"/reference/totalfinance/backtest/portfolio#LatestObservations","description":"The latest observation of each kind at or before the instant, per instrument.","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  bar bar.adjusted bar.close bar.high bar.low bar.open bar.symbol bar.timestampMs bar.volume bar.vwap chainQuote chainQuote.ask chainQuote.ask"},{"title":"LifecycleFacts","url":"/reference/totalfinance/backtest/portfolio#LifecycleFacts","description":"The facts an adapter's lifecycle sees for one instrument in `(previousAsOf, asOf]`.","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  corporateActions coupons dividends fundingRates"},{"title":"LifecycleInput","url":"/reference/totalfinance/backtest/portfolio#LifecycleInput","description":"interface from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  asOf facts facts.corporateActions facts.coupons facts.dividends facts.fundingRates held held.contractMultiplier held.quantity instrumentId l"},{"title":"LiquidationRow","url":"/reference/totalfinance/backtest/portfolio#LiquidationRow","description":"interface from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  asOf code instrumentId policy quantity shortfall"},{"title":"MarkInput","url":"/reference/totalfinance/backtest/portfolio#MarkInput","description":"interface from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  asOf instrumentId latest latest.bar latest.bar.adjusted latest.bar.close latest.bar.high latest.bar.low latest.bar.open latest.bar.symbol la"},{"title":"MarkOutcome","url":"/reference/totalfinance/backtest/portfolio#MarkOutcome","description":"type from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/portfolio type  pricePerUnit source unavailable"},{"title":"OrderRecord","url":"/reference/totalfinance/backtest/portfolio/page-2#OrderRecord","description":"interface from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  asOf filledQuantity instrumentId orderId outcome quantity reason side source type"},{"title":"OrderSource","url":"/reference/totalfinance/backtest/portfolio/page-2#OrderSource","description":"type from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/portfolio type  "},{"title":"PORTFOLIO_CALENDARS","url":"/reference/totalfinance/backtest/portfolio/page-2#PORTFOLIO_CALENDARS","description":"value from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/portfolio value  "},{"title":"PORTFOLIO_INSTRUMENT_CEILING","url":"/reference/totalfinance/backtest/portfolio/page-2#PORTFOLIO_INSTRUMENT_CEILING","description":"Decision 9: instruments one run may hold.","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/portfolio value  "},{"title":"PORTFOLIO_ROW_CEILING","url":"/reference/totalfinance/backtest/portfolio/page-2#PORTFOLIO_ROW_CEILING","description":"Decision 9: rows one run may read per row set.","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/portfolio value  "},{"title":"PortfolioBacktestAssumptions","url":"/reference/totalfinance/backtest/portfolio/page-2#PortfolioBacktestAssumptions","description":"interface from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  baseCurrency calendar conventionsVersion execution execution.ambiguity execution.costs execution.costs.borrow execution.costs.commission exe"},{"title":"PortfolioBacktestDiagnostics","url":"/reference/totalfinance/backtest/portfolio/page-2#PortfolioBacktestDiagnostics","description":"interface from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  autoReason converged decomposition engine externalFlowCount fillCount finiteDifferenceBumps iterations lifecycleEventCount liquidationCount "},{"title":"PortfolioMarketData","url":"/reference/totalfinance/backtest/portfolio/page-2#PortfolioMarketData","description":"interface from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  bars corporateActions coupons dividends forwardRates fundingRates fxRates optionChains orderBooks quotes trades"},{"title":"PortfolioStrategy","url":"/reference/totalfinance/backtest/portfolio/page-2#PortfolioStrategy","description":"type from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/backtest/portfolio type  model model.baseCurrency model.benchmark model.benchmark.asOf model.benchmark.benchmarkId model.benchmark.constituents model.contentHash mod"},{"title":"RebalanceSchedule","url":"/reference/totalfinance/backtest/portfolio/page-2#RebalanceSchedule","description":"interface from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  frequency"},{"title":"RejectionRow","url":"/reference/totalfinance/backtest/portfolio/page-2#RejectionRow","description":"interface from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  asOf code detail instrumentId orderId"},{"title":"RollTerms","url":"/reference/totalfinance/backtest/portfolio/page-2#RollTerms","description":"A future's declared roll: the successor contract and how many sessions before expiry to roll.","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  sessionsBeforeExpiry toInstrumentId"},{"title":"SessionContext","url":"/reference/totalfinance/backtest/portfolio/page-2#SessionContext","description":"What a direct strategy sees at a decision instant.","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  asOf cash index instruments marks netAssetValue observations positions"},{"title":"SessionPosition","url":"/reference/totalfinance/backtest/portfolio/page-2#SessionPosition","description":"interface from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/backtest/portfolio interface  baseCurrencyMarketValue contractMultiplier currency instrumentId markPricePerUnit quantity"},{"title":"accruedFromTerms","url":"/reference/totalfinance/backtest/portfolio/page-2#accruedFromTerms","description":"Finite accrued interest per unit of quantity at the instant, from the coupon terms alone.\nRefuses terms whose calculation overflows, even when their individual ","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/portfolio function  (asOf) (terms) (terms).annualRate (terms).dayCount (terms).faceValuePerUnit (terms).issueDate (terms).maturityDate (terms).paymentsPerYear"},{"title":"adapterFor","url":"/reference/totalfinance/backtest/portfolio/page-3#adapterFor","description":"The adapter a specification uses: its own for `custom`, the built-in otherwise.","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/portfolio function  (instrumentId) (specification) (specification).adapter (specification).assetClass (specification).classification (specification).contract (s"},{"title":"assertInstrumentAdapterConformance","url":"/reference/totalfinance/backtest/portfolio/page-3#assertInstrumentAdapterConformance","description":"The conformance suite (Decision 6a): pure, deterministic, finite, JSON-safe, payloads shaped as events.","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/portfolio function  (input) (input).adapter (input).fixtures (input).fixtures.lifecycle (input).fixtures.mark return.kind return.lifecycles return.marks return."},{"title":"instrumentAdapters","url":"/reference/totalfinance/backtest/portfolio/page-3#instrumentAdapters","description":"The built-in adapters, keyed by kind.","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"value","keywords":"@insiderfinance/totalfinance/backtest/portfolio value  "},{"title":"requireAccountingPolicy","url":"/reference/totalfinance/backtest/portfolio/page-3#requireAccountingPolicy","description":"function from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/portfolio function  (field) (functionName) (value) return.baseCurrency return.initialCash return.lotRelief return.settlement"},{"title":"requireInstrumentSpecification","url":"/reference/totalfinance/backtest/portfolio/page-3#requireInstrumentSpecification","description":"function from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/portfolio function  (field) (functionName) (value) return.adapter return.assetClass return.classification return.contract return.contractMultiplier return.coupo"},{"title":"requirePortfolioBacktestRequest","url":"/reference/totalfinance/backtest/portfolio/page-3#requirePortfolioBacktestRequest","description":"function from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/portfolio function  (functionName) (label) (value) return.accounting return.calendar return.execution return.externalFlows return.instruments return.marketData "},{"title":"requirePortfolioMarketData","url":"/reference/totalfinance/backtest/portfolio/page-3#requirePortfolioMarketData","description":"function from @insiderfinance/totalfinance/backtest/portfolio","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/portfolio function  (field) (functionName) (value) return.bars return.corporateActions return.coupons return.dividends return.forwardRates return.fundingRates r"},{"title":"requirePortfolioStepperRequest","url":"/reference/totalfinance/backtest/portfolio/page-3#requirePortfolioStepperRequest","description":"The stepper's request (Stage 7B.1): `portfolioBacktest`'s request without a strategy — the orders\ncome from `close()`. A `strategy` member teaches which verb wa","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/portfolio function  (functionName) (label) (value) return.accounting return.calendar return.execution return.externalFlows return.instruments return.marketData "},{"title":"splitShares","url":"/reference/totalfinance/backtest/portfolio/page-3#splitShares","description":"A rational approximation of a split ratio as positive integers (2 → 2:1, 0.5 → 1:2, 1.5 → 3:2).","category":"@insiderfinance/totalfinance/backtest/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/backtest/portfolio function  (ratio) return.sharesAfterSplit return.sharesBeforeSplit"},{"title":"CALENDAR_DATA_VERSION","url":"/reference/totalfinance/calendars#CALENDAR_DATA_VERSION","description":"Bump when the holiday rules or closure list change.","category":"@insiderfinance/totalfinance/calendars","kind":"value","keywords":"@insiderfinance/totalfinance/calendars value  "},{"title":"CBOE","url":"/reference/totalfinance/calendars#CBOE","description":"value from @insiderfinance/totalfinance/calendars","category":"@insiderfinance/totalfinance/calendars","kind":"value","keywords":"@insiderfinance/totalfinance/calendars value  addBusinessDays addBusinessDays(date) addBusinessDays(days) businessDaysBetween businessDaysBetween(from) businessDaysBetween(to) isBusiness @insiderfinance/totalfinance/calendars/cboe"},{"title":"Calendar","url":"/reference/totalfinance/calendars#Calendar","description":"interface from @insiderfinance/totalfinance/calendars","category":"@insiderfinance/totalfinance/calendars","kind":"interface","keywords":"@insiderfinance/totalfinance/calendars interface  addBusinessDays addBusinessDays(date) addBusinessDays(days) businessDaysBetween businessDaysBetween(from) businessDaysBetween(to) isBusiness @insiderfinance/totalfinance/core"},{"title":"ExpirationKind","url":"/reference/totalfinance/calendars#ExpirationKind","description":"type from @insiderfinance/totalfinance/calendars","category":"@insiderfinance/totalfinance/calendars","kind":"type","keywords":"@insiderfinance/totalfinance/calendars type  "},{"title":"NYSE","url":"/reference/totalfinance/calendars#NYSE","description":"value from @insiderfinance/totalfinance/calendars","category":"@insiderfinance/totalfinance/calendars","kind":"value","keywords":"@insiderfinance/totalfinance/calendars value  addBusinessDays addBusinessDays(date) addBusinessDays(days) businessDaysBetween businessDaysBetween(from) businessDaysBetween(to) isBusiness @insiderfinance/totalfinance/calendars/nyse"},{"title":"TradingCalendar","url":"/reference/totalfinance/calendars#TradingCalendar","description":"A core `Calendar` extended with trader vocabulary.","category":"@insiderfinance/totalfinance/calendars","kind":"interface","keywords":"@insiderfinance/totalfinance/calendars interface  addBusinessDays addBusinessDays(date) addBusinessDays(days) businessDaysBetween businessDaysBetween(from) businessDaysBetween(to) isBusiness"},{"title":"US_EQUITY_CALENDAR_COVERAGE","url":"/reference/totalfinance/calendars#US_EQUITY_CALENDAR_COVERAGE","description":"Documented closure-data boundary; future ad-hoc closures cannot be predicted from rules.","category":"@insiderfinance/totalfinance/calendars","kind":"value","keywords":"@insiderfinance/totalfinance/calendars value  dataVersion historicalFloor limitations verifiedThrough"},{"title":"crypto24x7","url":"/reference/totalfinance/calendars#crypto24x7","description":"The 24×7 crypto calendar with trader vocabulary (R10).","category":"@insiderfinance/totalfinance/calendars","kind":"value","keywords":"@insiderfinance/totalfinance/calendars value  addBusinessDays addBusinessDays(date) addBusinessDays(days) businessDaysBetween businessDaysBetween(from) businessDaysBetween(to) isBusiness @insiderfinance/totalfinance/calendars/crypto"},{"title":"expirations","url":"/reference/totalfinance/calendars#expirations","description":"Option expirations in `[from, to]` (inclusive), holiday-shifted per the calendar. `kind`\ndefaults to `'monthly'` (the classic OPEX dates).","category":"@insiderfinance/totalfinance/calendars","kind":"function","keywords":"@insiderfinance/totalfinance/calendars function  (calendar) (calendar).addBusinessDays (calendar).businessDaysBetween (calendar).isBusinessDay (calendar).isHalfDay (calendar).isHoliday (cal"},{"title":"nextExpiry","url":"/reference/totalfinance/calendars#nextExpiry","description":"The first expiration strictly after `date` (`kind` defaults to `'weekly'` — the nearest Friday\nexpiry, holiday-shifted).","category":"@insiderfinance/totalfinance/calendars","kind":"function","keywords":"@insiderfinance/totalfinance/calendars function  (calendar) (calendar).addBusinessDays (calendar).businessDaysBetween (calendar).isBusinessDay (calendar).isHalfDay (calendar).isHoliday (cal"},{"title":"requireCalendar","url":"/reference/totalfinance/calendars#requireCalendar","description":"Validate that `value` is a usable `Calendar` object; throws a teaching `InputError` otherwise.\nShared by every facade in this package so garbage inputs (strings","category":"@insiderfinance/totalfinance/calendars","kind":"function","keywords":"@insiderfinance/totalfinance/calendars function  (functionName) (value) return.addBusinessDays return.businessDaysBetween return.isBusinessDay return.isHalfDay return.isHoliday return.name "},{"title":"tradingDaysToExpiry","url":"/reference/totalfinance/calendars#tradingDaysToExpiry","description":"Trading sessions remaining until an expiry — the days-to-expiry number traders scale\nvolatility with (`√(tradingDays / 252)`), counted on THIS calendar's actual","category":"@insiderfinance/totalfinance/calendars","kind":"function","keywords":"@insiderfinance/totalfinance/calendars function  (calendar) (calendar).addBusinessDays (calendar).businessDaysBetween (calendar).isBusinessDay (calendar).isHalfDay (calendar).isHoliday (cal"},{"title":"usMarketClosures","url":"/reference/totalfinance/calendars#usMarketClosures","description":"Ad-hoc full closures that no rule can derive. Complete for the era this list spans (2001→present);\ndates BEFORE 2001 are not covered — day counts across earlier","category":"@insiderfinance/totalfinance/calendars","kind":"value","keywords":"@insiderfinance/totalfinance/calendars value  "},{"title":"usMarketHalfDayRules","url":"/reference/totalfinance/calendars#usMarketHalfDayRules","description":"value from @insiderfinance/totalfinance/calendars","category":"@insiderfinance/totalfinance/calendars","kind":"value","keywords":"@insiderfinance/totalfinance/calendars value  "},{"title":"usMarketHolidayRules","url":"/reference/totalfinance/calendars#usMarketHolidayRules","description":"value from @insiderfinance/totalfinance/calendars","category":"@insiderfinance/totalfinance/calendars","kind":"value","keywords":"@insiderfinance/totalfinance/calendars value  "},{"title":"withTradingVocabulary","url":"/reference/totalfinance/calendars#withTradingVocabulary","description":"Extend a core `Calendar` with the trader-vocabulary alias `isTradingDay` (≡ `isBusinessDay`).\nReturns a new object; the wrapped methods are the ORIGINAL functio","category":"@insiderfinance/totalfinance/calendars","kind":"function","keywords":"@insiderfinance/totalfinance/calendars function  (calendar) (calendar).addBusinessDays (calendar).businessDaysBetween (calendar).isBusinessDay (calendar).isHalfDay (calendar).isHoliday (cal"},{"title":"CLI_COMMANDS","url":"/reference/totalfinance/cli#CLI_COMMANDS","description":"The `totalfinance` command surface, published so the CLI guide is checked against what ships (the\nsame standing as the MCP guide's tool list).","category":"@insiderfinance/totalfinance/cli","kind":"value","keywords":"@insiderfinance/totalfinance/cli value  "},{"title":"CLI_EXIT_CODES","url":"/reference/totalfinance/cli#CLI_EXIT_CODES","description":"The `totalfinance` exit codes — a contract (Stage 7A Decision 6), published so a caller's script and\nthe CLI guide's table are checked against the same values.","category":"@insiderfinance/totalfinance/cli","kind":"value","keywords":"@insiderfinance/totalfinance/cli value  inputRefused internal jobCancelled operationFailed success usage"},{"title":"CliCommand","url":"/reference/totalfinance/cli#CliCommand","description":"type from @insiderfinance/totalfinance/cli","category":"@insiderfinance/totalfinance/cli","kind":"type","keywords":"@insiderfinance/totalfinance/cli type  "},{"title":"CliExitCode","url":"/reference/totalfinance/cli#CliExitCode","description":"type from @insiderfinance/totalfinance/cli","category":"@insiderfinance/totalfinance/cli","kind":"type","keywords":"@insiderfinance/totalfinance/cli type  "},{"title":"JobRun","url":"/reference/totalfinance/cli#JobRun","description":"interface from @insiderfinance/totalfinance/cli","category":"@insiderfinance/totalfinance/cli","kind":"interface","keywords":"@insiderfinance/totalfinance/cli interface  cancel completion record record.error record.error.code record.error.context record.error.issues record.error.message record.error.operation @insiderfinance/totalfinance/workflows/local"},{"title":"JobRunner","url":"/reference/totalfinance/cli#JobRunner","description":"What a transport needs from a job runner — structural, so a host can supply its own.","category":"@insiderfinance/totalfinance/cli","kind":"interface","keywords":"@insiderfinance/totalfinance/cli interface  cancel cancel().return.error cancel().return.error.code cancel().return.error.context cancel().return.error.issues cancel().return.error.mes @insiderfinance/totalfinance/workflows/local"},{"title":"JobSubmission","url":"/reference/totalfinance/cli#JobSubmission","description":"interface from @insiderfinance/totalfinance/cli","category":"@insiderfinance/totalfinance/cli","kind":"interface","keywords":"@insiderfinance/totalfinance/cli interface  deadlineMs id inlineResultBytes input maxInputBytes requestId seed @insiderfinance/totalfinance/workflows/local"},{"title":"LocalJobRunnerInput","url":"/reference/totalfinance/cli#LocalJobRunnerInput","description":"interface from @insiderfinance/totalfinance/cli","category":"@insiderfinance/totalfinance/cli","kind":"interface","keywords":"@insiderfinance/totalfinance/cli interface  clock directory packs pollMs profile registry registry.describe registry.describe().return.annotations registry.describe().return.authorizat @insiderfinance/totalfinance/workflows/local"},{"title":"REGISTRY_PROFILES","url":"/reference/totalfinance/cli#REGISTRY_PROFILES","description":"value from @insiderfinance/totalfinance/cli","category":"@insiderfinance/totalfinance/cli","kind":"value","keywords":"@insiderfinance/totalfinance/cli value   @insiderfinance/totalfinance/workflows/local"},{"title":"RegistryProfile","url":"/reference/totalfinance/cli#RegistryProfile","description":"type from @insiderfinance/totalfinance/cli","category":"@insiderfinance/totalfinance/cli","kind":"type","keywords":"@insiderfinance/totalfinance/cli type   @insiderfinance/totalfinance/workflows/local"},{"title":"SubmitJobInput","url":"/reference/totalfinance/cli#SubmitJobInput","description":"interface from @insiderfinance/totalfinance/cli","category":"@insiderfinance/totalfinance/cli","kind":"interface","keywords":"@insiderfinance/totalfinance/cli interface  artifacts artifacts.get artifacts.get().return.handle artifacts.get().return.value artifacts.get(uri) artifacts.list artifacts.list(filter)  @insiderfinance/totalfinance/workflows/local"},{"title":"cancelJob","url":"/reference/totalfinance/cli#cancelJob","description":"Cancel a job from ANY process: the record moves to `cancelled`; the running process's runner terminates its worker on the next poll.","category":"@insiderfinance/totalfinance/cli","kind":"function","keywords":"@insiderfinance/totalfinance/cli function  (input) (input).clock (input).id (input).jobs return.error return.error.code return.error.context return.error.issues return.error.message r @insiderfinance/totalfinance/workflows/local"},{"title":"createFileArtifactStore","url":"/reference/totalfinance/cli#createFileArtifactStore","description":"A file-backed artifact store: `<directory>/artifacts/<namespace>_<hash>.json` per value, plus\n`<directory>/artifacts/index.json` listing every handle. Idempoten","category":"@insiderfinance/totalfinance/cli","kind":"function","keywords":"@insiderfinance/totalfinance/cli function  (input) (input).directory return.get return.list return.put @insiderfinance/totalfinance/workflows/local"},{"title":"createFileJobStore","url":"/reference/totalfinance/cli#createFileJobStore","description":"A file-backed job store: `<directory>/jobs/<id>.json` per record, re-read on every call.","category":"@insiderfinance/totalfinance/cli","kind":"function","keywords":"@insiderfinance/totalfinance/cli function  (input) (input).directory return.create return.get return.list return.update @insiderfinance/totalfinance/workflows/local"},{"title":"createLocalJobRunner","url":"/reference/totalfinance/cli#createLocalJobRunner","description":"function from @insiderfinance/totalfinance/cli","category":"@insiderfinance/totalfinance/cli","kind":"function","keywords":"@insiderfinance/totalfinance/cli function  (rawInput) (rawInput).clock (rawInput).directory (rawInput).packs (rawInput).pollMs (rawInput).profile (rawInput).registry return.cancel ret @insiderfinance/totalfinance/workflows/local"},{"title":"packsForProfile","url":"/reference/totalfinance/cli#packsForProfile","description":"The packs a profile selects — `full` is every shipped pack, the journey packs and the backtests included.","category":"@insiderfinance/totalfinance/cli","kind":"function","keywords":"@insiderfinance/totalfinance/cli function  (profile) @insiderfinance/totalfinance/workflows/local"},{"title":"registryForProfile","url":"/reference/totalfinance/cli#registryForProfile","description":"The registry for a profile, optionally narrowed to named packs (`--packs a,b`).","category":"@insiderfinance/totalfinance/cli","kind":"function","keywords":"@insiderfinance/totalfinance/cli function  (input) (input).packs (input).profile return.describe return.get return.list return.packs return.require return.run return.size @insiderfinance/totalfinance/workflows/local"},{"title":"submitJob","url":"/reference/totalfinance/cli#submitJob","description":"Submit an operation: a job-class operation runs in a terminated-on-cancel worker; any other\noperation runs inline and its record is already terminal on return.","category":"@insiderfinance/totalfinance/cli","kind":"function","keywords":"@insiderfinance/totalfinance/cli function  (rawInput) (rawInput).artifacts (rawInput).clock (rawInput).deadlineMs (rawInput).directory (rawInput).id (rawInput).inlineResultBytes (rawI @insiderfinance/totalfinance/workflows/local"},{"title":"CalendarSpreadInput","url":"/reference/totalfinance/commodities#CalendarSpreadInput","description":"Input for {@link calendarSpread}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  farPoint farPoint.forwardPrice farPoint.timeToDeliveryYears nearPoint nearPoint.forwardPrice nearPoint.timeToDeliveryYears @insiderfinance/totalfinance/commodities/term-structure"},{"title":"CalendarSpreadResult","url":"/reference/totalfinance/commodities#CalendarSpreadResult","description":"Result of {@link calendarSpread}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  annualizedSpreadRate assumptions assumptions.annualizedSpreadRateConvention diagnostics diagnostics.warnings spread @insiderfinance/totalfinance/commodities/term-structure"},{"title":"CommodityBasisInput","url":"/reference/totalfinance/commodities#CommodityBasisInput","description":"Input for {@link commodityBasis}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  futuresPrice spotPrice @insiderfinance/totalfinance/commodities/forwards"},{"title":"CommodityBasisResult","url":"/reference/totalfinance/commodities#CommodityBasisResult","description":"Result of {@link commodityBasis}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  assumptions assumptions.definition basis basisFraction diagnostics diagnostics.warnings @insiderfinance/totalfinance/commodities/forwards"},{"title":"CommodityCarryInput","url":"/reference/totalfinance/commodities#CommodityCarryInput","description":"Input for {@link commodityCarry}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  annualConvenienceYield annualFinancingRate annualStorageCostRate compounding compounding.periodsPerYear compounding.type forwardPrice spotPr @insiderfinance/totalfinance/commodities/forwards"},{"title":"CommodityCarryResult","url":"/reference/totalfinance/commodities#CommodityCarryResult","description":"Result of {@link commodityCarry}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  annualizedCarryRate assumptions assumptions.carryDefinition assumptions.compounding assumptions.compounding.periodsPerYear assumptions.compo @insiderfinance/totalfinance/commodities/forwards"},{"title":"CommodityCurvePoint","url":"/reference/totalfinance/commodities#CommodityCurvePoint","description":"One point on a commodity forward curve.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  forwardPrice timeToDeliveryYears @insiderfinance/totalfinance/commodities/term-structure"},{"title":"CommodityForwardPriceInput","url":"/reference/totalfinance/commodities#CommodityForwardPriceInput","description":"Input for {@link commodityForwardPrice} — the FROZEN first-touch field set.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  annualConvenienceYield annualFinancingRate annualStorageCostRate compounding compounding.periodsPerYear compounding.type spotPrice timeToDel @insiderfinance/totalfinance/commodities/forwards"},{"title":"CommodityForwardValueInput","url":"/reference/totalfinance/commodities#CommodityForwardValueInput","description":"Input for {@link commodityForwardValue}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  contractForwardPrice currentForwardPrice discountFactorToDelivery perspective quantity @insiderfinance/totalfinance/commodities/forwards"},{"title":"CommodityForwardValueResult","url":"/reference/totalfinance/commodities#CommodityForwardValueResult","description":"Result of {@link commodityForwardValue}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  assumptions assumptions.discountFactorToDelivery assumptions.perspective assumptions.valuationConvention contractValue diagnostics diagnosti @insiderfinance/totalfinance/commodities/forwards"},{"title":"ConvertCommodityQuantityInput","url":"/reference/totalfinance/commodities#ConvertCommodityQuantityInput","description":"Input for {@link convertCommodityQuantity}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  conversionFactor fromUnit quantity toUnit @insiderfinance/totalfinance/commodities/term-structure"},{"title":"ConvertCommodityQuantityResult","url":"/reference/totalfinance/commodities#ConvertCommodityQuantityResult","description":"Result of {@link convertCommodityQuantity}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  assumptions assumptions.conversionFactor assumptions.conversionSource assumptions.fromUnit assumptions.toUnit convertedQuantity diagnostics  @insiderfinance/totalfinance/commodities/term-structure"},{"title":"CurveSpreadAnalyticsInput","url":"/reference/totalfinance/commodities#CurveSpreadAnalyticsInput","description":"Input for {@link curveSpreadAnalytics}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  curve @insiderfinance/totalfinance/commodities/term-structure"},{"title":"CurveSpreadAnalyticsResult","url":"/reference/totalfinance/commodities#CurveSpreadAnalyticsResult","description":"Result of {@link curveSpreadAnalytics}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  adjacentSpreads assumptions assumptions.annualizedSpreadRateConvention diagnostics diagnostics.warnings frontToBack frontToBack.annualizedSp @insiderfinance/totalfinance/commodities/term-structure"},{"title":"CurveSpreadRow","url":"/reference/totalfinance/commodities#CurveSpreadRow","description":"One adjacent-pair (or front-to-back) spread row.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  annualizedSpreadRate fromTimeYears spread toTimeYears @insiderfinance/totalfinance/commodities/term-structure"},{"title":"FuturesHedgeRatioInput","url":"/reference/totalfinance/commodities#FuturesHedgeRatioInput","description":"Input for {@link futuresHedgeRatio}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  betaOrHedgeEffectiveness exposureQuantity futuresContractSize @insiderfinance/totalfinance/commodities/forwards"},{"title":"FuturesHedgeRatioResult","url":"/reference/totalfinance/commodities#FuturesHedgeRatioResult","description":"Result of {@link futuresHedgeRatio}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  assumptions assumptions.betaOrHedgeEffectiveness assumptions.hedgeRatioBasis assumptions.rounding contractsRequired diagnostics diagnostics. @insiderfinance/totalfinance/commodities/forwards"},{"title":"ImpliedConvenienceYieldInput","url":"/reference/totalfinance/commodities#ImpliedConvenienceYieldInput","description":"Input for {@link impliedConvenienceYield}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  annualFinancingRate annualStorageCostRate compounding compounding.periodsPerYear compounding.type forwardPrice spotPrice timeToDeliveryYears @insiderfinance/totalfinance/commodities/forwards"},{"title":"ImpliedConvenienceYieldResult","url":"/reference/totalfinance/commodities#ImpliedConvenienceYieldResult","description":"Result of {@link impliedConvenienceYield}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  assumptions assumptions.compounding assumptions.compounding.periodsPerYear assumptions.compounding.type assumptions.inversion diagnostics di @insiderfinance/totalfinance/commodities/forwards"},{"title":"ImpliedStorageCostInput","url":"/reference/totalfinance/commodities#ImpliedStorageCostInput","description":"Input for {@link impliedStorageCost}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  annualConvenienceYield annualFinancingRate compounding compounding.periodsPerYear compounding.type forwardPrice spotPrice timeToDeliveryYear @insiderfinance/totalfinance/commodities/forwards"},{"title":"ImpliedStorageCostResult","url":"/reference/totalfinance/commodities/page-2#ImpliedStorageCostResult","description":"Result of {@link impliedStorageCost}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  assumptions assumptions.compounding assumptions.compounding.periodsPerYear assumptions.compounding.type assumptions.inversion diagnostics di @insiderfinance/totalfinance/commodities/forwards"},{"title":"RollReturnDecompositionInput","url":"/reference/totalfinance/commodities/page-2#RollReturnDecompositionInput","description":"Input for {@link rollReturnDecomposition}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  finalContractPriceBeforeRoll finalSpotPrice initialContractPrice initialSpotPrice nextContractPriceAtRoll @insiderfinance/totalfinance/commodities/term-structure"},{"title":"RollReturnDecompositionResult","url":"/reference/totalfinance/commodities/page-2#RollReturnDecompositionResult","description":"Result of {@link rollReturnDecomposition}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  assumptions assumptions.declaredResidualBound assumptions.reconciliation carryConvergenceReturn diagnostics diagnostics.reconciliationResidu @insiderfinance/totalfinance/commodities/term-structure"},{"title":"RollYieldInput","url":"/reference/totalfinance/commodities/page-2#RollYieldInput","description":"Input for {@link rollYield}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  expiringContractPrice nextContractPrice spotPriceAtRoll @insiderfinance/totalfinance/commodities/term-structure"},{"title":"RollYieldResult","url":"/reference/totalfinance/commodities/page-2#RollYieldResult","description":"Result of {@link rollYield}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  assumptions assumptions.decompositionConvention assumptions.rollDirection assumptions.signLaw decomposition decomposition.expiringVersusSpot @insiderfinance/totalfinance/commodities/term-structure"},{"title":"SeasonalityMonthRow","url":"/reference/totalfinance/commodities/page-2#SeasonalityMonthRow","description":"One calendar-month row of a {@link seasonalityProfile}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  month observationCount statisticValue statisticValueAbsentReason @insiderfinance/totalfinance/commodities/term-structure"},{"title":"SeasonalityObservation","url":"/reference/totalfinance/commodities/page-2#SeasonalityObservation","description":"One dated observation for {@link seasonalityProfile}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  observationDate value @insiderfinance/totalfinance/commodities/term-structure"},{"title":"SeasonalityProfileInput","url":"/reference/totalfinance/commodities/page-2#SeasonalityProfileInput","description":"Input for {@link seasonalityProfile}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  observations statistic @insiderfinance/totalfinance/commodities/term-structure"},{"title":"SeasonalityProfileResult","url":"/reference/totalfinance/commodities/page-2#SeasonalityProfileResult","description":"Result of {@link seasonalityProfile}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  assumptions assumptions.scope assumptions.statistic diagnostics diagnostics.observationCountByMonth diagnostics.warnings months overallMean @insiderfinance/totalfinance/commodities/term-structure"},{"title":"TermStructureState","url":"/reference/totalfinance/commodities/page-2#TermStructureState","description":"The four disclosed term-structure states.","category":"@insiderfinance/totalfinance/commodities","kind":"type","keywords":"@insiderfinance/totalfinance/commodities type   @insiderfinance/totalfinance/commodities/term-structure"},{"title":"TermStructureStateInput","url":"/reference/totalfinance/commodities/page-2#TermStructureStateInput","description":"Input for {@link termStructureState}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  curve flatToleranceFraction @insiderfinance/totalfinance/commodities/term-structure"},{"title":"TermStructureStateResult","url":"/reference/totalfinance/commodities/page-2#TermStructureStateResult","description":"Result of {@link termStructureState}.","category":"@insiderfinance/totalfinance/commodities","kind":"interface","keywords":"@insiderfinance/totalfinance/commodities interface  assumptions assumptions.definition assumptions.flatToleranceFraction diagnostics diagnostics.fallingSegmentCount diagnostics.flatSegmentCoun @insiderfinance/totalfinance/commodities/term-structure"},{"title":"calendarSpread","url":"/reference/totalfinance/commodities/page-2#calendarSpread","description":"The calendar spread between two deliveries: the price spread `far − near`, and the annualized\ncontinuous carry the pair implies. Near must genuinely be nearer —","category":"@insiderfinance/totalfinance/commodities","kind":"function","keywords":"@insiderfinance/totalfinance/commodities function  (input) (input).farPoint (input).nearPoint return.annualizedSpreadRate return.assumptions return.assumptions.annualizedSpreadRateConvention  @insiderfinance/totalfinance/commodities/term-structure"},{"title":"commodityBasis","url":"/reference/totalfinance/commodities/page-2#commodityBasis","description":"The basis between spot and a quoted futures price. `basis` (a price difference) and\n`basisFraction` (a dimensionless ratio) are DIFFERENT quantities and both de","category":"@insiderfinance/totalfinance/commodities","kind":"function","keywords":"@insiderfinance/totalfinance/commodities function  (input) (input).futuresPrice (input).spotPrice return.assumptions return.assumptions.definition return.basis return.basisFraction return.dia @insiderfinance/totalfinance/commodities/forwards"},{"title":"commodityCarry","url":"/reference/totalfinance/commodities/page-2#commodityCarry","description":"The annualized TOTAL carry a spot/forward pair implies, by inverting the compounding growth\nfactor. When all three components (financing, storage, convenience) ","category":"@insiderfinance/totalfinance/commodities","kind":"function","keywords":"@insiderfinance/totalfinance/commodities function  (input) (input).annualConvenienceYield (input).annualFinancingRate (input).annualStorageCostRate (input).compounding (input).forwardPrice (i @insiderfinance/totalfinance/commodities/forwards"},{"title":"commodityForwardPrice","url":"/reference/totalfinance/commodities/page-2#commodityForwardPrice","description":"THEORETICAL cost-of-carry forward price: `spotPrice × G(netCarryRate, timeToDeliveryYears)`\nwhere `netCarryRate = annualFinancingRate + annualStorageCostRate − ","category":"@insiderfinance/totalfinance/commodities","kind":"function","keywords":"@insiderfinance/totalfinance/commodities function  (input) (input).annualConvenienceYield (input).annualFinancingRate (input).annualStorageCostRate (input).compounding (input).spotPrice (inpu @insiderfinance/totalfinance/commodities/forwards"},{"title":"commodityForwardValue","url":"/reference/totalfinance/commodities/page-2#commodityForwardValue","description":"CURRENT VALUE of an existing forward contract:\n`±(currentForwardPrice − contractForwardPrice) × quantity × discountFactorToDelivery`, positive\nfor `'long'` and ","category":"@insiderfinance/totalfinance/commodities","kind":"function","keywords":"@insiderfinance/totalfinance/commodities function  (input) (input).contractForwardPrice (input).currentForwardPrice (input).discountFactorToDelivery (input).perspective (input).quantity retur @insiderfinance/totalfinance/commodities/forwards"},{"title":"convertCommodityQuantity","url":"/reference/totalfinance/commodities/page-2#convertCommodityQuantity","description":"Convert a commodity quantity between units with an EXPLICIT caller-supplied factor:\n`convertedQuantity = quantity × conversionFactor`. Economics are preserved e","category":"@insiderfinance/totalfinance/commodities","kind":"function","keywords":"@insiderfinance/totalfinance/commodities function  (input) (input).conversionFactor (input).fromUnit (input).quantity (input).toUnit return.assumptions return.assumptions.conversionFactor ret @insiderfinance/totalfinance/commodities/term-structure"},{"title":"curveSpreadAnalytics","url":"/reference/totalfinance/commodities/page-2#curveSpreadAnalytics","description":"Spread analytics across a whole curve: one {@link CurveSpreadRow} per adjacent pair plus the\noverall front-to-back row, every rate under the disclosed continuou","category":"@insiderfinance/totalfinance/commodities","kind":"function","keywords":"@insiderfinance/totalfinance/commodities function  (input) (input).curve return.adjacentSpreads return.assumptions return.assumptions.annualizedSpreadRateConvention return.diagnostics return. @insiderfinance/totalfinance/commodities/term-structure"},{"title":"futuresHedgeRatio","url":"/reference/totalfinance/commodities/page-2#futuresHedgeRatio","description":"Futures contracts required to hedge an exposure:\n`exposureQuantity × betaOrHedgeEffectiveness / futuresContractSize`. The count is NOT rounded —\nwhether to roun","category":"@insiderfinance/totalfinance/commodities","kind":"function","keywords":"@insiderfinance/totalfinance/commodities function  (input) (input).betaOrHedgeEffectiveness (input).exposureQuantity (input).futuresContractSize return.assumptions return.assumptions.betaOrHe @insiderfinance/totalfinance/commodities/forwards"},{"title":"impliedConvenienceYield","url":"/reference/totalfinance/commodities/page-3#impliedConvenienceYield","description":"The convenience yield the spot/forward pair implies, given the other carry components — the\ninverse of {@link commodityForwardPrice} solved for `annualConvenien","category":"@insiderfinance/totalfinance/commodities","kind":"function","keywords":"@insiderfinance/totalfinance/commodities function  (input) (input).annualFinancingRate (input).annualStorageCostRate (input).compounding (input).forwardPrice (input).spotPrice (input).timeToD @insiderfinance/totalfinance/commodities/forwards"},{"title":"impliedStorageCost","url":"/reference/totalfinance/commodities/page-3#impliedStorageCost","description":"The proportional storage cost rate the spot/forward pair implies, given the other carry\ncomponents — the spec's \"when the remaining inputs identify it uniquely\"","category":"@insiderfinance/totalfinance/commodities","kind":"function","keywords":"@insiderfinance/totalfinance/commodities function  (input) (input).annualConvenienceYield (input).annualFinancingRate (input).compounding (input).forwardPrice (input).spotPrice (input).timeTo @insiderfinance/totalfinance/commodities/forwards"},{"title":"rollReturnDecomposition","url":"/reference/totalfinance/commodities/page-3#rollReturnDecomposition","description":"Decompose the return on a long futures position over one holding period ending at a roll.\nWith `S0/S1` the initial/final spot and `F0/F1` the held contract's in","category":"@insiderfinance/totalfinance/commodities","kind":"function","keywords":"@insiderfinance/totalfinance/commodities function  (input) (input).finalContractPriceBeforeRoll (input).finalSpotPrice (input).initialContractPrice (input).initialSpotPrice (input).nextContra @insiderfinance/totalfinance/commodities/term-structure"},{"title":"rollYield","url":"/reference/totalfinance/commodities/page-3#rollYield","description":"The roll yield when rolling a LONG position from the expiring contract into the next:\n`(expiring − next) / next`. Positive in backwardation — the next contract ","category":"@insiderfinance/totalfinance/commodities","kind":"function","keywords":"@insiderfinance/totalfinance/commodities function  (input) (input).expiringContractPrice (input).nextContractPrice (input).spotPriceAtRoll return.assumptions return.assumptions.decompositionC @insiderfinance/totalfinance/commodities/term-structure"},{"title":"seasonalityProfile","url":"/reference/totalfinance/commodities/page-3#seasonalityProfile","description":"Group caller-supplied dated observations by calendar month and report the requested statistic\nper month plus the overall mean. Purely descriptive: it never extr","category":"@insiderfinance/totalfinance/commodities","kind":"function","keywords":"@insiderfinance/totalfinance/commodities function  (input) (input).observations (input).statistic return.assumptions return.assumptions.scope return.assumptions.statistic return.diagnostics r @insiderfinance/totalfinance/commodities/term-structure"},{"title":"termStructureState","url":"/reference/totalfinance/commodities/page-3#termStructureState","description":"Classify a forward curve's term structure with the reasoning disclosed. Each adjacent pair is a\nsegment with fractional slope `far / near − 1`; segments beyond ","category":"@insiderfinance/totalfinance/commodities","kind":"function","keywords":"@insiderfinance/totalfinance/commodities function  (input) (input).curve (input).flatToleranceFraction return.assumptions return.assumptions.definition return.assumptions.flatToleranceFractio @insiderfinance/totalfinance/commodities/term-structure"},{"title":"ArbitrageError","url":"/reference/totalfinance/core#ArbitrageError","description":"Inputs violate a no-arbitrage condition (e.g. a price below intrinsic value).","category":"@insiderfinance/totalfinance/core","kind":"class","keywords":"@insiderfinance/totalfinance/core class  (message) (options) (options).cause (options).code (options).context code context return.code return.context return.toJSON toJSON toJSON().r"},{"title":"Assumptions","url":"/reference/totalfinance/core#Assumptions","description":"Assumptions echoed on every pro result. Extra model-specific fields are added via the `Extra`\ntype parameter so each domain can annotate its own conventions wit","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  asOf calendar calendarVersion compounding compounding.periodsPerYear compounding.type conventionsVersion dayCount dividendModel engine expir"},{"title":"BetweenOptions","url":"/reference/totalfinance/core#BetweenOptions","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  inclusive"},{"title":"CONVENTIONS_VERSION","url":"/reference/totalfinance/core#CONVENTIONS_VERSION","description":"Bump this only when default conventions change (major versions only, design law #3).","category":"@insiderfinance/totalfinance/core","kind":"value","keywords":"@insiderfinance/totalfinance/core value  "},{"title":"CalendarConfig","url":"/reference/totalfinance/core#CalendarConfig","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  closures halfDayRules holidayRules name session session.close session.halfDayClose session.open timezone version weekendDays"},{"title":"CalendarDate","url":"/reference/totalfinance/core#CalendarDate","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  day month year"},{"title":"ClosedRequestSpecification","url":"/reference/totalfinance/core#ClosedRequestSpecification","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  branches contract fields"},{"title":"ClosedRequestTeaching","url":"/reference/totalfinance/core#ClosedRequestTeaching","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  argumentName exampleCall hints open subject"},{"title":"Computed","url":"/reference/totalfinance/core#Computed","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear"},{"title":"ConfigurationError","url":"/reference/totalfinance/core#ConfigurationError","description":"The library was configured in a contradictory or unusable way.","category":"@insiderfinance/totalfinance/core","kind":"class","keywords":"@insiderfinance/totalfinance/core class  (message) (options) (options).cause (options).code (options).context code context return.code return.context return.toJSON toJSON toJSON().r"},{"title":"ConvergenceError","url":"/reference/totalfinance/core#ConvergenceError","description":"A numerical solver failed to converge. Never silently replaced with a guess (design law #4).","category":"@insiderfinance/totalfinance/core","kind":"class","keywords":"@insiderfinance/totalfinance/core class  (message) (options) (options).cause (options).code (options).context code context return.code return.context return.toJSON toJSON toJSON().r"},{"title":"CorporateAction","url":"/reference/totalfinance/core#CorporateAction","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  cash details effectiveDate newSymbol ratio symbol type"},{"title":"DEFAULT_COMPOUNDING","url":"/reference/totalfinance/core#DEFAULT_COMPOUNDING","description":"value from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"value","keywords":"@insiderfinance/totalfinance/core value  periodsPerYear type"},{"title":"DEFAULT_DAY_COUNT","url":"/reference/totalfinance/core#DEFAULT_DAY_COUNT","description":"Library default conventions (spec §7.4 defaults table).","category":"@insiderfinance/totalfinance/core","kind":"value","keywords":"@insiderfinance/totalfinance/core value  "},{"title":"DEFAULT_DIVIDEND_YIELD","url":"/reference/totalfinance/core#DEFAULT_DIVIDEND_YIELD","description":"value from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"value","keywords":"@insiderfinance/totalfinance/core value  "},{"title":"DEFAULT_GREEK_UNITS","url":"/reference/totalfinance/core#DEFAULT_GREEK_UNITS","description":"value from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"value","keywords":"@insiderfinance/totalfinance/core value  rho theta vega"},{"title":"DataError","url":"/reference/totalfinance/core#DataError","description":"A data-quality problem (crossed/locked market, stale quote, bad print).","category":"@insiderfinance/totalfinance/core","kind":"class","keywords":"@insiderfinance/totalfinance/core class  (message) (options) (options).cause (options).code (options).context code context return.code return.context return.toJSON toJSON toJSON().r"},{"title":"DayCount","url":"/reference/totalfinance/core#DayCount","description":"Day-count conventions supported in the 0.0.1 surface.","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  "},{"title":"DaySession","url":"/reference/totalfinance/core/page-2#DaySession","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  close date isBusinessDay isHalfDay open"},{"title":"Deliverable","url":"/reference/totalfinance/core/page-2#Deliverable","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  cash notes shares"},{"title":"Diagnostics","url":"/reference/totalfinance/core/page-2#Diagnostics","description":"Non-value metadata about how a result was computed.","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  autoReason converged decomposition engine finiteDifferenceBumps iterations method selection selection.candidates selection.mode selection.re"},{"title":"Dividend","url":"/reference/totalfinance/core/page-2#Dividend","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  amount currency exDate payDate symbol type"},{"title":"DividendModel","url":"/reference/totalfinance/core/page-2#DividendModel","description":"type from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  "},{"title":"EpochMs","url":"/reference/totalfinance/core/page-2#EpochMs","description":"Unix epoch milliseconds.","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  "},{"title":"ErrorCode","url":"/reference/totalfinance/core/page-2#ErrorCode","description":"A literal table allows bundlers to discard the registry or unused properties without executing\na catalog constructor. The declared key/value/order contract is c","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  ArtifactDuplicateMigration ArtifactEmbeddedInputTooLarge ArtifactFamilyMismatch ArtifactIdMismatch ArtifactMigrationMissing ArtifactModelVer"},{"title":"ExerciseTime","url":"/reference/totalfinance/core/page-2#ExerciseTime","description":"type from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  "},{"title":"Facade","url":"/reference/totalfinance/core/page-2#Facade","description":"`ExplainValue` defaults to `Output` and diverges only for solver facades (Law 7 / E3): the plain\ncall THROWS on failure so its output stays `number`, while the ","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  (input) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain(input) @insiderfinance/totalfinance/options"},{"title":"FormatMoneyOptions","url":"/reference/totalfinance/core/page-2#FormatMoneyOptions","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  currency decimals locale"},{"title":"FormatPercentOptions","url":"/reference/totalfinance/core/page-2#FormatPercentOptions","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  asPercentagePoints decimals locale"},{"title":"GreekUnits","url":"/reference/totalfinance/core/page-2#GreekUnits","description":"Units in which Greeks are reported.","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  rho theta vega"},{"title":"GuaranteedSelection","url":"/reference/totalfinance/core/page-2#GuaranteedSelection","description":"The names a selection of type `S` is CERTAIN to contain — the names a result may promise as\nrequired. Every other name in `S[number]` was only possibly selected","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  "},{"title":"HolidayRule","url":"/reference/totalfinance/core/page-2#HolidayRule","description":"A holiday/half-day rule: given a year, return the ISO date it falls on, or `null` if not observed.","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  (year)"},{"title":"InputError","url":"/reference/totalfinance/core/page-2#InputError","description":"Invalid or nonsensical input (programmer error or malformed payload).","category":"@insiderfinance/totalfinance/core","kind":"class","keywords":"@insiderfinance/totalfinance/core class  (message) (options) (options).cause (options).code (options).context code context return.code return.context return.toJSON toJSON toJSON().r"},{"title":"InterestCompounding","url":"/reference/totalfinance/core/page-2#InterestCompounding","description":"The ONE public interest-compounding grammar (FC0). Every rate-bearing contract in the library\nquotes its compounding in this vocabulary — the former core `'cont","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  periodsPerYear type @insiderfinance/totalfinance/fixed-income"},{"title":"JSONSchema","url":"/reference/totalfinance/core/page-2#JSONSchema","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  $id $schema additionalProperties additionalProperties.$id additionalProperties.$schema additionalProperties.additionalProperties additionalP @insiderfinance/totalfinance/core/schema"},{"title":"MarketInputs","url":"/reference/totalfinance/core/page-2#MarketInputs","description":"The canonical market snapshot every pricing/analytics entrypoint takes (spec §5.3 / WS3.2). One\nshape, one vocabulary: `spot`, `rate`, optional `dividendYield` ","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  asOf dividendYield riskFreeRate spot"},{"title":"ORDER_SIDES","url":"/reference/totalfinance/core/page-2#ORDER_SIDES","description":"value from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"value","keywords":"@insiderfinance/totalfinance/core value  "},{"title":"ORDER_TYPES","url":"/reference/totalfinance/core/page-2#ORDER_TYPES","description":"value from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"value","keywords":"@insiderfinance/totalfinance/core value  "},{"title":"OccOptionSymbol","url":"/reference/totalfinance/core/page-3#OccOptionSymbol","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  expiresAt expiry expiryConvention root strike type"},{"title":"OptionContract","url":"/reference/totalfinance/core/page-3#OptionContract","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  adjusted currency deliverable deliverable.cash deliverable.notes deliverable.shares exerciseTime expiresAt expiry expiryConvention multiplie @insiderfinance/totalfinance/options"},{"title":"OptionQuote","url":"/reference/totalfinance/core/page-3#OptionQuote","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  ask askSize bid bidSize conditions contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash contract.deli @insiderfinance/totalfinance/options @insiderfinance/totalfinance/strategy"},{"title":"OptionQuoteGreeks","url":"/reference/totalfinance/core/page-3#OptionQuoteGreeks","description":"Per-share Greeks on a chain row, in TotalFinance display units: `delta` per $1 of spot, `gamma` per\n$1², `theta` per calendar day, `vega` per volatility point, ","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  delta gamma provenance provenance.model provenance.source provenance.timestampMs rho theta vega"},{"title":"OptionQuoteGreeksProvenance","url":"/reference/totalfinance/core/page-3#OptionQuoteGreeksProvenance","description":"Who produced a chain row's Greeks, with what, and when.","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  model source timestampMs"},{"title":"OptionStyle","url":"/reference/totalfinance/core/page-3#OptionStyle","description":"Exercise style of a LISTED equity/index option. `'bermudan'` was removed (alignment spec P3.4):\nno vanilla engine supports it, and a representable-but-unpriceab","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type   @insiderfinance/totalfinance/options"},{"title":"OptionTrade","url":"/reference/totalfinance/core/page-3#OptionTrade","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  aggressorSide ask askSize bid bidSize conditions contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash"},{"title":"OptionType","url":"/reference/totalfinance/core/page-3#OptionType","description":"type from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type   @insiderfinance/totalfinance/options"},{"title":"OrderBook","url":"/reference/totalfinance/core/page-3#OrderBook","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  asks bids symbol timestampMs"},{"title":"OrderBookLevel","url":"/reference/totalfinance/core/page-3#OrderBookLevel","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  exchange price size"},{"title":"PostconditionError","url":"/reference/totalfinance/core/page-3#PostconditionError","description":"A LIBRARY defect surfaced loudly (Law 7 runtime postcondition): a successful facade/analysis\nresult was about to carry an undisclosed NaN/Infinity. This is neve","category":"@insiderfinance/totalfinance/core","kind":"class","keywords":"@insiderfinance/totalfinance/core class  (message) (options) (options).cause (options).code (options).context code context return.code return.context return.toJSON toJSON toJSON().r"},{"title":"PriceSource","url":"/reference/totalfinance/core/page-3#PriceSource","description":"Price-source selection for quotes (spec §9.5 bid/ask/mid selection).","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type   @insiderfinance/totalfinance/options"},{"title":"Provenance","url":"/reference/totalfinance/core/page-3#Provenance","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  asOf dataset provider receivedAt requestId sourceVersion warnings"},{"title":"QuantError","url":"/reference/totalfinance/core/page-3#QuantError","description":"Base class for every TotalFinance error.","category":"@insiderfinance/totalfinance/core","kind":"class","keywords":"@insiderfinance/totalfinance/core class  (message) (options) (options).cause (options).code (options).context code context return.code return.context return.toJSON toJSON toJSON().r"},{"title":"QuantErrorOptions","url":"/reference/totalfinance/core/page-3#QuantErrorOptions","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  cause code context"},{"title":"QuantWarning","url":"/reference/totalfinance/core/page-3#QuantWarning","description":"A structured, machine-readable warning. `code` is stable public API.","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  code context message severity"},{"title":"Quote","url":"/reference/totalfinance/core/page-3#Quote","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  ask askSize bid bidSize conditions exchange symbol timestampMs"},{"title":"RateCurve","url":"/reference/totalfinance/core/page-3#RateCurve","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  asOf compounding compounding.periodsPerYear compounding.type currency dayCount interpolation points"},{"title":"RateCurvePoint","url":"/reference/totalfinance/core/page-4#RateCurvePoint","description":"One curve pillar: a `'YYYY-MM-DD'` date and the ZERO RATE quoted there, as a decimal, under the\nowning curve's own `compounding`/`dayCount`. The field is `zeroR","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  date zeroRate"},{"title":"RawFundamentalsRecord","url":"/reference/totalfinance/core/page-4#RawFundamentalsRecord","description":"The RAW provider-fundamentals record — an explicitly raw/open DATA-EDGE artifact (FC0). A\nvendor's untyped field bag survives ONLY here; compute functions never","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  asOf fields fiscalPeriod symbol @insiderfinance/totalfinance/fundamentals"},{"title":"RequireFiniteFieldsOptions","url":"/reference/totalfinance/core/page-4#RequireFiniteFieldsOptions","description":"The shared enforcement path for a request object's NUMERIC fields (spec 3B.1b).\n\nOne call answers the three questions a numeric contract actually makes, in the ","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  exampleCall hints path"},{"title":"RhoUnit","url":"/reference/totalfinance/core/page-4#RhoUnit","description":"type from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  "},{"title":"SeriesFacade","url":"/reference/totalfinance/core/page-4#SeriesFacade","description":"A multi-argument (series-first) facade: the plain call takes `(data, parameters?, …)`, and `.explain()`\ntakes the SAME arguments and returns the {@link Computed","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain"},{"title":"Settlement","url":"/reference/totalfinance/core/page-4#Settlement","description":"type from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  "},{"title":"SymbolId","url":"/reference/totalfinance/core/page-4#SymbolId","description":"type from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  "},{"title":"TIME_IN_FORCE_VALUES","url":"/reference/totalfinance/core/page-4#TIME_IN_FORCE_VALUES","description":"value from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"value","keywords":"@insiderfinance/totalfinance/core value  "},{"title":"ThetaUnit","url":"/reference/totalfinance/core/page-4#ThetaUnit","description":"type from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  "},{"title":"Trade","url":"/reference/totalfinance/core/page-4#Trade","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  conditions exchange price sequence size symbol timestampMs"},{"title":"US_EQUITY_HALF_DAY_RULES","url":"/reference/totalfinance/core/page-4#US_EQUITY_HALF_DAY_RULES","description":"US equity/options early-close (13:00 ET) rules — the ONE table, consumed by `@insiderfinance/totalfinance/calendars`\nas well: the day after Thanksgiving, and 24","category":"@insiderfinance/totalfinance/core","kind":"value","keywords":"@insiderfinance/totalfinance/core value  "},{"title":"UnsupportedError","url":"/reference/totalfinance/core/page-4#UnsupportedError","description":"A requested operation is not supported by the selected engine/model/contract.","category":"@insiderfinance/totalfinance/core","kind":"class","keywords":"@insiderfinance/totalfinance/core class  (message) (options) (options).cause (options).code (options).context code context return.code return.context return.toJSON toJSON toJSON().r"},{"title":"ValidationBranchSpecification","url":"/reference/totalfinance/core/page-4#ValidationBranchSpecification","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  fields"},{"title":"ValidationFieldKind","url":"/reference/totalfinance/core/page-4#ValidationFieldKind","description":"What the validator checks for a field, projected from the inventory's richer kind vocabulary.","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  "},{"title":"ValidationFieldSpecification","url":"/reference/totalfinance/core/page-4#ValidationFieldSpecification","description":"interface from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"interface","keywords":"@insiderfinance/totalfinance/core interface  allowsInfinity branches fields kind literals name nullable openKinds optional safeIntegerElementsMaximum safeIntegerMaximum"},{"title":"VegaUnit","url":"/reference/totalfinance/core/page-4#VegaUnit","description":"type from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  "},{"title":"WarningCode","url":"/reference/totalfinance/core/page-4#WarningCode","description":"Canonical warning codes. Like error codes, these are stable public API — consumers branch on them.\nThe set is open; packages may add codes, but documented ones ","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  ArtifactComparisonDifferentMarket ArtifactComparisonDifferentUniverse ArtifactLibraryVersionDiffers BacktestAssignment BacktestComboLegUnfil"},{"title":"WarningSeverity","url":"/reference/totalfinance/core/page-4#WarningSeverity","description":"type from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  "},{"title":"Weekday","url":"/reference/totalfinance/core/page-4#Weekday","description":"Day of week, Sunday = 0 … Saturday = 6.","category":"@insiderfinance/totalfinance/core","kind":"type","keywords":"@insiderfinance/totalfinance/core type  "},{"title":"addDays","url":"/reference/totalfinance/core/page-5#addDays","description":"Add `n` calendar days to an ISO date.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (date) (days)"},{"title":"alwaysOpen","url":"/reference/totalfinance/core/page-5#alwaysOpen","description":"A 24/7 calendar (every day is a business day) — e.g. crypto.","category":"@insiderfinance/totalfinance/core","kind":"value","keywords":"@insiderfinance/totalfinance/core value  addBusinessDays addBusinessDays(date) addBusinessDays(days) businessDaysBetween businessDaysBetween(from) businessDaysBetween(to) isBusiness"},{"title":"assertFiniteResult","url":"/reference/totalfinance/core/page-5#assertFiniteResult","description":"Law 7 runtime postcondition (spec P2.1, tightened in E3): a SUCCESSFUL explained result is\nJSON-safe — it NEVER carries a non-finite number (`JSON.stringify` wo","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (label) (result) (result).assumptions (result).diagnostics (result).provenance (result).value"},{"title":"assertFiniteValue","url":"/reference/totalfinance/core/page-5#assertFiniteValue","description":"function from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (label) (value)"},{"title":"between","url":"/reference/totalfinance/core/page-5#between","description":"Range predicate. Replaces wrapped-number DSLs (design law #2): use\n`between(Math.abs(delta), 0.25, 0.35)` rather than `delta.abs().between(...)`.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (max) (min) (options) (options).inclusive (value)"},{"title":"clamp","url":"/reference/totalfinance/core/page-5#clamp","description":"Clamp `value` into `[min, max]`.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (max) (min) (value)"},{"title":"compoundFactor","url":"/reference/totalfinance/core/page-5#compoundFactor","description":"Compound (growth) factor for `rate` over `years` under any {@link InterestCompounding} form.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (annualRate) (compounding) (compounding).periodsPerYear (compounding).type (years)"},{"title":"compoundingPeriodsPerYear","url":"/reference/totalfinance/core/page-5#compoundingPeriodsPerYear","description":"Periods per year for a discrete convention; `null` for the two non-discrete forms.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (compounding) (compounding).periodsPerYear (compounding).type"},{"title":"createRuleCalendar","url":"/reference/totalfinance/core/page-5#createRuleCalendar","description":"Build a `Calendar` from rules. Holiday/half-day sets are computed lazily per year and cached.\n\nThe config is SNAPSHOTTED at construction — rule arrays, closures","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (config) (config).closures (config).halfDayRules (config).holidayRules (config).name (config).session (config).session.close (config).sessio"},{"title":"dayOfWeek","url":"/reference/totalfinance/core/page-5#dayOfWeek","description":"Day of week for an ISO date.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (date)"},{"title":"defineCalendar","url":"/reference/totalfinance/core/page-5#defineCalendar","description":"Define a custom calendar (spec §22.4 extension API). A thin wrapper over `createRuleCalendar` so\nthe extension surface is stable even if the engine evolves.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (config) (config).closures (config).halfDayRules (config).holidayRules (config).name (config).session (config).session.close (config).sessio"},{"title":"discountFactor","url":"/reference/totalfinance/core/page-5#discountFactor","description":"Discount factor for `rate` over `years` under any {@link InterestCompounding} form.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (annualRate) (compounding) (compounding).periodsPerYear (compounding).type (years)"},{"title":"easterSunday","url":"/reference/totalfinance/core/page-5#easterSunday","description":"Easter Sunday via the Anonymous Gregorian algorithm (Computus).","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (year) return.day return.month"},{"title":"emptyDiagnostics","url":"/reference/totalfinance/core/page-5#emptyDiagnostics","description":"Construct an empty diagnostics object with no warnings.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  return.autoReason return.converged return.decomposition return.engine return.finiteDifferenceBumps return.iterations return.method return.se"},{"title":"ensureEnum","url":"/reference/totalfinance/core/page-5#ensureEnum","description":"Enum guard: `value` must be exactly one of `allowed` (design law #4 — a meaning-changing field is\nnever coerced; `type: 'Call'` must teach, not silently price t","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (allowed) (field) (functionName) (value)"},{"title":"ensureFinite","url":"/reference/totalfinance/core/page-5#ensureFinite","description":"Throw unless `value` is a finite number.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (field) (functionName) (value)"},{"title":"ensureFiniteWhenPresent","url":"/reference/totalfinance/core/page-5#ensureFiniteWhenPresent","description":"A finite numeric value WHEN PRESENT — the optional-field sibling of {@link requireFiniteFields}.\n\n`undefined` is allowed (optional omission, C06); anything else","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (field) (functionName) (value)"},{"title":"ensureKnownKeys","url":"/reference/totalfinance/core/page-5#ensureKnownKeys","description":"Law 12 — facade, analysis, and builder object inputs REJECT unknown keys (a misspelled option\nmust never be silently ignored: `greek: false` computing Greeks an","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (allowed) (field) (functionName) (value)"},{"title":"ensureNonNegative","url":"/reference/totalfinance/core/page-5#ensureNonNegative","description":"Throw unless `value` is a finite number `>= 0`.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (code) (field) (functionName) (value)"},{"title":"ensurePositive","url":"/reference/totalfinance/core/page-5#ensurePositive","description":"Throw unless `value` is a finite number `> 0`.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (code) (field) (functionName) (value)"},{"title":"facade","url":"/reference/totalfinance/core/page-6#facade","description":"Pair a plain-value `call` with its envelope-returning `explain` into a single {@link Facade}.\n`label` is the public name of the facade as the user calls it (e.g","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (call) (explain) (label) return.explain"},{"title":"finalizeResult","url":"/reference/totalfinance/core/page-6#finalizeResult","description":"Validate and return a direct Computed result in one expression.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (label) (result)"},{"title":"finiteOrNull","url":"/reference/totalfinance/core/page-6#finiteOrNull","description":"Law 7 helper: a computed quantity that overflowed/underflowed to NaN/±Infinity is reported as\n`null` (undefined-with-reason at the envelope tier), never as a no","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (value)"},{"title":"formatMoney","url":"/reference/totalfinance/core/page-6#formatMoney","description":"Format a number as currency using the platform `Intl` (browser-safe).","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (options) (options).currency (options).decimals (options).locale (value)"},{"title":"formatOccSymbol","url":"/reference/totalfinance/core/page-6#formatOccSymbol","description":"Format option components into a compact OCC option symbol.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (option) (option).expiry (option).root (option).strike (option).type"},{"title":"formatPercent","url":"/reference/totalfinance/core/page-6#formatPercent","description":"Format a fraction (`0.22`) as a percent string (`\"22.00%\"`).","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (options) (options).asPercentagePoints (options).decimals (options).locale (value)"},{"title":"goodFriday","url":"/reference/totalfinance/core/page-6#goodFriday","description":"Good Friday (two days before Easter Sunday).","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (year)"},{"title":"isComputed","url":"/reference/totalfinance/core/page-6#isComputed","description":"Runtime guard for the one-envelope law (dx §7.2): a rich result is `Computed` iff it carries\n`value`, `assumptions.conventionsVersion`, and a `diagnostics.warni","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (value)"},{"title":"isFiniteNumber","url":"/reference/totalfinance/core/page-6#isFiniteNumber","description":"True only for a real, finite number (rejects `NaN`, `Infinity`, and non-numbers).","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (value)"},{"title":"isNonNegative","url":"/reference/totalfinance/core/page-6#isNonNegative","description":"function from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (value)"},{"title":"isOccOptionSymbol","url":"/reference/totalfinance/core/page-6#isOccOptionSymbol","description":"Whether `symbol` is an OCC option symbol: true exactly when the OCC grammar accepts it — the\nsame parse {@link parseOccSymbol} performs before resolving the exp","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (symbol)"},{"title":"isPositive","url":"/reference/totalfinance/core/page-6#isPositive","description":"function from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (value)"},{"title":"isQuantError","url":"/reference/totalfinance/core/page-6#isQuantError","description":"Type guard: is this value a QuantError (and optionally a specific code)?","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (code) (value)"},{"title":"isTrustworthy","url":"/reference/totalfinance/core/page-6#isTrustworthy","description":"C (hygiene): the one question a caller asks of any envelope — may I act on this number? A result\nis trustworthy when its iterative procedure converged (or none ","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (result)"},{"title":"isUsEquityHalfDay","url":"/reference/totalfinance/core/page-6#isUsEquityHalfDay","description":"Whether a `YYYY-MM-DD` calendar date is a US equity/options early-close day (13:00 ET). Applies\n{@link US_EQUITY_HALF_DAY_RULES} with the weekend and observed-h","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (date)"},{"title":"isoDateToEpochMs","url":"/reference/totalfinance/core/page-6#isoDateToEpochMs","description":"Convert an ISO `YYYY-MM-DD` date to epoch milliseconds at UTC midnight.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (value)"},{"title":"lastWeekdayOfMonth","url":"/reference/totalfinance/core/page-6#lastWeekdayOfMonth","description":"The last `weekday` of a month, e.g. last Monday of May.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (month) (weekday) (year)"},{"title":"missingFieldError","url":"/reference/totalfinance/core/page-6#missingFieldError","description":"Build the canonical \"a required field is missing\" error (design law #4 / the first-touch law).\nOne voice across every facade: it names the field and shows a WOR","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (example) (field) (functionName) (hint) return.code return.context return.toJSON"},{"title":"nthWeekdayOfMonth","url":"/reference/totalfinance/core/page-6#nthWeekdayOfMonth","description":"The `occurrence`-th (1-based) `weekday` of a month, e.g. 3rd Monday of January. Returns `null`\nwhen the month has no such occurrence (e.g. a 5th Friday in a 4-F","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (month) (occurrence) (weekday) (year)"},{"title":"observedHoliday","url":"/reference/totalfinance/core/page-6#observedHoliday","description":"Apply the US observance rule: Saturday → preceding Friday, Sunday → following Monday.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (day) (month) (year)"},{"title":"optionExpiryToMs","url":"/reference/totalfinance/core/page-7#optionExpiryToMs","description":"Parse an option-expiry label to epoch-ms. A bare `YYYY-MM-DD` resolves to {@link usEquityCloseUtcMs}\n(16:00 ET) — not UTC midnight — so an intraday `asOf` on th","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (expiry)"},{"title":"parseIsoDate","url":"/reference/totalfinance/core/page-7#parseIsoDate","description":"Parse an ISO `YYYY-MM-DD` date into calendar components, validating it is a real date.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (value) return.day return.month return.year"},{"title":"parseOccSymbol","url":"/reference/totalfinance/core/page-7#parseOccSymbol","description":"Parse an OCC option symbol into its components.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (symbol) return.expiresAt return.expiry return.expiryConvention return.root return.strike return.type"},{"title":"plausibilityWarnings","url":"/reference/totalfinance/core/page-7#plausibilityWarnings","description":"Plausibility warnings for the two classic quant footguns (the first-touch law §2.4). Facades stay\nsilent-and-correct on the plain-value path (a 2200% vol is leg","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (inputs) (inputs).riskFreeRate (inputs).timeToExpiryYears (inputs).volatility"},{"title":"requireArgumentArray","url":"/reference/totalfinance/core/page-7#requireArgumentArray","description":"Throw unless `value` is a real array (or typed array).","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (field) (functionName) (value)"},{"title":"requireArgumentObject","url":"/reference/totalfinance/core/page-7#requireArgumentObject","description":"function from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (field) (functionName) (value)"},{"title":"requireFiniteFields","url":"/reference/totalfinance/core/page-7#requireFiniteFields","description":"function from @insiderfinance/totalfinance/core","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (fields) (functionName) (input) (options) (options).exampleCall (options).hints (options).path"},{"title":"requireRateCurveData","url":"/reference/totalfinance/core/page-7#requireRateCurveData","description":"The ONE full validator for a stored/observed {@link RateCurve} as PLAIN DATA — shared by the\nGate B market-snapshot spine (`observations.curves`) and the Gate C","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (functionName) (path) (value) return.asOf return.compounding return.currency return.dayCount return.interpolation return.points"},{"title":"requireRepresentableResult","url":"/reference/totalfinance/core/page-7#requireRepresentableResult","description":"Law 7's INPUT-DRIVEN twin (2026-08-23 review wave): refuse a computed result that finite inputs\npushed past IEEE-754 double precision. `assertFiniteValue` repor","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (functionName) (result)"},{"title":"requireSelection","url":"/reference/totalfinance/core/page-7#requireSelection","description":"Validate an explicit SELECTION list — `outputs: ['price', 'gamma']`, `metrics: ['gex']` — and\nreturn a dense copy in request order.\n\nA selection decides what is","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (allowed) (field) (functionName) (value)"},{"title":"resolveAsOf","url":"/reference/totalfinance/core/page-7#resolveAsOf","description":"Resolve a DATE-GRANULAR `asOf` to epoch ms — ledgers, calendars, fundamentals, performance and\nresearch windows, where \"as of 2026-07-06\" means the calendar dat","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (asOf) (functionName)"},{"title":"resolveValuationAsOf","url":"/reference/totalfinance/core/page-7#resolveValuationAsOf","description":"Resolve a VALUATION instant (`asOf`) to epoch ms — the door every option-pricing path uses\n(options, strategy, volatility, structure, scenarios, risk marking). ","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (asOf) (functionName)"},{"title":"resolvedExpiry","url":"/reference/totalfinance/core/page-7#resolvedExpiry","description":"Resolve an expiry label to the REQUIRED contract fields (E2): the spreadable\n`{ expiresAt, expiryConvention }` pair for constructing an `OptionContract` from a ","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (expiry) return.expiresAt return.expiryConvention"},{"title":"round","url":"/reference/totalfinance/core/page-7#round","description":"Round half-away-from-zero to `decimals` places, robust to floating-point representation.\n\nTotal over the double domain: `decimals` must be an integer in [-323, ","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (decimals) (value)"},{"title":"selectQuotePrice","url":"/reference/totalfinance/core/page-7#selectQuotePrice","description":"Resolve a single price from an option quote per the requested source. Returns `undefined` when\nthe requested fields are absent. `mid` falls back to (bid+ask)/2 ","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (quote) (quote).ask (quote).askSize (quote).bid (quote).bidSize (quote).conditions (quote).contract (quote).exchange (quote).greeks (quote). @insiderfinance/totalfinance/options"},{"title":"seriesFacade","url":"/reference/totalfinance/core/page-7#seriesFacade","description":"Pair a series-first `call` with an `.explain()` that takes the same arguments (S2 facades).\n`label` is the public name of the facade as the user calls it (e.g. ","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (call) (explain) (label) return.explain"},{"title":"sideOf","url":"/reference/totalfinance/core/page-7#sideOf","description":"The side of a signed quantity: positive buys, negative sells. Zero and non-finite values have\nno side and are refused — a caller that reaches here with `0` has ","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (functionName) (signed)"},{"title":"signOf","url":"/reference/totalfinance/core/page-7#signOf","description":"The sign of a side: `+1` for a buy, `-1` for a sell. Any other value is refused.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (functionName) (side)"},{"title":"stableSum","url":"/reference/totalfinance/core/page-7#stableSum","description":"Sum signed finite addends without losing a representable answer to evaluation order.\n\nThe ordinary path uses a non-overlapping floating-point expansion: low-ord","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (addends)"},{"title":"suspiciousReturnsWarning","url":"/reference/totalfinance/core/page-7#suspiciousReturnsWarning","description":"The third classic footgun (dx WS-3 / R6): a PRICE or equity series passed where per-period\nRETURNS are expected. Returns are decimals (`0.01` = +1%); a series w","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (returns) return.code return.context return.message return.severity"},{"title":"toFixedSafe","url":"/reference/totalfinance/core/page-8#toFixedSafe","description":"`toFixed` that never throws on non-finite input and never returns `\"NaN\"` silently.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (decimals) (value)"},{"title":"usEquityCloseUtcMs","url":"/reference/totalfinance/core/page-8#usEquityCloseUtcMs","description":"UTC epoch-ms for the **US equity/options market close** on a calendar date — 16:00\nAmerica/New_York, or 13:00 on an early-close day ({@link isUsEquityHalfDay}) ","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (day) (month) (year)"},{"title":"usEquityMarketDateUtcMs","url":"/reference/totalfinance/core/page-8#usEquityMarketDateUtcMs","description":"UTC-midnight epoch of the market DATE an instant falls on — the anchor for weekday / day-of-month\narithmetic (`getUTCDay()` on it is the ET weekday) and for who","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (epochMs)"},{"title":"usEquityMarketDayIndex","url":"/reference/totalfinance/core/page-8#usEquityMarketDayIndex","description":"The US equity/options market's calendar DAY an instant falls on, as a whole-day index (days since\nthe epoch of the America/New_York calendar date). Differencing","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (epochMs)"},{"title":"usEquitySessionInstant","url":"/reference/totalfinance/core/page-8#usEquitySessionInstant","description":"The instant of a US equity/options session boundary on a `YYYY-MM-DD` date — the one-call way\nto say \"as of today's close\" without remembering the DST offset:\n\n","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (date) (session)"},{"title":"validateClosedRequest","url":"/reference/totalfinance/core/page-8#validateClosedRequest","description":"Validate one public closed request against its GENERATED contract spec. Call ONCE at the public\nboundary; internals stay unchecked. Domain semantics (positivity","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (functionName) (specification) (specification).branches (specification).contract (specification).fields (teaching) (teaching).argumentName ("},{"title":"validateResolvedExpiry","url":"/reference/totalfinance/core/page-8#validateResolvedExpiry","description":"ONE expiry law, cross-field (E2): validate that a resolved option-expiry triple —\n`expiry` label, `expiresAt` instant, `expiryConvention` — is internally consis","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (expiresAt) (expiry) (expiryConvention) (functionName)"},{"title":"warning","url":"/reference/totalfinance/core/page-8#warning","description":"Build a warning helper, defaulting severity to `warn`.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (code) (context) (message) (severity) return.code return.context return.message return.severity"},{"title":"weekendsOnly","url":"/reference/totalfinance/core/page-8#weekendsOnly","description":"A calendar whose only non-business days are weekends.","category":"@insiderfinance/totalfinance/core","kind":"value","keywords":"@insiderfinance/totalfinance/core value  addBusinessDays addBusinessDays(date) addBusinessDays(days) businessDaysBetween businessDaysBetween(from) businessDaysBetween(to) isBusiness"},{"title":"wrongShapeError","url":"/reference/totalfinance/core/page-8#wrongShapeError","description":"Build a \"this object isn't the expected shape\" error that echoes the keys the caller DID pass. The\nreceived-keys echo turns the error into documentation of the ","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (expected) (functionName) (received) return.code return.context return.toJSON"},{"title":"yearFraction","url":"/reference/totalfinance/core/page-8#yearFraction","description":"Year fraction between two dates under a day-count convention.\n\n- `ACT/365F` and `ACT/360` use actual elapsed days.\n- `30/360` uses the US (NASD) bond-basis adju","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (dayCount) (from) (to)"},{"title":"ymd","url":"/reference/totalfinance/core/page-8#ymd","description":"Compose an ISO date from components.","category":"@insiderfinance/totalfinance/core","kind":"function","keywords":"@insiderfinance/totalfinance/core function  (day) (month) (year)"},{"title":"ANALYSIS_ARTIFACT_KIND","url":"/reference/totalfinance/core/artifacts#ANALYSIS_ARTIFACT_KIND","description":"value from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/core/artifacts value  "},{"title":"ANALYSIS_ARTIFACT_SCHEMA_VERSION","url":"/reference/totalfinance/core/artifacts#ANALYSIS_ARTIFACT_SCHEMA_VERSION","description":"Current artifact schema version — same bump-with-migration policy as the market snapshot.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/core/artifacts value  "},{"title":"ARTIFACT_WORK_LIMITS","url":"/reference/totalfinance/core/artifacts#ARTIFACT_WORK_LIMITS","description":"Decision 9's bounded-work table: what a caller may lower, and the hard maxima never passed.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/core/artifacts value  embeddedRowLimit embeddedRowLimit.default embeddedRowLimit.maximum gridPoints gridPoints.default gridPoints.maximum holdoutEvaluations holdo"},{"title":"AnalysisArtifact","url":"/reference/totalfinance/core/artifacts#AnalysisArtifact","description":"interface from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  artifactType conventionsVersion createdFrom id inputs inputs.inputsHash inputs.parameters inputs.snapshotHash kind producedBy producedBy.lib"},{"title":"AppliedMigration","url":"/reference/totalfinance/core/artifacts#AppliedMigration","description":"One applied step, echoed by the readers so an upgrade is never invisible.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  description fromVersion kind toVersion"},{"title":"ArtifactComparison","url":"/reference/totalfinance/core/artifacts#ArtifactComparison","description":"interface from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  artifactIds artifactIds.baseline artifactIds.candidate artifactType assumptions assumptions.comparison assumptions.conventionsVersion assump"},{"title":"ArtifactInputs","url":"/reference/totalfinance/core/artifacts#ArtifactInputs","description":"Input identity for replay: hashes for bulk, embedded values only for small parameters.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  inputsHash parameters snapshotHash"},{"title":"ArtifactMigration","url":"/reference/totalfinance/core/artifacts#ArtifactMigration","description":"One explicit schema-upgrade step for one envelope kind.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  description fromVersion kind migrate migrate(envelope) toVersion"},{"title":"ArtifactMigrationRegistry","url":"/reference/totalfinance/core/artifacts#ArtifactMigrationRegistry","description":"interface from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  find find().return.description find().return.fromVersion find().return.kind find().return.migrate find().return.toVersion find(fromVersion) "},{"title":"ArtifactProducedBy","url":"/reference/totalfinance/core/artifacts#ArtifactProducedBy","description":"What produced the result — the call a replay re-issues.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  libraryVersion operation"},{"title":"ArtifactReplayParity","url":"/reference/totalfinance/core/artifacts#ArtifactReplayParity","description":"interface from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  addedPaths assumptions assumptions.comparison assumptions.conventionsVersion assumptions.limits assumptions.limits.maximumDifferences assump"},{"title":"CANONICAL_DATA_MAX_DEPTH","url":"/reference/totalfinance/core/artifacts#CANONICAL_DATA_MAX_DEPTH","description":"The default nesting limit: deeper stored data is refused as a structural hazard.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/core/artifacts value  "},{"title":"CANONICAL_JSON_VERSION","url":"/reference/totalfinance/core/artifacts#CANONICAL_JSON_VERSION","description":"The canonicalization rules above, as a versioned public fact.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/core/artifacts value  "},{"title":"COMPARISON_LIMITS","url":"/reference/totalfinance/core/artifacts#COMPARISON_LIMITS","description":"value from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/core/artifacts value  maximumDifferences maximumDifferences.default maximumDifferences.maximum maximumLeaves maximumLeaves.default maximumLeaves.maximum"},{"title":"CONTENT_HASH_PREFIX","url":"/reference/totalfinance/core/artifacts#CONTENT_HASH_PREFIX","description":"The hash-string grammar: algorithm prefix + lowercase hex digest.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/core/artifacts value  "},{"title":"CalculationArtifactComparison","url":"/reference/totalfinance/core/artifacts#CalculationArtifactComparison","description":"type from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/core/artifacts type  artifactIds artifactIds.baseline artifactIds.candidate assumptions assumptions.comparison assumptions.conventionsVersion assumptions.limits "},{"title":"CalculationComparisonReason","url":"/reference/totalfinance/core/artifacts#CalculationComparisonReason","description":"type from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/core/artifacts type  "},{"title":"CalculationMetric","url":"/reference/totalfinance/core/artifacts#CalculationMetric","description":"The same economic metric mapped explicitly across two (possibly different) result schemas.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  baseline baseline.path baseline.unit candidate candidate.path candidate.unit name tolerance tolerance.absolute tolerance.relative"},{"title":"CalculationMetricComparison","url":"/reference/totalfinance/core/artifacts#CalculationMetricComparison","description":"interface from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  absoluteDelta baseline baseline.path baseline.unavailableReason baseline.unit baseline.value candidate candidate.path candidate.unavailableR"},{"title":"CalculationMetricObservation","url":"/reference/totalfinance/core/artifacts#CalculationMetricObservation","description":"interface from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  path unavailableReason unit value"},{"title":"CalculationMetricSelector","url":"/reference/totalfinance/core/artifacts/page-2#CalculationMetricSelector","description":"Own-property path relative to an artifact's `result`; components avoid ambiguous dotted keys.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  path unit"},{"title":"CalculationMetricUnavailableReason","url":"/reference/totalfinance/core/artifacts/page-2#CalculationMetricUnavailableReason","description":"type from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/core/artifacts type  "},{"title":"CalculationOperationPolicy","url":"/reference/totalfinance/core/artifacts/page-2#CalculationOperationPolicy","description":"type from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/core/artifacts type  "},{"title":"CalculationSourceDiagnostics","url":"/reference/totalfinance/core/artifacts/page-2#CalculationSourceDiagnostics","description":"Preserved source diagnostics: consumed fields are validated; harmless metadata remains intact.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  converged warnings"},{"title":"CanonicalDataScanOptions","url":"/reference/totalfinance/core/artifacts/page-2#CanonicalDataScanOptions","description":"interface from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  functionName ignoredSymbols label maximumDepth maximumWorkUnits requireFiniteNumbers"},{"title":"CompareCalculationArtifactsInput","url":"/reference/totalfinance/core/artifacts/page-2#CompareCalculationArtifactsInput","description":"interface from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  baseline baseline.artifactType baseline.conventionsVersion baseline.createdFrom baseline.id baseline.inputs baseline.inputs.inputsHash basel"},{"title":"ComparisonLimits","url":"/reference/totalfinance/core/artifacts/page-2#ComparisonLimits","description":"Work caps for one comparison or parity check. Defaults and hard maxima are Decision 9's.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  maximumDifferences maximumLeaves"},{"title":"ComparisonTolerance","url":"/reference/totalfinance/core/artifacts/page-2#ComparisonTolerance","description":"A two-sided tolerance: `|Δ| ≤ absolute + relative · |baseline|`, evaluated exactly on the supplied IEEE values.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  absolute relative"},{"title":"CreateMarketSnapshotInput","url":"/reference/totalfinance/core/artifacts/page-2#CreateMarketSnapshotInput","description":"Input for {@link createMarketSnapshot}.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  asOf conventions conventions.calendar conventions.compounding conventions.compounding.periodsPerYear conventions.compounding.type convention"},{"title":"CreateMarketSnapshotInputConventions","url":"/reference/totalfinance/core/artifacts/page-2#CreateMarketSnapshotInputConventions","description":"The caller-facing conventions at create time: everything in {@link MarketSnapshotConventions}\nEXCEPT `conventionsVersion` and `asOfConvention`, which the librar","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  calendar compounding compounding.periodsPerYear compounding.type dayCount"},{"title":"FittedModelObjectiveKind","url":"/reference/totalfinance/core/artifacts/page-2#FittedModelObjectiveKind","description":"type from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/core/artifacts type  "},{"title":"FittedModelResidualSource","url":"/reference/totalfinance/core/artifacts/page-2#FittedModelResidualSource","description":"type from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/core/artifacts type  "},{"title":"FittedModelSummary","url":"/reference/totalfinance/core/artifacts/page-2#FittedModelSummary","description":"interface from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  convergence convergence.converged convergence.iterations convergence.reason family inputIdentity inputIdentity.calibrationHash inputIdentity"},{"title":"MARKET_SNAPSHOT_KIND","url":"/reference/totalfinance/core/artifacts/page-2#MARKET_SNAPSHOT_KIND","description":"value from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/core/artifacts value  "},{"title":"MARKET_SNAPSHOT_SCHEMA_VERSION","url":"/reference/totalfinance/core/artifacts/page-2#MARKET_SNAPSHOT_SCHEMA_VERSION","description":"Current market-snapshot schema version. Bump ONLY with a shape change, and land the bump with a\nregistered migration — `readMarketSnapshot` refuses an older sto","category":"@insiderfinance/totalfinance/core/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/core/artifacts value  "},{"title":"MarketSnapshot","url":"/reference/totalfinance/core/artifacts/page-2#MarketSnapshot","description":"interface from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  asOf conventions conventions.asOfConvention conventions.calendar conventions.compounding conventions.compounding.periodsPerYear conventions."},{"title":"MarketSnapshotAsOfConvention","url":"/reference/totalfinance/core/artifacts/page-2#MarketSnapshotAsOfConvention","description":"How a snapshot's `asOf` was expressed at create time (stamped by `createMarketSnapshot`).","category":"@insiderfinance/totalfinance/core/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/core/artifacts type  "},{"title":"MarketSnapshotConventions","url":"/reference/totalfinance/core/artifacts/page-2#MarketSnapshotConventions","description":"interface from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  asOfConvention calendar compounding compounding.periodsPerYear compounding.type conventionsVersion dayCount"},{"title":"MarketSnapshotObservations","url":"/reference/totalfinance/core/artifacts/page-2#MarketSnapshotObservations","description":"interface from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  chains curves dividendYields riskFreeRates spots surfaces volatilities"},{"title":"NonFiniteNumber","url":"/reference/totalfinance/core/artifacts/page-2#NonFiniteNumber","description":"How a non-finite number is carried through JSON — one grammar, library-wide.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  nonFinite"},{"title":"OptionChainObservation","url":"/reference/totalfinance/core/artifacts/page-3#OptionChainObservation","description":"An option-chain observation: EITHER inline rows (small chains) or a {@link TableHandle}\nreference (large chains stay out of the envelope). Exactly one of the tw","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  quotes table table.columnCount table.columns table.contentHash table.kind table.locator table.mediaType table.rowCount"},{"title":"SCENARIO_SET_KIND","url":"/reference/totalfinance/core/artifacts/page-3#SCENARIO_SET_KIND","description":"value from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/core/artifacts value  "},{"title":"SCENARIO_SET_SCHEMA_VERSION","url":"/reference/totalfinance/core/artifacts/page-3#SCENARIO_SET_SCHEMA_VERSION","description":"Current scenario-set schema version — same bump-with-migration policy as the other envelopes.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/core/artifacts value  "},{"title":"ScenarioDefinition","url":"/reference/totalfinance/core/artifacts/page-3#ScenarioDefinition","description":"interface from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  name overrides shocks"},{"title":"ScenarioFactor","url":"/reference/totalfinance/core/artifacts/page-3#ScenarioFactor","description":"The factor vocabulary shared with `@insiderfinance/totalfinance/risk`'s scenario engine; open for custom labels.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/core/artifacts type  "},{"title":"ScenarioOverride","url":"/reference/totalfinance/core/artifacts/page-3#ScenarioOverride","description":"An absolute set: the observation for `(factor, target)` BECOMES `value` before shocks apply.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  factor target value"},{"title":"ScenarioSet","url":"/reference/totalfinance/core/artifacts/page-3#ScenarioSet","description":"interface from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  kind name provenance provenance.asOf provenance.dataset provenance.provider provenance.receivedAt provenance.requestId provenance.sourceVers"},{"title":"ScenarioShock","url":"/reference/totalfinance/core/artifacts/page-3#ScenarioShock","description":"A relative change: `percent` scales the base level; `absolute` adds in the factor's own unit.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  factor kind target value"},{"title":"SpotObservation","url":"/reference/totalfinance/core/artifacts/page-3#SpotObservation","description":"A spot observation. Open per Law 12: extra vendor fields are preserved, finite, and unread.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  currency price timestampMs"},{"title":"TABLE_HANDLE_KIND","url":"/reference/totalfinance/core/artifacts/page-3#TABLE_HANDLE_KIND","description":"value from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/core/artifacts value  "},{"title":"TABLE_MEDIA_TYPE_ARROW_RESERVED","url":"/reference/totalfinance/core/artifacts/page-3#TABLE_MEDIA_TYPE_ARROW_RESERVED","description":"The reserved (unimplemented) Arrow media type — reserved here so no caller invents a second name.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/core/artifacts value  "},{"title":"TableHandle","url":"/reference/totalfinance/core/artifacts/page-3#TableHandle","description":"interface from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  columnCount columns contentHash kind locator mediaType rowCount"},{"title":"ValueDifference","url":"/reference/totalfinance/core/artifacts/page-3#ValueDifference","description":"One differing leaf between the baseline and the candidate.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  absoluteDelta baselineValue candidateValue path relativeDelta withinTolerance"},{"title":"VolatilitySurfaceObservation","url":"/reference/totalfinance/core/artifacts/page-3#VolatilitySurfaceObservation","description":"An implied-volatility surface grid; `impliedVolatilities[i][j]` pairs expiry `i` with strike `j`.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  impliedVolatilities strikes timeToExpiryYears"},{"title":"WorkLimitLaw","url":"/reference/totalfinance/core/artifacts/page-3#WorkLimitLaw","description":"interface from @insiderfinance/totalfinance/core/artifacts","category":"@insiderfinance/totalfinance/core/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/core/artifacts interface  default maximum"},{"title":"applyReportMigrations","url":"/reference/totalfinance/core/artifacts/page-3#applyReportMigrations","description":"Gate B's migration policy at the REPORT level (Decision 5). The report is presented to the\ncaller's registry through the envelope view `{ kind, schemaVersion: <","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (input) (input).currentVersion (input).functionName (input).kind (input).migrations (input).report (input).storedVersion (input).subject (in"},{"title":"artifactReplayParity","url":"/reference/totalfinance/core/artifacts/page-3#artifactReplayParity","description":"Byte-exact replay parity between a saved value and its recomputation (Decision 7).","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function ```ts\nconst parity = artifactReplayParity({ saved: artifact.result, recomputed: rerun });\nparity.ide (input) (input).limits (input).recomputed (input).saved return.addedPaths return.assumptions return.assumptions.comparison return.assumption"},{"title":"canonicalJsonOf","url":"/reference/totalfinance/core/artifacts/page-3#canonicalJsonOf","description":"Serialize a JSON-safe value to its ONE canonical string. Deterministic: the same logical value —\nwhatever key order, whatever `-0`s — always yields the same byt","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (value)"},{"title":"canonicalStringWorkUnits","url":"/reference/totalfinance/core/artifacts/page-3#canonicalStringWorkUnits","description":"The canonical work cost of one string: one unit plus one per 64 characters.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (value)"},{"title":"compareAnalysisArtifacts","url":"/reference/totalfinance/core/artifacts/page-3#compareAnalysisArtifacts","description":"Compare two analysis artifacts of one `artifactType`, leaf by leaf (module header).","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function ```ts\nconst comparison = compareAnalysisArtifacts({\n  baseline: yesterdayArtifact,\n  candidate: toda (input) (input).baseline (input).candidate (input).limits (input).tolerance return.artifactIds return.artifactIds.baseline return.artifactId"},{"title":"compareCalculationArtifacts","url":"/reference/totalfinance/core/artifacts/page-4#compareCalculationArtifacts","description":"Compare selected financial metrics without confusing numerical closeness with matching economics.\nUses existing AnalysisArtifact validation/hashes and exact rep","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function ```ts\nconst comparison = compareCalculationArtifacts({\n  baseline, candidate,\n  metrics: [{ name: 'p (input) (input).baseline (input).candidate (input).limits (input).metrics (input).operationPolicy return.artifactIds return.artifactIds.base"},{"title":"contentHash","url":"/reference/totalfinance/core/artifacts/page-4#contentHash","description":"The spine's content identity: `sha256:` + SHA-256 of the value's canonical JSON. Same logical\nvalue → same hash, regardless of key order or `-0`; any covered fi","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (value)"},{"title":"createAnalysisArtifact","url":"/reference/totalfinance/core/artifacts/page-4#createAnalysisArtifact","description":"Save a computed result as an identified, immutable artifact.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function ```ts\nimport { createAnalysisArtifact, marketSnapshotContentHash } from '@insiderfinance/totalfinanc (input) (input).artifactType (input).createdFrom (input).inputs (input).inputs.parameters (input).inputs.snapshotHash (input).producedBy (in"},{"title":"createArtifactMigrationRegistry","url":"/reference/totalfinance/core/artifacts/page-4#createArtifactMigrationRegistry","description":"Create an empty, caller-owned migration registry.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  return.find return.register return.upgrade"},{"title":"createMarketSnapshot","url":"/reference/totalfinance/core/artifacts/page-4#createMarketSnapshot","description":"Build an immutable, versioned market snapshot from caller-supplied observations.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function ```ts\nimport { createMarketSnapshot, marketSnapshotContentHash } from '@insiderfinance/totalfinance/ (input) (input).asOf (input).conventions (input).observations (input).provenance return.asOf return.conventions return.kind return.observati"},{"title":"createScenarioSet","url":"/reference/totalfinance/core/artifacts/page-4#createScenarioSet","description":"Build an immutable, serializable scenario set.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function ```ts\nconst stress = createScenarioSet({\n  name: 'q3-desk-stress',\n  scenarios: [\n    { name: 'crash (input) (input).name (input).provenance (input).scenarios return.kind return.name return.provenance return.scenarios return.schemaVersion"},{"title":"createTableHandle","url":"/reference/totalfinance/core/artifacts/page-4#createTableHandle","description":"Build a validated, frozen table handle.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function ```ts\nconst handle = createTableHandle({\n  contentHash: contentHash(chainRows),\n  rowCount: chainRow (input) (input).columnCount (input).columns (input).contentHash (input).locator (input).mediaType (input).rowCount return.columnCount return"},{"title":"flattenSummaryParameters","url":"/reference/totalfinance/core/artifacts/page-4#flattenSummaryParameters","description":"A validated summary's flat parameter view: arrays become indexed keys (`thetaTerm.theta[2]`).\nTakes the whole summary (validated here, like every door) rather t","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (summary) (summary).convergence (summary).convergence.converged (summary).convergence.iterations (summary).convergence.reason (summary).fami"},{"title":"fromCanonicalJson","url":"/reference/totalfinance/core/artifacts/page-4#fromCanonicalJson","description":"Parse a canonical (or any) JSON text back to the runtime value, decoding every non-finite wrapper\nto its number. The inverse of {@link canonicalJsonOf}: `fromCa","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (text)"},{"title":"isAnalysisArtifact","url":"/reference/totalfinance/core/artifacts/page-4#isAnalysisArtifact","description":"Sound structural test for a CURRENT-version analysis-artifact envelope: the complete read-door\nbody validation behind a boolean door — closed keys, report shape","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (value)"},{"title":"isContentHashString","url":"/reference/totalfinance/core/artifacts/page-4#isContentHashString","description":"Exact shape test for a spine hash string (used by handle/artifact validation).","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (value)"},{"title":"isFittedModelSummary","url":"/reference/totalfinance/core/artifacts/page-4#isFittedModelSummary","description":"Sound structural predicate for a fitted-model summary: the COMPLETE {@link requireFittedModelSummary}\nvalidation behind a boolean door, so `value is FittedModel","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (value)"},{"title":"isMarketSnapshot","url":"/reference/totalfinance/core/artifacts/page-4#isMarketSnapshot","description":"Sound structural test for a CURRENT-version market snapshot envelope: the complete read-door\nvalidation (closed keys, kind, version, finite `asOf`, every observ","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (value)"},{"title":"isNonFiniteNumber","url":"/reference/totalfinance/core/artifacts/page-4#isNonFiniteNumber","description":"Exact wrapper test: a plain object whose ONLY member is a valid `nonFinite` tag.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (value)"},{"title":"isScenarioSet","url":"/reference/totalfinance/core/artifacts/page-4#isScenarioSet","description":"Sound structural test for a CURRENT-version scenario-set envelope: the complete read-door\nvalidation behind a boolean door — `true` means `readScenarioSet` woul","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (value)"},{"title":"isTableHandle","url":"/reference/totalfinance/core/artifacts/page-4#isTableHandle","description":"Structural PREDICATE for a table handle: the COMPLETE {@link requireTableHandle} validation\nbehind a boolean door, so `value is TableHandle` is a sound claim — ","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (value)"},{"title":"marketSnapshotContentHash","url":"/reference/totalfinance/core/artifacts/page-4#marketSnapshotContentHash","description":"The snapshot's content identity: `sha256:` over the canonical envelope WITHOUT `provenance`.\nConventions, `asOf`, and every observation are covered (two snapsho","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (snapshot) (snapshot).asOf (snapshot).conventions (snapshot).kind (snapshot).observations (snapshot).provenance (snapshot).schemaVersion"},{"title":"readAnalysisArtifact","url":"/reference/totalfinance/core/artifacts/page-4#readAnalysisArtifact","description":"Restore a stored artifact: envelope validation, explicit migration, full body re-validation —\nand TWO hash verifications. `inputs.inputsHash` is recomputed from","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (input) (input).artifact (input).migrations return.artifact return.migrationsApplied"},{"title":"readMarketSnapshot","url":"/reference/totalfinance/core/artifacts/page-4#readMarketSnapshot","description":"The ONE door back in for stored snapshots: validates the envelope (closed key set, kind,\nversion) BEFORE reading any observation, applies explicitly registered ","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (input) (input).migrations (input).snapshot return.migrationsApplied return.snapshot"},{"title":"readScenarioSet","url":"/reference/totalfinance/core/artifacts/page-4#readScenarioSet","description":"Restore a stored scenario set, with the shared version/migration policy.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (input) (input).migrations (input).scenarioSet return.migrationsApplied return.scenarioSet"},{"title":"requireComparisonTolerance","url":"/reference/totalfinance/core/artifacts/page-5#requireComparisonTolerance","description":"The explicit two-sided tolerance law: both members finite and ≥ 0, or no tolerance at all.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (input) (input).functionName (input).tolerance return.absolute return.relative"},{"title":"requireFittedModelSummary","url":"/reference/totalfinance/core/artifacts/page-5#requireFittedModelSummary","description":"The FULL summary validator — closed keys at every level, typed and finite fields, and the\nhonesty rules (a null objective or residual statistic needs its reason","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (functionName) (label) (value) return.convergence return.convergence.converged return.convergence.iterations return.convergence.reason retur"},{"title":"requireInstantMarketSnapshot","url":"/reference/totalfinance/core/artifacts/page-5#requireInstantMarketSnapshot","description":"The instant of a market snapshot for an OPTION-PRICING consumer. A snapshot created from a bare\ndate (`asOfConvention: 'date-midnight-utc'`) is refused with the","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (functionName) (snapshot) (snapshot).asOf (snapshot).conventions (snapshot).kind (snapshot).observations (snapshot).provenance (snapshot).sc"},{"title":"requireWorkLimit","url":"/reference/totalfinance/core/artifacts/page-5#requireWorkLimit","description":"Validate one work limit: a safe integer at or above `floor` (default 1), at or below the law's\nhard maximum; `undefined` takes the law's default when it has one","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (input) (input).field (input).floor (input).functionName (input).law (input).value"},{"title":"residualStatistics","url":"/reference/totalfinance/core/artifacts/page-5#residualStatistics","description":"Count, root-mean-square, and maximum absolute value of a residual list (null statistics when empty).","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (residuals) return.count return.maximumAbsolute return.rootMeanSquare"},{"title":"scanCanonicalData","url":"/reference/totalfinance/core/artifacts/page-5#scanCanonicalData","description":"Prove and measure behavior-free canonical stored data (see the module header). Returns the\ndeterministic canonical work cost; throws the first structural refusa","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function ```ts\nconst cost = scanCanonicalData(input.report, {\n  functionName: 'readReport',\n  label: 'input.r (options) (options).functionName (options).ignoredSymbols (options).label (options).maximumDepth (options).maximumWorkUnits (options).requir"},{"title":"scenarioSetContentHash","url":"/reference/totalfinance/core/artifacts/page-5#scenarioSetContentHash","description":"Content identity for a scenario set: the canonical envelope WITHOUT `provenance`.","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (scenarioSet) (scenarioSet).kind (scenarioSet).name (scenarioSet).provenance (scenarioSet).scenarios (scenarioSet).schemaVersion"},{"title":"sha256Hex","url":"/reference/totalfinance/core/artifacts/page-5#sha256Hex","description":"SHA-256 of a UTF-8 string, as 64 lowercase hex characters. The raw primitive under\n{@link contentHash}, exported so golden vectors and external comparisons (`ec","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (text)"},{"title":"tableHandleForRows","url":"/reference/totalfinance/core/artifacts/page-5#tableHandleForRows","description":"Mint the table handle for a row set the caller holds (Stage 4.5 Decision 4 — the ONE column law\nevery package shares, so the same rows always mint the same hand","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function ```ts\nconst handle = tableHandleForRows({ rows: observations, locator: 'universe/2026-09-01.json' }) (input) (input).locator (input).mediaType (input).rows return.columnCount return.columns return.contentHash return.kind return.locator retur"},{"title":"verifyReferencedRows","url":"/reference/totalfinance/core/artifacts/page-5#verifyReferencedRows","description":"Prove caller-supplied rows are the referenced table: they must be an array whose canonical\ncontent hash equals the stored handle's. Returns the rows (as given) ","category":"@insiderfinance/totalfinance/core/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/core/artifacts function  (input) (input).functionName (input).handle (input).label (input).rows"},{"title":"DATA_CONTRACT_VERSION","url":"/reference/totalfinance/core/data#DATA_CONTRACT_VERSION","description":"Public provider-neutral research contract, separate from all provider HTTP packages.","category":"@insiderfinance/totalfinance/core/data","kind":"value","keywords":"@insiderfinance/totalfinance/core/data value  "},{"title":"DataProviderError","url":"/reference/totalfinance/core/data#DataProviderError","description":"class from @insiderfinance/totalfinance/core/data","category":"@insiderfinance/totalfinance/core/data","kind":"class","keywords":"@insiderfinance/totalfinance/core/data class  (options) (options).cause (options).code (options).guidance (options).guidance.field (options).guidance.rule (options).retryAfterMs (options"},{"title":"createDataView","url":"/reference/totalfinance/core/data/page-3#createDataView","description":"Restore canonical page facts and choices; never infer missing v1 query/provider context.","category":"@insiderfinance/totalfinance/core/data","kind":"function","keywords":"@insiderfinance/totalfinance/core/data function  (input) (selection) return.bars return.closePrices return.continuation return.continuation.binding return.continuation.cursor return.continu"},{"title":"defineDataProvider","url":"/reference/totalfinance/core/data/page-3#defineDataProvider","description":"function from @insiderfinance/totalfinance/core/data","category":"@insiderfinance/totalfinance/core/data","kind":"function","keywords":"@insiderfinance/totalfinance/core/data function  (source) (source).capabilities (source).contractVersion (source).id (source).protocol (source).query (source).version return.capabilities re"},{"title":"DataAbortProbe","url":"/reference/totalfinance/core/data-conformance#DataAbortProbe","description":"interface from @insiderfinance/totalfinance/core/data-conformance","category":"@insiderfinance/totalfinance/core/data-conformance","kind":"interface","keywords":"@insiderfinance/totalfinance/core/data-conformance interface  kind name pageSize request request.expirationFrom request.expirationTo request.from request.interval request.kind request.maxStrike request."},{"title":"DataErrorProbe","url":"/reference/totalfinance/core/data-conformance#DataErrorProbe","description":"interface from @insiderfinance/totalfinance/core/data-conformance","category":"@insiderfinance/totalfinance/core/data-conformance","kind":"interface","keywords":"@insiderfinance/totalfinance/core/data-conformance interface  expectedCode kind name pageSize request"},{"title":"DataPagesProbe","url":"/reference/totalfinance/core/data-conformance#DataPagesProbe","description":"interface from @insiderfinance/totalfinance/core/data-conformance","category":"@insiderfinance/totalfinance/core/data-conformance","kind":"interface","keywords":"@insiderfinance/totalfinance/core/data-conformance interface  expectedPages kind name pageSize request request.expirationFrom request.expirationTo request.from request.interval request.kind request.maxS"},{"title":"DataProviderProbe","url":"/reference/totalfinance/core/data-conformance#DataProviderProbe","description":"type from @insiderfinance/totalfinance/core/data-conformance","category":"@insiderfinance/totalfinance/core/data-conformance","kind":"type","keywords":"@insiderfinance/totalfinance/core/data-conformance type  expectedCode expectedFacts expectedPages expectedRecords kind name pageSize request request.expirationFrom request.expirationTo request.from"},{"title":"DataRecordsProbe","url":"/reference/totalfinance/core/data-conformance#DataRecordsProbe","description":"interface from @insiderfinance/totalfinance/core/data-conformance","category":"@insiderfinance/totalfinance/core/data-conformance","kind":"interface","keywords":"@insiderfinance/totalfinance/core/data-conformance interface  expectedFacts expectedRecords kind name pageSize request request.expirationFrom request.expirationTo request.from request.interval request.k"},{"title":"ValidateDataProviderInput","url":"/reference/totalfinance/core/data-conformance#ValidateDataProviderInput","description":"interface from @insiderfinance/totalfinance/core/data-conformance","category":"@insiderfinance/totalfinance/core/data-conformance","kind":"interface","keywords":"@insiderfinance/totalfinance/core/data-conformance interface  maxPages maxRecords probes provider provider.capabilities provider.capabilities(options) provider.capabilities(options).signal provider.cont"},{"title":"validateDataProvider","url":"/reference/totalfinance/core/data-conformance#validateDataProvider","description":"function from @insiderfinance/totalfinance/core/data-conformance","category":"@insiderfinance/totalfinance/core/data-conformance","kind":"function","keywords":"@insiderfinance/totalfinance/core/data-conformance function  (input) (input).maxPages (input).maxRecords (input).probes (input).provider (input).timeoutMs"},{"title":"DiscountCurveRequirement","url":"/reference/totalfinance/core/pricing#DiscountCurveRequirement","description":"ONE named discount curve, satisfied by a core {@link RateCurve} — PLAIN DATA, the same payload a\nGate B market snapshot stores under `observations.curves`, so t","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  currency curveId kind optional"},{"title":"DividendYieldRequirement","url":"/reference/totalfinance/core/pricing#DividendYieldRequirement","description":"A continuous dividend yield (decimal) for one underlying.","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  kind optional symbol"},{"title":"ForwardRequirement","url":"/reference/totalfinance/core/pricing#ForwardRequirement","description":"The forward price of one underlying to a delivery/expiry instant.","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  expiresAt kind optional symbol"},{"title":"ImpliedVolatilityRequirement","url":"/reference/totalfinance/core/pricing#ImpliedVolatilityRequirement","description":"An implied volatility (decimal, e.g. `0.24`) for one contract coordinate.","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  expiresAt kind optional strike symbol"},{"title":"MarketObservation","url":"/reference/totalfinance/core/pricing#MarketObservation","description":"One satisfied requirement: the descriptor it answers plus the value. Carrying the DESCRIPTOR\n(not a bare keyed map) keeps matching structural and lets the same ","category":"@insiderfinance/totalfinance/core/pricing","kind":"type","keywords":"@insiderfinance/totalfinance/core/pricing type  requirement requirement.currency requirement.curveId requirement.expiresAt requirement.kind requirement.optional requirement.strike requirem"},{"title":"MarketRequirement","url":"/reference/totalfinance/core/pricing#MarketRequirement","description":"One typed market-requirement descriptor — plain, serializable data. A pricer returns these from\n`requirements(instrument)`; a runner satisfies them from a snaps","category":"@insiderfinance/totalfinance/core/pricing","kind":"type","keywords":"@insiderfinance/totalfinance/core/pricing type  currency curveId expiresAt kind optional strike symbol"},{"title":"ObservationKind","url":"/reference/totalfinance/core/pricing#ObservationKind","description":"The closed set of observation kinds a pricer may require. These names are the shared vocabulary\nwith the Gate B market-snapshot spine: a snapshot stores observa","category":"@insiderfinance/totalfinance/core/pricing","kind":"type","keywords":"@insiderfinance/totalfinance/core/pricing type  "},{"title":"ObservationValueByKind","url":"/reference/totalfinance/core/pricing#ObservationValueByKind","description":"The value type each observation kind is satisfied with. Every value is plain, serializable data.","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  discountCurve discountCurve.asOf discountCurve.compounding discountCurve.compounding.periodsPerYear discountCurve.compounding.type discountC"},{"title":"Pricer","url":"/reference/totalfinance/core/pricing#Pricer","description":"interface from @insiderfinance/totalfinance/core/pricing","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  capabilities capabilities.batch capabilities.greeks capabilities.randomness name price price(input) price(input).instrument price(input).obs"},{"title":"PricerBatchPriceInput","url":"/reference/totalfinance/core/pricing#PricerBatchPriceInput","description":"One complete batch pricing request: one coherent observation set across many instruments.","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  instruments observations request request.greeks request.seed"},{"title":"PricerCapabilities","url":"/reference/totalfinance/core/pricing#PricerCapabilities","description":"Machine-readable pricer capabilities, behaviorally verified by {@link validatePricer} — a claim\nthe kit cannot confirm fails conformance, so capabilities can ne","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  batch greeks randomness"},{"title":"PricerPriceInput","url":"/reference/totalfinance/core/pricing#PricerPriceInput","description":"One complete scalar pricing request.","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  instrument observations request request.greeks request.seed"},{"title":"PricerProbe","url":"/reference/totalfinance/core/pricing#PricerProbe","description":"One caller-supplied behavioral fixture for {@link validatePricer}. The CALLER supplies the\ninstrument and a full observation set — the kit cannot invent meaning","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  expectSelection instrument observations request request.greeks request.seed"},{"title":"PricerValuationRequest","url":"/reference/totalfinance/core/pricing#PricerValuationRequest","description":"Per-call request flags. Closed; adapters map them onto their wrapped function's own options.","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  greeks seed"},{"title":"PricerValuationResult","url":"/reference/totalfinance/core/pricing#PricerValuationResult","description":"Domain-neutral static floor for a Gate-C valuation result.\n\n`Computed<number>` is the default, but domains may legitimately widen assumption vocabularies\n(fixed","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  assumptions assumptions.conventionsVersion diagnostics diagnostics.engine diagnostics.selection diagnostics.selection.candidates diagnostics"},{"title":"RequirementOfKind","url":"/reference/totalfinance/core/pricing#RequirementOfKind","description":"The requirement-descriptor variant for one kind.","category":"@insiderfinance/totalfinance/core/pricing","kind":"type","keywords":"@insiderfinance/totalfinance/core/pricing type  "},{"title":"RiskFreeRateRequirement","url":"/reference/totalfinance/core/pricing#RiskFreeRateRequirement","description":"A continuously-compounded risk-free rate (decimal) for one currency.","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  currency kind optional"},{"title":"SelectionCandidate","url":"/reference/totalfinance/core/pricing#SelectionCandidate","description":"One engine an automatic selection considered, with why it was or was not usable/chosen.","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  eligible name reason"},{"title":"SelectionReport","url":"/reference/totalfinance/core/pricing#SelectionReport","description":"The inspectable engine-selection report carried at `diagnostics.selection`. This FORMALIZES the\noptions package's existing `diagnostics.engine` + `diagnostics.a","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  candidates mode reason selected selected.name selected.version"},{"title":"SpotRequirement","url":"/reference/totalfinance/core/pricing#SpotRequirement","description":"The spot price of one underlying.","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  kind optional symbol"},{"title":"ValuationInstantRequirement","url":"/reference/totalfinance/core/pricing/page-2#ValuationInstantRequirement","description":"The instant a valuation is \"as of\". Required by any pricer that discounts or measures time to\nexpiry. Making it a requirement — rather than ambient state — is w","category":"@insiderfinance/totalfinance/core/pricing","kind":"interface","keywords":"@insiderfinance/totalfinance/core/pricing interface  kind optional"},{"title":"definePricer","url":"/reference/totalfinance/core/pricing/page-2#definePricer","description":"Structural, side-effect-free validation of a pricer definition (identity, capability grammar,\nmethod presence, batch coherence). Mirrors `defineOptionPricingEng","category":"@insiderfinance/totalfinance/core/pricing","kind":"function","keywords":"@insiderfinance/totalfinance/core/pricing function  (pricer) (pricer).capabilities (pricer).name (pricer).price (pricer).priceBatch (pricer).requirements (pricer).supports (pricer).version ret"},{"title":"missingRequirements","url":"/reference/totalfinance/core/pricing/page-2#missingRequirements","description":"The REQUIRED requirements not satisfied by `observations` — a runner's pre-flight, so a book can\nreport every gap at once instead of failing one missing observa","category":"@insiderfinance/totalfinance/core/pricing","kind":"function","keywords":"@insiderfinance/totalfinance/core/pricing function  (input) (input).observations (input).requirements"},{"title":"observationFor","url":"/reference/totalfinance/core/pricing/page-2#observationFor","description":"Find the observation satisfying `requirement`, or `undefined`. Pure lookup, no validation walk.","category":"@insiderfinance/totalfinance/core/pricing","kind":"function","keywords":"@insiderfinance/totalfinance/core/pricing function  (observations) (requirement) (requirement).currency (requirement).curveId (requirement).expiresAt (requirement).kind (requirement).optional "},{"title":"optionalObservationValue","url":"/reference/totalfinance/core/pricing/page-2#optionalObservationValue","description":"The value satisfying an OPTIONAL requirement, or `undefined` when absent. The consuming pricer\nowns disclosing whatever default it applies (the no-silent-econom","category":"@insiderfinance/totalfinance/core/pricing","kind":"function","keywords":"@insiderfinance/totalfinance/core/pricing function  (functionName) (observations) (requirement)"},{"title":"requireObservationValue","url":"/reference/totalfinance/core/pricing/page-2#requireObservationValue","description":"The value satisfying a REQUIRED requirement. Missing → the protocol's teaching error\n(`pricer.requirement_unsatisfied`, naming the exact descriptor and what was","category":"@insiderfinance/totalfinance/core/pricing","kind":"function","keywords":"@insiderfinance/totalfinance/core/pricing function  (functionName) (observations) (requirement)"},{"title":"requirementKey","url":"/reference/totalfinance/core/pricing/page-2#requirementKey","description":"Canonical identity of a requirement: kind plus subject fields in declaration order, e.g.\n`impliedVolatility(symbol=AAPL, strike=200, expiresAt=1789430400000)` o","category":"@insiderfinance/totalfinance/core/pricing","kind":"function","keywords":"@insiderfinance/totalfinance/core/pricing function  (requirement) (requirement).currency (requirement).curveId (requirement).expiresAt (requirement).kind (requirement).optional (requirement).s"},{"title":"sameRequirement","url":"/reference/totalfinance/core/pricing/page-2#sameRequirement","description":"Whether two descriptors identify the same observation (same kind + subject; `optional` ignored).","category":"@insiderfinance/totalfinance/core/pricing","kind":"function","keywords":"@insiderfinance/totalfinance/core/pricing function  (first) (first).currency (first).curveId (first).expiresAt (first).kind (first).optional (first).strike (first).symbol (second) (second).cur"},{"title":"validateMarketObservation","url":"/reference/totalfinance/core/pricing/page-2#validateMarketObservation","description":"Validate one observation: a valid descriptor plus a value of that kind's type.","category":"@insiderfinance/totalfinance/core/pricing","kind":"function","keywords":"@insiderfinance/totalfinance/core/pricing function  (functionName) (label) (observation) return.requirement return.value"},{"title":"validateMarketRequirement","url":"/reference/totalfinance/core/pricing/page-2#validateMarketRequirement","description":"Validate one requirement descriptor: known kind, closed keys, correctly-typed subject fields.\nUsed by the helpers below and by the conformance kit; adapters get","category":"@insiderfinance/totalfinance/core/pricing","kind":"function","keywords":"@insiderfinance/totalfinance/core/pricing function  (functionName) (label) (requirement) return.currency return.curveId return.expiresAt return.kind return.optional return.strike return.symbol"},{"title":"validatePricer","url":"/reference/totalfinance/core/pricing/page-2#validatePricer","description":"Behaviorally verify a Pricer against CALLER-SUPPLIED fixtures. Every failure teaches: the error\nnames the probe, the broken law, and the fix.\n\nPer probe, the ki","category":"@insiderfinance/totalfinance/core/pricing","kind":"function","keywords":"@insiderfinance/totalfinance/core/pricing function  (pricer) (pricer).capabilities (pricer).name (pricer).price (pricer).priceBatch (pricer).requirements (pricer).supports (pricer).version (pr"},{"title":"validateSelectionReport","url":"/reference/totalfinance/core/pricing/page-2#validateSelectionReport","description":"Validate a selection report's grammar (shape, mode/candidates coherence, chosen-among-candidates).","category":"@insiderfinance/totalfinance/core/pricing","kind":"function","keywords":"@insiderfinance/totalfinance/core/pricing function  (functionName) (report) return.candidates return.mode return.reason return.selected return.selected.name return.selected.version"},{"title":"ArraySchema","url":"/reference/totalfinance/core/schema#ArraySchema","description":"class from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"class","keywords":"@insiderfinance/totalfinance/core/schema class  (bounds) (bounds).max (bounds).min (item) (item)._check (item)._toJSONSchema (item).describe (item).description (item).isOptional (item).kin"},{"title":"BarSchema","url":"/reference/totalfinance/core/schema#BarSchema","description":"value from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _check(inpu"},{"title":"BooleanSchema","url":"/reference/totalfinance/core/schema#BooleanSchema","description":"class from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"class","keywords":"@insiderfinance/totalfinance/core/schema class  _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _check(inpu"},{"title":"CorporateActionSchema","url":"/reference/totalfinance/core/schema#CorporateActionSchema","description":"value from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _check(inpu"},{"title":"DividendSchema","url":"/reference/totalfinance/core/schema#DividendSchema","description":"value from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _check(inpu"},{"title":"EnumSchema","url":"/reference/totalfinance/core/schema#EnumSchema","description":"class from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"class","keywords":"@insiderfinance/totalfinance/core/schema class  (values) _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _c"},{"title":"Infer","url":"/reference/totalfinance/core/schema#Infer","description":"Extract the validated output type of a schema.","category":"@insiderfinance/totalfinance/core/schema","kind":"type","keywords":"@insiderfinance/totalfinance/core/schema type  "},{"title":"InferObject","url":"/reference/totalfinance/core/schema#InferObject","description":"type from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"type","keywords":"@insiderfinance/totalfinance/core/schema type  "},{"title":"JSONSchemaTypeName","url":"/reference/totalfinance/core/schema#JSONSchemaTypeName","description":"A pragmatic JSON Schema (Draft 2020-12) shape — enough for MCP tools and docs.","category":"@insiderfinance/totalfinance/core/schema","kind":"type","keywords":"@insiderfinance/totalfinance/core/schema type  "},{"title":"JSON_SCHEMA_MAX_DEPTH","url":"/reference/totalfinance/core/schema#JSON_SCHEMA_MAX_DEPTH","description":"The deepest nesting a document may declare; deeper is a cycle, not a schema.","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  "},{"title":"LiteralSchema","url":"/reference/totalfinance/core/schema#LiteralSchema","description":"class from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"class","keywords":"@insiderfinance/totalfinance/core/schema class  (value) _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _ch"},{"title":"NumberConstraints","url":"/reference/totalfinance/core/schema#NumberConstraints","description":"interface from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"interface","keywords":"@insiderfinance/totalfinance/core/schema interface  exclusiveMax exclusiveMin integer max min"},{"title":"NumberSchema","url":"/reference/totalfinance/core/schema#NumberSchema","description":"class from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"class","keywords":"@insiderfinance/totalfinance/core/schema class  (constraints) (constraints).exclusiveMax (constraints).exclusiveMin (constraints).integer (constraints).max (constraints).min _check _check("},{"title":"ObjectSchema","url":"/reference/totalfinance/core/schema#ObjectSchema","description":"class from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"class","keywords":"@insiderfinance/totalfinance/core/schema class  (shape) _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _ch"},{"title":"OptionContractSchema","url":"/reference/totalfinance/core/schema#OptionContractSchema","description":"E2 — the contract schema validates the RESOLVED ARTIFACT cross-field, not just field shapes:\nafter the structural parse, `validateResolvedExpiry` confirms the l","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio @insiderfinance/totalfinance/options @insiderfinance/totalfinance/options/schema"},{"title":"OptionQuoteSchema","url":"/reference/totalfinance/core/schema#OptionQuoteSchema","description":"value from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _check(inpu"},{"title":"OptionTradeSchema","url":"/reference/totalfinance/core/schema#OptionTradeSchema","description":"value from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _check(inpu"},{"title":"OptionalSchema","url":"/reference/totalfinance/core/schema#OptionalSchema","description":"class from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"class","keywords":"@insiderfinance/totalfinance/core/schema class  (inner) (inner)._check (inner)._toJSONSchema (inner).describe (inner).description (inner).isOptional (inner).kind (inner).optional (inner).p"},{"title":"OrderBookLevelSchema","url":"/reference/totalfinance/core/schema#OrderBookLevelSchema","description":"value from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _check(inpu"},{"title":"OrderBookSchema","url":"/reference/totalfinance/core/schema/page-2#OrderBookSchema","description":"value from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _check(inpu"},{"title":"ParseOptions","url":"/reference/totalfinance/core/schema/page-2#ParseOptions","description":"interface from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"interface","keywords":"@insiderfinance/totalfinance/core/schema interface  mode"},{"title":"QuoteSchema","url":"/reference/totalfinance/core/schema/page-2#QuoteSchema","description":"value from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _check(inpu"},{"title":"RateCurvePointSchema","url":"/reference/totalfinance/core/schema/page-2#RateCurvePointSchema","description":"OPEN (2026-08-23, fourth external review): `RateCurvePoint` entries are documented \"open to\nvendor decoration (Law 12)\" and the runtime curve validator accepts ","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _check(inpu"},{"title":"RateCurveSchema","url":"/reference/totalfinance/core/schema/page-2#RateCurveSchema","description":"value from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"RawFundamentalsRecordSchema","url":"/reference/totalfinance/core/schema/page-2#RawFundamentalsRecordSchema","description":"value from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _check(inpu"},{"title":"RecordSchema","url":"/reference/totalfinance/core/schema/page-2#RecordSchema","description":"An object with arbitrary string keys whose values all satisfy `value` (e.g. `Fundamentals.fields`).","category":"@insiderfinance/totalfinance/core/schema","kind":"class","keywords":"@insiderfinance/totalfinance/core/schema class  (value) (value)._check (value)._toJSONSchema (value).describe (value).description (value).isOptional (value).kind (value).optional (value).p"},{"title":"SafeParseResult","url":"/reference/totalfinance/core/schema/page-2#SafeParseResult","description":"type from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"type","keywords":"@insiderfinance/totalfinance/core/schema type  data error error.code error.context error.toJSON error.toJSON().return.code error.toJSON().return.context error.toJSON().return.message erro"},{"title":"Schema","url":"/reference/totalfinance/core/schema/page-2#Schema","description":"Public schema interface. Concrete builder implementations stay internal.","category":"@insiderfinance/totalfinance/core/schema","kind":"interface","keywords":"@insiderfinance/totalfinance/core/schema interface  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"SchemaIssue","url":"/reference/totalfinance/core/schema/page-2#SchemaIssue","description":"interface from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"interface","keywords":"@insiderfinance/totalfinance/core/schema interface  code message path"},{"title":"StandardSchemaV1","url":"/reference/totalfinance/core/schema/page-2#StandardSchemaV1","description":"The Standard Schema v1 interface (https://standardschema.dev).\n\nTotalFinance schemas implement this so users can plug them into any Standard-Schema-aware tool\n(","category":"@insiderfinance/totalfinance/core/schema","kind":"interface","keywords":"@insiderfinance/totalfinance/core/schema interface  ~standard ~standard.types ~standard.types.input ~standard.types.output ~standard.validate ~standard.validate().return.issues ~standard.valid"},{"title":"StandardSchemaV1Issue","url":"/reference/totalfinance/core/schema/page-2#StandardSchemaV1Issue","description":"interface from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"interface","keywords":"@insiderfinance/totalfinance/core/schema interface  message path"},{"title":"StandardSchemaV1Props","url":"/reference/totalfinance/core/schema/page-2#StandardSchemaV1Props","description":"interface from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"interface","keywords":"@insiderfinance/totalfinance/core/schema interface  types types.input types.output validate validate().return.issues validate().return.value validate(value) vendor version"},{"title":"StandardSchemaV1Result","url":"/reference/totalfinance/core/schema/page-2#StandardSchemaV1Result","description":"type from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"type","keywords":"@insiderfinance/totalfinance/core/schema type  issues value"},{"title":"StringConstraints","url":"/reference/totalfinance/core/schema/page-2#StringConstraints","description":"interface from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"interface","keywords":"@insiderfinance/totalfinance/core/schema interface  format maxLength minLength pattern"},{"title":"StringSchema","url":"/reference/totalfinance/core/schema/page-2#StringSchema","description":"class from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"class","keywords":"@insiderfinance/totalfinance/core/schema class  (constraints) (constraints).format (constraints).maxLength (constraints).minLength (constraints).pattern _check _check().return.issues _chec"},{"title":"TradeSchema","url":"/reference/totalfinance/core/schema/page-2#TradeSchema","description":"value from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _check(inpu"},{"title":"UnionSchema","url":"/reference/totalfinance/core/schema/page-2#UnionSchema","description":"class from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"class","keywords":"@insiderfinance/totalfinance/core/schema class  (members) _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _"},{"title":"UnknownSchema","url":"/reference/totalfinance/core/schema/page-2#UnknownSchema","description":"Accepts any value unchanged. For genuinely open payloads (e.g. `Record<string, unknown>` maps).","category":"@insiderfinance/totalfinance/core/schema","kind":"class","keywords":"@insiderfinance/totalfinance/core/schema class  _check _check().return.issues _check().return.ok _check().return.value _check(input) _toJSONSchema _toJSONSchema().return.$id _toJSONSchema("},{"title":"ValidationMode","url":"/reference/totalfinance/core/schema/page-3#ValidationMode","description":"type from @insiderfinance/totalfinance/core/schema","category":"@insiderfinance/totalfinance/core/schema","kind":"type","keywords":"@insiderfinance/totalfinance/core/schema type  "},{"title":"__TOTALFINANCE_SCHEMA_FACADE__","url":"/reference/totalfinance/core/schema/page-3#__TOTALFINANCE_SCHEMA_FACADE__","description":"Marker so the bundle harness can prove this module never leaks into a compute entrypoint.","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  "},{"title":"coreSchemas","url":"/reference/totalfinance/core/schema/page-3#coreSchemas","description":"Convenience namespace of the core payload schemas. Covers every exported market-data object type,\nso the schema/interface drift test (`schema-parity.test.ts`) c","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  Bar Bar._check Bar._check().return.issues Bar._check().return.ok Bar._check().return.value Bar._check(context) Bar._check(context).mode Bar."},{"title":"requireJSONSchema","url":"/reference/totalfinance/core/schema/page-3#requireJSONSchema","description":"Assert that `value` is a well-formed JSON Schema document; throws a typed `InputError` naming the\noffending path (`<field>.properties.<name>.type`, …) otherwise","category":"@insiderfinance/totalfinance/core/schema","kind":"function","keywords":"@insiderfinance/totalfinance/core/schema function functionName - The public function reporting the refusal (core's own guard order). field - The argum (field) (functionName) (value)"},{"title":"schema","url":"/reference/totalfinance/core/schema/page-3#schema","description":"The schema builder. Returns typed schemas with `parse`/`safeParse`/`toJSONSchema`.","category":"@insiderfinance/totalfinance/core/schema","kind":"value","keywords":"@insiderfinance/totalfinance/core/schema value  array array().return._check array().return._toJSONSchema array().return.describe array().return.description array().return.isOptional array("},{"title":"validate","url":"/reference/totalfinance/core/schema/page-3#validate","description":"Validate `input` against `schema`, returning a typed `SafeParseResult`.","category":"@insiderfinance/totalfinance/core/schema","kind":"function","keywords":"@insiderfinance/totalfinance/core/schema function  (input) (options) (options).mode (schema) (schema).describe (schema).isOptional (schema).kind (schema).optional (schema).parse (schema).safe"},{"title":"BasisStructure","url":"/reference/totalfinance/crypto#BasisStructure","description":"Whether a dated future trades above (contango) or below (backwardation) spot.","category":"@insiderfinance/totalfinance/crypto","kind":"type","keywords":"@insiderfinance/totalfinance/crypto type   @insiderfinance/totalfinance/crypto/carry"},{"title":"CarryCurve","url":"/reference/totalfinance/crypto#CarryCurve","description":"The futures carry term structure.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  forwards interpolated points shape spot @insiderfinance/totalfinance/crypto/curve"},{"title":"CarryCurveFuture","url":"/reference/totalfinance/crypto#CarryCurveFuture","description":"A single dated future on the underlying.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  price timeToExpiryYears @insiderfinance/totalfinance/crypto/curve"},{"title":"CarryCurveInput","url":"/reference/totalfinance/crypto#CarryCurveInput","description":"Input for {@link carryCurve}.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  coinYield financingRate flatTolerance futures queryTenors spot @insiderfinance/totalfinance/crypto/curve"},{"title":"CarryCurvePoint","url":"/reference/totalfinance/crypto#CarryCurvePoint","description":"A carry-curve point (one expiry).","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  annualizedCarry price richness structure timeToExpiryYears @insiderfinance/totalfinance/crypto/curve"},{"title":"CarryCurveShape","url":"/reference/totalfinance/crypto#CarryCurveShape","description":"The overall term-structure shape (from the forward-carry sequence).","category":"@insiderfinance/totalfinance/crypto","kind":"type","keywords":"@insiderfinance/totalfinance/crypto type   @insiderfinance/totalfinance/crypto/curve"},{"title":"CarryForward","url":"/reference/totalfinance/crypto#CarryForward","description":"The market's marginal carry over a window between two expiries (the first is `spot → F₁`).","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  forwardCarry fromTenorYears toTenorYears @insiderfinance/totalfinance/crypto/curve"},{"title":"CarryInterp","url":"/reference/totalfinance/crypto#CarryInterp","description":"An interpolated carry point.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  annualizedCarry impliedForward timeToExpiryYears @insiderfinance/totalfinance/crypto/curve"},{"title":"CarrySignal","url":"/reference/totalfinance/crypto#CarrySignal","description":"Which instrument prices richer carry.","category":"@insiderfinance/totalfinance/crypto","kind":"type","keywords":"@insiderfinance/totalfinance/crypto type   @insiderfinance/totalfinance/crypto/carry"},{"title":"FundingBasisSpread","url":"/reference/totalfinance/crypto#FundingBasisSpread","description":"The perp-vs-future carry spread and its signal.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  basisImpliedCarry fundingImpliedCarry signal spread @insiderfinance/totalfinance/crypto/carry"},{"title":"FundingBasisSpreadInput","url":"/reference/totalfinance/crypto#FundingBasisSpreadInput","description":"Input for {@link fundingBasisSpread}.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  fundingRate future intervalHours spot timeToExpiryYears tolerance @insiderfinance/totalfinance/crypto/carry"},{"title":"FuturesBasis","url":"/reference/totalfinance/crypto#FuturesBasis","description":"A dated future's basis and (when financing is given) its cash-and-carry edge.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  annualizedLog annualizedSimple basis basisFraction carryArbitrage fairFuture richness structure @insiderfinance/totalfinance/crypto/carry"},{"title":"FuturesBasisInput","url":"/reference/totalfinance/crypto#FuturesBasisInput","description":"Input for {@link futuresBasis}.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  arbitrageThreshold coinYield financingRate future spot timeToExpiryYears @insiderfinance/totalfinance/crypto/carry"},{"title":"InverseFuture","url":"/reference/totalfinance/crypto#InverseFuture","description":"The coin economics of an inverse-margined futures/perp position.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  coinDelta coinExposure coinGamma coinPnl usdPnl @insiderfinance/totalfinance/crypto/inverse"},{"title":"InverseFutureInput","url":"/reference/totalfinance/crypto#InverseFutureInput","description":"Input for {@link inverseFuture}.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  entryPrice markPrice notionalUsd side @insiderfinance/totalfinance/crypto/inverse"},{"title":"InverseHedge","url":"/reference/totalfinance/crypto#InverseHedge","description":"The inverse future/perp trade that neutralizes a coin delta.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  hedgeCoinDelta notionalUsd residualCoinGamma side @insiderfinance/totalfinance/crypto/inverse"},{"title":"InverseHedgeInput","url":"/reference/totalfinance/crypto#InverseHedgeInput","description":"Input for {@link inverseHedge}.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  coinDelta coinGamma markPrice @insiderfinance/totalfinance/crypto/inverse"},{"title":"InverseSide","url":"/reference/totalfinance/crypto#InverseSide","description":"Position side of an inverse contract.","category":"@insiderfinance/totalfinance/crypto","kind":"type","keywords":"@insiderfinance/totalfinance/crypto type   @insiderfinance/totalfinance/crypto/inverse"},{"title":"Liquidation","url":"/reference/totalfinance/crypto#Liquidation","description":"Isolated-margin liquidation economics of a leveraged perp/future position.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  bankruptcyPrice distanceToLiquidation initialMarginRate liquidationPrice @insiderfinance/totalfinance/crypto/liquidation"},{"title":"LiquidationAssumptions","url":"/reference/totalfinance/crypto#LiquidationAssumptions","description":"The convention fields {@link liquidationPrice} echoes in `assumptions` (Law 2).","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  maintenanceMarginRate margin marginBasis side @insiderfinance/totalfinance/crypto/liquidation"},{"title":"LiquidationInput","url":"/reference/totalfinance/crypto/page-2#LiquidationInput","description":"Input for {@link liquidationPrice}.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  entryPrice leverage maintenanceMarginRate margin side @insiderfinance/totalfinance/crypto/liquidation"},{"title":"MarginMode","url":"/reference/totalfinance/crypto/page-2#MarginMode","description":"Margin mode: `inverse` = coin-margined (Deribit/BitMEX), `linear` = USDT-margined.","category":"@insiderfinance/totalfinance/crypto","kind":"type","keywords":"@insiderfinance/totalfinance/crypto type   @insiderfinance/totalfinance/crypto/liquidation"},{"title":"OptionsBasisSpread","url":"/reference/totalfinance/crypto/page-2#OptionsBasisSpread","description":"The options-implied (put-call-parity) synthetic forward reconciled against the dated future.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  basisImpliedCarry optionsImpliedCarry optionsImpliedForward signal spread @insiderfinance/totalfinance/crypto/carry"},{"title":"OptionsBasisSpreadInput","url":"/reference/totalfinance/crypto/page-2#OptionsBasisSpreadInput","description":"Input for {@link optionsBasisSpread}.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  call future put riskFreeRate spot strike timeToExpiryYears tolerance @insiderfinance/totalfinance/crypto/carry"},{"title":"OptionsCarrySignal","url":"/reference/totalfinance/crypto/page-2#OptionsCarrySignal","description":"Which market prices the richer forward: the dated future, the options-implied synthetic, or neither.","category":"@insiderfinance/totalfinance/crypto","kind":"type","keywords":"@insiderfinance/totalfinance/crypto type   @insiderfinance/totalfinance/crypto/carry"},{"title":"PerpetualFunding","url":"/reference/totalfinance/crypto/page-2#PerpetualFunding","description":"The annualized carry a funding rate implies.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  annualizedCompounded annualizedSimple fundingRate intervalHours longCarry periodsPerYear premium shortCarry @insiderfinance/totalfinance/crypto/carry"},{"title":"PerpetualFundingInput","url":"/reference/totalfinance/crypto/page-2#PerpetualFundingInput","description":"Input for {@link perpetualFunding}.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  extremeAnnualized fundingRate indexPrice intervalHours markPrice @insiderfinance/totalfinance/crypto/carry"},{"title":"PredictedFunding","url":"/reference/totalfinance/crypto/page-2#PredictedFunding","description":"The venue-formula next-interval funding.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  capped clamp fundingRate interestRate premium @insiderfinance/totalfinance/crypto/carry"},{"title":"PredictedFundingInput","url":"/reference/totalfinance/crypto/page-2#PredictedFundingInput","description":"Input for {@link predictedFunding}.","category":"@insiderfinance/totalfinance/crypto","kind":"interface","keywords":"@insiderfinance/totalfinance/crypto interface  cap clamp interestRate premium @insiderfinance/totalfinance/crypto/carry"},{"title":"carryCurve","url":"/reference/totalfinance/crypto/page-2#carryCurve","description":"function from @insiderfinance/totalfinance/crypto","category":"@insiderfinance/totalfinance/crypto","kind":"function","keywords":"@insiderfinance/totalfinance/crypto function  (input) (input).coinYield (input).financingRate (input).flatTolerance (input).futures (input).queryTenors (input).spot return.assumptions re @insiderfinance/totalfinance/crypto/curve"},{"title":"fundingBasisSpread","url":"/reference/totalfinance/crypto/page-2#fundingBasisSpread","description":"function from @insiderfinance/totalfinance/crypto","category":"@insiderfinance/totalfinance/crypto","kind":"function","keywords":"@insiderfinance/totalfinance/crypto function  (input) (input).fundingRate (input).future (input).intervalHours (input).spot (input).timeToExpiryYears (input).tolerance return.assumptions @insiderfinance/totalfinance/crypto/carry"},{"title":"futuresBasis","url":"/reference/totalfinance/crypto/page-2#futuresBasis","description":"function from @insiderfinance/totalfinance/crypto","category":"@insiderfinance/totalfinance/crypto","kind":"function","keywords":"@insiderfinance/totalfinance/crypto function  (input) (input).arbitrageThreshold (input).coinYield (input).financingRate (input).future (input).spot (input).timeToExpiryYears return.assu @insiderfinance/totalfinance/crypto/carry"},{"title":"inverseFuture","url":"/reference/totalfinance/crypto/page-2#inverseFuture","description":"function from @insiderfinance/totalfinance/crypto","category":"@insiderfinance/totalfinance/crypto","kind":"function","keywords":"@insiderfinance/totalfinance/crypto function  (input) (input).entryPrice (input).markPrice (input).notionalUsd (input).side return.assumptions return.diagnostics return.provenance return @insiderfinance/totalfinance/crypto/inverse"},{"title":"inverseHedge","url":"/reference/totalfinance/crypto/page-2#inverseHedge","description":"function from @insiderfinance/totalfinance/crypto","category":"@insiderfinance/totalfinance/crypto","kind":"function","keywords":"@insiderfinance/totalfinance/crypto function  (input) (input).coinDelta (input).coinGamma (input).markPrice return.assumptions return.diagnostics return.provenance return.value @insiderfinance/totalfinance/crypto/inverse"},{"title":"liquidationPrice","url":"/reference/totalfinance/crypto/page-2#liquidationPrice","description":"Isolated-margin liquidation & bankruptcy price of a leveraged perpetual/future position (inverse or\nlinear). Size-independent: depends only on entry price, leve","category":"@insiderfinance/totalfinance/crypto","kind":"function","keywords":"@insiderfinance/totalfinance/crypto function  (input) (input).entryPrice (input).leverage (input).maintenanceMarginRate (input).margin (input).side return.assumptions return.diagnostics  @insiderfinance/totalfinance/crypto/liquidation"},{"title":"optionsBasisSpread","url":"/reference/totalfinance/crypto/page-2#optionsBasisSpread","description":"function from @insiderfinance/totalfinance/crypto","category":"@insiderfinance/totalfinance/crypto","kind":"function","keywords":"@insiderfinance/totalfinance/crypto function  (input) (input).call (input).future (input).put (input).riskFreeRate (input).spot (input).strike (input).timeToExpiryYears (input).tolerance @insiderfinance/totalfinance/crypto/carry"},{"title":"perpetualFunding","url":"/reference/totalfinance/crypto/page-2#perpetualFunding","description":"Annualize a perpetual funding rate into its implied cost-of-carry, in both simple and compounded terms,\nwith the long/short carry sign made explicit. See `docs/","category":"@insiderfinance/totalfinance/crypto","kind":"function","keywords":"@insiderfinance/totalfinance/crypto function  (input) (input).extremeAnnualized (input).fundingRate (input).indexPrice (input).intervalHours (input).markPrice return.assumptions return.d @insiderfinance/totalfinance/crypto/carry"},{"title":"predictedFunding","url":"/reference/totalfinance/crypto/page-2#predictedFunding","description":"function from @insiderfinance/totalfinance/crypto","category":"@insiderfinance/totalfinance/crypto","kind":"function","keywords":"@insiderfinance/totalfinance/crypto function  (input) (input).cap (input).clamp (input).interestRate (input).premium return.assumptions return.diagnostics return.provenance return.value @insiderfinance/totalfinance/crypto/carry"},{"title":"Amortization","url":"/reference/totalfinance/fixed-income#Amortization","description":"Amortization style for an amortizing bond.","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type  principalByPeriod type @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"AmortizingBondSpecification","url":"/reference/totalfinance/fixed-income#AmortizingBondSpecification","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  amortization amortization.principalByPeriod amortization.type convention couponRate dayCount endOfMonth faceValue frequency issueDate maturi @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"BaseSpecification","url":"/reference/totalfinance/fixed-income#BaseSpecification","description":"The fields every bond specification shares — the base the per-kind specifications extend.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  convention couponRate dayCount endOfMonth faceValue frequency issueDate maturityDate @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"BermudanSwaptionResult","url":"/reference/totalfinance/fixed-income#BermudanSwaptionResult","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion assumptions.dayCount assumptions.fixedDayCount assumptions.fixedFrequency assumptions.meanReversi @insiderfinance/totalfinance/fixed-income/lattice"},{"title":"BermudanSwaptionSpecification","url":"/reference/totalfinance/fixed-income#BermudanSwaptionSpecification","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  curve curve.addSpread curve.addSpread(spread) curve.bumpPillar curve.bumpPillar(delta) curve.bumpPillar(index) curve.dayCount curve.discount @insiderfinance/totalfinance/fixed-income/lattice"},{"title":"Bond","url":"/reference/totalfinance/fixed-income#Bond","description":"A constructed bond: schedule, cash flows, and settlement-relative helpers.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  accrued accrued(context) accrued(context).forecastCurve accrued(context).knownFixingRate accrued(context).referenceIndex accrued(settlementD @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"BondAssumptions","url":"/reference/totalfinance/fixed-income#BondAssumptions","description":"Conventions echoed on every bond pricing/metrics result (spec §7.4 / WS2.2). Bonds discount either\nactuarially (`(1 + y/f)^(−f·τ)`) or off a curve, so `compound","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type  asOf businessDayConvention calendar calendarVersion compounding conventionsVersion dayCount dividendModel engine expiryConvention frequency  @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"BondComputed","url":"/reference/totalfinance/fixed-income#BondComputed","description":"The {@link Computed} envelope specialised to bond results (dx §2.7): `assumptions` is the widened\n{@link BondAssumptions} — fixed income needs the `ACT/ACT`/`30","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.asOf assumptions.businessDayConvention assumptions.calendar assumptions.calendarVersion assumptions.compounding assu @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"BondFacade","url":"/reference/totalfinance/fixed-income#BondFacade","description":"A bond facade: the plain call plus an `.explain()` companion returning {@link BondComputed}.","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.value explain(callArguments) @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"BondFutureCtdFrontierInput","url":"/reference/totalfinance/fixed-income#BondFutureCtdFrontierInput","description":"Input for {@link bondFutureCtdFrontier} — a {@link BondFutureInput} basket plus the scan controls.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  deliverables deliveryDate futuresPrice futuresPrices notionalCoupon refineSwitches repoRate settlementDate switchLocationToleranceBp yieldSh @insiderfinance/totalfinance/fixed-income/futures"},{"title":"BondFutureCtdFrontierResult","url":"/reference/totalfinance/fixed-income#BondFutureCtdFrontierResult","description":"The bond-future CTD switching-frontier analysis.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion assumptions.deliveryDate assumptions.futuresPriceScenario assumptions.refineSwitches assumptions. @insiderfinance/totalfinance/fixed-income/futures"},{"title":"BondFutureHedgeInput","url":"/reference/totalfinance/fixed-income#BondFutureHedgeInput","description":"Input for {@link bondFutureHedge} — the basket plus an optional position to hedge.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  deliverables deliveryDate futuresPrice hedgeDv01 notionalCoupon repoRate settlementDate @insiderfinance/totalfinance/fixed-income/futures"},{"title":"BondFutureHedgeResult","url":"/reference/totalfinance/fixed-income#BondFutureHedgeResult","description":"The bond-future hedge analysis.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion assumptions.deliveryDate assumptions.futuresPrice assumptions.settlementDate ctdConversionFactor  @insiderfinance/totalfinance/fixed-income/futures"},{"title":"BondFutureInput","url":"/reference/totalfinance/fixed-income#BondFutureInput","description":"Input for {@link bondFuture}.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  deliverables deliveryDate futuresPrice notionalCoupon repoRate settlementDate @insiderfinance/totalfinance/fixed-income/futures"},{"title":"BondFutureResult","url":"/reference/totalfinance/fixed-income#BondFutureResult","description":"The bond-future basket analysis.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion assumptions.deliveryDate assumptions.futuresPrice assumptions.notionalCoupon assumptions.repoRate @insiderfinance/totalfinance/fixed-income/futures"},{"title":"BondKind","url":"/reference/totalfinance/fixed-income#BondKind","description":"type from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type   @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"BondOption","url":"/reference/totalfinance/fixed-income#BondOption","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  date price @insiderfinance/totalfinance/fixed-income/lattice"},{"title":"BondPrice","url":"/reference/totalfinance/fixed-income#BondPrice","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  accruedInterest assumptions assumptions.asOf assumptions.businessDayConvention assumptions.calendar assumptions.calendarVersion assumptions. @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"BootstrapInstrument","url":"/reference/totalfinance/fixed-income#BootstrapInstrument","description":"type from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type  convexityAdjustment dayCount end fixedDayCount fixedFrequency floatDayCount floatFrequency maturity price rate start type @insiderfinance/totalfinance/fixed-income/curves"},{"title":"BootstrapOptions","url":"/reference/totalfinance/fixed-income#BootstrapOptions","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  dayCount extrapolation interpolation referenceDate @insiderfinance/totalfinance/fixed-income/curves"},{"title":"BreakevenInflationInput","url":"/reference/totalfinance/fixed-income/page-2#BreakevenInflationInput","description":"Input for {@link breakevenInflation}.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  inflationRiskPremium liquidityPremium nominalYield realYield @insiderfinance/totalfinance/fixed-income/inflation"},{"title":"BreakevenInflationResult","url":"/reference/totalfinance/fixed-income/page-2#BreakevenInflationResult","description":"The breakeven inflation rate and its decomposition.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion assumptions.method breakeven breakevenCompounded diagnostics diagnostics.autoReason diagnostics.c @insiderfinance/totalfinance/fixed-income/inflation"},{"title":"BusinessDayConvention","url":"/reference/totalfinance/fixed-income/page-2#BusinessDayConvention","description":"Business-day roll conventions (spec §14).","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type   @insiderfinance/totalfinance/fixed-income/conventions"},{"title":"CallFeature","url":"/reference/totalfinance/fixed-income/page-2#CallFeature","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  callDate callPrice @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"CallableBondResult","url":"/reference/totalfinance/fixed-income/page-2#CallableBondResult","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion assumptions.dayCount assumptions.meanReversion assumptions.model assumptions.settlementDate assum @insiderfinance/totalfinance/fixed-income/lattice"},{"title":"CallableBondSpecification","url":"/reference/totalfinance/fixed-income/page-2#CallableBondSpecification","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  bond bond.accrued bond.accrued(context) bond.accrued(context).forecastCurve bond.accrued(context).knownFixingRate bond.accrued(context).refe @insiderfinance/totalfinance/fixed-income/lattice"},{"title":"CapFloorResult","url":"/reference/totalfinance/fixed-income/page-2#CapFloorResult","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion caplets diagnostics diagnostics.warnings price @insiderfinance/totalfinance/fixed-income/rates"},{"title":"CapFloorSpecification","url":"/reference/totalfinance/fixed-income/page-2#CapFloorSpecification","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  dayCount frequency maturityDate model notional startDate strike type volatility @insiderfinance/totalfinance/fixed-income/rates"},{"title":"CapletResult","url":"/reference/totalfinance/fixed-income/page-2#CapletResult","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  end expiry forwardRate start value @insiderfinance/totalfinance/fixed-income/rates"},{"title":"CashFlow","url":"/reference/totalfinance/fixed-income/page-2#CashFlow","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  amount date interest notional paymentDate principal @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"CdsCurves","url":"/reference/totalfinance/fixed-income/page-2#CdsCurves","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  discountCurve discountCurve.addSpread discountCurve.addSpread(spread) discountCurve.bumpPillar discountCurve.bumpPillar(delta) discountCurve @insiderfinance/totalfinance/fixed-income/credit"},{"title":"CdsQuote","url":"/reference/totalfinance/fixed-income/page-2#CdsQuote","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  maturity spread @insiderfinance/totalfinance/fixed-income/credit"},{"title":"CdsSpecification","url":"/reference/totalfinance/fixed-income/page-2#CdsSpecification","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  accrualOnDefault dayCount effectiveDate frequency maturityDate notional protectionSteps recovery spread @insiderfinance/totalfinance/fixed-income/credit"},{"title":"CdsValuation","url":"/reference/totalfinance/fixed-income/page-2#CdsValuation","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion diagnostics diagnostics.warnings parSpread premiumLeg protectionLeg riskyAnnuity upfront value @insiderfinance/totalfinance/fixed-income/credit"},{"title":"CirModel","url":"/reference/totalfinance/fixed-income/page-2#CirModel","description":"A CIR model plus the honest disclosure of whether its parameters keep the short rate strictly\npositive. Structurally a {@link ShortRateModel}, so existing consu","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  diagnostics diagnostics.warnings discountBond discountBond(shortRate) discountBond(tau) shortRateMoments shortRateMoments().return.mean shor @insiderfinance/totalfinance/fixed-income/models"},{"title":"CirParameters","url":"/reference/totalfinance/fixed-income/page-2#CirParameters","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  a b r0 sigma @insiderfinance/totalfinance/fixed-income/models"},{"title":"CmsConvexityInput","url":"/reference/totalfinance/fixed-income/page-2#CmsConvexityInput","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  expiry forwardSwapRate paymentsPerYear swapTenorYears volatility @insiderfinance/totalfinance/fixed-income/rates"},{"title":"CmsConvexityResult","url":"/reference/totalfinance/fixed-income/page-2#CmsConvexityResult","description":"The convexity-adjustment envelope: the adjustment plus what produced it (Law 2).","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion diagnostics diagnostics.warnings value @insiderfinance/totalfinance/fixed-income/rates"},{"title":"CmsResult","url":"/reference/totalfinance/fixed-income/page-2#CmsResult","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion cmsRate convexityAdjustment diagnostics diagnostics.warnings forwardSwapRate @insiderfinance/totalfinance/fixed-income/rates"},{"title":"CmsSpecification","url":"/reference/totalfinance/fixed-income/page-2#CmsSpecification","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  fixedDayCount fixedFrequency floatDayCount floatFrequency resetDate swapTenorYears volatility @insiderfinance/totalfinance/fixed-income/rates"},{"title":"ConversionFactorInput","url":"/reference/totalfinance/fixed-income/page-3#ConversionFactorInput","description":"Input for {@link conversionFactor}.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  bond bond.accrued bond.accrued(context) bond.accrued(context).forecastCurve bond.accrued(context).knownFixingRate bond.accrued(context).refe @insiderfinance/totalfinance/fixed-income/futures"},{"title":"ConversionFactorResult","url":"/reference/totalfinance/fixed-income/page-3#ConversionFactorResult","description":"The conversion factor plus the rounding breakdown that produced it.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion assumptions.couponFrequency diagnostics diagnostics.autoReason diagnostics.converged diagnostics. @insiderfinance/totalfinance/fixed-income/futures"},{"title":"ConvertibleBondOption","url":"/reference/totalfinance/fixed-income/page-3#ConvertibleBondOption","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  date price @insiderfinance/totalfinance/fixed-income/convertible"},{"title":"ConvertibleBondResult","url":"/reference/totalfinance/fixed-income/page-3#ConvertibleBondResult","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion assumptions.creditModel assumptions.model assumptions.recovery assumptions.stepsPerYear bondFloor @insiderfinance/totalfinance/fixed-income/convertible"},{"title":"ConvertibleBondSpecification","url":"/reference/totalfinance/fixed-income/page-3#ConvertibleBondSpecification","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  calls conversionRatio couponRate dayCount dividendYield faceValue frequency hazardRate issueDate maturityDate puts recovery riskFreeRate set @insiderfinance/totalfinance/fixed-income/convertible"},{"title":"CpiSeasonalityInput","url":"/reference/totalfinance/fixed-income/page-3#CpiSeasonalityInput","description":"Input for {@link cpiSeasonality}.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  series @insiderfinance/totalfinance/fixed-income/inflation"},{"title":"CpiSeasonalityResult","url":"/reference/totalfinance/fixed-income/page-3#CpiSeasonalityResult","description":"The extracted monthly seasonal factors.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion assumptions.method diagnostics diagnostics.autoReason diagnostics.converged diagnostics.decomposi @insiderfinance/totalfinance/fixed-income/inflation"},{"title":"CreditSpreadCurveAssumptions","url":"/reference/totalfinance/fixed-income/page-3#CreditSpreadCurveAssumptions","description":"The conventions `creditSpreadCurve.explain` echoes (H03) — every knob the per-tenor CDS runs on.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  accrualOnDefault conventionsVersion dayCount frequency protectionSteps recovery referenceDate @insiderfinance/totalfinance/fixed-income/credit"},{"title":"CreditSpreadCurveFacade","url":"/reference/totalfinance/fixed-income/page-3#CreditSpreadCurveFacade","description":"type from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type  (options) (options).accrualOnDefault (options).dayCount (options).discountCurve (options).frequency (options).protectionSteps (options).reco @insiderfinance/totalfinance/fixed-income/credit"},{"title":"CreditSpreadPoint","url":"/reference/totalfinance/fixed-income/page-3#CreditSpreadPoint","description":"One tenor of a {@link creditSpreadCurve}: the maturity and its par (breakeven) CDS spread.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  maturity parSpread @insiderfinance/totalfinance/fixed-income/credit"},{"title":"CreditTriangleHazardResult","url":"/reference/totalfinance/fixed-income/page-3#CreditTriangleHazardResult","description":"The credit-triangle envelope: the implied hazard plus the recovery it assumed (Law 2).","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.approximation assumptions.conventionsVersion assumptions.recovery diagnostics diagnostics.warnings value @insiderfinance/totalfinance/fixed-income/credit"},{"title":"CrossCurrencyBasisInput","url":"/reference/totalfinance/fixed-income/page-3#CrossCurrencyBasisInput","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  basis basis.addSpread basis.addSpread(spread) basis.bumpPillar basis.bumpPillar(delta) basis.bumpPillar(index) basis.dayCount basis.discount @insiderfinance/totalfinance/fixed-income/cross-currency"},{"title":"CrossCurrencyBasisResult","url":"/reference/totalfinance/fixed-income/page-3#CrossCurrencyBasisResult","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion collateralizedCurve collateralizedCurve.addSpread collateralizedCurve.addSpread(spread) collatera @insiderfinance/totalfinance/fixed-income/cross-currency"},{"title":"CtdFrontierScenario","url":"/reference/totalfinance/fixed-income/page-3#CtdFrontierScenario","description":"One node of the CTD frontier scan: the whole basket, repriced at a parallel shift + a futures price.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  ctdId deliverables futuresPrice impliedRepoRate netBasis yieldShiftBp @insiderfinance/totalfinance/fixed-income/futures"},{"title":"CtdSwitch","url":"/reference/totalfinance/fixed-income/page-3#CtdSwitch","description":"A cheapest-to-deliver switch between two frontier nodes.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  bracketBp estimatedSwitchBp fromCtd method toCtd @insiderfinance/totalfinance/fixed-income/futures"},{"title":"CurveExtrapolation","url":"/reference/totalfinance/fixed-income/page-3#CurveExtrapolation","description":"What to do outside the pillar range.","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type   @insiderfinance/totalfinance/fixed-income/curves"},{"title":"CurveInterpolation","url":"/reference/totalfinance/fixed-income/page-3#CurveInterpolation","description":"Interpolation policy across pillars.","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type   @insiderfinance/totalfinance/fixed-income/curves"},{"title":"CurveMetrics","url":"/reference/totalfinance/fixed-income/page-3#CurveMetrics","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  accruedInterest assumptions assumptions.asOf assumptions.businessDayConvention assumptions.calendar assumptions.calendarVersion assumptions. @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"CurveOptions","url":"/reference/totalfinance/fixed-income/page-3#CurveOptions","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  compounding compounding.periodsPerYear compounding.type dayCount extrapolation interpolation referenceDate @insiderfinance/totalfinance/fixed-income/curves"},{"title":"CurvePillar","url":"/reference/totalfinance/fixed-income/page-3#CurvePillar","description":"A resolved pillar: its date, year fraction from the reference date, continuous zero, and discount.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  date discount tenorYears zero @insiderfinance/totalfinance/fixed-income/curves"},{"title":"CurvePricingOptions","url":"/reference/totalfinance/fixed-income/page-4#CurvePricingOptions","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  bump context context.forecastCurve context.forecastCurve.addSpread context.forecastCurve.addSpread(spread) context.forecastCurve.bumpPillar  @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"DeliverableAnalysis","url":"/reference/totalfinance/fixed-income/page-4#DeliverableAnalysis","description":"The full basis analysis for one deliverable.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  accruedAtDelivery accruedAtSettlement carry cleanPrice conversionFactor conversionFactorSource grossBasis id impliedRepoRate interimCoupons  @insiderfinance/totalfinance/fixed-income/futures"},{"title":"DeliverableBond","url":"/reference/totalfinance/fixed-income/page-4#DeliverableBond","description":"One deliverable in the futures basket.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  bond bond.accrued bond.accrued(context) bond.accrued(context).forecastCurve bond.accrued(context).knownFixingRate bond.accrued(context).refe @insiderfinance/totalfinance/fixed-income/futures"},{"title":"DeliverableRisk","url":"/reference/totalfinance/fixed-income/page-4#DeliverableRisk","description":"Per-deliverable interest-rate risk.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  conversionFactor dv01 futuresDv01ViaBond id yield @insiderfinance/totalfinance/fixed-income/futures"},{"title":"DepositInstrument","url":"/reference/totalfinance/fixed-income/page-4#DepositInstrument","description":"A money-market deposit: simple rate accruing to `maturity`.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  dayCount maturity rate type @insiderfinance/totalfinance/fixed-income/curves"},{"title":"ExposurePoint","url":"/reference/totalfinance/fixed-income/page-4#ExposurePoint","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  ene epe pfe95 tenorYears @insiderfinance/totalfinance/fixed-income/xva"},{"title":"FixedIncomeDayCount","url":"/reference/totalfinance/fixed-income/page-4#FixedIncomeDayCount","description":"Day-count conventions supported by the fixed-income surface — the three from `@insiderfinance/totalfinance/core` plus\n`ACT/ACT` (ISDA, calendar-year split) and ","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type   @insiderfinance/totalfinance/fixed-income/conventions"},{"title":"FixedRateBondSpecification","url":"/reference/totalfinance/fixed-income/page-4#FixedRateBondSpecification","description":"type from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type  convention couponRate dayCount endOfMonth faceValue frequency issueDate maturityDate @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"FloatingRateNoteSpecification","url":"/reference/totalfinance/fixed-income/page-4#FloatingRateNoteSpecification","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  convention couponRate dayCount endOfMonth faceValue frequency issueDate maturityDate spread @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"ForwardSwapResult","url":"/reference/totalfinance/fixed-income/page-4#ForwardSwapResult","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  annuity assumptions assumptions.conventionsVersion diagnostics diagnostics.warnings forwardSwapRate pv01 @insiderfinance/totalfinance/fixed-income/rates"},{"title":"ForwardSwapSpecification","url":"/reference/totalfinance/fixed-income/page-4#ForwardSwapSpecification","description":"A forward-starting swap; the fixed rate is the OUTPUT (the par forward rate), so it is omitted.","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type  fixedDayCount fixedFrequency floatDayCount floatFrequency floatSpread maturityDate notional startDate @insiderfinance/totalfinance/fixed-income/rates"},{"title":"FraInstrument","url":"/reference/totalfinance/fixed-income/page-4#FraInstrument","description":"A forward rate agreement fixing `rate` over `[start, end]`.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  dayCount end rate start type @insiderfinance/totalfinance/fixed-income/curves"},{"title":"FraResult","url":"/reference/totalfinance/fixed-income/page-4#FraResult","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  accrual assumptions assumptions.conventionsVersion diagnostics diagnostics.warnings discountFactor forwardRate value @insiderfinance/totalfinance/fixed-income/rates"},{"title":"FraSpecification","url":"/reference/totalfinance/fixed-income/page-4#FraSpecification","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  dayCount end fixedRate notional start @insiderfinance/totalfinance/fixed-income/rates"},{"title":"Frequency","url":"/reference/totalfinance/fixed-income/page-4#Frequency","description":"Coupon payment frequency, named or as an explicit number of payments per year.","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type   @insiderfinance/totalfinance/fixed-income/conventions"},{"title":"FutureInstrument","url":"/reference/totalfinance/fixed-income/page-4#FutureInstrument","description":"A rate future quoted as `price = 100·(1 − impliedRate)` over `[start, end]`.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  convexityAdjustment dayCount end price start type @insiderfinance/totalfinance/fixed-income/curves"},{"title":"G2ppModel","url":"/reference/totalfinance/fixed-income/page-4#G2ppModel","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  caplet caplet(input) caplet(input).accrualFraction caplet(input).bondMaturity caplet(input).optionMaturity caplet(input).strikeRate discount @insiderfinance/totalfinance/fixed-income/models"},{"title":"G2ppParameters","url":"/reference/totalfinance/fixed-income/page-4#G2ppParameters","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  a b eta rho sigma @insiderfinance/totalfinance/fixed-income/models"},{"title":"GaussianShortRateModel","url":"/reference/totalfinance/fixed-income/page-4#GaussianShortRateModel","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  caplet caplet(input) caplet(input).accrualFraction caplet(input).bondMaturity caplet(input).optionMaturity caplet(input).strikeRate discount @insiderfinance/totalfinance/fixed-income/models"},{"title":"HazardBootstrapOptions","url":"/reference/totalfinance/fixed-income/page-4#HazardBootstrapOptions","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  accrualOnDefault dayCount discountCurve discountCurve.addSpread discountCurve.addSpread(spread) discountCurve.bumpPillar discountCurve.bumpP @insiderfinance/totalfinance/fixed-income/credit"},{"title":"HullWhiteModel","url":"/reference/totalfinance/fixed-income/page-5#HullWhiteModel","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  caplet caplet(input) caplet(input).accrualFraction caplet(input).bondMaturity caplet(input).optionMaturity caplet(input).strikeRate discount @insiderfinance/totalfinance/fixed-income/models"},{"title":"HullWhiteParameters","url":"/reference/totalfinance/fixed-income/page-5#HullWhiteParameters","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  a sigma @insiderfinance/totalfinance/fixed-income/models"},{"title":"ImpliedCrossCurrencyBasisInput","url":"/reference/totalfinance/fixed-income/page-5#ImpliedCrossCurrencyBasisInput","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  domestic domestic.addSpread domestic.addSpread(spread) domestic.bumpPillar domestic.bumpPillar(delta) domestic.bumpPillar(index) domestic.da @insiderfinance/totalfinance/fixed-income/cross-currency"},{"title":"ImpliedCrossCurrencyBasisResult","url":"/reference/totalfinance/fixed-income/page-5#ImpliedCrossCurrencyBasisResult","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion basis diagnostics diagnostics.warnings @insiderfinance/totalfinance/fixed-income/cross-currency"},{"title":"InflationLinkedBondSpecification","url":"/reference/totalfinance/fixed-income/page-5#InflationLinkedBondSpecification","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  baseIndex convention couponRate dayCount deflationFloor endOfMonth faceValue frequency issueDate maturityDate @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"MultiCurve","url":"/reference/totalfinance/fixed-income/page-5#MultiCurve","description":"A dual-curve set (spec §14.2): an OIS `discountCurve` and an index `forecastCurve`. Its shape is\nexactly the `SwapCurves` every swap analytic (`swapValue`, `swa","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  discountCurve discountCurve.addSpread discountCurve.addSpread(spread) discountCurve.bumpPillar discountCurve.bumpPillar(delta) discountCurve @insiderfinance/totalfinance/fixed-income/curves"},{"title":"MultiCurveBootstrapOptions","url":"/reference/totalfinance/fixed-income/page-5#MultiCurveBootstrapOptions","description":"Options for {@link bootstrapMultiCurve}: the OIS + projection instrument sets share one build config.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  dayCount extrapolation interpolation ois projection referenceDate @insiderfinance/totalfinance/fixed-income/curves"},{"title":"OasAnalyticsResult","url":"/reference/totalfinance/fixed-income/page-5#OasAnalyticsResult","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion assumptions.dayCount assumptions.meanReversion assumptions.model assumptions.settlementDate assum @insiderfinance/totalfinance/fixed-income/lattice"},{"title":"OasAnalyticsSpecification","url":"/reference/totalfinance/fixed-income/page-5#OasAnalyticsSpecification","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  bond bond.accrued bond.accrued(context) bond.accrued(context).forecastCurve bond.accrued(context).knownFixingRate bond.accrued(context).refe @insiderfinance/totalfinance/fixed-income/lattice"},{"title":"OptionRight","url":"/reference/totalfinance/fixed-income/page-5#OptionRight","description":"type from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type   @insiderfinance/totalfinance/fixed-income/rates"},{"title":"ParCdsSpecification","url":"/reference/totalfinance/fixed-income/page-5#ParCdsSpecification","description":"A par-spread request: a {@link CdsSpecification} WITHOUT `spread` (H02) — the par spread is the\nANSWER, so requiring a current spread demanded an input the calc","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type  accrualOnDefault dayCount effectiveDate frequency maturityDate notional protectionSteps recovery @insiderfinance/totalfinance/fixed-income/credit"},{"title":"ParSwapSpecification","url":"/reference/totalfinance/fixed-income/page-5#ParSwapSpecification","description":"A par-rate request: a {@link SwapSpecification} WITHOUT `fixedRate` (H04) — the par rate is the\nANSWER, so requiring a fixed coupon demanded an input the calcul","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type  fixedDayCount fixedFrequency floatDayCount floatFrequency floatSpread maturityDate notional startDate @insiderfinance/totalfinance/fixed-income/rates"},{"title":"PriceFromYieldOptions","url":"/reference/totalfinance/fixed-income/page-5#PriceFromYieldOptions","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  context context.forecastCurve context.forecastCurve.addSpread context.forecastCurve.addSpread(spread) context.forecastCurve.bumpPillar conte @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"ProjectionBootstrapOptions","url":"/reference/totalfinance/fixed-income/page-5#ProjectionBootstrapOptions","description":"Options for {@link bootstrapProjection}: {@link BootstrapOptions} plus the OIS discount curve.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  dayCount discountCurve discountCurve.addSpread discountCurve.addSpread(spread) discountCurve.bumpPillar discountCurve.bumpPillar(delta) disc @insiderfinance/totalfinance/fixed-income/curves"},{"title":"ProjectionContext","url":"/reference/totalfinance/fixed-income/page-5#ProjectionContext","description":"Projection inputs for instruments whose coupons are not fixed at issuance.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  forecastCurve forecastCurve.addSpread forecastCurve.addSpread(spread) forecastCurve.bumpPillar forecastCurve.bumpPillar(delta) forecastCurve @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"RatesVolatilityModel","url":"/reference/totalfinance/fixed-income/page-5#RatesVolatilityModel","description":"type from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type   @insiderfinance/totalfinance/fixed-income/rates"},{"title":"ScheduleOptions","url":"/reference/totalfinance/fixed-income/page-5#ScheduleOptions","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  calendar calendar.addBusinessDays calendar.addBusinessDays(date) calendar.addBusinessDays(days) calendar.businessDaysBetween calendar.busine @insiderfinance/totalfinance/fixed-income/conventions"},{"title":"SchedulePeriod","url":"/reference/totalfinance/fixed-income/page-5#SchedulePeriod","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  accrualEnd accrualStart isStub paymentDate @insiderfinance/totalfinance/fixed-income/conventions"},{"title":"ShortRateModel","url":"/reference/totalfinance/fixed-income/page-5#ShortRateModel","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  discountBond discountBond(shortRate) discountBond(tau) shortRateMoments shortRateMoments().return.mean shortRateMoments().return.standardDev @insiderfinance/totalfinance/fixed-income/models"},{"title":"ShortRateMoments","url":"/reference/totalfinance/fixed-income/page-6#ShortRateMoments","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  mean standardDeviation variance @insiderfinance/totalfinance/fixed-income/models"},{"title":"ShortRateTree","url":"/reference/totalfinance/fixed-income/page-6#ShortRateTree","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  discountBond discountBond(maturity) gridTimes model reachAt reachAt(stepIndex) rollback rollback(atNode) rollback(terminal) rollback(termina @insiderfinance/totalfinance/fixed-income/models"},{"title":"ShortRateTreeOptions","url":"/reference/totalfinance/fixed-income/page-6#ShortRateTreeOptions","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  horizonYears meanReversion model sigma steps @insiderfinance/totalfinance/fixed-income/models"},{"title":"SurvivalCurve","url":"/reference/totalfinance/fixed-income/page-6#SurvivalCurve","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  conditionalDefaultProbability conditionalDefaultProbability(from) conditionalDefaultProbability(to) dayCount defaultProbability defaultProba @insiderfinance/totalfinance/fixed-income/credit"},{"title":"SurvivalCurveOptions","url":"/reference/totalfinance/fixed-income/page-6#SurvivalCurveOptions","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  dayCount referenceDate @insiderfinance/totalfinance/fixed-income/credit"},{"title":"SurvivalPillar","url":"/reference/totalfinance/fixed-income/page-6#SurvivalPillar","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  cumulativeHazard date hazard survival tenorYears @insiderfinance/totalfinance/fixed-income/credit"},{"title":"SwapCurves","url":"/reference/totalfinance/fixed-income/page-6#SwapCurves","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  discountCurve discountCurve.addSpread discountCurve.addSpread(spread) discountCurve.bumpPillar discountCurve.bumpPillar(delta) discountCurve @insiderfinance/totalfinance/fixed-income/rates"},{"title":"SwapInstrument","url":"/reference/totalfinance/fixed-income/page-6#SwapInstrument","description":"A par swap or OIS: the fixed leg pays `rate` at `fixedFrequency`; single-curve par condition.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  fixedDayCount fixedFrequency floatDayCount floatFrequency maturity rate type @insiderfinance/totalfinance/fixed-income/curves"},{"title":"SwapRateAssumptions","url":"/reference/totalfinance/fixed-income/page-6#SwapRateAssumptions","description":"The conventions `swapRate.explain` echoes (FI day-count vocabulary — wider than core's\n`Assumptions` enum, so the facade construction below carries the same typ","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  conventionsVersion fixedDayCount fixedFrequency floatDayCount floatFrequency floatSpread maturityDate notional startDate @insiderfinance/totalfinance/fixed-income/rates"},{"title":"SwapRateFacade","url":"/reference/totalfinance/fixed-income/page-6#SwapRateFacade","description":"type from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type  (curves) (curves).discountCurve (curves).forecastCurve (specification) (specification).fixedDayCount (specification).fixedFrequency (specifi @insiderfinance/totalfinance/fixed-income/rates"},{"title":"SwapSpecification","url":"/reference/totalfinance/fixed-income/page-6#SwapSpecification","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  fixedDayCount fixedFrequency fixedRate floatDayCount floatFrequency floatSpread maturityDate notional startDate @insiderfinance/totalfinance/fixed-income/rates"},{"title":"SwapValuation","url":"/reference/totalfinance/fixed-income/page-6#SwapValuation","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  annuity assumptions assumptions.conventionsVersion diagnostics diagnostics.warnings fixedLegPresentValue floatLegPresentValue parRate pv01 v @insiderfinance/totalfinance/fixed-income/rates"},{"title":"SwaptionResult","url":"/reference/totalfinance/fixed-income/page-6#SwaptionResult","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  annuity assumptions assumptions.conventionsVersion diagnostics diagnostics.warnings forwardSwapRate price @insiderfinance/totalfinance/fixed-income/rates"},{"title":"SwaptionSpecification","url":"/reference/totalfinance/fixed-income/page-6#SwaptionSpecification","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  expiry fixedDayCount fixedFrequency fixedRate floatDayCount floatFrequency floatSpread maturityDate model notional optionType startDate vola @insiderfinance/totalfinance/fixed-income/rates"},{"title":"TipsIndexRatioInput","url":"/reference/totalfinance/fixed-income/page-6#TipsIndexRatioInput","description":"Input for {@link tipsIndexRatio}.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  baseReferenceCpi cpi datedDate settlementDate @insiderfinance/totalfinance/fixed-income/inflation"},{"title":"TipsIndexRatioResult","url":"/reference/totalfinance/fixed-income/page-6#TipsIndexRatioResult","description":"The reference CPI and index ratio for a settlement date.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion assumptions.interpolation assumptions.lagMonths baseReferenceCpi diagnostics diagnostics.autoReas @insiderfinance/totalfinance/fixed-income/inflation"},{"title":"TreeModel","url":"/reference/totalfinance/fixed-income/page-6#TreeModel","description":"type from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type   @insiderfinance/totalfinance/fixed-income/models"},{"title":"VasicekParameters","url":"/reference/totalfinance/fixed-income/page-6#VasicekParameters","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  a b r0 sigma @insiderfinance/totalfinance/fixed-income/models"},{"title":"XvaParameters","url":"/reference/totalfinance/fixed-income/page-6#XvaParameters","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  counterpartySurvival counterpartySurvival.conditionalDefaultProbability counterpartySurvival.conditionalDefaultProbability(from) counterpart @insiderfinance/totalfinance/fixed-income/xva"},{"title":"XvaResult","url":"/reference/totalfinance/fixed-income/page-6#XvaResult","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion assumptions.model assumptions.paths assumptions.seed assumptions.stepsPerYear bilateralCva cva di @insiderfinance/totalfinance/fixed-income/xva"},{"title":"XvaSwapSpecification","url":"/reference/totalfinance/fixed-income/page-7#XvaSwapSpecification","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  curve curve.addSpread curve.addSpread(spread) curve.bumpPillar curve.bumpPillar(delta) curve.bumpPillar(index) curve.dayCount curve.discount @insiderfinance/totalfinance/fixed-income/xva"},{"title":"YieldCurve","url":"/reference/totalfinance/fixed-income/page-7#YieldCurve","description":"A discount/zero/forward curve. Immutable; shocks return new curves.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  addSpread addSpread(spread) bumpPillar bumpPillar(delta) bumpPillar(index) dayCount discount discount(at) extrapolation forwardRate forwardR @insiderfinance/totalfinance/fixed-income/curves"},{"title":"YieldFromPriceOptions","url":"/reference/totalfinance/fixed-income/page-7#YieldFromPriceOptions","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  context context.forecastCurve context.forecastCurve.addSpread context.forecastCurve.addSpread(spread) context.forecastCurve.bumpPillar conte @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"YieldMetrics","url":"/reference/totalfinance/fixed-income/page-7#YieldMetrics","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  accruedInterest assumptions assumptions.asOf assumptions.businessDayConvention assumptions.calendar assumptions.calendarVersion assumptions. @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"YieldMetricsOptions","url":"/reference/totalfinance/fixed-income/page-7#YieldMetricsOptions","description":"Input for {@link yieldMetrics}.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  context context.forecastCurve context.forecastCurve.addSpread context.forecastCurve.addSpread(spread) context.forecastCurve.bumpPillar conte @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"YieldShiftGrid","url":"/reference/totalfinance/fixed-income/page-7#YieldShiftGrid","description":"A parallel-yield-shift grid: either an explicit list of basis-point shifts, or an inclusive\n`{ from, to, step }` range. The default (`{ from: -200, to: 200, ste","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type  from step to @insiderfinance/totalfinance/fixed-income/futures"},{"title":"YieldToCallAssumptions","url":"/reference/totalfinance/fixed-income/page-7#YieldToCallAssumptions","description":"{@link yieldToCall}.explain assumptions: the bond conventions plus the call/price basis echo.","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type  asOf businessDayConvention calendar calendarVersion callDate compounding conventionsVersion dayCount dividendModel engine expiryConvention f @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"YieldToCallFacade","url":"/reference/totalfinance/fixed-income/page-7#YieldToCallFacade","description":"type from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income type  (bond) (bond).accrued (bond).businessDayConvention (bond).cashflows (bond).couponRate (bond).dayCount (bond).faceValue (bond).frequency (bon @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"ZeroCouponBondSpecification","url":"/reference/totalfinance/fixed-income/page-7#ZeroCouponBondSpecification","description":"interface from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  dayCount faceValue frequency issueDate maturityDate @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"ZeroCouponInflationSwapInput","url":"/reference/totalfinance/fixed-income/page-7#ZeroCouponInflationSwapInput","description":"Input for {@link zeroCouponInflationSwap}.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  contractRate discountFactor forwardIndexRatio maturityYears notional payer swapRate @insiderfinance/totalfinance/fixed-income/inflation"},{"title":"ZeroCouponInflationSwapResult","url":"/reference/totalfinance/fixed-income/page-7#ZeroCouponInflationSwapResult","description":"The economics of a zero-coupon inflation swap.","category":"@insiderfinance/totalfinance/fixed-income","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income interface  assumptions assumptions.conventionsVersion assumptions.method diagnostics diagnostics.autoReason diagnostics.converged diagnostics.decomposi @insiderfinance/totalfinance/fixed-income/inflation"},{"title":"addMonths","url":"/reference/totalfinance/fixed-income/page-7#addMonths","description":"Add `months` to an ISO date. The day-of-month is clamped to the target month's length; when\n`endOfMonth` is set the result snaps to the last day of the target m","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (date) (endOfMonth) (months) @insiderfinance/totalfinance/fixed-income/conventions"},{"title":"adjustDate","url":"/reference/totalfinance/fixed-income/page-7#adjustDate","description":"function from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (calendar) (calendar).addBusinessDays (calendar).businessDaysBetween (calendar).isBusinessDay (calendar).isHalfDay (calendar).isHoliday (cal @insiderfinance/totalfinance/fixed-income/conventions"},{"title":"bermudanSwaption","url":"/reference/totalfinance/fixed-income/page-7#bermudanSwaption","description":"Price a Bermudan swaption on the Hull-White tree. At each exercise date the holder takes\n`max(continuation, swapValue)`, where the node-level forward swap value","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (specification) (specification).curve (specification).exerciseDates (specification).fixedDayCount (specification).fixedFrequency (specificat @insiderfinance/totalfinance/fixed-income/lattice"},{"title":"bondFuture","url":"/reference/totalfinance/fixed-income/page-7#bondFuture","description":"Bond-future basis, carry, implied repo rate, and cheapest-to-deliver across a basket. See\n`docs/specs/bond-future-ctd.md`.","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (input) (input).deliverables (input).deliveryDate (input).futuresPrice (input).notionalCoupon (input).repoRate (input).settlementDate return @insiderfinance/totalfinance/fixed-income/futures"},{"title":"bondFutureCtdFrontier","url":"/reference/totalfinance/fixed-income/page-7#bondFutureCtdFrontier","description":"The cheapest-to-deliver *frontier*: how the CTD identity and the futures risk move under explicit\nparallel-yield (and optional futures-price) scenarios. This is","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (input) (input).deliverables (input).deliveryDate (input).futuresPrice (input).futuresPrices (input).notionalCoupon (input).refineSwitches ( @insiderfinance/totalfinance/fixed-income/futures"},{"title":"bondFutureHedge","url":"/reference/totalfinance/fixed-income/page-7#bondFutureHedge","description":"Bond-future DV01 hedge ratio and futures-implied yield. Composes {@link bondFuture} (to find the CTD and\nthe conversion factors) with the bond yield/DV01 analyt","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (input) (input).deliverables (input).deliveryDate (input).futuresPrice (input).hedgeDv01 (input).notionalCoupon (input).repoRate (input).set @insiderfinance/totalfinance/fixed-income/futures"},{"title":"bonds","url":"/reference/totalfinance/fixed-income/page-7#bonds","description":"Bond constructors (spec §14.1).","category":"@insiderfinance/totalfinance/fixed-income","kind":"value","keywords":"@insiderfinance/totalfinance/fixed-income value  amortizing amortizing().return.accrued amortizing().return.businessDayConvention amortizing().return.cashflows amortizing().return.couponRat @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"bootstrapHazardFromCds","url":"/reference/totalfinance/fixed-income/page-7#bootstrapHazardFromCds","description":"Bootstrap a survival curve from a CDS par-spread term structure. Hazard is piecewise-constant\nbetween quote maturities; each segment is solved so the CDS to tha","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (options) (options).accrualOnDefault (options).dayCount (options).discountCurve (options).frequency (options).protectionSteps (options).reco @insiderfinance/totalfinance/fixed-income/credit"},{"title":"breakevenInflation","url":"/reference/totalfinance/fixed-income/page-7#breakevenInflation","description":"The breakeven inflation rate implied by a nominal and a real (TIPS) yield — arithmetic and exact\nFisher-compounded — with the standard premium decomposition. Se","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (input) (input).inflationRiskPremium (input).liquidityPremium (input).nominalYield (input).realYield return.assumptions return.assumptions.c @insiderfinance/totalfinance/fixed-income/inflation"},{"title":"callableBond","url":"/reference/totalfinance/fixed-income/page-8#callableBond","description":"Price a callable and/or putable bond on a short-rate tree, with option value, effective duration, and OAS.","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (specification) (specification).bond (specification).calls (specification).curve (specification).marketPrice (specification).meanReversion ( @insiderfinance/totalfinance/fixed-income/lattice"},{"title":"capFloorPrice","url":"/reference/totalfinance/fixed-income/page-8#capFloorPrice","description":"Price a cap or floor as a strip of Black/Bachelier caplets/floorlets off discount/forecast curves.","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (curves) (curves).discountCurve (curves).forecastCurve (specification) (specification).dayCount (specification).frequency (specification).ma @insiderfinance/totalfinance/fixed-income/rates"},{"title":"cdsBasis","url":"/reference/totalfinance/fixed-income/page-8#cdsBasis","description":"CDS–bond basis: `cdsParSpread − bondImpliedSpread`, both DECIMAL annualized spreads (H01,\nratified plain). **Positive = the CDS is rich relative to the bond** (","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (input) (input).bondImpliedSpread (input).cdsParSpread @insiderfinance/totalfinance/fixed-income/credit"},{"title":"cdsParSpread","url":"/reference/totalfinance/fixed-income/page-8#cdsParSpread","description":"function from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (curves) (curves).discountCurve (curves).survivalCurve (specification) (specification).accrualOnDefault (specification).dayCount (specificat @insiderfinance/totalfinance/fixed-income/credit"},{"title":"cdsValue","url":"/reference/totalfinance/fixed-income/page-8#cdsValue","description":"Value a CDS off discount and survival curves (PV to the protection buyer).","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (curves) (curves).discountCurve (curves).survivalCurve (specification) (specification).accrualOnDefault (specification).dayCount (specificat @insiderfinance/totalfinance/fixed-income/credit"},{"title":"cir","url":"/reference/totalfinance/fixed-income/page-8#cir","description":"Construct a CIR model `dr = a(b − r)dt + σ√r dW` (affine, non-negative rates).\n\nThe Feller condition `2ab ≥ σ²` is what keeps the short rate strictly positive. ","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (parameters) (parameters).a (parameters).b (parameters).r0 (parameters).sigma return.diagnostics return.diagnostics.warnings return.discount @insiderfinance/totalfinance/fixed-income/models"},{"title":"cmsConvexityAdjustment","url":"/reference/totalfinance/fixed-income/page-8#cmsConvexityAdjustment","description":"The standard CMS convexity adjustment (Hull): valuing the swap-rate payoff with the bond function\n`G(y) = Σ cᵢ·(1 + y/m)^(−i)` of a par bond paying the swap's f","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (specification) (specification).expiry (specification).forwardSwapRate (specification).paymentsPerYear (specification).swapTenorYears (speci @insiderfinance/totalfinance/fixed-income/rates"},{"title":"compareDates","url":"/reference/totalfinance/fixed-income/page-8#compareDates","description":"Compare two ISO dates: negative if `a < b`, 0 if equal, positive if `a > b`.","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (first) (second) @insiderfinance/totalfinance/fixed-income/conventions"},{"title":"conversionFactor","url":"/reference/totalfinance/fixed-income/page-8#conversionFactor","description":"The CME/CBOT conversion factor for a deliverable bond: the price per $1 face that would make it yield\nthe contract's notional coupon (default 6%) on the first d","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (input) (input).bond (input).deliveryDate (input).notionalCoupon return.assumptions return.assumptions.conventionsVersion return.assumptions @insiderfinance/totalfinance/fixed-income/futures"},{"title":"convertibleBond","url":"/reference/totalfinance/fixed-income/page-8#convertibleBond","description":"Price a convertible bond on an equity lattice with reduced-form credit (spec §14.1).","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (specification) (specification).calls (specification).conversionRatio (specification).couponRate (specification).dayCount (specification).di @insiderfinance/totalfinance/fixed-income/convertible"},{"title":"cpiSeasonality","url":"/reference/totalfinance/fixed-income/page-8#cpiSeasonality","description":"Extract 12 multiplicative CPI seasonal factors from an NSA history via the classic ratio-to-centered-\n2×12-moving-average, normalized to average 1. See `docs/sp","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (input) (input).series return.assumptions return.assumptions.conventionsVersion return.assumptions.method return.diagnostics return.factors  @insiderfinance/totalfinance/fixed-income/inflation"},{"title":"credit","url":"/reference/totalfinance/fixed-income/page-8#credit","description":"Survival-curve constructors and credit analytics (spec §14.4).","category":"@insiderfinance/totalfinance/fixed-income","kind":"value","keywords":"@insiderfinance/totalfinance/fixed-income value  bootstrapHazardFromCds bootstrapHazardFromCds().return.conditionalDefaultProbability bootstrapHazardFromCds().return.dayCount bootstrapHazar @insiderfinance/totalfinance/fixed-income/credit"},{"title":"creditSpreadCurve","url":"/reference/totalfinance/fixed-income/page-8#creditSpreadCurve","description":"Par CDS spreads at each tenor off the survival/discount curves. Facade (H03): the plain call\nreturns the points; `.explain()` echoes every convention the per-te","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (options) (options).accrualOnDefault (options).dayCount (options).discountCurve (options).frequency (options).protectionSteps (options).reco @insiderfinance/totalfinance/fixed-income/credit"},{"title":"creditTriangleHazard","url":"/reference/totalfinance/fixed-income/page-8#creditTriangleHazard","description":"function from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (input) (input).recovery (input).spread return.assumptions return.assumptions.approximation return.assumptions.conventionsVersion return.ass @insiderfinance/totalfinance/fixed-income/credit"},{"title":"crossCurrencyBasisCurve","url":"/reference/totalfinance/fixed-income/page-8#crossCurrencyBasisCurve","description":"Build the domestic-collateralized foreign discount curve (spec §14.5): the foreign OIS curve plus the\ncross-currency basis, `D_for^dom = foreign.addSpread(basis","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (input) (input).basis (input).domestic (input).foreign (input).spot return.assumptions return.assumptions.conventionsVersion return.collater @insiderfinance/totalfinance/fixed-income/cross-currency"},{"title":"curveMetrics","url":"/reference/totalfinance/fixed-income/page-8#curveMetrics","description":"Price a bond against a discount curve and report effective/key-rate risk from curve shocks.\nFacade (dx §2.7): the plain call returns the rich {@link CurveMetric","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.value explain(callArguments) return.accru @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"curves","url":"/reference/totalfinance/fixed-income/page-8#curves","description":"Curve constructors (spec §14.2). Every builder returns an immutable {@link YieldCurve} whose\ndiscount factors, zero rates, and forwards are mutually consistent.","category":"@insiderfinance/totalfinance/fixed-income","kind":"value","keywords":"@insiderfinance/totalfinance/fixed-income value  bootstrap bootstrap().return.addSpread bootstrap().return.bumpPillar bootstrap().return.dayCount bootstrap().return.discount bootstrap().ret @insiderfinance/totalfinance/fixed-income/curves"},{"title":"daysInMonth","url":"/reference/totalfinance/fixed-income/page-8#daysInMonth","description":"Days in a given month (`month` is 1-12).","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (month) (year) @insiderfinance/totalfinance/fixed-income/conventions"},{"title":"daysInYear","url":"/reference/totalfinance/fixed-income/page-8#daysInYear","description":"Days in a Gregorian year (365 or 366).","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (year) @insiderfinance/totalfinance/fixed-income/conventions"},{"title":"discountFromZero","url":"/reference/totalfinance/fixed-income/page-8#discountFromZero","description":"Discount factor implied by a zero rate quoted in `compounding` over time `t`.","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (compounding) (compounding).periodsPerYear (compounding).type (years) (zero) @insiderfinance/totalfinance/fixed-income/curves"},{"title":"forwardCmsRate","url":"/reference/totalfinance/fixed-income/page-9#forwardCmsRate","description":"Forward CMS rate off a curve: the forward swap rate of the underlying constant-maturity swap plus the\nconvexity adjustment. Discount the resulting rate on the r","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (curves) (curves).discountCurve (curves).forecastCurve (specification) (specification).fixedDayCount (specification).fixedFrequency (specifi @insiderfinance/totalfinance/fixed-income/rates"},{"title":"forwardSwap","url":"/reference/totalfinance/fixed-income/page-9#forwardSwap","description":"The curve-driven forward swap rate and annuity of a (possibly forward-starting) swap — the two curve\ninputs a swaption needs, in one call. For a swaption struck","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (curves) (curves).discountCurve (curves).forecastCurve (specification) (specification).fixedDayCount (specification).fixedFrequency (specifi @insiderfinance/totalfinance/fixed-income/rates"},{"title":"fraValue","url":"/reference/totalfinance/fixed-income/page-9#fraValue","description":"function from @insiderfinance/totalfinance/fixed-income","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (options) (options).curve (specification) (specification).dayCount (specification).end (specification).fixedRate (specification).notional (s @insiderfinance/totalfinance/fixed-income/rates"},{"title":"g2pp","url":"/reference/totalfinance/fixed-income/page-9#g2pp","description":"G2++ (two-additive-factor Gaussian) short-rate model `r(t) = φ(t) + x(t) + y(t)` with correlated\nOrnstein-Uhlenbeck factors, fit to the initial `curve` (Brigo–M","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (curve) (curve).addSpread (curve).bumpPillar (curve).dayCount (curve).discount (curve).extrapolation (curve).forwardRate (curve).instantaneo @insiderfinance/totalfinance/fixed-income/models"},{"title":"generateSchedule","url":"/reference/totalfinance/fixed-income/page-9#generateSchedule","description":"Generate a coupon schedule by rolling backward from maturity at the coupon interval — the market\ndefault, which places any irregular (\"stub\") period at the fron","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (options) (options).calendar (options).convention (options).effectiveDate (options).endOfMonth (options).frequency (options).maturityDate (o @insiderfinance/totalfinance/fixed-income/conventions"},{"title":"hullWhite","url":"/reference/totalfinance/fixed-income/page-9#hullWhite","description":"Construct a Hull-White model `dr = (θ(t) − a·r)dt + σ dW`, with θ implied by `curve`.","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (curve) (curve).addSpread (curve).bumpPillar (curve).dayCount (curve).discount (curve).extrapolation (curve).forwardRate (curve).instantaneo @insiderfinance/totalfinance/fixed-income/models"},{"title":"impliedCrossCurrencyBasis","url":"/reference/totalfinance/fixed-income/page-9#impliedCrossCurrencyBasis","description":"Invert market FX forwards to the cross-currency basis (spec §14.5) — the inverse of\n{@link crossCurrencyBasisCurve}. From `F(0,t) = spot · D_for^dom(t)/D_dom(t)","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (input) (input).domestic (input).foreign (input).forwards (input).spot return.assumptions return.assumptions.conventionsVersion return.basis @insiderfinance/totalfinance/fixed-income/cross-currency"},{"title":"isEndOfMonth","url":"/reference/totalfinance/fixed-income/page-9#isEndOfMonth","description":"Whether an ISO date is the last calendar day of its month.","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (date) @insiderfinance/totalfinance/fixed-income/conventions"},{"title":"isLeapYear","url":"/reference/totalfinance/fixed-income/page-9#isLeapYear","description":"Gregorian leap-year test.","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (year) @insiderfinance/totalfinance/fixed-income/conventions"},{"title":"oasAnalytics","url":"/reference/totalfinance/fixed-income/page-9#oasAnalytics","description":"Market-calibrated option-adjusted-spread analytics for a callable/putable bond: the OAS, the Z-spread,\ntheir difference (the embedded-**option cost**), and the ","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (specification) (specification).bond (specification).calls (specification).curve (specification).durationShock (specification).marketPrice ( @insiderfinance/totalfinance/fixed-income/lattice"},{"title":"paymentsPerYear","url":"/reference/totalfinance/fixed-income/page-9#paymentsPerYear","description":"Resolve a {@link Frequency} to an integer number of payments per year (must divide 12 evenly).","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (frequency) @insiderfinance/totalfinance/fixed-income/conventions"},{"title":"priceFromYield","url":"/reference/totalfinance/fixed-income/page-9#priceFromYield","description":"Dirty/clean price and accrued interest for a bond at a given yield. Facade (dx §2.7): the plain\ncall returns the rich {@link BondPrice}; `.explain()` wraps the ","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.value explain(callArguments) return.accru @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"priceMultiCurve","url":"/reference/totalfinance/fixed-income/page-9#priceMultiCurve","description":"Price a bond with separate discount and forecast curves (multi-curve framework, no shock).\n\n`knownFixingRate` is the FRN in-progress coupon's observed reset — s","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (bond) (bond).accrued (bond).businessDayConvention (bond).cashflows (bond).couponRate (bond).dayCount (bond).faceValue (bond).frequency (bon @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"rateCurveFromYieldCurve","url":"/reference/totalfinance/fixed-income/page-9#rateCurveFromYieldCurve","description":"Project a live {@link YieldCurve} to core `RateCurve` data (module header).","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function ```ts\nconst data = rateCurveFromYieldCurve({ curve: curves.bootstrap(instruments, options), currency (input) (input).currency (input).curve return.asOf return.compounding return.currency return.dayCount return.interpolation return.points"},{"title":"shortRateTree","url":"/reference/totalfinance/fixed-income/page-9#shortRateTree","description":"Build a Hull-White / Black-Karasinski trinomial tree calibrated to `curve` via forward induction\n(Hull's two-stage procedure). Stage 1 lays out a symmetric mean","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (curve) (curve).addSpread (curve).bumpPillar (curve).dayCount (curve).discount (curve).extrapolation (curve).forwardRate (curve).instantaneo @insiderfinance/totalfinance/fixed-income/models"},{"title":"swapRate","url":"/reference/totalfinance/fixed-income/page-9#swapRate","description":"Par swap rate that makes the swap value zero: `floatLegPv / annuity`. Facade (H04): the plain\ncall returns the scalar; `.explain()` discloses the leg decomposit","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (curves) (curves).discountCurve (curves).forecastCurve (specification) (specification).fixedDayCount (specification).fixedFrequency (specifi @insiderfinance/totalfinance/fixed-income/rates"},{"title":"swapValue","url":"/reference/totalfinance/fixed-income/page-9#swapValue","description":"Value an interest-rate swap (or OIS) off discount/forecast curves.","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (curves) (curves).discountCurve (curves).forecastCurve (specification) (specification).fixedDayCount (specification).fixedFrequency (specifi @insiderfinance/totalfinance/fixed-income/rates"},{"title":"swapXva","url":"/reference/totalfinance/fixed-income/page-9#swapXva","description":"Compute CVA / DVA / FVA for an interest-rate swap via a Hull-White exposure simulation.","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (parameters) (parameters).counterpartySurvival (parameters).fundingSpread (parameters).meanReversion (parameters).ownRecovery (parameters).o @insiderfinance/totalfinance/fixed-income/xva"},{"title":"swaptionPrice","url":"/reference/totalfinance/fixed-income/page-9#swaptionPrice","description":"Price a European swaption. The forward swap rate `S` is the natural martingale under the annuity\nmeasure, so the price is `annuity · ForwardOption(S, K, σ, T)` ","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (curves) (curves).discountCurve (curves).forecastCurve (specification) (specification).expiry (specification).fixedDayCount (specification). @insiderfinance/totalfinance/fixed-income/rates"},{"title":"tipsIndexRatio","url":"/reference/totalfinance/fixed-income/page-9#tipsIndexRatio","description":"The TIPS reference CPI and index ratio for a settlement date: the 3-month-lagged NSA CPI, linearly\ninterpolated by day across the settlement month, over the dat","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (input) (input).baseReferenceCpi (input).cpi (input).datedDate (input).settlementDate return.assumptions return.assumptions.conventionsVersi @insiderfinance/totalfinance/fixed-income/inflation"},{"title":"vasicek","url":"/reference/totalfinance/fixed-income/page-10#vasicek","description":"Construct a Vasicek model `dr = a(b − r)dt + σ dW`.","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (parameters) (parameters).a (parameters).b (parameters).r0 (parameters).sigma return.caplet return.discountBond return.floorlet return.short @insiderfinance/totalfinance/fixed-income/models"},{"title":"yearFraction","url":"/reference/totalfinance/fixed-income/page-10#yearFraction","description":"Year fraction between two ISO dates under a fixed-income day-count convention. `ACT/ACT` and\n`30E/360` are implemented here; the three core conventions delegate","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (dayCount) (from) (to) @insiderfinance/totalfinance/fixed-income/conventions"},{"title":"yieldCurveFromRateCurve","url":"/reference/totalfinance/fixed-income/page-10#yieldCurveFromRateCurve","description":"Build a live {@link YieldCurve} from core `RateCurve` data (module header).","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function ```ts\nconst curve = yieldCurveFromRateCurve({\n  curve: snapshot.observations.curves['USD.treasury'], (input) (input).curve (input).extrapolation (input).interpolation return.addSpread return.bumpPillar return.dayCount return.discount return."},{"title":"yieldMetrics","url":"/reference/totalfinance/fixed-income/page-10#yieldMetrics","description":"Full set of yield-based risk metrics at a given yield (actuarial convention). Duration and\nconvexity are the closed-form analytic sensitivities of the dirty pri","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.value explain(callArguments) return.accru @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"yieldToCall","url":"/reference/totalfinance/fixed-income/page-10#yieldToCall","description":"Yield to a call date (H05): the plain call returns the scalar; `.explain()` mirrors\n`yieldToMaturity.explain()` — solver facts in diagnostics, the resolved call","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (bond) (bond).accrued (bond).businessDayConvention (bond).cashflows (bond).couponRate (bond).dayCount (bond).faceValue (bond).frequency (bon @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"yieldToMaturity","url":"/reference/totalfinance/fixed-income/page-10#yieldToMaturity","description":"Solve the yield to maturity that reprices a bond to the observed price (Brent on [−0.99·f, 1]).\nFacade (dx §2.7): the plain call returns the bare yield; `.expla","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.value explain(callArguments) @insiderfinance/totalfinance/fixed-income/bonds"},{"title":"zeroCouponInflationSwap","url":"/reference/totalfinance/fixed-income/page-10#zeroCouponInflationSwap","description":"A **zero-coupon inflation swap** (ZCIS) — the standard inflation-market instrument. At maturity the\ninflation leg pays `I(T)/I(0) − 1` and the fixed leg pays `(","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (input) (input).contractRate (input).discountFactor (input).forwardIndexRatio (input).maturityYears (input).notional (input).payer (input).s @insiderfinance/totalfinance/fixed-income/inflation"},{"title":"zeroFromDiscount","url":"/reference/totalfinance/fixed-income/page-10#zeroFromDiscount","description":"Zero rate (in `compounding`) implied by a discount factor over time `t`.","category":"@insiderfinance/totalfinance/fixed-income","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income function  (compounding) (compounding).periodsPerYear (compounding).type (discountFactor) (years) @insiderfinance/totalfinance/fixed-income/curves"},{"title":"CURVE_MODEL_FAMILIES","url":"/reference/totalfinance/fixed-income/artifacts#CURVE_MODEL_FAMILIES","description":"value from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts value  "},{"title":"CalibrationOf","url":"/reference/totalfinance/fixed-income/artifacts#CalibrationOf","description":"type from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts type  "},{"title":"CurveCalibrations","url":"/reference/totalfinance/fixed-income/artifacts#CurveCalibrations","description":"The direct bootstrap's input per family, verbatim (live curves where the bootstrap takes them).","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  discount-curve discount-curve.instruments discount-curve.options discount-curve.options.dayCount discount-curve.options.extrapolation discou"},{"title":"CurveEvaluationDifference","url":"/reference/totalfinance/fixed-income/artifacts#CurveEvaluationDifference","description":"interface from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  comparedCount grid maximumAbsoluteDifference measure nullCount placement rootMeanSquareDifference unit"},{"title":"CurveEvaluations","url":"/reference/totalfinance/fixed-income/artifacts#CurveEvaluations","description":"What `evaluateFittedModel` takes per family — the restored curve's own query, at dates.","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  discount-curve discount-curve.dates discount-curve.measure hazard-curve hazard-curve.dates hazard-curve.measure multi-curve multi-curve.curv"},{"title":"CurveFits","url":"/reference/totalfinance/fixed-income/artifacts#CurveFits","description":"The stored fit per family: the live result's own data members.","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  discount-curve discount-curve.dayCount discount-curve.extrapolation discount-curve.interpolation discount-curve.pillars discount-curve.refer"},{"title":"CurveFittedModelReport","url":"/reference/totalfinance/fixed-income/artifacts#CurveFittedModelReport","description":"The typed report every curve verb reads and writes — the artifact's `result`, verbatim.","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts type  assumptions assumptions.calibrator assumptions.conventionsVersion assumptions.currency assumptions.evaluator assumptions.family assumptions."},{"title":"CurveLiveFits","url":"/reference/totalfinance/fixed-income/artifacts#CurveLiveFits","description":"The live result per family — what the direct bootstrap returns and what `fittedModelArtifact` accepts.","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  discount-curve discount-curve.addSpread discount-curve.addSpread(spread) discount-curve.bumpPillar discount-curve.bumpPillar(delta) discount"},{"title":"CurveModelFamily","url":"/reference/totalfinance/fixed-income/artifacts#CurveModelFamily","description":"type from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts type  "},{"title":"CurveStoredCalibrations","url":"/reference/totalfinance/fixed-income/artifacts#CurveStoredCalibrations","description":"The STORED calibration: live curves as their data, the bulk row sets optionally as `TableHandle`s.","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  discount-curve discount-curve.instruments discount-curve.instruments.columnCount discount-curve.instruments.columns discount-curve.instrumen"},{"title":"EvaluationOf","url":"/reference/totalfinance/fixed-income/artifacts#EvaluationOf","description":"type from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts type  "},{"title":"FITTED_MODEL_FAMILIES","url":"/reference/totalfinance/fixed-income/artifacts#FITTED_MODEL_FAMILIES","description":"The frozen, data-only descriptor table (Program 5's registry metadata) for the curve families.","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts value  "},{"title":"FIXED_INCOME_FITTED_MODEL_ARTIFACT_TYPE","url":"/reference/totalfinance/fixed-income/artifacts#FIXED_INCOME_FITTED_MODEL_ARTIFACT_TYPE","description":"value from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts value  "},{"title":"FitOf","url":"/reference/totalfinance/fixed-income/artifacts#FitOf","description":"type from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts type  "},{"title":"FittedModelArtifactInput","url":"/reference/totalfinance/fixed-income/artifacts#FittedModelArtifactInput","description":"interface from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  calibration createdFrom currency family fit libraryVersion limits limits.embeddedRowLimit limits.maximumEmbeddedBytes locators provenance pr"},{"title":"FittedModelArtifactLimits","url":"/reference/totalfinance/fixed-income/artifacts#FittedModelArtifactLimits","description":"interface from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  embeddedRowLimit maximumEmbeddedBytes @insiderfinance/totalfinance/volatility/artifacts"},{"title":"FittedModelComparison","url":"/reference/totalfinance/fixed-income/artifacts#FittedModelComparison","description":"interface from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  artifactIds artifactIds.baseline artifactIds.candidate assumptions assumptions.conventionsVersion assumptions.family assumptions.limits assu"},{"title":"FittedModelEvaluation","url":"/reference/totalfinance/fixed-income/artifacts#FittedModelEvaluation","description":"interface from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  assumptions assumptions.conventionsVersion assumptions.currency assumptions.evaluator assumptions.extrapolation assumptions.family assumptio"},{"title":"FittedModelFamilyDescriptor","url":"/reference/totalfinance/fixed-income/artifacts#FittedModelFamilyDescriptor","description":"interface from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  calibrator costClass evaluator family modelVersion qualifiedFamily referenceableRowSets requiredData supportedProducts warmStart"},{"title":"FittedModelHoldoutInput","url":"/reference/totalfinance/fixed-income/artifacts#FittedModelHoldoutInput","description":"interface from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  calibration family holdout holdout.everyNth holdout.indices holdout.offset"},{"title":"FittedModelHoldoutReport","url":"/reference/totalfinance/fixed-income/artifacts/page-2#FittedModelHoldoutReport","description":"interface from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  assumptions assumptions.conventionsVersion assumptions.family assumptions.holdout assumptions.holdout.everyNth assumptions.holdout.indices a"},{"title":"FittedModelHoldoutSelection","url":"/reference/totalfinance/fixed-income/artifacts/page-2#FittedModelHoldoutSelection","description":"type from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts type  everyNth indices offset"},{"title":"FittedModelReplay","url":"/reference/totalfinance/fixed-income/artifacts/page-2#FittedModelReplay","description":"interface from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  artifactId assumptions assumptions.calibrator assumptions.conventionsVersion assumptions.family assumptions.libraryVersion assumptions.libra"},{"title":"LiveFitOf","url":"/reference/totalfinance/fixed-income/artifacts/page-2#LiveFitOf","description":"type from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts type  "},{"title":"ParameterDelta","url":"/reference/totalfinance/fixed-income/artifacts/page-2#ParameterDelta","description":"interface from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  absoluteDelta baselineValue candidateValue parameter relativeDelta @insiderfinance/totalfinance/volatility/artifacts"},{"title":"ReadFittedModelResult","url":"/reference/totalfinance/fixed-income/artifacts/page-2#ReadFittedModelResult","description":"interface from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  artifact artifact.artifactType artifact.conventionsVersion artifact.createdFrom artifact.id artifact.inputs artifact.inputs.inputsHash artif"},{"title":"StoredCalibrationOf","url":"/reference/totalfinance/fixed-income/artifacts/page-2#StoredCalibrationOf","description":"type from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts type  "},{"title":"SurvivalCurveData","url":"/reference/totalfinance/fixed-income/artifacts/page-2#SurvivalCurveData","description":"A `SurvivalCurve`'s own data — exactly its non-method members.","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  dayCount pillars referenceDate"},{"title":"SurvivalCurveMeasure","url":"/reference/totalfinance/fixed-income/artifacts/page-2#SurvivalCurveMeasure","description":"type from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts type  "},{"title":"YieldCurveData","url":"/reference/totalfinance/fixed-income/artifacts/page-2#YieldCurveData","description":"A `YieldCurve`'s own data — its non-method members plus {@link ZeroRateAtOrigin}.","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts interface  dayCount extrapolation interpolation pillars referenceDate zeroRateAtOrigin"},{"title":"YieldCurveMeasure","url":"/reference/totalfinance/fixed-income/artifacts/page-2#YieldCurveMeasure","description":"type from @insiderfinance/totalfinance/fixed-income/artifacts","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts type  "},{"title":"ZeroRateAtOrigin","url":"/reference/totalfinance/fixed-income/artifacts/page-2#ZeroRateAtOrigin","description":"How a curve answers `zeroRate(referenceDate)` when a pillar sits ON the reference date:\n`'quoted'` echoes that pillar's zero (curves built from zero rates, whos","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts type  "},{"title":"compareFittedModels","url":"/reference/totalfinance/fixed-income/artifacts/page-2#compareFittedModels","description":"Compare two curve fits of one family (Decision 6).","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts function  (input) (input).baseline (input).baseline.artifactType (input).baseline.conventionsVersion (input).baseline.createdFrom (input).baseline.id "},{"title":"evaluateFittedModel","url":"/reference/totalfinance/fixed-income/artifacts/page-2#evaluateFittedModel","description":"Evaluate a restored curve through its own methods, at dates, in one stated measure.","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts function  (input) (input).at (input).model (input).model.artifactType (input).model.conventionsVersion (input).model.createdFrom (input).model.id (inp"},{"title":"fittedModelArtifact","url":"/reference/totalfinance/fixed-income/artifacts/page-2#fittedModelArtifact","description":"Describe a bootstrap's result and save it as an identified, immutable artifact.","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts function ```ts\nconst curve = curves.bootstrap(instruments, { referenceDate: '2026-01-01' });\nconst artifact = (input) (input).calibration (input).createdFrom (input).currency (input).family (input).fit (input).libraryVersion (input).limits (input).lo"},{"title":"fittedModelHoldout","url":"/reference/totalfinance/fixed-income/artifacts/page-2#fittedModelHoldout","description":"Fit on the retained instruments and reprice the held-out ones with the restored curve through\nthe package's public valuation (Decision 8 — Program 5's residuals","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts function  (input) (input).calibration (input).family (input).holdout return.assumptions return.assumptions.conventionsVersion return.assumptions.famil"},{"title":"readFittedModel","url":"/reference/totalfinance/fixed-income/artifacts/page-2#readFittedModel","description":"Restore a curve artifact: Gate B's read door, a foreign-type refusal, the report-level migration policy, report re-validation.","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts function  (input) (input).artifact (input).migrations return.artifact return.migrationsApplied return.modelMigrationsApplied return.report @insiderfinance/totalfinance/volatility/artifacts"},{"title":"replayFittedModel","url":"/reference/totalfinance/fixed-income/artifacts/page-2#replayFittedModel","description":"Re-issue the bootstrap from the stored calibration (curves restored exactly, referenced rows verified) and prove byte parity.","category":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts function  (input) (input).artifact (input).libraryVersion (input).limits (input).migrations (input).referencedData return.artifactId return.assumption @insiderfinance/totalfinance/volatility/artifacts"},{"title":"CdsParSpreadAssumptions","url":"/reference/totalfinance/fixed-income/credit#CdsParSpreadAssumptions","description":"The conventions `cdsParSpread.explain` echoes (FI day-count vocabulary — wider than core's\n`Assumptions` enum, so the facade construction below carries the same","category":"@insiderfinance/totalfinance/fixed-income/credit","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/credit interface  accrualOnDefault conventionsVersion dayCount effectiveDate frequency maturityDate notional protectionSteps recovery"},{"title":"CdsParSpreadFacade","url":"/reference/totalfinance/fixed-income/credit#CdsParSpreadFacade","description":"type from @insiderfinance/totalfinance/fixed-income/credit","category":"@insiderfinance/totalfinance/fixed-income/credit","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income/credit type  (curves) (curves).discountCurve (curves).survivalCurve (specification) (specification).accrualOnDefault (specification).dayCount (specificat"},{"title":"G2ppDiscountBondInput","url":"/reference/totalfinance/fixed-income/models#G2ppDiscountBondInput","description":"interface from @insiderfinance/totalfinance/fixed-income/models","category":"@insiderfinance/totalfinance/fixed-income/models","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/models interface  timeToMaturity valuationTime x y"},{"title":"HullWhiteDiscountBondInput","url":"/reference/totalfinance/fixed-income/models#HullWhiteDiscountBondInput","description":"interface from @insiderfinance/totalfinance/fixed-income/models","category":"@insiderfinance/totalfinance/fixed-income/models","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/models interface  shortRate timeToMaturity valuationTime"},{"title":"RateOptionletInput","url":"/reference/totalfinance/fixed-income/models#RateOptionletInput","description":"Inputs shared by Gaussian caplet and floorlet methods.","category":"@insiderfinance/totalfinance/fixed-income/models","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/models interface  accrualFraction bondMaturity optionMaturity strikeRate"},{"title":"ZeroCouponBondOptionInput","url":"/reference/totalfinance/fixed-income/models#ZeroCouponBondOptionInput","description":"Inputs shared by Gaussian zero-coupon-bond option methods.","category":"@insiderfinance/totalfinance/fixed-income/models","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/models interface  bondMaturity optionMaturity right strike"},{"title":"BOND_DISCOUNT_CURVE_PRICER_NAME","url":"/reference/totalfinance/fixed-income/pricer#BOND_DISCOUNT_CURVE_PRICER_NAME","description":"value from @insiderfinance/totalfinance/fixed-income/pricer","category":"@insiderfinance/totalfinance/fixed-income/pricer","kind":"value","keywords":"@insiderfinance/totalfinance/fixed-income/pricer value  "},{"title":"BOND_SETTLEMENT_DATE_PROJECTION","url":"/reference/totalfinance/fixed-income/pricer#BOND_SETTLEMENT_DATE_PROJECTION","description":"value from @insiderfinance/totalfinance/fixed-income/pricer","category":"@insiderfinance/totalfinance/fixed-income/pricer","kind":"value","keywords":"@insiderfinance/totalfinance/fixed-income/pricer value  "},{"title":"BondDiscountCurvePriceResult","url":"/reference/totalfinance/fixed-income/pricer#BondDiscountCurvePriceResult","description":"The complete direct `priceMultiCurve` result plus Gate C's scalar value and adapter disclosures.","category":"@insiderfinance/totalfinance/fixed-income/pricer","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/pricer interface  accruedInterest assumptions assumptions.asOf assumptions.businessDayConvention assumptions.calendar assumptions.calendarVersion assumptions."},{"title":"BondDiscountCurvePricerAssumptions","url":"/reference/totalfinance/fixed-income/pricer#BondDiscountCurvePricerAssumptions","description":"type from @insiderfinance/totalfinance/fixed-income/pricer","category":"@insiderfinance/totalfinance/fixed-income/pricer","kind":"type","keywords":"@insiderfinance/totalfinance/fixed-income/pricer type  asOf businessDayConvention calendar calendarVersion compounding conventionsVersion currency curveId curveReferenceDate dayCount dividendMode"},{"title":"BondDiscountCurvePricerOptions","url":"/reference/totalfinance/fixed-income/pricer#BondDiscountCurvePricerOptions","description":"interface from @insiderfinance/totalfinance/fixed-income/pricer","category":"@insiderfinance/totalfinance/fixed-income/pricer","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/pricer interface  currency curveId extrapolation interpolation priceType"},{"title":"bondDiscountCurvePricer","url":"/reference/totalfinance/fixed-income/pricer#bondDiscountCurvePricer","description":"Adapt the existing fixed-income discount-curve bond pricing path to Gate C.","category":"@insiderfinance/totalfinance/fixed-income/pricer","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income/pricer function  (options) (options).currency (options).curveId (options).extrapolation (options).interpolation (options).priceType return.capabilities retur"},{"title":"BachelierKernelInput","url":"/reference/totalfinance/fixed-income/rates#BachelierKernelInput","description":"Bachelier (normal) kernel: value of an option on a forward, undiscounted. Handles ≤0\nforwards/strikes. Named `bachelierKernel` to avoid colliding with the optio","category":"@insiderfinance/totalfinance/fixed-income/rates","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/rates interface  forward normalVolatility right strike timeToExpiryYears"},{"title":"BlackKernelInput","url":"/reference/totalfinance/fixed-income/rates#BlackKernelInput","description":"Black-76 kernel: value of an option on a forward, undiscounted. Falls back to intrinsic\nat T=0 or σ=0. Named `blackKernel` (not `black`) to avoid colliding with","category":"@insiderfinance/totalfinance/fixed-income/rates","kind":"interface","keywords":"@insiderfinance/totalfinance/fixed-income/rates interface  forward right strike timeToExpiryYears volatility"},{"title":"bachelierKernel","url":"/reference/totalfinance/fixed-income/rates/page-2#bachelierKernel","description":"function from @insiderfinance/totalfinance/fixed-income/rates","category":"@insiderfinance/totalfinance/fixed-income/rates","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income/rates function  (input) (input).forward (input).normalVolatility (input).right (input).strike (input).timeToExpiryYears"},{"title":"blackKernel","url":"/reference/totalfinance/fixed-income/rates/page-2#blackKernel","description":"function from @insiderfinance/totalfinance/fixed-income/rates","category":"@insiderfinance/totalfinance/fixed-income/rates","kind":"function","keywords":"@insiderfinance/totalfinance/fixed-income/rates function  (input) (input).forward (input).right (input).strike (input).timeToExpiryYears (input).volatility"},{"title":"ConvertCurrencyInput","url":"/reference/totalfinance/foreign-exchange#ConvertCurrencyInput","description":"Input for {@link convertCurrency} — the FC5 canonical first-touch shape.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  amount fromCurrency spotRate spotRate.baseCurrency spotRate.quoteCurrency spotRate.quotePerBase toCurrency @insiderfinance/totalfinance/foreign-exchange/spot"},{"title":"ConvertCurrencyResult","url":"/reference/totalfinance/foreign-exchange#ConvertCurrencyResult","description":"Result of {@link convertCurrency}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  assumptions assumptions.fromCurrency assumptions.orientation assumptions.quoteUsed assumptions.quoteUsed.baseCurrency assumptions.quoteUsed. @insiderfinance/totalfinance/foreign-exchange/spot"},{"title":"CoveredInterestParityForwardInput","url":"/reference/totalfinance/foreign-exchange#CoveredInterestParityForwardInput","description":"Input for {@link coveredInterestParityForward}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  compounding compounding.periodsPerYear compounding.type domesticAnnualRate foreignAnnualRate spotRate spotRate.baseCurrency spotRate.quoteCu @insiderfinance/totalfinance/foreign-exchange/forwards"},{"title":"CoveredInterestParityForwardResult","url":"/reference/totalfinance/foreign-exchange#CoveredInterestParityForwardResult","description":"Result of {@link coveredInterestParityForward}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  assumptions assumptions.compounding assumptions.compounding.periodsPerYear assumptions.compounding.type assumptions.rateRoles assumptions.ti @insiderfinance/totalfinance/foreign-exchange/forwards"},{"title":"CrossRateInput","url":"/reference/totalfinance/foreign-exchange#CrossRateInput","description":"Input for {@link crossRate}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  crossBaseCurrency crossQuoteCurrency firstQuote firstQuote.baseCurrency firstQuote.quoteCurrency firstQuote.quotePerBase secondQuote secondQ @insiderfinance/totalfinance/foreign-exchange/spot"},{"title":"CrossRateResult","url":"/reference/totalfinance/foreign-exchange#CrossRateResult","description":"Result of {@link crossRate}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  assumptions assumptions.derivation assumptions.throughCurrency diagnostics diagnostics.warnings quote quote.baseCurrency quote.quoteCurrency @insiderfinance/totalfinance/foreign-exchange/spot"},{"title":"CurrencyExposureInput","url":"/reference/totalfinance/foreign-exchange#CurrencyExposureInput","description":"Input for {@link currencyExposure}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  baseCurrency positions spotRates @insiderfinance/totalfinance/foreign-exchange/risk"},{"title":"CurrencyExposurePosition","url":"/reference/totalfinance/foreign-exchange#CurrencyExposurePosition","description":"One position handed to {@link currencyExposure}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  currency marketValueInPositionCurrency positionLabel @insiderfinance/totalfinance/foreign-exchange/risk"},{"title":"CurrencyExposureQuoteUse","url":"/reference/totalfinance/foreign-exchange#CurrencyExposureQuoteUse","description":"How one currency was restated into the base currency.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  currency orientation quote quote.baseCurrency quote.quoteCurrency quote.quotePerBase @insiderfinance/totalfinance/foreign-exchange/risk"},{"title":"CurrencyExposureResult","url":"/reference/totalfinance/foreign-exchange#CurrencyExposureResult","description":"Result of {@link currencyExposure}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  assumptions assumptions.baseCurrency assumptions.missingPairPolicy assumptions.quotesUsed byCurrency diagnostics diagnostics.warnings exclud @insiderfinance/totalfinance/foreign-exchange/risk"},{"title":"CurrencyExposureRow","url":"/reference/totalfinance/foreign-exchange#CurrencyExposureRow","description":"One aggregated per-currency exposure row.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  currency exposureFraction positionCount valueInBaseCurrency valueInCurrency @insiderfinance/totalfinance/foreign-exchange/risk"},{"title":"CurrencyPairQuote","url":"/reference/totalfinance/foreign-exchange#CurrencyPairQuote","description":"One foreign-exchange quote. `quotePerBase` is the price of ONE unit of `baseCurrency` expressed\nin `quoteCurrency` — EUR/USD 1.08 is `{ baseCurrency: 'EUR', quo","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  baseCurrency quoteCurrency quotePerBase @insiderfinance/totalfinance/foreign-exchange/spot"},{"title":"ExcludedCurrencyExposurePosition","url":"/reference/totalfinance/foreign-exchange#ExcludedCurrencyExposurePosition","description":"One excluded position, with the reason it could not participate.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  positionLabel reason @insiderfinance/totalfinance/foreign-exchange/risk"},{"title":"ForeignExchangeDiagnostics","url":"/reference/totalfinance/foreign-exchange#ForeignExchangeDiagnostics","description":"Diagnostics every FC5 analysis result carries (the FC2 result grammar).","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  warnings @insiderfinance/totalfinance/foreign-exchange/spot"},{"title":"ForeignExchangeForwardPointsInput","url":"/reference/totalfinance/foreign-exchange#ForeignExchangeForwardPointsInput","description":"Input for {@link foreignExchangeForwardPoints}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  forwardRate forwardRate.baseCurrency forwardRate.quoteCurrency forwardRate.quotePerBase pointSize spotRate spotRate.baseCurrency spotRate.qu @insiderfinance/totalfinance/foreign-exchange/forwards"},{"title":"ForeignExchangeForwardPointsResult","url":"/reference/totalfinance/foreign-exchange#ForeignExchangeForwardPointsResult","description":"Result of {@link foreignExchangeForwardPoints}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  assumptions assumptions.formula assumptions.pointSize assumptions.pointSizeSource diagnostics diagnostics.warnings forwardPoints @insiderfinance/totalfinance/foreign-exchange/forwards"},{"title":"ForeignExchangeForwardValueInput","url":"/reference/totalfinance/foreign-exchange#ForeignExchangeForwardValueInput","description":"Input for {@link foreignExchangeForwardValue} — also one leg of {@link foreignExchangeSwapValue}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  contractRate contractRate.baseCurrency contractRate.quoteCurrency contractRate.quotePerBase currentForwardRate currentForwardRate.baseCurren @insiderfinance/totalfinance/foreign-exchange/forwards"},{"title":"ForeignExchangeForwardValueResult","url":"/reference/totalfinance/foreign-exchange#ForeignExchangeForwardValueResult","description":"Result of {@link foreignExchangeForwardValue}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  assumptions assumptions.discountFactorSource assumptions.perspective assumptions.signConvention diagnostics diagnostics.warnings forwardValu @insiderfinance/totalfinance/foreign-exchange/forwards"},{"title":"ForeignExchangeSwapValueInput","url":"/reference/totalfinance/foreign-exchange#ForeignExchangeSwapValueInput","description":"Input for {@link foreignExchangeSwapValue}: two forward legs on the SAME pair.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  farLeg farLeg.contractRate farLeg.contractRate.baseCurrency farLeg.contractRate.quoteCurrency farLeg.contractRate.quotePerBase farLeg.curren @insiderfinance/totalfinance/foreign-exchange/forwards"},{"title":"ForeignExchangeSwapValueResult","url":"/reference/totalfinance/foreign-exchange#ForeignExchangeSwapValueResult","description":"Result of {@link foreignExchangeSwapValue}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  assumptions assumptions.composition assumptions.farLegPerspective assumptions.nearLegPerspective assumptions.signConvention diagnostics diag @insiderfinance/totalfinance/foreign-exchange/forwards"},{"title":"HEDGED_PROFIT_AND_LOSS_DECOMPOSITION","url":"/reference/totalfinance/foreign-exchange/page-2#HEDGED_PROFIT_AND_LOSS_DECOMPOSITION","description":"The exact decomposition prose, frozen so tests and docs can quote it.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"value","keywords":"@insiderfinance/totalfinance/foreign-exchange value   @insiderfinance/totalfinance/foreign-exchange/risk"},{"title":"HedgeRatioInput","url":"/reference/totalfinance/foreign-exchange/page-2#HedgeRatioInput","description":"Input for {@link hedgeRatio}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  exposureBaseAmount hedgeNotionalBaseAmount @insiderfinance/totalfinance/foreign-exchange/risk"},{"title":"HedgeRatioResult","url":"/reference/totalfinance/foreign-exchange/page-2#HedgeRatioResult","description":"Result of {@link hedgeRatio}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  assumptions assumptions.definition assumptions.exposureBaseAmount assumptions.hedgeNotionalBaseAmount diagnostics diagnostics.warnings hedge @insiderfinance/totalfinance/foreign-exchange/risk"},{"title":"InvertCurrencyPairQuoteInput","url":"/reference/totalfinance/foreign-exchange/page-2#InvertCurrencyPairQuoteInput","description":"Input for {@link invertCurrencyPairQuote}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  quote quote.baseCurrency quote.quoteCurrency quote.quotePerBase @insiderfinance/totalfinance/foreign-exchange/spot"},{"title":"InvertCurrencyPairQuoteResult","url":"/reference/totalfinance/foreign-exchange/page-2#InvertCurrencyPairQuoteResult","description":"Result of {@link invertCurrencyPairQuote}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  assumptions assumptions.inversion diagnostics diagnostics.warnings quote quote.baseCurrency quote.quoteCurrency quote.quotePerBase @insiderfinance/totalfinance/foreign-exchange/spot"},{"title":"NonDeliverableForwardValueInput","url":"/reference/totalfinance/foreign-exchange/page-2#NonDeliverableForwardValueInput","description":"Input for {@link nonDeliverableForwardValue}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  contractRate contractRate.baseCurrency contractRate.quoteCurrency contractRate.quotePerBase discountFactorToSettlement fixingRate fixingRate @insiderfinance/totalfinance/foreign-exchange/forwards"},{"title":"NonDeliverableForwardValueResult","url":"/reference/totalfinance/foreign-exchange/page-2#NonDeliverableForwardValueResult","description":"Result of {@link nonDeliverableForwardValue}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  assumptions assumptions.fixingSource assumptions.perspective assumptions.settlementConstraint assumptions.settlementCurrency assumptions.sig @insiderfinance/totalfinance/foreign-exchange/forwards"},{"title":"PipValueInput","url":"/reference/totalfinance/foreign-exchange/page-2#PipValueInput","description":"Input for {@link pipValue}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  notionalAmount notionalCurrency pipSize quote quote.baseCurrency quote.quoteCurrency quote.quotePerBase @insiderfinance/totalfinance/foreign-exchange/spot"},{"title":"PipValueResult","url":"/reference/totalfinance/foreign-exchange/page-2#PipValueResult","description":"Result of {@link pipValue}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  assumptions assumptions.baseConversion assumptions.notionalCurrency assumptions.notionalCurrencyRole assumptions.pipSize assumptions.pipSize @insiderfinance/totalfinance/foreign-exchange/spot"},{"title":"SpotForwardHedgedProfitAndLossInput","url":"/reference/totalfinance/foreign-exchange/page-2#SpotForwardHedgedProfitAndLossInput","description":"Input for {@link spotForwardHedgedProfitAndLoss}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  finalSpotRate finalSpotRate.baseCurrency finalSpotRate.quoteCurrency finalSpotRate.quotePerBase forwardRateAtHedge forwardRateAtHedge.baseCu @insiderfinance/totalfinance/foreign-exchange/risk"},{"title":"SpotForwardHedgedProfitAndLossResult","url":"/reference/totalfinance/foreign-exchange/page-2#SpotForwardHedgedProfitAndLossResult","description":"Result of {@link spotForwardHedgedProfitAndLoss}.","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"interface","keywords":"@insiderfinance/totalfinance/foreign-exchange interface  assumptions assumptions.decomposition assumptions.hedgedFraction assumptions.notionalDirection diagnostics diagnostics.warnings hedgedCompon @insiderfinance/totalfinance/foreign-exchange/risk"},{"title":"convertCurrency","url":"/reference/totalfinance/foreign-exchange/page-2#convertCurrency","description":"Convert an amount between two currencies at the supplied spot quote. The quote must connect the\ntwo currencies; when it is oriented the other way the conversion","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"function","keywords":"@insiderfinance/totalfinance/foreign-exchange function  (input) (input).amount (input).fromCurrency (input).spotRate (input).toCurrency return.assumptions return.assumptions.fromCurrency return.as @insiderfinance/totalfinance/foreign-exchange/spot"},{"title":"coveredInterestParityForward","url":"/reference/totalfinance/foreign-exchange/page-2#coveredInterestParityForward","description":"The no-arbitrage forward: `forward = spot × growthFactor(domestic) / growthFactor(foreign)`. The\nDOMESTIC rate is the QUOTE currency's rate and the FOREIGN rate","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"function","keywords":"@insiderfinance/totalfinance/foreign-exchange function  (input) (input).compounding (input).domesticAnnualRate (input).foreignAnnualRate (input).spotRate (input).timeYears return.assumptions retur @insiderfinance/totalfinance/foreign-exchange/forwards"},{"title":"crossRate","url":"/reference/totalfinance/foreign-exchange/page-2#crossRate","description":"Derive a cross pair through the ONE currency the two supplied quotes share (EUR/USD × USD/JPY →\nEUR/JPY). Every orientation case is handled by explicit inversio","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"function","keywords":"@insiderfinance/totalfinance/foreign-exchange function  (input) (input).crossBaseCurrency (input).crossQuoteCurrency (input).firstQuote (input).secondQuote return.assumptions return.assumptions.de @insiderfinance/totalfinance/foreign-exchange/spot"},{"title":"currencyExposure","url":"/reference/totalfinance/foreign-exchange/page-2#currencyExposure","description":"Aggregate positions into per-currency exposure in one declared base currency. Base-currency\npositions pass through unconverted; every other currency is restated","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"function","keywords":"@insiderfinance/totalfinance/foreign-exchange function  (input) (input).baseCurrency (input).positions (input).spotRates return.assumptions return.assumptions.baseCurrency return.assumptions.missi @insiderfinance/totalfinance/foreign-exchange/risk"},{"title":"foreignExchangeForwardPoints","url":"/reference/totalfinance/foreign-exchange/page-2#foreignExchangeForwardPoints","description":"Forward points: `(forward − spot) / pointSize`. Positive when the base currency trades at a\nforward premium. `pointSize` is always explicit — a symbol's spellin","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"function","keywords":"@insiderfinance/totalfinance/foreign-exchange function  (input) (input).forwardRate (input).pointSize (input).spotRate return.assumptions return.assumptions.formula return.assumptions.pointSize re @insiderfinance/totalfinance/foreign-exchange/forwards"},{"title":"foreignExchangeForwardValue","url":"/reference/totalfinance/foreign-exchange/page-2#foreignExchangeForwardValue","description":"Mark-to-market of an outstanding forward: `±(currentForward − contract) × notionalBase ×\ndiscountFactorToSettlement`, positive sign for `'buyer-of-base'`, negat","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"function","keywords":"@insiderfinance/totalfinance/foreign-exchange function  (input) (input).contractRate (input).currentForwardRate (input).discountFactorToSettlement (input).notionalBaseAmount (input).perspective re @insiderfinance/totalfinance/foreign-exchange/forwards"},{"title":"foreignExchangeSwapValue","url":"/reference/totalfinance/foreign-exchange/page-2#foreignExchangeSwapValue","description":"Value of a foreign-exchange swap as the sum of its two forward legs, each valued with\n{@link foreignExchangeForwardValue} (composed, not copied). Both legs must","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"function","keywords":"@insiderfinance/totalfinance/foreign-exchange function  (input) (input).farLeg (input).nearLeg return.assumptions return.assumptions.composition return.assumptions.farLegPerspective return.assumpt @insiderfinance/totalfinance/foreign-exchange/forwards"},{"title":"hedgeRatio","url":"/reference/totalfinance/foreign-exchange/page-3#hedgeRatio","description":"The simple hedge ratio: `hedgeNotionalBaseAmount / exposureBaseAmount`, both amounts echoed. A\nzero exposure has no ratio — the result is `null` with the reason","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"function","keywords":"@insiderfinance/totalfinance/foreign-exchange function  (input) (input).exposureBaseAmount (input).hedgeNotionalBaseAmount return.assumptions return.assumptions.definition return.assumptions.expos @insiderfinance/totalfinance/foreign-exchange/risk"},{"title":"invertCurrencyPairQuote","url":"/reference/totalfinance/foreign-exchange/page-3#invertCurrencyPairQuote","description":"Flip a quote's direction: EUR/USD 1.08 becomes USD/EUR 1/1.08. Inverting twice returns the\noriginal pair (the quote-direction identity, tested at 1e-12).","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"function","keywords":"@insiderfinance/totalfinance/foreign-exchange function  (input) (input).quote return.assumptions return.assumptions.inversion return.diagnostics return.quote @insiderfinance/totalfinance/foreign-exchange/spot"},{"title":"nonDeliverableForwardValue","url":"/reference/totalfinance/foreign-exchange/page-3#nonDeliverableForwardValue","description":"Cash-settled value of a non-deliverable forward at its OBSERVED fixing: `±(fixing − contract) ×\nnotionalBase × discountFactorToSettlement`, in the settlement cu","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"function","keywords":"@insiderfinance/totalfinance/foreign-exchange function  (input) (input).contractRate (input).discountFactorToSettlement (input).fixingRate (input).notionalBaseAmount (input).perspective (input).se @insiderfinance/totalfinance/foreign-exchange/forwards"},{"title":"pipValue","url":"/reference/totalfinance/foreign-exchange/page-3#pipValue","description":"Value of one pip for a position. A pip moves `quotePerBase` by `pipSize`, so a notional of `N`\nBASE units gains/loses `pipSize × N` quote-currency units per pip","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"function","keywords":"@insiderfinance/totalfinance/foreign-exchange function  (input) (input).notionalAmount (input).notionalCurrency (input).pipSize (input).quote return.assumptions return.assumptions.baseConversion r @insiderfinance/totalfinance/foreign-exchange/spot"},{"title":"requireCurrencyCode","url":"/reference/totalfinance/foreign-exchange/page-3#requireCurrencyCode","description":"Validate one currency-code field at a public boundary: a string matching `/^[A-Z]{3}$/`\n(uppercase three-letter ISO-4217 style). A lowercase spelling is answere","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"function","keywords":"@insiderfinance/totalfinance/foreign-exchange function  (field) (functionName) (value) @insiderfinance/totalfinance/foreign-exchange/spot"},{"title":"requireCurrencyPairQuote","url":"/reference/totalfinance/foreign-exchange/page-3#requireCurrencyPairQuote","description":"Validate a {@link CurrencyPairQuote} at a public boundary (Law 12 closed request): known keys,\ntwo DISTINCT uppercase currency codes, and a finite `quotePerBase","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"function","keywords":"@insiderfinance/totalfinance/foreign-exchange function  (functionName) (label) (quote) (quote).baseCurrency (quote).quoteCurrency (quote).quotePerBase @insiderfinance/totalfinance/foreign-exchange/spot"},{"title":"spotForwardHedgedProfitAndLoss","url":"/reference/totalfinance/foreign-exchange/page-3#spotForwardHedgedProfitAndLoss","description":"P&L of a base-currency position that hedged `hedgedFraction` of its notional at a forward. The\ndecomposition is exact and disclosed: the unhedged part rides the","category":"@insiderfinance/totalfinance/foreign-exchange","kind":"function","keywords":"@insiderfinance/totalfinance/foreign-exchange function  (input) (input).finalSpotRate (input).forwardRateAtHedge (input).hedgedFraction (input).initialSpotRate (input).notionalBaseAmount return.as @insiderfinance/totalfinance/foreign-exchange/risk"},{"title":"AltmanComponent","url":"/reference/totalfinance/fundamentals#AltmanComponent","description":"One Altman component.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  coefficient component contribution definition value @insiderfinance/totalfinance/fundamentals/scores"},{"title":"AltmanInput","url":"/reference/totalfinance/fundamentals#AltmanInput","description":"Input for {@link altmanZScore}.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  marketEquity statements statements.balance statements.balance.accountsPayable statements.balance.accountsReceivable statements.balance.cashA @insiderfinance/totalfinance/fundamentals/scores"},{"title":"AltmanResult","url":"/reference/totalfinance/fundamentals#AltmanResult","description":"Result of {@link altmanZScore}.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  assumptions assumptions.equityBasis assumptions.model assumptions.variant components diagnostics diagnostics.warnings variant zScore @insiderfinance/totalfinance/fundamentals/scores"},{"title":"AltmanVariant","url":"/reference/totalfinance/fundamentals#AltmanVariant","description":"The published Altman variants; each fixes its coefficients and its equity basis.","category":"@insiderfinance/totalfinance/fundamentals","kind":"type","keywords":"@insiderfinance/totalfinance/fundamentals type   @insiderfinance/totalfinance/fundamentals/scores"},{"title":"AnalyzeFundamentalsInput","url":"/reference/totalfinance/fundamentals#AnalyzeFundamentalsInput","description":"Input for {@link analyzeFundamentals}.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  altmanVariant asOf debtServiceAmount marketSnapshot marketSnapshot.marketCapitalization marketSnapshot.observedTimestampMs marketSnapshot.sh"},{"title":"AnalyzeFundamentalsResult","url":"/reference/totalfinance/fundamentals#AnalyzeFundamentalsResult","description":"Result of {@link analyzeFundamentals}.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  asOf assumptions assumptions.asOf assumptions.periodUsed assumptions.periodUsed.fiscalYear assumptions.periodUsed.periodEndDate assumptions."},{"title":"AnalyzedRatio","url":"/reference/totalfinance/fundamentals#AnalyzedRatio","description":"One computed (or explicitly not-computed) metric.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  reason value"},{"title":"BalanceSheet","url":"/reference/totalfinance/fundamentals#BalanceSheet","description":"One reported balance sheet (balances at `period.periodEndDate`).","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  accountsPayable accountsReceivable cashAndCashEquivalents currentAssets currentLiabilities inventory longTermDebt metadata minorityInterest  @insiderfinance/totalfinance/fundamentals/statements"},{"title":"BalanceSheetRatioInput","url":"/reference/totalfinance/fundamentals#BalanceSheetRatioInput","description":"Balance-only formulas: use the actual balance sheet or the existing complete set.","category":"@insiderfinance/totalfinance/fundamentals","kind":"type","keywords":"@insiderfinance/totalfinance/fundamentals type  balance balance.accountsPayable balance.accountsReceivable balance.cashAndCashEquivalents balance.currentAssets balance.currentLiabilities b @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"BeneishComponent","url":"/reference/totalfinance/fundamentals#BeneishComponent","description":"One Beneish component index.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  coefficient contribution currentPeriodEndDate expandedName index priorPeriodEndDate value @insiderfinance/totalfinance/fundamentals/scores"},{"title":"BeneishInput","url":"/reference/totalfinance/fundamentals#BeneishInput","description":"Input for {@link beneishMScore}: two consecutive periods.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  current current.balance current.balance.accountsPayable current.balance.accountsReceivable current.balance.cashAndCashEquivalents current.ba @insiderfinance/totalfinance/fundamentals/scores"},{"title":"BeneishResult","url":"/reference/totalfinance/fundamentals#BeneishResult","description":"Result of {@link beneishMScore}.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  assumptions assumptions.model components diagnostics diagnostics.warnings mScore notes @insiderfinance/totalfinance/fundamentals/scores"},{"title":"CashFlowStatement","url":"/reference/totalfinance/fundamentals#CashFlowStatement","description":"One reported cash-flow statement (flows over the period).","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  acquisitions capitalExpenditure depreciationAndAmortization dividendsPaid financingCashFlow investingCashFlow metadata operatingCashFlow per @insiderfinance/totalfinance/fundamentals/statements"},{"title":"CommonSizeInput","url":"/reference/totalfinance/fundamentals#CommonSizeInput","description":"Input for {@link commonSizeFinancialStatements}.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  statements statements.balance statements.balance.accountsPayable statements.balance.accountsReceivable statements.balance.cashAndCashEquival @insiderfinance/totalfinance/fundamentals/statements"},{"title":"CommonSizeResult","url":"/reference/totalfinance/fundamentals#CommonSizeResult","description":"Result of {@link commonSizeFinancialStatements}: each line as a FRACTION of its stated base.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  assumptions assumptions.balanceBasis assumptions.cashFlowBasis assumptions.incomeBasis balance balance.basis balance.lines cashFlow cashFlow @insiderfinance/totalfinance/fundamentals/statements"},{"title":"DayMetricRatioInput","url":"/reference/totalfinance/fundamentals#DayMetricRatioInput","description":"Day metrics: the pair plus the explicit period-day count (never guessed).","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  current current.balance current.balance.accountsPayable current.balance.accountsReceivable current.balance.cashAndCashEquivalents current.ba @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"DebtServiceCoverageInput","url":"/reference/totalfinance/fundamentals#DebtServiceCoverageInput","description":"Additive income-only coverage request; the existing extendable full-set interface is preserved.","category":"@insiderfinance/totalfinance/fundamentals","kind":"type","keywords":"@insiderfinance/totalfinance/fundamentals type   @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"DebtServiceRatioInput","url":"/reference/totalfinance/fundamentals#DebtServiceRatioInput","description":"Debt-service coverage: the exact supplied denominator.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  debtServiceAmount statements statements.balance statements.balance.accountsPayable statements.balance.accountsReceivable statements.balance. @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"EnterpriseMultipleRatioInput","url":"/reference/totalfinance/fundamentals#EnterpriseMultipleRatioInput","description":"Enterprise-value multiples: separately supplied non-operating assets.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  marketObservation marketObservation.marketCapitalization marketObservation.observedTimestampMs marketObservation.sharePrice marketObservatio @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"FinancialStatements","url":"/reference/totalfinance/fundamentals#FinancialStatements","description":"The three statements of ONE period. The periods must agree on their identity — end date, type,\ncurrency, and monetary scale — because every ratio that crosses s","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  balance balance.accountsPayable balance.accountsReceivable balance.cashAndCashEquivalents balance.currentAssets balance.currentLiabilities b @insiderfinance/totalfinance/fundamentals/statements"},{"title":"FundamentalGrowthInput","url":"/reference/totalfinance/fundamentals/page-2#FundamentalGrowthInput","description":"Input for {@link fundamentalGrowth}.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  observations @insiderfinance/totalfinance/fundamentals/statements"},{"title":"FundamentalGrowthResult","url":"/reference/totalfinance/fundamentals/page-2#FundamentalGrowthResult","description":"Result of {@link fundamentalGrowth} — the one analysis report grammar.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  assumptions assumptions.elapsedYearsBasis assumptions.observationCount compoundAnnualGrowthRate compoundAnnualGrowthReason diagnostics diagn @insiderfinance/totalfinance/fundamentals/statements"},{"title":"FundamentalPeriod","url":"/reference/totalfinance/fundamentals/page-2#FundamentalPeriod","description":"One reported fundamental period, point-in-time aware (FC0 — frozen).","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  accession availableTimestampMs currency filedTimestampMs fiscalQuarter fiscalYear form monetaryScale periodEndDate periodStartDate periodTyp"},{"title":"FundamentalSeries","url":"/reference/totalfinance/fundamentals/page-2#FundamentalSeries","description":"The full reported history of one entity, restatements included: ordered by period end ascending,\nwith a restatement appearing as a SECOND record for the same pe","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  entity statements @insiderfinance/totalfinance/fundamentals/statements"},{"title":"FundamentalSnapshot","url":"/reference/totalfinance/fundamentals/page-2#FundamentalSnapshot","description":"The point-in-time view of a series: exactly the statement sets an observer at `asOf` could have\nseen, one version per period under the stated restatement policy","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  asOf entity restatementPolicy statements @insiderfinance/totalfinance/fundamentals/statements"},{"title":"IncomeStatement","url":"/reference/totalfinance/fundamentals/page-2#IncomeStatement","description":"One reported income statement (flows over the period).","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  costOfRevenue dilutedSharesOutstanding grossProfit incomeFromContinuingOperations incomeTaxExpense interestExpense metadata netIncome operat @insiderfinance/totalfinance/fundamentals/statements"},{"title":"IncomeStatementRatioInput","url":"/reference/totalfinance/fundamentals/page-2#IncomeStatementRatioInput","description":"Income-only formulas: use the actual income statement or the existing complete set.","category":"@insiderfinance/totalfinance/fundamentals","kind":"type","keywords":"@insiderfinance/totalfinance/fundamentals type  income income.costOfRevenue income.dilutedSharesOutstanding income.grossProfit income.incomeFromContinuingOperations income.incomeTaxExpense @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"InvestedCapitalRatioInput","url":"/reference/totalfinance/fundamentals/page-2#InvestedCapitalRatioInput","description":"Return on invested capital: the pair plus an optional explicit tax rate.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  current current.balance current.balance.accountsPayable current.balance.accountsReceivable current.balance.cashAndCashEquivalents current.ba @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"MarketMultipleRatioInput","url":"/reference/totalfinance/fundamentals/page-2#MarketMultipleRatioInput","description":"Market multiples: the market side plus the optional freshness bound.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  marketObservation marketObservation.marketCapitalization marketObservation.observedTimestampMs marketObservation.sharePrice marketObservatio @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"MarketObservation","url":"/reference/totalfinance/fundamentals/page-2#MarketObservation","description":"The market side of a valuation multiple — a narrow structural view, not a market-data feed.\n`marketCapitalization` may be given directly or derived as `sharePri","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  marketCapitalization observedTimestampMs sharePrice sharesOutstanding @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"PairRatioInput","url":"/reference/totalfinance/fundamentals/page-2#PairRatioInput","description":"Average-balance heads: the period being measured and the immediately prior period.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  current current.balance current.balance.accountsPayable current.balance.accountsReceivable current.balance.cashAndCashEquivalents current.ba @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"PerShareFundamentalsInput","url":"/reference/totalfinance/fundamentals/page-2#PerShareFundamentalsInput","description":"Input for {@link perShareFundamentals}.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  splitFactorSincePeriod statements statements.balance statements.balance.accountsPayable statements.balance.accountsReceivable statements.bal @insiderfinance/totalfinance/fundamentals/statements"},{"title":"PerShareFundamentalsResult","url":"/reference/totalfinance/fundamentals/page-2#PerShareFundamentalsResult","description":"Result of {@link perShareFundamentals}.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  assumptions assumptions.dilutedSharesUsed assumptions.splitFactorSincePeriod assumptions.unitBasis bookValuePerShare diagnostics diagnostics @insiderfinance/totalfinance/fundamentals/statements"},{"title":"PiotroskiInput","url":"/reference/totalfinance/fundamentals/page-2#PiotroskiInput","description":"Input for {@link piotroskiFScore}: three consecutive periods of one entity.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  current current.balance current.balance.accountsPayable current.balance.accountsReceivable current.balance.cashAndCashEquivalents current.ba @insiderfinance/totalfinance/fundamentals/scores"},{"title":"PiotroskiResult","url":"/reference/totalfinance/fundamentals/page-2#PiotroskiResult","description":"Result of {@link piotroskiFScore}.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  assumptions assumptions.model assumptions.returnBasis diagnostics diagnostics.warnings evaluableSignals fScore signals @insiderfinance/totalfinance/fundamentals/scores"},{"title":"PiotroskiSignal","url":"/reference/totalfinance/fundamentals/page-2#PiotroskiSignal","description":"One of the nine binary signals.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  detail reason signal value @insiderfinance/totalfinance/fundamentals/scores"},{"title":"RatioCategory","url":"/reference/totalfinance/fundamentals/page-2#RatioCategory","description":"type from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"type","keywords":"@insiderfinance/totalfinance/fundamentals type   @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"RatioFacade","url":"/reference/totalfinance/fundamentals/page-2#RatioFacade","description":"A ratio head: plain value + `.explain`. The DECLARED input is the head's exact shape — the\ndeclaration never licenses a key the runtime refuses (the shared bag ","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  (input) explain explain().return.assumptions explain().return.assumptions.category explain().return.assumptions.conventionsVersion explain() @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"RatioInput","url":"/reference/totalfinance/fundamentals/page-2#RatioInput","description":"Common inputs a ratio head can declare.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  balance balance.accountsPayable balance.accountsReceivable balance.cashAndCashEquivalents balance.currentAssets balance.currentLiabilities b @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"RatioPeriodIdentity","url":"/reference/totalfinance/fundamentals/page-2#RatioPeriodIdentity","description":"The identity of the period a ratio was computed over.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  availableTimestampMs currency fiscalYear monetaryScale periodEndDate periodType @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"RatioReport","url":"/reference/totalfinance/fundamentals/page-3#RatioReport","description":"What `.explain()` returns for every ratio head — the ONE `Computed` envelope (dx §7.2).","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  assumptions assumptions.category assumptions.conventionsVersion assumptions.formula assumptions.period assumptions.period.availableTimestamp @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"ReconcileStatementsInput","url":"/reference/totalfinance/fundamentals/page-3#ReconcileStatementsInput","description":"Input for {@link reconcileFinancialStatements}.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  priorStatements priorStatements.balance priorStatements.balance.accountsPayable priorStatements.balance.accountsReceivable priorStatements.b @insiderfinance/totalfinance/fundamentals/statements"},{"title":"ReconciliationCheck","url":"/reference/totalfinance/fundamentals/page-3#ReconciliationCheck","description":"One accounting-identity check.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  detail difference name withinTolerance @insiderfinance/totalfinance/fundamentals/statements"},{"title":"ReconciliationResult","url":"/reference/totalfinance/fundamentals/page-3#ReconciliationResult","description":"Result of {@link reconcileFinancialStatements}.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  assumptions assumptions.toleranceAmount checks diagnostics diagnostics.warnings reconciles toleranceAmount @insiderfinance/totalfinance/fundamentals/statements"},{"title":"RestatementPolicy","url":"/reference/totalfinance/fundamentals/page-3#RestatementPolicy","description":"How {@link selectFundamentalSnapshot } resolves multiple visible versions of one period.","category":"@insiderfinance/totalfinance/fundamentals","kind":"type","keywords":"@insiderfinance/totalfinance/fundamentals type   @insiderfinance/totalfinance/fundamentals/statements"},{"title":"SelectFundamentalSnapshotInput","url":"/reference/totalfinance/fundamentals/page-3#SelectFundamentalSnapshotInput","description":"Input for {@link selectFundamentalSnapshot}.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  asOf restatementPolicy series series.entity series.statements @insiderfinance/totalfinance/fundamentals/statements"},{"title":"SingleStatementRatioInput","url":"/reference/totalfinance/fundamentals/page-3#SingleStatementRatioInput","description":"Single-period heads.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  statements statements.balance statements.balance.accountsPayable statements.balance.accountsReceivable statements.balance.cashAndCashEquival @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"TrailingTwelveMonthInput","url":"/reference/totalfinance/fundamentals/page-3#TrailingTwelveMonthInput","description":"Input for {@link trailingTwelveMonthStatements}.","category":"@insiderfinance/totalfinance/fundamentals","kind":"interface","keywords":"@insiderfinance/totalfinance/fundamentals interface  statements @insiderfinance/totalfinance/fundamentals/statements"},{"title":"accrualRatio","url":"/reference/totalfinance/fundamentals/page-3#accrualRatio","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).current (input).prior explain explain().return.assumptions explain().return.assumptions.category explain().return.assumption @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"altmanZScore","url":"/reference/totalfinance/fundamentals/page-3#altmanZScore","description":"The Altman Z-score with the published coefficients and denominator definitions per variant.\n`X1` working capital / assets, `X2` retained earnings / assets, `X3`","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).marketEquity (input).statements (input).variant return.assumptions return.assumptions.equityBasis return.assumptions.model r @insiderfinance/totalfinance/fundamentals/scores"},{"title":"analyzeFundamentals","url":"/reference/totalfinance/fundamentals/page-3#analyzeFundamentals","description":"The one-call analysis. Missing inputs disable exactly the metrics that need them, each with a\nstated reason; nothing is guessed, proxied, or silently skipped.","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).altmanVariant (input).asOf (input).debtServiceAmount (input).marketSnapshot (input).maximumStalenessMs (input).nonOperatingA"},{"title":"assetTurnover","url":"/reference/totalfinance/fundamentals/page-3#assetTurnover","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).current (input).prior explain explain().return.assumptions explain().return.assumptions.category explain().return.assumption @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"beneishMScore","url":"/reference/totalfinance/fundamentals/page-3#beneishMScore","description":"The original eight-variable 1999 Beneish equation\n`-4.84 + 0.920 DSRI + 0.528 GMI + 0.404 AQI + 0.892 SGI + 0.115 DEPI - 0.172 SGAI + 4.679 TATA\n- 0.327 LVGI`, ","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).current (input).prior return.assumptions return.assumptions.model return.components return.diagnostics return.diagnostics.wa @insiderfinance/totalfinance/fundamentals/scores"},{"title":"bookValuePerShare","url":"/reference/totalfinance/fundamentals/page-3#bookValuePerShare","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).statements explain explain().return.assumptions explain().return.assumptions.category explain().return.assumptions.conventio @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"cashConversionCycle","url":"/reference/totalfinance/fundamentals/page-3#cashConversionCycle","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).current (input).periodDays (input).prior explain explain().return.assumptions explain().return.assumptions.category explain( @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"cashFlowToNetIncome","url":"/reference/totalfinance/fundamentals/page-3#cashFlowToNetIncome","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).statements explain explain().return.assumptions explain().return.assumptions.category explain().return.assumptions.conventio @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"cashRatio","url":"/reference/totalfinance/fundamentals/page-3#cashRatio","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).balance (input).balance.accountsPayable (input).balance.accountsReceivable (input).balance.cashAndCashEquivalents (input).ba @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"cashReturnOnAssets","url":"/reference/totalfinance/fundamentals/page-3#cashReturnOnAssets","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).current (input).prior explain explain().return.assumptions explain().return.assumptions.category explain().return.assumption @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"commonSizeFinancialStatements","url":"/reference/totalfinance/fundamentals/page-3#commonSizeFinancialStatements","description":"Common-size statements: every reported numeric line divided by its conventional base — income\nand cash-flow lines by revenue, balance lines by total assets. Fra","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).statements return.assumptions return.assumptions.balanceBasis return.assumptions.cashFlowBasis return.assumptions.incomeBasi @insiderfinance/totalfinance/fundamentals/statements"},{"title":"currentRatio","url":"/reference/totalfinance/fundamentals/page-4#currentRatio","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).balance (input).balance.accountsPayable (input).balance.accountsReceivable (input).balance.cashAndCashEquivalents (input).ba @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"daysInventoryOutstanding","url":"/reference/totalfinance/fundamentals/page-4#daysInventoryOutstanding","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).current (input).periodDays (input).prior explain explain().return.assumptions explain().return.assumptions.category explain( @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"daysPayablesOutstanding","url":"/reference/totalfinance/fundamentals/page-4#daysPayablesOutstanding","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).current (input).periodDays (input).prior explain explain().return.assumptions explain().return.assumptions.category explain( @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"daysSalesOutstanding","url":"/reference/totalfinance/fundamentals/page-4#daysSalesOutstanding","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).current (input).periodDays (input).prior explain explain().return.assumptions explain().return.assumptions.category explain( @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"debtServiceCoverage","url":"/reference/totalfinance/fundamentals/page-4#debtServiceCoverage","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) explain explain().return.assumptions explain().return.assumptions.category explain().return.assumptions.conventionsVersion explain() @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"debtToAssets","url":"/reference/totalfinance/fundamentals/page-4#debtToAssets","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).balance (input).balance.accountsPayable (input).balance.accountsReceivable (input).balance.cashAndCashEquivalents (input).ba @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"debtToEquity","url":"/reference/totalfinance/fundamentals/page-4#debtToEquity","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).balance (input).balance.accountsPayable (input).balance.accountsReceivable (input).balance.cashAndCashEquivalents (input).ba @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"dividendYield","url":"/reference/totalfinance/fundamentals/page-4#dividendYield","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).marketObservation (input).maximumStalenessMs (input).statements explain explain().return.assumptions explain().return.assump @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"earningsPerShare","url":"/reference/totalfinance/fundamentals/page-4#earningsPerShare","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).income (input).income.costOfRevenue (input).income.dilutedSharesOutstanding (input).income.grossProfit (input).income.income @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"earningsYield","url":"/reference/totalfinance/fundamentals/page-4#earningsYield","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).marketObservation (input).maximumStalenessMs (input).statements explain explain().return.assumptions explain().return.assump @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"ebitdaMargin","url":"/reference/totalfinance/fundamentals/page-4#ebitdaMargin","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).statements explain explain().return.assumptions explain().return.assumptions.category explain().return.assumptions.conventio @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"enterpriseValueToEbitda","url":"/reference/totalfinance/fundamentals/page-4#enterpriseValueToEbitda","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).marketObservation (input).maximumStalenessMs (input).nonOperatingAssets (input).statements explain explain().return.assumpti @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"enterpriseValueToRevenue","url":"/reference/totalfinance/fundamentals/page-4#enterpriseValueToRevenue","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).marketObservation (input).maximumStalenessMs (input).nonOperatingAssets (input).statements explain explain().return.assumpti @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"freeCashFlowPerShare","url":"/reference/totalfinance/fundamentals/page-4#freeCashFlowPerShare","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).statements explain explain().return.assumptions explain().return.assumptions.category explain().return.assumptions.conventio @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"freeCashFlowYield","url":"/reference/totalfinance/fundamentals/page-4#freeCashFlowYield","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).marketObservation (input).maximumStalenessMs (input).statements explain explain().return.assumptions explain().return.assump @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"fundamentalGrowth","url":"/reference/totalfinance/fundamentals/page-4#fundamentalGrowth","description":"Period-over-period and compound annual growth of one fundamental amount.","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).observations return.assumptions return.assumptions.elapsedYearsBasis return.assumptions.observationCount return.compoundAnnu @insiderfinance/totalfinance/fundamentals/statements"},{"title":"grossMargin","url":"/reference/totalfinance/fundamentals/page-4#grossMargin","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).income (input).income.costOfRevenue (input).income.dilutedSharesOutstanding (input).income.grossProfit (input).income.income @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"interestCoverage","url":"/reference/totalfinance/fundamentals/page-4#interestCoverage","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).income (input).income.costOfRevenue (input).income.dilutedSharesOutstanding (input).income.grossProfit (input).income.income @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"inventoryTurnover","url":"/reference/totalfinance/fundamentals/page-4#inventoryTurnover","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).current (input).prior explain explain().return.assumptions explain().return.assumptions.category explain().return.assumption @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"isPeriodAvailableAt","url":"/reference/totalfinance/fundamentals/page-4#isPeriodAvailableAt","description":"Point-in-time eligibility: whether `period` was AVAILABLE to an observer at `asOf` (epoch ms).\n`availableTimestampMs`, not `periodEndDate`, controls eligibility","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (asOf) (period) (period).accession (period).availableTimestampMs (period).currency (period).filedTimestampMs (period).fiscalQuarter (period)"},{"title":"netDebtToEbitda","url":"/reference/totalfinance/fundamentals/page-5#netDebtToEbitda","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).statements explain explain().return.assumptions explain().return.assumptions.category explain().return.assumptions.conventio @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"netProfitMargin","url":"/reference/totalfinance/fundamentals/page-5#netProfitMargin","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).income (input).income.costOfRevenue (input).income.dilutedSharesOutstanding (input).income.grossProfit (input).income.income @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"operatingMargin","url":"/reference/totalfinance/fundamentals/page-5#operatingMargin","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).income (input).income.costOfRevenue (input).income.dilutedSharesOutstanding (input).income.grossProfit (input).income.income @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"payablesTurnover","url":"/reference/totalfinance/fundamentals/page-5#payablesTurnover","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).current (input).prior explain explain().return.assumptions explain().return.assumptions.category explain().return.assumption @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"perShareFundamentals","url":"/reference/totalfinance/fundamentals/page-5#perShareFundamentals","description":"Split-aware per-share normalization: the period's diluted shares are multiplied by the supplied\ncumulative split factor so a pre-split period and a post-split o","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).splitFactorSincePeriod (input).statements return.assumptions return.assumptions.dilutedSharesUsed return.assumptions.splitFa @insiderfinance/totalfinance/fundamentals/statements"},{"title":"piotroskiFScore","url":"/reference/totalfinance/fundamentals/page-5#piotroskiFScore","description":"The standard nine binary signals, per the paper: profitability (return on beginning assets,\noperating cash flow, their improvement, accruals), leverage/liquidit","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).current (input).prior (input).priorPrior return.assumptions return.assumptions.model return.assumptions.returnBasis return.d @insiderfinance/totalfinance/fundamentals/scores"},{"title":"priceToBook","url":"/reference/totalfinance/fundamentals/page-5#priceToBook","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).marketObservation (input).maximumStalenessMs (input).statements explain explain().return.assumptions explain().return.assump @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"priceToEarnings","url":"/reference/totalfinance/fundamentals/page-5#priceToEarnings","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).marketObservation (input).maximumStalenessMs (input).statements explain explain().return.assumptions explain().return.assump @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"priceToSales","url":"/reference/totalfinance/fundamentals/page-5#priceToSales","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).marketObservation (input).maximumStalenessMs (input).statements explain explain().return.assumptions explain().return.assump @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"quickRatio","url":"/reference/totalfinance/fundamentals/page-5#quickRatio","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).balance (input).balance.accountsPayable (input).balance.accountsReceivable (input).balance.cashAndCashEquivalents (input).ba @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"receivablesTurnover","url":"/reference/totalfinance/fundamentals/page-5#receivablesTurnover","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).current (input).prior explain explain().return.assumptions explain().return.assumptions.category explain().return.assumption @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"reconcileFinancialStatements","url":"/reference/totalfinance/fundamentals/page-5#reconcileFinancialStatements","description":"Accounting-identity diagnostics: the balance-sheet identity, gross-profit articulation,\ncurrent-versus-total containment, and — with the prior period — cash art","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).priorStatements (input).statements (input).toleranceAmount return.assumptions return.assumptions.toleranceAmount return.chec @insiderfinance/totalfinance/fundamentals/statements"},{"title":"requireBalanceSheet","url":"/reference/totalfinance/fundamentals/page-5#requireBalanceSheet","description":"Validate one {@link BalanceSheet} at a public boundary.","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (balance) (balance).accountsPayable (balance).accountsReceivable (balance).cashAndCashEquivalents (balance).currentAssets (balance).currentL @insiderfinance/totalfinance/fundamentals/statements"},{"title":"requireCashFlowStatement","url":"/reference/totalfinance/fundamentals/page-5#requireCashFlowStatement","description":"Validate one {@link CashFlowStatement} at a public boundary.","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (cashFlow) (cashFlow).acquisitions (cashFlow).capitalExpenditure (cashFlow).depreciationAndAmortization (cashFlow).dividendsPaid (cashFlow). @insiderfinance/totalfinance/fundamentals/statements"},{"title":"requireFinancialStatements","url":"/reference/totalfinance/fundamentals/page-5#requireFinancialStatements","description":"Validate a {@link FinancialStatements} set: each statement, then the identity agreement — the\nthree periods must share `periodEndDate`, `periodType`, `currency`","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (functionName) (statements) (statements).balance (statements).cashFlow (statements).income @insiderfinance/totalfinance/fundamentals/statements"},{"title":"requireFundamentalPeriod","url":"/reference/totalfinance/fundamentals/page-5#requireFundamentalPeriod","description":"Validate a {@link FundamentalPeriod} at a public boundary (Law 12 closed request): presence,\ntypes, the strict date grammar, the literal domains, and the orderi","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (functionName) (period) (period).accession (period).availableTimestampMs (period).currency (period).filedTimestampMs (period).fiscalQuarter "},{"title":"requireIncomeStatement","url":"/reference/totalfinance/fundamentals/page-5#requireIncomeStatement","description":"Validate one {@link IncomeStatement} at a public boundary.","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (functionName) (income) (income).costOfRevenue (income).dilutedSharesOutstanding (income).grossProfit (income).incomeFromContinuingOperation @insiderfinance/totalfinance/fundamentals/statements"},{"title":"requireMarketObservation","url":"/reference/totalfinance/fundamentals/page-5#requireMarketObservation","description":"Validate a {@link MarketObservation} at a public boundary.","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (functionName) (observation) (observation).marketCapitalization (observation).observedTimestampMs (observation).sharePrice (observation).sha @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"returnOnAssets","url":"/reference/totalfinance/fundamentals/page-5#returnOnAssets","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).current (input).prior explain explain().return.assumptions explain().return.assumptions.category explain().return.assumption @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"returnOnCapitalEmployed","url":"/reference/totalfinance/fundamentals/page-5#returnOnCapitalEmployed","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).current (input).prior explain explain().return.assumptions explain().return.assumptions.category explain().return.assumption @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"returnOnEquity","url":"/reference/totalfinance/fundamentals/page-6#returnOnEquity","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).current (input).prior explain explain().return.assumptions explain().return.assumptions.category explain().return.assumption @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"returnOnInvestedCapital","url":"/reference/totalfinance/fundamentals/page-6#returnOnInvestedCapital","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).current (input).prior (input).taxRate explain explain().return.assumptions explain().return.assumptions.category explain().r @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"revenuePerShare","url":"/reference/totalfinance/fundamentals/page-6#revenuePerShare","description":"function from @insiderfinance/totalfinance/fundamentals","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).income (input).income.costOfRevenue (input).income.dilutedSharesOutstanding (input).income.grossProfit (input).income.income @insiderfinance/totalfinance/fundamentals/ratios"},{"title":"selectFundamentalSnapshot","url":"/reference/totalfinance/fundamentals/page-6#selectFundamentalSnapshot","description":"The point-in-time view of a series: availability-gated by `statementsAvailableTimestampMs` (never\nby period end), then resolved to ONE version per (periodType, ","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).asOf (input).restatementPolicy (input).series return.asOf return.entity return.restatementPolicy return.statements @insiderfinance/totalfinance/fundamentals/statements"},{"title":"statementsAvailableTimestampMs","url":"/reference/totalfinance/fundamentals/page-6#statementsAvailableTimestampMs","description":"The point-in-time availability of a statement SET: the latest of the three statements'\n`availableTimestampMs` — a set is visible only when every statement in it","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (statements) (statements).balance (statements).cashFlow (statements).income @insiderfinance/totalfinance/fundamentals/statements"},{"title":"trailingTwelveMonthStatements","url":"/reference/totalfinance/fundamentals/page-6#trailingTwelveMonthStatements","description":"Compose four consecutive fiscal quarters into one trailing-twelve-months set: income and\ncash-flow FLOWS sum; BALANCES are the latest quarter's (a balance is a ","category":"@insiderfinance/totalfinance/fundamentals","kind":"function","keywords":"@insiderfinance/totalfinance/fundamentals function  (input) (input).statements return.balance return.cashFlow return.income @insiderfinance/totalfinance/fundamentals/statements"},{"title":"LocalHttpServer","url":"/reference/totalfinance/http#LocalHttpServer","description":"interface from @insiderfinance/totalfinance/http","category":"@insiderfinance/totalfinance/http","kind":"interface","keywords":"@insiderfinance/totalfinance/http interface  address address().return.host address().return.port address().return.url document document.components document.components.schemas document.c"},{"title":"LocalHttpServerBudgets","url":"/reference/totalfinance/http#LocalHttpServerBudgets","description":"interface from @insiderfinance/totalfinance/http","category":"@insiderfinance/totalfinance/http","kind":"interface","keywords":"@insiderfinance/totalfinance/http interface  deadlineMs defaultSeed inlineResultBytes maxInputBytes"},{"title":"LocalHttpServerInput","url":"/reference/totalfinance/http#LocalHttpServerInput","description":"interface from @insiderfinance/totalfinance/http","category":"@insiderfinance/totalfinance/http","kind":"interface","keywords":"@insiderfinance/totalfinance/http interface  allowNonLoopback artifacts artifacts.get artifacts.get().return.handle artifacts.get().return.value artifacts.get(uri) artifacts.list artifa"},{"title":"OpenApiDocument","url":"/reference/totalfinance/http#OpenApiDocument","description":"The subset of OpenAPI 3.1 this document uses — enough to be typed, validated, and diffed.","category":"@insiderfinance/totalfinance/http","kind":"interface","keywords":"@insiderfinance/totalfinance/http interface  components components.schemas components.securitySchemes info info.description info.title info.version openapi paths servers"},{"title":"OpenApiDocumentInput","url":"/reference/totalfinance/http#OpenApiDocumentInput","description":"interface from @insiderfinance/totalfinance/http","category":"@insiderfinance/totalfinance/http","kind":"interface","keywords":"@insiderfinance/totalfinance/http interface  registry registry.describe registry.describe().return.annotations registry.describe().return.authorization registry.describe().return.costCl"},{"title":"createLocalHttpServer","url":"/reference/totalfinance/http#createLocalHttpServer","description":"Create the server (not yet listening).","category":"@insiderfinance/totalfinance/http","kind":"function","keywords":"@insiderfinance/totalfinance/http function  (rawInput) (rawInput).allowNonLoopback (rawInput).artifacts (rawInput).artifacts.get (rawInput).artifacts.list (rawInput).artifacts.put (raw"},{"title":"openApiDocument","url":"/reference/totalfinance/http#openApiDocument","description":"Generate the OpenAPI 3.1 document for a registry.","category":"@insiderfinance/totalfinance/http","kind":"function","keywords":"@insiderfinance/totalfinance/http function  (input) (input).registry (input).serverUrl return.components return.components.schemas return.components.securitySchemes return.info return."},{"title":"statusForError","url":"/reference/totalfinance/http#statusForError","description":"HTTP status for an OperationError (Decision 7).","category":"@insiderfinance/totalfinance/http","kind":"function","keywords":"@insiderfinance/totalfinance/http function  (error) (error).code (error).context (error).issues (error).message (error).operation (error).operation.id (error).operation.version"},{"title":"AdaptiveSimpsonOptions","url":"/reference/totalfinance/math#AdaptiveSimpsonOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  maxDepth maxEvaluations tolerance @insiderfinance/totalfinance/math/integration"},{"title":"AdaptiveSimpsonResult","url":"/reference/totalfinance/math#AdaptiveSimpsonResult","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  converged deepestLevel value @insiderfinance/totalfinance/math/integration"},{"title":"AugmentedDickeyFullerOptions","url":"/reference/totalfinance/math#AugmentedDickeyFullerOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  lags regression @insiderfinance/totalfinance/math/timeseries"},{"title":"AxisOptions","url":"/reference/totalfinance/math#AxisOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  aggregate assumeSorted extrapolate @insiderfinance/totalfinance/math/interpolation"},{"title":"BootstrapOptions","url":"/reference/totalfinance/math#BootstrapOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  iterations seed @insiderfinance/totalfinance/math/random"},{"title":"BootstrapResult","url":"/reference/totalfinance/math#BootstrapResult","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  confidenceInterval95 estimates iterations mean seed standardDeviation @insiderfinance/totalfinance/math/random"},{"title":"Bracket","url":"/reference/totalfinance/math#Bracket","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  found iterations lowerBound objectiveAtLowerBound objectiveAtUpperBound upperBound @insiderfinance/totalfinance/math/solvers"},{"title":"BracketExpandOptions","url":"/reference/totalfinance/math#BracketExpandOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  factor maximumIterations @insiderfinance/totalfinance/math/solvers"},{"title":"Complex","url":"/reference/totalfinance/math#Complex","description":"A complex number `re + im·i`.","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  im re @insiderfinance/totalfinance/math/linalg"},{"title":"CovarianceEstimate","url":"/reference/totalfinance/math#CovarianceEstimate","description":"A well-conditioned covariance estimate plus its conditioning diagnostics.","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  assumptions assumptions.conventionsVersion assumptions.marketProxy assumptions.method assumptions.population conditionNumber covariance diag @insiderfinance/totalfinance/math/linalg"},{"title":"CovarianceMethod","url":"/reference/totalfinance/math#CovarianceMethod","description":"Covariance estimator selector for {@link estimateCovariance}.","category":"@insiderfinance/totalfinance/math","kind":"type","keywords":"@insiderfinance/totalfinance/math type   @insiderfinance/totalfinance/math/linalg"},{"title":"Derivatives","url":"/reference/totalfinance/math#Derivatives","description":"First through third derivatives at a point, for derivative-based solvers.","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  d2f d3f df f @insiderfinance/totalfinance/math/solvers"},{"title":"DifferentialEvolutionOptions","url":"/reference/totalfinance/math#DifferentialEvolutionOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  crossover maxGenerations mutation populationSize seed tolerance @insiderfinance/totalfinance/math/optimize"},{"title":"EigenResult","url":"/reference/totalfinance/math#EigenResult","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  values vectors @insiderfinance/totalfinance/math/linalg"},{"title":"EngleGrangerResult","url":"/reference/totalfinance/math#EngleGrangerResult","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  alpha beta cointegrated residualAugmentedDickeyFuller residualAugmentedDickeyFuller.criticalValues residualAugmentedDickeyFuller.criticalVal @insiderfinance/totalfinance/math/timeseries"},{"title":"EstimateCovarianceOptions","url":"/reference/totalfinance/math#EstimateCovarianceOptions","description":"Options for {@link estimateCovariance}.","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  conditionThreshold halfLife lambda ledoitWolfTarget market method population ridge @insiderfinance/totalfinance/math/linalg"},{"title":"ExtrapolationPolicy","url":"/reference/totalfinance/math#ExtrapolationPolicy","description":"type from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"type","keywords":"@insiderfinance/totalfinance/math type   @insiderfinance/totalfinance/math/interpolation"},{"title":"FunctionWithDerivatives","url":"/reference/totalfinance/math#FunctionWithDerivatives","description":"type from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"type","keywords":"@insiderfinance/totalfinance/math type  (x) return.d2f return.d3f return.df return.f @insiderfinance/totalfinance/math/solvers"},{"title":"GeneralEigenResult","url":"/reference/totalfinance/math#GeneralEigenResult","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  values vectors @insiderfinance/totalfinance/math/linalg"},{"title":"InterpolateOptions","url":"/reference/totalfinance/math#InterpolateOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  extrapolate @insiderfinance/totalfinance/math/interpolation"},{"title":"KalmanFilterResult","url":"/reference/totalfinance/math/page-2#KalmanFilterResult","description":"Forward-pass (filter) output. All arrays are length `T`, aligned to the observation sequence.","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  filteredCovariances filteredStates innovationCovariances innovations logLikelihood observationDimension observedCount predictedCovariances p @insiderfinance/totalfinance/math/filters"},{"title":"KalmanModel","url":"/reference/totalfinance/math/page-2#KalmanModel","description":"Linear-Gaussian state-space parameters. `n` = state dimension, `m` = observation dimension.","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  F H P0 Q R x0 @insiderfinance/totalfinance/math/filters"},{"title":"KalmanObservation","url":"/reference/totalfinance/math/page-2#KalmanObservation","description":"A single observation: an `m`-vector, a bare number (only when `m = 1`), or `null` / a vector\ncontaining `NaN` to mark a MISSING observation (that step predicts ","category":"@insiderfinance/totalfinance/math","kind":"type","keywords":"@insiderfinance/totalfinance/math type   @insiderfinance/totalfinance/math/filters"},{"title":"KalmanSmoothResult","url":"/reference/totalfinance/math/page-2#KalmanSmoothResult","description":"RTS-smoother output — the filter result plus the backward-smoothed estimates.","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  filteredCovariances filteredStates innovationCovariances innovations logLikelihood observationDimension observedCount predictedCovariances p @insiderfinance/totalfinance/math/filters"},{"title":"KpssOptions","url":"/reference/totalfinance/math/page-2#KpssOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  regression @insiderfinance/totalfinance/math/timeseries"},{"title":"KurtosisOptions","url":"/reference/totalfinance/math/page-2#KurtosisOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  excess nanPolicy @insiderfinance/totalfinance/math/statistics"},{"title":"LMOptions","url":"/reference/totalfinance/math/page-2#LMOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  lambda0 maximumIterations tolerance @insiderfinance/totalfinance/math/optimize"},{"title":"LedoitWolfOptions","url":"/reference/totalfinance/math/page-2#LedoitWolfOptions","description":"Options for {@link ledoitWolfShrinkage}.","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  market target @insiderfinance/totalfinance/math/linalg"},{"title":"LedoitWolfResult","url":"/reference/totalfinance/math/page-2#LedoitWolfResult","description":"The Ledoit–Wolf shrunk covariance and the intensity that produced it.","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  averageCorrelation averageVariance covariance marketVariance observations sampleCovariance shrinkage target @insiderfinance/totalfinance/math/linalg"},{"title":"LevenbergMarquardtResult","url":"/reference/totalfinance/math/page-2#LevenbergMarquardtResult","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  converged evaluations iterations parameters reason residualNorm @insiderfinance/totalfinance/math/optimize"},{"title":"LjungBoxOptions","url":"/reference/totalfinance/math/page-2#LjungBoxOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  fittedParameterCount @insiderfinance/totalfinance/math/timeseries"},{"title":"LuResult","url":"/reference/totalfinance/math/page-2#LuResult","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  lu pivotIndices sign @insiderfinance/totalfinance/math/linalg"},{"title":"Matrix","url":"/reference/totalfinance/math/page-2#Matrix","description":"type from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"type","keywords":"@insiderfinance/totalfinance/math type   @insiderfinance/totalfinance/math/linalg"},{"title":"MedianAbsoluteDeviationOptions","url":"/reference/totalfinance/math/page-2#MedianAbsoluteDeviationOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  nanPolicy scale @insiderfinance/totalfinance/math/statistics"},{"title":"MinOptions","url":"/reference/totalfinance/math/page-2#MinOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  maximumIterations tolerance @insiderfinance/totalfinance/math/optimize"},{"title":"MinResult","url":"/reference/totalfinance/math/page-2#MinResult","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  argMin converged evaluations iterations minimum reason @insiderfinance/totalfinance/math/optimize"},{"title":"MonteCarloOptions","url":"/reference/totalfinance/math/page-2#MonteCarloOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  confidence minPaths paths randomNumberGenerator randomNumberGenerator().return.getState randomNumberGenerator().return.next randomNumberGene @insiderfinance/totalfinance/math/montecarlo"},{"title":"MonteCarloResult","url":"/reference/totalfinance/math/page-2#MonteCarloResult","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  confidenceInterval converged paths seed standardError value variance @insiderfinance/totalfinance/math/montecarlo"},{"title":"MultiMinOptions","url":"/reference/totalfinance/math/page-2#MultiMinOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  grad grad(point) maximumIterations tolerance @insiderfinance/totalfinance/math/optimize"},{"title":"MultiMinResult","url":"/reference/totalfinance/math/page-2#MultiMinResult","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  argMin converged evaluations iterations minimum reason seed @insiderfinance/totalfinance/math/optimize"},{"title":"MultivariateFunction","url":"/reference/totalfinance/math/page-3#MultivariateFunction","description":"type from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"type","keywords":"@insiderfinance/totalfinance/math type  (x) @insiderfinance/totalfinance/math/optimize"},{"title":"NanPolicy","url":"/reference/totalfinance/math/page-3#NanPolicy","description":"type from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"type","keywords":"@insiderfinance/totalfinance/math type   @insiderfinance/totalfinance/math/statistics"},{"title":"OlsHacOptions","url":"/reference/totalfinance/math/page-3#OlsHacOptions","description":"Newey–West HAC configuration: Bartlett-kernel bandwidth (number of lags).","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  lags @insiderfinance/totalfinance/math/regression"},{"title":"OlsOptions","url":"/reference/totalfinance/math/page-3#OlsOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  hac hac.lags intercept @insiderfinance/totalfinance/math/regression"},{"title":"OlsResult","url":"/reference/totalfinance/math/page-3#OlsResult","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  adjustedRSquared coefficientCount coefficients observationCount rSquared residuals standardErrors tStatistics @insiderfinance/totalfinance/math/regression"},{"title":"PopulationOptions","url":"/reference/totalfinance/math/page-3#PopulationOptions","description":"The estimator choice alone — the whole contract of the rolling family and `covarianceMatrix`.","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  population @insiderfinance/totalfinance/math/statistics"},{"title":"QrResult","url":"/reference/totalfinance/math/page-3#QrResult","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  q r @insiderfinance/totalfinance/math/linalg"},{"title":"RandomNumberGenerator","url":"/reference/totalfinance/math/page-3#RandomNumberGenerator","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  getState getState().return.algorithm getState().return.seed getState().return.state next seed @insiderfinance/totalfinance/math/random"},{"title":"RandomNumberGeneratorState","url":"/reference/totalfinance/math/page-3#RandomNumberGeneratorState","description":"Serializable PRNG state — restore an RNG mid-stream with `restoreRandomNumberGenerator`.\n\nA DISCRIMINATED UNION, because `algorithm: string` with `state: number","category":"@insiderfinance/totalfinance/math","kind":"type","keywords":"@insiderfinance/totalfinance/math type  algorithm seed state @insiderfinance/totalfinance/math/random"},{"title":"RootProblem","url":"/reference/totalfinance/math/page-3#RootProblem","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  lowerBound objective objective(x) upperBound @insiderfinance/totalfinance/math/solvers"},{"title":"SOBOL_MAX_DIMENSIONS","url":"/reference/totalfinance/math/page-3#SOBOL_MAX_DIMENSIONS","description":"value from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"value","keywords":"@insiderfinance/totalfinance/math value   @insiderfinance/totalfinance/math/lowdiscrepancy"},{"title":"ScalarFunction","url":"/reference/totalfinance/math/page-3#ScalarFunction","description":"type from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"type","keywords":"@insiderfinance/totalfinance/math type  (x) @insiderfinance/totalfinance/math/solvers"},{"title":"SolverFailureReason","url":"/reference/totalfinance/math/page-3#SolverFailureReason","description":"type from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"type","keywords":"@insiderfinance/totalfinance/math type   @insiderfinance/totalfinance/math/solvers"},{"title":"SolverOptions","url":"/reference/totalfinance/math/page-3#SolverOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  maximumIterations residualTolerance stepTolerance tolerance @insiderfinance/totalfinance/math/solvers"},{"title":"SolverResult","url":"/reference/totalfinance/math/page-3#SolverResult","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  bracket converged iterations method reason residual value @insiderfinance/totalfinance/math/solvers"},{"title":"StatisticsOptions","url":"/reference/totalfinance/math/page-3#StatisticsOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  nanPolicy @insiderfinance/totalfinance/math/statistics"},{"title":"SvdResult","url":"/reference/totalfinance/math/page-3#SvdResult","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  s u v @insiderfinance/totalfinance/math/linalg"},{"title":"TestResult","url":"/reference/totalfinance/math/page-3#TestResult","description":"Uniform result shape for every hypothesis test in this module.","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  criticalValues criticalValues.1% criticalValues.10% criticalValues.5% method pValue statistic @insiderfinance/totalfinance/math/timeseries"},{"title":"VarianceOptions","url":"/reference/totalfinance/math/page-3#VarianceOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  nanPolicy population @insiderfinance/totalfinance/math/statistics"},{"title":"WinsorizeOptions","url":"/reference/totalfinance/math/page-3#WinsorizeOptions","description":"interface from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"interface","keywords":"@insiderfinance/totalfinance/math interface  lower nanPolicy upper @insiderfinance/totalfinance/math/statistics"},{"title":"acf","url":"/reference/totalfinance/math/page-4#acf","description":"Sample autocorrelation function through `maxLag`, using the biased (÷N) estimator that guarantees a\npositive-semidefinite sequence. Returns `[1, ρ₁, …, ρ_maxLag","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (maxLag) (series) @insiderfinance/totalfinance/math/timeseries"},{"title":"adaptiveSimpson","url":"/reference/totalfinance/math/page-4#adaptiveSimpson","description":"Adaptive Simpson integration of `f` on `[a, b]` to the requested tolerance. Throws\n`ConvergenceError` (`integration.max_depth`) if the depth budget is exhausted","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (integrand) (lowerBound) (options) (options).maxDepth (options).maxEvaluations (options).tolerance (upperBound) @insiderfinance/totalfinance/math/integration"},{"title":"adaptiveSimpsonSafe","url":"/reference/totalfinance/math/page-4#adaptiveSimpsonSafe","description":"Adaptive Simpson integration returning diagnostics instead of throwing. The tolerance is HALVED at\neach recursion level so the total error stays bounded by `tol","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (integrand) (lowerBound) (options) (options).maxDepth (options).maxEvaluations (options).tolerance (upperBound) return.converged return.deep @insiderfinance/totalfinance/math/integration"},{"title":"antitheticSampler","url":"/reference/totalfinance/math/page-4#antitheticSampler","description":"Wrap a payoff over a standard-normal vector into an antithetic sampler: each path evaluates the\npayoff at `Z` and `-Z` and averages, reducing variance for monot","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (dimensions) (payoff) @insiderfinance/totalfinance/math/montecarlo"},{"title":"augmentedDickeyFullerTest","url":"/reference/totalfinance/math/page-4#augmentedDickeyFullerTest","description":"Augmented Dickey–Fuller test for a unit root. Regresses `Δyₜ` on `y_{t−1}`, a constant (and a trend\nfor `'ct'`), and `lags` lagged differences; the statistic is","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).lags (options).regression (series) return.criticalValues return.criticalValues.1% return.criticalValues.10% return.criti @insiderfinance/totalfinance/math/timeseries"},{"title":"bfgs","url":"/reference/totalfinance/math/page-4#bfgs","description":"BFGS quasi-Newton minimization with a backtracking (Armijo) line search.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (objective) (options) (options).grad (options).maximumIterations (options).tolerance (start) return.argMin return.converged return.evaluatio @insiderfinance/totalfinance/math/optimize"},{"title":"bicubicInterp","url":"/reference/totalfinance/math/page-4#bicubicInterp","description":"Bicubic interpolation at a single `(x, y)` (see {@link makeBicubicInterpolator}).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (x) (xs) (y) (ys) (z) @insiderfinance/totalfinance/math/interpolation"},{"title":"bilinearInterp","url":"/reference/totalfinance/math/page-4#bilinearInterp","description":"Bilinear interpolation on a grid. `z[i][j]` is the value at `(xs[i], ys[j])`. Clamps to the grid\nedges outside the domain.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (x) (xs) (y) (ys) (z) @insiderfinance/totalfinance/math/interpolation"},{"title":"bisection","url":"/reference/totalfinance/math/page-4#bisection","description":"function from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (a0) (b0) (objective) (options) (options).maximumIterations (options).residualTolerance (options).stepTolerance (options).tolerance return.b @insiderfinance/totalfinance/math/solvers"},{"title":"bivariateNormalCdf","url":"/reference/totalfinance/math/page-4#bivariateNormalCdf","description":"Cumulative bivariate normal: P(X ≤ a, Y ≤ b) where (X, Y) is standard bivariate normal with\ncorrelation `rho ∈ [-1, 1]`. Returns `NaN` if any argument is `NaN` ","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (a) (b) (rho) @insiderfinance/totalfinance/math/bivariate"},{"title":"bootstrap","url":"/reference/totalfinance/math/page-4#bootstrap","description":"Nonparametric bootstrap: resample `data` with replacement `iterations` times, apply `statistic`,\nand summarize the distribution of the estimate. Deterministic g","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (data) (options) (options).iterations (options).seed (statistic) return.confidenceInterval95 return.estimates return.iterations return.mean  @insiderfinance/totalfinance/math/random"},{"title":"bracketExpand","url":"/reference/totalfinance/math/page-4#bracketExpand","description":"Expand an initial interval outward until it brackets a sign change.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (a0) (b0) (objective) (options) (options).factor (options).maximumIterations return.found return.iterations return.lowerBound return.objecti @insiderfinance/totalfinance/math/solvers"},{"title":"brent","url":"/reference/totalfinance/math/page-4#brent","description":"Brent's method: inverse-quadratic / secant interpolation with a bisection safeguard. The robust\ndefault root solver.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (a0) (b0) (objective) (options) (options).maximumIterations (options).residualTolerance (options).stepTolerance (options).tolerance return.b @insiderfinance/totalfinance/math/solvers"},{"title":"brentMin","url":"/reference/totalfinance/math/page-4#brentMin","description":"Brent's method for 1-D minimization (parabolic interpolation with a golden-section safeguard).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (a0) (b0) (objective) (options) (options).maximumIterations (options).tolerance return.argMin return.converged return.evaluations return.ite @insiderfinance/totalfinance/math/optimize"},{"title":"brownianBridge","url":"/reference/totalfinance/math/page-4#brownianBridge","description":"Brownian-bridge path construction on a uniform grid of `n` steps of size `stepSize` (a DIMENSIONLESS\ngrid spacing — callers building a unit grid pass `1` and sc","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (normals) (stepSize) @insiderfinance/totalfinance/math/montecarlo"},{"title":"chiSquare","url":"/reference/totalfinance/math/page-4#chiSquare","description":"The chi-square distribution with `df` degrees of freedom (`df > 0`) — gamma(k = df/2, θ = 2).","category":"@insiderfinance/totalfinance/math","kind":"value","keywords":"@insiderfinance/totalfinance/math value  cdf cdf(degreesOfFreedom) cdf(x) inverseCdf inverseCdf(degreesOfFreedom) inverseCdf(probability) @insiderfinance/totalfinance/math/distributions"},{"title":"cholesky","url":"/reference/totalfinance/math/page-4#cholesky","description":"Cholesky factorization: lower-triangular `L` with `A = L Lᵀ`. Throws if `A` is not PD.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (matrix) @insiderfinance/totalfinance/math/linalg"},{"title":"choleskySolve","url":"/reference/totalfinance/math/page-4#choleskySolve","description":"Solve `A x = b` given the Cholesky factor `L` of `A`.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (L) (b) @insiderfinance/totalfinance/math/linalg"},{"title":"controlVariateEstimate","url":"/reference/totalfinance/math/page-4#controlVariateEstimate","description":"Control-variate adjusted estimate: `E[Y] ≈ Ȳ − c·(X̄ − E[X])`, with `c = cov(Y,X)/var(X)`.\n`samples` are the target outputs, `controls` the control outputs, `co","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (controlMean) (controls) (samples) @insiderfinance/totalfinance/math/montecarlo"},{"title":"correlatedNormalSampler","url":"/reference/totalfinance/math/page-4#correlatedNormalSampler","description":"Build a sampler of correlated standard normals from a covariance/correlation matrix (via Cholesky).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (covarianceOrCorrelation) @insiderfinance/totalfinance/math/montecarlo"},{"title":"correlation","url":"/reference/totalfinance/math/page-5#correlation","description":"Pearson correlation coefficient. Throws on unequal lengths.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).nanPolicy (xs) (ys) @insiderfinance/totalfinance/math/statistics"},{"title":"covariance","url":"/reference/totalfinance/math/page-5#covariance","description":"Covariance of two equal-length series (sample by default). Throws on unequal lengths.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).nanPolicy (options).population (xs) (ys) @insiderfinance/totalfinance/math/statistics"},{"title":"covarianceMatrix","url":"/reference/totalfinance/math/page-5#covarianceMatrix","description":"Covariance matrix of a set of equal-length variables (`series[k]` is variable k).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).population (series) @insiderfinance/totalfinance/math/linalg"},{"title":"determinant","url":"/reference/totalfinance/math/page-5#determinant","description":"Determinant via LU; returns 0 for a singular matrix instead of throwing.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (matrix) @insiderfinance/totalfinance/math/linalg"},{"title":"differentialEvolution","url":"/reference/totalfinance/math/page-5#differentialEvolution","description":"Differential evolution (Storn–Price `rand/1/bin`): a seeded, bound-constrained **global** optimizer\nfor multimodal objectives the local methods (Nelder–Mead/BFG","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (bounds) (objective) (options) (options).crossover (options).maxGenerations (options).mutation (options).populationSize (options).seed (opti @insiderfinance/totalfinance/math/optimize"},{"title":"eigen","url":"/reference/totalfinance/math/page-5#eigen","description":"Eigenvalues and (for real eigenvalues) eigenvectors of a general real matrix. Eigenvalues come from\nthe Francis QR algorithm ({@link eigenvalues}); each real ei","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (matrix) return.values return.vectors @insiderfinance/totalfinance/math/linalg"},{"title":"eigenvalues","url":"/reference/totalfinance/math/page-5#eigenvalues","description":"Eigenvalues of a general real matrix via the **Francis double-shift QR** algorithm on its Hessenberg\nform (the EISPACK/JAMA `hqr2` reduction to real Schur form)","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (matrix) @insiderfinance/totalfinance/math/linalg"},{"title":"engleGranger","url":"/reference/totalfinance/math/page-5#engleGranger","description":"Engle–Granger two-step cointegration test. Step 1 regresses `y` on `x` (with intercept); step 2 runs\nan ADF test on the residuals. Because the residuals are est","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (dependent) (independent) return.alpha return.beta return.cointegrated return.residualAugmentedDickeyFuller @insiderfinance/totalfinance/math/timeseries"},{"title":"estimateCovariance","url":"/reference/totalfinance/math/page-5#estimateCovariance","description":"The covariance-estimation front door: turn a returns matrix into a well-conditioned (usually\ninvertible) covariance and report its **conditioning** so a caller ","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).conditionThreshold (options).halfLife (options).lambda (options).ledoitWolfTarget (options).market (options).method (opt @insiderfinance/totalfinance/math/linalg"},{"title":"findRoot","url":"/reference/totalfinance/math/page-5#findRoot","description":"Safe hybrid solver: expand a bracket if needed, then run Brent. Kept as a named entrypoint so\ncallers express intent (\"give me the robust default\").","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (lowerBound) (objective) (options) (options).maximumIterations (options).residualTolerance (options).stepTolerance (options).tolerance (uppe @insiderfinance/totalfinance/math/solvers"},{"title":"gamma","url":"/reference/totalfinance/math/page-5#gamma","description":"The gamma distribution with shape `k > 0` and scale `θ > 0` (default `θ = 1`).","category":"@insiderfinance/totalfinance/math","kind":"value","keywords":"@insiderfinance/totalfinance/math value  cdf cdf(shape) cdf(theta) cdf(x) inverseCdf inverseCdf(probability) inverseCdf(shape) inverseCdf(theta) @insiderfinance/totalfinance/math/distributions"},{"title":"gaussLegendre","url":"/reference/totalfinance/math/page-5#gaussLegendre","description":"Gauss–Legendre integration of `f` on `[a, b]` using `n` points (default 10).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (integrand) (lowerBound) (nodeCount) (upperBound) @insiderfinance/totalfinance/math/integration"},{"title":"gaussLegendreNodes","url":"/reference/totalfinance/math/page-5#gaussLegendreNodes","description":"Gauss–Legendre nodes and weights on `[-1, 1]` for `n` points, as a FRESH pair of arrays.\n\nThe rule is computed once per order and memoized, but the cached array","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (nodeCount) return.nodes return.weights @insiderfinance/totalfinance/math/integration"},{"title":"goldenSectionMin","url":"/reference/totalfinance/math/page-5#goldenSectionMin","description":"function from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (lowerBound) (objective) (options) (options).maximumIterations (options).tolerance (upperBound) return.argMin return.converged return.evalua @insiderfinance/totalfinance/math/optimize"},{"title":"halley","url":"/reference/totalfinance/math/page-5#halley","description":"Halley's method (cubic convergence). `objective` returns `{ f, df, d2f }`.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (objective) (options) (options).maximumIterations (options).residualTolerance (options).stepTolerance (options).tolerance (x0) return.bracke @insiderfinance/totalfinance/math/solvers"},{"title":"haltonPoint","url":"/reference/totalfinance/math/page-5#haltonPoint","description":"Halton point at `index` in `dimensions` dimensions.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (dimensions) (index) @insiderfinance/totalfinance/math/lowdiscrepancy"},{"title":"haltonSequence","url":"/reference/totalfinance/math/page-5#haltonSequence","description":"Halton sequence of `n` points in `dimensions` dimensions, starting at `start` (default 1, skips origin).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (count) (dimensions) (options) (options).start @insiderfinance/totalfinance/math/lowdiscrepancy"},{"title":"householder","url":"/reference/totalfinance/math/page-5#householder","description":"Householder's method of order 3 (quartic convergence). `objective` returns `{ f, df, d2f, d3f }`.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (objective) (options) (options).maximumIterations (options).residualTolerance (options).stepTolerance (options).tolerance (x0) return.bracke @insiderfinance/totalfinance/math/solvers"},{"title":"hurstExponent","url":"/reference/totalfinance/math/page-5#hurstExponent","description":"Hurst exponent via rescaled-range (R/S) analysis. For a geometric progression of window sizes the\nmean rescaled range `⟨R/S⟩ₙ` scales as `nᴴ`; `H` is the slope ","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (series) @insiderfinance/totalfinance/math/timeseries"},{"title":"identity","url":"/reference/totalfinance/math/page-5#identity","description":"The `n × n` identity matrix.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (size) @insiderfinance/totalfinance/math/linalg"},{"title":"jacobiEigen","url":"/reference/totalfinance/math/page-6#jacobiEigen","description":"Symmetric eigendecomposition via cyclic Jacobi rotations. The tolerance is RELATIVE to the input's\noff-diagonal Frobenius norm, so a matrix scaled by any consta","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (input) (options) (options).maximumIterations (options).tolerance return.values return.vectors @insiderfinance/totalfinance/math/linalg"},{"title":"kalmanFilter","url":"/reference/totalfinance/math/page-6#kalmanFilter","description":"Run the forward Kalman recursion over `observations`. Each step predicts `xₜ|ₜ₋₁` from the previous\nfiltered state, then (when the observation is present) updat","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (model) (model).F (model).H (model).P0 (model).Q (model).R (model).x0 (observations) return.filteredCovariances return.filteredStates return @insiderfinance/totalfinance/math/filters"},{"title":"kalmanLogLikelihood","url":"/reference/totalfinance/math/page-6#kalmanLogLikelihood","description":"The Gaussian log-likelihood of `observations` under `model` — the innovation-form likelihood from\nthe forward pass. This is the objective to maximise when calib","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (model) (model).F (model).H (model).P0 (model).Q (model).R (model).x0 (observations) @insiderfinance/totalfinance/math/filters"},{"title":"kalmanSmooth","url":"/reference/totalfinance/math/page-6#kalmanSmooth","description":"Rauch–Tung–Striebel fixed-interval smoother. Runs the forward filter, then a backward pass giving\n`xₜ|T` / `Pₜ|T` — the state estimates conditioned on the WHOLE","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (model) (model).F (model).H (model).P0 (model).Q (model).R (model).x0 (observations) return.filteredCovariances return.filteredStates return @insiderfinance/totalfinance/math/filters"},{"title":"kpssTest","url":"/reference/totalfinance/math/page-6#kpssTest","description":"Kwiatkowski–Phillips–Schmidt–Shin (KPSS) stationarity test. The null is (level or trend)\nstationarity, so a LARGE statistic (above the critical value) rejects s","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).regression (series) return.criticalValues return.criticalValues.1% return.criticalValues.10% return.criticalValues.5% re @insiderfinance/totalfinance/math/timeseries"},{"title":"kurtosis","url":"/reference/totalfinance/math/page-6#kurtosis","description":"Population kurtosis; excess (−3) by default.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).excess (options).nanPolicy (xs) @insiderfinance/totalfinance/math/statistics"},{"title":"ledoitWolfShrinkage","url":"/reference/totalfinance/math/page-6#ledoitWolfShrinkage","description":"function from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).market (options).target (series) return.averageCorrelation return.averageVariance return.covariance return.marketVarianc @insiderfinance/totalfinance/math/linalg"},{"title":"levenbergMarquardt","url":"/reference/totalfinance/math/page-6#levenbergMarquardt","description":"Levenberg–Marquardt least-squares minimization of `||residuals(parameters)||²`.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).lambda0 (options).maximumIterations (options).tolerance (p0) (residuals) return.converged return.evaluations return.iter @insiderfinance/totalfinance/math/optimize"},{"title":"lgamma","url":"/reference/totalfinance/math/page-6#lgamma","description":"Natural log of the gamma function, `ln Γ(x)`, via the Lanczos approximation (g = 7, 9 coefficients),\naccurate to ~1e-15 for `x > 0`. Uses the reflection formula","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (x) @insiderfinance/totalfinance/math/distributions"},{"title":"linearInterp","url":"/reference/totalfinance/math/page-6#linearInterp","description":"Interpolate `y` at `x` over the points `(xs[i], ys[i])`.\n\nTRUSTED FAST PATH: `xs` MUST be strictly ascending and the same length as `ys` — this function\ndoes no","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).extrapolate (x) (xs) (ys) @insiderfinance/totalfinance/math/interpolation"},{"title":"ljungBox","url":"/reference/totalfinance/math/page-6#ljungBox","description":"Ljung–Box portmanteau test for autocorrelation up to `lags`:\n`Q = N(N+2) Σ_{k=1}^{h} ρ̂ₖ² / (N−k)`, distributed `χ²(h)` under the white-noise null. The p-value ","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (lags) (options) (options).fittedParameterCount (series) return.criticalValues return.criticalValues.1% return.criticalValues.10% return.cri @insiderfinance/totalfinance/math/timeseries"},{"title":"luDecompose","url":"/reference/totalfinance/math/page-6#luDecompose","description":"LU decomposition with partial pivoting: `P·A = L·U`. Throws on a singular matrix.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (matrix) return.lu return.pivotIndices return.sign @insiderfinance/totalfinance/math/linalg"},{"title":"luSolve","url":"/reference/totalfinance/math/page-6#luSolve","description":"Solve `A·x = b` from a precomputed {@link luDecompose} result.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (b) (result) (result).lu (result).pivotIndices (result).sign @insiderfinance/totalfinance/math/linalg"},{"title":"makeBicubicInterpolator","url":"/reference/totalfinance/math/page-6#makeBicubicInterpolator","description":"Build a reusable **bicubic** interpolator over a regular grid `z[i][j] = f(xs[i], ys[j])` — a smooth\ntensor-product natural cubic spline (C² in both axes). One ","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (xs) (ys) (z) @insiderfinance/totalfinance/math/interpolation"},{"title":"makeLinearInterpolator","url":"/reference/totalfinance/math/page-6#makeLinearInterpolator","description":"Build a reusable linear interpolator over fixed points (validates the axis by default).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (xs) (ys) @insiderfinance/totalfinance/math/interpolation"},{"title":"makeNaturalCubicSpline","url":"/reference/totalfinance/math/page-6#makeNaturalCubicSpline","description":"Build a natural cubic spline interpolator (second derivative zero at both ends).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).aggregate (options).assumeSorted (options).extrapolate (xs) (ys) @insiderfinance/totalfinance/math/interpolation"},{"title":"makePchipInterpolator","url":"/reference/totalfinance/math/page-6#makePchipInterpolator","description":"Build a PCHIP (monotone cubic Hermite) interpolator — shape-preserving, no overshoot.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).aggregate (options).assumeSorted (options).extrapolate (xs) (ys) @insiderfinance/totalfinance/math/interpolation"},{"title":"matrixMultiply","url":"/reference/totalfinance/math/page-6#matrixMultiply","description":"Matrix product `A (m×k) · B (k×n)` → `m×n`. Throws on a dimension mismatch.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (left) (right) @insiderfinance/totalfinance/math/linalg"},{"title":"matrixVectorProduct","url":"/reference/totalfinance/math/page-6#matrixVectorProduct","description":"Matrix–vector product `A (m×n) · x (n)` → `m`.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (matrix) (vector) @insiderfinance/totalfinance/math/linalg"},{"title":"max","url":"/reference/totalfinance/math/page-6#max","description":"function from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).nanPolicy (xs) @insiderfinance/totalfinance/math/statistics"},{"title":"mean","url":"/reference/totalfinance/math/page-7#mean","description":"function from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).nanPolicy (xs) @insiderfinance/totalfinance/math/statistics"},{"title":"median","url":"/reference/totalfinance/math/page-7#median","description":"function from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).nanPolicy (xs) @insiderfinance/totalfinance/math/statistics"},{"title":"medianAbsoluteDeviation","url":"/reference/totalfinance/math/page-7#medianAbsoluteDeviation","description":"Median absolute deviation.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).nanPolicy (options).scale (xs) @insiderfinance/totalfinance/math/statistics"},{"title":"min","url":"/reference/totalfinance/math/page-7#min","description":"function from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).nanPolicy (xs) @insiderfinance/totalfinance/math/statistics"},{"title":"monteCarlo","url":"/reference/totalfinance/math/page-7#monteCarlo","description":"function from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).confidence (options).minPaths (options).paths (options).randomNumberGenerator (options).seed (options).targetStandardErr @insiderfinance/totalfinance/math/montecarlo"},{"title":"mulberry32","url":"/reference/totalfinance/math/page-7#mulberry32","description":"Mulberry32 — a small, fast, well-distributed seedable PRNG.\n\nThe state is seeded with `seed >>> 0` (the algorithm is 32-bit), but the ECHOED `seed` is the\ncalle","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (seed) return.getState return.next return.seed @insiderfinance/totalfinance/math/random"},{"title":"nearestCorrelation","url":"/reference/totalfinance/math/page-7#nearestCorrelation","description":"A valid correlation matrix near `matrix`: ONE eigenvalue-clipping pass to PSD ({@link nearestPsd}),\nthen a rescale to a unit diagonal.\n\nNot the Frobenius-NEARES","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (matrix) @insiderfinance/totalfinance/math/linalg"},{"title":"nearestPsd","url":"/reference/totalfinance/math/page-7#nearestPsd","description":"Nearest positive-semidefinite matrix (eigenvalue clipping).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (matrix) @insiderfinance/totalfinance/math/linalg"},{"title":"nelderMead","url":"/reference/totalfinance/math/page-7#nelderMead","description":"Nelder–Mead simplex minimization (derivative-free).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (objective) (options) (options).grad (options).maximumIterations (options).tolerance (start) return.argMin return.converged return.evaluatio @insiderfinance/totalfinance/math/optimize"},{"title":"newton","url":"/reference/totalfinance/math/page-7#newton","description":"Newton–Raphson. `objective` returns `{ f, df }`.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (objective) (options) (options).maximumIterations (options).residualTolerance (options).stepTolerance (options).tolerance (x0) return.bracke @insiderfinance/totalfinance/math/solvers"},{"title":"normal","url":"/reference/totalfinance/math/page-7#normal","description":"Convenience namespace mirroring the spec's `normal.pdf/cdf/inverseCdf` facade.","category":"@insiderfinance/totalfinance/math","kind":"value","keywords":"@insiderfinance/totalfinance/math value  cdf cdf(x) inverseCdf inverseCdf(probability) logCdf logCdf(x) logPdf logPdf(x) logSurvivalFunction logSurvivalFunction(x) pdf pdf(x) surviv @insiderfinance/totalfinance/math/normal"},{"title":"normalCdf","url":"/reference/totalfinance/math/page-7#normalCdf","description":"Standard normal cumulative distribution function Φ(x).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (x) @insiderfinance/totalfinance/math/normal"},{"title":"normalInverseCdf","url":"/reference/totalfinance/math/page-7#normalInverseCdf","description":"Inverse standard normal CDF (quantile function). Returns `-Infinity` at p<=0 and `+Infinity` at\np>=1.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (probability) @insiderfinance/totalfinance/math/normal"},{"title":"normalLogCdf","url":"/reference/totalfinance/math/page-7#normalLogCdf","description":"Log of the standard normal CDF, stable into the far-left tail (where Φ(x) underflows to 0).\nUses `log(Φ(x))` for `x ≥ -20` and the asymptotic expansion\n`Φ(x) = ","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (x) @insiderfinance/totalfinance/math/normal"},{"title":"normalLogPdf","url":"/reference/totalfinance/math/page-7#normalLogPdf","description":"Log of the standard normal PDF — exact and stable everywhere.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (x) @insiderfinance/totalfinance/math/normal"},{"title":"normalLogSurvivalFunction","url":"/reference/totalfinance/math/page-7#normalLogSurvivalFunction","description":"Log of the standard normal survival function (stable in the far-right tail).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (x) @insiderfinance/totalfinance/math/normal"},{"title":"normalPdf","url":"/reference/totalfinance/math/page-7#normalPdf","description":"Standard normal probability density function φ(x).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (x) @insiderfinance/totalfinance/math/normal"},{"title":"normalSample","url":"/reference/totalfinance/math/page-7#normalSample","description":"function from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (mu) (randomNumberGenerator) (randomNumberGenerator).getState (randomNumberGenerator).next (randomNumberGenerator).seed (sigma) @insiderfinance/totalfinance/math/random"},{"title":"normalSurvivalFunction","url":"/reference/totalfinance/math/page-7#normalSurvivalFunction","description":"Standard normal survival function: 1 − Φ(x) = Φ(−x) (stable in the right tail).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (x) @insiderfinance/totalfinance/math/normal"},{"title":"ols","url":"/reference/totalfinance/math/page-7#ols","description":"Ordinary least squares fit of `y` on `X` (rows = observations, columns = predictors, no intercept\ncolumn). Returns coefficients, standard errors, t-statistics, ","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function y Response vector, length `n`. X Design rows, `n × p` (predictors only; the intercept is added unles (design) (options) (options).hac (options).intercept (response) return.adjustedRSquared return.coefficientCount return.coefficients return.o @insiderfinance/totalfinance/math/regression"},{"title":"ouHalfLife","url":"/reference/totalfinance/math/page-8#ouHalfLife","description":"Half-life of mean reversion from an AR(1) fit `xₜ = a + b·x_{t−1} + εₜ`:\n`halfLife = −ln 2 / ln b`. Defined (positive) only for a mean-reverting series with `0 ","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (series) @insiderfinance/totalfinance/math/timeseries"},{"title":"pacf","url":"/reference/totalfinance/math/page-8#pacf","description":"Partial autocorrelation function through `maxLag` via the Durbin–Levinson recursion on the sample\nACF. Returns `[1, φ₁₁, …, φ_maxLag,maxLag]` (index 0 = 1 by co","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (maxLag) (series) @insiderfinance/totalfinance/math/timeseries"},{"title":"pseudoInverse","url":"/reference/totalfinance/math/page-8#pseudoInverse","description":"Moore–Penrose pseudoinverse `A⁺` via SVD (singular values below `rcond·σ_max` are dropped).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (matrix) (options) (options).rcond @insiderfinance/totalfinance/math/linalg"},{"title":"qrDecompose","url":"/reference/totalfinance/math/page-8#qrDecompose","description":"Householder QR of an `m × n` matrix (`m ≥ n`): `A = Q·R`, `Q` thin with orthonormal columns.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (matrix) return.q return.r @insiderfinance/totalfinance/math/linalg"},{"title":"qrSolve","url":"/reference/totalfinance/math/page-8#qrSolve","description":"Least-squares solve of `A·x ≈ b` (`m ≥ n`) via QR back-substitution.\n\nRejects a rank-deficient (numerically singular) system rather than silently returning zero","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (b) (matrix) (options) (options).rcond @insiderfinance/totalfinance/math/linalg"},{"title":"quantile","url":"/reference/totalfinance/math/page-8#quantile","description":"Quantile via the type-7 (linear interpolation of order statistics) method — the default used by\nNumPy and R. `p` is in [0, 1].","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).nanPolicy (probability) (xs) @insiderfinance/totalfinance/math/statistics"},{"title":"regularizedBeta","url":"/reference/totalfinance/math/page-8#regularizedBeta","description":"Regularized incomplete beta `Iₓ(a, b)` — exported primitive behind the Student-t CDF.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (a) (b) (x) @insiderfinance/totalfinance/math/distributions"},{"title":"regularizedGammaP","url":"/reference/totalfinance/math/page-8#regularizedGammaP","description":"Regularized lower incomplete gamma `P(a, x)` — exported for callers (e.g. the chi-square survival\nused by Ljung–Box) that want the primitive directly rather tha","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (a) (x) @insiderfinance/totalfinance/math/distributions"},{"title":"restoreRandomNumberGenerator","url":"/reference/totalfinance/math/page-8#restoreRandomNumberGenerator","description":"Restore an RNG from a serialized state snapshot. Rejects malformed snapshots (no silent degeneracy).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (snapshot) (snapshot).algorithm (snapshot).seed (snapshot).state return.getState return.next return.seed @insiderfinance/totalfinance/math/random"},{"title":"ridder","url":"/reference/totalfinance/math/page-8#ridder","description":"Ridder's method: exponential interpolation on a sign-changing bracket. Often beats bisection.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (a0) (b0) (objective) (options) (options).maximumIterations (options).residualTolerance (options).stepTolerance (options).tolerance return.b @insiderfinance/totalfinance/math/solvers"},{"title":"rollingCorrelation","url":"/reference/totalfinance/math/page-8#rollingCorrelation","description":"Rolling Pearson correlation over a window. Aligned with `NaN` warmup.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (window) (xs) (ys) @insiderfinance/totalfinance/math/statistics"},{"title":"rollingCovariance","url":"/reference/totalfinance/math/page-8#rollingCovariance","description":"Rolling covariance over a window. Aligned with `NaN` warmup. Takes {@link PopulationOptions} for\nthe same reason as {@link rollingStandardDeviation}.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).population (window) (xs) (ys) @insiderfinance/totalfinance/math/statistics"},{"title":"rollingMean","url":"/reference/totalfinance/math/page-8#rollingMean","description":"Rolling mean. Output length equals input; the first `window-1` values are `NaN`. A window holding\na non-finite value — or whose own sum overflows — is reported ","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (window) (xs) @insiderfinance/totalfinance/math/statistics"},{"title":"rollingStandardDeviation","url":"/reference/totalfinance/math/page-8#rollingStandardDeviation","description":"Rolling standard deviation (sample by default). Aligned with `NaN` warmup. Takes\n{@link PopulationOptions}, not `VarianceOptions`: the rolling family has no `na","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).population (window) (xs) @insiderfinance/totalfinance/math/statistics"},{"title":"secant","url":"/reference/totalfinance/math/page-8#secant","description":"Secant method from two starting points. Fast but not bracketed.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (objective) (options) (options).maximumIterations (options).residualTolerance (options).stepTolerance (options).tolerance (x0) (x1) return.b @insiderfinance/totalfinance/math/solvers"},{"title":"skewness","url":"/reference/totalfinance/math/page-8#skewness","description":"Population skewness (third standardized moment).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).nanPolicy (xs) @insiderfinance/totalfinance/math/statistics"},{"title":"sobolSequence","url":"/reference/totalfinance/math/page-8#sobolSequence","description":"Sobol sequence of `n` points in `dimensions` dimensions (indices `0..n-1`; index 0 is the origin). The\nfirst `2^m` points form a regular `(0, m, dim)`-net.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (count) (dimensions) @insiderfinance/totalfinance/math/lowdiscrepancy"},{"title":"solveAll","url":"/reference/totalfinance/math/page-8#solveAll","description":"Solve a batch of bracketed root problems, returning one diagnostic-carrying result per row.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).maximumIterations (options).residualTolerance (options).stepTolerance (options).tolerance (problems) @insiderfinance/totalfinance/math/solvers"},{"title":"standardDeviation","url":"/reference/totalfinance/math/page-8#standardDeviation","description":"function from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).nanPolicy (options).population (xs) @insiderfinance/totalfinance/math/statistics"},{"title":"stratifiedUniforms","url":"/reference/totalfinance/math/page-8#stratifiedUniforms","description":"`n` stratified uniforms — one sample in each stratum `[i/n, (i+1)/n)`.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (count) (randomNumberGenerator) (randomNumberGenerator).getState (randomNumberGenerator).next (randomNumberGenerator).seed @insiderfinance/totalfinance/math/montecarlo"},{"title":"studentT","url":"/reference/totalfinance/math/page-9#studentT","description":"Student's t-distribution with `df` degrees of freedom (`df > 0`, need not be an integer).","category":"@insiderfinance/totalfinance/math","kind":"value","keywords":"@insiderfinance/totalfinance/math value  cdf cdf(degreesOfFreedom) cdf(x) inverseCdf inverseCdf(degreesOfFreedom) inverseCdf(probability) pdf pdf(degreesOfFreedom) pdf(x) survivalFu @insiderfinance/totalfinance/math/distributions"},{"title":"sum","url":"/reference/totalfinance/math/page-9#sum","description":"Kahan-compensated sum — minimizes rounding error over long series.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).nanPolicy (xs) @insiderfinance/totalfinance/math/statistics"},{"title":"svd","url":"/reference/totalfinance/math/page-9#svd","description":"Thin singular value decomposition `A = U·diag(s)·Vᵀ` via the one-sided Jacobi (Hestenes) method —\naccurate and dependency-free for the small matrices TotalFinan","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (matrix) (options) (options).maxSweeps (options).tolerance return.s return.u return.v @insiderfinance/totalfinance/math/linalg"},{"title":"transpose","url":"/reference/totalfinance/math/page-9#transpose","description":"Transpose of an `m × n` matrix → `n × m`.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (matrix) @insiderfinance/totalfinance/math/linalg"},{"title":"trimmedMean","url":"/reference/totalfinance/math/page-9#trimmedMean","description":"Trimmed mean: drop `fraction` of the data from each tail, then average the rest.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).fraction (options).nanPolicy (xs) @insiderfinance/totalfinance/math/statistics"},{"title":"uniformSamples","url":"/reference/totalfinance/math/page-9#uniformSamples","description":"Fill a typed array with uniform [0, 1) samples.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (count) (randomNumberGenerator) (randomNumberGenerator).getState (randomNumberGenerator).next (randomNumberGenerator).seed @insiderfinance/totalfinance/math/random"},{"title":"validateInterpolationData","url":"/reference/totalfinance/math/page-9#validateInterpolationData","description":"function from @insiderfinance/totalfinance/math","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).aggregate (options).assumeSorted (options).extrapolate (xs) (ys) return.xs return.ys @insiderfinance/totalfinance/math/interpolation"},{"title":"variance","url":"/reference/totalfinance/math/page-9#variance","description":"Two-pass variance (stable under large constant offsets).","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).nanPolicy (options).population (xs) @insiderfinance/totalfinance/math/statistics"},{"title":"welfordVariance","url":"/reference/totalfinance/math/page-9#welfordVariance","description":"Online (Welford) variance — single pass, numerically stable. Equivalent to `variance`.","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).nanPolicy (options).population (xs) @insiderfinance/totalfinance/math/statistics"},{"title":"winsorize","url":"/reference/totalfinance/math/page-9#winsorize","description":"Winsorize: clip values beyond the lower/upper quantiles to those quantiles. Returns a new array.\nUnder `propagate`, a NaN anywhere yields an all-NaN array of th","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (options) (options).lower (options).nanPolicy (options).upper (xs) @insiderfinance/totalfinance/math/statistics"},{"title":"xoshiro128ss","url":"/reference/totalfinance/math/page-9#xoshiro128ss","description":"xoshiro128** — a higher-quality seedable PRNG (longer period, better statistical properties).\nAs with {@link mulberry32}, the state is derived from `seed >>> 0`","category":"@insiderfinance/totalfinance/math","kind":"function","keywords":"@insiderfinance/totalfinance/math function  (seed) return.getState return.next return.seed @insiderfinance/totalfinance/math/random"},{"title":"TrimmedMeanOptions","url":"/reference/totalfinance/math/statistics#TrimmedMeanOptions","description":"interface from @insiderfinance/totalfinance/math/statistics","category":"@insiderfinance/totalfinance/math/statistics","kind":"interface","keywords":"@insiderfinance/totalfinance/math/statistics interface  fraction nanPolicy"},{"title":"AmericanExerciseInput","url":"/reference/totalfinance/options#AmericanExerciseInput","description":"One cohesive request for American exercise analysis.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash contract.deliverable.notes contract.deliverable."},{"title":"AmericanExerciseOptions","url":"/reference/totalfinance/options#AmericanExerciseOptions","description":"Options for {@link americanExercise}.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  boundaryPoints"},{"title":"AmericanExerciseResult","url":"/reference/totalfinance/options#AmericanExerciseResult","description":"The American exercise analysis.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  american assumptions assumptions.conventionsVersion assumptions.dividendModel assumptions.timeToExpiryYears assumptions.valueEngine boundary"},{"title":"AmericanImpliedVolatilityInput","url":"/reference/totalfinance/options#AmericanImpliedVolatilityInput","description":"One cohesive request for American implied-volatility inversion.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash contract.deliverable.notes contract.deliverable."},{"title":"AmericanImpliedVolatilityOptions","url":"/reference/totalfinance/options#AmericanImpliedVolatilityOptions","description":"Options for {@link americanImpliedVolatility}. Mirrors the subset of `ImpliedVolatilityOptions` it honours.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  engine engine.capabilities engine.capabilities.deterministic engine.capabilities.dividends engine.capabilities.extendedGreeks engine.capabil"},{"title":"AsianInput","url":"/reference/totalfinance/options#AsianInput","description":"Inputs for the exact discrete geometric-average Asian price.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  averagingPoints dividendYield riskFreeRate spot strike timeToExpiryYears volatility @insiderfinance/totalfinance/options/exotics"},{"title":"AsianMonteCarloInput","url":"/reference/totalfinance/options#AsianMonteCarloInput","description":"Market and contract inputs shared by arithmetic Asian Monte-Carlo pricing.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield riskFreeRate spot strike timeToExpiryYears volatility @insiderfinance/totalfinance/options/exotics"},{"title":"AsianMonteCarloOptions","url":"/reference/totalfinance/options#AsianMonteCarloOptions","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  antithetic averagingPoints brownianBridge confidence method paths randomNumberGenerator seed @insiderfinance/totalfinance/options/exotics"},{"title":"AutoEngineOptions","url":"/reference/totalfinance/options#AutoEngineOptions","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  objective"},{"title":"AutoObjective","url":"/reference/totalfinance/options#AutoObjective","description":"Objective steering {@link engines.auto}: maximise accuracy (default) or speed.","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  "},{"title":"AutocallableInput","url":"/reference/totalfinance/options#AutocallableInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  autocallBarrier couponRate dividendYield knockInBarrier notional observationTimes riskFreeRate spot volatility @insiderfinance/totalfinance/options/exotics"},{"title":"BachelierImpliedVolatilityInput","url":"/reference/totalfinance/options#BachelierImpliedVolatilityInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  forward price riskFreeRate strike timeToExpiryYears type @insiderfinance/totalfinance/options/bachelier"},{"title":"BachelierImpliedVolatilityResult","url":"/reference/totalfinance/options#BachelierImpliedVolatilityResult","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  converged iterations reason value @insiderfinance/totalfinance/options/bachelier"},{"title":"BachelierInput","url":"/reference/totalfinance/options#BachelierInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  forward normalVolatility riskFreeRate strike timeToExpiryYears @insiderfinance/totalfinance/options/bachelier"},{"title":"BachelierTypedInput","url":"/reference/totalfinance/options#BachelierTypedInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  forward normalVolatility riskFreeRate strike timeToExpiryYears type @insiderfinance/totalfinance/options/bachelier"},{"title":"BarrierInput","url":"/reference/totalfinance/options#BarrierInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  barrier dividendYield riskFreeRate spot strike timeToExpiryYears volatility @insiderfinance/totalfinance/options/exotics"},{"title":"BarrierMonteCarloOptions","url":"/reference/totalfinance/options#BarrierMonteCarloOptions","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  antithetic brownianBridge confidence method paths randomNumberGenerator seed steps @insiderfinance/totalfinance/options/exotics"},{"title":"BarrierType","url":"/reference/totalfinance/options#BarrierType","description":"type from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type   @insiderfinance/totalfinance/options/exotics"},{"title":"BasketInput","url":"/reference/totalfinance/options#BasketInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  correlation dividendYields riskFreeRate spots strike timeToExpiryYears volatilities weights @insiderfinance/totalfinance/options/exotics"},{"title":"BinomialEngineOptions","url":"/reference/totalfinance/options#BinomialEngineOptions","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  steps variant"},{"title":"BinomialVariant","url":"/reference/totalfinance/options/page-2#BinomialVariant","description":"type from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  "},{"title":"Black76ImpliedVolatilityInput","url":"/reference/totalfinance/options/page-2#Black76ImpliedVolatilityInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  forward price riskFreeRate strike timeToExpiryYears type @insiderfinance/totalfinance/options/black76"},{"title":"Black76ImpliedVolatilityResult","url":"/reference/totalfinance/options/page-2#Black76ImpliedVolatilityResult","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  converged iterations message reason value @insiderfinance/totalfinance/options/black76"},{"title":"Black76Input","url":"/reference/totalfinance/options/page-2#Black76Input","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  forward riskFreeRate strike timeToExpiryYears volatility @insiderfinance/totalfinance/options/black76"},{"title":"Black76TypedInput","url":"/reference/totalfinance/options/page-2#Black76TypedInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  forward riskFreeRate strike timeToExpiryYears type volatility @insiderfinance/totalfinance/options/black76"},{"title":"BlackScholesEvaluateInput","url":"/reference/totalfinance/options/page-2#BlackScholesEvaluateInput","description":"Input for {@link blackScholes}.evaluate: the typed Black–Scholes input plus the outputs to compute.\n`outputs` is required, nonempty, dense and duplicate-free.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield outputs riskFreeRate spot strike timeToExpiryYears type volatility @insiderfinance/totalfinance/options/black-scholes"},{"title":"BlackScholesEvaluateManyOptions","url":"/reference/totalfinance/options/page-2#BlackScholesEvaluateManyOptions","description":"Options for {@link blackScholesEvaluateMany}.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  outputs @insiderfinance/totalfinance/options/batch"},{"title":"BlackScholesEvaluateManyResult","url":"/reference/totalfinance/options/page-2#BlackScholesEvaluateManyResult","description":"One `Float64Array` (one value per row) for each selected output. The outputs the selection is\ncertain to contain are required columns; any other output it might","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type   @insiderfinance/totalfinance/options/batch"},{"title":"BlackScholesEvaluation","url":"/reference/totalfinance/options/page-2#BlackScholesEvaluation","description":"The result of a selected evaluation. The outputs the selection is certain to contain are required\nnumbers; any other output it might contain is optional ({@link","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type   @insiderfinance/totalfinance/options/black-scholes"},{"title":"BlackScholesImpliedVolatilityInput","url":"/reference/totalfinance/options/page-2#BlackScholesImpliedVolatilityInput","description":"Facade input for implied-volatility solving.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield price riskFreeRate spot strike timeToExpiryYears type"},{"title":"BlackScholesImpliedVolatilityInputSchema","url":"/reference/totalfinance/options/page-2#BlackScholesImpliedVolatilityInputSchema","description":"Schema for an implied-volatility request. Built from {@link blackScholesShape} (minus `volatility`, which is the\nunknown being solved) so its fields carry the s","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _check(inpu @insiderfinance/totalfinance/options/schema"},{"title":"BlackScholesImpliedVolatilityOptions","url":"/reference/totalfinance/options/page-2#BlackScholesImpliedVolatilityOptions","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  lowerVolatilityBound upperVolatilityBound @insiderfinance/totalfinance/options/black-scholes"},{"title":"BlackScholesImpliedVolatilityResult","url":"/reference/totalfinance/options/page-2#BlackScholesImpliedVolatilityResult","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  converged error iterations message reason value @insiderfinance/totalfinance/options/black-scholes"},{"title":"BlackScholesInput","url":"/reference/totalfinance/options/page-2#BlackScholesInput","description":"Flat facade input for a single Black–Scholes–Merton computation.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield riskFreeRate spot strike timeToExpiryYears volatility"},{"title":"BlackScholesInputSchema","url":"/reference/totalfinance/options/page-2#BlackScholesInputSchema","description":"Schema for a `BlackScholesInput` facade payload.","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _check(inpu @insiderfinance/totalfinance/options/schema"},{"title":"BlackScholesNoArbitrageInput","url":"/reference/totalfinance/options/page-2#BlackScholesNoArbitrageInput","description":"Input for {@link checkBlackScholesNoArbitrage} — the observed price plus the BSM inputs it's bounded against.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield price riskFreeRate spot strike timeToExpiryYears type"},{"title":"BlackScholesOutput","url":"/reference/totalfinance/options/page-2#BlackScholesOutput","description":"A Black–Scholes output a selective call can request. First-order Greeks use the library's display\nunits (theta per calendar day, vega and rho per 1%); higher-or","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type   @insiderfinance/totalfinance/options/batch @insiderfinance/totalfinance/options/black-scholes"},{"title":"BlackScholesOutputBuffers","url":"/reference/totalfinance/options/page-2#BlackScholesOutputBuffers","description":"Caller-owned output storage for {@link blackScholesEvaluateManyInto}: the property names ARE the\nselection. Each buffer is a `Float64Array` with at least one el","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  charm color delta gamma price rho speed theta vanna vega vomma @insiderfinance/totalfinance/options/batch"},{"title":"BlackScholesOutputSelection","url":"/reference/totalfinance/options/page-2#BlackScholesOutputSelection","description":"A selection of outputs, as an array or (inferred from a literal) a tuple.","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type   @insiderfinance/totalfinance/options/batch @insiderfinance/totalfinance/options/black-scholes"},{"title":"BlackScholesTypedInput","url":"/reference/totalfinance/options/page-2#BlackScholesTypedInput","description":"Facade input where the option type is explicit (`blackScholes.price`, `blackScholes.greeks`).","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield riskFreeRate spot strike timeToExpiryYears type volatility"},{"title":"BlackScholesTypedInputSchema","url":"/reference/totalfinance/options/page-3#BlackScholesTypedInputSchema","description":"Schema for a typed BSM payload (`blackScholes.price` / `blackScholes.greeks`).","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _check(inpu @insiderfinance/totalfinance/options/schema"},{"title":"BoundaryPoint","url":"/reference/totalfinance/options/page-3#BoundaryPoint","description":"One point on the exercise-boundary curve.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  criticalSpot yearsToExpiry"},{"title":"BoxSpreadAssumptions","url":"/reference/totalfinance/options/page-3#BoxSpreadAssumptions","description":"Assumptions echoed by {@link boxSpreadRate}.","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  asOf calendar calendarVersion compounding compounding.periodsPerYear compounding.type conventionsVersion dayCount dividendModel engine expir @insiderfinance/totalfinance/options/parity"},{"title":"BoxSpreadDiagnostics","url":"/reference/totalfinance/options/page-3#BoxSpreadDiagnostics","description":"Diagnostics for {@link boxSpreadRate}.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  autoReason converged debit decomposition discountFactor engine finiteDifferenceBumps iterations method selection selection.candidates select @insiderfinance/totalfinance/options/parity"},{"title":"BoxSpreadOptions","url":"/reference/totalfinance/options/page-3#BoxSpreadOptions","description":"Options for {@link boxSpreadRate}.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  asOf source @insiderfinance/totalfinance/options/parity"},{"title":"BoxSpreadResult","url":"/reference/totalfinance/options/page-3#BoxSpreadResult","description":"The rich envelope returned by {@link boxSpreadRate}.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/options/parity"},{"title":"ChainGreeksAssumptionsExtra","url":"/reference/totalfinance/options/page-3#ChainGreeksAssumptionsExtra","description":"Extra assumptions `chainGreeks` echoes beyond the shared conventions.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield engines engines.american engines.european priceSource provenanceSource riskFreeRate spot units units.rho units.theta units.veg"},{"title":"ChainGreeksDiagnostics","url":"/reference/totalfinance/options/page-3#ChainGreeksDiagnostics","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  autoReason converged decomposition engine finiteDifferenceBumps iterations method rows selection selection.candidates selection.mode selecti"},{"title":"ChainGreeksInput","url":"/reference/totalfinance/options/page-3#ChainGreeksInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  market market.asOf market.dividendYield market.riskFreeRate market.spot priceSource quotes"},{"title":"ChainGreeksResult","url":"/reference/totalfinance/options/page-3#ChainGreeksResult","description":"`value` is the input rows in order: a solved row carries `impliedVolatility` and `greeks`; a\nskipped row is returned unchanged and named in `diagnostics.rows`.","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear"},{"title":"ChainGreeksRowDiagnostic","url":"/reference/totalfinance/options/page-3#ChainGreeksRowDiagnostic","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  engine index message reason status"},{"title":"ChainGreeksRowStatus","url":"/reference/totalfinance/options/page-3#ChainGreeksRowStatus","description":"type from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  "},{"title":"CliquetInput","url":"/reference/totalfinance/options/page-3#CliquetInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield globalCap globalFloor localCap localFloor notional resetTimes riskFreeRate spot volatility @insiderfinance/totalfinance/options/exotics"},{"title":"CompareEnginesInput","url":"/reference/totalfinance/options/page-3#CompareEnginesInput","description":"One cohesive request for side-by-side engine comparison.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash contract.deliverable.notes contract.deliverable."},{"title":"CompoGreeks","url":"/reference/totalfinance/options/page-3#CompoGreeks","description":"The compo's multi-factor risk.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  assetDelta assetGamma assetVega correlationVega fxDelta fxVega rho theta @insiderfinance/totalfinance/options/exotics"},{"title":"CompoInput","url":"/reference/totalfinance/options/page-3#CompoInput","description":"Input for the {@link compo} composite option.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  correlation dividendYield domesticRate fxSpot fxVolatility spot strike timeToExpiryYears volatility @insiderfinance/totalfinance/options/exotics"},{"title":"CompoMonteCarloOptions","url":"/reference/totalfinance/options/page-3#CompoMonteCarloOptions","description":"Monte-Carlo options for {@link compo.monteCarloPrice}.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  antithetic brownianBridge confidence foreignRate method paths randomNumberGenerator seed @insiderfinance/totalfinance/options/exotics"},{"title":"ControlVariate","url":"/reference/totalfinance/options/page-3#ControlVariate","description":"A control variate: a per-path quantity `fn(z)` with a known expectation `mean`.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  estimate estimate(normalDraws) mean @insiderfinance/totalfinance/options/monte-carlo"},{"title":"DEFAULT_OUTLIER_THRESHOLD","url":"/reference/totalfinance/options/page-3#DEFAULT_OUTLIER_THRESHOLD","description":"Default MAD multiplier `k`: a strike whose parity residual exceeds `k·MAD` is trimmed.","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value   @insiderfinance/totalfinance/options/parity"},{"title":"DigitalInput","url":"/reference/totalfinance/options/page-3#DigitalInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  cash dividendYield riskFreeRate spot strike timeToExpiryYears volatility @insiderfinance/totalfinance/options/exotics"},{"title":"DigitalKind","url":"/reference/totalfinance/options/page-4#DigitalKind","description":"type from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type   @insiderfinance/totalfinance/options/exotics"},{"title":"DiscreteDividend","url":"/reference/totalfinance/options/page-4#DiscreteDividend","description":"A discrete cash dividend with an ex-date (ISO) and per-share amount.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  amount exDate"},{"title":"DividendTermStructure","url":"/reference/totalfinance/options/page-4#DividendTermStructure","description":"The dividend term structure across the requested expiries.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  assumptions assumptions.continuousYield assumptions.conventionsVersion assumptions.dividendModel assumptions.riskFreeRate assumptions.spot c"},{"title":"DividendTermStructureInput","url":"/reference/totalfinance/options/page-4#DividendTermStructureInput","description":"Input for {@link dividendTermStructure}.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  asOf dividendYield dividends maturities riskFreeRate spot"},{"title":"DividendTermStructurePoint","url":"/reference/totalfinance/options/page-4#DividendTermStructurePoint","description":"One expiry's row of the dividend term structure.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  carry discreteCount discreteEquivalentYield dividendPresentValue forward impliedContinuousYield maturity yearsToExpiry"},{"title":"DoubleTouchInput","url":"/reference/totalfinance/options/page-4#DoubleTouchInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  cash dividendYield lower riskFreeRate spot timeToExpiryYears upper volatility @insiderfinance/totalfinance/options/exotics"},{"title":"DoubleTouchKind","url":"/reference/totalfinance/options/page-4#DoubleTouchKind","description":"type from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type   @insiderfinance/totalfinance/options/exotics"},{"title":"DupireOptions","url":"/reference/totalfinance/options/page-4#DupireOptions","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  floorVolatility logMoneynessStep timeStepYears @insiderfinance/totalfinance/options/local-volatility @insiderfinance/totalfinance/volatility @insiderfinance/totalfinance/volatility/local-volatility"},{"title":"EngineComparison","url":"/reference/totalfinance/options/page-4#EngineComparison","description":"Result of {@link compareEngines}: rows sorted by accuracy against a high-resolution reference.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  assumptions assumptions.conventionsVersion assumptions.engines assumptions.referenceEngine diagnostics diagnostics.warnings reference refere"},{"title":"EngineComparisonRow","url":"/reference/totalfinance/options/page-4#EngineComparisonRow","description":"One engine's result inside a {@link compareEngines} comparison.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  absoluteDifferenceFromReference converged differenceFromReference engine greeks greeks.delta greeks.gamma greeks.rho greeks.theta greeks.veg"},{"title":"EquityLattice","url":"/reference/totalfinance/options/page-4#EquityLattice","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  rollback rollback(combine) rollback(terminal) spotAt spotAt(stepIndex) spotAt(upMoveCount) steps timeStepYears upProbability @insiderfinance/totalfinance/options/lattice"},{"title":"EquityLatticeOptions","url":"/reference/totalfinance/options/page-4#EquityLatticeOptions","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield horizonYears riskFreeRate spot steps variant volatility @insiderfinance/totalfinance/options/lattice"},{"title":"ExoticMonteCarloResult","url":"/reference/totalfinance/options/page-4#ExoticMonteCarloResult","description":"A Monte-Carlo exotic result, enriched with the error statistics.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/options/exotics"},{"title":"ExoticResult","url":"/reference/totalfinance/options/page-4#ExoticResult","description":"A plain exotic-pricing result: value + assumptions + diagnostics.","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/options/exotics"},{"title":"ExtendedGreeks","url":"/reference/totalfinance/options/page-4#ExtendedGreeks","description":"Extended (higher-order) Greeks (spec §9.4).","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  charm color delta gamma lambda phi rho speed theta ultima vanna vega vera veta vomma zomma"},{"title":"FiniteDifferenceEngineOptions","url":"/reference/totalfinance/options/page-4#FiniteDifferenceEngineOptions","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  gridPoints timeSteps"},{"title":"ForwardStartInput","url":"/reference/totalfinance/options/page-4#ForwardStartInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield resetTime riskFreeRate spot strikeMultiplier timeToExpiryYears volatility @insiderfinance/totalfinance/options/exotics"},{"title":"GbmPathInput","url":"/reference/totalfinance/options/page-4#GbmPathInput","description":"A geometric-Brownian-motion path from `steps` standard normals: `S[0..steps]` with\n`S[k+1] = S[k]·exp((r − q − ½σ²)·dt + σ·√dt·z[k])`, `dt = T/steps`. Exact (no","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield riskFreeRate shocks spot timeToExpiryYears volatility @insiderfinance/totalfinance/options/monte-carlo"},{"title":"GbmTerminalInput","url":"/reference/totalfinance/options/page-4#GbmTerminalInput","description":"The terminal GBM price from a single standard normal — `gbmPath` specialised to one step.\n\nExpert kernel form (model-subpath surface) — the curated root surface","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield riskFreeRate shock spot timeToExpiryYears volatility @insiderfinance/totalfinance/options/monte-carlo"},{"title":"Greeks","url":"/reference/totalfinance/options/page-5#Greeks","description":"First-order Greeks in TotalFinance default units:\n  - `theta` per calendar day (ACT/365F),\n  - `vega` per 1 volatility point (1% = 0.01),\n  - `rho` per 1% chang","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  delta gamma rho theta vega"},{"title":"HestonCosineExpansionOptions","url":"/reference/totalfinance/options/page-5#HestonCosineExpansionOptions","description":"Options for the COS analytic pricer.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  extendedGreeks greeks terms truncation @insiderfinance/totalfinance/options/heston"},{"title":"HestonInput","url":"/reference/totalfinance/options/page-5#HestonInput","description":"Market inputs for a Heston computation.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield riskFreeRate spot strike timeToExpiryYears @insiderfinance/totalfinance/options/heston"},{"title":"HestonMonteCarloOptions","url":"/reference/totalfinance/options/page-5#HestonMonteCarloOptions","description":"Options for the QE Monte-Carlo pricer.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  antithetic brownianBridge confidence greeks method paths randomNumberGenerator seed steps @insiderfinance/totalfinance/options/heston"},{"title":"HestonMonteCarloResult","url":"/reference/totalfinance/options/page-5#HestonMonteCarloResult","description":"A Heston MC result enriched with the Monte-Carlo error statistics.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/options/heston"},{"title":"HestonParameters","url":"/reference/totalfinance/options/page-5#HestonParameters","description":"Heston parameters (variances, not volatilities).","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  kappa rho sigma theta v0 @insiderfinance/totalfinance/options/heston"},{"title":"ImpliedBorrowOptions","url":"/reference/totalfinance/options/page-5#ImpliedBorrowOptions","description":"Options for {@link impliedBorrow} — adds the spot used in diagnostics.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  asOf outlierThreshold riskFreeRate source spot @insiderfinance/totalfinance/options/parity"},{"title":"ImpliedDividendYieldOptions","url":"/reference/totalfinance/options/page-5#ImpliedDividendYieldOptions","description":"Options for {@link impliedDividendYield} — adds the spot needed to back out `q`.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  asOf outlierThreshold riskFreeRate source spot @insiderfinance/totalfinance/options/parity"},{"title":"ImpliedForwardOptions","url":"/reference/totalfinance/options/page-5#ImpliedForwardOptions","description":"Options shared by the regression-based parity functions.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  asOf outlierThreshold riskFreeRate source @insiderfinance/totalfinance/options/parity"},{"title":"ImpliedVolatilityDiagnostics","url":"/reference/totalfinance/options/page-5#ImpliedVolatilityDiagnostics","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  converged engine fallback iterations method warnings"},{"title":"ImpliedVolatilityFunction","url":"/reference/totalfinance/options/page-5#ImpliedVolatilityFunction","description":"A market implied-volatility surface as a function of strike and time-to-expiry (years).","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  (strike) (timeToExpiryYears) @insiderfinance/totalfinance/options/local-volatility"},{"title":"ImpliedVolatilityMethod","url":"/reference/totalfinance/options/page-5#ImpliedVolatilityMethod","description":"type from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  "},{"title":"ImpliedVolatilityOptionInput","url":"/reference/totalfinance/options/page-5#ImpliedVolatilityOptionInput","description":"Input for {@link impliedVolatilityOption} — one object: `{ contract, market, ...solver options }`.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash contract.deliverable.notes contract.deliverable."},{"title":"ImpliedVolatilityOptions","url":"/reference/totalfinance/options/page-5#ImpliedVolatilityOptions","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  failFast fallback method"},{"title":"ImpliedVolatilityReason","url":"/reference/totalfinance/options/page-5#ImpliedVolatilityReason","description":"type from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  "},{"title":"ImpliedVolatilityResult","url":"/reference/totalfinance/options/page-5#ImpliedVolatilityResult","description":"Result of a pro `option.impliedVolatility(...)` call.","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear"},{"title":"ImpliedVolatilitySolveResult","url":"/reference/totalfinance/options/page-5#ImpliedVolatilitySolveResult","description":"`value` is `null` when the solve failed (no-arbitrage violation / no convergence) — the\nreason rides `diagnostics` (`converged: false` + a warning). Never NaN (","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear"},{"title":"InstrumentBuilderInput","url":"/reference/totalfinance/options/page-5#InstrumentBuilderInput","description":"Instrument-builder input: the convention lives in the builder name, so no `style` here.","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  convention currency expiry multiplier root strike underlying"},{"title":"InverseGreeks","url":"/reference/totalfinance/options/page-5#InverseGreeks","description":"An inverse option's risk in both denominations.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  coin coin.delta coin.gamma coin.rho coin.theta coin.vega usd usd.delta usd.gamma usd.rho usd.theta usd.vega @insiderfinance/totalfinance/options/exotics"},{"title":"InverseOptionInput","url":"/reference/totalfinance/options/page-5#InverseOptionInput","description":"Input for the {@link inverseOption} coin-settled option.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  coinYield riskFreeRate spot strike timeToExpiryYears volatility @insiderfinance/totalfinance/options/exotics"},{"title":"InverseOptionMonteCarloOptions","url":"/reference/totalfinance/options/page-6#InverseOptionMonteCarloOptions","description":"Monte-Carlo options for {@link inverseOption.monteCarloPrice}.","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  antithetic brownianBridge confidence method paths randomNumberGenerator seed @insiderfinance/totalfinance/options/exotics"},{"title":"LatticeNode","url":"/reference/totalfinance/options/page-6#LatticeNode","description":"Per-node context handed to a {@link EquityLattice.rollback} combiner.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  discount down spot stepIndex timeStepYears timeToExpiryYears up upMoveCount upProbability @insiderfinance/totalfinance/options/lattice"},{"title":"LatticeVariant","url":"/reference/totalfinance/options/page-6#LatticeVariant","description":"type from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type   @insiderfinance/totalfinance/options/lattice"},{"title":"LocalVolatilityFunction","url":"/reference/totalfinance/options/page-6#LocalVolatilityFunction","description":"Local volatility as a function of underlying level and time (years).","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  (level) (timeToExpiryYears) @insiderfinance/totalfinance/options/local-volatility @insiderfinance/totalfinance/volatility @insiderfinance/totalfinance/volatility/local-volatility"},{"title":"LocalVolatilityGridSpecification","url":"/reference/totalfinance/options/page-6#LocalVolatilityGridSpecification","description":"Grid specification for {@link localVolatilityGrid}: strictly-ascending level and time knots.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  levels times @insiderfinance/totalfinance/options/local-volatility @insiderfinance/totalfinance/volatility @insiderfinance/totalfinance/volatility/local-volatility"},{"title":"LocalVolatilityInput","url":"/reference/totalfinance/options/page-6#LocalVolatilityInput","description":"Market inputs for a local-volatility MC price.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield riskFreeRate spot strike timeToExpiryYears @insiderfinance/totalfinance/options/local-volatility"},{"title":"LocalVolatilityMarket","url":"/reference/totalfinance/options/page-6#LocalVolatilityMarket","description":"Market context the Dupire transform needs to convert strikes to moneyness.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield riskFreeRate spot @insiderfinance/totalfinance/options/local-volatility @insiderfinance/totalfinance/volatility @insiderfinance/totalfinance/volatility/local-volatility"},{"title":"LocalVolatilityMonteCarloOptions","url":"/reference/totalfinance/options/page-6#LocalVolatilityMonteCarloOptions","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  antithetic brownianBridge confidence method paths randomNumberGenerator seed steps @insiderfinance/totalfinance/options/local-volatility"},{"title":"LocalVolatilityMonteCarloResult","url":"/reference/totalfinance/options/page-6#LocalVolatilityMonteCarloResult","description":"A local-volatility MC result enriched with the Monte-Carlo error statistics.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/options/local-volatility"},{"title":"LookbackInput","url":"/reference/totalfinance/options/page-6#LookbackInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield riskFreeRate runningMax runningMin spot strike timeToExpiryYears volatility @insiderfinance/totalfinance/options/exotics"},{"title":"LookbackMonteCarloOptions","url":"/reference/totalfinance/options/page-6#LookbackMonteCarloOptions","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  antithetic brownianBridge confidence method paths randomNumberGenerator seed steps @insiderfinance/totalfinance/options/exotics"},{"title":"LookbackStrike","url":"/reference/totalfinance/options/page-6#LookbackStrike","description":"type from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type   @insiderfinance/totalfinance/options/exotics"},{"title":"MonteCarloEstimate","url":"/reference/totalfinance/options/page-6#MonteCarloEstimate","description":"The raw estimate returned by {@link monteCarloEstimate}, before it is wrapped in a pricing envelope.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  confidenceInterval converged method paths seed standardError value varianceReduction varianceReduction.antithetic varianceReduction.brownian @insiderfinance/totalfinance/options/monte-carlo"},{"title":"MonteCarloMethod","url":"/reference/totalfinance/options/page-6#MonteCarloMethod","description":"Sampling strategy for a Monte-Carlo estimate.","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type   @insiderfinance/totalfinance/options/monte-carlo"},{"title":"MonteCarloPriceOptions","url":"/reference/totalfinance/options/page-6#MonteCarloPriceOptions","description":"Options for {@link monteCarloPrice}. Extends the shared MC sampling options.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  antithetic brownianBridge confidence extendedGreeks greeks method paths randomNumberGenerator seed @insiderfinance/totalfinance/options/monte-carlo"},{"title":"MonteCarloPriceResult","url":"/reference/totalfinance/options/page-6#MonteCarloPriceResult","description":"A pricing result enriched with the Monte-Carlo error statistics.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/options/monte-carlo"},{"title":"MonteCarloRandomNumberGenerator","url":"/reference/totalfinance/options/page-6#MonteCarloRandomNumberGenerator","description":"Pseudo-random generator choice for `method: 'pseudo'`.","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type   @insiderfinance/totalfinance/options/monte-carlo"},{"title":"MonteCarloSamplingOptions","url":"/reference/totalfinance/options/page-6#MonteCarloSamplingOptions","description":"Options shared by every Monte-Carlo pricer.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  antithetic brownianBridge confidence method paths randomNumberGenerator seed @insiderfinance/totalfinance/options/monte-carlo"},{"title":"MonteCarloStatistics","url":"/reference/totalfinance/options/page-6#MonteCarloStatistics","description":"The diagnostics block shared by every Monte-Carlo result.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  confidenceInterval method paths seed standardError varianceReduction varianceReduction.antithetic varianceReduction.brownianBridge varianceR @insiderfinance/totalfinance/options/monte-carlo"},{"title":"MultiAssetInput","url":"/reference/totalfinance/options/page-6#MultiAssetInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  correlation dividendYields riskFreeRate spots strike timeToExpiryYears volatilities @insiderfinance/totalfinance/options/exotics"},{"title":"NapoleonInput","url":"/reference/totalfinance/options/page-7#NapoleonInput","description":"Input for {@link napoleon} and {@link reverseCliquet} (same shape; the coupon is degraded differently).","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  coupon dividendYield globalFloor notional resetTimes riskFreeRate spot volatility @insiderfinance/totalfinance/options/exotics"},{"title":"OptionBatchColumns","url":"/reference/totalfinance/options/page-7#OptionBatchColumns","description":"Struct-of-arrays columnar batch input. `type`: 1 = call, ≤ 0 = put.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield riskFreeRate spot strike timeToExpiryYears type volatility @insiderfinance/totalfinance/options/batch"},{"title":"OptionBatchResult","url":"/reference/totalfinance/options/page-7#OptionBatchResult","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  delta gamma price rho theta vega @insiderfinance/totalfinance/options/batch"},{"title":"OptionBuilderInput","url":"/reference/totalfinance/options/page-7#OptionBuilderInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  convention currency expiry multiplier root strike style underlying"},{"title":"OptionChainHealthConfig","url":"/reference/totalfinance/options/page-7#OptionChainHealthConfig","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  maximumQuoteAgeMs maximumQuotes maximumRelativeSpread minimumExpiries minimumStrikesPerExpiry model priceSource solver solver.lowerVolatilit"},{"title":"OptionChainHealthContract","url":"/reference/totalfinance/options/page-7#OptionChainHealthContract","description":"Pricing identity only: accounting/venue metadata is not used to scale or interpret premiums.","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  expiresAt expiry expiryConvention strike style type underlying"},{"title":"OptionChainHealthExpiryCoverage","url":"/reference/totalfinance/options/page-7#OptionChainHealthExpiryCoverage","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  belowMinimumStrikes callStrikes expired expiresAt missingCallStrikes missingPutStrikes putStrikes quoteCount selectedPriceCount solvedCount "},{"title":"OptionChainHealthInput","url":"/reference/totalfinance/options/page-7#OptionChainHealthInput","description":"type from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  "},{"title":"OptionChainHealthIssue","url":"/reference/totalfinance/options/page-7#OptionChainHealthIssue","description":"type from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  "},{"title":"OptionChainHealthMarket","url":"/reference/totalfinance/options/page-7#OptionChainHealthMarket","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  asOf dividendYield dividends riskFreeRate spot underlying"},{"title":"OptionChainHealthModelMarket","url":"/reference/totalfinance/options/page-7#OptionChainHealthModelMarket","description":"The model path requires real caller-supplied economics; the quote-only path does not.","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  asOf dividendYield dividends riskFreeRate spot underlying"},{"title":"OptionChainHealthModelResult","url":"/reference/totalfinance/options/page-7#OptionChainHealthModelResult","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  bounds bounds.lower bounds.upper engine impliedVolatility solver solver.converged solver.iterations solver.method solver.priceResidual solve"},{"title":"OptionChainHealthModelStatus","url":"/reference/totalfinance/options/page-7#OptionChainHealthModelStatus","description":"type from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  "},{"title":"OptionChainHealthQuote","url":"/reference/totalfinance/options/page-7#OptionChainHealthQuote","description":"Canonical quote fields; only timestamp absence is relaxed so it can be reported honestly.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  ask askSize bid bidSize conditions contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash contract.deli"},{"title":"OptionChainHealthReport","url":"/reference/totalfinance/options/page-7#OptionChainHealthReport","description":"Concrete report shape, directly assignable to createAnalysisArtifact's result without a cast.","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear"},{"title":"OptionChainHealthRow","url":"/reference/totalfinance/options/page-7#OptionChainHealthRow","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  ageMs ask bid contract contract.expiresAt contract.expiry contract.expiryConvention contract.strike contract.style contract.type contract.un"},{"title":"OptionEnginePriceInput","url":"/reference/totalfinance/options/page-7#OptionEnginePriceInput","description":"One complete request to a pluggable option-pricing engine.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash contract.deliverable.notes contract.deliverable."},{"title":"OptionImpliedVolatilityBatchColumns","url":"/reference/totalfinance/options/page-7#OptionImpliedVolatilityBatchColumns","description":"Columnar input for batch implied-volatility inversion (an option chain). `type`: 1 = call, ≤ 0 = put.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield price riskFreeRate spot strike timeToExpiryYears type @insiderfinance/totalfinance/options/batch"},{"title":"OptionImpliedVolatilityBatchResult","url":"/reference/totalfinance/options/page-8#OptionImpliedVolatilityBatchResult","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  converged impliedVolatility reasons @insiderfinance/totalfinance/options/batch"},{"title":"OptionMarket","url":"/reference/totalfinance/options/page-8#OptionMarket","description":"Market inputs for the pro pricing API (spec §9.1). Extends the workspace-canonical\n{@link MarketInputs} (spot/rate/dividendYield/asOf) and adds the option-speci","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  asOf dividendYield dividends forward price riskFreeRate spot volatility"},{"title":"OptionPricingEngine","url":"/reference/totalfinance/options/page-8#OptionPricingEngine","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  capabilities capabilities.deterministic capabilities.dividends capabilities.extendedGreeks capabilities.greeks capabilities.styles name pric"},{"title":"OptionPricingEngineProbe","url":"/reference/totalfinance/options/page-8#OptionPricingEngineProbe","description":"One caller-supplied behavioral probe for {@link validateOptionPricingEngine}.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash contract.deliverable.notes contract.deliverable."},{"title":"ParityAssumptions","url":"/reference/totalfinance/options/page-8#ParityAssumptions","description":"Assumptions echoed by the regression-based parity functions.","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  asOf calendar calendarVersion compounding compounding.periodsPerYear compounding.type conventionsVersion dayCount dividendModel engine expir @insiderfinance/totalfinance/options/parity"},{"title":"ParityCode","url":"/reference/totalfinance/options/page-8#ParityCode","description":"Stable `parity.*` error/warning codes (public API; the set is open).","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  DegenerateBox InsufficientStrikes NonPositiveDiscount NonPositiveForward RateMismatch StrikeUnavailable @insiderfinance/totalfinance/options/parity"},{"title":"ParityDiagnostics","url":"/reference/totalfinance/options/page-8#ParityDiagnostics","description":"Diagnostics for the regression-based parity functions. Extends the shared {@link Diagnostics}.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  autoReason converged decomposition engine finiteDifferenceBumps impliedDiscountFactor impliedRate iterations medianAbsoluteDeviationResidual @insiderfinance/totalfinance/options/parity"},{"title":"ParityResult","url":"/reference/totalfinance/options/page-8#ParityResult","description":"The rich envelope returned by {@link impliedForward}/{@link impliedDividendYield}/{@link impliedBorrow}.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/options/parity"},{"title":"ParityStrikeResidual","url":"/reference/totalfinance/options/page-8#ParityStrikeResidual","description":"Per-strike parity diagnostic echoed for every usable strike (design law: nothing hidden).","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  call fitted put residual spread strike trimmed @insiderfinance/totalfinance/options/parity"},{"title":"PriceManyInput","url":"/reference/totalfinance/options/page-8#PriceManyInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  contracts engine engine.capabilities engine.capabilities.deterministic engine.capabilities.dividends engine.capabilities.extendedGreeks engi @insiderfinance/totalfinance/options/batch"},{"title":"PriceOptionInput","url":"/reference/totalfinance/options/page-8#PriceOptionInput","description":"Input for {@link priceOption} — ONE options-bearing object (alignment spec P3.5b).","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash contract.deliverable.notes contract.deliverable."},{"title":"PriceOptions","url":"/reference/totalfinance/options/page-8#PriceOptions","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  extendedGreeks greeks"},{"title":"PriceResult","url":"/reference/totalfinance/options/page-8#PriceResult","description":"Result of a pro `option.price(...)` call: a value envelope plus Greeks. `greeks` is OPTIONAL — absent\nmeans \"not computed\" (e.g. a Monte-Carlo engine priced wit","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear"},{"title":"QuantoInput","url":"/reference/totalfinance/options/page-8#QuantoInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  correlation dividendYield domesticRate foreignRate fxVolatility spot strike timeToExpiryYears volatility @insiderfinance/totalfinance/options/exotics"},{"title":"RainbowKind","url":"/reference/totalfinance/options/page-8#RainbowKind","description":"type from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type   @insiderfinance/totalfinance/options/exotics"},{"title":"ReverseCliquetInput","url":"/reference/totalfinance/options/page-8#ReverseCliquetInput","description":"Reverse cliquet takes the same inputs as {@link napoleon}; the coupon is degraded by `Σ min(rᵢ, 0)`.","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type  coupon dividendYield globalFloor notional resetTimes riskFreeRate spot volatility @insiderfinance/totalfinance/options/exotics"},{"title":"SabrInput","url":"/reference/totalfinance/options/page-9#SabrInput","description":"Market inputs for a SABR computation. Provide `forward`, or `spot` (+ `rate`, `dividendYield`).","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  dividendYield forward riskFreeRate spot strike timeToExpiryYears @insiderfinance/totalfinance/options/sabr"},{"title":"SabrMonteCarloOptions","url":"/reference/totalfinance/options/page-9#SabrMonteCarloOptions","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  antithetic brownianBridge confidence method paths randomNumberGenerator seed steps @insiderfinance/totalfinance/options/sabr"},{"title":"SabrMonteCarloResult","url":"/reference/totalfinance/options/page-9#SabrMonteCarloResult","description":"A SABR MC result enriched with the Monte-Carlo error statistics.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/options/sabr"},{"title":"SabrOptions","url":"/reference/totalfinance/options/page-9#SabrOptions","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  extendedGreeks greeks volatilityType @insiderfinance/totalfinance/options/sabr"},{"title":"SabrParameters","url":"/reference/totalfinance/options/page-9#SabrParameters","description":"SABR parameters.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  alpha beta nu rho @insiderfinance/totalfinance/options/sabr"},{"title":"SabrVolatilityType","url":"/reference/totalfinance/options/page-9#SabrVolatilityType","description":"Which Hagan expansion to use.","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type   @insiderfinance/totalfinance/options/sabr"},{"title":"SpreadInput","url":"/reference/totalfinance/options/page-9#SpreadInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  correlation dividendYield1 dividendYield2 riskFreeRate spot1 spot2 strike timeToExpiryYears volatility1 volatility2 @insiderfinance/totalfinance/options/exotics"},{"title":"TouchInput","url":"/reference/totalfinance/options/page-9#TouchInput","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  barrier cash dividendYield payAt riskFreeRate spot timeToExpiryYears volatility @insiderfinance/totalfinance/options/exotics"},{"title":"TouchKind","url":"/reference/totalfinance/options/page-9#TouchKind","description":"type from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"type","keywords":"@insiderfinance/totalfinance/options type   @insiderfinance/totalfinance/options/exotics"},{"title":"TouchMonteCarloOptions","url":"/reference/totalfinance/options/page-9#TouchMonteCarloOptions","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  antithetic brownianBridge confidence method paths randomNumberGenerator seed steps @insiderfinance/totalfinance/options/exotics"},{"title":"TrinomialEngineOptions","url":"/reference/totalfinance/options/page-9#TrinomialEngineOptions","description":"interface from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  steps"},{"title":"UsEquityOptionInput","url":"/reference/totalfinance/options/page-9#UsEquityOptionInput","description":"Input for {@link usEquityOption}: an OCC symbol, or the contract's data with its `type`.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  convention currency expiry multiplier occSymbol root strike type underlying"},{"title":"VanillaIntrinsicInput","url":"/reference/totalfinance/options/page-9#VanillaIntrinsicInput","description":"Input for {@link vanillaIntrinsicUnchecked} and the public `vanillaIntrinsic`.","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  strike type underlyingPrice @insiderfinance/totalfinance/options/payoff"},{"title":"VarianceReduction","url":"/reference/totalfinance/options/page-9#VarianceReduction","description":"Variance-reduction techniques actually applied to an estimate (echoed for reproducibility).","category":"@insiderfinance/totalfinance/options","kind":"interface","keywords":"@insiderfinance/totalfinance/options interface  antithetic brownianBridge controlVariate @insiderfinance/totalfinance/options/monte-carlo"},{"title":"americanExercise","url":"/reference/totalfinance/options/page-9#americanExercise","description":"Decompose an American option into its European value plus early-exercise premium, recover the exercise\nboundary `S*(τ)`, and say whether to exercise now. See `d","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).contract (input).market (input).options return.american return.assumptions return.assumptions.conventionsVersion return.assu"},{"title":"americanImpliedVolatility","url":"/reference/totalfinance/options/page-9#americanImpliedVolatility","description":"Solve the implied volatility of an American contract from `market.price` by inverting an American\npricing engine over σ with a safeguarded Brent bracket (`[1e-4","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).contract (input).market (input).options return.assumptions return.diagnostics return.provenance return.value"},{"title":"asian","url":"/reference/totalfinance/options/page-9#asian","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  geometricPrice geometricPrice().return.assumptions geometricPrice().return.diagnostics geometricPrice().return.provenance geometricPrice().r @insiderfinance/totalfinance/options/exotics"},{"title":"autocallable","url":"/reference/totalfinance/options/page-9#autocallable","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  monteCarloPrice monteCarloPrice().return.assumptions monteCarloPrice().return.diagnostics monteCarloPrice().return.monteCarlo monteCarloPric @insiderfinance/totalfinance/options/exotics"},{"title":"bachelier","url":"/reference/totalfinance/options/page-9#bachelier","description":"The Bachelier facade namespace.","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  call call(input) call(input).forward call(input).normalVolatility call(input).riskFreeRate call(input).strike call(input).timeToExpiryYears  @insiderfinance/totalfinance/options/bachelier"},{"title":"barrier","url":"/reference/totalfinance/options/page-9#barrier","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  monteCarloPrice monteCarloPrice().return.assumptions monteCarloPrice().return.diagnostics monteCarloPrice().return.monteCarlo monteCarloPric @insiderfinance/totalfinance/options/exotics"},{"title":"basket","url":"/reference/totalfinance/options/page-10#basket","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  approximatePrice approximatePrice().return.assumptions approximatePrice().return.diagnostics approximatePrice().return.provenance approximat @insiderfinance/totalfinance/options/exotics"},{"title":"black76","url":"/reference/totalfinance/options/page-10#black76","description":"The Black-76 facade namespace.","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  call call(input) call(input).forward call(input).riskFreeRate call(input).strike call(input).timeToExpiryYears call(input).volatility call.e @insiderfinance/totalfinance/options/black76"},{"title":"boxSpreadRate","url":"/reference/totalfinance/options/page-10#boxSpreadRate","description":"Implied financing rate from the box spread between strikes `k1 < k2`.\n\nA box (bull call spread `+` bear put spread) locks in `(k2 − k1)` at expiry for a net deb","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).expiry (input).lowerStrike (input).options (input).quotes (input).upperStrike return.assumptions return.diagnostics return.v @insiderfinance/totalfinance/options/parity"},{"title":"callContract","url":"/reference/totalfinance/options/page-10#callContract","description":"Generic call builder — `style` REQUIRED.","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).convention (input).currency (input).expiry (input).multiplier (input).root (input).strike (input).style (input).underlying r"},{"title":"chainGreeks","url":"/reference/totalfinance/options/page-10#chainGreeks","description":"Solve every chain row's implied volatility and Greeks from its observed price. See the module\nnote: non-throwing per row, style-routed, display units, provenanc","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).market (input).priceSource (input).quotes return.assumptions return.diagnostics return.provenance return.value"},{"title":"checkBlackScholesNoArbitrage","url":"/reference/totalfinance/options/page-10#checkBlackScholesNoArbitrage","description":"Check an observed price against BSM no-arbitrage bounds. Returns a report: `admissible` plus the\n`[lower, upper]` band, with each violation as a structured `sev","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).dividendYield (input).price (input).riskFreeRate (input).spot (input).strike (input).timeToExpiryYears (input).type return.a"},{"title":"cliquet","url":"/reference/totalfinance/options/page-10#cliquet","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  monteCarloPrice monteCarloPrice().return.assumptions monteCarloPrice().return.diagnostics monteCarloPrice().return.monteCarlo monteCarloPric @insiderfinance/totalfinance/options/exotics"},{"title":"compareEngines","url":"/reference/totalfinance/options/page-10#compareEngines","description":"Price one contract across many engines and report each engine's value, Greeks, convergence,\ntiming, and deviation from a high-resolution reference (spec §9.7). ","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).contract (input).market (input).options (input).options.engines (input).options.now (input).options.reference return.assumpt"},{"title":"compo","url":"/reference/totalfinance/options/page-10#compo","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  greeks greeks().return.assumptions greeks().return.diagnostics greeks().return.provenance greeks().return.value greeks(input) greeks(input). @insiderfinance/totalfinance/options/exotics"},{"title":"defineOptionPricingEngine","url":"/reference/totalfinance/options/page-10#defineOptionPricingEngine","description":"Define a custom pricing engine (spec §22.1). TotalFinance treats it like any built-in engine: pass it\nto `option.price({ contract: contract, market: market, eng","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (engine) (engine).capabilities (engine).capabilities.deterministic (engine).capabilities.dividends (engine).capabilities.extendedGreeks (eng"},{"title":"digital","url":"/reference/totalfinance/options/page-10#digital","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  extendedGreeks extendedGreeks().return.assumptions extendedGreeks().return.diagnostics extendedGreeks().return.provenance extendedGreeks().r @insiderfinance/totalfinance/options/exotics"},{"title":"dividendTermStructure","url":"/reference/totalfinance/options/page-10#dividendTermStructure","description":"Build the dividend term structure — per-expiry forward, dividend PV, and continuous-equivalent yield —\nfrom a discrete cash schedule and/or a continuous yield. ","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).asOf (input).dividendYield (input).dividends (input).maturities (input).riskFreeRate (input).spot return.assumptions return."},{"title":"doubleTouch","url":"/reference/totalfinance/options/page-10#doubleTouch","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  greeks greeks().return.assumptions greeks().return.diagnostics greeks().return.provenance greeks().return.value greeks(input) greeks(input). @insiderfinance/totalfinance/options/exotics"},{"title":"european","url":"/reference/totalfinance/options/page-10#european","description":"European-exercise contract with the convention in the name (index-style options).\n\nA DATE-ONLY expiry must say which instant it means: pass a zoned datetime, or","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).convention (input).currency (input).expiry (input).multiplier (input).root (input).strike (input).type (input).underlying re"},{"title":"forwardStart","url":"/reference/totalfinance/options/page-10#forwardStart","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  monteCarloPrice monteCarloPrice().return.assumptions monteCarloPrice().return.diagnostics monteCarloPrice().return.monteCarlo monteCarloPric @insiderfinance/totalfinance/options/exotics"},{"title":"gbm","url":"/reference/totalfinance/options/page-10#gbm","description":"The geometric-Brownian-motion namespace — the grouped surface over the flat `gbm*` kernels.\n`gbm.path` / `gbm.terminal` are the same functions; prefer the names","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  path path(input) path(input).dividendYield path(input).riskFreeRate path(input).shocks path(input).spot path(input).timeToExpiryYears path(i @insiderfinance/totalfinance/options/monte-carlo"},{"title":"heston","url":"/reference/totalfinance/options/page-10#heston","description":"The Heston model namespace — the grouped, discoverable surface over the flat `heston*` functions.\n`heston.price` / `heston.monteCarloPrice` / `heston.cosineExpa","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  cosineExpansion cosineExpansion(input) cosineExpansion(input).dividendYield cosineExpansion(input).parameters cosineExpansion(input).riskFre @insiderfinance/totalfinance/options/heston"},{"title":"impliedBorrow","url":"/reference/totalfinance/options/page-10#impliedBorrow","description":"Implied borrow / financing spread: the regression-implied financing rate `r*` (from the parity\nslope) minus the supplied `rate`. Zero when the chain was priced ","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).expiry (input).options (input).quotes return.assumptions return.diagnostics return.value @insiderfinance/totalfinance/options/parity"},{"title":"impliedDividendYield","url":"/reference/totalfinance/options/page-11#impliedDividendYield","description":"Implied continuous dividend yield `q` from `F = S·e^((r−q)T)` ⇒ `q = r − ln(F/S)/T`, using the\nregression forward and the supplied `spot`/`rate`.","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).expiry (input).options (input).quotes return.assumptions return.diagnostics return.value @insiderfinance/totalfinance/options/parity"},{"title":"impliedForward","url":"/reference/totalfinance/options/page-11#impliedForward","description":"Implied forward `F` from put-call parity across one expiry's chain.\n\nRegresses `C(K) − P(K)` on `K`; from `slope = −e^(−rT)` and `intercept = e^(−rT)·F`,\n`F = −","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).expiry (input).options (input).quotes return.assumptions return.diagnostics return.value @insiderfinance/totalfinance/options/parity"},{"title":"impliedVolatilityMany","url":"/reference/totalfinance/options/page-11#impliedVolatilityMany","description":"Batch implied volatility with per-row diagnostics on `results`. A bad row yields a non-converged\nrow result rather than aborting the chain — unless `failFast` i","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (options) (options).failFast (options).fallback (options).method (rows) return.assumptions return.diagnostics return.diagnostics.converged r"},{"title":"impliedVolatilityOption","url":"/reference/totalfinance/options/page-11#impliedVolatilityOption","description":"function from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).contract (input).engine (input).failFast (input).fallback (input).market (input).method return.assumptions return.diagnostic"},{"title":"inverseOption","url":"/reference/totalfinance/options/page-11#inverseOption","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  barrier barrier().return.assumptions barrier().return.diagnostics barrier().return.provenance barrier().return.value barrier(input) barrier( @insiderfinance/totalfinance/options/exotics"},{"title":"localVolatility","url":"/reference/totalfinance/options/page-11#localVolatility","description":"The local-volatility namespace — the grouped, discoverable surface over the flat local-volatility functions.\n`localVolatility.fromImplied` / `localVolatility.gr","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  fromImplied fromImplied(input) fromImplied(input).impliedVolatility fromImplied(input).market fromImplied(input).options grid grid(localVola @insiderfinance/totalfinance/options/local-volatility"},{"title":"lookback","url":"/reference/totalfinance/options/page-11#lookback","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  monteCarloPrice monteCarloPrice().return.assumptions monteCarloPrice().return.diagnostics monteCarloPrice().return.monteCarlo monteCarloPric @insiderfinance/totalfinance/options/exotics"},{"title":"napoleon","url":"/reference/totalfinance/options/page-11#napoleon","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  monteCarloPrice monteCarloPrice().return.assumptions monteCarloPrice().return.diagnostics monteCarloPrice().return.monteCarlo monteCarloPric @insiderfinance/totalfinance/options/exotics"},{"title":"optionChainHealth","url":"/reference/totalfinance/options/page-11#optionChainHealth","description":"Consolidated chain-health report. Structural malformations throw indexed InputError; absent\nprices/timestamps, empty chains and unavailable inverses are valid r","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function ```ts\nimport { option, optionChainHealth } from '@insiderfinance/totalfinance/options';\n\nconst contr (input) return.assumptions return.coverage return.coverage.belowMinimumExpiries return.coverage.duplicateQuoteCount return.coverage.expected"},{"title":"priceMany","url":"/reference/totalfinance/options/page-11#priceMany","description":"Price many contracts against one market, returning a rich `PriceResult` per contract (rows form).","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).contracts (input).engine (input).market @insiderfinance/totalfinance/options/batch"},{"title":"priceOption","url":"/reference/totalfinance/options/page-11#priceOption","description":"function from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).contract (input).engine (input).extendedGreeks (input).greeks (input).market return.assumptions return.diagnostics return.gr"},{"title":"putContract","url":"/reference/totalfinance/options/page-11#putContract","description":"Generic put builder — `style` REQUIRED.","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).convention (input).currency (input).expiry (input).multiplier (input).root (input).strike (input).style (input).underlying r"},{"title":"quanto","url":"/reference/totalfinance/options/page-11#quanto","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  price price().return.assumptions price().return.diagnostics price().return.provenance price().return.value price(input) price(input).correla @insiderfinance/totalfinance/options/exotics"},{"title":"rainbow","url":"/reference/totalfinance/options/page-11#rainbow","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  monteCarloPrice monteCarloPrice().return.assumptions monteCarloPrice().return.diagnostics monteCarloPrice().return.monteCarlo monteCarloPric @insiderfinance/totalfinance/options/exotics"},{"title":"reverseCliquet","url":"/reference/totalfinance/options/page-11#reverseCliquet","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  floorlessValue floorlessValue().return.assumptions floorlessValue().return.diagnostics floorlessValue().return.provenance floorlessValue().r @insiderfinance/totalfinance/options/exotics"},{"title":"sabr","url":"/reference/totalfinance/options/page-11#sabr","description":"The SABR model namespace — the grouped, discoverable surface over the flat `sabr*` functions.\n`sabr.volatility` / `sabr.price` / `sabr.monteCarloPrice` / `sabr.","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  monteCarloEstimate monteCarloEstimate().return.confidenceInterval monteCarloEstimate().return.converged monteCarloEstimate().return.method m @insiderfinance/totalfinance/options/sabr"},{"title":"schemas","url":"/reference/totalfinance/options/page-11#schemas","description":"Convenience namespace mirroring the spec's `schemas.OptionContract.parse(...)` usage.","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  BlackScholesImpliedVolatilityInput BlackScholesImpliedVolatilityInput._check BlackScholesImpliedVolatilityInput._check().return.issues Black @insiderfinance/totalfinance/options/schema"},{"title":"spread","url":"/reference/totalfinance/options/page-12#spread","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  monteCarloPrice monteCarloPrice().return.assumptions monteCarloPrice().return.diagnostics monteCarloPrice().return.monteCarlo monteCarloPric @insiderfinance/totalfinance/options/exotics"},{"title":"touch","url":"/reference/totalfinance/options/page-12#touch","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  greeks greeks().return.assumptions greeks().return.diagnostics greeks().return.provenance greeks().return.value greeks(input) greeks(input). @insiderfinance/totalfinance/options/exotics"},{"title":"usEquityCall","url":"/reference/totalfinance/options/page-12#usEquityCall","description":"function from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).convention (input).currency (input).expiry (input).multiplier (input).root (input).strike (input).underlying return.adjusted"},{"title":"usEquityOption","url":"/reference/totalfinance/options/page-12#usEquityOption","description":"US listed equity option from DATA (B7): either an OCC symbol, or `type` plus the fields\n`usEquityCall`/`usEquityPut` take. The two named builders remain the sug","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).convention (input).currency (input).expiry (input).multiplier (input).occSymbol (input).root (input).strike (input).type (in"},{"title":"usEquityPut","url":"/reference/totalfinance/options/page-12#usEquityPut","description":"US listed equity put — see {@link usEquityCall}.","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (input) (input).convention (input).currency (input).expiry (input).multiplier (input).root (input).strike (input).underlying return.adjusted"},{"title":"validateOptionPricingEngine","url":"/reference/totalfinance/options/page-12#validateOptionPricingEngine","description":"Behaviorally verify a custom pricing engine against CALLER-SUPPLIED fixtures. Registration via\n{@link defineOptionPricingEngine} is deliberately side-effect-fre","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function  (engine) (engine).capabilities (engine).capabilities.deterministic (engine).capabilities.dividends (engine).capabilities.extendedGreeks (eng"},{"title":"vanillaIntrinsic","url":"/reference/totalfinance/options/page-12#vanillaIntrinsic","description":"Gross vanilla intrinsic value per unit: `max(underlyingPrice − strike, 0)` for a call,\n`max(strike − underlyingPrice, 0)` for a put.\n\nA plain number out, and no","category":"@insiderfinance/totalfinance/options","kind":"function","keywords":"@insiderfinance/totalfinance/options function ```ts\nimport { vanillaIntrinsic } from '@insiderfinance/totalfinance/options/payoff';\n\nvanillaIntrin (input) (input).strike (input).type (input).underlyingPrice"},{"title":"varianceSwap","url":"/reference/totalfinance/options/page-12#varianceSwap","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  hestonFairVariance hestonFairVariance(parameters) hestonFairVariance(parameters).kappa hestonFairVariance(parameters).theta hestonFairVarian @insiderfinance/totalfinance/options/exotics"},{"title":"volatilitySwap","url":"/reference/totalfinance/options/page-12#volatilitySwap","description":"value from @insiderfinance/totalfinance/options","category":"@insiderfinance/totalfinance/options","kind":"value","keywords":"@insiderfinance/totalfinance/options value  approximateFairVolatility approximateFairVolatility(input) approximateFairVolatility(input).fairVariance approximateFairVolatility(input).va @insiderfinance/totalfinance/options/exotics"},{"title":"bachelierExtendedGreeks","url":"/reference/totalfinance/options/bachelier#bachelierExtendedGreeks","description":"Bachelier (normal-model) higher-order Greeks (w.r.t. the forward `F` and the NORMAL vol `σ_N`). These\nare the arithmetic-BM analogues of {@link blackScholesExte","category":"@insiderfinance/totalfinance/options/bachelier","kind":"function","keywords":"@insiderfinance/totalfinance/options/bachelier function  (input) (input).forward (input).normalVolatility (input).riskFreeRate (input).strike (input).timeToExpiryYears (input).type return.charm ret"},{"title":"bachelierGreeks","url":"/reference/totalfinance/options/bachelier#bachelierGreeks","description":"Bachelier first-order Greeks (vega is per 1.00 of normal vol).","category":"@insiderfinance/totalfinance/options/bachelier","kind":"function","keywords":"@insiderfinance/totalfinance/options/bachelier function  (input) (input).forward (input).normalVolatility (input).riskFreeRate (input).strike (input).timeToExpiryYears (input).type return.delta ret"},{"title":"bachelierImpliedVolatility","url":"/reference/totalfinance/options/bachelier#bachelierImpliedVolatility","description":"Solve Bachelier (normal) implied volatility. Reports failure honestly. Endpoint acceptance uses\nthe same RELATIVE tolerance as the BSM kernel (see {@link implie","category":"@insiderfinance/totalfinance/options/bachelier","kind":"function","keywords":"@insiderfinance/totalfinance/options/bachelier function  (input) (input).forward (input).price (input).riskFreeRate (input).strike (input).timeToExpiryYears (input).type return.converged return.ite"},{"title":"bachelierPrice","url":"/reference/totalfinance/options/bachelier#bachelierPrice","description":"function from @insiderfinance/totalfinance/options/bachelier","category":"@insiderfinance/totalfinance/options/bachelier","kind":"function","keywords":"@insiderfinance/totalfinance/options/bachelier function  (input) (input).forward (input).normalVolatility (input).riskFreeRate (input).strike (input).timeToExpiryYears (input).type"},{"title":"blackScholesEvaluateMany","url":"/reference/totalfinance/options/batch#blackScholesEvaluateMany","description":"Black–Scholes–Merton outputs for every row of a columnar batch, computing ONLY the selected\noutputs and their dependencies — `{ outputs: ['gamma'] }` evaluates ","category":"@insiderfinance/totalfinance/options/batch","kind":"function","keywords":"@insiderfinance/totalfinance/options/batch function const { gamma } = blackScholesEvaluateMany(columns, { outputs: ['gamma'] }); (columns) (columns).dividendYield (columns).riskFreeRate (columns).spot (columns).strike (columns).timeToExpiryYears (columns).type (columns"},{"title":"blackScholesEvaluateManyInto","url":"/reference/totalfinance/options/batch#blackScholesEvaluateManyInto","description":"Write the selected Black–Scholes–Merton outputs for every row into caller-owned buffers — the\nbuffer-writing form of {@link blackScholesEvaluateMany}. Temporary","category":"@insiderfinance/totalfinance/options/batch","kind":"function","keywords":"@insiderfinance/totalfinance/options/batch function const gamma = new Float64Array(capacity);\nblackScholesEvaluateManyInto(columns, { gamma }); (columns) (columns).dividendYield (columns).riskFreeRate (columns).spot (columns).strike (columns).timeToExpiryYears (columns).type (columns"},{"title":"blackScholesImpliedVolatilityMany","url":"/reference/totalfinance/options/batch#blackScholesImpliedVolatilityMany","description":"Batch implied volatility over a columnar option chain (spec §9.6). Each row is inverted with the\nbounded Brent solver; rows that cannot be solved report `conver","category":"@insiderfinance/totalfinance/options/batch","kind":"function","keywords":"@insiderfinance/totalfinance/options/batch function  (cols) (cols).dividendYield (cols).price (cols).riskFreeRate (cols).spot (cols).strike (cols).timeToExpiryYears (cols).type return.converged"},{"title":"blackScholesPriceMany","url":"/reference/totalfinance/options/batch#blackScholesPriceMany","description":"BSM batch pricing over columnar input. Pass `{ greeks: true }` to also fill the five first-order\nGreek columns (theta per calendar day, vega and rho per 1%), co","category":"@insiderfinance/totalfinance/options/batch","kind":"function","keywords":"@insiderfinance/totalfinance/options/batch function  (cols) (cols).dividendYield (cols).riskFreeRate (cols).spot (cols).strike (cols).timeToExpiryYears (cols).type (cols).volatility (options) ("},{"title":"blackScholesPriceManyInto","url":"/reference/totalfinance/options/batch#blackScholesPriceManyInto","description":"Write BSM prices for `cols` into the provided `out` buffer, committing only after all rows succeed.\n\nValidates the columns (closed keys, exact row counts) and e","category":"@insiderfinance/totalfinance/options/batch","kind":"function","keywords":"@insiderfinance/totalfinance/options/batch function  (cols) (cols).dividendYield (cols).riskFreeRate (cols).spot (cols).strike (cols).timeToExpiryYears (cols).type (cols).volatility (out)"},{"title":"BlackScholesEvaluateFacade","url":"/reference/totalfinance/options/black-scholes#BlackScholesEvaluateFacade","description":"`blackScholes.evaluate` — a selected calculation with its `.explain` companion. An empty\nselection is refused at run time (`input.out_of_range`).","category":"@insiderfinance/totalfinance/options/black-scholes","kind":"interface","keywords":"@insiderfinance/totalfinance/options/black-scholes interface  (input) (input).dividendYield (input).outputs (input).riskFreeRate (input).spot (input).strike (input).timeToExpiryYears (input).type (input"},{"title":"BlackScholesImpliedVolatilityKernelInput","url":"/reference/totalfinance/options/black-scholes#BlackScholesImpliedVolatilityKernelInput","description":"interface from @insiderfinance/totalfinance/options/black-scholes","category":"@insiderfinance/totalfinance/options/black-scholes","kind":"interface","keywords":"@insiderfinance/totalfinance/options/black-scholes interface  dividendYield lowerVolatilityBound price riskFreeRate spot strike timeToExpiryYears type upperVolatilityBound"},{"title":"BlackScholesKernelInput","url":"/reference/totalfinance/options/black-scholes#BlackScholesKernelInput","description":"interface from @insiderfinance/totalfinance/options/black-scholes","category":"@insiderfinance/totalfinance/options/black-scholes","kind":"interface","keywords":"@insiderfinance/totalfinance/options/black-scholes interface  dividendYield riskFreeRate spot strike timeToExpiryYears type volatility"},{"title":"BlackScholesPriceBoundsInput","url":"/reference/totalfinance/options/black-scholes#BlackScholesPriceBoundsInput","description":"interface from @insiderfinance/totalfinance/options/black-scholes","category":"@insiderfinance/totalfinance/options/black-scholes","kind":"interface","keywords":"@insiderfinance/totalfinance/options/black-scholes interface  dividendYield riskFreeRate spot strike timeToExpiryYears type"},{"title":"blackScholesExtendedGreeks","url":"/reference/totalfinance/options/black-scholes#blackScholesExtendedGreeks","description":"Higher-order Greeks under BSM (spec §9.4), analytic and exact. First-order fields (`delta`…`rho`)\ncarry the same default units as {@link blackScholesGreeks}; th","category":"@insiderfinance/totalfinance/options/black-scholes","kind":"function","keywords":"@insiderfinance/totalfinance/options/black-scholes function  (input) (input).dividendYield (input).riskFreeRate (input).spot (input).strike (input).timeToExpiryYears (input).type (input).volatility ret"},{"title":"blackScholesGreeks","url":"/reference/totalfinance/options/black-scholes#blackScholesGreeks","description":"First-order Greeks in TotalFinance default units (theta/day, vega/1%, rho/1%).","category":"@insiderfinance/totalfinance/options/black-scholes","kind":"function","keywords":"@insiderfinance/totalfinance/options/black-scholes function  (input) (input).dividendYield (input).riskFreeRate (input).spot (input).strike (input).timeToExpiryYears (input).type (input).volatility ret"},{"title":"blackScholesImpliedVolatility","url":"/reference/totalfinance/options/black-scholes#blackScholesImpliedVolatility","description":"Solve implied volatility from a price using Brent with no-arbitrage bound checks.\n\nReturns `converged: false` with a machine-readable `reason` on failure — neve","category":"@insiderfinance/totalfinance/options/black-scholes","kind":"function","keywords":"@insiderfinance/totalfinance/options/black-scholes function  (input) (input).dividendYield (input).lowerVolatilityBound (input).price (input).riskFreeRate (input).spot (input).strike (input).timeToExpi"},{"title":"blackScholesPrice","url":"/reference/totalfinance/options/black-scholes#blackScholesPrice","description":"Black–Scholes–Merton price for a European call/put with continuous dividend yield `q`.\n\nThis is the seed defect Phase 3B was opened on. It validated the object ","category":"@insiderfinance/totalfinance/options/black-scholes","kind":"function","keywords":"@insiderfinance/totalfinance/options/black-scholes function  (input) (input).dividendYield (input).riskFreeRate (input).spot (input).strike (input).timeToExpiryYears (input).type (input).volatility"},{"title":"blackScholesPriceBounds","url":"/reference/totalfinance/options/black-scholes#blackScholesPriceBounds","description":"No-arbitrage price bounds for a vanilla under BSM (forward intrinsic ≤ price ≤ discounted spot/strike).","category":"@insiderfinance/totalfinance/options/black-scholes","kind":"function","keywords":"@insiderfinance/totalfinance/options/black-scholes function  (input) (input).dividendYield (input).riskFreeRate (input).spot (input).strike (input).timeToExpiryYears (input).type return.lower return.up"},{"title":"Black76PriceBoundsInput","url":"/reference/totalfinance/options/black76#Black76PriceBoundsInput","description":"type from @insiderfinance/totalfinance/options/black76","category":"@insiderfinance/totalfinance/options/black76","kind":"type","keywords":"@insiderfinance/totalfinance/options/black76 type  forward riskFreeRate strike timeToExpiryYears type"},{"title":"black76ExtendedGreeks","url":"/reference/totalfinance/options/black76#black76ExtendedGreeks","description":"Black-76 higher-order Greeks (w.r.t. the forward `F`). The forward-price derivatives (vanna, charm,\nvomma, speed, color, zomma, veta, ultima) coincide with BSM'","category":"@insiderfinance/totalfinance/options/black76","kind":"function","keywords":"@insiderfinance/totalfinance/options/black76 function  (input) (input).forward (input).riskFreeRate (input).strike (input).timeToExpiryYears (input).type (input).volatility return.charm return.co"},{"title":"black76Greeks","url":"/reference/totalfinance/options/black76#black76Greeks","description":"Black-76 first-order Greeks (theta/day, vega/1%, rho/1%; delta/gamma w.r.t. the forward).","category":"@insiderfinance/totalfinance/options/black76","kind":"function","keywords":"@insiderfinance/totalfinance/options/black76 function  (input) (input).forward (input).riskFreeRate (input).strike (input).timeToExpiryYears (input).type (input).volatility return.delta return.ga"},{"title":"black76ImpliedVolatility","url":"/reference/totalfinance/options/black76#black76ImpliedVolatility","description":"Solve Black-76 implied volatility. Reports failure honestly; never fabricates a value. Bounds and\nendpoint acceptance follow the same RELATIVE-tolerance rules a","category":"@insiderfinance/totalfinance/options/black76","kind":"function","keywords":"@insiderfinance/totalfinance/options/black76 function  (input) (input).forward (input).price (input).riskFreeRate (input).strike (input).timeToExpiryYears (input).type return.converged return.ite"},{"title":"black76Price","url":"/reference/totalfinance/options/black76#black76Price","description":"Black-76 price.\n\nThe second seed defect named in the spec, and the same shape as the first: omitting `volatility`\nmade `sigma` `undefined`, `d1` `NaN`, and the ","category":"@insiderfinance/totalfinance/options/black76","kind":"function","keywords":"@insiderfinance/totalfinance/options/black76 function  (input) (input).forward (input).riskFreeRate (input).strike (input).timeToExpiryYears (input).type (input).volatility"},{"title":"black76PriceBounds","url":"/reference/totalfinance/options/black76#black76PriceBounds","description":"No-arbitrage price bounds for Black-76.","category":"@insiderfinance/totalfinance/options/black76","kind":"function","keywords":"@insiderfinance/totalfinance/options/black76 function  (input) (input).forward (input).riskFreeRate (input).strike (input).timeToExpiryYears (input).type return.lower return.upper"},{"title":"HestonFirstOrderStepsInput","url":"/reference/totalfinance/options/heston#HestonFirstOrderStepsInput","description":"The EXACT first-order FD sizes cosGreeks differences with — shared with the disclosure (D6).","category":"@insiderfinance/totalfinance/options/heston","kind":"interface","keywords":"@insiderfinance/totalfinance/options/heston interface  parameters parameters.kappa parameters.rho parameters.sigma parameters.theta parameters.v0 spot timeToExpiryYears"},{"title":"hestonCosineExpansionPrice","url":"/reference/totalfinance/options/heston#hestonCosineExpansionPrice","description":"function from @insiderfinance/totalfinance/options/heston","category":"@insiderfinance/totalfinance/options/heston","kind":"function","keywords":"@insiderfinance/totalfinance/options/heston function  (input) (input).dividendYield (input).parameters (input).riskFreeRate (input).spot (input).strike (input).terms (input).timeToExpiryYears (i"},{"title":"hestonFirstOrderSteps","url":"/reference/totalfinance/options/heston#hestonFirstOrderSteps","description":"function from @insiderfinance/totalfinance/options/heston","category":"@insiderfinance/totalfinance/options/heston","kind":"function","keywords":"@insiderfinance/totalfinance/options/heston function  (input) (input).parameters (input).spot (input).timeToExpiryYears return.rateStep return.spotStep return.timeStepYears return.volatilityStep"},{"title":"hestonImpliedVolatility","url":"/reference/totalfinance/options/heston#hestonImpliedVolatility","description":"Black–Scholes implied volatility of the Heston COS price — the bridge to a Heston vol surface.\nReturns the standard IV envelope: on a failed inversion `value` i","category":"@insiderfinance/totalfinance/options/heston","kind":"function","keywords":"@insiderfinance/totalfinance/options/heston function  (request) (request).input (request).options (request).parameters (request).type return.converged return.error return.iterations return.messa"},{"title":"hestonMonteCarloEstimate","url":"/reference/totalfinance/options/heston#hestonMonteCarloEstimate","description":"Low-level kernel: Heston QE Monte-Carlo estimate of the discounted European payoff.\n\nExpert kernel form (model-subpath surface) — the curated root surface is {@","category":"@insiderfinance/totalfinance/options/heston","kind":"function","keywords":"@insiderfinance/totalfinance/options/heston function  (input) (input).dividendYield (input).options (input).parameters (input).riskFreeRate (input).spot (input).strike (input).timeToExpiryYears "},{"title":"hestonMonteCarloPrice","url":"/reference/totalfinance/options/heston#hestonMonteCarloPrice","description":"Price a European option under Heston by QE Monte-Carlo, returning value + MC stats.\n\nExpert kernel form (model-subpath surface) — the curated root surface is {@","category":"@insiderfinance/totalfinance/options/heston","kind":"function","keywords":"@insiderfinance/totalfinance/options/heston function  (request) (request).input (request).options (request).parameters (request).type return.assumptions return.diagnostics return.greeks return.g"},{"title":"hestonPrice","url":"/reference/totalfinance/options/heston#hestonPrice","description":"Price a European option under Heston via the COS method, with finite-difference Greeks.\n\nExpert kernel form (model-subpath surface) — the curated root surface i","category":"@insiderfinance/totalfinance/options/heston","kind":"function","keywords":"@insiderfinance/totalfinance/options/heston function  (request) (request).input (request).options (request).parameters (request).type return.assumptions return.diagnostics return.greeks return.g"},{"title":"equityLattice","url":"/reference/totalfinance/options/lattice#equityLattice","description":"Build a Cox–Ross–Rubinstein / Jarrow–Rudd equity binomial lattice.","category":"@insiderfinance/totalfinance/options/lattice","kind":"function","keywords":"@insiderfinance/totalfinance/options/lattice function  (options) (options).dividendYield (options).horizonYears (options).riskFreeRate (options).spot (options).steps (options).variant (options).v"},{"title":"dupireLocalVolatility","url":"/reference/totalfinance/options/local-volatility#dupireLocalVolatility","description":"Build the Dupire local-volatility function σ_loc(level, t) from an implied-vol surface. The returned\nfunction is pure and can be evaluated anywhere on the (leve","category":"@insiderfinance/totalfinance/options/local-volatility","kind":"function","keywords":"@insiderfinance/totalfinance/options/local-volatility function  (input) (input).impliedVolatility (input).market (input).options"},{"title":"localVolatilityGrid","url":"/reference/totalfinance/options/local-volatility#localVolatilityGrid","description":"Precompute a local-volatility function onto a (level × time) grid and return a fast bilinear-interpolating\n`LocalVolatilityFunction`. The exact `dupireLocalVola","category":"@insiderfinance/totalfinance/options/local-volatility","kind":"function","keywords":"@insiderfinance/totalfinance/options/local-volatility function  (localVolatility) (specification) (specification).levels (specification).times"},{"title":"localVolatilityMonteCarloEstimate","url":"/reference/totalfinance/options/local-volatility#localVolatilityMonteCarloEstimate","description":"Low-level kernel: local-volatility Monte-Carlo estimate of the discounted European payoff.\n\nExpert kernel form (model-subpath surface) — the curated root surfac","category":"@insiderfinance/totalfinance/options/local-volatility","kind":"function","keywords":"@insiderfinance/totalfinance/options/local-volatility function  (input) (input).dividendYield (input).localVolatility (input).options (input).riskFreeRate (input).spot (input).strike (input).timeToExpiryY"},{"title":"localVolatilityMonteCarloPrice","url":"/reference/totalfinance/options/local-volatility#localVolatilityMonteCarloPrice","description":"Price a European option under a local-volatility diffusion by Monte-Carlo. Pass a `LocalVolatilityFunction`\n(typically from {@link dupireLocalVolatility}); the ","category":"@insiderfinance/totalfinance/options/local-volatility","kind":"function","keywords":"@insiderfinance/totalfinance/options/local-volatility function  (request) (request).input (request).localVolatility (request).options (request).type return.assumptions return.diagnostics return.greeks ret"},{"title":"MonteCarloEuropeanInput","url":"/reference/totalfinance/options/monte-carlo#MonteCarloEuropeanInput","description":"Required raw inputs for one discounted European GBM estimate.","category":"@insiderfinance/totalfinance/options/monte-carlo","kind":"interface","keywords":"@insiderfinance/totalfinance/options/monte-carlo interface  dividendYield options options.antithetic options.brownianBridge options.confidence options.extendedGreeks options.greeks options.method opti"},{"title":"MonteCarloPriceInput","url":"/reference/totalfinance/options/monte-carlo#MonteCarloPriceInput","description":"Price a European contract by Monte-Carlo simulation, returning value, Greeks, assumptions, and the\nMC error statistics (`result.mc`). Validates the market the s","category":"@insiderfinance/totalfinance/options/monte-carlo","kind":"interface","keywords":"@insiderfinance/totalfinance/options/monte-carlo interface  contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash contract.deliverable.notes contract.deliverable."},{"title":"gbmPath","url":"/reference/totalfinance/options/monte-carlo#gbmPath","description":"function from @insiderfinance/totalfinance/options/monte-carlo","category":"@insiderfinance/totalfinance/options/monte-carlo","kind":"function","keywords":"@insiderfinance/totalfinance/options/monte-carlo function  (input) (input).dividendYield (input).riskFreeRate (input).shocks (input).spot (input).timeToExpiryYears (input).volatility"},{"title":"gbmTerminal","url":"/reference/totalfinance/options/monte-carlo#gbmTerminal","description":"function from @insiderfinance/totalfinance/options/monte-carlo","category":"@insiderfinance/totalfinance/options/monte-carlo","kind":"function","keywords":"@insiderfinance/totalfinance/options/monte-carlo function  (input) (input).dividendYield (input).riskFreeRate (input).shock (input).spot (input).timeToExpiryYears (input).volatility"},{"title":"monteCarloEuropean","url":"/reference/totalfinance/options/monte-carlo#monteCarloEuropean","description":"Low-level kernel: estimate the discounted European payoff on GBM. Inputs are assumed validated\n(S, K, T, σ all > 0). Uses the discounted terminal price as a con","category":"@insiderfinance/totalfinance/options/monte-carlo","kind":"function","keywords":"@insiderfinance/totalfinance/options/monte-carlo function  (input) (input).dividendYield (input).options (input).riskFreeRate (input).spot (input).strike (input).timeToExpiryYears (input).type (input"},{"title":"monteCarloPrice","url":"/reference/totalfinance/options/monte-carlo#monteCarloPrice","description":"function from @insiderfinance/totalfinance/options/monte-carlo","category":"@insiderfinance/totalfinance/options/monte-carlo","kind":"function","keywords":"@insiderfinance/totalfinance/options/monte-carlo function  (input) (input).contract (input).market (input).options return.assumptions return.diagnostics return.greeks return.greeks.charm return.greek"},{"title":"OPTION_CONTRACT_PRICER_NAME","url":"/reference/totalfinance/options/pricer#OPTION_CONTRACT_PRICER_NAME","description":"Adapter identity, reported via `definePricer` and usable in selection/diagnostics tooling.","category":"@insiderfinance/totalfinance/options/pricer","kind":"value","keywords":"@insiderfinance/totalfinance/options/pricer value  "},{"title":"OptionContractPricerOptions","url":"/reference/totalfinance/options/pricer#OptionContractPricerOptions","description":"interface from @insiderfinance/totalfinance/options/pricer","category":"@insiderfinance/totalfinance/options/pricer","kind":"interface","keywords":"@insiderfinance/totalfinance/options/pricer interface  engine engine.capabilities engine.capabilities.deterministic engine.capabilities.dividends engine.capabilities.extendedGreeks engine.capabil"},{"title":"optionContractPricer","url":"/reference/totalfinance/options/pricer#optionContractPricer","description":"Build a `Pricer<OptionContract, PriceResult>` around the EXISTING `option.price`.\n\n`optionContractPricer()` — automatic engine selection (`engines.auto()`), dis","category":"@insiderfinance/totalfinance/options/pricer","kind":"function","keywords":"@insiderfinance/totalfinance/options/pricer function  (options) (options).engine return.capabilities return.name return.price return.priceBatch return.requirements return.supports return.version"},{"title":"SabrVolatilityInput","url":"/reference/totalfinance/options/sabr#SabrVolatilityInput","description":"Point at which to evaluate a SABR smile: forward, strike, and time to expiry.","category":"@insiderfinance/totalfinance/options/sabr","kind":"interface","keywords":"@insiderfinance/totalfinance/options/sabr interface  forward strike timeToExpiryYears"},{"title":"SabrVolatilityOptions","url":"/reference/totalfinance/options/sabr#SabrVolatilityOptions","description":"Knobs for {@link sabrVolatility}.","category":"@insiderfinance/totalfinance/options/sabr","kind":"interface","keywords":"@insiderfinance/totalfinance/options/sabr interface  volatilityType"},{"title":"sabrMonteCarloEstimate","url":"/reference/totalfinance/options/sabr#sabrMonteCarloEstimate","description":"Low-level kernel: SABR Euler Monte-Carlo estimate of the discounted European payoff.\n\nExpert kernel form (model-subpath surface) — the curated root surface is {","category":"@insiderfinance/totalfinance/options/sabr","kind":"function","keywords":"@insiderfinance/totalfinance/options/sabr function  (input) (input).forward (input).options (input).parameters (input).riskFreeRate (input).strike (input).timeToExpiryYears (input).type return"},{"title":"sabrMonteCarloPrice","url":"/reference/totalfinance/options/sabr#sabrMonteCarloPrice","description":"Price a European option under SABR by Euler Monte-Carlo of the SDE (validates the Hagan formula).\n\nExpert kernel form (model-subpath surface) — the curated root","category":"@insiderfinance/totalfinance/options/sabr","kind":"function","keywords":"@insiderfinance/totalfinance/options/sabr function  (request) (request).input (request).options (request).parameters (request).type return.assumptions return.diagnostics return.greeks return.g"},{"title":"sabrPrice","url":"/reference/totalfinance/options/sabr#sabrPrice","description":"Price a European option under SABR by evaluating Hagan's implied vol and pricing with Black-76\n(lognormal) or Bachelier (normal). Greeks are finite differences:","category":"@insiderfinance/totalfinance/options/sabr","kind":"function","keywords":"@insiderfinance/totalfinance/options/sabr function  (request) (request).input (request).options (request).parameters (request).type return.assumptions return.diagnostics return.greeks return.g"},{"title":"sabrVolatility","url":"/reference/totalfinance/options/sabr#sabrVolatility","description":"Hagan implied volatility (lognormal/Black by default, or normal/Bachelier). Returns the volatility\nto feed into Black-76 (lognormal) or Bachelier (normal) at th","category":"@insiderfinance/totalfinance/options/sabr","kind":"function","keywords":"@insiderfinance/totalfinance/options/sabr function  (request) (request).input (request).options (request).parameters"},{"title":"BlackScholesInputShape","url":"/reference/totalfinance/options/schema#BlackScholesInputShape","description":"type from @insiderfinance/totalfinance/options/schema","category":"@insiderfinance/totalfinance/options/schema","kind":"type","keywords":"@insiderfinance/totalfinance/options/schema type  "},{"title":"BlackScholesTypedInputShape","url":"/reference/totalfinance/options/schema#BlackScholesTypedInputShape","description":"type from @insiderfinance/totalfinance/options/schema","category":"@insiderfinance/totalfinance/options/schema","kind":"type","keywords":"@insiderfinance/totalfinance/options/schema type  "},{"title":"OptionContractShape","url":"/reference/totalfinance/options/schema#OptionContractShape","description":"type from @insiderfinance/totalfinance/options/schema","category":"@insiderfinance/totalfinance/options/schema","kind":"type","keywords":"@insiderfinance/totalfinance/options/schema type  "},{"title":"blackScholesShape","url":"/reference/totalfinance/options/schema#blackScholesShape","description":"The Black–Scholes–Merton input field descriptors — the ONE source of truth for every option\npayload schema (facade, typed, implied-vol) and for consumers (MCP t","category":"@insiderfinance/totalfinance/options/schema","kind":"value","keywords":"@insiderfinance/totalfinance/options/schema value  dividendYield dividendYield._check dividendYield._check().return.issues dividendYield._check().return.ok dividendYield._check().return.value"},{"title":"optionType","url":"/reference/totalfinance/options/schema#optionType","description":"The `call | put` option-type enum, shared by every typed option schema.","category":"@insiderfinance/totalfinance/options/schema","kind":"value","keywords":"@insiderfinance/totalfinance/options/schema value  _check _check().return.issues _check().return.ok _check().return.value _check(context) _check(context).mode _check(context).path _check(inpu"},{"title":"AccountFlowSegment","url":"/reference/totalfinance/performance#AccountFlowSegment","description":"Per-account external-flow totals. `accountId` is `'unassigned'` for flows without one.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  accountId deposits net withdrawals @insiderfinance/totalfinance/performance/flow-aware"},{"title":"AnalyzeInput","url":"/reference/totalfinance/performance#AnalyzeInput","description":"Input for {@link analyze}: an explicit `equity` curve (growth of capital) **or** a per-period\n`returns` series — a tagged union so the caller can never silently","category":"@insiderfinance/totalfinance/performance","kind":"type","keywords":"@insiderfinance/totalfinance/performance type  equity returns @insiderfinance/totalfinance/performance/analyze"},{"title":"AnalyzeOptions","url":"/reference/totalfinance/performance#AnalyzeOptions","description":"interface from @insiderfinance/totalfinance/performance","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  benchmark periodsPerYear riskFreeRate @insiderfinance/totalfinance/performance/analyze"},{"title":"AnnualizationOptions","url":"/reference/totalfinance/performance#AnnualizationOptions","description":"interface from @insiderfinance/totalfinance/performance","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  periodsPerYear @insiderfinance/totalfinance/performance/sharpe"},{"title":"AnnualizationPolicy","url":"/reference/totalfinance/performance#AnnualizationPolicy","description":"The explicit annualization policy: `'none'` or a declared day-count basis.","category":"@insiderfinance/totalfinance/performance","kind":"type","keywords":"@insiderfinance/totalfinance/performance type  basis @insiderfinance/totalfinance/performance/flow-aware"},{"title":"BenchmarkRelativeRow","url":"/reference/totalfinance/performance#BenchmarkRelativeRow","description":"One aligned relative-performance row.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  benchmarkCumulativeReturn date portfolioCumulativeReturn relativePerformance @insiderfinance/totalfinance/performance/flow-aware"},{"title":"BenchmarkRelativeTimelineInput","url":"/reference/totalfinance/performance#BenchmarkRelativeTimelineInput","description":"Input for {@link benchmarkRelativeTimeline}.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  benchmarkBasis benchmarkReturns portfolioIndex @insiderfinance/totalfinance/performance/flow-aware"},{"title":"BenchmarkRelativeTimelineResult","url":"/reference/totalfinance/performance#BenchmarkRelativeTimelineResult","description":"Result of {@link benchmarkRelativeTimeline}.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  assumptions assumptions.anchorDate assumptions.benchmarkBasis assumptions.benchmarkReturnConvention assumptions.relativeMethod diagnostics d @insiderfinance/totalfinance/performance/flow-aware"},{"title":"BenchmarkReturnObservation","url":"/reference/totalfinance/performance#BenchmarkReturnObservation","description":"One benchmark observation: the simple return of the period ENDING on `date`.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  date simpleReturn @insiderfinance/totalfinance/performance/flow-aware"},{"title":"ContributionByGroupInput","url":"/reference/totalfinance/performance#ContributionByGroupInput","description":"Input for {@link contributionByGroup}.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  groupReturns @insiderfinance/totalfinance/performance/flow-aware"},{"title":"ContributionByGroupResult","url":"/reference/totalfinance/performance#ContributionByGroupResult","description":"Result of {@link contributionByGroup}.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  assumptions assumptions.formula assumptions.scope contributions diagnostics diagnostics.groupCount diagnostics.reconciliationResidual diagno @insiderfinance/totalfinance/performance/flow-aware"},{"title":"DrawdownResult","url":"/reference/totalfinance/performance#DrawdownResult","description":"interface from @insiderfinance/totalfinance/performance","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  longestDurationPeriods maxDrawdown peakIndex recoveryIndex troughIndex @insiderfinance/totalfinance/performance/drawdown"},{"title":"ExposureResult","url":"/reference/totalfinance/performance#ExposureResult","description":"interface from @insiderfinance/totalfinance/performance","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  averageGross averageLong averageNet averageShort timeInMarket @insiderfinance/totalfinance/performance/activity"},{"title":"ExternalCashFlow","url":"/reference/totalfinance/performance#ExternalCashFlow","description":"One EXTERNAL cash flow: money crossing the portfolio boundary, never profit or loss.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  accountId amount cashFlowDate label @insiderfinance/totalfinance/performance/flow-aware"},{"title":"GroupContribution","url":"/reference/totalfinance/performance#GroupContribution","description":"One group's contribution row.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  contribution groupLabel simpleReturn weight @insiderfinance/totalfinance/performance/flow-aware"},{"title":"GroupReturn","url":"/reference/totalfinance/performance#GroupReturn","description":"One group's weight and simple return over ONE period.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  groupLabel simpleReturn weight @insiderfinance/totalfinance/performance/flow-aware"},{"title":"InternalTransfer","url":"/reference/totalfinance/performance#InternalTransfer","description":"One identified transfer between two accounts of the SAME portfolio — internal, not external.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  amount cashFlowDate fromAccountId toAccountId @insiderfinance/totalfinance/performance/flow-aware"},{"title":"LinkSubperiodReturnsInput","url":"/reference/totalfinance/performance#LinkSubperiodReturnsInput","description":"Input for {@link linkSubperiodReturns}.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  linking subperiodReturns @insiderfinance/totalfinance/performance/flow-aware"},{"title":"LinkSubperiodReturnsResult","url":"/reference/totalfinance/performance#LinkSubperiodReturnsResult","description":"Result of {@link linkSubperiodReturns}.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  assumptions assumptions.formula assumptions.linking diagnostics diagnostics.subperiodCount diagnostics.warnings linkedReturn @insiderfinance/totalfinance/performance/flow-aware"},{"title":"ModifiedDietzFlowWeight","url":"/reference/totalfinance/performance#ModifiedDietzFlowWeight","description":"One flow with the day-weight Modified Dietz applied to it.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  amount cashFlowDate weight @insiderfinance/totalfinance/performance/flow-aware"},{"title":"ModifiedDietzReturnInput","url":"/reference/totalfinance/performance/page-2#ModifiedDietzReturnInput","description":"Input for {@link modifiedDietzReturn}.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  externalCashFlows valuations @insiderfinance/totalfinance/performance/flow-aware"},{"title":"ModifiedDietzReturnResult","url":"/reference/totalfinance/performance/page-2#ModifiedDietzReturnResult","description":"Result of {@link modifiedDietzReturn}.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  assumptions assumptions.dayCount assumptions.weightFormula diagnostics diagnostics.daysInPeriod diagnostics.flowCount diagnostics.warnings f @insiderfinance/totalfinance/performance/flow-aware"},{"title":"MoneyWeightedReturnInput","url":"/reference/totalfinance/performance/page-2#MoneyWeightedReturnInput","description":"Input for {@link moneyWeightedReturn}.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  externalCashFlows valuations @insiderfinance/totalfinance/performance/flow-aware"},{"title":"MoneyWeightedReturnResult","url":"/reference/totalfinance/performance/page-2#MoneyWeightedReturnResult","description":"Result of {@link moneyWeightedReturn}.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  assumptions assumptions.asOf assumptions.signConvention diagnostics diagnostics.scheduleRowCount diagnostics.warnings moneyWeightedReturn re @insiderfinance/totalfinance/performance/flow-aware"},{"title":"PerformanceGap","url":"/reference/totalfinance/performance/page-2#PerformanceGap","description":"One excluded date range with the reason it was excluded — never forward-filled.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  fromDate reason toDate @insiderfinance/totalfinance/performance/flow-aware"},{"title":"PerformanceSummary","url":"/reference/totalfinance/performance/page-2#PerformanceSummary","description":"interface from @insiderfinance/totalfinance/performance","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  alpha annualizedReturn annualizedVolatility assumptions assumptions.benchmarkLength assumptions.periodsPerYear assumptions.riskFreeRate beta @insiderfinance/totalfinance/performance/analyze"},{"title":"PortfolioReturnIndexInput","url":"/reference/totalfinance/performance/page-2#PortfolioReturnIndexInput","description":"Input for {@link portfolioReturnIndex}.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  baseValue externalCashFlows valuations @insiderfinance/totalfinance/performance/flow-aware"},{"title":"PortfolioReturnIndexResult","url":"/reference/totalfinance/performance/page-2#PortfolioReturnIndexResult","description":"Result of {@link portfolioReturnIndex}.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  assumptions assumptions.baseValue assumptions.flowConvention assumptions.flowTiming assumptions.gapPolicy assumptions.linking diagnostics di @insiderfinance/totalfinance/performance/flow-aware"},{"title":"PortfolioValuation","url":"/reference/totalfinance/performance/page-2#PortfolioValuation","description":"One portfolio mark: the net asset value observed on a strict calendar date.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  netAssetValue valuationDate @insiderfinance/totalfinance/performance/flow-aware"},{"title":"ReturnIndexPoint","url":"/reference/totalfinance/performance/page-2#ReturnIndexPoint","description":"One point of a total-return index series.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  date indexValue @insiderfinance/totalfinance/performance/flow-aware"},{"title":"SectorClassificationObservation","url":"/reference/totalfinance/performance/page-2#SectorClassificationObservation","description":"One effective-dated, bitemporal sector-classification observation.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  classificationObservationId effectiveFromSessionDate effectiveToSessionDate knownAtTimestampMs sectorId sectorName securityId sourceId sourc @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceAssignedClassificationLineage","url":"/reference/totalfinance/performance/page-2#SectorPerformanceAssignedClassificationLineage","description":"Assigned classification lineage carried by every included member.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  classificationObservationId effectiveFromSessionDate effectiveToSessionDate knownAtTimestampMs sectorId sectorName securityId sourceId sourc @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceAssumptions","url":"/reference/totalfinance/performance/page-2#SectorPerformanceAssumptions","description":"interface from @insiderfinance/totalfinance/performance","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  policyVersion rankingAndTies returnBasis rounding weighting @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceBlocker","url":"/reference/totalfinance/performance/page-2#SectorPerformanceBlocker","description":"A calculation-level reason that no complete sector result could be produced.","category":"@insiderfinance/totalfinance/performance","kind":"type","keywords":"@insiderfinance/totalfinance/performance type   @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceClassificationLineage","url":"/reference/totalfinance/performance/page-2#SectorPerformanceClassificationLineage","description":"Selected classification lineage sufficient to replay a member's sector assignment.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  classificationObservationId effectiveFromSessionDate effectiveToSessionDate knownAtTimestampMs sectorId sectorName securityId sourceId sourc @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceCloseLineage","url":"/reference/totalfinance/performance/page-2#SectorPerformanceCloseLineage","description":"Selected close lineage sufficient to replay one return leg.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  adjustmentVersion closeObservationId currency knownAtTimestampMs listingId quality securityId sessionId sourceId sourceTimestampMs splitAdju @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceCloseObservation","url":"/reference/totalfinance/performance/page-2#SectorPerformanceCloseObservation","description":"One exact-session split-adjusted close observation.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  adjustmentVersion closeObservationId currency knownAtTimestampMs listingId quality securityId sessionId sourceId sourceTimestampMs splitAdju @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceCompletedSession","url":"/reference/totalfinance/performance/page-2#SectorPerformanceCompletedSession","description":"One caller-supplied completed market session.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  completedAtTimestampMs sessionDate sessionId @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceCutoffs","url":"/reference/totalfinance/performance/page-2#SectorPerformanceCutoffs","description":"Explicit point-in-time and session-completion cutoffs. All comparisons are inclusive.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  knowledgeCutoffTimestampMs sessionCompletedCutoffTimestampMs sourceCutoffTimestampMs @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceExclusion","url":"/reference/totalfinance/performance/page-2#SectorPerformanceExclusion","description":"Explicit partial lineage for a nominated security excluded from calculation.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  classification classification.classificationObservationId classification.effectiveFromSessionDate classification.effectiveToSessionDate clas @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceExclusionReason","url":"/reference/totalfinance/performance/page-3#SectorPerformanceExclusionReason","description":"Why a nominated member could not contribute; reasons are emitted in this declared order.","category":"@insiderfinance/totalfinance/performance","kind":"type","keywords":"@insiderfinance/totalfinance/performance type   @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceInput","url":"/reference/totalfinance/performance/page-3#SectorPerformanceInput","description":"The simple on-ramp needs no invented price, calendar, classification or source lineage.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  members @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceMember","url":"/reference/totalfinance/performance/page-3#SectorPerformanceMember","description":"A supplied decimal return over the SAME caller-chosen period and comparable return basis.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  periodReturn sectorId sectorName securityId @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceMemberResult","url":"/reference/totalfinance/performance/page-3#SectorPerformanceMemberResult","description":"The selected fields of one same-period return observation.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  periodReturn sectorId sectorName securityId @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceReasonCount","url":"/reference/totalfinance/performance/page-3#SectorPerformanceReasonCount","description":"Deterministic count of one exclusion reason.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  count reason @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceReport","url":"/reference/totalfinance/performance/page-3#SectorPerformanceReport","description":"Rich report accepted directly by createAnalysisArtifact; raw calculation needs no artifact.","category":"@insiderfinance/totalfinance/performance","kind":"type","keywords":"@insiderfinance/totalfinance/performance type  assumptions assumptions.policyVersion assumptions.rankingAndTies assumptions.returnBasis assumptions.rounding assumptions.weighting diagnost @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceSectorResult","url":"/reference/totalfinance/performance/page-3#SectorPerformanceSectorResult","description":"interface from @insiderfinance/totalfinance/performance","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  includedSecurityCount members periodReturn rank sectorId sectorName @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceSessionLineage","url":"/reference/totalfinance/performance/page-3#SectorPerformanceSessionLineage","description":"Selected completed-session lineage.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  completedAtTimestampMs sessionDate sessionId @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceSnapshotAssumptions","url":"/reference/totalfinance/performance/page-3#SectorPerformanceSnapshotAssumptions","description":"The immutable semantics echoed by every result.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  cacheAndFreshness classification eligibility missingAndStale policyVersion rankingAndTies returnBasis rounding sessionSelection temporalSele @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceSnapshotDiagnostics","url":"/reference/totalfinance/performance/page-3#SectorPerformanceSnapshotDiagnostics","description":"Input, coverage, and exclusion diagnostics for the calculation.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  blockers eligibleSecurityCount excludedSecurityCount includedSecurityCount inputCounts inputCounts.classifications inputCounts.completedSess @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceSnapshotInput","url":"/reference/totalfinance/performance/page-3#SectorPerformanceSnapshotInput","description":"Complete, caller-supplied input to the pure calculation. No policy argument is needed: the\nimplemented version is stamped in the report. The four dense arrays s","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  classificationTaxonomy classificationTaxonomy.taxonomyId classificationTaxonomy.taxonomyVersion classifications completedSessions cutoffs cu @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceSnapshotMemberResult","url":"/reference/totalfinance/performance/page-3#SectorPerformanceSnapshotMemberResult","description":"One included security and every selected input that contributed to its return.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  classification classification.classificationObservationId classification.effectiveFromSessionDate classification.effectiveToSessionDate clas @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceSnapshotReport","url":"/reference/totalfinance/performance/page-3#SectorPerformanceSnapshotReport","description":"Canonical, replayable result of one requested daily sector-performance calculation.","category":"@insiderfinance/totalfinance/performance","kind":"type","keywords":"@insiderfinance/totalfinance/performance type  assumptions assumptions.cacheAndFreshness assumptions.classification assumptions.eligibility assumptions.missingAndStale assumptions.policyV @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceSnapshotSectorResult","url":"/reference/totalfinance/performance/page-3#SectorPerformanceSnapshotSectorResult","description":"One canonical sector result. No provider compatibility alias is part of this contract.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  dailyReturn eligibleSecurityCount excludedSecurityCount includedSecurityCount members rank sectorId sectorName @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceTaxonomy","url":"/reference/totalfinance/performance/page-3#SectorPerformanceTaxonomy","description":"The classification taxonomy selected for this calculation.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  taxonomyId taxonomyVersion @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SectorPerformanceUniverseMember","url":"/reference/totalfinance/performance/page-3#SectorPerformanceUniverseMember","description":"A caller-nominated eligible security and listing. Ticker decoration is not used as identity.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  listingId securityId universeMembershipId @insiderfinance/totalfinance/performance/sector-performance"},{"title":"SegmentExternalFlowsInput","url":"/reference/totalfinance/performance/page-3#SegmentExternalFlowsInput","description":"Input for {@link segmentExternalFlows}.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  accountFilter externalCashFlows @insiderfinance/totalfinance/performance/flow-aware"},{"title":"SegmentExternalFlowsResult","url":"/reference/totalfinance/performance/page-3#SegmentExternalFlowsResult","description":"Result of {@link segmentExternalFlows}.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  assumptions assumptions.accountFilter assumptions.transferIdentification byAccount diagnostics diagnostics.excludedByFilterCount diagnostics @insiderfinance/totalfinance/performance/flow-aware"},{"title":"SharpeOptions","url":"/reference/totalfinance/performance/page-3#SharpeOptions","description":"interface from @insiderfinance/totalfinance/performance","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  periodsPerYear riskFreeRate @insiderfinance/totalfinance/performance/sharpe"},{"title":"SortinoOptions","url":"/reference/totalfinance/performance/page-3#SortinoOptions","description":"interface from @insiderfinance/totalfinance/performance","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  periodsPerYear riskFreeRate targetReturn @insiderfinance/totalfinance/performance/metrics"},{"title":"TimeWeightedReturnInput","url":"/reference/totalfinance/performance/page-4#TimeWeightedReturnInput","description":"Input for {@link timeWeightedReturn}.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  annualization annualization.basis externalCashFlows flowTiming valuations @insiderfinance/totalfinance/performance/flow-aware"},{"title":"TimeWeightedReturnResult","url":"/reference/totalfinance/performance/page-4#TimeWeightedReturnResult","description":"Result of {@link timeWeightedReturn}.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  annualizedReturn assumptions assumptions.annualization assumptions.annualization.basis assumptions.flowConvention assumptions.flowTiming ass @insiderfinance/totalfinance/performance/flow-aware"},{"title":"TimeWeightedSubperiod","url":"/reference/totalfinance/performance/page-4#TimeWeightedSubperiod","description":"One measured subperiod between consecutive valuation dates.","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  endDate endNetAssetValue externalFlowAmount simpleReturn startDate startNetAssetValue @insiderfinance/totalfinance/performance/flow-aware"},{"title":"WinLossStatistics","url":"/reference/totalfinance/performance/page-4#WinLossStatistics","description":"Win/loss decomposition of a per-period return series (see {@link winLossStatistics}).","category":"@insiderfinance/totalfinance/performance","kind":"interface","keywords":"@insiderfinance/totalfinance/performance interface  averageLoss averageWin expectancy hitRate @insiderfinance/totalfinance/performance/ratios"},{"title":"alpha","url":"/reference/totalfinance/performance/page-4#alpha","description":"Annualized Jensen's alpha: the strategy's average return in excess of what its beta exposure to the\nbenchmark would predict, `α = ppy · (r̄ − [rf_p + β·(b̄ − rf","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/relative"},{"title":"analyze","url":"/reference/totalfinance/performance/page-4#analyze","description":"The performance summary facade (dx §2.3): plain call → the summary; `.explain()` → the core\nComputed envelope around it (the summary's own warnings ride `diagno","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/analyze"},{"title":"annualizedReturn","url":"/reference/totalfinance/performance/page-4#annualizedReturn","description":"Geometric annualized return from a per-period return series.","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/metrics"},{"title":"annualizedVolatility","url":"/reference/totalfinance/performance/page-4#annualizedVolatility","description":"Annualized volatility: per-period stddev scaled by √periodsPerYear.","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/sharpe"},{"title":"benchmarkRelativeTimeline","url":"/reference/totalfinance/performance/page-4#benchmarkRelativeTimeline","description":"Benchmark-relative timeline: aligns a portfolio total-return index with benchmark period\nreturns BY DATE and reports cumulative relative performance rows. A row","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (input) (input).benchmarkBasis (input).benchmarkReturns (input).portfolioIndex return.assumptions return.assumptions.anchorDate return.assum @insiderfinance/totalfinance/performance/flow-aware"},{"title":"beta","url":"/reference/totalfinance/performance/page-4#beta","description":"Beta: sensitivity of the strategy to the benchmark, `cov(r, b) / var(b)`.","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/relative"},{"title":"calmar","url":"/reference/totalfinance/performance/page-4#calmar","description":"Calmar ratio: annualized return divided by maximum drawdown.","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/metrics"},{"title":"contributionByGroup","url":"/reference/totalfinance/performance/page-4#contributionByGroup","description":"Single-period contribution by group: `contribution = weight × simpleReturn` per group, summing\nto the weighted total return. At single-period scope the reconcil","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (input) (input).groupReturns return.assumptions return.assumptions.formula return.assumptions.scope return.contributions return.diagnostics  @insiderfinance/totalfinance/performance/flow-aware"},{"title":"cumulativeReturns","url":"/reference/totalfinance/performance/page-4#cumulativeReturns","description":"Cumulative compounded return at each step from a series of simple returns.","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (returns) @insiderfinance/totalfinance/performance/returns"},{"title":"equityCurve","url":"/reference/totalfinance/performance/page-4#equityCurve","description":"Equity curve (growth of `start`) from a series of simple returns. The curve begins at `start` and\nhas length `returns.length + 1`, so `analyze({ equity: equityC","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (returns) (start) @insiderfinance/totalfinance/performance/returns"},{"title":"expectancy","url":"/reference/totalfinance/performance/page-4#expectancy","description":"Expectancy: the mean per-period return — `null` when undefined (empty series), exactly as\n`analyze().expectancy` reports it (one word, one shape). For the win/l","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/ratios"},{"title":"exposure","url":"/reference/totalfinance/performance/page-4#exposure","description":"Exposure facade (dx §2.3): plain call → the profile; `.explain()` → the Computed envelope.","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/activity"},{"title":"hitRate","url":"/reference/totalfinance/performance/page-4#hitRate","description":"Hit rate: fraction of non-zero periods that were positive (`wins / (wins + losses)`).","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/ratios"},{"title":"informationRatio","url":"/reference/totalfinance/performance/page-4#informationRatio","description":"Information ratio: annualized mean active return divided by annualized tracking error — the Sharpe\nratio of the active (strategy − benchmark) return series.","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/relative"},{"title":"linkSubperiodReturns","url":"/reference/totalfinance/performance/page-4#linkSubperiodReturns","description":"Explicit subperiod linking: `'geometric'` compounds (`Π(1 + rᵢ) − 1`, the time-weighted\nconvention), `'arithmetic'` sums (`Σ rᵢ`, no compounding — an approximat","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (input) (input).linking (input).subperiodReturns return.assumptions return.assumptions.formula return.assumptions.linking return.diagnostics @insiderfinance/totalfinance/performance/flow-aware"},{"title":"logReturns","url":"/reference/totalfinance/performance/page-4#logReturns","description":"Continuously-compounded (log) returns; output length is `prices.length - 1`.","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (prices) @insiderfinance/totalfinance/performance/returns"},{"title":"maxDrawdown","url":"/reference/totalfinance/performance/page-5#maxDrawdown","description":"Maximum drawdown facade (dx §2.3): plain call → the `DrawdownResult`; `.explain()` → the\n`Computed` envelope. `equity` is a PRICE-level series by contract, so t","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/drawdown"},{"title":"maxDrawdownFromReturns","url":"/reference/totalfinance/performance/page-5#maxDrawdownFromReturns","description":"Maximum drawdown of the growth-of-1 equity curve implied by a per-period **return** series\n(WS3.3b) — the returns-input counterpart to {@link maxDrawdown}, whic","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (returns) return.longestDurationPeriods return.maxDrawdown return.peakIndex return.recoveryIndex return.troughIndex @insiderfinance/totalfinance/performance/drawdown"},{"title":"modifiedDietzReturn","url":"/reference/totalfinance/performance/page-5#modifiedDietzReturn","description":"Classic Modified Dietz single-period return:\n`(netAssetValue₁ − netAssetValue₀ − F) / (netAssetValue₀ + Σ weightᵢ·flowᵢ)` where `F` is the\nnet external flow and","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (input) (input).externalCashFlows (input).valuations return.assumptions return.assumptions.dayCount return.assumptions.weightFormula return. @insiderfinance/totalfinance/performance/flow-aware"},{"title":"moneyWeightedReturn","url":"/reference/totalfinance/performance/page-5#moneyWeightedReturn","description":"Money-weighted return: the dated internal rate of return of the INVESTOR's cash-flow schedule,\ncomposed from `datedInternalRateOfReturn` in `@insiderfinance/tot","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (input) (input).externalCashFlows (input).valuations return.assumptions return.assumptions.asOf return.assumptions.signConvention return.dia @insiderfinance/totalfinance/performance/flow-aware"},{"title":"omega","url":"/reference/totalfinance/performance/page-5#omega","description":"Omega ratio at a per-period `threshold` (default 0): Σ gains above θ ÷ Σ losses below θ.\n\n**`null`, never `Infinity`** (Law 7): with gains but no losses the rat","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/ratios"},{"title":"portfolioReturnIndex","url":"/reference/totalfinance/performance/page-5#portfolioReturnIndex","description":"The portfolio's total-return index: the time-weighted subperiod returns (same flow convention\nand gap rules as {@link timeWeightedReturn}) chained geometrically","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (input) (input).baseValue (input).externalCashFlows (input).valuations return.assumptions return.assumptions.baseValue return.assumptions.fl @insiderfinance/totalfinance/performance/flow-aware"},{"title":"profitFactor","url":"/reference/totalfinance/performance/page-5#profitFactor","description":"Profit factor: gross gains ÷ gross losses.\n\n**`null`, never `Infinity`** (Law 7): a series with gains but no losses has an unbounded profit\nfactor, and a series","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/ratios"},{"title":"rollingReturn","url":"/reference/totalfinance/performance/page-5#rollingReturn","description":"Rolling compounded return over a trailing window (`Π(1 + r) − 1`), aligned to the input index with\nthe leading `window − 1` entries set to `NaN`.","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/rolling"},{"title":"rollingSharpe","url":"/reference/totalfinance/performance/page-5#rollingSharpe","description":"Rolling annualized Sharpe ratio over a trailing window (leading `window − 1` entries are `NaN`).","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/rolling"},{"title":"rollingVolatility","url":"/reference/totalfinance/performance/page-5#rollingVolatility","description":"Rolling annualized volatility over a trailing window (leading `window − 1` entries are `NaN`).\n`options.periodsPerYear` defaults to 252 — matching every other `","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/rolling"},{"title":"sectorPerformance","url":"/reference/totalfinance/performance/page-5#sectorPerformance","description":"Equal-weight sectors from same-period decimal returns. Rows are open observations, the request\nis closed. Inputs are copied, never mutated; identities, not tick","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function sectorPerformance({ members: [{ securityId: 'A', sectorId: 'technology', sectorName: 'Technology', p (input) (input).members return.assumptions return.assumptions.policyVersion return.assumptions.rankingAndTies return.assumptions.returnBasis @insiderfinance/totalfinance/performance/sector-performance"},{"title":"sectorPerformanceSnapshot","url":"/reference/totalfinance/performance/page-5#sectorPerformanceSnapshot","description":"Calculate one target session's audited sector returns from governed inputs.\n\nThe function is deterministic and pure: it performs no I/O, reads no clock, mutates","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (input) (input).classificationTaxonomy (input).classifications (input).completedSessions (input).cutoffs (input).eligibleUniverse (input).ma @insiderfinance/totalfinance/performance/sector-performance"},{"title":"segmentExternalFlows","url":"/reference/totalfinance/performance/page-5#segmentExternalFlows","description":"External-flow segmentation: totals by account plus the net, with transfers BETWEEN accounts of\none portfolio identified and reported as internal — a transfer ne","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (input) (input).accountFilter (input).externalCashFlows return.assumptions return.assumptions.accountFilter return.assumptions.transferIdent @insiderfinance/totalfinance/performance/flow-aware"},{"title":"sharpe","url":"/reference/totalfinance/performance/page-5#sharpe","description":"Annualized Sharpe ratio of a per-period return series.","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/sharpe"},{"title":"simpleReturns","url":"/reference/totalfinance/performance/page-5#simpleReturns","description":"Simple period-over-period returns; output length is `prices.length - 1`. A zero price before the\nfinal observation throws (that period's return divides by zero)","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (prices) @insiderfinance/totalfinance/performance/returns"},{"title":"sortino","url":"/reference/totalfinance/performance/page-5#sortino","description":"Annualized Sortino ratio (downside-deviation-adjusted).","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/metrics"},{"title":"timeWeightedReturn","url":"/reference/totalfinance/performance/page-5#timeWeightedReturn","description":"Time-weighted return: simple returns between consecutive valuation dates, linked geometrically.\n\nFlow convention (also echoed in `assumptions.flowConvention`): ","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (input) (input).annualization (input).externalCashFlows (input).flowTiming (input).valuations return.annualizedReturn return.assumptions ret @insiderfinance/totalfinance/performance/flow-aware"},{"title":"trackingError","url":"/reference/totalfinance/performance/page-5#trackingError","description":"Annualized tracking error: the volatility of the active (strategy − benchmark) return series.","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/relative"},{"title":"treynor","url":"/reference/totalfinance/performance/page-5#treynor","description":"Treynor ratio: excess (over risk-free) annualized return per unit of systematic risk (beta),\n`(annualizedReturn − rf) / β`. Uses the geometric annualized return","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/relative"},{"title":"turnover","url":"/reference/totalfinance/performance/page-5#turnover","description":"Turnover facade (dx §2.3): plain call → the ratio; `.explain()` → the Computed envelope.","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/activity"},{"title":"underwater","url":"/reference/totalfinance/performance/page-6#underwater","description":"Per-period drawdown series (input-aligned): the fractional decline from the running peak at each\nindex, as a non-negative number (0 at a fresh high). The series","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (equity) @insiderfinance/totalfinance/performance/drawdown"},{"title":"winLossStatistics","url":"/reference/totalfinance/performance/page-6#winLossStatistics","description":"function from @insiderfinance/totalfinance/performance","category":"@insiderfinance/totalfinance/performance","kind":"function","keywords":"@insiderfinance/totalfinance/performance function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/performance/ratios"},{"title":"ANNUALIZATION_KEYS","url":"/reference/totalfinance/performance/sharpe#ANNUALIZATION_KEYS","description":"Law 12 allowlist for {@link AnnualizationOptions} — a `periodsPeryear` typo teaches, never silently annualizes at 252.","category":"@insiderfinance/totalfinance/performance/sharpe","kind":"value","keywords":"@insiderfinance/totalfinance/performance/sharpe value  "},{"title":"AnnualizationExtra","url":"/reference/totalfinance/performance/sharpe#AnnualizationExtra","description":"Conventions disclosed by an annualization-only metric.","category":"@insiderfinance/totalfinance/performance/sharpe","kind":"type","keywords":"@insiderfinance/totalfinance/performance/sharpe type  periodsPerYear"},{"title":"DEFAULT_PERIODS_PER_YEAR","url":"/reference/totalfinance/performance/sharpe#DEFAULT_PERIODS_PER_YEAR","description":"The daily-data annualization convention. It is an industry constant (252 trading days), not a\nhidden finance choice — so it DEFAULTS when omitted and is echoed ","category":"@insiderfinance/totalfinance/performance/sharpe","kind":"value","keywords":"@insiderfinance/totalfinance/performance/sharpe value  "},{"title":"RiskAdjustedExtra","url":"/reference/totalfinance/performance/sharpe#RiskAdjustedExtra","description":"Conventions disclosed by a risk-adjusted (excess-return) metric.","category":"@insiderfinance/totalfinance/performance/sharpe","kind":"type","keywords":"@insiderfinance/totalfinance/performance/sharpe type  periodsPerYear riskFreeRate"},{"title":"SHARPE_KEYS","url":"/reference/totalfinance/performance/sharpe#SHARPE_KEYS","description":"Law 12 allowlist for {@link SharpeOptions} — the parent's keys plus the risk-free rate.","category":"@insiderfinance/totalfinance/performance/sharpe","kind":"value","keywords":"@insiderfinance/totalfinance/performance/sharpe value  "},{"title":"annualizationAssumptions","url":"/reference/totalfinance/performance/sharpe#annualizationAssumptions","description":"Assumptions echoing just the annualization factor.","category":"@insiderfinance/totalfinance/performance/sharpe","kind":"function","keywords":"@insiderfinance/totalfinance/performance/sharpe function  (periodsPerYear) return.asOf return.calendar return.calendarVersion return.compounding return.conventionsVersion return.dayCount return.divi"},{"title":"degenerateAwareDiagnostics","url":"/reference/totalfinance/performance/sharpe#degenerateAwareDiagnostics","description":"Degenerate-NaN honesty (design law #4: a NaN result must ride with an explicit diagnostic, never\nalone). Wraps {@link returnsDiagnostics} and — when the compute","category":"@insiderfinance/totalfinance/performance/sharpe","kind":"function","keywords":"@insiderfinance/totalfinance/performance/sharpe function  (functionName) (reason) (series) (value) return.autoReason return.converged return.decomposition return.engine return.finiteDifferenceBumps "},{"title":"requireSeries","url":"/reference/totalfinance/performance/sharpe#requireSeries","description":"Boundary guard for every series-consuming performance facade (dx §1.2 applied here): the input\nmust be a real array (or typed array) of numbers — a string, `und","category":"@insiderfinance/totalfinance/performance/sharpe","kind":"function","keywords":"@insiderfinance/totalfinance/performance/sharpe function  (field) (functionName) (series)"},{"title":"returnsDiagnostics","url":"/reference/totalfinance/performance/sharpe#returnsDiagnostics","description":"Diagnostics for a returns-consuming explain path (dx WS-3/R6): flags any input series whose\nvalues look like prices rather than per-period decimal returns. Shar","category":"@insiderfinance/totalfinance/performance/sharpe","kind":"function","keywords":"@insiderfinance/totalfinance/performance/sharpe function  (series) return.autoReason return.converged return.decomposition return.engine return.finiteDifferenceBumps return.iterations return.method "},{"title":"riskAdjustedAssumptions","url":"/reference/totalfinance/performance/sharpe#riskAdjustedAssumptions","description":"Assumptions echoing the annualization factor and the applied risk-free rate.","category":"@insiderfinance/totalfinance/performance/sharpe","kind":"function","keywords":"@insiderfinance/totalfinance/performance/sharpe function  (input) (input).periodsPerYear (input).riskFreeRate return.asOf return.calendar return.calendarVersion return.compounding return.conventions"},{"title":"AccountMigrationMarker","url":"/reference/totalfinance/portfolio#AccountMigrationMarker","description":"An account-migration marker as folded (slice 3): the fact IS the marker; no economic effect.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  effectiveTimestampMs eventId fromAccountId toAccountId"},{"title":"AccountState","url":"/reference/totalfinance/portfolio#AccountState","description":"One account's derived facts. Accumulators are keyed by uppercase currency code.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  cashBalances financingCosts incomeByInstrument incomeReceived positions realizedPnl realizedPnlByInstrument transactionCosts transactionCost"},{"title":"AdminAccountMigrationEvent","url":"/reference/totalfinance/portfolio#AdminAccountMigrationEvent","description":"An audit marker that an account's identity moved; no economic effect (the marker is the fact).","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  eventType fromAccountId reason toAccountId @insiderfinance/totalfinance/portfolio/events"},{"title":"AdminCorrectionEvent","url":"/reference/totalfinance/portfolio#AdminCorrectionEvent","description":"Reverse an applied fact exactly and record what it should have been, atomically. The\n`replacement` folds at the ORIGINAL's effective instant (so lot order and s","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  eventType original original.accountId original.causationId original.correlationId original.effectiveTimestampMs original.event original.even @insiderfinance/totalfinance/portfolio/events"},{"title":"AdminReversalEvent","url":"/reference/totalfinance/portfolio#AdminReversalEvent","description":"Reverse an applied fact EXACTLY. The envelope's `reversesEventId` names it; `original` carries\nthe applied envelope verbatim so the fold can prove (by content h","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  eventType original original.accountId original.causationId original.correlationId original.effectiveTimestampMs original.event original.even @insiderfinance/totalfinance/portfolio/events"},{"title":"AllocatePortfolioInput","url":"/reference/totalfinance/portfolio#AllocatePortfolioInput","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  asOf baseCurrency cashReserve contractMultipliers currencyConversions currentHoldings defaultLotSize instrumentClassification lotSizes minim @insiderfinance/totalfinance/portfolio/policy"},{"title":"AllocatePortfolioResult","url":"/reference/totalfinance/portfolio#AllocatePortfolioResult","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  allocations asOf assumptions assumptions.conventionsVersion assumptions.costModel assumptions.currencyConversionsUsed assumptions.pricing as @insiderfinance/totalfinance/portfolio/policy"},{"title":"AllocationCash","url":"/reference/totalfinance/portfolio#AllocationCash","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  achievedWeight reserve residualAmount targetAmount targetWeight @insiderfinance/totalfinance/portfolio/policy"},{"title":"AllocationDustRow","url":"/reference/totalfinance/portfolio#AllocationDustRow","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  instrumentId reason tradeNotional @insiderfinance/totalfinance/portfolio/policy"},{"title":"AllocationPrice","url":"/reference/totalfinance/portfolio#AllocationPrice","description":"One instrument's price at the allocation instant, in its trading currency.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  currency price @insiderfinance/totalfinance/portfolio/policy"},{"title":"AllocationRow","url":"/reference/totalfinance/portfolio#AllocationRow","description":"One instrument's sizing. Notionals are base currency.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  achievedWeight contractMultiplier currency currentQuantity dust implied instrumentId lotSize price priceInBaseCurrency roundingResidualNotio @insiderfinance/totalfinance/portfolio/policy"},{"title":"AllocationSizing","url":"/reference/totalfinance/portfolio#AllocationSizing","description":"The validated sizing grammar. `null` = not supplied (fractional quantities / no dust threshold).","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  defaultLotSize lotSizes minimumNotional transactionCosts transactionCosts.commissionPerTrade transactionCosts.commissionPerUnit transactionC @insiderfinance/totalfinance/portfolio/policy"},{"title":"AllocationSizingInput","url":"/reference/totalfinance/portfolio#AllocationSizingInput","description":"The sizing grammar {@link allocatePortfolio} and `proposePortfolioRebalance` share.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  defaultLotSize lotSizes minimumNotional transactionCosts transactionCosts.commissionPerTrade transactionCosts.commissionPerUnit transactionC @insiderfinance/totalfinance/portfolio/policy"},{"title":"AllocationTarget","url":"/reference/totalfinance/portfolio#AllocationTarget","description":"One allocation goal. Exactly one of `weight` (share of NAV) or `riskBudget` (share of risk).","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  driftBand group group.assetClass group.currency group.instrumentId group.sleeveId group.strategy group.tag group.underlying riskBudget weigh @insiderfinance/totalfinance/portfolio/policy"},{"title":"AllocationTrade","url":"/reference/totalfinance/portfolio#AllocationTrade","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  currency estimatedCost estimatedNotional instrumentId quantity side @insiderfinance/totalfinance/portfolio/policy"},{"title":"AllocationTransactionCosts","url":"/reference/totalfinance/portfolio#AllocationTransactionCosts","description":"The transaction-cost model — every term optional and explicit; an omitted term estimates 0.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  commissionPerTrade commissionPerUnit slippageBasisPoints spreadBasisPoints @insiderfinance/totalfinance/portfolio/policy"},{"title":"ApplyJournalEventsInput","url":"/reference/totalfinance/portfolio#ApplyJournalEventsInput","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  events previousState previousState.duplicateEventIds previousState.eventCount previousState.eventIds previousState.journalId previousState.o @insiderfinance/totalfinance/portfolio/trade"},{"title":"ApplyJournalEventsResult","url":"/reference/totalfinance/portfolio#ApplyJournalEventsResult","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  applied diagnostics diagnostics.duplicateCount diagnostics.eventCount diagnostics.lateFillCount diagnostics.orderCount diagnostics.unresolve @insiderfinance/totalfinance/portfolio/trade"},{"title":"ApplyPortfolioEventsInput","url":"/reference/totalfinance/portfolio#ApplyPortfolioEventsInput","description":"Input for {@link applyPortfolioEvents}: exactly ONE of `portfolio` (fresh) or `previousState`.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  events portfolio portfolio.baseCurrency portfolio.lotRelief portfolio.portfolioId previousState previousState.accountMigrations previousStat"},{"title":"AuthorizationGrant","url":"/reference/totalfinance/portfolio#AuthorizationGrant","description":"Human authority bound to one plan, one preflight, and the snapshots they were judged against.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  accountId approvedBy baseCurrency comboIds contentHash expiresAt grantId idempotencyKeys issuedAt kind marketAsOf marketHash marketMaximumAg @insiderfinance/totalfinance/portfolio/trade"},{"title":"BenchmarkConstituent","url":"/reference/totalfinance/portfolio/page-2#BenchmarkConstituent","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  instrumentId weight @insiderfinance/totalfinance/portfolio/policy"},{"title":"BenchmarkIdentity","url":"/reference/totalfinance/portfolio/page-2#BenchmarkIdentity","description":"Benchmark identity — a name and, when known, its dated membership.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  asOf benchmarkId constituents @insiderfinance/totalfinance/portfolio/policy"},{"title":"CashBalance","url":"/reference/totalfinance/portfolio/page-2#CashBalance","description":"One currency's cash: the booked total plus the settlement schedule of its dated legs.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  settlementSchedule totalAmount"},{"title":"CashConversionEvent","url":"/reference/totalfinance/portfolio/page-2#CashConversionEvent","description":"A realized FX conversion between two cash balances of one account. Both legs are explicit\namounts — the realized rate is `toAmount / fromAmount`; no rate arithm","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  eventType fromAmount fromCurrency toAmount toCurrency @insiderfinance/totalfinance/portfolio/events"},{"title":"CashDepositEvent","url":"/reference/totalfinance/portfolio/page-2#CashDepositEvent","description":"External money INTO the portfolio — an external flow, never investment profit (FC4's law).","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  amount currency eventType settleTimestampMs @insiderfinance/totalfinance/portfolio/events"},{"title":"CashDifference","url":"/reference/totalfinance/portfolio/page-2#CashDifference","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  currency explanation explanation.detail explanation.kind explanation.ratio externalSettled externalTotal ledgerSettled ledgerTotal ledgerUns @insiderfinance/totalfinance/portfolio/reconciliation"},{"title":"CashInLieuEvent","url":"/reference/totalfinance/portfolio/page-2#CashInLieuEvent","description":"Cash in lieu of a fractional quantity surrendered (after a split, merger, or spin-off).","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  amount currency eventType instrumentId quantity relatesToEventId settleTimestampMs @insiderfinance/totalfinance/portfolio/events"},{"title":"CashTransferEvent","url":"/reference/totalfinance/portfolio/page-2#CashTransferEvent","description":"Cash moved between two accounts of the SAME portfolio — internal, never an external flow.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  amount currency eventType fromAccountId toAccountId @insiderfinance/totalfinance/portfolio/events"},{"title":"CashWithdrawalEvent","url":"/reference/totalfinance/portfolio/page-2#CashWithdrawalEvent","description":"External money OUT of the portfolio — an external flow, never investment loss.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  amount currency eventType settleTimestampMs @insiderfinance/totalfinance/portfolio/events"},{"title":"CompareDisclosedHoldingPartitionsInput","url":"/reference/totalfinance/portfolio/page-2#CompareDisclosedHoldingPartitionsInput","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  baseline baseline.comparisonEligible baseline.evidenceIds baseline.holdings baseline.managerId baseline.mappingComplete baseline.periodEnd b @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"CompareDisclosedHoldingsInput","url":"/reference/totalfinance/portfolio/page-2#CompareDisclosedHoldingsInput","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  baseline baseline.comparisonEligible baseline.evidenceIds baseline.holdings baseline.managerId baseline.mappingComplete baseline.periodEnd b @insiderfinance/totalfinance/portfolio/disclosed-holdings"},{"title":"ContractMultiplierChangeEvent","url":"/reference/totalfinance/portfolio/page-2#ContractMultiplierChangeEvent","description":"A contract adjustment rescales the multiplier; total basis is preserved exactly.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  contractMultiplierAfter eventType instrumentId reason strikePricePerUnitAfter @insiderfinance/totalfinance/portfolio/events"},{"title":"ContributionHandling","url":"/reference/totalfinance/portfolio/page-2#ContributionHandling","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/policy"},{"title":"CostChargeEvent","url":"/reference/totalfinance/portfolio/page-2#CostChargeEvent","description":"An explicit transaction cost — a SEPARATE event, never folded into lot cost basis (FC7\nmandatory state: costs are separate components), attributed via `instrume","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  amount costType currency eventType instrumentId relatesToEventId @insiderfinance/totalfinance/portfolio/events"},{"title":"CostType","url":"/reference/totalfinance/portfolio/page-2#CostType","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/events"},{"title":"CreateAuthorizationGrantInput","url":"/reference/totalfinance/portfolio/page-2#CreateAuthorizationGrantInput","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  account approvedBy expiresAt grantId idempotencyKeys idempotencyKeys.count idempotencyKeys.prefix marketHash marketMaximumAgeMs mode now pla @insiderfinance/totalfinance/portfolio/trade"},{"title":"CreatePortfolioLedgerInput","url":"/reference/totalfinance/portfolio/page-2#CreatePortfolioLedgerInput","description":"Input for {@link createPortfolioLedger}.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  baseCurrency events lotRelief portfolioId provenance provenance.asOf provenance.dataset provenance.provider provenance.receivedAt provenance @insiderfinance/totalfinance/portfolio/ledger"},{"title":"CurrencyPairQuote","url":"/reference/totalfinance/portfolio/page-2#CurrencyPairQuote","description":"One spot exchange-rate quote — `@insiderfinance/totalfinance/foreign-exchange`'s (FC5) `CurrencyPairQuote`\nvocabulary, reused STRUCTURALLY because the FC0 depen","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  baseCurrency quoteCurrency quotePerBase @insiderfinance/totalfinance/portfolio/performance"},{"title":"DerivativeContractTerms","url":"/reference/totalfinance/portfolio/page-2#DerivativeContractTerms","description":"The terms a derivative position carries from its opening fill.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  expiryTimestampMs kind strikePricePerUnit type underlyingInstrumentId @insiderfinance/totalfinance/portfolio/events"},{"title":"DerivativeRollEvent","url":"/reference/totalfinance/portfolio/page-2#DerivativeRollEvent","description":"Close a contract and open its successor in one economic event (one provenance).","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  closePricePerUnit contract contract.expiryTimestampMs contract.kind contract.strikePricePerUnit contract.type contract.underlyingInstrumentI @insiderfinance/totalfinance/portfolio/events"},{"title":"DerivativeSettlement","url":"/reference/totalfinance/portfolio/page-3#DerivativeSettlement","description":"Physical delivery of the underlying at the strike, or cash at an explicit settlement price.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  kind settlementPricePerUnit @insiderfinance/totalfinance/portfolio/events"},{"title":"DisclosedHolding","url":"/reference/totalfinance/portfolio/page-3#DisclosedHolding","description":"A source holding observation. Extra metadata is accepted but is not consumed or copied.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  classId evidenceIds holdingId instrumentType investmentDiscretion issuerId mappingStatus otherManagerIds putCall quantity quantityUnit repor @insiderfinance/totalfinance/portfolio/disclosed-holdings"},{"title":"DisclosedHoldingChange","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingChange","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  baselineHoldingIds baselineQuantity baselineReportedValue classId classification currentHoldingIds currentQuantity currentReportedValue issu @insiderfinance/totalfinance/portfolio/disclosed-holdings"},{"title":"DisclosedHoldingChangeReason","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingChangeReason","description":"Snapshot eligibility codes identify the side; row and currency codes describe the pair.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/disclosed-holdings"},{"title":"DisclosedHoldingPartition","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingPartition","description":"A source holding observation. Extra metadata is accepted but is not consumed or copied.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  classId evidenceIds holdingId instrumentType investmentDiscretion issuerId mappingStatus otherManagerReferences putCall quantity quantityUni @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"DisclosedHoldingPartitionChange","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingPartitionChange","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  baselineHoldingIds baselineQuantity baselineReportedValue classification currentHoldingIds currentQuantity currentReportedValue issuerId par @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"DisclosedHoldingPartitionChangeReason","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingPartitionChangeReason","description":"Snapshot eligibility codes identify the side; row and currency codes describe the pair.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"DisclosedHoldingPartitionKey","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingPartitionKey","description":"Reported line basis; sourceReportId is present only with filing-local references.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  classId investmentDiscretion otherManagerReferences securityId sourceReportId @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"DisclosedHoldingPartitionReason","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingPartitionReason","description":"Library-generated row/position review codes; source reviewReasons remain free-form.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"DisclosedHoldingPartitionResult","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingPartitionResult","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  evidenceIds holdingIds issuerId partitionKey partitionKey.classId partitionKey.investmentDiscretion partitionKey.otherManagerReferences part @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"DisclosedHoldingPartitionRowResult","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingPartitionRowResult","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  classId evidenceIds holdingId instrumentType investmentDiscretion issuerId mappingStatus normalizedReportedValue otherManagerReferences part @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"DisclosedHoldingPartitionsConcentration","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingPartitionsConcentration","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  denominatorReportedValue largestPartitionWeight partitionHerfindahlIndex reasons status valueCurrency @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"DisclosedHoldingPartitionsConcentrationReason","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingPartitionsConcentrationReason","description":"Zero totals additionally withhold ratios, but do not invalidate otherwise justified absence.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"DisclosedHoldingPartitionsPolicy","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingPartitionsPolicy","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  discretionPolicy ratioDecimalPlaces supportedProfile @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"DisclosedHoldingPartitionsReport","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingPartitionsReport","description":"Rich JSON-safe report directly accepted by createAnalysisArtifact.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  assumptions assumptions.changes assumptions.denominator assumptions.discretion assumptions.partitionBasis assumptions.policy assumptions.pol @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"DisclosedHoldingPartitionsSnapshot","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingPartitionsSnapshot","description":"Selected disclosure facts, not a cash/transaction portfolio or amendment-selection request.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  comparisonEligible evidenceIds holdings managerId mappingComplete periodEnd reportComplete reportIds reviewReasons @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"DisclosedHoldingPartitionsSnapshotReason","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingPartitionsSnapshotReason","description":"Reasons the supplied universe cannot establish absence or comparable whole-universe totals.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"DisclosedHoldingPartitionsSnapshotReport","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingPartitionsSnapshotReport","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  comparisonEligible concentration concentration.denominatorReportedValue concentration.largestPartitionWeight concentration.partitionHerfinda @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"DisclosedHoldingReason","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingReason","description":"Library-generated row/position review codes; source reviewReasons remain free-form.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/disclosed-holdings"},{"title":"DisclosedHoldingResult","url":"/reference/totalfinance/portfolio/page-3#DisclosedHoldingResult","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  classId evidenceIds holdingId instrumentType investmentDiscretion issuerId mappingStatus normalizedReportedValue otherManagerIds putCall qua @insiderfinance/totalfinance/portfolio/disclosed-holdings"},{"title":"DisclosedHoldingsConcentration","url":"/reference/totalfinance/portfolio/page-4#DisclosedHoldingsConcentration","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  denominatorReportedValue herfindahlIndex largestWeight reasons status valueCurrency @insiderfinance/totalfinance/portfolio/disclosed-holdings"},{"title":"DisclosedHoldingsConcentrationReason","url":"/reference/totalfinance/portfolio/page-4#DisclosedHoldingsConcentrationReason","description":"Zero totals additionally withhold ratios, but do not invalidate otherwise justified absence.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/disclosed-holdings"},{"title":"DisclosedHoldingsPolicy","url":"/reference/totalfinance/portfolio/page-4#DisclosedHoldingsPolicy","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  discretionPolicy ratioDecimalPlaces supportedProfile @insiderfinance/totalfinance/portfolio/disclosed-holdings"},{"title":"DisclosedHoldingsReport","url":"/reference/totalfinance/portfolio/page-4#DisclosedHoldingsReport","description":"Rich JSON-safe report directly accepted by createAnalysisArtifact.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  assumptions assumptions.changes assumptions.denominator assumptions.discretion assumptions.policy assumptions.policy.discretionPolicy assump @insiderfinance/totalfinance/portfolio/disclosed-holdings"},{"title":"DisclosedHoldingsSnapshot","url":"/reference/totalfinance/portfolio/page-4#DisclosedHoldingsSnapshot","description":"Selected disclosure facts, not a cash/transaction portfolio or amendment-selection request.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  comparisonEligible evidenceIds holdings managerId mappingComplete periodEnd reportComplete reportIds reviewReasons @insiderfinance/totalfinance/portfolio/disclosed-holdings"},{"title":"DisclosedHoldingsSnapshotReason","url":"/reference/totalfinance/portfolio/page-4#DisclosedHoldingsSnapshotReason","description":"Reasons the supplied universe cannot establish absence or comparable whole-universe totals.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/disclosed-holdings"},{"title":"DisclosedHoldingsSnapshotReport","url":"/reference/totalfinance/portfolio/page-4#DisclosedHoldingsSnapshotReport","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  comparisonEligible concentration concentration.denominatorReportedValue concentration.herfindahlIndex concentration.largestWeight concentrat @insiderfinance/totalfinance/portfolio/disclosed-holdings"},{"title":"DisclosedPositionResult","url":"/reference/totalfinance/portfolio/page-4#DisclosedPositionResult","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  classId evidenceIds holdingIds issuerId quantity reasons reportedValue securityId status valueCurrency weight @insiderfinance/totalfinance/portfolio/disclosed-holdings"},{"title":"DisclosedUncomparedHoldingPartition","url":"/reference/totalfinance/portfolio/page-4#DisclosedUncomparedHoldingPartition","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  classification evidenceIds holdingIds issuerId partitionKey partitionKey.classId partitionKey.investmentDiscretion partitionKey.otherManager @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"EconomicPortfolioEvent","url":"/reference/totalfinance/portfolio/page-4#EconomicPortfolioEvent","description":"The events with an economic effect — everything an `admin.*` event can reference or replace.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  accruedInterest amount amountPerShare basisAllocationFraction cashPerShare childInstrumentId closePricePerUnit contract contract.expiryTimes @insiderfinance/totalfinance/portfolio/events"},{"title":"ExecutionJournalEvent","url":"/reference/totalfinance/portfolio/page-4#ExecutionJournalEvent","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  detail detail.accountId detail.artifactHash detail.baseCurrency detail.comboId detail.executionPolicyHash detail.fill detail.fill.accountId  @insiderfinance/totalfinance/portfolio/trade"},{"title":"ExecutionJournalState","url":"/reference/totalfinance/portfolio/page-4#ExecutionJournalState","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  duplicateEventIds eventCount eventIds journalId orders preSubmission @insiderfinance/totalfinance/portfolio/trade"},{"title":"ExecutionOrderState","url":"/reference/totalfinance/portfolio/page-4#ExecutionOrderState","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  averageFillPrice cancelRequested fillIds filledQuantity lastEventId lastTimestampMs lateFillIds orderId planHash reason reconciledEventId re @insiderfinance/totalfinance/portfolio/trade"},{"title":"ExecutionPlan","url":"/reference/totalfinance/portfolio/page-4#ExecutionPlan","description":"The normalized, content-addressed plan every later stage binds to — the actionable boundary.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  accountId asOf baseCurrency combos contentHash evidence kind orders portfolioId rationale schemaVersion source source.intentHash source.kind @insiderfinance/totalfinance/portfolio/trade"},{"title":"ExpandedTargets","url":"/reference/totalfinance/portfolio/page-4#ExpandedTargets","description":"The expansion of group targets to instrument targets — what allocation and rebalancing act on.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  cashTarget cashTarget.driftBand cashTarget.implied cashTarget.targetWeight declaredWeightTotal groupTargets instrumentTargets unresolved war @insiderfinance/totalfinance/portfolio/policy"},{"title":"ExternalAccountSnapshot","url":"/reference/totalfinance/portfolio/page-4#ExternalAccountSnapshot","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  cash positions @insiderfinance/totalfinance/portfolio/reconciliation"},{"title":"ExternalCashBalance","url":"/reference/totalfinance/portfolio/page-4#ExternalCashBalance","description":"One currency's cash as the external source reports it. `settled` is optional — many report only totals.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  settled total @insiderfinance/totalfinance/portfolio/reconciliation"},{"title":"ExternalFlow","url":"/reference/totalfinance/portfolio/page-4#ExternalFlow","description":"A planned contribution (`amount > 0`) or withdrawal (`amount < 0`) at `asOf`.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  amount currency @insiderfinance/totalfinance/portfolio/policy"},{"title":"ExternalPortfolioSnapshot","url":"/reference/totalfinance/portfolio/page-4#ExternalPortfolioSnapshot","description":"A normalized external snapshot — the shape adapters produce from broker/custodian statements.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  accounts asOf source @insiderfinance/totalfinance/portfolio/reconciliation"},{"title":"ExternalPosition","url":"/reference/totalfinance/portfolio/page-4#ExternalPosition","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  costBasis currency instrumentId quantity @insiderfinance/totalfinance/portfolio/reconciliation"},{"title":"FillEffect","url":"/reference/totalfinance/portfolio/page-5#FillEffect","description":"What one applied fill did — the facts an exact reversal needs (slice 3).","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  accountId accruedInterest cashDelta currency instrumentId openedLotIds realizedPnl relievedQuantity"},{"title":"FinancingChargeEvent","url":"/reference/totalfinance/portfolio/page-5#FinancingChargeEvent","description":"A financing charge paid in cash — margin interest, borrow fee, or perpetual funding paid.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  amount currency eventType financingType instrumentId @insiderfinance/totalfinance/portfolio/events"},{"title":"FinancingType","url":"/reference/totalfinance/portfolio/page-5#FinancingType","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/events"},{"title":"FixedIncomeRedemptionEvent","url":"/reference/totalfinance/portfolio/page-5#FixedIncomeRedemptionEvent","description":"Principal settled on a fixed-income position: long or short lots relieved at the redemption\nprice. Long holdings receive principal; short holdings pay it. Direc","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  currency eventType instrumentId lotSelections pricePerUnit quantity redemptionType settleTimestampMs @insiderfinance/totalfinance/portfolio/events"},{"title":"FutureContractTerms","url":"/reference/totalfinance/portfolio/page-5#FutureContractTerms","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  expiryTimestampMs kind underlyingInstrumentId @insiderfinance/totalfinance/portfolio/events"},{"title":"GlidePath","url":"/reference/totalfinance/portfolio/page-5#GlidePath","description":"Dated strategic target sets along a horizon; `interpolation` is REQUIRED (never guessed).","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  interpolation points @insiderfinance/totalfinance/portfolio/policy"},{"title":"GlidePathPoint","url":"/reference/totalfinance/portfolio/page-5#GlidePathPoint","description":"One glide-path point: a dated target set that runs until the next point (no `effectiveTo`).","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  effectiveFrom note targets @insiderfinance/totalfinance/portfolio/policy"},{"title":"GrantVerification","url":"/reference/totalfinance/portfolio/page-5#GrantVerification","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  assumptions assumptions.bindingConvention assumptions.conventionsVersion assumptions.marketAgeMs assumptions.marketAsOf assumptions.marketMa @insiderfinance/totalfinance/portfolio/trade"},{"title":"GroupTarget","url":"/reference/totalfinance/portfolio/page-5#GroupTarget","description":"One group target after membership resolution.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  driftBand group group.assetClass group.currency group.instrumentId group.sleeveId group.strategy group.tag group.underlying key members targ @insiderfinance/totalfinance/portfolio/policy"},{"title":"GroupWeightLimit","url":"/reference/totalfinance/portfolio/page-5#GroupWeightLimit","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  group group.assetClass group.currency group.instrumentId group.sleeveId group.strategy group.tag group.underlying maximumWeight @insiderfinance/totalfinance/portfolio/policy"},{"title":"IncomeReceivedEvent","url":"/reference/totalfinance/portfolio/page-5#IncomeReceivedEvent","description":"Income cash effect — dividend, coupon, interest, staking reward, or funding receipt.\nDespite the historical `income.received` event name, dividends and coupons ","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  amount currency eventType incomeType instrumentId settleTimestampMs @insiderfinance/totalfinance/portfolio/events"},{"title":"IncomeReinvestment","url":"/reference/totalfinance/portfolio/page-5#IncomeReinvestment","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/policy"},{"title":"IncomeType","url":"/reference/totalfinance/portfolio/page-5#IncomeType","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/events"},{"title":"InstrumentClassification","url":"/reference/totalfinance/portfolio/page-5#InstrumentClassification","description":"Caller-supplied identity metadata for grouping; every field optional, unknown instruments group as `unclassified`.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  assetClass strategy tags underlying @insiderfinance/totalfinance/portfolio/performance"},{"title":"InstrumentTarget","url":"/reference/totalfinance/portfolio/page-5#InstrumentTarget","description":"One instrument's resolved target after group expansion.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  driftBand implied instrumentId sourceGroups targetWeight @insiderfinance/totalfinance/portfolio/policy"},{"title":"InvestmentPolicy","url":"/reference/totalfinance/portfolio/page-5#InvestmentPolicy","description":"The user-supplied investment policy (agent-native \"Investment policy\"). Targets come inline or\nfrom a model artifact — never both. Everything else is optional a","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  allowedAccounts allowedInstruments benchmark benchmark.asOf benchmark.benchmarkId benchmark.constituents contributionHandling driftBand inco @insiderfinance/totalfinance/portfolio/policy"},{"title":"LiabilityEntry","url":"/reference/totalfinance/portfolio/page-5#LiabilityEntry","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  amount currency date @insiderfinance/totalfinance/portfolio/policy"},{"title":"LiabilitySchedule","url":"/reference/totalfinance/portfolio/page-5#LiabilitySchedule","description":"A schedule of dated liabilities / planned withdrawals the portfolio must fund.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  entries note @insiderfinance/totalfinance/portfolio/policy"},{"title":"LotReliefPolicy","url":"/reference/totalfinance/portfolio/page-5#LotReliefPolicy","description":"The decided lot-relief set (agent-native doc, \"Initial accounting scope\").","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/ledger"},{"title":"MODEL_PORTFOLIO_KIND","url":"/reference/totalfinance/portfolio/page-5#MODEL_PORTFOLIO_KIND","description":"value from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio value   @insiderfinance/totalfinance/portfolio/policy"},{"title":"MODEL_PORTFOLIO_SCHEMA_VERSION","url":"/reference/totalfinance/portfolio/page-6#MODEL_PORTFOLIO_SCHEMA_VERSION","description":"value from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio value   @insiderfinance/totalfinance/portfolio/policy"},{"title":"MONITOR_ALERT_FAMILIES","url":"/reference/totalfinance/portfolio/page-6#MONITOR_ALERT_FAMILIES","description":"value from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio value   @insiderfinance/totalfinance/portfolio/policy"},{"title":"MONITOR_LIQUIDITY_PARTICIPATION_RATE","url":"/reference/totalfinance/portfolio/page-6#MONITOR_LIQUIDITY_PARTICIPATION_RATE","description":"Days to liquidate = |quantity| ÷ (averageDailyVolume × this rate). Stated in assumptions.","category":"@insiderfinance/totalfinance/portfolio","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio value   @insiderfinance/totalfinance/portfolio/policy"},{"title":"MergerEvent","url":"/reference/totalfinance/portfolio/page-6#MergerEvent","description":"A merger: stock-for-stock (`sharesPerShare` of `toInstrumentId` per share held), cash\n(`cashPerShare`), or both. At least one consideration is REQUIRED.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  cashPerShare currency eventType fromInstrumentId settleTimestampMs sharesPerShare toInstrumentId @insiderfinance/totalfinance/portfolio/events"},{"title":"ModelPortfolio","url":"/reference/totalfinance/portfolio/page-6#ModelPortfolio","description":"The immutable, content-addressed model artifact.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  baseCurrency benchmark benchmark.asOf benchmark.benchmarkId benchmark.constituents contentHash glidePath glidePath.interpolation glidePath.p @insiderfinance/totalfinance/portfolio/policy"},{"title":"ModelPortfolioDefinition","url":"/reference/totalfinance/portfolio/page-6#ModelPortfolioDefinition","description":"The definition {@link createModelPortfolio} freezes.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  baseCurrency benchmark benchmark.asOf benchmark.benchmarkId benchmark.constituents glidePath glidePath.interpolation glidePath.points horizo @insiderfinance/totalfinance/portfolio/policy"},{"title":"ModelSleeve","url":"/reference/totalfinance/portfolio/page-6#ModelSleeve","description":"A hierarchical sleeve. A LEAF declares `members`; a CHILD declares `parentSleeveId` and its\n`weightWithinParent` (siblings sum to 1). A parent's own target weig","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  members note parentSleeveId sleeveId weightWithinParent @insiderfinance/totalfinance/portfolio/policy"},{"title":"MonitorAlert","url":"/reference/totalfinance/portfolio/page-6#MonitorAlert","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  direction evidence family key message severity state subject threshold value @insiderfinance/totalfinance/portfolio/policy"},{"title":"MonitorAlertDirection","url":"/reference/totalfinance/portfolio/page-6#MonitorAlertDirection","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/policy"},{"title":"MonitorAlertFamily","url":"/reference/totalfinance/portfolio/page-6#MonitorAlertFamily","description":"The alert families this build evaluates.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/policy"},{"title":"MonitorAlertSeverity","url":"/reference/totalfinance/portfolio/page-6#MonitorAlertSeverity","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/policy"},{"title":"MonitorAlertState","url":"/reference/totalfinance/portfolio/page-6#MonitorAlertState","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/policy"},{"title":"MonitorDeferredFamily","url":"/reference/totalfinance/portfolio/page-6#MonitorDeferredFamily","description":"The doc's families this build declares unsupported: dividend risk needs an ex-dividend calendar\n(none in this build), order status lives in the execution journa","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/policy"},{"title":"MonitorFamilyEvaluation","url":"/reference/totalfinance/portfolio/page-6#MonitorFamilyEvaluation","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  family observationCount reason status @insiderfinance/totalfinance/portfolio/policy"},{"title":"MonitorHysteresis","url":"/reference/totalfinance/portfolio/page-6#MonitorHysteresis","description":"Enter/exit bounds: a rule ENTERS past `enter` and only CLEARS past `exit`.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  enter exit @insiderfinance/totalfinance/portfolio/policy"},{"title":"MonitorPortfolioInput","url":"/reference/totalfinance/portfolio/page-6#MonitorPortfolioInput","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  acknowledgments asOf assignmentRiskMoneyness averageDailyVolumes currencyConversions instrumentClassification market market.asOf market.conv @insiderfinance/totalfinance/portfolio/policy"},{"title":"MonitorPortfolioResult","url":"/reference/totalfinance/portfolio/page-6#MonitorPortfolioResult","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  alerts asOf assumptions assumptions.conventions assumptions.conventionsVersion assumptions.liquidityParticipationRate assumptions.rulesAppli @insiderfinance/totalfinance/portfolio/policy"},{"title":"MonitorRule","url":"/reference/totalfinance/portfolio/page-6#MonitorRule","description":"A per-family rule override. Every field optional; the resolved rule is echoed in the result.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  cooldownMs debounceEvaluations direction enabled hysteresis hysteresis.enter hysteresis.exit severity threshold @insiderfinance/totalfinance/portfolio/policy"},{"title":"MonitorRuleState","url":"/reference/totalfinance/portfolio/page-6#MonitorRuleState","description":"One rule's carried state, keyed `'family:key'` in {@link PortfolioMonitorState.rules}.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  acknowledged active consecutiveBreaches lastRaisedAtMs lastValue @insiderfinance/totalfinance/portfolio/policy"},{"title":"MonitorThresholdSource","url":"/reference/totalfinance/portfolio/page-6#MonitorThresholdSource","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/policy"},{"title":"NORMALIZED_FILL_KEYS","url":"/reference/totalfinance/portfolio/page-7#NORMALIZED_FILL_KEYS","description":"value from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio value   @insiderfinance/totalfinance/portfolio/events"},{"title":"NormalizedFill","url":"/reference/totalfinance/portfolio/page-7#NormalizedFill","description":"One execution fact, normalized. Everything an economic ledger needs to book the fill is here;\nnothing about the order's journey (acknowledgements, partials, rep","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  accountId accruedInterest contract contract.expiryTimestampMs contract.kind contract.strikePricePerUnit contract.type contract.underlyingIns @insiderfinance/totalfinance/portfolio/events"},{"title":"NormalizedFillCosts","url":"/reference/totalfinance/portfolio/page-7#NormalizedFillCosts","description":"Additional cash charges, each in the fill's currency, ≥ 0. Never repeat costs embedded in pricePerUnit.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  commission exchangeFees regulatoryFees slippageAdjustment @insiderfinance/totalfinance/portfolio/events"},{"title":"NormalizedFillLiquidity","url":"/reference/totalfinance/portfolio/page-7#NormalizedFillLiquidity","description":"Whether the fill added liquidity (rested) or removed it (crossed); unknown when the venue did not say.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/events"},{"title":"OptionAssignmentEvent","url":"/reference/totalfinance/portfolio/page-7#OptionAssignmentEvent","description":"A writer is assigned on short option contracts.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  eventType instrumentId lotSelections premiumTreatment quantity settleTimestampMs settlement settlement.kind settlement.settlementPricePerUni @insiderfinance/totalfinance/portfolio/events"},{"title":"OptionContractTerms","url":"/reference/totalfinance/portfolio/page-7#OptionContractTerms","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  expiryTimestampMs kind strikePricePerUnit type underlyingInstrumentId @insiderfinance/totalfinance/portfolio/events"},{"title":"OptionExerciseEvent","url":"/reference/totalfinance/portfolio/page-7#OptionExerciseEvent","description":"A holder exercises long option contracts.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  eventType instrumentId lotSelections premiumTreatment quantity settleTimestampMs settlement settlement.kind settlement.settlementPricePerUni @insiderfinance/totalfinance/portfolio/events"},{"title":"OptionExpirationEvent","url":"/reference/totalfinance/portfolio/page-7#OptionExpirationEvent","description":"Option contracts expire worthless: lots are relieved at zero, no cash moves.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  eventType instrumentId lotSelections quantity @insiderfinance/totalfinance/portfolio/events"},{"title":"PORTFOLIO_EVENT_SCHEMA_VERSION","url":"/reference/totalfinance/portfolio/page-7#PORTFOLIO_EVENT_SCHEMA_VERSION","description":"Version of the event grammar carried by EVERY envelope. Bump only with a payload shape change,\nlanded together with a registered ledger migration.","category":"@insiderfinance/totalfinance/portfolio","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio value   @insiderfinance/totalfinance/portfolio/events"},{"title":"PORTFOLIO_LEDGER_KIND","url":"/reference/totalfinance/portfolio/page-7#PORTFOLIO_LEDGER_KIND","description":"value from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio value   @insiderfinance/totalfinance/portfolio/ledger"},{"title":"PORTFOLIO_LEDGER_SCHEMA_VERSION","url":"/reference/totalfinance/portfolio/page-7#PORTFOLIO_LEDGER_SCHEMA_VERSION","description":"Current ledger-envelope schema version. Bump ONLY with a shape change, landed together with a\nregistered migration — `readPortfolioLedgerSnapshot` refuses an ol","category":"@insiderfinance/totalfinance/portfolio","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio value   @insiderfinance/totalfinance/portfolio/ledger"},{"title":"PORTFOLIO_MONITOR_STATE_SCHEMA_VERSION","url":"/reference/totalfinance/portfolio/page-7#PORTFOLIO_MONITOR_STATE_SCHEMA_VERSION","description":"value from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio value   @insiderfinance/totalfinance/portfolio/policy"},{"title":"PORTFOLIO_STATE_SCHEMA_VERSION","url":"/reference/totalfinance/portfolio/page-7#PORTFOLIO_STATE_SCHEMA_VERSION","description":"2 (2026-08-28, FC7 slice 2): accounts gained the per-instrument attribution maps.\n3 (2026-08-28, FC7 slice 3): the fold records per-fill effects (for exact reve","category":"@insiderfinance/totalfinance/portfolio","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio value  "},{"title":"PerpetualContractTerms","url":"/reference/totalfinance/portfolio/page-7#PerpetualContractTerms","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  kind underlyingInstrumentId @insiderfinance/totalfinance/portfolio/events"},{"title":"PolicyCheck","url":"/reference/totalfinance/portfolio/page-7#PolicyCheck","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  detail limit name value verdict @insiderfinance/totalfinance/portfolio/trade"},{"title":"PolicyDecision","url":"/reference/totalfinance/portfolio/page-7#PolicyDecision","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  checks requiredScope verdict @insiderfinance/totalfinance/portfolio/trade"},{"title":"PolicyLimits","url":"/reference/totalfinance/portfolio/page-7#PolicyLimits","description":"Hard limits a proposal must satisfy and a monitor evaluates. Every limit is explicit.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  maximumDailyLoss maximumDaysToLiquidate maximumDrawdown maximumGrossLeverage maximumGroupWeights maximumPositionWeight minimumSettledCash @insiderfinance/totalfinance/portfolio/policy"},{"title":"PortfolioDefinition","url":"/reference/totalfinance/portfolio/page-7#PortfolioDefinition","description":"The fresh-ledger definition accepted by {@link applyPortfolioEvents} and the ledger artifact.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  baseCurrency lotRelief portfolioId"},{"title":"PortfolioEvent","url":"/reference/totalfinance/portfolio/page-8#PortfolioEvent","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  accruedInterest amount amountPerShare basisAllocationFraction cashPerShare childInstrumentId closePricePerUnit contract contract.expiryTimes @insiderfinance/totalfinance/portfolio/events"},{"title":"PortfolioEventEnvelope","url":"/reference/totalfinance/portfolio/page-8#PortfolioEventEnvelope","description":"The canonical event envelope — JSON-safe, CloudEvents-mappable without the dependency, and\nclock-free: BOTH timestamps are supplied explicitly; the package neve","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  accountId causationId correlationId effectiveTimestampMs event event.accruedInterest event.amount event.amountPerShare event.basisAllocation @insiderfinance/totalfinance/portfolio/events @insiderfinance/totalfinance/portfolio/ledger"},{"title":"PortfolioEventType","url":"/reference/totalfinance/portfolio/page-8#PortfolioEventType","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/events"},{"title":"PortfolioEventsFromFillInput","url":"/reference/totalfinance/portfolio/page-8#PortfolioEventsFromFillInput","description":"Input for {@link portfolioEventsFromFill}.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  fill fill.accountId fill.accruedInterest fill.contract fill.contract.expiryTimestampMs fill.contract.kind fill.contract.strikePricePerUnit f @insiderfinance/totalfinance/portfolio/events"},{"title":"PortfolioExposure","url":"/reference/totalfinance/portfolio/page-8#PortfolioExposure","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  gross grossLeverage long net short @insiderfinance/totalfinance/portfolio/performance"},{"title":"PortfolioExposureGroupRow","url":"/reference/totalfinance/portfolio/page-8#PortfolioExposureGroupRow","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  baseCurrencyNotionalValue label @insiderfinance/totalfinance/portfolio/performance"},{"title":"PortfolioExposureGrouping","url":"/reference/totalfinance/portfolio/page-8#PortfolioExposureGrouping","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  dimension reason reconciles reconciliationResidual rows @insiderfinance/totalfinance/portfolio/performance"},{"title":"PortfolioGroupingDimension","url":"/reference/totalfinance/portfolio/page-8#PortfolioGroupingDimension","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/performance"},{"title":"PortfolioLedger","url":"/reference/totalfinance/portfolio/page-8#PortfolioLedger","description":"The immutable reusable ledger artifact (the agent-native doc's decided API ladder). It earns\nits existence through repeated queries, identity, migration, and re","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  apply apply(events) baseCurrency events lotRelief pnl pnl().return.assumptions pnl().return.assumptions.conventionsVersion pnl().return.assu @insiderfinance/totalfinance/portfolio/ledger"},{"title":"PortfolioLedgerSnapshot","url":"/reference/totalfinance/portfolio/page-8#PortfolioLedgerSnapshot","description":"The serialized ledger: pure JSON, canonical-JSON-stable, storable anywhere. Derived state is\ndeliberately ABSENT — restoring re-folds the events, so the stored ","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  baseCurrency events kind lotRelief portfolioId provenance provenance.asOf provenance.dataset provenance.provider provenance.receivedAt prove @insiderfinance/totalfinance/portfolio/ledger"},{"title":"PortfolioMonitorState","url":"/reference/totalfinance/portfolio/page-8#PortfolioMonitorState","description":"The JSON-safe, frozen monitor state handed back as the next evaluation's `previousState`.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  asOf evaluationCount netAssetValue peakNetAssetValue rules schemaVersion @insiderfinance/totalfinance/portfolio/policy"},{"title":"PortfolioPerformanceInputsInput","url":"/reference/totalfinance/portfolio/page-8#PortfolioPerformanceInputsInput","description":"Input for {@link portfolioPerformanceInputs}.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  ledger ledger.apply ledger.apply(events) ledger.baseCurrency ledger.events ledger.lotRelief ledger.pnl ledger.pnl().return.assumptions ledge @insiderfinance/totalfinance/portfolio/performance"},{"title":"PortfolioPerformanceInputsResult","url":"/reference/totalfinance/portfolio/page-8#PortfolioPerformanceInputsResult","description":"Result of {@link portfolioPerformanceInputs} — FC4's exact input series.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  assumptions assumptions.conventionsVersion assumptions.flowMapping assumptions.markInstant diagnostics diagnostics.excludedFlowCount diagnos @insiderfinance/totalfinance/portfolio/performance"},{"title":"PortfolioPnlComponents","url":"/reference/totalfinance/portfolio/page-8#PortfolioPnlComponents","description":"P&L components in the base currency. `totalPnl` is their signed sum.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  financing foreignExchangePnl income realizedPnl totalPnl transactionCosts unrealizedPnl @insiderfinance/totalfinance/portfolio/performance"},{"title":"PortfolioPnlCurrencyRow","url":"/reference/totalfinance/portfolio/page-8#PortfolioPnlCurrencyRow","description":"One currency's ledger over the window, in that currency's own units unless stated.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  closingLocalValue conversionNet currency externalFlows financing income openingLocalValue quoteAtEnd quoteAtStart realizedPnl transactionCos @insiderfinance/totalfinance/portfolio/performance"},{"title":"PortfolioPnlGroupRow","url":"/reference/totalfinance/portfolio/page-8#PortfolioPnlGroupRow","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  financing foreignExchangePnl income label realizedPnl totalPnl transactionCosts unrealizedPnl @insiderfinance/totalfinance/portfolio/performance"},{"title":"PortfolioPnlGrouping","url":"/reference/totalfinance/portfolio/page-8#PortfolioPnlGrouping","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  dimension reason reconciles reconciliationResidual rows unattributed unattributed.financing unattributed.foreignExchangePnl unattributed.inc @insiderfinance/totalfinance/portfolio/performance"},{"title":"PortfolioPnlInput","url":"/reference/totalfinance/portfolio/page-8#PortfolioPnlInput","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  from from.currencyConversions from.market from.market.asOf from.market.conventions from.market.conventions.asOfConvention from.market.conven @insiderfinance/totalfinance/portfolio/performance"},{"title":"PortfolioPnlResult","url":"/reference/totalfinance/portfolio/page-8#PortfolioPnlResult","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  assumptions assumptions.conventionsVersion assumptions.conversionConvention assumptions.identity assumptions.lotRelief assumptions.residualT @insiderfinance/totalfinance/portfolio/performance"},{"title":"PortfolioSnapshotCashRow","url":"/reference/totalfinance/portfolio/page-8#PortfolioSnapshotCashRow","description":"One account × currency cash row at the valuation instant.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  accountId baseCurrencyValue currency settledAmount totalAmount unsettledPayable unsettledReceivable"},{"title":"PortfolioSnapshotInput","url":"/reference/totalfinance/portfolio/page-9#PortfolioSnapshotInput","description":"Input for {@link portfolioSnapshot}.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  asOf currencyConversions market market.asOf market.conventions market.conventions.asOfConvention market.conventions.calendar market.conventi"},{"title":"PortfolioSnapshotPosition","url":"/reference/totalfinance/portfolio/page-9#PortfolioSnapshotPosition","description":"One valued position at the valuation instant.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  accountId baseCurrencyMarketValue baseCurrencyNotionalValue baseCurrencyUnrealizedPnl contractMultiplier costBasis currency instrumentId lot"},{"title":"PortfolioSnapshotResult","url":"/reference/totalfinance/portfolio/page-9#PortfolioSnapshotResult","description":"Result of {@link portfolioSnapshot}.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  asOf assumptions assumptions.conventionsVersion assumptions.currencyConversionsUsed assumptions.lotRelief assumptions.marketAsOf assumptions"},{"title":"PortfolioState","url":"/reference/totalfinance/portfolio/page-9#PortfolioState","description":"The derived portfolio state: a JSON-safe, deeply frozen fold result. The economic policy that\nshaped it (`baseCurrency`, `lotRelief`) is echoed ON the state, an","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  accountMigrations accounts appliedEvents baseCurrency eventCount fillEffects lastEffectiveTimestampMs lotRelief lotSequence portfolioId reve @insiderfinance/totalfinance/portfolio/ledger"},{"title":"PortfolioTimelineInput","url":"/reference/totalfinance/portfolio/page-9#PortfolioTimelineInput","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  instrumentClassification ledger ledger.apply ledger.apply(events) ledger.baseCurrency ledger.events ledger.lotRelief ledger.pnl ledger.pnl() @insiderfinance/totalfinance/portfolio/performance"},{"title":"PortfolioTimelineResult","url":"/reference/totalfinance/portfolio/page-9#PortfolioTimelineResult","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  assumptions assumptions.conventionsVersion assumptions.exposureConvention assumptions.indexConvention assumptions.lotRelief assumptions.mark @insiderfinance/totalfinance/portfolio/performance"},{"title":"PortfolioTimelineRow","url":"/reference/totalfinance/portfolio/page-9#PortfolioTimelineRow","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  asOf cashBaseCurrencyValue drawdown exposure exposure.gross exposure.grossLeverage exposure.long exposure.net exposure.short exposureByGroup @insiderfinance/totalfinance/portfolio/performance"},{"title":"PortfolioValuationMark","url":"/reference/totalfinance/portfolio/page-9#PortfolioValuationMark","description":"One dated valuation: the market snapshot (and base-currency quotes) to value the ledger at.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  currencyConversions market market.asOf market.conventions market.conventions.asOfConvention market.conventions.calendar market.conventions.c @insiderfinance/totalfinance/portfolio/performance"},{"title":"PositionDifference","url":"/reference/totalfinance/portfolio/page-9#PositionDifference","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  costBasis costBasis.difference costBasis.external costBasis.ledger costBasis.withinTolerance currency currencyMismatch currencyMismatch.exte @insiderfinance/totalfinance/portfolio/reconciliation"},{"title":"PositionDifferenceKind","url":"/reference/totalfinance/portfolio/page-9#PositionDifferenceKind","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/reconciliation"},{"title":"PositionState","url":"/reference/totalfinance/portfolio/page-9#PositionState","description":"One instrument's open position in one account.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  contract contract.expiryTimestampMs contract.kind contract.strikePricePerUnit contract.type contract.underlyingInstrumentId contractMultipli"},{"title":"PositionTransferEvent","url":"/reference/totalfinance/portfolio/page-9#PositionTransferEvent","description":"Lots move between two accounts of the portfolio; basis and opening dates are preserved.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  eventType fromAccountId instrumentId lotSelections quantity toAccountId @insiderfinance/totalfinance/portfolio/events"},{"title":"PreflightReport","url":"/reference/totalfinance/portfolio/page-9#PreflightReport","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  after after.asOf after.assumptions after.assumptions.conventionsVersion after.assumptions.currencyConversionsUsed after.assumptions.lotRelie @insiderfinance/totalfinance/portfolio/trade"},{"title":"PremiumTreatment","url":"/reference/totalfinance/portfolio/page-9#PremiumTreatment","description":"What happens to the option premium on physical exercise/assignment: folded into the delivered\nunderlying's basis or proceeds (the common tax-lot convention), or","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/events"},{"title":"ProposePortfolioRebalanceInput","url":"/reference/totalfinance/portfolio/page-9#ProposePortfolioRebalanceInput","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  asOf averageDailyVolumes currencyConversions defaultLotSize externalFlow externalFlow.amount externalFlow.currency instrumentClassification  @insiderfinance/totalfinance/portfolio/policy"},{"title":"ProposePortfolioRebalanceResult","url":"/reference/totalfinance/portfolio/page-9#ProposePortfolioRebalanceResult","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  asOf assumptions assumptions.conventions assumptions.conventionsVersion assumptions.costModel assumptions.flowHandling assumptions.liquidity @insiderfinance/totalfinance/portfolio/policy"},{"title":"ReadPortfolioLedgerSnapshotInput","url":"/reference/totalfinance/portfolio/page-9#ReadPortfolioLedgerSnapshotInput","description":"Input for {@link readPortfolioLedgerSnapshot}.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  migrations migrations.find migrations.find().return.description migrations.find().return.fromVersion migrations.find().return.kind migration @insiderfinance/totalfinance/portfolio/ledger"},{"title":"RebalanceCashSummary","url":"/reference/totalfinance/portfolio/page-9#RebalanceCashSummary","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  available minimumReserve raised remainingReserve used @insiderfinance/totalfinance/portfolio/policy"},{"title":"RebalanceCashWeight","url":"/reference/totalfinance/portfolio/page-9#RebalanceCashWeight","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  current postTrade target @insiderfinance/totalfinance/portfolio/policy"},{"title":"RebalanceDustSummary","url":"/reference/totalfinance/portfolio/page-9#RebalanceDustSummary","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  aggregateNotional skipped @insiderfinance/totalfinance/portfolio/policy"},{"title":"RebalanceEstimates","url":"/reference/totalfinance/portfolio/page-10#RebalanceEstimates","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  commission slippage spread totalCost turnover @insiderfinance/totalfinance/portfolio/policy"},{"title":"RebalanceGroupWeight","url":"/reference/totalfinance/portfolio/page-10#RebalanceGroupWeight","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  current driftBand key outsideBand postTrade target @insiderfinance/totalfinance/portfolio/policy"},{"title":"RebalanceInstrumentWeight","url":"/reference/totalfinance/portfolio/page-10#RebalanceInstrumentWeight","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  current driftBand instrumentId outsideBand postTrade sourceGroups target @insiderfinance/totalfinance/portfolio/policy"},{"title":"RebalanceLotPreview","url":"/reference/totalfinance/portfolio/page-10#RebalanceLotPreview","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  costBasisPerUnit estimatedRealizedPnl lotId quantity @insiderfinance/totalfinance/portfolio/policy"},{"title":"RebalanceLotSelection","url":"/reference/totalfinance/portfolio/page-10#RebalanceLotSelection","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  estimatedRealizedPnl lots policy @insiderfinance/totalfinance/portfolio/policy"},{"title":"RebalanceObjectivePoint","url":"/reference/totalfinance/portfolio/page-10#RebalanceObjectivePoint","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  driftDistance trackingDistance @insiderfinance/totalfinance/portfolio/policy"},{"title":"RebalanceRiskPoint","url":"/reference/totalfinance/portfolio/page-10#RebalanceRiskPoint","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  cashWeight grossLeverage herfindahlIndex maximumPositionWeight topThreeWeight @insiderfinance/totalfinance/portfolio/policy"},{"title":"RebalanceScope","url":"/reference/totalfinance/portfolio/page-10#RebalanceScope","description":"Trade every instrument to target, or only what is outside its drift band. REQUIRED.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/policy"},{"title":"RebalanceTrade","url":"/reference/totalfinance/portfolio/page-10#RebalanceTrade","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  accountId currency estimatedCommission estimatedNotional estimatedSlippageCost estimatedSpreadCost instrumentId lotSelection lotSelection.es @insiderfinance/totalfinance/portfolio/policy"},{"title":"RebalanceTradeReason","url":"/reference/totalfinance/portfolio/page-10#RebalanceTradeReason","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/policy"},{"title":"ReconcileExecutionInput","url":"/reference/totalfinance/portfolio/page-10#ReconcileExecutionInput","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  asOf external external.accounts external.asOf external.source fills journal journal.duplicateEventIds journal.eventCount journal.eventIds jo @insiderfinance/totalfinance/portfolio/trade"},{"title":"ReconcilePortfolioInput","url":"/reference/totalfinance/portfolio/page-10#ReconcilePortfolioInput","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  asOf correctionSourceId external external.accounts external.asOf external.source portfolio portfolio.accountMigrations portfolio.accounts po @insiderfinance/totalfinance/portfolio/reconciliation"},{"title":"ReconcilePortfolioResult","url":"/reference/totalfinance/portfolio/page-10#ReconcilePortfolioResult","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  accounts asOf assumptions assumptions.comparisonConvention assumptions.conventionsVersion assumptions.lotRelief assumptions.tolerance assump @insiderfinance/totalfinance/portfolio/reconciliation"},{"title":"ReconciliationAccountReport","url":"/reference/totalfinance/portfolio/page-10#ReconciliationAccountReport","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  accountId cash positions presentInExternal presentInLedger @insiderfinance/totalfinance/portfolio/reconciliation"},{"title":"ReconciliationExplanation","url":"/reference/totalfinance/portfolio/page-10#ReconciliationExplanation","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type  detail kind ratio @insiderfinance/totalfinance/portfolio/reconciliation"},{"title":"ReconciliationReport","url":"/reference/totalfinance/portfolio/page-10#ReconciliationReport","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  asOf assumptions assumptions.conventionsVersion assumptions.matchConvention assumptions.tolerance assumptions.tolerance.cashAmount assumptio @insiderfinance/totalfinance/portfolio/trade"},{"title":"ReconciliationTolerance","url":"/reference/totalfinance/portfolio/page-10#ReconciliationTolerance","description":"Explicit — never defaulted. Absolute amounts in position units and in each currency's units.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  cashAmount costBasis quantity @insiderfinance/totalfinance/portfolio/reconciliation"},{"title":"RedemptionType","url":"/reference/totalfinance/portfolio/page-10#RedemptionType","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/events"},{"title":"ResolveModelTargetsInput","url":"/reference/totalfinance/portfolio/page-10#ResolveModelTargetsInput","description":"Input for {@link resolveModelTargets}.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  asOf model model.baseCurrency model.benchmark model.benchmark.asOf model.benchmark.benchmarkId model.benchmark.constituents model.contentHas @insiderfinance/totalfinance/portfolio/policy"},{"title":"ResolvedMonitorRule","url":"/reference/totalfinance/portfolio/page-10#ResolvedMonitorRule","description":"The rule actually applied to a family — defaults, policy limits, and overrides resolved.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  cooldownMs debounceEvaluations direction enabled hysteresis hysteresis.enter hysteresis.exit severity threshold thresholdSource @insiderfinance/totalfinance/portfolio/policy"},{"title":"ResolvedTargetSource","url":"/reference/totalfinance/portfolio/page-11#ResolvedTargetSource","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/policy"},{"title":"ResolvedTargets","url":"/reference/totalfinance/portfolio/page-11#ResolvedTargets","description":"The targets effective at one instant, with where they came from.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  effectiveFrom interpolation interpolation.fraction interpolation.from interpolation.to source targets @insiderfinance/totalfinance/portfolio/policy"},{"title":"ReturnOfCapitalEvent","url":"/reference/totalfinance/portfolio/page-11#ReturnOfCapitalEvent","description":"A return of capital: cash received reduces basis (never income); excess over basis is realized.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  amountPerShare currency eventType instrumentId settleTimestampMs @insiderfinance/totalfinance/portfolio/events"},{"title":"ScheduledSettlement","url":"/reference/totalfinance/portfolio/page-11#ScheduledSettlement","description":"One dated cash leg: `amount` (signed) becomes settled once `asOf ≥ settleTimestampMs`.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  amount eventId settleTimestampMs"},{"title":"SettlementStyle","url":"/reference/totalfinance/portfolio/page-11#SettlementStyle","description":"How a position's cash settles: at the fill, or through variation margin.","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/events"},{"title":"SleeveMember","url":"/reference/totalfinance/portfolio/page-11#SleeveMember","description":"A sleeve member: an instrument and its weight WITHIN the sleeve (members sum to 1).","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  instrumentId weight @insiderfinance/totalfinance/portfolio/policy"},{"title":"SpinOffEvent","url":"/reference/totalfinance/portfolio/page-11#SpinOffEvent","description":"A spin-off: child shares per parent share with an EXPLICIT basis allocation fraction.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  basisAllocationFraction childInstrumentId eventType parentInstrumentId sharesPerParentShare @insiderfinance/totalfinance/portfolio/events"},{"title":"StockSplitEvent","url":"/reference/totalfinance/portfolio/page-11#StockSplitEvent","description":"A forward or reverse stock split: every lot's quantity scales by\n`sharesAfterSplit / sharesBeforeSplit` and its per-unit basis by the inverse, so total cost\nbas","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  eventType instrumentId sharesAfterSplit sharesBeforeSplit @insiderfinance/totalfinance/portfolio/events"},{"title":"SymbolChangeEvent","url":"/reference/totalfinance/portfolio/page-11#SymbolChangeEvent","description":"The instrument is renamed; lots, basis, and lot ids carry over.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  eventType fromInstrumentId toInstrumentId @insiderfinance/totalfinance/portfolio/events"},{"title":"TRADE_PLAN_KIND","url":"/reference/totalfinance/portfolio/page-11#TRADE_PLAN_KIND","description":"value from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio value   @insiderfinance/totalfinance/portfolio/policy"},{"title":"TRADE_PLAN_SCHEMA_VERSION","url":"/reference/totalfinance/portfolio/page-11#TRADE_PLAN_SCHEMA_VERSION","description":"value from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio value   @insiderfinance/totalfinance/portfolio/policy"},{"title":"TargetGroup","url":"/reference/totalfinance/portfolio/page-11#TargetGroup","description":"The group a target applies to — EXACTLY ONE key. `instrumentId` and `sleeveId` resolve through\nthe model; the classification keys resolve through the caller's `","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  assetClass currency instrumentId sleeveId strategy tag underlying @insiderfinance/totalfinance/portfolio/policy"},{"title":"TargetGroupKey","url":"/reference/totalfinance/portfolio/page-11#TargetGroupKey","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/policy"},{"title":"TargetSet","url":"/reference/totalfinance/portfolio/page-11#TargetSet","description":"A dated, complete set of targets.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  effectiveFrom effectiveTo note targets @insiderfinance/totalfinance/portfolio/policy"},{"title":"TaxLot","url":"/reference/totalfinance/portfolio/page-11#TaxLot","description":"One tax lot. Long lots have `quantity > 0`; short lots `quantity < 0`.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  costBasisPerUnit lotId openedByEventId openedTimestampMs quantity"},{"title":"TradeCostEstimate","url":"/reference/totalfinance/portfolio/page-11#TradeCostEstimate","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  commission slippage spread total @insiderfinance/totalfinance/portfolio/policy"},{"title":"TradeFillEvent","url":"/reference/totalfinance/portfolio/page-11#TradeFillEvent","description":"An executed fill — the audited bridge from the execution journal into economic holdings\n(Permanent law 3). Buys open/extend long lots or cover short lots; sells","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  accruedInterest contract contract.expiryTimestampMs contract.kind contract.strikePricePerUnit contract.type contract.underlyingInstrumentId  @insiderfinance/totalfinance/portfolio/events"},{"title":"TradeFillLotSelection","url":"/reference/totalfinance/portfolio/page-11#TradeFillLotSelection","description":"One `specific-lot` relief instruction: which lot, and how much of it, this fill closes.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  lotId quantity @insiderfinance/totalfinance/portfolio/events"},{"title":"TradeIntent","url":"/reference/totalfinance/portfolio/page-11#TradeIntent","description":"The desired economic action, without a broker payload or a credential (law 5).","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  accountId asOf combos evidence kind orders rationale schemaVersion @insiderfinance/totalfinance/portfolio/trade"},{"title":"TradeOrder","url":"/reference/totalfinance/portfolio/page-12#TradeOrder","description":"One executable order — field for field the execution grammar every engine and the paper broker fill.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  comboId instrumentId limitPrice orderId plannedTimestampMs quantity side stopPrice submittedTimestampMs timeInForce type @insiderfinance/totalfinance/portfolio/trade"},{"title":"TradePlanArtifact","url":"/reference/totalfinance/portfolio/page-12#TradePlanArtifact","description":"A normalized, content-addressed plan suitable for preflight. It contains NO execution capability.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  asOf baseCurrency contentHash kind policyContentHash portfolioId schemaVersion trades @insiderfinance/totalfinance/portfolio/policy"},{"title":"TradePlanTrade","url":"/reference/totalfinance/portfolio/page-12#TradePlanTrade","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  accountId contractMultiplier currency estimatedNotional instrumentId quantity referencePricePerUnit side @insiderfinance/totalfinance/portfolio/policy"},{"title":"TradePolicy","url":"/reference/totalfinance/portfolio/page-12#TradePolicy","description":"A closed, deterministic policy over a plan: FC7's limits verbatim plus the order-level bounds.","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  allowUndefinedRiskOptions allowedAccounts allowedAssetClasses allowedInstruments allowedOrderTypes limits limits.maximumDailyLoss limits.max @insiderfinance/totalfinance/portfolio/trade"},{"title":"UnresolvedConstraint","url":"/reference/totalfinance/portfolio/page-12#UnresolvedConstraint","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  constraint limit reason status value @insiderfinance/totalfinance/portfolio/policy"},{"title":"UnresolvedConstraintStatus","url":"/reference/totalfinance/portfolio/page-12#UnresolvedConstraintStatus","description":"`capped`: the constraint bound the plan (trimmed to honour it; the goal is unmet).\n`violated`: the plan as proposed breaks the limit (never auto-fixed; `feasibl","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/policy"},{"title":"UnresolvedTarget","url":"/reference/totalfinance/portfolio/page-12#UnresolvedTarget","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  group group.assetClass group.currency group.instrumentId group.sleeveId group.strategy group.tag group.underlying key reason @insiderfinance/totalfinance/portfolio/policy"},{"title":"VariationMarginEvent","url":"/reference/totalfinance/portfolio/page-12#VariationMarginEvent","description":"A variation-margin settlement: every open lot of a `'variation-margin'` position re-bases to\nthe settlement price and the difference is realized in cash — the f","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  eventType instrumentId settlementPricePerUnit @insiderfinance/totalfinance/portfolio/events"},{"title":"VerifyAuthorizationGrantInput","url":"/reference/totalfinance/portfolio/page-12#VerifyAuthorizationGrantInput","description":"interface from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio interface  grant grant.accountId grant.approvedBy grant.baseCurrency grant.comboIds grant.contentHash grant.expiresAt grant.grantId grant.idempotencyKe @insiderfinance/totalfinance/portfolio/trade"},{"title":"WithdrawalHandling","url":"/reference/totalfinance/portfolio/page-12#WithdrawalHandling","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/policy"},{"title":"WithinGroupAllocation","url":"/reference/totalfinance/portfolio/page-12#WithinGroupAllocation","description":"type from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio type   @insiderfinance/totalfinance/portfolio/policy"},{"title":"allocatePortfolio","url":"/reference/totalfinance/portfolio/page-12#allocatePortfolio","description":"Turn a policy's target weights into executable quantities at `asOf` — see the module comment for\nthe laws. A proposal built on this is a PLAN: nothing here exec","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function ```ts\nimport { allocatePortfolio } from '@insiderfinance/totalfinance/portfolio/policy';\n\nconst plan (input) (input).asOf (input).baseCurrency (input).cashReserve (input).contractMultipliers (input).currencyConversions (input).currentHolding"},{"title":"applyJournalEvents","url":"/reference/totalfinance/portfolio/page-12#applyJournalEvents","description":"Fold journal events onto a state (Decision 6). The transition table:\n\n- `proposed` / `preflighted` / `authorized` are accepted only before `submitted`;\n- `submi","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (input) (input).events (input).previousState return.applied return.diagnostics return.diagnostics.duplicateCount return.diagnostics.eventCou @insiderfinance/totalfinance/portfolio/trade"},{"title":"applyPortfolioEvents","url":"/reference/totalfinance/portfolio/page-12#applyPortfolioEvents","description":"The direct pure reducer (FC7 required API; the agent-native doc's decided API ladder): fold\n`events` over a fresh `portfolio` definition or a `previousState`, r","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function ```ts\nimport { applyPortfolioEvents } from '@insiderfinance/totalfinance/portfolio';\n\nconst state =  (input) (input).events (input).portfolio (input).previousState return.accountMigrations return.accounts return.appliedEvents return.baseCurr"},{"title":"compareDisclosedHoldingPartitions","url":"/reference/totalfinance/portfolio/page-12#compareDisclosedHoldingPartitions","description":"Compare supplied reported partitions without treating discretion redistribution as a position change.","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (input) (input).baseline (input).comparisonMode (input).current (input).policy return.assumptions return.assumptions.changes return.assumpti @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions"},{"title":"compareDisclosedHoldings","url":"/reference/totalfinance/portfolio/page-12#compareDisclosedHoldings","description":"Compare supplied reported holdings; exact decimal quantities and values are never inferred trades.\nA complete supported universe establishes absence; incomplete","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function compareDisclosedHoldings({ baseline, current, comparisonMode: 'reported-period-change', policy: { su (input) (input).baseline (input).comparisonMode (input).current (input).policy return.assumptions return.assumptions.changes return.assumpti @insiderfinance/totalfinance/portfolio/disclosed-holdings"},{"title":"createAuthorizationGrant","url":"/reference/totalfinance/portfolio/page-12#createAuthorizationGrant","description":"Mint a grant (Decision 5). Refuses a preflight whose decision is `deny`\n(`trade.preflight_denied`), a plan the preflight did not judge, a portfolio or market ha","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (input) (input).account (input).approvedBy (input).expiresAt (input).grantId (input).idempotencyKeys (input).idempotencyKeys.count (input).i @insiderfinance/totalfinance/portfolio/trade"},{"title":"createModelPortfolio","url":"/reference/totalfinance/portfolio/page-12#createModelPortfolio","description":"Freeze a {@link ModelPortfolioDefinition} into an immutable, content-addressed\n{@link ModelPortfolio} artifact. The definition is fully validated first; the has","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function ```ts\nimport { createModelPortfolio } from '@insiderfinance/totalfinance/portfolio/policy';\n\nconst m (definition) (definition).baseCurrency (definition).benchmark (definition).glidePath (definition).horizonEndDate (definition).liabilities (d"},{"title":"createPortfolioLedger","url":"/reference/totalfinance/portfolio/page-12#createPortfolioLedger","description":"Build the immutable ledger artifact from a definition and its economic events. Validates every\nenvelope, folds the state through `applyPortfolioEvents` (the ONE","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function ```ts\nimport { createPortfolioLedger, readPortfolioLedgerSnapshot } from '@insiderfinance/totalfinan (input) (input).baseCurrency (input).events (input).lotRelief (input).portfolioId (input).provenance return.apply return.baseCurrency return @insiderfinance/totalfinance/portfolio/ledger"},{"title":"duplicateBoundaryKey","url":"/reference/totalfinance/portfolio/page-12#duplicateBoundaryKey","description":"The `(sourceId, eventId)` duplicate-boundary key — the exact registry key `PortfolioState`\nrecords under `appliedEvents`, exposed so stores and importers can pr","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (envelope) (envelope).accountId (envelope).causationId (envelope).correlationId (envelope).effectiveTimestampMs (envelope).event (envelope). @insiderfinance/totalfinance/portfolio/events"},{"title":"isModelPortfolio","url":"/reference/totalfinance/portfolio/page-13#isModelPortfolio","description":"Whether a value is a structurally valid, untampered model artifact (a predicate: never throws).","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (value) @insiderfinance/totalfinance/portfolio/policy"},{"title":"isPortfolioLedgerSnapshot","url":"/reference/totalfinance/portfolio/page-13#isPortfolioLedgerSnapshot","description":"Structural test for a (current-version) serialized ledger envelope.","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (value) @insiderfinance/totalfinance/portfolio/ledger"},{"title":"mergeTradePolicies","url":"/reference/totalfinance/portfolio/page-13#mergeTradePolicies","description":"The stricter of every policy given: the minimum of each bound, the intersection of each allow list, the stricter unverifiable handling.","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (input) (input).policies return.allowUndefinedRiskOptions return.allowedAccounts return.allowedAssetClasses return.allowedInstruments return @insiderfinance/totalfinance/portfolio/trade"},{"title":"monitorPortfolio","url":"/reference/totalfinance/portfolio/page-13#monitorPortfolio","description":"Evaluate one explicit valuation against the policy and the prior monitor state — see the module\ncomment for the decisions. Pure: same inputs, same alerts and st","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function ```ts\nimport { monitorPortfolio } from '@insiderfinance/totalfinance/portfolio/policy';\n\nconst first (input) (input).acknowledgments (input).asOf (input).assignmentRiskMoneyness (input).averageDailyVolumes (input).currencyConversions (input)"},{"title":"normalizeTradePlan","url":"/reference/totalfinance/portfolio/page-13#normalizeTradePlan","description":"function from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (input) (input).accountId (input).asOf (input).currencyConversions (input).evidence (input).instruments (input).intent (input).market (input @insiderfinance/totalfinance/portfolio/trade"},{"title":"portfolioEventContentHash","url":"/reference/totalfinance/portfolio/page-13#portfolioEventContentHash","description":"The event's content identity and the CONFLICT boundary for duplicate `(sourceId, eventId)`\ndelivery: the `sha256:` content hash (Gate B canonical JSON) of the e","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (envelope) (envelope).accountId (envelope).causationId (envelope).correlationId (envelope).effectiveTimestampMs (envelope).event (envelope). @insiderfinance/totalfinance/portfolio/events"},{"title":"portfolioEventsFromFill","url":"/reference/totalfinance/portfolio/page-13#portfolioEventsFromFill","description":"Map one {@link NormalizedFill} to the economic events the ledger folds: exactly one `trade.fill`\n(id = `fillId`) followed by one `cost.charge` per non-zero cost","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (input) (input).fill (input).provenance (input).recordedTimestampMs (input).sourceId @insiderfinance/totalfinance/portfolio/events"},{"title":"portfolioLedgerContentHash","url":"/reference/totalfinance/portfolio/page-13#portfolioLedgerContentHash","description":"The ledger's content identity: `sha256:` over the canonical envelope with `provenance` removed\nat BOTH levels — the ledger's own and every event's (Gate B Decis","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (snapshot) (snapshot).baseCurrency (snapshot).events (snapshot).kind (snapshot).lotRelief (snapshot).portfolioId (snapshot).provenance (snap @insiderfinance/totalfinance/portfolio/ledger"},{"title":"portfolioPerformanceInputs","url":"/reference/totalfinance/portfolio/page-13#portfolioPerformanceInputs","description":"Derive the EXACT `valuations` + `externalCashFlows` series FC4's flow-aware calls consume, from\na ledger and explicit per-date marks. The identity test in `test","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function ```ts\nimport { timeWeightedReturn } from '@insiderfinance/totalfinance/performance';\nimport { portfo (input) (input).ledger (input).valuationMarks return.assumptions return.assumptions.conventionsVersion return.assumptions.flowMapping return @insiderfinance/totalfinance/portfolio/performance"},{"title":"portfolioPnl","url":"/reference/totalfinance/portfolio/page-13#portfolioPnl","description":"Reconciled P&L between two valuation marks — see the module comment for the identity and the\nconversion convention. Never mutates the ledger; every number is ba","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (input) (input).from (input).instrumentClassification (input).ledger (input).to return.assumptions return.assumptions.conventionsVersion ret @insiderfinance/totalfinance/portfolio/performance"},{"title":"portfolioSnapshot","url":"/reference/totalfinance/portfolio/page-13#portfolioSnapshot","description":"Value a portfolio state against an explicit market snapshot at an explicit instant.","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function ```ts\nimport { createMarketSnapshot } from '@insiderfinance/totalfinance/core/artifacts';\nimport { a (input) (input).asOf (input).currencyConversions (input).market (input).portfolio return.asOf return.assumptions return.assumptions.conventi"},{"title":"portfolioTimeline","url":"/reference/totalfinance/portfolio/page-13#portfolioTimeline","description":"NAV, cash, flows, exposure, drawdown, and P&L components through time — see the module comment.","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (input) (input).instrumentClassification (input).ledger (input).valuationMarks return.assumptions return.assumptions.conventionsVersion retu @insiderfinance/totalfinance/portfolio/performance"},{"title":"preflightTradePlan","url":"/reference/totalfinance/portfolio/page-13#preflightTradePlan","description":"function from @insiderfinance/totalfinance/portfolio","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (input) (input).asOf (input).averageDailyVolumes (input).costs (input).currencyConversions (input).instruments (input).market (input).monito @insiderfinance/totalfinance/portfolio/trade"},{"title":"proposePortfolioRebalance","url":"/reference/totalfinance/portfolio/page-13#proposePortfolioRebalance","description":"Propose a rebalance of the ledger's managed book toward the policy's targets at `asOf` — a plan,\nnever an execution. See the module comment for the laws and the","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function ```ts\nimport { createMarketSnapshot } from '@insiderfinance/totalfinance/core/artifacts';\nimport { p (input) (input).asOf (input).averageDailyVolumes (input).currencyConversions (input).defaultLotSize (input).externalFlow (input).instrumentC @insiderfinance/totalfinance/portfolio/policy"},{"title":"readPortfolioLedgerSnapshot","url":"/reference/totalfinance/portfolio/page-13#readPortfolioLedgerSnapshot","description":"The ONE door back in for stored ledgers: validates the envelope (closed key set, kind, version)\nBEFORE reading any event, applies explicitly registered migratio","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (input) (input).migrations (input).snapshot return.ledger return.migrationsApplied @insiderfinance/totalfinance/portfolio/ledger"},{"title":"reconcileExecution","url":"/reference/totalfinance/portfolio/page-13#reconcileExecution","description":"Reconcile an execution (Decision 8). Pure: the journal (events or a folded state), the ledger,\nthe fills, and the optional external snapshot are inputs; the tol","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (input) (input).asOf (input).external (input).fills (input).journal (input).journal.duplicateEventIds (input).journal.eventCount (input).jou @insiderfinance/totalfinance/portfolio/trade"},{"title":"reconcilePortfolio","url":"/reference/totalfinance/portfolio/page-13#reconcilePortfolio","description":"Compare a derived state with a normalized external snapshot at `asOf` — see the module comment.","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (input) (input).asOf (input).correctionSourceId (input).external (input).portfolio (input).tolerance return.accounts return.asOf return.assu @insiderfinance/totalfinance/portfolio/reconciliation"},{"title":"requireNormalizedFill","url":"/reference/totalfinance/portfolio/page-13#requireNormalizedFill","description":"Validate a {@link NormalizedFill} at a public boundary: a closed plain-data record whose numbers\nare finite, whose quantity is positive, whose settlement never ","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (fill) (functionName) (label) @insiderfinance/totalfinance/portfolio/events"},{"title":"requirePortfolioEventEnvelope","url":"/reference/totalfinance/portfolio/page-13#requirePortfolioEventEnvelope","description":"Validate one {@link PortfolioEventEnvelope} at a public boundary (Law 12 closed request): known\nkeys at every level, identity strings, finite explicit timestamp","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (envelope) (envelope).accountId (envelope).causationId (envelope).correlationId (envelope).effectiveTimestampMs (envelope).event (envelope). @insiderfinance/totalfinance/portfolio/events"},{"title":"resolveModelTargets","url":"/reference/totalfinance/portfolio/page-13#resolveModelTargets","description":"The targets a model makes effective at `asOf`: the latest tactical set covering the instant,\nelse the glide path (stepped or interpolated), else the strategic s","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function ```ts\nconst effective = resolveModelTargets({ model, asOf: '2026-06-30' });\neffective.source; // 'st (input) (input).asOf (input).model return.effectiveFrom return.interpolation return.interpolation.fraction return.interpolation.from return. @insiderfinance/totalfinance/portfolio/policy"},{"title":"verifyAuthorizationGrant","url":"/reference/totalfinance/portfolio/page-14#verifyAuthorizationGrant","description":"Re-verify a grant at execution (Decision 5): expiry, the plan hash, the portfolio and market\nhashes, the market's age against the grant's allowance, the mode, t","category":"@insiderfinance/totalfinance/portfolio","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio function  (input) (input).grant (input).idempotencyKey (input).marketAsOf (input).marketHash (input).mode (input).now (input).orders (input).plan (inp @insiderfinance/totalfinance/portfolio/trade"},{"title":"AUTHORIZATION_GRANT_KIND","url":"/reference/totalfinance/portfolio/trade#AUTHORIZATION_GRANT_KIND","description":"value from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio/trade value  "},{"title":"AUTHORIZATION_GRANT_SCHEMA_VERSION","url":"/reference/totalfinance/portfolio/trade#AUTHORIZATION_GRANT_SCHEMA_VERSION","description":"value from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio/trade value  "},{"title":"EXECUTION_JOURNAL_EVENT_CEILING","url":"/reference/totalfinance/portfolio/trade#EXECUTION_JOURNAL_EVENT_CEILING","description":"A journal read folds at most this many events (Decision 11).","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio/trade value  "},{"title":"EXECUTION_JOURNAL_EVENT_TYPES","url":"/reference/totalfinance/portfolio/trade#EXECUTION_JOURNAL_EVENT_TYPES","description":"value from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio/trade value  "},{"title":"EXECUTION_PLAN_KIND","url":"/reference/totalfinance/portfolio/trade#EXECUTION_PLAN_KIND","description":"value from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio/trade value  "},{"title":"EXECUTION_PLAN_SCHEMA_VERSION","url":"/reference/totalfinance/portfolio/trade#EXECUTION_PLAN_SCHEMA_VERSION","description":"value from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio/trade value  "},{"title":"ExecutionJournalDetail","url":"/reference/totalfinance/portfolio/trade#ExecutionJournalDetail","description":"The closed detail record; which fields matter depends on the event type (see `applyJournalEvents`).","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio/trade interface  accountId artifactHash baseCurrency comboId executionPolicyHash fill fill.accountId fill.accruedInterest fill.contract fill.contract.expiryT"},{"title":"ExecutionJournalEventType","url":"/reference/totalfinance/portfolio/trade#ExecutionJournalEventType","description":"type from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio/trade type  "},{"title":"ExecutionOrderStatus","url":"/reference/totalfinance/portfolio/trade#ExecutionOrderStatus","description":"type from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio/trade type  "},{"title":"ExecutionPlanCombo","url":"/reference/totalfinance/portfolio/trade#ExecutionPlanCombo","description":"A multi-leg order on a plan: one order to the broker, filled all-or-none against one observation.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio/trade interface  comboId netLimitPrice orderIds"},{"title":"ExecutionPlanSource","url":"/reference/totalfinance/portfolio/trade#ExecutionPlanSource","description":"type from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio/trade type  intentHash kind planHash policyContentHash"},{"title":"GRANT_IDEMPOTENCY_KEY_CEILING","url":"/reference/totalfinance/portfolio/trade#GRANT_IDEMPOTENCY_KEY_CEILING","description":"A grant carries at most this many idempotency keys — one per submission attempt it licenses.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio/trade value  "},{"title":"GrantRefusal","url":"/reference/totalfinance/portfolio/trade/page-2#GrantRefusal","description":"interface from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio/trade interface  detail orderId reason"},{"title":"GrantRefusalReason","url":"/reference/totalfinance/portfolio/trade/page-2#GrantRefusalReason","description":"type from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio/trade type  "},{"title":"GrantVariance","url":"/reference/totalfinance/portfolio/trade/page-2#GrantVariance","description":"How far an executed order may drift from the authorized plan before the grant refuses it.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio/trade interface  maximumNotionalRatio maximumQuantityRatio maximumSlippageBps"},{"title":"MergeTradePoliciesInput","url":"/reference/totalfinance/portfolio/trade/page-2#MergeTradePoliciesInput","description":"The stricter of two policies: the minimum of every bound, the intersection of every allow list.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio/trade type  policies"},{"title":"NormalizeTradePlanInput","url":"/reference/totalfinance/portfolio/trade/page-2#NormalizeTradePlanInput","description":"interface from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio/trade interface  accountId asOf currencyConversions evidence instruments intent intent.accountId intent.asOf intent.combos intent.evidence intent.kind intent"},{"title":"PREFLIGHT_REPORT_KIND","url":"/reference/totalfinance/portfolio/trade/page-2#PREFLIGHT_REPORT_KIND","description":"value from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio/trade value  "},{"title":"PREFLIGHT_REPORT_SCHEMA_VERSION","url":"/reference/totalfinance/portfolio/trade/page-2#PREFLIGHT_REPORT_SCHEMA_VERSION","description":"value from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio/trade value  "},{"title":"PolicyCheckVerdict","url":"/reference/totalfinance/portfolio/trade/page-2#PolicyCheckVerdict","description":"type from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"type","keywords":"@insiderfinance/totalfinance/portfolio/trade type  "},{"title":"PreflightCostRates","url":"/reference/totalfinance/portfolio/trade/page-2#PreflightCostRates","description":"Declared cost rates preflight estimates with (the execution policy's own models live in the broker).","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio/trade interface  commissionBps commissionPerOrder slippageBps spreadBps"},{"title":"PreflightEstimates","url":"/reference/totalfinance/portfolio/trade/page-2#PreflightEstimates","description":"interface from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio/trade interface  commission slippage spread totalCost tradedNotional turnover"},{"title":"PreflightInstrument","url":"/reference/totalfinance/portfolio/trade/page-2#PreflightInstrument","description":"Instrument description for preflight; held economic terms remain ledger-authoritative.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio/trade interface  assetClass contract contract.expiryTimestampMs contract.kind contract.strikePricePerUnit contract.type contract.underlyingInstrumentId contr"},{"title":"PreflightSession","url":"/reference/totalfinance/portfolio/trade/page-2#PreflightSession","description":"interface from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio/trade interface  halted open"},{"title":"PreflightTradePlanInput","url":"/reference/totalfinance/portfolio/trade/page-2#PreflightTradePlanInput","description":"interface from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio/trade interface  asOf averageDailyVolumes costs costs.commissionBps costs.commissionPerOrder costs.slippageBps costs.spreadBps currencyConversions instrument"},{"title":"RECONCILIATION_REPORT_KIND","url":"/reference/totalfinance/portfolio/trade/page-2#RECONCILIATION_REPORT_KIND","description":"value from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio/trade value  "},{"title":"RECONCILIATION_REPORT_SCHEMA_VERSION","url":"/reference/totalfinance/portfolio/trade/page-3#RECONCILIATION_REPORT_SCHEMA_VERSION","description":"value from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio/trade value  "},{"title":"ReconciliationFillMatch","url":"/reference/totalfinance/portfolio/trade/page-3#ReconciliationFillMatch","description":"interface from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio/trade interface  fillId inLedger journaled ledgerKey orderId quantity"},{"title":"ReconciliationOrderCheck","url":"/reference/totalfinance/portfolio/trade/page-3#ReconciliationOrderCheck","description":"interface from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio/trade interface  difference fillQuantity journaledQuantity orderId state withinTolerance"},{"title":"TRADE_INTENT_KIND","url":"/reference/totalfinance/portfolio/trade/page-3#TRADE_INTENT_KIND","description":"value from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio/trade value  "},{"title":"TRADE_INTENT_SCHEMA_VERSION","url":"/reference/totalfinance/portfolio/trade/page-3#TRADE_INTENT_SCHEMA_VERSION","description":"value from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio/trade value  "},{"title":"TRADE_PLAN_ORDER_CEILING","url":"/reference/totalfinance/portfolio/trade/page-3#TRADE_PLAN_ORDER_CEILING","description":"The most orders one plan may carry (Decision 11).","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"value","keywords":"@insiderfinance/totalfinance/portfolio/trade value  "},{"title":"TradeIntentCombo","url":"/reference/totalfinance/portfolio/trade/page-3#TradeIntentCombo","description":"A combo's terms on an intent: the net limit its legs must meet together.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio/trade interface  comboId netLimitPrice"},{"title":"TradeIntentOrder","url":"/reference/totalfinance/portfolio/trade/page-3#TradeIntentOrder","description":"One line of an intent: a quantity, or a notional weight of NAV the normalization sizes at the mark.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"interface","keywords":"@insiderfinance/totalfinance/portfolio/trade interface  comboId instrumentId limitPrice notionalWeight quantity side stopPrice timeInForce type"},{"title":"decideFromChecks","url":"/reference/totalfinance/portfolio/trade/page-3#decideFromChecks","description":"function from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio/trade function  (checks) (onUnverifiable) return.checks return.requiredScope return.verdict"},{"title":"journalOrderStates","url":"/reference/totalfinance/portfolio/trade/page-3#journalOrderStates","description":"The journal's order states in id order — a stable listing for receipts and reconciliation.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio/trade function  (state) (state).duplicateEventIds (state).eventCount (state).eventIds (state).journalId (state).orders (state).preSubmission"},{"title":"referencePriceOf","url":"/reference/totalfinance/portfolio/trade/page-4#referencePriceOf","description":"The reference price for an instrument: the snapshot's spot when it has one at a positive price,\nelse null (a limit price stands in only without one). The snapsh","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio/trade function  (instrumentId) (market) (market).asOf (market).conventions (market).kind (market).observations (market).provenance (market).schemaVersion re"},{"title":"requireAuthorizationGrant","url":"/reference/totalfinance/portfolio/trade/page-4#requireAuthorizationGrant","description":"An authorization grant: closed, its kind and version, every binding typed, the hash re-verified.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio/trade function  (functionName) (label) (value) return.accountId return.approvedBy return.baseCurrency return.comboIds return.contentHash return.expiresAt re"},{"title":"requireExecutionJournalEvent","url":"/reference/totalfinance/portfolio/trade/page-4#requireExecutionJournalEvent","description":"A journal event: closed, typed, its detail record closed; the fold judges the sequence.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio/trade function  (functionName) (label) (value) return.detail return.eventId return.eventType return.idempotencyKey return.journalId return.orderId return.pl"},{"title":"requireExecutionJournalState","url":"/reference/totalfinance/portfolio/trade/page-4#requireExecutionJournalState","description":"A folded journal state, as `applyJournalEvents` returns it.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio/trade function  (functionName) (label) (value) return.duplicateEventIds return.eventCount return.eventIds return.journalId return.orders return.preSubmissio"},{"title":"requireExecutionOrderState","url":"/reference/totalfinance/portfolio/trade/page-4#requireExecutionOrderState","description":"function from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio/trade function  (functionName) (label) (value) return.averageFillPrice return.cancelRequested return.fillIds return.filledQuantity return.lastEventId return"},{"title":"requireExecutionPlan","url":"/reference/totalfinance/portfolio/trade/page-4#requireExecutionPlan","description":"An execution plan: the closed artifact every later stage binds to; its content hash must match its body.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio/trade function  (functionName) (label) (value) return.accountId return.asOf return.baseCurrency return.combos return.contentHash return.evidence return.kind"},{"title":"requireGrantVariance","url":"/reference/totalfinance/portfolio/trade/page-4#requireGrantVariance","description":"function from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio/trade function  (field) (functionName) (value) return.maximumNotionalRatio return.maximumQuantityRatio return.maximumSlippageBps"},{"title":"requirePreflightCostRates","url":"/reference/totalfinance/portfolio/trade/page-4#requirePreflightCostRates","description":"function from @insiderfinance/totalfinance/portfolio/trade","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio/trade function  (functionName) (label) (value) return.commissionBps return.commissionPerOrder return.slippageBps return.spreadBps"},{"title":"requirePreflightInstrument","url":"/reference/totalfinance/portfolio/trade/page-4#requirePreflightInstrument","description":"An instrument description preflight and the broker read for an instrument the ledger may not hold.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio/trade function  (functionName) (label) (value) return.assetClass return.contract return.contractMultiplier return.currency"},{"title":"requirePreflightReport","url":"/reference/totalfinance/portfolio/trade/page-4#requirePreflightReport","description":"A preflight report: closed, its kind and version, its content hash re-verified over the body.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio/trade function  (functionName) (label) (value) return.after return.alerts return.asOf return.assumptions return.assumptions.conventionsVersion return.assump"},{"title":"requireTradeIntent","url":"/reference/totalfinance/portfolio/trade/page-4#requireTradeIntent","description":"A trade intent: closed, without a credential, a quantity or a notional weight per line.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio/trade function  (functionName) (label) (value) return.accountId return.asOf return.combos return.evidence return.kind return.orders return.rationale return."},{"title":"requireTradeOrder","url":"/reference/totalfinance/portfolio/trade/page-4#requireTradeOrder","description":"One executable order in the frozen execution grammar.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio/trade function  (functionName) (label) (value) return.comboId return.instrumentId return.limitPrice return.orderId return.plannedTimestampMs return.quantity"},{"title":"requireTradePolicy","url":"/reference/totalfinance/portfolio/trade/page-4#requireTradePolicy","description":"The structured trade policy: closed, deterministic, paper-only in this stage.","category":"@insiderfinance/totalfinance/portfolio/trade","kind":"function","keywords":"@insiderfinance/totalfinance/portfolio/trade function  (functionName) (label) (value) return.allowUndefinedRiskOptions return.allowedAccounts return.allowedAssetClasses return.allowedInstruments "},{"title":"AbnormalReturnRow","url":"/reference/totalfinance/research#AbnormalReturnRow","description":"One aligned event-window session with actual, expected, and abnormal return.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  abnormalReturn actualReturn expectedReturn tradingSessionDate tradingSessionOffset @insiderfinance/totalfinance/research/events"},{"title":"AggregateEventStudiesAssumptions","url":"/reference/totalfinance/research#AggregateEventStudiesAssumptions","description":"Aggregate assumptions — per-study fields that legitimately differ are labelled, not hidden.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  cumulativeConvention estimationWindow estimationWindow.endTradingSessionOffset estimationWindow.startTradingSessionOffset eventWindow eventW @insiderfinance/totalfinance/research/events"},{"title":"AggregateEventStudiesInput","url":"/reference/totalfinance/research#AggregateEventStudiesInput","description":"Input for {@link aggregateEventStudies}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  studies @insiderfinance/totalfinance/research/events"},{"title":"AggregateEventStudiesResult","url":"/reference/totalfinance/research#AggregateEventStudiesResult","description":"The pooled result: same grammar, plus how many studies were pooled.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  assumptions assumptions.cumulativeConvention assumptions.estimationWindow assumptions.estimationWindow.endTradingSessionOffset assumptions.e @insiderfinance/totalfinance/research/events"},{"title":"AlignEventWindowsInput","url":"/reference/totalfinance/research#AlignEventWindowsInput","description":"Input for {@link alignEventWindows}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  eventWindow eventWindow.endTradingSessionOffset eventWindow.startTradingSessionOffset events returnObservations sessionPolicy @insiderfinance/totalfinance/research/events"},{"title":"AlignEventWindowsResult","url":"/reference/totalfinance/research#AlignEventWindowsResult","description":"The alignment helper's result — the anchoring truth {@link eventStudy} itself computes over.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  alignments assumptions assumptions.eventWindow assumptions.eventWindow.endTradingSessionOffset assumptions.eventWindow.startTradingSessionOf @insiderfinance/totalfinance/research/events"},{"title":"AlignedEventWindow","url":"/reference/totalfinance/research#AlignedEventWindow","description":"One successfully aligned event.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  anchorTradingSessionDate eventId instrumentId rows @insiderfinance/totalfinance/research/events"},{"title":"AlignedSessionRow","url":"/reference/totalfinance/research#AlignedSessionRow","description":"One event-relative session row before any expected-return modelling.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  simpleReturn tradingSessionDate tradingSessionOffset @insiderfinance/totalfinance/research/events"},{"title":"AverageAbnormalReturnRow","url":"/reference/totalfinance/research#AverageAbnormalReturnRow","description":"One cross-sectional row: AAR, CAAR, and the per-offset t-statistic with its sample size.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  averageAbnormalReturn cumulativeAverageAbnormalReturn eventCount tStatistic tStatisticAbsentReason tradingSessionOffset @insiderfinance/totalfinance/research/events"},{"title":"CANONICAL_FACTOR_RECIPES","url":"/reference/totalfinance/research#CANONICAL_FACTOR_RECIPES","description":"The seven canonical recipe families. Each is a frozen, versioned artifact; callers may copy and\nmodify freely (the result is then their recipe, and should carry","category":"@insiderfinance/totalfinance/research","kind":"value","keywords":"@insiderfinance/totalfinance/research value   @insiderfinance/totalfinance/research/factors"},{"title":"ComparisonOperator","url":"/reference/totalfinance/research#ComparisonOperator","description":"Every comparison operator, retained as the convenient public vocabulary union.","category":"@insiderfinance/totalfinance/research","kind":"type","keywords":"@insiderfinance/totalfinance/research type   @insiderfinance/totalfinance/research/screening"},{"title":"CompositeComponent","url":"/reference/totalfinance/research#CompositeComponent","description":"One composite component: an already-standardized factor vector with a weight and direction.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  direction entries label weight @insiderfinance/totalfinance/research/factors"},{"title":"CompositeFactorScoreInput","url":"/reference/totalfinance/research#CompositeFactorScoreInput","description":"Input for {@link compositeFactorScore}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  components missingValuePolicy @insiderfinance/totalfinance/research/factors"},{"title":"CompositeFactorScoreResult","url":"/reference/totalfinance/research#CompositeFactorScoreResult","description":"Result of {@link compositeFactorScore}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  assumptions assumptions.components assumptions.missingValuePolicy diagnostics diagnostics.exclusionReasons diagnostics.instrumentCount diagn @insiderfinance/totalfinance/research/factors"},{"title":"CumulativeConvention","url":"/reference/totalfinance/research#CumulativeConvention","description":"How abnormal returns cumulate: `'sum'` = Σ AR (classic CAR); `'compound'` = Π(1 + AR) − 1.","category":"@insiderfinance/totalfinance/research","kind":"type","keywords":"@insiderfinance/totalfinance/research type   @insiderfinance/totalfinance/research/events"},{"title":"EligibilityLag","url":"/reference/totalfinance/research#EligibilityLag","description":"interface from @insiderfinance/totalfinance/research","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  sessionTimestamps tradingSessions @insiderfinance/totalfinance/research/screening"},{"title":"EligibleObservationsAtInput","url":"/reference/totalfinance/research#EligibleObservationsAtInput","description":"interface from @insiderfinance/totalfinance/research","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  asOf fieldDefinitions lag lag.sessionTimestamps lag.tradingSessions observations universeHistory universeHistory.members universeHistory.uni @insiderfinance/totalfinance/research/screening"},{"title":"EligibleObservationsAtResult","url":"/reference/totalfinance/research#EligibleObservationsAtResult","description":"interface from @insiderfinance/totalfinance/research","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  assumptions assumptions.asOf assumptions.availabilityCutoffMs assumptions.lagTradingSessions assumptions.universeId assumptions.versionResol @insiderfinance/totalfinance/research/screening"},{"title":"EventMarketModel","url":"/reference/totalfinance/research#EventMarketModel","description":"The market model fitted for one event (`'market'` model only).","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  alpha beta rSquared rSquaredAbsentReason @insiderfinance/totalfinance/research/events"},{"title":"EventStudyAssumptions","url":"/reference/totalfinance/research#EventStudyAssumptions","description":"The conventions an event study ran under, echoed verbatim.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  cumulativeConvention estimationWindow estimationWindow.endTradingSessionOffset estimationWindow.startTradingSessionOffset eventWindow eventW @insiderfinance/totalfinance/research/events"},{"title":"EventStudyDiagnostics","url":"/reference/totalfinance/research/page-2#EventStudyDiagnostics","description":"What the study disclosed about coverage and exclusions.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  contaminatedEventIds eventsIncluded eventsSupplied excludedEvents warnings @insiderfinance/totalfinance/research/events"},{"title":"EventStudyEventResult","url":"/reference/totalfinance/research/page-2#EventStudyEventResult","description":"One included event's aligned rows and cumulative abnormal return.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  anchorTradingSessionDate cumulativeAbnormalReturn eventId instrumentId marketModel marketModel.alpha marketModel.beta marketModel.rSquared m @insiderfinance/totalfinance/research/events"},{"title":"EventStudyInput","url":"/reference/totalfinance/research/page-2#EventStudyInput","description":"Input for {@link eventStudy}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  cumulativeConvention estimationWindow estimationWindow.endTradingSessionOffset estimationWindow.startTradingSessionOffset eventWindow eventW @insiderfinance/totalfinance/research/events"},{"title":"EventStudyResult","url":"/reference/totalfinance/research/page-2#EventStudyResult","description":"The full event-study result — assumptions and diagnostics always present.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  assumptions assumptions.cumulativeConvention assumptions.estimationWindow assumptions.estimationWindow.endTradingSessionOffset assumptions.e @insiderfinance/totalfinance/research/events"},{"title":"EventStudySessionPolicy","url":"/reference/totalfinance/research/page-2#EventStudySessionPolicy","description":"How a timestamp maps to session 0 — see the module header for the exact anchoring rules.","category":"@insiderfinance/totalfinance/research","kind":"type","keywords":"@insiderfinance/totalfinance/research type   @insiderfinance/totalfinance/research/events"},{"title":"ExpectedReturnContext","url":"/reference/totalfinance/research/page-2#ExpectedReturnContext","description":"What a caller-supplied factor model is shown per event session.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  instrumentId marketReturn tradingSessionDate @insiderfinance/totalfinance/research/events"},{"title":"ExpectedReturnModelInput","url":"/reference/totalfinance/research/page-2#ExpectedReturnModelInput","description":"The declared expected-return model — a closed union; `'custom'` is the structural escape.","category":"@insiderfinance/totalfinance/research","kind":"type","keywords":"@insiderfinance/totalfinance/research type  expectedReturn expectedReturn(context) expectedReturn(context).instrumentId expectedReturn(context).marketReturn expectedReturn(context).tra @insiderfinance/totalfinance/research/events"},{"title":"FactorCoverage","url":"/reference/totalfinance/research/page-2#FactorCoverage","description":"Coverage of a factor vector: what fraction of entries carry a value.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  coverageFraction entryCount valuedCount @insiderfinance/totalfinance/research/factors"},{"title":"FactorDecayInput","url":"/reference/totalfinance/research/page-2#FactorDecayInput","description":"Input for {@link factorDecay}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  factorEntries horizons minimumCoverageFraction @insiderfinance/totalfinance/research/factors"},{"title":"FactorDecayResult","url":"/reference/totalfinance/research/page-2#FactorDecayResult","description":"Result of {@link factorDecay}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  assumptions assumptions.coefficient assumptions.minimumCoverageFraction byHorizon diagnostics diagnostics.warnings @insiderfinance/totalfinance/research/factors"},{"title":"FactorEntry","url":"/reference/totalfinance/research/page-2#FactorEntry","description":"One instrument's factor value at a cross-section; `null` = the source had no value.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  instrumentId value @insiderfinance/totalfinance/research/factors"},{"title":"FactorRecipe","url":"/reference/totalfinance/research/page-2#FactorRecipe","description":"A versioned factor recipe: everything the factor DOES, disclosed — features, transforms,\ndirection, lag, neutralization, weights, and the missing-value policy. ","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  direction disclosure features lagTradingSessions missingValuePolicy neutralization recipeName recipeVersion @insiderfinance/totalfinance/research/factors"},{"title":"FactorRecipeFeature","url":"/reference/totalfinance/research/page-2#FactorRecipeFeature","description":"One feature inside a recipe.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  field transform weight @insiderfinance/totalfinance/research/factors"},{"title":"FactorSpreadReturnInput","url":"/reference/totalfinance/research/page-2#FactorSpreadReturnInput","description":"Input for {@link factorSpreadReturn}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  direction entries forwardReturns quantileCount @insiderfinance/totalfinance/research/factors"},{"title":"FactorSpreadReturnResult","url":"/reference/totalfinance/research/page-2#FactorSpreadReturnResult","description":"Result of {@link factorSpreadReturn}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  assumptions assumptions.direction assumptions.legWeighting assumptions.quantileCount diagnostics diagnostics.longLegCount diagnostics.shortL @insiderfinance/totalfinance/research/factors"},{"title":"FactorTurnoverInput","url":"/reference/totalfinance/research/page-2#FactorTurnoverInput","description":"Input for {@link factorTurnover}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  currentPortfolios previousPortfolios @insiderfinance/totalfinance/research/factors"},{"title":"FactorTurnoverResult","url":"/reference/totalfinance/research/page-2#FactorTurnoverResult","description":"Result of {@link factorTurnover}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  assumptions assumptions.definition byQuantile diagnostics diagnostics.warnings @insiderfinance/totalfinance/research/factors"},{"title":"FieldDefinition","url":"/reference/totalfinance/research/page-2#FieldDefinition","description":"One declared feature: research fields are DECLARED, never guessed from the data.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  description fieldName kind unit"},{"title":"FieldKind","url":"/reference/totalfinance/research/page-2#FieldKind","description":"What kind of value a declared field carries.","category":"@insiderfinance/totalfinance/research","kind":"type","keywords":"@insiderfinance/totalfinance/research type  "},{"title":"FormQuantilePortfoliosInput","url":"/reference/totalfinance/research/page-2#FormQuantilePortfoliosInput","description":"Input for {@link formQuantilePortfolios}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  direction entries quantileCount @insiderfinance/totalfinance/research/factors"},{"title":"FormQuantilePortfoliosResult","url":"/reference/totalfinance/research/page-3#FormQuantilePortfoliosResult","description":"Result of {@link formQuantilePortfolios}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  assumptions assumptions.direction assumptions.quantileCount assumptions.sizing assumptions.tieBreaker diagnostics diagnostics.coverage diagn @insiderfinance/totalfinance/research/factors"},{"title":"IdentityComparisonOperator","url":"/reference/totalfinance/research/page-3#IdentityComparisonOperator","description":"Equality comparisons; runtime field declarations decide which value kind is compatible.","category":"@insiderfinance/totalfinance/research","kind":"type","keywords":"@insiderfinance/totalfinance/research type   @insiderfinance/totalfinance/research/screening"},{"title":"InformationCoefficientInput","url":"/reference/totalfinance/research/page-3#InformationCoefficientInput","description":"Input for {@link informationCoefficient}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  factorEntries forwardReturns minimumCoverageFraction @insiderfinance/totalfinance/research/factors"},{"title":"InformationCoefficientResult","url":"/reference/totalfinance/research/page-3#InformationCoefficientResult","description":"Result of {@link informationCoefficient}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  assumptions assumptions.minimumCoverageFraction assumptions.pearsonBasis assumptions.rankBasis diagnostics diagnostics.pairedCount diagnosti @insiderfinance/totalfinance/research/factors"},{"title":"MarketEvent","url":"/reference/totalfinance/research/page-3#MarketEvent","description":"One market event (FC3 frozen contract) — announcement time is the information instant.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  announcedTimestampMs effectiveTimestampMs eventId eventType instrumentId metadata"},{"title":"MarketReturnObservation","url":"/reference/totalfinance/research/page-3#MarketReturnObservation","description":"One market (index/benchmark) return for one trading session.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  simpleReturn tradingSessionDate @insiderfinance/totalfinance/research/events"},{"title":"MissingValuePolicy","url":"/reference/totalfinance/research/page-3#MissingValuePolicy","description":"How rows with a missing value at a consumed field are handled. `'exclude'` is the safe default.","category":"@insiderfinance/totalfinance/research","kind":"type","keywords":"@insiderfinance/totalfinance/research type   @insiderfinance/totalfinance/research/screening"},{"title":"NeutralizeFactorInput","url":"/reference/totalfinance/research/page-3#NeutralizeFactorInput","description":"Input for {@link neutralizeFactor}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  entries exposures groups minimumCoverageFraction @insiderfinance/totalfinance/research/factors"},{"title":"NeutralizeFactorResult","url":"/reference/totalfinance/research/page-3#NeutralizeFactorResult","description":"Result of {@link neutralizeFactor}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  assumptions assumptions.continuousNeutralization assumptions.groupNeutralization assumptions.intercept assumptions.minimumCoverageFraction d @insiderfinance/totalfinance/research/factors"},{"title":"ObservedValue","url":"/reference/totalfinance/research/page-3#ObservedValue","description":"One observed value: a declared field's value, or `null` where the source had none.","category":"@insiderfinance/totalfinance/research","kind":"type","keywords":"@insiderfinance/totalfinance/research type  "},{"title":"OrderingComparisonOperator","url":"/reference/totalfinance/research/page-3#OrderingComparisonOperator","description":"Numeric ordering comparisons over one declared field.","category":"@insiderfinance/totalfinance/research","kind":"type","keywords":"@insiderfinance/totalfinance/research type   @insiderfinance/totalfinance/research/screening"},{"title":"OverlappingEventPolicy","url":"/reference/totalfinance/research/page-3#OverlappingEventPolicy","description":"How same-instrument window collisions are handled. REQUIRED — no default.","category":"@insiderfinance/totalfinance/research","kind":"type","keywords":"@insiderfinance/totalfinance/research type   @insiderfinance/totalfinance/research/events"},{"title":"RankTiePolicy","url":"/reference/totalfinance/research/page-3#RankTiePolicy","description":"How tied values rank. Every policy is stable (ties enumerate by instrumentId ascending).","category":"@insiderfinance/totalfinance/research","kind":"type","keywords":"@insiderfinance/totalfinance/research type   @insiderfinance/totalfinance/research/screening"},{"title":"RankUniverseInput","url":"/reference/totalfinance/research/page-3#RankUniverseInput","description":"Input for {@link rankUniverse}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  asOf fieldDefinitions missingValuePolicy observations rankBy rankBy.direction rankBy.field tiePolicy universeId @insiderfinance/totalfinance/research/screening"},{"title":"RankUniverseResult","url":"/reference/totalfinance/research/page-3#RankUniverseResult","description":"Result of {@link rankUniverse}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  assumptions assumptions.asOf assumptions.finalTieBreaker assumptions.missingValuePolicy assumptions.rankBy assumptions.rankBy.direction assu @insiderfinance/totalfinance/research/screening"},{"title":"ReturnObservation","url":"/reference/totalfinance/research/page-3#ReturnObservation","description":"One per-session simple return for one instrument — the event-study raw material.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  instrumentId simpleReturn tradingSessionDate"},{"title":"ScoreComponent","url":"/reference/totalfinance/research/page-3#ScoreComponent","description":"One weighted component of a composite score.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  direction field standardization weight @insiderfinance/totalfinance/research/screening"},{"title":"ScoreUniverseInput","url":"/reference/totalfinance/research/page-3#ScoreUniverseInput","description":"Input for {@link scoreUniverse}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  asOf components fieldDefinitions missingValuePolicy observations universeId @insiderfinance/totalfinance/research/screening"},{"title":"ScoreUniverseResult","url":"/reference/totalfinance/research/page-3#ScoreUniverseResult","description":"Result of {@link scoreUniverse}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  assumptions assumptions.asOf assumptions.components assumptions.finalTieBreaker assumptions.missingValuePolicy assumptions.universeId assump @insiderfinance/totalfinance/research/screening"},{"title":"ScreenFilter","url":"/reference/totalfinance/research/page-3#ScreenFilter","description":"The closed, serializable filter grammar.","category":"@insiderfinance/totalfinance/research","kind":"type","keywords":"@insiderfinance/totalfinance/research type  all any field from not operator to value values @insiderfinance/totalfinance/research/screening"},{"title":"ScreenOrdering","url":"/reference/totalfinance/research/page-4#ScreenOrdering","description":"One ordering key.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  direction field @insiderfinance/totalfinance/research/screening"},{"title":"ScreenUniverseInput","url":"/reference/totalfinance/research/page-4#ScreenUniverseInput","description":"Input for {@link screenUniverse}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  asOf customPredicate customPredicate(observation) customPredicate(observation).availableTimestampMs customPredicate(observation).fields cust @insiderfinance/totalfinance/research/screening"},{"title":"ScreenUniverseResult","url":"/reference/totalfinance/research/page-4#ScreenUniverseResult","description":"Result of {@link screenUniverse}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  assumptions assumptions.asOf assumptions.customPredicate assumptions.finalTieBreaker assumptions.limit assumptions.missingValuePolicy assump @insiderfinance/totalfinance/research/screening"},{"title":"ScreenedRow","url":"/reference/totalfinance/research/page-4#ScreenedRow","description":"One screened row.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  availableTimestampMs fields instrumentId @insiderfinance/totalfinance/research/screening"},{"title":"StandardizeFactorInput","url":"/reference/totalfinance/research/page-4#StandardizeFactorInput","description":"Input for {@link standardizeFactor}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  entries method minimumCoverageFraction @insiderfinance/totalfinance/research/factors"},{"title":"StandardizeFactorResult","url":"/reference/totalfinance/research/page-4#StandardizeFactorResult","description":"Result of {@link standardizeFactor}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  assumptions assumptions.mean assumptions.method assumptions.minimumCoverageFraction assumptions.sampleStandardDeviation assumptions.tieHandl @insiderfinance/totalfinance/research/factors"},{"title":"TradingSessionWindow","url":"/reference/totalfinance/research/page-4#TradingSessionWindow","description":"An inclusive event-relative session window; offset 0 is the event session.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  endTradingSessionOffset startTradingSessionOffset @insiderfinance/totalfinance/research/events"},{"title":"UniverseExit","url":"/reference/totalfinance/research/page-4#UniverseExit","description":"interface from @insiderfinance/totalfinance/research","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  delistingReturn exitReason exitTimestampMs instrumentId @insiderfinance/totalfinance/research/screening"},{"title":"UniverseExitReason","url":"/reference/totalfinance/research/page-4#UniverseExitReason","description":"type from @insiderfinance/totalfinance/research","category":"@insiderfinance/totalfinance/research","kind":"type","keywords":"@insiderfinance/totalfinance/research type   @insiderfinance/totalfinance/research/screening"},{"title":"UniverseHistory","url":"/reference/totalfinance/research/page-4#UniverseHistory","description":"interface from @insiderfinance/totalfinance/research","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  members universeId @insiderfinance/totalfinance/research/screening"},{"title":"UniverseMember","url":"/reference/totalfinance/research/page-4#UniverseMember","description":"One membership interval of one instrument. Half-open: `[fromTimestampMs, toTimestampMs)`.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  delistingReturn exitReason fromTimestampMs instrumentId toTimestampMs @insiderfinance/totalfinance/research/screening"},{"title":"UniverseMembershipAtInput","url":"/reference/totalfinance/research/page-4#UniverseMembershipAtInput","description":"interface from @insiderfinance/totalfinance/research","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  asOf previousAsOf universeHistory universeHistory.members universeHistory.universeId @insiderfinance/totalfinance/research/screening"},{"title":"UniverseMembershipAtResult","url":"/reference/totalfinance/research/page-4#UniverseMembershipAtResult","description":"interface from @insiderfinance/totalfinance/research","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  additions assumptions assumptions.asOf assumptions.membershipRule assumptions.previousAsOf assumptions.universeId diagnostics diagnostics.ad @insiderfinance/totalfinance/research/screening"},{"title":"UniverseObservation","url":"/reference/totalfinance/research/page-4#UniverseObservation","description":"One universe row: an instrument's declared features as of an availability instant.\n`availableTimestampMs` controls point-in-time eligibility — the same law the ","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  availableTimestampMs fields instrumentId"},{"title":"WinsorizationMethod","url":"/reference/totalfinance/research/page-4#WinsorizationMethod","description":"The explicit winsorization method — cutoffs are stated, never implied.","category":"@insiderfinance/totalfinance/research","kind":"type","keywords":"@insiderfinance/totalfinance/research type  lowerPercentile multiplier type upperPercentile @insiderfinance/totalfinance/research/factors"},{"title":"WinsorizeFactorInput","url":"/reference/totalfinance/research/page-4#WinsorizeFactorInput","description":"Input for {@link winsorizeFactor}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  entries method method.lowerPercentile method.multiplier method.type method.upperPercentile minimumCoverageFraction @insiderfinance/totalfinance/research/factors"},{"title":"WinsorizeFactorResult","url":"/reference/totalfinance/research/page-4#WinsorizeFactorResult","description":"Result of {@link winsorizeFactor}.","category":"@insiderfinance/totalfinance/research","kind":"interface","keywords":"@insiderfinance/totalfinance/research interface  assumptions assumptions.lowerBound assumptions.method assumptions.method.lowerPercentile assumptions.method.multiplier assumptions.method.ty @insiderfinance/totalfinance/research/factors"},{"title":"aggregateEventStudies","url":"/reference/totalfinance/research/page-4#aggregateEventStudies","description":"Pool the INCLUDED events of several {@link eventStudy} results and recompute AAR/CAAR and\nper-offset t-statistics across the pooled cross-section. Studies must ","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).studies return.assumptions return.averageAbnormalReturns return.diagnostics return.events return.studiesAggregated @insiderfinance/totalfinance/research/events"},{"title":"alignEventWindows","url":"/reference/totalfinance/research/page-4#alignEventWindows","description":"The alignment step of {@link eventStudy} alone: per event, the anchor session and the resolved\nevent-window rows, or the exclusion reason. Runs the SAME anchori","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).eventWindow (input).events (input).returnObservations (input).sessionPolicy return.alignments return.assumptions return.assu @insiderfinance/totalfinance/research/events"},{"title":"compositeFactorScore","url":"/reference/totalfinance/research/page-4#compositeFactorScore","description":"Weighted composite of standardized factor vectors; direction flips signs so higher is better.","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).components (input).missingValuePolicy return.assumptions return.assumptions.components return.assumptions.missingValuePolicy @insiderfinance/totalfinance/research/factors"},{"title":"eligibleObservationsAt","url":"/reference/totalfinance/research/page-5#eligibleObservationsAt","description":"The observations a decision at `asOf` may see: available at or before the cutoff (an explicit\nsession lag moves the cutoff back through the caller's session ind","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).asOf (input).fieldDefinitions (input).lag (input).observations (input).universeHistory return.assumptions return.assumptions @insiderfinance/totalfinance/research/screening"},{"title":"eventStudy","url":"/reference/totalfinance/research/page-5#eventStudy","description":"Run an event study: anchor each event on its instrument's sessions under the declared session\npolicy, model expected returns, and disclose abnormal returns per ","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).cumulativeConvention (input).estimationWindow (input).eventWindow (input).events (input).expectedReturnModel (input).marketR @insiderfinance/totalfinance/research/events"},{"title":"factorDecay","url":"/reference/totalfinance/research/page-5#factorDecay","description":"The factor's rank information coefficient at each stated horizon — its signal decay curve.","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).factorEntries (input).horizons (input).minimumCoverageFraction return.assumptions return.assumptions.coefficient return.assu @insiderfinance/totalfinance/research/factors"},{"title":"factorSpreadReturn","url":"/reference/totalfinance/research/page-5#factorSpreadReturn","description":"Top-minus-bottom quantile forward return, equal-weighted within each leg.","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).direction (input).entries (input).forwardReturns (input).quantileCount return.assumptions return.assumptions.direction retur @insiderfinance/totalfinance/research/factors"},{"title":"factorTurnover","url":"/reference/totalfinance/research/page-5#factorTurnover","description":"Per-quantile membership turnover between two formations.","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).currentPortfolios (input).previousPortfolios return.assumptions return.assumptions.definition return.byQuantile return.diagn @insiderfinance/totalfinance/research/factors"},{"title":"formQuantilePortfolios","url":"/reference/totalfinance/research/page-5#formQuantilePortfolios","description":"Sort the valued entries and cut them into `quantileCount` portfolios. Every valued entry lands\nin EXACTLY one portfolio and no portfolio repeats a name — the ac","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).direction (input).entries (input).quantileCount return.assumptions return.assumptions.direction return.assumptions.quantileC @insiderfinance/totalfinance/research/factors"},{"title":"informationCoefficient","url":"/reference/totalfinance/research/page-5#informationCoefficient","description":"The information coefficient: Pearson correlation of a factor with forward returns over the\ninstruments carrying BOTH, plus the Spearman rank version. Fewer than","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).factorEntries (input).forwardReturns (input).minimumCoverageFraction return.assumptions return.assumptions.minimumCoverageFr @insiderfinance/totalfinance/research/factors"},{"title":"neutralizeFactor","url":"/reference/totalfinance/research/page-5#neutralizeFactor","description":"Neutralize a factor against sector/industry groups (demean within group) and/or continuous\nexposures (remove the OLS projection, intercept included). Residuals ","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).entries (input).exposures (input).groups (input).minimumCoverageFraction return.assumptions return.assumptions.continuousNeu @insiderfinance/totalfinance/research/factors"},{"title":"rankUniverse","url":"/reference/totalfinance/research/page-5#rankUniverse","description":"Rank one declared numeric field across the point-in-time universe.","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).asOf (input).fieldDefinitions (input).missingValuePolicy (input).observations (input).rankBy (input).rankBy.direction (input @insiderfinance/totalfinance/research/screening"},{"title":"requireDefinitionsMap","url":"/reference/totalfinance/research/page-5#requireDefinitionsMap","description":"The definitions Map every declaration-aware guard consumes — typed, never assumed.","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (definitions) (functionName)"},{"title":"requireFieldDefinitions","url":"/reference/totalfinance/research/page-5#requireFieldDefinitions","description":"Validate the field-definition list and return them keyed by name.","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (fieldDefinitions) (functionName)"},{"title":"requireMarketEvent","url":"/reference/totalfinance/research/page-5#requireMarketEvent","description":"Validate one {@link MarketEvent} at a public boundary.","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (event) (event).announcedTimestampMs (event).effectiveTimestampMs (event).eventId (event).eventType (event).instrumentId (event).metadata (f"},{"title":"requireReturnObservations","url":"/reference/totalfinance/research/page-5#requireReturnObservations","description":"Validate a return-observation array, naming the failing row.","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (functionName) (label) (observations)"},{"title":"requireScreenFilter","url":"/reference/totalfinance/research/page-5#requireScreenFilter","description":"Validate a filter tree against the declarations: every field declared, every operator known,\nevery comparison kind-compatible (an ordering comparison of a categ","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (definitions) (filter) (filter).all (filter).any (filter).field (filter).from (filter).not (filter).operator (filter).to (filter).value (fil @insiderfinance/totalfinance/research/screening"},{"title":"requireUniverseHistory","url":"/reference/totalfinance/research/page-5#requireUniverseHistory","description":"Validate a {@link UniverseHistory} at a public boundary: a closed record whose members are\nclosed records with finite instants, a half-open non-empty interval e","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (functionName) (history) (history).members (history).universeId (label) @insiderfinance/totalfinance/research/screening"},{"title":"requireUniverseObservation","url":"/reference/totalfinance/research/page-5#requireUniverseObservation","description":"Validate one observation against the declarations: closed keys at the row level, every field\nkey DECLARED, and every value matching its declared kind. `null` me","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (definitions) (functionName) (observation) (observation).availableTimestampMs (observation).fields (observation).instrumentId (path)"},{"title":"requireUniverseObservations","url":"/reference/totalfinance/research/page-5#requireUniverseObservations","description":"Validate a whole observation array, naming the failing row.","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (definitions) (functionName) (observations)"},{"title":"scoreUniverse","url":"/reference/totalfinance/research/page-5#scoreUniverse","description":"Weighted composite scoring over standardized declared fields. Standardization is computed over\nthe rows that carry the component; direction flips the sign so hi","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).asOf (input).components (input).fieldDefinitions (input).missingValuePolicy (input).observations (input).universeId return.a @insiderfinance/totalfinance/research/screening"},{"title":"screenUniverse","url":"/reference/totalfinance/research/page-5#screenUniverse","description":"A point-in-time screen: eligibility, version resolution, filter, ordering with the always-on\nstable tie-breaker, and the honest exclusion ledger. Deterministic ","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).asOf (input).customPredicate (input).fieldDefinitions (input).filter (input).limit (input).missingValuePolicy (input).observ @insiderfinance/totalfinance/research/screening"},{"title":"standardizeFactor","url":"/reference/totalfinance/research/page-5#standardizeFactor","description":"Standardize a factor cross-sectionally: z-scores over the valued entries, or average-rank\npercentiles scaled to (0, 1]. Nulls pass through; a zero-dispersion z-","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).entries (input).method (input).minimumCoverageFraction return.assumptions return.assumptions.mean return.assumptions.method  @insiderfinance/totalfinance/research/factors"},{"title":"universeMembershipAt","url":"/reference/totalfinance/research/page-6#universeMembershipAt","description":"Who is in the universe at an instant, and — against a previous instant — who joined and who\nleft (with the exit reason and any delisting return). The membership","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).asOf (input).previousAsOf (input).universeHistory return.additions return.assumptions return.assumptions.asOf return.assumpt @insiderfinance/totalfinance/research/screening"},{"title":"winsorizeFactor","url":"/reference/totalfinance/research/page-6#winsorizeFactor","description":"Winsorize a factor vector under an EXPLICIT method. The percentile form uses the CLASSIC Winsor\nconvention — order-statistic replacement: the `floor(n × lowerPe","category":"@insiderfinance/totalfinance/research","kind":"function","keywords":"@insiderfinance/totalfinance/research function  (input) (input).entries (input).method (input).minimumCoverageFraction return.assumptions return.assumptions.lowerBound return.assumptions.m @insiderfinance/totalfinance/research/factors"},{"title":"AbnormalReturnDelta","url":"/reference/totalfinance/research/artifacts#AbnormalReturnDelta","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  absoluteDelta baselineAverageAbnormalReturn baselineCumulativeAverageAbnormalReturn candidateAverageAbnormalReturn candidateCumulativeAverag"},{"title":"CountDelta","url":"/reference/totalfinance/research/artifacts#CountDelta","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  baselineCount candidateCount delta reason"},{"title":"HygieneBacktestOverfitting","url":"/reference/totalfinance/research/artifacts#HygieneBacktestOverfitting","description":"`backtestOverfittingProbability`'s result — risk's `BacktestOverfittingProbabilityResult`, structurally.","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  assumptions assumptions.conventionsVersion backtestOverfittingProbability combinations diagnostics diagnostics.warnings medianLogit observat"},{"title":"HygieneDeflatedSharpe","url":"/reference/totalfinance/research/artifacts#HygieneDeflatedSharpe","description":"`deflatedSharpeRatio`'s result — risk's `DeflatedSharpeResult`, structurally.","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  assumptions assumptions.conventionsVersion deflatedSharpe diagnostics diagnostics.warnings expectedMaxSharpe probabilisticSharpe trialCount"},{"title":"HygieneLeakageReport","url":"/reference/totalfinance/research/artifacts#HygieneLeakageReport","description":"`detectLeakage`'s report — risk's `LeakageReport`, structurally.","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  assumptions assumptions.conventionsVersion clean diagnostics diagnostics.warnings leaks"},{"title":"HygieneMultipleTest","url":"/reference/totalfinance/research/artifacts#HygieneMultipleTest","description":"`adjustPValues`' result — risk's `MultipleTestResult`, structurally.","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  adjusted alpha method rejected"},{"title":"HygieneParameterSweep","url":"/reference/totalfinance/research/artifacts#HygieneParameterSweep","description":"`parameterSweepDiagnostics`' result — risk's `ParameterSweepResult`, structurally.","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  bestSharpe deflatedSharpe expectedMaxSharpe meanSharpe probabilisticSharpe trialCount varianceSharpe"},{"title":"HygieneResearchVerdict","url":"/reference/totalfinance/research/artifacts#HygieneResearchVerdict","description":"`researchProtocol`'s verdict — risk's `ResearchVerdict`, structurally.","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  assumptions assumptions.confidence assumptions.conventionsVersion assumptions.periodsPerYear deflatedSharpe diagnostics diagnostics.warnings"},{"title":"HygieneVerdictSection","url":"/reference/totalfinance/research/artifacts#HygieneVerdictSection","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  baseline candidate changed"},{"title":"IdListSection","url":"/reference/totalfinance/research/artifacts#IdListSection","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  count ids remainderCount"},{"title":"InputOf","url":"/reference/totalfinance/research/artifacts#InputOf","description":"type from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/research/artifacts type  "},{"title":"KeyedDelta","url":"/reference/totalfinance/research/artifacts#KeyedDelta","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  absoluteDelta baselineValue candidateValue key"},{"title":"NamedDelta","url":"/reference/totalfinance/research/artifacts#NamedDelta","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  absoluteDelta baselineValue candidateValue name"},{"title":"PortfolioMembership","url":"/reference/totalfinance/research/artifacts#PortfolioMembership","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  membership membership.entered membership.entered.count membership.entered.ids membership.entered.remainderCount membership.exited membership"},{"title":"RESEARCH_RUN_ARTIFACT_TYPE","url":"/reference/totalfinance/research/artifacts#RESEARCH_RUN_ARTIFACT_TYPE","description":"value from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/research/artifacts value  "},{"title":"RESEARCH_RUN_KINDS","url":"/reference/totalfinance/research/artifacts#RESEARCH_RUN_KINDS","description":"The frozen descriptor per run kind — Program 5's registry metadata without a registry.","category":"@insiderfinance/totalfinance/research/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/research/artifacts value  "},{"title":"RESEARCH_RUN_LIMITS","url":"/reference/totalfinance/research/artifacts#RESEARCH_RUN_LIMITS","description":"Decision 9's bounded-work table (core's `ARTIFACT_WORK_LIMITS`, re-exported for this subpath's callers).","category":"@insiderfinance/totalfinance/research/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/research/artifacts value  embeddedRowLimit embeddedRowLimit.default embeddedRowLimit.maximum gridPoints gridPoints.default gridPoints.maximum holdoutEvaluations holdo"},{"title":"RankMove","url":"/reference/totalfinance/research/artifacts#RankMove","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  baselineRank candidateRank delta instrumentId"},{"title":"RankMovesSection","url":"/reference/totalfinance/research/artifacts#RankMovesSection","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  movedCount movers remainderCount"},{"title":"ReadResearchRunResult","url":"/reference/totalfinance/research/artifacts/page-2#ReadResearchRunResult","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  artifact artifact.artifactType artifact.conventionsVersion artifact.createdFrom artifact.id artifact.inputs artifact.inputs.inputsHash artif"},{"title":"Referenced","url":"/reference/totalfinance/research/artifacts/page-2#Referenced","description":"The stored form of an input: every bulk array may be a `TableHandle` instead of its rows, and a\ncaller function is never stored (the run is recorded non-replaya","category":"@insiderfinance/totalfinance/research/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/research/artifacts type  "},{"title":"ResearchHygieneBlock","url":"/reference/totalfinance/research/artifacts/page-2#ResearchHygieneBlock","description":"The closed block: every member optional, every present member verbatim.","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  backtestOverfitting backtestOverfitting.assumptions backtestOverfitting.assumptions.conventionsVersion backtestOverfitting.backtestOverfitti"},{"title":"ResearchRunArtifactInput","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunArtifactInput","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  createdFrom hygiene hygiene.backtestOverfitting hygiene.backtestOverfitting.assumptions hygiene.backtestOverfitting.assumptions.conventionsV"},{"title":"ResearchRunArtifactLimits","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunArtifactLimits","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  embeddedRowLimit maximumEmbeddedBytes"},{"title":"ResearchRunComparison","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunComparison","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  artifactIds artifactIds.baseline artifactIds.candidate assumptions assumptions.conventionsVersion assumptions.kind assumptions.limits assump"},{"title":"ResearchRunCostClass","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunCostClass","description":"type from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/research/artifacts type  "},{"title":"ResearchRunInputs","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunInputs","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  aggregate-event-studies aggregate-event-studies.studies composite-factor-score composite-factor-score.components composite-factor-score.miss"},{"title":"ResearchRunKind","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunKind","description":"type from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/research/artifacts type  "},{"title":"ResearchRunKindDescriptor","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunKindDescriptor","description":"The frozen, data-only description of one run kind — the research twin of `FITTED_MODEL_FAMILIES`.","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  bulkRowSets callbackFields costClass kind operation replayableWithoutCallbacks requiredData runVersion"},{"title":"ResearchRunReplay","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunReplay","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  artifactId assumptions assumptions.conventionsVersion assumptions.kind assumptions.libraryVersion assumptions.libraryVersion.current assumpt"},{"title":"ResearchRunReport","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunReport","description":"The typed report every verb reads and writes — the artifact's `result`, verbatim.","category":"@insiderfinance/totalfinance/research/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/research/artifacts type  assumptions assumptions.conventionsVersion assumptions.embeddedRowLimit assumptions.inputPolicy assumptions.kind assumptions.nonReplayableFi"},{"title":"ResearchRunResults","url":"/reference/totalfinance/research/artifacts/page-2#ResearchRunResults","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  aggregate-event-studies aggregate-event-studies.assumptions aggregate-event-studies.assumptions.cumulativeConvention aggregate-event-studies"},{"title":"RunOf","url":"/reference/totalfinance/research/artifacts/page-2#RunOf","description":"type from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/research/artifacts type  "},{"title":"ScoreDeltasSection","url":"/reference/totalfinance/research/artifacts/page-2#ScoreDeltasSection","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  count maximumAbsoluteDelta meanAbsoluteDelta perInstrument remainderCount"},{"title":"ValueDelta","url":"/reference/totalfinance/research/artifacts/page-2#ValueDelta","description":"interface from @insiderfinance/totalfinance/research/artifacts","category":"@insiderfinance/totalfinance/research/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/research/artifacts interface  absoluteDelta baselineValue candidateValue instrumentId"},{"title":"compareResearchRuns","url":"/reference/totalfinance/research/artifacts/page-2#compareResearchRuns","description":"Compare two research runs of one kind: identity (universe, as-of, filter / rank field /\ncomponents), membership, rank moves, score deltas, exclusion-reason delt","category":"@insiderfinance/totalfinance/research/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/research/artifacts function  (input) (input).baseline (input).baseline.artifactType (input).baseline.conventionsVersion (input).baseline.createdFrom (input).baseline.id "},{"title":"readResearchRun","url":"/reference/totalfinance/research/artifacts/page-2#readResearchRun","description":"Restore a research-run artifact: Gate B's read door, a foreign-type refusal, then the caller's\nregistry applied a second time at the run level under `research.r","category":"@insiderfinance/totalfinance/research/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/research/artifacts function  (input) (input).artifact (input).migrations return.artifact return.migrationsApplied return.modelMigrationsApplied return.report"},{"title":"replayResearchRun","url":"/reference/totalfinance/research/artifacts/page-2#replayResearchRun","description":"Re-issue the run's direct operation from the stored input and compare canonical bytes with the\nsaved run (Decision 7). Referenced row sets must be supplied and ","category":"@insiderfinance/totalfinance/research/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/research/artifacts function  (input) (input).artifact (input).libraryVersion (input).limits (input).migrations (input).referencedData return.artifactId return.assumption"},{"title":"researchRunArtifact","url":"/reference/totalfinance/research/artifacts/page-2#researchRunArtifact","description":"Describe a direct research operation's result and save it as an identified, immutable artifact.","category":"@insiderfinance/totalfinance/research/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/research/artifacts function ```ts\nconst run = screenUniverse(input);\nconst artifact = researchRunArtifact({ kind: 'screen', run, (input) (input).createdFrom (input).hygiene (input).input (input).kind (input).libraryVersion (input).limits (input).locators (input).proven"},{"title":"AggregateGreeksResult","url":"/reference/totalfinance/risk#AggregateGreeksResult","description":"{@link aggregateGreeks}'s envelope: `value` carries the book-level totals; `assumptions` echo the\nposition count and the missing-greeks-count-as-0 convention.","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/risk/portfolio"},{"title":"AttributionPeriod","url":"/reference/totalfinance/risk#AttributionPeriod","description":"One period's returns and Brinson effects, to be linked across time.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  allocation benchmarkReturn interaction label portfolioReturn segments selection"},{"title":"BacktestOverfittingProbabilityOptions","url":"/reference/totalfinance/risk#BacktestOverfittingProbabilityOptions","description":"Options for {@link probabilityOfBacktestOverfitting}.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  splits @insiderfinance/totalfinance/risk/research"},{"title":"BacktestOverfittingProbabilityResult","url":"/reference/totalfinance/risk#BacktestOverfittingProbabilityResult","description":"The result of a CSCV probability-of-backtest-overfitting analysis.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion backtestOverfittingProbability combinations diagnostics diagnostics.warnings medianLogit observat @insiderfinance/totalfinance/risk/research"},{"title":"BetaWeightedDeltaResult","url":"/reference/totalfinance/risk#BetaWeightedDeltaResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion diagnostics diagnostics.warnings dollarDelta indexDelta perPosition @insiderfinance/totalfinance/risk/portfolio"},{"title":"BetaWeightedPosition","url":"/reference/totalfinance/risk#BetaWeightedPosition","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  beta delta spot @insiderfinance/totalfinance/risk/portfolio"},{"title":"BinaryEdge","url":"/reference/totalfinance/risk#BinaryEdge","description":"A binary win/loss bet, amounts expressed per unit staked.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  lossAmount winAmount winProbability @insiderfinance/totalfinance/risk/sizing"},{"title":"BlackLittermanOptions","url":"/reference/totalfinance/risk#BlackLittermanOptions","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  constraints constraints.bounds constraints.budget constraints.groups constraints.longOnly constraints.maximumIterations constraints.toleranc @insiderfinance/totalfinance/risk/optimize"},{"title":"BlackLittermanResult","url":"/reference/totalfinance/risk#BlackLittermanResult","description":"The Black-Litterman result (dx §2.4): the core `Computed` envelope, like the other optimizers.\n`value` carries the prior/posterior returns and the posterior-opt","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/risk/optimize"},{"title":"BlackLittermanView","url":"/reference/totalfinance/risk#BlackLittermanView","description":"An investor view for {@link blackLitterman}.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  confidence pick view @insiderfinance/totalfinance/risk/optimize"},{"title":"BookGreeks","url":"/reference/totalfinance/risk#BookGreeks","description":"Net book greeks in trader-facing DISPLAY units (delta $, theta/day, vega/1%, rho/1%), dollar-scaled.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  delta gamma rho theta vega"},{"title":"BookOptions","url":"/reference/totalfinance/risk#BookOptions","description":"Options for {@link analyzeBook}.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  indexPrice multiplier regulationTRate scenarios"},{"title":"BookPosition","url":"/reference/totalfinance/risk#BookPosition","description":"One position in the book: a strategy Position, its market, and optional grouping/beta metadata.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  beta id market market.asOf market.dividendYield market.legVolatilities market.riskFreeRate market.spot market.volatility position position.l"},{"title":"BookRisk","url":"/reference/totalfinance/risk#BookRisk","description":"The full book risk read-out.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion assumptions.indexPrice assumptions.multiplier betaWeightedDelta betaWeightedDelta.assumptions bet"},{"title":"BookVaRComponent","url":"/reference/totalfinance/risk#BookVaRComponent","description":"Per-underlying risk contribution.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  componentVaR delta gamma standaloneVaR underlying vega"},{"title":"BookVaRMethodResult","url":"/reference/totalfinance/risk#BookVaRMethodResult","description":"A VaR/CVaR read-out for one method (positive loss magnitudes, plus the disclosed P&L moments).","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  conditionalValueAtRisk excessKurtosis pnlMean pnlStandardDeviation skewness valueAtRisk"},{"title":"BookVaROptions","url":"/reference/totalfinance/risk#BookVaROptions","description":"Options for {@link bookVaR}.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  confidence correlation factors horizonDays method samples seed tradingDaysPerYear"},{"title":"BookVaRPosition","url":"/reference/totalfinance/risk#BookVaRPosition","description":"A position in the book: a strategy Position + its market (reuses the {@link PnlMarket} shape).","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  id market market.asOf market.dividendYield market.legVolatilities market.riskFreeRate market.spot market.volatility position position.legs p"},{"title":"BookVaRResult","url":"/reference/totalfinance/risk#BookVaRResult","description":"The full book-VaR read-out.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.confidence assumptions.conventionsVersion assumptions.horizonDays assumptions.samples assumptions.seed assumptions.t"},{"title":"BrinsonAttribution","url":"/reference/totalfinance/risk#BrinsonAttribution","description":"The Brinson attribution.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  activeReturn allocation assumptions assumptions.conventionsVersion assumptions.method benchmarkReturn diagnostics diagnostics.autoReason dia"},{"title":"BrinsonAttributionOptions","url":"/reference/totalfinance/risk/page-2#BrinsonAttributionOptions","description":"Options for {@link brinsonAttribution}.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  method"},{"title":"BrinsonSegment","url":"/reference/totalfinance/risk/page-2#BrinsonSegment","description":"One segment (sector/bucket) of a Brinson attribution.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  benchmarkReturn benchmarkWeight name portfolioReturn portfolioWeight"},{"title":"CVaROptimizeOptions","url":"/reference/totalfinance/risk/page-2#CVaROptimizeOptions","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  alpha bounds budget groups longOnly maximumIterations minReturn step tolerance transactionCosts transactionCosts.perUnitTurnover transaction @insiderfinance/totalfinance/risk/optimize"},{"title":"CVaROptimizeResult","url":"/reference/totalfinance/risk/page-2#CVaROptimizeResult","description":"CVaR-optimizer result: the standard envelope whose `value` also carries the optimized tail.","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type  assumptions assumptions.asOf assumptions.budget assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compoun @insiderfinance/totalfinance/risk/optimize"},{"title":"CapitalAssetPricingExpectedReturnsInput","url":"/reference/totalfinance/risk/page-2#CapitalAssetPricingExpectedReturnsInput","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  annualMarketRiskPremium annualRiskFreeRate assetIds betas method"},{"title":"ConcentrationResult","url":"/reference/totalfinance/risk/page-2#ConcentrationResult","description":"{@link concentration}'s report: the values plus the applied conventions (Law 2 report grammar).","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion diagnostics diagnostics.warnings effectiveCount gini hhi topKShare topWeight @insiderfinance/totalfinance/risk/portfolio"},{"title":"ConcentrationValues","url":"/reference/totalfinance/risk/page-2#ConcentrationValues","description":"The bare concentration read-out (the values `analyzeBook` embeds without a nested report).","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  effectiveCount gini hhi topKShare topWeight @insiderfinance/totalfinance/risk/portfolio"},{"title":"CostAwareKelly","url":"/reference/totalfinance/risk/page-2#CostAwareKelly","description":"The cost-aware sizing verdict.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion assumptions.edgeType assumptions.fraction breakevenCost costPerPeriod diagnostics diagnostics.aut"},{"title":"CostAwareKellyInput","url":"/reference/totalfinance/risk/page-2#CostAwareKellyInput","description":"Input for {@link costAwareKelly}.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  edge edge.gaussian edge.gaussian.mean edge.gaussian.variance edge.returns fraction holdingCost horizonPeriods roundTripCost"},{"title":"CovarianceInput","url":"/reference/totalfinance/risk/page-2#CovarianceInput","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assets returns"},{"title":"CovarianceOptions","url":"/reference/totalfinance/risk/page-2#CovarianceOptions","description":"Estimator options — delegated verbatim to `@insiderfinance/totalfinance/math`'s `estimateCovariance`.","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type  conditionThreshold halfLife lambda ledoitWolfTarget market method population ridge"},{"title":"CovarianceResult","url":"/reference/totalfinance/risk/page-2#CovarianceResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion assumptions.method assumptions.observations assumptions.orientation diagnostics diagnostics.autoR"},{"title":"CovarianceValue","url":"/reference/totalfinance/risk/page-2#CovarianceValue","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assets covariance meanReturns"},{"title":"DeflatedSharpeResult","url":"/reference/totalfinance/risk/page-2#DeflatedSharpeResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion deflatedSharpe diagnostics diagnostics.warnings expectedMaxSharpe probabilisticSharpe trialCount @insiderfinance/totalfinance/risk/research"},{"title":"DrawdownAtRisk","url":"/reference/totalfinance/risk/page-2#DrawdownAtRisk","description":"Drawdown-at-Risk read-out.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.confidence assumptions.conventionsVersion conditionalDrawdownAtRisk confidence diagnostics diagnostics.autoReason di"},{"title":"EdgeOutcome","url":"/reference/totalfinance/risk/page-2#EdgeOutcome","description":"One outcome of a discrete payoff distribution, P&L per unit staked.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  payoff probability @insiderfinance/totalfinance/risk/sizing"},{"title":"EfficientFrontierGrid","url":"/reference/totalfinance/risk/page-2#EfficientFrontierGrid","description":"How the frontier is sampled — an explicit choice, never defaulted.","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type  count kind values @insiderfinance/totalfinance/risk/optimize"},{"title":"EfficientFrontierGridKind","url":"/reference/totalfinance/risk/page-2#EfficientFrontierGridKind","description":"type from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type   @insiderfinance/totalfinance/risk/optimize"},{"title":"EfficientFrontierInput","url":"/reference/totalfinance/risk/page-2#EfficientFrontierInput","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  constraints constraints.bounds constraints.budget constraints.groups constraints.longOnly constraints.maximumIterations constraints.toleranc @insiderfinance/totalfinance/risk/optimize"},{"title":"EfficientFrontierResult","url":"/reference/totalfinance/risk/page-2#EfficientFrontierResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.budget assumptions.constraintSummary assumptions.conventionsVersion assumptions.grid assumptions.grid.count assumpti @insiderfinance/totalfinance/risk/optimize"},{"title":"EfficientFrontierValue","url":"/reference/totalfinance/risk/page-3#EfficientFrontierValue","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  expectedReturnRange expectedReturnRange.maximum expectedReturnRange.minimum failedCount minimumVariance minimumVariance.converged minimumVar @insiderfinance/totalfinance/risk/optimize"},{"title":"EstimateExpectedReturnsInput","url":"/reference/totalfinance/risk/page-3#EstimateExpectedReturnsInput","description":"The closed request: an explicit `method` discriminant selects the branch and its own keys.","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type  annualMarketRiskPremium annualRiskFreeRate annualized asOf assetIds betas expectedReturns halfLifePeriods method observationTimestamps perio"},{"title":"ExpectedReturnsMethod","url":"/reference/totalfinance/risk/page-3#ExpectedReturnsMethod","description":"type from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type  "},{"title":"ExpectedReturnsResult","url":"/reference/totalfinance/risk/page-3#ExpectedReturnsResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.annualMarketRiskPremium assumptions.annualRiskFreeRate assumptions.asOf assumptions.conventionsVersion assumptions.e"},{"title":"ExpectedReturnsValue","url":"/reference/totalfinance/risk/page-3#ExpectedReturnsValue","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  annualized assetIds expectedReturns"},{"title":"ExplainPnlInput","url":"/reference/totalfinance/risk/page-3#ExplainPnlInput","description":"Decompose a realized P&L into greek terms + residual, given the position's Greeks (in the options\npackage's units — theta per day, vega per vol point, rho per 1","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  actualPnl greeks greeks.charm greeks.color greeks.delta greeks.deltaRate greeks.gamma greeks.lambda greeks.phi greeks.rho greeks.rhoConvexit"},{"title":"ExplainPositionPnlInput","url":"/reference/totalfinance/risk/page-3#ExplainPositionPnlInput","description":"Decompose a strategy {@link StrategyPosition}'s realized P&L between two market states, aggregate and\nper leg. Marks the position at each state with `Position.v","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  from from.asOf from.dividendYield from.legVolatilities from.riskFreeRate from.spot from.volatility position position.legs position.metrics p"},{"title":"ExponentiallyWeightedExpectedReturnsInput","url":"/reference/totalfinance/risk/page-3#ExponentiallyWeightedExpectedReturnsInput","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  asOf assetIds halfLifePeriods method observationTimestamps periodsPerYear returns"},{"title":"ExtremeValueTailRisk","url":"/reference/totalfinance/risk/page-3#ExtremeValueTailRisk","description":"EVT tail-risk read-out.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.confidence assumptions.conventionsVersion conditionalValueAtRisk confidence diagnostics diagnostics.autoReason diagn"},{"title":"FactorAttribution","url":"/reference/totalfinance/risk/page-3#FactorAttribution","description":"The factor attribution.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  adjustedRSquared alpha assumptions assumptions.conventionsVersion assumptions.riskFreeRate diagnostics diagnostics.autoReason diagnostics.co"},{"title":"FactorAttributionInput","url":"/reference/totalfinance/risk/page-3#FactorAttributionInput","description":"Inputs for {@link factorAttribution}.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  factors returns riskFreeRate"},{"title":"FactorContribution","url":"/reference/totalfinance/risk/page-3#FactorContribution","description":"A factor's exposure and its contribution to the realized return.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  beta contribution name tStatistic"},{"title":"FactorExposureResult","url":"/reference/totalfinance/risk/page-3#FactorExposureResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion diagnostics diagnostics.warnings exposure factors varianceExplained @insiderfinance/totalfinance/risk/factor"},{"title":"FactorSeries","url":"/reference/totalfinance/risk/page-3#FactorSeries","description":"One observable factor's return series.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  name returns"},{"title":"FrontierPoint","url":"/reference/totalfinance/risk/page-3#FrontierPoint","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  converged expectedReturn feasible index iterations reason requested requested.riskAversion requested.targetReturn sharpeRatio variance volat @insiderfinance/totalfinance/risk/optimize"},{"title":"FrontierPortfolio","url":"/reference/totalfinance/risk/page-3#FrontierPortfolio","description":"One solved (or failed) portfolio on the frontier.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  converged expectedReturn feasible iterations reason sharpeRatio variance volatility warnings weights @insiderfinance/totalfinance/risk/optimize"},{"title":"GeneralizedParetoFit","url":"/reference/totalfinance/risk/page-3#GeneralizedParetoFit","description":"A fitted Generalized Pareto tail.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion assumptions.estimator diagnostics diagnostics.autoReason diagnostics.converged diagnostics.decomp"},{"title":"GeneralizedParetoFitOptions","url":"/reference/totalfinance/risk/page-3#GeneralizedParetoFitOptions","description":"Options for {@link fitGeneralizedParetoTail}.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  method minExceedances tailFraction threshold"},{"title":"GroupConstraint","url":"/reference/totalfinance/risk/page-3#GroupConstraint","description":"A sector/group exposure cap: the listed asset indices must sum within `[min, max]`.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  max members min @insiderfinance/totalfinance/risk/optimize"},{"title":"HistoricalMeanExpectedReturnsInput","url":"/reference/totalfinance/risk/page-3#HistoricalMeanExpectedReturnsInput","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  asOf assetIds method observationTimestamps periodsPerYear returns"},{"title":"HistoricalPortfolioVaRInput","url":"/reference/totalfinance/risk/page-4#HistoricalPortfolioVaRInput","description":"A matrix of asset returns: one row per observation, one column per asset (the weights' order).","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  method options options.confidence options.horizonPeriods returns weights @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"HistoricalPortfolioVaROptions","url":"/reference/totalfinance/risk/page-4#HistoricalPortfolioVaROptions","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  confidence horizonPeriods @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"HistoricalPortfolioVaRResult","url":"/reference/totalfinance/risk/page-4#HistoricalPortfolioVaRResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion conditionalValueAtRisk confidence cornishFisher diagnostics diagnostics.warnings horizonPeriods m @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"KellyBetInput","url":"/reference/totalfinance/risk/page-4#KellyBetInput","description":"Inputs for {@link kellyBet}. Supply the edge exactly one of four ways.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  drawdownLimit drawdownLimit.maxProbability drawdownLimit.toFraction edge edge.binary edge.binary.lossAmount edge.binary.winAmount edge.binar @insiderfinance/totalfinance/risk/sizing"},{"title":"KellyOptions","url":"/reference/totalfinance/risk/page-4#KellyOptions","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  bounds budget fraction groups longOnly maximumIterations normalize tolerance transactionCosts transactionCosts.perUnitTurnover transactionCo @insiderfinance/totalfinance/risk/optimize"},{"title":"KellySizing","url":"/reference/totalfinance/risk/page-4#KellySizing","description":"The sizing verdict.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  appliedFraction assumptions assumptions.conventionsVersion assumptions.drawdownModel assumptions.edgeType assumptions.fraction bindingConstr @insiderfinance/totalfinance/risk/sizing"},{"title":"LeakageIssue","url":"/reference/totalfinance/risk/page-4#LeakageIssue","description":"One leaking split found by {@link checkLeakage}.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  overlapCount sample split @insiderfinance/totalfinance/risk/research"},{"title":"LeakageReport","url":"/reference/totalfinance/risk/page-4#LeakageReport","description":"{@link checkLeakage}'s report: the leak findings plus the Law 2 report grammar.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion clean diagnostics diagnostics.warnings leaks @insiderfinance/totalfinance/risk/research"},{"title":"LegPnlExplain","url":"/reference/totalfinance/risk/page-4#LegPnlExplain","description":"Per-leg realized P&L attribution (bare terms; the report wrapper lives on the position level).","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  charm delta deltaRate gamma leg leg.expiry leg.impliedVolatility leg.kind leg.premium leg.price leg.quantity leg.strike phi rho rhoConvexity"},{"title":"LinkAttributionOptions","url":"/reference/totalfinance/risk/page-4#LinkAttributionOptions","description":"Options for {@link linkAttribution}.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  method"},{"title":"LinkedAttribution","url":"/reference/totalfinance/risk/page-4#LinkedAttribution","description":"The multi-period-linked attribution.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  activeReturn allocation assumptions assumptions.conventionsVersion assumptions.method assumptions.periods benchmarkReturn diagnostics diagno"},{"title":"LinkingCoefficient","url":"/reference/totalfinance/risk/page-4#LinkingCoefficient","description":"A per-period Cariño linking coefficient `βₜ`.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  coefficient label"},{"title":"LiquidityPosition","url":"/reference/totalfinance/risk/page-4#LiquidityPosition","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  averageDailyVolume size @insiderfinance/totalfinance/risk/portfolio"},{"title":"LiquidityResult","url":"/reference/totalfinance/risk/page-4#LiquidityResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion diagnostics diagnostics.warnings perAsset portfolioDaysToLiquidate @insiderfinance/totalfinance/risk/portfolio"},{"title":"MarginResult","url":"/reference/totalfinance/risk/page-4#MarginResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion diagnostics diagnostics.warnings grossExposure initialMargin leverage longExposure maintenanceMar @insiderfinance/totalfinance/risk/portfolio"},{"title":"MarketImpactInput","url":"/reference/totalfinance/risk/page-4#MarketImpactInput","description":"Inputs to {@link marketImpact}: the trade size, the asset's ADV, and its per-period vol.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  averageDailyVolume size volatility @insiderfinance/totalfinance/risk/portfolio"},{"title":"MarketImpactResult","url":"/reference/totalfinance/risk/page-4#MarketImpactResult","description":"{@link marketImpact}'s envelope: the impact cost plus the applied impact-law coefficient.","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.coefficient assumptions.compounding assumptions.co @insiderfinance/totalfinance/risk/portfolio"},{"title":"MaxSharpeOptions","url":"/reference/totalfinance/risk/page-4#MaxSharpeOptions","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  bounds budget groups longOnly maximumIterations riskFreeRatePerPeriod tolerance transactionCosts transactionCosts.perUnitTurnover transactio @insiderfinance/totalfinance/risk/optimize"},{"title":"MeanExcessPlot","url":"/reference/totalfinance/risk/page-4#MeanExcessPlot","description":"The mean-excess plot and the threshold it suggests.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion assumptions.losses assumptions.observations diagnostics diagnostics.autoReason diagnostics.conver"},{"title":"MeanExcessPlotOptions","url":"/reference/totalfinance/risk/page-4#MeanExcessPlotOptions","description":"Options for {@link meanExcessPlot}.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  gridSize linearTolerance minExceedances startQuantile thresholds"},{"title":"MeanExcessPoint","url":"/reference/totalfinance/risk/page-5#MeanExcessPoint","description":"One point of the mean-excess plot.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  exceedances meanExcess standardError threshold"},{"title":"MeanReturnsInput","url":"/reference/totalfinance/risk/page-5#MeanReturnsInput","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  periodsPerYear returns"},{"title":"MeanVarianceOptions","url":"/reference/totalfinance/risk/page-5#MeanVarianceOptions","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  bounds budget groups longOnly maximumIterations riskAversion tolerance transactionCosts transactionCosts.perUnitTurnover transactionCosts.pr @insiderfinance/totalfinance/risk/optimize"},{"title":"MonteCarloPortfolioVaRResult","url":"/reference/totalfinance/risk/page-5#MonteCarloPortfolioVaRResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion conditionalValueAtRisk confidence cornishFisher diagnostics diagnostics.warnings horizonPeriods m @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"MultipleTestMethod","url":"/reference/totalfinance/risk/page-5#MultipleTestMethod","description":"type from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type   @insiderfinance/totalfinance/risk/research"},{"title":"MultipleTestOptions","url":"/reference/totalfinance/risk/page-5#MultipleTestOptions","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  alpha method @insiderfinance/totalfinance/risk/research"},{"title":"MultipleTestResult","url":"/reference/totalfinance/risk/page-5#MultipleTestResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  adjusted alpha method rejected @insiderfinance/totalfinance/risk/research"},{"title":"NakedMarginInput","url":"/reference/totalfinance/risk/page-5#NakedMarginInput","description":"Inputs to {@link nakedCallMargin} / {@link nakedPutMargin}: the underlier spot, strike, and premium.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  premium spot strike @insiderfinance/totalfinance/risk/portfolio"},{"title":"NakedMarginOptions","url":"/reference/totalfinance/risk/page-5#NakedMarginOptions","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  equityRate floorRate multiplier @insiderfinance/totalfinance/risk/portfolio"},{"title":"NakedMarginResult","url":"/reference/totalfinance/risk/page-5#NakedMarginResult","description":"The naked-margin envelope: `value` is the Reg-T requirement in account currency per contract, and\nthe applied multiplier / equity-rate / floor-rate defaults rid","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/risk/portfolio"},{"title":"OptimizeConstraints","url":"/reference/totalfinance/risk/page-5#OptimizeConstraints","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  bounds budget groups longOnly maximumIterations tolerance transactionCosts transactionCosts.perUnitTurnover transactionCosts.previousWeights @insiderfinance/totalfinance/risk/optimize"},{"title":"OptimizeResult","url":"/reference/totalfinance/risk/page-5#OptimizeResult","description":"The public optimizer result (dx §2.4): the core `Computed` envelope. `value` carries the weights\nand the objective at the solution; `assumptions` echo which obj","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type  assumptions assumptions.asOf assumptions.budget assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compoun @insiderfinance/totalfinance/risk/optimize"},{"title":"OptionMarginLeg","url":"/reference/totalfinance/risk/page-5#OptionMarginLeg","description":"One option leg of a position for the margin calculation.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  premium quantity strike type @insiderfinance/totalfinance/risk/portfolio @insiderfinance/totalfinance/risk/sizing"},{"title":"OptionsMarginOptions","url":"/reference/totalfinance/risk/page-5#OptionsMarginOptions","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  equityRate floorRate multiplier putMarginBasis spot @insiderfinance/totalfinance/risk/portfolio @insiderfinance/totalfinance/risk/sizing"},{"title":"OptionsMarginResult","url":"/reference/totalfinance/risk/page-5#OptionsMarginResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion buyingPowerReduction definedRisk diagnostics diagnostics.warnings initialMargin maxLoss method ne @insiderfinance/totalfinance/risk/portfolio @insiderfinance/totalfinance/risk/sizing"},{"title":"ParameterSweepResult","url":"/reference/totalfinance/risk/page-5#ParameterSweepResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  bestSharpe deflatedSharpe expectedMaxSharpe meanSharpe probabilisticSharpe trialCount varianceSharpe @insiderfinance/totalfinance/risk/research"},{"title":"ParametricPortfolioVaROptions","url":"/reference/totalfinance/risk/page-5#ParametricPortfolioVaROptions","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  confidence horizonPeriods mean @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"PcaComponent","url":"/reference/totalfinance/risk/page-5#PcaComponent","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  eigenvalue loadings varianceExplained @insiderfinance/totalfinance/risk/factor"},{"title":"PcaResult","url":"/reference/totalfinance/risk/page-6#PcaResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion components cumulativeVariance diagnostics diagnostics.warnings eigenvalues loadings totalVariance @insiderfinance/totalfinance/risk/factor"},{"title":"PnlAttribution","url":"/reference/totalfinance/risk/page-6#PnlAttribution","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  charm delta deltaRate gamma other phi rho rhoConvexity theta thetaConvexity thetaRate total vanna vega vera veta vomma @insiderfinance/totalfinance/risk/scenario"},{"title":"PnlExplain","url":"/reference/totalfinance/risk/page-6#PnlExplain","description":"A realized P&L attribution: greek terms + the unexplained residual, summing exactly to `total`.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion charm delta deltaRate diagnostics diagnostics.warnings gamma phi rho rhoConvexity theta thetaConv"},{"title":"PnlMarket","url":"/reference/totalfinance/risk/page-6#PnlMarket","description":"A market snapshot for {@link explainPositionPnl}: what changes between the two states.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  asOf dividendYield legVolatilities riskFreeRate spot volatility"},{"title":"PnlMove","url":"/reference/totalfinance/risk/page-6#PnlMove","description":"A realized market move (t0 → t1), in the raw units `taylorPnl` expects.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  dDividendYield dRate dSpot dTimeYears dVolatility"},{"title":"PortfolioGreeks","url":"/reference/totalfinance/risk/page-6#PortfolioGreeks","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  delta gamma rho theta value vega @insiderfinance/totalfinance/risk/portfolio"},{"title":"PortfolioPnlExplain","url":"/reference/totalfinance/risk/page-6#PortfolioPnlExplain","description":"A book-level realized P&L attribution (term-wise sum), preserving each position's explain. The\nreport wrapper (Law 2) lives at THIS level (and on each `byPositi","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion byPosition charm delta deltaRate diagnostics diagnostics.warnings gamma phi rho rhoConvexity thet"},{"title":"PortfolioPnlItem","url":"/reference/totalfinance/risk/page-6#PortfolioPnlItem","description":"One position in a portfolio P&L explain, with its own market context.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  from from.asOf from.dividendYield from.legVolatilities from.riskFreeRate from.spot from.volatility id position position.legs position.metric"},{"title":"PortfolioVaRInput","url":"/reference/totalfinance/risk/page-6#PortfolioVaRInput","description":"The one request for a portfolio's VaR: `method` names the model — `'parametric'` (a Gaussian on\nthe covariance), `'monteCarlo'` (correlated normal draws on the ","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type  method options options.confidence options.horizonPeriods returns weights @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"PortfolioVaROutput","url":"/reference/totalfinance/risk/page-6#PortfolioVaROutput","description":"type from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type  assumptions assumptions.conventionsVersion componentVaR conditionalValueAtRisk confidence cornishFisher diagnostics diagnostics.warnings hor @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"PortfolioVaRResult","url":"/reference/totalfinance/risk/page-6#PortfolioVaRResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion componentVaR conditionalValueAtRisk confidence cornishFisher diagnostics diagnostics.warnings hor @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"Position","url":"/reference/totalfinance/risk/page-6#Position","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  data greeks greeks.charm greeks.color greeks.delta greeks.deltaRate greeks.gamma greeks.lambda greeks.phi greeks.rho greeks.rhoConvexity gre @insiderfinance/totalfinance/risk/scenario"},{"title":"PositionGreeks","url":"/reference/totalfinance/risk/page-6#PositionGreeks","description":"A position's Greeks in TotalFinance's ONE unit system — the units `@insiderfinance/totalfinance/options` and\n`@insiderfinance/totalfinance/strategy` report (`DE","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  charm color delta deltaRate gamma lambda phi rho rhoConvexity speed spot theta thetaConvexity thetaRate ultima value vanna vega vera veta vo @insiderfinance/totalfinance/risk/scenario"},{"title":"PositionPnlExplain","url":"/reference/totalfinance/risk/page-6#PositionPnlExplain","description":"A position's realized P&L attribution, aggregate + per leg.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion charm delta deltaRate diagnostics diagnostics.warnings gamma perLeg phi rho rhoConvexity theta th"},{"title":"PositionRisk","url":"/reference/totalfinance/risk/page-6#PositionRisk","description":"Per-position risk row.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  definedRisk greeks greeks.delta greeks.gamma greeks.rho greeks.theta greeks.vega id margin underlying value"},{"title":"PositionScenarioResult","url":"/reference/totalfinance/risk/page-6#PositionScenarioResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  attribution attribution.charm attribution.delta attribution.deltaRate attribution.gamma attribution.other attribution.phi attribution.rho at @insiderfinance/totalfinance/risk/scenario"},{"title":"ProbabilisticSharpeResult","url":"/reference/totalfinance/risk/page-6#ProbabilisticSharpeResult","description":"{@link probabilisticSharpeRatio}'s envelope: the probability plus the applied benchmark.","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type  assumptions assumptions.asOf assumptions.benchmarkSharpe assumptions.calendar assumptions.calendarVersion assumptions.compounding assumption @insiderfinance/totalfinance/risk/research"},{"title":"PurgedKFoldOptions","url":"/reference/totalfinance/risk/page-6#PurgedKFoldOptions","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  embargo folds purgeGap @insiderfinance/totalfinance/risk/research"},{"title":"ResearchProtocolInput","url":"/reference/totalfinance/risk/page-6#ResearchProtocolInput","description":"Inputs for {@link researchProtocol}.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  confidence outOfSampleReturns periodsPerYear returns riskFreeRate trials trials.trialCount trials.trialSharpes trials.varianceSharpe"},{"title":"ResearchVerdict","url":"/reference/totalfinance/risk/page-6#ResearchVerdict","description":"The research verdict.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.confidence assumptions.conventionsVersion assumptions.periodsPerYear deflatedSharpe diagnostics diagnostics.autoReas"},{"title":"ResolvedGridShock","url":"/reference/totalfinance/risk/page-7#ResolvedGridShock","description":"One resolved axis entry of a {@link ScenarioGridResult} (H12).","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  factor kind resolvedMove value @insiderfinance/totalfinance/risk/scenario"},{"title":"RiskContributionRow","url":"/reference/totalfinance/risk/page-7#RiskContributionRow","description":"One asset's row in a {@link RiskContributionsResult} (H10).","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  asset component fraction marginal @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"RiskContributionsResult","url":"/reference/totalfinance/risk/page-7#RiskContributionsResult","description":"The H10 report: portfolio volatility + rows + the Law 2 envelope.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.assets assumptions.conventionsVersion contributions diagnostics diagnostics.warnings portfolioVolatility @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"Scenario","url":"/reference/totalfinance/risk/page-7#Scenario","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  name shocks @insiderfinance/totalfinance/risk/scenario"},{"title":"ScenarioGridResult","url":"/reference/totalfinance/risk/page-7#ScenarioGridResult","description":"The H12 report: both axes with resolved shock semantics + the P&L cells + the Law 2 envelope.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion assumptions.greekUnits assumptions.greekUnits.phi assumptions.greekUnits.rho assumptions.greekUni @insiderfinance/totalfinance/risk/scenario"},{"title":"ScenarioResult","url":"/reference/totalfinance/risk/page-7#ScenarioResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  attribution attribution.charm attribution.delta attribution.deltaRate attribution.gamma attribution.other attribution.phi attribution.rho at @insiderfinance/totalfinance/risk/scenario"},{"title":"SegmentEffect","url":"/reference/totalfinance/risk/page-7#SegmentEffect","description":"The allocation / selection / interaction effects for one segment.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  allocation interaction name selection total"},{"title":"SharpeStatistics","url":"/reference/totalfinance/risk/page-7#SharpeStatistics","description":"Sample statistics of a return series needed for Sharpe inference. All in per-observation units.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  kurtosis observations sharpe skewness @insiderfinance/totalfinance/risk/research"},{"title":"SharpeStatisticsReport","url":"/reference/totalfinance/risk/page-7#SharpeStatisticsReport","description":"{@link sharpeStatistics}'s report: the stats plus the applied conventions (Law 2 report grammar).","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion diagnostics diagnostics.warnings kurtosis observations sharpe skewness @insiderfinance/totalfinance/risk/research"},{"title":"Shock","url":"/reference/totalfinance/risk/page-7#Shock","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  factor kind value @insiderfinance/totalfinance/risk/scenario"},{"title":"ShockFactor","url":"/reference/totalfinance/risk/page-7#ShockFactor","description":"type from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type   @insiderfinance/totalfinance/risk/scenario"},{"title":"ShockKind","url":"/reference/totalfinance/risk/page-7#ShockKind","description":"type from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type   @insiderfinance/totalfinance/risk/scenario"},{"title":"ShrunkKelly","url":"/reference/totalfinance/risk/page-7#ShrunkKelly","description":"The estimation-error-shrunk Kelly book.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  appliedScaling assumptions assumptions.assets assumptions.conventionsVersion assumptions.fraction assumptions.sampleSize correctedSharpeSqua"},{"title":"ShrunkKellyInput","url":"/reference/totalfinance/risk/page-7#ShrunkKellyInput","description":"Input for {@link shrunkKelly}.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  covariance fraction mean sampleSize"},{"title":"SpectralRisk","url":"/reference/totalfinance/risk/page-7#SpectralRisk","description":"Spectral risk read-out.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  alpha assumptions assumptions.conventionsVersion diagnostics diagnostics.autoReason diagnostics.converged diagnostics.decomposition diagnost"},{"title":"Split","url":"/reference/totalfinance/risk/page-7#Split","description":"A train/test split as sorted index arrays into a length-`n` sample.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  test train @insiderfinance/totalfinance/risk/research"},{"title":"StrategyLeg","url":"/reference/totalfinance/risk/page-7#StrategyLeg","description":"The subset of a strategy `Leg` that risk reads (mirrors `@insiderfinance/totalfinance/strategy`'s `Leg` union).","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type  expiry impliedVolatility kind premium price quantity strike"},{"title":"StrategyLegKind","url":"/reference/totalfinance/risk/page-7#StrategyLegKind","description":"A leg's instrument kind (mirrors strategy's `LegKind`).","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type  "},{"title":"StrategyLegValuation","url":"/reference/totalfinance/risk/page-7#StrategyLegValuation","description":"One leg's valuation from `Position.value()` (mirrors `LegValuation`).","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  greeks greeks.charm greeks.color greeks.delta greeks.gamma greeks.lambda greeks.phi greeks.rho greeks.speed greeks.theta greeks.ultima greek"},{"title":"StrategyMarkToMarketMarket","url":"/reference/totalfinance/risk/page-7#StrategyMarkToMarketMarket","description":"The mark-to-market market a strategy `Position.value()` accepts (mirrors `MarkToMarketInput`).","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  asOf dividendYield expiry riskFreeRate spot volatility volatilityShock"},{"title":"StrategyMarkToMarketResult","url":"/reference/totalfinance/risk/page-8#StrategyMarkToMarketResult","description":"The mark-to-market result risk reads from `Position.value()` (mirrors `MarkToMarketResult`).","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  greeks greeks.charm greeks.color greeks.delta greeks.gamma greeks.lambda greeks.phi greeks.rho greeks.speed greeks.theta greeks.ultima greek"},{"title":"StrategyOptionLeg","url":"/reference/totalfinance/risk/page-8#StrategyOptionLeg","description":"An option row of a strategy position (mirrors strategy's `OptionLeg`).","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  expiry impliedVolatility kind premium price quantity strike"},{"title":"StrategyPayoffMetrics","url":"/reference/totalfinance/risk/page-8#StrategyPayoffMetrics","description":"The subset of `PayoffMetrics` risk reads from `Position.metrics()` (`null` = unbounded loss).","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  bounded bounded.loss bounded.profit maxLoss"},{"title":"StrategyPosition","url":"/reference/totalfinance/risk/page-8#StrategyPosition","description":"The structural surface of a strategy `Position` that risk depends on: signed legs, a `value()`\nmark-to-market that merges over the position's remembered market,","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  legs metrics metrics().return.bounded metrics().return.bounded.loss metrics().return.bounded.profit metrics().return.maxLoss value value().r"},{"title":"StrategyStockLeg","url":"/reference/totalfinance/risk/page-8#StrategyStockLeg","description":"A stock row of a strategy position (mirrors strategy's `StockLeg`): signed shares at a price.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  expiry impliedVolatility kind premium price quantity strike"},{"title":"StressOptions","url":"/reference/totalfinance/risk/page-8#StressOptions","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  reprice reprice(position) reprice(position).data reprice(position).greeks reprice(position).id reprice(position).multiplier reprice(position @insiderfinance/totalfinance/risk/scenario"},{"title":"StressTestResult","url":"/reference/totalfinance/risk/page-8#StressTestResult","description":"The H11 report: scenarios + the Law 2 envelope with the book-level valuation summary.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion assumptions.positions assumptions.scenarios assumptions.valuation diagnostics diagnostics.warning @insiderfinance/totalfinance/risk/scenario"},{"title":"SuppliedExpectedReturnsInput","url":"/reference/totalfinance/risk/page-8#SuppliedExpectedReturnsInput","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  annualized assetIds expectedReturns method"},{"title":"SurvivorshipContext","url":"/reference/totalfinance/risk/page-8#SurvivorshipContext","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  includesDelisted pointInTimeUniverse @insiderfinance/totalfinance/risk/research"},{"title":"TaylorPnlResult","url":"/reference/totalfinance/risk/page-8#TaylorPnlResult","description":"{@link taylorPnl}'s report: the attribution inline plus the applied conventions (Law 2).","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion charm delta deltaRate diagnostics diagnostics.warnings gamma other phi rho rhoConvexity theta the @insiderfinance/totalfinance/risk/scenario"},{"title":"TurnoverConstraint","url":"/reference/totalfinance/risk/page-8#TurnoverConstraint","description":"A turnover budget relative to a base (current) portfolio: `Σ|w − previousWeights| ≤ max`.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  max previousWeights @insiderfinance/totalfinance/risk/optimize"},{"title":"UnderlyingRisk","url":"/reference/totalfinance/risk/page-8#UnderlyingRisk","description":"Per-underlying risk row (positions grouped by `underlying`).","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  greeks greeks.delta greeks.gamma greeks.rho greeks.theta greeks.vega margin underlying value"},{"title":"UnderlyingRiskFactor","url":"/reference/totalfinance/risk/page-8#UnderlyingRiskFactor","description":"One underlying's risk-factor parameters.","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  spotReturnVolatility volatilityOfVolatility"},{"title":"VaRMethod","url":"/reference/totalfinance/risk/page-8#VaRMethod","description":"type from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk type   @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"VaROptions","url":"/reference/totalfinance/risk/page-8#VaROptions","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  confidence cornishFisher horizonPeriods method samples seed @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"VaRResult","url":"/reference/totalfinance/risk/page-8#VaRResult","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  assumptions assumptions.conventionsVersion conditionalValueAtRisk confidence cornishFisher diagnostics diagnostics.warnings horizonPeriods m @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"WalkForwardOptions","url":"/reference/totalfinance/risk/page-8#WalkForwardOptions","description":"interface from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"interface","keywords":"@insiderfinance/totalfinance/risk interface  mode step testSize trainSize @insiderfinance/totalfinance/risk/research"},{"title":"adjustPValues","url":"/reference/totalfinance/risk/page-8#adjustPValues","description":"Adjust a set of p-values for multiple testing. Bonferroni/Šidák/Holm control the family-wise error\nrate; Benjamini–Hochberg controls the false-discovery rate. R","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).alpha (options).method (pValues) return.adjusted return.alpha return.method return.rejected @insiderfinance/totalfinance/risk/research"},{"title":"aggregateGreeks","url":"/reference/totalfinance/risk/page-8#aggregateGreeks","description":"Aggregate per-position Greeks into book-level totals, each scaled by the position's signed\n`quantity` (default 1) AND its contract `multiplier` (default 1) — pe","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (positions) return.assumptions return.diagnostics return.provenance return.value @insiderfinance/totalfinance/risk/portfolio"},{"title":"analyzeBook","url":"/reference/totalfinance/risk/page-8#analyzeBook","description":"Aggregate a book of strategy positions into net risk: greeks, beta-weighted delta, margin,\nconcentration, per-position + per-underlying breakdowns, and (optiona","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).indexPrice (options).multiplier (options).regulationTRate (options).scenarios (positions) return.assumptions return.assu"},{"title":"betaWeightedDelta","url":"/reference/totalfinance/risk/page-9#betaWeightedDelta","description":"Beta-weight a book's delta to a reference index — the standard \"what's my net delta in SPY terms\"\nread-out. Each position's dollar delta `δ·price` is scaled by ","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).indexPrice (positions) return.assumptions return.assumptions.conventionsVersion return.diagnostics return.diagnostics.wa @insiderfinance/totalfinance/risk/portfolio"},{"title":"blackLitterman","url":"/reference/totalfinance/risk/page-9#blackLitterman","description":"Black-Litterman (1992): blend a market-equilibrium prior on expected returns with subjective views\nto get a posterior `μ_BL` and covariance, then mean-variance-","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).constraints (options).covariance (options).marketWeights (options).priorMean (options).riskAversion (options).tau (optio @insiderfinance/totalfinance/risk/optimize"},{"title":"bookVaR","url":"/reference/totalfinance/risk/page-9#bookVaR","description":"function from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).confidence (options).correlation (options).factors (options).horizonDays (options).method (options).samples (options).se"},{"title":"brinsonAttribution","url":"/reference/totalfinance/risk/page-9#brinsonAttribution","description":"Decompose a portfolio's active return vs a benchmark into allocation (sector bets), selection\n(security picks), and interaction — an exact decomposition (the th","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).method (segments) return.activeReturn return.allocation return.assumptions return.assumptions.conventionsVersion return."},{"title":"checkLeakage","url":"/reference/totalfinance/risk/page-9#checkLeakage","description":"Flag any split whose train and test index sets overlap (look-ahead leakage). The findings are\n`research.train_test_leakage` warnings on `diagnostics.warnings` (","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (splits) return.assumptions return.assumptions.conventionsVersion return.clean return.diagnostics return.diagnostics.warnings return.leaks @insiderfinance/totalfinance/risk/research"},{"title":"concentration","url":"/reference/totalfinance/risk/page-9#concentration","description":"Concentration of a (possibly long/short) weight vector, measured on gross-normalized shares\n`s_i = |w_i| / Σ|w|`: the HHI and its reciprocal effective-N, the la","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).topK (weights) return.assumptions return.assumptions.conventionsVersion return.diagnostics return.diagnostics.warnings r @insiderfinance/totalfinance/risk/portfolio"},{"title":"conditionalValueAtRiskOptimize","url":"/reference/totalfinance/risk/page-9#conditionalValueAtRiskOptimize","description":"Minimize portfolio CVaR over a scenario set (Rockafellar–Uryasev, projected subgradient).\n`value` carries the weights plus the optimized `conditionalValueAtRisk","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).alpha (options).bounds (options).budget (options).groups (options).longOnly (options).maximumIterations (options).minRet @insiderfinance/totalfinance/risk/optimize"},{"title":"costAwareKelly","url":"/reference/totalfinance/risk/page-9#costAwareKelly","description":"Cost-aware Kelly for a continuous edge. Costs — a per-period holding cost plus an amortized round-trip\ncost, `c = holdingCost + roundTripCost/horizonPeriods` — ","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).edge (input).edge.gaussian (input).edge.gaussian.mean (input).edge.gaussian.variance (input).edge.returns (input).fraction ("},{"title":"covariance","url":"/reference/totalfinance/risk/page-9#covariance","description":"Estimate a portfolio covariance (and mean returns) from raw return history — the first step of\nevery optimizer journey. Delegates estimation to `estimateCovaria","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).assets (input).returns (options) (options).conditionThreshold (options).halfLife (options).lambda (options).ledoitWolfTarget"},{"title":"covarianceToCorrelation","url":"/reference/totalfinance/risk/page-9#covarianceToCorrelation","description":"Convert a covariance matrix to a correlation matrix (unit diagonal).","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (covariance) @insiderfinance/totalfinance/risk/factor"},{"title":"deflatedSharpeRatio","url":"/reference/totalfinance/risk/page-9#deflatedSharpeRatio","description":"Deflated Sharpe Ratio (Bailey & López de Prado 2014): the PSR evaluated against the *expected\nmaximum* Sharpe that `N` independent trials would produce by chanc","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (statistics) (statistics).kurtosis (statistics).observations (statistics).sharpe (statistics).skewness (trials) (trials).trialCount (trials) @insiderfinance/totalfinance/risk/research"},{"title":"diversificationRatio","url":"/reference/totalfinance/risk/page-9#diversificationRatio","description":"Diversification ratio: weighted-average asset volatility ÷ portfolio volatility (≥ 1). A\nzero-volatility portfolio has no finite ratio — that degenerate input t","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (covariance) (weights) @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"drawdownAtRisk","url":"/reference/totalfinance/risk/page-9#drawdownAtRisk","description":"Drawdown-at-Risk and Conditional Drawdown-at-Risk (Chekhlov–Uryasev) from a return series: the\n`α`-quantile of the path's underwater (fractional-drawdown) curve","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).confidence (returns) return.assumptions return.assumptions.confidence return.assumptions.conventionsVersion return.condi"},{"title":"efficientFrontier","url":"/reference/totalfinance/risk/page-9#efficientFrontier","description":"Trace the constrained mean-variance efficient frontier by composing `minVariance`,\n`meanVariance`, and (with a risk-free rate) `maxSharpe` under ONE constraint ","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).constraints (input).covariance (input).grid (input).mean (input).riskFreeRatePerPeriod return.assumptions return.assumptions @insiderfinance/totalfinance/risk/optimize"},{"title":"estimateExpectedReturns","url":"/reference/totalfinance/risk/page-9#estimateExpectedReturns","description":"Estimate per-asset expected returns under an EXPLICIT method — the `mean` for `maxSharpe`,\n`meanVariance`, `kelly`, and `efficientFrontier`.\n\n```ts\nestimateExpe","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).annualMarketRiskPremium (input).annualRiskFreeRate (input).annualized (input).asOf (input).assetIds (input).betas (input).ex"},{"title":"expectedShortfall","url":"/reference/totalfinance/risk/page-9#expectedShortfall","description":"Conditional VaR / expected shortfall (positive loss magnitude), with the same `.explain()`.","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"explainPnl","url":"/reference/totalfinance/risk/page-9#explainPnl","description":"function from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).actualPnl (input).greeks (input).move return.assumptions return.assumptions.conventionsVersion return.charm return.delta ret"},{"title":"explainPortfolioPnl","url":"/reference/totalfinance/risk/page-9#explainPortfolioPnl","description":"Decompose a portfolio's realized P&L: each position with its own market context (so a book can span\nunderlyings). The book explain is the term-wise sum; each po","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (items) return.assumptions return.assumptions.conventionsVersion return.byPosition return.charm return.delta return.deltaRate return.diagnos"},{"title":"explainPositionPnl","url":"/reference/totalfinance/risk/page-9#explainPositionPnl","description":"function from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).from (input).position (input).to return.assumptions return.assumptions.conventionsVersion return.charm return.delta return.d"},{"title":"extremeValueTailRisk","url":"/reference/totalfinance/risk/page-9#extremeValueTailRisk","description":"Extreme-tail VaR and Expected Shortfall via the MonteCarloNeil–Frey peaks-over-threshold method, shown beside\nthe empirical and normal numbers with a fat-tail r","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).confidence (options).method (options).minExceedances (options).tailFraction (options).threshold (returns) return.assumpt"},{"title":"factorAttribution","url":"/reference/totalfinance/risk/page-10#factorAttribution","description":"Attribute a return series to observable factors by OLS regression, splitting the realized return into\na contribution per factor plus a specific (alpha) residual","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).factors (input).returns (input).riskFreeRate return.adjustedRSquared return.alpha return.assumptions return.assumptions.conv"},{"title":"factorExposure","url":"/reference/totalfinance/risk/page-10#factorExposure","description":"Keep the top-`k` principal components and report each asset's exposure (loading) to them.","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (covariance) (options) (options).correlation (options).factorCount return.assumptions return.assumptions.conventionsVersion return.diagnosti @insiderfinance/totalfinance/risk/factor"},{"title":"fitGeneralizedParetoTail","url":"/reference/totalfinance/risk/page-10#fitGeneralizedParetoTail","description":"Fit a Generalized Pareto Distribution to the **loss** tail (peaks-over-threshold). Returns the tail\nindex `ξ`, scale `β`, threshold, and exceedance count, with ","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).method (options).minExceedances (options).tailFraction (options).threshold (returns) return.assumptions return.assumptio"},{"title":"hrp","url":"/reference/totalfinance/risk/page-10#hrp","description":"Hierarchical Risk Parity portfolio (correlation-distance clustering + recursive bisection).","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (covariance) (options) (options).budget return.assumptions return.diagnostics return.provenance return.value return.value.objective return.v @insiderfinance/totalfinance/risk/optimize"},{"title":"kelly","url":"/reference/totalfinance/risk/page-10#kelly","description":"function from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).covariance (input).mean (input).options return.assumptions return.diagnostics return.provenance return.value return.value.ob @insiderfinance/totalfinance/risk/optimize"},{"title":"kellyBet","url":"/reference/totalfinance/risk/page-10#kellyBet","description":"Size a single bet by the Kelly criterion — compute the growth-optimal fraction from the edge, then\nscale it down sanely (half-Kelly by default, a drawdown budge","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).drawdownLimit (input).drawdownLimit.maxProbability (input).drawdownLimit.toFraction (input).edge (input).edge.binary (input) @insiderfinance/totalfinance/risk/sizing"},{"title":"linkAttribution","url":"/reference/totalfinance/risk/page-10#linkAttribution","description":"Link single-period Brinson attributions across time with **Cariño's** logarithmic coefficients, so the\ncumulative allocation / selection / interaction sum **exa","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).method (periods) return.activeReturn return.allocation return.assumptions return.assumptions.conventionsVersion return.a"},{"title":"liquidity","url":"/reference/totalfinance/risk/page-10#liquidity","description":"Liquidity approximation: days to liquidate each position when trading at most `participation` of its\naverage daily volume (default 20%), plus the slowest name's","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).participation (positions) return.assumptions return.assumptions.conventionsVersion return.diagnostics return.diagnostics @insiderfinance/totalfinance/risk/portfolio"},{"title":"margin","url":"/reference/totalfinance/risk/page-10#margin","description":"Margin approximation from signed position notionals and account equity: gross/net/long/short\nexposure, Reg-T-style initial (default 50%) and maintenance (defaul","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).equity (options).initialRate (options).maintenanceRate (positionNotionals) return.assumptions return.assumptions.convent @insiderfinance/totalfinance/risk/portfolio"},{"title":"marketImpact","url":"/reference/totalfinance/risk/page-10#marketImpact","description":"Plain impact cost; use `marketImpact.explain(...)` for the coefficient and diagnostics.","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/risk/portfolio"},{"title":"maxSharpe","url":"/reference/totalfinance/risk/page-10#maxSharpe","description":"function from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).covariance (input).mean (input).options return.assumptions return.diagnostics return.provenance return.value return.value.ob @insiderfinance/totalfinance/risk/optimize"},{"title":"meanExcessPlot","url":"/reference/totalfinance/risk/page-10#meanExcessPlot","description":"The **mean-excess plot** — the standard tool for choosing the EVT peaks-over-threshold cutoff the rest of\nthe pack takes as an input. The mean-excess `e(u) = E[","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).gridSize (options).linearTolerance (options).minExceedances (options).startQuantile (options).thresholds (returns) retur"},{"title":"meanReturns","url":"/reference/totalfinance/risk/page-10#meanReturns","description":"Per-asset arithmetic mean returns from observations-major history — the `mu` for\n`maxSharpe({ mean, covariance })` / `meanVariance({ mean, covariance })`. Kept ","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).periodsPerYear (input).returns"},{"title":"meanVariance","url":"/reference/totalfinance/risk/page-10#meanVariance","description":"function from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).covariance (input).mean (input).options return.assumptions return.diagnostics return.provenance return.value return.value.ob @insiderfinance/totalfinance/risk/optimize"},{"title":"minVariance","url":"/reference/totalfinance/risk/page-10#minVariance","description":"Global minimum-variance portfolio. `value.objective` is the portfolio variance `wᵀΣw`.","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (constraints) (constraints).bounds (constraints).budget (constraints).groups (constraints).longOnly (constraints).maximumIterations (constra @insiderfinance/totalfinance/risk/optimize"},{"title":"nakedCallMargin","url":"/reference/totalfinance/risk/page-10#nakedCallMargin","description":"Plain per-contract requirement; use `.explain()` for the applied Reg-T knobs.","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/risk/portfolio"},{"title":"nakedPutMargin","url":"/reference/totalfinance/risk/page-10#nakedPutMargin","description":"Plain per-contract requirement; use `.explain()` for the applied Reg-T knobs.","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/risk/portfolio"},{"title":"optionsMargin","url":"/reference/totalfinance/risk/page-10#optionsMargin","description":"Initial margin / buying-power for a single-underlying, single-expiry multi-leg option position\n(spec §15.3, product review §6). The expiration payoff is piecewi","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (legs) (options) (options).equityRate (options).floorRate (options).multiplier (options).putMarginBasis (options).spot return.assumptions re @insiderfinance/totalfinance/risk/portfolio @insiderfinance/totalfinance/risk/sizing"},{"title":"parameterSweepDiagnostics","url":"/reference/totalfinance/risk/page-10#parameterSweepDiagnostics","description":"Summarize a parameter sweep: given the per-trial Sharpes and the sample statistics of the *selected*\n(best) configuration's return series, report the dispersion","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (selected) (selected).kurtosis (selected).observations (selected).sharpe (selected).skewness (trialSharpes) return.bestSharpe return.deflate @insiderfinance/totalfinance/risk/research"},{"title":"pca","url":"/reference/totalfinance/risk/page-10#pca","description":"Principal-component analysis of a covariance (or, with `correlation`, the standardized) matrix.","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (covariance) (options) (options).correlation return.assumptions return.assumptions.conventionsVersion return.components return.cumulativeVar @insiderfinance/totalfinance/risk/factor"},{"title":"portfolioVaR","url":"/reference/totalfinance/risk/page-11#portfolioVaR","description":"function from @insiderfinance/totalfinance/risk","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).method (input).options (input).returns (input).weights return.assumptions return.assumptions.conventionsVersion return.compo @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"portfolioVariance","url":"/reference/totalfinance/risk/page-11#portfolioVariance","description":"Portfolio variance `wᵀΣw` (H07 contract): every weight and covariance cell validated finite, Σ\nnumerically symmetric with a non-negative diagonal, a materially ","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (covariance) (weights) @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"portfolioVolatility","url":"/reference/totalfinance/risk/page-11#portfolioVolatility","description":"Portfolio volatility `√(wᵀΣw)` — H08: delegates to H07's variance kernel, validating under its own name.","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (covariance) (weights) @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"probabilisticSharpeRatio","url":"/reference/totalfinance/risk/page-11#probabilisticSharpeRatio","description":"Plain probability; use `.explain()` for the benchmark and observation count.","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/risk/research"},{"title":"probabilityOfBacktestOverfitting","url":"/reference/totalfinance/risk/page-11#probabilityOfBacktestOverfitting","description":"**Probability of backtest overfitting** (Bailey & López de Prado's CSCV). Given a `T × N` matrix of\nper-period returns — `T` time observations (rows) × `N` stra","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).splits (returns) return.assumptions return.assumptions.conventionsVersion return.backtestOverfittingProbability return.c @insiderfinance/totalfinance/risk/research"},{"title":"purgedKFold","url":"/reference/totalfinance/risk/page-11#purgedKFold","description":"Purged & embargoed K-fold cross-validation (López de Prado, *Advances in Financial ML* ch. 7).\nEach fold's test set is a contiguous block; training drops any ob","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (observationCount) (options) (options).embargo (options).folds (options).purgeGap @insiderfinance/totalfinance/risk/research"},{"title":"researchProtocol","url":"/reference/totalfinance/risk/page-11#researchProtocol","description":"Render a statistically honest verdict on a research process — deflate for selection, confirm\nout-of-sample, and conclude `significant` / `inconclusive` / `likel","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).confidence (input).outOfSampleReturns (input).periodsPerYear (input).returns (input).riskFreeRate (input).trials (input).tri"},{"title":"riskContributions","url":"/reference/totalfinance/risk/page-11#riskContributions","description":"Per-asset volatility risk contributions (H10 report). A zero-volatility portfolio has no\ndefined marginal/component/fraction — those rows carry `null` with a de","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (covariance) (weights) return.assumptions return.assumptions.assets return.assumptions.conventionsVersion return.contributions return.diagno @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"riskParity","url":"/reference/totalfinance/risk/page-11#riskParity","description":"Equal-risk-contribution (risk parity) portfolio.","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (covariance) (options) (options).budget (options).maximumIterations (options).tolerance return.assumptions return.diagnostics return.provena @insiderfinance/totalfinance/risk/optimize"},{"title":"scenario","url":"/reference/totalfinance/risk/page-11#scenario","description":"Build a named scenario from shocks. Each shock is validated at build time (use the `shock.*`\nconstructors — they produce exactly this shape), so a malformed sho","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (name) (shocks) return.name return.shocks @insiderfinance/totalfinance/risk/scenario"},{"title":"scenarioGrid","url":"/reference/totalfinance/risk/page-11#scenarioGrid","description":"2-D scenario grid (H12 report): P&L (per unit) of one position's Greeks across a Cartesian\nproduct of spot and vol shocks. A serialized result is self-interpret","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).greeks (input).spotShocks (input).volatilityShocks return.assumptions return.assumptions.conventionsVersion return.assumptio @insiderfinance/totalfinance/risk/scenario"},{"title":"sharpeStatistics","url":"/reference/totalfinance/risk/page-11#sharpeStatistics","description":"Sample Sharpe statistics of a return series: the per-observation (non-annualized) Sharpe plus the\nskewness and (non-excess) kurtosis that the probabilistic-Shar","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).riskFreeRate (returns) return.assumptions return.assumptions.conventionsVersion return.diagnostics return.diagnostics.wa @insiderfinance/totalfinance/risk/research"},{"title":"shock","url":"/reference/totalfinance/risk/page-11#shock","description":"Typed shock constructors. Strings carry units; raw numbers are absolute.","category":"@insiderfinance/totalfinance/risk","kind":"value","keywords":"@insiderfinance/totalfinance/risk value  dividend dividend().return.factor dividend().return.kind dividend().return.value dividend(change) factor factor().return.factor factor().ret @insiderfinance/totalfinance/risk/scenario"},{"title":"shrunkKelly","url":"/reference/totalfinance/risk/page-11#shrunkKelly","description":"Estimation-error-shrunk portfolio Kelly. The plug-in weights `Σ̂⁻¹μ̂` overbet because `μ̂`/`Σ̂` are\nestimated from a finite sample; this scales them by the grow","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).covariance (input).fraction (input).mean (input).sampleSize return.appliedScaling return.assumptions return.assumptions.asse"},{"title":"spectralRisk","url":"/reference/totalfinance/risk/page-11#spectralRisk","description":"A coherent spectral risk measure (Acerbi): a weighted average of the loss quantiles with a\nnon-decreasing weight on worse outcomes. Pass `{ riskAversion }` for ","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).alpha (options).riskAversion (returns) return.alpha return.assumptions return.assumptions.conventionsVersion return.diag"},{"title":"stressTest","url":"/reference/totalfinance/risk/page-11#stressTest","description":"Stress a positions book across scenarios (H11 report): per-scenario and per-position P&L.","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (input) (input).options (input).positions (input).scenarios return.assumptions return.assumptions.conventionsVersion return.assumptions.posi @insiderfinance/totalfinance/risk/scenario"},{"title":"survivorshipWarning","url":"/reference/totalfinance/risk/page-11#survivorshipWarning","description":"Return a survivorship-bias warning when the backtest universe excludes delisted names or is not\npoint-in-time — both bias results upward — or `null` when neithe","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (context) (context).includesDelisted (context).pointInTimeUniverse return.code return.context return.message return.severity @insiderfinance/totalfinance/risk/research"},{"title":"taylorPnl","url":"/reference/totalfinance/risk/page-11#taylorPnl","description":"Greeks-Taylor P&L of a single position's Greeks under a scenario (per unit).","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (greeks) (greeks).charm (greeks).color (greeks).delta (greeks).deltaRate (greeks).gamma (greeks).lambda (greeks).phi (greeks).rho (greeks).r @insiderfinance/totalfinance/risk/scenario"},{"title":"valueAtRisk","url":"/reference/totalfinance/risk/page-11#valueAtRisk","description":"VaR (positive loss magnitude) for a single return/P&L series. Plain call → the number;\n`.explain()` → the Computed envelope echoing confidence/method/horizonPer","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"valueAtRiskReport","url":"/reference/totalfinance/risk/page-11#valueAtRiskReport","description":"Full VaR + CVaR report for a single return/P&L series.","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (options) (options).confidence (options).cornishFisher (options).horizonPeriods (options).method (options).samples (options).seed (returns)  @insiderfinance/totalfinance/risk/value-at-risk"},{"title":"walkForwardSplits","url":"/reference/totalfinance/risk/page-12#walkForwardSplits","description":"Generate walk-forward (rolling or anchored) train/test splits over `n` ordered observations.","category":"@insiderfinance/totalfinance/risk","kind":"function","keywords":"@insiderfinance/totalfinance/risk function  (observationCount) (options) (options).mode (options).step (options).testSize (options).trainSize @insiderfinance/totalfinance/risk/research"},{"title":"EfficientFrontierConstraints","url":"/reference/totalfinance/risk/optimize#EfficientFrontierConstraints","description":"Frontier constraints are the shared feasible-region grammar. Linear transaction costs are an\nobjective penalty, not a feasible-region constraint, and therefore ","category":"@insiderfinance/totalfinance/risk/optimize","kind":"type","keywords":"@insiderfinance/totalfinance/risk/optimize type  bounds budget groups longOnly maximumIterations tolerance turnover turnover.max turnover.previousWeights"},{"title":"PutMarginBasis","url":"/reference/totalfinance/risk/portfolio#PutMarginBasis","description":"How an UNCOVERED short put is margined:\n  - `'reg-t-naked'` (default) — the Reg-T naked-put requirement, i.e. {@link nakedPutMargin};\n  - `'cash-secured'` — the","category":"@insiderfinance/totalfinance/risk/portfolio","kind":"type","keywords":"@insiderfinance/totalfinance/risk/portfolio type  "},{"title":"StressTestInput","url":"/reference/totalfinance/risk/scenario#StressTestInput","description":"interface from @insiderfinance/totalfinance/risk/scenario","category":"@insiderfinance/totalfinance/risk/scenario","kind":"interface","keywords":"@insiderfinance/totalfinance/risk/scenario interface  options options.reprice options.reprice(position) options.reprice(position).data options.reprice(position).greeks options.reprice(position)."},{"title":"ValueAtRiskAssumptionExtras","url":"/reference/totalfinance/risk/value-at-risk#ValueAtRiskAssumptionExtras","description":"Conventions a VaR-family explain envelope discloses.","category":"@insiderfinance/totalfinance/risk/value-at-risk","kind":"type","keywords":"@insiderfinance/totalfinance/risk/value-at-risk type  confidence cornishFisher distribution horizonPeriods method momentScaling quantileEstimator samples seed"},{"title":"FullRevaluationScenarioPortfolioBindingDescriptor","url":"/reference/totalfinance/scenarios#FullRevaluationScenarioPortfolioBindingDescriptor","description":"Serializable full-revaluation durable-portfolio binding descriptor.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  accountId bindingDescriptorHash book id instrumentDescriptor instrumentDescriptorHash instrumentId pricer pricer.capabilities pricer.capabil @insiderfinance/totalfinance/scenarios/portfolio"},{"title":"FullRevaluationScenarioPortfolioBindingInput","url":"/reference/totalfinance/scenarios#FullRevaluationScenarioPortfolioBindingInput","description":"Full-revaluation durable-portfolio binding.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  accountId book id instrument instrumentDescriptor instrumentId pricer pricer.capabilities pricer.capabilities.batch pricer.capabilities.gree @insiderfinance/totalfinance/scenarios/portfolio"},{"title":"FullRevaluationScenarioTargetDescriptor","url":"/reference/totalfinance/scenarios#FullRevaluationScenarioTargetDescriptor","description":"Serializable full-revaluation target descriptor; behavior is deliberately absent.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  account book contractMultiplier currency id instrumentDescriptor instrumentDescriptorHash pricer pricer.capabilities pricer.capabilities.bat"},{"title":"FullRevaluationScenarioTargetInput","url":"/reference/totalfinance/scenarios#FullRevaluationScenarioTargetInput","description":"Bind one concrete instrument to the pricer that understands it.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  account book contractMultiplier currency id instrument instrumentDescriptor pricer pricer.capabilities pricer.capabilities.batch pricer.capa"},{"title":"RunScenariosInput","url":"/reference/totalfinance/scenarios#RunScenariosInput","description":"One complete shared-scenario request.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  currencyConversions market market.asOf market.conventions market.conventions.asOfConvention market.conventions.calendar market.conventions.c"},{"title":"RunScenariosOptions","url":"/reference/totalfinance/scenarios#RunScenariosOptions","description":"Closed execution options for `runScenarios`.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  factorHandlers failureMode marketResolvers maximumValuationCells maximumWorkUnits seed"},{"title":"ScenarioAggregateRow","url":"/reference/totalfinance/scenarios#ScenarioAggregateRow","description":"One deterministic aggregate row.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  baseValue failedTargetIds group key pnl reason reportingCurrency scenarioValue status targetIds"},{"title":"ScenarioAppliedCurveInstruction","url":"/reference/totalfinance/scenarios#ScenarioAppliedCurveInstruction","description":"Compact discount-curve instruction detail.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  afterCurveHash beforeCurveHash detail factor instructionIndex phase pillarCount subject target"},{"title":"ScenarioAppliedCustomInstruction","url":"/reference/totalfinance/scenarios#ScenarioAppliedCustomInstruction","description":"Compact custom-handler instruction detail.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  afterObservationsHash beforeObservationsHash detail factor handler handler.name handler.version instructionIndex phase subject target"},{"title":"ScenarioAppliedInstruction","url":"/reference/totalfinance/scenarios#ScenarioAppliedInstruction","description":"Lossless identity of an instruction applied to one target cell.","category":"@insiderfinance/totalfinance/scenarios","kind":"type","keywords":"@insiderfinance/totalfinance/scenarios type  after afterCurveHash afterObservationsHash before beforeCurveHash beforeObservationsHash detail factor handler handler.name handler.version "},{"title":"ScenarioAppliedInstructionBase","url":"/reference/totalfinance/scenarios#ScenarioAppliedInstructionBase","description":"Shared coordinates recorded for every applied instruction.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  factor instructionIndex phase subject target"},{"title":"ScenarioAppliedScalarInstruction","url":"/reference/totalfinance/scenarios#ScenarioAppliedScalarInstruction","description":"Scalar or foreign-exchange instruction detail.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  after before detail factor instructionIndex phase subject target"},{"title":"ScenarioAxisRow","url":"/reference/totalfinance/scenarios#ScenarioAxisRow","description":"Stable scenario-axis metadata.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  name overrideCount scenarioHash scenarioIndex shockCount"},{"title":"ScenarioBaseAggregateSet","url":"/reference/totalfinance/scenarios#ScenarioBaseAggregateSet","description":"Aggregate rows for the base axis.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  kind rows scenarioIndex scenarioName"},{"title":"ScenarioBaseCell","url":"/reference/totalfinance/scenarios#ScenarioBaseCell","description":"Base valuation cell.","category":"@insiderfinance/totalfinance/scenarios","kind":"type","keywords":"@insiderfinance/totalfinance/scenarios type  failure failure.code failure.context failure.contextStatus failure.message failure.scenarioIndex failure.scenarioName failure.targetId failu"},{"title":"ScenarioBehaviorIdentity","url":"/reference/totalfinance/scenarios#ScenarioBehaviorIdentity","description":"Serializable name/version identity for a callback used by the run.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  name version"},{"title":"ScenarioCell","url":"/reference/totalfinance/scenarios#ScenarioCell","description":"Scenario valuation cell.","category":"@insiderfinance/totalfinance/scenarios","kind":"type","keywords":"@insiderfinance/totalfinance/scenarios type  blockedByBaseFailure blockedByBaseFailure.code blockedByBaseFailure.context blockedByBaseFailure.contextStatus blockedByBaseFailure.message "},{"title":"ScenarioCurrencyConversionUse","url":"/reference/totalfinance/scenarios#ScenarioCurrencyConversionUse","description":"Exact currency quote and orientation used for one conversion.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  orientation quote quote.baseCurrency quote.quoteCurrency quote.quotePerBase sourceQuoteIndex"},{"title":"ScenarioExecutionFailure","url":"/reference/totalfinance/scenarios#ScenarioExecutionFailure","description":"Behavior-free execution failure safe to retain in an artifact.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  code context contextStatus message scenarioIndex scenarioName targetId targetIndex valuationMethod"},{"title":"ScenarioFactorHandler","url":"/reference/totalfinance/scenarios#ScenarioFactorHandler","description":"One synchronous, per-call owner of a non-reserved scenario factor.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  apply apply(input) apply(input).instruction apply(input).instruction.factor apply(input).instruction.kind apply(input).instruction.target ap"},{"title":"ScenarioFactorHandlerInput","url":"/reference/totalfinance/scenarios/page-2#ScenarioFactorHandlerInput","description":"Frozen, behavior-free input supplied to one custom-factor handler call.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  instruction instruction.factor instruction.kind instruction.target instruction.value observations target target.account target.book target.c"},{"title":"ScenarioFullRevaluationValue","url":"/reference/totalfinance/scenarios/page-2#ScenarioFullRevaluationValue","description":"Successful full-revaluation cell payload.","category":"@insiderfinance/totalfinance/scenarios","kind":"type","keywords":"@insiderfinance/totalfinance/scenarios type  appliedInstructions contractMultiplier currencyConversion currencyConversion.orientation currencyConversion.quote currencyConversion.quote.b"},{"title":"ScenarioMarketResolver","url":"/reference/totalfinance/scenarios/page-2#ScenarioMarketResolver","description":"One synchronous, per-call market-requirement resolver.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  name resolve resolve().return.requirement resolve().return.requirement.currency resolve().return.requirement.curveId resolve().return.requir"},{"title":"ScenarioMarketResolverInput","url":"/reference/totalfinance/scenarios/page-2#ScenarioMarketResolverInput","description":"Frozen, behavior-free input supplied to one market resolver call.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  market market.asOf market.conventions market.conventions.asOfConvention market.conventions.calendar market.conventions.compounding market.co"},{"title":"ScenarioMetric","url":"/reference/totalfinance/scenarios/page-2#ScenarioMetric","description":"Estimated and observed value for one execution metric.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  actual estimated unavailableReason"},{"title":"ScenarioOutcomeAggregateSet","url":"/reference/totalfinance/scenarios/page-2#ScenarioOutcomeAggregateSet","description":"Aggregate rows for one scenario.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  kind rows scenarioIndex scenarioName"},{"title":"ScenarioPortfolioBinding","url":"/reference/totalfinance/scenarios/page-2#ScenarioPortfolioBinding","description":"Opaque, builder-produced durable-portfolio scenario binding.","category":"@insiderfinance/totalfinance/scenarios","kind":"type","keywords":"@insiderfinance/totalfinance/scenarios type   @insiderfinance/totalfinance/scenarios/portfolio"},{"title":"ScenarioPortfolioBindingBaseInput","url":"/reference/totalfinance/scenarios/page-2#ScenarioPortfolioBindingBaseInput","description":"Identity and grouping supplied by a durable-portfolio binding.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  accountId book id instrumentId strategy tags @insiderfinance/totalfinance/scenarios/portfolio"},{"title":"ScenarioPortfolioBindingBuilders","url":"/reference/totalfinance/scenarios/page-2#ScenarioPortfolioBindingBuilders","description":"The public two-builder durable-portfolio binding namespace.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  fullRevaluation fullRevaluation(input) fullRevaluation(input).accountId fullRevaluation(input).book fullRevaluation(input).id fullRevaluatio @insiderfinance/totalfinance/scenarios/portfolio"},{"title":"ScenarioPortfolioBindingDescriptor","url":"/reference/totalfinance/scenarios/page-2#ScenarioPortfolioBindingDescriptor","description":"Complete public durable-portfolio binding data.","category":"@insiderfinance/totalfinance/scenarios","kind":"type","keywords":"@insiderfinance/totalfinance/scenarios type  accountId bindingDescriptorHash book id instrumentDescriptor instrumentDescriptorHash instrumentId pricer pricer.capabilities pricer.capabil @insiderfinance/totalfinance/scenarios/portfolio"},{"title":"ScenarioPortfolioBindingDescriptorBase","url":"/reference/totalfinance/scenarios/page-2#ScenarioPortfolioBindingDescriptorBase","description":"Serializable durable-portfolio binding identity.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  accountId bindingDescriptorHash book id instrumentId strategy tags @insiderfinance/totalfinance/scenarios/portfolio"},{"title":"ScenarioPricerDescriptor","url":"/reference/totalfinance/scenarios/page-2#ScenarioPricerDescriptor","description":"Serializable identity and capabilities of the behavior bound to a target.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  capabilities capabilities.batch capabilities.greeks capabilities.randomness name version"},{"title":"ScenarioPricingResult","url":"/reference/totalfinance/scenarios/page-2#ScenarioPricingResult","description":"Detached Gate-C pricing result retained without discarding domain-specific fields.","category":"@insiderfinance/totalfinance/scenarios","kind":"type","keywords":"@insiderfinance/totalfinance/scenarios type  assumptions diagnostics diagnostics.autoReason diagnostics.converged diagnostics.decomposition diagnostics.engine diagnostics.finiteDifferen"},{"title":"ScenarioReadonlyData","url":"/reference/totalfinance/scenarios/page-2#ScenarioReadonlyData","description":"Recursively readonly view of canonical scenario callback data.","category":"@insiderfinance/totalfinance/scenarios","kind":"type","keywords":"@insiderfinance/totalfinance/scenarios type  "},{"title":"ScenarioReadonlyMarketObservation","url":"/reference/totalfinance/scenarios/page-2#ScenarioReadonlyMarketObservation","description":"Named, tool-walkable readonly projection of core's existing `MarketObservation` union.\n\nThe arm/value grammar remains owned by `@insiderfinance/totalfinance/cor","category":"@insiderfinance/totalfinance/scenarios","kind":"type","keywords":"@insiderfinance/totalfinance/scenarios type  requirement requirement.currency requirement.curveId requirement.expiresAt requirement.kind requirement.optional requirement.strike requirem"},{"title":"ScenarioReadonlyRateCurve","url":"/reference/totalfinance/scenarios/page-2#ScenarioReadonlyRateCurve","description":"Readonly callback view of core's existing plain-data `RateCurve`.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  asOf compounding compounding.periodsPerYear compounding.type currency dayCount interpolation points"},{"title":"ScenarioReadonlyRateCurvePoint","url":"/reference/totalfinance/scenarios/page-2#ScenarioReadonlyRateCurvePoint","description":"Readonly curve pillar supplied to or returned from a scenario callback.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  date zeroRate"},{"title":"ScenarioReplayParameters","url":"/reference/totalfinance/scenarios/page-2#ScenarioReplayParameters","description":"Canonical JSON-safe parameters needed to reproduce a run.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  currencyConversions factorHandlers failureMode maximumValuationCells maximumWorkUnits millisecondsPerYear reportingCurrency resolvers result"},{"title":"ScenarioReplayTargetBinding","url":"/reference/totalfinance/scenarios/page-2#ScenarioReplayTargetBinding","description":"Explicit behavior-only handoff used by artifact replay fixtures.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  target targetId"},{"title":"ScenarioResultLayout","url":"/reference/totalfinance/scenarios/page-2#ScenarioResultLayout","description":"Stable flat-grid indexing contract.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  cellCount cellsPerScenario indexFormula order scenarioCount targetCount"},{"title":"ScenarioRunAssumptions","url":"/reference/totalfinance/scenarios/page-3#ScenarioRunAssumptions","description":"Complete assumptions and execution laws applied by the runner.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  baseSeed conventionsVersion currencyConversionPolicy factorHandlers failureMode inputRateCompounding inputRateCompounding.periodsPerYear inp"},{"title":"ScenarioRunDiagnostics","url":"/reference/totalfinance/scenarios/page-3#ScenarioRunDiagnostics","description":"Warnings, failures, unused inputs, and bounded-work evidence.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  failures metrics metrics.blockedCells metrics.blockedCells.actual metrics.blockedCells.estimated metrics.blockedCells.unavailableReason metr"},{"title":"ScenarioRunMetrics","url":"/reference/totalfinance/scenarios/page-3#ScenarioRunMetrics","description":"Bounded-work and execution counters for one run.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  blockedCells blockedCells.actual blockedCells.estimated blockedCells.unavailableReason factorHandlerCalls factorHandlerCalls.actual factorHa"},{"title":"ScenarioRunResult","url":"/reference/totalfinance/scenarios/page-3#ScenarioRunResult","description":"Complete shared scenario analysis result.","category":"@insiderfinance/totalfinance/scenarios","kind":"type","keywords":"@insiderfinance/totalfinance/scenarios type  aggregates aggregates.base aggregates.base.kind aggregates.base.rows aggregates.base.scenarioIndex aggregates.base.scenarioName aggregates.s"},{"title":"ScenarioSuccessfulValueFields","url":"/reference/totalfinance/scenarios/page-3#ScenarioSuccessfulValueFields","description":"Successful value fields common to base and scenario cells.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  appliedInstructions contractMultiplier currencyConversion currencyConversion.orientation currencyConversion.quote currencyConversion.quote.b"},{"title":"ScenarioTarget","url":"/reference/totalfinance/scenarios/page-3#ScenarioTarget","description":"Opaque, builder-produced scenario target.","category":"@insiderfinance/totalfinance/scenarios","kind":"type","keywords":"@insiderfinance/totalfinance/scenarios type  "},{"title":"ScenarioTargetAxisRow","url":"/reference/totalfinance/scenarios/page-3#ScenarioTargetAxisRow","description":"Stable target-axis metadata.","category":"@insiderfinance/totalfinance/scenarios","kind":"type","keywords":"@insiderfinance/totalfinance/scenarios type  "},{"title":"ScenarioTargetBaseInput","url":"/reference/totalfinance/scenarios/page-3#ScenarioTargetBaseInput","description":"Shared identity, scaling, and grouping fields for a scenario target.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  account book contractMultiplier currency id quantity strategy tags underlying"},{"title":"ScenarioTargetBuilders","url":"/reference/totalfinance/scenarios/page-3#ScenarioTargetBuilders","description":"The public three-builder target namespace.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  fullRevaluation fullRevaluation(input) fullRevaluation(input).account fullRevaluation(input).book fullRevaluation(input).contractMultiplier "},{"title":"ScenarioTargetDescriptor","url":"/reference/totalfinance/scenarios/page-3#ScenarioTargetDescriptor","description":"Complete public target data, without the private instrument/pricer binding.","category":"@insiderfinance/totalfinance/scenarios","kind":"type","keywords":"@insiderfinance/totalfinance/scenarios type  account book contractMultiplier currency id instrumentDescriptor instrumentDescriptorHash pricer pricer.capabilities pricer.capabilities.bat"},{"title":"ScenarioTargetDescriptorBase","url":"/reference/totalfinance/scenarios/page-3#ScenarioTargetDescriptorBase","description":"Serializable fields common to every target-axis row.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  account book contractMultiplier currency id quantity strategy tags targetDescriptorHash underlying"},{"title":"ScenarioTargetsFromPortfolioInput","url":"/reference/totalfinance/scenarios/page-3#ScenarioTargetsFromPortfolioInput","description":"Convert one detached durable portfolio state into runner targets.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  bindings state state.accountMigrations state.accounts state.appliedEvents state.baseCurrency state.eventCount state.fillEffects state.lastEf @insiderfinance/totalfinance/scenarios/portfolio"},{"title":"ScenarioTaylorValue","url":"/reference/totalfinance/scenarios/page-3#ScenarioTaylorValue","description":"Successful Taylor scenario cell payload.","category":"@insiderfinance/totalfinance/scenarios","kind":"type","keywords":"@insiderfinance/totalfinance/scenarios type  appliedInstructions contractMultiplier currencyConversion currencyConversion.orientation currencyConversion.quote currencyConversion.quote.b"},{"title":"ScenarioValuationMethod","url":"/reference/totalfinance/scenarios/page-3#ScenarioValuationMethod","description":"Valuation method used by one target.","category":"@insiderfinance/totalfinance/scenarios","kind":"type","keywords":"@insiderfinance/totalfinance/scenarios type  "},{"title":"SpotAssetInstrument","url":"/reference/totalfinance/scenarios/page-3#SpotAssetInstrument","description":"Plain instrument consumed by the first-party spot pricer.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  symbol"},{"title":"SpotScenarioTargetInput","url":"/reference/totalfinance/scenarios/page-3#SpotScenarioTargetInput","description":"Builder input for the common one-unit spot-asset target.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  account book currency id quantity strategy symbol tags"},{"title":"TaylorFactorLevel","url":"/reference/totalfinance/scenarios/page-3#TaylorFactorLevel","description":"One named Taylor factor and the level at which the supplied sensitivities were measured.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  level subject"},{"title":"TaylorFactors","url":"/reference/totalfinance/scenarios/page-3#TaylorFactors","description":"Explicit base levels used by a Taylor approximation.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  dividend dividend.level dividend.subject riskFreeRate riskFreeRate.level riskFreeRate.subject spot spot.level spot.subject valuationInstant "},{"title":"TaylorScenarioPortfolioBindingDescriptor","url":"/reference/totalfinance/scenarios/page-3#TaylorScenarioPortfolioBindingDescriptor","description":"Serializable Taylor durable-portfolio binding descriptor.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  accountId bindingDescriptorHash book id instrumentId strategy tags taylor taylor.baseValuePerUnit taylor.factors taylor.factors.dividend tay @insiderfinance/totalfinance/scenarios/portfolio"},{"title":"TaylorScenarioPortfolioBindingInput","url":"/reference/totalfinance/scenarios/page-3#TaylorScenarioPortfolioBindingInput","description":"Taylor durable-portfolio binding.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  accountId baseValuePerUnit book factors factors.dividend factors.dividend.level factors.dividend.subject factors.riskFreeRate factors.riskFr @insiderfinance/totalfinance/scenarios/portfolio"},{"title":"TaylorScenarioTargetDescriptor","url":"/reference/totalfinance/scenarios/page-4#TaylorScenarioTargetDescriptor","description":"Serializable Taylor target descriptor.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  account book contractMultiplier currency id quantity strategy tags targetDescriptorHash taylor taylor.baseValuePerUnit taylor.factors taylor"},{"title":"TaylorScenarioTargetInput","url":"/reference/totalfinance/scenarios/page-4#TaylorScenarioTargetInput","description":"Builder input for an explicit Greeks-Taylor approximation.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  account baseValuePerUnit book contractMultiplier currency factors factors.dividend factors.dividend.level factors.dividend.subject factors.r"},{"title":"TaylorSensitivities","url":"/reference/totalfinance/scenarios/page-4#TaylorSensitivities","description":"Greeks for a Taylor target in TotalFinance's ONE unit system — the units `@insiderfinance/totalfinance/options` reports\n(theta per calendar day, vega per volati","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  charm delta deltaRate gamma phi rho rhoConvexity theta thetaConvexity thetaRate vanna vega vera veta vomma"},{"title":"TaylorValuationInstantLevel","url":"/reference/totalfinance/scenarios/page-4#TaylorValuationInstantLevel","description":"Base valuation instant for time sensitivities.","category":"@insiderfinance/totalfinance/scenarios","kind":"interface","keywords":"@insiderfinance/totalfinance/scenarios interface  level"},{"title":"runScenarios","url":"/reference/totalfinance/scenarios/page-4#runScenarios","description":"Run one validated ScenarioSet over heterogeneous builder-owned targets and one market snapshot.","category":"@insiderfinance/totalfinance/scenarios","kind":"function","keywords":"@insiderfinance/totalfinance/scenarios function  (rawInput) (rawInput).currencyConversions (rawInput).market (rawInput).options (rawInput).reportingCurrency (rawInput).scenarioSet (rawInput"},{"title":"scenarioPortfolioBinding","url":"/reference/totalfinance/scenarios/page-4#scenarioPortfolioBinding","description":"Opaque builder namespace for durable portfolio-to-scenario bindings.","category":"@insiderfinance/totalfinance/scenarios","kind":"value","keywords":"@insiderfinance/totalfinance/scenarios value  fullRevaluation fullRevaluation(input) fullRevaluation(input).accountId fullRevaluation(input).book fullRevaluation(input).id fullRevaluatio @insiderfinance/totalfinance/scenarios/portfolio"},{"title":"scenarioTarget","url":"/reference/totalfinance/scenarios/page-4#scenarioTarget","description":"Builder namespace for opaque, immutable scenario targets.","category":"@insiderfinance/totalfinance/scenarios","kind":"value","keywords":"@insiderfinance/totalfinance/scenarios value  fullRevaluation fullRevaluation(input) fullRevaluation(input).account fullRevaluation(input).book fullRevaluation(input).contractMultiplier "},{"title":"scenarioTargetsFromPortfolio","url":"/reference/totalfinance/scenarios/page-4#scenarioTargetsFromPortfolio","description":"Convert every open position in one validated durable portfolio snapshot into exactly one opaque\nscenario target. Ledger facts remain authoritative; bindings con","category":"@insiderfinance/totalfinance/scenarios","kind":"function","keywords":"@insiderfinance/totalfinance/scenarios function  (rawInput) (rawInput).bindings (rawInput).state @insiderfinance/totalfinance/scenarios/portfolio"},{"title":"spotAssetPricer","url":"/reference/totalfinance/scenarios/page-4#spotAssetPricer","description":"First-party Gate-C adapter for a directly observed spot asset. Its per-unit value is exactly the\nmatching spot observation; quantity and any contract multiplier","category":"@insiderfinance/totalfinance/scenarios","kind":"function","keywords":"@insiderfinance/totalfinance/scenarios function  return.capabilities return.name return.price return.priceBatch return.requirements return.supports return.version"},{"title":"BuildStrategyInput","url":"/reference/totalfinance/strategy#BuildStrategyInput","description":"Build a named strategy chosen at runtime: `buildStrategy({ name: 'ironCondor', input })` is exactly\n`ironCondor(input)` with the name as data — for agents, UIs,","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  config config.expiry config.market config.market.asOf config.market.dividendYield config.market.expiry config.market.riskFreeRate config.mar"},{"title":"CalendarInput","url":"/reference/totalfinance/strategy#CalendarInput","description":"A calendar (horizontal) spread: same strike, short near leg + long far leg. Multi-expiry by\nconstruction, so there is deliberately NO single `expiry` field — th","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  farExpiry longPremium nearExpiry quantity shortPremium strike"},{"title":"ChainFill","url":"/reference/totalfinance/strategy#ChainFill","description":"One resolved fill: the traded contract (null for a stock leg), its premium, and its delta.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash contract.deliverable.notes contract.deliverable. @insiderfinance/totalfinance/strategy/from-chain"},{"title":"ChartInclude","url":"/reference/totalfinance/strategy#ChartInclude","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  currentPnl delta expirationPnl theta"},{"title":"ClassifiableLeg","url":"/reference/totalfinance/strategy#ClassifiableLeg","description":"The members `strategySignature` reads; a stock row carries no strike (`undefined`), an option row must.","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  expiry kind quantity strike"},{"title":"CollarInput","url":"/reference/totalfinance/strategy#CollarInput","description":"Collar: long 100·q shares + long q protective puts + short q covered calls.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  call call.premium call.strike expiry put put.premium put.strike quantity stockPrice"},{"title":"CondorInput","url":"/reference/totalfinance/strategy#CondorInput","description":"Four ascending same-type strikes `k1 < k2 < k3 < k4`.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  expiry k1 k1.premium k1.strike k2 k2.premium k2.strike k3 k3.premium k3.strike k4 k4.premium k4.strike quantity"},{"title":"DiagonalInput","url":"/reference/totalfinance/strategy#DiagonalInput","description":"A diagonal spread: short near leg and long far leg at different strikes. No single `expiry`\nfield exists (see {@link CalendarInput}); either strike ordering is ","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  farExpiry longPremium longStrike nearExpiry quantity shortPremium shortStrike"},{"title":"DirectionalBias","url":"/reference/totalfinance/strategy#DirectionalBias","description":"type from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  "},{"title":"DoubleDiagonalInput","url":"/reference/totalfinance/strategy#DoubleDiagonalInput","description":"Double diagonal: a short near-dated strangle financing a long far-dated strangle. No single\n`expiry` field exists (see {@link CalendarInput}).","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  call call.longPremium call.longStrike call.shortPremium call.shortStrike farExpiry nearExpiry put put.longPremium put.longStrike put.shortPr"},{"title":"DoubleDiagonalSide","url":"/reference/totalfinance/strategy#DoubleDiagonalSide","description":"One diagonal side (call or put): short near strike + long far strike.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  longPremium longStrike shortPremium shortStrike"},{"title":"ExplainPositionOptions","url":"/reference/totalfinance/strategy#ExplainPositionOptions","description":"Options for {@link explainPosition}.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  market market.asOf market.dividendYield market.expiry market.legVolatilities market.riskFreeRate market.spot market.volatility market.volati"},{"title":"FromChainOptions","url":"/reference/totalfinance/strategy#FromChainOptions","description":"type from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type   @insiderfinance/totalfinance/strategy/from-chain"},{"title":"FromChainResult","url":"/reference/totalfinance/strategy#FromChainResult","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  assumptions assumptions.conventionsVersion assumptions.expiry assumptions.multiplier assumptions.priceSource assumptions.quantity fills legs @insiderfinance/totalfinance/strategy/from-chain"},{"title":"FromChainType","url":"/reference/totalfinance/strategy#FromChainType","description":"The v1 structures the bridge can build.","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type   @insiderfinance/totalfinance/strategy/from-chain"},{"title":"IronButterflyInput","url":"/reference/totalfinance/strategy#IronButterflyInput","description":"Iron butterfly: short ATM call + short ATM put + long OTM wings (a short straddle + long strangle).","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  body body.callPremium body.putPremium body.strike callWing callWing.premium callWing.strike expiry putWing putWing.premium putWing.strike qu"},{"title":"IronCondorInput","url":"/reference/totalfinance/strategy#IronCondorInput","description":"Four ascending roles: long put wing < short put < short call < long call wing.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  callLong callLong.premium callLong.strike callShort callShort.premium callShort.strike expiry putLong putLong.premium putLong.strike putShor"},{"title":"JadeLizardInput","url":"/reference/totalfinance/strategy#JadeLizardInput","description":"Jade lizard: short put + short call + long higher call (a short put with a short call spread).","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  expiry longCall longCall.premium longCall.strike put put.premium put.strike quantity shortCall shortCall.premium shortCall.strike"},{"title":"LadderInput","url":"/reference/totalfinance/strategy#LadderInput","description":"Three ascending same-type strikes: `lower < middle < upper`.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  expiry lower lower.premium lower.strike middle middle.premium middle.strike quantity upper upper.premium upper.strike"},{"title":"Leg","url":"/reference/totalfinance/strategy#Leg","description":"A single position leg: a stock row or an option row, discriminated by `kind`.","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  expiry impliedVolatility kind premium price quantity strike"},{"title":"LegInput","url":"/reference/totalfinance/strategy/page-2#LegInput","description":"A leg before entry-price resolution: an option's `premium` (or a stock's `price`) is optional\nand filled by the model — the Black–Scholes–Merton premium, the ma","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  "},{"title":"LegKind","url":"/reference/totalfinance/strategy/page-2#LegKind","description":"type from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  "},{"title":"LegValuation","url":"/reference/totalfinance/strategy/page-2#LegValuation","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  greeks greeks.charm greeks.color greeks.delta greeks.gamma greeks.lambda greeks.phi greeks.rho greeks.speed greeks.theta greeks.ultima greek"},{"title":"MarkToMarketInput","url":"/reference/totalfinance/strategy/page-2#MarkToMarketInput","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  asOf dividendYield expiry legVolatilities riskFreeRate spot volatility volatilityShock"},{"title":"MarkToMarketResult","url":"/reference/totalfinance/strategy/page-2#MarkToMarketResult","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear"},{"title":"MarketSource","url":"/reference/totalfinance/strategy/page-2#MarketSource","description":"Where the market fields a computation ran with came from (R5): entirely from the construction\nmarket (`'construction'`), entirely from the call site (`'call'`),","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  "},{"title":"MoveBias","url":"/reference/totalfinance/strategy/page-2#MoveBias","description":"type from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  "},{"title":"OptimalExitPoint","url":"/reference/totalfinance/strategy/page-2#OptimalExitPoint","description":"A point of the optimal-exit surface: per (spot, vol shock), the day that optimizes P&L.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  daysForward pnl underlyingPrice volatilityShock"},{"title":"OptimizeStrategyOptions","url":"/reference/totalfinance/strategy/page-2#OptimizeStrategyOptions","description":"Options for {@link optimizeStrategy}.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  asOf dividendYield expiries gridPoints maxRisk maxWidth minProbabilityOfProfit minThesisProbabilityOfProfit objective riskFreeRate sizing si"},{"title":"OptimizeStrategyResult","url":"/reference/totalfinance/strategy/page-2#OptimizeStrategyResult","description":"The optimizer read-out.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  assumptions assumptions.conventionsVersion assumptions.expiries assumptions.gridPoints assumptions.objective candidates diagnostics diagnost"},{"title":"OptimizedStrategy","url":"/reference/totalfinance/strategy/page-2#OptimizedStrategy","description":"A scanned candidate re-scored under the trader's thesis.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  bounded bounded.loss bounded.profit breakevens capital capital.assumptions capital.assumptions.conventionsVersion capital.diagnostics capita"},{"title":"OptimizedStrategyCapital","url":"/reference/totalfinance/strategy/page-2#OptimizedStrategyCapital","description":"The capital (buying-power) a candidate ties up, from Reg-T options margin — an economically honest\ndenominator that is DISTINCT from `|maxLoss|`: a naked short ","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  assumptions assumptions.conventionsVersion diagnostics diagnostics.warnings maxLoss method requirement"},{"title":"OptimizedStrategyKelly","url":"/reference/totalfinance/strategy/page-2#OptimizedStrategyKelly","description":"The Kelly verdict for a candidate (present only when `sizing` was requested): a full {@link KellySizing}\non dimensionless (P&L ÷ capital) returns, or a structur","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  reason sizing sizing.appliedFraction sizing.assumptions sizing.assumptions.conventionsVersion sizing.assumptions.drawdownModel sizing.assump"},{"title":"OptimizerExpiry","url":"/reference/totalfinance/strategy/page-2#OptimizerExpiry","description":"One expiry in the search space: its chain (+ optional pricing `volatility`/`smile`).","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  chain expiry smile smile(strike) volatility"},{"title":"OptimizerObjective","url":"/reference/totalfinance/strategy/page-2#OptimizerObjective","description":"Ranking objective: a thesis-based one, or the scanner's market-implied ones.","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  "},{"title":"OptimizerSizingOptions","url":"/reference/totalfinance/strategy/page-2#OptimizerSizingOptions","description":"Opt-in Kelly sizing for the optimizer: every {@link kellyBet} knob except `edge` (which the optimizer\nbuilds from each candidate's thesis outcomes), plus a requ","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  drawdownLimit drawdownLimit.maxProbability drawdownLimit.toFraction enabled fraction horizonPeriods maxFraction"},{"title":"OptimizerThesis","url":"/reference/totalfinance/strategy/page-2#OptimizerThesis","description":"The trader's view of the terminal price — a lognormal centered at a target (or drift).","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  drift pdf pdf(price) pdf(timeToExpiryYears) pdfRange pdfRange.from pdfRange.to targetPrice volatility"},{"title":"OptionLeg","url":"/reference/totalfinance/strategy/page-2#OptionLeg","description":"An option leg. `quantity` is signed contracts — positive = long, negative = short — scaled by the\nposition multiplier; `premium` is the entry premium per share.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  expiry impliedVolatility kind premium price quantity strike"},{"title":"OptionLegInput","url":"/reference/totalfinance/strategy/page-2#OptionLegInput","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  expiry impliedVolatility premium quantity strike"},{"title":"PayoffMetrics","url":"/reference/totalfinance/strategy/page-3#PayoffMetrics","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  bounded bounded.loss bounded.profit breakevens maxLoss maxProfit netCredit netDebit"},{"title":"PayoffResult","url":"/reference/totalfinance/strategy/page-3#PayoffResult","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  bounded bounded.loss bounded.profit breakevens maxLoss maxProfit netCredit netDebit points"},{"title":"PayoffSvgOptions","url":"/reference/totalfinance/strategy/page-3#PayoffSvgOptions","description":"Options for {@link payoffSvg}.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  height includeCurrentPnl market market.asOf market.dividendYield market.expiry market.legVolatilities market.riskFreeRate market.volatility "},{"title":"Position","url":"/reference/totalfinance/strategy/page-3#Position","description":"class from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"class","keywords":"@insiderfinance/totalfinance/strategy class  (config) (config).expiry (config).market (config).multiplier (config).premiums (legs) assumptions assumptions().return.constructedAs assumpt"},{"title":"PositionAssumptions","url":"/reference/totalfinance/strategy/page-3#PositionAssumptions","description":"Position-construction assumptions (design law #3): how entry premiums were sourced.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  constructedAs multiplier premiumSource premiumVolatilitySource"},{"title":"PositionConfig","url":"/reference/totalfinance/strategy/page-3#PositionConfig","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  expiry market market.asOf market.dividendYield market.expiry market.riskFreeRate market.spot market.volatility multiplier premiums"},{"title":"PositionExplanation","url":"/reference/totalfinance/strategy/page-3#PositionExplanation","description":"A structured, prose-ready explanation of a position.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  aliases assumptions assumptions.classifier assumptions.conventionsVersion assumptions.marketDependent definedRisk diagnostics diagnostics.wa"},{"title":"PremiumMarket","url":"/reference/totalfinance/strategy/page-3#PremiumMarket","description":"Market snapshot for MODEL-priced entry premiums (§3.4). Supplied via `PositionConfig.market` with\n`premiums: 'model'` so a builder given strikes but no fills (t","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  asOf dividendYield expiry riskFreeRate spot volatility"},{"title":"PremiumSource","url":"/reference/totalfinance/strategy/page-3#PremiumSource","description":"How a position's entry premiums were obtained.","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  "},{"title":"PremiumVolatilitySource","url":"/reference/totalfinance/strategy/page-3#PremiumVolatilitySource","description":"Which volatility priced a modeled entry premium (see `PositionAssumptions`).","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  "},{"title":"PriceRange","url":"/reference/totalfinance/strategy/page-3#PriceRange","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  from steps to"},{"title":"ProbabilityInput","url":"/reference/totalfinance/strategy/page-3#ProbabilityInput","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  asOf dividendYield expectedReturn expiry measure riskFreeRate spot volatility @insiderfinance/totalfinance/strategy/probability"},{"title":"ProbabilityMeasure","url":"/reference/totalfinance/strategy/page-3#ProbabilityMeasure","description":"type from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type   @insiderfinance/totalfinance/strategy/probability"},{"title":"ProbabilityMetrics","url":"/reference/totalfinance/strategy/page-3#ProbabilityMetrics","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/strategy/probability"},{"title":"ProbabilityModel","url":"/reference/totalfinance/strategy/page-3#ProbabilityModel","description":"The explicit probability model behind the metrics (echoed, per spec §12.6).","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  drift measure timeToExpiryYears volatility volatilityModel @insiderfinance/totalfinance/strategy/probability"},{"title":"ProbabilityMonteCarloInput","url":"/reference/totalfinance/strategy/page-3#ProbabilityMonteCarloInput","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  asOf dividendYield expectedReturn expiry localVolatility localVolatility(level) localVolatility(timeToExpiryYears) measure paths pnlQuantile @insiderfinance/totalfinance/strategy/probability"},{"title":"ProbabilityMonteCarloMetrics","url":"/reference/totalfinance/strategy/page-3#ProbabilityMonteCarloMetrics","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/strategy/probability"},{"title":"RatioInput","url":"/reference/totalfinance/strategy/page-3#RatioInput","description":"Long one option and short `ratio` of a further option (default 1×2).","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  expiry long long.premium long.strike quantity ratio short short.premium short.strike"},{"title":"ReverseJadeLizardInput","url":"/reference/totalfinance/strategy/page-3#ReverseJadeLizardInput","description":"Reverse jade lizard: short call + short put + long lower put (a short call with a short put spread).","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  call call.premium call.strike expiry longPut longPut.premium longPut.strike quantity shortPut shortPut.premium shortPut.strike"},{"title":"Role","url":"/reference/totalfinance/strategy/page-3#Role","description":"A distinct-strike builder slot (R3): a bare strike number, or `{ strike, premium? }`. A bare\nnumber means \"strike only\" — the premium is supplied later or model","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  premium strike"},{"title":"SCAN_OBJECTIVES","url":"/reference/totalfinance/strategy/page-4#SCAN_OBJECTIVES","description":"Every ranking objective a scan accepts, as DATA — the single source the type, the runtime guard and\nthe error message are all derived from.\n\nRV11 — these were t","category":"@insiderfinance/totalfinance/strategy","kind":"value","keywords":"@insiderfinance/totalfinance/strategy value   @insiderfinance/totalfinance/strategy/scanner"},{"title":"ScanCandidate","url":"/reference/totalfinance/strategy/page-4#ScanCandidate","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  bounded bounded.loss bounded.profit breakevens expectedValue expectedValuePerRisk legs liquidity maxLoss maxProfit netDebit probabilityOfPro @insiderfinance/totalfinance/strategy/scanner"},{"title":"ScanObjective","url":"/reference/totalfinance/strategy/page-4#ScanObjective","description":"Ranking objective; `expectedValuePerRisk` (expected value ÷ max loss) is the default.","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type   @insiderfinance/totalfinance/strategy/scanner"},{"title":"ScanOptions","url":"/reference/totalfinance/strategy/page-4#ScanOptions","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  asOf chain dividendYield expiry maxRisk maxWidth minProbabilityOfProfit rankBy riskFreeRate smile smile(strike) spot structures top volatili @insiderfinance/totalfinance/strategy/scanner"},{"title":"ScanQuoteRow","url":"/reference/totalfinance/strategy/page-4#ScanQuoteRow","description":"One strike's market data. `call`/`put` are mid premiums; bid/ask feed the liquidity score.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  call callAsk callBid put putAsk putBid strike @insiderfinance/totalfinance/strategy/scanner"},{"title":"ScanStructure","url":"/reference/totalfinance/strategy/page-4#ScanStructure","description":"The structures the scanner can enumerate (all single-expiry, defined-risk or long-premium).","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type   @insiderfinance/totalfinance/strategy/scanner"},{"title":"ScenarioRow","url":"/reference/totalfinance/strategy/page-4#ScenarioRow","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  daysForward delta gamma pnl theta underlyingPrice vega volatilityShock @insiderfinance/totalfinance/strategy/probability"},{"title":"ScenarioTableResult","url":"/reference/totalfinance/strategy/page-4#ScenarioTableResult","description":"Result of `scenarioTable()` — the R2 one-envelope form: `value` is the grid rows, `assumptions`\nechoes the conventions plus `marketSource` (construction/call/me","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/strategy/probability"},{"title":"ShortStraddleInput","url":"/reference/totalfinance/strategy/page-4#ShortStraddleInput","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  callPremium expiry putPremium quantity strike"},{"title":"ShortStrangleInput","url":"/reference/totalfinance/strategy/page-4#ShortStrangleInput","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  call call.premium call.strike expiry put put.premium put.strike quantity"},{"title":"SingleLegInput","url":"/reference/totalfinance/strategy/page-4#SingleLegInput","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  expiry premium quantity strike"},{"title":"StockLeg","url":"/reference/totalfinance/strategy/page-4#StockLeg","description":"A share position inside a strategy (B4: a stock leg is a stock). `quantity` is signed shares —\npositive = long, negative = short — never scaled by the option mu","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  expiry impliedVolatility kind premium price quantity strike"},{"title":"StockLegInput","url":"/reference/totalfinance/strategy/page-4#StockLegInput","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  price quantity"},{"title":"StockOptionInput","url":"/reference/totalfinance/strategy/page-4#StockOptionInput","description":"Shared: an underlying stock entry price plus a per-contract unit count (100 shares per contract).","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  expiry quantity stockPrice"},{"title":"StraddleInput","url":"/reference/totalfinance/strategy/page-4#StraddleInput","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  callPremium expiry putPremium quantity strike"},{"title":"StrangleInput","url":"/reference/totalfinance/strategy/page-4#StrangleInput","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  call call.premium call.strike expiry put put.premium put.strike quantity"},{"title":"StrategyDescriptor","url":"/reference/totalfinance/strategy/page-4#StrategyDescriptor","description":"A manifest entry, as served by {@link listStrategies}.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  description example multiExpiry name"},{"title":"StrategyMatch","url":"/reference/totalfinance/strategy/page-4#StrategyMatch","description":"One classification match. `exact` is always true today (a fuzzy tier can be added later).","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  exact name"},{"title":"StrikeLeg","url":"/reference/totalfinance/strategy/page-4#StrikeLeg","description":"A strike + optional entry premium for one option leg. Omit `premium` and build the position with\n`{ premiums: 'model', market }` to have it priced from the mark","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  premium strike"},{"title":"SyntheticInput","url":"/reference/totalfinance/strategy/page-4#SyntheticInput","description":"A single strike with a call and a put premium (synthetics / same-strike structures).","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  callPremium expiry putPremium quantity strike"},{"title":"SyntheticPutInput","url":"/reference/totalfinance/strategy/page-5#SyntheticPutInput","description":"Synthetic put (synthetic long put): short stock + long call.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  expiry premium quantity stockPrice strike"},{"title":"TimeBias","url":"/reference/totalfinance/strategy/page-5#TimeBias","description":"type from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  "},{"title":"TouchProbability","url":"/reference/totalfinance/strategy/page-5#TouchProbability","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  price probability @insiderfinance/totalfinance/strategy/probability"},{"title":"TwoStrikeInput","url":"/reference/totalfinance/strategy/page-5#TwoStrikeInput","description":"Two ascending strikes `lower < upper`.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  expiry lower lower.premium lower.strike quantity upper upper.premium upper.strike"},{"title":"UnitInput","url":"/reference/totalfinance/strategy/page-5#UnitInput","description":"Unit count + position-level expiry (R4) shared by every builder.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  expiry quantity"},{"title":"VerticalInput","url":"/reference/totalfinance/strategy/page-5#VerticalInput","description":"interface from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  expiry long long.premium long.strike quantity short short.premium short.strike"},{"title":"VolatilityBias","url":"/reference/totalfinance/strategy/page-5#VolatilityBias","description":"type from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  "},{"title":"VolatilitySource","url":"/reference/totalfinance/strategy/page-5#VolatilitySource","description":"Where a mark-to-market's volatility came from: all position-level, all per-leg, or a mix.","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  "},{"title":"WhatIfCell","url":"/reference/totalfinance/strategy/page-5#WhatIfCell","description":"One cell of a {@link WhatIfCubeValue}: a mark-to-market at a (spot, vol shock, days-forward) point.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  daysForward delta gamma pnl theta underlyingPrice vega volatilityShock"},{"title":"WhatIfCubeBreakEven","url":"/reference/totalfinance/strategy/page-5#WhatIfCubeBreakEven","description":"The what-if cube's break-even-time surface: the first non-negative-P&L day per (price, vol).","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  firstNonNegativeDayByPriceAndVolatility"},{"title":"WhatIfCubeOptions","url":"/reference/totalfinance/strategy/page-5#WhatIfCubeOptions","description":"Options for {@link Position.whatIfCube }.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  daysForward market market.asOf market.dividendYield market.expiry market.legVolatilities market.riskFreeRate market.volatility market.volati"},{"title":"WhatIfCubeProbability","url":"/reference/totalfinance/strategy/page-5#WhatIfCubeProbability","description":"The what-if cube's probability block — resolved spot mass per day, tails, and expected P&L.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  expectationMeaning expectedPnlByVolatilityAndDay gridPolicy modelAssumptions modelAssumptions.annualizedVolatility modelAssumptions.dividend"},{"title":"WhatIfCubeResult","url":"/reference/totalfinance/strategy/page-5#WhatIfCubeResult","description":"Result of {@link Position.whatIfCube } — the R2 one-envelope form.","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear"},{"title":"WhatIfCubeValue","url":"/reference/totalfinance/strategy/page-5#WhatIfCubeValue","description":"The cube value: the axes, the flat (row-major) cells, the optimal-exit surface, and the extremes.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  axes axes.daysForward axes.prices axes.volatilityShocks best best.daysForward best.delta best.gamma best.pnl best.theta best.underlyingPrice"},{"title":"WhatIfGbmProbabilityModel","url":"/reference/totalfinance/strategy/page-5#WhatIfGbmProbabilityModel","description":"The GBM terminal-price law for the what-if cube's spot distribution (Wave 6 §3). Drift follows the\nsame measure grammar as {@link Position.probability } — there","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  annualizedVolatility drift expectedReturn kind measure"},{"title":"WhatIfProbabilityModel","url":"/reference/totalfinance/strategy/page-5#WhatIfProbabilityModel","description":"The what-if cube's spot process: a GBM (by measure) or an explicit terminal density over a support.","category":"@insiderfinance/totalfinance/strategy","kind":"type","keywords":"@insiderfinance/totalfinance/strategy type  annualizedVolatility density density(price) density(yearsForward) drift expectedReturn kind measure support support.from support.to"},{"title":"WhatIfProbabilityOptions","url":"/reference/totalfinance/strategy/page-5#WhatIfProbabilityOptions","description":"Probability-mode options for {@link Position.whatIfCube }.","category":"@insiderfinance/totalfinance/strategy","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy interface  gridPolicy model model.annualizedVolatility model.density model.density(price) model.density(yearsForward) model.drift model.expectedReturn "},{"title":"bearCallLadder","url":"/reference/totalfinance/strategy/page-5#bearCallLadder","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).lower (input).middle (input).q"},{"title":"bearCallSpread","url":"/reference/totalfinance/strategy/page-5#bearCallSpread","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).long (input).quantity (input)."},{"title":"bearPutLadder","url":"/reference/totalfinance/strategy/page-5#bearPutLadder","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).lower (input).middle (input).q"},{"title":"bearPutSpread","url":"/reference/totalfinance/strategy/page-6#bearPutSpread","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).long (input).quantity (input)."},{"title":"buildStrategy","url":"/reference/totalfinance/strategy/page-6#buildStrategy","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (request) (request).config (request).input (request).name return.assumptions return.chartData return.constructedAs return.legs return.market"},{"title":"bullCallLadder","url":"/reference/totalfinance/strategy/page-6#bullCallLadder","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).lower (input).middle (input).q"},{"title":"bullCallSpread","url":"/reference/totalfinance/strategy/page-6#bullCallSpread","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).long (input).quantity (input)."},{"title":"bullPutLadder","url":"/reference/totalfinance/strategy/page-6#bullPutLadder","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).lower (input).middle (input).q"},{"title":"bullPutSpread","url":"/reference/totalfinance/strategy/page-6#bullPutSpread","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).long (input).quantity (input)."},{"title":"calendarCallSpread","url":"/reference/totalfinance/strategy/page-6#calendarCallSpread","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).farExpiry (input).longPremium (input).nearExp"},{"title":"calendarPutSpread","url":"/reference/totalfinance/strategy/page-6#calendarPutSpread","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).farExpiry (input).longPremium (input).nearExp"},{"title":"callBrokenWing","url":"/reference/totalfinance/strategy/page-6#callBrokenWing","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).lower (input).middle (input).q"},{"title":"callRatioBackspread","url":"/reference/totalfinance/strategy/page-6#callRatioBackspread","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).long (input).quantity (input)."},{"title":"callRatioSpread","url":"/reference/totalfinance/strategy/page-6#callRatioSpread","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).long (input).quantity (input)."},{"title":"cashSecuredPut","url":"/reference/totalfinance/strategy/page-6#cashSecuredPut","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).premium (input).quantity (inpu"},{"title":"classifyStrategy","url":"/reference/totalfinance/strategy/page-6#classifyStrategy","description":"Classify a leg list (or a Position) against the named-strategy catalog. `matches` carries every\nmatching name in manifest order — payoff-identical aliases all m","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (input) (input).assumptions (input).chartData (input).constructedAs (input).legs (input).market (input).market.asOf (input).market.dividendY"},{"title":"collar","url":"/reference/totalfinance/strategy/page-6#collar","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).call (input).expiry (input).put (input).quant"},{"title":"coveredCall","url":"/reference/totalfinance/strategy/page-6#coveredCall","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).premium (input).quantity (inpu"},{"title":"coveredShortStraddle","url":"/reference/totalfinance/strategy/page-6#coveredShortStraddle","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).callPremium (input).expiry (input).putPremium"},{"title":"coveredShortStrangle","url":"/reference/totalfinance/strategy/page-6#coveredShortStrangle","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).call (input).expiry (input).put (input).quant"},{"title":"diagonalCallSpread","url":"/reference/totalfinance/strategy/page-6#diagonalCallSpread","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).farExpiry (input).longPremium (input).longStr"},{"title":"diagonalPutSpread","url":"/reference/totalfinance/strategy/page-6#diagonalPutSpread","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).farExpiry (input).longPremium (input).longStr"},{"title":"doubleDiagonal","url":"/reference/totalfinance/strategy/page-6#doubleDiagonal","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).call (input).farExpiry (input).nearExpiry (in"},{"title":"explainPosition","url":"/reference/totalfinance/strategy/page-7#explainPosition","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (options) (options).market (options).market.asOf (options).market.dividendYield (options).market.expiry (options).market.legVolatilities (op"},{"title":"guts","url":"/reference/totalfinance/strategy/page-7#guts","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).lower (input).quantity (input)"},{"title":"inverseCallBrokenWing","url":"/reference/totalfinance/strategy/page-7#inverseCallBrokenWing","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).lower (input).middle (input).q"},{"title":"inverseIronButterfly","url":"/reference/totalfinance/strategy/page-7#inverseIronButterfly","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).body (input).body.callPremium (input).body.pu"},{"title":"inverseIronCondor","url":"/reference/totalfinance/strategy/page-7#inverseIronCondor","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).callLong (input).callShort (input).expiry (in"},{"title":"inversePutBrokenWing","url":"/reference/totalfinance/strategy/page-7#inversePutBrokenWing","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).lower (input).middle (input).q"},{"title":"ironButterfly","url":"/reference/totalfinance/strategy/page-7#ironButterfly","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).body (input).body.callPremium (input).body.pu"},{"title":"ironCondor","url":"/reference/totalfinance/strategy/page-7#ironCondor","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).callLong (input).callShort (input).expiry (in"},{"title":"jadeLizard","url":"/reference/totalfinance/strategy/page-7#jadeLizard","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).longCall (input).put (input).q"},{"title":"legs","url":"/reference/totalfinance/strategy/page-7#legs","description":"Plain leg records for custom strategies. No direction or size is inferred.","category":"@insiderfinance/totalfinance/strategy","kind":"value","keywords":"@insiderfinance/totalfinance/strategy value  call call().return.expiry call().return.impliedVolatility call().return.kind call().return.premium call().return.price call().return.quantit"},{"title":"listStrategies","url":"/reference/totalfinance/strategy/page-7#listStrategies","description":"Every named builder: name, description, multi-expiry flag, and a canonical example input.","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  "},{"title":"longCall","url":"/reference/totalfinance/strategy/page-7#longCall","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).premium (input).quantity (inpu"},{"title":"longCallButterfly","url":"/reference/totalfinance/strategy/page-7#longCallButterfly","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).lower (input).middle (input).q"},{"title":"longCallCondor","url":"/reference/totalfinance/strategy/page-7#longCallCondor","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).k1 (input).k2 (input).k3 (inpu"},{"title":"longCombo","url":"/reference/totalfinance/strategy/page-7#longCombo","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).lower (input).quantity (input)"},{"title":"longPut","url":"/reference/totalfinance/strategy/page-7#longPut","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).premium (input).quantity (inpu"},{"title":"longPutButterfly","url":"/reference/totalfinance/strategy/page-7#longPutButterfly","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).lower (input).middle (input).q"},{"title":"longPutCondor","url":"/reference/totalfinance/strategy/page-7#longPutCondor","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).k1 (input).k2 (input).k3 (inpu"},{"title":"longSyntheticFuture","url":"/reference/totalfinance/strategy/page-7#longSyntheticFuture","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).callPremium (input).expiry (input).putPremium"},{"title":"optimizeStrategy","url":"/reference/totalfinance/strategy/page-7#optimizeStrategy","description":"Search structures × strikes × expiries for the best trade under a thesis. Reuses `scanStrategies` per\nexpiry, re-scores each candidate under the thesis density,","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (options) (options).asOf (options).dividendYield (options).expiries (options).gridPoints (options).maxRisk (options).maxWidth (options).minP"},{"title":"payoffSvg","url":"/reference/totalfinance/strategy/page-8#payoffSvg","description":"Render a {@link Position}'s payoff diagram as a self-contained `<svg>` string. See the spec.","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (options) (options).height (options).includeCurrentPnl (options).market (options).market.asOf (options).market.dividendYield (options).marke"},{"title":"protectivePut","url":"/reference/totalfinance/strategy/page-8#protectivePut","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).premium (input).quantity (inpu"},{"title":"putBrokenWing","url":"/reference/totalfinance/strategy/page-8#putBrokenWing","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).lower (input).middle (input).q"},{"title":"putRatioBackspread","url":"/reference/totalfinance/strategy/page-8#putRatioBackspread","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).long (input).quantity (input)."},{"title":"putRatioSpread","url":"/reference/totalfinance/strategy/page-8#putRatioSpread","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).long (input).quantity (input)."},{"title":"reverseJadeLizard","url":"/reference/totalfinance/strategy/page-8#reverseJadeLizard","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).call (input).expiry (input).longPut (input).q"},{"title":"scanStrategies","url":"/reference/totalfinance/strategy/page-8#scanStrategies","description":"Enumerate, score, and rank option structures over a strike grid. `candidates` carries the top-N\nby the chosen objective, each with the full payoff/probability m","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (options) (options).asOf (options).chain (options).dividendYield (options).expiry (options).maxRisk (options).maxWidth (options).minProbabil @insiderfinance/totalfinance/strategy/scanner"},{"title":"shortCall","url":"/reference/totalfinance/strategy/page-8#shortCall","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).premium (input).quantity (inpu"},{"title":"shortCallButterfly","url":"/reference/totalfinance/strategy/page-8#shortCallButterfly","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).lower (input).middle (input).q"},{"title":"shortCallCondor","url":"/reference/totalfinance/strategy/page-8#shortCallCondor","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).k1 (input).k2 (input).k3 (inpu"},{"title":"shortCombo","url":"/reference/totalfinance/strategy/page-8#shortCombo","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).lower (input).quantity (input)"},{"title":"shortGuts","url":"/reference/totalfinance/strategy/page-8#shortGuts","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).lower (input).quantity (input)"},{"title":"shortPut","url":"/reference/totalfinance/strategy/page-8#shortPut","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).premium (input).quantity (inpu"},{"title":"shortPutButterfly","url":"/reference/totalfinance/strategy/page-8#shortPutButterfly","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).lower (input).middle (input).q"},{"title":"shortPutCondor","url":"/reference/totalfinance/strategy/page-8#shortPutCondor","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).k1 (input).k2 (input).k3 (inpu"},{"title":"shortStraddle","url":"/reference/totalfinance/strategy/page-8#shortStraddle","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).callPremium (input).expiry (input).putPremium"},{"title":"shortStrangle","url":"/reference/totalfinance/strategy/page-8#shortStrangle","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).call (input).expiry (input).put (input).quant"},{"title":"shortSyntheticFuture","url":"/reference/totalfinance/strategy/page-8#shortSyntheticFuture","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).callPremium (input).expiry (input).putPremium"},{"title":"straddle","url":"/reference/totalfinance/strategy/page-8#straddle","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).callPremium (input).expiry (input).putPremium"},{"title":"strangle","url":"/reference/totalfinance/strategy/page-8#strangle","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).call (input).expiry (input).put (input).quant"},{"title":"strap","url":"/reference/totalfinance/strategy/page-9#strap","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).callPremium (input).expiry (input).putPremium"},{"title":"strategy","url":"/reference/totalfinance/strategy/page-9#strategy","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (positionLegs) bearCallLadder bearCallLadder().return.assumpt"},{"title":"strategyFromChain","url":"/reference/totalfinance/strategy/page-9#strategyFromChain","description":"Build a {@link Position} from an option chain. Returns the position, its resolved legs (premiums and\nper-leg IVs attached), and the fills (contract / premium / ","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (options) (rows) return.assumptions return.assumptions.conventionsVersion return.assumptions.expiry return.assumptions.multiplier return.ass @insiderfinance/totalfinance/strategy/from-chain"},{"title":"strategyOf","url":"/reference/totalfinance/strategy/page-9#strategyOf","description":"Build a position from legs.","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (legs) return.assumptions return.chartData return.constructed"},{"title":"strategySignature","url":"/reference/totalfinance/strategy/page-9#strategySignature","description":"Normalize legs to a structural BASE signature string (order-, scale-, and spacing-independent).\nTwo leg lists share a base signature iff they have the same (kin","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (legs)"},{"title":"strip","url":"/reference/totalfinance/strategy/page-9#strip","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).callPremium (input).expiry (input).putPremium"},{"title":"syntheticPut","url":"/reference/totalfinance/strategy/page-9#syntheticPut","description":"function from @insiderfinance/totalfinance/strategy","category":"@insiderfinance/totalfinance/strategy","kind":"function","keywords":"@insiderfinance/totalfinance/strategy function  (config) (config).expiry (config).market (config).multiplier (config).premiums (input) (input).expiry (input).premium (input).quantity (inpu"},{"title":"ExpectedIntrinsicInput","url":"/reference/totalfinance/strategy/probability#ExpectedIntrinsicInput","description":"interface from @insiderfinance/totalfinance/strategy/probability","category":"@insiderfinance/totalfinance/strategy/probability","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy/probability interface  drift spot strike timeToExpiryYears type volatility"},{"title":"TerminalDistributionInput","url":"/reference/totalfinance/strategy/probability#TerminalDistributionInput","description":"interface from @insiderfinance/totalfinance/strategy/probability","category":"@insiderfinance/totalfinance/strategy/probability","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy/probability interface  drift spot strike timeToExpiryYears volatility"},{"title":"TouchProbabilityInput","url":"/reference/totalfinance/strategy/probability#TouchProbabilityInput","description":"interface from @insiderfinance/totalfinance/strategy/probability","category":"@insiderfinance/totalfinance/strategy/probability","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy/probability interface  barrier drift spot timeToExpiryYears volatility"},{"title":"expectedIntrinsic","url":"/reference/totalfinance/strategy/probability#expectedIntrinsic","description":"Undiscounted expected option intrinsic under the supplied terminal distribution.","category":"@insiderfinance/totalfinance/strategy/probability","kind":"function","keywords":"@insiderfinance/totalfinance/strategy/probability function  (input) (input).drift (input).spot (input).strike (input).timeToExpiryYears (input).type (input).volatility"},{"title":"terminalCdf","url":"/reference/totalfinance/strategy/probability#terminalCdf","description":"P(S_T ≤ strike) under a lognormal terminal distribution.","category":"@insiderfinance/totalfinance/strategy/probability","kind":"function","keywords":"@insiderfinance/totalfinance/strategy/probability function  (input) (input).drift (input).spot (input).strike (input).timeToExpiryYears (input).volatility"},{"title":"touchProbability","url":"/reference/totalfinance/strategy/probability#touchProbability","description":"GBM first-passage probability of touching `barrier` before expiry.","category":"@insiderfinance/totalfinance/strategy/probability","kind":"function","keywords":"@insiderfinance/totalfinance/strategy/probability function  (input) (input).barrier (input).drift (input).spot (input).timeToExpiryYears (input).volatility"},{"title":"ScanResult","url":"/reference/totalfinance/strategy/scanner#ScanResult","description":"The scan report (Law 2 report grammar): the ranked candidates plus the applied conventions\n(`assumptions`) and a warnings channel (`diagnostics`).","category":"@insiderfinance/totalfinance/strategy/scanner","kind":"interface","keywords":"@insiderfinance/totalfinance/strategy/scanner interface  assumptions assumptions.conventionsVersion assumptions.dayCount assumptions.rankBy assumptions.scoringVolatility assumptions.structures assu"},{"title":"AggressorSide","url":"/reference/totalfinance/structure#AggressorSide","description":"type from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type   @insiderfinance/totalfinance/structure/flow"},{"title":"AtSpotExposure","url":"/reference/totalfinance/structure#AtSpotExposure","description":"What `atSpot` re-evaluates for a profile: its selected `gex` and/or `dex`.","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type   @insiderfinance/totalfinance/structure/exposure"},{"title":"CallPutPremium","url":"/reference/totalfinance/structure#CallPutPremium","description":"Call-vs-put premium/volume summary with put/call ratios (spec §11.6).","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  callPremium callVolume netPremium putCallPremiumRatio putCallVolumeRatio putPremium putVolume @insiderfinance/totalfinance/structure/flow"},{"title":"ClassifiedTrade","url":"/reference/totalfinance/structure#ClassifiedTrade","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  classificationProvenance classificationProvenance.policy classificationProvenance.providedSide classificationProvenance.reason classificatio @insiderfinance/totalfinance/structure/flow"},{"title":"ContractExposure","url":"/reference/totalfinance/structure#ContractExposure","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  charm color delta dex expiry gamma gex impliedVolatility multiplier openInterest sign speed strike theta timeToExpiryYears type vanna vega v @insiderfinance/totalfinance/structure/exposure"},{"title":"ContractExposureRow","url":"/reference/totalfinance/structure#ContractExposureRow","description":"A per-contract row of a profile (see {@link ExposureAggregate}): the contract's identity and inputs,\nits computed metrics, the raw `gamma` only when `gex` was c","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  expiry impliedVolatility multiplier openInterest sign strike timeToExpiryYears type @insiderfinance/totalfinance/structure/exposure"},{"title":"DefaultScenarioMetric","url":"/reference/totalfinance/structure#DefaultScenarioMetric","description":"The metrics a `scenarioMap` computes when none are requested.","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type   @insiderfinance/totalfinance/structure/exposure"},{"title":"DeltaAdjustedPremium","url":"/reference/totalfinance/structure#DeltaAdjustedPremium","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  bearishPremium bullishPremium netDirectional totalDeltaAdjusted @insiderfinance/totalfinance/structure/flow"},{"title":"DirectionalFlowTrade","url":"/reference/totalfinance/structure#DirectionalFlowTrade","description":"One directional flow print. `delta` is the option's signed delta at the print — caller-supplied\nfrom their own greeks (this package never fabricates greeks), ke","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  delta premium side type @insiderfinance/totalfinance/structure/flow"},{"title":"ExpiryRow","url":"/reference/totalfinance/structure#ExpiryRow","description":"A by-expiry row narrowed to the requested metrics (see {@link StrikeRow}).","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  expiry @insiderfinance/totalfinance/structure/exposure"},{"title":"ExposureAggregate","url":"/reference/totalfinance/structure#ExposureAggregate","description":"The totals of a profile that computed the guaranteed metrics `G` and possibly `P`: guaranteed\nmetrics are required, possible ones optional, everything else abse","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type   @insiderfinance/totalfinance/structure/exposure"},{"title":"ExposureConfig","url":"/reference/totalfinance/structure#ExposureConfig","description":"Non-market exposure configuration: the sign convention and computation knobs (WS3.2).","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  convention convention.calls convention.puts defaultMultiplier gammaUnit minTimeToExpiry priceSource @insiderfinance/totalfinance/structure/exposure"},{"title":"ExposureConvention","url":"/reference/totalfinance/structure#ExposureConvention","description":"type from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  calls puts @insiderfinance/totalfinance/structure/exposure"},{"title":"ExposureMarket","url":"/reference/totalfinance/structure#ExposureMarket","description":"Market snapshot for `exposure()` — the workspace-canonical {@link MarketInputs}, except `spot` is\noptional here because it falls back to each quote's `underlyin","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  asOf dividendYield riskFreeRate spot @insiderfinance/totalfinance/structure/exposure"},{"title":"ExposureMetric","url":"/reference/totalfinance/structure#ExposureMetric","description":"type from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type   @insiderfinance/totalfinance/structure/exposure"},{"title":"ExposureProfile","url":"/reference/totalfinance/structure#ExposureProfile","description":"A computed exposure profile with levels, by-strike/by-expiry views, and scenario maps. R2\nenvelope: the sign convention and every resolved knob live in `assumpt","category":"@insiderfinance/totalfinance/structure","kind":"class","keywords":"@insiderfinance/totalfinance/structure class  (request) (request).config (request).market (request).metrics (request).quotes aggregate assumptions assumptions.asOf assumptions.calendar a @insiderfinance/totalfinance/structure/exposure"},{"title":"ExposureShortcutInput","url":"/reference/totalfinance/structure#ExposureShortcutInput","description":"The chain, market and sign convention every exposure takes — the input of the single-metric shortcuts.","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  config config.convention config.convention.calls config.convention.puts config.defaultMultiplier config.gammaUnit config.minTimeToExpiry con @insiderfinance/totalfinance/structure/exposure"},{"title":"ExposureTotals","url":"/reference/totalfinance/structure#ExposureTotals","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  charm color dex gex speed theta vanna vega vomma @insiderfinance/totalfinance/structure/exposure"},{"title":"FlowAnalysis","url":"/reference/totalfinance/structure#FlowAnalysis","description":"Result of analyzing a stream of option trades. R2 envelope: the rules/windows ride `assumptions`\nand the heuristic caveats ride `diagnostics.warnings` as `model","category":"@insiderfinance/totalfinance/structure","kind":"class","keywords":"@insiderfinance/totalfinance/structure class  (options) (options).blockMinPremium (options).blockMinSize (options).classificationSource (options).multiplier (options).spreadWindowMs (opt @insiderfinance/totalfinance/structure/flow"},{"title":"FlowClassificationProvenance","url":"/reference/totalfinance/structure/page-2#FlowClassificationProvenance","description":"Lineage of the classification, not a claim that a provider label is exchange-confirmed.","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  policy providedSide reason source @insiderfinance/totalfinance/structure/flow"},{"title":"FlowClassificationSource","url":"/reference/totalfinance/structure/page-2#FlowClassificationSource","description":"`provided-or-quotes` is the backwards-compatible rule: supplied buy/sell wins, but unknown or\nabsent classification falls through to quotes. `provided-first` pr","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type   @insiderfinance/totalfinance/structure/flow"},{"title":"FlowGroup","url":"/reference/totalfinance/structure/page-2#FlowGroup","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  buyPremium expiry netPremium premium sellPremium size strike trades type underlying volumeOpenInterestRatio @insiderfinance/totalfinance/structure/flow"},{"title":"FlowGroupKey","url":"/reference/totalfinance/structure/page-2#FlowGroupKey","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  expiry strike type underlying @insiderfinance/totalfinance/structure/flow"},{"title":"FlowOptions","url":"/reference/totalfinance/structure/page-2#FlowOptions","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  blockMinPremium blockMinSize classificationSource multiplier spreadWindowMs sweepMinPrints sweepWindowMs @insiderfinance/totalfinance/structure/flow"},{"title":"GammaUnit","url":"/reference/totalfinance/structure/page-2#GammaUnit","description":"type from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type   @insiderfinance/totalfinance/structure/exposure"},{"title":"GexSplit","url":"/reference/totalfinance/structure/page-2#GexSplit","description":"The call/put GEX + OI split attached to a by-strike row WHEN `'gex'` is requested (WS4.5): the\ncanonical dashboard chart draws `callGex` bars up and `putGex` ba","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  callGex callOpenInterest putGex putOpenInterest @insiderfinance/totalfinance/structure/exposure"},{"title":"GuaranteedExposureMetrics","url":"/reference/totalfinance/structure/page-2#GuaranteedExposureMetrics","description":"The metrics an `exposure()` call is GUARANTEED to have computed: every metric when `metrics` is\nomitted, otherwise the names the selection is certain to contain","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type   @insiderfinance/totalfinance/structure/exposure"},{"title":"GuaranteedSuppliedExposureMetrics","url":"/reference/totalfinance/structure/page-2#GuaranteedSuppliedExposureMetrics","description":"The metrics a selection guarantees: both when omitted, otherwise the names the selection is certain\nto contain ({@link GuaranteedSelection}) — none for a dynami","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  "},{"title":"Levels","url":"/reference/totalfinance/structure/page-2#Levels","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  callWall charmWall gammaFlips gammaRegime largestCallOpenInterest largestPutOpenInterest maxGammaStrike maxPain minGammaStrike monthlyOpexWa @insiderfinance/totalfinance/structure/exposure"},{"title":"NetDrift","url":"/reference/totalfinance/structure/page-2#NetDrift","description":"Net dealer-hedging drift estimate (spec §11.5).","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  bias charmFlowPerDay distanceToZeroGamma gammaRegime vannaFlowPerVolatilityPoint zeroGamma @insiderfinance/totalfinance/structure/exposure"},{"title":"OpenCloseEstimate","url":"/reference/totalfinance/structure/page-2#OpenCloseEstimate","description":"Opening-vs-closing estimate; only a definite `open` (size exceeds prior OI) is inferred.","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type   @insiderfinance/totalfinance/structure/flow"},{"title":"OptionFlowDriftAssumptions","url":"/reference/totalfinance/structure/page-2#OptionFlowDriftAssumptions","description":"type from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  bucketMinutes classificationSource coverageMeaning duplicatePolicy heuristicRule interval minimumClassificationCoverage multiplier orderPoli"},{"title":"OptionFlowDriftBucket","url":"/reference/totalfinance/structure/page-2#OptionFlowDriftBucket","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  change change.bearishPremium change.bearishVolume change.bullishPremium change.bullishVolume change.callBounds change.callBuyPremium change."},{"title":"OptionFlowDriftConfig","url":"/reference/totalfinance/structure/page-2#OptionFlowDriftConfig","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  asOf bucketMinutes classificationSource minimumClassificationCoverage multiplier priceOverlay priceOverlay.quotes priceOverlay.symbol priceO"},{"title":"OptionFlowDriftHeuristic","url":"/reference/totalfinance/structure/page-2#OptionFlowDriftHeuristic","description":"type from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  "},{"title":"OptionFlowDriftInput","url":"/reference/totalfinance/structure/page-2#OptionFlowDriftInput","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  config config.asOf config.bucketMinutes config.classificationSource config.minimumClassificationCoverage config.multiplier config.priceOverl"},{"title":"OptionFlowDriftPrice","url":"/reference/totalfinance/structure/page-2#OptionFlowDriftPrice","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  price source symbol timestampMs"},{"title":"OptionFlowDriftPrint","url":"/reference/totalfinance/structure/page-2#OptionFlowDriftPrint","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  classificationProvenance classificationProvenance.policy classificationProvenance.providedSide classificationProvenance.reason classificatio"},{"title":"OptionFlowDriftResult","url":"/reference/totalfinance/structure/page-2#OptionFlowDriftResult","description":"type from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  assumptions assumptions.asOf assumptions.bucketMinutes assumptions.calendar assumptions.calendarVersion assumptions.classificationSource ass"},{"title":"OptionFlowDriftSession","url":"/reference/totalfinance/structure/page-3#OptionFlowDriftSession","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  calendar calendar.addBusinessDays calendar.addBusinessDays(date) calendar.addBusinessDays(days) calendar.businessDaysBetween calendar.busine"},{"title":"OptionFlowDriftTotals","url":"/reference/totalfinance/structure/page-3#OptionFlowDriftTotals","description":"All premiums are raw currency amounts; all volumes are contract counts (not shares).","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  bearishPremium bearishVolume bullishPremium bullishVolume callBounds callBuyPremium callDrift callPremium callSellPremium callUnknownPremium"},{"title":"OptionFlowDriftTrade","url":"/reference/totalfinance/structure/page-3#OptionFlowDriftTrade","description":"Canonical epoch-ms print, optionally carrying a caller-normalized, tape-wide unique ID.","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  aggressorSide ask askSize bid bidSize conditions contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash"},{"title":"OptionFlowDriftValue","url":"/reference/totalfinance/structure/page-3#OptionFlowDriftValue","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  buckets minutes session session.closeTimestampMs session.date session.endTimestampMs session.isBusinessDay session.isHalfDay session.openTim"},{"title":"OptionFlowPriceOverlay","url":"/reference/totalfinance/structure/page-3#OptionFlowPriceOverlay","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  quotes symbol trades"},{"title":"OptionFlowVolumeConfirmation","url":"/reference/totalfinance/structure/page-3#OptionFlowVolumeConfirmation","description":"Descriptive sign agreement, NOT evidence of predictive power.","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  "},{"title":"PossibleExposureMetrics","url":"/reference/totalfinance/structure/page-3#PossibleExposureMetrics","description":"The metrics an `exposure()` call MAY have computed: every metric unless a selection narrows them.","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type   @insiderfinance/totalfinance/structure/exposure"},{"title":"PossibleSuppliedExposureMetrics","url":"/reference/totalfinance/structure/page-3#PossibleSuppliedExposureMetrics","description":"The metrics a selection may have computed.","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  "},{"title":"RankByKey","url":"/reference/totalfinance/structure/page-3#RankByKey","description":"type from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type   @insiderfinance/totalfinance/structure/flow"},{"title":"RankOptions","url":"/reference/totalfinance/structure/page-3#RankOptions","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  by limit minPremium minVolumeOpenInterestRatio @insiderfinance/totalfinance/structure/flow"},{"title":"ScenarioCell","url":"/reference/totalfinance/structure/page-3#ScenarioCell","description":"A scenario-grid cell carrying ONLY the requested metrics (WS2.4), plus its grid coordinates.","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  spot timeAdvance volatilityShock @insiderfinance/totalfinance/structure/exposure"},{"title":"ScenarioMap","url":"/reference/totalfinance/structure/page-3#ScenarioMap","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  cells evaluations metrics @insiderfinance/totalfinance/structure/exposure"},{"title":"ScenarioMapOptions","url":"/reference/totalfinance/structure/page-3#ScenarioMapOptions","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  metrics spot spot.from spot.steps spot.to timeAdvance volatilityShock @insiderfinance/totalfinance/structure/exposure"},{"title":"Spread","url":"/reference/totalfinance/structure/page-3#Spread","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  contracts directionKnown id legs netPremium timestampMs underlying @insiderfinance/totalfinance/structure/flow"},{"title":"StrikeRow","url":"/reference/totalfinance/structure/page-3#StrikeRow","description":"A by-strike row narrowed to the requested metrics: only the selected `M` keys are present (WS2.4),\nnever a zero-filled full set. `StrikeRow` with no type argume","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  strike @insiderfinance/totalfinance/structure/exposure"},{"title":"SuppliedExposureAssumptions","url":"/reference/totalfinance/structure/page-3#SuppliedExposureAssumptions","description":"type from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  aggregationPolicy asOf calendar calendarVersion compounding compounding.periodsPerYear compounding.type conventionsVersion currencyPolicy da"},{"title":"SuppliedExposureAssumptionsFor","url":"/reference/totalfinance/structure/page-3#SuppliedExposureAssumptionsFor","description":"Assumptions of a report that computed `G` (and possibly `P`): the GEX unit and convention echoes\nonly with `gex`, the DEX ones only with `dex`, plus `metrics` w","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  aggregationPolicy asOf breakdowns calendar calendarVersion compounding compounding.periodsPerYear compounding.type conventionsVersion curren"},{"title":"SuppliedExposureBreakdownsFor","url":"/reference/totalfinance/structure/page-3#SuppliedExposureBreakdownsFor","description":"The `byStrike` and `byExpiry` breakdowns of a report, by the request's `breakdowns` flag: present\nwhen it is omitted or `true` (the released report), absent for","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  "},{"title":"SuppliedExposureConfig","url":"/reference/totalfinance/structure/page-3#SuppliedExposureConfig","description":"Closed controls. No rate, dividend, pricing-model, or scenario knobs are accepted.","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  defaultMultiplier dexConvention dexConvention.calls dexConvention.puts gammaUnit gexConvention gexConvention.calls gexConvention.puts maximu"},{"title":"SuppliedExposureContribution","url":"/reference/totalfinance/structure/page-3#SuppliedExposureContribution","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash contract.deliverable.notes contract.deliverable."},{"title":"SuppliedExposureContributionFor","url":"/reference/totalfinance/structure/page-4#SuppliedExposureContributionFor","description":"A contribution row of a report that computed `G` (and possibly `P`): the GEX sign and value only\nwith `gex`, the DEX sign and value only with `dex`, and only th","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash contract.deliverable.notes contract.deliverable."},{"title":"SuppliedExposureExclusion","url":"/reference/totalfinance/structure/page-4#SuppliedExposureExclusion","description":"type from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  "},{"title":"SuppliedExposureGreeks","url":"/reference/totalfinance/structure/page-4#SuppliedExposureGreeks","description":"Open observation: the core chain row's Greeks (`OptionQuote.greeks`) with `gamma` and the\nprovenance REQUIRED. Delta and gamma are NOT multiplied by open intere","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  delta gamma provenance provenance.model provenance.source provenance.timestampMs rho theta vega"},{"title":"SuppliedExposureInput","url":"/reference/totalfinance/structure/page-4#SuppliedExposureInput","description":"The input of today's (both-metric) report, as released.","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  config config.defaultMultiplier config.dexConvention config.dexConvention.calls config.dexConvention.puts config.gammaUnit config.gexConvent"},{"title":"SuppliedExposureMarket","url":"/reference/totalfinance/structure/page-4#SuppliedExposureMarket","description":"Open spot observation plus an explicit report cutoff; all quotes must name this underlying.","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  asOf source spot timestampMs underlying"},{"title":"SuppliedExposureMetric","url":"/reference/totalfinance/structure/page-4#SuppliedExposureMetric","description":"The supplied-Greek exposures {@link exposureFromGreeks} can select.","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  "},{"title":"SuppliedExposurePositionConvention","url":"/reference/totalfinance/structure/page-4#SuppliedExposurePositionConvention","description":"Explicit OI-position signs, applied ONCE to the supplied signed Greek, independently per metric.","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  calls puts"},{"title":"SuppliedExposureQuote","url":"/reference/totalfinance/structure/page-4#SuppliedExposureQuote","description":"Canonical OptionQuote with independently sourced Greeks; harmless decoration is accepted.","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  ask askSize bid bidSize conditions contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash contract.deli"},{"title":"SuppliedExposureReport","url":"/reference/totalfinance/structure/page-4#SuppliedExposureReport","description":"Plain JSON-safe analysis report, directly compatible with saved-analysis report grammar.\n\n`G`/`P` follow the `metrics` selection (guaranteed/possible metrics); ","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  aggregate aggregate.callOpenInterest aggregate.includedQuotes aggregate.openInterest aggregate.putOpenInterest assumptions assumptions.aggre"},{"title":"SuppliedExposureRequest","url":"/reference/totalfinance/structure/page-4#SuppliedExposureRequest","description":"What `exposureFromGreeks` accepts: {@link SuppliedExposureInput} (which it always accepts) widened\nso a GEX-only or DEX-only selection can omit the other metric","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  breakdowns config config.defaultMultiplier config.dexConvention config.dexConvention.calls config.dexConvention.puts config.gammaUnit config"},{"title":"SuppliedExposureRequestConfig","url":"/reference/totalfinance/structure/page-4#SuppliedExposureRequestConfig","description":"The configuration `exposureFromGreeks` accepts. A selected metric's controls are required (checked\nat run time): `gexConvention` and `gammaUnit` for GEX, `dexCo","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  defaultMultiplier dexConvention dexConvention.calls dexConvention.puts gammaUnit gexConvention gexConvention.calls gexConvention.puts maximu"},{"title":"SuppliedExposureRequestGreeks","url":"/reference/totalfinance/structure/page-4#SuppliedExposureRequestGreeks","description":"The supplied Greeks `exposureFromGreeks` accepts on a quote. Which ones are required depends on\n`metrics`: both without a selection (exactly {@link SuppliedExpo","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  delta gamma provenance provenance.model provenance.source provenance.timestampMs rho theta vega"},{"title":"SuppliedExposureRequestQuote","url":"/reference/totalfinance/structure/page-4#SuppliedExposureRequestQuote","description":"A quote as `exposureFromGreeks` accepts it: {@link SuppliedExposureQuote} with selectable Greeks.","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  ask askSize bid bidSize conditions contract contract.adjusted contract.currency contract.deliverable contract.deliverable.cash contract.deli"},{"title":"SuppliedExposureTotals","url":"/reference/totalfinance/structure/page-4#SuppliedExposureTotals","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  callDex callGex callOpenInterest dex gex grossDex grossGex includedQuotes openInterest putDex putGex putOpenInterest"},{"title":"SuppliedExposureTotalsFor","url":"/reference/totalfinance/structure/page-4#SuppliedExposureTotalsFor","description":"Totals of a report that computed `G` (and possibly `P`); with the defaults, {@link SuppliedExposureTotals}.","category":"@insiderfinance/totalfinance/structure","kind":"type","keywords":"@insiderfinance/totalfinance/structure type  callOpenInterest includedQuotes openInterest putOpenInterest"},{"title":"Sweep","url":"/reference/totalfinance/structure/page-4#Sweep","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  endTimestampMs expiry id premium prints side size startTimestampMs strike type underlying venueVerified @insiderfinance/totalfinance/structure/flow"},{"title":"Unusualness","url":"/reference/totalfinance/structure/page-4#Unusualness","description":"interface from @insiderfinance/totalfinance/structure","category":"@insiderfinance/totalfinance/structure","kind":"interface","keywords":"@insiderfinance/totalfinance/structure interface  assumptions assumptions.baselineLength assumptions.conventionsVersion diagnostics diagnostics.warnings mean percentile stdev zScore @insiderfinance/totalfinance/structure/flow"},{"title":"charmExposure","url":"/reference/totalfinance/structure/page-4#charmExposure","description":"Charm exposure alone — the signed dollar-delta change as ONE calendar day elapses (`−∂DEX/∂T` per\nday). A higher-order exposure. Equivalent to `exposure({ ...in","category":"@insiderfinance/totalfinance/structure","kind":"function","keywords":"@insiderfinance/totalfinance/structure function  (input) (input).config (input).market (input).quotes return.aggregate return.assumptions return.atSpot return.byExpiry return.byStrike retur @insiderfinance/totalfinance/structure/exposure"},{"title":"colorExposure","url":"/reference/totalfinance/structure/page-4#colorExposure","description":"Color exposure alone — the signed change in GEX as ONE calendar day elapses (`−∂GEX/∂T` per day),\nin the profile's `gammaUnit`. A higher-order exposure. Equival","category":"@insiderfinance/totalfinance/structure","kind":"function","keywords":"@insiderfinance/totalfinance/structure function  (input) (input).config (input).market (input).quotes return.aggregate return.assumptions return.atSpot return.byExpiry return.byStrike retur @insiderfinance/totalfinance/structure/exposure"},{"title":"deltaAdjustedPremium","url":"/reference/totalfinance/structure/page-4#deltaAdjustedPremium","description":"Delta-adjusted (delta-weighted) premium of a set of directional flow prints (spec §11.6, product\nreview §4). Weighting premium by |delta| turns raw premium into","category":"@insiderfinance/totalfinance/structure","kind":"function","keywords":"@insiderfinance/totalfinance/structure function  (trades) return.bearishPremium return.bullishPremium return.netDirectional return.totalDeltaAdjusted @insiderfinance/totalfinance/structure/flow"},{"title":"deltaExposure","url":"/reference/totalfinance/structure/page-5#deltaExposure","description":"Delta exposure (DEX) alone — dollar delta (`Δ·OI·multiplier·spot`), signed by the convention.\nComputes delta only. Equivalent to `exposure({ ...input, metrics: ","category":"@insiderfinance/totalfinance/structure","kind":"function","keywords":"@insiderfinance/totalfinance/structure function  (input) (input).config (input).market (input).quotes return.aggregate return.assumptions return.atSpot return.byExpiry return.byStrike retur @insiderfinance/totalfinance/structure/exposure"},{"title":"exposure","url":"/reference/totalfinance/structure/page-5#exposure","description":"Compute an exposure profile from an option chain.\n\nOmit `metrics` for the full profile. Pass `metrics` to compute only some exposures — a literal\nselection type","category":"@insiderfinance/totalfinance/structure","kind":"function","keywords":"@insiderfinance/totalfinance/structure function const profile = exposure({ quotes, market, config: { convention: 'dealerShortGamma' }, metrics: ['ge (input) (input).config (input).market (input).metrics (input).quotes return.aggregate return.assumptions return.atSpot return.byExpiry retur @insiderfinance/totalfinance/structure/exposure"},{"title":"exposureFromGreeks","url":"/reference/totalfinance/structure/page-5#exposureFromGreeks","description":"Account for caller-supplied signed Greeks at one spot snapshot. GEX is\n`gamma * openInterest * multiplier * gexSign * spot * (spot * 0.01)` for\n`per1PercentMove","category":"@insiderfinance/totalfinance/structure","kind":"function","keywords":"@insiderfinance/totalfinance/structure function ```ts\nimport { resolvedExpiry } from '@insiderfinance/totalfinance/core';\nimport { exposureFromGreek (request) (request).breakdowns (request).config (request).market (request).metrics (request).quotes return.aggregate return.assumptions retu"},{"title":"flow","url":"/reference/totalfinance/structure/page-5#flow","description":"Analyze a stream of option trades for aggressor, sweeps, blocks, and spreads.","category":"@insiderfinance/totalfinance/structure","kind":"function","keywords":"@insiderfinance/totalfinance/structure function  (options) (options).blockMinPremium (options).blockMinSize (options).classificationSource (options).multiplier (options).spreadWindowMs (opt @insiderfinance/totalfinance/structure/flow"},{"title":"gammaExposure","url":"/reference/totalfinance/structure/page-5#gammaExposure","description":"Gamma exposure (GEX) alone — the dollar change in dealer delta for a 1% spot move\n(`Γ·OI·multiplier·spot²·0.01`, or per point with `gammaUnit: 'perPoint'`), sig","category":"@insiderfinance/totalfinance/structure","kind":"function","keywords":"@insiderfinance/totalfinance/structure function const gex = gammaExposure({ quotes, market: { spot: 6500, riskFreeRate: 0.043, asOf }, config: { con (input) (input).config (input).market (input).quotes return.aggregate return.assumptions return.atSpot return.byExpiry return.byStrike retur @insiderfinance/totalfinance/structure/exposure"},{"title":"optionFlowDrift","url":"/reference/totalfinance/structure/page-5#optionFlowDrift","description":"Aggregate observed raw option trading premium for one explicit session. Example:\n`optionFlowDrift({ trades, session: { date: '2026-06-04' }, config: { symbol: '","category":"@insiderfinance/totalfinance/structure","kind":"function","keywords":"@insiderfinance/totalfinance/structure function  (input) (input).config (input).session (input).trades return.assumptions return.diagnostics return.provenance return.value"},{"title":"speedExposure","url":"/reference/totalfinance/structure/page-5#speedExposure","description":"Speed exposure alone — the change in GEX for a +1% spot move, in the GEX unit (computes speed and\ngamma). A higher-order exposure. Equivalent to `exposure({ ...","category":"@insiderfinance/totalfinance/structure","kind":"function","keywords":"@insiderfinance/totalfinance/structure function  (input) (input).config (input).market (input).quotes return.aggregate return.assumptions return.atSpot return.byExpiry return.byStrike retur @insiderfinance/totalfinance/structure/exposure"},{"title":"thetaExposure","url":"/reference/totalfinance/structure/page-5#thetaExposure","description":"Theta exposure alone — dollar option-value decay per calendar day (`θ/day·OI·multiplier`).\nEquivalent to `exposure({ ...input, metrics: ['theta'] })`.","category":"@insiderfinance/totalfinance/structure","kind":"function","keywords":"@insiderfinance/totalfinance/structure function  (input) (input).config (input).market (input).quotes return.aggregate return.assumptions return.atSpot return.byExpiry return.byStrike retur @insiderfinance/totalfinance/structure/exposure"},{"title":"unusualness","url":"/reference/totalfinance/structure/page-5#unusualness","description":"Unusualness of a reading versus a caller-supplied baseline history (spec §11.6, product review §4):\nthe z-score and percentile of `value` against `baseline` (e.","category":"@insiderfinance/totalfinance/structure","kind":"function","keywords":"@insiderfinance/totalfinance/structure function  (baseline) (value) return.assumptions return.assumptions.baselineLength return.assumptions.conventionsVersion return.diagnostics return.diag @insiderfinance/totalfinance/structure/flow"},{"title":"vannaExposure","url":"/reference/totalfinance/structure/page-5#vannaExposure","description":"Vanna exposure alone — the dollar-delta change per +1% volatility (`vanna·OI·multiplier·spot·0.01`).\nA higher-order exposure. Equivalent to `exposure({ ...input","category":"@insiderfinance/totalfinance/structure","kind":"function","keywords":"@insiderfinance/totalfinance/structure function  (input) (input).config (input).market (input).quotes return.aggregate return.assumptions return.atSpot return.byExpiry return.byStrike retur @insiderfinance/totalfinance/structure/exposure"},{"title":"vegaExposure","url":"/reference/totalfinance/structure/page-5#vegaExposure","description":"Vega exposure alone — the dollar change in option value per 1% (0.01) volatility move\n(`vega%·OI·multiplier`). Equivalent to `exposure({ ...input, metrics: ['ve","category":"@insiderfinance/totalfinance/structure","kind":"function","keywords":"@insiderfinance/totalfinance/structure function  (input) (input).config (input).market (input).quotes return.aggregate return.assumptions return.atSpot return.byExpiry return.byStrike retur @insiderfinance/totalfinance/structure/exposure"},{"title":"vommaExposure","url":"/reference/totalfinance/structure/page-5#vommaExposure","description":"Vomma (volga) exposure alone — the change in vega exposure per +1% volatility. A higher-order\nexposure. Equivalent to `exposure({ ...input, metrics: ['vomma'] }","category":"@insiderfinance/totalfinance/structure","kind":"function","keywords":"@insiderfinance/totalfinance/structure function  (input) (input).config (input).market (input).quotes return.aggregate return.assumptions return.atSpot return.byExpiry return.byStrike retur @insiderfinance/totalfinance/structure/exposure"},{"title":"ALIAS_TABLE","url":"/reference/totalfinance/technical-analysis#ALIAS_TABLE","description":"Curated TotalFinance ↔ TA-Lib ↔ pandas-ta ↔ TradingView name map. Grouped by family for readability;\nthe order is informational only (resolution and the matrix ","category":"@insiderfinance/totalfinance/technical-analysis","kind":"value","keywords":"@insiderfinance/totalfinance/technical-analysis value   @insiderfinance/totalfinance/technical-analysis/aliases"},{"title":"AberrationParameters","url":"/reference/totalfinance/technical-analysis#AberrationParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  atrPeriod period @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"AberrationPoint","url":"/reference/totalfinance/technical-analysis#AberrationPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  atr lowerBand upperBand zeroLine @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"AccelerationBandsParameters","url":"/reference/totalfinance/technical-analysis#AccelerationBandsParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  multiplier period @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"AdxPoint","url":"/reference/totalfinance/technical-analysis#AdxPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  adx minusDI plusDI @insiderfinance/totalfinance/technical-analysis/bars"},{"title":"AggregateStream","url":"/reference/totalfinance/technical-analysis#AggregateStream","description":"A streaming aggregator: each input bar yields zero or more completed output units.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  next next(bar) next(bar).close next(bar).high next(bar).low next(bar).open next(bar).volume toJSON toJSON().return.kind toJSON().return.sche @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"AggressorMethod","url":"/reference/totalfinance/technical-analysis#AggressorMethod","description":"type from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"AlignOptions","url":"/reference/totalfinance/technical-analysis#AlignOptions","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  intervalMs @insiderfinance/totalfinance/technical-analysis/resample"},{"title":"AlmaParameters","url":"/reference/totalfinance/technical-analysis#AlmaParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  offset period sigma @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"AmatParameters","url":"/reference/totalfinance/technical-analysis#AmatParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fast lookback movingAverageType slow @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"AmatPoint","url":"/reference/totalfinance/technical-analysis#AmatPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  long short @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"AnchoredVwapParameters","url":"/reference/totalfinance/technical-analysis#AnchoredVwapParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  anchor @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"AnchoredVwapPoint","url":"/reference/totalfinance/technical-analysis#AnchoredVwapPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  anchorBarsAgo vwap @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"ApoParameters","url":"/reference/totalfinance/technical-analysis#ApoParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fast slow @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"ArcherObvParameters","url":"/reference/totalfinance/technical-analysis#ArcherObvParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fast runLength slow @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"ArcherObvPoint","url":"/reference/totalfinance/technical-analysis#ArcherObvPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fast long obv short slow @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"AroonPoint","url":"/reference/totalfinance/technical-analysis#AroonPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  down up @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"AtrBandsParameters","url":"/reference/totalfinance/technical-analysis#AtrBandsParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  multiplier period @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"AtrTrailingStopParameters","url":"/reference/totalfinance/technical-analysis#AtrTrailingStopParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  multiplier period @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"AwesomeParameters","url":"/reference/totalfinance/technical-analysis#AwesomeParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fast slow @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"BarAggregator","url":"/reference/totalfinance/technical-analysis/page-2#BarAggregator","description":"class from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis class  (parameters) (parameters).kind (parameters).shouldClose flush next next(bar) next(bar).close next(bar).high next(bar).low next(bar).open nex @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"BarColumns","url":"/reference/totalfinance/technical-analysis/page-2#BarColumns","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  close high low open volume"},{"title":"BarInput","url":"/reference/totalfinance/technical-analysis/page-2#BarInput","description":"OHLCV-style input row for bar indicators.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  close high low open volume @insiderfinance/totalfinance/technical-analysis/framework"},{"title":"BollingerParameters","url":"/reference/totalfinance/technical-analysis/page-2#BollingerParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period standardDeviation @insiderfinance/totalfinance/technical-analysis/bands"},{"title":"BollingerPoint","url":"/reference/totalfinance/technical-analysis/page-2#BollingerPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  bandwidth lower middle percentB upper @insiderfinance/totalfinance/technical-analysis/bands"},{"title":"BookImbalanceParameters","url":"/reference/totalfinance/technical-analysis/page-2#BookImbalanceParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  levels weighted @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"BookLevel","url":"/reference/totalfinance/technical-analysis/page-2#BookLevel","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  price size @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"BrarPoint","url":"/reference/totalfinance/technical-analysis/page-2#BrarPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  popularityIndex willingnessIndex @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"CANDLE_SETTINGS","url":"/reference/totalfinance/technical-analysis/page-2#CANDLE_SETTINGS","description":"TA-Lib default candle settings (`TA_RestoreCandleDefaultSettings`).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"value","keywords":"@insiderfinance/totalfinance/technical-analysis value  bodyDoji bodyDoji.averagePeriod bodyDoji.factor bodyDoji.range bodyLong bodyLong.averagePeriod bodyLong.factor bodyLong.range bodyShort body @insiderfinance/totalfinance/technical-analysis/candle-talib"},{"title":"CDL_ALIASES","url":"/reference/totalfinance/technical-analysis/page-2#CDL_ALIASES","description":"TA-Lib `CDL*` function name → TotalFinance catalog name.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"value","keywords":"@insiderfinance/totalfinance/technical-analysis value   @insiderfinance/totalfinance/technical-analysis/candle-aliases"},{"title":"CandleDetector","url":"/reference/totalfinance/technical-analysis/page-2#CandleDetector","description":"type from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type  (view) (view).black (view).body (view).bodyAverage (view).bodyGapDown (view).bodyGapUp (view).bodyHigh (view).bodyLow (view).close (view).do @insiderfinance/totalfinance/technical-analysis/candlesticks"},{"title":"CandleMatch","url":"/reference/totalfinance/technical-analysis/page-2#CandleMatch","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  pattern signal @insiderfinance/totalfinance/technical-analysis/candlesticks"},{"title":"CandleRangeType","url":"/reference/totalfinance/technical-analysis/page-2#CandleRangeType","description":"type from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/candle-talib"},{"title":"CandleSetting","url":"/reference/totalfinance/technical-analysis/page-2#CandleSetting","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  averagePeriod factor range @insiderfinance/totalfinance/technical-analysis/candle-talib"},{"title":"CandleSettingName","url":"/reference/totalfinance/technical-analysis/page-2#CandleSettingName","description":"type from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/candle-talib"},{"title":"CandleView","url":"/reference/totalfinance/technical-analysis/page-2#CandleView","description":"A read-only view of the last `len + 10` bars positioned at the current bar, exposing geometry and\nTA-Lib candle-average thresholds. `i` is an offset back from t","category":"@insiderfinance/totalfinance/technical-analysis","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis class  (parameters) (parameters).history (parameters).length black black(index) body body(index) bodyAverage bodyGapDown bodyGapDown(barIndex) body @insiderfinance/totalfinance/technical-analysis/candlesticks"},{"title":"CandleZParameters","url":"/reference/totalfinance/technical-analysis/page-2#CandleZParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  ddof period @insiderfinance/totalfinance/technical-analysis/candle-aliases"},{"title":"CandleZPoint","url":"/reference/totalfinance/technical-analysis/page-2#CandleZPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  close high low open @insiderfinance/totalfinance/technical-analysis/candle-aliases"},{"title":"ChaikinOscParameters","url":"/reference/totalfinance/technical-analysis/page-2#ChaikinOscParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fast slow @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"ChaikinVolatilityParameters","url":"/reference/totalfinance/technical-analysis/page-2#ChaikinVolatilityParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period rocPeriod @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"ChandeKrollStopParameters","url":"/reference/totalfinance/technical-analysis/page-3#ChandeKrollStopParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  atrPeriod multiplier period @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"ChandeKrollStopPoint","url":"/reference/totalfinance/technical-analysis/page-3#ChandeKrollStopPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  long short @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"ChandelierParameters","url":"/reference/totalfinance/technical-analysis/page-3#ChandelierParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  multiplier period @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"ChandelierPoint","url":"/reference/totalfinance/technical-analysis/page-3#ChandelierPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  long short @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"ChannelPoint","url":"/reference/totalfinance/technical-analysis/page-3#ChannelPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  lower middle upper @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"Condition","url":"/reference/totalfinance/technical-analysis/page-3#Condition","description":"A boolean predicate over the signal context, tagged with the column refs it reads.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  (barIndex) (context) (context).get refs @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"ConnorsRsiParameters","url":"/reference/totalfinance/technical-analysis/page-3#ConnorsRsiParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  rankPeriod rsiPeriod streakPeriod @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"CoppockParameters","url":"/reference/totalfinance/technical-analysis/page-3#CoppockParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  longRoc shortRoc wma @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"CountBarParameters","url":"/reference/totalfinance/technical-analysis/page-3#CountBarParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  count flush @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"CovarianceParameters","url":"/reference/totalfinance/technical-analysis/page-3#CovarianceParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period sample @insiderfinance/totalfinance/technical-analysis/features"},{"title":"CprPoint","url":"/reference/totalfinance/technical-analysis/page-3#CprPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  bottomCentral pivot topCentral @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"CrossSignalParameters","url":"/reference/totalfinance/technical-analysis/page-3#CrossSignalParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  above below @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"CvdAggregator","url":"/reference/totalfinance/technical-analysis/page-3#CvdAggregator","description":"Streaming, serializable cumulative-volume-delta aggregator — feed it trades (with optional aligned\nquotes) and it tracks running CVD and buy/sell volume. Mirror","category":"@insiderfinance/totalfinance/technical-analysis","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis class  (method) buyVolume cumulative fromJSON fromJSON().return.buyVolume fromJSON().return.cumulative fromJSON().return.next fromJSON().return.sel @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"CvdParameters","url":"/reference/totalfinance/technical-analysis/page-3#CvdParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  method quotes @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"CvdResult","url":"/reference/totalfinance/technical-analysis/page-3#CvdResult","description":"CVD report (Law 2): the aligned series and totals plus conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  assumptions assumptions.conventionsVersion assumptions.method buyVolume cumulative delta diagnostics diagnostics.warnings sellVolume sign @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"DivergenceCode","url":"/reference/totalfinance/technical-analysis/page-3#DivergenceCode","description":"Signed class code for the aligned/streaming {@link DivergencePoint}: sign is bullish(+)/bearish(−),\nmagnitude is regular(1)/hidden(2). `0` marks a confirmed-not","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/divergence"},{"title":"DivergenceEvent","url":"/reference/totalfinance/technical-analysis/page-3#DivergenceEvent","description":"A confirmed divergence event (the point-list form returned by {@link divergences}).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  index indicatorSwings kind priceSwings @insiderfinance/totalfinance/technical-analysis/divergence"},{"title":"DivergenceKind","url":"/reference/totalfinance/technical-analysis/page-3#DivergenceKind","description":"The four standard divergence classes.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/divergence"},{"title":"DivergenceParameters","url":"/reference/totalfinance/technical-analysis/page-3#DivergenceParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  kinds swing swing.left swing.right @insiderfinance/totalfinance/technical-analysis/divergence"},{"title":"DivergencePoint","url":"/reference/totalfinance/technical-analysis/page-3#DivergencePoint","description":"One aligned/streaming point. All fields are numeric (so warmup slots are cleanly all-`NaN`): the\nfriendly string `kind` lives on {@link DivergenceEvent}, the ev","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  code index indicatorSwings priceSwings @insiderfinance/totalfinance/technical-analysis/divergence"},{"title":"DmiPoint","url":"/reference/totalfinance/technical-analysis/page-4#DmiPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  dx minusDI minusDM plusDI plusDM @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"DollarBarParameters","url":"/reference/totalfinance/technical-analysis/page-4#DollarBarParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  dollar flush @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"DrawdownPoint","url":"/reference/totalfinance/technical-analysis/page-4#DrawdownPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  drawdown log percent @insiderfinance/totalfinance/technical-analysis/features"},{"title":"DspParameters","url":"/reference/totalfinance/technical-analysis/page-4#DspParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"EbswParameters","url":"/reference/totalfinance/technical-analysis/page-4#EbswParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  bars period @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"ElderRayPoint","url":"/reference/totalfinance/technical-analysis/page-4#ElderRayPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  bear bull @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"ElderThermometerParameters","url":"/reference/totalfinance/technical-analysis/page-4#ElderThermometerParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  long period short @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"ElderThermometerPoint","url":"/reference/totalfinance/technical-analysis/page-4#ElderThermometerPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  long movingAverage short thermo @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"EomParameters","url":"/reference/totalfinance/technical-analysis/page-4#EomParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period scale @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"EqualLevelParameters","url":"/reference/totalfinance/technical-analysis/page-4#EqualLevelParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  strength tolerance @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"EqualLevelPoint","url":"/reference/totalfinance/technical-analysis/page-4#EqualLevelPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  count detected level @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"FIB_EXTENSION_LEVELS","url":"/reference/totalfinance/technical-analysis/page-4#FIB_EXTENSION_LEVELS","description":"value from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"value","keywords":"@insiderfinance/totalfinance/technical-analysis value   @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"FIB_RETRACEMENT_LEVELS","url":"/reference/totalfinance/technical-analysis/page-4#FIB_RETRACEMENT_LEVELS","description":"value from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"value","keywords":"@insiderfinance/totalfinance/technical-analysis value   @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"FeatureColumn","url":"/reference/totalfinance/technical-analysis/page-4#FeatureColumn","description":"A computed column: one value (scalar or record) per input bar.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/pipeline"},{"title":"FeaturePipeline","url":"/reference/totalfinance/technical-analysis/page-4#FeaturePipeline","description":"class from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis class  (candles) applyBars applyBars(indicator) applyBars(indicator).explain applyBars(indicator).fromJSON applyBars(indicator).stream applyBars(op @insiderfinance/totalfinance/technical-analysis/pipeline"},{"title":"FibLevel","url":"/reference/totalfinance/technical-analysis/page-4#FibLevel","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  price ratio @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"Field","url":"/reference/totalfinance/technical-analysis/page-4#Field","description":"type from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/pipeline"},{"title":"FisherParameters","url":"/reference/totalfinance/technical-analysis/page-4#FisherParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"FisherPoint","url":"/reference/totalfinance/technical-analysis/page-4#FisherPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fisher trigger @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"FootprintBar","url":"/reference/totalfinance/technical-analysis/page-4#FootprintBar","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  buyVolume close delta high low open sellVolume time trades volume @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"FootprintBarParameters","url":"/reference/totalfinance/technical-analysis/page-5#FootprintBarParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  by method quotes threshold @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"FramaParameters","url":"/reference/totalfinance/technical-analysis/page-5#FramaParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"FvgParameters","url":"/reference/totalfinance/technical-analysis/page-5#FvgParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  minimumGapPercent @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"GannHiLoPoint","url":"/reference/totalfinance/technical-analysis/page-5#GannHiLoPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  trend value @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"Gap","url":"/reference/totalfinance/technical-analysis/page-5#Gap","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  direction index sizeFraction @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"GapFillEvent","url":"/reference/totalfinance/technical-analysis/page-5#GapFillEvent","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  direction fillIndex filled gapFrom gapTo index sizeFraction @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"HeikinAshiBar","url":"/reference/totalfinance/technical-analysis/page-5#HeikinAshiBar","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  close high low open @insiderfinance/totalfinance/technical-analysis/chart-types @insiderfinance/totalfinance/technical-analysis/transforms"},{"title":"HilbertCore","url":"/reference/totalfinance/technical-analysis/page-5#HilbertCore","description":"Shared Ehlers Hilbert-transform discriminator. Emits once the FIR history has filled (~6 bars).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis class  fromJSON fromJSON().return.toJSON fromJSON().return.update fromJSON(snapshot) fromJSON(snapshot).kind fromJSON(snapshot).schemaVersion fromJ @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"HilbertOut","url":"/reference/totalfinance/technical-analysis/page-5#HilbertOut","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  dcPeriod dcPhase inPhase quadrature trendline @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"HistoricalVolatilityParameters","url":"/reference/totalfinance/technical-analysis/page-5#HistoricalVolatilityParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  annualization period @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"HoltWinterChannelParameters","url":"/reference/totalfinance/technical-analysis/page-5#HoltWinterChannelParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  accelerationSmoothing levelSmoothing scalar trendSmoothing varianceSmoothing @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"HwmaParameters","url":"/reference/totalfinance/technical-analysis/page-5#HwmaParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  accelerationSmoothing levelSmoothing trendSmoothing @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"IchimokuParameters","url":"/reference/totalfinance/technical-analysis/page-5#IchimokuParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  base conversion displacement spanB @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"IchimokuPoint","url":"/reference/totalfinance/technical-analysis/page-5#IchimokuPoint","description":"Ichimoku components computed causally at the current bar — **no look-ahead, no shifting**. To draw a\nstandard Ichimoku cloud, plot `senkouA`/`senkouB` shifted *","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  chikou displacement kijun senkouA senkouB tenkan @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"Indicator","url":"/reference/totalfinance/technical-analysis/page-5#Indicator","description":"A facade indicator: callable (batch) with `.explain`, `.stream`, and `.fromJSON`.\n\n`parameters` is OPTIONAL on every call form (the first-touch law): a paramete","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/framework"},{"title":"IndicatorAliasRow","url":"/reference/totalfinance/technical-analysis/page-5#IndicatorAliasRow","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  pandas talib totalfinance tradingview @insiderfinance/totalfinance/technical-analysis/aliases"},{"title":"IndicatorCategory","url":"/reference/totalfinance/technical-analysis/page-5#IndicatorCategory","description":"type from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/registry"},{"title":"IndicatorConventions","url":"/reference/totalfinance/technical-analysis/page-5#IndicatorConventions","description":"A JSON-safe record of the CHOICES an indicator made that its parameters do not reveal.\n\nParameters say what you asked for; conventions say what the library deci","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/framework"},{"title":"IndicatorDefinition","url":"/reference/totalfinance/technical-analysis/page-5#IndicatorDefinition","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  category conventions defaults inputs name nan nan(parameters) output output.value output.value.bounds output.value.fields output.value.items @insiderfinance/totalfinance/technical-analysis/registry"},{"title":"IndicatorDescription","url":"/reference/totalfinance/technical-analysis/page-5#IndicatorDescription","description":"One indicator's full metadata card.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  aliases aliases.pandas aliases.talib aliases.tradingview category conventions defaults inputs name output output.value output.value.bounds o"},{"title":"IndicatorInputs","url":"/reference/totalfinance/technical-analysis/page-6#IndicatorInputs","description":"type from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/registry"},{"title":"IndicatorMatchEvidence","url":"/reference/totalfinance/technical-analysis/page-6#IndicatorMatchEvidence","description":"Inspectable evidence for why a queried row matched — its match class, score, and the name that hit.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  kind matchedOn matchedOn.source matchedOn.value score"},{"title":"IndicatorMetadata","url":"/reference/totalfinance/technical-analysis/page-6#IndicatorMetadata","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  category conventions defaults inputs name parameters @insiderfinance/totalfinance/technical-analysis/registry"},{"title":"IndicatorNumberOutput","url":"/reference/totalfinance/technical-analysis/page-6#IndicatorNumberOutput","description":"A numeric output leaf, optionally with a semantic role, unit, and inclusive value bounds.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  bounds role type unit"},{"title":"IndicatorOutputMetadata","url":"/reference/totalfinance/technical-analysis/page-6#IndicatorOutputMetadata","description":"An indicator's output metadata: its runtime value schema plus an optional visualization hint.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  value value.bounds value.fields value.items value.length value.length.fixed value.length.parameter value.role value.type value.unit value.va"},{"title":"IndicatorOutputValue","url":"/reference/totalfinance/technical-analysis/page-6#IndicatorOutputValue","description":"The recursive output value schema — a scalar leaf, a named record, or a vector.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type  bounds fields items length length.fixed length.parameter role type unit values"},{"title":"IndicatorRow","url":"/reference/totalfinance/technical-analysis/page-6#IndicatorRow","description":"The bulk-list row shape (no warmup — that is a per-`describe` measurement).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  category defaults inputs match match.kind match.matchedOn match.matchedOn.source match.matchedOn.value match.score name output output.value "},{"title":"IndicatorStream","url":"/reference/totalfinance/technical-analysis/page-6#IndicatorStream","description":"A stateful streaming indicator. `next` returns `null` during warmup.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  next next(input) toJSON toJSON().return.kind toJSON().return.schemaVersion toJSON().return.state value @insiderfinance/totalfinance/technical-analysis/framework"},{"title":"IndicatorVisualization","url":"/reference/totalfinance/technical-analysis/page-6#IndicatorVisualization","description":"How an indicator plots (one path per drawn series), separate from the runtime `value` shape.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  kind plots referenceLevels"},{"title":"InertiaParameters","url":"/reference/totalfinance/technical-analysis/page-6#InertiaParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period rviPeriod @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"InformationBarAggregator","url":"/reference/totalfinance/technical-analysis/page-6#InformationBarAggregator","description":"class from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis class  (parameters) (parameters).kind (parameters).mode (parameters).threshold (parameters).weight flush fromJSON fromJSON().return.flush fromJSON( @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"InformationBarParameters","url":"/reference/totalfinance/technical-analysis/page-6#InformationBarParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  flush threshold @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"JmaParameters","url":"/reference/totalfinance/technical-analysis/page-6#JmaParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period phase power @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"KagiParameters","url":"/reference/totalfinance/technical-analysis/page-6#KagiParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  percent reversal @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"KagiSegment","url":"/reference/totalfinance/technical-analysis/page-6#KagiSegment","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  direction from line to @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"KamaParameters","url":"/reference/totalfinance/technical-analysis/page-6#KamaParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fast period slow @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"KdjParameters","url":"/reference/totalfinance/technical-analysis/page-6#KdjParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period signal @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"KdjPoint","url":"/reference/totalfinance/technical-analysis/page-6#KdjPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  d j k @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"KeltnerParameters","url":"/reference/totalfinance/technical-analysis/page-6#KeltnerParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  atrPeriod multiplier period @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"KlingerParameters","url":"/reference/totalfinance/technical-analysis/page-6#KlingerParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fast signal slow @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"KlingerPoint","url":"/reference/totalfinance/technical-analysis/page-7#KlingerPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  klinger signal @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"KstParameters","url":"/reference/totalfinance/technical-analysis/page-7#KstParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  rocPeriods signal smaPeriods @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"KstPoint","url":"/reference/totalfinance/technical-analysis/page-7#KstPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  kst signal @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"LabeledSwing","url":"/reference/totalfinance/technical-analysis/page-7#LabeledSwing","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  index kind label price @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"LaguerreParameters","url":"/reference/totalfinance/technical-analysis/page-7#LaguerreParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  gamma @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"Line","url":"/reference/totalfinance/technical-analysis/page-7#Line","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  from intercept slope to @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"LineBreakBar","url":"/reference/totalfinance/technical-analysis/page-7#LineBreakBar","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  close direction open @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"LineBreakParameters","url":"/reference/totalfinance/technical-analysis/page-7#LineBreakParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  lines @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"LineBreakStream","url":"/reference/totalfinance/technical-analysis/page-7#LineBreakStream","description":"class from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis class  (count) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON(snapshot) fromJSON(snapshot).kind fromJSON(snapshot).schemaVersion @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"LinregPoint","url":"/reference/totalfinance/technical-analysis/page-7#LinregPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  angle forecast intercept slope value @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"LiquiditySweepParameters","url":"/reference/totalfinance/technical-analysis/page-7#LiquiditySweepParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  lookback @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"LiquiditySweepPoint","url":"/reference/totalfinance/technical-analysis/page-7#LiquiditySweepPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  direction level @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"LiveStream","url":"/reference/totalfinance/technical-analysis/page-7#LiveStream","description":"A live streaming indicator (spec §13.4, WS6.1) — an {@link IndicatorStream} plus `peek`, the\nforming-bar affordance. This is the public shape returned by `indic","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  next next(input) peek peek(input) toJSON toJSON().return.kind toJSON().return.schemaVersion toJSON().return.state value @insiderfinance/totalfinance/technical-analysis/framework"},{"title":"MacdExtParameters","url":"/reference/totalfinance/technical-analysis/page-7#MacdExtParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fast fastMovingAverageType signal signalMovingAverageType slow slowMovingAverageType @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"MacdFixParameters","url":"/reference/totalfinance/technical-analysis/page-7#MacdFixParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  signal @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"MacdParameters","url":"/reference/totalfinance/technical-analysis/page-7#MacdParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fast signal slow @insiderfinance/totalfinance/technical-analysis/macd"},{"title":"MacdPoint","url":"/reference/totalfinance/technical-analysis/page-7#MacdPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  histogram macd signal @insiderfinance/totalfinance/technical-analysis/macd"},{"title":"MamaParameters","url":"/reference/totalfinance/technical-analysis/page-7#MamaParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fastLimit slowLimit @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"MamaPoint","url":"/reference/totalfinance/technical-analysis/page-7#MamaPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fama mama @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"MarketStructure","url":"/reference/totalfinance/technical-analysis/page-7#MarketStructure","description":"Market-structure report (Law 2): labeled swings and events plus conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  assumptions assumptions.conventionsVersion assumptions.strength diagnostics diagnostics.warnings events swings @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"MassIndexParameters","url":"/reference/totalfinance/technical-analysis/page-8#MassIndexParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fast slow @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"MavpParameters","url":"/reference/totalfinance/technical-analysis/page-8#MavpParameters","description":"Variable-period MA (TA-Lib MAVP): the period for bar `i` comes from `periods[i]`, clamped to\n`[minPeriod, maxPeriod]` and rounded. Batch only — the per-bar peri","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  maxPeriod minPeriod movingAverageType @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"MinMaxIndexPoint","url":"/reference/totalfinance/technical-analysis/page-8#MinMaxIndexPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  maxIndex minIndex @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"MinMaxPoint","url":"/reference/totalfinance/technical-analysis/page-8#MinMaxPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  max min @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"MovingAverageName","url":"/reference/totalfinance/technical-analysis/page-8#MovingAverageName","description":"type from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"MovingAverageParameters","url":"/reference/totalfinance/technical-analysis/page-8#MovingAverageParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  movingAverageType period @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"MovingAverageRibbonParameters","url":"/reference/totalfinance/technical-analysis/page-8#MovingAverageRibbonParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  periods @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"MovingAverageType","url":"/reference/totalfinance/technical-analysis/page-8#MovingAverageType","description":"type from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"MswParameters","url":"/reference/totalfinance/technical-analysis/page-8#MswParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"MswPoint","url":"/reference/totalfinance/technical-analysis/page-8#MswPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  lead sine @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"OpeningRange","url":"/reference/totalfinance/technical-analysis/page-8#OpeningRange","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  assumptions assumptions.conventionsVersion assumptions.periods diagnostics diagnostics.warnings high low mid @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"Operand","url":"/reference/totalfinance/technical-analysis/page-8#Operand","description":"type from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"OrderBlockParameters","url":"/reference/totalfinance/technical-analysis/page-8#OrderBlockParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  lookback @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"OrderBook","url":"/reference/totalfinance/technical-analysis/page-8#OrderBook","description":"Order book with levels sorted best-first (bids descending, asks ascending).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  asks bids @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"OrderBookLevel","url":"/reference/totalfinance/technical-analysis/page-8#OrderBookLevel","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  askSize bidSize @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"PANDAS_CDL_ALIASES","url":"/reference/totalfinance/technical-analysis/page-8#PANDAS_CDL_ALIASES","description":"pandas-ta `cdl_pattern(name=...)` pattern name → TotalFinance catalog name.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"value","keywords":"@insiderfinance/totalfinance/technical-analysis value   @insiderfinance/totalfinance/technical-analysis/candle-aliases"},{"title":"Pair","url":"/reference/totalfinance/technical-analysis/page-8#Pair","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  x y @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"PeriodParameters","url":"/reference/totalfinance/technical-analysis/page-8#PeriodParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap @insiderfinance/totalfinance/technical-analysis/statistics @insiderfinance/totalfinance/technical-analysis/trend @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"PhasorPoint","url":"/reference/totalfinance/technical-analysis/page-8#PhasorPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  inPhase quadrature @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"PivotLevels","url":"/reference/totalfinance/technical-analysis/page-8#PivotLevels","description":"Pivot-level report (Law 2): the levels plus the applied conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  assumptions assumptions.conventionsVersion assumptions.method diagnostics diagnostics.warnings pivot resistance support @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"PivotMethod","url":"/reference/totalfinance/technical-analysis/page-9#PivotMethod","description":"type from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"PmaxParameters","url":"/reference/totalfinance/technical-analysis/page-9#PmaxParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  multiplier period @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"PmaxPoint","url":"/reference/totalfinance/technical-analysis/page-9#PmaxPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  pmax trend @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"PnfColumn","url":"/reference/totalfinance/technical-analysis/page-9#PnfColumn","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  boxes high kind low @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"PnfParameters","url":"/reference/totalfinance/technical-analysis/page-9#PnfParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  boxSize reversal @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"PpoParameters","url":"/reference/totalfinance/technical-analysis/page-9#PpoParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fast signal slow @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"PpoPoint","url":"/reference/totalfinance/technical-analysis/page-9#PpoPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  histogram ppo signal @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"PriceVolumeParameters","url":"/reference/totalfinance/technical-analysis/page-9#PriceVolumeParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  signed @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"PriorSessionLevel","url":"/reference/totalfinance/technical-analysis/page-9#PriorSessionLevel","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  close high low @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"ProjectionPoint","url":"/reference/totalfinance/technical-analysis/page-9#ProjectionPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  lower po upper @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"PsarExtParameters","url":"/reference/totalfinance/technical-analysis/page-9#PsarExtParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  accelInitLong accelInitShort accelLong accelMaxLong accelMaxShort accelShort offsetOnReverse startValue @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"PsarParameters","url":"/reference/totalfinance/technical-analysis/page-9#PsarParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  max step @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"PsarPoint","url":"/reference/totalfinance/technical-analysis/page-9#PsarPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  sar trend @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"PvoParameters","url":"/reference/totalfinance/technical-analysis/page-9#PvoParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fast signal slow @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"PvoPoint","url":"/reference/totalfinance/technical-analysis/page-9#PvoPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  histogram pvo signal @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"QqeParameters","url":"/reference/totalfinance/technical-analysis/page-9#QqeParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  factor rsiPeriod smooth @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"QqePoint","url":"/reference/totalfinance/technical-analysis/page-9#QqePoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  longBand rsiMovingAverage shortBand @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"QuantileParameters","url":"/reference/totalfinance/technical-analysis/page-9#QuantileParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period quantile @insiderfinance/totalfinance/technical-analysis/features"},{"title":"Quote","url":"/reference/totalfinance/technical-analysis/page-9#Quote","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  ask askSize bid bidSize @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"RainbowParameters","url":"/reference/totalfinance/technical-analysis/page-9#RainbowParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  levels period @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"RangeBarParameters","url":"/reference/totalfinance/technical-analysis/page-10#RangeBarParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  flush size @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"RangeVolatilityParameters","url":"/reference/totalfinance/technical-analysis/page-10#RangeVolatilityParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  annualization period @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"RegisteredIndicator","url":"/reference/totalfinance/technical-analysis/page-10#RegisteredIndicator","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  category conventions defaults indicator indicator(input) indicator(parameters) indicator.explain indicator.explain().return.assumptions indi @insiderfinance/totalfinance/technical-analysis/registry"},{"title":"RegressionPoint","url":"/reference/totalfinance/technical-analysis/page-10#RegressionPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  intercept rSquared slope @insiderfinance/totalfinance/technical-analysis/features"},{"title":"RenkoBrick","url":"/reference/totalfinance/technical-analysis/page-10#RenkoBrick","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  close direction open @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"RenkoParameters","url":"/reference/totalfinance/technical-analysis/page-10#RenkoParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  brickSize @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"RenkoStream","url":"/reference/totalfinance/technical-analysis/page-10#RenkoStream","description":"class from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis class  (brick) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON(snapshot) fromJSON(snapshot).kind fromJSON(snapshot).schemaVersion @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"ResampleInterval","url":"/reference/totalfinance/technical-analysis/page-10#ResampleInterval","description":"Named timeframes, or a raw millisecond interval.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/resample"},{"title":"ResampleOptions","url":"/reference/totalfinance/technical-analysis/page-10#ResampleOptions","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  includePartial @insiderfinance/totalfinance/technical-analysis/resample"},{"title":"ResampledBar","url":"/reference/totalfinance/technical-analysis/page-10#ResampledBar","description":"A resampled higher-timeframe bar: OHLCV plus the bucket VWAP and a forming-bucket flag.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  close high low open partial timestampMs volume vwap @insiderfinance/totalfinance/technical-analysis/resample"},{"title":"RescaleParameters","url":"/reference/totalfinance/technical-analysis/page-10#RescaleParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  max min period @insiderfinance/totalfinance/technical-analysis/features"},{"title":"RocParameters","url":"/reference/totalfinance/technical-analysis/page-10#RocParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"RollingAnchoredVwapParameters","url":"/reference/totalfinance/technical-analysis/page-10#RollingAnchoredVwapParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  anchor lookback @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"RollingVolatilityParameters","url":"/reference/totalfinance/technical-analysis/page-10#RollingVolatilityParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  annualization period @insiderfinance/totalfinance/technical-analysis/series"},{"title":"RsiParameters","url":"/reference/totalfinance/technical-analysis/page-10#RsiParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period @insiderfinance/totalfinance/technical-analysis/rsi"},{"title":"Rule","url":"/reference/totalfinance/technical-analysis/page-10#Rule","description":"A labeled and/or-combination of conditions — the unit {@link SignalBuilder#addRule } accepts.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  label terms @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"RuleBuilder","url":"/reference/totalfinance/technical-analysis/page-10#RuleBuilder","description":"Builds one rule as a chain of conditions. Evaluation is STRICT LEFT-TO-RIGHT with NO operator\nprecedence: each `.and(c)` / `.or(c)` folds `c` into the accumulat","category":"@insiderfinance/totalfinance/technical-analysis","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis class  (__0) (__0).first (__0).owner and and(condition) and(condition).refs emit emit().return.addRule emit().return.atr emit().return.columns emit @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"RvgiPoint","url":"/reference/totalfinance/technical-analysis/page-10#RvgiPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  rvi signal @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"RviParameters","url":"/reference/totalfinance/technical-analysis/page-10#RviParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period stdevPeriod @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"SCHEMA_VERSION","url":"/reference/totalfinance/technical-analysis/page-10#SCHEMA_VERSION","description":"Current snapshot schema version. Bump when a stored snapshot's shape changes incompatibly.\n\n2 — the flat `{ kind, v?, ...state }` shape became the explicit `{ k","category":"@insiderfinance/totalfinance/technical-analysis","kind":"value","keywords":"@insiderfinance/totalfinance/technical-analysis value   @insiderfinance/totalfinance/technical-analysis/framework"},{"title":"SearchIndicatorsOptions","url":"/reference/totalfinance/technical-analysis/page-11#SearchIndicatorsOptions","description":"Options for {@link searchIndicators}.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  category limit match minScore offset query"},{"title":"SearchIndicatorsResult","url":"/reference/totalfinance/technical-analysis/page-11#SearchIndicatorsResult","description":"Result of {@link searchIndicators}.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  indicators limit offset total"},{"title":"SearchMatchMode","url":"/reference/totalfinance/technical-analysis/page-11#SearchMatchMode","description":"How a `query` is matched. `auto` (default) uses substring first, deterministic fuzzy only as a fallback.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type  "},{"title":"SessionRange","url":"/reference/totalfinance/technical-analysis/page-11#SessionRange","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  close high low open range session volume @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"SessionVwapParameters","url":"/reference/totalfinance/technical-analysis/page-11#SessionVwapParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  resetEvery @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"SignContext","url":"/reference/totalfinance/technical-analysis/page-11#SignContext","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  previousPrice previousSign quote quote.ask quote.askSize quote.bid quote.bidSize @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"SignalBuilder","url":"/reference/totalfinance/technical-analysis/page-11#SignalBuilder","description":"class from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis class  (candles) addRule addRule(rule) addRule(rule).label addRule(rule).terms atr atr(options) atr(options).as atr(parameters) atr(parameters).per @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"SignalContext","url":"/reference/totalfinance/technical-analysis/page-11#SignalContext","description":"class from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis class  (parameters) (parameters).candles (parameters).cols get get(barIndex) get(operand) return.get @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"SignalEvent","url":"/reference/totalfinance/technical-analysis/page-11#SignalEvent","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  index label @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"SinePoint","url":"/reference/totalfinance/technical-analysis/page-11#SinePoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  leadSine sine @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"SmcSweepParameters","url":"/reference/totalfinance/technical-analysis/page-11#SmcSweepParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period wickMultiplier @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"SmiParameters","url":"/reference/totalfinance/technical-analysis/page-11#SmiParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  long short signal @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"SmiPoint","url":"/reference/totalfinance/technical-analysis/page-11#SmiPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  oscillator signal smi @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"SnapshotState","url":"/reference/totalfinance/technical-analysis/page-11#SnapshotState","description":"Checked access to one snapshot's opaque state.\n\nEvery accessor takes the state key and returns the value the restorer needs, or throws a typed\n`InputError` nami","category":"@insiderfinance/totalfinance/technical-analysis","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis class  (kind) (state) boolean boolean(field) cached cached(field) child child().return.kind child().return.schemaVersion child().return.state child"},{"title":"SqueezeParameters","url":"/reference/totalfinance/technical-analysis/page-11#SqueezeParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  bollingerBandPeriod bollingerStandardDeviations keltnerChannelMultiplier keltnerChannelPeriod @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"SqueezePoint","url":"/reference/totalfinance/technical-analysis/page-11#SqueezePoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  momentum on @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"SqueezeProParameters","url":"/reference/totalfinance/technical-analysis/page-11#SqueezeProParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  bollingerBandPeriod bollingerStandardDeviations keltnerChannelPeriod narrowKeltnerChannelMultiplier normalKeltnerChannelMultiplier wideKeltn @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"SqueezeProPoint","url":"/reference/totalfinance/technical-analysis/page-11#SqueezeProPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  highCompression lowCompression momentum normalCompression @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"SrLevel","url":"/reference/totalfinance/technical-analysis/page-11#SrLevel","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  price touches @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"StandardDeviationParameters","url":"/reference/totalfinance/technical-analysis/page-11#StandardDeviationParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period sample @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"StcParameters","url":"/reference/totalfinance/technical-analysis/page-12#StcParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  cycle fast slow @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"StochRsiParameters","url":"/reference/totalfinance/technical-analysis/page-12#StochRsiParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  dPeriod kPeriod rsiPeriod stochPeriod @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"StochRsiPoint","url":"/reference/totalfinance/technical-analysis/page-12#StochRsiPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  d k @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"StochasticParameters","url":"/reference/totalfinance/technical-analysis/page-12#StochasticParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  dPeriod kPeriod smoothK @insiderfinance/totalfinance/technical-analysis/bars"},{"title":"StochasticPoint","url":"/reference/totalfinance/technical-analysis/page-12#StochasticPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  d k @insiderfinance/totalfinance/technical-analysis/bars"},{"title":"StructureEvent","url":"/reference/totalfinance/technical-analysis/page-12#StructureEvent","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  direction index type @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"StructureEventType","url":"/reference/totalfinance/technical-analysis/page-12#StructureEventType","description":"type from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"SupertrendParameters","url":"/reference/totalfinance/technical-analysis/page-12#SupertrendParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  multiplier period @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"SupertrendPoint","url":"/reference/totalfinance/technical-analysis/page-12#SupertrendPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  direction supertrend @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"SupportResistance","url":"/reference/totalfinance/technical-analysis/page-12#SupportResistance","description":"Support/resistance report (Law 2): clustered levels plus conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  assumptions assumptions.conventionsVersion assumptions.strength assumptions.tolerance diagnostics diagnostics.warnings resistance support @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"SwingLabel","url":"/reference/totalfinance/technical-analysis/page-12#SwingLabel","description":"type from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type   @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"SwingPoint","url":"/reference/totalfinance/technical-analysis/page-12#SwingPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  index price @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"SwingTrailingStopParameters","url":"/reference/totalfinance/technical-analysis/page-12#SwingTrailingStopParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  strength @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"SwingWindow","url":"/reference/totalfinance/technical-analysis/page-12#SwingWindow","description":"Fractal confirmation window: `left` bars before and `right` bars after the pivot.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  left right @insiderfinance/totalfinance/technical-analysis/divergence"},{"title":"Swings","url":"/reference/totalfinance/technical-analysis/page-12#Swings","description":"Swing report (Law 2): the confirmed swing points plus applied conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  assumptions assumptions.conventionsVersion assumptions.strength diagnostics diagnostics.warnings highs lows @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"T3Parameters","url":"/reference/totalfinance/technical-analysis/page-12#T3Parameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period volumeFactor @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"TALIB_CANDLE_NAMES","url":"/reference/totalfinance/technical-analysis/page-12#TALIB_CANDLE_NAMES","description":"Pattern names implemented with exact TA-Lib adaptive parity in this module.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"value","keywords":"@insiderfinance/totalfinance/technical-analysis value   @insiderfinance/totalfinance/technical-analysis/candle-talib"},{"title":"TdSequentialParameters","url":"/reference/totalfinance/technical-analysis/page-12#TdSequentialParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  lookback @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"TdSequentialPoint","url":"/reference/totalfinance/technical-analysis/page-12#TdSequentialPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  countdown direction setup @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"TechnicalAnalysisAssumptionExtras","url":"/reference/totalfinance/technical-analysis/page-12#TechnicalAnalysisAssumptionExtras","description":"Domain extras every TA explain envelope discloses.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  conventions indicator parameters @insiderfinance/totalfinance/technical-analysis/framework"},{"title":"TechnicalAnalysisExplain","url":"/reference/totalfinance/technical-analysis/page-13#TechnicalAnalysisExplain","description":"The TA explain envelope: core `Computed` whose diagnostics ALWAYS carry the warmup count.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis type  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/technical-analysis/framework"},{"title":"TechnicalAnalysisSnapshot","url":"/reference/totalfinance/technical-analysis/page-13#TechnicalAnalysisSnapshot","description":"Serialized streaming-state snapshot (3B.N7).\n\nThe ENVELOPE is explicit and public: `kind` says which indicator wrote it, `schemaVersion` says\nwhich shape it is ","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  kind schemaVersion state @insiderfinance/totalfinance/technical-analysis/framework"},{"title":"Term","url":"/reference/totalfinance/technical-analysis/page-13#Term","description":"One condition inside a rule, with the operator joining it to the PREVIOUS term.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  condition condition(barIndex) condition(context) condition(context).get condition.refs operator @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"TickVolumeBin","url":"/reference/totalfinance/technical-analysis/page-13#TickVolumeBin","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  buyVolume delta high low sellVolume trades volume @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"TickVolumeProfile","url":"/reference/totalfinance/technical-analysis/page-13#TickVolumeProfile","description":"Tick-profile report (Law 2): the footprint bins and levels plus conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  assumptions assumptions.bins assumptions.conventionsVersion assumptions.method assumptions.tickSize assumptions.valueAreaFraction bins diagn @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"TickVolumeProfileParameters","url":"/reference/totalfinance/technical-analysis/page-13#TickVolumeProfileParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  bins method quotes tickSize valueAreaFraction @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"TimeBar","url":"/reference/totalfinance/technical-analysis/page-13#TimeBar","description":"A timestamped OHLCV bar (ms since the Unix epoch).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  close high low open timestampMs volume @insiderfinance/totalfinance/technical-analysis/resample"},{"title":"TosStdevAllParameters","url":"/reference/totalfinance/technical-analysis/page-13#TosStdevAllParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  ddof period stds @insiderfinance/totalfinance/technical-analysis/features"},{"title":"TosStdevAllPoint","url":"/reference/totalfinance/technical-analysis/page-13#TosStdevAllPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  line lower upper @insiderfinance/totalfinance/technical-analysis/features"},{"title":"Trade","url":"/reference/totalfinance/technical-analysis/page-13#Trade","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  price side size time @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"TrailingStopPoint","url":"/reference/totalfinance/technical-analysis/page-13#TrailingStopPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  stop trend @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"TrendSignalPoint","url":"/reference/totalfinance/technical-analysis/page-13#TrendSignalPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  entry exit trend @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"TrendTestParameters","url":"/reference/totalfinance/technical-analysis/page-13#TrendTestParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period strict @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"TrixHistogramParameters","url":"/reference/totalfinance/technical-analysis/page-13#TrixHistogramParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period signal @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"TrixHistogramPoint","url":"/reference/totalfinance/technical-analysis/page-13#TrixHistogramPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  histogram signal trix @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"TsiParameters","url":"/reference/totalfinance/technical-analysis/page-13#TsiParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  long short signal @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"TsiPoint","url":"/reference/totalfinance/technical-analysis/page-13#TsiPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  signal tsi @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"UltimateParameters","url":"/reference/totalfinance/technical-analysis/page-13#UltimateParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  long medium short @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"ValueWhenParameters","url":"/reference/totalfinance/technical-analysis/page-13#ValueWhenParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  occurrence @insiderfinance/totalfinance/technical-analysis/features"},{"title":"VfiParameters","url":"/reference/totalfinance/technical-analysis/page-13#VfiParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  coefficient period smooth volumeCutoff @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"VidyaParameters","url":"/reference/totalfinance/technical-analysis/page-14#VidyaParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  cmoPeriod period @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"VolatilityStopParameters","url":"/reference/totalfinance/technical-analysis/page-14#VolatilityStopParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  multiplier period @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"VolatilityStopPoint","url":"/reference/totalfinance/technical-analysis/page-14#VolatilityStopPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  stop trend @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"VolumeBarParameters","url":"/reference/totalfinance/technical-analysis/page-14#VolumeBarParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  flush volume @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"VolumeBin","url":"/reference/totalfinance/technical-analysis/page-14#VolumeBin","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  high low volume @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"VolumeOscillatorParameters","url":"/reference/totalfinance/technical-analysis/page-14#VolumeOscillatorParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fast slow @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"VolumeProfile","url":"/reference/totalfinance/technical-analysis/page-14#VolumeProfile","description":"Volume-profile report (Law 2): the bins and levels plus conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  assumptions assumptions.bins assumptions.conventionsVersion assumptions.valueAreaFraction bins diagnostics diagnostics.warnings poc totalVol @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"VolumeProfileParameters","url":"/reference/totalfinance/technical-analysis/page-14#VolumeProfileParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  bins valueAreaFraction @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"VortexPoint","url":"/reference/totalfinance/technical-analysis/page-14#VortexPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  viMinus viPlus @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"VwMacdParameters","url":"/reference/totalfinance/technical-analysis/page-14#VwMacdParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  fast signal slow @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"VwapBandsParameters","url":"/reference/totalfinance/technical-analysis/page-14#VwapBandsParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  multiplier @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"VwapBandsPoint","url":"/reference/totalfinance/technical-analysis/page-14#VwapBandsPoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  lower upper vwap @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"WarmupMetadata","url":"/reference/totalfinance/technical-analysis/page-14#WarmupMetadata","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  category inputs name parameters warmup @insiderfinance/totalfinance/technical-analysis/warmup"},{"title":"WilderPeriodParameters","url":"/reference/totalfinance/technical-analysis/page-14#WilderPeriodParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  period @insiderfinance/totalfinance/technical-analysis/bars"},{"title":"WinsorizeParameters","url":"/reference/totalfinance/technical-analysis/page-14#WinsorizeParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  lower period upper @insiderfinance/totalfinance/technical-analysis/features"},{"title":"ZigZagParameters","url":"/reference/totalfinance/technical-analysis/page-14#ZigZagParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  deviation @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"ZigZagPivot","url":"/reference/totalfinance/technical-analysis/page-14#ZigZagPivot","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  index kind price @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"ZonePoint","url":"/reference/totalfinance/technical-analysis/page-14#ZonePoint","description":"interface from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis interface  bottom direction mid top @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"aberration","url":"/reference/totalfinance/technical-analysis/page-14#aberration","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).atrPeriod (parameters).period explain explain().return.assumptions explain().return.diagnostics explain(). @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"accelerationBands","url":"/reference/totalfinance/technical-analysis/page-14#accelerationBands","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).multiplier (parameters).period explain explain().return.assumptions explain().return.diagnostics explain() @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"acos","url":"/reference/totalfinance/technical-analysis/page-15#acos","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"adLine","url":"/reference/totalfinance/technical-analysis/page-15#adLine","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"add","url":"/reference/totalfinance/technical-analysis/page-15#add","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"adx","url":"/reference/totalfinance/technical-analysis/page-15#adx","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/bars"},{"title":"adxr","url":"/reference/totalfinance/technical-analysis/page-15#adxr","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"aggregators","url":"/reference/totalfinance/technical-analysis/page-15#aggregators","description":"Streaming aggregators for live bar construction (each returns completed bars per input bar).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"value","keywords":"@insiderfinance/totalfinance/technical-analysis value  dollar dollar().return.flush dollar().return.next dollar().return.restore dollar().return.toJSON dollar(threshold) dollarImbalance dollarImb @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"aliasesOf","url":"/reference/totalfinance/technical-analysis/page-15#aliasesOf","description":"The alias row for a canonical TotalFinance name, if one exists.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (canonical) return.pandas return.talib return.totalfinance return.tradingview @insiderfinance/totalfinance/technical-analysis/aliases"},{"title":"alignToBars","url":"/reference/totalfinance/technical-analysis/page-15#alignToBars","description":"Project a higher-timeframe series onto a lower-timeframe bar index, strictly causally (spec §13,\nWS6.2). `higherSeries[j]` is a value computed on `higherBars[j]","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (input).higherBars (input).higherSeries (input).lowerBars (input).options @insiderfinance/totalfinance/technical-analysis/resample"},{"title":"alma","url":"/reference/totalfinance/technical-analysis/page-15#alma","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).offset (parameters).period (parameters).sigma explain explain().return.assumptions explain().return.diagno @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"amat","url":"/reference/totalfinance/technical-analysis/page-15#amat","description":"Archer Moving Averages Trends (pandas-ta `amat`).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).fast (parameters).lookback (parameters).movingAverageType (parameters).slow explain explain().return.assum @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"anchoredVwap","url":"/reference/totalfinance/technical-analysis/page-15#anchoredVwap","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).anchor explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"apo","url":"/reference/totalfinance/technical-analysis/page-15#apo","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).fast (parameters).slow explain explain().return.assumptions explain().return.diagnostics explain().return. @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"archerObv","url":"/reference/totalfinance/technical-analysis/page-15#archerObv","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).fast (parameters).runLength (parameters).slow explain explain().return.assumptions explain().return.diagno @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"aroon","url":"/reference/totalfinance/technical-analysis/page-15#aroon","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"aroonOscillator","url":"/reference/totalfinance/technical-analysis/page-15#aroonOscillator","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"asin","url":"/reference/totalfinance/technical-analysis/page-15#asin","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"atan","url":"/reference/totalfinance/technical-analysis/page-15#atan","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"atr","url":"/reference/totalfinance/technical-analysis/page-15#atr","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/bars"},{"title":"atrBands","url":"/reference/totalfinance/technical-analysis/page-15#atrBands","description":"ATR Bands — SMA(close) ± multiplier·ATR (an SMA-centred ATR channel).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).multiplier (parameters).period explain explain().return.assumptions explain().return.diagnostics explain() @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"atrTrailingStop","url":"/reference/totalfinance/technical-analysis/page-15#atrTrailingStop","description":"ATR trailing stop (Vervoort / UT-Bot): close-anchored `close ± multiplier·ATR`, trailed per leg.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).multiplier (parameters).period explain explain().return.assumptions explain().return.diagnostics explain() @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"averagePrice","url":"/reference/totalfinance/technical-analysis/page-16#averagePrice","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/transforms"},{"title":"awesomeOscillator","url":"/reference/totalfinance/technical-analysis/page-16#awesomeOscillator","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).fast (parameters).slow explain explain().return.assumptions explain().return.diagnostics explain().return. @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"bar","url":"/reference/totalfinance/technical-analysis/page-16#bar","description":"value from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"value","keywords":"@insiderfinance/totalfinance/technical-analysis value  average average(bar) average(bar).close average(bar).high average(bar).low average(bar).open average(bar).volume average(rest) body body(bar @insiderfinance/totalfinance/technical-analysis/transforms"},{"title":"barSince","url":"/reference/totalfinance/technical-analysis/page-16#barSince","description":"Bars since the input condition (`> 0`) was last true (0 on a true bar; NaN before the first).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/features"},{"title":"barsFromColumns","url":"/reference/totalfinance/technical-analysis/page-16#barsFromColumns","description":"Convert columnar OHLCV arrays into bar rows. All supplied columns must be arrays of one shared\nlength; omitted columns are simply absent from the rows. Throws t","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (columns) (columns).close (columns).high (columns).low (columns).open (columns).volume"},{"title":"bb","url":"/reference/totalfinance/technical-analysis/page-16#bb","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).standardDeviation explain explain().return.assumptions explain().return.diagnostics ex"},{"title":"bbands","url":"/reference/totalfinance/technical-analysis/page-16#bbands","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).standardDeviation explain explain().return.assumptions explain().return.diagnostics ex @insiderfinance/totalfinance/technical-analysis/bands"},{"title":"beta","url":"/reference/totalfinance/technical-analysis/page-16#beta","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"between","url":"/reference/totalfinance/technical-analysis/page-16#between","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (high) (low) (operand) return.refs @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"bias","url":"/reference/totalfinance/technical-analysis/page-16#bias","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"bollingerBandWidth","url":"/reference/totalfinance/technical-analysis/page-16#bollingerBandWidth","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).standardDeviation explain explain().return.assumptions explain().return.diagnostics ex @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"bollingerPercentB","url":"/reference/totalfinance/technical-analysis/page-16#bollingerPercentB","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).standardDeviation explain explain().return.assumptions explain().return.diagnostics ex @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"bookImbalance","url":"/reference/totalfinance/technical-analysis/page-16#bookImbalance","description":"Plain imbalance; use `.explain()` for effective depth, weighting, and null diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"bop","url":"/reference/totalfinance/technical-analysis/page-16#bop","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"brar","url":"/reference/totalfinance/technical-analysis/page-16#brar","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"breakouts","url":"/reference/totalfinance/technical-analysis/page-16#breakouts","description":"Breakout signal aligned to the input: at each bar, `+1` if the close exceeds the highest high of\nthe prior `lookback` bars, `−1` if it breaks below the lowest l","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (options) (options).lookback return.assumptions return.assumptions.conventionsVersion return.assumptions.lookback return.diagnostics  @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"candleAverage","url":"/reference/totalfinance/technical-analysis/page-16#candleAverage","description":"TA-Lib's `TA_CANDLEAVERAGE` at every bar: `factor · (avg of `range` over the preceding `averagePeriod`\nbars) / denom`, where `denom = 2` for the Shadows range t","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (setting) (setting).averagePeriod (setting).factor (setting).range @insiderfinance/totalfinance/technical-analysis/candle-talib"},{"title":"candleColor","url":"/reference/totalfinance/technical-analysis/page-16#candleColor","description":"Candle color: +1 white (close ≥ open), −1 black.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bar) (bar).close (bar).high (bar).low (bar).open (bar).volume @insiderfinance/totalfinance/technical-analysis/candle-talib"},{"title":"candleRange","url":"/reference/totalfinance/technical-analysis/page-16#candleRange","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/transforms"},{"title":"candlestickNames","url":"/reference/totalfinance/technical-analysis/page-16#candlestickNames","description":"Names of every catalogued candlestick pattern.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"value","keywords":"@insiderfinance/totalfinance/technical-analysis value   @insiderfinance/totalfinance/technical-analysis/candlesticks"},{"title":"candlesticks","url":"/reference/totalfinance/technical-analysis/page-17#candlesticks","description":"All candlestick patterns, keyed by name → an aligned batch+stream indicator emitting ±100 / 0.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"value","keywords":"@insiderfinance/totalfinance/technical-analysis value   @insiderfinance/totalfinance/technical-analysis/candlesticks"},{"title":"cci","url":"/reference/totalfinance/technical-analysis/page-17#cci","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"cdlClosingMarubozuTalib","url":"/reference/totalfinance/technical-analysis/page-17#cdlClosingMarubozuTalib","description":"CDLCLOSINGMARUBOZU (TA-Lib): a long real body where the shadow on the *close* side is shorter than\n`ShadowVeryShort` (the open-side shadow is unconstrained) → ±","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) @insiderfinance/totalfinance/technical-analysis/candle-talib"},{"title":"cdlDoji","url":"/reference/totalfinance/technical-analysis/page-17#cdlDoji","description":"Dedicated Doji pattern accessor (pandas-ta `cdl_doji`).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/candle-aliases"},{"title":"cdlDojiTalib","url":"/reference/totalfinance/technical-analysis/page-17#cdlDojiTalib","description":"CDLDOJI (TA-Lib): +100 when the real body is no larger than `BodyDoji`'s adaptive threshold (a\nfraction of the trailing high-low average), else 0. Doji is non-d","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) @insiderfinance/totalfinance/technical-analysis/candle-talib"},{"title":"cdlInside","url":"/reference/totalfinance/technical-analysis/page-17#cdlInside","description":"Inside-bar pattern (TA-Lib `CDLINSIDE`): +100 bullish inside, −100 bearish inside, else 0.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/candle-aliases"},{"title":"cdlMarubozuTalib","url":"/reference/totalfinance/technical-analysis/page-17#cdlMarubozuTalib","description":"CDLMARUBOZU (TA-Lib): a long real body (`BodyLong`) with both shadows shorter than the\n`ShadowVeryShort` threshold → ±100 by candle color (white +100, black −10","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) @insiderfinance/totalfinance/technical-analysis/candle-talib"},{"title":"cdlPattern","url":"/reference/totalfinance/technical-analysis/page-17#cdlPattern","description":"Run a single candlestick pattern by TotalFinance or TA-Lib name, returning the aligned ±100/0 series.\nPass `'all'` to scan the full catalog (returns per-bar mat","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (name) @insiderfinance/totalfinance/technical-analysis/candle-aliases"},{"title":"cdlZ","url":"/reference/totalfinance/technical-analysis/page-17#cdlZ","description":"pandas-ta `cdl_z`: rolling sample z-score normalization of OHLC candles.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).ddof (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().retur @insiderfinance/totalfinance/technical-analysis/candle-aliases"},{"title":"ceil","url":"/reference/totalfinance/technical-analysis/page-17#ceil","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"centerOfGravity","url":"/reference/totalfinance/technical-analysis/page-17#centerOfGravity","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"centralPivotRange","url":"/reference/totalfinance/technical-analysis/page-17#centralPivotRange","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"cfo","url":"/reference/totalfinance/technical-analysis/page-17#cfo","description":"Chande Forecast Oscillator: % distance of price from its linear-regression value.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"chaikinMoneyFlow","url":"/reference/totalfinance/technical-analysis/page-17#chaikinMoneyFlow","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"chaikinOscillator","url":"/reference/totalfinance/technical-analysis/page-17#chaikinOscillator","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).fast (parameters).slow explain explain().return.assumptions explain().return.diagnostics explain().return. @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"chaikinVolatility","url":"/reference/totalfinance/technical-analysis/page-17#chaikinVolatility","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).rocPeriod explain explain().return.assumptions explain().return.diagnostics explain(). @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"chandeKrollStop","url":"/reference/totalfinance/technical-analysis/page-17#chandeKrollStop","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).atrPeriod (parameters).multiplier (parameters).period explain explain().return.assumptions explain().retur @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"chandelierExit","url":"/reference/totalfinance/technical-analysis/page-17#chandelierExit","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).multiplier (parameters).period explain explain().return.assumptions explain().return.diagnostics explain() @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"change","url":"/reference/totalfinance/technical-analysis/page-17#change","description":"Alias of `diff`.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"channel","url":"/reference/totalfinance/technical-analysis/page-17#channel","description":"The trendline pair as a channel; `support`/`resistance` are the channel rails.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (options) (options).strength return.assumptions return.assumptions.conventionsVersion return.assumptions.strength return.diagnostics  @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"charts","url":"/reference/totalfinance/technical-analysis/page-18#charts","description":"Chart-construction group: alternative chart types built from OHLC bars.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"value","keywords":"@insiderfinance/totalfinance/technical-analysis value  dollarBars dollarBars(bars) dollarBars(parameters) dollarBars(parameters).dollar dollarBars(parameters).flush dollarImbalanceBars dollarImba"},{"title":"checkSnapshotVersion","url":"/reference/totalfinance/technical-analysis/page-18#checkSnapshotVersion","description":"Validate a snapshot's schema version before restoring. A newer version is rejected — this build\ncan't know what changed, so restoring would silently corrupt sta","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (snapshot) (snapshot).kind (snapshot).schemaVersion (snapshot).state @insiderfinance/totalfinance/technical-analysis/framework"},{"title":"choppinessIndex","url":"/reference/totalfinance/technical-analysis/page-18#choppinessIndex","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"cmo","url":"/reference/totalfinance/technical-analysis/page-18#cmo","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).talib explain explain().return.assumptions explain().return.diagnostics explain().retu @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"collectAsync","url":"/reference/totalfinance/technical-analysis/page-18#collectAsync","description":"Drain an async iterable through a stream into an aligned series (NaN sentinel during warmup).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (nan) (source) (stream) (stream).next (stream).toJSON (stream).value @insiderfinance/totalfinance/technical-analysis/framework"},{"title":"columnsFromBars","url":"/reference/totalfinance/technical-analysis/page-18#columnsFromBars","description":"Convert bar rows back into columnar arrays (only columns present on the first bar are emitted).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) return.close return.high return.low return.open return.volume"},{"title":"compatibilityMatrixMarkdown","url":"/reference/totalfinance/technical-analysis/page-18#compatibilityMatrixMarkdown","description":"Render the TotalFinance ↔ TA-Lib ↔ pandas-ta ↔ TradingView name map as a Markdown matrix.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function   @insiderfinance/totalfinance/technical-analysis/aliases"},{"title":"condition","url":"/reference/totalfinance/technical-analysis/page-18#condition","description":"Build a custom condition. `refs` are the column aliases / `alias.field` / raw OHLCV fields the\npredicate reads via `context.get(...)` — they are validated up fr","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (predicate) (refs) return.refs @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"connorsRsi","url":"/reference/totalfinance/technical-analysis/page-18#connorsRsi","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).rankPeriod (parameters).rsiPeriod (parameters).streakPeriod explain explain().return.assumptions explain() @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"coppock","url":"/reference/totalfinance/technical-analysis/page-18#coppock","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).longRoc (parameters).shortRoc (parameters).wma explain explain().return.assumptions explain().return.diagn @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"correl","url":"/reference/totalfinance/technical-analysis/page-18#correl","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"cos","url":"/reference/totalfinance/technical-analysis/page-18#cos","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"cosh","url":"/reference/totalfinance/technical-analysis/page-18#cosh","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"covariance","url":"/reference/totalfinance/technical-analysis/page-18#covariance","description":"Rolling covariance of a paired series (sample denominator by default).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).sample explain explain().return.assumptions explain().return.diagnostics explain().ret @insiderfinance/totalfinance/technical-analysis/features"},{"title":"crossOver","url":"/reference/totalfinance/technical-analysis/page-18#crossOver","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (first) (second) return.refs @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"crossSignals","url":"/reference/totalfinance/technical-analysis/page-18#crossSignals","description":"Cross-based long/flat state machine: enter when the series crosses above `above`, exit below `below`.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).above (parameters).below explain explain().return.assumptions explain().return.diagnostics explain().retur @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"crossUnder","url":"/reference/totalfinance/technical-analysis/page-18#crossUnder","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (first) (second) return.refs @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"crossany","url":"/reference/totalfinance/technical-analysis/page-18#crossany","description":"1 on the bar where `x` crosses either above or below `y`, else 0.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"crossover","url":"/reference/totalfinance/technical-analysis/page-18#crossover","description":"1 on the bar where `x` crosses above `y`, else 0.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"cti","url":"/reference/totalfinance/technical-analysis/page-18#cti","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"cumulativeSum","url":"/reference/totalfinance/technical-analysis/page-19#cumulativeSum","description":"Running cumulative sum.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/features"},{"title":"cumulativeVolumeDelta","url":"/reference/totalfinance/technical-analysis/page-19#cumulativeVolumeDelta","description":"Batch cumulative volume delta over a trade tape.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (parameters) (parameters).method (parameters).quotes (trades) return.assumptions return.assumptions.conventionsVersion return.assumptions.me @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"cvd","url":"/reference/totalfinance/technical-analysis/page-19#cvd","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"decreasing","url":"/reference/totalfinance/technical-analysis/page-19#decreasing","description":"1 when the series is lower than `period` bars ago (strict → every step fell).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).strict explain explain().return.assumptions explain().return.diagnostics explain().ret @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"defineIndicator","url":"/reference/totalfinance/technical-analysis/page-19#defineIndicator","description":"Build an aligned batch+stream indicator and register it. Returns the facade.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (definition) (definition).category (definition).conventions (definition).defaults (definition).inputs (definition).name (definition).nan (de @insiderfinance/totalfinance/technical-analysis/registry"},{"title":"dema","url":"/reference/totalfinance/technical-analysis/page-19#dema","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"describeIndicator","url":"/reference/totalfinance/technical-analysis/page-19#describeIndicator","description":"One indicator's full metadata card (alias-aware): category, input kind, parameters, defaults, which are\nrequired, its warmup, and its cross-library aliases. Thr","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (name) (probeLength) return.aliases return.aliases.pandas return.aliases.talib return.aliases.tradingview return.category return.conventions"},{"title":"detectCandles","url":"/reference/totalfinance/technical-analysis/page-19#detectCandles","description":"Scan bars with the whole catalog, returning the matched patterns (non-zero signal) at each bar.\nIndex `i` of the result lists patterns that complete on bar `i`.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) @insiderfinance/totalfinance/technical-analysis/candlesticks"},{"title":"difference","url":"/reference/totalfinance/technical-analysis/page-19#difference","description":"Discrete difference: `input[i] − input[i − period]`.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"div","url":"/reference/totalfinance/technical-analysis/page-19#div","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"divergence","url":"/reference/totalfinance/technical-analysis/page-19#divergence","description":"The `divergence` indicator (registry name `divergence`, category `price-action`): a streaming\nprice/indicator divergence detector. Input is a `{ x: price, y: in","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).kinds (parameters).swing explain explain().return.assumptions explain().return.diagnostics explain().retur @insiderfinance/totalfinance/technical-analysis/divergence"},{"title":"divergences","url":"/reference/totalfinance/technical-analysis/page-19#divergences","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (input).indicator (input).parameters (input).price @insiderfinance/totalfinance/technical-analysis/divergence"},{"title":"dmi","url":"/reference/totalfinance/technical-analysis/page-19#dmi","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"dollarBars","url":"/reference/totalfinance/technical-analysis/page-19#dollarBars","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (parameters) (parameters).dollar (parameters).flush @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"dollarImbalanceBars","url":"/reference/totalfinance/technical-analysis/page-19#dollarImbalanceBars","description":"Dollar imbalance bars — signed dollar value `|Σ sign(Δclose)·close·volume|`.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (parameters) (parameters).flush (parameters).threshold @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"dollarRunBars","url":"/reference/totalfinance/technical-analysis/page-19#dollarRunBars","description":"Dollar run bars — close on the larger one-sided dollar run.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (parameters) (parameters).flush (parameters).threshold @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"donchian","url":"/reference/totalfinance/technical-analysis/page-19#donchian","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"donchianTrend","url":"/reference/totalfinance/technical-analysis/page-19#donchianTrend","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"dpo","url":"/reference/totalfinance/technical-analysis/page-19#dpo","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"drawdown","url":"/reference/totalfinance/technical-analysis/page-19#drawdown","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/features"},{"title":"dsp","url":"/reference/totalfinance/technical-analysis/page-20#dsp","description":"Detrended Synthetic Price: `close - EMA(close, period)` (pandas-ta `dsp`).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"dx","url":"/reference/totalfinance/technical-analysis/page-20#dx","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"easeOfMovement","url":"/reference/totalfinance/technical-analysis/page-20#easeOfMovement","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).scale explain explain().return.assumptions explain().return.diagnostics explain().retu @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"ebsw","url":"/reference/totalfinance/technical-analysis/page-20#ebsw","description":"Even Better Sinewave (pandas-ta `ebsw`), bounded roughly to [-1, 1].\n\nMatches pandas-ta **including its degree/radian translation defect** — it is not Ehlers's ","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).bars (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().retur @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"efficiencyRatio","url":"/reference/totalfinance/technical-analysis/page-20#efficiencyRatio","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"efi","url":"/reference/totalfinance/technical-analysis/page-20#efi","description":"Elder's Force Index (alias of `forceIndex`).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"elderRay","url":"/reference/totalfinance/technical-analysis/page-20#elderRay","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"elderThermometer","url":"/reference/totalfinance/technical-analysis/page-20#elderThermometer","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).long (parameters).period (parameters).short explain explain().return.assumptions explain().return.diagnost @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"ema","url":"/reference/totalfinance/technical-analysis/page-20#ema","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"emv","url":"/reference/totalfinance/technical-analysis/page-20#emv","description":"Ease of Movement (alias of `easeOfMovement`).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).scale explain explain().return.assumptions explain().return.diagnostics explain().retu @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"entropy","url":"/reference/totalfinance/technical-analysis/page-20#entropy","description":"Rolling Shannon entropy (pandas-ta: each value as a fraction of the window sum), in bits.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"equalHighs","url":"/reference/totalfinance/technical-analysis/page-20#equalHighs","description":"Equal highs — consecutive swing highs within `tolerance` (a buy-side liquidity pool).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).strength (parameters).tolerance explain explain().return.assumptions explain().return.diagnostics explain( @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"equalLows","url":"/reference/totalfinance/technical-analysis/page-20#equalLows","description":"Equal lows — consecutive swing lows within `tolerance` (a sell-side liquidity pool).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).strength (parameters).tolerance explain explain().return.assumptions explain().return.diagnostics explain( @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"exp","url":"/reference/totalfinance/technical-analysis/page-20#exp","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"exponentialDecay","url":"/reference/totalfinance/technical-analysis/page-20#exponentialDecay","description":"Exponential decay floor — same shape, with an `exp(−period)` step (decays far more slowly).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"fairValueGaps","url":"/reference/totalfinance/technical-analysis/page-20#fairValueGaps","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).minimumGapPercent explain explain().return.assumptions explain().return.diagnostics explain().return.diagn @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"falling","url":"/reference/totalfinance/technical-analysis/page-20#falling","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (operand) return.refs @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"features","url":"/reference/totalfinance/technical-analysis/page-20#features","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (candles) return.applyBars return.applySeries return.atr return.bbands return.column return.ema return.field return.macd return.obv return.r @insiderfinance/totalfinance/technical-analysis/pipeline"},{"title":"fibExtension","url":"/reference/totalfinance/technical-analysis/page-20#fibExtension","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (input).end (input).levels (input).projectFrom (input).start @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"fibRetracement","url":"/reference/totalfinance/technical-analysis/page-20#fibRetracement","description":"Fibonacci retracement levels for a move from `start` (origin / 100% line) to `end` (extreme / 0%\nline): `price(r) = end + (start − end)·r`. Direction-agnostic —","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (end) (levels) (start) @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"fisherTransform","url":"/reference/totalfinance/technical-analysis/page-21#fisherTransform","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"floor","url":"/reference/totalfinance/technical-analysis/page-21#floor","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"footprintBars","url":"/reference/totalfinance/technical-analysis/page-21#footprintBars","description":"Aggregate a trade tape into OHLCV bars annotated with the aggressor footprint (buy/sell volume and\ndelta), bucketing by trade `count`, cumulative `volume`, or `","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (parameters) (parameters).by (parameters).method (parameters).quotes (parameters).threshold (trades) @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"forceIndex","url":"/reference/totalfinance/technical-analysis/page-21#forceIndex","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"forecastOscillator","url":"/reference/totalfinance/technical-analysis/page-21#forecastOscillator","description":"Forecast Oscillator: % distance of price from its time-series forecast (one bar ahead).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"fractals","url":"/reference/totalfinance/technical-analysis/page-21#fractals","description":"Bill Williams fractals: a 5-bar swing (strength 2).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) return.assumptions return.assumptions.conventionsVersion return.assumptions.strength return.diagnostics return.diagnostics.warnings r @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"fractionalChange","url":"/reference/totalfinance/technical-analysis/page-21#fractionalChange","description":"Fractional change: `(input[i] − input[i − period]) / input[i − period]`.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"frama","url":"/reference/totalfinance/technical-analysis/page-21#frama","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"fwma","url":"/reference/totalfinance/technical-analysis/page-21#fwma","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"gannHighLowActivator","url":"/reference/totalfinance/technical-analysis/page-21#gannHighLowActivator","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"gap","url":"/reference/totalfinance/technical-analysis/page-21#gap","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/transforms"},{"title":"gapFill","url":"/reference/totalfinance/technical-analysis/page-21#gapFill","description":"Opening gaps with fill tracking: the same events {@link gaps} detects, plus whether and when each\none closed. A gap fills when a later bar trades back to the pr","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (options) (options).minSizeFraction return.assumptions return.assumptions.conventionsVersion return.assumptions.minSizeFraction retur @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"gaps","url":"/reference/totalfinance/technical-analysis/page-21#gaps","description":"Opening gaps: this bar's open leaves the prior bar's RANGE (above its high or below its low).\n`sizeFraction` is measured from the prior CLOSE — the level a fill","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (options) (options).minSizeFraction return.assumptions return.assumptions.conventionsVersion return.assumptions.minSizeFraction retur @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"garmanKlass","url":"/reference/totalfinance/technical-analysis/page-21#garmanKlass","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).annualization (parameters).period explain explain().return.assumptions explain().return.diagnostics explai @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"getIndicator","url":"/reference/totalfinance/technical-analysis/page-21#getIndicator","description":"The registered entry for `name`, or `undefined`.\n\nThe result is DEEPLY FROZEN. It is a view of the registry, not a copy to edit: mutating it used to\nreach the f","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (name) return.category return.conventions return.defaults return.indicator return.indicator.explain return.indicator.fromJSON return.indicat @insiderfinance/totalfinance/technical-analysis/registry"},{"title":"gt","url":"/reference/totalfinance/technical-analysis/page-21#gt","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (left) (right) return.refs @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"gte","url":"/reference/totalfinance/technical-analysis/page-21#gte","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (left) (right) return.refs @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"hasIndicator","url":"/reference/totalfinance/technical-analysis/page-21#hasIndicator","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (name) @insiderfinance/totalfinance/technical-analysis/registry"},{"title":"heikinAshi","url":"/reference/totalfinance/technical-analysis/page-21#heikinAshi","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/chart-types @insiderfinance/totalfinance/technical-analysis/transforms"},{"title":"highestBars","url":"/reference/totalfinance/technical-analysis/page-21#highestBars","description":"Bars-ago of the rolling window high (alias of `rollingMaxIndex`).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"historicalVolatility","url":"/reference/totalfinance/technical-analysis/page-22#historicalVolatility","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).annualization (parameters).period explain explain().return.assumptions explain().return.diagnostics explai @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"hl2","url":"/reference/totalfinance/technical-analysis/page-22#hl2","description":"(high + low) / 2 — alias of `medianPrice`.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"hlc3","url":"/reference/totalfinance/technical-analysis/page-22#hlc3","description":"(high + low + close) / 3 — alias of `typicalPrice`.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"hma","url":"/reference/totalfinance/technical-analysis/page-22#hma","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"holtWinterChannel","url":"/reference/totalfinance/technical-analysis/page-22#holtWinterChannel","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).accelerationSmoothing (parameters).levelSmoothing (parameters).scalar (parameters).trendSmoothing (paramet @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"holtWinterMovingAverage","url":"/reference/totalfinance/technical-analysis/page-22#holtWinterMovingAverage","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).accelerationSmoothing (parameters).levelSmoothing (parameters).trendSmoothing explain explain().return.ass @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"htDcPeriod","url":"/reference/totalfinance/technical-analysis/page-22#htDcPeriod","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"htDcPhase","url":"/reference/totalfinance/technical-analysis/page-22#htDcPhase","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"htPhasor","url":"/reference/totalfinance/technical-analysis/page-22#htPhasor","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"htSine","url":"/reference/totalfinance/technical-analysis/page-22#htSine","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"htTrendMode","url":"/reference/totalfinance/technical-analysis/page-22#htTrendMode","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"htTrendline","url":"/reference/totalfinance/technical-analysis/page-22#htTrendline","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"ichimoku","url":"/reference/totalfinance/technical-analysis/page-22#ichimoku","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).base (parameters).conversion (parameters).displacement (parameters).spanB explain explain().return.assumpt @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"imbalanceBars","url":"/reference/totalfinance/technical-analysis/page-22#imbalanceBars","description":"Tick imbalance bars — close on `|Σ sign(Δclose)|`.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (parameters) (parameters).flush (parameters).threshold @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"increasing","url":"/reference/totalfinance/technical-analysis/page-22#increasing","description":"1 when the series is higher than `period` bars ago (strict → every step rose).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).strict explain explain().return.assumptions explain().return.diagnostics explain().ret @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"indicatorCategories","url":"/reference/totalfinance/technical-analysis/page-22#indicatorCategories","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function   @insiderfinance/totalfinance/technical-analysis/registry"},{"title":"indicatorWarmup","url":"/reference/totalfinance/technical-analysis/page-22#indicatorWarmup","description":"The warmup of a SINGLE indicator (alias-aware name), measured on a probe series — the targeted\ncounterpart to {@link indicatorWarmups} for a `describe`-style lo","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (name) (probeLength) return.category return.inputs return.name return.parameters return.warmup @insiderfinance/totalfinance/technical-analysis/warmup"},{"title":"indicatorWarmups","url":"/reference/totalfinance/technical-analysis/page-22#indicatorWarmups","description":"Measure the warmup of every registered indicator at canonical parameters. `probeLength` must\nexceed the longest warmup (default 512 comfortably covers the catal","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (probeLength) @insiderfinance/totalfinance/technical-analysis/warmup"},{"title":"inertia","url":"/reference/totalfinance/technical-analysis/page-22#inertia","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).rviPeriod explain explain().return.assumptions explain().return.diagnostics explain(). @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"jma","url":"/reference/totalfinance/technical-analysis/page-22#jma","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).phase (parameters).power explain explain().return.assumptions explain().return.diagnos @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"kagi","url":"/reference/totalfinance/technical-analysis/page-23#kagi","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (parameters) (parameters).percent (parameters).reversal @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"kama","url":"/reference/totalfinance/technical-analysis/page-23#kama","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).fast (parameters).period (parameters).slow explain explain().return.assumptions explain().return.diagnosti @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"kdj","url":"/reference/totalfinance/technical-analysis/page-23#kdj","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).signal explain explain().return.assumptions explain().return.diagnostics explain().ret @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"keltner","url":"/reference/totalfinance/technical-analysis/page-23#keltner","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).atrPeriod (parameters).multiplier (parameters).period explain explain().return.assumptions explain().retur @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"klinger","url":"/reference/totalfinance/technical-analysis/page-23#klinger","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).fast (parameters).signal (parameters).slow explain explain().return.assumptions explain().return.diagnosti @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"kst","url":"/reference/totalfinance/technical-analysis/page-23#kst","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).rocPeriods (parameters).signal (parameters).smaPeriods explain explain().return.assumptions explain().retu @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"kurtosis","url":"/reference/totalfinance/technical-analysis/page-23#kurtosis","description":"Rolling sample excess kurtosis (bias-corrected G2).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"kvo","url":"/reference/totalfinance/technical-analysis/page-23#kvo","description":"Klinger Volume Oscillator (alias of `klinger`).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).fast (parameters).signal (parameters).slow explain explain().return.assumptions explain().return.diagnosti @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"lag","url":"/reference/totalfinance/technical-analysis/page-23#lag","description":"Alias of `shift` (causal lag; leading is not possible in a streaming model).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"laguerreRsi","url":"/reference/totalfinance/technical-analysis/page-23#laguerreRsi","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).gamma explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoR @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"lineAt","url":"/reference/totalfinance/technical-analysis/page-23#lineAt","description":"Evaluate a fitted line (price = intercept + slope·index) at a bar index.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (index) (line) (line).from (line).intercept (line).slope (line).to @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"lineBreak","url":"/reference/totalfinance/technical-analysis/page-23#lineBreak","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (parameters) (parameters).lines @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"linearDecay","url":"/reference/totalfinance/technical-analysis/page-23#linearDecay","description":"Linear decay floor — the series may rise freely but falls no faster than `1/period` per bar.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"linreg","url":"/reference/totalfinance/technical-analysis/page-23#linreg","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"linregAngle","url":"/reference/totalfinance/technical-analysis/page-23#linregAngle","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"linregIntercept","url":"/reference/totalfinance/technical-analysis/page-23#linregIntercept","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"linregSlope","url":"/reference/totalfinance/technical-analysis/page-23#linregSlope","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"liquiditySweeps","url":"/reference/totalfinance/technical-analysis/page-23#liquiditySweeps","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).lookback explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.au @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"listIndicators","url":"/reference/totalfinance/technical-analysis/page-23#listIndicators","description":"Every registered indicator (optionally one category). The ARRAY is fresh; the entries are frozen.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (category) @insiderfinance/totalfinance/technical-analysis/registry"},{"title":"ln","url":"/reference/totalfinance/technical-analysis/page-23#ln","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"log10","url":"/reference/totalfinance/technical-analysis/page-24#log10","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"logReturns","url":"/reference/totalfinance/technical-analysis/page-24#logReturns","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/series"},{"title":"longRun","url":"/reference/totalfinance/technical-analysis/page-24#longRun","description":"1 when fast (`x`) and slow (`y`) are both rising over the lookback — a confirmed up-run.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"lowerShadow","url":"/reference/totalfinance/technical-analysis/page-24#lowerShadow","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/transforms"},{"title":"lowestBars","url":"/reference/totalfinance/technical-analysis/page-24#lowestBars","description":"Bars-ago of the rolling window low (alias of `rollingMinIndex`).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"lt","url":"/reference/totalfinance/technical-analysis/page-24#lt","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (left) (right) return.refs @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"lte","url":"/reference/totalfinance/technical-analysis/page-24#lte","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (left) (right) return.refs @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"macd","url":"/reference/totalfinance/technical-analysis/page-24#macd","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).fast (parameters).signal (parameters).slow explain explain().return.assumptions explain().return.diagnosti @insiderfinance/totalfinance/technical-analysis/macd @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"macdExt","url":"/reference/totalfinance/technical-analysis/page-24#macdExt","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).fast (parameters).fastMovingAverageType (parameters).signal (parameters).signalMovingAverageType (paramete @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"macdFix","url":"/reference/totalfinance/technical-analysis/page-24#macdFix","description":"MACDFIX — fixed 12/26 EMA MACD with a configurable signal period (TA-Lib MACDFIX).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).signal explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"mama","url":"/reference/totalfinance/technical-analysis/page-24#mama","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).fastLimit (parameters).slowLimit explain explain().return.assumptions explain().return.diagnostics explain @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"marketFacilitationIndex","url":"/reference/totalfinance/technical-analysis/page-24#marketFacilitationIndex","description":"Bill Williams Market Facilitation Index — (high − low) / volume.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"marketStructure","url":"/reference/totalfinance/technical-analysis/page-24#marketStructure","description":"Label the swing sequence (HH/HL/LH/LL) and flag breaks of structure. A higher-high while already\nbullish is a continuation (BOS); a higher-high that reverses a ","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (options) (options).strength return.assumptions return.assumptions.conventionsVersion return.assumptions.strength return.diagnostics  @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"massIndex","url":"/reference/totalfinance/technical-analysis/page-24#massIndex","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).fast (parameters).slow explain explain().return.assumptions explain().return.diagnostics explain().return. @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"mavp","url":"/reference/totalfinance/technical-analysis/page-24#mavp","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (input).parameters (input).periods (input).series @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"mcginley","url":"/reference/totalfinance/technical-analysis/page-24#mcginley","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"medianPrice","url":"/reference/totalfinance/technical-analysis/page-24#medianPrice","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/transforms"},{"title":"mfi","url":"/reference/totalfinance/technical-analysis/page-24#mfi","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"microprice","url":"/reference/totalfinance/technical-analysis/page-24#microprice","description":"Plain microprice; use `.explain()` for null/fallback diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (input).asks (input).bids explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().re @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"midpoint","url":"/reference/totalfinance/technical-analysis/page-24#midpoint","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"midprice","url":"/reference/totalfinance/technical-analysis/page-25#midprice","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"minusDI","url":"/reference/totalfinance/technical-analysis/page-25#minusDI","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"minusDM","url":"/reference/totalfinance/technical-analysis/page-25#minusDM","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"momentum","url":"/reference/totalfinance/technical-analysis/page-25#momentum","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"movingAverage","url":"/reference/totalfinance/technical-analysis/page-25#movingAverage","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).movingAverageType (parameters).period explain explain().return.assumptions explain().return.diagnostics ex @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"movingAverageRibbon","url":"/reference/totalfinance/technical-analysis/page-25#movingAverageRibbon","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).periods explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.aut @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"msw","url":"/reference/totalfinance/technical-analysis/page-25#msw","description":"Mesa Sine Wave (pandas-ta/tulipy `msw`).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/cycle"},{"title":"mult","url":"/reference/totalfinance/technical-analysis/page-25#mult","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"natr","url":"/reference/totalfinance/technical-analysis/page-25#natr","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"normalize","url":"/reference/totalfinance/technical-analysis/page-25#normalize","description":"Rolling min-max normalization to [0, 1] (0.5 on a flat window).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"not","url":"/reference/totalfinance/technical-analysis/page-25#not","description":"Logical negation of a condition (carries through the inner condition's refs).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (condition) (condition).refs return.refs @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"nvi","url":"/reference/totalfinance/technical-analysis/page-25#nvi","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"obv","url":"/reference/totalfinance/technical-analysis/page-25#obv","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).talib explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoR @insiderfinance/totalfinance/technical-analysis/bars"},{"title":"ohlc4","url":"/reference/totalfinance/technical-analysis/page-25#ohlc4","description":"(open + high + low + close) / 4 — alias of `averagePrice`.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"ohlcvFromBars","url":"/reference/totalfinance/technical-analysis/page-25#ohlcvFromBars","description":"Explicitly project core Bar records to OHLCV indicator rows. Source identity, timestamps,\nadjustment flags and caller provenance remain in the original records:","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars)"},{"title":"openingRange","url":"/reference/totalfinance/technical-analysis/page-25#openingRange","description":"High/low of the first `periods` bars — the opening range.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (options) (options).periods return.assumptions return.assumptions.conventionsVersion return.assumptions.periods return.diagnostics re @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"openingRangeBreakout","url":"/reference/totalfinance/technical-analysis/page-25#openingRangeBreakout","description":"Opening-range breakout signal aligned to the input: `0` within the opening range, then `+1` on the\nfirst close above the range high, `−1` below the range low (N","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (options) (options).periods @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"orbRetest","url":"/reference/totalfinance/technical-analysis/page-25#orbRetest","description":"Opening-range retest aligned to the input: after a close breaks the range, `+1` on the first bar\nthat pulls back to touch the range high (a retest of an up-brea","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (options) (options).periods @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"orderBlocks","url":"/reference/totalfinance/technical-analysis/page-25#orderBlocks","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).lookback explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.au @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"orderBookImbalance","url":"/reference/totalfinance/technical-analysis/page-25#orderBookImbalance","description":"Plain single-level imbalance; use `.explain()` for zero-depth diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (input).askSize (input).bidSize explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explai @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"pMax","url":"/reference/totalfinance/technical-analysis/page-26#pMax","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).multiplier (parameters).period explain explain().return.assumptions explain().return.diagnostics explain() @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"pairs","url":"/reference/totalfinance/technical-analysis/page-26#pairs","description":"Zip two equal-length series into the `Pair[]` that `beta` / `correl` consume. Throws on a length\nmismatch — silent truncation would mask a benchmark/asset align","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (x) (y) @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"parkinson","url":"/reference/totalfinance/technical-analysis/page-26#parkinson","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).annualization (parameters).period explain explain().return.assumptions explain().return.diagnostics explai @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"pascalWma","url":"/reference/totalfinance/technical-analysis/page-26#pascalWma","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"percentAtr","url":"/reference/totalfinance/technical-analysis/page-26#percentAtr","description":"ATR as a percent of close (a.k.a. ATRP).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"percentRank","url":"/reference/totalfinance/technical-analysis/page-26#percentRank","description":"Rolling percentile position of the current value within the window, in [0, 100].","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"pgo","url":"/reference/totalfinance/technical-analysis/page-26#pgo","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"pivots","url":"/reference/totalfinance/technical-analysis/page-26#pivots","description":"Pivot levels for the next period from a prior period's OHLC.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bar) (bar).close (bar).high (bar).low (bar).open (bar).volume (method) return.assumptions return.assumptions.conventionsVersion return.assu @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"plusDI","url":"/reference/totalfinance/technical-analysis/page-26#plusDI","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"plusDM","url":"/reference/totalfinance/technical-analysis/page-26#plusDM","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"pointAndFigure","url":"/reference/totalfinance/technical-analysis/page-26#pointAndFigure","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (parameters) (parameters).boxSize (parameters).reversal @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"ppo","url":"/reference/totalfinance/technical-analysis/page-26#ppo","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).fast (parameters).signal (parameters).slow explain explain().return.assumptions explain().return.diagnosti @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"previousSessionLevels","url":"/reference/totalfinance/technical-analysis/page-26#previousSessionLevels","description":"For each bar, the high/low/close of the PRIOR session (the fully-completed session before the bar's\nown). `sessionIds[i]` groups bars (bars carry no timestamp, ","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (sessionIds) @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"priceAction","url":"/reference/totalfinance/technical-analysis/page-26#priceAction","description":"Price-action group: swings, structure, ranges, and level detection.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"value","keywords":"@insiderfinance/totalfinance/technical-analysis value  breakouts breakouts().return.assumptions breakouts().return.assumptions.conventionsVersion breakouts().return.assumptions.lookback breakouts"},{"title":"priceDistance","url":"/reference/totalfinance/technical-analysis/page-26#priceDistance","description":"Price Distance — 2·(H−L) + |open − close[drift]| − |close − open|.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).drift explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoR @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"priceVolume","url":"/reference/totalfinance/technical-analysis/page-26#priceVolume","description":"Price · Volume — close × volume, optionally signed by the close-to-close direction.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).signed explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"priceVolumeRank","url":"/reference/totalfinance/technical-analysis/page-26#priceVolumeRank","description":"Price Volume Rank — 1: price↑ & volume↑, 2: price↑ & volume↓, 3: price↓ & volume↑,\n4: price↓ & volume↓ (ties count as \"down\").","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"projectionOscillator","url":"/reference/totalfinance/technical-analysis/page-26#projectionOscillator","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"psar","url":"/reference/totalfinance/technical-analysis/page-26#psar","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).max (parameters).step explain explain().return.assumptions explain().return.diagnostics explain().return.d @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"psarExt","url":"/reference/totalfinance/technical-analysis/page-26#psarExt","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).accelInitLong (parameters).accelInitShort (parameters).accelLong (parameters).accelMaxLong (parameters).ac @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"psychologicalLine","url":"/reference/totalfinance/technical-analysis/page-27#psychologicalLine","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"pvi","url":"/reference/totalfinance/technical-analysis/page-27#pvi","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"pvo","url":"/reference/totalfinance/technical-analysis/page-27#pvo","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).fast (parameters).signal (parameters).slow explain explain().return.assumptions explain().return.diagnosti @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"pvt","url":"/reference/totalfinance/technical-analysis/page-27#pvt","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"qqe","url":"/reference/totalfinance/technical-analysis/page-27#qqe","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).factor (parameters).rsiPeriod (parameters).smooth explain explain().return.assumptions explain().return.di @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"qstick","url":"/reference/totalfinance/technical-analysis/page-27#qstick","description":"Q Stick — SMA of (close − open); positive = bullish bodies dominate.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"rSquared","url":"/reference/totalfinance/technical-analysis/page-27#rSquared","description":"Rolling R² (squared Pearson correlation) of a paired series.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"rainbowMovingAverage","url":"/reference/totalfinance/technical-analysis/page-27#rainbowMovingAverage","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).levels (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().ret @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"rangeBars","url":"/reference/totalfinance/technical-analysis/page-27#rangeBars","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (parameters) (parameters).flush (parameters).size @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"readSnapshot","url":"/reference/totalfinance/technical-analysis/page-27#readSnapshot","description":"Validate a snapshot envelope and open its state for checked reading.\n\n`expected` is the kind the CALLING restorer produces. Passing it is what turns a restorer ","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (expected) (snapshot) (snapshot).kind (snapshot).schemaVersion (snapshot).state return.boolean return.cached return.child return.children re @insiderfinance/totalfinance/technical-analysis/framework"},{"title":"realBody","url":"/reference/totalfinance/technical-analysis/page-27#realBody","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/transforms"},{"title":"realizedVolatility","url":"/reference/totalfinance/technical-analysis/page-27#realizedVolatility","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).annualization (parameters).period explain explain().return.assumptions explain().return.diagnostics explai @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"register","url":"/reference/totalfinance/technical-analysis/page-27#register","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (entry) (entry).category (entry).conventions (entry).defaults (entry).indicator (entry).indicator.explain (entry).indicator.fromJSON (entry) @insiderfinance/totalfinance/technical-analysis/registry"},{"title":"registryMarkdown","url":"/reference/totalfinance/technical-analysis/page-27#registryMarkdown","description":"Render the registry as a Markdown reference table, grouped by category.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function   @insiderfinance/totalfinance/technical-analysis/registry"},{"title":"relativeVigorIndex","url":"/reference/totalfinance/technical-analysis/page-27#relativeVigorIndex","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"relativeVolatilityIndex","url":"/reference/totalfinance/technical-analysis/page-27#relativeVolatilityIndex","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).stdevPeriod explain explain().return.assumptions explain().return.diagnostics explain( @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"relativeVolume","url":"/reference/totalfinance/technical-analysis/page-27#relativeVolume","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"renko","url":"/reference/totalfinance/technical-analysis/page-27#renko","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (parameters) (parameters).brickSize @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"resample","url":"/reference/totalfinance/technical-analysis/page-27#resample","description":"Resample ascending timestamped bars to a higher timeframe on epoch-aligned buckets. OHLC =\nfirst-open / max-high / min-low / last-close; volume is summed; VWAP ","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (interval) (options) (options).includePartial @insiderfinance/totalfinance/technical-analysis/resample"},{"title":"rescale","url":"/reference/totalfinance/technical-analysis/page-27#rescale","description":"Rolling rescale of the min-max-normalized value into [min, max].","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).max (parameters).min (parameters).period explain explain().return.assumptions explain().return.diagnostics @insiderfinance/totalfinance/technical-analysis/features"},{"title":"resolveCandleName","url":"/reference/totalfinance/technical-analysis/page-28#resolveCandleName","description":"Resolve a TotalFinance or TA-Lib `CDL*` pattern name to the TotalFinance catalog name (throws if unknown).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (name) @insiderfinance/totalfinance/technical-analysis/candle-aliases"},{"title":"resolveIndicator","url":"/reference/totalfinance/technical-analysis/page-28#resolveIndicator","description":"Resolve a name (any convention) to its registered indicator, or `undefined`.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (name) return.category return.conventions return.defaults return.indicator return.indicator.explain return.indicator.fromJSON return.indicat @insiderfinance/totalfinance/technical-analysis/aliases"},{"title":"resolveIndicatorName","url":"/reference/totalfinance/technical-analysis/page-28#resolveIndicatorName","description":"Resolve any TotalFinance / TA-Lib / pandas-ta / TradingView name (case-insensitive) to the canonical\nTotalFinance indicator name. An exact canonical name wins o","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (name) @insiderfinance/totalfinance/technical-analysis/aliases"},{"title":"returns","url":"/reference/totalfinance/technical-analysis/page-28#returns","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/series"},{"title":"rising","url":"/reference/totalfinance/technical-analysis/page-28#rising","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (operand) return.refs @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"rma","url":"/reference/totalfinance/technical-analysis/page-28#rma","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"roc","url":"/reference/totalfinance/technical-analysis/page-28#roc","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"rocp","url":"/reference/totalfinance/technical-analysis/page-28#rocp","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"rocr","url":"/reference/totalfinance/technical-analysis/page-28#rocr","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"rocr100","url":"/reference/totalfinance/technical-analysis/page-28#rocr100","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"rogersSatchell","url":"/reference/totalfinance/technical-analysis/page-28#rogersSatchell","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).annualization (parameters).period explain explain().return.assumptions explain().return.diagnostics explai @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"rollingAnchoredVwap","url":"/reference/totalfinance/technical-analysis/page-28#rollingAnchoredVwap","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).anchor (parameters).lookback explain explain().return.assumptions explain().return.diagnostics explain().r @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"rollingBeta","url":"/reference/totalfinance/technical-analysis/page-28#rollingBeta","description":"Rolling beta vs a benchmark (alias of `beta`).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"rollingCorrelation","url":"/reference/totalfinance/technical-analysis/page-28#rollingCorrelation","description":"Rolling Pearson correlation (alias of `correl`).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"rollingMax","url":"/reference/totalfinance/technical-analysis/page-28#rollingMax","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"rollingMaxIndex","url":"/reference/totalfinance/technical-analysis/page-28#rollingMaxIndex","description":"Bars ago (0 = current bar) of the highest value in the window.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"rollingMean","url":"/reference/totalfinance/technical-analysis/page-28#rollingMean","description":"Rolling mean (alias of `sma`).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"rollingMeanAbsoluteDeviation","url":"/reference/totalfinance/technical-analysis/page-28#rollingMeanAbsoluteDeviation","description":"Rolling mean absolute deviation from the window mean.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"rollingMedian","url":"/reference/totalfinance/technical-analysis/page-28#rollingMedian","description":"Rolling median.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"rollingMin","url":"/reference/totalfinance/technical-analysis/page-28#rollingMin","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"rollingMinIndex","url":"/reference/totalfinance/technical-analysis/page-29#rollingMinIndex","description":"Bars ago (0 = current bar) of the lowest value in the window.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"rollingMinMax","url":"/reference/totalfinance/technical-analysis/page-29#rollingMinMax","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"rollingMinMaxIndex","url":"/reference/totalfinance/technical-analysis/page-29#rollingMinMaxIndex","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"rollingQuantile","url":"/reference/totalfinance/technical-analysis/page-29#rollingQuantile","description":"Rolling quantile (linear interpolation).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).quantile explain explain().return.assumptions explain().return.diagnostics explain().r @insiderfinance/totalfinance/technical-analysis/features"},{"title":"rollingRank","url":"/reference/totalfinance/technical-analysis/page-29#rollingRank","description":"Rolling 1-based ordinal rank of the current value within the window.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"rollingRegression","url":"/reference/totalfinance/technical-analysis/page-29#rollingRegression","description":"Rolling ordinary-least-squares regression of y on x: `{ slope, intercept, rSquared }`.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"rollingSum","url":"/reference/totalfinance/technical-analysis/page-29#rollingSum","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"rollingVolatility","url":"/reference/totalfinance/technical-analysis/page-29#rollingVolatility","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).annualization (parameters).period explain explain().return.assumptions explain().return.diagnostics explai @insiderfinance/totalfinance/technical-analysis/series"},{"title":"rollingVwap","url":"/reference/totalfinance/technical-analysis/page-29#rollingVwap","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"rsi","url":"/reference/totalfinance/technical-analysis/page-29#rsi","description":"Wilder's RSI (period 14 default, disclosed via `.explain()`).\n\nFlat-series convention: when the average loss over the window is zero (a flat or monotonically\nri","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/rsi"},{"title":"rsx","url":"/reference/totalfinance/technical-analysis/page-29#rsx","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"runBars","url":"/reference/totalfinance/technical-analysis/page-29#runBars","description":"Tick run bars — close on the larger one-sided tick run.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (parameters) (parameters).flush (parameters).threshold @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"schaffTrendCycle","url":"/reference/totalfinance/technical-analysis/page-29#schaffTrendCycle","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).cycle (parameters).fast (parameters).slow explain explain().return.assumptions explain().return.diagnostic @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"searchIndicators","url":"/reference/totalfinance/technical-analysis/page-29#searchIndicators","description":"Filter the registry by a name/alias search and category, then paginate — the token-lean alternative to\npulling all ~335 indicators. `query` matches the canonica","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (options) (options).category (options).limit (options).match (options).minScore (options).offset (options).query return.indicators return.li"},{"title":"sessionRanges","url":"/reference/totalfinance/technical-analysis/page-29#sessionRanges","description":"Aggregate bars into per-session OHLCV + range. `sessionIds[i]` is the session a bar belongs to\n(bars carry no timestamp, so the caller supplies the grouping). S","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (sessionIds) @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"sessionVwap","url":"/reference/totalfinance/technical-analysis/page-29#sessionVwap","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).resetEvery explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics. @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"shift","url":"/reference/totalfinance/technical-analysis/page-29#shift","description":"Lag a series by `period` bars: `output[i] = input[i − period]`.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"shortRun","url":"/reference/totalfinance/technical-analysis/page-29#shortRun","description":"1 when fast (`x`) and slow (`y`) are both falling over the lookback — a confirmed down-run.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"signal","url":"/reference/totalfinance/technical-analysis/page-29#signal","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (candles) return.addRule return.atr return.columns return.ema return.events return.feature return.rsi return.signals return.sma return.use r @insiderfinance/totalfinance/technical-analysis/signal"},{"title":"sin","url":"/reference/totalfinance/technical-analysis/page-29#sin","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"sineWma","url":"/reference/totalfinance/technical-analysis/page-30#sineWma","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"sinh","url":"/reference/totalfinance/technical-analysis/page-30#sinh","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"skew","url":"/reference/totalfinance/technical-analysis/page-30#skew","description":"Rolling sample skewness (bias-corrected Fisher-Pearson G1).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"slope","url":"/reference/totalfinance/technical-analysis/page-30#slope","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"sma","url":"/reference/totalfinance/technical-analysis/page-30#sma","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"smcSweep","url":"/reference/totalfinance/technical-analysis/page-30#smcSweep","description":"pandas-ta `smc_sweep`: +1 bullish low sweep, -1 bearish high sweep, 0 none.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).wickMultiplier explain explain().return.assumptions explain().return.diagnostics expla @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"smiErgodic","url":"/reference/totalfinance/technical-analysis/page-30#smiErgodic","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).long (parameters).short (parameters).signal explain explain().return.assumptions explain().return.diagnost @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"snapshotOf","url":"/reference/totalfinance/technical-analysis/page-30#snapshotOf","description":"Stamp indicator state into the public envelope. Every `toJSON` goes through here.\n\nThis is also where the state becomes JSON-SAFE: after `snapshotOf`, no number","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (kind) (state) return.kind return.schemaVersion return.state @insiderfinance/totalfinance/technical-analysis/framework"},{"title":"sqrt","url":"/reference/totalfinance/technical-analysis/page-30#sqrt","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"squeeze","url":"/reference/totalfinance/technical-analysis/page-30#squeeze","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).bollingerBandPeriod (parameters).bollingerStandardDeviations (parameters).keltnerChannelMultiplier (parame @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"squeezePro","url":"/reference/totalfinance/technical-analysis/page-30#squeezePro","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).bollingerBandPeriod (parameters).bollingerStandardDeviations (parameters).keltnerChannelPeriod (parameters @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"standardDeviation","url":"/reference/totalfinance/technical-analysis/page-30#standardDeviation","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).sample explain explain().return.assumptions explain().return.diagnostics explain().ret @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"standardError","url":"/reference/totalfinance/technical-analysis/page-30#standardError","description":"Rolling standard error of the mean: sampleStd / √n.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"stoch","url":"/reference/totalfinance/technical-analysis/page-30#stoch","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).dPeriod (parameters).kPeriod (parameters).smoothK explain explain().return.assumptions explain().return.di"},{"title":"stochFast","url":"/reference/totalfinance/technical-analysis/page-30#stochFast","description":"Alias of {@link stochastic}: with the default `smoothK: 1` the stochastic IS the fast stochastic\n(raw %K + SMA %D — TA-Lib STOCHF). One implementation, two regi","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).dPeriod (parameters).kPeriod (parameters).smoothK explain explain().return.assumptions explain().return.di @insiderfinance/totalfinance/technical-analysis/bars @insiderfinance/totalfinance/technical-analysis/statistics"},{"title":"stochRsi","url":"/reference/totalfinance/technical-analysis/page-30#stochRsi","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).dPeriod (parameters).kPeriod (parameters).rsiPeriod (parameters).stochPeriod explain explain().return.assu @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"stochastic","url":"/reference/totalfinance/technical-analysis/page-30#stochastic","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).dPeriod (parameters).kPeriod (parameters).smoothK explain explain().return.assumptions explain().return.di @insiderfinance/totalfinance/technical-analysis/bars"},{"title":"streamAsync","url":"/reference/totalfinance/technical-analysis/page-30#streamAsync","description":"Feed a stream from an **async iterable** source (spec §13.2 streaming adapters), yielding each\nnon-`null` (post-warmup) output as it is produced. Lets indicator","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (source) (stream) (stream).next (stream).toJSON (stream).value @insiderfinance/totalfinance/technical-analysis/framework"},{"title":"sub","url":"/reference/totalfinance/technical-analysis/page-30#sub","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"superSmoother","url":"/reference/totalfinance/technical-analysis/page-30#superSmoother","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"supertrend","url":"/reference/totalfinance/technical-analysis/page-31#supertrend","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).multiplier (parameters).period explain explain().return.assumptions explain().return.diagnostics explain() @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"supportResistance","url":"/reference/totalfinance/technical-analysis/page-31#supportResistance","description":"Cluster swing highs into resistance levels and swing lows into support levels.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (options) (options).strength (options).tolerance return.assumptions return.assumptions.conventionsVersion return.assumptions.strength @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"swingTrailingStop","url":"/reference/totalfinance/technical-analysis/page-31#swingTrailingStop","description":"Structure-based trailing stop: trails the most recent confirmed swing low (long) / high (short).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).strength explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.au @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"swings","url":"/reference/totalfinance/technical-analysis/page-31#swings","description":"Swing highs/lows: a swing high is a bar whose high strictly exceeds the highs of the `strength`\nbars on each side (and symmetrically for lows). The first and la","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (options) (options).strength return.assumptions return.assumptions.conventionsVersion return.assumptions.strength return.diagnostics  @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"symmetricWma","url":"/reference/totalfinance/technical-analysis/page-31#symmetricWma","description":"Symmetric (triangular) weighted MA — identical to the triangular MA (`trima`).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"t3","url":"/reference/totalfinance/technical-analysis/page-31#t3","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).volumeFactor explain explain().return.assumptions explain().return.diagnostics explain @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"talibCandle","url":"/reference/totalfinance/technical-analysis/page-31#talibCandle","description":"Run an adaptive TA-Lib candlestick pattern by name (camelCase or `CDL*`), returning the ±100/0\nseries. Throws for patterns not yet ported to the adaptive engine","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (name) @insiderfinance/totalfinance/technical-analysis/candle-talib"},{"title":"tan","url":"/reference/totalfinance/technical-analysis/page-31#tan","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"tanh","url":"/reference/totalfinance/technical-analysis/page-31#tanh","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/math"},{"title":"tdSequential","url":"/reference/totalfinance/technical-analysis/page-31#tdSequential","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).lookback explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.au @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"tema","url":"/reference/totalfinance/technical-analysis/page-31#tema","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"tickBars","url":"/reference/totalfinance/technical-analysis/page-31#tickBars","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (parameters) (parameters).count (parameters).flush @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"tickVolumeProfile","url":"/reference/totalfinance/technical-analysis/page-31#tickVolumeProfile","description":"Volume-by-price built from the **actual trade prints** (each trade's full size lands in the bucket\nof its exact price — no bar-range smearing), with the POC, va","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (parameters) (parameters).bins (parameters).method (parameters).quotes (parameters).tickSize (parameters).valueAreaFraction (trades) return. @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"tosStdevAll","url":"/reference/totalfinance/technical-analysis/page-31#tosStdevAll","description":"Thinkorswim Standard Deviation All: OLS line plus source-standard-deviation bands.\n\nOmitting `period` uses **all history seen so far** (a causal, stream-friendl","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).ddof (parameters).period (parameters).stds explain explain().return.assumptions explain().return.diagnosti @insiderfinance/totalfinance/technical-analysis/features"},{"title":"tradeSign","url":"/reference/totalfinance/technical-analysis/page-31#tradeSign","description":"Plain aggressor sign; use `tradeSign.explain(...)` for the resolving rule and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (callArguments) explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explain().return.value explain @insiderfinance/totalfinance/technical-analysis/microstructure"},{"title":"trendSignals","url":"/reference/totalfinance/technical-analysis/page-31#trendSignals","description":"Turn a trend series (>0 ⇒ in-trend) into trend/entry/exit flags.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"trendlines","url":"/reference/totalfinance/technical-analysis/page-31#trendlines","description":"Connect the two most recent swing lows (support) and swing highs (resistance) into trendlines.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (options) (options).strength return.assumptions return.assumptions.conventionsVersion return.assumptions.strength return.diagnostics  @insiderfinance/totalfinance/technical-analysis/price-action"},{"title":"trima","url":"/reference/totalfinance/technical-analysis/page-31#trima","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"trix","url":"/reference/totalfinance/technical-analysis/page-31#trix","description":"TRIX — the 1-bar rate of change of a triple-smoothed EMA, in percent.\n\nWarmup is TA-Lib's TRIX lookback, `3·(period − 1) + 1`: the triple EMA itself first exist","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"trixHistogram","url":"/reference/totalfinance/technical-analysis/page-31#trixHistogram","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).signal explain explain().return.assumptions explain().return.diagnostics explain().ret @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"trueRange","url":"/reference/totalfinance/technical-analysis/page-32#trueRange","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/transforms"},{"title":"tsf","url":"/reference/totalfinance/technical-analysis/page-32#tsf","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"tsi","url":"/reference/totalfinance/technical-analysis/page-32#tsi","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).long (parameters).short (parameters).signal explain explain().return.assumptions explain().return.diagnost @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"ttmTrend","url":"/reference/totalfinance/technical-analysis/page-32#ttmTrend","description":"TTM Trend — +1 when close is above the SMA of HL2 over the lookback, −1 otherwise.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"typicalPrice","url":"/reference/totalfinance/technical-analysis/page-32#typicalPrice","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/transforms"},{"title":"ulcerIndex","url":"/reference/totalfinance/technical-analysis/page-32#ulcerIndex","description":"Ulcer Index — RMS of percent drawdown from the rolling `period` high close.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"ultimateOscillator","url":"/reference/totalfinance/technical-analysis/page-32#ultimateOscillator","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).long (parameters).medium (parameters).short explain explain().return.assumptions explain().return.diagnost @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"upperShadow","url":"/reference/totalfinance/technical-analysis/page-32#upperShadow","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/transforms"},{"title":"valueWhen","url":"/reference/totalfinance/technical-analysis/page-32#valueWhen","description":"The source (`y`) value when the condition (`x > 0`) was last true (the `occurrence`-th most recent).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).occurrence explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics. @insiderfinance/totalfinance/technical-analysis/features"},{"title":"variance","url":"/reference/totalfinance/technical-analysis/page-32#variance","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period (parameters).sample explain explain().return.assumptions explain().return.diagnostics explain().ret @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"verticalHorizontalFilter","url":"/reference/totalfinance/technical-analysis/page-32#verticalHorizontalFilter","description":"Vertical Horizontal Filter — trend strength = range / summed absolute change.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"vfi","url":"/reference/totalfinance/technical-analysis/page-32#vfi","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).coefficient (parameters).period (parameters).smooth (parameters).volumeCutoff explain explain().return.ass @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"vidya","url":"/reference/totalfinance/technical-analysis/page-32#vidya","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).cmoPeriod (parameters).period explain explain().return.assumptions explain().return.diagnostics explain(). @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"volatilityStop","url":"/reference/totalfinance/technical-analysis/page-32#volatilityStop","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).multiplier (parameters).period explain explain().return.assumptions explain().return.diagnostics explain() @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"volumeBars","url":"/reference/totalfinance/technical-analysis/page-32#volumeBars","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (parameters) (parameters).flush (parameters).volume @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"volumeImbalanceBars","url":"/reference/totalfinance/technical-analysis/page-32#volumeImbalanceBars","description":"Volume imbalance bars — signed volume `|Σ sign(Δclose)·volume|`.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (parameters) (parameters).flush (parameters).threshold @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"volumeOscillator","url":"/reference/totalfinance/technical-analysis/page-32#volumeOscillator","description":"Volume Oscillator — 100·(EMA_fast(volume) − EMA_slow(volume)) / EMA_slow(volume).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).fast (parameters).slow explain explain().return.assumptions explain().return.diagnostics explain().return. @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"volumeProfile","url":"/reference/totalfinance/technical-analysis/page-32#volumeProfile","description":"Fixed-range volume profile: each bar's volume is spread across the price buckets its high-low range\noverlaps, **in proportion to the overlap** (a bar contributi","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (parameters) (parameters).bins (parameters).valueAreaFraction return.assumptions return.assumptions.bins return.assumptions.conventio @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"volumeRunBars","url":"/reference/totalfinance/technical-analysis/page-32#volumeRunBars","description":"Volume run bars — close on the larger one-sided volume run.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (parameters) (parameters).flush (parameters).threshold @insiderfinance/totalfinance/technical-analysis/chart-types"},{"title":"volumeWeightedMacd","url":"/reference/totalfinance/technical-analysis/page-32#volumeWeightedMacd","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).fast (parameters).signal (parameters).slow explain explain().return.assumptions explain().return.diagnosti @insiderfinance/totalfinance/technical-analysis/momentum"},{"title":"vortex","url":"/reference/totalfinance/technical-analysis/page-33#vortex","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"vwap","url":"/reference/totalfinance/technical-analysis/page-33#vwap","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/bars"},{"title":"vwapBands","url":"/reference/totalfinance/technical-analysis/page-33#vwapBands","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).multiplier explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics. @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"vwma","url":"/reference/totalfinance/technical-analysis/page-33#vwma","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"warmupMarkdown","url":"/reference/totalfinance/technical-analysis/page-33#warmupMarkdown","description":"Render warmup/lookahead/displacement reference as Markdown, grouped by category.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function   @insiderfinance/totalfinance/technical-analysis/warmup"},{"title":"wcp","url":"/reference/totalfinance/technical-analysis/page-33#wcp","description":"(high + low + 2·close) / 4 — alias of `weightedClose`.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"weightedClose","url":"/reference/totalfinance/technical-analysis/page-33#weightedClose","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/transforms"},{"title":"williamsAd","url":"/reference/totalfinance/technical-analysis/page-33#williamsAd","description":"Williams Accumulation/Distribution — running sum of close − true-low/high on up/down days.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.autoReason explain().ret @insiderfinance/totalfinance/technical-analysis/volume"},{"title":"williamsR","url":"/reference/totalfinance/technical-analysis/page-33#williamsR","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/momentum @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"willr","url":"/reference/totalfinance/technical-analysis/page-33#willr","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto"},{"title":"winsorize","url":"/reference/totalfinance/technical-analysis/page-33#winsorize","description":"Rolling winsorize: clip the current value to the window's [lower, upper] quantiles.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).lower (parameters).period (parameters).upper explain explain().return.assumptions explain().return.diagnos @insiderfinance/totalfinance/technical-analysis/features"},{"title":"wma","url":"/reference/totalfinance/technical-analysis/page-33#wma","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"yangZhang","url":"/reference/totalfinance/technical-analysis/page-33#yangZhang","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).annualization (parameters).period explain explain().return.assumptions explain().return.diagnostics explai @insiderfinance/totalfinance/technical-analysis/volatility"},{"title":"zScore","url":"/reference/totalfinance/technical-analysis/page-33#zScore","description":"Rolling z-score: `(value − mean) / populationStd` over the window (0 on a flat window).","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/features"},{"title":"zigzag","url":"/reference/totalfinance/technical-analysis/page-33#zigzag","description":"ZigZag pivots: alternating swing highs and lows that each reverse price by at least `deviation`%.\nThe last pivot is provisional — a larger move can still extend","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (bars) (parameters) (parameters).deviation return.assumptions return.assumptions.conventionsVersion return.assumptions.deviation return.diag @insiderfinance/totalfinance/technical-analysis/trend"},{"title":"zlema","url":"/reference/totalfinance/technical-analysis/page-33#zlema","description":"function from @insiderfinance/totalfinance/technical-analysis","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/moving-averages @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"zlma","url":"/reference/totalfinance/technical-analysis/page-33#zlma","description":"Zero-lag EMA — alias of `zlema`.","category":"@insiderfinance/totalfinance/technical-analysis","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis function  (input) (parameters) (parameters).period explain explain().return.assumptions explain().return.diagnostics explain().return.diagnostics.auto @insiderfinance/totalfinance/technical-analysis/overlap"},{"title":"BollingerStream","url":"/reference/totalfinance/technical-analysis/bands#BollingerStream","description":"class from @insiderfinance/totalfinance/technical-analysis/bands","category":"@insiderfinance/totalfinance/technical-analysis/bands","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/bands class  (parameters) (parameters).period (parameters).standardDeviation fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.v"},{"title":"AdxStream","url":"/reference/totalfinance/technical-analysis/bars#AdxStream","description":"class from @insiderfinance/totalfinance/technical-analysis/bars","category":"@insiderfinance/totalfinance/technical-analysis/bars","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/bars class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.adx fromJSON().return.valu"},{"title":"AtrStream","url":"/reference/totalfinance/technical-analysis/bars#AtrStream","description":"class from @insiderfinance/totalfinance/technical-analysis/bars","category":"@insiderfinance/totalfinance/technical-analysis/bars","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/bars class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"ObvStream","url":"/reference/totalfinance/technical-analysis/bars#ObvStream","description":"class from @insiderfinance/totalfinance/technical-analysis/bars","category":"@insiderfinance/totalfinance/technical-analysis/bars","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/bars class  (talib) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSON"},{"title":"StochasticStream","url":"/reference/totalfinance/technical-analysis/bars#StochasticStream","description":"class from @insiderfinance/totalfinance/technical-analysis/bars","category":"@insiderfinance/totalfinance/technical-analysis/bars","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/bars class  (parameters) (parameters).dPeriod (parameters).kPeriod (parameters).smoothK fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSO"},{"title":"VwapStream","url":"/reference/totalfinance/technical-analysis/bars#VwapStream","description":"class from @insiderfinance/totalfinance/technical-analysis/bars","category":"@insiderfinance/totalfinance/technical-analysis/bars","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/bars class  fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSON(snapsho"},{"title":"CandleZStream","url":"/reference/totalfinance/technical-analysis/candle-aliases#CandleZStream","description":"class from @insiderfinance/totalfinance/technical-analysis/candle-aliases","category":"@insiderfinance/totalfinance/technical-analysis/candle-aliases","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/candle-aliases class  (parameters) (parameters).ddof (parameters).period fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON"},{"title":"CandleStream","url":"/reference/totalfinance/technical-analysis/candlesticks#CandleStream","description":"class from @insiderfinance/totalfinance/technical-analysis/candlesticks","category":"@insiderfinance/totalfinance/technical-analysis/candlesticks","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/candlesticks class  (parameters) (parameters).detect (parameters).length (parameters).name next next(bar) next(bar).close next(bar).high next(bar).low next(bar)"},{"title":"DspStream","url":"/reference/totalfinance/technical-analysis/cycle#DspStream","description":"class from @insiderfinance/totalfinance/technical-analysis/cycle","category":"@insiderfinance/totalfinance/technical-analysis/cycle","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/cycle class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"EbswStream","url":"/reference/totalfinance/technical-analysis/cycle#EbswStream","description":"Even Better Sinewave — **pandas-ta-compatible, including pandas-ta's degree/radian defect.**\n\npandas-ta's `ebsw` feeds `360 / period` (and `√2·180 / bars`) to `","category":"@insiderfinance/totalfinance/technical-analysis/cycle","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/cycle class  (parameters) (parameters).bars (parameters).period fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON"},{"title":"HtPhasorStream","url":"/reference/totalfinance/technical-analysis/cycle#HtPhasorStream","description":"class from @insiderfinance/totalfinance/technical-analysis/cycle","category":"@insiderfinance/totalfinance/technical-analysis/cycle","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/cycle class  core core.toJSON core.toJSON().return.kind core.toJSON().return.schemaVersion core.toJSON().return.state core.update core.update().return.dc"},{"title":"HtScalarStream","url":"/reference/totalfinance/technical-analysis/cycle#HtScalarStream","description":"class from @insiderfinance/totalfinance/technical-analysis/cycle","category":"@insiderfinance/totalfinance/technical-analysis/cycle","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/cycle class  (parameters) (parameters).kind (parameters).pick core core.toJSON core.toJSON().return.kind core.toJSON().return.schemaVersion core.toJSON()"},{"title":"HtSineStream","url":"/reference/totalfinance/technical-analysis/cycle#HtSineStream","description":"class from @insiderfinance/totalfinance/technical-analysis/cycle","category":"@insiderfinance/totalfinance/technical-analysis/cycle","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/cycle class  core core.toJSON core.toJSON().return.kind core.toJSON().return.schemaVersion core.toJSON().return.state core.update core.update().return.dc"},{"title":"HtTrendModeStream","url":"/reference/totalfinance/technical-analysis/cycle#HtTrendModeStream","description":"1 = trend, 0 = cycle. Cycle mode is entered on a sine/lead-sine crossing and held for roughly one\ndominant cycle (an Ehlers-style heuristic; TA-Lib's exact tren","category":"@insiderfinance/totalfinance/technical-analysis/cycle","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/cycle class  core core.toJSON core.toJSON().return.kind core.toJSON().return.schemaVersion core.toJSON().return.state core.update core.update().return.dc"},{"title":"MswStream","url":"/reference/totalfinance/technical-analysis/cycle#MswStream","description":"class from @insiderfinance/totalfinance/technical-analysis/cycle","category":"@insiderfinance/totalfinance/technical-analysis/cycle","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/cycle class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.lead fromJSON().return.val"},{"title":"DrawdownStream","url":"/reference/totalfinance/technical-analysis/features#DrawdownStream","description":"class from @insiderfinance/totalfinance/technical-analysis/features","category":"@insiderfinance/totalfinance/technical-analysis/features","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/features class  fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.drawdown fromJSON().return.value.lo"},{"title":"IndicatorInputKind","url":"/reference/totalfinance/technical-analysis/framework#IndicatorInputKind","description":"The input class an indicator consumes (mirrored by the registry's `IndicatorInputs`).","category":"@insiderfinance/totalfinance/technical-analysis/framework","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis/framework type  "},{"title":"SnapshotState","url":"/reference/totalfinance/technical-analysis/framework#SnapshotState","description":"Checked access to one snapshot's opaque state.\n\nEvery accessor takes the state key and returns the value the restorer needs, or throws a typed\n`InputError` nami","category":"@insiderfinance/totalfinance/technical-analysis/framework","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/framework class  (kind) (state) boolean boolean(field) cached cached(field) child child().return.kind child().return.schemaVersion child().return.state child"},{"title":"bindIndicatorMetadata","url":"/reference/totalfinance/technical-analysis/framework#bindIndicatorMetadata","description":"Bind registration metadata onto a facade built by {@link makeIndicator} — the single choke point\nof the disclosure law: built-in leaves bind their shared privat","category":"@insiderfinance/totalfinance/technical-analysis/framework","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis/framework function — called by built-in construction and `registry.register`; not public API. (indicator) (metadata) (metadata).conventions (metadata).defaults (metadata).inputs (metadata).parameters"},{"title":"closes","url":"/reference/totalfinance/technical-analysis/framework#closes","description":"Map a column of bars to their close prices.","category":"@insiderfinance/totalfinance/technical-analysis/framework","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis/framework function  (bars)"},{"title":"collect","url":"/reference/totalfinance/technical-analysis/framework#collect","description":"Run a stream over a series, producing aligned output with a NaN sentinel during warmup. `warmup`\nis the index of the first non-warmup value (equal to the input ","category":"@insiderfinance/totalfinance/technical-analysis/framework","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis/framework function  (input) (nan) (stream) (stream).next (stream).toJSON (stream).value return.value return.warmup"},{"title":"makeIndicator","url":"/reference/totalfinance/technical-analysis/framework#makeIndicator","description":"Build a facade indicator from a stream factory, a restorer, and a NaN-sentinel factory.\n`defaults` (when declared) are the indicator's industry-standard paramet","category":"@insiderfinance/totalfinance/technical-analysis/framework","kind":"function","keywords":"@insiderfinance/totalfinance/technical-analysis/framework function  (defaults) (make) (nan) (restore) return.explain return.fromJSON return.stream"},{"title":"MacdStream","url":"/reference/totalfinance/technical-analysis/macd#MacdStream","description":"class from @insiderfinance/totalfinance/technical-analysis/macd","category":"@insiderfinance/totalfinance/technical-analysis/macd","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/macd class  (parameters) (parameters).fast (parameters).signal (parameters).slow fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().ret"},{"title":"BinaryMathStream","url":"/reference/totalfinance/technical-analysis/math#BinaryMathStream","description":"class from @insiderfinance/totalfinance/technical-analysis/math","category":"@insiderfinance/totalfinance/technical-analysis/math","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/math class  (parameters) (parameters).combine (parameters).kind next next(pair) next(pair).x next(pair).y restore restore(kind) restore(operation) retur"},{"title":"CrossPairStream","url":"/reference/totalfinance/technical-analysis/math#CrossPairStream","description":"class from @insiderfinance/totalfinance/technical-analysis/math","category":"@insiderfinance/totalfinance/technical-analysis/math","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/math class  (parameters) (parameters).kind (parameters).mode fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(s"},{"title":"UnaryMathStream","url":"/reference/totalfinance/technical-analysis/math#UnaryMathStream","description":"class from @insiderfinance/totalfinance/technical-analysis/math","category":"@insiderfinance/totalfinance/technical-analysis/math","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/math class  (parameters) (parameters).kind (parameters).transform next next(value) restore restore(kind) restore(operation) return.next return.toJSON re"},{"title":"BookImbalanceResult","url":"/reference/totalfinance/technical-analysis/microstructure#BookImbalanceResult","description":"Book-imbalance envelope (Law 2): the imbalance plus applied conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis/microstructure","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis/microstructure interface  assumptions assumptions.conventionsVersion assumptions.levels assumptions.weighted diagnostics diagnostics.warnings value"},{"title":"MicropriceResult","url":"/reference/totalfinance/technical-analysis/microstructure#MicropriceResult","description":"Microprice envelope (Law 2): the size-weighted mid plus conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis/microstructure","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis/microstructure interface  assumptions assumptions.conventionsVersion diagnostics diagnostics.warnings value"},{"title":"TradeDirection","url":"/reference/totalfinance/technical-analysis/microstructure#TradeDirection","description":"type from @insiderfinance/totalfinance/technical-analysis/microstructure","category":"@insiderfinance/totalfinance/technical-analysis/microstructure","kind":"type","keywords":"@insiderfinance/totalfinance/technical-analysis/microstructure type  "},{"title":"TradeSignResult","url":"/reference/totalfinance/technical-analysis/microstructure#TradeSignResult","description":"Aggressor-classification envelope (Law 2): the sign plus applied conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis/microstructure","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis/microstructure interface  assumptions assumptions.conventionsVersion assumptions.method diagnostics diagnostics.warnings value"},{"title":"ApoStream","url":"/reference/totalfinance/technical-analysis/momentum#ApoStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).fast (parameters).slow fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(s"},{"title":"AwesomeStream","url":"/reference/totalfinance/technical-analysis/momentum#AwesomeStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).fast (parameters).slow fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(s"},{"title":"BiasStream","url":"/reference/totalfinance/technical-analysis/momentum#BiasStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"BrarStream","url":"/reference/totalfinance/technical-analysis/momentum#BrarStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.popularityIndex fromJSON()"},{"title":"CciStream","url":"/reference/totalfinance/technical-analysis/momentum#CciStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"CenterOfGravityStream","url":"/reference/totalfinance/technical-analysis/momentum#CenterOfGravityStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"CmoParameters","url":"/reference/totalfinance/technical-analysis/momentum#CmoParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum interface  period talib @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"CmoStream","url":"/reference/totalfinance/technical-analysis/momentum#CmoStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"ConnorsRsiStream","url":"/reference/totalfinance/technical-analysis/momentum#ConnorsRsiStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).rankPeriod (parameters).rsiPeriod (parameters).streakPeriod fromJSON fromJSON().return.next fromJSON().return.toJS"},{"title":"CoppockStream","url":"/reference/totalfinance/technical-analysis/momentum#CoppockStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).longRoc (parameters).shortRoc (parameters).wmaPeriod fromJSON fromJSON().return.next fromJSON().return.toJSON from"},{"title":"CtiStream","url":"/reference/totalfinance/technical-analysis/momentum#CtiStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"DpoStream","url":"/reference/totalfinance/technical-analysis/momentum#DpoStream","description":"Detrended Price Oscillator, Pring's causal form: `close[t − shift] − SMA(close, period)[t]` with\n`shift = ⌊period/2⌋ + 1` (the same lag pandas-ta applies with `","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"EfficiencyRatioStream","url":"/reference/totalfinance/technical-analysis/momentum#EfficiencyRatioStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"ElderRayStream","url":"/reference/totalfinance/technical-analysis/momentum#ElderRayStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.bear fromJSON().return.val"},{"title":"FisherStream","url":"/reference/totalfinance/technical-analysis/momentum/page-2#FisherStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.fisher fromJSON().return.v"},{"title":"InertiaStream","url":"/reference/totalfinance/technical-analysis/momentum/page-2#InertiaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).period (parameters).rviPeriod fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fro"},{"title":"KdjStream","url":"/reference/totalfinance/technical-analysis/momentum/page-2#KdjStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).period (parameters).signal fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJS"},{"title":"KstStream","url":"/reference/totalfinance/technical-analysis/momentum/page-2#KstStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).rocPeriods (parameters).signal (parameters).smaPeriods fromJSON fromJSON().return.next fromJSON().return.toJSON fr"},{"title":"LaguerreRsiStream","url":"/reference/totalfinance/technical-analysis/momentum/page-2#LaguerreRsiStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (gamma) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSON"},{"title":"LinregOscStream","url":"/reference/totalfinance/technical-analysis/momentum/page-2#LinregOscStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).kind (parameters).period (parameters).useForecast next next(value) restore restore(kind) restore(useForecast) retu"},{"title":"MOVING_AVERAGE_TYPES","url":"/reference/totalfinance/technical-analysis/momentum/page-2#MOVING_AVERAGE_TYPES","description":"value from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"value","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum value   @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"MacdExtStream","url":"/reference/totalfinance/technical-analysis/momentum/page-2#MacdExtStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (__0) (__0).fast (__0).fastType (__0).signalMovingAverage (__0).signalType (__0).slow (__0).slowType fromJSON fromJSON().return.next fromJSO"},{"title":"PeriodParameters","url":"/reference/totalfinance/technical-analysis/momentum/page-2#PeriodParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum interface  period @insiderfinance/totalfinance/technical-analysis/oscillators"},{"title":"PgoStream","url":"/reference/totalfinance/technical-analysis/momentum/page-3#PgoStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"PpoStream","url":"/reference/totalfinance/technical-analysis/momentum/page-3#PpoStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).fast (parameters).signal (parameters).slow fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().ret"},{"title":"ProjectionOscillatorStream","url":"/reference/totalfinance/technical-analysis/momentum/page-3#ProjectionOscillatorStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.lower fromJSON().return.va"},{"title":"PsychologicalLineStream","url":"/reference/totalfinance/technical-analysis/momentum/page-3#PsychologicalLineStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"PvoStream","url":"/reference/totalfinance/technical-analysis/momentum/page-3#PvoStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).fast (parameters).signal (parameters).slow fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().ret"},{"title":"QqeStream","url":"/reference/totalfinance/technical-analysis/momentum/page-3#QqeStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).factor (parameters).rsiPeriod (parameters).smooth fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSO"},{"title":"RocStream","url":"/reference/totalfinance/technical-analysis/momentum/page-3#RocStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).mode (parameters).period next next(value) restore restore(mode) return.next return.toJSON return.value toJSON toJS"},{"title":"RsxStream","url":"/reference/totalfinance/technical-analysis/momentum/page-3#RsxStream","description":"Jurik RSX — the cascaded double-smoother momentum/|momentum| ratio mapped to [0, 100]. Uses the\ncanonical Jurik filter cascade; the reference's f88/f90 warmup c","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"RvgiStream","url":"/reference/totalfinance/technical-analysis/momentum/page-3#RvgiStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.rvi fromJSON().return.valu"},{"title":"SchaffTrendCycleStream","url":"/reference/totalfinance/technical-analysis/momentum/page-3#SchaffTrendCycleStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).cycle (parameters).fast (parameters).slow fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().retu"},{"title":"SlopeStream","url":"/reference/totalfinance/technical-analysis/momentum/page-3#SlopeStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"SmiErgodicStream","url":"/reference/totalfinance/technical-analysis/momentum/page-4#SmiErgodicStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).long (parameters).short (parameters).signal fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().re"},{"title":"SqueezeCore","url":"/reference/totalfinance/technical-analysis/momentum/page-4#SqueezeCore","description":"Shared Bollinger-inside-Keltner squeeze machinery + the LazyBear momentum histogram.","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).bollingerBandPeriod (parameters).bollingerStandardDeviations (parameters).keltnerChannelPeriod bollingerBandPeriod"},{"title":"SqueezeProStream","url":"/reference/totalfinance/technical-analysis/momentum/page-4#SqueezeProStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).bollingerBandPeriod (parameters).bollingerStandardDeviations (parameters).keltnerChannelPeriod (parameters).narrow"},{"title":"SqueezeStream","url":"/reference/totalfinance/technical-analysis/momentum/page-4#SqueezeStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).bollingerBandPeriod (parameters).bollingerStandardDeviations (parameters).keltnerChannelMultiplier (parameters).ke"},{"title":"StochRsiStream","url":"/reference/totalfinance/technical-analysis/momentum/page-4#StochRsiStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).dPeriod (parameters).kPeriod (parameters).rsiPeriod (parameters).stochPeriod fromJSON fromJSON().return.next fromJ"},{"title":"TdSequentialStream","url":"/reference/totalfinance/technical-analysis/momentum/page-4#TdSequentialStream","description":"Core TD Sequential: the price-flip setup (1–9) and a basic countdown (1–13). This implements the\nessential setup/countdown signal, not the full DeMark ruleset (","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (lookback) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.countdown fromJSON().ret"},{"title":"TrixHistogramStream","url":"/reference/totalfinance/technical-analysis/momentum/page-4#TrixHistogramStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).period (parameters).signal fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJS"},{"title":"TrixStream","url":"/reference/totalfinance/technical-analysis/momentum/page-5#TrixStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"TsiStream","url":"/reference/totalfinance/technical-analysis/momentum/page-5#TsiStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).long (parameters).short (parameters).signal fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().re"},{"title":"UltimateStream","url":"/reference/totalfinance/technical-analysis/momentum/page-5#UltimateStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).long (parameters).medium (parameters).short fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().re"},{"title":"VolumeWeightedMacdStream","url":"/reference/totalfinance/technical-analysis/momentum/page-5#VolumeWeightedMacdStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (parameters) (parameters).fast (parameters).signal (parameters).slow fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().ret"},{"title":"WilliamsRStream","url":"/reference/totalfinance/technical-analysis/momentum/page-5#WilliamsRStream","description":"class from @insiderfinance/totalfinance/technical-analysis/momentum","category":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"AlmaStream","url":"/reference/totalfinance/technical-analysis/moving-averages#AlmaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (parameters) (parameters).offset (parameters).period (parameters).sigma fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON()."},{"title":"AnchoredVwapStream","url":"/reference/totalfinance/technical-analysis/moving-averages#AnchoredVwapStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (anchor) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"DemaStream","url":"/reference/totalfinance/technical-analysis/moving-averages#DemaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"EmaStream","url":"/reference/totalfinance/technical-analysis/moving-averages#EmaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"FramaStream","url":"/reference/totalfinance/technical-analysis/moving-averages#FramaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"HmaStream","url":"/reference/totalfinance/technical-analysis/moving-averages#HmaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"KamaStream","url":"/reference/totalfinance/technical-analysis/moving-averages#KamaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (parameters) (parameters).fast (parameters).period (parameters).slow fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().ret"},{"title":"MamaStream","url":"/reference/totalfinance/technical-analysis/moving-averages#MamaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (parameters) (parameters).fastLimit (parameters).slowLimit fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value "},{"title":"McGinleyStream","url":"/reference/totalfinance/technical-analysis/moving-averages#McGinleyStream","description":"McGinley Dynamic (John R. McGinley) — an EMA-like average whose smoothing constant self-adjusts by\nthe ratio of price to the current average, so it speeds up in","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"RmaStream","url":"/reference/totalfinance/technical-analysis/moving-averages#RmaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"RollingVwapStream","url":"/reference/totalfinance/technical-analysis/moving-averages#RollingVwapStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"SmaStream","url":"/reference/totalfinance/technical-analysis/moving-averages#SmaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"SuperSmootherStream","url":"/reference/totalfinance/technical-analysis/moving-averages#SuperSmootherStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"T3Stream","url":"/reference/totalfinance/technical-analysis/moving-averages/page-2#T3Stream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (parameters) (parameters).period (parameters).volumeFactor fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value "},{"title":"TemaStream","url":"/reference/totalfinance/technical-analysis/moving-averages/page-2#TemaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"TrimaStream","url":"/reference/totalfinance/technical-analysis/moving-averages/page-2#TrimaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"VidyaStream","url":"/reference/totalfinance/technical-analysis/moving-averages/page-2#VidyaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (parameters) (parameters).cmoPeriod (parameters).period fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fro"},{"title":"VwmaStream","url":"/reference/totalfinance/technical-analysis/moving-averages/page-2#VwmaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"WmaStream","url":"/reference/totalfinance/technical-analysis/moving-averages/page-2#WmaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"ZlemaStream","url":"/reference/totalfinance/technical-analysis/moving-averages/page-2#ZlemaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/moving-averages","category":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"ApoStream","url":"/reference/totalfinance/technical-analysis/oscillators#ApoStream","description":"class from @insiderfinance/totalfinance/technical-analysis/oscillators","category":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators class  (parameters) (parameters).fast (parameters).slow fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(s"},{"title":"AwesomeStream","url":"/reference/totalfinance/technical-analysis/oscillators#AwesomeStream","description":"class from @insiderfinance/totalfinance/technical-analysis/oscillators","category":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators class  (parameters) (parameters).fast (parameters).slow fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(s"},{"title":"CciStream","url":"/reference/totalfinance/technical-analysis/oscillators#CciStream","description":"class from @insiderfinance/totalfinance/technical-analysis/oscillators","category":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"CmoStream","url":"/reference/totalfinance/technical-analysis/oscillators#CmoStream","description":"class from @insiderfinance/totalfinance/technical-analysis/oscillators","category":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"ConnorsRsiStream","url":"/reference/totalfinance/technical-analysis/oscillators#ConnorsRsiStream","description":"class from @insiderfinance/totalfinance/technical-analysis/oscillators","category":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators class  (parameters) (parameters).rankPeriod (parameters).rsiPeriod (parameters).streakPeriod fromJSON fromJSON().return.next fromJSON().return.toJS"},{"title":"DpoStream","url":"/reference/totalfinance/technical-analysis/oscillators#DpoStream","description":"Detrended Price Oscillator, Pring's causal form: `close[t − shift] − SMA(close, period)[t]` with\n`shift = ⌊period/2⌋ + 1` (the same lag pandas-ta applies with `","category":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"FisherStream","url":"/reference/totalfinance/technical-analysis/oscillators#FisherStream","description":"class from @insiderfinance/totalfinance/technical-analysis/oscillators","category":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.fisher fromJSON().return.v"},{"title":"KstStream","url":"/reference/totalfinance/technical-analysis/oscillators#KstStream","description":"class from @insiderfinance/totalfinance/technical-analysis/oscillators","category":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators class  (parameters) (parameters).rocPeriods (parameters).signal (parameters).smaPeriods fromJSON fromJSON().return.next fromJSON().return.toJSON fr"},{"title":"MacdExtStream","url":"/reference/totalfinance/technical-analysis/oscillators#MacdExtStream","description":"class from @insiderfinance/totalfinance/technical-analysis/oscillators","category":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators class  (__0) (__0).fast (__0).fastType (__0).signalMovingAverage (__0).signalType (__0).slow (__0).slowType fromJSON fromJSON().return.next fromJSO"},{"title":"PpoStream","url":"/reference/totalfinance/technical-analysis/oscillators/page-2#PpoStream","description":"class from @insiderfinance/totalfinance/technical-analysis/oscillators","category":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators class  (parameters) (parameters).fast (parameters).signal (parameters).slow fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().ret"},{"title":"RocStream","url":"/reference/totalfinance/technical-analysis/oscillators/page-2#RocStream","description":"class from @insiderfinance/totalfinance/technical-analysis/oscillators","category":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators class  (parameters) (parameters).mode (parameters).period next next(value) restore restore(mode) return.next return.toJSON return.value toJSON toJS"},{"title":"StochRsiStream","url":"/reference/totalfinance/technical-analysis/oscillators/page-2#StochRsiStream","description":"class from @insiderfinance/totalfinance/technical-analysis/oscillators","category":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators class  (parameters) (parameters).dPeriod (parameters).kPeriod (parameters).rsiPeriod (parameters).stochPeriod fromJSON fromJSON().return.next fromJ"},{"title":"TrixStream","url":"/reference/totalfinance/technical-analysis/oscillators/page-2#TrixStream","description":"class from @insiderfinance/totalfinance/technical-analysis/oscillators","category":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"TsiStream","url":"/reference/totalfinance/technical-analysis/oscillators/page-2#TsiStream","description":"class from @insiderfinance/totalfinance/technical-analysis/oscillators","category":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators class  (parameters) (parameters).long (parameters).short (parameters).signal fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().re"},{"title":"UltimateStream","url":"/reference/totalfinance/technical-analysis/oscillators/page-2#UltimateStream","description":"class from @insiderfinance/totalfinance/technical-analysis/oscillators","category":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators class  (parameters) (parameters).long (parameters).medium (parameters).short fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().re"},{"title":"WilliamsRStream","url":"/reference/totalfinance/technical-analysis/oscillators/page-2#WilliamsRStream","description":"class from @insiderfinance/totalfinance/technical-analysis/oscillators","category":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"AlmaStream","url":"/reference/totalfinance/technical-analysis/overlap#AlmaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (parameters) (parameters).offset (parameters).period (parameters).sigma fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON()."},{"title":"AnchoredVwapStream","url":"/reference/totalfinance/technical-analysis/overlap#AnchoredVwapStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (anchor) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"DemaStream","url":"/reference/totalfinance/technical-analysis/overlap#DemaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"EmaStream","url":"/reference/totalfinance/technical-analysis/overlap#EmaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"FramaStream","url":"/reference/totalfinance/technical-analysis/overlap#FramaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"GannHiLoStream","url":"/reference/totalfinance/technical-analysis/overlap#GannHiLoStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.trend fromJSON().return.va"},{"title":"HmaStream","url":"/reference/totalfinance/technical-analysis/overlap#HmaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"HwmaStream","url":"/reference/totalfinance/technical-analysis/overlap#HwmaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (parameters) (parameters).accelerationSmoothing (parameters).levelSmoothing (parameters).trendSmoothing fromJSON fromJSON().return.next from"},{"title":"JmaStream","url":"/reference/totalfinance/technical-analysis/overlap#JmaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (parameters) (parameters).period (parameters).phase (parameters).power fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().r"},{"title":"KamaStream","url":"/reference/totalfinance/technical-analysis/overlap#KamaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (parameters) (parameters).fast (parameters).period (parameters).slow fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().ret"},{"title":"MamaStream","url":"/reference/totalfinance/technical-analysis/overlap/page-2#MamaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (parameters) (parameters).fastLimit (parameters).slowLimit fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value "},{"title":"McGinleyStream","url":"/reference/totalfinance/technical-analysis/overlap/page-2#McGinleyStream","description":"McGinley Dynamic (John R. McGinley) — an EMA-like average whose smoothing constant self-adjusts by\nthe ratio of price to the current average, so it speeds up in","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"MovingAverageRibbonStream","url":"/reference/totalfinance/technical-analysis/overlap/page-2#MovingAverageRibbonStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (periods) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJS"},{"title":"RainbowMovingAverageStream","url":"/reference/totalfinance/technical-analysis/overlap/page-2#RainbowMovingAverageStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (parameters) (parameters).levels (parameters).period fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJS"},{"title":"RmaStream","url":"/reference/totalfinance/technical-analysis/overlap/page-2#RmaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"RollingAnchoredVwapStream","url":"/reference/totalfinance/technical-analysis/overlap/page-2#RollingAnchoredVwapStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (parameters) (parameters).anchorLow (parameters).lookback fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value f"},{"title":"RollingVwapStream","url":"/reference/totalfinance/technical-analysis/overlap/page-2#RollingVwapStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"SessionVwapStream","url":"/reference/totalfinance/technical-analysis/overlap/page-2#SessionVwapStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (resetEvery) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fro"},{"title":"SmaStream","url":"/reference/totalfinance/technical-analysis/overlap/page-2#SmaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"SuperSmootherStream","url":"/reference/totalfinance/technical-analysis/overlap/page-2#SuperSmootherStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"T3Stream","url":"/reference/totalfinance/technical-analysis/overlap/page-2#T3Stream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (parameters) (parameters).period (parameters).volumeFactor fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value "},{"title":"TemaStream","url":"/reference/totalfinance/technical-analysis/overlap/page-2#TemaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"TrimaStream","url":"/reference/totalfinance/technical-analysis/overlap/page-2#TrimaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"VidyaStream","url":"/reference/totalfinance/technical-analysis/overlap/page-3#VidyaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (parameters) (parameters).cmoPeriod (parameters).period fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fro"},{"title":"VwapBandsStream","url":"/reference/totalfinance/technical-analysis/overlap/page-3#VwapBandsStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (mult) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.lower fromJSON().return.valu"},{"title":"VwmaStream","url":"/reference/totalfinance/technical-analysis/overlap/page-3#VwmaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"WeightedMovingAverageStream","url":"/reference/totalfinance/technical-analysis/overlap/page-3#WeightedMovingAverageStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (parameters) (parameters).kind (parameters).weights next next(value) restore restore(kind) return.next return.toJSON return.value toJSON toJ"},{"title":"WmaStream","url":"/reference/totalfinance/technical-analysis/overlap/page-3#WmaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"ZlemaStream","url":"/reference/totalfinance/technical-analysis/overlap/page-3#ZlemaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/overlap","category":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"BreakoutsReport","url":"/reference/totalfinance/technical-analysis/price-action#BreakoutsReport","description":"Breakout report (Law 2): the aligned signal series plus conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis/price-action","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis/price-action interface  assumptions assumptions.conventionsVersion assumptions.lookback diagnostics diagnostics.warnings signal"},{"title":"Fractals","url":"/reference/totalfinance/technical-analysis/price-action#Fractals","description":"Fractal report (Law 2): Bill Williams up/down fractals plus conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis/price-action","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis/price-action interface  assumptions assumptions.conventionsVersion assumptions.strength diagnostics diagnostics.warnings down up"},{"title":"GapFillReport","url":"/reference/totalfinance/technical-analysis/price-action#GapFillReport","description":"Gap-fill report (Law 2): the tracked gap events plus conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis/price-action","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis/price-action interface  assumptions assumptions.conventionsVersion assumptions.minSizeFraction diagnostics diagnostics.warnings events"},{"title":"GapsReport","url":"/reference/totalfinance/technical-analysis/price-action#GapsReport","description":"Gap report (Law 2): the detected gaps plus conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis/price-action","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis/price-action interface  assumptions assumptions.conventionsVersion assumptions.minSizeFraction diagnostics diagnostics.warnings gaps"},{"title":"TrendlineChannel","url":"/reference/totalfinance/technical-analysis/price-action/page-2#TrendlineChannel","description":"Trendline/channel report (Law 2): the two rails plus conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis/price-action","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis/price-action interface  assumptions assumptions.conventionsVersion assumptions.strength diagnostics diagnostics.warnings resistance resistance.from resistance.inter"},{"title":"RsiStream","url":"/reference/totalfinance/technical-analysis/rsi#RsiStream","description":"class from @insiderfinance/totalfinance/technical-analysis/rsi","category":"@insiderfinance/totalfinance/technical-analysis/rsi","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/rsi class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"LogReturnsStream","url":"/reference/totalfinance/technical-analysis/series#LogReturnsStream","description":"class from @insiderfinance/totalfinance/technical-analysis/series","category":"@insiderfinance/totalfinance/technical-analysis/series","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/series class  fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSON(snapsho"},{"title":"ReturnsStream","url":"/reference/totalfinance/technical-analysis/series#ReturnsStream","description":"class from @insiderfinance/totalfinance/technical-analysis/series","category":"@insiderfinance/totalfinance/technical-analysis/series","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/series class  fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSON(snapsho"},{"title":"RollingVolatilityStream","url":"/reference/totalfinance/technical-analysis/series#RollingVolatilityStream","description":"class from @insiderfinance/totalfinance/technical-analysis/series","category":"@insiderfinance/totalfinance/technical-analysis/series","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/series class  (parameters) (parameters).period (parameters).scale fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSO"},{"title":"BetaStream","url":"/reference/totalfinance/technical-analysis/statistics#BetaStream","description":"class from @insiderfinance/totalfinance/technical-analysis/statistics","category":"@insiderfinance/totalfinance/technical-analysis/statistics","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/statistics class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"BopStream","url":"/reference/totalfinance/technical-analysis/statistics#BopStream","description":"class from @insiderfinance/totalfinance/technical-analysis/statistics","category":"@insiderfinance/totalfinance/technical-analysis/statistics","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/statistics class  fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSON(snapsho"},{"title":"CorrelStream","url":"/reference/totalfinance/technical-analysis/statistics#CorrelStream","description":"class from @insiderfinance/totalfinance/technical-analysis/statistics","category":"@insiderfinance/totalfinance/technical-analysis/statistics","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/statistics class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"MOVING_AVERAGE_NAMES","url":"/reference/totalfinance/technical-analysis/statistics#MOVING_AVERAGE_NAMES","description":"value from @insiderfinance/totalfinance/technical-analysis/statistics","category":"@insiderfinance/totalfinance/technical-analysis/statistics","kind":"value","keywords":"@insiderfinance/totalfinance/technical-analysis/statistics value  "},{"title":"MidpointStream","url":"/reference/totalfinance/technical-analysis/statistics#MidpointStream","description":"class from @insiderfinance/totalfinance/technical-analysis/statistics","category":"@insiderfinance/totalfinance/technical-analysis/statistics","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/statistics class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"MidpriceStream","url":"/reference/totalfinance/technical-analysis/statistics#MidpriceStream","description":"class from @insiderfinance/totalfinance/technical-analysis/statistics","category":"@insiderfinance/totalfinance/technical-analysis/statistics","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/statistics class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"MinMaxIndexStream","url":"/reference/totalfinance/technical-analysis/statistics#MinMaxIndexStream","description":"class from @insiderfinance/totalfinance/technical-analysis/statistics","category":"@insiderfinance/totalfinance/technical-analysis/statistics","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/statistics class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.maxIndex fromJSON().return"},{"title":"MinMaxStream","url":"/reference/totalfinance/technical-analysis/statistics#MinMaxStream","description":"class from @insiderfinance/totalfinance/technical-analysis/statistics","category":"@insiderfinance/totalfinance/technical-analysis/statistics","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/statistics class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.max fromJSON().return.valu"},{"title":"RollStream","url":"/reference/totalfinance/technical-analysis/statistics#RollStream","description":"class from @insiderfinance/totalfinance/technical-analysis/statistics","category":"@insiderfinance/totalfinance/technical-analysis/statistics","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/statistics class  (parameters) (parameters).mode (parameters).period next next(value) restore restore(mode) return.next return.toJSON return.value toJSON toJS"},{"title":"GapStream","url":"/reference/totalfinance/technical-analysis/transforms#GapStream","description":"class from @insiderfinance/totalfinance/technical-analysis/transforms","category":"@insiderfinance/totalfinance/technical-analysis/transforms","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/transforms class  fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSON(snapsho"},{"title":"HeikinAshiStream","url":"/reference/totalfinance/technical-analysis/transforms#HeikinAshiStream","description":"class from @insiderfinance/totalfinance/technical-analysis/transforms","category":"@insiderfinance/totalfinance/technical-analysis/transforms","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/transforms class  fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.close fromJSON().return.value.high "},{"title":"MapBarStream","url":"/reference/totalfinance/technical-analysis/transforms#MapBarStream","description":"class from @insiderfinance/totalfinance/technical-analysis/transforms","category":"@insiderfinance/totalfinance/technical-analysis/transforms","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/transforms class  (parameters) (parameters).kind (parameters).project next next(bar) next(bar).close next(bar).high next(bar).low next(bar).open next(bar).vol"},{"title":"TrueRangeStream","url":"/reference/totalfinance/technical-analysis/transforms#TrueRangeStream","description":"class from @insiderfinance/totalfinance/technical-analysis/transforms","category":"@insiderfinance/totalfinance/technical-analysis/transforms","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/transforms class  fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSON(snapsho"},{"title":"AdxrStream","url":"/reference/totalfinance/technical-analysis/trend#AdxrStream","description":"class from @insiderfinance/totalfinance/technical-analysis/trend","category":"@insiderfinance/totalfinance/technical-analysis/trend","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/trend class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"AroonStream","url":"/reference/totalfinance/technical-analysis/trend#AroonStream","description":"class from @insiderfinance/totalfinance/technical-analysis/trend","category":"@insiderfinance/totalfinance/technical-analysis/trend","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/trend class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.down fromJSON().return.val"},{"title":"ChandelierStream","url":"/reference/totalfinance/technical-analysis/trend#ChandelierStream","description":"class from @insiderfinance/totalfinance/technical-analysis/trend","category":"@insiderfinance/totalfinance/technical-analysis/trend","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/trend class  (parameters) (parameters).mult (parameters).period fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON"},{"title":"DmiStream","url":"/reference/totalfinance/technical-analysis/trend#DmiStream","description":"class from @insiderfinance/totalfinance/technical-analysis/trend","category":"@insiderfinance/totalfinance/technical-analysis/trend","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/trend class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.dx fromJSON().return.value"},{"title":"DonchianTrendStream","url":"/reference/totalfinance/technical-analysis/trend#DonchianTrendStream","description":"Donchian breakout trend: +1 once the close makes a new `period`-bar high, −1 on a new `period`-bar\nlow, holding the prior state between breakouts.","category":"@insiderfinance/totalfinance/technical-analysis/trend","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/trend class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"IchimokuStream","url":"/reference/totalfinance/technical-analysis/trend#IchimokuStream","description":"class from @insiderfinance/totalfinance/technical-analysis/trend","category":"@insiderfinance/totalfinance/technical-analysis/trend","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/trend class  (parameters) (parameters).basePeriod (parameters).conv (parameters).displacement (parameters).spanBPeriod fromJSON fromJSON().return.next fr"},{"title":"LinregStream","url":"/reference/totalfinance/technical-analysis/trend#LinregStream","description":"class from @insiderfinance/totalfinance/technical-analysis/trend","category":"@insiderfinance/totalfinance/technical-analysis/trend","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/trend class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.angle fromJSON().return.va"},{"title":"PsarExtStream","url":"/reference/totalfinance/technical-analysis/trend/page-2#PsarExtStream","description":"TA-Lib SAREXT — Parabolic SAR with independent acceleration factors per side and an offset applied\non reversal. Output is signed: positive while long, negative ","category":"@insiderfinance/totalfinance/technical-analysis/trend","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/trend class  (parameters) (parameters).afInitLong (parameters).afInitShort (parameters).afLong (parameters).afMaxLong (parameters).afMaxShort (parameters"},{"title":"PsarStream","url":"/reference/totalfinance/technical-analysis/trend/page-2#PsarStream","description":"class from @insiderfinance/totalfinance/technical-analysis/trend","category":"@insiderfinance/totalfinance/technical-analysis/trend","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/trend class  (parameters) (parameters).maxAf (parameters).step fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON("},{"title":"SupertrendStream","url":"/reference/totalfinance/technical-analysis/trend/page-2#SupertrendStream","description":"class from @insiderfinance/totalfinance/technical-analysis/trend","category":"@insiderfinance/totalfinance/technical-analysis/trend","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/trend class  (parameters) (parameters).mult (parameters).period fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON"},{"title":"VortexStream","url":"/reference/totalfinance/technical-analysis/trend/page-2#VortexStream","description":"class from @insiderfinance/totalfinance/technical-analysis/trend","category":"@insiderfinance/totalfinance/technical-analysis/trend","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/trend class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.viMinus fromJSON().return."},{"title":"ZigZagReport","url":"/reference/totalfinance/technical-analysis/trend/page-2#ZigZagReport","description":"ZigZag report (Law 2): the pivot list plus the applied conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis/trend","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis/trend interface  assumptions assumptions.conventionsVersion assumptions.deviation diagnostics diagnostics.warnings pivots provisional"},{"title":"BollingerBandFieldStream","url":"/reference/totalfinance/technical-analysis/volatility#BollingerBandFieldStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volatility","category":"@insiderfinance/totalfinance/technical-analysis/volatility","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volatility class  (parameters) (parameters).field (parameters).kind (parameters).period (parameters).standardDeviation next next(value) restore restore(field)"},{"title":"BollingerParameters","url":"/reference/totalfinance/technical-analysis/volatility#BollingerParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis/volatility","category":"@insiderfinance/totalfinance/technical-analysis/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis/volatility interface  period standardDeviation"},{"title":"ChaikinVolatilityStream","url":"/reference/totalfinance/technical-analysis/volatility#ChaikinVolatilityStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volatility","category":"@insiderfinance/totalfinance/technical-analysis/volatility","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volatility class  (parameters) (parameters).period (parameters).rocPeriod fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fro"},{"title":"DonchianStream","url":"/reference/totalfinance/technical-analysis/volatility#DonchianStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volatility","category":"@insiderfinance/totalfinance/technical-analysis/volatility","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volatility class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON().return.value.lower fromJSON().return.va"},{"title":"HistoricalVolatilityStream","url":"/reference/totalfinance/technical-analysis/volatility#HistoricalVolatilityStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volatility","category":"@insiderfinance/totalfinance/technical-analysis/volatility","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volatility class  (parameters) (parameters).period (parameters).scale fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSO"},{"title":"KeltnerStream","url":"/reference/totalfinance/technical-analysis/volatility#KeltnerStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volatility","category":"@insiderfinance/totalfinance/technical-analysis/volatility","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volatility class  (parameters) (parameters).atrPeriod (parameters).mult (parameters).period fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON("},{"title":"MomentStream","url":"/reference/totalfinance/technical-analysis/volatility#MomentStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volatility","category":"@insiderfinance/totalfinance/technical-analysis/volatility","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volatility class  (parameters) (parameters).kind (parameters).period (parameters).sample (parameters).variance fromJSON fromJSON().return.next fromJSON().retu"},{"title":"NatrStream","url":"/reference/totalfinance/technical-analysis/volatility#NatrStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volatility","category":"@insiderfinance/totalfinance/technical-analysis/volatility","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volatility class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"PeriodParameters","url":"/reference/totalfinance/technical-analysis/volatility/page-2#PeriodParameters","description":"interface from @insiderfinance/totalfinance/technical-analysis/volatility","category":"@insiderfinance/totalfinance/technical-analysis/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis/volatility interface  period"},{"title":"RangeVolatilityStream","url":"/reference/totalfinance/technical-analysis/volatility/page-2#RangeVolatilityStream","description":"Generic window of per-bar contributions → σ = √(mean·scale).","category":"@insiderfinance/totalfinance/technical-analysis/volatility","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volatility class  (parameters) (parameters).kind (parameters).period (parameters).scale (parameters).term next next(bar) next(bar).close next(bar).high next(b"},{"title":"RealizedVolatilityStream","url":"/reference/totalfinance/technical-analysis/volatility/page-2#RealizedVolatilityStream","description":"Realized volatility — the root-mean-square of log returns over the window (no mean subtraction, the\nrealized-variance convention), versus `historicalVolatility`","category":"@insiderfinance/totalfinance/technical-analysis/volatility","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volatility class  (parameters) (parameters).period (parameters).scale fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSO"},{"title":"RviStream","url":"/reference/totalfinance/technical-analysis/volatility/page-2#RviStream","description":"Relative Volatility Index — RSI's logic applied to the rolling standard deviation of price instead\nof price change: up-day stdev and down-day stdev are Wilder-s","category":"@insiderfinance/totalfinance/technical-analysis/volatility","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volatility class  (parameters) (parameters).smoothPeriod (parameters).stdevPeriod fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.v"},{"title":"YangZhangStream","url":"/reference/totalfinance/technical-analysis/volatility/page-2#YangZhangStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volatility","category":"@insiderfinance/totalfinance/technical-analysis/volatility","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volatility class  (parameters) (parameters).period (parameters).scale fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSO"},{"title":"AdLineStream","url":"/reference/totalfinance/technical-analysis/volume#AdLineStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volume","category":"@insiderfinance/totalfinance/technical-analysis/volume","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volume class  fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSON(snapsho"},{"title":"ChaikinOscStream","url":"/reference/totalfinance/technical-analysis/volume#ChaikinOscStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volume","category":"@insiderfinance/totalfinance/technical-analysis/volume","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volume class  (parameters) (parameters).fast (parameters).slow fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(s"},{"title":"CmfStream","url":"/reference/totalfinance/technical-analysis/volume#CmfStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volume","category":"@insiderfinance/totalfinance/technical-analysis/volume","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volume class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"CvdStream","url":"/reference/totalfinance/technical-analysis/volume#CvdStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volume","category":"@insiderfinance/totalfinance/technical-analysis/volume","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volume class  fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSON(snapsho"},{"title":"EomStream","url":"/reference/totalfinance/technical-analysis/volume#EomStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volume","category":"@insiderfinance/totalfinance/technical-analysis/volume","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volume class  (parameters) (parameters).period (parameters).scale fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSO"},{"title":"ForceIndexStream","url":"/reference/totalfinance/technical-analysis/volume#ForceIndexStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volume","category":"@insiderfinance/totalfinance/technical-analysis/volume","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volume class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"KlingerStream","url":"/reference/totalfinance/technical-analysis/volume#KlingerStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volume","category":"@insiderfinance/totalfinance/technical-analysis/volume","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volume class  (parameters) (parameters).fast (parameters).signal (parameters).slow fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().ret"},{"title":"MfiStream","url":"/reference/totalfinance/technical-analysis/volume#MfiStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volume","category":"@insiderfinance/totalfinance/technical-analysis/volume","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volume class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"OrderBookImbalanceResult","url":"/reference/totalfinance/technical-analysis/volume#OrderBookImbalanceResult","description":"Order-book-imbalance envelope (Law 2): the imbalance plus conventions and diagnostics.","category":"@insiderfinance/totalfinance/technical-analysis/volume","kind":"interface","keywords":"@insiderfinance/totalfinance/technical-analysis/volume interface  assumptions assumptions.conventionsVersion diagnostics diagnostics.warnings value"},{"title":"PvtStream","url":"/reference/totalfinance/technical-analysis/volume#PvtStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volume","category":"@insiderfinance/totalfinance/technical-analysis/volume","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volume class  fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSON(snapsho"},{"title":"RelativeVolumeStream","url":"/reference/totalfinance/technical-analysis/volume#RelativeVolumeStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volume","category":"@insiderfinance/totalfinance/technical-analysis/volume","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volume class  (period) fromJSON fromJSON().return.next fromJSON().return.toJSON fromJSON().return.value fromJSON(snapshot) fromJSON(snapshot).kind fromJSO"},{"title":"VfiStream","url":"/reference/totalfinance/technical-analysis/volume/page-2#VfiStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volume","category":"@insiderfinance/totalfinance/technical-analysis/volume","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volume class  (parameters) (parameters).coefficient (parameters).period (parameters).smooth (parameters).volumeCutoff fromJSON fromJSON().return.next from"},{"title":"VolumeIndexStream","url":"/reference/totalfinance/technical-analysis/volume/page-2#VolumeIndexStream","description":"class from @insiderfinance/totalfinance/technical-analysis/volume","category":"@insiderfinance/totalfinance/technical-analysis/volume","kind":"class","keywords":"@insiderfinance/totalfinance/technical-analysis/volume class  (parameters) (parameters).kind (parameters).positive next next(bar) next(bar).close next(bar).high next(bar).low next(bar).open next(bar).vo"},{"title":"AdjustedPresentValueInput","url":"/reference/totalfinance/valuation#AdjustedPresentValueInput","description":"Input for {@link adjustedPresentValue}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  compounding compounding.periodsPerYear compounding.type financingSideEffects unleveredCashFlows unleveredCostOfCapital @insiderfinance/totalfinance/valuation/corporate"},{"title":"AdjustedPresentValueResult","url":"/reference/totalfinance/valuation#AdjustedPresentValueResult","description":"Result of {@link adjustedPresentValue}: the decomposition plus the echoed assumptions.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  adjustedPresentValue assumptions assumptions.compounding assumptions.compounding.periodsPerYear assumptions.compounding.type assumptions.sid @insiderfinance/totalfinance/valuation/corporate"},{"title":"AfterTaxCostOfDebtInput","url":"/reference/totalfinance/valuation#AfterTaxCostOfDebtInput","description":"Input for {@link afterTaxCostOfDebt}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualPreTaxCostOfDebt marginalTaxRate unusableTaxShieldAdjustment @insiderfinance/totalfinance/valuation/corporate"},{"title":"AmortizationRow","url":"/reference/totalfinance/valuation#AmortizationRow","description":"One row of an {@link amortizationSchedule}. Columns are SIGNED: every column is a positive\nmagnitude for a nonnegative periodic rate, while a negative rate cred","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  closingBalance fee interest openingBalance payment period principal @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"AmortizationScheduleInput","url":"/reference/totalfinance/valuation#AmortizationScheduleInput","description":"Input for {@link amortizationSchedule}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  balloon numberOfPeriods paymentTiming periodicFee periodicInterestRate principal @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"AmortizationScheduleResult","url":"/reference/totalfinance/valuation#AmortizationScheduleResult","description":"The schedule plus its reconciliation facts — the unrounded rows reconcile exactly.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  balloon payment rounding rows totalInterest totalPrincipal @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"AmountDriver","url":"/reference/totalfinance/valuation#AmountDriver","description":"An explicit per-period amount, or an explicit fraction of that period's revenue.","category":"@insiderfinance/totalfinance/valuation","kind":"type","keywords":"@insiderfinance/totalfinance/valuation type  amount fractionOfRevenue @insiderfinance/totalfinance/valuation/forecasting"},{"title":"CapitalAssetPricingInput","url":"/reference/totalfinance/valuation#CapitalAssetPricingInput","description":"Input for {@link capitalAssetPricingExpectedReturn}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualMarketRiskPremium annualRiskFreeRate beta @insiderfinance/totalfinance/valuation/corporate"},{"title":"CapitalComponent","url":"/reference/totalfinance/valuation#CapitalComponent","description":"One market-value capital component with its (already after-tax where applicable) annual cost.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualCostOfCapital label marketValue @insiderfinance/totalfinance/valuation/corporate"},{"title":"ComparableAggregation","url":"/reference/totalfinance/valuation#ComparableAggregation","description":"How the surviving peer multiples collapse into one. REQUIRED — never guessed.","category":"@insiderfinance/totalfinance/valuation","kind":"type","keywords":"@insiderfinance/totalfinance/valuation type   @insiderfinance/totalfinance/valuation/corporate"},{"title":"ComparableCompanyValuationInput","url":"/reference/totalfinance/valuation#ComparableCompanyValuationInput","description":"Input for {@link comparableCompanyValuation}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  aggregation metricDefinition metricName outlierPolicy outlierPolicy.method outlierPolicy.multiplier peers period subjectMetricAmount valuati @insiderfinance/totalfinance/valuation/corporate"},{"title":"ComparableCompanyValuationResult","url":"/reference/totalfinance/valuation#ComparableCompanyValuationResult","description":"Result of {@link comparableCompanyValuation} — every recorded convention echoed.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  aggregatedMultiple aggregation assumptions assumptions.outlierPolicy assumptions.outlierPolicy.method assumptions.outlierPolicy.multiplier a @insiderfinance/totalfinance/valuation/corporate"},{"title":"ComparableOutlierPolicy","url":"/reference/totalfinance/valuation#ComparableOutlierPolicy","description":"The EXPLICIT outlier policy, applied to peer multiples BEFORE aggregation.\n\n`'interquartile-range'` excludes peers whose multiple lies outside\n`[Q1 − multiplier","category":"@insiderfinance/totalfinance/valuation","kind":"type","keywords":"@insiderfinance/totalfinance/valuation type  method multiplier @insiderfinance/totalfinance/valuation/corporate"},{"title":"ComparablePeer","url":"/reference/totalfinance/valuation#ComparablePeer","description":"One peer observation: the name and its multiple for the SAME metric/period as the subject.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  multiple peerName @insiderfinance/totalfinance/valuation/corporate"},{"title":"ComparablePeerExcluded","url":"/reference/totalfinance/valuation#ComparablePeerExcluded","description":"One peer the outlier policy excluded, with the exact reason.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  multiple peerName reason @insiderfinance/totalfinance/valuation/corporate"},{"title":"ComparablePeerUsed","url":"/reference/totalfinance/valuation#ComparablePeerUsed","description":"One peer that survived the outlier policy; `weight` present only under `'weighted-mean'`.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  multiple peerName weight @insiderfinance/totalfinance/valuation/corporate"},{"title":"ComparableValuationBasis","url":"/reference/totalfinance/valuation#ComparableValuationBasis","description":"Whether the multiple prices the whole firm or only the equity. REQUIRED — never guessed.","category":"@insiderfinance/totalfinance/valuation","kind":"type","keywords":"@insiderfinance/totalfinance/valuation type   @insiderfinance/totalfinance/valuation/corporate"},{"title":"ConvertPriceLevelInput","url":"/reference/totalfinance/valuation#ConvertPriceLevelInput","description":"Select exactly one method; ratio and reference fields cannot be mixed at runtime.","category":"@insiderfinance/totalfinance/valuation","kind":"type","keywords":"@insiderfinance/totalfinance/valuation type  method referenceSourcePrice referenceTargetPrice sourcePriceLevel sourcePriceUnit targetPricePerSourcePrice targetPriceUnit @insiderfinance/totalfinance/valuation/price-levels"},{"title":"CostOfEquityInput","url":"/reference/totalfinance/valuation#CostOfEquityInput","description":"Input for {@link costOfEquity} — the method is an explicit discriminant, never inferred.","category":"@insiderfinance/totalfinance/valuation","kind":"type","keywords":"@insiderfinance/totalfinance/valuation type  annualMarketRiskPremium annualRiskFreeRate beta method nextAnnualDividendPerShare perpetualGrowthRate sharePrice @insiderfinance/totalfinance/valuation/corporate"},{"title":"DatedCashFlow","url":"/reference/totalfinance/valuation#DatedCashFlow","description":"One cash flow on a strict `YYYY-MM-DD` calendar date.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  amount cashFlowDate label @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"DatedInternalRateOfReturnInput","url":"/reference/totalfinance/valuation/page-2#DatedInternalRateOfReturnInput","description":"Input for {@link datedInternalRateOfReturn}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  asOf cashFlows compounding compounding.periodsPerYear compounding.type dayCount @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"DatedNetPresentValueInput","url":"/reference/totalfinance/valuation/page-2#DatedNetPresentValueInput","description":"Input for {@link datedNetPresentValue}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualDiscountRate asOf cashFlows compounding compounding.periodsPerYear compounding.type dayCount @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"DecliningBalanceInput","url":"/reference/totalfinance/valuation/page-2#DecliningBalanceInput","description":"Declining-balance adds its explicit rate multiplier.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  cost factor period salvageValue usefulLifePeriods @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"DepreciationInput","url":"/reference/totalfinance/valuation/page-2#DepreciationInput","description":"The explicit depreciation coordinates every method requires.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  cost period salvageValue usefulLifePeriods @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"DiaToDjiaLevelInput","url":"/reference/totalfinance/valuation/page-2#DiaToDjiaLevelInput","description":"Three explicit prices for approximate DIA → DJIA proportional mapping.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  diaPriceLevel referenceDiaPrice referenceDjiaPrice @insiderfinance/totalfinance/valuation/price-levels"},{"title":"DiaToYmLevelInput","url":"/reference/totalfinance/valuation/page-2#DiaToYmLevelInput","description":"Three explicit prices for approximate DIA → YM proportional mapping.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  diaPriceLevel referenceDiaPrice referenceYmPrice @insiderfinance/totalfinance/valuation/price-levels"},{"title":"DiscountCashFlowsInput","url":"/reference/totalfinance/valuation/page-2#DiscountCashFlowsInput","description":"Input for {@link discountCashFlows}: per-flow present values plus their total.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualDiscountRate cashFlows compounding compounding.periodsPerYear compounding.type @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"DiscountedCashFlowAssumptions","url":"/reference/totalfinance/valuation/page-2#DiscountedCashFlowAssumptions","description":"Every assumption the valuation rests on — closed and versioned.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualDiscountRate bridgeDecision compounding compounding.periodsPerYear compounding.type contractVersion currency dayCount discountRateSour @insiderfinance/totalfinance/valuation/corporate"},{"title":"DiscountedCashFlowCommonResult","url":"/reference/totalfinance/valuation/page-2#DiscountedCashFlowCommonResult","description":"The shared core of a DCF result.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  assumptions assumptions.annualDiscountRate assumptions.bridgeDecision assumptions.compounding assumptions.compounding.periodsPerYear assumpt @insiderfinance/totalfinance/valuation/corporate"},{"title":"DiscountedCashFlowDiagnostics","url":"/reference/totalfinance/valuation/page-2#DiscountedCashFlowDiagnostics","description":"Diagnostics the valuation discloses — closed and versioned alongside the assumptions.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  exclusions projectedPeriodCount terminalValueShareOfValue warnings @insiderfinance/totalfinance/valuation/corporate"},{"title":"DiscountedCashFlowFromStatementsInput","url":"/reference/totalfinance/valuation/page-2#DiscountedCashFlowFromStatementsInput","description":"Input for {@link discountedCashFlowFromStatements}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  projection projection.baseStatements projection.baseStatements.balance projection.baseStatements.balance.accountsPayable projection.baseStat @insiderfinance/totalfinance/valuation/forecasting"},{"title":"DiscountedCashFlowFromStatementsResult","url":"/reference/totalfinance/valuation/page-2#DiscountedCashFlowFromStatementsResult","description":"Result of {@link discountedCashFlowFromStatements}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  assumptions assumptions.cashFlowsUsed assumptions.projectedPeriodCount cashFlowsUsed diagnostics diagnostics.warnings projection projection. @insiderfinance/totalfinance/valuation/forecasting"},{"title":"DiscountedCashFlowInput","url":"/reference/totalfinance/valuation/page-2#DiscountedCashFlowInput","description":"Input for {@link discountedCashFlow}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualDiscountRate compounding compounding.periodsPerYear compounding.type currency dayCount dilutedSharesOutstanding enterpriseToEquityBrid @insiderfinance/totalfinance/valuation/corporate"},{"title":"DiscountedCashFlowResult","url":"/reference/totalfinance/valuation/page-2#DiscountedCashFlowResult","description":"The basis-discriminated DCF result: FCFF → firm, FCFE → equity, never relabeled.","category":"@insiderfinance/totalfinance/valuation","kind":"type","keywords":"@insiderfinance/totalfinance/valuation type   @insiderfinance/totalfinance/valuation/corporate"},{"title":"DiscountedCashFlowRow","url":"/reference/totalfinance/valuation/page-2#DiscountedCashFlowRow","description":"One discounted flow: the input flow plus its discount factor and present value.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  amount discountFactor label presentValue timeYears @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"DiscountedCashFlowScenario","url":"/reference/totalfinance/valuation/page-2#DiscountedCashFlowScenario","description":"One named deterministic scenario: explicit overrides of the base input, nothing invented.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  overrides overrides.annualDiscountRate overrides.dayCount overrides.projectedCashFlows overrides.terminalValueMethod overrides.terminalValue @insiderfinance/totalfinance/valuation/corporate"},{"title":"DiscountedPaybackInput","url":"/reference/totalfinance/valuation/page-2#DiscountedPaybackInput","description":"Input for {@link discountedPaybackPeriod}. A separate interface rather than optional fields on\n{@link PaybackInput}: the discounted head REQUIRES its rate at ru","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualDiscountRate cashFlows compounding compounding.periodsPerYear compounding.type @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"DiscountedProjectedCashFlowRow","url":"/reference/totalfinance/valuation/page-2#DiscountedProjectedCashFlowRow","description":"One discounted projection row.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  cashFlowAmount cashFlowDate discountFactor presentValue timeYears @insiderfinance/totalfinance/valuation/corporate"},{"title":"DividendDiscountInput","url":"/reference/totalfinance/valuation/page-2#DividendDiscountInput","description":"Input for {@link dividendDiscountValuation}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualCostOfEquity compounding compounding.periodsPerYear compounding.type projectedDividendsPerShare terminalValueMethod terminalValueMetho @insiderfinance/totalfinance/valuation/corporate"},{"title":"DividendDiscountResult","url":"/reference/totalfinance/valuation/page-2#DividendDiscountResult","description":"Result of {@link dividendDiscountValuation}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  assumptions assumptions.annualCostOfEquity assumptions.compounding assumptions.compounding.periodsPerYear assumptions.compounding.type assum @insiderfinance/totalfinance/valuation/corporate"},{"title":"DjiaToDiaLevelInput","url":"/reference/totalfinance/valuation/page-3#DjiaToDiaLevelInput","description":"Three explicit prices for approximate DJIA → DIA proportional mapping.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  djiaPriceLevel referenceDiaPrice referenceDjiaPrice @insiderfinance/totalfinance/valuation/price-levels"},{"title":"EffectiveAnnualRateInput","url":"/reference/totalfinance/valuation/page-3#EffectiveAnnualRateInput","description":"Input for {@link effectiveAnnualRate}: the EAR of a nominal rate under its compounding.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  compounding compounding.periodsPerYear compounding.type nominalAnnualRate @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"EnterpriseToEquityBridge","url":"/reference/totalfinance/valuation/page-3#EnterpriseToEquityBridge","description":"The enterprise-to-equity bridge — every field explicit, none silently zeroed.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  cashAndCashEquivalents minorityInterest nonOperatingAssets preferredEquity totalDebt @insiderfinance/totalfinance/valuation/corporate"},{"title":"EnterpriseToEquityValueInput","url":"/reference/totalfinance/valuation/page-3#EnterpriseToEquityValueInput","description":"Input for {@link enterpriseToEquityValue}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  enterpriseToEquityBridge enterpriseToEquityBridge.cashAndCashEquivalents enterpriseToEquityBridge.minorityInterest enterpriseToEquityBridge. @insiderfinance/totalfinance/valuation/corporate"},{"title":"EquivalentAnnualAnnuityInput","url":"/reference/totalfinance/valuation/page-3#EquivalentAnnualAnnuityInput","description":"Input for {@link equivalentAnnualAnnuity}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualDiscountRate cashFlows compounding compounding.periodsPerYear compounding.type projectLifeYears @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"EquivalentInterestRateInput","url":"/reference/totalfinance/valuation/page-3#EquivalentInterestRateInput","description":"Input for {@link equivalentInterestRate}: re-express a rate in another convention.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualInterestRate fromCompounding fromCompounding.periodsPerYear fromCompounding.type toCompounding toCompounding.periodsPerYear toCompound @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"EsToSpyLevelInput","url":"/reference/totalfinance/valuation/page-3#EsToSpyLevelInput","description":"Three explicit prices for approximate ES → SPY proportional mapping.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  esPriceLevel referenceEsPrice referenceSpyPrice @insiderfinance/totalfinance/valuation/price-levels"},{"title":"FinancingSideEffect","url":"/reference/totalfinance/valuation/page-3#FinancingSideEffect","description":"One financing side effect: a labeled stream discounted at ITS OWN rate.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualDiscountRate cashFlows label @insiderfinance/totalfinance/valuation/corporate"},{"title":"FinancingSideEffectValue","url":"/reference/totalfinance/valuation/page-3#FinancingSideEffectValue","description":"One side effect echoed with its present value — the decomposition the method exists for.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualDiscountRate label presentValue @insiderfinance/totalfinance/valuation/corporate"},{"title":"FreeCashFlowToEquityInput","url":"/reference/totalfinance/valuation/page-3#FreeCashFlowToEquityInput","description":"Input for {@link freeCashFlowToEquity} — net borrowing is NET, not the total debt change.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  capitalExpenditure depreciationAndAmortization increaseInNetWorkingCapital netBorrowing netIncome @insiderfinance/totalfinance/valuation/corporate"},{"title":"FreeCashFlowToFirmInput","url":"/reference/totalfinance/valuation/page-3#FreeCashFlowToFirmInput","description":"Input for {@link freeCashFlowToFirm} — the exact quantities, never proxies.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  capitalExpenditure depreciationAndAmortization increaseInNetWorkingCapital operatingIncome taxRate @insiderfinance/totalfinance/valuation/corporate"},{"title":"FutureValueInput","url":"/reference/totalfinance/valuation/page-3#FutureValueInput","description":"Input for {@link futureValue}: what one present amount grows to.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualInterestRate compounding compounding.periodsPerYear compounding.type presentAmount timeYears @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"InternalRateOfReturnInput","url":"/reference/totalfinance/valuation/page-3#InternalRateOfReturnInput","description":"Input for {@link internalRateOfReturn}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  cashFlows compounding compounding.periodsPerYear compounding.type @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"InternalRateOfReturnReport","url":"/reference/totalfinance/valuation/page-3#InternalRateOfReturnReport","description":"The `.explain()` report shared by the IRR family (Law 2 envelope).","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  assumptions assumptions.asOf assumptions.compounding assumptions.compounding.periodsPerYear assumptions.compounding.type assumptions.convent @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"InternalRateRoot","url":"/reference/totalfinance/valuation/page-3#InternalRateRoot","description":"One admissible root with the residual NPV at that rate (≈ 0 by construction).","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualRate residualNetPresentValue @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"IwmToRtyLevelInput","url":"/reference/totalfinance/valuation/page-3#IwmToRtyLevelInput","description":"Three explicit prices for approximate IWM → RTY proportional mapping.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  iwmPriceLevel referenceIwmPrice referenceRtyPrice @insiderfinance/totalfinance/valuation/price-levels"},{"title":"IwmToRutLevelInput","url":"/reference/totalfinance/valuation/page-3#IwmToRutLevelInput","description":"Three explicit prices for approximate IWM → RUT proportional mapping.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  iwmPriceLevel referenceIwmPrice referenceRutPrice @insiderfinance/totalfinance/valuation/price-levels"},{"title":"LeveragedBuyoutAnalysisInput","url":"/reference/totalfinance/valuation/page-3#LeveragedBuyoutAnalysisInput","description":"Input for {@link leveragedBuyoutAnalysis}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  cashSweepFraction exit exit.exitEbitdaMultiple exit.exitFees exit.year operatingForecast sources sources.sponsorEquity sources.tranches tran @insiderfinance/totalfinance/valuation/corporate"},{"title":"LeveragedBuyoutAnalysisResult","url":"/reference/totalfinance/valuation/page-3#LeveragedBuyoutAnalysisResult","description":"Result of {@link leveragedBuyoutAnalysis}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualSchedule assumptions assumptions.disclosedSimplifications diagnostics diagnostics.warnings equityCashFlows exitBridge exitBridge.enter @insiderfinance/totalfinance/valuation/corporate"},{"title":"LeveragedBuyoutAnnualScheduleRow","url":"/reference/totalfinance/valuation/page-3#LeveragedBuyoutAnnualScheduleRow","description":"One year of the annual schedule: the operating totals plus every tranche's row.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  cashAccumulated cashSweptToDebt ebitda freeCashFlow interest taxes trancheRows year @insiderfinance/totalfinance/valuation/corporate"},{"title":"LeveragedBuyoutDebtScheduleRow","url":"/reference/totalfinance/valuation/page-4#LeveragedBuyoutDebtScheduleRow","description":"One tranche-year of the debt schedule. Closing law: ending = beginning − mandatory − sweep.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  beginningBalance cashSweep endingBalance interest mandatoryAmortization trancheName year @insiderfinance/totalfinance/valuation/corporate"},{"title":"LeveragedBuyoutDebtTrancheInput","url":"/reference/totalfinance/valuation/page-4#LeveragedBuyoutDebtTrancheInput","description":"One debt tranche in the capital structure.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualInterestRate cashSweepPriority mandatoryAmortizationFraction principal trancheName @insiderfinance/totalfinance/valuation/corporate"},{"title":"LeveragedBuyoutExitBridge","url":"/reference/totalfinance/valuation/page-4#LeveragedBuyoutExitBridge","description":"The walk from exit enterprise value to sponsor proceeds.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  enterpriseValue equityProceeds exitEbitda exitEbitdaMultiple exitFees netDebtAtExit @insiderfinance/totalfinance/valuation/corporate"},{"title":"LeveragedBuyoutExitInput","url":"/reference/totalfinance/valuation/page-4#LeveragedBuyoutExitInput","description":"Exit assumptions. `year` must equal the last forecast year.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  exitEbitdaMultiple exitFees year @insiderfinance/totalfinance/valuation/corporate"},{"title":"LeveragedBuyoutOperatingYearInput","url":"/reference/totalfinance/valuation/page-4#LeveragedBuyoutOperatingYearInput","description":"One forecast year. Years are 1..N consecutive from the close.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  capitalExpenditure ebitda increaseInNetWorkingCapital taxRate year @insiderfinance/totalfinance/valuation/corporate"},{"title":"LeveragedBuyoutSourcesAndUses","url":"/reference/totalfinance/valuation/page-4#LeveragedBuyoutSourcesAndUses","description":"Both sides of the entry, itemized — the \"sources equal uses\" law made inspectable.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  sources sources.sponsorEquity sources.totalSources sources.tranches uses uses.cashToBalanceSheet uses.purchaseEnterpriseValue uses.totalUses @insiderfinance/totalfinance/valuation/corporate"},{"title":"LeveragedBuyoutSourcesInput","url":"/reference/totalfinance/valuation/page-4#LeveragedBuyoutSourcesInput","description":"The sources side of the entry: who funds the purchase.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  sponsorEquity tranches @insiderfinance/totalfinance/valuation/corporate"},{"title":"LeveragedBuyoutTransactionInput","url":"/reference/totalfinance/valuation/page-4#LeveragedBuyoutTransactionInput","description":"The uses side of the entry: what the purchase consumes. All explicit.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  cashToBalanceSheet purchaseEnterpriseValue transactionFees @insiderfinance/totalfinance/valuation/corporate"},{"title":"LoanNumberOfPeriodsInput","url":"/reference/totalfinance/valuation/page-4#LoanNumberOfPeriodsInput","description":"Input for {@link loanNumberOfPeriods}: how long a payment takes to retire a loan.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  balloon payment paymentTiming periodicInterestRate principal @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"LoanPeriodInput","url":"/reference/totalfinance/valuation/page-4#LoanPeriodInput","description":"Input naming one period of an existing loan.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  balloon numberOfPeriods paymentTiming period periodicInterestRate principal @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"LoanPeriodicInterestRateInput","url":"/reference/totalfinance/valuation/page-4#LoanPeriodicInterestRateInput","description":"Input for {@link loanPeriodicInterestRate}: the rate implied by a known payment.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  balloon numberOfPeriods payment paymentTiming principal @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"LoanRangeInput","url":"/reference/totalfinance/valuation/page-4#LoanRangeInput","description":"Input for the two cumulative heads: an inclusive period range.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  balloon fromPeriod numberOfPeriods paymentTiming periodicInterestRate principal toPeriod @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"LoanTermsInput","url":"/reference/totalfinance/valuation/page-4#LoanTermsInput","description":"The shared loan coordinates every head below validates the same way.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  balloon numberOfPeriods paymentTiming periodicInterestRate principal @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"MarginalDistribution","url":"/reference/totalfinance/valuation/page-4#MarginalDistribution","description":"An explicit marginal distribution.","category":"@insiderfinance/totalfinance/valuation","kind":"type","keywords":"@insiderfinance/totalfinance/valuation type  from maximum mean minimum mode standardDeviation to type @insiderfinance/totalfinance/valuation/corporate"},{"title":"ModifiedInternalRateOfReturnInput","url":"/reference/totalfinance/valuation/page-4#ModifiedInternalRateOfReturnInput","description":"Input for {@link modifiedInternalRateOfReturn}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  cashFlows compounding compounding.periodsPerYear compounding.type financeRate reinvestmentRate @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"NamedPriceLevelConversionAssumptions","url":"/reference/totalfinance/valuation/page-4#NamedPriceLevelConversionAssumptions","description":"Named coordinates plus the explicit reference-price mapping supplied by a pair helper.","category":"@insiderfinance/totalfinance/valuation","kind":"type","keywords":"@insiderfinance/totalfinance/valuation type  conversion conversion.method conversion.referenceSourcePrice conversion.referenceTargetPrice conversion.sourcePriceLevel conversion.sourcePr @insiderfinance/totalfinance/valuation/price-levels"},{"title":"NdxToQqqLevelInput","url":"/reference/totalfinance/valuation/page-4#NdxToQqqLevelInput","description":"Three explicit prices for approximate NDX → QQQ proportional mapping.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  ndxPriceLevel referenceNdxPrice referenceQqqPrice @insiderfinance/totalfinance/valuation/price-levels"},{"title":"NetPresentValueInput","url":"/reference/totalfinance/valuation/page-4#NetPresentValueInput","description":"Input for {@link netPresentValue}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualDiscountRate cashFlows compounding compounding.periodsPerYear compounding.type @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"NominalAnnualRateInput","url":"/reference/totalfinance/valuation/page-4#NominalAnnualRateInput","description":"Input for {@link nominalAnnualRate}: the nominal rate whose EAR is the given effective rate.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  compounding compounding.periodsPerYear compounding.type effectiveAnnualRate @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"NqToQqqLevelInput","url":"/reference/totalfinance/valuation/page-4#NqToQqqLevelInput","description":"Three explicit prices for approximate NQ → QQQ proportional mapping.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  nqPriceLevel referenceNqPrice referenceQqqPrice @insiderfinance/totalfinance/valuation/price-levels"},{"title":"OperatingForecastInput","url":"/reference/totalfinance/valuation/page-5#OperatingForecastInput","description":"Input for {@link operatingForecast}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  baseRevenue periods @insiderfinance/totalfinance/valuation/forecasting"},{"title":"OperatingForecastPeriod","url":"/reference/totalfinance/valuation/page-5#OperatingForecastPeriod","description":"One forecast period's explicit drivers.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  capitalExpenditure capitalExpenditure.amount capitalExpenditure.fractionOfRevenue depreciationAndAmortization depreciationAndAmortization.am @insiderfinance/totalfinance/valuation/forecasting"},{"title":"OperatingForecastResult","url":"/reference/totalfinance/valuation/page-5#OperatingForecastResult","description":"Result of {@link operatingForecast}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  assumptions assumptions.baseRevenue assumptions.periods diagnostics diagnostics.warnings rows @insiderfinance/totalfinance/valuation/forecasting"},{"title":"OperatingForecastRow","url":"/reference/totalfinance/valuation/page-5#OperatingForecastRow","description":"One forecast row — every derived figure alongside the drivers that produced it.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  capitalExpenditure depreciationAndAmortization freeCashFlowToEquity freeCashFlowToEquityAbsentReason freeCashFlowToFirm increaseInNetWorking @insiderfinance/totalfinance/valuation/forecasting"},{"title":"PaybackInput","url":"/reference/totalfinance/valuation/page-5#PaybackInput","description":"Input for {@link paybackPeriod}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  cashFlows @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"PaymentTiming","url":"/reference/totalfinance/valuation/page-5#PaymentTiming","description":"When within each period the payment falls. REQUIRED — timing changes every number.","category":"@insiderfinance/totalfinance/valuation","kind":"type","keywords":"@insiderfinance/totalfinance/valuation type   @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"PresentValueInput","url":"/reference/totalfinance/valuation/page-5#PresentValueInput","description":"Input for {@link presentValue}: what one future amount is worth today.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualInterestRate compounding compounding.periodsPerYear compounding.type futureAmount timeYears @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"PriceLevelConversionAssumptions","url":"/reference/totalfinance/valuation/page-5#PriceLevelConversionAssumptions","description":"Disclosures on {@link convertPriceLevel}'s `.explain()` companion.","category":"@insiderfinance/totalfinance/valuation","kind":"type","keywords":"@insiderfinance/totalfinance/valuation type  conversion conversion.method conversion.referenceSourcePrice conversion.referenceTargetPrice conversion.sourcePriceLevel conversion.sourcePr @insiderfinance/totalfinance/valuation/price-levels"},{"title":"PriceLevelCoordinates","url":"/reference/totalfinance/valuation/page-5#PriceLevelCoordinates","description":"Coordinates shared by both methods of {@link convertPriceLevel }.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  sourcePriceLevel sourcePriceUnit targetPriceUnit @insiderfinance/totalfinance/valuation/price-levels"},{"title":"ProbabilisticDiscountedCashFlowInput","url":"/reference/totalfinance/valuation/page-5#ProbabilisticDiscountedCashFlowInput","description":"Input for {@link probabilisticDiscountedCashFlow}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  correlationMatrix discountedCashFlowInput discountedCashFlowInput.annualDiscountRate discountedCashFlowInput.compounding discountedCashFlowI @insiderfinance/totalfinance/valuation/corporate"},{"title":"ProbabilisticDiscountedCashFlowResult","url":"/reference/totalfinance/valuation/page-5#ProbabilisticDiscountedCashFlowResult","description":"Result of {@link probabilisticDiscountedCashFlow}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  assumptions assumptions.baseCase assumptions.correlationMatrix assumptions.dependence assumptions.distributions diagnostics diagnostics.warn @insiderfinance/totalfinance/valuation/corporate"},{"title":"ProfitabilityIndexInput","url":"/reference/totalfinance/valuation/page-5#ProfitabilityIndexInput","description":"Input for {@link profitabilityIndex}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualDiscountRate cashFlows compounding compounding.periodsPerYear compounding.type @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"ProjectStatementsInput","url":"/reference/totalfinance/valuation/page-5#ProjectStatementsInput","description":"Input for {@link projectFinancialStatements}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  baseStatements baseStatements.balance baseStatements.balance.accountsPayable baseStatements.balance.accountsReceivable baseStatements.balanc @insiderfinance/totalfinance/valuation/forecasting"},{"title":"ProjectStatementsResult","url":"/reference/totalfinance/valuation/page-5#ProjectStatementsResult","description":"Result of {@link projectFinancialStatements}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  assumptions assumptions.periods balancingItem diagnostics diagnostics.warnings reconciliation statements @insiderfinance/totalfinance/valuation/forecasting"},{"title":"ProjectedCashFlow","url":"/reference/totalfinance/valuation/page-5#ProjectedCashFlow","description":"One projected cash flow: dated (with the valuation-date day count) or timed.","category":"@insiderfinance/totalfinance/valuation","kind":"type","keywords":"@insiderfinance/totalfinance/valuation type  amount cashFlowDate timeYears @insiderfinance/totalfinance/valuation/corporate"},{"title":"ProjectedCashFlowSchedule","url":"/reference/totalfinance/valuation/page-5#ProjectedCashFlowSchedule","description":"One coherent projection time basis. A schedule is entirely dated or entirely year-fraction based;\nthe type rejects the mixed array the runtime has always refuse","category":"@insiderfinance/totalfinance/valuation","kind":"type","keywords":"@insiderfinance/totalfinance/valuation type   @insiderfinance/totalfinance/valuation/corporate"},{"title":"ProjectedStatements","url":"/reference/totalfinance/valuation/page-5#ProjectedStatements","description":"One projected period's three articulated statements (a closed forecast contract).","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  balance balance.accountsPayable balance.accountsReceivable balance.cashAndCashEquivalents balance.inventory balance.otherAssets balance.othe @insiderfinance/totalfinance/valuation/forecasting"},{"title":"QqqToNdxLevelInput","url":"/reference/totalfinance/valuation/page-5#QqqToNdxLevelInput","description":"Three explicit prices for approximate QQQ → NDX proportional mapping.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  qqqPriceLevel referenceNdxPrice referenceQqqPrice @insiderfinance/totalfinance/valuation/price-levels"},{"title":"QqqToNqLevelInput","url":"/reference/totalfinance/valuation/page-5#QqqToNqLevelInput","description":"Three explicit prices for approximate QQQ → NQ proportional mapping.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  qqqPriceLevel referenceNqPrice referenceQqqPrice @insiderfinance/totalfinance/valuation/price-levels"},{"title":"RandomizedVariable","url":"/reference/totalfinance/valuation/page-5#RandomizedVariable","description":"One randomized DCF variable. `'cash-flow-scale'` shocks the whole stream proportionally.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  distribution distribution.from distribution.maximum distribution.mean distribution.minimum distribution.mode distribution.standardDeviation  @insiderfinance/totalfinance/valuation/corporate"},{"title":"RatioPriceLevelInput","url":"/reference/totalfinance/valuation/page-6#RatioPriceLevelInput","description":"Proportional mapping from an explicit directed ratio.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  method sourcePriceLevel sourcePriceUnit targetPricePerSourcePrice targetPriceUnit @insiderfinance/totalfinance/valuation/price-levels"},{"title":"ReferencePriceLevelInput","url":"/reference/totalfinance/valuation/page-6#ReferencePriceLevelInput","description":"Proportional mapping from a pair of caller-supplied reference prices.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  method referenceSourcePrice referenceTargetPrice sourcePriceLevel sourcePriceUnit targetPriceUnit @insiderfinance/totalfinance/valuation/price-levels"},{"title":"ResidualIncomeInput","url":"/reference/totalfinance/valuation/page-6#ResidualIncomeInput","description":"Input for {@link residualIncomeValuation}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualCostOfEquity beginningBookValuePerShare projections terminalResidualIncome terminalResidualIncome.method terminalResidualIncome.perpet @insiderfinance/totalfinance/valuation/corporate"},{"title":"ResidualIncomeProjection","url":"/reference/totalfinance/valuation/page-6#ResidualIncomeProjection","description":"One projected clean-surplus year.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  dividendsPerShare earningsPerShare @insiderfinance/totalfinance/valuation/corporate"},{"title":"ResidualIncomeResult","url":"/reference/totalfinance/valuation/page-6#ResidualIncomeResult","description":"Result of {@link residualIncomeValuation}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  assumptions assumptions.annualCostOfEquity assumptions.cleanSurplus assumptions.terminalResidualIncome assumptions.terminalResidualIncome.me @insiderfinance/totalfinance/valuation/corporate"},{"title":"RevenueDriver","url":"/reference/totalfinance/valuation/page-6#RevenueDriver","description":"Revenue is stated directly or grown EXPLICITLY from the prior period — never extrapolated.","category":"@insiderfinance/totalfinance/valuation","kind":"type","keywords":"@insiderfinance/totalfinance/valuation type  amount growthRate @insiderfinance/totalfinance/valuation/forecasting"},{"title":"ReverseDiscountedCashFlowInput","url":"/reference/totalfinance/valuation/page-6#ReverseDiscountedCashFlowInput","description":"Input for {@link reverseDiscountedCashFlow}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  discountedCashFlowInput discountedCashFlowInput.annualDiscountRate discountedCashFlowInput.compounding discountedCashFlowInput.compounding.p @insiderfinance/totalfinance/valuation/corporate"},{"title":"ReverseDiscountedCashFlowResult","url":"/reference/totalfinance/valuation/page-6#ReverseDiscountedCashFlowResult","description":"Result of {@link reverseDiscountedCashFlow}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  assumptions assumptions.method assumptions.searchRange assumptions.searchRange.from assumptions.searchRange.to assumptions.targetValue assum @insiderfinance/totalfinance/valuation/corporate"},{"title":"ReverseDiscountedCashFlowTarget","url":"/reference/totalfinance/valuation/page-6#ReverseDiscountedCashFlowTarget","description":"The variable the reverse analysis solves for — an explicit discriminant.","category":"@insiderfinance/totalfinance/valuation","kind":"type","keywords":"@insiderfinance/totalfinance/valuation type  searchRange searchRange.from searchRange.to variable @insiderfinance/totalfinance/valuation/corporate"},{"title":"RtyToIwmLevelInput","url":"/reference/totalfinance/valuation/page-6#RtyToIwmLevelInput","description":"Three explicit prices for approximate RTY → IWM proportional mapping.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  referenceIwmPrice referenceRtyPrice rtyPriceLevel @insiderfinance/totalfinance/valuation/price-levels"},{"title":"RutToIwmLevelInput","url":"/reference/totalfinance/valuation/page-6#RutToIwmLevelInput","description":"Three explicit prices for approximate RUT → IWM proportional mapping.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  referenceIwmPrice referenceRutPrice rutPriceLevel @insiderfinance/totalfinance/valuation/price-levels"},{"title":"ScenarioAnalysisInput","url":"/reference/totalfinance/valuation/page-6#ScenarioAnalysisInput","description":"Input for {@link discountedCashFlowScenarioAnalysis}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  discountedCashFlowInput discountedCashFlowInput.annualDiscountRate discountedCashFlowInput.compounding discountedCashFlowInput.compounding.p @insiderfinance/totalfinance/valuation/corporate"},{"title":"ScenarioAnalysisResult","url":"/reference/totalfinance/valuation/page-6#ScenarioAnalysisResult","description":"Result of {@link discountedCashFlowScenarioAnalysis}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  assumptions assumptions.scenarioNames baseCase diagnostics diagnostics.warnings scenarios @insiderfinance/totalfinance/valuation/corporate"},{"title":"SensitivityAxis","url":"/reference/totalfinance/valuation/page-6#SensitivityAxis","description":"A sensitivity axis: which variable, and the explicit values to evaluate.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  values variable @insiderfinance/totalfinance/valuation/corporate"},{"title":"SensitivityTableInput","url":"/reference/totalfinance/valuation/page-6#SensitivityTableInput","description":"Input for {@link discountedCashFlowSensitivityTable}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  columnAxis columnAxis.values columnAxis.variable discountedCashFlowInput discountedCashFlowInput.annualDiscountRate discountedCashFlowInput. @insiderfinance/totalfinance/valuation/corporate"},{"title":"SensitivityTableResult","url":"/reference/totalfinance/valuation/page-6#SensitivityTableResult","description":"Result of {@link discountedCashFlowSensitivityTable}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  assumptions assumptions.cellValue assumptions.columnUnit assumptions.columnVariable assumptions.rowUnit assumptions.rowVariable baseCase cel @insiderfinance/totalfinance/valuation/corporate"},{"title":"SpxToSpyLevelInput","url":"/reference/totalfinance/valuation/page-6#SpxToSpyLevelInput","description":"Three explicit prices for approximate SPX → SPY proportional mapping.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  referenceSpxPrice referenceSpyPrice spxPriceLevel @insiderfinance/totalfinance/valuation/price-levels"},{"title":"SpyToEsLevelInput","url":"/reference/totalfinance/valuation/page-6#SpyToEsLevelInput","description":"Three explicit prices for approximate SPY → ES proportional mapping.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  referenceEsPrice referenceSpyPrice spyPriceLevel @insiderfinance/totalfinance/valuation/price-levels"},{"title":"SpyToSpxLevelInput","url":"/reference/totalfinance/valuation/page-6#SpyToSpxLevelInput","description":"Three explicit prices for approximate SPY → SPX proportional mapping.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  referenceSpxPrice referenceSpyPrice spyPriceLevel @insiderfinance/totalfinance/valuation/price-levels"},{"title":"StatementProjectionPeriod","url":"/reference/totalfinance/valuation/page-6#StatementProjectionPeriod","description":"One projected period's explicit drivers — operating AND balance-sheet.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  accountsPayable accountsPayable.amount accountsPayable.fractionOfRevenue accountsReceivable accountsReceivable.amount accountsReceivable.fra @insiderfinance/totalfinance/valuation/forecasting"},{"title":"TerminalValueInput","url":"/reference/totalfinance/valuation/page-7#TerminalValueInput","description":"Input for {@link terminalValue}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  annualDiscountRate terminalValueMethod terminalValueMethod.exitMultiple terminalValueMethod.method terminalValueMethod.perpetualGrowthRate t @insiderfinance/totalfinance/valuation/corporate"},{"title":"TerminalValueMethod","url":"/reference/totalfinance/valuation/page-7#TerminalValueMethod","description":"The terminal method — a discriminated union, and the discriminant is validated FIRST.","category":"@insiderfinance/totalfinance/valuation","kind":"type","keywords":"@insiderfinance/totalfinance/valuation type  exitMultiple method perpetualGrowthRate terminalCashFlow terminalMetricAmount @insiderfinance/totalfinance/valuation/corporate"},{"title":"TimedCashFlow","url":"/reference/totalfinance/valuation/page-7#TimedCashFlow","description":"One cash flow at a year offset from the valuation instant (`timeYears: 0`).","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  amount label timeYears @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"ValuationProvenance","url":"/reference/totalfinance/valuation/page-7#ValuationProvenance","description":"Caller-supplied provenance, echoed verbatim — a closed contract, not a bag.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  forecastIdentity restatementIdentity source statementIdentity @insiderfinance/totalfinance/valuation/corporate"},{"title":"WeightedAverageCostOfCapitalInput","url":"/reference/totalfinance/valuation/page-7#WeightedAverageCostOfCapitalInput","description":"Input for {@link weightedAverageCostOfCapital}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  components @insiderfinance/totalfinance/valuation/corporate"},{"title":"WeightedAverageCostOfCapitalResult","url":"/reference/totalfinance/valuation/page-7#WeightedAverageCostOfCapitalResult","description":"Result of {@link weightedAverageCostOfCapital}.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  assumptions assumptions.componentCount assumptions.weightBasis components diagnostics diagnostics.warnings totalCapital totalCapitalAbsentRe @insiderfinance/totalfinance/valuation/corporate"},{"title":"YmToDiaLevelInput","url":"/reference/totalfinance/valuation/page-7#YmToDiaLevelInput","description":"Three explicit prices for approximate YM → DIA proportional mapping.","category":"@insiderfinance/totalfinance/valuation","kind":"interface","keywords":"@insiderfinance/totalfinance/valuation interface  referenceDiaPrice referenceYmPrice ymPriceLevel @insiderfinance/totalfinance/valuation/price-levels"},{"title":"adjustedPresentValue","url":"/reference/totalfinance/valuation/page-7#adjustedPresentValue","description":"Adjusted present value: the unlevered operating value at the unlevered cost of capital PLUS the\npresent value of each financing side effect at its own declared ","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).compounding (input).financingSideEffects (input).unleveredCashFlows (input).unleveredCostOfCapital return.adjustedPresentVal @insiderfinance/totalfinance/valuation/corporate"},{"title":"afterTaxCostOfDebt","url":"/reference/totalfinance/valuation/page-7#afterTaxCostOfDebt","description":"After-tax cost of debt = annual pre-tax cost × (1 − marginal tax rate), plus any EXPLICIT\nunusable-tax-shield adjustment.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).annualPreTaxCostOfDebt (input).marginalTaxRate (input).unusableTaxShieldAdjustment @insiderfinance/totalfinance/valuation/corporate"},{"title":"amortizationSchedule","url":"/reference/totalfinance/valuation/page-7#amortizationSchedule","description":"The full amortization schedule. Unrounded binary64 values reconcile within arithmetic precision (closing\nbalance = opening − principal; Σ principal ≈ principal ","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).balloon (input).numberOfPeriods (input).paymentTiming (input).periodicFee (input).periodicInterestRate (input).principal ret @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"annuityPayment","url":"/reference/totalfinance/valuation/page-7#annuityPayment","description":"The level payment that amortizes `principal` down to `balloon` over `numberOfPeriods` at the\nperiodic rate, under the explicit payment timing. Positive for ever","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).balloon (input).numberOfPeriods (input).paymentTiming (input).periodicInterestRate (input).principal @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"capitalAssetPricingExpectedReturn","url":"/reference/totalfinance/valuation/page-7#capitalAssetPricingExpectedReturn","description":"Capital-asset-pricing expected return = annual risk-free rate + beta × annual market risk\npremium. The premium is supplied AS a premium — passing the market ret","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).annualMarketRiskPremium (input).annualRiskFreeRate (input).beta @insiderfinance/totalfinance/valuation/corporate"},{"title":"comparableCompanyValuation","url":"/reference/totalfinance/valuation/page-7#comparableCompanyValuation","description":"Comparable-company valuation: apply the EXPLICIT outlier policy to the peer multiples, aggregate\nthe survivors under the declared method, and price the subject'","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).aggregation (input).metricDefinition (input).metricName (input).outlierPolicy (input).peers (input).period (input).subjectMe @insiderfinance/totalfinance/valuation/corporate"},{"title":"convertPriceLevel","url":"/reference/totalfinance/valuation/page-7#convertPriceLevel","description":"Map a source price level to an approximate target level in the supplied target price unit.\n\nReference mode: `sourcePriceLevel * referenceTargetPrice / reference","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function ```ts\nimport { convertPriceLevel } from '@insiderfinance/totalfinance/valuation/price-levels';\nconst (input) (input).method (input).referenceSourcePrice (input).referenceTargetPrice (input).sourcePriceLevel (input).sourcePriceUnit (input).ta"},{"title":"costOfEquity","url":"/reference/totalfinance/valuation/page-7#costOfEquity","description":"Cost of equity under an EXPLICIT method: `'capital-asset-pricing'` (risk-free + beta × premium)\nor `'dividend-growth'` (next dividend / price + growth). The div","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).annualMarketRiskPremium (input).annualRiskFreeRate (input).beta (input).method (input).nextAnnualDividendPerShare (input).pe @insiderfinance/totalfinance/valuation/corporate"},{"title":"cumulativeLoanInterest","url":"/reference/totalfinance/valuation/page-7#cumulativeLoanInterest","description":"Total interest across an inclusive period range — SIGNED: positive for a nonnegative rate,\nnegative when the periodic rate is negative (interest credited to the","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).balloon (input).fromPeriod (input).numberOfPeriods (input).paymentTiming (input).periodicInterestRate (input).principal (inp @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"cumulativeLoanPrincipal","url":"/reference/totalfinance/valuation/page-7#cumulativeLoanPrincipal","description":"Total balance reduction across an inclusive period range — SIGNED: exceeds the payments made\nwhen the periodic rate is negative (each period's principal compone","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).balloon (input).fromPeriod (input).numberOfPeriods (input).paymentTiming (input).periodicInterestRate (input).principal (inp @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"datedInternalRateOfReturn","url":"/reference/totalfinance/valuation/page-7#datedInternalRateOfReturn","description":"The dated internal rate of return AT `asOf` — historical flows accumulate forward, future\nflows discount back, under one declared convention. `null` on no root ","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).asOf (input).cashFlows (input).compounding (input).dayCount explain explain().return.assumptions explain().return.assumption @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"datedNetPresentValue","url":"/reference/totalfinance/valuation/page-7#datedNetPresentValue","description":"Dated net present value AT `asOf`. Future flows discount back and HISTORICAL flows accumulate\nforward under the same declared convention — a realized flow is ne","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).annualDiscountRate (input).asOf (input).cashFlows (input).compounding (input).dayCount @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"decliningBalanceDepreciation","url":"/reference/totalfinance/valuation/page-7#decliningBalanceDepreciation","description":"Declining-balance charge in `period` at the explicit `factor`, floored at salvage.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).cost (input).factor (input).period (input).salvageValue (input).usefulLifePeriods @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"diaToDjiaLevel","url":"/reference/totalfinance/valuation/page-8#diaToDjiaLevel","description":"Approximate DJIA level corresponding to the supplied DIA level and reference prices.\nAssumes the proportional mapping holds; not a quote, forecast, fair value o","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function diaToDjiaLevel({ diaPriceLevel: 401.98, referenceDiaPrice: 398, referenceDjiaPrice: 40000 }); // ≈ 4 (input) (input).diaPriceLevel (input).referenceDiaPrice (input).referenceDjiaPrice explain explain().return.assumptions explain().return.dia @insiderfinance/totalfinance/valuation/price-levels"},{"title":"diaToYmLevel","url":"/reference/totalfinance/valuation/page-8#diaToYmLevel","description":"Approximate YM level corresponding to the supplied DIA level and reference prices.\nAssumes the proportional mapping holds; not a quote, forecast, fair value or ","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function diaToYmLevel({ diaPriceLevel: 401.98, referenceDiaPrice: 398, referenceYmPrice: 40000 }); // ≈ 40400 (input) (input).diaPriceLevel (input).referenceDiaPrice (input).referenceYmPrice explain explain().return.assumptions explain().return.diagn @insiderfinance/totalfinance/valuation/price-levels"},{"title":"discountCashFlows","url":"/reference/totalfinance/valuation/page-8#discountCashFlows","description":"Discount each flow individually (a supplied time-zero flow discounts by exactly 1 — included\nonce, never inferred). Rows preserve input order; `presentValueTota","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).annualDiscountRate (input).cashFlows (input).compounding return.presentValueTotal return.rows @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"discountedCashFlow","url":"/reference/totalfinance/valuation/page-8#discountedCashFlow","description":"The direct DCF: explicit projections, explicit conventions, explicit terminal method. The\ntop-level `annualDiscountRate` feeds the terminal primitive too, so a ","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).annualDiscountRate (input).compounding (input).currency (input).dayCount (input).dilutedSharesOutstanding (input).enterprise @insiderfinance/totalfinance/valuation/corporate"},{"title":"discountedCashFlowFromStatements","url":"/reference/totalfinance/valuation/page-8#discountedCashFlowFromStatements","description":"The composition the acceptance law names: project the statements, take the emitted FCFF (firm\nbasis) or FCFE (equity basis) at whole-year offsets, and hand them","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).projection (input).valuation (input).valuation.annualDiscountRate (input).valuation.compounding (input).valuation.currency ( @insiderfinance/totalfinance/valuation/forecasting"},{"title":"discountedCashFlowScenarioAnalysis","url":"/reference/totalfinance/valuation/page-8#discountedCashFlowScenarioAnalysis","description":"Named deterministic assumption sets over one base case. Each scenario is the base input with\nONLY its stated overrides replaced — scenario values are supplied, ","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).discountedCashFlowInput (input).scenarios return.assumptions return.assumptions.scenarioNames return.baseCase return.diagnos @insiderfinance/totalfinance/valuation/corporate"},{"title":"discountedCashFlowSensitivityTable","url":"/reference/totalfinance/valuation/page-8#discountedCashFlowSensitivityTable","description":"A two-axis sensitivity table where EVERY cell is a direct {@link discountedCashFlow} call with\nexactly one row and one column value substituted — no incremental","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).columnAxis (input).discountedCashFlowInput (input).rowAxis return.assumptions return.assumptions.cellValue return.assumption @insiderfinance/totalfinance/valuation/corporate"},{"title":"discountedPaybackPeriod","url":"/reference/totalfinance/valuation/page-8#discountedPaybackPeriod","description":"{@link paybackPeriod} on DISCOUNTED flows — the recovery clock respects the time value.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).annualDiscountRate (input).cashFlows (input).compounding @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"dividendDiscountValuation","url":"/reference/totalfinance/valuation/page-8#dividendDiscountValuation","description":"Present value of explicit projected dividends per share plus a terminal stage. With an EMPTY\nprojection stage and a perpetual-growth terminal (its `terminalCash","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).annualCostOfEquity (input).compounding (input).projectedDividendsPerShare (input).terminalValueMethod return.assumptions ret @insiderfinance/totalfinance/valuation/corporate"},{"title":"djiaToDiaLevel","url":"/reference/totalfinance/valuation/page-8#djiaToDiaLevel","description":"Approximate DIA level corresponding to the supplied DJIA level and reference prices.\nAssumes the proportional mapping holds; not a quote, forecast, fair value o","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function djiaToDiaLevel({ djiaPriceLevel: 40400, referenceDjiaPrice: 40000, referenceDiaPrice: 398 }); // ≈ 4 (input) (input).djiaPriceLevel (input).referenceDiaPrice (input).referenceDjiaPrice explain explain().return.assumptions explain().return.di @insiderfinance/totalfinance/valuation/price-levels"},{"title":"doubleDecliningBalanceDepreciation","url":"/reference/totalfinance/valuation/page-8#doubleDecliningBalanceDepreciation","description":"Double-declining balance: {@link decliningBalanceDepreciation} at factor 2.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).cost (input).period (input).salvageValue (input).usefulLifePeriods @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"effectiveAnnualRate","url":"/reference/totalfinance/valuation/page-8#effectiveAnnualRate","description":"Effective annual rate: the one-year growth of the nominal rate under its convention, minus 1.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).compounding (input).nominalAnnualRate @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"enterpriseToEquityValue","url":"/reference/totalfinance/valuation/page-8#enterpriseToEquityValue","description":"Equity value = enterprise value − total debt − preferred equity − minority interest + cash and\ncash equivalents + non-operating assets. The bridge is EXPLICIT: ","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).enterpriseToEquityBridge (input).enterpriseValue @insiderfinance/totalfinance/valuation/corporate"},{"title":"equivalentAnnualAnnuity","url":"/reference/totalfinance/valuation/page-8#equivalentAnnualAnnuity","description":"The level annual amount whose PV over `projectLifeYears` equals the project NPV — the standard\nyardstick for comparing projects of unequal length. The annuity f","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).annualDiscountRate (input).cashFlows (input).compounding (input).projectLifeYears @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"equivalentInterestRate","url":"/reference/totalfinance/valuation/page-8#equivalentInterestRate","description":"Re-express a rate in another convention so both produce the SAME one-year growth.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).annualInterestRate (input).fromCompounding (input).toCompounding @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"esToSpyLevel","url":"/reference/totalfinance/valuation/page-8#esToSpyLevel","description":"Approximate SPY level corresponding to the supplied ES level and reference prices.\nAssumes the proportional mapping holds; not a quote, forecast, fair value or ","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function esToSpyLevel({ esPriceLevel: 6030, referenceEsPrice: 6000, referenceSpyPrice: 596 }); // ≈ 598.98 (input) (input).esPriceLevel (input).referenceEsPrice (input).referenceSpyPrice explain explain().return.assumptions explain().return.diagno @insiderfinance/totalfinance/valuation/price-levels"},{"title":"freeCashFlowToEquity","url":"/reference/totalfinance/valuation/page-8#freeCashFlowToEquity","description":"FCFE = net income + depreciation/amortization − capital expenditure − increase in net working\ncapital + net borrowing.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).capitalExpenditure (input).depreciationAndAmortization (input).increaseInNetWorkingCapital (input).netBorrowing (input).netI @insiderfinance/totalfinance/valuation/corporate"},{"title":"freeCashFlowToFirm","url":"/reference/totalfinance/valuation/page-8#freeCashFlowToFirm","description":"FCFF = operating income × (1 − tax rate) + depreciation/amortization − capital expenditure −\nincrease in net working capital. Wants OPERATING income — handing i","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).capitalExpenditure (input).depreciationAndAmortization (input).increaseInNetWorkingCapital (input).operatingIncome (input).t @insiderfinance/totalfinance/valuation/corporate"},{"title":"futureValue","url":"/reference/totalfinance/valuation/page-8#futureValue","description":"Future value of one present amount: `presentAmount · compoundFactor(rate, t, compounding)`.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).annualInterestRate (input).compounding (input).presentAmount (input).timeYears @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"internalRateOfReturn","url":"/reference/totalfinance/valuation/page-8#internalRateOfReturn","description":"The internal rate of return of explicit timed flows, or `null` when no admissible root exists\nor MORE THAN ONE does — an ambiguous IRR is never chosen silently.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).cashFlows (input).compounding explain explain().return.assumptions explain().return.assumptions.asOf explain().return.assump @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"iwmToRtyLevel","url":"/reference/totalfinance/valuation/page-9#iwmToRtyLevel","description":"Approximate RTY level corresponding to the supplied IWM level and reference prices.\nAssumes the proportional mapping holds; not a quote, forecast, fair value or","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function iwmToRtyLevel({ iwmPriceLevel: 199.98, referenceIwmPrice: 198, referenceRtyPrice: 2000 }); // ≈ 2020 (input) (input).iwmPriceLevel (input).referenceIwmPrice (input).referenceRtyPrice explain explain().return.assumptions explain().return.diag @insiderfinance/totalfinance/valuation/price-levels"},{"title":"iwmToRutLevel","url":"/reference/totalfinance/valuation/page-9#iwmToRutLevel","description":"Approximate RUT level corresponding to the supplied IWM level and reference prices.\nAssumes the proportional mapping holds; not a quote, forecast, fair value or","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function iwmToRutLevel({ iwmPriceLevel: 199.98, referenceIwmPrice: 198, referenceRutPrice: 2000 }); // ≈ 2020 (input) (input).iwmPriceLevel (input).referenceIwmPrice (input).referenceRutPrice explain explain().return.assumptions explain().return.diag @insiderfinance/totalfinance/valuation/price-levels"},{"title":"leveragedBuyoutAnalysis","url":"/reference/totalfinance/valuation/page-9#leveragedBuyoutAnalysis","description":"Leveraged buyout analysis: entry sources/uses, an annual debt/cash schedule under mandatory\namortization plus a priority-ordered cash sweep, the exit bridge fro","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).cashSweepFraction (input).exit (input).operatingForecast (input).sources (input).transaction return.annualSchedule return.as @insiderfinance/totalfinance/valuation/corporate"},{"title":"loanInterestPayment","url":"/reference/totalfinance/valuation/page-9#loanInterestPayment","description":"Interest portion of the payment in one period — SIGNED: positive for a nonnegative rate,\nnegative when the periodic rate is negative (the period credits interes","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).balloon (input).numberOfPeriods (input).paymentTiming (input).period (input).periodicInterestRate (input).principal @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"loanNumberOfPeriods","url":"/reference/totalfinance/valuation/page-9#loanNumberOfPeriods","description":"Periods (possibly fractional) for `payment` to amortize `principal` down to `balloon`.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).balloon (input).payment (input).paymentTiming (input).periodicInterestRate (input).principal @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"loanPeriodicInterestRate","url":"/reference/totalfinance/valuation/page-9#loanPeriodicInterestRate","description":"The per-period rate that makes `payment` amortize `principal` — a PROVEN bracket on the monotone\npayment-in-rate map (geometric expansion until the sign changes","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).balloon (input).numberOfPeriods (input).payment (input).paymentTiming (input).principal @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"loanPrincipalPayment","url":"/reference/totalfinance/valuation/page-9#loanPrincipalPayment","description":"Balance reduction in one period (`payment − interest`) — SIGNED: exceeds the payment when the\nperiodic rate (and so the interest component) is negative.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).balloon (input).numberOfPeriods (input).paymentTiming (input).period (input).periodicInterestRate (input).principal @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"modifiedInternalRateOfReturn","url":"/reference/totalfinance/valuation/page-9#modifiedInternalRateOfReturn","description":"Modified IRR: negative flows discount to time zero at `financeRate`; positive flows compound to\nthe horizon at `reinvestmentRate`; the MIRR is the single rate e","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).cashFlows (input).compounding (input).financeRate (input).reinvestmentRate @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"ndxToQqqLevel","url":"/reference/totalfinance/valuation/page-9#ndxToQqqLevel","description":"Approximate QQQ level corresponding to the supplied NDX level and reference prices.\nAssumes the proportional mapping holds; not a quote, forecast, fair value or","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function ndxToQqqLevel({ ndxPriceLevel: 20250, referenceNdxPrice: 20000, referenceQqqPrice: 500 }); // ≈ 506. (input) (input).ndxPriceLevel (input).referenceNdxPrice (input).referenceQqqPrice explain explain().return.assumptions explain().return.diag @insiderfinance/totalfinance/valuation/price-levels"},{"title":"netPresentValue","url":"/reference/totalfinance/valuation/page-9#netPresentValue","description":"Net present value of explicit timed flows. A supplied `timeYears: 0` flow is included exactly\nonce at face value; no time-zero flow is ever inferred.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).annualDiscountRate (input).cashFlows (input).compounding @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"nominalAnnualRate","url":"/reference/totalfinance/valuation/page-9#nominalAnnualRate","description":"Nominal annual rate whose EAR under `compounding` equals the given effective rate.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).compounding (input).effectiveAnnualRate @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"nqToQqqLevel","url":"/reference/totalfinance/valuation/page-9#nqToQqqLevel","description":"Approximate QQQ level corresponding to the supplied NQ level and reference prices.\nAssumes the proportional mapping holds; not a quote, forecast, fair value or ","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function nqToQqqLevel({ nqPriceLevel: 20250, referenceNqPrice: 20000, referenceQqqPrice: 500 }); // ≈ 506.25 (input) (input).nqPriceLevel (input).referenceNqPrice (input).referenceQqqPrice explain explain().return.assumptions explain().return.diagno @insiderfinance/totalfinance/valuation/price-levels"},{"title":"operatingForecast","url":"/reference/totalfinance/valuation/page-9#operatingForecast","description":"Revenue, margins, taxes, working capital, capital expenditure, depreciation, and the resulting\nFCFF (and FCFE where the financing drivers are supplied) — from E","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).baseRevenue (input).periods return.assumptions return.assumptions.baseRevenue return.assumptions.periods return.diagnostics  @insiderfinance/totalfinance/valuation/forecasting"},{"title":"paybackPeriod","url":"/reference/totalfinance/valuation/page-9#paybackPeriod","description":"Years until cumulative cash flow first reaches zero (linear interpolation within the\nrecovering interval), or `null` when the outlay is never recovered.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).cashFlows @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"presentValue","url":"/reference/totalfinance/valuation/page-9#presentValue","description":"Present value of one future amount: `futureAmount · discountFactor(rate, t, compounding)`.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).annualInterestRate (input).compounding (input).futureAmount (input).timeYears @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"probabilisticDiscountedCashFlow","url":"/reference/totalfinance/valuation/page-9#probabilisticDiscountedCashFlow","description":"Monte-Carlo DCF over the DECLARED randomized variables: Gaussian dependence per the supplied\ncorrelations, inverse-CDF marginal transforms, one direct {@link di","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).correlationMatrix (input).discountedCashFlowInput (input).distributions (input).sampleCount (input).seed return.assumptions  @insiderfinance/totalfinance/valuation/corporate"},{"title":"profitabilityIndex","url":"/reference/totalfinance/valuation/page-9#profitabilityIndex","description":"PV of the positive flows ÷ PV of the outlays (positive magnitude): > 1 means value-creating at\nthe discount rate.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).annualDiscountRate (input).cashFlows (input).compounding @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"projectFinancialStatements","url":"/reference/totalfinance/valuation/page-9#projectFinancialStatements","description":"A three-statement projection from a typed historical base and explicit per-period drivers.\n\nThe articulation, written out (Δ = period change):\n\n    ΔtotalAssets","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).baseStatements (input).periods return.assumptions return.assumptions.periods return.balancingItem return.diagnostics return. @insiderfinance/totalfinance/valuation/forecasting"},{"title":"qqqToNdxLevel","url":"/reference/totalfinance/valuation/page-9#qqqToNdxLevel","description":"Approximate NDX level corresponding to the supplied QQQ level and reference prices.\nAssumes the proportional mapping holds; not a quote, forecast, fair value or","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function qqqToNdxLevel({ qqqPriceLevel: 506.25, referenceQqqPrice: 500, referenceNdxPrice: 20000 }); // ≈ 202 (input) (input).qqqPriceLevel (input).referenceNdxPrice (input).referenceQqqPrice explain explain().return.assumptions explain().return.diag @insiderfinance/totalfinance/valuation/price-levels"},{"title":"qqqToNqLevel","url":"/reference/totalfinance/valuation/page-9#qqqToNqLevel","description":"Approximate NQ level corresponding to the supplied QQQ level and reference prices.\nAssumes the proportional mapping holds; not a quote, forecast, fair value or ","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function qqqToNqLevel({ qqqPriceLevel: 506.25, referenceQqqPrice: 500, referenceNqPrice: 20000 }); // ≈ 20250 (input) (input).qqqPriceLevel (input).referenceNqPrice (input).referenceQqqPrice explain explain().return.assumptions explain().return.diagn @insiderfinance/totalfinance/valuation/price-levels"},{"title":"requireCompoundingWhenPresent","url":"/reference/totalfinance/valuation/page-10#requireCompoundingWhenPresent","description":"Shared when-present compounding ladder — the seven-form grammar, taught at the boundary.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (compounding) (functionName) @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"requireDayCountWhenPresent","url":"/reference/totalfinance/valuation/page-10#requireDayCountWhenPresent","description":"Shared when-present day-count ladder over core's ONE vocabulary.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (dayCount) (functionName) @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"residualIncomeValuation","url":"/reference/totalfinance/valuation/page-10#residualIncomeValuation","description":"Clean-surplus residual income: value = beginning book value + Σ PV(EPS_t − r × B_{t−1}) + PV of\nthe stated terminal stage. Book value rolls forward as `B_t = B_","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).annualCostOfEquity (input).beginningBookValuePerShare (input).projections (input).terminalResidualIncome (input).terminalRes @insiderfinance/totalfinance/valuation/corporate"},{"title":"reverseDiscountedCashFlow","url":"/reference/totalfinance/valuation/page-10#reverseDiscountedCashFlow","description":"Solve for the stated variable so the DCF reproduces `targetValue` (enterprise value on the firm\nbasis, equity value on equity). Bisection over the EXPLICIT sear","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).discountedCashFlowInput (input).target (input).targetValue return.assumptions return.assumptions.method return.assumptions.s @insiderfinance/totalfinance/valuation/corporate"},{"title":"rtyToIwmLevel","url":"/reference/totalfinance/valuation/page-10#rtyToIwmLevel","description":"Approximate IWM level corresponding to the supplied RTY level and reference prices.\nAssumes the proportional mapping holds; not a quote, forecast, fair value or","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function rtyToIwmLevel({ rtyPriceLevel: 2020, referenceRtyPrice: 2000, referenceIwmPrice: 198 }); // ≈ 199.98 (input) (input).referenceIwmPrice (input).referenceRtyPrice (input).rtyPriceLevel explain explain().return.assumptions explain().return.diag @insiderfinance/totalfinance/valuation/price-levels"},{"title":"rutToIwmLevel","url":"/reference/totalfinance/valuation/page-10#rutToIwmLevel","description":"Approximate IWM level corresponding to the supplied RUT level and reference prices.\nAssumes the proportional mapping holds; not a quote, forecast, fair value or","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function rutToIwmLevel({ rutPriceLevel: 2020, referenceRutPrice: 2000, referenceIwmPrice: 198 }); // ≈ 199.98 (input) (input).referenceIwmPrice (input).referenceRutPrice (input).rutPriceLevel explain explain().return.assumptions explain().return.diag @insiderfinance/totalfinance/valuation/price-levels"},{"title":"spxToSpyLevel","url":"/reference/totalfinance/valuation/page-10#spxToSpyLevel","description":"Approximate SPY level corresponding to the supplied SPX level and reference prices.\nAssumes the proportional mapping holds; not a quote, forecast, fair value or","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function spxToSpyLevel({ spxPriceLevel: 6030, referenceSpxPrice: 6000, referenceSpyPrice: 596 }); // ≈ 598.98 (input) (input).referenceSpxPrice (input).referenceSpyPrice (input).spxPriceLevel explain explain().return.assumptions explain().return.diag @insiderfinance/totalfinance/valuation/price-levels"},{"title":"spyToEsLevel","url":"/reference/totalfinance/valuation/page-10#spyToEsLevel","description":"Approximate ES level corresponding to the supplied SPY level and reference prices.\nAssumes the proportional mapping holds; not a quote, forecast, fair value or ","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function spyToEsLevel({ spyPriceLevel: 598.98, referenceSpyPrice: 596, referenceEsPrice: 6000 }); // ≈ 6030 (input) (input).referenceEsPrice (input).referenceSpyPrice (input).spyPriceLevel explain explain().return.assumptions explain().return.diagn @insiderfinance/totalfinance/valuation/price-levels"},{"title":"spyToSpxLevel","url":"/reference/totalfinance/valuation/page-10#spyToSpxLevel","description":"Approximate SPX level corresponding to the supplied SPY level and reference prices.\nAssumes the proportional mapping holds; not a quote, forecast, fair value or","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function spyToSpxLevel({ spyPriceLevel: 598.98, referenceSpyPrice: 596, referenceSpxPrice: 6000 }); // ≈ 6030 (input) (input).referenceSpxPrice (input).referenceSpyPrice (input).spyPriceLevel explain explain().return.assumptions explain().return.diag @insiderfinance/totalfinance/valuation/price-levels"},{"title":"straightLineDepreciation","url":"/reference/totalfinance/valuation/page-10#straightLineDepreciation","description":"Straight-line: the same charge every period, `(cost − salvage) / life`.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).cost (input).period (input).salvageValue (input).usefulLifePeriods @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"sumOfYearsDigitsDepreciation","url":"/reference/totalfinance/valuation/page-10#sumOfYearsDigitsDepreciation","description":"Sum-of-years'-digits charge in `period`: `(cost − salvage) · remainingLife / Σ digits`.","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).cost (input).period (input).salvageValue (input).usefulLifePeriods @insiderfinance/totalfinance/valuation/cash-flows"},{"title":"terminalValue","url":"/reference/totalfinance/valuation/page-10#terminalValue","description":"The terminal value AT the end of the forecast horizon (not yet discounted to the valuation\ndate): perpetual growth `terminalCashFlow × (1 + g) / (r − g)`, or th","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).annualDiscountRate (input).terminalValueMethod @insiderfinance/totalfinance/valuation/corporate"},{"title":"weightedAverageCostOfCapital","url":"/reference/totalfinance/valuation/page-10#weightedAverageCostOfCapital","description":"Market-value weighted average of the supplied component costs. Weights are normalized from the\nmarket values and REPORTED; a zero or negative total capital base","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function  (input) (input).components return.assumptions return.assumptions.componentCount return.assumptions.weightBasis return.components return.diag @insiderfinance/totalfinance/valuation/corporate"},{"title":"ymToDiaLevel","url":"/reference/totalfinance/valuation/page-10#ymToDiaLevel","description":"Approximate DIA level corresponding to the supplied YM level and reference prices.\nAssumes the proportional mapping holds; not a quote, forecast, fair value or ","category":"@insiderfinance/totalfinance/valuation","kind":"function","keywords":"@insiderfinance/totalfinance/valuation function ymToDiaLevel({ ymPriceLevel: 40400, referenceYmPrice: 40000, referenceDiaPrice: 398 }); // ≈ 401.98 (input) (input).referenceDiaPrice (input).referenceYmPrice (input).ymPriceLevel explain explain().return.assumptions explain().return.diagno @insiderfinance/totalfinance/valuation/price-levels"},{"title":"ConvertPriceLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#ConvertPriceLevelInputSchema","description":"Closed request schema for {@link convertPriceLevel }; select exactly one explicit method.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"DiaToDjiaLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#DiaToDjiaLevelInputSchema","description":"Closed three-price request for {@link diaToDjiaLevel }; never fetches or assumes reference prices.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"DiaToYmLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#DiaToYmLevelInputSchema","description":"Closed three-price request for {@link diaToYmLevel }; never fetches or assumes reference prices.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"DjiaToDiaLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#DjiaToDiaLevelInputSchema","description":"Closed three-price request for {@link djiaToDiaLevel }; never fetches or assumes reference prices.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"EsToSpyLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#EsToSpyLevelInputSchema","description":"Closed three-price request for {@link esToSpyLevel }; never fetches or assumes reference prices.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"IwmToRtyLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#IwmToRtyLevelInputSchema","description":"Closed three-price request for {@link iwmToRtyLevel }; never fetches or assumes reference prices.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"IwmToRutLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#IwmToRutLevelInputSchema","description":"Closed three-price request for {@link iwmToRutLevel }; never fetches or assumes reference prices.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"NdxToQqqLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#NdxToQqqLevelInputSchema","description":"Closed three-price request for {@link ndxToQqqLevel }; never fetches or assumes reference prices.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"NqToQqqLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#NqToQqqLevelInputSchema","description":"Closed three-price request for {@link nqToQqqLevel }; never fetches or assumes reference prices.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"QqqToNdxLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#QqqToNdxLevelInputSchema","description":"Closed three-price request for {@link qqqToNdxLevel }; never fetches or assumes reference prices.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"QqqToNqLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#QqqToNqLevelInputSchema","description":"Closed three-price request for {@link qqqToNqLevel }; never fetches or assumes reference prices.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"RtyToIwmLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#RtyToIwmLevelInputSchema","description":"Closed three-price request for {@link rtyToIwmLevel }; never fetches or assumes reference prices.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"RutToIwmLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#RutToIwmLevelInputSchema","description":"Closed three-price request for {@link rutToIwmLevel }; never fetches or assumes reference prices.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"SpxToSpyLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#SpxToSpyLevelInputSchema","description":"Closed three-price request for {@link spxToSpyLevel }; never fetches or assumes reference prices.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"SpyToEsLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#SpyToEsLevelInputSchema","description":"Closed three-price request for {@link spyToEsLevel }; never fetches or assumes reference prices.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"SpyToSpxLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#SpyToSpxLevelInputSchema","description":"Closed three-price request for {@link spyToSpxLevel }; never fetches or assumes reference prices.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"YmToDiaLevelInputSchema","url":"/reference/totalfinance/valuation/schemas#YmToDiaLevelInputSchema","description":"Closed three-price request for {@link ymToDiaLevel }; never fetches or assumes reference prices.","category":"@insiderfinance/totalfinance/valuation/schemas","kind":"value","keywords":"@insiderfinance/totalfinance/valuation/schemas value  describe describe(description) isOptional kind optional optional().return.describe optional().return.isOptional optional().return.kind optio"},{"title":"ArbitrageCheckOptions","url":"/reference/totalfinance/volatility#ArbitrageCheckOptions","description":"Combined knobs for reports that deliberately run both checks.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  butterflyPoints calendarPoints step tolerance @insiderfinance/totalfinance/volatility/arbitrage"},{"title":"ArbitrageKind","url":"/reference/totalfinance/volatility#ArbitrageKind","description":"type from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"type","keywords":"@insiderfinance/totalfinance/volatility type   @insiderfinance/totalfinance/volatility/arbitrage"},{"title":"ArbitrageReport","url":"/reference/totalfinance/volatility#ArbitrageReport","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  arbitrageFree assumptions assumptions.butterflyPoints assumptions.calendarPoints assumptions.conventionsVersion assumptions.step assumptions @insiderfinance/totalfinance/volatility/arbitrage"},{"title":"ArbitrageSlice","url":"/reference/totalfinance/volatility#ArbitrageSlice","description":"A single expiry slice, as the arbitrage checks see it.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  expiry forward impliedVolatility impliedVolatility(strike) strikeRange strikes timeToExpiryYears @insiderfinance/totalfinance/volatility/arbitrage"},{"title":"ArbitrageViolation","url":"/reference/totalfinance/volatility#ArbitrageViolation","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  expiry kind logMoneyness magnitude message strike @insiderfinance/totalfinance/volatility/arbitrage"},{"title":"AtmTermPoint","url":"/reference/totalfinance/volatility#AtmTermPoint","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  atmImpliedVolatility atmTotalVariance expiry timeToExpiryYears @insiderfinance/totalfinance/volatility/term"},{"title":"AtmTermStructure","url":"/reference/totalfinance/volatility#AtmTermStructure","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.coordinate calendarMonotone diagnostics diagnostics.autoReason diagnostics.converged  @insiderfinance/totalfinance/volatility/term"},{"title":"AtmVolatilityPoint","url":"/reference/totalfinance/volatility#AtmVolatilityPoint","description":"One point on the ATM-vol term structure.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  atmVolatility expiry @insiderfinance/totalfinance/volatility/earnings"},{"title":"ButterflyCheckOptions","url":"/reference/totalfinance/volatility#ButterflyCheckOptions","description":"Knobs used only by the butterfly-density scan.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  butterflyPoints step tolerance @insiderfinance/totalfinance/volatility/arbitrage"},{"title":"CalendarCheckOptions","url":"/reference/totalfinance/volatility#CalendarCheckOptions","description":"Knobs used only by the calendar total-variance scan.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  calendarPoints tolerance @insiderfinance/totalfinance/volatility/arbitrage"},{"title":"CalendarSkewAssumptions","url":"/reference/totalfinance/volatility#CalendarSkewAssumptions","description":"The conventions `calendarSkew.explain` echoes: the sorted expiry pair and the canonical step.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  conventionsVersion farExpiry farTimeToExpiryYears logMoneynessStep nearExpiry nearTimeToExpiryYears @insiderfinance/totalfinance/volatility/term"},{"title":"CalendarSkewFacade","url":"/reference/totalfinance/volatility#CalendarSkewFacade","description":"type from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"type","keywords":"@insiderfinance/totalfinance/volatility type  (from) (surface) (surface).arbitrage (surface).assumptions (surface).diagnostics (surface).essvi (surface).expiries (surface).heston (surfac @insiderfinance/totalfinance/volatility/term"},{"title":"CalibratedEvent","url":"/reference/totalfinance/volatility#CalibratedEvent","description":"One calibrated past event.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  date error impliedMove overpriced realizedMove @insiderfinance/totalfinance/volatility/earnings"},{"title":"CalibratedSwaptionNode","url":"/reference/totalfinance/volatility#CalibratedSwaptionNode","description":"A calibrated `(expiry, tenor)` node.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  atmVolatility converged expiryYears forward parameters parameters.alpha parameters.beta parameters.nu parameters.rho rmse tenorYears @insiderfinance/totalfinance/volatility/swaption-cube"},{"title":"ESSVIArbitrage","url":"/reference/totalfinance/volatility#ESSVIArbitrage","description":"No-arbitrage diagnosis of an eSSVI surface.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  butterflyArbitrageFree calendarArbitrageFree minButterflyG minCalendarSlope @insiderfinance/totalfinance/volatility/essvi"},{"title":"ESSVICalibration","url":"/reference/totalfinance/volatility#ESSVICalibration","description":"Result of {@link calibrateEssvi}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  arbitrage arbitrage.butterflyArbitrageFree arbitrage.calendarArbitrageFree arbitrage.minButterflyG arbitrage.minCalendarSlope assumptions as @insiderfinance/totalfinance/volatility/essvi"},{"title":"ESSVICalibrationInput","url":"/reference/totalfinance/volatility#ESSVICalibrationInput","description":"Input for {@link calibrateEssvi}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  slices @insiderfinance/totalfinance/volatility/essvi"},{"title":"ESSVICalibrationOptions","url":"/reference/totalfinance/volatility#ESSVICalibrationOptions","description":"Options for {@link calibrateEssvi}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  initialParameters initialParameters.phi initialParameters.phi.eta initialParameters.phi.gamma initialParameters.phi.kind initialParameters.p @insiderfinance/totalfinance/volatility/essvi"},{"title":"ESSVIParameters","url":"/reference/totalfinance/volatility#ESSVIParameters","description":"Calibrated eSSVI surface parameters — SSVI with a per-maturity skew.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  phi phi.eta phi.gamma phi.kind phi.lambda thetaTerm @insiderfinance/totalfinance/volatility/essvi"},{"title":"ESSVISliceInput","url":"/reference/totalfinance/volatility/page-2#ESSVISliceInput","description":"One maturity slice of the market surface (same shape as SSVI's).","category":"@insiderfinance/totalfinance/volatility","kind":"type","keywords":"@insiderfinance/totalfinance/volatility type  impliedVolatility k timeToExpiryYears w @insiderfinance/totalfinance/volatility/essvi"},{"title":"EventMoveCalibration","url":"/reference/totalfinance/volatility/page-2#EventMoveCalibration","description":"The straddle-implied vs realized-move calibration.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.method averageImplied averageRealized bias count diagnostics diagnostics.autoReason d @insiderfinance/totalfinance/volatility/earnings"},{"title":"EventMoveObservation","url":"/reference/totalfinance/volatility/page-2#EventMoveObservation","description":"One past event: the straddle-implied move before it and the realized move after.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  date impliedMove realizedMove @insiderfinance/totalfinance/volatility/earnings"},{"title":"EventVolatilityAtExpiryResult","url":"/reference/totalfinance/volatility/page-2#EventVolatilityAtExpiryResult","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.asOf assumptions.baseVolatility assumptions.conventionsVersion assumptions.eventDate assumptions.eventMove assumptio @insiderfinance/totalfinance/volatility/earnings"},{"title":"EventVolatilityAtExpiryRow","url":"/reference/totalfinance/volatility/page-2#EventVolatilityAtExpiryRow","description":"One evaluated expiry of {@link eventVolatilityAtExpiry}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  daysToExpiry expiry spansEvent timeToExpiryYears value @insiderfinance/totalfinance/volatility/earnings"},{"title":"EventVolatilityCalibration","url":"/reference/totalfinance/volatility/page-2#EventVolatilityCalibration","description":"The event-vol fit.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.asOf assumptions.conventionsVersion assumptions.eventDate assumptions.method baseVariance baseVolatility daysToEvent @insiderfinance/totalfinance/volatility/earnings"},{"title":"EventVolatilityDecomposition","url":"/reference/totalfinance/volatility/page-2#EventVolatilityDecomposition","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.method assumptions.timeToExpiryYears baseVariance diagnostics diagnostics.warnings ev @insiderfinance/totalfinance/volatility/event"},{"title":"ExpectedMove","url":"/reference/totalfinance/volatility/page-2#ExpectedMove","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  expectedAbsolute lower oneSigma oneSigmaFraction upper @insiderfinance/totalfinance/volatility/event"},{"title":"ExpectedMoveImpliedVolatilityInput","url":"/reference/totalfinance/volatility/page-2#ExpectedMoveImpliedVolatilityInput","description":"Input for {@link expectedMoveFromImpliedVolatility}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  impliedVolatility spot timeToExpiryYears @insiderfinance/totalfinance/volatility/event"},{"title":"ExpectedMoveStraddleInput","url":"/reference/totalfinance/volatility/page-2#ExpectedMoveStraddleInput","description":"Input for {@link expectedMoveFromStraddle}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  spot straddlePrice @insiderfinance/totalfinance/volatility/event"},{"title":"ExpiryTailRisk","url":"/reference/totalfinance/volatility/page-2#ExpiryTailRisk","description":"One expiry's model-free tail-risk moments.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  daysToExpiry excessKurtosis expiry forward skewIndex skewness strikesUsed timeToExpiryYears @insiderfinance/totalfinance/volatility/tail-risk"},{"title":"ExpiryVariance","url":"/reference/totalfinance/volatility/page-2#ExpiryVariance","description":"One expiry's model-free fair variance/vol.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  daysToExpiry expiry fairVolatility forward strikesUsed timeToExpiryYears variance @insiderfinance/totalfinance/volatility/variance-index"},{"title":"FitEventVolatilityOptions","url":"/reference/totalfinance/volatility/page-2#FitEventVolatilityOptions","description":"Inputs for {@link calibrateEventVolatility}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  asOf baseVolatility eventDate termStructure @insiderfinance/totalfinance/volatility/earnings"},{"title":"FittedExpiry","url":"/reference/totalfinance/volatility/page-2#FittedExpiry","description":"One expiry's fitted vs actual ATM vol.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  atmVolatility daysToExpiry expiry fittedVolatility residual spansEvent timeToExpiryYears @insiderfinance/totalfinance/volatility/earnings"},{"title":"ForwardSkewAssumptions","url":"/reference/totalfinance/volatility/page-2#ForwardSkewAssumptions","description":"The conventions `forwardSkew.explain` echoes: the sorted expiry pair and the applied step.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  conventionsVersion farExpiry farTimeToExpiryYears nearExpiry nearTimeToExpiryYears step @insiderfinance/totalfinance/volatility/term"},{"title":"ForwardSkewFacade","url":"/reference/totalfinance/volatility/page-2#ForwardSkewFacade","description":"type from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"type","keywords":"@insiderfinance/totalfinance/volatility type  (from) (options) (options).step (surface) (surface).arbitrage (surface).assumptions (surface).diagnostics (surface).essvi (surface).expiries @insiderfinance/totalfinance/volatility/term"},{"title":"ForwardVolatilityAssumptions","url":"/reference/totalfinance/volatility/page-2#ForwardVolatilityAssumptions","description":"The conventions `forwardVolatility.explain` echoes: the resolved (time-ordered) expiry pair.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  conventionsVersion farExpiry farTimeToExpiryYears nearExpiry nearTimeToExpiryYears @insiderfinance/totalfinance/volatility/term"},{"title":"ForwardVolatilityFacade","url":"/reference/totalfinance/volatility/page-2#ForwardVolatilityFacade","description":"type from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"type","keywords":"@insiderfinance/totalfinance/volatility type  (from) (surface) (surface).arbitrage (surface).assumptions (surface).diagnostics (surface).essvi (surface).expiries (surface).heston (surfac @insiderfinance/totalfinance/volatility/term"},{"title":"GarchFit","url":"/reference/totalfinance/volatility/page-2#GarchFit","description":"A fitted GARCH(1,1) model. `converged`/`iterations` mirror the optimizer result honestly.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  alpha assumptions assumptions.conventionsVersion assumptions.initialParameters assumptions.mean assumptions.observations beta converged diag @insiderfinance/totalfinance/volatility/forecast"},{"title":"GarchFitOptions","url":"/reference/totalfinance/volatility/page-2#GarchFitOptions","description":"Options for {@link fitGarch}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  initialParameters initialParameters.alpha initialParameters.beta mean seed @insiderfinance/totalfinance/volatility/forecast"},{"title":"GarchForecast","url":"/reference/totalfinance/volatility/page-3#GarchForecast","description":"The multi-step variance forecast produced by {@link garchForecast}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  annualizedVolatility assumptions assumptions.conventionsVersion assumptions.horizonPeriods assumptions.periodsPerYear diagnostics diagnostic @insiderfinance/totalfinance/volatility/forecast"},{"title":"GarchForecastOptions","url":"/reference/totalfinance/volatility/page-3#GarchForecastOptions","description":"Options for {@link garchForecast}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  periodsPerYear @insiderfinance/totalfinance/volatility/forecast"},{"title":"HarRvCoefficients","url":"/reference/totalfinance/volatility/page-3#HarRvCoefficients","description":"OLS coefficients of the HAR-RV regression `RVₜ = const + daily·RVᵈ + weekly·RVʷ + monthly·RVᵐ`.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  const daily monthly weekly @insiderfinance/totalfinance/volatility/forecast"},{"title":"HarRvFit","url":"/reference/totalfinance/volatility/page-3#HarRvFit","description":"A fitted HAR-RV model plus its in-sample fit diagnostics.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.method assumptions.monthly assumptions.weekly coefficients coefficients.const coeffic @insiderfinance/totalfinance/volatility/forecast"},{"title":"HarRvForecastAssumptions","url":"/reference/totalfinance/volatility/page-3#HarRvForecastAssumptions","description":"The conventions `harRvForecast.explain` echoes: the fitted windows and the forecast horizon.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  conventionsVersion horizonKind monthly weekly @insiderfinance/totalfinance/volatility/forecast"},{"title":"HarRvForecastFacade","url":"/reference/totalfinance/volatility/page-3#HarRvForecastFacade","description":"type from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"type","keywords":"@insiderfinance/totalfinance/volatility type  (fit) (fit).assumptions (fit).assumptions.conventionsVersion (fit).assumptions.method (fit).assumptions.monthly (fit).assumptions.weekly (fi @insiderfinance/totalfinance/volatility/forecast"},{"title":"HarRvOptions","url":"/reference/totalfinance/volatility/page-3#HarRvOptions","description":"Options for {@link fitHarRv}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  monthly weekly @insiderfinance/totalfinance/volatility/forecast"},{"title":"HestonSurfaceFit","url":"/reference/totalfinance/volatility/page-3#HestonSurfaceFit","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.initialParameters assumptions.maximumIterations assumptions.targets converged diagnos @insiderfinance/totalfinance/volatility/heston-surface"},{"title":"HestonSurfaceMarket","url":"/reference/totalfinance/volatility/page-3#HestonSurfaceMarket","description":"The state of the world for {@link calibrateHestonSurface}: spot and the carry rates.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  dividendYield riskFreeRate spot @insiderfinance/totalfinance/volatility/heston-surface"},{"title":"HestonSurfaceTarget","url":"/reference/totalfinance/volatility/page-3#HestonSurfaceTarget","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  forward impliedVolatility strike timeToExpiryYears @insiderfinance/totalfinance/volatility/heston-surface"},{"title":"ImpliedVolatilityStatistics","url":"/reference/totalfinance/volatility/page-3#ImpliedVolatilityStatistics","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  current max mean min observations percentile rank @insiderfinance/totalfinance/volatility/metrics"},{"title":"LocalVolatilitySurface","url":"/reference/totalfinance/volatility/page-3#LocalVolatilitySurface","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  grid grid(specification) grid(specification).levels grid(specification).times localVolatility localVolatility(level) localVolatility(timeToE @insiderfinance/totalfinance/volatility/local-volatility"},{"title":"MinimumVarianceDeltaOptions","url":"/reference/totalfinance/volatility/page-3#MinimumVarianceDeltaOptions","description":"Inputs for {@link minimumVarianceDelta}. Provide exactly one of `volatilitySpotBeta` or `skewSlope`.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  dividendYield regime riskFreeRate skewSlope spot strike timeToExpiryYears type volatility volatilitySpotBeta @insiderfinance/totalfinance/volatility/min-variance-delta"},{"title":"MinimumVarianceDeltaResult","url":"/reference/totalfinance/volatility/page-3#MinimumVarianceDeltaResult","description":"The minimum-variance delta read-out.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  blackScholesDelta minimumVarianceDelta skewAdjustment vega volatilitySpotBeta @insiderfinance/totalfinance/volatility/min-variance-delta"},{"title":"ObservedSkewAssumptions","url":"/reference/totalfinance/volatility/page-3#ObservedSkewAssumptions","description":"type from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"type","keywords":"@insiderfinance/totalfinance/volatility type  atmMethod deltaSource deltaTolerance duplicatePolicy impliedVolatilitySource minimumContracts riskReversalConvention slopeMethod slopeWindow"},{"title":"ObservedSkewAtm","url":"/reference/totalfinance/volatility/page-3#ObservedSkewAtm","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  impliedVolatility observations strike"},{"title":"ObservedSkewConfig","url":"/reference/totalfinance/volatility/page-3#ObservedSkewConfig","description":"Canonical quote plus vendor delta. Records are open to vendor decoration, never mutated.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  deltaTolerance expiry minimumContracts riskReversalConvention slopeWindow tailDeltaTolerance"},{"title":"ObservedSkewInput","url":"/reference/totalfinance/volatility/page-4#ObservedSkewInput","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  config config.deltaTolerance config.expiry config.minimumContracts config.riskReversalConvention config.slopeWindow config.tailDeltaToleranc"},{"title":"ObservedSkewMetrics","url":"/reference/totalfinance/volatility/page-4#ObservedSkewMetrics","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  atm atm.impliedVolatility atm.observations atm.strike butterfly10Delta butterfly25Delta call10Delta call10Delta.nearestDeltaDistance call10D"},{"title":"ObservedSkewObservation","url":"/reference/totalfinance/volatility/page-4#ObservedSkewObservation","description":"An actual supplied observation. quoteIndex traces back to the original input, not a sorted copy.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  delta impliedVolatility openInterest quoteIndex strike timestampMs type"},{"title":"ObservedSkewResult","url":"/reference/totalfinance/volatility/page-4#ObservedSkewResult","description":"type from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"type","keywords":"@insiderfinance/totalfinance/volatility type  assumptions assumptions.asOf assumptions.atmMethod assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.comp"},{"title":"ObservedSkewSmilePoint","url":"/reference/totalfinance/volatility/page-4#ObservedSkewSmilePoint","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  call call.delta call.impliedVolatility call.openInterest call.quoteIndex call.strike call.timestampMs call.type impliedVolatilityVsAtm money"},{"title":"ObservedSkewUnavailableReason","url":"/reference/totalfinance/volatility/page-4#ObservedSkewUnavailableReason","description":"Reasons are data availability, not malformed-input errors (which throw typed InputError).","category":"@insiderfinance/totalfinance/volatility","kind":"type","keywords":"@insiderfinance/totalfinance/volatility type  "},{"title":"ObservedSkewWing","url":"/reference/totalfinance/volatility/page-4#ObservedSkewWing","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  nearestDeltaDistance selected selected.delta selected.impliedVolatility selected.openInterest selected.quoteIndex selected.strike selected.t"},{"title":"ProbabilityInTheMoneyInput","url":"/reference/totalfinance/volatility/page-4#ProbabilityInTheMoneyInput","description":"Input for {@link probabilityInTheMoney}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  dividendYield riskFreeRate spot strike timeToExpiryYears type volatility @insiderfinance/totalfinance/volatility/event"},{"title":"ProbabilityOfTouchInput","url":"/reference/totalfinance/volatility/page-4#ProbabilityOfTouchInput","description":"Input for {@link probabilityOfTouch}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  barrier dividendYield riskFreeRate spot timeToExpiryYears volatility @insiderfinance/totalfinance/volatility/event"},{"title":"RISK_NEUTRAL_ESTIMATE","url":"/reference/totalfinance/volatility/page-4#RISK_NEUTRAL_ESTIMATE","description":"The standard \"this is a risk-neutral model estimate, not a real-world forecast\" caveat.","category":"@insiderfinance/totalfinance/volatility","kind":"value","keywords":"@insiderfinance/totalfinance/volatility value  code context message severity @insiderfinance/totalfinance/volatility/estimate"},{"title":"RiskNeutralDistribution","url":"/reference/totalfinance/volatility/page-4#RiskNeutralDistribution","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  cdf cdf(strike) density density(strike) diagnostics diagnostics.autoReason diagnostics.converged diagnostics.decomposition diagnostics.engin @insiderfinance/totalfinance/volatility/analytics"},{"title":"RiskNeutralOptions","url":"/reference/totalfinance/volatility/page-4#RiskNeutralOptions","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  dividendYield riskFreeRate spot step timeToExpiryYears @insiderfinance/totalfinance/volatility/analytics"},{"title":"RiskReversalButterfly","url":"/reference/totalfinance/volatility/page-4#RiskReversalButterfly","description":"The risk-reversal / butterfly decomposition of a smile.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.delta assumptions.deltaConvention atmVolatility butterfly callStrike callVolatility d @insiderfinance/totalfinance/volatility/risk-reversal"},{"title":"RiskReversalButterflyInput","url":"/reference/totalfinance/volatility/page-4#RiskReversalButterflyInput","description":"Input for {@link riskReversalButterfly}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  delta forward smile smile(strike) timeToExpiryYears @insiderfinance/totalfinance/volatility/risk-reversal"},{"title":"RiskReversalConvention","url":"/reference/totalfinance/volatility/page-4#RiskReversalConvention","description":"type from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"type","keywords":"@insiderfinance/totalfinance/volatility type   @insiderfinance/totalfinance/volatility/skew"},{"title":"SABRCalibrationOptions","url":"/reference/totalfinance/volatility/page-4#SABRCalibrationOptions","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  beta initialParameters initialParameters.alpha initialParameters.nu initialParameters.rho maximumIterations tolerance volatilityType @insiderfinance/totalfinance/volatility/sabr"},{"title":"SABRCalibrationResult","url":"/reference/totalfinance/volatility/page-4#SABRCalibrationResult","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.beta assumptions.conventionsVersion assumptions.initialParameters assumptions.volatilityType converged diagnostics d @insiderfinance/totalfinance/volatility/sabr"},{"title":"SABRSmileInput","url":"/reference/totalfinance/volatility/page-4#SABRSmileInput","description":"Market smile input for {@link calibrateSabrSmile}: the forward, and aligned strikes/impliedVolatilities at one expiry.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  forward impliedVolatilities strikes timeToExpiryYears @insiderfinance/totalfinance/volatility/sabr"},{"title":"SSVIArbitrage","url":"/reference/totalfinance/volatility/page-4#SSVIArbitrage","description":"No-arbitrage diagnosis of an SSVI surface.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  butterflyArbitrageFree calendarArbitrageFree minButterflyG sufficientConditionsHold @insiderfinance/totalfinance/volatility/ssvi"},{"title":"SSVICalibration","url":"/reference/totalfinance/volatility/page-4#SSVICalibration","description":"Result of {@link calibrateSsvi}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  arbitrage arbitrage.butterflyArbitrageFree arbitrage.calendarArbitrageFree arbitrage.minButterflyG arbitrage.sufficientConditionsHold assump @insiderfinance/totalfinance/volatility/ssvi"},{"title":"SSVICalibrationInput","url":"/reference/totalfinance/volatility/page-5#SSVICalibrationInput","description":"Input for {@link calibrateSsvi}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  slices @insiderfinance/totalfinance/volatility/ssvi"},{"title":"SSVICalibrationOptions","url":"/reference/totalfinance/volatility/page-5#SSVICalibrationOptions","description":"Options for {@link calibrateSsvi}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  initialParameters initialParameters.phi initialParameters.phi.eta initialParameters.phi.gamma initialParameters.phi.kind initialParameters.p @insiderfinance/totalfinance/volatility/ssvi"},{"title":"SSVIParameters","url":"/reference/totalfinance/volatility/page-5#SSVIParameters","description":"Calibrated SSVI surface parameters.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  phi phi.eta phi.gamma phi.kind phi.lambda rho thetaTerm @insiderfinance/totalfinance/volatility/ssvi"},{"title":"SSVIPhi","url":"/reference/totalfinance/volatility/page-5#SSVIPhi","description":"The SSVI curvature function `φ(θ)`.","category":"@insiderfinance/totalfinance/volatility","kind":"type","keywords":"@insiderfinance/totalfinance/volatility type  eta gamma kind lambda @insiderfinance/totalfinance/volatility/ssvi"},{"title":"SSVISliceInput","url":"/reference/totalfinance/volatility/page-5#SSVISliceInput","description":"One maturity slice of the market surface.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  impliedVolatility k timeToExpiryYears w @insiderfinance/totalfinance/volatility/ssvi"},{"title":"SURFACE_SCHEMA_VERSION","url":"/reference/totalfinance/volatility/page-5#SURFACE_SCHEMA_VERSION","description":"Schema version stamped onto every {@link VolatilitySurface#toJSON } snapshot; checked on restore (WS4.4).","category":"@insiderfinance/totalfinance/volatility","kind":"value","keywords":"@insiderfinance/totalfinance/volatility value   @insiderfinance/totalfinance/volatility/surface"},{"title":"SVICalibrationOptions","url":"/reference/totalfinance/volatility/page-5#SVICalibrationOptions","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  initialParameters initialParameters.m initialParameters.sigma maximumIterations timeToExpiryYears tolerance @insiderfinance/totalfinance/volatility/svi"},{"title":"SVICalibrationResult","url":"/reference/totalfinance/volatility/page-5#SVICalibrationResult","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.initialParameters assumptions.method assumptions.points butterflyFree converged diagn @insiderfinance/totalfinance/volatility/svi"},{"title":"SVIParameters","url":"/reference/totalfinance/volatility/page-5#SVIParameters","description":"Raw-SVI parameters (Gatheral). `a`,`b`,`σ` carry total-variance units; `m`,`k` are log-moneyness.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  a b m rho sigma @insiderfinance/totalfinance/volatility/svi"},{"title":"SVISmileInput","url":"/reference/totalfinance/volatility/page-5#SVISmileInput","description":"Total-variance smile input for {@link calibrateSvi}: log-moneyness `k` and total variance `w` points.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  k w @insiderfinance/totalfinance/volatility/svi"},{"title":"SVIWarmStart","url":"/reference/totalfinance/volatility/page-5#SVIWarmStart","description":"A warm start for {@link calibrateSvi}: the two FREE members of the outer search, in the canonical\nSVI spelling (`m` is the smile's centre, `σ` its smoothness). ","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  m sigma @insiderfinance/totalfinance/volatility/svi"},{"title":"SabrBartlettGreeks","url":"/reference/totalfinance/volatility/page-5#SabrBartlettGreeks","description":"The Bartlett (minimum-variance) SABR greeks, alongside the naive SABR greeks they adjust.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  bartlettDelta bartlettGamma bartlettVega deltaAdjustment gammaAdjustment impliedVolatility sabrDelta sabrGamma sabrVega vegaAdjustment @insiderfinance/totalfinance/volatility/sabr-delta"},{"title":"SabrBartlettOptions","url":"/reference/totalfinance/volatility/page-5#SabrBartlettOptions","description":"Knobs for {@link sabrBartlettGreeks}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  volatilityType @insiderfinance/totalfinance/volatility/sabr-delta"},{"title":"SkewConfig","url":"/reference/totalfinance/volatility/page-5#SkewConfig","description":"Non-market skew configuration: which expiry, the price source, model, and RR convention (WS3.2).","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  expiry model priceSource riskReversalConvention @insiderfinance/totalfinance/volatility/skew"},{"title":"SkewMarket","url":"/reference/totalfinance/volatility/page-5#SkewMarket","description":"Market snapshot for `skew()` — the workspace-canonical {@link MarketInputs}, except `spot` is\noptional (it falls back to each quote's `underlyingPrice` when omi","category":"@insiderfinance/totalfinance/volatility","kind":"type","keywords":"@insiderfinance/totalfinance/volatility type  asOf dividendYield riskFreeRate spot @insiderfinance/totalfinance/volatility/skew"},{"title":"SkewMetrics","url":"/reference/totalfinance/volatility/page-5#SkewMetrics","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  atmImpliedVolatility butterfly10Delta butterfly25Delta call10DeltaImpliedVolatility call25DeltaImpliedVolatility callSkew expiry forward put @insiderfinance/totalfinance/volatility/skew"},{"title":"SkewResult","url":"/reference/totalfinance/volatility/page-5#SkewResult","description":"type from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"type","keywords":"@insiderfinance/totalfinance/volatility type  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/volatility/skew"},{"title":"SmileAnchors","url":"/reference/totalfinance/volatility/page-5#SmileAnchors","description":"The three `(strike, vol)` smile anchors implied by the quotes.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.delta assumptions.deltaConvention atmStrike atmVolatility callStrike callVolatility d @insiderfinance/totalfinance/volatility/risk-reversal"},{"title":"SmileFromQuotesInput","url":"/reference/totalfinance/volatility/page-5#SmileFromQuotesInput","description":"Input for {@link smileFromQuotes}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  atmVolatility butterfly delta forward riskReversal timeToExpiryYears @insiderfinance/totalfinance/volatility/risk-reversal"},{"title":"StickyRegime","url":"/reference/totalfinance/volatility/page-5#StickyRegime","description":"The measured regime.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.skewSlope diagnostics diagnostics.autoReason diagnostics.converged diagnostics.decomp @insiderfinance/totalfinance/volatility/sticky-regime"},{"title":"StickyRegimeInput","url":"/reference/totalfinance/volatility/page-6#StickyRegimeInput","description":"Inputs for {@link stickyRegime}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  fixedStrikeVolatility skewSlope spot @insiderfinance/totalfinance/volatility/sticky-regime"},{"title":"SurfaceConfig","url":"/reference/totalfinance/volatility/page-6#SurfaceConfig","description":"Non-market surface configuration: price source, model, and per-model calibration knobs (WS3.2).","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  cosineExpansionTerms essviPhi essviWeight hestonInitialParameters hestonInitialParameters.kappa hestonInitialParameters.rho hestonInitialPar @insiderfinance/totalfinance/volatility/surface"},{"title":"SurfaceLookup","url":"/reference/totalfinance/volatility/page-6#SurfaceLookup","description":"Result of a surface lookup: the IV plus whether the query was extrapolated.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/volatility/surface"},{"title":"SurfaceMarket","url":"/reference/totalfinance/volatility/page-6#SurfaceMarket","description":"Market snapshot for `volatilitySurface()` — the workspace-canonical {@link MarketInputs}, except `spot` is\noptional (it falls back to each quote's `underlyingPr","category":"@insiderfinance/totalfinance/volatility","kind":"type","keywords":"@insiderfinance/totalfinance/volatility type  asOf dividendYield riskFreeRate spot @insiderfinance/totalfinance/volatility/surface"},{"title":"SurfaceMode","url":"/reference/totalfinance/volatility/page-6#SurfaceMode","description":"One principal mode of surface motion.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  eigenvalue loadings scores shape varianceExplained @insiderfinance/totalfinance/volatility/surface-pca"},{"title":"SurfaceModel","url":"/reference/totalfinance/volatility/page-6#SurfaceModel","description":"`raw`/`interpolated`/`smoothed` are non-parametric (linear, PCHIP, and a Gaussian-kernel smoother);\n`svi`/`sabr` fit a parametric smile per expiry; `heston` cal","category":"@insiderfinance/totalfinance/volatility","kind":"type","keywords":"@insiderfinance/totalfinance/volatility type   @insiderfinance/totalfinance/volatility/surface"},{"title":"SurfacePcaInput","url":"/reference/totalfinance/volatility/page-6#SurfacePcaInput","description":"Inputs for {@link surfacePCA}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  changes gridPoints maxComponents snapshots @insiderfinance/totalfinance/volatility/surface-pca"},{"title":"SurfacePcaResult","url":"/reference/totalfinance/volatility/page-6#SurfacePcaResult","description":"Result of {@link surfacePCA}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.changeType assumptions.conventionsVersion assumptions.ordered changeType cumulativeVarianceExplained diagnostics dia @insiderfinance/totalfinance/volatility/surface-pca"},{"title":"SurfacePcaScenarioInput","url":"/reference/totalfinance/volatility/page-6#SurfacePcaScenarioInput","description":"Inputs for {@link surfacePcaScenarios}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  base combined floor maxModes pca pca.assumptions pca.assumptions.changeType pca.assumptions.conventionsVersion pca.assumptions.ordered pca.c @insiderfinance/totalfinance/volatility/surface-pca"},{"title":"SurfacePcaScenarios","url":"/reference/totalfinance/volatility/page-6#SurfacePcaScenarios","description":"Result of {@link surfacePcaScenarios}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.changeType assumptions.conventionsVersion assumptions.floor base combinedSurface diagnostics diagnostics.autoReason  @insiderfinance/totalfinance/volatility/surface-pca"},{"title":"SurfacePoint","url":"/reference/totalfinance/volatility/page-6#SurfacePoint","description":"A raw solved surface point before smoothing.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  expiry impliedVolatility strike timeToExpiryYears type @insiderfinance/totalfinance/volatility/surface"},{"title":"SurfaceRow","url":"/reference/totalfinance/volatility/page-6#SurfaceRow","description":"One chart-facing row from {@link VolatilitySurface#toRows } — the smile-chart / heatmap feed. Per the\nworkspace missing-value policy (WS2.12), every chart-facin","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  delta expiry impliedVolatility logMoneyness strike @insiderfinance/totalfinance/volatility/surface"},{"title":"SurfaceScenario","url":"/reference/totalfinance/volatility/page-6#SurfaceScenario","description":"One shocked-surface scenario (a `sigma`-standard-deviation move along one mode).","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  mode shape shockVector shockedSurface sigma @insiderfinance/totalfinance/volatility/surface-pca"},{"title":"SurfaceShock","url":"/reference/totalfinance/volatility/page-6#SurfaceShock","description":"A vol-structure shock echoed in a shocked surface's {@link VolatilitySurface.assumptions} (WS4.4).","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  parallel skewTilt sticky @insiderfinance/totalfinance/volatility/surface"},{"title":"SurfaceSlice","url":"/reference/totalfinance/volatility/page-6#SurfaceSlice","description":"One per-expiry smile, strikes ascending.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  deltas essvi essvi.phi essvi.phi.eta essvi.phi.gamma essvi.phi.kind essvi.phi.lambda essvi.thetaTerm expiry forward heston heston.kappa hest @insiderfinance/totalfinance/volatility/surface"},{"title":"SwaptionCube","url":"/reference/totalfinance/volatility/page-6#SwaptionCube","description":"The calibrated swaption cube (data-only, serializable).","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.backbone assumptions.conventionsVersion assumptions.shift assumptions.volatilityType diagnostics diagnostics.autoRea @insiderfinance/totalfinance/volatility/swaption-cube"},{"title":"SwaptionCubeInput","url":"/reference/totalfinance/volatility/page-6#SwaptionCubeInput","description":"Input for {@link swaptionCube}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  beta maximumIterations nodes shift tolerance volatilityType @insiderfinance/totalfinance/volatility/swaption-cube"},{"title":"SwaptionCubeNode","url":"/reference/totalfinance/volatility/page-6#SwaptionCubeNode","description":"One market `(expiry, tenor)` node: a forward swap rate and a smile.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  beta expiryYears forward strikes tenorYears volatilities @insiderfinance/totalfinance/volatility/swaption-cube"},{"title":"SwaptionCubeVolatilityQuery","url":"/reference/totalfinance/volatility/page-6#SwaptionCubeVolatilityQuery","description":"Query for {@link swaptionCubeVolatility}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  cube cube.assumptions cube.assumptions.backbone cube.assumptions.conventionsVersion cube.assumptions.shift cube.assumptions.volatilityType c @insiderfinance/totalfinance/volatility/swaption-cube"},{"title":"SwaptionCubeVolatilityResult","url":"/reference/totalfinance/volatility/page-6#SwaptionCubeVolatilityResult","description":"The interpolated implied vol at a cube point.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.interpolation assumptions.shift assumptions.volatilityType diagnostics diagnostics.au @insiderfinance/totalfinance/volatility/swaption-cube"},{"title":"TailRiskOptions","url":"/reference/totalfinance/volatility/page-7#TailRiskOptions","description":"Inputs for {@link tailRiskIndex}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  asOf horizonDays quotes riskFreeRate spot @insiderfinance/totalfinance/volatility/tail-risk"},{"title":"TailRiskResult","url":"/reference/totalfinance/volatility/page-7#TailRiskResult","description":"The tail-risk read-out.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.horizonDays assumptions.measure assumptions.method diagnostics diagnostics.autoReason @insiderfinance/totalfinance/volatility/tail-risk"},{"title":"VannaVolga5Density","url":"/reference/totalfinance/volatility/page-7#VannaVolga5Density","description":"The 5-pillar-implied risk-neutral terminal distribution and its moments.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.measure assumptions.method assumptions.smile cdf cdf(strike) density density(strike)  @insiderfinance/totalfinance/volatility/vanna-volga"},{"title":"VannaVolga5DensityInput","url":"/reference/totalfinance/volatility/page-7#VannaVolga5DensityInput","description":"Input for {@link vannaVolga5Density} — the five vanna-volga quotes plus the density grid controls.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  atmVolatility butterfly10 butterfly25 forward gridPoints innerDelta outerDelta riskReversal10 riskReversal25 step timeToExpiryYears widthSta @insiderfinance/totalfinance/volatility/vanna-volga"},{"title":"VannaVolga5Input","url":"/reference/totalfinance/volatility/page-7#VannaVolga5Input","description":"Input for {@link calibrateVannaVolga5}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  atmVolatility butterfly10 butterfly25 forward innerDelta outerDelta riskReversal10 riskReversal25 strikes timeToExpiryYears wingExtrapolatio @insiderfinance/totalfinance/volatility/vanna-volga"},{"title":"VannaVolga5Pillar","url":"/reference/totalfinance/volatility/page-7#VannaVolga5Pillar","description":"One of the five market pillars a {@link VannaVolga5Smile} reprices exactly.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  delta kind strike volatility @insiderfinance/totalfinance/volatility/vanna-volga"},{"title":"VannaVolga5Smile","url":"/reference/totalfinance/volatility/page-7#VannaVolga5Smile","description":"The 5-pillar smile and the pillars it reprices.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.deltaConvention assumptions.interpolation assumptions.method assumptions.wingExtrapol @insiderfinance/totalfinance/volatility/vanna-volga"},{"title":"VannaVolgaApproximationInput","url":"/reference/totalfinance/volatility/page-7#VannaVolgaApproximationInput","description":"Input for {@link vannaVolgaApproximation} — the vanna-volga input plus the CM order.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  atmVolatility butterfly delta forward order riskReversal strikes timeToExpiryYears @insiderfinance/totalfinance/volatility/vanna-volga"},{"title":"VannaVolgaApproximationSmile","url":"/reference/totalfinance/volatility/page-7#VannaVolgaApproximationSmile","description":"The Castagna–Mercurio-approximated smile and the pillars it reprices.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.delta assumptions.deltaConvention assumptions.method assumptions.order delta diagnost @insiderfinance/totalfinance/volatility/vanna-volga"},{"title":"VannaVolgaDensity","url":"/reference/totalfinance/volatility/page-7#VannaVolgaDensity","description":"The vanna-volga-implied risk-neutral terminal distribution and its moments.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.measure assumptions.method assumptions.order assumptions.smile cdf cdf(strike) densit @insiderfinance/totalfinance/volatility/vanna-volga"},{"title":"VannaVolgaDensityInput","url":"/reference/totalfinance/volatility/page-7#VannaVolgaDensityInput","description":"Input for {@link vannaVolgaDensity} — the vanna-volga quotes plus the density grid controls.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  atmVolatility butterfly delta forward gridPoints order riskReversal step timeToExpiryYears widthStandardDeviations @insiderfinance/totalfinance/volatility/vanna-volga"},{"title":"VannaVolgaInput","url":"/reference/totalfinance/volatility/page-7#VannaVolgaInput","description":"Input for {@link calibrateVannaVolga}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  atmVolatility butterfly delta forward riskReversal strikes timeToExpiryYears @insiderfinance/totalfinance/volatility/vanna-volga"},{"title":"VannaVolgaSmile","url":"/reference/totalfinance/volatility/page-7#VannaVolgaSmile","description":"The vanna–volga-constructed smile and the pillars it reprices.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.delta assumptions.deltaConvention assumptions.method delta diagnostics diagnostics.au @insiderfinance/totalfinance/volatility/vanna-volga"},{"title":"VarianceIndexOptions","url":"/reference/totalfinance/volatility/page-7#VarianceIndexOptions","description":"Inputs for {@link varianceIndex}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  asOf dividendYield horizonDays quotes riskFreeRate spot @insiderfinance/totalfinance/volatility/variance-index"},{"title":"VarianceIndexResult","url":"/reference/totalfinance/volatility/page-7#VarianceIndexResult","description":"The variance-index read-out.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.horizonDays assumptions.measure assumptions.method diagnostics diagnostics.autoReason @insiderfinance/totalfinance/volatility/variance-index"},{"title":"VarianceRiskPremiumPoint","url":"/reference/totalfinance/volatility/page-7#VarianceRiskPremiumPoint","description":"One expiry's variance-risk-premium point.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  daysToExpiry expiry fairVolatility forward realizedVolatility strikesUsed timeToExpiryYears variance varianceRiskPremium volatilitySpread @insiderfinance/totalfinance/volatility/variance-index"},{"title":"VarianceRiskPremiumTermStructureOptions","url":"/reference/totalfinance/volatility/page-7#VarianceRiskPremiumTermStructureOptions","description":"Inputs for {@link varianceRiskPremiumTermStructure}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  asOf dividendYield horizonDays quotes realizedVolatility riskFreeRate spot @insiderfinance/totalfinance/volatility/variance-index"},{"title":"VarianceRiskPremiumTermStructureResult","url":"/reference/totalfinance/volatility/page-7#VarianceRiskPremiumTermStructureResult","description":"The VRP term-structure read-out.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.conventionsVersion assumptions.measure assumptions.method diagnostics diagnostics.autoReason diagnostics.converged d @insiderfinance/totalfinance/volatility/variance-index"},{"title":"VarianceSwapResult","url":"/reference/totalfinance/volatility/page-7#VarianceSwapResult","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  fairVolatility variance @insiderfinance/totalfinance/volatility/analytics"},{"title":"VolatilityConeAssumptions","url":"/reference/totalfinance/volatility/page-7#VolatilityConeAssumptions","description":"The conventions `volatilityCone.explain` echoes: the applied windows and annualization.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  annualization conventionsVersion periodsPerYear windows @insiderfinance/totalfinance/volatility/analytics"},{"title":"VolatilityConeFacade","url":"/reference/totalfinance/volatility/page-8#VolatilityConeFacade","description":"type from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"type","keywords":"@insiderfinance/totalfinance/volatility type  (options) (options).periodsPerYear (options).windows (returns) explain explain().return.assumptions explain().return.diagnostics explain().r @insiderfinance/totalfinance/volatility/analytics"},{"title":"VolatilityConeWindow","url":"/reference/totalfinance/volatility/page-8#VolatilityConeWindow","description":"interface from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  current max median min p25 p75 window @insiderfinance/totalfinance/volatility/analytics"},{"title":"VolatilitySpotBeta","url":"/reference/totalfinance/volatility/page-8#VolatilitySpotBeta","description":"The empirical vol–spot β and its regression diagnostics.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  correlation dropped observationCount rSquared referenceSpot slope slopeStandardError slopeTStatistic volatilitySpotBeta @insiderfinance/totalfinance/volatility/volatility-spot-beta"},{"title":"VolatilitySpotBetaInput","url":"/reference/totalfinance/volatility/page-8#VolatilitySpotBetaInput","description":"Input for {@link estimateVolatilitySpotBeta}.","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  basis hacLags impliedVolatility referenceSpot spot @insiderfinance/totalfinance/volatility/volatility-spot-beta"},{"title":"VolatilitySurface","url":"/reference/totalfinance/volatility/page-8#VolatilitySurface","description":"A fitted implied-volatility surface with diagnostics-bearing lookup.","category":"@insiderfinance/totalfinance/volatility","kind":"class","keywords":"@insiderfinance/totalfinance/volatility class  (input) (input).config (input).market (input).quotes arbitrage arbitrage().return.arbitrageFree arbitrage().return.assumptions arbitrage().r @insiderfinance/totalfinance/volatility/surface"},{"title":"VolatilitySurfaceSnapshot","url":"/reference/totalfinance/volatility/page-8#VolatilitySurfaceSnapshot","description":"A serialized surface (spec WS4.4). Carries the model, per-slice smile state (including any fitted\n`svi`/`sabr`/`heston` parameters), points, assumptions/diagnos","category":"@insiderfinance/totalfinance/volatility","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility interface  assumptions assumptions.asOf assumptions.calendar assumptions.calendarVersion assumptions.compounding assumptions.compounding.periodsPerYear @insiderfinance/totalfinance/volatility/surface"},{"title":"arbitrageReport","url":"/reference/totalfinance/volatility/page-8#arbitrageReport","description":"Run all static no-arbitrage checks over a set of slices (Law 2 report grammar).","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).butterflyPoints (options).calendarPoints (options).step (options).tolerance (slices) return.arbitrageFree return.assumpt @insiderfinance/totalfinance/volatility/arbitrage"},{"title":"atmTermStructure","url":"/reference/totalfinance/volatility/page-8#atmTermStructure","description":"The ATM implied-vol term structure: ATM IV and total variance per expiry, with a monotonicity flag.","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (surface) (surface).arbitrage (surface).assumptions (surface).diagnostics (surface).essvi (surface).expiries (surface).heston (surface).impl @insiderfinance/totalfinance/volatility/term"},{"title":"calendarSkew","url":"/reference/totalfinance/volatility/page-8#calendarSkew","description":"Calendar skew: how the ATM skew slope changes from the near to the far expiry (`slope_far −\nslope_near`). Negative when the near-dated smile is steeper (the usu","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (from) (surface) (surface).arbitrage (surface).assumptions (surface).diagnostics (surface).essvi (surface).expiries (surface).heston (surfac @insiderfinance/totalfinance/volatility/term"},{"title":"calibrateEssvi","url":"/reference/totalfinance/volatility/page-8#calibrateEssvi","description":"Fit a calendar-arbitrage-free eSSVI surface: θ knots from each slice's ATM variance (made monotone),\nthen per-maturity `ρᵢ` and a global `φ` by least squares — ","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).initialParameters (options).initialParameters.phi (options).initialParameters.rho (options).maximumIterations (options). @insiderfinance/totalfinance/volatility/essvi"},{"title":"calibrateEventMove","url":"/reference/totalfinance/volatility/page-8#calibrateEventMove","description":"Calibrate the earnings straddle: compare each past event's implied move (before) to its realized move\n(after), and aggregate — the ratio, how often selling the ","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (observations) return.assumptions return.assumptions.conventionsVersion return.assumptions.method return.averageImplied return.averageRealiz @insiderfinance/totalfinance/volatility/earnings"},{"title":"calibrateEventVolatility","url":"/reference/totalfinance/volatility/page-8#calibrateEventVolatility","description":"Extract the continuous vol and the discrete event jump from an ATM-vol term structure by fitting\n`Vᵢ = σ_base²·Tᵢ + J²·[spans]` (a 2-coefficient least-squares r","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).asOf (options).baseVolatility (options).eventDate (options).termStructure return.assumptions return.assumptions.asOf ret @insiderfinance/totalfinance/volatility/earnings"},{"title":"calibrateHestonSurface","url":"/reference/totalfinance/volatility/page-8#calibrateHestonSurface","description":"function from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (request) (request).market (request).options (request).options.initialParameters (request).options.initialParameters.kappa (request).options @insiderfinance/totalfinance/volatility/heston-surface"},{"title":"calibrateSabrSmile","url":"/reference/totalfinance/volatility/page-8#calibrateSabrSmile","description":"function from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).forward (input).impliedVolatilities (input).strikes (input).timeToExpiryYears (options) (options).beta (options).initialPara @insiderfinance/totalfinance/volatility/sabr"},{"title":"calibrateSsvi","url":"/reference/totalfinance/volatility/page-8#calibrateSsvi","description":"Fit a calendar-arbitrage-free SSVI surface to a market total-variance surface: θ knots from each\nslice's ATM variance (made monotone), then a global `ρ` and `φ`","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).initialParameters (options).initialParameters.phi (options).initialParameters.rho (options).maximumIterations (options). @insiderfinance/totalfinance/volatility/ssvi"},{"title":"calibrateSvi","url":"/reference/totalfinance/volatility/page-8#calibrateSvi","description":"function from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).k (input).w (options) (options).initialParameters (options).maximumIterations (options).timeToExpiryYears (options).toleranc @insiderfinance/totalfinance/volatility/svi"},{"title":"calibrateVannaVolga","url":"/reference/totalfinance/volatility/page-8#calibrateVannaVolga","description":"Construct a vanna–volga smile from the `(ATM, riskReversal, butterfly)` quotes and evaluate it at the\nrequested strikes. The three market pillars (from {@link s","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).atmVolatility (input).butterfly (input).delta (input).forward (input).riskReversal (input).strikes (input).timeToExpiryYears @insiderfinance/totalfinance/volatility/vanna-volga"},{"title":"calibrateVannaVolga5","url":"/reference/totalfinance/volatility/page-8#calibrateVannaVolga5","description":"Build the FX/crypto smile from the full five-quote set — ATM + the 25Δ and 10Δ risk reversal / butterfly —\nso it **exactly reprices all five market pillars** (1","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).atmVolatility (input).butterfly10 (input).butterfly25 (input).forward (input).innerDelta (input).outerDelta (input).riskReve @insiderfinance/totalfinance/volatility/vanna-volga"},{"title":"checkButterfly","url":"/reference/totalfinance/volatility/page-8#checkButterfly","description":"Butterfly arbitrage: Gatheral's `g(k)` (∝ risk-neutral density) must stay non-negative.\nEnvelope-shaped: `value` is the violation list, `assumptions.points` the","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).butterflyPoints (options).step (options).tolerance (slice) (slice).expiry (slice).forward (slice).impliedVolatility (sli @insiderfinance/totalfinance/volatility/arbitrage"},{"title":"checkCalendar","url":"/reference/totalfinance/volatility/page-8#checkCalendar","description":"Calendar arbitrage: total variance must not fall as maturity increases (at fixed\nforward-moneyness). Envelope-shaped: `value` is the violation list, `assumption","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).calendarPoints (options).tolerance (slices) return.assumptions return.diagnostics return.provenance return.value @insiderfinance/totalfinance/volatility/arbitrage"},{"title":"estimateVolatilitySpotBeta","url":"/reference/totalfinance/volatility/page-9#estimateVolatilitySpotBeta","description":"function from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).basis (input).hacLags (input).impliedVolatility (input).referenceSpot (input).spot return.assumptions return.diagnostics ret @insiderfinance/totalfinance/volatility/volatility-spot-beta"},{"title":"eventStrippedVolatility","url":"/reference/totalfinance/volatility/page-9#eventStrippedVolatility","description":"Plain de-earned volatility; use `.explain()` for assumptions and clamp diagnostics.","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).atmVolatility (input).eventMove (input).timeToExpiryYears explain explain().return.assumptions explain().return.diagnostics  @insiderfinance/totalfinance/volatility/event"},{"title":"eventVolatilityAtExpiry","url":"/reference/totalfinance/volatility/page-9#eventVolatilityAtExpiry","description":"Evaluate a fitted event-volatility model at any expiries — the forward door of\n{@link calibrateEventVolatility}: the ATM volatility the model implies at an expi","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function ```ts\nconst fit = calibrateEventVolatility({ termStructure, eventDate: '2026-05-11', asOf: '2026-05- (input) (input).expiries (input).fit return.assumptions return.assumptions.asOf return.assumptions.baseVolatility return.assumptions.convent @insiderfinance/totalfinance/volatility/earnings"},{"title":"eventVolatilityDecomposition","url":"/reference/totalfinance/volatility/page-9#eventVolatilityDecomposition","description":"Decompose an event-spanning ATM vol into a continuous (diffusive) part and a discrete event jump\n(spec §10.3). With a base (non-event) vol `σ_base` for the same","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).atmVolatility (options).baseVolatility (options).timeToExpiryYears return.assumptions return.assumptions.conventionsVers @insiderfinance/totalfinance/volatility/event"},{"title":"expectedMoveFromImpliedVolatility","url":"/reference/totalfinance/volatility/page-9#expectedMoveFromImpliedVolatility","description":"FACADE (P3.2, one gesture): the plain call returns the {@link ExpectedMove} numbers; the same\ncall's `.explain()` returns the full envelope with the risk-neutra","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).impliedVolatility (input).spot (input).timeToExpiryYears explain explain().return.assumptions explain().return.diagnostics e @insiderfinance/totalfinance/volatility/event"},{"title":"expectedMoveFromStraddle","url":"/reference/totalfinance/volatility/page-9#expectedMoveFromStraddle","description":"FACADE: plain {@link ExpectedMove}; `.explain()` for the envelope.","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).spot (input).straddlePrice explain explain().return.assumptions explain().return.diagnostics explain().return.provenance exp @insiderfinance/totalfinance/volatility/event"},{"title":"fitGarch","url":"/reference/totalfinance/volatility/page-9#fitGarch","description":"Fit a GARCH(1,1) model to a returns series by Gaussian MLE.\n\nThe conditional variance follows `σ²ₜ = ω + α·r²ₜ₋₁ + β·σ²ₜ₋₁`, seeded with the sample second momen","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).initialParameters (options).initialParameters.alpha (options).initialParameters.beta (options).mean (options).seed (retu @insiderfinance/totalfinance/volatility/forecast"},{"title":"fitHarRv","url":"/reference/totalfinance/volatility/page-9#fitHarRv","description":"Fit a HAR-RV (heterogeneous autoregressive) model to a realized-variance series by OLS.\n\nRegresses `RVₜ` on `[1, RVₜ₋₁, avg(last {@link HarRvOptions.weekly}), a","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).monthly (options).weekly (realizedVariances) return.assumptions return.assumptions.conventionsVersion return.assumptions @insiderfinance/totalfinance/volatility/forecast"},{"title":"forwardSkew","url":"/reference/totalfinance/volatility/page-9#forwardSkew","description":"Forward skew: the skew slope of the *forward-starting* smile between two expiries, built from the\nadded forward variance at fixed forward-log-moneyness. `d(σ_fw","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (from) (options) (options).step (surface) (surface).arbitrage (surface).assumptions (surface).diagnostics (surface).essvi (surface).expiries @insiderfinance/totalfinance/volatility/term"},{"title":"forwardVolatility","url":"/reference/totalfinance/volatility/page-9#forwardVolatility","description":"Forward-starting ATM volatility between two expiries from ATM total variance:\n`√((w_far − w_near)/(t_far − t_near))`. Throws an {@link ArbitrageError}\n(`volatil","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (from) (surface) (surface).arbitrage (surface).assumptions (surface).diagnostics (surface).essvi (surface).expiries (surface).heston (surfac @insiderfinance/totalfinance/volatility/term"},{"title":"garchForecast","url":"/reference/totalfinance/volatility/page-9#garchForecast","description":"function from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).fit (input).horizonPeriods (input).lastVariance (input).options return.annualizedVolatility return.assumptions return.assump @insiderfinance/totalfinance/volatility/forecast"},{"title":"harRvForecast","url":"/reference/totalfinance/volatility/page-9#harRvForecast","description":"One-step-ahead HAR-RV forecast from the latest daily/weekly/monthly aggregates of `history`,\nusing the same windows the model was fit with. Requires at least `m","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (fit) (fit).assumptions (fit).assumptions.conventionsVersion (fit).assumptions.method (fit).assumptions.monthly (fit).assumptions.weekly (fi @insiderfinance/totalfinance/volatility/forecast"},{"title":"impliedVolatilityPercentile","url":"/reference/totalfinance/volatility/page-9#impliedVolatilityPercentile","description":"function from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).current (input).history explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explai @insiderfinance/totalfinance/volatility/metrics"},{"title":"impliedVolatilityRank","url":"/reference/totalfinance/volatility/page-9#impliedVolatilityRank","description":"FACADES (P3.2, one gesture): plain value from the call; the same call's `.explain()` returns the\nenvelope (window, method, and the flat-history caveat when rank","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).current (input).history explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explai @insiderfinance/totalfinance/volatility/metrics"},{"title":"impliedVolatilityStatistics","url":"/reference/totalfinance/volatility/page-9#impliedVolatilityStatistics","description":"function from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).current (input).history explain explain().return.assumptions explain().return.diagnostics explain().return.provenance explai @insiderfinance/totalfinance/volatility/metrics"},{"title":"localVolatilitySurface","url":"/reference/totalfinance/volatility/page-9#localVolatilitySurface","description":"Fit a Dupire local-volatility surface from an implied-vol function `σ_imp(strike, t)` and market context.","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).impliedVolatility (input).market (input).options return.grid return.localVolatility @insiderfinance/totalfinance/volatility/local-volatility"},{"title":"minimumVarianceDelta","url":"/reference/totalfinance/volatility/page-9#minimumVarianceDelta","description":"The minimum-variance (smile-adjusted) delta for one option. Composes `blackScholesGreeks` (for `Δ_BS` and\nvega) with a vol–spot sensitivity `β`. See the spec — ","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).dividendYield (options).regime (options).riskFreeRate (options).skewSlope (options).spot (options).strike (options).time @insiderfinance/totalfinance/volatility/min-variance-delta"},{"title":"observedSkew","url":"/reference/totalfinance/volatility/page-9#observedSkew","description":"Observe a single expiry. Compose separate calls for a term structure; compare their mean ATM IVs\nonly when available. IV/RR/BF/spreads are decimals (multiply by","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).config (input).market (input).market.asOf (input).market.spot (input).quotes return.assumptions return.diagnostics return.pr"},{"title":"probabilityInTheMoney","url":"/reference/totalfinance/volatility/page-9#probabilityInTheMoney","description":"FACADE: plain probability; `.explain()` carries the risk-neutral disclosure.","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).dividendYield (input).riskFreeRate (input).spot (input).strike (input).timeToExpiryYears (input).type (input).volatility exp @insiderfinance/totalfinance/volatility/event"},{"title":"probabilityOfTouch","url":"/reference/totalfinance/volatility/page-9#probabilityOfTouch","description":"FACADE: plain first-passage probability; `.explain()` for the envelope.","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).barrier (input).dividendYield (input).riskFreeRate (input).spot (input).timeToExpiryYears (input).volatility explain explain @insiderfinance/totalfinance/volatility/event"},{"title":"realizedImpliedSpread","url":"/reference/totalfinance/volatility/page-10#realizedImpliedSpread","description":"function from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).impliedVolatility (input).realizedVolatility @insiderfinance/totalfinance/volatility/event"},{"title":"riskNeutralDistribution","url":"/reference/totalfinance/volatility/page-10#riskNeutralDistribution","description":"Breeden–Litzenberger (1978): the risk-neutral terminal distribution implied by a call-price curve.\nGiven the smile `volatilitySmile(strike)`, prices calls via B","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).dividendYield (options).riskFreeRate (options).spot (options).step (options).timeToExpiryYears (volatilitySmile) return. @insiderfinance/totalfinance/volatility/analytics"},{"title":"riskReversalButterfly","url":"/reference/totalfinance/volatility/page-10#riskReversalButterfly","description":"Decompose a smile into the ATM vol, the δ-delta **risk reversal** (`callVolatility − putVolatility`, the skew) and\n**butterfly** (`(callVolatility + putVolatili","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).delta (input).forward (input).smile (input).timeToExpiryYears return.assumptions return.assumptions.conventionsVersion retur @insiderfinance/totalfinance/volatility/risk-reversal"},{"title":"sabrBartlettGreeks","url":"/reference/totalfinance/volatility/page-10#sabrBartlettGreeks","description":"Bartlett (2006) minimum-variance delta, vega & gamma for a SABR-parametrised option — the model-consistent\nhedges that account for the correlated forward/vol dy","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (request) (request).input (request).options (request).parameters (request).type return.assumptions return.diagnostics return.provenance retu @insiderfinance/totalfinance/volatility/sabr-delta"},{"title":"skew","url":"/reference/totalfinance/volatility/page-10#skew","description":"Compute skew/smile metrics for one expiry of an option chain.","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).config (input).market (input).quotes return.assumptions return.diagnostics return.provenance return.value @insiderfinance/totalfinance/volatility/skew"},{"title":"smileFromQuotes","url":"/reference/totalfinance/volatility/page-10#smileFromQuotes","description":"Recover the three smile anchors — the δ-delta put, the ATM, and the δ-delta call `(strike, vol)` — from\nthe `(ATM, riskReversal, butterfly)` quotes. Exact inver","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).atmVolatility (input).butterfly (input).delta (input).forward (input).riskReversal (input).timeToExpiryYears return.assumpti @insiderfinance/totalfinance/volatility/risk-reversal"},{"title":"stickyRegime","url":"/reference/totalfinance/volatility/page-10#stickyRegime","description":"Measure whether the market's smile is sticky-strike or sticky-moneyness (sticky-delta) from a history\nof spot and a fixed reference strike's implied vol. See `d","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).fixedStrikeVolatility (input).skewSlope (input).spot return.assumptions return.assumptions.conventionsVersion return.assumpt @insiderfinance/totalfinance/volatility/sticky-regime"},{"title":"surfaceArbitrageReport","url":"/reference/totalfinance/volatility/page-10#surfaceArbitrageReport","description":"Adapt a {@link VolatilitySurface} to {@link arbitrageReport}, carrying its sparse-data warnings through\ninto `diagnostics.warnings`.","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).butterflyPoints (options).calendarPoints (options).step (options).tolerance (surface) (surface).arbitrage (surface).assu @insiderfinance/totalfinance/volatility/arbitrage"},{"title":"surfaceLocalVolatility","url":"/reference/totalfinance/volatility/page-10#surfaceLocalVolatility","description":"Fit a Dupire local-volatility surface directly from a calibrated {@link VolatilitySurface}.","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).market (input).options (input).surface return.grid return.localVolatility @insiderfinance/totalfinance/volatility/local-volatility"},{"title":"surfacePCA","url":"/reference/totalfinance/volatility/page-10#surfacePCA","description":"Principal-component analysis of vol-surface changes: the dominant modes of surface motion\n(level / slope / curvature), each with its variance explained and fact","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).changes (input).gridPoints (input).maxComponents (input).snapshots return.assumptions return.assumptions.changeType return.a @insiderfinance/totalfinance/volatility/surface-pca"},{"title":"surfacePcaScenarios","url":"/reference/totalfinance/volatility/page-10#surfacePcaScenarios","description":"Turn a fitted {@link surfacePCA} into **stress scenarios**: shock a base surface by `±k` standard\ndeviations along each principal mode (`k·√λ·loadings`, since `","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).base (input).combined (input).floor (input).maxModes (input).pca (input).sigmas return.assumptions return.assumptions.change @insiderfinance/totalfinance/volatility/surface-pca"},{"title":"swaptionCube","url":"/reference/totalfinance/volatility/page-10#swaptionCube","description":"function from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).beta (input).maximumIterations (input).nodes (input).shift (input).tolerance (input).volatilityType return.assumptions retur @insiderfinance/totalfinance/volatility/swaption-cube"},{"title":"swaptionCubeVolatility","url":"/reference/totalfinance/volatility/page-10#swaptionCubeVolatility","description":"Evaluate the swaption cube's implied vol at an arbitrary `(expiry, tenor, strike)` by bilinearly\ninterpolating the forward and SABR parameters across the grid, ","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (query) (query).cube (query).expiryYears (query).strike (query).tenorYears return.assumptions return.assumptions.conventionsVersion return.a @insiderfinance/totalfinance/volatility/swaption-cube"},{"title":"tailRiskIndex","url":"/reference/totalfinance/volatility/page-10#tailRiskIndex","description":"The SKEW-style tail-risk index from an option chain: per-expiry risk-neutral skewness / excess\nkurtosis (BKM), plus the constant-maturity SKEW value. See `docs/","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).asOf (options).horizonDays (options).quotes (options).riskFreeRate (options).spot return.assumptions return.assumptions. @insiderfinance/totalfinance/volatility/tail-risk"},{"title":"varianceIndex","url":"/reference/totalfinance/volatility/page-10#varianceIndex","description":"The VIX-style constant-maturity, model-free implied vol from an option chain, with the per-expiry\nfair-variance term structure. See `docs/specs/variance-index.m","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).asOf (options).dividendYield (options).horizonDays (options).quotes (options).riskFreeRate (options).spot return.assumpt @insiderfinance/totalfinance/volatility/variance-index"},{"title":"varianceRiskPremium","url":"/reference/totalfinance/volatility/page-10#varianceRiskPremium","description":"Variance risk premium: `impliedVolatility² − realizedVolatility²`, the premium of option-implied\nANNUALIZED variance over subsequently-realized annualized varia","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).impliedVolatility (input).realizedVolatility @insiderfinance/totalfinance/volatility/event"},{"title":"varianceRiskPremiumTermStructure","url":"/reference/totalfinance/volatility/page-10#varianceRiskPremiumTermStructure","description":"The variance-risk-premium term structure — per-expiry implied variance (from {@link varianceIndex})\nminus realized variance — plus the VRP at the constant-matur","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).asOf (options).dividendYield (options).horizonDays (options).quotes (options).realizedVolatility (options).riskFreeRate  @insiderfinance/totalfinance/volatility/variance-index"},{"title":"varianceSwapRate","url":"/reference/totalfinance/volatility/page-10#varianceSwapRate","description":"Model-free implied volatility via the CBOE VIX replication (Demeterfi–Derman–Kamal–Zou): a strip of\nout-of-the-money option mid-prices integrates to the fair va","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).boundaryCallPrice (options).boundaryPriceAveraged (options).forward (options).otmPrices (options).riskFreeRate (options) @insiderfinance/totalfinance/volatility/analytics"},{"title":"volatilityCone","url":"/reference/totalfinance/volatility/page-10#volatilityCone","description":"Realized-volatility cone: for each lookback `window`, the percentile spread of annualized realized\nvolatility across all rolling windows of the return series, p","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (options) (options).periodsPerYear (options).windows (returns) explain explain().return.assumptions explain().return.diagnostics explain().r @insiderfinance/totalfinance/volatility/analytics"},{"title":"volatilitySurface","url":"/reference/totalfinance/volatility/page-10#volatilitySurface","description":"function from @insiderfinance/totalfinance/volatility","category":"@insiderfinance/totalfinance/volatility","kind":"function","keywords":"@insiderfinance/totalfinance/volatility function  (input) (input).config (input).market (input).quotes return.arbitrage return.assumptions return.diagnostics return.essvi return.expiries ret @insiderfinance/totalfinance/volatility/surface"},{"title":"CalibrationOf","url":"/reference/totalfinance/volatility/artifacts#CalibrationOf","description":"type from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/volatility/artifacts type  "},{"title":"EvaluationOf","url":"/reference/totalfinance/volatility/artifacts#EvaluationOf","description":"type from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/volatility/artifacts type  "},{"title":"FITTED_MODEL_FAMILIES","url":"/reference/totalfinance/volatility/artifacts#FITTED_MODEL_FAMILIES","description":"The frozen, data-only descriptor table (Program 5's registry metadata).","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/volatility/artifacts value  "},{"title":"FITTED_MODEL_LIMITS","url":"/reference/totalfinance/volatility/artifacts#FITTED_MODEL_LIMITS","description":"Decision 9's bounded-work table (core's `ARTIFACT_WORK_LIMITS`, re-exported for this subpath's callers).","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/volatility/artifacts value  embeddedRowLimit embeddedRowLimit.default embeddedRowLimit.maximum gridPoints gridPoints.default gridPoints.maximum holdoutEvaluations holdo"},{"title":"FitOf","url":"/reference/totalfinance/volatility/artifacts#FitOf","description":"type from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/volatility/artifacts type  "},{"title":"FittedModelArtifactInput","url":"/reference/totalfinance/volatility/artifacts#FittedModelArtifactInput","description":"interface from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/artifacts interface  calibration createdFrom family fit libraryVersion limits limits.embeddedRowLimit limits.maximumEmbeddedBytes locators provenance provenance."},{"title":"FittedModelComparison","url":"/reference/totalfinance/volatility/artifacts#FittedModelComparison","description":"interface from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/artifacts interface  artifactIds artifactIds.baseline artifactIds.candidate assumptions assumptions.conventionsVersion assumptions.evaluationReason assumptions.f"},{"title":"FittedModelEvaluation","url":"/reference/totalfinance/volatility/artifacts#FittedModelEvaluation","description":"interface from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/artifacts interface  assumptions assumptions.conventionsVersion assumptions.evaluator assumptions.extrapolation assumptions.family assumptions.modelVersion assum"},{"title":"FittedModelFamilyDescriptor","url":"/reference/totalfinance/volatility/artifacts#FittedModelFamilyDescriptor","description":"Program 5's \"registry metadata\" as DATA — one frozen descriptor per family, no runtime registry.","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/artifacts interface  calibrator costClass evaluator family modelVersion qualifiedFamily referenceableRowSets requiredData supportedProducts warmStart"},{"title":"FittedModelHoldoutInput","url":"/reference/totalfinance/volatility/artifacts#FittedModelHoldoutInput","description":"interface from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/artifacts interface  calibration family holdout holdout.everyNth holdout.indices holdout.lastCount holdout.offset"},{"title":"FittedModelHoldoutReport","url":"/reference/totalfinance/volatility/artifacts#FittedModelHoldoutReport","description":"interface from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/artifacts interface  assumptions assumptions.conventionsVersion assumptions.family assumptions.holdout assumptions.holdout.everyNth assumptions.holdout.indices a"},{"title":"FittedModelHoldoutSelection","url":"/reference/totalfinance/volatility/artifacts#FittedModelHoldoutSelection","description":"type from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/volatility/artifacts type  everyNth indices lastCount offset"},{"title":"FittedModelReplay","url":"/reference/totalfinance/volatility/artifacts#FittedModelReplay","description":"interface from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/artifacts interface  artifactId assumptions assumptions.calibrator assumptions.conventionsVersion assumptions.family assumptions.libraryVersion assumptions.libra"},{"title":"FittedModelStabilityInput","url":"/reference/totalfinance/volatility/artifacts#FittedModelStabilityInput","description":"interface from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/artifacts interface  calibration family perturbation perturbation.relative restarts seed tolerance tolerance.absolute tolerance.relative"},{"title":"FittedModelStabilityReport","url":"/reference/totalfinance/volatility/artifacts#FittedModelStabilityReport","description":"interface from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/artifacts interface  assumptions assumptions.conventionsVersion assumptions.family assumptions.generator assumptions.members assumptions.modelVersion assumptions"},{"title":"ReadFittedModelResult","url":"/reference/totalfinance/volatility/artifacts#ReadFittedModelResult","description":"interface from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/artifacts interface  artifact artifact.artifactType artifact.conventionsVersion artifact.createdFrom artifact.id artifact.inputs artifact.inputs.inputsHash artif"},{"title":"StoredCalibrationOf","url":"/reference/totalfinance/volatility/artifacts#StoredCalibrationOf","description":"type from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/volatility/artifacts type  "},{"title":"VOLATILITY_FITTED_MODEL_ARTIFACT_TYPE","url":"/reference/totalfinance/volatility/artifacts#VOLATILITY_FITTED_MODEL_ARTIFACT_TYPE","description":"value from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/volatility/artifacts value  "},{"title":"VOLATILITY_MODEL_FAMILIES","url":"/reference/totalfinance/volatility/artifacts/page-2#VOLATILITY_MODEL_FAMILIES","description":"value from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"value","keywords":"@insiderfinance/totalfinance/volatility/artifacts value  "},{"title":"VolatilityCalibrations","url":"/reference/totalfinance/volatility/artifacts/page-2#VolatilityCalibrations","description":"The direct calibrator's input per family, verbatim.","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/artifacts interface  essvi essvi.options essvi.options.initialParameters essvi.options.initialParameters.phi essvi.options.initialParameters.phi.eta essvi.option"},{"title":"VolatilityEvaluations","url":"/reference/totalfinance/volatility/artifacts/page-2#VolatilityEvaluations","description":"What `evaluateFittedModel` takes per family — the family's direct evaluator's coordinates.","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/artifacts interface  essvi essvi.logMoneyness essvi.timeToExpiryYears event-move event-volatility event-volatility.expiries garch garch.horizonPeriods garch.last"},{"title":"VolatilityFits","url":"/reference/totalfinance/volatility/artifacts/page-2#VolatilityFits","description":"The direct calibrator's result per family, verbatim (the surface as its own `toJSON()` snapshot).","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/artifacts interface  essvi essvi.arbitrage essvi.arbitrage.butterflyArbitrageFree essvi.arbitrage.calendarArbitrageFree essvi.arbitrage.minButterflyG essvi.arbit"},{"title":"VolatilityFittedModelReport","url":"/reference/totalfinance/volatility/artifacts/page-2#VolatilityFittedModelReport","description":"The typed report every domain verb reads and writes — the artifact's `result`, verbatim.","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/volatility/artifacts type  assumptions assumptions.calibrator assumptions.conventionsVersion assumptions.evaluator assumptions.family assumptions.inputPolicy assumptio"},{"title":"VolatilityModelFamily","url":"/reference/totalfinance/volatility/artifacts/page-2#VolatilityModelFamily","description":"type from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/volatility/artifacts type  "},{"title":"VolatilityStoredCalibrations","url":"/reference/totalfinance/volatility/artifacts/page-2#VolatilityStoredCalibrations","description":"The STORED calibration: the declared bulk row set may be a `TableHandle` (Decision 9).","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/artifacts interface  essvi essvi.options essvi.options.initialParameters essvi.options.initialParameters.phi essvi.options.initialParameters.phi.eta essvi.option"},{"title":"VolatilityWarmStarts","url":"/reference/totalfinance/volatility/artifacts/page-2#VolatilityWarmStarts","description":"What `warmStartFrom` returns per warm-startable family — spread into the next calibration's options.","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/artifacts interface  essvi essvi.initialParameters essvi.initialParameters.phi essvi.initialParameters.phi.eta essvi.initialParameters.phi.gamma essvi.initialPar"},{"title":"WarmStartOf","url":"/reference/totalfinance/volatility/artifacts/page-2#WarmStartOf","description":"type from @insiderfinance/totalfinance/volatility/artifacts","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"type","keywords":"@insiderfinance/totalfinance/volatility/artifacts type  "},{"title":"compareFittedModels","url":"/reference/totalfinance/volatility/artifacts/page-2#compareFittedModels","description":"Compare two fits of one family: named parameter deltas, objective/convergence/residual deltas,\narbitrage-status change, market and calibration identity, the str","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/artifacts function  (input) (input).baseline (input).baseline.artifactType (input).baseline.conventionsVersion (input).baseline.createdFrom (input).baseline.id "},{"title":"evaluateFittedModel","url":"/reference/totalfinance/volatility/artifacts/page-2#evaluateFittedModel","description":"Evaluate a restored fitted model through its family's direct evaluator (Decision 3).","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/artifacts function  (input) (input).at (input).model (input).model.artifactType (input).model.conventionsVersion (input).model.createdFrom (input).model.id (inp"},{"title":"fittedModelArtifact","url":"/reference/totalfinance/volatility/artifacts/page-2#fittedModelArtifact","description":"Describe a direct calibrator's result and save it as an identified, immutable artifact.","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/artifacts function ```ts\nconst fit = calibrateSsvi(surface, { weight: 'vega' });\nconst artifact = fittedModelArtifact({ (input) (input).calibration (input).createdFrom (input).family (input).fit (input).libraryVersion (input).limits (input).locators (input).pr"},{"title":"fittedModelHoldout","url":"/reference/totalfinance/volatility/artifacts/page-2#fittedModelHoldout","description":"Fit on the retained points through the direct calibrator, evaluate the direct evaluator on the\nheld-out points, and report in-sample and out-of-sample residuals","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/artifacts function  (input) (input).calibration (input).family (input).holdout return.assumptions return.assumptions.conventionsVersion return.assumptions.famil"},{"title":"fittedModelStability","url":"/reference/totalfinance/volatility/artifacts/page-2#fittedModelStability","description":"Re-run the direct calibrator from seeded, deterministic perturbations of the base fit's free\nstart members and report the parameter spread (Decision 8).","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/artifacts function  (input) (input).calibration (input).family (input).perturbation (input).perturbation.relative (input).restarts (input).seed (input).toleranc"},{"title":"warmStartFrom","url":"/reference/totalfinance/volatility/artifacts/page-2#warmStartFrom","description":"The warm-start option a saved fit fills for the next calibration (Decision 8).","category":"@insiderfinance/totalfinance/volatility/artifacts","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/artifacts function  (input) (input).model (input).model.artifactType (input).model.conventionsVersion (input).model.createdFrom (input).model.id (input).model.i"},{"title":"essviArbitrageFree","url":"/reference/totalfinance/volatility/essvi#essviArbitrageFree","description":"Diagnose the no-arbitrage status of an eSSVI surface: butterfly (exact Gatheral `g ≥ 0` at each grid\nmaturity, reducing the slice to raw SVI) and calendar (`w(k","category":"@insiderfinance/totalfinance/volatility/essvi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/essvi function  (options) (options).grid (options).maturityGrid (parameters) (parameters).phi (parameters).thetaTerm return.butterflyArbitrageFree return.ca"},{"title":"essviTotalVariance","url":"/reference/totalfinance/volatility/essvi#essviTotalVariance","description":"Total implied variance `w(k, t)` on a calibrated eSSVI surface.","category":"@insiderfinance/totalfinance/volatility/essvi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/essvi function  (k) (parameters) (parameters).phi (parameters).thetaTerm (timeToExpiryYears)"},{"title":"essviVolatility","url":"/reference/totalfinance/volatility/essvi#essviVolatility","description":"Implied volatility `√(w/t)` on a calibrated eSSVI surface.","category":"@insiderfinance/totalfinance/volatility/essvi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/essvi function  (k) (parameters) (parameters).phi (parameters).thetaTerm (timeToExpiryYears)"},{"title":"PreparedSlice","url":"/reference/totalfinance/volatility/ssvi#PreparedSlice","description":"A market slice with its total variances resolved and its ATM θ computed. Shared with `./essvi.ts`.","category":"@insiderfinance/totalfinance/volatility/ssvi","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/ssvi interface  k theta timeToExpiryYears w"},{"title":"SsviSliceInput","url":"/reference/totalfinance/volatility/ssvi#SsviSliceInput","description":"interface from @insiderfinance/totalfinance/volatility/ssvi","category":"@insiderfinance/totalfinance/volatility/ssvi","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/ssvi interface  k psi rho theta"},{"title":"SsviToSviInput","url":"/reference/totalfinance/volatility/ssvi#SsviToSviInput","description":"Exact reduction of SSVI-at-θ to a raw-SVI slice, so `./svi.ts` evaluation and the Gatheral-`g`\nbutterfly test apply directly: `a = (θ/2)(1−ρ²)`, `b = θψ/2`, `ρ_","category":"@insiderfinance/totalfinance/volatility/ssvi","kind":"interface","keywords":"@insiderfinance/totalfinance/volatility/ssvi interface  psi rho theta"},{"title":"atmTotalVariance","url":"/reference/totalfinance/volatility/ssvi#atmTotalVariance","description":"Linear interpolation of the (k, w) points evaluated at k = 0 (the ATM total variance). Shared with `./essvi.ts`.","category":"@insiderfinance/totalfinance/volatility/ssvi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/ssvi function  (k) (w)"},{"title":"calibrationWeights","url":"/reference/totalfinance/volatility/ssvi#calibrationWeights","description":"Per-point least-squares weights for a set of prepared slices: `1` (uniform) or the Black vega\n`φ(d₁)·√t` at the market vol `σ = √(w/t)` (vega). The weights depe","category":"@insiderfinance/totalfinance/volatility/ssvi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/ssvi function  (slices) (weight)"},{"title":"phiValue","url":"/reference/totalfinance/volatility/ssvi#phiValue","description":"Evaluate the curvature `φ(θ)`. Shared with `./essvi.ts` (the eSSVI extension) so the two use one\ndefinition. The unguarded arithmetic lives in `./ssvi-kernel.ts","category":"@insiderfinance/totalfinance/volatility/ssvi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/ssvi function  (phi) (phi).eta (phi).gamma (phi).kind (phi).lambda (theta)"},{"title":"prepareSlices","url":"/reference/totalfinance/volatility/ssvi#prepareSlices","description":"Validate + resolve each slice's total variances (`w` or `iv²·t`), compute its ATM θ, and sort by\nmaturity. Shared with `./essvi.ts`, whose calibration input is ","category":"@insiderfinance/totalfinance/volatility/ssvi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/ssvi function  (functionName) (input) (input).slices"},{"title":"ssviArbitrageFree","url":"/reference/totalfinance/volatility/ssvi#ssviArbitrageFree","description":"Diagnose the no-arbitrage status of an SSVI surface: calendar (θ non-decreasing + the ∂_θ(θφ) bound)\nand butterfly (the exact Gatheral `g ≥ 0` density test at e","category":"@insiderfinance/totalfinance/volatility/ssvi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/ssvi function  (options) (options).grid (parameters) (parameters).phi (parameters).rho (parameters).thetaTerm return.butterflyArbitrageFree return.calendar"},{"title":"ssviSliceW","url":"/reference/totalfinance/volatility/ssvi#ssviSliceW","description":"SSVI total variance at a fixed θ (the raw SSVI slice function). Shared with `./essvi.ts`.","category":"@insiderfinance/totalfinance/volatility/ssvi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/ssvi function  (input) (input).k (input).psi (input).rho (input).theta"},{"title":"ssviToSVI","url":"/reference/totalfinance/volatility/ssvi#ssviToSVI","description":"function from @insiderfinance/totalfinance/volatility/ssvi","category":"@insiderfinance/totalfinance/volatility/ssvi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/ssvi function  (input) (input).psi (input).rho (input).theta return.a return.b return.m return.rho return.sigma"},{"title":"ssviTotalVariance","url":"/reference/totalfinance/volatility/ssvi#ssviTotalVariance","description":"Total implied variance `w(k, t)` on a calibrated SSVI surface.","category":"@insiderfinance/totalfinance/volatility/ssvi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/ssvi function  (k) (parameters) (parameters).phi (parameters).rho (parameters).thetaTerm (timeToExpiryYears)"},{"title":"ssviVolatility","url":"/reference/totalfinance/volatility/ssvi#ssviVolatility","description":"Implied volatility `√(w/t)` on a calibrated SSVI surface.","category":"@insiderfinance/totalfinance/volatility/ssvi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/ssvi function  (k) (parameters) (parameters).phi (parameters).rho (parameters).thetaTerm (timeToExpiryYears)"},{"title":"thetaAt","url":"/reference/totalfinance/volatility/ssvi/page-2#thetaAt","description":"Interpolate `θ(t)` linearly in `t` from the knots; `θ(0)=0`, flat beyond the last knot (constant total\nvariance — a decreasing vol). Monotone knots ⇒ monotone `","category":"@insiderfinance/totalfinance/volatility/ssvi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/ssvi function  (thetaTerm) (timeToExpiryYears)"},{"title":"SURFACE_MARKET_KEYS","url":"/reference/totalfinance/volatility/surface#SURFACE_MARKET_KEYS","description":"The documented {@link SurfaceMarket} fields (the {@link MarketInputs} keys, `spot` optional).","category":"@insiderfinance/totalfinance/volatility/surface","kind":"value","keywords":"@insiderfinance/totalfinance/volatility/surface value  "},{"title":"sviButterflyFree","url":"/reference/totalfinance/volatility/svi#sviButterflyFree","description":"Whether the slice is butterfly-arbitrage-free across a log-moneyness grid (default ±1, 81 points).","category":"@insiderfinance/totalfinance/volatility/svi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/svi function  (grid) (parameters) (parameters).a (parameters).b (parameters).m (parameters).rho (parameters).sigma"},{"title":"sviG","url":"/reference/totalfinance/volatility/svi#sviG","description":"Gatheral's `g(k)` density function. The risk-neutral density implied by an SVI slice is\nproportional to `g(k)`, so `g(k) ≥ 0` everywhere ⇔ the slice is free of ","category":"@insiderfinance/totalfinance/volatility/svi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/svi function  (k) (parameters) (parameters).a (parameters).b (parameters).m (parameters).rho (parameters).sigma"},{"title":"sviMinG","url":"/reference/totalfinance/volatility/svi#sviMinG","description":"The minimum Gatheral `g(k)` over a log-moneyness grid (`≥ 0` ⇔ butterfly-arbitrage-free).","category":"@insiderfinance/totalfinance/volatility/svi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/svi function  (grid) (parameters) (parameters).a (parameters).b (parameters).m (parameters).rho (parameters).sigma"},{"title":"sviTotalVariance","url":"/reference/totalfinance/volatility/svi#sviTotalVariance","description":"Total implied variance `w(k)` of a raw-SVI slice.\n\nOmitting any of the five parameters used to return `NaN` — a total variance that is not a number,\nhanded back","category":"@insiderfinance/totalfinance/volatility/svi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/svi function  (k) (parameters) (parameters).a (parameters).b (parameters).m (parameters).rho (parameters).sigma"},{"title":"sviVolatility","url":"/reference/totalfinance/volatility/svi#sviVolatility","description":"Implied volatility of a raw-SVI slice at log-moneyness `k` and maturity `t` (years).","category":"@insiderfinance/totalfinance/volatility/svi","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/svi function  (k) (parameters) (parameters).a (parameters).b (parameters).m (parameters).rho (parameters).sigma (timeToExpiryYears)"},{"title":"vannaVolga5Density","url":"/reference/totalfinance/volatility/vanna-volga#vannaVolga5Density","description":"The risk-neutral terminal distribution implied by the **five**-pillar vanna-volga smile (ATM + 25Δ + 10Δ\nRR/BF) — the {@link vannaVolgaDensity} read-out (PDF / ","category":"@insiderfinance/totalfinance/volatility/vanna-volga","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/vanna-volga function  (input) (input).atmVolatility (input).butterfly10 (input).butterfly25 (input).forward (input).gridPoints (input).innerDelta (input).outerDel"},{"title":"vannaVolgaApproximation","url":"/reference/totalfinance/volatility/vanna-volga#vannaVolgaApproximation","description":"Vanna-volga implied vol by the Castagna–Mercurio (2007) closed form — the fast, always-defined market\nquote, complementing the exact replication in {@link calib","category":"@insiderfinance/totalfinance/volatility/vanna-volga","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/vanna-volga function  (input) (input).atmVolatility (input).butterfly (input).delta (input).forward (input).order (input).riskReversal (input).strikes (input).tim"},{"title":"vannaVolgaDensity","url":"/reference/totalfinance/volatility/vanna-volga#vannaVolgaDensity","description":"The risk-neutral terminal distribution implied by the three vanna-volga quotes (ATM + δ-delta RR/BF).\nBuilds the **Castagna–Mercurio** smile (the always-defined","category":"@insiderfinance/totalfinance/volatility/vanna-volga","kind":"function","keywords":"@insiderfinance/totalfinance/volatility/vanna-volga function  (input) (input).atmVolatility (input).butterfly (input).delta (input).forward (input).gridPoints (input).order (input).riskReversal (input)."},{"title":"ArtifactStore","url":"/reference/totalfinance/workflows#ArtifactStore","description":"A writable store: `put` is idempotent by content (the same value yields the same handle).","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  get get().return.handle get().return.value get(uri) list list(filter) list(filter).kind put put().return.contentHash put().return.createdTim"},{"title":"ArtifactStorePutInput","url":"/reference/totalfinance/workflows#ArtifactStorePutInput","description":"interface from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  createdTimestampMs expiresTimestampMs kind provenance provenance.asOf provenance.dataset provenance.provider provenance.receivedAt provenanc"},{"title":"ArtifactStoreReader","url":"/reference/totalfinance/workflows#ArtifactStoreReader","description":"Read access to the handles an input may reference (Decision 5); `null` when no store was supplied.","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  get get().return.handle get().return.value get(uri) list list(filter) list(filter).kind"},{"title":"AuthorizationStore","url":"/reference/totalfinance/workflows#AuthorizationStore","description":"interface from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  consume consume().return.consumedTimestampMs consume().return.idempotencyKey consume().return.journalEvents consume().return.journalId consu"},{"title":"DEFAULT_CAPABILITIES","url":"/reference/totalfinance/workflows#DEFAULT_CAPABILITIES","description":"What a caller holds when it names nothing: read, analyze, propose.","category":"@insiderfinance/totalfinance/workflows","kind":"value","keywords":"@insiderfinance/totalfinance/workflows value  "},{"title":"EXECUTION_JOURNAL_STORE_CEILING","url":"/reference/totalfinance/workflows#EXECUTION_JOURNAL_STORE_CEILING","description":"A journal read folds at most this many events; the store refuses to grow a journal beyond it.","category":"@insiderfinance/totalfinance/workflows","kind":"value","keywords":"@insiderfinance/totalfinance/workflows value  "},{"title":"ExecutionJournalStore","url":"/reference/totalfinance/workflows#ExecutionJournalStore","description":"interface from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  append append().return.appended append().return.journalId append().return.skipped append().return.total append(input) append(input).events l"},{"title":"GrantConsumption","url":"/reference/totalfinance/workflows#GrantConsumption","description":"The one submission a grant licensed, durably prepared before its journal commit.","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  consumedTimestampMs idempotencyKey journalEvents journalId journalStoreId receiptId"},{"title":"HANDLE_KINDS","url":"/reference/totalfinance/workflows#HANDLE_KINDS","description":"The handle kinds, their uri namespaces, and the envelope kind a stored value of that kind carries.","category":"@insiderfinance/totalfinance/workflows","kind":"value","keywords":"@insiderfinance/totalfinance/workflows value  authorization authorization.envelopeKind authorization.namespace job job.envelopeKind job.namespace journal journal.envelopeKind journal.nam"},{"title":"JOB_STATES","url":"/reference/totalfinance/workflows#JOB_STATES","description":"value from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"value","keywords":"@insiderfinance/totalfinance/workflows value  "},{"title":"JobRecord","url":"/reference/totalfinance/workflows#JobRecord","description":"interface from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  error error.code error.context error.issues error.message error.operation error.operation.id error.operation.version finishedAt id inputsHas"},{"title":"JobState","url":"/reference/totalfinance/workflows#JobState","description":"type from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"type","keywords":"@insiderfinance/totalfinance/workflows type  "},{"title":"JobStore","url":"/reference/totalfinance/workflows#JobStore","description":"interface from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  create create().return.error create().return.error.code create().return.error.context create().return.error.issues create().return.error.mes"},{"title":"KNOWN_CAPABILITIES","url":"/reference/totalfinance/workflows#KNOWN_CAPABILITIES","description":"The capabilities this stage names; a runtime may grant others (the registry does not enumerate them).","category":"@insiderfinance/totalfinance/workflows","kind":"value","keywords":"@insiderfinance/totalfinance/workflows value  "},{"title":"MAX_ROWS","url":"/reference/totalfinance/workflows#MAX_ROWS","description":"value from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"value","keywords":"@insiderfinance/totalfinance/workflows value  "},{"title":"OPERATION_BUDGETS","url":"/reference/totalfinance/workflows#OPERATION_BUDGETS","description":"value from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"value","keywords":"@insiderfinance/totalfinance/workflows value  inlineResultBytes inlineResultBytes.default inlineResultBytes.maximum maxInputBytes maxInputBytes.maximum maxInputBytes.transportDefault"},{"title":"OPERATION_ID","url":"/reference/totalfinance/workflows#OPERATION_ID","description":"value from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"value","keywords":"@insiderfinance/totalfinance/workflows value  "},{"title":"OperationAnnotations","url":"/reference/totalfinance/workflows#OperationAnnotations","description":"What a transport advertises about an operation's behaviour — DERIVED from its effect metadata, never authored.","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  destructiveHint idempotentHint openWorldHint readOnlyHint"},{"title":"OperationAuthorization","url":"/reference/totalfinance/workflows#OperationAuthorization","description":"type from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"type","keywords":"@insiderfinance/totalfinance/workflows type  "},{"title":"OperationContext","url":"/reference/totalfinance/workflows#OperationContext","description":"interface from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  artifacts artifacts.get artifacts.get().return.handle artifacts.get().return.value artifacts.get(uri) artifacts.list artifacts.list(filter) "},{"title":"OperationCostClass","url":"/reference/totalfinance/workflows/page-2#OperationCostClass","description":"type from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"type","keywords":"@insiderfinance/totalfinance/workflows type  "},{"title":"OperationDescription","url":"/reference/totalfinance/workflows/page-2#OperationDescription","description":"The transport-neutral description every adapter renders.","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  annotations annotations.destructiveHint annotations.idempotentHint annotations.openWorldHint annotations.readOnlyHint authorization costClas"},{"title":"OperationError","url":"/reference/totalfinance/workflows/page-2#OperationError","description":"The one error shape every transport maps: the QuantError code, or a runtime code.","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  code context issues message operation operation.id operation.version"},{"title":"OperationIdempotency","url":"/reference/totalfinance/workflows/page-2#OperationIdempotency","description":"type from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"type","keywords":"@insiderfinance/totalfinance/workflows type  "},{"title":"OperationOutput","url":"/reference/totalfinance/workflows/page-2#OperationOutput","description":"What an operation returns — the runtime completes it into an {@link OperationResult}.","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  artifacts incomplete status structured summary"},{"title":"OperationPack","url":"/reference/totalfinance/workflows/page-2#OperationPack","description":"interface from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  name operations"},{"title":"OperationRegistry","url":"/reference/totalfinance/workflows/page-2#OperationRegistry","description":"interface from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  describe describe().return.annotations describe().return.authorization describe().return.costClass describe().return.description describe()."},{"title":"OperationResult","url":"/reference/totalfinance/workflows/page-2#OperationResult","description":"interface from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  artifacts assumptions diagnostics diagnostics.incomplete diagnostics.status diagnostics.warnings identity identity.artifactIds identity.inpu"},{"title":"OperationResultSchemaInput","url":"/reference/totalfinance/workflows/page-2#OperationResultSchemaInput","description":"interface from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  handle handle.$id handle.$schema handle.additionalProperties handle.additionalProperties.$id handle.additionalProperties.$schema handle.addi"},{"title":"OperationSideEffect","url":"/reference/totalfinance/workflows/page-2#OperationSideEffect","description":"type from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"type","keywords":"@insiderfinance/totalfinance/workflows type  "},{"title":"OperationSignal","url":"/reference/totalfinance/workflows/page-2#OperationSignal","description":"The structural shape of a cancellation signal (an `AbortSignal` satisfies it): this package is\nbrowser-safe and declares no platform lib, so the contract names ","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  aborted reason"},{"title":"RESOURCE_HANDLE_SCHEMA","url":"/reference/totalfinance/workflows/page-2#RESOURCE_HANDLE_SCHEMA","description":"A `ResourceHandle` — a stored report, job, portfolio, scenario, market, authorization or\njournal — as JSON Schema. The kinds and URI namespaces are read from th","category":"@insiderfinance/totalfinance/workflows","kind":"value","keywords":"@insiderfinance/totalfinance/workflows value  $id $schema additionalProperties additionalProperties.$id additionalProperties.$schema additionalProperties.additionalProperties additionalP"},{"title":"ResourceHandle","url":"/reference/totalfinance/workflows/page-2#ResourceHandle","description":"An explicit, store-scoped reference to stored data — never implicit session state.","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  contentHash createdTimestampMs expiresTimestampMs kind provenance provenance.asOf provenance.dataset provenance.provider provenance.received"},{"title":"ResourceHandleKind","url":"/reference/totalfinance/workflows/page-2#ResourceHandleKind","description":"The kinds of stored data a handle can point at (Decision 5).","category":"@insiderfinance/totalfinance/workflows","kind":"type","keywords":"@insiderfinance/totalfinance/workflows type  "},{"title":"RunOperationInput","url":"/reference/totalfinance/workflows/page-2#RunOperationInput","description":"Run one operation: bytes → strict parse → seed policy → run → JSON-safe → identity/usage.\nThrows the typed teaching error a direct call would raise (a QuantErro","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  artifacts artifacts.get artifacts.get().return.handle artifacts.get().return.value artifacts.get(uri) artifacts.list artifacts.list(filter) "},{"title":"RunOperationOptions","url":"/reference/totalfinance/workflows/page-2#RunOperationOptions","description":"interface from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  artifacts artifacts.get artifacts.get().return.handle artifacts.get().return.value artifacts.get(uri) artifacts.list artifacts.list(filter) "},{"title":"TotalFinanceOperation","url":"/reference/totalfinance/workflows/page-2#TotalFinanceOperation","description":"interface from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"interface","keywords":"@insiderfinance/totalfinance/workflows interface  authorization costClass description deterministic handleFields id idempotency inputSchema inputSchema.describe inputSchema.describe(descript"},{"title":"WORKFLOWS_VERSION","url":"/reference/totalfinance/workflows/page-2#WORKFLOWS_VERSION","description":"Generated by publication:update from the public distribution version; browser-safe.","category":"@insiderfinance/totalfinance/workflows","kind":"value","keywords":"@insiderfinance/totalfinance/workflows value  "},{"title":"analysisOperations","url":"/reference/totalfinance/workflows/page-2#analysisOperations","description":"The analysis additions (dx §WS-5) to the default read-only tool set.","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  "},{"title":"applyJobPatch","url":"/reference/totalfinance/workflows/page-2#applyJobPatch","description":"Apply a patch to a record under the state machine; the merged record is re-validated whole.","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (current) (current).error (current).error.code (current).error.context (current).error.issues (current).error.message (current).error.operat"},{"title":"artifactPack","url":"/reference/totalfinance/workflows/page-3#artifactPack","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"backtestPack","url":"/reference/totalfinance/workflows/page-3#backtestPack","description":"The opt-in backtest pack (dx §4.2: backtests do not belong in the default server). Enable with\n`createTotalFinanceMcpServer({ packs: [backtestPack()] })`.","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"calendarPack","url":"/reference/totalfinance/workflows/page-3#calendarPack","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"capRows","url":"/reference/totalfinance/workflows/page-3#capRows","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (field) (max) (operationId) (rows)"},{"title":"createMemoryArtifactStore","url":"/reference/totalfinance/workflows/page-3#createMemoryArtifactStore","description":"A pure in-memory artifact store — browser-safe; idempotent by content.","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.get return.list return.put"},{"title":"createMemoryAuthorizationStore","url":"/reference/totalfinance/workflows/page-3#createMemoryAuthorizationStore","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.consume return.get return.list return.put"},{"title":"createMemoryExecutionJournalStore","url":"/reference/totalfinance/workflows/page-3#createMemoryExecutionJournalStore","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.append return.list return.read return.storeId return.transact"},{"title":"createMemoryJobStore","url":"/reference/totalfinance/workflows/page-3#createMemoryJobStore","description":"A pure in-memory job store — browser-safe; records are copied on the way in and out.","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.create return.get return.list return.update"},{"title":"createOperationRegistry","url":"/reference/totalfinance/workflows/page-3#createOperationRegistry","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (input) (input).operations (input).packs return.describe return.get return.list return.packs return.require return.run return.size"},{"title":"cryptoPack","url":"/reference/totalfinance/workflows/page-3#cryptoPack","description":"The crypto derivatives pack (P3.7): funding + carry analytics.","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"defaultOperations","url":"/reference/totalfinance/workflows/page-3#defaultOperations","description":"The default read-only tool set — every domain pack flattened (dx §WS-5).","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  "},{"title":"defaultPacks","url":"/reference/totalfinance/workflows/page-3#defaultPacks","description":"The ten domain packs that make up the default read-only server, in tool-list order.","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  "},{"title":"defineOperation","url":"/reference/totalfinance/workflows/page-3#defineOperation","description":"Define an operation. Every effect field has the read-only default this stage ships; a definition\nis validated once here so a malformed operation never reaches a","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (definition) (definition).authorization (definition).costClass (definition).description (definition).deterministic (definition).handleFields"},{"title":"describeOperation","url":"/reference/totalfinance/workflows/page-3#describeOperation","description":"The transport-neutral description of an operation — what CLI help, OpenAPI, and MCP tools render.","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (operation) (operation).authorization (operation).costClass (operation).description (operation).deterministic (operation).handleFields (oper"},{"title":"extendObjectSchema","url":"/reference/totalfinance/workflows/page-3#extendObjectSchema","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (base) (base).describe (base).isOptional (base).kind (base).optional (base).parse (base).safeParse (base).toJSONSchema (base).~standard (ext"},{"title":"fixedIncomePack","url":"/reference/totalfinance/workflows/page-3#fixedIncomePack","description":"The fixed-income pack (P3.7): bond analytics.\n\nThe pack id is `fixed_income`, matching the `totalfinance.fixed_income.*` tool prefix. It was\n`fixed-income` whil","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"handleUriOf","url":"/reference/totalfinance/workflows/page-3#handleUriOf","description":"The uri of a handle: `totalfinance://<namespace>/<id>` — content hash for data, the job id for a job.","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (id) (kind)"},{"title":"journeyOperations","url":"/reference/totalfinance/workflows/page-3#journeyOperations","description":"Every journey operation across the four journey packs, flattened.","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  "},{"title":"journeyPacks","url":"/reference/totalfinance/workflows/page-3#journeyPacks","description":"The five journey packs — opt-in beside the ten domain packs (Decision 9 counts them apart from\nthe twenty-three defaults; Stage 4.7 slice 2 added the valuation ","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  "},{"title":"jsonSafe","url":"/reference/totalfinance/workflows/page-3#jsonSafe","description":"JSON-safe normalization of a structured result: every non-finite number (NaN, ±Infinity — a\nnon-converged inversion, an indicator warmup) becomes `null` at the ","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (value)"},{"title":"missingCapabilities","url":"/reference/totalfinance/workflows/page-4#missingCapabilities","description":"The required capabilities the caller does not hold, sorted — the runtime's gate. Both lists are validated.","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (capabilities) (required)"},{"title":"operationAnnotations","url":"/reference/totalfinance/workflows/page-4#operationAnnotations","description":"Annotations are a pure function of the effect metadata — the one place a transport hint is decided.","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (operation) (operation).idempotency (operation).requiredCapabilities (operation).sideEffect return.destructiveHint return.idempotentHint ret"},{"title":"operationResultSchema","url":"/reference/totalfinance/workflows/page-4#operationResultSchema","description":"The `OperationResult` envelope as JSON Schema: operation and library identity, the summary, the\nstructured output (or its spilled handle), assumptions, diagnost","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (input) (input).handle (input).handle.$id (input).handle.$schema (input).handle.additionalProperties (input).handle.additionalProperties.$id"},{"title":"optionsPack","url":"/reference/totalfinance/workflows/page-4#optionsPack","description":"The default read-only tools, grouped into ten domain packs (dx §5.3). Each pack can be enabled on\nits own — `createTotalFinanceMcpServer({ packs: [optionsPack()","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"parseHandleUri","url":"/reference/totalfinance/workflows/page-4#parseHandleUri","description":"Parse a handle uri into its kind and id; a malformed uri is refused with the grammar.","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (uri) return.id return.kind"},{"title":"performancePack","url":"/reference/totalfinance/workflows/page-4#performancePack","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"portfolioPack","url":"/reference/totalfinance/workflows/page-4#portfolioPack","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"requireArtifactListFilter","url":"/reference/totalfinance/workflows/page-4#requireArtifactListFilter","description":"Validate a `list` filter (shared by every store).","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (filter) (functionName) return.kind"},{"title":"requireArtifactPut","url":"/reference/totalfinance/workflows/page-4#requireArtifactPut","description":"Validate a `put` request and derive the handle it would mint (shared by every store).","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (functionName) (input) return.canonical return.handle"},{"title":"requireAuthorizationPut","url":"/reference/totalfinance/workflows/page-4#requireAuthorizationPut","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (functionName) (input) return.canonical return.grant return.handle"},{"title":"requireCapabilities","url":"/reference/totalfinance/workflows/page-4#requireCapabilities","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (field) (functionName) (value)"},{"title":"requireJobRecord","url":"/reference/totalfinance/workflows/page-4#requireJobRecord","description":"The closed structural guard for a job record (shared by every store).","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (field) (functionName) (value) return.error return.error.code return.error.context return.error.issues return.error.message return.error.ope"},{"title":"requireJournalAppend","url":"/reference/totalfinance/workflows/page-4#requireJournalAppend","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (functionName) (input) return.events return.journalId"},{"title":"requireJournalId","url":"/reference/totalfinance/workflows/page-4#requireJournalId","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (functionName) (value)"},{"title":"requireOperation","url":"/reference/totalfinance/workflows/page-4#requireOperation","description":"Prove a value is a COMPLETE operation (the shape `defineOperation` returns): closed keys, every\nmember typed. The one guard every door that receives an operatio","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (field) (functionName) (value) return.authorization return.costClass return.description return.deterministic return.handleFields return.id r"},{"title":"requireResourceHandle","url":"/reference/totalfinance/workflows/page-4#requireResourceHandle","description":"The closed structural guard for a caller-supplied handle (core's guard order).","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (field) (functionName) (value)"},{"title":"researchPack","url":"/reference/totalfinance/workflows/page-4#researchPack","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"riskPack","url":"/reference/totalfinance/workflows/page-4#riskPack","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"runOperation","url":"/reference/totalfinance/workflows/page-4#runOperation","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (request) (request).artifacts (request).artifacts.get (request).artifacts.list (request).artifacts.put (request).capabilities (request).crea"},{"title":"scenarioPack","url":"/reference/totalfinance/workflows/page-4#scenarioPack","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"spilledResultSchema","url":"/reference/totalfinance/workflows/page-5#spilledResultSchema","description":"The `structured` slot of a result that exceeded the caller's inline byte budget: the runtime\nstored the full output as a report and answered with its handle and","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (handle) (handle).$id (handle).$schema (handle).additionalProperties (handle).additionalProperties.$id (handle).additionalProperties.$schema"},{"title":"strategyPack","url":"/reference/totalfinance/workflows/page-5#strategyPack","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"structurePack","url":"/reference/totalfinance/workflows/page-5#structurePack","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"technicalAnalysisPack","url":"/reference/totalfinance/workflows/page-5#technicalAnalysisPack","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"toOperationError","url":"/reference/totalfinance/workflows/page-5#toOperationError","description":"Map any thrown value to the one error shape every transport renders: a QuantError keeps its code,\nmessage, and context (a schema refusal keeps its issues); anyt","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  (error) (operation) (operation).authorization (operation).costClass (operation).description (operation).deterministic (operation).handleFiel"},{"title":"tradePack","url":"/reference/totalfinance/workflows/page-5#tradePack","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"valuationPack","url":"/reference/totalfinance/workflows/page-5#valuationPack","description":"The company-valuation journey pack — opt-in beside the ten domain packs and the other journey packs.","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"volatilityPack","url":"/reference/totalfinance/workflows/page-5#volatilityPack","description":"function from @insiderfinance/totalfinance/workflows","category":"@insiderfinance/totalfinance/workflows","kind":"function","keywords":"@insiderfinance/totalfinance/workflows function  return.name return.operations"},{"title":"createFileAuthorizationStore","url":"/reference/totalfinance/workflows/local#createFileAuthorizationStore","description":"The authorization store on disk: `<directory>/authorizations/<hash>.json` plus an index of handles.","category":"@insiderfinance/totalfinance/workflows/local","kind":"function","keywords":"@insiderfinance/totalfinance/workflows/local function  (input) (input).directory return.consume return.get return.list return.put"},{"title":"createFileExecutionJournalStore","url":"/reference/totalfinance/workflows/local#createFileExecutionJournalStore","description":"Journals use `journals/v2/<sha256-of-exact-id>.json` with an identity-checked envelope.\nLegacy sanitized arrays are read only if ALL embedded IDs match. A succe","category":"@insiderfinance/totalfinance/workflows/local","kind":"function","keywords":"@insiderfinance/totalfinance/workflows/local function  (input) (input).directory return.append return.list return.read return.storeId return.transact"},{"title":"@insiderfinance/totalfinance","url":"/reference/totalfinance","description":"Public import: @insiderfinance/totalfinance. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/backtest","url":"/reference/totalfinance/backtest","description":"Public import: @insiderfinance/totalfinance/backtest. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/backtest","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/backtest/artifacts","url":"/reference/totalfinance/backtest/artifacts","description":"Public import: @insiderfinance/totalfinance/backtest/artifacts. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/backtest/artifacts","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/backtest/costs","url":"/reference/totalfinance/backtest/costs","description":"Public import: @insiderfinance/totalfinance/backtest/costs. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/backtest/costs","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/backtest/cross-sectional","url":"/reference/totalfinance/backtest/cross-sectional","description":"Public import: @insiderfinance/totalfinance/backtest/cross-sectional. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/backtest/cross-sectional","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/backtest/environment","url":"/reference/totalfinance/backtest/environment","description":"Public import: @insiderfinance/totalfinance/backtest/environment. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/backtest/environment","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/backtest/event-driven","url":"/reference/totalfinance/backtest/event-driven","description":"Public import: @insiderfinance/totalfinance/backtest/event-driven. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/backtest/event-driven","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/backtest/execution","url":"/reference/totalfinance/backtest/execution","description":"Public import: @insiderfinance/totalfinance/backtest/execution. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/backtest/execution","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/backtest/options","url":"/reference/totalfinance/backtest/options","description":"Public import: @insiderfinance/totalfinance/backtest/options. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/backtest/options","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/backtest/paper","url":"/reference/totalfinance/backtest/paper","description":"Public import: @insiderfinance/totalfinance/backtest/paper. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/backtest/paper","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/backtest/portfolio","url":"/reference/totalfinance/backtest/portfolio","description":"Public import: @insiderfinance/totalfinance/backtest/portfolio. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/backtest/portfolio","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/backtest/tearsheet","url":"/reference/totalfinance/backtest/tearsheet","description":"Public import: @insiderfinance/totalfinance/backtest/tearsheet. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/backtest/tearsheet","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/backtest/vectorized","url":"/reference/totalfinance/backtest/vectorized","description":"Public import: @insiderfinance/totalfinance/backtest/vectorized. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/backtest/vectorized","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/calendars","url":"/reference/totalfinance/calendars","description":"Public import: @insiderfinance/totalfinance/calendars. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/calendars","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/calendars/cboe","url":"/reference/totalfinance/calendars/cboe","description":"Public import: @insiderfinance/totalfinance/calendars/cboe. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/calendars/cboe","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/calendars/crypto","url":"/reference/totalfinance/calendars/crypto","description":"Public import: @insiderfinance/totalfinance/calendars/crypto. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/calendars/crypto","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/calendars/nyse","url":"/reference/totalfinance/calendars/nyse","description":"Public import: @insiderfinance/totalfinance/calendars/nyse. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/calendars/nyse","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/cli","url":"/reference/totalfinance/cli","description":"Public import: @insiderfinance/totalfinance/cli. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/cli","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/commodities","url":"/reference/totalfinance/commodities","description":"Public import: @insiderfinance/totalfinance/commodities. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/commodities","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/commodities/forwards","url":"/reference/totalfinance/commodities/forwards","description":"Public import: @insiderfinance/totalfinance/commodities/forwards. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/commodities/forwards","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/commodities/term-structure","url":"/reference/totalfinance/commodities/term-structure","description":"Public import: @insiderfinance/totalfinance/commodities/term-structure. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/commodities/term-structure","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/core","url":"/reference/totalfinance/core","description":"Public import: @insiderfinance/totalfinance/core. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/core","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/core/artifacts","url":"/reference/totalfinance/core/artifacts","description":"Public import: @insiderfinance/totalfinance/core/artifacts. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/core/artifacts","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/core/data","url":"/reference/totalfinance/core/data","description":"Public import: @insiderfinance/totalfinance/core/data. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/core/data","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/core/data-conformance","url":"/reference/totalfinance/core/data-conformance","description":"Public import: @insiderfinance/totalfinance/core/data-conformance. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/core/data-conformance","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/core/pricing","url":"/reference/totalfinance/core/pricing","description":"Public import: @insiderfinance/totalfinance/core/pricing. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/core/pricing","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/core/schema","url":"/reference/totalfinance/core/schema","description":"Public import: @insiderfinance/totalfinance/core/schema. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/core/schema","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/crypto","url":"/reference/totalfinance/crypto","description":"Public import: @insiderfinance/totalfinance/crypto. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/crypto","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/crypto/carry","url":"/reference/totalfinance/crypto/carry","description":"Public import: @insiderfinance/totalfinance/crypto/carry. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/crypto/carry","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/crypto/curve","url":"/reference/totalfinance/crypto/curve","description":"Public import: @insiderfinance/totalfinance/crypto/curve. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/crypto/curve","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/crypto/inverse","url":"/reference/totalfinance/crypto/inverse","description":"Public import: @insiderfinance/totalfinance/crypto/inverse. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/crypto/inverse","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/crypto/liquidation","url":"/reference/totalfinance/crypto/liquidation","description":"Public import: @insiderfinance/totalfinance/crypto/liquidation. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/crypto/liquidation","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/data","url":"/reference/totalfinance/data","description":"Public import: @insiderfinance/totalfinance/data. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/data","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fixed-income","url":"/reference/totalfinance/fixed-income","description":"Public import: @insiderfinance/totalfinance/fixed-income. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fixed-income","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fixed-income/artifacts","url":"/reference/totalfinance/fixed-income/artifacts","description":"Public import: @insiderfinance/totalfinance/fixed-income/artifacts. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fixed-income/artifacts","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fixed-income/bonds","url":"/reference/totalfinance/fixed-income/bonds","description":"Public import: @insiderfinance/totalfinance/fixed-income/bonds. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fixed-income/bonds","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fixed-income/conventions","url":"/reference/totalfinance/fixed-income/conventions","description":"Public import: @insiderfinance/totalfinance/fixed-income/conventions. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fixed-income/conventions","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fixed-income/convertible","url":"/reference/totalfinance/fixed-income/convertible","description":"Public import: @insiderfinance/totalfinance/fixed-income/convertible. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fixed-income/convertible","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fixed-income/credit","url":"/reference/totalfinance/fixed-income/credit","description":"Public import: @insiderfinance/totalfinance/fixed-income/credit. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fixed-income/credit","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fixed-income/cross-currency","url":"/reference/totalfinance/fixed-income/cross-currency","description":"Public import: @insiderfinance/totalfinance/fixed-income/cross-currency. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fixed-income/cross-currency","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fixed-income/curves","url":"/reference/totalfinance/fixed-income/curves","description":"Public import: @insiderfinance/totalfinance/fixed-income/curves. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fixed-income/curves","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fixed-income/futures","url":"/reference/totalfinance/fixed-income/futures","description":"Public import: @insiderfinance/totalfinance/fixed-income/futures. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fixed-income/futures","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fixed-income/inflation","url":"/reference/totalfinance/fixed-income/inflation","description":"Public import: @insiderfinance/totalfinance/fixed-income/inflation. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fixed-income/inflation","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fixed-income/lattice","url":"/reference/totalfinance/fixed-income/lattice","description":"Public import: @insiderfinance/totalfinance/fixed-income/lattice. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fixed-income/lattice","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fixed-income/models","url":"/reference/totalfinance/fixed-income/models","description":"Public import: @insiderfinance/totalfinance/fixed-income/models. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fixed-income/models","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fixed-income/pricer","url":"/reference/totalfinance/fixed-income/pricer","description":"Public import: @insiderfinance/totalfinance/fixed-income/pricer. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fixed-income/pricer","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fixed-income/rates","url":"/reference/totalfinance/fixed-income/rates","description":"Public import: @insiderfinance/totalfinance/fixed-income/rates. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fixed-income/rates","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fixed-income/xva","url":"/reference/totalfinance/fixed-income/xva","description":"Public import: @insiderfinance/totalfinance/fixed-income/xva. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fixed-income/xva","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/foreign-exchange","url":"/reference/totalfinance/foreign-exchange","description":"Public import: @insiderfinance/totalfinance/foreign-exchange. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/foreign-exchange","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/foreign-exchange/forwards","url":"/reference/totalfinance/foreign-exchange/forwards","description":"Public import: @insiderfinance/totalfinance/foreign-exchange/forwards. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/foreign-exchange/forwards","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/foreign-exchange/risk","url":"/reference/totalfinance/foreign-exchange/risk","description":"Public import: @insiderfinance/totalfinance/foreign-exchange/risk. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/foreign-exchange/risk","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/foreign-exchange/spot","url":"/reference/totalfinance/foreign-exchange/spot","description":"Public import: @insiderfinance/totalfinance/foreign-exchange/spot. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/foreign-exchange/spot","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fundamentals","url":"/reference/totalfinance/fundamentals","description":"Public import: @insiderfinance/totalfinance/fundamentals. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fundamentals","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fundamentals/ratios","url":"/reference/totalfinance/fundamentals/ratios","description":"Public import: @insiderfinance/totalfinance/fundamentals/ratios. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fundamentals/ratios","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fundamentals/scores","url":"/reference/totalfinance/fundamentals/scores","description":"Public import: @insiderfinance/totalfinance/fundamentals/scores. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fundamentals/scores","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/fundamentals/statements","url":"/reference/totalfinance/fundamentals/statements","description":"Public import: @insiderfinance/totalfinance/fundamentals/statements. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/fundamentals/statements","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/http","url":"/reference/totalfinance/http","description":"Public import: @insiderfinance/totalfinance/http. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/http","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/math","url":"/reference/totalfinance/math","description":"Public import: @insiderfinance/totalfinance/math. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/math","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/math/bivariate","url":"/reference/totalfinance/math/bivariate","description":"Public import: @insiderfinance/totalfinance/math/bivariate. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/math/bivariate","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/math/distributions","url":"/reference/totalfinance/math/distributions","description":"Public import: @insiderfinance/totalfinance/math/distributions. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/math/distributions","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/math/filters","url":"/reference/totalfinance/math/filters","description":"Public import: @insiderfinance/totalfinance/math/filters. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/math/filters","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/math/integration","url":"/reference/totalfinance/math/integration","description":"Public import: @insiderfinance/totalfinance/math/integration. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/math/integration","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/math/interpolation","url":"/reference/totalfinance/math/interpolation","description":"Public import: @insiderfinance/totalfinance/math/interpolation. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/math/interpolation","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/math/linalg","url":"/reference/totalfinance/math/linalg","description":"Public import: @insiderfinance/totalfinance/math/linalg. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/math/linalg","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/math/lowdiscrepancy","url":"/reference/totalfinance/math/lowdiscrepancy","description":"Public import: @insiderfinance/totalfinance/math/lowdiscrepancy. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/math/lowdiscrepancy","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/math/montecarlo","url":"/reference/totalfinance/math/montecarlo","description":"Public import: @insiderfinance/totalfinance/math/montecarlo. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/math/montecarlo","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/math/normal","url":"/reference/totalfinance/math/normal","description":"Public import: @insiderfinance/totalfinance/math/normal. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/math/normal","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/math/optimize","url":"/reference/totalfinance/math/optimize","description":"Public import: @insiderfinance/totalfinance/math/optimize. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/math/optimize","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/math/random","url":"/reference/totalfinance/math/random","description":"Public import: @insiderfinance/totalfinance/math/random. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/math/random","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/math/regression","url":"/reference/totalfinance/math/regression","description":"Public import: @insiderfinance/totalfinance/math/regression. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/math/regression","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/math/solvers","url":"/reference/totalfinance/math/solvers","description":"Public import: @insiderfinance/totalfinance/math/solvers. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/math/solvers","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/math/statistics","url":"/reference/totalfinance/math/statistics","description":"Public import: @insiderfinance/totalfinance/math/statistics. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/math/statistics","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/math/timeseries","url":"/reference/totalfinance/math/timeseries","description":"Public import: @insiderfinance/totalfinance/math/timeseries. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/math/timeseries","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/options","url":"/reference/totalfinance/options","description":"Public import: @insiderfinance/totalfinance/options. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/options","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/options/bachelier","url":"/reference/totalfinance/options/bachelier","description":"Public import: @insiderfinance/totalfinance/options/bachelier. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/options/bachelier","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/options/batch","url":"/reference/totalfinance/options/batch","description":"Public import: @insiderfinance/totalfinance/options/batch. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/options/batch","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/options/black-scholes","url":"/reference/totalfinance/options/black-scholes","description":"Public import: @insiderfinance/totalfinance/options/black-scholes. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/options/black-scholes","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/options/black76","url":"/reference/totalfinance/options/black76","description":"Public import: @insiderfinance/totalfinance/options/black76. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/options/black76","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/options/exotics","url":"/reference/totalfinance/options/exotics","description":"Public import: @insiderfinance/totalfinance/options/exotics. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/options/exotics","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/options/heston","url":"/reference/totalfinance/options/heston","description":"Public import: @insiderfinance/totalfinance/options/heston. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/options/heston","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/options/lattice","url":"/reference/totalfinance/options/lattice","description":"Public import: @insiderfinance/totalfinance/options/lattice. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/options/lattice","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/options/local-volatility","url":"/reference/totalfinance/options/local-volatility","description":"Public import: @insiderfinance/totalfinance/options/local-volatility. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/options/local-volatility","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/options/monte-carlo","url":"/reference/totalfinance/options/monte-carlo","description":"Public import: @insiderfinance/totalfinance/options/monte-carlo. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/options/monte-carlo","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/options/parity","url":"/reference/totalfinance/options/parity","description":"Public import: @insiderfinance/totalfinance/options/parity. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/options/parity","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/options/payoff","url":"/reference/totalfinance/options/payoff","description":"Public import: @insiderfinance/totalfinance/options/payoff. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/options/payoff","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/options/pricer","url":"/reference/totalfinance/options/pricer","description":"Public import: @insiderfinance/totalfinance/options/pricer. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/options/pricer","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/options/sabr","url":"/reference/totalfinance/options/sabr","description":"Public import: @insiderfinance/totalfinance/options/sabr. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/options/sabr","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/options/schema","url":"/reference/totalfinance/options/schema","description":"Public import: @insiderfinance/totalfinance/options/schema. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/options/schema","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/performance","url":"/reference/totalfinance/performance","description":"Public import: @insiderfinance/totalfinance/performance. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/performance","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/performance/activity","url":"/reference/totalfinance/performance/activity","description":"Public import: @insiderfinance/totalfinance/performance/activity. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/performance/activity","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/performance/analyze","url":"/reference/totalfinance/performance/analyze","description":"Public import: @insiderfinance/totalfinance/performance/analyze. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/performance/analyze","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/performance/drawdown","url":"/reference/totalfinance/performance/drawdown","description":"Public import: @insiderfinance/totalfinance/performance/drawdown. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/performance/drawdown","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/performance/flow-aware","url":"/reference/totalfinance/performance/flow-aware","description":"Public import: @insiderfinance/totalfinance/performance/flow-aware. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/performance/flow-aware","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/performance/metrics","url":"/reference/totalfinance/performance/metrics","description":"Public import: @insiderfinance/totalfinance/performance/metrics. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/performance/metrics","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/performance/ratios","url":"/reference/totalfinance/performance/ratios","description":"Public import: @insiderfinance/totalfinance/performance/ratios. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/performance/ratios","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/performance/relative","url":"/reference/totalfinance/performance/relative","description":"Public import: @insiderfinance/totalfinance/performance/relative. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/performance/relative","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/performance/returns","url":"/reference/totalfinance/performance/returns","description":"Public import: @insiderfinance/totalfinance/performance/returns. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/performance/returns","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/performance/rolling","url":"/reference/totalfinance/performance/rolling","description":"Public import: @insiderfinance/totalfinance/performance/rolling. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/performance/rolling","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/performance/sector-performance","url":"/reference/totalfinance/performance/sector-performance","description":"Public import: @insiderfinance/totalfinance/performance/sector-performance. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/performance/sector-performance","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/performance/sharpe","url":"/reference/totalfinance/performance/sharpe","description":"Public import: @insiderfinance/totalfinance/performance/sharpe. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/performance/sharpe","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/portfolio","url":"/reference/totalfinance/portfolio","description":"Public import: @insiderfinance/totalfinance/portfolio. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/portfolio","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/portfolio/disclosed-holding-partitions","url":"/reference/totalfinance/portfolio/disclosed-holding-partitions","description":"Public import: @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/portfolio/disclosed-holding-partitions","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/portfolio/disclosed-holdings","url":"/reference/totalfinance/portfolio/disclosed-holdings","description":"Public import: @insiderfinance/totalfinance/portfolio/disclosed-holdings. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/portfolio/disclosed-holdings","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/portfolio/events","url":"/reference/totalfinance/portfolio/events","description":"Public import: @insiderfinance/totalfinance/portfolio/events. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/portfolio/events","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/portfolio/ledger","url":"/reference/totalfinance/portfolio/ledger","description":"Public import: @insiderfinance/totalfinance/portfolio/ledger. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/portfolio/ledger","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/portfolio/performance","url":"/reference/totalfinance/portfolio/performance","description":"Public import: @insiderfinance/totalfinance/portfolio/performance. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/portfolio/performance","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/portfolio/policy","url":"/reference/totalfinance/portfolio/policy","description":"Public import: @insiderfinance/totalfinance/portfolio/policy. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/portfolio/policy","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/portfolio/reconciliation","url":"/reference/totalfinance/portfolio/reconciliation","description":"Public import: @insiderfinance/totalfinance/portfolio/reconciliation. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/portfolio/reconciliation","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/portfolio/trade","url":"/reference/totalfinance/portfolio/trade","description":"Public import: @insiderfinance/totalfinance/portfolio/trade. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/portfolio/trade","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/research","url":"/reference/totalfinance/research","description":"Public import: @insiderfinance/totalfinance/research. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/research","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/research/artifacts","url":"/reference/totalfinance/research/artifacts","description":"Public import: @insiderfinance/totalfinance/research/artifacts. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/research/artifacts","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/research/events","url":"/reference/totalfinance/research/events","description":"Public import: @insiderfinance/totalfinance/research/events. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/research/events","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/research/factors","url":"/reference/totalfinance/research/factors","description":"Public import: @insiderfinance/totalfinance/research/factors. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/research/factors","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/research/screening","url":"/reference/totalfinance/research/screening","description":"Public import: @insiderfinance/totalfinance/research/screening. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/research/screening","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/risk","url":"/reference/totalfinance/risk","description":"Public import: @insiderfinance/totalfinance/risk. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/risk","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/risk/factor","url":"/reference/totalfinance/risk/factor","description":"Public import: @insiderfinance/totalfinance/risk/factor. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/risk/factor","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/risk/optimize","url":"/reference/totalfinance/risk/optimize","description":"Public import: @insiderfinance/totalfinance/risk/optimize. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/risk/optimize","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/risk/portfolio","url":"/reference/totalfinance/risk/portfolio","description":"Public import: @insiderfinance/totalfinance/risk/portfolio. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/risk/portfolio","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/risk/research","url":"/reference/totalfinance/risk/research","description":"Public import: @insiderfinance/totalfinance/risk/research. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/risk/research","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/risk/scenario","url":"/reference/totalfinance/risk/scenario","description":"Public import: @insiderfinance/totalfinance/risk/scenario. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/risk/scenario","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/risk/sizing","url":"/reference/totalfinance/risk/sizing","description":"Public import: @insiderfinance/totalfinance/risk/sizing. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/risk/sizing","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/risk/value-at-risk","url":"/reference/totalfinance/risk/value-at-risk","description":"Public import: @insiderfinance/totalfinance/risk/value-at-risk. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/risk/value-at-risk","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/scenarios","url":"/reference/totalfinance/scenarios","description":"Public import: @insiderfinance/totalfinance/scenarios. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/scenarios","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/scenarios/portfolio","url":"/reference/totalfinance/scenarios/portfolio","description":"Public import: @insiderfinance/totalfinance/scenarios/portfolio. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/scenarios/portfolio","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/strategy","url":"/reference/totalfinance/strategy","description":"Public import: @insiderfinance/totalfinance/strategy. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/strategy","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/strategy/from-chain","url":"/reference/totalfinance/strategy/from-chain","description":"Public import: @insiderfinance/totalfinance/strategy/from-chain. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/strategy/from-chain","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/strategy/probability","url":"/reference/totalfinance/strategy/probability","description":"Public import: @insiderfinance/totalfinance/strategy/probability. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/strategy/probability","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/strategy/scanner","url":"/reference/totalfinance/strategy/scanner","description":"Public import: @insiderfinance/totalfinance/strategy/scanner. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/strategy/scanner","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/structure","url":"/reference/totalfinance/structure","description":"Public import: @insiderfinance/totalfinance/structure. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/structure","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/structure/exposure","url":"/reference/totalfinance/structure/exposure","description":"Public import: @insiderfinance/totalfinance/structure/exposure. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/structure/exposure","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/structure/flow","url":"/reference/totalfinance/structure/flow","description":"Public import: @insiderfinance/totalfinance/structure/flow. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/structure/flow","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis","url":"/reference/totalfinance/technical-analysis","description":"Public import: @insiderfinance/totalfinance/technical-analysis. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/aliases","url":"/reference/totalfinance/technical-analysis/aliases","description":"Public import: @insiderfinance/totalfinance/technical-analysis/aliases. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/aliases","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/bands","url":"/reference/totalfinance/technical-analysis/bands","description":"Public import: @insiderfinance/totalfinance/technical-analysis/bands. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/bands","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/bars","url":"/reference/totalfinance/technical-analysis/bars","description":"Public import: @insiderfinance/totalfinance/technical-analysis/bars. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/bars","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/candle-aliases","url":"/reference/totalfinance/technical-analysis/candle-aliases","description":"Public import: @insiderfinance/totalfinance/technical-analysis/candle-aliases. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/candle-aliases","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/candle-talib","url":"/reference/totalfinance/technical-analysis/candle-talib","description":"Public import: @insiderfinance/totalfinance/technical-analysis/candle-talib. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/candle-talib","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/candlesticks","url":"/reference/totalfinance/technical-analysis/candlesticks","description":"Public import: @insiderfinance/totalfinance/technical-analysis/candlesticks. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/candlesticks","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/chart-types","url":"/reference/totalfinance/technical-analysis/chart-types","description":"Public import: @insiderfinance/totalfinance/technical-analysis/chart-types. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/chart-types","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/cycle","url":"/reference/totalfinance/technical-analysis/cycle","description":"Public import: @insiderfinance/totalfinance/technical-analysis/cycle. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/cycle","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/divergence","url":"/reference/totalfinance/technical-analysis/divergence","description":"Public import: @insiderfinance/totalfinance/technical-analysis/divergence. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/divergence","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/features","url":"/reference/totalfinance/technical-analysis/features","description":"Public import: @insiderfinance/totalfinance/technical-analysis/features. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/features","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/framework","url":"/reference/totalfinance/technical-analysis/framework","description":"Public import: @insiderfinance/totalfinance/technical-analysis/framework. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/framework","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/macd","url":"/reference/totalfinance/technical-analysis/macd","description":"Public import: @insiderfinance/totalfinance/technical-analysis/macd. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/macd","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/math","url":"/reference/totalfinance/technical-analysis/math","description":"Public import: @insiderfinance/totalfinance/technical-analysis/math. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/math","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/microstructure","url":"/reference/totalfinance/technical-analysis/microstructure","description":"Public import: @insiderfinance/totalfinance/technical-analysis/microstructure. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/microstructure","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/momentum","url":"/reference/totalfinance/technical-analysis/momentum","description":"Public import: @insiderfinance/totalfinance/technical-analysis/momentum. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/momentum","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/moving-averages","url":"/reference/totalfinance/technical-analysis/moving-averages","description":"Public import: @insiderfinance/totalfinance/technical-analysis/moving-averages. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/moving-averages","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/oscillators","url":"/reference/totalfinance/technical-analysis/oscillators","description":"Public import: @insiderfinance/totalfinance/technical-analysis/oscillators. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/oscillators","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/overlap","url":"/reference/totalfinance/technical-analysis/overlap","description":"Public import: @insiderfinance/totalfinance/technical-analysis/overlap. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/overlap","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/pipeline","url":"/reference/totalfinance/technical-analysis/pipeline","description":"Public import: @insiderfinance/totalfinance/technical-analysis/pipeline. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/pipeline","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/price-action","url":"/reference/totalfinance/technical-analysis/price-action","description":"Public import: @insiderfinance/totalfinance/technical-analysis/price-action. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/price-action","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/registry","url":"/reference/totalfinance/technical-analysis/registry","description":"Public import: @insiderfinance/totalfinance/technical-analysis/registry. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/registry","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/resample","url":"/reference/totalfinance/technical-analysis/resample","description":"Public import: @insiderfinance/totalfinance/technical-analysis/resample. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/resample","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/rsi","url":"/reference/totalfinance/technical-analysis/rsi","description":"Public import: @insiderfinance/totalfinance/technical-analysis/rsi. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/rsi","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/series","url":"/reference/totalfinance/technical-analysis/series","description":"Public import: @insiderfinance/totalfinance/technical-analysis/series. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/series","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/signal","url":"/reference/totalfinance/technical-analysis/signal","description":"Public import: @insiderfinance/totalfinance/technical-analysis/signal. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/signal","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/statistics","url":"/reference/totalfinance/technical-analysis/statistics","description":"Public import: @insiderfinance/totalfinance/technical-analysis/statistics. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/statistics","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/transforms","url":"/reference/totalfinance/technical-analysis/transforms","description":"Public import: @insiderfinance/totalfinance/technical-analysis/transforms. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/transforms","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/trend","url":"/reference/totalfinance/technical-analysis/trend","description":"Public import: @insiderfinance/totalfinance/technical-analysis/trend. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/trend","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/volatility","url":"/reference/totalfinance/technical-analysis/volatility","description":"Public import: @insiderfinance/totalfinance/technical-analysis/volatility. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/volatility","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/volume","url":"/reference/totalfinance/technical-analysis/volume","description":"Public import: @insiderfinance/totalfinance/technical-analysis/volume. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/volume","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/technical-analysis/warmup","url":"/reference/totalfinance/technical-analysis/warmup","description":"Public import: @insiderfinance/totalfinance/technical-analysis/warmup. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/technical-analysis/warmup","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/valuation","url":"/reference/totalfinance/valuation","description":"Public import: @insiderfinance/totalfinance/valuation. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/valuation","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/valuation/cash-flows","url":"/reference/totalfinance/valuation/cash-flows","description":"Public import: @insiderfinance/totalfinance/valuation/cash-flows. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/valuation/cash-flows","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/valuation/corporate","url":"/reference/totalfinance/valuation/corporate","description":"Public import: @insiderfinance/totalfinance/valuation/corporate. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/valuation/corporate","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/valuation/forecasting","url":"/reference/totalfinance/valuation/forecasting","description":"Public import: @insiderfinance/totalfinance/valuation/forecasting. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/valuation/forecasting","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/valuation/price-levels","url":"/reference/totalfinance/valuation/price-levels","description":"Public import: @insiderfinance/totalfinance/valuation/price-levels. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/valuation/price-levels","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/valuation/schemas","url":"/reference/totalfinance/valuation/schemas","description":"Public import: @insiderfinance/totalfinance/valuation/schemas. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/valuation/schemas","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility","url":"/reference/totalfinance/volatility","description":"Public import: @insiderfinance/totalfinance/volatility. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/analytics","url":"/reference/totalfinance/volatility/analytics","description":"Public import: @insiderfinance/totalfinance/volatility/analytics. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/analytics","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/arbitrage","url":"/reference/totalfinance/volatility/arbitrage","description":"Public import: @insiderfinance/totalfinance/volatility/arbitrage. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/arbitrage","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/artifacts","url":"/reference/totalfinance/volatility/artifacts","description":"Public import: @insiderfinance/totalfinance/volatility/artifacts. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/artifacts","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/earnings","url":"/reference/totalfinance/volatility/earnings","description":"Public import: @insiderfinance/totalfinance/volatility/earnings. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/earnings","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/essvi","url":"/reference/totalfinance/volatility/essvi","description":"Public import: @insiderfinance/totalfinance/volatility/essvi. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/essvi","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/estimate","url":"/reference/totalfinance/volatility/estimate","description":"Public import: @insiderfinance/totalfinance/volatility/estimate. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/estimate","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/event","url":"/reference/totalfinance/volatility/event","description":"Public import: @insiderfinance/totalfinance/volatility/event. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/event","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/forecast","url":"/reference/totalfinance/volatility/forecast","description":"Public import: @insiderfinance/totalfinance/volatility/forecast. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/forecast","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/heston-surface","url":"/reference/totalfinance/volatility/heston-surface","description":"Public import: @insiderfinance/totalfinance/volatility/heston-surface. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/heston-surface","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/local-volatility","url":"/reference/totalfinance/volatility/local-volatility","description":"Public import: @insiderfinance/totalfinance/volatility/local-volatility. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/local-volatility","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/metrics","url":"/reference/totalfinance/volatility/metrics","description":"Public import: @insiderfinance/totalfinance/volatility/metrics. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/metrics","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/min-variance-delta","url":"/reference/totalfinance/volatility/min-variance-delta","description":"Public import: @insiderfinance/totalfinance/volatility/min-variance-delta. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/min-variance-delta","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/risk-reversal","url":"/reference/totalfinance/volatility/risk-reversal","description":"Public import: @insiderfinance/totalfinance/volatility/risk-reversal. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/risk-reversal","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/sabr","url":"/reference/totalfinance/volatility/sabr","description":"Public import: @insiderfinance/totalfinance/volatility/sabr. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/sabr","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/sabr-delta","url":"/reference/totalfinance/volatility/sabr-delta","description":"Public import: @insiderfinance/totalfinance/volatility/sabr-delta. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/sabr-delta","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/skew","url":"/reference/totalfinance/volatility/skew","description":"Public import: @insiderfinance/totalfinance/volatility/skew. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/skew","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/ssvi","url":"/reference/totalfinance/volatility/ssvi","description":"Public import: @insiderfinance/totalfinance/volatility/ssvi. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/ssvi","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/sticky-regime","url":"/reference/totalfinance/volatility/sticky-regime","description":"Public import: @insiderfinance/totalfinance/volatility/sticky-regime. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/sticky-regime","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/surface","url":"/reference/totalfinance/volatility/surface","description":"Public import: @insiderfinance/totalfinance/volatility/surface. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/surface","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/surface-pca","url":"/reference/totalfinance/volatility/surface-pca","description":"Public import: @insiderfinance/totalfinance/volatility/surface-pca. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/surface-pca","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/svi","url":"/reference/totalfinance/volatility/svi","description":"Public import: @insiderfinance/totalfinance/volatility/svi. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/svi","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/swaption-cube","url":"/reference/totalfinance/volatility/swaption-cube","description":"Public import: @insiderfinance/totalfinance/volatility/swaption-cube. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/swaption-cube","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/tail-risk","url":"/reference/totalfinance/volatility/tail-risk","description":"Public import: @insiderfinance/totalfinance/volatility/tail-risk. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/tail-risk","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/term","url":"/reference/totalfinance/volatility/term","description":"Public import: @insiderfinance/totalfinance/volatility/term. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/term","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/vanna-volga","url":"/reference/totalfinance/volatility/vanna-volga","description":"Public import: @insiderfinance/totalfinance/volatility/vanna-volga. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/vanna-volga","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/variance-index","url":"/reference/totalfinance/volatility/variance-index","description":"Public import: @insiderfinance/totalfinance/volatility/variance-index. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/variance-index","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/volatility/volatility-spot-beta","url":"/reference/totalfinance/volatility/volatility-spot-beta","description":"Public import: @insiderfinance/totalfinance/volatility/volatility-spot-beta. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/volatility/volatility-spot-beta","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/workflows","url":"/reference/totalfinance/workflows","description":"Public import: @insiderfinance/totalfinance/workflows. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/workflows","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance/workflows/local","url":"/reference/totalfinance/workflows/local","description":"Public import: @insiderfinance/totalfinance/workflows/local. Browse its complete export contracts.","category":"@insiderfinance/totalfinance","keywords":"@insiderfinance/totalfinance/workflows/local","kind":"entrypoint"},{"title":"@insiderfinance/totalfinance-mcp","url":"/reference/mcp","description":"Public import: @insiderfinance/totalfinance-mcp. Browse its complete export contracts.","category":"@insiderfinance/totalfinance-mcp","keywords":"@insiderfinance/totalfinance-mcp","kind":"entrypoint"},{"title":"totalfinance.artifact.compare","url":"/agents/operations/totalfinance.artifact.compare","description":"Compare a baseline and a candidate artifact of the same type leaf by leaf: value differences with absolute and relative deltas, added and removed paths, whether inputs and producers match, and — when a tolerance is supplied — whether every numeric leaf is within it. The result is compareAnalysisArtifacts(...) verbatim.","category":"MCP / CLI / HTTP operation","keywords":"Compare two analysis artifacts artifact backtesting full portfolio scenarios","kind":"operation"},{"title":"totalfinance.artifact.read","url":"/agents/operations/totalfinance.artifact.read","description":"Validate a Gate B analysis artifact (its envelope, its recomputed inputs hash, and its content-hash identity) and return its identity, type, producer, provenance warnings, table names, and a bounded preview of the stored result — the one read door for any artifact over the wire. Migrations are not registered over the wire; a stored older version is refused with the versions named.","category":"MCP / CLI / HTTP operation","keywords":"Read an analysis artifact artifact backtesting full portfolio scenarios","kind":"operation"},{"title":"totalfinance.backtest.cross_sectional_run","url":"/agents/operations/totalfinance.backtest.cross_sectional_run","description":"Backtest a point-in-time cross-sectional strategy: a returns dataset with declared features, a universe history with entries and exits, one declarative signal (a versioned factor recipe, a composite score, or a screen), a rebalance schedule, and a portfolio construction (quantile/count/fraction selection on each side; equal, score, inverse-volatility, or risk-budget weights; dollar/sector/beta/factor neutrality; position, weight, turnover, and participation caps — every trim a reported goal). Fills go through the execution policy into the portfolio ledger; the final value reconciles to the ledger NAV. Rebalances, holdings, fills, the ledger, the timeline, attribution, the benchmark block, and the performance summary — crossSectionalBacktest(...) verbatim. Opt-in (backtestPack): payloads and runtime are heavier than the default set; bulk row sets above the row cap travel by handle.","category":"MCP / CLI / HTTP operation","keywords":"Run a cross-sectional backtest backtest backtesting full","kind":"operation"},{"title":"totalfinance.backtest.environment_episode","url":"/agents/operations/totalfinance.backtest.environment_episode","description":"Run one of the six maintained baseline policies through the deterministic trading environment over a catalogue episode (or a named declarative definition) at a seed, and return Agent Bench's report for that episode: operational conformance (look-ahead, replay equality, duplicate orders under the retry drive, external-order attempts, reconciliation; the mask and limit counts) apart from strategy quality (return, volatility, Sharpe, Sortino, drawdown, turnover, cost, exposure, violations) — no single score by design. With artifact: 'embed', the recorded episode travels as an `environment` run artifact that replays to its run hash. Declarative inputs only: a TypeScript policy or a reward goal callback is SDK-only. Opt-in (backtestPack).","category":"MCP / CLI / HTTP operation","keywords":"Bench a baseline policy over one trading-environment episode backtest backtesting full","kind":"operation"},{"title":"totalfinance.backtest.options_run","url":"/agents/operations/totalfinance.backtest.options_run","description":"Backtest a declarative options strategy over chain snapshots: structure selection by delta and DTE, exit and roll triggers, optional delta hedging, declarative commission and slippage, American assignment modelling, and the marking policy (current-quote or entry volatility; what a missing mark does). Several rules may hold several trades at once (book), pre-trade limits reject entries with rows, combo or legged fills, quote freshness, split lineage, dividend evidence, the surface summary, and the portfolio ledger the equity reconciles to. Equity points, trades with per-leg attribution and mark counts, settlements, and the standard performance summary. The result is optionsBacktest(...) verbatim. Opt-in (backtestPack): payloads and runtime are heavier than the default set.","category":"MCP / CLI / HTTP operation","keywords":"Run an options backtest backtest backtesting full","kind":"operation"},{"title":"totalfinance.backtest.portfolio_run","url":"/agents/operations/totalfinance.backtest.portfolio_run","description":"Backtest a multi-asset portfolio through the ledger: instruments with built-in adapters (equity, etf, option, future, fx-forward, crypto-spot, crypto-perpetual, bond), market data by row set, a model or inline targets on a rebalance schedule, an execution policy with settlement lags, external flows, a calendar, and the margin check with forced liquidation. Every fill, flow, lifecycle fact, and liquidation is a portfolio event; the equity is the ledger's net asset value. The result is portfolioBacktest(...) verbatim. Opt-in (backtestPack): payloads and runtime are heavier than the default set; bulk row sets above the row cap travel by handle.","category":"MCP / CLI / HTTP operation","keywords":"Run a portfolio backtest backtest backtesting full","kind":"operation"},{"title":"totalfinance.backtest.vectorized_run","url":"/agents/operations/totalfinance.backtest.vectorized_run","description":"Run a single-asset vectorized backtest: signal-following fills at close, optional bps fees. Returns final value, turnover, and the performance summary; every hidden policy the run assumed (fill timing, costs, slippage, settlement, calendar, margin) is echoed in `assumptions`, and the implementation-risk warnings (look-ahead, data alignment) ride `diagnostics`. Deliberately opt-in (backtestPack) — payloads and runtime are heavier than the default tools. executionLag shifts signal lookup before rebalance sampling; a month-end target can miss the next monthly sample. Use the SDK researchProtocol and selection-hygiene workflow before comparing candidates; see docs/guides/dogfood-journeys.md.","category":"MCP / CLI / HTTP operation","keywords":"Run a vectorized backtest backtest backtesting full","kind":"operation"},{"title":"totalfinance.calendar.sessions","url":"/agents/operations/totalfinance.calendar.sessions","description":"Trading days, holidays, and half days for an exchange calendar over a date range (≤ ~13 months), plus option expirations (weekly Fridays / monthly OPEX / quarterly, shifted off holidays from the calendar data) when `expirationKind` is set, and the next expiry after the range start. NYSE/CBOE one-off closure coverage begins 2001-01-01; earlier ranges carry a diagnostic. Rules project other dates, not future emergency closures.","category":"MCP / CLI / HTTP operation","keywords":"Trading sessions & option expirations calendar default full","kind":"operation"},{"title":"totalfinance.crypto.futures_basis","url":"/agents/operations/totalfinance.crypto.futures_basis","description":"Annualized basis of a dated future over spot — the cash-and-carry yield. Reports raw and percentage basis, simple and continuously-compounded annualization, contango/backwardation, and flags an arbitrage-sized basis.","category":"MCP / CLI / HTTP operation","keywords":"Futures basis / cash-and-carry crypto default full","kind":"operation"},{"title":"totalfinance.crypto.perpetual_funding","url":"/agents/operations/totalfinance.crypto.perpetual_funding","description":"Annualize a perpetual funding rate into the implied cost-of-carry: the mark/index premium, simple and compounded annualized funding, and an extreme-funding flag. All rates are decimals; the interval defaults to the standard 8 hours.","category":"MCP / CLI / HTTP operation","keywords":"Perpetual funding → implied carry crypto default full","kind":"operation"},{"title":"totalfinance.fixed_income.bond_analytics","url":"/agents/operations/totalfinance.fixed_income.bond_analytics","description":"Full fixed-rate bond analytics from a specification: given a `yield`, price it; given a `price`, solve the yield to maturity — then report clean/dirty price, accrued interest, Macaulay/modified duration, convexity, and DV01. Dates are YYYY-MM-DD; rates are decimals.","category":"MCP / CLI / HTTP operation","keywords":"Bond price/yield analytics fixed_income default full","kind":"operation"},{"title":"totalfinance.option.greeks","url":"/agents/operations/totalfinance.option.greeks","description":"Compute first-order Greeks (delta, gamma, theta/day, vega/1%, rho/1%) for a European option under Black–Scholes–Merton. Supply time as timeToExpiryYears (years) or as expiry + asOf (dates).","category":"MCP / CLI / HTTP operation","keywords":"Compute first-order Greeks options default full options strategies","kind":"operation"},{"title":"totalfinance.option.implied_volatility","url":"/agents/operations/totalfinance.option.implied_volatility","description":"Solve Black–Scholes–Merton implied volatility from an observed option price using the method suite (auto/brent/newton/halley/householder, with an optional Brent fallback). Supply time as timeToExpiryYears (years) or as expiry + asOf (dates). Non-convergence and no-arbitrage failures are reported in diagnostics (converged: false), never fabricated; the method actually used is echoed in diagnostics.method.","category":"MCP / CLI / HTTP operation","keywords":"Solve implied volatility options default full options strategies","kind":"operation"},{"title":"totalfinance.option.price","url":"/agents/operations/totalfinance.option.price","description":"Price a European option with the Black–Scholes–Merton model. Supply time as timeToExpiryYears (years) or as expiry + asOf (dates). Returns the price plus the assumptions (day count, compounding, units, resolved timeToExpiryYears) and diagnostics that produced it.","category":"MCP / CLI / HTTP operation","keywords":"Price an option (Black–Scholes–Merton) options default full options strategies","kind":"operation"},{"title":"totalfinance.performance.analyze","url":"/agents/operations/totalfinance.performance.analyze","description":"Summarize a return series or equity curve: total/annualized return, volatility, Sharpe, Sortino, Calmar, max drawdown, omega, hit rate, profit factor, expectancy — plus beta/alpha/tracking error/information ratio/Treynor when a `benchmark` is supplied. Suspicious inputs (prices passed as returns, returns passed as equity) are flagged in diagnostics.warnings, never silently reported.","category":"MCP / CLI / HTTP operation","keywords":"Full performance summary performance backtesting default full portfolio","kind":"operation"},{"title":"totalfinance.portfolio.analyze","url":"/agents/operations/totalfinance.portfolio.analyze","description":"One report of up to three direct results: the valuation snapshot at `asOf` (always), the dated timeline with P&L since each prior mark and drawdown (when `marks` are supplied), and the policy monitor with its alerts and carried state (when `monitor` is supplied). Each result is the direct function verbatim; nothing is aggregated across them, and one `assumptions` says which parts ran and why the others did not.","category":"MCP / CLI / HTTP operation","keywords":"Analyze a portfolio (snapshot, timeline, monitor) portfolio full portfolio","kind":"operation"},{"title":"totalfinance.portfolio.create","url":"/agents/operations/totalfinance.portfolio.create","description":"Start here before portfolio.record_events: supply durable portfolioId, baseCurrency and explicit initial events (an empty array creates no cash). Uses the existing artifact store and ledger reducer. Requires portfolio:write and a writable store. Save the returned handle and open it with portfolio.inspect from portfolioPack (enable both trade and portfolio packs, or use --profile full); subsequent event writes return a new immutable handle. Opt-in (tradePack).","category":"MCP / CLI / HTTP operation","keywords":"Create and store an explicitly defined portfolio ledger trade full","kind":"operation"},{"title":"totalfinance.portfolio.explain_pnl","url":"/agents/operations/totalfinance.portfolio.explain_pnl","description":"Explain the change in net asset value between two dated valuation marks: external flows, investment return, and the identity components (realized, unrealized, income, transaction costs, financing, foreign exchange) that reconcile to it with a published residual, by currency and by grouping. The result is portfolioPnl(...) verbatim.","category":"MCP / CLI / HTTP operation","keywords":"Explain portfolio P&L between two marks portfolio full portfolio","kind":"operation"},{"title":"totalfinance.portfolio.inspect","url":"/agents/operations/totalfinance.portfolio.inspect","description":"Open a returned totalfinance://portfolios/... handle through the same configured store, or import an inline serialized ledger for read-only inspection. Revalidates and replays the ledger. Summary returns identity/counts; events, positions and cash return bounded previews (default 20, maximum 100 rows). This does not value the portfolio; use portfolio.snapshot with explicit marks. Opt-in (portfolioPack).","category":"MCP / CLI / HTTP operation","keywords":"Open a portfolio ledger or handle and inspect a bounded page portfolio full portfolio","kind":"operation"},{"title":"totalfinance.portfolio.rebalance_proposal","url":"/agents/operations/totalfinance.portfolio.rebalance_proposal","description":"Fold the ledger snapshot to its state, mark it from the market snapshot, and propose the trades that take the portfolio to the policy targets (or only the drifted ones) under the policy limits, lot sizes, minimum notional, transaction-cost estimates, and an optional external flow. The result is proposePortfolioRebalance(...) verbatim: weights before and after, the cash summary, the trades with their estimates, the objective, and every target it could not resolve. Read-only by construction — it returns a proposal and places nothing. Opt-in (portfolioPack).","category":"MCP / CLI / HTTP operation","keywords":"Propose a rebalance (a proposal, never an order) portfolio full portfolio","kind":"operation"},{"title":"totalfinance.portfolio.record_events","url":"/agents/operations/totalfinance.portfolio.record_events","description":"Fold validated portfolio events (fills from trade.submit, deposits, corporate actions) onto a ledger through the ledger's own reducer and put the new ledger into the artifact store as a content-addressed portfolio handle. The write is the put: an unchanged ledger is the same handle; identical replays fold once and applied counts only new events. Changed event bodies are refused. Requires a writable artifact store and the portfolio:write capability. Opt-in (tradePack).","category":"MCP / CLI / HTTP operation","keywords":"Apply events to a ledger and store the new ledger trade full","kind":"operation"},{"title":"totalfinance.portfolio.snapshot","url":"/agents/operations/totalfinance.portfolio.snapshot","description":"Value every cash balance and position of a portfolio at one instant from a Gate B market snapshot: net asset value in the base currency, per-account cash rows (settled and unsettled), per-position marks, cost basis and unrealized P&L. Supply the portfolio as its serialized ledger envelope (re-hydrated through readPortfolioLedgerSnapshot) or as a derived PortfolioState. The result is portfolioSnapshot(...) verbatim.","category":"MCP / CLI / HTTP operation","keywords":"Value a portfolio at an instant portfolio full portfolio","kind":"operation"},{"title":"totalfinance.research.event_study","url":"/agents/operations/totalfinance.research.event_study","description":"Measure abnormal returns around dated events under a declared expected-return model (mean-adjusted, market-adjusted, or market model), with explicit session, overlap, and cumulation policies; per-event rows and cumulative abnormal returns, and the average abnormal return by offset with t-statistics. The result is eventStudy(...) verbatim.","category":"MCP / CLI / HTTP operation","keywords":"Run an event study research full research","kind":"operation"},{"title":"totalfinance.research.rank","url":"/agents/operations/totalfinance.research.rank","description":"Rank a point-in-time universe by one declared numeric field with an explicit tie policy (competition, dense, ordinal) and missing-value policy. The result is rankUniverse(...) verbatim.","category":"MCP / CLI / HTTP operation","keywords":"Rank a universe research full research","kind":"operation"},{"title":"totalfinance.research.score","url":"/agents/operations/totalfinance.research.score","description":"Score a point-in-time universe as a weighted composite of standardized components (z-score or percentile rank, higher- or lower-is-better) with an explicit missing-value policy. The result is scoreUniverse(...) verbatim.","category":"MCP / CLI / HTTP operation","keywords":"Score a universe research full research","kind":"operation"},{"title":"totalfinance.research.screen","url":"/agents/operations/totalfinance.research.screen","description":"Filter a point-in-time universe of instrument observations with a declarative filter tree, order the survivors, and optionally limit them — a replayable screen by construction (no caller predicate crosses the wire). The result is screenUniverse(...) verbatim.","category":"MCP / CLI / HTTP operation","keywords":"Screen a universe research full research","kind":"operation"},{"title":"totalfinance.risk.optimize","url":"/agents/operations/totalfinance.risk.optimize","description":"Solve a portfolio: minVariance, maxSharpe (tangency), meanVariance utility, riskParity (equal risk contribution), hrp (hierarchical risk parity), or kelly. Returns the Computed envelope: value.weights + value.objective, assumptions echo the objective and budget, and diagnostics carry converged/iterations — a non-converged solve adds an optimize.not_converged warning instead of pretending.","category":"MCP / CLI / HTTP operation","keywords":"Portfolio optimization risk default full portfolio","kind":"operation"},{"title":"totalfinance.risk.value_at_risk","url":"/agents/operations/totalfinance.risk.value_at_risk","description":"Estimate Value-at-Risk (VaR) and Conditional VaR / expected shortfall from a return series. Methods: historical (empirical quantile, default), parametric (Gaussian, optional Cornish-Fisher for skew/kurtosis), or monteCarlo. Both are positive loss magnitudes at the given `confidence`; the horizon scales by √-time. The applied confidence/method/horizon ride `assumptions` (with the resolved seed/samples for monteCarlo) and warnings ride `diagnostics`.","category":"MCP / CLI / HTTP operation","keywords":"Value-at-Risk & Conditional VaR risk default full portfolio","kind":"operation"},{"title":"totalfinance.scenario.run","url":"/agents/operations/totalfinance.scenario.run","description":"Revalue every target under every scenario of a Gate B scenario set against a Gate B market snapshot: a scenario-major cell grid with base values, per-cell P&L in local and reporting currency, and per-scenario aggregates. Targets are the serializable kinds — spot assets, Taylor (greeks) positions, and a portfolio bound through Taylor bindings. The result is runScenarios(...) verbatim.","category":"MCP / CLI / HTTP operation","keywords":"Run a scenario set against targets scenario full scenarios","kind":"operation"},{"title":"totalfinance.strategy.analyze","url":"/agents/operations/totalfinance.strategy.analyze","description":"Build a multi-leg options position from its legs and return breakevens, net debit/credit, max profit, and max loss. Legs may be given without premiums: pass `premiums: \"model\"` with a `market` snapshot (spot, volatility, riskFreeRate, asOf, expiry) and every unpriced leg is priced by the BSM engine — so an iron condor’s P&L and probability-of-profit come from strikes alone. Set `probability: true` (with `market`) to also get probability-of-profit, expected value, risk/reward, and probability-of-touch. `premiumSource` reports whether premiums were user- or model-supplied.","category":"MCP / CLI / HTTP operation","keywords":"Analyze an options strategy strategy default full strategies","kind":"operation"},{"title":"totalfinance.strategy.list","url":"/agents/operations/totalfinance.strategy.list","description":"Discover every named strategy builder: name, one-line description, whether it spans multiple expiries, and a canonical example input (the exact shape `totalfinance.strategy.analyze` accepts via its `strategy` + `input` form). Agents self-serve the input shapes from here.","category":"MCP / CLI / HTTP operation","keywords":"List the named-strategy catalog strategy default full strategies","kind":"operation"},{"title":"totalfinance.structure.exposures","url":"/agents/operations/totalfinance.structure.exposures","description":"Compute dealer-positioning exposure (net GEX/DEX at spot) and key levels — call/put walls, zero-gamma flip, max pain, pin risk, and 0DTE/weekly/monthly OPEX walls — from an option chain. Each row needs `strike`, `expiry`, `type`, `openInterest`, and either `impliedVolatility` or `price` (IV is implied from price when omitted). Inferred from open interest and a sign convention (echoed in `assumptions.convention`, with its caveats as `model.limitation` warnings in `diagnostics.warnings`) — it does not know true dealer books.","category":"MCP / CLI / HTTP operation","keywords":"Dealer exposure & levels from an option chain structure default full","kind":"operation"},{"title":"totalfinance.structure.flow","url":"/agents/operations/totalfinance.structure.flow","description":"Classify option prints into aggressor-side flow: sweeps (multi-print bursts, venue-verified when exchange codes are supplied), blocks, and multi-leg spreads. Aggressor side is NBBO-estimated (Lee–Ready style) — the honest caveats ride diagnostics.warnings as `model.limitation` entries (mirrored as `limitations` strings for quick reading); nothing is presented as exchange-confirmed unless it is.","category":"MCP / CLI / HTTP operation","keywords":"Classify options flow (sweeps / blocks / spreads) structure default full","kind":"operation"},{"title":"totalfinance.technical_analysis.calculate","url":"/agents/operations/totalfinance.technical_analysis.calculate","description":"Compute any of TotalFinance’s ~300 registered technical indicators over a price series. Pass canonical core Bar records directly under bars; symbol, timestampMs, vwap and adjusted are declared fields. Source records require open, one symbol and strictly increasing unique timestamps; no stripping or SDK preprocessing is needed. Identity/time are validated before OHLCV projection; retain the original source/provenance alongside the result. Close-based (`series`) indicators take `closes`; bar-based indicators take `bars` (OHLCV objects) or parallel column arrays under `series`; pair indicators (e.g. beta, correl) take `x` and `y`. Use `totalfinance.technical_analysis.list` to discover indicator names, input kinds, and parameters. Output is aligned to input length with null during warmup; `assumptions.parameters` echoes the parameters actually used (declared defaults merged with yours), and `diagnostics.warmup` is the first real index.","category":"MCP / CLI / HTTP operation","keywords":"Calculate a technical indicator technical_analysis default full","kind":"operation"},{"title":"totalfinance.technical_analysis.describe","url":"/agents/operations/totalfinance.technical_analysis.describe","description":"Return the full card for a single indicator (alias-aware): category, input kind, parameters, defaults, which parameters are required, its warmup (leading bars before the first real value), and its cross-library aliases. The token-lean way to learn one indicator without listing all ~335. Discover names with `totalfinance.technical_analysis.list`; compute with `totalfinance.technical_analysis.calculate`.","category":"MCP / CLI / HTTP operation","keywords":"Describe one technical indicator technical_analysis default full","kind":"operation"},{"title":"totalfinance.technical_analysis.list","url":"/agents/operations/totalfinance.technical_analysis.list","description":"Discover the technical indicators available to `totalfinance.technical_analysis.calculate`. Returns each indicator’s name, category, input kind (series | bars | pair), parameters, defaults, and which parameters are required. Narrow the ~335-indicator catalog with `search` (matches a name or a TA-Lib/pandas/TradingView alias) and/or `category`, and page it with `limit` (default 50) / `offset` (`total` is the full match count). For one indicator’s full card (including its warmup), use `totalfinance.technical_analysis.describe`. To browse momentum, use { category: \"momentum\" }, rather than searching the name momentum. Then pass a name to `totalfinance.technical_analysis.calculate`.","category":"MCP / CLI / HTTP operation","keywords":"List technical indicators technical_analysis default full","kind":"operation"},{"title":"totalfinance.trade.authorize","url":"/agents/operations/totalfinance.trade.authorize","description":"Bind human authority to one plan and one preflight report: the plan hash, the portfolio and market hashes preflight judged, the market instant and an age allowance, the paper mode, the account, a variance envelope, an expiry, the approver, and a closed set of idempotency keys. Refuses a denied preflight, an unjudged plan, or a stale expiry. The grant is put into the authorization store under its content hash and returned with its handle. Requires the trade:approve capability. Opt-in (tradePack).","category":"MCP / CLI / HTTP operation","keywords":"Mint an authorization grant for a preflighted plan trade full","kind":"operation"},{"title":"totalfinance.trade.cancel","url":"/agents/operations/totalfinance.trade.cancel","description":"Journal cancel-requested then cancelled for an open order in the journal store under `<sourceId>:journal`; a terminal order is not cancelled twice (accepted: false, the state says why). Cancelling a combo leg cancels all remaining legs of that plan-local combo. Both the original journal and authorization stores are required to recover pending submissions before cancellation; no new grant is needed. A fill delivered after the cancellation is Decision 6's late-fill path. Paper only; requires trade:paper. Opt-in (tradePack).","category":"MCP / CLI / HTTP operation","keywords":"Cancel an open paper order trade full","kind":"operation"},{"title":"totalfinance.trade.preflight","url":"/agents/operations/totalfinance.trade.preflight","description":"Normalize an intent (or take an execution plan) and judge it: the portfolio before and after through the ledger's own fold of hypothetical fills, every policy check with its verdict, declared-rate cost estimates, the monitor's alerts on the after-state, and one decision — allow only when every check passes, deny on any failure, require-approval when evidence is missing; never an allow from missing information. No effect. Opt-in (tradePack).","category":"MCP / CLI / HTTP operation","keywords":"Preflight a trade plan against the ledger, the market, and the policy trade full","kind":"operation"},{"title":"totalfinance.trade.reconcile","url":"/agents/operations/totalfinance.trade.reconcile","description":"Join the journal's order states (from the journal store by `journalId`, or inline events) to the ledger's fills under the execution source in both directions, compare delivered fill quantities per order within an explicit tolerance, list the unresolved orders, and — with an external snapshot — compose reconcilePortfolio verbatim. With planHash, exclude other plans’ journaled orders and fills from both joins; unattributed source fills remain discrepancies. External snapshots are judged over the whole portfolio. reconciled is true only when everything agrees and no order is unresolved. No effect; requires trade:paper. Opt-in (tradePack).","category":"MCP / CLI / HTTP operation","keywords":"Reconcile an execution journal to the ledger trade full","kind":"operation"},{"title":"totalfinance.trade.submit","url":"/agents/operations/totalfinance.trade.submit","description":"Verify the grant against the plan, the portfolio and market hashes, the market instant, the account, and the idempotency key; journal submitted and acknowledged; return the content-addressed receipt — the SAME receipt for a retry with the same key and plan (no second order), trade.idempotency_conflict for the same key with another plan, trade.grant_expired for an expired grant. With `observations`, the open orders meet the market through the engines' own fill path. Top-level fills/events are only this call’s new deltas; the submission receipt is immutable. `currentOrders` is the authoritative journal-derived current state and cumulative filled/remaining quantities for this receipt. `recovery: { fills, events }` contains all persisted normalized fills and reproducible ledger envelopes for this receipt’s orders, including this call’s fills. Retry after a lost response and apply recovery.events with portfolio.record_events; identical events fold once. Recovery grows with later fills without replaying the fill engine. The journal continues transactionally from the required journal store under `<sourceId>:journal`; retries must retain that store and source. A grant atomically records its exact prepared submission before journal commit: a retry with the same key into the same store/journal recovers those events and reads the same receipt; any other submission of the grant is trade.grant_consumed. Every journal write recovers earlier pending submissions before allocating new identities. Inline history must match persisted history exactly. Inline grants must exist unchanged in the trusted authorization store. Paper only; requires trade:paper. Opt-in (tradePack).","category":"MCP / CLI / HTTP operation","keywords":"Submit an authorized plan to the paper broker trade full","kind":"operation"},{"title":"totalfinance.valuation.company","url":"/agents/operations/totalfinance.valuation.company","description":"Project the three statements from explicit drivers, take the free cash flows the valuation basis needs, and discount them under the stated conventions (basis, date, currency, the REQUIRED discount rate, compounding, day count, the terminal value method, the enterprise-to-equity bridge). The result is discountedCashFlowFromStatements(...) verbatim — the projection with its balance-sheet reconciliation, the cash flows used, and the valuation — plus discountedCashFlowSensitivityTable(...) over the same flows when a sensitivity request is supplied. Opt-in (valuationPack).","category":"MCP / CLI / HTTP operation","keywords":"Value a company from its statements valuation full valuation","kind":"operation"},{"title":"totalfinance.volatility.event","url":"/agents/operations/totalfinance.volatility.event","description":"Decompose pre-event implied volatility into base + event variance and the implied one-day event move (the earnings-move read): eventMove = √max(0, atmVolatility²·timeToExpiryYears − baseVolatility²·timeToExpiryYears). Optionally reports the variance risk premium when `realizedVolatility` is supplied.","category":"MCP / CLI / HTTP operation","keywords":"Event-volatility decomposition (earnings) volatility default full options strategies","kind":"operation"},{"title":"totalfinance.volatility.expected_move","url":"/agents/operations/totalfinance.volatility.expected_move","description":"Compute the expected 1-sigma move of the underlying by expiry — the lognormal ±1σ band and the expected absolute move. Provide `impliedVolatility` + `timeToExpiryYears` to imply it from volatility, or `straddlePrice` to imply it from the ATM straddle. Risk-neutral, not a directional forecast.","category":"MCP / CLI / HTTP operation","keywords":"Expected move (1σ) volatility default full options strategies","kind":"operation"},{"title":"totalfinance.volatility.metrics","url":"/agents/operations/totalfinance.volatility.metrics","description":"Where does the current implied volatility sit against its history? Returns IV rank (min–max position, 0–100), IV percentile (share of history below current, 0–100), and summary statistics — the standard \"is IV high?\" read before selling or buying premium.","category":"MCP / CLI / HTTP operation","keywords":"IV rank / percentile / stats volatility default full options strategies","kind":"operation"},{"title":"totalfinance.volatility.probability_in_the_money","url":"/agents/operations/totalfinance.volatility.probability_in_the_money","description":"Risk-neutral probability that an option finishes in the money at expiry — N(d2) for a call, N(−d2) for a put. This is the model probability P(S_t ⋛ K), not a real-world forecast.","category":"MCP / CLI / HTTP operation","keywords":"Probability of finishing in-the-money volatility default full options strategies","kind":"operation"},{"title":"totalfinance.volatility.probability_of_touch","url":"/agents/operations/totalfinance.volatility.probability_of_touch","description":"Risk-neutral probability that the underlying TOUCHES `barrier` at any time before expiry (first-passage probability for geometric Brownian motion). Useful for stop/target and one-touch reasoning.","category":"MCP / CLI / HTTP operation","keywords":"Probability of touching a level volatility default full options strategies","kind":"operation"},{"title":"totalfinance.volatility.surface","url":"/agents/operations/totalfinance.volatility.surface","description":"Fit an implied-volatility surface from chain quotes (IV given directly, or implied from price) and return the surface rows, per-expiry ATM term structure, and the static-arbitrage report (calendar/butterfly violations). The surface never fabricates: non-convergence and extrapolation are reported in diagnostics/warnings.","category":"MCP / CLI / HTTP operation","keywords":"Fit an implied-vol surface volatility default full options strategies","kind":"operation"}]