Skip to content
Navigation

Compute a financial model with filing-prefilled assumptions

GET
https://api.sureshake.com/v2/entities/{id}/models/{templateKey}

Path parameters

  • id
    string
    required
    format: uuid
  • templateKey
    string
    required
    maxLength: 64 · minLength: 1

Returns

200

Default Response

JSON
  • data
    object
    required
    • entityId
      string
      required
      format: uuid
    • entityName
      string
      required
    • templateKey
      string
      required
    • templateLabel
      string
      required
    • kind
      dcf
      or
      historicals
      or
      multiples
      or
      wacc
      or
      epv
      required
    • state
      computed
      or
      insufficient_data
      required
    • missingMetricKeys
      array of
      string
      required
    • basePeriodEnd
      string
      or null
      required
    • currency
      string
      required
    • assumptions
      array of
      object
      required
      • key
        string
        required
      • label
        string
        required
      • value
        number
        required
      • unit
        percent
        or
        multiple
        or
        currency
        or
        count
        or
        years
        required
      • source
        prefilled_from_filings
        or
        default
        or
        user
        required
      • editable
        boolean
        required
      • provenance
        object
        or null
        required
        • concept
          string
          required
        • form
          string
          required
        • accessionNumber
          string
          required
        • filedDate
          string
          required
        • periodEnd
          string
          required
    • projections
      array of
      object
      required
      • year
        integer
        required
      • label
        string
        required
      • revenue
        number
        or null
        required
      • ebitda
        number
        or null
        required
      • freeCashFlow
        number
        or null
        required
      • presentValue
        number
        or null
        required
    • historicals
      array of
      object
      required
      • fiscalYear
        integer
        or null
        required
      • periodEnd
        string
        required
      • revenue
        number
        or null
        required
      • revenueGrowth
        number
        or null
        required
      • operatingIncome
        number
        or null
        required
      • operatingMargin
        number
        or null
        required
      • netIncome
        number
        or null
        required
      • netMargin
        number
        or null
        required
      • operatingCashFlow
        number
        or null
        required
      • capitalExpenditures
        number
        or null
        required
      • freeCashFlow
        number
        or null
        required
      • dilutedEps
        number
        or null
        required
      • sharesOutstanding
        number
        or null
        required
    • valuation
      object
      or null
      required
      • enterpriseValue
        number
        required
      • presentValueOfCashFlows
        number
        required
      • presentValueOfTerminal
        number
        required
      • terminalValue
        number
        required
      • netDebt
        number
        required
      • equityValue
        number
        required
      • sharesOutstanding
        number
        or null
        required
      • fairValuePerShare
        number
        or null
        required
      • currency
        string
        required
    • rateResult
      object
      or null
      required
      • wacc
        number
        required
      • costOfEquity
        number
        required
      • costOfDebtAfterTax
        number
        required
      • weightEquity
        number
        required
      • weightDebt
        number
        required
    • dcfDetail
      object
      or null
      required
      • valuationDate
        string
        required
      • baseYear
        object
        required
        • year
          integer
          required
        • label
          string
          required
        • periodEnd
          string
          required
        • revenue
          number
          required
        • revenueGrowth
          number
          or null
          required
        • ebitda
          number
          or null
          required
        • ebitdaMargin
          number
          or null
          required
        • nopat
          number
          or null
          required
        • freeCashFlow
          number
          or null
          required
        • netWorkingCapital
          number
          or null
          required
      • drivers
        array of
        object
        required
        • key
          revenue_growth
          or
          ebitda_margin
          or
          other_income
          or
          capex_pct_revenue
          or
          nwc_pct_revenue
          or
          da_pct_revenue
          +1 more
          required
        • label
          string
          required
        • unit
          percent
          or
          multiple
          or
          currency
          or
          count
          or
          years
          required
        • editable
          boolean
          required
        • values
          array of
          object
          required
          • year
            integer
            required
          • label
            string
            required
          • value
            number
            required
          • source
            prefilled_from_filings
            or
            default
            or
            user
            required
      • scenarios
        object
        required
        • discountRate
          object
          required
          • low
            number
            required
          • mid
            number
            required
          • high
            number
            required
        • exitMultiple
          object
          or null
          required
          • low
            number
            required
          • mid
            number
            required
          • high
            number
            required
        • terminalGrowth
          object
          or null
          required
          • low
            number
            required
          • mid
            number
            required
          • high
            number
            required
      • projections
        array of
        object
        required
        • year
          integer
          required
        • label
          string
          required
        • revenue
          number
          required
        • revenueGrowth
          number
          or null
          required
        • ebitda
          number
          required
        • ebitdaMargin
          number
          required
        • otherIncome
          number
          required
        • depreciationAndAmortization
          number
          required
        • ebit
          number
          required
        • proFormaTaxes
          number
          required
        • nopat
          number
          required
        • capitalExpenditures
          number
          required
        • netWorkingCapital
          number
          required
        • nwcInvestment
          number
          required
        • freeCashFlow
          number
          required
        • fcfGrowth
          number
          or null
          required
      • discounting
        object
        required
        • valuationDate
          string
          required
        • rows
          array of
          object
          required
          • year
            integer
            required
          • label
            string
            required
          • periodStart
            string
            required
          • periodEnd
            string
            required
          • midPeriodDate
            string
            required
          • discountPeriod
            number
            required
        • terminalDiscountPeriod
          number
          required
      • discountFactors
        array of
        object
        required
        • year
          integer
          or null
          required
        • label
          string
          required
        • discountPeriod
          number
          required
        • factor
          object
          required
          • low
            number
            required
          • mid
            number
            required
          • high
            number
            required
      • enterpriseValue
        object
        required
        • rows
          array of
          object
          required
          • year
            integer
            required
          • label
            string
            required
          • freeCashFlow
            number
            required
          • presentValue
            object
            required
            • low
              number
              required
            • mid
              number
              required
            • high
              number
              required
        • presentValueOfDiscreteCashFlows
          object
          required
          • low
            number
            required
          • mid
            number
            required
          • high
            number
            required
        • terminalBasis
          revenue
          or
          ebitda
          or
          perpetuity
          required
        • terminalMetricLabel
          string
          required
        • terminalMetric
          number
          required
        • terminalMultiple
          object
          or null
          required
          • low
            number
            required
          • mid
            number
            required
          • high
            number
            required
        • terminalGrowth
          object
          or null
          required
          • low
            number
            required
          • mid
            number
            required
          • high
            number
            required
        • terminalValue
          object
          required
          • low
            number
            required
          • mid
            number
            required
          • high
            number
            required
        • terminalDiscountFactor
          object
          required
          • low
            number
            required
          • mid
            number
            required
          • high
            number
            required
        • presentValueOfTerminalValue
          object
          required
          • low
            number
            required
          • mid
            number
            required
          • high
            number
            required
        • enterpriseValue
          object
          required
          • low
            number
            required
          • mid
            number
            required
          • high
            number
            required
      • equityWaterfall
        object
        required
        • enterpriseValue
          object
          required
          • low
            number
            required
          • mid
            number
            required
          • high
            number
            required
        • cashAndEquivalents
          number
          required
        • totalDebt
          number
          required
        • netDebt
          number
          required
        • equityValue
          object
          required
          • low
            number
            required
          • mid
            number
            required
          • high
            number
            required
        • sharesOutstanding
          number
          or null
          required
        • fairValuePerShare
          object
          or null
          required
          • low
            number
            required
          • mid
            number
            required
          • high
            number
            required
      • summary
        object
        required
        • currency
          string
          required
        • stockPrice
          number
          or null
          required
        • fairValue
          object
          or null
          required
          • low
            number
            required
          • mid
            number
            required
          • high
            number
            required
        • upside
          object
          or null
          required
          • low
            number
            required
          • mid
            number
            required
          • high
            number
            required
        • revenueCagr
          number
          or null
          required
        • averageEbitdaMargin
          number
          or null
          required
        • unleveredFcfCagr
          number
          or null
          required
      • history
        object
        required
        • capitalExpenditures
          object
          or null
          required
          • driverKey
            revenue_growth
            or
            ebitda_margin
            or
            other_income
            or
            capex_pct_revenue
            or
            nwc_pct_revenue
            or
            da_pct_revenue
            +1 more
            required
          • rows
            array of
            object
            required
            • label
              string
              required
            • periodEnd
              string
              required
            • fiscalYear
              integer
              or null
              required
            • ytd
              boolean
              required
            • value
              number
              or null
              required
            • pctOfRevenue
              number
              or null
              required
          • average
            number
            or null
            required
        • depreciationAndAmortization
          object
          or null
          required
          • driverKey
            revenue_growth
            or
            ebitda_margin
            or
            other_income
            or
            capex_pct_revenue
            or
            nwc_pct_revenue
            or
            da_pct_revenue
            +1 more
            required
          • rows
            array of
            object
            required
            • label
              string
              required
            • periodEnd
              string
              required
            • fiscalYear
              integer
              or null
              required
            • ytd
              boolean
              required
            • value
              number
              or null
              required
            • pctOfRevenue
              number
              or null
              required
          • average
            number
            or null
            required
        • taxRate
          object
          or null
          required
          • driverKey
            revenue_growth
            or
            ebitda_margin
            or
            other_income
            or
            capex_pct_revenue
            or
            nwc_pct_revenue
            or
            da_pct_revenue
            +1 more
            required
          • rows
            array of
            object
            required
            • label
              string
              required
            • periodEnd
              string
              required
            • fiscalYear
              integer
              or null
              required
            • ytd
              boolean
              required
            • value
              number
              or null
              required
            • pctOfRevenue
              number
              or null
              required
          • average
            number
            or null
            required
        • netWorkingCapital
          object
          or null
          required
          • quarters
            array of
            object
            required
            • label
              string
              required
            • periodEnd
              string
              required
            • totalCurrentAssets
              number
              or null
              required
            • cashAndShortTermInvestments
              number
              or null
              required
            • totalCurrentLiabilities
              number
              or null
              required
            • currentPortionOfDebt
              number
              or null
              required
            • netWorkingCapital
              number
              or null
              required
            • ltmRevenue
              number
              or null
              required
            • pctOfLtmRevenue
              number
              or null
              required
          • lastFourQuarterAveragePct
            number
            or null
            required
    • generatedAt
      string
      required
      format: date-time
    • disclaimer
      string
      required
  • meta
    optional
    object
    • timestamp
      string
      required
      format: date-time

400

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

404

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

500

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

503

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

Type to search…

↑↓ navigate↵ selectEsc close