Pools

Get liquidity pool by ID

Retrieves a liquidity pool by its unique identifier.

GEThttps://indexer-dev.saturnbtc.io/v0/pool/by-id/{id}

Path parameters

id*string

The unique identifier of the liquidity pool.

Response

200404

The liquidity pool details with serialized BigInt values.

Body

application/json

shards*array of object

config*object

liquidity*string

price*string

token0Amount*string

token1Amount*string

Request

JavaScriptCurlPython

const response = await fetch('https://indexer-dev.saturnbtc.io/v0/pool/by-id/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "shards": [
    {
      "pubkey": "text",
      "pool_pubkey": "text",
      "rune_utxo": {
        "needs_consolidation": {
          "No": {}
        },
        "utxo": {
          "txid": "text",
          "vout": 0
        },
        "value": "text",
        "runes": [
          {
            "id": {
              "block": "text",
              "tx": 0
            },
            "amount": "text"
          }
        ]
      },
      "btc_utxos": [
        {
          "needs_consolidation": {
            "No": {}
          },
          "utxo": {
            "txid": "text",
            "vout": 0
          },
          "value": "text",
          "runes": [
            {
              "id": {
                "block": "text",
                "tx": 0
              },
              "amount": "text"
            }
          ]
        }
      ],
      "liquidity": "text",
      "protocol_fee_owed": "text",
      "last_block_height": "text",
      "times_updated": "text",
      "k_last": "text",
      "k_last_counter": "text"
    }
  ],
  "config": {
    "pubkey": "text",
    "fee_tier": 0,
    "shards": 0,
    "token_0": {
      "block": "text",
      "tx": 0
    },
    "token_1": {
      "block": "text",
      "tx": 0
    }
  },
  "liquidity": "text",
  "price": "text",
  "token0Amount": "text",
  "token1Amount": "text"
}

Get liquidity pools by token names

Retrieves liquidity pools matching the specified token names and optional fee tier.

GEThttps://indexer-dev.saturnbtc.io/v0/pool/by-token-names

Query parameters

Response

200404

A list of liquidity pools with serialized BigInt values.

Body

application/json

shards*array of object

config*object

liquidity*string

price*string

token0Amount*string

token1Amount*string

Request

JavaScriptCurlPython

