Users

Get user positions by public key

get

Retrieves all positions associated with a user's public key.

Path parameters

pubkeystring · min: 64 · max: 66required

• The user's public key in hexadecimal format.
• Type: string
• Description: The public key identifying the user whose positions are being requested.
• Example: '02a1633caf...e4613f0f0f'

Pattern: ^[0-9a-fA-F]+$

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://indexer-dev.saturnbtc.io/v0/user/positions/{pubkey}'

200

500

200

[
  {
    "poolStats": {
      "id": "text",
      "tvl_now": "text",
      "tvl_24h_ago": "text",
      "tvl_diff": "text",
      "volume_24h": "text",
      "volume_diff_24h": "text",
      "fees_24h": "text",
      "apy_24h": "text",
      "apy": "text",
      "volume_7d": "text",
      "fees_7d": "text",
      "apy_7d": "text",
      "price": "text",
      "token0Amount": "text",
      "token1Amount": "text",
      "token0": {
        "id": "text",
        "name": "text",
        "displayName": "text",
        "symbol": "text",
        "tradeable": true,
        "verified": true,
        "icon": null,
        "priority": 1,
        "type": null,
        "divisibility": 1,
        "supply": "text",
        "batchSize": "text",
        "transactionId": "text",
        "createdAt": "text"
      },
      "token1": {
        "id": "text",
        "name": "text",
        "displayName": "text",
        "symbol": "text",
        "tradeable": true,
        "verified": true,
        "icon": null,
        "priority": 1,
        "type": null,
        "divisibility": 1,
        "supply": "text",
        "batchSize": "text",
        "transactionId": "text",
        "createdAt": "text"
      },
      "liquidity": "text",
      "fee_rate": 1
    },
    "estimatedYield": "text",
    "id": "text",
    "pool_pubkey": "text",
    "owner": "text",
    "liquidity": "text"
  }
]

An array of positions with estimated yields, serialized with BigInt values.

• Type: PositionResult[]
• Description: An array of the user's positions, each including detailed statistics and estimated yield.

Get a user's position by public key and pool ID

get

Retrieves a specific position for a user by public key and pool ID.

Path parameters

pubkeystring · min: 64 · max: 66required

• The user's public key in hexadecimal format.
• Type: string
• Description: The public key identifying the user.
• Example: '02a1633caf...e4613f0f0f'

Pattern: ^[0-9a-fA-F]+$

poolIdstring · min: 64 · max: 66required

• The unique identifier of the liquidity pool.
• Type: string
• Description: The ID of the liquidity pool for which the user's position is requested.
• Example: '02a1633caf...e4613f0f0f'

Pattern: ^[0-9a-fA-F]+$

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://indexer-dev.saturnbtc.io/v0/user/position/{pubkey}/{poolId}'

200

404

500

200

{
  "poolStats": {
    "id": "text",
    "tvl_now": "text",
    "tvl_24h_ago": "text",
    "tvl_diff": "text",
    "volume_24h": "text",
    "volume_diff_24h": "text",
    "fees_24h": "text",
    "apy_24h": "text",
    "apy": "text",
    "volume_7d": "text",
    "fees_7d": "text",
    "apy_7d": "text",
    "price": "text",
    "token0Amount": "text",
    "token1Amount": "text",
    "token0": {
      "id": "text",
      "name": "text",
      "displayName": "text",
      "symbol": "text",
      "tradeable": true,
      "verified": true,
      "icon": null,
      "priority": 1,
      "type": null,
      "divisibility": 1,
      "supply": "text",
      "batchSize": "text",
      "transactionId": "text",
      "createdAt": "text"
    },
    "token1": {
      "id": "text",
      "name": "text",
      "displayName": "text",
      "symbol": "text",
      "tradeable": true,
      "verified": true,
      "icon": null,
      "priority": 1,
      "type": null,
      "divisibility": 1,
      "supply": "text",
      "batchSize": "text",
      "transactionId": "text",
      "createdAt": "text"
    },
    "liquidity": "text",
    "fee_rate": 1
  },
  "estimatedYield": "text",
  "id": "text",
  "pool_pubkey": "text",
  "owner": "text",
  "liquidity": "text"
}

The position with estimated yield, serialized with BigInt values.

• Type: SerializeBigInt<PositionResult>
• Description: The user's position in the specified pool, including detailed statistics and estimated yield.

Get user positions by public key and filter

post

Retrieves positions associated with a user's public key based on a filter.

Path parameters

pubkeystring · min: 64 · max: 66required

• The user's public key in hexadecimal format.

Pattern: ^[0-9a-fA-F]+$

Body

namestring[]required

An array of token names to filter positions.

minLiquiditystringrequired

The minimum liquidity to filter positions.

sortobject[]required

An array of sorting fields and directions.

limitinteger · min: 1 · max: 100optional

offsetintegerrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://indexer-dev.saturnbtc.io/v0/user/positions/{pubkey}/by-filter' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": [
      "text"
    ],
    "minLiquidity": "text",
    "sort": [
      {
        "field": null,
        "order": null
      }
    ],
    "limit": 1,
    "offset": 1
  }'

200

200

{
  "response": [
    {
      "poolStats": {
        "id": "text",
        "tvl_now": "text",
        "tvl_24h_ago": "text",
        "tvl_diff": "text",
        "volume_24h": "text",
        "volume_diff_24h": "text",
        "fees_24h": "text",
        "apy_24h": "text",
        "apy": "text",
        "volume_7d": "text",
        "fees_7d": "text",
        "apy_7d": "text",
        "price": "text",
        "token0Amount": "text",
        "token1Amount": "text",
        "token0": {
          "id": "text",
          "name": "text",
          "displayName": "text",
          "symbol": "text",
          "tradeable": true,
          "verified": true,
          "icon": null,
          "priority": 1,
          "type": null,
          "divisibility": 1,
          "supply": "text",
          "batchSize": "text",
          "transactionId": "text",
          "createdAt": "text"
        },
        "token1": {
          "id": "text",
          "name": "text",
          "displayName": "text",
          "symbol": "text",
          "tradeable": true,
          "verified": true,
          "icon": null,
          "priority": 1,
          "type": null,
          "divisibility": 1,
          "supply": "text",
          "batchSize": "text",
          "transactionId": "text",
          "createdAt": "text"
        },
        "liquidity": "text",
        "fee_rate": 1
      },
      "estimatedYield": "text",
      "id": "text",
      "pool_pubkey": "text",
      "owner": "text",
      "liquidity": "text"
    }
  ],
  "offset": 1
}

A paginated response containing an array of positions, serialized with BigInt values.