Financial Model Endpoints

Prebuilt financial models for public companies: six DCF variants (terminal growth, EBITDA exit, and revenue exit — each over 5 or 10 years), annual historical-financials tables, six multiples valuations (EV/EBIT, EV/EBITDA, P/E, Price/Sales, Price/Book, EV/Revenue), a WACC calculator, and Greenwald earnings power value. Models are deterministic calculators over SEC-derived canonical periods — no AI, no market data. Default assumptions are prefilled from filings and carry per-input provenance; every default is explicit and most are overridable.

All three endpoints are public reads with no authentication. The examples use Bentley Systems (entityId from the ticker resolver or the public profile).

List Model Templates

curl "https://api.sureshake.com/v2/entities/5210b6a3-5677-4bd9-8f8d-6e9dab011a28/models"

const response = await fetch(
'https://api.sureshake.com/v2/entities/5210b6a3-5677-4bd9-8f8d-6e9dab011a28/models',
);
const { data } = await response.json();

Each template reports its state (available | partial | unavailable) plus requiredMetricKeys, missingMetricKeys, and prefilledMetricKeys, so clients can tell exactly which filing facts back a model before computing it.

Compute a Model (filing defaults)

curl "https://api.sureshake.com/v2/entities/5210b6a3-5677-4bd9-8f8d-6e9dab011a28/models/dcf_5_year_terminal_growth"

const response = await fetch(
'https://api.sureshake.com/v2/entities/5210b6a3-5677-4bd9-8f8d-6e9dab011a28/models/dcf_5_year_terminal_growth',
);
const { data } = await response.json();

Response fields (data)

The dcfDetail block (DCF templates)

Every DCF template also returns a fully worked model:

Recompute with Overridden Assumptions

curl -X POST -H "content-type: application/json" \
-d '{"assumptions":{"discount_rate":0.12,"initial_growth":0.10}}' \
"https://api.sureshake.com/v2/entities/5210b6a3-5677-4bd9-8f8d-6e9dab011a28/models/dcf_5_year_terminal_growth/compute"

const response = await fetch(
'https://api.sureshake.com/v2/entities/5210b6a3-5677-4bd9-8f8d-6e9dab011a28/models/dcf_5_year_terminal_growth/compute',
{
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({ assumptions: { discount_rate: 0.12 } }),
},
);
const { data } = await response.json();

Overrides are keyed by assumption key and expressed as decimals (0.12 = 12%). Unknown keys, non-numeric values, and overrides of filing-backed (editable: false) assumptions return 400. Economically invalid combinations (e.g. a discount rate at or below terminal growth for a perpetuity model) also return 400 with an explanatory message.

Per-year driver overrides (DCF templates)

DCF templates additionally accept a drivers object keyed by driver, then by four-digit projection year:

{
  "assumptions": { "discount_rate": 0.09 },
  "drivers": {
    "revenue_growth": { "2027": 0.071, "2028": 0.053 },
    "ebitda_margin": { "2027": 0.222 }
  }
}

Unspecified years keep their seeded defaults; overridden cells come back with source: "user" in dcfDetail.drivers. Years outside the projection horizon, unknown driver keys, and driver overrides on non-DCF templates return 400.

Overriding a mid assumption (discount_rate, exit_multiple, terminal_growth) automatically re-derives its low/high band edges unless you pin them explicitly (discount_rate_low, exit_multiple_high, …).

Saved Scenarios

Authenticated users can save named override sets per company model and share them read-only.

Scenarios are private to their owner. The share token resolves to the overrides and scenario name only — never the owner's identity.

Export a Model

curl -X POST -H "content-type: application/json" \
-d '{"format":"xlsx","assumptions":{"discount_rate":0.09}}' \
-OJ "https://api.sureshake.com/v2/entities/5210b6a3-5677-4bd9-8f8d-6e9dab011a28/models/revenue_exit/export"

const response = await fetch(
'https://api.sureshake.com/v2/entities/5210b6a3-5677-4bd9-8f8d-6e9dab011a28/models/revenue_exit/export',
{
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({ format: 'csv' }),
},
);
const blob = await response.blob();

Accepts the same body as compute plus format: "csv" | "xlsx", and returns the file directly with a Content-Disposition attachment header. The export reflects whatever overrides you send and always embeds the disclaimer.

{
"error": {
  "code": "BAD_REQUEST",
  "message": "Assumption \"base_revenue\" is filing-backed and not overridable.",
  "traceId": "hFz2kQnU8dJcQ0v9tXw1p"
}
}

Related pages

• Interactive DCF models guide — how the company-page model UI uses these endpoints: per-year editing, scenarios, sharing, exports, and the AI assistant
• Company Data Endpoints — public profile, ticker resolver, and the company terminal