Live API reference
Scramble generates the OpenAPI 3.1 reference from deployed Laravel routes. Treat it as the endpoint source of truth.
Developers · launch contract
Build against the API that exists today.
Public calculator REST endpoints and the generated OpenAPI reference are live. Scoped account-key management is code-backed, while public MCP access remains unlaunched and must not be treated as an available integration.
- REST base
/api/v1- Key contract
developer-api.v1- Credential header
X-API-Key- MCP status
- Coming soon
01
What is available
Public access and gated contracts are labelled separately.
Public calculator REST
Stateless valuation and financial-calculator catalogs and run routes are available without claiming MCP or licensed-data access.
Scoped-key contract
Scoped key creation, rotation, quota metadata, and revocation are implemented; no plan includes developer API keys yet, and authenticated production availability is not yet monitored.
MCP launch boundary
The backend transport is implemented, but public advertising and real-client production certification have not passed their launch gates.
02
Use public REST today
These catalog calls require no developer key.
Public calculator catalogs
Use the deployed OpenAPI reference for the current public request and response schemas. Public calculator operations are separate from the unlaunched MCP transport.
Key-backed access
The account surface implements scoped key creation, rotation, quota metadata, and revocation. Until its authenticated production journey is certified, rely only on the public routes shown in the live OpenAPI reference.
03
Scopes and limits
Least privilege is selected when each key is created.
| Scope | Current use | Status |
|---|---|---|
| Public calculator REST | Stateless valuation and personal-finance calculator catalog and run routes. | Available |
valuation:calculate / financial-calculators:calculate | Scoped key contract for stateless calculator operations. | Production certification pending |
| Source-backed defaults and historical backtests | Licensed-data features. | Disabled pending licensing |
| MCP transport and tools | Read/calc-only implementation behind a launch gate. | Coming soon |
The source contract defines X-RateLimit-Limit,X-RateLimit-Remaining, X-RateLimit-Reset, and HTTP 429 exhaustion behavior. Those fields do not replace an authenticated production availability check.
04
Version and support policy
No hidden commercial promises.
Public REST routes use the /api/v1 prefix. The implemented key metadata contract usesdeveloper-api.v1. MCP setup instructions are withheld until its launch gate passes.
The launch plan does not promise an uptime SLA, webhooks, dedicated capacity, bulk redistribution rights, or compatibility with named third-party MCP clients. Public MCP access is not launched; review the changelogbefore adopting a newly released integration.