const response = await fetch('https://indexer-dev.saturnbtc.io/v0/pool/by-token-names?token0=text&token1=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

[
  {
    "shards": [
      {
        "pubkey": "text",
        "pool_pubkey": "text",
        "rune_utxo": {
          "needs_consolidation": {
            "No": {}
          },
          "utxo": {
            "txid": "text",
            "vout": 0
          },
          "value": "text",
          "runes": [
            {
              "id": {
                "block": "text",
                "tx": 0
              },
              "amount": "text"
            }
          ]
        },
        "btc_utxos": [
          {
            "needs_consolidation": {
              "No": {}
            },
            "utxo": {
              "txid": "text",
              "vout": 0
            },
            "value": "text",
            "runes": [
              {
                "id": {
                  "block": "text",
                  "tx": 0
                },
                "amount": "text"
              }
            ]
          }
        ],
        "liquidity": "text",
        "protocol_fee_owed": "text",
        "last_block_height": "text",
        "times_updated": "text",
        "k_last": "text",
        "k_last_counter": "text"
      }
    ],
    "config": {
      "pubkey": "text",
      "fee_tier": 0,
      "shards": 0,
      "token_0": {
        "block": "text",
        "tx": 0
      },
      "token_1": {
        "block": "text",
        "tx": 0
      }
    },
    "liquidity": "text",
    "price": "text",
    "token0Amount": "text",
    "token1Amount": "text"
  }
]

Get liquidity pools by token IDs

Retrieves liquidity pools matching the specified token IDs and optional fee tier.

GEThttps://indexer-dev.saturnbtc.io/v0/pool/by-token-ids

Query parameters

Response

200404

A list of liquidity pools with serialized BigInt values.

Body

application/json

shards*array of object

config*object

liquidity*string

price*string

token0Amount*string

token1Amount*string

Request

JavaScriptCurlPython

const response = await fetch('https://indexer-dev.saturnbtc.io/v0/pool/by-token-ids?token0=text&token1=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

[
  {
    "shards": [
      {
        "pubkey": "text",
        "pool_pubkey": "text",
        "rune_utxo": {
          "needs_consolidation": {
            "No": {}
          },
          "utxo": {
            "txid": "text",
            "vout": 0
          },
          "value": "text",
          "runes": [
            {
              "id": {
                "block": "text",
                "tx": 0
              },
              "amount": "text"
            }
          ]
        },
        "btc_utxos": [
          {
            "needs_consolidation": {
              "No": {}
            },
            "utxo": {
              "txid": "text",
              "vout": 0
            },
            "value": "text",
            "runes": [
              {
                "id": {
                  "block": "text",
                  "tx": 0
                },
                "amount": "text"
              }
            ]
          }
        ],
        "liquidity": "text",
        "protocol_fee_owed": "text",
        "last_block_height": "text",
        "times_updated": "text",
        "k_last": "text",
        "k_last_counter": "text"
      }
    ],
    "config": {
      "pubkey": "text",
      "fee_tier": 0,
      "shards": 0,
      "token_0": {
        "block": "text",
        "tx": 0
      },
      "token_1": {
        "block": "text",
        "tx": 0
      }
    },
    "liquidity": "text",
    "price": "text",
    "token0Amount": "text",
    "token1Amount": "text"
  }
]

Get pool statistics by IDs

Retrieves statistics for multiple pools identified by their IDs.

GEThttps://indexer-dev.saturnbtc.io/v0/pool/stats/by-ids

Query parameters

Response

200404

A list of pool statistics with serialized BigInt values.

Body

application/json

id*string

tvl_now*string

tvl_24h_ago*string

tvl_diff*string

volume_24h*string

volume_diff_24h*string

fees_24h*string

apy_24h*string

apy*string

volume_7d*string

fees_7d*string

apy_7d*string

price*string

token0Amount*string

token1Amount*string

token0*object

token1*object

liquidity*string

fee_rate*number

Request

JavaScriptCurlPython

const response = await fetch('https://indexer-dev.saturnbtc.io/v0/pool/stats/by-ids?poolIds=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

[
  {
    "id": "text",
    "tvl_now": "text",
    "tvl_24h_ago": "text",
    "tvl_diff": "text",
    "volume_24h": "text",
    "volume_diff_24h": "text",
    "fees_24h": "text",
    "apy_24h": "text",
    "apy": "text",
    "volume_7d": "text",
    "fees_7d": "text",
    "apy_7d": "text",
    "price": "text",
    "token0Amount": "text",
    "token1Amount": "text",
    "token0": {
      "id": "text",
      "name": "text",
      "displayName": "text",
      "symbol": "text",
      "tradeable": false,
      "verified": false,
      "icon": "text",
      "priority": 0,
      "divisibility": 0,
      "supply": "text",
      "batchSize": "text",
      "transactionId": "text",
      "createdAt": "text"
    },
    "token1": {
      "id": "text",
      "name": "text",
      "displayName": "text",
      "symbol": "text",
      "tradeable": false,
      "verified": false,
      "icon": "text",
      "priority": 0,
      "divisibility": 0,
      "supply": "text",
      "batchSize": "text",
      "transactionId": "text",
      "createdAt": "text"
    },
    "liquidity": "text",
    "fee_rate": 0
  }
]

Get pool statistics by filter

Retrieves a paginated list of pool statistics based on provided filters.

POSThttps://indexer-dev.saturnbtc.io/v0/pool/stats/by-filter

Body

application/json

The filter parameters for searching pools.

• name: An array of token names to filter pools.
• minTvl: The minimum total value locked (TVL) to filter pools.
• minVolume: The minimum trading volume to filter pools.
• sort: An array of sorting fields and directions.
• limit (optional): The maximum number of results to return.
• offset (optional): The number of results to skip for pagination.

name*array of string

minTvl*string

minVolume*string

sort*array of SortFieldSorteablePoolFields (object)

limitinteger

offset*integer

Response

201404

A paginated response containing a list of pool statistics with serialized BigInt values.

Body

application/json

response*array of object

offset*number

Request

JavaScriptCurlPython

const response = await fetch('https://indexer-dev.saturnbtc.io/v0/pool/stats/by-filter', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": [
        "text"
      ],
      "minTvl": "text",
      "minVolume": "text",
      "sort": [
        {}
      ]
    }),
});
const data = await response.json();

Response

201404

{
  "response": [
    {
      "id": "text",
      "tvl_now": "text",
      "tvl_24h_ago": "text",
      "tvl_diff": "text",
      "volume_24h": "text",
      "volume_diff_24h": "text",
      "fees_24h": "text",
      "apy_24h": "text",
      "apy": "text",
      "volume_7d": "text",
      "fees_7d": "text",
      "apy_7d": "text",
      "price": "text",
      "token0Amount": "text",
      "token1Amount": "text",
      "token0": {
        "id": "text",
        "name": "text",
        "displayName": "text",
        "symbol": "text",
        "tradeable": false,
        "verified": false,
        "icon": "text",
        "priority": 0,
        "divisibility": 0,
        "supply": "text",
        "batchSize": "text",
        "transactionId": "text",
        "createdAt": "text"
      },
      "token1": {
        "id": "text",
        "name": "text",
        "displayName": "text",
        "symbol": "text",
        "tradeable": false,
        "verified": false,
        "icon": "text",
        "priority": 0,
        "divisibility": 0,
        "supply": "text",
        "batchSize": "text",
        "transactionId": "text",
        "createdAt": "text"
      },
      "liquidity": "text",
      "fee_rate": 0
    }
  ],
  "offset": 0
}

