Documentation / API Reference

API Reference

AnchorFX exposes a public, read-only REST + SSE API for escrow data, FX rates, analytics, and audit — plus an authenticated fee-sponsorship endpoint for gasless settlement. The interactive reference lives at the live API Reference page.

Base URL

https://anchorfx.vercel.app

Endpoints

GET /api/escrows

List all escrows (optional ?contract= override).

GET /api/rates

Live FX rates (optional ?oracle= override).

GET /api/fxroute

Quote a corridor: ?from=US&to=PH&amount=1000.

GET /api/analytics

On-chain analytics by escrow status + volume.

GET /api/health

RPC + contract health check.

GET /api/audit

Audit trail of contract events.

GET /api/events

Server-Sent Events stream of live events.

GET /api/export

Export all escrows as CSV or JSON.

POST /api/sponsor

Fee sponsorship — pay network fee for gasless users.

GET /api/feedback

In-app product feedback (session-scoped).

Example

curl — live escrows

curl -s https://anchorfx.vercel.app/api/escrows | jq
{
  "escrows": [{ "id": 1, "sender": "G...", "status": "Settled" }],
  "count": 71
}

INFO

Rate-limited

All public endpoints are rate-limited per IP and validated against the on-chain contract.