Skip to main content
Use the REST API when your application needs indexed market data or protocol state without reading every protocol mapping itself.
Mainnet is the documentation default. The network selector in the upper-right corner changes REST, WebSocket, OpenAPI, and example URLs across the site. A selection is stored in the browser and persists across pages and reloads. The API does not sign, prove, submit, or reconcile Shield transactions for your application.

​
What the API provides

  • Pool and token discovery, including Explore market lists and transaction feeds
  • Pool state, statistics, trades, candles, and oracle snapshots
  • Indexed positions and unclaimed outputs
  • Routes with up to three hops, route topology, fee tiers, protocol state, and compliance controls
  • Live update notifications over WebSocket

​
Access model

The API has three access levels. An API token does not grant administrative privileges. The testnet faucet and diagnostic helpers require an enabled deployment policy. The current mainnet deployment disables them.

​
Pool oracle

Use GET /pools/{key}/oracle?window_seconds=1800 for a public indexed oracle snapshot. Supported windows are 300, 1800, 3600, and 86400 seconds. The default is 1800 seconds. The response uses stored snapshots and quotes. Check observed_block, evaluated_at, start_at, and end_at before using the result. Window metrics include mean tick, tick variance, harmonic liquidity, and zero-liquidity duration. The totals object contains cumulative counters, not totals for the selected window. A 409 response can indicate oracle_uninitialized or oracle_history_unavailable. A 503 response can indicate twap_not_deployed or oracle_source_unavailable. Do not substitute zero values for unavailable oracle data. See Pagination and errors for retry guidance.

​
Choose the next page

​
Service endpoints

​
Exact values

Financial values use JSON strings. Preserve token amounts, liquidity, fees, revisions, and field identifiers exactly. Do not pass them through JavaScript number or localized number formatting. Routing and indexed state can change before a Shield transaction finalizes. Apply your own price limit, minimum output, deadline, record checks, and final-state reconciliation.