Get grouped pool statistics by token filter

Retrieves a paginated list of pool statistics grouped by tokens based on provided filters.

POSThttps://indexer-dev.saturnbtc.io/v0/pool/stats/by-token-filter

Body

application/json

The filter parameters for searching and grouping pools by tokens.

• name: An array of token names to filter pools.
• minTvl: The minimum total value locked (TVL) to filter pools.
• minVolume: The minimum trading volume to filter pools.
• sort: An array of sorting fields and directions.
• limit (optional): The maximum number of results to return.
• offset (optional): The number of results to skip for pagination.

name*array of string

minTvl*string

minVolume*string

sort*array of SortFieldSorteableGroupedPoolsFields (object)

limitinteger

offset*integer

Response

201404

A paginated response containing a list of grouped pool statistics with serialized BigInt values.

Body

application/json

response*array of object

offset*number

Request

JavaScriptCurlPython

const response = await fetch('https://indexer-dev.saturnbtc.io/v0/pool/stats/by-token-filter', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": [
        "text"
      ],
      "minTvl": "text",
      "minVolume": "text",
      "sort": [
        {}
      ]
    }),
});
const data = await response.json();

Response

201404

{
  "response": [
    {
      "token0": {
        "id": "text",
        "name": "text",
        "displayName": "text",
        "symbol": "text",
        "tradeable": false,
        "verified": false,
        "icon": "text",
        "priority": 0,
        "divisibility": 0,
        "supply": "text",
        "batchSize": "text",
        "transactionId": "text",
        "createdAt": "text"
      },
      "token1": {
        "id": "text",
        "name": "text",
        "displayName": "text",
        "symbol": "text",
        "tradeable": false,
        "verified": false,
        "icon": "text",
        "priority": 0,
        "divisibility": 0,
        "supply": "text",
        "batchSize": "text",
        "transactionId": "text",
        "createdAt": "text"
      },
      "volume_24h": "text",
      "volume_diff_24h": "text",
      "volume_7d": "text",
      "fees_24h": "text",
      "tvl_now": "text",
      "tvl_24h_ago": "text",
      "tvl_diff": "text",
      "smaller_24h_apy": "text",
      "larger_24h_apy": "text",
      "smaller_7d_apy": "text",
      "larger_7d_apy": "text",
      "pools": [
        {
          "id": "text",
          "liquidity": "text",
          "price": "text",
          "token0Amount": "text",
          "token1Amount": "text",
          "tvl_now": "text",
          "tvl_24h_ago": "text",
          "tvl_diff": "text",
          "volume_24h": "text",
          "volume_diff_24h": "text",
          "fees_24h": "text",
          "apy_24h": "text",
          "apy_7d": "text",
          "apy": "text",
          "volume_7d": "text",
          "fees_7d": "text",
          "fee_rate": 0
        }
      ]
    }
  ],
  "offset": 0
}

Get liquidity pools

Retrieves a paginated list of liquidity pools based on the specified name and sorting options.

GEThttps://indexer-dev.saturnbtc.io/v0/pool

Query parameters

Response

200

A paginated response containing a list of liquidity pools with serialized BigInt values.

Body

application/json

response*array of object

offset*number

Request

JavaScriptCurlPython

const response = await fetch('https://indexer-dev.saturnbtc.io/v0/pool', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "response": [
    {
      "shards": [
        {
          "pubkey": "text",
          "pool_pubkey": "text",
          "rune_utxo": {
            "needs_consolidation": {
              "No": {}
            },
            "utxo": {
              "txid": "text",
              "vout": 0
            },
            "value": "text",
            "runes": [
              {
                "id": {
                  "block": "text",
                  "tx": 0
                },
                "amount": "text"
              }
            ]
          },
          "btc_utxos": [
            {
              "needs_consolidation": {
                "No": {}
              },
              "utxo": {
                "txid": "text",
                "vout": 0
              },
              "value": "text",
              "runes": [
                {
                  "id": {
                    "block": "text",
                    "tx": 0
                  },
                  "amount": "text"
                }
              ]
            }
          ],
          "liquidity": "text",
          "protocol_fee_owed": "text",
          "last_block_height": "text",
          "times_updated": "text",
          "k_last": "text",
          "k_last_counter": "text"
        }
      ],
      "config": {
        "pubkey": "text",
        "fee_tier": 0,
        "shards": 0,
        "token_0": {
          "block": "text",
          "tx": 0
        },
        "token_1": {
          "block": "text",
          "tx": 0
        }
      },
      "liquidity": "text",
      "price": "text",
      "token0Amount": "text",
      "token1Amount": "text"
    }
  ],
  "offset": 0
}