Skip to main content
Use the REST API when your application needs indexed data or current transaction input schemas 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
  • current pool state, statistics, trades, and candles
  • indexed swaps, positions, and balances
  • routes with up to three hops
  • revisioned protocol state, route topology, fee tiers, tick spacings, and compliance controls
  • transaction input schemas for the configured Shield Swap deployment
  • live update notifications over WebSocket

​
Access model

The API has three access levels. An API token covers the data and trading surface. It does not grant administrative privileges.

​
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.