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.
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.
Endpoints
Pulled live from the backend OpenAPI spec — stays in sync with the production surface automatically.| Method | Path | Description | Tier |
|---|---|---|---|
| GET | /v1/stocks/{ticker}/analysis-pack | Latest report headline — rating, fair-value range, confidence score. | Free |
| GET | /v1/stocks/screen | Filter the covered universe by valuation, quality, upside, and rating. | Growth |
| GET | /v1/stocks/{ticker}/valuation | Six valuation models plus the 5×5 sensitivity grid for one ticker. | Growth |
| POST | /v1/stocks/{ticker}/reports/generate | Trigger on-demand report generation. Returns a report id you can stream. | Growth |
| STREAM | /v1/stocks/{ticker}/reports/{id}/stream | Server-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-calculators | Catalog of stateless valuation calculators (ids, archetypes, methodology variants, sensitivity axes). | Free |
| POST | /v1/valuation-calculators/run | Run one calculator against caller-supplied assumptions. Stateless — no DB writes. | Free |
| POST | /v1/valuation-calculators/suite | Run every applicable calculator against one payload. Returns one per-model envelope for each registered calculator. | Free |
| POST | /v1/valuation-calculators/sensitivity | Generate 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/defaults | Enterprise/admin calibrated ticker defaults, optionally filtered by model and methodology_variant, ready to feed into /run or /suite. | Enterprise |
| GET | /v1/financial-calculators | List standalone financial planning calculators and their public endpoints. | Free |
| GET | /v1/financial-calculators/lump-sum-investment | Lump sum investment calculator schema, outputs, and endpoint map. | Free |
| POST | /v1/financial-calculators/lump-sum-investment/calculate | Run the standalone lump sum investment calculator with compounding, inflation, fee, tax, and scenario assumptions. | Free |
| POST | /v1/financial-calculators/lump-sum-investment/run | Alias for the lump sum investment calculator run endpoint. | Free |
| POST | /v1/financial-calculators/lump-sum-investment/sensitivity | Recompute a 2-axis sensitivity grid for expected return, years, or initial investment. | Free |
| GET | /v1/financial-calculators/lump-sum-investment/schema | Lump sum investment calculator input and output schema for API and agent clients. | Free |
| GET | /v1/financial-calculators/lump-sum-investment/defaults | Lump sum investment default inputs with USD default principal and annual return assumptions. | Free |
| GET | /v1/stocks/{ticker}/financial-calculators/lump-sum-investment/defaults | Enterprise/admin ticker-prefill defaults for the lump sum investment calculator with visible source audit. | Enterprise |
| POST | /v1/financial-calculators/sip/calculate | Run the standalone SIP calculator with contribution frequency, timing, rate convention, step-up, fee, tax, and inflation assumptions. | Free |
| POST | /v1/financial-calculators/sip/sensitivity | Recompute a SIP sensitivity grid for expected return, years, or contribution amount. | Free |
| POST | /v1/financial-calculators/sip/solve-contribution | Solve the recurring contribution required to reach a target future value under the same SIP assumptions. | Free |
| GET | /v1/financial-calculators/sip/schema | SIP calculator input and output schema for API and agent clients. | Free |
| GET | /v1/financial-calculators/sip/defaults | SIP calculator default inputs with USD contribution, monthly frequency, and explicit timing convention. | Free |
| GET | /v1/stocks/{ticker}/financial-calculators/sip/defaults | Enterprise/admin ticker-prefill defaults for the SIP calculator with visible source audit. | Enterprise |
| POST | /v1/stocks/{ticker}/financial-calculators/sip/backtest | Professional/admin historical SIP ticker backtest using available internal price history. | Enterprise |
| POST | /v1/financial-calculators/goal-based-sip/calculate | Run the standalone goal-based SIP calculator to solve the required recurring contribution for a target corpus. | Free |
| POST | /v1/financial-calculators/goal-based-sip/run | Alias for the goal-based SIP calculator run endpoint. | Free |
| POST | /v1/financial-calculators/goal-based-sip/sensitivity | Recompute a 2-axis sensitivity grid for goal-based SIP required contributions. | Free |
| POST | /v1/financial-calculators/goal-based-sip/solve-tenure | Solve the number of years needed for a fixed recurring contribution to reach the target corpus. | Free |
| GET | /v1/financial-calculators/goal-based-sip/schema | Goal-based SIP input and output schema for API and agent clients. | Free |
| GET | /v1/financial-calculators/goal-based-sip/defaults | Goal-based SIP default target, currency, return, inflation, and contribution assumptions. | Free |
| GET | /v1/stocks/{ticker}/financial-calculators/goal-based-sip/defaults | Enterprise/admin ticker-prefill defaults for the goal-based SIP calculator with visible source audit. | Enterprise |
| POST | /v1/stocks/{ticker}/financial-calculators/goal-based-sip/backtest | Professional/admin historical goal-feasibility backtest using available internal price history. | Enterprise |
| GET | /v1/financial-calculators/sip-time-to-goal | SIP time-to-goal calculator schema, outputs, and endpoint map. | Free |
| POST | /v1/financial-calculators/sip-time-to-goal/calculate | Run 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/run | Alias for the SIP time-to-goal calculator run endpoint. | Free |
| POST | /v1/financial-calculators/sip-time-to-goal/sensitivity | Recompute a 2-axis sensitivity grid for SIP time-to-goal assumptions. | Free |
| GET | /v1/financial-calculators/sip-time-to-goal/schema | SIP time-to-goal input and output schema for API and agent clients. | Free |
| GET | /v1/financial-calculators/sip-time-to-goal/defaults | SIP time-to-goal default target, contribution, currency, return, and timing assumptions. | Free |
| GET | /v1/stocks/{ticker}/financial-calculators/sip-time-to-goal/defaults | Enterprise/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/backtest | Professional/admin historical periodic target-hit backtest using available internal price history. | Enterprise |
| POST | /v1/financial-calculators/investment-time-to-goal/calculate | Run 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/run | Alias for the investment time-to-goal calculator run endpoint. | Free |
| POST | /v1/financial-calculators/investment-time-to-goal/sensitivity | Recompute a 2-axis sensitivity grid for investment time-to-goal assumptions. | Free |
| GET | /v1/financial-calculators/investment-time-to-goal/schema | Investment time-to-goal input and output schema for API and agent clients. | Free |
| GET | /v1/financial-calculators/investment-time-to-goal/defaults | Investment time-to-goal default target, initial investment, return, inflation, and tax assumptions. | Free |
| GET | /v1/stocks/{ticker}/financial-calculators/investment-time-to-goal/defaults | Enterprise/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/backtest | Professional/admin historical target-hit backtest for a one-time investment using available internal price history. | Enterprise |
| GET | /v1/financial-calculators/asset-allocation | Asset allocation calculator schema, outputs, and endpoint map. | Free |
| POST | /v1/financial-calculators/asset-allocation/calculate | Run the standalone asset allocation calculator with salary, savings-rate, age, risk-profile, emergency fund, and allocation assumptions. | Free |
| POST | /v1/financial-calculators/asset-allocation/run | Alias for the asset allocation calculator run endpoint. | Free |
| GET | /v1/financial-calculators/asset-allocation/schema | Asset allocation calculator input and output schema for API and agent clients. | Free |
| GET | /v1/financial-calculators/asset-allocation/defaults | Asset 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-portfolios | Premium/admin model portfolio templates with editable allocation and expected-return assumptions. | Enterprise |
| GET | /v1/financial-calculators/education-savings | Education savings calculator schema, outputs, and endpoint map. | Free |
| POST | /v1/financial-calculators/education-savings/calculate | Run the standalone education savings calculator with child age, education inflation, returns, current savings, aid, and program duration. | Free |
| POST | /v1/financial-calculators/education-savings/run | Alias for the education savings calculator run endpoint. | Free |
| GET | /v1/financial-calculators/education-savings/schema | Education savings calculator input and output schema for API and agent clients. | Free |
| GET | /v1/financial-calculators/education-savings/defaults | Education savings default inputs with USD currency, visible education inflation, and monthly timing assumptions. | Free |
| GET | /v1/financial-calculators/education-savings/education-cost-presets | Public region/type education-cost presets for guided planning. Presets are editable assumptions. | Free |
| GET | /v1/financial-calculators/education-savings/model-portfolios | Premium/admin model portfolio templates with editable return and fee assumptions for education goals. | Enterprise |
| GET | /v1/financial-calculators/education-savings/ticker-defaults | Premium/admin historical ticker or index return prefill with source audit for education savings assumptions. | Enterprise |
| GET | /v1/financial-calculators/fd-vs-equity | FD vs stock market returns calculator schema, outputs, and endpoint map. | Free |
| POST | /v1/financial-calculators/fd-vs-equity/calculate | Run 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/run | Alias for the FD/RD vs equity/SIP calculator run endpoint. | Free |
| GET | /v1/financial-calculators/fd-vs-equity/schema | FD/RD vs equity/SIP input and output schema for API and agent clients. | Free |
| GET | /v1/financial-calculators/fd-vs-equity/defaults | FD/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-defaults | Premium/admin historical equity ticker or index prefill with CAGR, volatility, drawdown, scenarios, and source audit. | Enterprise |
| GET | /v1/user/financial-calculator-workbooks | List the signed-in user's saved financial calculator workbooks. | Growth |
| POST | /v1/user/financial-calculator-workbooks | Save a private financial calculator workbook for reuse. | Growth |
| GET | /v1/financial-calculators/fixed-deposit | Fixed deposit calculator schema, outputs, and endpoint map. | Free |
| POST | /v1/financial-calculators/fixed-deposit/calculate | Run the standalone fixed deposit calculator with compounding, payout mode, tax, withholding, scenario, and schedule assumptions. | Free |
| POST | /v1/financial-calculators/fixed-deposit/run | Alias for the public fixed deposit calculator run endpoint. | Free |
| GET | /v1/financial-calculators/fixed-deposit/schema | Fixed deposit calculator input and output schema for API and agent clients. | Free |
| GET | /v1/financial-calculators/fixed-deposit/defaults | Fixed deposit default inputs with USD currency, 10-thousand principal, quarterly compounding, and cumulative maturity assumptions. | Free |
| GET | /v1/financial-calculators/compound-interest | Compound interest calculator schema, outputs, and endpoint map. | Free |
| GET | /v1/financial-calculators/cagr | CAGR calculator schema, outputs, and endpoint map. | Free |
| POST | /v1/financial-calculators/cagr/calculate | Run the standalone CAGR calculator with beginning value, ending value, period, unit scaling, scenarios, and period sensitivity. | Free |
| POST | /v1/financial-calculators/cagr/run | Alias for the public CAGR calculator run endpoint. | Free |
| GET | /v1/financial-calculators/cagr/schema | CAGR calculator input and output schema for API and agent clients. | Free |
| GET | /v1/financial-calculators/cagr/defaults | CAGR default inputs with 100 to 200 over 10 years as the baseline example. | Free |
| GET | /v1/financial-calculators/gst | GST calculator schema, outputs, endpoint map, official-source links, and rate presets. | Free |
| POST | /v1/financial-calculators/gst/calculate | Run 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/run | Alias for the public GST calculator run endpoint. | Free |
| GET | /v1/financial-calculators/gst/schema | GST calculator input and output schema for API and agent clients. | Free |
| GET | /v1/financial-calculators/gst/defaults | GST default inputs with INR currency, 18% rate, intrastate split, and editable rate presets. | Free |
| POST | /v1/financial-calculators/compound-interest/calculate | Run 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/run | Alias for the public compound interest calculator run endpoint. | Free |
| GET | /v1/financial-calculators/compound-interest/schema | Compound interest calculator input and output schema for API and agent clients. | Free |
| GET | /v1/financial-calculators/compound-interest/defaults | Compound interest default inputs with USD principal, monthly compounding, and monthly recurring contribution assumptions. | Free |
| GET | /v1/financial-calculators/recurring-deposit | Recurring deposit calculator schema, outputs, and endpoint map. | Free |
| POST | /v1/financial-calculators/recurring-deposit/calculate | Run the standalone recurring deposit calculator with monthly contribution, compounding, deposit timing, tax, withholding, scenario, and schedule assumptions. | Free |
| POST | /v1/financial-calculators/recurring-deposit/run | Alias for the public recurring deposit calculator run endpoint. | Free |
| GET | /v1/financial-calculators/recurring-deposit/schema | Recurring deposit calculator input and output schema for API and agent clients. | Free |
| GET | /v1/financial-calculators/recurring-deposit/defaults | Recurring deposit default inputs with USD monthly amount, quarterly compounding, and beginning-of-month contribution assumptions. | Free |
| POST | /v1/financial-calculators/ppf/calculate | Run the standalone Public Provident Fund calculator with manual deposits, tenure, rate, and fifth-day timing assumptions. | Free |
| POST | /v1/financial-calculators/ppf/run | Alias for the public PPF calculator run endpoint. | Free |
| GET | /v1/financial-calculators/ppf/schema | PPF calculator input and output schema for API and agent clients. | Free |
| GET | /v1/financial-calculators/ppf/defaults | PPF calculator default inputs, including current editable rate assumption and amount unit. | Free |
| POST | /v1/financial-calculators/education-loan-emi/calculate | Run the standalone education-loan EMI calculator with loan amount, rate, tenure, course duration, and moratorium assumptions. | Free |
| POST | /v1/financial-calculators/education-loan-emi/run | Alias for the public education-loan EMI calculator run endpoint. | Free |
| GET | /v1/financial-calculators/education-loan-emi/schema | Education loan EMI calculator input and output schema for API and agent clients. | Free |
| GET | /v1/financial-calculators/education-loan-emi/defaults | Education loan EMI default inputs with USD default principal and moratorium assumptions. | Free |
| POST | /v1/financial-calculators/step-up-sip/calculate | Run 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/run | Alias 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/schema | Step-up SIP calculator input and output schema for API and agent clients. | Free |
| GET | /v1/financial-calculators/step-up-sip/defaults | Step-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-defaults | Editable Step-Up SIP model assumptions by region, currency, and profile. | Enterprise |
| GET | /v1/financial-calculators/step-up-sip/return-defaults | Premium/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.
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.
Rate limits & pricing
Per-key, per-month. Burst capacity ≈ 2× sustained.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.
Errors
Stablecode field — branch on that, not the message.Ready to integrate?
Start with the free tier — 100 requests/month, no card required. Upgrade in-product when production volume justifies it.