Arcade toolkit for the OptionsAhoy equity-compensation calculators.
Project description
arcade-optionsahoy
An Arcade toolkit for the OptionsAhoy equity-compensation calculators. One @tool-decorated function per OptionsAhoy REST endpoint, built on the keyless optionsahoy client and the arcade-tdk Tool Development Kit. No OptionsAhoy account, no application programming interface (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
The toolkit exposes seven Arcade tools, each a @tool-decorated function with typing.Annotated parameters mirroring its endpoint:
AmtIsoOptimize- multi-year ISO exercise optimizer under the alternative minimum tax (AMT)NsoCalculate- non-qualified stock option (NSO) exercise tax, sell-at-exercise versus holdRsuSellVsHold- restricted stock unit (RSU) sell at vest versus hold for long-term capital gainsConcentrationAnalyze- single-stock concentration risk and the after-tax cost of diversifyingProtectivePutPrice- protective put and zero-cost collar pricingQsbsCheck- qualified small business stock (QSBS) Section 1202 eligibility and exclusionEquityFundingPlan- multi-year plan to fund a cash goal from equity by a target date
Coverage spans the full federal tax code plus all 50 states and DC. The toolkit pulls in the keyless optionsahoy client automatically. No API key is read, stored, or sent anywhere. Set OPTIONSAHOY_BASE_URL to point the tools at a different host.
Tools: inputs and outputs
Each tool's parameters list the required fields below; every tool also accepts optional forward-looking fields (such as expected_sale_price, volatility, expected_market_return) 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, wrapped as {"ok": true, "result": {...}}; the fields below are those of result.
AmtIsoOptimize
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,strike(USD),fmv(USD),filing_status(single|married_joint|head_household),ordinary_income(USD),state_code(two-letter, orDC),carryforward_credit(USD),horizon(1 to 10),cash_return_rate(decimal),grant_date(YYYY-MM-DD),has_left_company(boolean),termination_date(YYYY-MM-DD, or null if still employed). - Optional:
expected_growth(decimal),volatility(decimal),volatility_drag(0 to 0.99),ticker(covered public symbol). - Returns:
crossoverSharesandcrossoverBargain(where AMT starts to bite this year);alreadyInAmtandstateHasAmt(booleans);bargainPerShare;effectiveHorizon;timing(key dates); andscheduleswith three strategieslumpSum,evenSplit, andoptimized, each carrying per-year tax, AMT owed and credit, long-term capital-gains tax at final sale, andnfv(net future value).
NsoCalculate
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,strike(USD),current_price(USD),ordinary_income(USD),filing_status,state_code,still_employed(boolean),hold_years(at least 1),hold_funding(sell-to-cover|cash). - Optional:
expected_sale_price(USD),haircut(0 to 1),volatility(decimal),expected_market_return(decimal),ticker. - Returns:
exercise(ordinary income and taxes at exercise, plus net cash if you sell every share);bracketJump;hold(the hold-and-sell-later path);sellNowInvest(sell now and invest the proceeds);holdMinusCashless(positive favors holding).
RsuSellVsHold
Compares selling vested restricted stock units (RSUs) at vest against holding them, on an after-tax, risk-adjusted basis.
- Inputs (required):
shares,current_price(USD),ordinary_income(USD),filing_status,state_code,still_employed(boolean),hold_years(0.25 to 5). - Optional:
expected_sale_price(USD),haircut(0 to 1),volatility(decimal),expected_market_return(decimal),ticker. - Returns:
vest(taxes due at vest);bracketJump;hold;sellNowInvest;holdMinusSell(positive favors holding).
ConcentrationAnalyze
Quantifies single-stock concentration risk and compares the after-tax cost of three responses: sell down, hold, or hedge.
- Inputs (required):
position_value(USD),cost_basis(USD),acquisition_date(YYYY-MM-DD),sector(one oftech_software,semiconductors,consumer_cyclical,consumer_defensive,financials,healthcare_biotech,energy,industrials,communication,broad_market),state_code,filing_status,ordinary_income(USD),total_assets(USD). - Optional:
expected_position_returnandexpected_market_return(decimals), orticker;volatility(decimal),volatility_drag(0 to 0.99),hedge_choice({kind, protectionLevel, tenorYears, upsideCapPct}). - Returns:
concentration(0 to 1);riskBand;isLongTermToday,longTermDate,daysUntilLongTerm;lossExposure[];schedule[](after-tax sell-down plans);hedging(present whenhedge_choiceis given);sectorContextLineandadvisorBenchmarkLine.
ProtectivePutPrice
Prices a protective put and a zero-cost collar for a stock position at a chosen downside-protection level and tenor.
- Inputs (required):
position_value(USD),sector(same set as concentration),protection_level(0.05 to 0.5),tenor_years(at least 0.25). - Optional:
volatility(decimal),expected_return(decimal),ticker_label. - Returns:
inputs;riskFreeRateandrealWorldDrift;barePut(the put alone);collar(put financed by selling a call, withupsideCapandisZeroCost);payoffTable[];payoffRange;recommended(bare-put|collar|none).
QsbsCheck
Checks qualified small business stock (QSBS) Section 1202 eligibility and computes the resulting federal capital-gains exclusion.
- Inputs (required):
acquisition_dateandsale_date(YYYY-MM-DD),entity_type(us-c-corp|other),acquisition_method(original-issuance|gift-or-inheritance|secondary|unsure),asset_category(under-50m|50m-to-75m|over-75m|unsure),industry(see the tool docstring for the full enum),active_business(yes|no|unsure),adjusted_basis(USD),expected_gain(USD),state_code,ordinary_income(USD),filing_status. - Returns:
verdict;exclusionPercent(0 to 1);perIssuerCap,tenXBasisCap,applicableCap;excludableGainandtaxableGain;federalTaxSaved;stateConformsandstateNote;holdingYears;yearsUntilFullExclusion;era;tests[].
EquityFundingPlan
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):
target_after_tax(USD),target_date(YYYY-MM-DD),ordinary_income(USD),filing_status,state_code, plus the holdings as eitherstacks(preferred: a list of stacks, each withcurrentPriceand alotslist of{shares, costBasisPerShare, acquisitionDate, vestDate?}) or the legacylotsplus a singlecurrent_price. - Optional:
expected_annual_growth(decimal),cash_interest_rate(decimal),risk_tolerance_shortfall(0 to 1),default_volatility(decimal),today(YYYY-MM-DD). - Returns: four named plans
recommended,lockInNow,balanced,holdForGrowth, plusfrontier[], and the echoedtargetAfterTax,targetDateISO,appliedRiskTolerance. Each plan carrieswealthAtTarget,totalTax,shortfallProbability, and aplanwithfeasible,schedule(per-year sales),comparison, andremainingShares.
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 arcade-optionsahoy
Quickstart
The toolkit is a standard Arcade toolkit: load it into a ToolCatalog and serve it, or run it in your own MCP server. To inspect the registered tools:
from arcade_tdk import ToolCatalog
import arcade_optionsahoy
catalog = ToolCatalog()
catalog.add_module(arcade_optionsahoy)
print(len(catalog)) # 7
print([t.definition.name for t in catalog])
To run the tools through the Arcade engine, install the Arcade CLI and follow the Creating a Toolkit guide, which loads installed toolkit packages by name. You can also call any tool directly as a plain Python function:
from arcade_optionsahoy import qsbs_check
result = qsbs_check(
acquisition_date="2018-01-01",
sale_date="2026-02-01",
entity_type="us-c-corp",
acquisition_method="original-issuance",
asset_category="under-50m",
industry="tech-software",
active_business="yes",
adjusted_basis=10000,
expected_gain=2000000,
state_code="CA",
ordinary_income=250000,
filing_status="single",
)
print(result["result"]["verdict"])
The seven endpoints accept forward-looking fields (such as expected_sale_price or volatility) that the schema marks optional but the API requires at call time; set a covered ticker (for example "NVDA") to let the API derive them, or pass explicit values. Omitting both returns a clear 400 explaining which field is needed.
Runnable example and source
- Runnable example:
examples/ - Source:
integrations/python/arcade-optionsahoy
Related
Sibling packages wrapping the same calculators:
- optionsahoy - plain Python client (no framework)
- crewai-optionsahoy - CrewAI tools
- optionsahoy-langchain - LangChain tools
- llama-index-tools-optionsahoy - LlamaIndex 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
Release history Release notifications | RSS feed
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 arcade_optionsahoy-0.1.7.tar.gz.
File metadata
- Download URL: arcade_optionsahoy-0.1.7.tar.gz
- Upload date:
- Size: 11.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d0e9c861e59784036bdbd0eb761ceb52d004df40f94b48e51e744174bd31b03f
|
|
| MD5 |
0268a49a10be8e09a24a45958fd30dab
|
|
| BLAKE2b-256 |
0156c014223f7ed053ad4c5107878bd4263424609eb51ce4bd50031216b611cc
|
Provenance
The following attestation bundles were made for arcade_optionsahoy-0.1.7.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:
arcade_optionsahoy-0.1.7.tar.gz -
Subject digest:
d0e9c861e59784036bdbd0eb761ceb52d004df40f94b48e51e744174bd31b03f - Sigstore transparency entry: 1895305784
- Sigstore integration time:
-
Permalink:
AlvisoOculus/optionsahoy-mcp@f2622d37ec9840e085d36d0b54b3850c96f8a28c -
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@f2622d37ec9840e085d36d0b54b3850c96f8a28c -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file arcade_optionsahoy-0.1.7-py3-none-any.whl.
File metadata
- Download URL: arcade_optionsahoy-0.1.7-py3-none-any.whl
- Upload date:
- Size: 11.5 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 |
1e8d5a44233cc7e7b78d30c4d89b383189d273662f7a5b6630b5084729d7ccec
|
|
| MD5 |
ecbc546ff9b5c6c07156f9e39c8aa443
|
|
| BLAKE2b-256 |
c93842f51f61d5301cdb8dc1e3ec30fe29f16bac262d76bf49a15c03ed478cef
|
Provenance
The following attestation bundles were made for arcade_optionsahoy-0.1.7-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:
arcade_optionsahoy-0.1.7-py3-none-any.whl -
Subject digest:
1e8d5a44233cc7e7b78d30c4d89b383189d273662f7a5b6630b5084729d7ccec - Sigstore transparency entry: 1895305942
- Sigstore integration time:
-
Permalink:
AlvisoOculus/optionsahoy-mcp@f2622d37ec9840e085d36d0b54b3850c96f8a28c -
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@f2622d37ec9840e085d36d0b54b3850c96f8a28c -
Trigger Event:
workflow_dispatch
-
Statement type: