Skip to content
ClearPortX

API reference

ClearPortX exposes a small set of REST endpoints to support price feeds, pool listings, and quote previews without requiring a full Canton participant node. This reference will expand as the SDK stabilizes.

Base URL

Section titled “Base URL”

All endpoints are hosted at https://api.clearportx.com.

Endpoints

Section titled “Endpoints”

GET /api/pools

Section titled “GET /api/pools”

List all active pools with current state.

[
  {
    "poolId": "cc-cbtc-25",
    "tokenX": "CC",
    "tokenY": "cBTC",
    "binStep": 25,
    "activeId": 6,
    "reserves": { "x": "125000", "y": "6.15" }
  }
]

GET /api/pools/:poolId/bins

Section titled “GET /api/pools/:poolId/bins”

Return all bins for a pool with their current liquidity.

GET /api/route?in=X&out=Y&amount=N

Section titled “GET /api/route?in=X&out=Y&amount=N”

Get the best route for a swap. The router may combine multiple pools to minimize slippage.

GET /api/price?symbol=SYMBOL

Section titled “GET /api/price?symbol=SYMBOL”

Return the current validated price for a supported asset. Prices are sourced from independent oracle networks and include a timestamp for staleness verification.

Full parameter schemas, authentication requirements, and error codes will be documented page by page as the API stabilizes.