Pool v2

This endpoint provides comprehensive information about all the pools on the selected chain, including details about its assets, the contract address of its liquidity pool, and other relevant data. This information is crucial for making off-chain calculations and predicting quotes.

URL

https://api.clipper.exchange/rfq/v2/pool/{CHAIN_ID}

Request

Path Param	Description	Example
chain	Integer - Required ID of the chain	chain_id=137

Query Param	Description	Example
pool_address	str - Optional The address of the pool. If not provided, all pools on the selected chain will be returned.	pool_address=0x655eDCE464CC797526600a462A8154650EEe4B77
time_in_seconds	Integer - Optional The time duration for which a quote will be available. This value is used to calculate the fees; as you decrease the time, you will see lower fees. By default, the system sets a predefined value. Note: For on-chain data, this field is not considered.	time_in_seconds=30
fieldset	String - Optional Determines whether the API should make calls to the blockchain to return on-chain data. Accepted Value: offchain-data If the parameter is not provided, it will default to handling on-chain data.	fieldset=offchain-data

Response

On-chain object

Field	Description
pools	List of Pool data on-chain object
pool_type	String - offchain

Pool Data on-chain object

Field	Description
pool	Pool on-chain object
assets	List of Asset on-chain objects

Pool on-chain object

Field	Description
chain_id	Integer - ID of the chain
address	String(ETH address) - Clipper contract address of the pool, is the address used when executing a transaction
num_assets	Integer - The total of assets available in the chain
value_in_usd	Float - Value of the pool in USD (***REVIEW TEMO)
swaps_enabled	Bool - Represents if the swaps are available for the chain

Asset on-chain object

Field	Description
name	String - The name of the asset, this value should be used when making a quote
address	String(ETH address) - The contract address of the asset
price_in_usd	Float - Current price in dollars for the asset
value_in_usd	Float - Value of the pool in USD
target_value_in_usd	Float - USD target value for this asset in the pool

Off-chain object

Field	Description
pools	List of Pool data off-chain object
pool_type	String - offchain

Pool Data off-chain object

Field	Description
pool	Pool off-chain object
assets	List of Asset off-chain objects
pairs	List of Pair objects

Pool off-chain object

Field	Description
chain_id	Integer - ID of the chain
address	String(ETH address) - Clipper contract address of the pool, is the address used when executing a transaction
num_assets	Integer - The total of assets available in the chain
k	Float - K factor
time_in_seconds	Integer - Number of seconds were used to calculate the fees of a swap, this number indicates the number of seconds that quotes are live
default_time_in_seconds	Integer - Default number of seconds that quotes are live, is value used to calculate fees when don't send the query param time_in_seconds
swaps_enabled	Bool - Represents if the swaps are available for the chain

Asset off-chain object

Field	Description
name	String - The name of the asset, this value should be used when making a quote
address	String(ETH address) - The contract address of the asset
price_in_usd	Float - Current price in dollars for the asset
listing_weight	Integer - asset weight within the pool

Pair object

Field	Description
assets	List[str] - Pair of assets available to make a swap - e.g: ["ETH", "MATIC"]
fee_in_basis_points	Float - Fee for make a swap between the pair

Examples

1.Get the offchain data for Polygon chain (chain_id=137)

Request

curl -X GET "https://api.clipper.exchange/rfq/v2/pool/137?fieldset=offchain-data" -H "x-api-key: mQzA8Uy6nZ8Vy"

Response

{
  "pool_type": "offchain",
  "pools": [
    {
      "pool": {
        "chain_id": 1,
        "address": "0x655eDCE464CC797526600a462A8154650EEe4B77",
        "num_assets": 4,
        "k": 0.06,
        "time_in_seconds": 60,
        "default_time_in_seconds": 60,
        "swaps_enabled": true
      },
      "assets": [
        {
          "name": "ETH",
          "address": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
          "price_in_usd": 2076.799,
          "listing_weight": 79
        },
        {
          "name": "USDC",
          "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          "price_in_usd": 1,
          "listing_weight": 188
        },
        {
          "name": "USDT",
          "address": "0xdAC17F958D2ee523a2206206994597C13D831ec7",
          "price_in_usd": 1,
          "listing_weight": 305
        },
        {
          "name": "DAI",
          "address": "0x6B175474E89094C44Da98b954EedeAC495271d0F",
          "price_in_usd": 1,
          "listing_weight": 250
        }
      ],
      "pairs": [
        {
          "assets": [
            "ETH",
            "USDC"
          ],
          "fee_in_basis_points": 9
        },
        {
          "assets": [
            "ETH",
            "USDT"
          ],
          "fee_in_basis_points": 9
        },
        {
          "assets": [
            "ETH",
            "DAI"
          ],
          "fee_in_basis_points": 8
        },
        {
          "assets": [
            "USDC",
            "USDT"
          ],
          "fee_in_basis_points": 5
        },
        {
          "assets": [
            "USDC",
            "DAI"
          ],
          "fee_in_basis_points": 5
        },
        {
          "assets": [
            "USDT",
            "DAI"
          ],
          "fee_in_basis_points": 5
        }
      ]
    }
  ]
}

1. Get the on-chain data for mainnet chain (chain_id=1)

Request

curl -X GET "https://api.clipper.exchange/rfq/v2/pool/1?pool_address=0x655eDCE464CC797526600a462A8154650EEe4B77" -H "x-api-key: mQzA8Uy6nZ8Vy"

Response

{
  "pool_type": "onchain",
  "pools": [
    {
      "pool": {
        "chain_id": 1,
        "address": "0x655eDCE464CC797526600a462A8154650EEe4B77",
        "num_assets": 4,
        "pool_tokens": 1.3792871898369242e+24,
        "value_in_usd": 1978682.496424432,
        "swaps_enabled": true
      },
      "assets": [
        {
          "name": "USDC",
          "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          "balance": "417751254142",
          "price_in_usd": 1,
          "value_in_usd": 417751.254142,
          "target_value_in_usd": 416727.89356391726
        },
        {
          "name": "USDT",
          "address": "0xdAC17F958D2ee523a2206206994597C13D831ec7",
          "balance": "259059412007",
          "price_in_usd": 1,
          "value_in_usd": 259059.412007,
          "target_value_in_usd": 256868.3409508736
        },
        {
          "name": "DAI",
          "address": "0x6B175474E89094C44Da98b954EedeAC495271d0F",
          "balance": "309714519494182375269440",
          "price_in_usd": 1,
          "value_in_usd": 309714.5194941824,
          "target_value_in_usd": 313379.3759600658
        },
        {
          "name": "ETH",
          "address": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
          "balance": "476877882758190421102",
          "price_in_usd": 2080.527,
          "value_in_usd": 992157.3107812497,
          "target_value_in_usd": 991706.8859495752
        }
      ]
    }
  ]
}