REST API

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

Hedera Network

Base URL

Mainnet

https://api.saucerswap.finance/

Testnet

https://test-api.saucerswap.finance/

Previewnet

Not supported

Statistics

General statistics

GET/stats

Response

Successful response

Body

circulatingSaucestring

Total sauce in circulation in its smallest unit

swapTotalinteger

Total swaps across all pools since inception

tvlstring

Total value locked priced in Tinybar

tvlUsdnumber (float)

Total value locked in USD

volumeTotalstring

Total trading volume since inception priced in Tinybar

volumeTotalUsdnumber (float)

Total volume in USD

Request

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

Response

{
  "circulatingSauce": "526531284317600",
  "swapTotal": "1600796",
  "tvl": "55577479377624950",
  "tvlUsd": 26773811.729033,
  "volumeTotal": "372768795310667371",
  "volumeTotalUsd": 220524200.282553
}

Single-Sided Staking statistics

GET/stats/sss

Response

Successful response

Body

avg5daynumber (float)

5-day average APR

idinteger

rationumber (float)

XSAUCE to SAUCE ratio

saucestring

SAUCE amount in its smallest unit

timestampSecondsinteger

Unix timestamp in seconds

xsaucestring

XSAUCE amount in its smallest unit

Request

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

Response

{
  "avg5day": 0.0462,
  "id": 146206,
  "ratio": 1.1172,
  "sauce": "242601707456381",
  "timestampSeconds": "1697616900",
  "xsauce": "217150119725425"
}

Get historical HBAR price data (minutely)

GET/stats/hbarHistoricalPrices

Query parameters

Response

Successful response

Body

idinteger

priceUsdnumber

timestampSecondsinteger

Request

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

Response

[
  {
    "id": 548294,
    "priceUsd": 0.04830379666666667,
    "timestampSeconds": 1697599980
  }
]

Get platform historical liquidity or volume data

GET/stats/platformData

Query parameters

Response

Successful response

Body

valueHbarstring

value in Tinybar

timestampSecondsinteger

Request

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

Response

[
  {
    "valueHbar": 46701854905030720,
    "timestampSeconds": 1697598000
  }
]

Farms

Get list of active farms

GET/farms

Response

Successful response

Body

id*integer

poolId*integer

sauceEmissions*number (float)

hbarEmissions*number (float)

totalStaked*string

Request

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

Response

[
  {
    "id": 14,
    "poolId": 35,
    "sauceEmissions": 2.3062,
    "hbarEmissions": 0.0103,
    "totalStaked": "955338445589"
  }
]

Get LP token amounts in farms by account id

GET/farms/totals/{accountId}

Path parameters

accountId*string

Response

Successful response

Body

farmId*integer

poolId*integer

accountId*string

timestamp*number (float)

staked*string

Staked LP amount in its smallest unit

Request

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

Response

[
  {
    "farmId": 14,
    "poolId": 35,
    "accountId": "0.0.12345",
    "timestamp": "1682469351.387795003",
    "staked": "95533844"
  }
]

Tokens

Get compact token data

GET/tokens

Response

Successful response

Body

id*string

icon*string

symbol*string

decimals*integer

price*string

priceUsd*number (float)

dueDiligenceComplete*boolean

isFeeOnTransferToken*boolean

Request

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

Response

[
  {
    "id": "0.0.731861",
    "icon": "/images/tokens/sauce.svg",
    "symbol": "SAUCE",
    "decimals": 6,
    "price": "36806544",
    "priceUsd": 0.01760954,
    "dueDiligenceComplete": true,
    "isFeeOnTransferToken": false
  }
]

Get detailed token data

GET/tokens/full

Response

Successful response

Body

id*string

name*string

symbol*string

icon*string

decimals*integer

price*string

priceUsd*number

dueDiligenceComplete*boolean

isFeeOnTransferToken*boolean

descriptionstring

websitestring

sentinelReportstring

twitterHandlestring

timestampSecondsLastListingChange*integer

Request

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

Response

[
  {
    "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"
  }
]

Get detailed token data by id

GET/tokens/{tokenId}

Path parameters

tokenId*string

Response

Successful response

Body

id*string

name*string

symbol*string

icon*string

decimals*integer

price*string

