Live API reference
Scramble generates the OpenAPI 3.1 reference from deployed Laravel routes. Treat it as the endpoint source of truth.
With your permission, we use privacy-limited analytics to understand which research journeys work. We do not run advertising trackers or session replay. You can change this choice in Preferences. Read the Privacy Policy.
Public REST endpoints are documented from the live OpenAPI spec. Professional accounts can create scoped keys for authenticated calculator traffic and the read/calc-only MCP beta.
/api/v1developer-api.v1X-API-KeyThe paid entitlement is narrow and explicit.
Scramble generates the OpenAPI 3.1 reference from deployed Laravel routes. Treat it as the endpoint source of truth.
Up to five active keys per account. Each key has a 1,000-call monthly quota and separate per-minute abuse limits.
valuation:calculate and financial-calculators:calculate cover stateless calculator operations and eligible MCP tools.
A secret appears only on create or rotation. List responses expose prefix, scopes, usage, dates, and status; keys can be rotated or revoked.
Keep the key in a secret manager or environment variable.
MCP currently exposes stateless, read/calc-only JSON-RPC tools. It cannot trade, mutate workbooks, generate reports, or change account data. The transport and schemas remain beta.
Stateless calculator catalog and run routes can be called without a key. A valid Professional key selects the elevated per-key rate bucket and records monthly usage.
Least privilege is selected when each key is created.
| Scope | Current use | Status |
|---|---|---|
valuation:calculate | Stateless valuation models, suites, sensitivity, formula resources, and matching MCP tools. | Available |
financial-calculators:calculate | Stateless personal-finance calculator operations and matching MCP tools. | Available |
| Source-backed defaults and historical backtests | Licensed-data features. | Disabled pending licensing |
| Report reader / generation MCP tools | Published research and report mutation. | Not in beta |
Successful key-backed responses include X-RateLimit-Limit,X-RateLimit-Remaining, and X-RateLimit-Reset. Monthly exhaustion returns HTTP 429 with Retry-After.
No hidden commercial promises.
REST routes use the /api/v1 prefix. Key metadata usesdeveloper-api.v1. MCP reports its protocol and beta server version during initialize.
The launch plan does not promise an uptime SLA, webhooks, dedicated capacity, bulk redistribution rights, or compatibility with named third-party MCP clients. Beta tool names and payloads can change; review the changelogbefore upgrading an integration.