Skip to main content

Full API Reference

Ratio FX exposes REST API endpoints across two primary subsystems. All endpoints require Bearer token authentication.

FX Engine Endpoints

The FX Engine API handles quote requests, firm quote execution, and system state queries.

EndpointMethodDescription
/v1/quoteGETRequest an indicative or firm quote for a corridor
/v1/firm-quotePOSTLock a firm executable quote with inventory reservation
/v1/executePOSTExecute a previously locked firm quote
/v1/system/stateGETQuery current State Engine status per corridor

Full request/response documentation: FX Engine API Reference

Reserve Pool Risk Endpoints

The Reserve Pool API exposes risk monitoring data, emergency controls, and batch lifecycle information.

EndpointMethodDescription
/v1/reserve/risk-statusGETCurrent VaR status snapshot for all corridors
/v1/reserve/batchesGETOpen rebalancing batches with WAOP and PnL
/v1/reserve/emergency-rfqPOSTManual emergency RFQ trigger (ops-level auth)
/v1/reserve/state-overridePOSTManual state override for corridor (ops-level auth)

Full request/response documentation: Risk API Reference

Error Handling

All error codes across both subsystems are documented in the Unified Error Code Reference.

Authentication

All endpoints require a Bearer token in the Authorization header:

Authorization: Bearer {your_api_token}

Standard endpoints use partner-level tokens. Reserve Pool emergency and override endpoints require ops-level tokens.