Thin Python client for the OptionsAhoy keyless public equity-compensation REST API.
Project description
optionsahoy
A thin, dependency-light Python client for the OptionsAhoy keyless public REST application programming interface (API). It wraps seven deterministic equity-compensation tax calculators behind one synchronous client. No OptionsAhoy account, no API key, full federal tax code plus all 50 states and the District of Columbia (DC).
Why not just ask the model?
We benchmarked five frontier large language models (LLMs), 3 runs each, 15 trials total, on the same multi-year incentive stock option (ISO) exercise problem. Every trial overshot the true after-tax outcome, by 2x to 20x. See the benchmark, updated for the latest models, at https://optionsahoy.com/benchmark. Multi-year scheduling has a search space larger than an LLM can reason through in-context; these tools return the verifiable answer instead.
Raw responses and scoring: llm-iso-benchmark. Full write-up: But can it do taxes though?.
Verified
Beyond determinism, the tax math is independently verified, every release: every 2026 federal constant matches its IRS Rev. Proc. 2025-32 value, worked federal cases reproduce to the cent against the independently-maintained PSL Tax-Calculator, and state tax reproduces to the cent against OpenTaxSolver across CA, NY, NJ, PA, and MA, with the headline answer recomputed live in your browser. Proof, shown beside the public sources: https://optionsahoy.com/verification
What it provides
Seven calculators, each a method on OptionsAhoyClient:
amt_iso(...)- multi-year ISO exercise optimizer under the alternative minimum tax (AMT)nso(...)- non-qualified stock option (NSO) exercise tax and after-tax proceeds, sell-at-exercise versus holdrsu_sell_vs_hold(...)- restricted stock unit (RSU) vest decision, sell at vest versus hold for long-term capital gainsconcentration(...)- single-stock concentration risk and the after-tax cost of diversifyingprotective_put(...)- protective put and zero-cost collar pricingqsbs(...)- qualified small business stock (QSBS) Section 1202 eligibility and exclusionequity_funding(...)- multi-year plan to fund a cash goal from equity by a target date
Coverage spans the full federal tax code (ordinary brackets, long-term capital gains, AMT with credit recovery, FICA, the net investment income tax) plus all 50 states and DC. The only runtime dependency is httpx. No API key is read, stored, or sent anywhere.
Tools: inputs and outputs
Each method takes keyword arguments. The required parameters are listed below; every method also accepts optional forward-looking fields (such as expectedSalePrice, volatility, expectedMarketReturn) and, where noted, a convenience ticker so the API can derive forward-looking inputs from that symbol. Returns are the top-level fields of the response; responses are wrapped as {"ok": true, "result": {...}} and the fields below are those of result.
amt_iso(...)
Optimizes a multi-year incentive stock option (ISO) exercise schedule under the alternative minimum tax (AMT): how many shares to exercise each year so the after-tax outcome is best.
- Inputs (required):
shares(ISO shares available to exercise),strike(exercise price per share, USD),fmv(current fair market value per share, USD),filingStatus(single|married_joint|head_household),ordinaryIncome(annual ordinary income before this exercise, USD),stateCode(two-letter US state code, orDC),carryforwardCredit(existing AMT credit carryforward, USD),horizon(planning horizon in years, 1 to 10),cashReturnRate(annual return on cash held instead of exercising, decimal),grantDate(ISO grant date, YYYY-MM-DD),hasLeftCompany(boolean),terminationDate(YYYY-MM-DD, ornullif still employed). - Optional:
expectedGrowth(expected annual share-price growth, decimal),volatility(annualized, decimal),volatilityDrag(0 to 0.99),ticker(covered public symbol to source expected return from). - Returns:
crossoverSharesandcrossoverBargain(the share count and bargain-element dollar amount at which AMT starts to bite this year);alreadyInAmt(boolean, whether the holder is already in AMT before exercising);stateHasAmt(boolean);bargainPerShare(fair market value minus strike, USD);effectiveHorizon(years actually usable, capped by grant expiration);timing(key dates:grantExpiration,qdEligibleDatefor the qualifying-disposition long-term threshold,exerciseWindowClose,daysUntilWindowClose,windowClosed,qdNotYetEligible); andscheduleswith three strategieslumpSum,evenSplit, andoptimized. Each schedule carriesyears[](per year:sharesexercised,bargain,regularFederal,regularState,tmtFederalandtmtStatetentative minimum tax,amtOwedFederalandamtOwedStateAMT actually owed above regular tax,creditRecovered,cashTaxtotal cash tax that year) plustotalTax,creditEarnedandcreditRemaining(AMT credit generated and still unrecovered),grossGain,federalLTCGandstateLTCG(long-term capital-gains tax at final sale), andnfv(net future value of the schedule).
nso(...)
Computes the tax and after-tax proceeds of exercising non-qualified stock options (NSOs), comparing selling at exercise against holding for later long-term capital gains.
- Inputs (required):
shares(NSO shares to exercise),strike(exercise price per share, USD),currentPrice(current share price, USD),ordinaryIncome(annual ordinary income before this exercise, USD),filingStatus(single|married_joint|head_household),stateCode(two-letter, orDC),stillEmployed(boolean; payroll taxes differ once separated),holdYears(years held after exercise, at least 1),holdFunding(sell-to-cover|cash; how the exercise is funded). - Optional:
expectedSalePrice(USD),haircut(risk haircut on expected upside, 0 to 1),volatility(decimal),expectedMarketReturn(decimal),ticker(covered symbol to source expected return). - Returns:
exercise(bargainElementordinary income at exercise, plusfederal,state,socialSecurity,medicare,additionalMedicaretaxes,total, andnetCashSellAllcash kept if you sell every share at exercise);bracketJump(fromRate,toRate,thresholdAtJump: the marginal-rate jump this exercise triggers);hold(the hold-and-sell-later path:sharesRetained,expectedGain,ltcgTotallong-term capital-gains tax at sale,afterTaxProceedsAtSale,netAtYearNnet wealth at the end of the hold);sellNowInvest(the alternative of selling now and investing the proceeds:netCashAtY0,marketGain,netAtYearN);holdMinusCashless(the dollar difference between holding and the sell-now path, positive favors holding).
rsu_sell_vs_hold(...)
Compares selling vested restricted stock units (RSUs) at vest against holding them, on an after-tax, risk-adjusted basis.
- Inputs (required):
shares(vested RSU shares),currentPrice(USD),ordinaryIncome(annual ordinary income, USD),filingStatus(single|married_joint|head_household),stateCode(two-letter, orDC),stillEmployed(boolean),holdYears(years to hold, 0.25 to 5). - Optional:
expectedSalePrice(USD),haircut(0 to 1),volatility(decimal),expectedMarketReturn(decimal),ticker(covered symbol). - Returns:
vest(taxes due at vest:vestValueordinary income recognized,federal,state,medicare,total,netCashAtVest, andfederalWithheldAtVestthe typical flat withholding);bracketJump(fromRate,toRate,thresholdAtJump);hold(sharesRetained,expectedGain,capGainTotalcapital-gains tax at sale,isLongTermboolean,netAtYearNnet wealth from holding);sellNowInvest(netCashAtY0,marketGain,netAtYearNfrom selling at vest and investing);holdMinusSell(dollar difference, positive favors holding).
concentration(...)
Quantifies single-stock concentration risk and compares the after-tax cost of three responses: sell down, hold, or hedge.
- Inputs (required):
positionValue(current market value of the position, USD),costBasis(total cost basis, USD),acquisitionDate(earliest lot, YYYY-MM-DD; sets the one-year long-term threshold),sector(one oftech_software,semiconductors,consumer_cyclical,consumer_defensive,financials,healthcare_biotech,energy,industrials,communication,broad_market; sets default volatility),stateCode(two-letter, orDC),filingStatus(single|married_joint|head_household),ordinaryIncome(USD),totalAssets(whole investable portfolio including this position, USD). - Optional:
expectedPositionReturn(decimal) andexpectedMarketReturn(decimal), orticker(covered symbol to derive both);volatility(decimal),volatilityDrag(0 to 0.99),hedgeChoice({kind: put|collar, protectionLevel, tenorYears, upsideCapPct}). - Returns:
concentration(position divided by totalAssets, 0 to 1);riskBand(a label:Low|Moderate|Concentrated|Highly concentrated|Extreme);isLongTermToday(boolean),longTermDateanddaysUntilLongTerm(when the position reaches long-term treatment);lossExposure[](dollar loss and resulting concentration at 30/50/70 percent drops:drop,dollarLoss,newConcentration);waitForLtInsight(a string nudge to wait for long-term rates, ornull);schedule[](after-tax sell-down plans, eachplanKey/planLabel,yearlySales,totalTax,endOfHorizonWealth,savingsVsLumpSum,wealthByYear);hedging(put or collarstrike,putPrice,sigma,riskFreeRate, present whenhedgeChoiceis given);sectorContextLineandadvisorBenchmarkLine(human-readable summary strings).
protective_put(...)
Prices a protective put and a zero-cost collar for a stock position at a chosen downside-protection level and tenor.
- Inputs (required):
positionValue(market value to hedge, USD),sector(one oftech_software,semiconductors,consumer_cyclical,consumer_defensive,financials,healthcare_biotech,energy,industrials,communication,broad_market; sets default volatility),protectionLevel(downside protected as a fraction, 0.05 to 0.5),tenorYears(hedge tenor in years, at least 0.25). - Optional:
volatility(annualized, decimal),expectedReturn(decimal),tickerLabel(display label for the symbol). - Returns:
inputs(the resolved inputs including the volatility used);riskFreeRateandrealWorldDrift(rates used to price);barePut(the put alone:strike,premium,annualCost,annualCostPct,maxLoss,coveredLossAtBadYear);collar(put financed by selling a call:putStrike,callStrike,netPremium,maxLoss,upsideCapandupsideCapPctthe gain you give up,isZeroCostboolean);payoffTable[](profit and loss at each drawdown:drawdownPct,barePutPnl,collarPnl,unhedgedPnl);payoffRange(lowerPct,upperPct);recommended(bare-put|collar|none).
qsbs(...)
Checks qualified small business stock (QSBS) Section 1202 eligibility and computes the resulting federal capital-gains exclusion.
- Inputs (required):
acquisitionDateandsaleDate(YYYY-MM-DD; the gap sets the holding period),entityType(us-c-corp|other),acquisitionMethod(original-issuance|gift-or-inheritance|secondary|unsure),assetCategory(issuer gross assets at issuance:under-50m|50m-to-75m|over-75m|unsure),industry(tech-software|manufacturing|biotech-research|retail-wholesale|health-services|law|engineering|architecture|accounting-actuarial|consulting|finance|farming|extraction|hospitality|performing-arts|other-services|unsure),activeBusiness(yes|no|unsure),adjustedBasis(USD),expectedGain(USD),stateCode(two-letter, orDC),ordinaryIncome(USD),filingStatus(single|married_joint|head_household). - Returns:
verdict(qualifies|partial|does-not-qualifyand similar);exclusionPercent(fraction of gain excluded, 0 to 1);perIssuerCap,tenXBasisCap(ten-times-basis cap), andapplicableCap(the binding cap, USD);excludableGainandtaxableGain(USD);federalTaxSaved(USD);stateConforms(full|partial|none) andstateNote(explanation string);holdingYears;yearsUntilFullExclusion;era(which Section 1202 ruleset applies, for examplepre-obbba);tests[](each eligibility test:id,label,statuspass|fail|warn,detail).
equity_funding(...)
Plans which equity lots to sell, and when, to fund a cash goal by a target date at the least after-tax cost, accounting for holding-period thresholds and shortfall risk.
- Inputs (required):
targetAfterTax(after-tax cash goal to raise, USD),targetDate(when the cash is needed, YYYY-MM-DD),ordinaryIncome(USD),filingStatus(single|married_joint|head_household),stateCode(two-letter, orDC), plus the holdings as eitherstacks(preferred: a list of stacks, each withcurrentPriceand alotslist of{shares, costBasisPerShare, acquisitionDate, vestDate?}, optional per-stackticker,expectedAnnualGrowth,volatility) or the legacylotsplus a singlecurrentPrice. - Optional:
expectedAnnualGrowth(decimal),cashInterestRate(decimal),riskToleranceShortfall(acceptable probability of shortfall, 0 to 1),defaultVolatility(decimal),today(override for the current date, YYYY-MM-DD). - Returns: four named plans
recommended,lockInNow,balanced,holdForGrowth, plusfrontier[](the full risk/return frontier), and the echoedtargetAfterTax,targetDateISO,appliedRiskTolerance. Each plan carriesplanKey/planLabel,wealthAtTarget(projected net wealth at the target date),totalTax,shortfallProbability(chance of missing the goal), and aplanwithfeasible(boolean),totalAfterTaxAchieved,totalSharesSold,totalGrossProceeds,totalTaxes(federal,state,niit,total),schedule(per-year sales with per-lotshares,grossProceeds,gainAmount,isLongTerm,federalTax,stateTax,niit,netCash),comparison(savings versus selling everything in the target year), andremainingShares/remainingPositionValue(what is left unsold).
To see the full typed signature for any method, read the client source: optionsahoy/client.py. The authoritative request schemas are the OpenAPI spec at https://optionsahoy.com/openapi.json and the agent docs at https://optionsahoy.com/for-agents.
Install
pip install optionsahoy
Quickstart
from optionsahoy import OptionsAhoyClient, OptionsAhoyError
client = OptionsAhoyClient() # base_url defaults to https://optionsahoy.com
try:
# QSBS: can this founder exclude gain on a planned sale?
result = client.qsbs(
acquisitionDate="2018-01-01",
saleDate="2026-02-01",
entityType="us-c-corp",
acquisitionMethod="original-issuance",
assetCategory="under-50m",
industry="tech-software",
activeBusiness="yes",
adjustedBasis=10000,
expectedGain=2000000,
stateCode="CA",
ordinaryIncome=250000,
filingStatus="single",
)
print(result)
except OptionsAhoyError as err:
print(err.status_code, err.payload)
Field names, types, and required-ness mirror the published OpenAPI schema at https://optionsahoy.com/openapi.json one for one; this client does not invent or rename fields. Optional fields left unset are not sent.
Forward-looking inputs
Some endpoints (for example nso and rsu_sell_vs_hold) accept forward-looking fields such as expectedSalePrice and volatility that the OpenAPI schema marks optional. At runtime the API requires you to supply these explicitly, or to set a covered ticker (for example "NVDA") so the API can derive them from that symbol's trailing data. Do not invent these values; pass what the user provides or a ticker. Omitting both returns a clear 400 explaining which field is needed.
Runnable example and source
- Runnable example:
examples/ - Source:
integrations/python/optionsahoy
Related
Agent-framework adapters that wrap this same client behind each framework's native tool interface:
- optionsahoy-langchain - LangChain tools
- llama-index-tools-optionsahoy - LlamaIndex tools
- crewai-optionsahoy - CrewAI tools
Other surfaces for the same calculators:
- Hosted Model Context Protocol (MCP) server: https://optionsahoy.com/mcp
- Agent integration docs: https://optionsahoy.com/for-agents
- Free in-browser calculators: https://optionsahoy.com/tools
Built by AlphaLatitude Inc., the company behind OptionsAhoy.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file optionsahoy-0.1.6.tar.gz.
File metadata
- Download URL: optionsahoy-0.1.6.tar.gz
- Upload date:
- Size: 14.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8d4f979fb4a00bb2d4a8bb202f2ea9bcc3f598f8d839518b2e0d0040797318c7
|
|
| MD5 |
5d3ebcf2041322a58fa09ccc70215422
|
|
| BLAKE2b-256 |
b3c2af09b0965293816c8095c65138e94d897df610e7801509a3d4f25a943a24
|
Provenance
The following attestation bundles were made for optionsahoy-0.1.6.tar.gz:
Publisher:
publish-python.yml on AlvisoOculus/optionsahoy-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
optionsahoy-0.1.6.tar.gz -
Subject digest:
8d4f979fb4a00bb2d4a8bb202f2ea9bcc3f598f8d839518b2e0d0040797318c7 - Sigstore transparency entry: 1834733518
- Sigstore integration time:
-
Permalink:
AlvisoOculus/optionsahoy-mcp@47e240575c5f7b95425e234d2c034ad889adf853 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/AlvisoOculus
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-python.yml@47e240575c5f7b95425e234d2c034ad889adf853 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file optionsahoy-0.1.6-py3-none-any.whl.
File metadata
- Download URL: optionsahoy-0.1.6-py3-none-any.whl
- Upload date:
- Size: 11.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b039f2c6d1be5ca86a94b97a978c3e81b10bf6e2776e9d1e67d3bf756b42450b
|
|
| MD5 |
58107709297ec6f2b97cd47065068237
|
|
| BLAKE2b-256 |
8a6120abd8d717581210c60156c83698184b4123f90f190f46c9687869976764
|
Provenance
The following attestation bundles were made for optionsahoy-0.1.6-py3-none-any.whl:
Publisher:
publish-python.yml on AlvisoOculus/optionsahoy-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
optionsahoy-0.1.6-py3-none-any.whl -
Subject digest:
b039f2c6d1be5ca86a94b97a978c3e81b10bf6e2776e9d1e67d3bf756b42450b - Sigstore transparency entry: 1834733671
- Sigstore integration time:
-
Permalink:
AlvisoOculus/optionsahoy-mcp@47e240575c5f7b95425e234d2c034ad889adf853 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/AlvisoOculus
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-python.yml@47e240575c5f7b95425e234d2c034ad889adf853 -
Trigger Event:
workflow_dispatch
-
Statement type: