REST API
Every public tool as a JSON endpoint, with an OpenAPI 3.1 document generated from the same schemas.
The REST API serves the public tools: read-only market data and calculators. Actions that send anything anywhere are never exposed here.
Endpoints
| Method | Path | Purpose |
|---|---|---|
GET | /api/v1/tools | Lists the tools with their input and output JSON Schemas |
POST | /api/v1/tools/<name> | Runs one tool; the body is the tool input as JSON |
GET | /api/v1/openapi.json | OpenAPI 3.1 document, generated from the zod registry |
Example
curl -s http://localhost:3070/api/v1/tools/compare_areas \
-H "content-type: application/json" \
-d '{"anchorArea":"Kestrel Park","nearby":3,"goal":"rent"}'The response is {"output": ...} with the tool's fields plus summary, notes, charts, provenance, attribution and synthetic.
Errors return {"error": {"code", "message"}} with status 400 (invalid input, unknown area), 404 (unknown tool) or 429 (rate limited).
Terms of use
- Keep
provenanceandattributionvisible wherever you show a figure. - No bulk extraction or re-publication of the marts.
- Not for tenant, borrower or employment screening, and never present outputs as official statistics.
- Rate limits apply per IP and globally.
A hosted instance may publish its own terms of use in addition to these.
Accounts and admin
Guests and accounts, sign-in by email code, password or Google, mail, daily message limits, the first superuser, the admin panel, settings and stored keys, operator instructions, retention, proxies and every related variable.
MCP server
The same tools over the Model Context Protocol, for any MCP client and any model.
Code: Apache-2.0. Original docs text and diagrams: CC BY 4.0. Excluded from both: data, figures and charts derived from DLD or Data.Dubai (governed by DATA_LICENSE.md and any DLD grant); EIBOR values (CBUAE terms); third-party names and logos; and the product and operator names and logos (no trademark licence).
The default data is SYNTHETIC – not Dubai data. Nothing here is financial, legal or investment advice.