Skip to content
StockMarketAgent
§ Developers · v1 stable

One REST API for every analysis we publish.

Programmatic access to the full StockMarketAgent corpus — recommendations, fair-value bands, scenarios, sensitivity matrices, kill-scenario risk registers. Same data the website renders, structured for your pipeline. JSON in, JSON out.

§ 01

Quick start

Three steps. Two minutes. No SDK required.

Create a free or paid API key

Registered users can mint Free keys from /preferences → API. Growth and Enterprise keys add higher quotas and expanded report, valuation, and scoring scopes.

Authenticate

Send your key in the X-API-Key header. API-key responses carry X-RateLimit-Remaining and X-RateLimit-Reset.

Make your first request

Pull the latest MSFT analysis pack — same content the public analysis pipeline consumes, grouped into metadata, computed valuation outputs, sensitivity grids, scoring, and peer data.

# 1. Get an API key from /preferences → API
export SMA_KEY="sa_4f8a...redacted"

# 2. Pull the latest MSFT analysis pack
curl https://api.stockmarketagent.ai/api/v1/stocks/MSFT/analysis-pack \
  -H "X-API-Key: $SMA_KEY"
§ 02

Endpoints

Pulled live from the backend OpenAPI spec — stays in sync with the production surface automatically.
MethodPathDescriptionTier
GET/v1/stocks/{ticker}/analysis-packLatest report headline — rating, fair-value range, confidence score.Free
GET/v1/stocks/screenFilter the covered universe by valuation, quality, upside, and rating.Growth
GET/v1/stocks/{ticker}/valuationSix valuation models plus the 5×5 sensitivity grid for one ticker.Growth
POST/v1/stocks/{ticker}/reports/generateTrigger on-demand report generation. Returns a report id you can stream.Growth
STREAM/v1/stocks/{ticker}/reports/{id}/streamServer-Sent Events — pushes per-phase progress while a report builds.Growth
GET/v1/r/{slug}Public shared report payload. No auth required.Free
GET/v1/valuation-calculatorsCatalog of stateless valuation calculators (ids, archetypes, methodology variants, sensitivity axes).Free
POST/v1/valuation-calculators/runRun one calculator against caller-supplied assumptions. Stateless — no DB writes.Free
POST/v1/valuation-calculators/suiteRun every applicable calculator against one payload. Returns one per-model envelope for each registered calculator.Free
POST/v1/valuation-calculators/sensitivityGenerate a 2-axis sensitivity matrix (default 5×5, up to 9×9) by re-running the calculator across axis offsets.Free
GET/v1/stocks/{ticker}/valuation-calculators/defaultsEnterprise/admin calibrated ticker defaults, optionally filtered by model and methodology_variant, ready to feed into /run or /suite.Enterprise
GET/v1/financial-calculatorsList standalone financial planning calculators and their public endpoints.Free
GET/v1/financial-calculators/lump-sum-investmentLump sum investment calculator schema, outputs, and endpoint map.Free
POST/v1/financial-calculators/lump-sum-investment/calculateRun the standalone lump sum investment calculator with compounding, inflation, fee, tax, and scenario assumptions.Free
POST/v1/financial-calculators/lump-sum-investment/runAlias for the lump sum investment calculator run endpoint.Free
POST/v1/financial-calculators/lump-sum-investment/sensitivityRecompute a 2-axis sensitivity grid for expected return, years, or initial investment.Free
GET/v1/financial-calculators/lump-sum-investment/schemaLump sum investment calculator input and output schema for API and agent clients.Free
GET/v1/financial-calculators/lump-sum-investment/defaultsLump sum investment default inputs with USD default principal and annual return assumptions.Free
GET/v1/stocks/{ticker}/financial-calculators/lump-sum-investment/defaultsEnterprise/admin ticker-prefill defaults for the lump sum investment calculator with visible source audit.Enterprise
POST/v1/financial-calculators/sip/calculateRun the standalone SIP calculator with contribution frequency, timing, rate convention, step-up, fee, tax, and inflation assumptions.Free
POST/v1/financial-calculators/sip/sensitivityRecompute a SIP sensitivity grid for expected return, years, or contribution amount.Free
POST/v1/financial-calculators/sip/solve-contributionSolve the recurring contribution required to reach a target future value under the same SIP assumptions.Free
GET/v1/financial-calculators/sip/schemaSIP calculator input and output schema for API and agent clients.Free
GET/v1/financial-calculators/sip/defaultsSIP calculator default inputs with USD contribution, monthly frequency, and explicit timing convention.Free
GET/v1/stocks/{ticker}/financial-calculators/sip/defaultsEnterprise/admin ticker-prefill defaults for the SIP calculator with visible source audit.Enterprise
POST/v1/stocks/{ticker}/financial-calculators/sip/backtestProfessional/admin historical SIP ticker backtest using available internal price history.Enterprise
POST/v1/financial-calculators/goal-based-sip/calculateRun the standalone goal-based SIP calculator to solve the required recurring contribution for a target corpus.Free
POST/v1/financial-calculators/goal-based-sip/runAlias for the goal-based SIP calculator run endpoint.Free
POST/v1/financial-calculators/goal-based-sip/sensitivityRecompute a 2-axis sensitivity grid for goal-based SIP required contributions.Free
POST/v1/financial-calculators/goal-based-sip/solve-tenureSolve the number of years needed for a fixed recurring contribution to reach the target corpus.Free
GET/v1/financial-calculators/goal-based-sip/schemaGoal-based SIP input and output schema for API and agent clients.Free
GET/v1/financial-calculators/goal-based-sip/defaultsGoal-based SIP default target, currency, return, inflation, and contribution assumptions.Free
GET/v1/stocks/{ticker}/financial-calculators/goal-based-sip/defaultsEnterprise/admin ticker-prefill defaults for the goal-based SIP calculator with visible source audit.Enterprise
POST/v1/stocks/{ticker}/financial-calculators/goal-based-sip/backtestProfessional/admin historical goal-feasibility backtest using available internal price history.Enterprise
GET/v1/financial-calculators/sip-time-to-goalSIP time-to-goal calculator schema, outputs, and endpoint map.Free
POST/v1/financial-calculators/sip-time-to-goal/calculateRun the standalone SIP time-to-goal calculator to solve periods, months, and years for a recurring investment target.Free
POST/v1/financial-calculators/sip-time-to-goal/runAlias for the SIP time-to-goal calculator run endpoint.Free
POST/v1/financial-calculators/sip-time-to-goal/sensitivityRecompute a 2-axis sensitivity grid for SIP time-to-goal assumptions.Free
GET/v1/financial-calculators/sip-time-to-goal/schemaSIP time-to-goal input and output schema for API and agent clients.Free
GET/v1/financial-calculators/sip-time-to-goal/defaultsSIP time-to-goal default target, contribution, currency, return, and timing assumptions.Free
GET/v1/stocks/{ticker}/financial-calculators/sip-time-to-goal/defaultsEnterprise/admin ticker-prefill defaults for the SIP time-to-goal calculator with visible source audit.Enterprise
POST/v1/stocks/{ticker}/financial-calculators/sip-time-to-goal/backtestProfessional/admin historical periodic target-hit backtest using available internal price history.Enterprise
POST/v1/financial-calculators/investment-time-to-goal/calculateRun the standalone investment time-to-goal calculator to solve years and months needed for a one-time investment target.Free
POST/v1/financial-calculators/investment-time-to-goal/runAlias for the investment time-to-goal calculator run endpoint.Free
POST/v1/financial-calculators/investment-time-to-goal/sensitivityRecompute a 2-axis sensitivity grid for investment time-to-goal assumptions.Free
GET/v1/financial-calculators/investment-time-to-goal/schemaInvestment time-to-goal input and output schema for API and agent clients.Free
GET/v1/financial-calculators/investment-time-to-goal/defaultsInvestment time-to-goal default target, initial investment, return, inflation, and tax assumptions.Free
GET/v1/stocks/{ticker}/financial-calculators/investment-time-to-goal/defaultsEnterprise/admin ticker-prefill defaults for the investment time-to-goal calculator with visible source audit.Enterprise
POST/v1/stocks/{ticker}/financial-calculators/investment-time-to-goal/backtestProfessional/admin historical target-hit backtest for a one-time investment using available internal price history.Enterprise
GET/v1/financial-calculators/asset-allocationAsset allocation calculator schema, outputs, and endpoint map.Free
POST/v1/financial-calculators/asset-allocation/calculateRun the standalone asset allocation calculator with salary, savings-rate, age, risk-profile, emergency fund, and allocation assumptions.Free
POST/v1/financial-calculators/asset-allocation/runAlias for the asset allocation calculator run endpoint.Free
GET/v1/financial-calculators/asset-allocation/schemaAsset allocation calculator input and output schema for API and agent clients.Free
GET/v1/financial-calculators/asset-allocation/defaultsAsset allocation default inputs with USD default salary, 25 percent target investment rate, and 100-minus-age allocation rule.Free
GET/v1/financial-calculators/asset-allocation/model-portfoliosPremium/admin model portfolio templates with editable allocation and expected-return assumptions.Enterprise
GET/v1/financial-calculators/education-savingsEducation savings calculator schema, outputs, and endpoint map.Free
POST/v1/financial-calculators/education-savings/calculateRun the standalone education savings calculator with child age, education inflation, returns, current savings, aid, and program duration.Free
POST/v1/financial-calculators/education-savings/runAlias for the education savings calculator run endpoint.Free
GET/v1/financial-calculators/education-savings/schemaEducation savings calculator input and output schema for API and agent clients.Free
GET/v1/financial-calculators/education-savings/defaultsEducation savings default inputs with USD currency, visible education inflation, and monthly timing assumptions.Free
GET/v1/financial-calculators/education-savings/education-cost-presetsPublic region/type education-cost presets for guided planning. Presets are editable assumptions.Free
GET/v1/financial-calculators/education-savings/model-portfoliosPremium/admin model portfolio templates with editable return and fee assumptions for education goals.Enterprise
GET/v1/financial-calculators/education-savings/ticker-defaultsPremium/admin historical ticker or index return prefill with source audit for education savings assumptions.Enterprise
GET/v1/financial-calculators/fd-vs-equityFD vs stock market returns calculator schema, outputs, and endpoint map.Free
POST/v1/financial-calculators/fd-vs-equity/calculateRun the standalone FD/RD vs equity/SIP calculator with compounding, tax, inflation, scenario, and break-even assumptions.Free
POST/v1/financial-calculators/fd-vs-equity/runAlias for the FD/RD vs equity/SIP calculator run endpoint.Free
GET/v1/financial-calculators/fd-vs-equity/schemaFD/RD vs equity/SIP input and output schema for API and agent clients.Free
GET/v1/financial-calculators/fd-vs-equity/defaultsFD/RD vs equity/SIP default inputs with USD amount, FD rate, equity return, compounding, tax, and inflation assumptions.Free
GET/v1/financial-calculators/fd-vs-equity/equity-defaultsPremium/admin historical equity ticker or index prefill with CAGR, volatility, drawdown, scenarios, and source audit.Enterprise
GET/v1/user/financial-calculator-workbooksList the signed-in user's saved financial calculator workbooks.Growth
POST/v1/user/financial-calculator-workbooksSave a private financial calculator workbook for reuse.Growth
GET/v1/financial-calculators/fixed-depositFixed deposit calculator schema, outputs, and endpoint map.Free
POST/v1/financial-calculators/fixed-deposit/calculateRun the standalone fixed deposit calculator with compounding, payout mode, tax, withholding, scenario, and schedule assumptions.Free
POST/v1/financial-calculators/fixed-deposit/runAlias for the public fixed deposit calculator run endpoint.Free
GET/v1/financial-calculators/fixed-deposit/schemaFixed deposit calculator input and output schema for API and agent clients.Free
GET/v1/financial-calculators/fixed-deposit/defaultsFixed deposit default inputs with USD currency, 10-thousand principal, quarterly compounding, and cumulative maturity assumptions.Free
GET/v1/financial-calculators/compound-interestCompound interest calculator schema, outputs, and endpoint map.Free
GET/v1/financial-calculators/cagrCAGR calculator schema, outputs, and endpoint map.Free
POST/v1/financial-calculators/cagr/calculateRun the standalone CAGR calculator with beginning value, ending value, period, unit scaling, scenarios, and period sensitivity.Free
POST/v1/financial-calculators/cagr/runAlias for the public CAGR calculator run endpoint.Free
GET/v1/financial-calculators/cagr/schemaCAGR calculator input and output schema for API and agent clients.Free
GET/v1/financial-calculators/cagr/defaultsCAGR default inputs with 100 to 200 over 10 years as the baseline example.Free
GET/v1/financial-calculators/gstGST calculator schema, outputs, endpoint map, official-source links, and rate presets.Free
POST/v1/financial-calculators/gst/calculateRun the standalone GST calculator with exclusive or inclusive amount, GST rate, supply split, amount unit, and display-rounding assumptions.Free
POST/v1/financial-calculators/gst/runAlias for the public GST calculator run endpoint.Free
GET/v1/financial-calculators/gst/schemaGST calculator input and output schema for API and agent clients.Free
GET/v1/financial-calculators/gst/defaultsGST default inputs with INR currency, 18% rate, intrastate split, and editable rate presets.Free
POST/v1/financial-calculators/compound-interest/calculateRun the standalone compound interest calculator with lump sum, recurring contribution, compounding, fee, inflation, tax, scenario, and schedule assumptions.Free
POST/v1/financial-calculators/compound-interest/runAlias for the public compound interest calculator run endpoint.Free
GET/v1/financial-calculators/compound-interest/schemaCompound interest calculator input and output schema for API and agent clients.Free
GET/v1/financial-calculators/compound-interest/defaultsCompound interest default inputs with USD principal, monthly compounding, and monthly recurring contribution assumptions.Free
GET/v1/financial-calculators/recurring-depositRecurring deposit calculator schema, outputs, and endpoint map.Free
POST/v1/financial-calculators/recurring-deposit/calculateRun the standalone recurring deposit calculator with monthly contribution, compounding, deposit timing, tax, withholding, scenario, and schedule assumptions.Free
POST/v1/financial-calculators/recurring-deposit/runAlias for the public recurring deposit calculator run endpoint.Free
GET/v1/financial-calculators/recurring-deposit/schemaRecurring deposit calculator input and output schema for API and agent clients.Free
GET/v1/financial-calculators/recurring-deposit/defaultsRecurring deposit default inputs with USD monthly amount, quarterly compounding, and beginning-of-month contribution assumptions.Free
POST/v1/financial-calculators/ppf/calculateRun the standalone Public Provident Fund calculator with manual deposits, tenure, rate, and fifth-day timing assumptions.Free
POST/v1/financial-calculators/ppf/runAlias for the public PPF calculator run endpoint.Free
GET/v1/financial-calculators/ppf/schemaPPF calculator input and output schema for API and agent clients.Free
GET/v1/financial-calculators/ppf/defaultsPPF calculator default inputs, including current editable rate assumption and amount unit.Free
POST/v1/financial-calculators/education-loan-emi/calculateRun the standalone education-loan EMI calculator with loan amount, rate, tenure, course duration, and moratorium assumptions.Free
POST/v1/financial-calculators/education-loan-emi/runAlias for the public education-loan EMI calculator run endpoint.Free
GET/v1/financial-calculators/education-loan-emi/schemaEducation loan EMI calculator input and output schema for API and agent clients.Free
GET/v1/financial-calculators/education-loan-emi/defaultsEducation loan EMI default inputs with USD default principal and moratorium assumptions.Free
POST/v1/financial-calculators/step-up-sip/calculateRun the standalone step-up SIP calculator with annual contribution increase, comparison, goal solve, fees, tax, and inflation assumptions.Free
POST/v1/financial-calculators/step-up-sip/runAlias for the Step-Up SIP calculation endpoint for API clients that use a run verb across calculators.Free
GET/v1/financial-calculators/step-up-sip/schemaStep-up SIP calculator input and output schema for API and agent clients.Free
GET/v1/financial-calculators/step-up-sip/defaultsStep-up SIP default inputs using the canonical 15,000 monthly contribution, 15% step-up, 12% return, and 10-year reference assumption set.Free
GET/v1/financial-calculators/step-up-sip/model-defaultsEditable Step-Up SIP model assumptions by region, currency, and profile.Enterprise
GET/v1/financial-calculators/step-up-sip/return-defaultsPremium/admin historical ticker return assumptions with source audit for the Step-Up SIP calculator.Enterprise

