REST API quickstart

This quickstart uses GET /pools, a public endpoint. You do not need an account, wallet signature, or API token.

List pools

Send a request to the selected network. Mainnet is the default; use the network selector in the upper-right corner to switch every example on this site to testnet.

curl --fail-with-body \
  "https://api.swap.shield.fi/pools?limit=10&offset=0"

const url = new URL("https://api.swap.shield.fi/pools");
url.search = new URLSearchParams({ limit: "10", offset: "0" });

const response = await fetch(url);
if (!response.ok) {
  throw new Error(`GET /pools returned ${response.status}`);
}

const pools = await response.json();
console.log(pools.data);

import json
from urllib.request import urlopen

url = "https://api.swap.shield.fi/pools?limit=10&offset=0"

with urlopen(url, timeout=10) as response:
    pools = json.load(response)

print(pools["data"])

Check the response

A successful response has a data array and a pagination object. Each pool includes its identifiers, enabled state, creation fee, and current fee.

{
  "data": [
    {
      "key": "3748...8179field",
      "token0": "2118...3732field",
      "token1": "4096...6596field",
      "enabled": true,
      "fee_percent": "30",
      "current_fee_percent": "30"
    }
  ],
  "pagination": {
    "total": 4,
    "limit": 10,
    "offset": 0
  }
}

The example shows selected fields and shortened identifiers. Treat pool keys, token IDs, amounts, and fees as exact strings in application code.Both fee fields use basis points: "30" means 0.30%. The creation value, fee_percent, remains part of the pool identity. The live value, current_fee_percent, is the current fee before Pricing Terms reductions. It is null when its source is unavailable.

Read one pool

Copy the exact key from a result and request that pool:

curl --fail-with-body \
  "https://api.swap.shield.fi/pools/POOL_KEY"

Replace POOL_KEY with the complete field value returned by GET /pools. Do not derive a pool key from token symbols.

Success check

You are done when:

both requests return HTTP 200
data contains the expected pool
the returned pool key is unchanged between requests
your client preserves integer-like values as strings

Before you call other endpoints

Pool metadata, pool analytics, token lists, Explore data, protocol state, and compliance reads are public. Routes, positions, unclaimed outputs, initialized ticks, and rebalance state require a wallet session or an ss_... API token with current terms accepted. Read Authentication before adding those endpoints to a backend or bot.

Continue from here

Choose an integration path if you are deciding between API data, the TypeScript SDK, and direct program calls.
Build a trading bot if you need routes, history, and live updates.
Browse the API reference for endpoint access requirements and exact schemas.

Start

Trade

Provide liquidity

Integration guides

Success check

Before you call other endpoints

Continue from here

​Success check

​Before you call other endpoints

​Continue from here

Success check

Before you call other endpoints

Continue from here