priceUsd*number

dueDiligenceComplete*boolean

isFeeOnTransferToken*boolean

descriptionstring

websitestring

sentinelReportstring

twitterHandlestring

timestampSecondsLastListingChange*integer

Request

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

Response

{
  "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"
}

Get default listed token data

GET/tokens/known

Response

Successful response

Body

id*string

name*string

symbol*string

icon*string

decimals*integer

price*string

priceUsd*number

dueDiligenceComplete*boolean

isFeeOnTransferToken*boolean

descriptionstring

websitestring

sentinelReportstring

twitterHandlestring

timestampSecondsLastListingChange*integer

Request

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

Response

[
  {
    "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"
  }
]

Get hourly, daily and weekly price change for default listed tokens

GET/tokens/default

Response

Successful response

Body

id*string

symbol*string

priceUsd*number (float)

liquidityUsd*number (float)

priceChangeHour*number (float)

priceChangeDay*number (float)

priceChangeWeek*number (float)

Request

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

Response

[
  {
    "id": "0.0.731861",
    "symbol": "SAUCE",
    "priceUsd": 0.0177,
    "liquidityUsd": 2880053.73,
    "priceChangeHour": 0.01,
    "priceChangeDay": 0.04,
    "priceChangeWeek": 0.11
  }
]

Get a mapping of tokenId to 24-hours price change percentage

GET/tokens/price-change

Response

Successful operation

Body

Other propertiesnumber

24-hours price change percentage for the given tokenId

Request

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

Response

{
  "0.0.731861": -2.5351798847046836,
  "0.0.786931": 4.047875243039449,
  "0.0.629591": -12.223518441429796
}

Get daily price, volume and liquidity for all tokens

GET/tokens/daily

Response

Successful response

Body

timestampSeconds*integer

Unix seconds

tokenId*string

Token ID

price*string

liquidity*string

Token liquidity in its smallest unit

volume*string

Token volume in its smallest unit

Request

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

Response

[
  {
    "timestampSeconds": 1697677200,
    "tokenId": "0.0.731861",
    "price": "36334886",
    "liquidity": "5971792596548121",
    "volume": "100169644699152"
  }
]

Get weekly price, volume and liquidity for all tokens

GET/tokens/weekly

Response

Successful response

Body

timestampSeconds*integer

Unix seconds

tokenId*string

Token ID

price*string

liquidity*string

Token liquidity in its smallest unit

volume*string

Token volume in its smallest unit

Request

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

Response

[
  {
    "timestampSeconds": 1697677200,
    "tokenId": "0.0.731861",
    "price": "36334886",
    "liquidity": "5971792596548121",
    "volume": "100169644699152"
  }
]

Get monthly price, volume and liquidity for all tokens

GET/tokens/monthly

Response

Successful response

Body

timestampSeconds*integer

Unix seconds

tokenId*string

Token ID

price*string

liquidity*string

Token liquidity in its smallest unit

volume*string

Token volume in its smallest unit

Request

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

Response

[
  {
    "timestampSeconds": 1697677200,
    "tokenId": "0.0.731861",
    "price": "36334886",
    "liquidity": "5971792596548121",
    "volume": "100169644699152"
  }
]

Get yearly price, volume and liquidity for all tokens

GET/tokens/yearly

Response

Successful response

Body

timestampSeconds*integer

Unix seconds

tokenId*string

Token ID

price*string

liquidity*string

Token liquidity in its smallest unit

volume*string

Token volume in its smallest unit

Request

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

Response

[
  {
    "timestampSeconds": 1697677200,
    "tokenId": "0.0.731861",
    "price": "36334886",
    "liquidity": "5971792596548121",
    "volume": "100169644699152"
  }
]

Get daily price, volume and liquidity for token by id

GET/tokens/daily/{tokenId}

Path parameters

tokenId*string

Response

Successful response

Body

timestampSeconds*integer

Unix seconds

tokenId*string

Token ID

price*string

liquidity*string

Token liquidity in its smallest unit

volume*string

Token volume in its smallest unit

Request

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

Response

[
  {
    "timestampSeconds": 1697677200,
    "tokenId": "0.0.731861",
    "price": "36334886",
    "liquidity": "5971792596548121",
    "volume": "100169644699152"
  }
]

