Liquidity

Get user liquidity balance

get

Retrieves comprehensive liquidity balance and all positions for a specified wallet.

For each position returns: NFT mint address, pool ID and configuration, liquidity amount, token amounts, price range (ticks), fees earned (unclaimed), rewards, and position status (in/out of range).

Aggregated data: total value across all positions (USD if available), total fees earned, number of active positions, positions grouped by pool.

Use cases: portfolio overview and analytics, calculate total liquidity provided, track earnings from all positions, monitor position health across multiple pools.

Path parameters

user_walletstringRequiredExample: EQdJjaPwUL6X3GjUp3ZQ1T3QA4XL9g9v3Z6rSUMGALMt

Responses

200

Successful Response

application/json

statusstring · enumRequiredPossible values:

resultanyRequired

warningsstring[]Optional

Any warnings about the operations

400

Bad Request

application/json

422

Validation Error

application/json

get

/api/liquidity_balance/{user_wallet}/

HTTPcURLJavaScriptPython

GET /internal-api/neptune/api/liquidity_balance/{user_wallet}/ HTTP/1.1
Accept: */*

{
  "status": "success",
  "result": {
    "total_value_usd": 15320,
    "assets": [
      {
        "mint": {
          "chainId": 101,
          "address": "ATLASXmbPQxBUYbxPsV97usA3fPQYEqzQBUHgiFCUsXx",
          "symbol": "ATLAS",
          "name": "Star Atlas",
          "decimals": 8,
          "logoURI": "https://images.swap.io/?w=48&h=48&t=68747470733a2f2f7261772e67697468756275736572636f6e74656e742e636f6d2f736f6c616e612d6c6162732f746f6b656e2d6c6973742f6d61696e2f6173736574732f6d61696e6e65742f41544c4153586d6250517842555962785073563937757341336650515945717a5142554867694643557358782f6c6f676f2e706e67&hash=f4f78cd6eb52b8ffb3b1ee7e25e7921f",
          "tags": [
            "community",
            "strict",
            "verified"
          ],
          "extensions": {
            "coingeckoId": "star-atlas"
          }
        },
        "value_usd": 7320,
        "amount": 5000
      },
      {
        "mint": {
          "chainId": 101,
          "address": "FeorejFjRRAfusN9Fg3WjEZ1dRCf74o6xwT5vDt3R34J",
          "symbol": "FEORE",
          "name": "Iron Ore",
          "decimals": 0,
          "logoURI": "https://images.swap.io/?w=48&h=48&t=68747470733a2f2f73746f726167652e676f6f676c65617069732e636f6d2f6e66742d6173736574732f6974656d732f46454f52452e706e67&hash=d9672cc1e61e8c095f03c8bfedc88233",
          "tags": [
            "staratlas"
          ],
          "extensions": {}
        },
        "value_usd": 8000,
        "amount": 1000000
      }
    ]
  }
}

Convert liquidity to token amounts

post

Convert liquidity to token amounts

Calculates token amounts for a given liquidity value within specified tick range.

Body

application/json

amm_config_indexinteger · int32Required

AMM configuration index

Example: 3

liquidityintegerRequired

Liquidity amount

Example: 25000

mint0stringRequired

First pool token address

Example: EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v

mint1stringRequired

Second pool token address

Example: Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB

tick_lowerinteger · int32Required

Lower tick

Example: -100

tick_upperinteger · int32Required

Upper tick

Example: 100

Responses

200

Liquidity to amounts

application/json

statusstring · enumRequiredPossible values:

500

Internal server error.

post

/api/liquidity_to_amounts/

HTTPcURLJavaScriptPython

POST /internal-api/neptune/api/liquidity_to_amounts/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "amm_config_index": 3,
  "liquidity": 25000,
  "mint0": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
  "mint1": "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB",
  "tick_lower": -100,
  "tick_upper": 100
}

{
  "result": {
    "amount_0": 1,
    "amount_1": 1
  },
  "status": "success"
}

Convert liquidity to token amounts for multiple positions

post

Convert liquidity to token amounts for multiple positions

Calculates token amounts for multiple liquidity positions in batch.

Body

application/json

Responses

200

Liquidity to amounts multiple

application/json

statusstring · enumRequiredPossible values:

500

Internal server error.

post

/api/liquidity_to_amounts_multiple/

HTTPcURLJavaScriptPython

POST /internal-api/neptune/api/liquidity_to_amounts_multiple/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 200

{
  "requests": [
    {
      "amm_config_index": 3,
      "liquidity": 25000,
      "mint0": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "mint1": "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB",
      "tick_lower": -100,
      "tick_upper": 100
    }
  ]
}

{
  "result": {
    "data": [
      {
        "amount_0": 1,
        "amount_1": 1
      }
    ]
  },
  "status": "success"
}