Pools and Positions (V2)

REST APIs for SaucerSwap V2 pools and positions

Access the SaucerSwap API using the following base URLs for testnet and mainnet environments:

Hedera Network	Base URL
Mainnet	https://api.saucerswap.finance/
Testnet	https://test-api.saucerswap.finance/
Previewnet	Not supported

Get all liquidity positions by account id

GET/v2/nfts/{accountId}/positions

Path parameters

accountId*string

Hedera account id

Example: "0.0.12345"

Response

200

Successful response

Body

application/json

tokenSN*integer

NFT serial number representing user's position

Example: 160

accountId*string

Hedera account id

Example: "0.0.12345"

deleted*boolean

True if this position was deleted otherwise false

Example: false

createdAt*string

Unix timestamp when this position was created

Example: "1697779560.762467685"

updatedAt*string

Unix timestamp when this position was updated

Example: "1698287867.747005303"

token0*Token (object)

token1*Token (object)

fee*integer

Swap fee tier denoted in basis points

Example: 3000

tickUpper*integer

Upper end of the position's price range

Example: -1620

tickLower*integer

Lower end of the position's price range

Example: -2820

liquidity*string

The amount of liquidity provided by the position

Example: "3249809842"

feeGrowthInside0LastX128*string

Accumulated fee growth for token0 inside the tick range since the last time liquidity was added or removed

Example: "2546890053379859378523505791149585"

feeGrowthInside1LastX128*string

Accumulated fee growth for token1 inside the tick range since the last time liquidity was added or removed

Example: "1232345435623984092384092380932840"

tokensOwed0*string

Total amount of token0 owed to the position due to fees generated from swaps within the position's price range

Example: "10"

tokensOwed1*string

Total amount of token1 owed to the position due to fees generated from swaps within the position's price range

Example: "20"

Request

JavaScriptCurlPython

const response = await fetch('/v2/nfts/{accountId}/positions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "tokenSN": 160,
    "accountId": "0.0.12345",
    "deleted": false,
    "createdAt": "1697779560.762467685",
    "updatedAt": "1698287867.747005303",
    "token0": {
      "id": "0.0.731861",
      "name": "SAUCE",
      "symbol": "SAUCE",
      "icon": "/images/tokens/sauce.svg",
      "decimals": 6,
      "price": "36806544",
      "priceUsd": 0.01763457,
      "dueDiligenceComplete": true,
      "isFeeOnTransferToken": false,
      "description": "SaucerSwap is an open source and non-custodial AMM protocol native to Hedera.",
      "website": "https://www.saucerswap.finance/",
      "sentinelReport": "https://sentinel.headstarter.org/details/saucerswap",
      "twitterHandle": "SaucerSwapLabs",
      "timestampSecondsLastListingChange": 0
    },
    "token1": {
      "id": "0.0.731861",
      "name": "SAUCE",
      "symbol": "SAUCE",
      "icon": "/images/tokens/sauce.svg",
      "decimals": 6,
      "price": "36806544",
      "priceUsd": 0.01763457,
      "dueDiligenceComplete": true,
      "isFeeOnTransferToken": false,
      "description": "SaucerSwap is an open source and non-custodial AMM protocol native to Hedera.",
      "website": "https://www.saucerswap.finance/",
      "sentinelReport": "https://sentinel.headstarter.org/details/saucerswap",
      "twitterHandle": "SaucerSwapLabs",
      "timestampSecondsLastListingChange": 0
    },
    "fee": 3000,
    "tickUpper": -1620,
    "tickLower": -2820,
    "liquidity": "3249809842",
    "feeGrowthInside0LastX128": "2546890053379859378523505791149585",
    "feeGrowthInside1LastX128": "1232345435623984092384092380932840",
    "tokensOwed0": "10",
    "tokensOwed1": "20"
  }
]

Get detailed data for a SaucerSwap V2 pool by id

GET/v2/pools/{poolId}

Path parameters

poolId*integer

Example: 1

Response

200

Successful response

Body

application/json

id*integer

Example: 1

contractId*string

Example: "0.0.3948521"

tokenA*TokenA (all of)

tokenB*TokenB (all of)

amountA*string

Total amount for token A

Example: "6313040"

amountB*string

Total amount for token B

Example: "6313042"

fee*integer

Swap fee tier for the pool, denoted in basis points

Example: 500

sqrtRatioX96*string

Encoded square root of price ratio between tokens in the pool as a Q64.96 number

Example: "79228162514992909706099547250"

tickCurrent*integer

Current active tick index, representing a specific price point in the pool

Example: 0

liquidity*string

Total liquidity for the pool

Example: "10878982596"

Request

JavaScriptCurlPython