Get weekly price, volume and liquidity for token by id

GET/tokens/weekly/{tokenId}

Path parameters

tokenId*string

Response

Successful response

Body

timestampSeconds*integer

Unix seconds

tokenId*string

Token ID

price*string

liquidity*string

Token liquidity in its smallest unit

volume*string

Token volume in its smallest unit

Request

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

Response

[
  {
    "timestampSeconds": 1697677200,
    "tokenId": "0.0.731861",
    "price": "36334886",
    "liquidity": "5971792596548121",
    "volume": "100169644699152"
  }
]

Get monthly price, volume and liquidity for token by id

GET/tokens/monthly/{tokenId}

Path parameters

tokenId*string

Response

Successful response

Body

timestampSeconds*integer

Unix seconds

tokenId*string

Token ID

price*string

liquidity*string

Token liquidity in its smallest unit

volume*string

Token volume in its smallest unit

Request

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

Response

[
  {
    "timestampSeconds": 1697677200,
    "tokenId": "0.0.731861",
    "price": "36334886",
    "liquidity": "5971792596548121",
    "volume": "100169644699152"
  }
]

Get yearly price, volume and liquidity for token by id

GET/tokens/yearly/{tokenId}

Path parameters

tokenId*string

Response

Successful response

Body

timestampSeconds*integer

Unix seconds

tokenId*string

Token ID

price*string

liquidity*string

Token liquidity in its smallest unit

volume*string

Token volume in its smallest unit

Request

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

Response

[
  {
    "timestampSeconds": 1697677200,
    "tokenId": "0.0.731861",
    "price": "36334886",
    "liquidity": "5971792596548121",
    "volume": "100169644699152"
  }
]

Get associated pools containing the token by id

GET/tokens/associated-pools/{tokenId}

Path parameters

tokenId*string

Response

Successful response

Body

id*integer

contractId*string

lpToken*LPToken (all of)

lpTokenReserve*string

LP token reserve in its smallest unit

tokenA*TokenA (all of)

tokenReserveA*string

Token A reserve in its smallest unit

tokenB*TokenB (all of)

tokenReserveB*string

Token B reserve in its smallest unit

Request

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

Response

