Liquidity

Liquidity provider operations.

Get liquidity withdrawal quote

get

Calculate how much of each token the user will receive when redeeming LP tokens.

Path parameters
tokenAstring · enumRequired

The name/symbol of the first token (URL encoded).

Example: CCPossible values:
tokenBstring · enumRequired

The name/symbol of the second token (URL encoded).

Example: USDCxPossible values:
Query parameters
lpTokenAmountnumber · doubleRequired

The amount of LP tokens to redeem

Example: 10
Responses
chevron-right
200

Liquidity withdrawal quote

application/json
get
/quoteLPWithdrawal/{tokenA}/{tokenB}

Get liquidity deposit quote

get

Calculate the maximum LP tokens that can be minted given the provided amounts of both instruments. Returns the optimal deposit amounts maintaining the pool ratio.

Path parameters
tokenAstring · enumRequired

The name/symbol of the first token (URL encoded).

Example: CCPossible values:
tokenBstring · enumRequired

The name/symbol of the second token (URL encoded).

Example: USDCxPossible values:
Query parameters
instrument1Amountnumber · doubleRequired

The amount of instrument 1 available for deposit

Example: 100
instrument2Amountnumber · doubleRequired

The available amount of instrument 2 available for deposit

Example: 200
Responses
chevron-right
200

Liquidity deposit quote

application/json
get
/quoteLPDeposit/{tokenA}/{tokenB}

Get pool yield/APY

get

Returns annualized percentage yield (APY) calculations for the pool across multiple time periods. APY is calculated based on the growth of value per LP token (k / lpSupply) over time. Requires Apollo DB connection for historical data; returns empty yield data if unavailable.

Path parameters
tokenAstring · enumRequired

The name/symbol of the first token (URL encoded).

Example: CCPossible values:
tokenBstring · enumRequired

The name/symbol of the second token (URL encoded).

Example: USDCxPossible values:
Responses
chevron-right
200

Pool yield data

application/json
get
/yield/{tokenA}/{tokenB}

Get historical yield/APY over time

get

Returns an array of timestamped APY data points for the pool. Each data point represents the annualized yield during that time interval, calculated based on the growth of value per LP token (sqrt(k) / lpSupply). Timestamps are aligned to interval boundaries (e.g., top of minute, top of hour, midnight).

Available windows:

  • hour: 60 data points at 1-minute intervals

  • day: 288 data points at 5-minute intervals

  • week: 168 data points at 1-hour intervals

  • month: 240 data points at 3-hour intervals

  • year: 365 data points at 1-day intervals

Requires Apollo DB connection for historical data.

Path parameters
tokenAstring · enumRequired

The name/symbol of the first token (URL encoded).

Example: CCPossible values:
tokenBstring · enumRequired

The name/symbol of the second token (URL encoded).

Example: USDCxPossible values:
Query parameters
windowstring · enumRequired

The time window for the yield history

Example: dayPossible values:
Responses
chevron-right
200

Historical yield data

application/json
get
/yield_history/{tokenA}/{tokenB}

Get pool trading volume in USD

get

Returns USD-denominated trading volume for the pool across multiple time periods. Volume is calculated by tracking changes in AMM reserves between consecutive states. Each swap is converted to USD at the exchange rate that was active at the time of that swap. USD conversion is performed using:

  • Stablecoins (SBC, USDCx): 1:1 with USD

  • CC (Canton Coin): Historical exchange rate from OpenMiningRound contracts via Scan ACS API Returns an error if neither token can be converted to USD.

Path parameters
tokenAstring · enumRequired

The name/symbol of the first token (URL encoded).

Example: CCPossible values:
tokenBstring · enumRequired

The name/symbol of the second token (URL encoded).

Example: USDCxPossible values:
Responses
chevron-right
200

Pool volume data in USD

application/json
get
/volume/{tokenA}/{tokenB}

Get historical trading volume over time

get

Returns an array of timestamped volume data points for the pool. Each data point represents the USD-denominated trading volume during that time interval. Timestamps are aligned to interval boundaries (e.g., top of minute, top of hour, midnight).

Available windows:

  • hour: 60 data points at 1-minute intervals

  • day: 288 data points at 5-minute intervals

  • week: 168 data points at 1-hour intervals

  • month: 240 data points at 3-hour intervals

  • year: 365 data points at 1-day intervals

Volume calculation uses the same methodology as /volume endpoint.

Path parameters
tokenAstring · enumRequired

The name/symbol of the first token (URL encoded).

Example: CCPossible values:
tokenBstring · enumRequired

The name/symbol of the second token (URL encoded).

Example: USDCxPossible values:
Query parameters
windowstring · enumRequired

The time window for the volume history

Example: dayPossible values:
Responses
chevron-right
200

Historical volume data

application/json
get
/volume_history/{tokenA}/{tokenB}

Last updated

Was this helpful?