Wealthnow
Sign up

API ReferenceExecution & Research

Status

Scenarios

POST/api/v3/research/scenario_simulator
Plan
Pro and up
Price
4 credits per call
MCP tool
research_scenario_simulator

Deterministic DCF-style projection under bull, base and bear (or your own) scenarios. You supply the TTM financials and, per scenario, revenue_growth_pct, net_margin_pct and exit_pe_multiple; it projects over horizon_quarters (default 4) and returns projected_revenue, projected_eps, projected_price, implied_upside_pct and implied_cagr_pct per scenario, each with a math_trail of the steps. The summary gives a probability-weighted expected_value_price, a skew label and the bull/bear asymmetry_ratio. Pure arithmetic on your inputs: no model, no market data.

Request body

application/json, required.

tickerstringRequired

Ticker the projection is for.

currentobjectRequired

Trailing-twelve-month starting point you supply.

current.revenue_ttmnumberRequired

TTM revenue, USD.

current.eps_ttmnumber or nullOptional

TTM diluted EPS, USD per share.

current.shares_outstandingnumberRequired

Shares outstanding, count.

current.current_pricenumberRequired

Current share price, USD.

scenariosmap of objectRequired

Scenario name (e.g. bull, base, bear) -> assumptions.

scenarios.{key}.revenue_growth_pctnumberRequired

Annual revenue growth, percent (25 = 25%)

scenarios.{key}.net_margin_pctnumberRequired

Net margin at the horizon, percent.

scenarios.{key}.exit_pe_multiplenumberRequired

Price/earnings multiple at the horizon, x.

horizon_quartersinteger or nullOptional

Projection horizon, quarters.

Default4
Range1 to 40
scenario_probabilitiesmap of number or nullOptional

Optional scenario name -> probability (normalised to sum to 1); enables the probability-weighted summary.

Response

A 200 is a JSON envelope: ok: true and this endpoint's own fields (see Execution & Research). It carries X-Request-ID, the credit headers (X-Credits-Cost, X-Credits-Remaining, X-Credits-Receipt, X-Credits-Settlement) and the rate-limit headers.

A 200 is billed even when it holds no data (an empty list, null, found: false), so check those fields. Pricing & credits explains the credit headers.

Errors

No error is billed. The body is { "ok": false, "error", "detail", "request_id" }; read the code from error.

ErrorMeaning
400 invalid_tickerThe request is malformed, for example a ticker that is not a symbol: invalid_ticker, refused before any credit is reserved, with param naming the parameter. Not billed.
401 unauthorizedMissing or invalid API key.
402 plan_requiredYour plan does not include this tool, you are out of credits, or your workspace's spend cap paused its keys. plan_required names the plan that unlocks the tool; usage_exceeded means the credit balance is spent; spend_cap_reached means the key is paused until the cap resets or is raised: detail names the cap and the reset, cap_usd and resets_at (ISO 8601) carry them, and doc_url links pricing and credits. Not billed.
403 scope_deniedThis API key is limited to some products and this tool is not one of them. product names the tool's product and scopes the key's products. An upgrade does not change it: use a key whose scopes include the product, or change this key's scopes. Not billed.
404 not_foundNo such resource. Not billed.
422 validationA parameter is missing, out of range or the wrong type; param names it. Not billed.
429 rate_limitedYour plan's rate limit is spent for this window. Retry after Retry-After seconds. Not billed.
503 paid_data_unavailableThe data could not be served completely right now; retry later. Not billed.
504 request_timeoutThe request ran past the server's time budget; retry. Not billed.

This table lists what the spec declares for this route. Error responses lists every code FIRM sends, with when to retry.

Guides

Read the Execution & Research guide for this endpoint's fields and examples.