API reference
Curated staging endpoints used by this portal’s Sheets pack and quickstart. Full schema lives in Swagger.
Interactive docs: Swagger UI · openapi.json
Project library surfaces (swap valuation and other advisory workflows) are documented under Projects until they appear in Swagger. They are not part of the FX market MCP tool list.
Identity
| Method | Path | Notes |
|---|---|---|
| GET | /api/v1/me | Who the key is; level and kind |
Excel / market (Sheets Tier A)
| Method | Path | Notes |
|---|---|---|
| GET | /api/v1/excel/spot | base, foreign, side (CLIENT_VIEW+) |
| GET | /api/v1/market/spot/history | start, end (PROVIDER+) |
| GET | /api/v1/market/forward | horizon_weeks; optional on (defaults today; use a prior day if staging curve missing) |
| GET | /api/v1/market/volatility | Annualised vol |
| GET | /api/v1/market/currencies | Supported list |
| POST | /api/v1/analytics/carry | JSON: spot, forward, tenor_weeks |
Coming to staging (Tier B)
| Method | Path | Notes |
|---|---|---|
| GET | /api/v1/excel/tick | Nearest tick mid around at |
| POST | /api/v1/excel/option-price | Option ticket body → premium / greeks |
| GET | /api/v1/me/cash-flows | Caller’s org cash flows (role-gated) |
| GET | /api/v1/me/trades | Caller’s org trades (role-gated) |
Conventions
- All routes under
/api/v1/… - FX quoted as foreign per base
- Rates are indicative, not executable quotes
- Auth:
Authorization: Bearer zvrd_…. See Auth