REST API: V2 liquidity positions by account

Get all liquidity positions by account id

curl --request GET \
  --url https://api.saucerswap.finance/v2/nfts/{accountId}/positions \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.saucerswap.finance/v2/nfts/{accountId}/positions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "tokenSN": 160,
    "accountId": "0.0.12345",
    "deleted": false,
    "createdAt": "1697779560.762467685",
    "updatedAt": "1698287867.747005303",
    "token0": {
      "decimals": 8,
      "icon": "/images/tokens/hbar.png",
      "id": "0.0.1456986",
      "name": "WHBAR [new]",
      "price": "100000000",
      "priceUsd": 0.0598982,
      "symbol": "HBAR",
      "dueDiligenceComplete": true,
      "isFeeOnTransferToken": false,
      "description": "Hedera is a public, open source, proof-of-stake network, with native cryptocurrency HBAR...",
      "website": "https://hedera.com/",
      "twitterHandle": "hedera"
    },
    "token1": {
      "decimals": 6,
      "icon": "/images/tokens/sauce.png",
      "id": "0.0.731861",
      "name": "SAUCE",
      "price": "24609831",
      "priceUsd": 0.0147408436767304,
      "symbol": "SAUCE",
      "dueDiligenceComplete": true,
      "isFeeOnTransferToken": false,
      "description": "SaucerSwap is an open source and non-custodial AMM protocol native to Hedera...",
      "website": "https://www.saucerswap.finance/",
      "twitterHandle": "SaucerSwapLabs"
    },
    "fee": 3000,
    "tickUpper": -1620,
    "tickLower": -2820,
    "liquidity": "3249809842",
    "feeGrowthInside0LastX128": "2546890053379859378523505791149585",
    "feeGrowthInside1LastX128": "1232345435623984092384092380932840",
    "tokensOwed0": "10",
    "tokensOwed1": "20"
  }
]

GET

nfts

{accountId}

positions

Get all liquidity positions by account id

curl --request GET \
  --url https://api.saucerswap.finance/v2/nfts/{accountId}/positions \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.saucerswap.finance/v2/nfts/{accountId}/positions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "tokenSN": 160,
    "accountId": "0.0.12345",
    "deleted": false,
    "createdAt": "1697779560.762467685",
    "updatedAt": "1698287867.747005303",
    "token0": {
      "decimals": 8,
      "icon": "/images/tokens/hbar.png",
      "id": "0.0.1456986",
      "name": "WHBAR [new]",
      "price": "100000000",
      "priceUsd": 0.0598982,
      "symbol": "HBAR",
      "dueDiligenceComplete": true,
      "isFeeOnTransferToken": false,
      "description": "Hedera is a public, open source, proof-of-stake network, with native cryptocurrency HBAR...",
      "website": "https://hedera.com/",
      "twitterHandle": "hedera"
    },
    "token1": {
      "decimals": 6,
      "icon": "/images/tokens/sauce.png",
      "id": "0.0.731861",
      "name": "SAUCE",
      "price": "24609831",
      "priceUsd": 0.0147408436767304,
      "symbol": "SAUCE",
      "dueDiligenceComplete": true,
      "isFeeOnTransferToken": false,
      "description": "SaucerSwap is an open source and non-custodial AMM protocol native to Hedera...",
      "website": "https://www.saucerswap.finance/",
      "twitterHandle": "SaucerSwapLabs"
    },
    "fee": 3000,
    "tickUpper": -1620,
    "tickLower": -2820,
    "liquidity": "3249809842",
    "feeGrowthInside0LastX128": "2546890053379859378523505791149585",
    "feeGrowthInside1LastX128": "1232345435623984092384092380932840",
    "tokensOwed0": "10",
    "tokensOwed1": "20"
  }
]

Authorizations

x-api-key

string

header

required

API key provisioned by the SaucerSwap team. Request one from [email protected] and send it in the x-api-key header with every request.

Headers

x-api-key

string

required

API key for authentication. Request a key from [email protected].

Example:

"YOUR_API_KEY"

Path Parameters

accountId

string

required

Hedera account id (shard.realm.num)

Example:

"0.0.12345"

Response

200 - application/json

Successful response

tokenSN

integer

required

NFT serial number representing user's position

Example:

160

accountId

string

required

Hedera account id (shard.realm.num)

Example:

"0.0.12345"

deleted

boolean

required

True if this position was deleted otherwise false

Example:

false

createdAt

string

required

Unix timestamp when this position was created

Example:

"1697779560.762467685"

updatedAt

string

required

Unix timestamp when this position was updated

Example:

"1698287867.747005303"

token0

object

required

Show child attributes

Example:

{
  "decimals": 8,
  "icon": "/images/tokens/hbar.png",
  "id": "0.0.1456986",
  "name": "WHBAR [new]",
  "price": "100000000",
  "priceUsd": 0.0598982,
  "symbol": "HBAR",
  "dueDiligenceComplete": true,
  "isFeeOnTransferToken": false,
  "description": "Hedera is a public, open source, proof-of-stake network, with native cryptocurrency HBAR...",
  "website": "https://hedera.com/",
  "twitterHandle": "hedera"
}

token1

object

required

Show child attributes

Example:

{
  "decimals": 6,
  "icon": "/images/tokens/sauce.png",
  "id": "0.0.731861",
  "name": "SAUCE",
  "price": "24609831",
  "priceUsd": 0.0147408436767304,
  "symbol": "SAUCE",
  "dueDiligenceComplete": true,
  "isFeeOnTransferToken": false,
  "description": "SaucerSwap is an open source and non-custodial AMM protocol native to Hedera...",
  "website": "https://www.saucerswap.finance/",
  "twitterHandle": "SaucerSwapLabs"
}

fee

integer

required

Fee tier in hundredths of a basis point. Divide by 100 for basis points or by 10,000 for percent; for example, 3000 = 30 bps = 0.30%.

Example:

3000

tickUpper

integer

required

Upper end of the position's price range

Example:

-1620

tickLower

integer

required

Lower end of the position's price range

Example:

-2820

liquidity

string

required

The amount of liquidity provided by the position

Example:

"3249809842"

feeGrowthInside0LastX128

string

required

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

Example:

"2546890053379859378523505791149585"

feeGrowthInside1LastX128

string

required

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

Example:

"1232345435623984092384092380932840"

tokensOwed0

string

required

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

Example:

"10"

tokensOwed1

string

required

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

Example:

"20"

REST API: V2 pool price history (candlesticks)REST API: LARI rewards by account

⌘I

Getting started

REST API

Orderbook API

REST API: V2 liquidity positions by account

Authorizations

Headers

Path Parameters

Response