Pools (V1)

REST APIs for V1 pools on SaucerSwap

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 the latest candlestick data for pool by id

GET/pools/conversionRates/latest/{poolId}

Path parameters

poolId*integer

Pool ID

Example: 1

Query parameters

Response

200

Successful response

Body

application/json

id*integer

Example: 2

poolId*integer

Example: 1

open*number

Example: 0.0482115316666979

high*number

Example: 0.0482115316666979

low*number

Example: 0.04819650172584323

close*number

Example: 0.04819650172584323

avg*number

Example: 118.56339424557434

volume*string

Example: "0"

liquidity*string

Example: "9668737245792"

volumeUsd*string

Example: "0"

liquidityUsd*string

Example: "4653.53"

timestampSeconds*integer

Example: 1697618460

startTimestampSeconds*integer

Example: 1697616000

Request

JavaScriptCurlPython

const response = await fetch('/pools/conversionRates/latest/{poolId}?interval=HOUR', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": 2,
  "poolId": 1,
  "open": 0.0482115316666979,
  "high": 0.0482115316666979,
  "low": 0.04819650172584323,
  "close": 0.04819650172584323,
  "avg": 118.56339424557434,
  "volume": "0",
  "liquidity": "9668737245792",
  "volumeUsd": "0",
  "liquidityUsd": "4653.53",
  "timestampSeconds": 1697618460,
  "startTimestampSeconds": 1697616000
}

Get historical candlestick data for pool by id

GET/pools/conversionRates/{poolId}

Path parameters

poolId*integer

Pool ID

Example: 1

Query parameters

Response

200

Successful response

Body

application/json

id*integer

Example: 2

poolId*integer

Example: 1

open*number

Example: 0.0482115316666979

high*number

Example: 0.0482115316666979

low*number

Example: 0.04819650172584323

close*number

Example: 0.04819650172584323

avg*number

Example: 118.56339424557434

volume*string

Example: "0"

liquidity*string

Example: "9668737245792"

volumeUsd*string

Example: "0"

liquidityUsd*string

Example: "4653.53"

timestampSeconds*integer

Example: 1697618460

startTimestampSeconds*integer

Example: 1697616000

Request

JavaScriptCurlPython

const response = await fetch('/pools/conversionRates/{poolId}?from=1697600000&to=1697610000&interval=HOUR', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": 2,
  "poolId": 1,
  "open": 0.0482115316666979,
  "high": 0.0482115316666979,
  "low": 0.04819650172584323,
  "close": 0.04819650172584323,
  "avg": 118.56339424557434,
  "volume": "0",
  "liquidity": "9668737245792",
  "volumeUsd": "0",
  "liquidityUsd": "4653.53",
  "timestampSeconds": 1697618460,
  "startTimestampSeconds": 1697616000
}

Get yearly volume and liquidity for pool by id

GET/pools/yearly/{poolId}

Path parameters

poolId*integer

Example: 1

Response

200

Successful response

Body

application/json

poolId*integer

Example: 502

timestampSeconds*integer

Example: 1697760000

liquidity*string

Pool liquidity in its smallest unit

Example: "1268297620467"

volume*string

Pool volume in its smallest unit

Example: "178297285042"

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "poolId": 502,
    "timestampSeconds": 1697760000,
    "liquidity": "1268297620467",
    "volume": "178297285042"
  }
]

Get monthly volume and liquidity for pool by id

GET/pools/monthly/{poolId}

Path parameters

poolId*integer

Example: 1

Response

200

Successful response

Body

application/json

poolId*integer

Example: 502

timestampSeconds*integer

Example: 1697760000

liquidity*string

Pool liquidity in its smallest unit

Example: "1268297620467"

volume*string

Pool volume in its smallest unit

Example: "178297285042"

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "poolId": 502,
    "timestampSeconds": 1697760000,
    "liquidity": "1268297620467",
    "volume": "178297285042"
  }
]

Get weekly volume and liquidity for a pool by id

GET/pools/weekly/{poolId}

Path parameters

poolId*integer

Example: 1

Response

200

Successful response

Body

application/json

poolId*integer

Example: 502

timestampSeconds*integer

Example: 1697760000

liquidity*string

Pool liquidity in its smallest unit

Example: "1268297620467"

volume*string

Pool volume in its smallest unit

Example: "178297285042"

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "poolId": 502,
    "timestampSeconds": 1697760000,
    "liquidity": "1268297620467",
    "volume": "178297285042"
  }
]

Get daily volume and liquidity for a pool by id

GET/pools/daily/{poolId}

Path parameters

poolId*integer

Example: 1

Response

200

Successful response

Body

application/json

poolId*integer

Example: 502

timestampSeconds*integer

Example: 1697760000

liquidity*string

Pool liquidity in its smallest unit

Example: "1268297620467"

volume*string

Pool volume in its smallest unit

Example: "178297285042"

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "poolId": 502,
    "timestampSeconds": 1697760000,
    "liquidity": "1268297620467",
    "volume": "178297285042"
  }
]

Get yearly volume and liquidity for pools

GET/pools/yearly

Response

200

Successful response

Body

application/json

poolId*integer

Example: 502

timestampSeconds*integer

Example: 1697760000

liquidity*string

Pool liquidity in its smallest unit

Example: "1268297620467"

volume*string

Pool volume in its smallest unit

Example: "178297285042"

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "poolId": 502,
    "timestampSeconds": 1697760000,
    "liquidity": "1268297620467",
    "volume": "178297285042"
  }
]

Get monthly volume and liquidity for pools

GET/pools/monthly

Response

200

Successful response

Body

application/json

poolId*integer

Example: 502

timestampSeconds*integer

Example: 1697760000

liquidity*string

Pool liquidity in its smallest unit

Example: "1268297620467"

volume*string