Pagination is cursor-based via ?cursor=…. List responses include nextCursor when more is available. If-None-Match + ETag are honored on every report endpoint — refresh polling is essentially free. The full surface lives in the OpenAPI reference.

§ 03

Response schema

Stable, versioned, and shaped for analysis pipelines — not for rendering.

The analysis-pack endpoint returns one top-level JSON document with meta, computed model output, sensitivity data, scoring, and peer context. Collection endpoints use Laravel's data envelopes. Numeric fields use unsuffixed base units — USD for prices, decimals (0–1) for probabilities, integers for confidence scores.

What's in an analysis pack

The headline action plus a 0–100 confidence score, the low/mid/high fair-value range, and bull/base/bear scenarios with probabilities that sum to 1.0 when those models are available. For the full report envelope and all 14 reader sections, use /stocks/{ticker}/reports/latest?include=sections.

What's not

We don't bill the public website HTML as API content, and the analysis pack is not a rendered report. Use the report endpoint when you need the canonical prose sections and report metadata.

{
  "meta": {
    "ticker": "MSFT",
    "name": "Microsoft Corporation",
    "sector": "Technology",
    "generated_at": "2026-04-25T12:00:00Z"
  },
  "archetype": {
    "archetype": "mature_compounder",
    "archetype_label": "Mature compounder"
  },
  "score": {
    "rating_band": "Strong Buy",
    "confidence_score": 87,
    "six_factor_score": 82
  },
  "valuation_results": {
    "synthesis": {
      "fair_value_low": 480,
      "fair_value_mid": 545,
      "fair_value_high": 612,
      "currency": "USD"
    }
  },
  "sensitivity_results": {
    "ke_vs_terminal_growth": "5x5 matrix omitted for brevity"
  }
}
§ 04

Rate limits & pricing

Per-key, per-month. Burst capacity ≈ 2× sustained.
Tier
Free · $0/mo
Tier
Growth · $99/mo
Tier
Enterprise · Custom
Requests / month
100
Universe + analysis-pack only
Requests / month
1,000
All GET endpoints + valuation
Requests / month
Unlimited
Contractual SLA, dedicated capacity
Streaming
Polling only
Streaming
5 conn
SSE + webhooks
Streaming
100 conn
SSE + webhooks + redrive

API-key responses include X-RateLimit-Remaining and X-RateLimit-Reset headers. Exceeding the monthly key quota returns 429 with a Retry-After hint and an upgrade_url in the body — never the connection drop.

§ 05

Errors

Stable code field — branch on that, not the message.
{
  "error": {
    "code": "ticker_not_covered",
    "message": "ROOT is not in our coverage universe.",
    "docs": "https://stockmarketagent.ai/developers#errors",
    "request_id": "req_01JBN7T1Z9XKQ"
  }
}

Ready to integrate?

Start with the free tier — 100 requests/month, no card required. Upgrade in-product when production volume justifies it.

Create free accountOpenAPI reference