V3 CFMM

API endpoints specific to Plenty V3

Ticks

Get all initialised ticks for a pool

GET https://api.plenty.network/config/ticks

This endpoint returns an array of objects where each object represents an initialised tick in a pool, its next and previous ticks, square root price at it, real price in both token x and y and net liquidity at it.

Query Parameters

Name	Type	Description
pool*	String	Tezos address of the v3 pool

200: OK Successfully returns all ticks

[
  {
    tick: string;
    prev: string;
    next: string;
    sqrtPrice: string;
    realPriceX: string;
    realPriceY: string;
    liquidityNet: string;
  }
]

Get the witness of a particular tick

GET https://api.plenty.network/config/ticks

This endpoint returns an object with a single field i.e. the witness of the provided tick

Query Parameters

Name	Type	Description
witnessOf*	Interger	The tick for which the witness is required

200: OK Successfully returned tick witness

{
  witness: string;
}

400: Bad Request Provided tick is not a number of not in range

Positions

Get all v3 positions of a specific Tezos address

GET https://api.plenty.network/v3/positions

This endpoint returns an array of objects where each object contains information about a position, the pool it belongs to, the tick boundaries, the liquidity and cumulative fee growth values.

Query Parameters

Name	Type	Description
address*	String	Tezos address of the user

200: OK Successfully returned list of positions

[
  {
    key_id: string; // Big_map key id
    amm: string; // Pool to which the position belongs
    owner: string;
    upper_tick_index: string;
    lower_tick_index: string;
    liquidity: string;
    fee_growth_inside_last_x: string; // Fee cumulatives
    fee_growth_inside_last_y: string;
  };
]