Skip to content
TotalFinance

Strategies · @insiderfinance/totalfinance

@insiderfinance/totalfinance/strategy

import { … } from '@insiderfinance/totalfinance/strategy'
stable-by-law (pre-1.0; not a 1.0 stability guarantee)iface 70type 25class 1const 2fn 69JSON ↗
fn

strap

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import { strap } from '@insiderfinance/totalfinance/strategy';

export declare const strap: (input: s.SyntheticInput, config?: PositionConfig) => Position;
Fields, parameters and returned members (34)

Loading 34 members…

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

fn

strategy

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import { strategy } from '@insiderfinance/totalfinance/strategy';

export declare const strategy: ((positionLegs: readonly LegInput[], config?: PositionConfig) => Position) & { bearCallLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; bearCallSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; bearPutLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; bearPutSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; buildStrategy(request: manifest.BuildStrategyInput): Position; bullCallLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; bullCallSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; bullPutLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; bullPutSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; calendarCallSpread: (input: import('@insiderfinance/totalfinance/strategy').CalendarInput, config?: PositionConfig) => Position; calendarPutSpread: (input: import('@insiderfinance/totalfinance/strategy').CalendarInput, config?: PositionConfig) => Position; callBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; callRatioBackspread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; callRatioSpread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; cashSecuredPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; collar: (input: import('@insiderfinance/totalfinance/strategy').CollarInput, config?: PositionConfig) => Position; coveredCall: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg, config?: PositionConfig) => Position; coveredShortStraddle: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStraddleInput, config?: PositionConfig) => Position; coveredShortStrangle: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStrangleInput, config?: PositionConfig) => Position; diagonalCallSpread: (input: import('@insiderfinance/totalfinance/strategy').DiagonalInput, config?: PositionConfig) => Position; diagonalPutSpread: (input: import('@insiderfinance/totalfinance/strategy').DiagonalInput, config?: PositionConfig) => Position; doubleDiagonal: (input: import('@insiderfinance/totalfinance/strategy').DoubleDiagonalInput, config?: PositionConfig) => Position; guts: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; inverseCallBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; inverseIronButterfly: (input: import('@insiderfinance/totalfinance/strategy').IronButterflyInput, config?: PositionConfig) => Position; inverseIronCondor: (input: import('@insiderfinance/totalfinance/strategy').IronCondorInput, config?: PositionConfig) => Position; inversePutBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; ironButterfly: (input: import('@insiderfinance/totalfinance/strategy').IronButterflyInput, config?: PositionConfig) => Position; ironCondor: (input: import('@insiderfinance/totalfinance/strategy').IronCondorInput, config?: PositionConfig) => Position; jadeLizard: (input: import('@insiderfinance/totalfinance/strategy').JadeLizardInput, config?: PositionConfig) => Position; listStrategies(): manifest.StrategyDescriptor[]; longCall: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; longCallButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; longCallCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; longCombo: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; longPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; longPutButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; longPutCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; longSyntheticFuture: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; protectivePut: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg, config?: PositionConfig) => Position; putBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; putRatioBackspread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; putRatioSpread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; reverseJadeLizard: (input: import('@insiderfinance/totalfinance/strategy').ReverseJadeLizardInput, config?: PositionConfig) => Position; shortCall: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; shortCallButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; shortCallCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; shortCombo: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; shortGuts: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; shortPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; shortPutButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; shortPutCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; shortStraddle: (input: import('@insiderfinance/totalfinance/strategy').ShortStraddleInput, config?: PositionConfig) => Position; shortStrangle: (input: import('@insiderfinance/totalfinance/strategy').ShortStrangleInput, config?: PositionConfig) => Position; shortSyntheticFuture: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; straddle: (input: import('@insiderfinance/totalfinance/strategy').StraddleInput, config?: PositionConfig) => Position; strangle: (input: import('@insiderfinance/totalfinance/strategy').StrangleInput, config?: PositionConfig) => Position; strap: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; strip: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; syntheticPut: (input: import('@insiderfinance/totalfinance/strategy').SyntheticPutInput, config?: PositionConfig) => Position; };
Fields, parameters and returned members (2,092)

Loading 2,092 members…

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

fn

strategyFromChain

#

Build a Position from an option chain. Returns the position, its resolved legs (premiums and per-leg IVs attached), and the fills (contract / premium / delta per leg). Missing quotes throw strategy.strike_unavailable; delta-targeted selection without deltas throws strategy.delta_required.

Signature
import { strategyFromChain } from '@insiderfinance/totalfinance/strategy';

export declare function strategyFromChain(rows: OptionQuote[], options: FromChainOptions): FromChainResult;
Fields, parameters and returned members (11)
Name · typeMeaning · unitRequired · default
(options)FromChainOptions—unitless by nameRequiredNo @default declared
(rows)OptionQuote[]—unitless by nameRequiredNo @default declared
return.assumptions{ conventionsVersion: string; expiry: string; multiplier: number; priceSource: PriceSource; quantity: number; }

C (hygiene): the conventions the selection applied — above all which quoted price became each premium.

unitless by name
RequiredNo @default declared
return.assumptions.conventionsVersionstring—unitless by nameRequiredNo @default declared
return.assumptions.expirystring

The selection expiry (the NEAR expiry for a calendar).

unitless by name
RequiredNo @default declared
return.assumptions.multipliernumber—unitless by nameRequiredNo @default declared
return.assumptions.priceSourcePriceSource

The price source every premium was read from ('mid' by default; never a silent fallback).

unitless by name
RequiredNo @default declared
return.assumptions.quantitynumber—unitless by nameRequiredNo @default declared
return.fillsChainFill[]—unitless by nameRequiredNo @default declared
return.legsLeg[]—unitless by nameRequiredNo @default declared
return.positionPosition—unitless by nameRequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

fn

strategyOf

#

Build a position from legs.

Signature
import { strategyOf } from '@insiderfinance/totalfinance/strategy';

export declare function strategyOf(legs: readonly LegInput[], config?: PositionConfig): Position;
Fields, parameters and returned members (29)

Loading 29 members…

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

fn

strategySignature

#

Normalize legs to a structural BASE signature string (order-, scale-, and spacing-independent). Two leg lists share a base signature iff they have the same (kind, sign, strike-rank, quantity-ratio, expiry-rank) multiset — strike DISTANCES are deliberately not encoded (spacing distinguishes only butterflies from broken wings, handled as a tie-breaker in classifyStrategy, never here).

Signature
import { strategySignature } from '@insiderfinance/totalfinance/strategy';

export declare function strategySignature(legs: readonly ClassifiableLeg[]): string;
Fields, parameters and returned members (1)
Name · typeMeaning · unitRequired · default
(legs)readonly ClassifiableLeg[]—unitless by nameRequiredNo @default declared

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

fn

strip

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import { strip } from '@insiderfinance/totalfinance/strategy';

export declare const strip: (input: s.SyntheticInput, config?: PositionConfig) => Position;
Fields, parameters and returned members (34)

Loading 34 members…

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.

fn

syntheticPut

#

Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.

Signature
import { syntheticPut } from '@insiderfinance/totalfinance/strategy';

export declare const syntheticPut: (input: s.SyntheticPutInput, config?: PositionConfig) => Position;
Fields, parameters and returned members (34)

Loading 34 members…

Stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.