[
  {
    "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 historical candlestick data for token by id

GET/tokens/prices/{tokenId}

Path parameters

tokenId*string

Query parameters

Response

Successful response

Body

id*integer

tokenId*string

open*integer

openUsd*number (float)

high*integer

highUsd*number (float)

low*integer

lowUsd*number (float)

close*integer

closeUsd*number (float)

avg*number (float)

avgUsd*number (float)

volume*string

liquidity*string

volumeUsd*number (float)

liquidityUsd*any

timestampSeconds*integer

startTimestampSeconds*integer

Request

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

Response

[
  {
    "id": 83,
    "tokenId": "0.0.731861",
    "open": 36358807,
    "openUsd": 0.017246927356274498,
    "high": 36370090,
    "highUsd": 0.017248478665373164,
    "low": 36334867,
    "lowUsd": 0.0169388611613325,
    "close": 36353193,
    "closeUsd": 0.0169388611613325,
    "avg": 36347000.92028988,
    "avgUsd": 0.017085609229304164,
    "volume": "4484168318250",
    "liquidity": "5976854242691456",
    "volumeUsd": 2110.33,
    "liquidityUsd": 2784930.18,
    "timestampSeconds": 1697681880,
    "startTimestampSeconds": 1697673600
  }
]

Get the latest candlestick data for token by id

GET/tokens/prices/latest/{tokenId}

Path parameters

tokenId*string

Query parameters

Response

Successful response

Body

id*integer

tokenId*string

open*integer

openUsd*number (float)

high*integer

highUsd*number (float)

low*integer

lowUsd*number (float)

close*integer

closeUsd*number (float)

avg*number (float)

avgUsd*number (float)

volume*string

liquidity*string

volumeUsd*number (float)

liquidityUsd*any

timestampSeconds*integer

startTimestampSeconds*integer

Request

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

Response

[
  {
    "id": 83,
    "tokenId": "0.0.731861",
    "open": 36358807,
    "openUsd": 0.017246927356274498,
    "high": 36370090,
    "highUsd": 0.017248478665373164,
    "low": 36334867,
    "lowUsd": 0.0169388611613325,
    "close": 36353193,
    "closeUsd": 0.0169388611613325,
    "avg": 36347000.92028988,
    "avgUsd": 0.017085609229304164,
    "volume": "4484168318250",
    "liquidity": "5976854242691456",
    "volumeUsd": 2110.33,
    "liquidityUsd": 2784930.18,
    "timestampSeconds": 1697681880,
    "startTimestampSeconds": 1697673600
  }
]

Get USD price history for a token by id

GET/tokens/prices/usd/{tokenId}

Path parameters

tokenId*string

Query parameters

Response

Successful response

Body

priceUsdnumber (float)

timestampSecondsinteger

Request

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

Response

[
  {
    "priceUsd": 0.017734458589574,
    "timestampSeconds": 1697601600
  }
]

Pools

Get compact data for all pools

GET/pools

Response

Successful response

Body

id*integer

contractId*string

lpToken*LPToken (all of)

lpTokenReserve*string

LP token reserve in its smallest unit

tokenA*TokenACompact (all of)

tokenReserveA*string

Token A reserve in its smallest unit

tokenB*TokenBCompact (all of)

tokenReserveB*string

Token B reserve in its smallest unit

Request

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

Response

[
  {
    "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"
  }
]

Get detailed data for all pools

GET/pools/full

Response

Successful response

Body

id*integer

contractId*string

lpToken*LPToken (all of)

lpTokenReserve*string

LP token reserve in its smallest unit

tokenA*TokenA (all of)

tokenReserveA*string

Token A reserve in its smallest unit

tokenB*TokenB (all of)

tokenReserveB*string

Token B reserve in its smallest unit

Request

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

Response

[
  {
    "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

Response

Successful response

Body

id*integer

contractId*string

lpToken*LPToken (all of)

lpTokenReserve*string

LP token reserve in its smallest unit

tokenA*TokenA (all of)

tokenReserveA*string

Token A reserve in its smallest unit

tokenB*TokenB (all of)

tokenReserveB*string

Token B reserve in its smallest unit

Request

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

Response

{
  "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 default listed pool data

GET/pools/known

Response

Successful response

Body

id*integer

contractId*string

lpToken*LPToken (all of)

lpTokenReserve*string

LP token reserve in its smallest unit

tokenA*TokenA (all of)

tokenReserveA*string

Token A reserve in its smallest unit

tokenB*TokenB (all of)

tokenReserveB*string

Token B reserve in its smallest unit

Request

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

Response

[
  {
    "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 daily volume and liquidity for pools

GET/pools/daily

Response

Successful response

Body

poolId*integer

timestampSeconds*integer

liquidity*string

Pool liquidity in its smallest unit

volume*string

Pool volume in its smallest unit

Request

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

Response

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

Get weekly volume and liquidity for pools

GET/pools/weekly

Response

Successful response

Body

poolId*integer

timestampSeconds*integer

liquidity*string

Pool liquidity in its smallest unit

volume*string

Pool volume in its smallest unit

Request

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

Response

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

Get monthly volume and liquidity for pools

GET/pools/monthly

Response

Successful response

Body

poolId*integer

timestampSeconds*integer

liquidity*string

Pool liquidity in its smallest unit

volume*string

Pool volume in its smallest unit

Request

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

Response

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

Get yearly volume and liquidity for pools

GET/pools/yearly

Response

Successful response

Body

poolId*integer

timestampSeconds*integer

liquidity*string

Pool liquidity in its smallest unit

volume*string

Pool volume in its smallest unit

Request

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

Response

[
  {
    "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

Response

Successful response

Body

poolId*integer

timestampSeconds*integer

liquidity*string

Pool liquidity in its smallest unit

volume*string

Pool volume in its smallest unit

Request

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

Response

[
  {
    "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

Response

Successful response

Body

poolId*integer

timestampSeconds*integer

liquidity*string

Pool liquidity in its smallest unit

volume*string

Pool volume in its smallest unit

Request

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

Response

[
  {
    "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

Response

Successful response

Body

poolId*integer

timestampSeconds*integer

liquidity*string

Pool liquidity in its smallest unit

volume*string

Pool volume in its smallest unit

Request

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

Response

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

Get yearly volume and liquidity for pool by id

GET/pools/yearly/{poolId}

Path parameters

poolId*integer

Response

Successful response

Body

poolId*integer

timestampSeconds*integer

liquidity*string

Pool liquidity in its smallest unit

volume*string

Pool volume in its smallest unit

Request

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

Response

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

Get historical candlestick data for pool by id

GET/pools/conversionRates/{poolId}

Path parameters

poolId*integer

Pool ID

Query parameters

Response

Successful response

Body

id*integer

poolId*integer

open*number

high*number

low*number

close*number

avg*number

volume*string

liquidity*string

volumeUsd*string

liquidityUsd*string

timestampSeconds*integer

startTimestampSeconds*integer

Request

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

Response

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

GET/pools/conversionRates/latest/{poolId}

Path parameters

poolId*integer

Pool ID

Query parameters

Response

Successful response

Body

id*integer

poolId*integer

open*number

high*number

low*number

close*number

avg*number

volume*string

liquidity*string

volumeUsd*string

liquidityUsd*string

timestampSeconds*integer

startTimestampSeconds*integer

Request

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

Response

{
  "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
}

SaucerSwap V2

Get compact data for all SaucerSwap V2 pools

GET/v2/pools

Response

Successful response

Body

id*integer

contractId*string

tokenA*TokenACompact (all of)

tokenB*TokenBCompact (all of)

amountA*string

Total amount for token A

amountB*string

Total amount for token B

fee*integer

Swap fee tier for the pool, denoted in basis points

sqrtRatioX96*string

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

tickCurrent*integer

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

liquidity*string

Total liquidity for the pool

Request

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

Response

[
  {
    "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",
    "liquidity": "10878982596"
  }
]

Get detailed data for all SaucerSwap V2 pools

GET/v2/pools/full

Response

Successful response

Body

id*integer

contractId*string

tokenA*TokenA (all of)

tokenB*TokenB (all of)

amountA*string

Total amount for token A

amountB*string

Total amount for token B

fee*integer

Swap fee tier for the pool, denoted in basis points

sqrtRatioX96*string

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

tickCurrent*integer

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

liquidity*string

Total liquidity for the pool

Request

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

Response

[
  {
    "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",
    "liquidity": "10878982596"
  }
]

Get detailed data for a SaucerSwap V2 pool by id

GET/v2/pools/{poolId}

Path parameters

poolId*integer

Response

Successful response

Body

id*integer

contractId*string

tokenA*TokenA (all of)

tokenB*TokenB (all of)

amountA*string

Total amount for token A

amountB*string

Total amount for token B

fee*integer

Swap fee tier for the pool, denoted in basis points

sqrtRatioX96*string

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

tickCurrent*integer

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

liquidity*string

Total liquidity for the pool

Request

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

Response

{
  "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",
  "liquidity": "10878982596"
}

Get all liquidity positions by account id

GET/v2/nfts/{accountId}/positions

Path parameters

accountId*string

Hedera account id

Response

Successful response

Body

tokenSN*integer

NFT serial number representing user's position

accountId*string

Hedera account id

deleted*boolean

True if this position was deleted otherwise false

createdAt*string

Unix timestamp when this position was created

updatedAt*string

Unix timestamp when this position was updated

token0*Token (object)

token1*Token (object)

fee*integer

Swap fee tier denoted in basis points

tickUpper*integer

Upper end of the position's price range

tickLower*integer

Lower end of the position's price range

liquidity*string

The amount of liquidity provided by the position

feeGrowthInside0LastX128*string

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

feeGrowthInside1LastX128*string

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

tokensOwed0*string

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

tokensOwed1*string

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

Request

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

Response

[
  {
    "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"
    },
    "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"
    },
    "fee": 3000,
    "tickUpper": -1620,
    "tickLower": -2820,
    "liquidity": "3249809842",
    "feeGrowthInside0LastX128": "2546890053379859378523505791149585",
    "feeGrowthInside1LastX128": "1232345435623984092384092380932840",
    "tokensOwed0": "10",
    "tokensOwed1": "20"
  }
]

PreviousDeveloper Resources NextSaucerSwap V1

Last updated 3 months ago