Everything you need to integrate FX Guard protection into your platform.
Interactive API documentation powered by Redoc. Browse endpoints, schemas, and try example requests.
Markdown reference docs optimised for AI coding assistants like Claude Code and Cursor. 168 endpoints across access and onboarding, documents and reporting, events and streaming, getting started, guards, market data, organisations and people, and reference data APIs.
Build and test your integration with live market data but no real trades or fees. Same API surface as production.
https://sandbox-api.currencyguard.com
Production — real Guards, real fees, and real settlements. Same endpoints, just change the base URL.
https://api.currencyguard.com
GET /api/v1/guard-pricing/quote ?guardCurrency=GBP &foreignCurrency=USD &payReceive=PAY &foreignAmount=50000 &settlementDate=2026-08-24
This is a public endpoint — no API key needed.
https://developer.currencyguard.com/llms.txthttps://developer.currencyguard.com/llm-friendly-api-docs/external/llms-full.txtThe llms-full.txt file contains all 164 endpoints — perfect for a single-shot context load.
POST /oauth2/tokenAuthorization: Bearer <token> on all API callsPublic endpoints like Guard Pricing don't need authentication.
POST /api-regulated/v1/guard-quoteAuthorization: Bearer <token>{
"companyId": "...",
"guardCurrency": "GBP",
"foreignCurrency": "USD",
"payReceive": "PAY",
"foreignAmount": 50000,
"settlementDate": "2026-08-24"
}Unlike the public pricing endpoint, this quote is tradable — pass the quoteId to the buy endpoint to execute.
POST /api-regulated/v1/guard-quotes/smart-parse{
"text": "We need to pay USD 650,000 against GBP in 45 days"
}Feed invoice text or emails directly — the LLM extracts currency, amount, direction, and timing automatically.
POST /api-regulated/v1/guard-quotes/{quoteId}/buy-guardPENDING_FEEPOST /api-regulated/v1/guards/{guardId}/complete-paymentACTIVEThe quote has a time-to-live — buy it before expiry or you'll need to re-quote.
settlementWindowOpens date has passedPOST /api-regulated/v1/guards/{guardId}/settle-guardIf the market rate is better than the Guard rate, the client can let it lapse — they're never locked in.
POST /api-regulated/v1/guards/{guardId}/quote-guard-extensionPOST /api-regulated/v1/guard-quotes/{quoteId}/buy-guard-extensionPOST /api-regulated/v1/guards/{guardId}/complete-extension-paymentThe extension fee reflects the extra duration only — the Guard rate stays the same.
GET /api-regulated/v1/guards/{guardId}/calculate-cancellation-refundPOST /api-regulated/v1/guards/{guardId}/cancel-guardRefund amount depends on the Guard's age and remaining maturity — check the calculation before confirming.
GET /api-regulated/v1/market-statusGuards can only be quoted and traded when markets are open — check before presenting pricing to users.
GET /api-regulated/v1/fx-spot-pricesGET /api-regulated/v1/fx-spot-prices/GBPUSDCompare spot rates against Guard rates to help clients decide whether to settle or let the Guard lapse.
POST /api-regulated/v1/introducing-brokers/{brokerId}/companiesEach company sits under an introducing broker — you'll need your broker ID from the onboarding step.
POST /api-regulated/v1/webhook-subscriptions
{
"subscriptionName": "Production order book",
"endpointUrl": "https://psp.example.com/webhooks/currencyguard"
}signingSecret from the 201 response — it's shown only oncelastEventSequence to spot gaps and detect delivery healthPOST /api-regulated/v1/webhook-subscriptions/{id}/rotate-secretSubscriptions auto-pause after repeated delivery failures — PATCH the status back to ACTIVE to resume from the last checkpoint, so no events are missed.