Pools

Liquidity Pool information and listing.

List all liquidity pools

get

Returns information about all available liquidity pools.

Responses

200

List of liquidity pools

application/json

400

Bad request

application/json

get

/pools

HTTPcURLJavaScriptPython

GET /v1/pools HTTP/1.1
Host: api.tradecraft.fi
Accept: */*

{
  "pools": [
    {
      "token1": "CC",
      "token2": "USDCx",
      "lp_token_name": "TC CC/USDCx LP",
      "token1_holdings": 5000,
      "token2_holdings": 10000,
      "total_lp_tokens": 1000,
      "lp_fee_percent": 0.3,
      "operator_fee_percent": 0.1,
      "yield24h": 0.052
    }
  ]
}

Get a liquidity pool's ID

get

Returns the liquidity pool identifier for a token pair.

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

200

Liquidity pool ID

application/json

amm_idstringRequired

The AMM pool identifier

Example: TC CC/USDCx LP

400

Liquidity pool not found or invalid token names given

application/json

get

/ammid/{tokenA}/{tokenB}

HTTPcURLJavaScriptPython

GET /v1/ammid/{tokenA}/{tokenB} HTTP/1.1
Host: api.tradecraft.fi
Accept: */*

{
  "amm_id": "TC CC/USDCx LP"
}

Get liquidity pool state

get

Returns detailed information about the liquidity pool state including holdings, supply, and the constant product K.

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

200

Pool state

application/json

Detailed AMM pool state.

total_lp_token_supplynumber · doubleRequired

Total supply of LP tokens.

Example: 1000

token_a_idstringRequired

Identifier for token A.

Example: CC

token_a_holdingsnumber · doubleRequired

Amount of token A in the pool.

Example: 5000

token_b_idstringRequired

Identifier for token B.

Example: USDCx

token_b_holdingsnumber · doubleRequired

Amount of token B in the pool.

Example: 10000

knumber · doubleRequired

The constant product (token_a_holdings * token_b_holdings).

Example: 50000000

400

Pool not found or token unknown

application/json

get

/inspect/{tokenA}/{tokenB}

HTTPcURLJavaScriptPython

GET /v1/inspect/{tokenA}/{tokenB} HTTP/1.1
Host: api.tradecraft.fi
Accept: */*

{
  "total_lp_token_supply": 1000,
  "token_a_id": "CC",
  "token_a_holdings": 5000,
  "token_b_id": "USDCx",
  "token_b_holdings": 10000,
  "k": 50000000
}