const response = await fetch('/v2/pools/{poolId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": 1,
  "contractId": "0.0.3948521",
  "tokenA": {
    "id": "0.0.731861",
    "name": "SAUCE",
    "symbol": "SAUCE",
    "decimals": 6,
    "priceUsd": 0.01760954,
    "description": "<p>SaucerSwap is an open source and non-custodial AMM protocol native to Hedera.</p>",
    "website": "https://www.saucerswap.finance/",
    "sentinelReport": "https://sentinel.headstarter.org/details/saucerswap",
    "twitterHandle": "SaucerSwapLabs",
    "timestampSecondsLastListingChange": 0,
    "__$markdownParsed": true
  },
  "tokenB": {
    "id": "0.0.1460200",
    "name": "xSAUCE",
    "symbol": "XSAUCE",
    "decimals": 6,
    "priceUsd": 0.01959459,
    "description": "<p>SaucerSwap is an open source and non-custodial AMM protocol native to Hedera.</p>",
    "website": "https://www.saucerswap.finance/",
    "sentinelReport": "https://sentinel.headstarter.org/details/saucerswap",
    "twitterHandle": "SaucerSwapLabs",
    "timestampSecondsLastListingChange": 0,
    "__$markdownParsed": true
  },
  "amountA": "6313040",
  "amountB": "6313042",
  "fee": 500,
  "sqrtRatioX96": "79228162514992909706099547250",
  "tickCurrent": 0,
  "liquidity": "10878982596"
}

Get detailed data for all SaucerSwap V2 pools

GET/v2/pools/full

Response

200

Successful response

Body

application/json

id*integer

Example: 1

contractId*string

Example: "0.0.3948521"

tokenA*TokenA (all of)

tokenB*TokenB (all of)

amountA*string

Total amount for token A

Example: "6313040"

amountB*string

Total amount for token B

Example: "6313042"

fee*integer

Swap fee tier for the pool, denoted in basis points

Example: 500

sqrtRatioX96*string

Encoded square root of price ratio between tokens in the pool as a Q64.96 number

Example: "79228162514992909706099547250"

tickCurrent*integer

Current active tick index, representing a specific price point in the pool

Example: 0

liquidity*string

Total liquidity for the pool

Example: "10878982596"

Request

JavaScriptCurlPython

const response = await fetch('/v2/pools/full', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 1,
    "contractId": "0.0.3948521",
    "tokenA": {
      "id": "0.0.731861",
      "name": "SAUCE",
      "symbol": "SAUCE",
      "decimals": 6,
      "priceUsd": 0.01760954,
      "description": "<p>SaucerSwap is an open source and non-custodial AMM protocol native to Hedera.</p>",
      "website": "https://www.saucerswap.finance/",
      "sentinelReport": "https://sentinel.headstarter.org/details/saucerswap",
      "twitterHandle": "SaucerSwapLabs",
      "timestampSecondsLastListingChange": 0,
      "__$markdownParsed": true
    },
    "tokenB": {
      "id": "0.0.1460200",
      "name": "xSAUCE",
      "symbol": "XSAUCE",
      "decimals": 6,
      "priceUsd": 0.01959459,
      "description": "<p>SaucerSwap is an open source and non-custodial AMM protocol native to Hedera.</p>",
      "website": "https://www.saucerswap.finance/",
      "sentinelReport": "https://sentinel.headstarter.org/details/saucerswap",
      "twitterHandle": "SaucerSwapLabs",
      "timestampSecondsLastListingChange": 0,
      "__$markdownParsed": true
    },
    "amountA": "6313040",
    "amountB": "6313042",
    "fee": 500,
    "sqrtRatioX96": "79228162514992909706099547250",
    "tickCurrent": 0,
    "liquidity": "10878982596"
  }
]

Get compact data for all SaucerSwap V2 pools

GET/v2/pools

Response

200

Successful response

Body

application/json

id*integer

Example: 1

contractId*string

Example: "0.0.3948521"

tokenA*TokenACompact (all of)

tokenB*TokenBCompact (all of)

amountA*string

Total amount for token A

Example: "6313040"

amountB*string

Total amount for token B

Example: "6313042"

fee*integer

Swap fee tier for the pool, denoted in basis points

Example: 500

sqrtRatioX96*string

Encoded square root of price ratio between tokens in the pool as a Q64.96 number

Example: "79228162514992909706099547250"

tickCurrent*integer

Current active tick index, representing a specific price point in the pool

Example: 0

liquidity*string

Total liquidity for the pool

Example: "10878982596"

Request

JavaScriptCurlPython

const response = await fetch('/v2/pools', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 1,
    "contractId": "0.0.3948521",
    "tokenA": {
      "id": "0.0.731861",
      "name": "SAUCE",
      "symbol": "SAUCE",
      "decimals": 6,
      "priceUsd": 0.01760954
    },
    "tokenB": {
      "id": "0.0.1460200",
      "name": "xSAUCE",
      "symbol": "XSAUCE",
      "decimals": 6,
      "priceUsd": 0.01959459
    },
    "amountA": "6313040",
    "amountB": "6313042",
    "fee": 500,
    "sqrtRatioX96": "79228162514992909706099547250",
    "tickCurrent": 0,
    "liquidity": "10878982596"
  }
]