Pool volume in its smallest unit

Example: "178297285042"

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "poolId": 502,
    "timestampSeconds": 1697760000,
    "liquidity": "1268297620467",
    "volume": "178297285042"
  }
]

Get weekly volume and liquidity for pools

GET/pools/weekly

Response

200

Successful response

Body

application/json

poolId*integer

Example: 502

timestampSeconds*integer

Example: 1697760000

liquidity*string

Pool liquidity in its smallest unit

Example: "1268297620467"

volume*string

Pool volume in its smallest unit

Example: "178297285042"

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "poolId": 502,
    "timestampSeconds": 1697760000,
    "liquidity": "1268297620467",
    "volume": "178297285042"
  }
]

Get daily volume and liquidity for pools

GET/pools/daily

Response

200

Successful response

Body

application/json

poolId*integer

Example: 502

timestampSeconds*integer

Example: 1697760000

liquidity*string

Pool liquidity in its smallest unit

Example: "1268297620467"

volume*string

Pool volume in its smallest unit

Example: "178297285042"

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "poolId": 502,
    "timestampSeconds": 1697760000,
    "liquidity": "1268297620467",
    "volume": "178297285042"
  }
]

Get default listed pool data

GET/pools/known

Response

200

Successful response

Body

application/json

id*integer

Example: 213

contractId*string

Example: "0.0.1465865"

lpToken*LPToken (all of)

lpTokenReserve*string

LP token reserve in its smallest unit

Example: "23490447137584"

tokenA*TokenA (all of)

tokenReserveA*string

Token A reserve in its smallest unit

Example: "25185652046087"

tokenB*TokenB (all of)

tokenReserveB*string

Token B reserve in its smallest unit

Example: "22634187941347"

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "id": 213,
    "contractId": "0.0.1465865",
    "lpToken": {
      "id": "0.0.1465866",
      "name": "SS-LP SAUCE - XSAUCE",
      "symbol": "SAUCE - XSAUCE",
      "decimals": 8,
      "priceUsd": 3.7760690082569948
    },
    "lpTokenReserve": "23490447137584",
    "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
    },
    "tokenReserveA": "25185652046087",
    "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
    },
    "tokenReserveB": "22634187941347"
  }
]

Get detailed data for a pool by id

GET/pools/{poolId}

Path parameters

poolId*integer

Example: 1

Response

200

Successful response

Body

application/json

id*integer

Example: 213

contractId*string

Example: "0.0.1465865"

lpToken*LPToken (all of)

lpTokenReserve*string

LP token reserve in its smallest unit

Example: "23490447137584"

tokenA*TokenA (all of)

tokenReserveA*string

Token A reserve in its smallest unit

Example: "25185652046087"

tokenB*TokenB (all of)

tokenReserveB*string

Token B reserve in its smallest unit

Example: "22634187941347"

Request

JavaScriptCurlPython

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

Response

200

{
  "id": 213,
  "contractId": "0.0.1465865",
  "lpToken": {
    "id": "0.0.1465866",
    "name": "SS-LP SAUCE - XSAUCE",
    "symbol": "SAUCE - XSAUCE",
    "decimals": 8,
    "priceUsd": 3.7760690082569948
  },
  "lpTokenReserve": "23490447137584",
  "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
  },
  "tokenReserveA": "25185652046087",
  "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
  },
  "tokenReserveB": "22634187941347"
}

Get detailed data for all pools

GET/pools/full

Response

200

Successful response

Body

application/json

id*integer

Example: 213

contractId*string

Example: "0.0.1465865"

lpToken*LPToken (all of)

lpTokenReserve*string

LP token reserve in its smallest unit

Example: "23490447137584"

tokenA*TokenA (all of)

tokenReserveA*string

Token A reserve in its smallest unit

Example: "25185652046087"

tokenB*TokenB (all of)

tokenReserveB*string

Token B reserve in its smallest unit

Example: "22634187941347"

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "id": 213,
    "contractId": "0.0.1465865",
    "lpToken": {
      "id": "0.0.1465866",
      "name": "SS-LP SAUCE - XSAUCE",
      "symbol": "SAUCE - XSAUCE",
      "decimals": 8,
      "priceUsd": 3.7760690082569948
    },
    "lpTokenReserve": "23490447137584",
    "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
    },
    "tokenReserveA": "25185652046087",
    "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
    },
    "tokenReserveB": "22634187941347"
  }
]

Get compact data for all pools

GET/pools

Response

200

Successful response

Body

application/json

id*integer

Example: 213

contractId*string

Example: "0.0.1465865"

lpToken*LPToken (all of)

lpTokenReserve*string

LP token reserve in its smallest unit

Example: "23490447137584"

tokenA*TokenACompact (all of)

tokenReserveA*string

Token A reserve in its smallest unit

Example: "25185652046087"

tokenB*TokenBCompact (all of)

tokenReserveB*string

Token B reserve in its smallest unit

Example: "22634187941347"

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "id": 213,
    "contractId": "0.0.1465865",
    "lpToken": {
      "id": "0.0.1465866",
      "name": "SS-LP SAUCE - XSAUCE",
      "symbol": "SAUCE - XSAUCE",
      "decimals": 8,
      "priceUsd": 3.7760690082569948
    },
    "lpTokenReserve": "23490447137584",
    "tokenA": {
      "id": "0.0.731861",
      "name": "SAUCE",
      "symbol": "SAUCE",
      "decimals": 6,
      "priceUsd": 0.01760954
    },
    "tokenReserveA": "25185652046087",
    "tokenB": {
      "id": "0.0.1460200",
      "name": "xSAUCE",
      "symbol": "XSAUCE",
      "decimals": 6,
      "priceUsd": 0.01959459
    },
    "tokenReserveB": "22634187941347"
  }
]