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, and fee.

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

The values above are shortened for readability. Treat pool keys, token IDs, amounts, and fees as exact strings in application code.

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 and token metadata reads are public. Routes, market history, positions, swaps, balances, protocol configuration, and transaction schemas require an invited wallet session or an ss_... API token. 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, schema-assisted execution, 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

Build

Trade

Provide liquidity

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