Positions

Decrease liquidity

post

Decrease liquidity

Removes liquidity from an existing position. Returns transaction for user to sign.

Body

application/json

amm_config_indexinteger · int32Required

AMM configuration index

Example: 6

liquidityintegerRequired

Liquidity amount

Example: 0

mint0stringRequired

First pool token address

Example: ATLASXmbPQxBUYbxPsV97usA3fPQYEqzQBUHgiFCUsXx

mint1stringRequired

Second pool token address

Example: Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB

slippage_bpsinteger · int64Required

Slippage in basis points

Example: 50

tick_lower_indexinteger · int32Required

Lower tick index

Example: -112059

tick_upper_indexinteger · int32Required

Upper tick index

Example: -109986

user_walletstringRequired

User wallet address

Example: EQdJjaPwUL6X3GjUp3ZQ1T3QA4XL9g9v3Z6rSUMGALMt

Responses

200

Decrease liquidity

application/json

400

Bad request. (personal position not exist)

application/json

500

Internal server error.

post

/api/decrease_liquidity/

HTTPcURLJavaScriptPython

POST /internal-api/neptune/api/decrease_liquidity/ HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 279

{
  "amm_config_index": 6,
  "liquidity": 0,
  "mint0": "ATLASXmbPQxBUYbxPsV97usA3fPQYEqzQBUHgiFCUsXx",
  "mint1": "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB",
  "slippage_bps": 50,
  "tick_lower_index": -112059,
  "tick_upper_index": -109986,
  "user_wallet": "EQdJjaPwUL6X3GjUp3ZQ1T3QA4XL9g9v3Z6rSUMGALMt"
}

{
  "result": {
    "amount_0": 1,
    "amount_1": 1,
    "liquidity": 1,
    "mint0": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "mint1": "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB",
    "tick_lower_index": 1,
    "tick_upper_index": 1,
    "transaction": "AAABAYui1UgtJHZBScK5yyV3MFlkebqQax1WtFUSMla/fc/sRbfP2zsXzPb65RtKOoylvJknEyPiPWh3PTG7IaxVpsMG+TucnHHBklH++x2lN8hIAgAAAQDB/lVjVn9HGyT5DXUmfXkxopXxXsTP89cx0jz2UbjAzQAAAAA=",
    "transfer_fee_0": 1,
    "transfer_fee_1": 1
  },
  "status": "success"
}

Decrease liquidity for multiple positions

post

Decrease liquidity for multiple positions

Removes liquidity from multiple positions in a single batch operation. Returns transaction for user to sign.

Body

application/json

Responses

200

Decrease liquidity multiple

application/json

400

Bad request. (personal position not exist)

application/json

500

Internal server error.

post

/api/decrease_liquidity_multiple/

HTTPcURLJavaScriptPython

POST /internal-api/neptune/api/decrease_liquidity_multiple/ HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 294

{
  "requests": [
    {
      "amm_config_index": 6,
      "liquidity": 0,
      "mint0": "ATLASXmbPQxBUYbxPsV97usA3fPQYEqzQBUHgiFCUsXx",
      "mint1": "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB",
      "slippage_bps": 50,
      "tick_lower_index": -112059,
      "tick_upper_index": -109986,
      "user_wallet": "EQdJjaPwUL6X3GjUp3ZQ1T3QA4XL9g9v3Z6rSUMGALMt"
    }
  ]
}

{
  "result": {
    "data": [
      {
        "amount_0": 1,
        "amount_1": 1,
        "liquidity": 1,
        "mint0": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
        "mint1": "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB",
        "tick_lower_index": 1,
        "tick_upper_index": 1,
        "transaction": "AAABAYui1UgtJHZBScK5yyV3MFlkebqQax1WtFUSMla/fc/sRbfP2zsXzPb65RtKOoylvJknEyPiPWh3PTG7IaxVpsMG+TucnHHBklH++x2lN8hIAgAAAQDB/lVjVn9HGyT5DXUmfXkxopXxXsTP89cx0jz2UbjAzQAAAAA=",
        "transfer_fee_0": 1,
        "transfer_fee_1": 1
      }
    ],
    "ixs_count": [
      1
    ],
    "transactions": [
      "text"
    ]
  },
  "status": "success"
}

Increase liquidity

post

Increase liquidity

Adds more liquidity to an existing position. Returns transaction for user to sign.

Body

application/json

amm_config_indexinteger · int32Required

AMM configuration index

Example: 6

input_amountinteger · int64Required

Input token amount

Example: 100

is_base_0booleanRequired

Whether token 0 is the base token

mint0stringRequired

First pool token address

Example: ATLASXmbPQxBUYbxPsV97usA3fPQYEqzQBUHgiFCUsXx

mint1stringRequired

Second pool token address

Example: Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB

slippage_bpsinteger · int64Required

Slippage in basis points

Example: 50

tick_lower_indexinteger · int32Required

Lower tick index

Example: -112059

tick_upper_indexinteger · int32Required

Upper tick index

Example: -109986

user_walletstringRequired

User wallet address

Example: EQdJjaPwUL6X3GjUp3ZQ1T3QA4XL9g9v3Z6rSUMGALMt

Responses

200

Increase liquidity

application/json

400

Bad request. (personal position not exist)

application/json

500

Internal server error.

post

/api/increase_liquidity/

HTTPcURLJavaScriptPython

POST /internal-api/neptune/api/increase_liquidity/ HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 301

{
  "amm_config_index": 6,
  "input_amount": 100,
  "is_base_0": true,
  "mint0": "ATLASXmbPQxBUYbxPsV97usA3fPQYEqzQBUHgiFCUsXx",
  "mint1": "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB",
  "slippage_bps": 50,
  "tick_lower_index": -112059,
  "tick_upper_index": -109986,
  "user_wallet": "EQdJjaPwUL6X3GjUp3ZQ1T3QA4XL9g9v3Z6rSUMGALMt"
}

{
  "result": {
    "amount_0": 1,
    "amount_1": 1,
    "liquidity": 1,
    "mint0": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "mint1": "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB",
    "tick_lower_index": 1,
    "tick_upper_index": 1,
    "transaction": "AAABAYui1UgtJHZBScK5yyV3MFlkebqQax1WtFUSMla/fc/sRbfP2zsXzPb65RtKOoylvJknEyPiPWh3PTG7IaxVpsMG+TucnHHBklH++x2lN8hIAgAAAQDB/lVjVn9HGyT5DXUmfXkxopXxXsTP89cx0jz2UbjAzQAAAAA=",
    "transfer_fee_0": 1,
    "transfer_fee_1": 1
  },
  "status": "success"
}

Open liquidity position

post

Open liquidity position

Opens a new liquidity position in a pool within specified tick range. Returns transaction for user to sign.

Body

application/json

amm_config_indexinteger · int32Required

AMM configuration index

Example: 3

input_amountinteger · int64Required

Input token amount

Example: 1

is_base_0booleanRequired

Whether token 0 is the base token

mint0stringRequired

First pool token address

Example: EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v

mint1stringRequired

Second pool token address

Example: Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB

slippage_bpsinteger · int64Required

Slippage in basis points

Example: 50

tick_lower_pricenumber · doubleRequired

Lower price boundary

Example: 0.8

tick_upper_pricenumber · doubleRequired

Upper price boundary

Example: 1.2

user_walletstringRequired

User wallet address

Example: EQdJjaPwUL6X3GjUp3ZQ1T3QA4XL9g9v3Z6rSUMGALMt

with_metadatabooleanRequired

Whether to include metadata

Responses

200

Open position

application/json

400

Bad request. (personal position already exist)

application/json

500

Internal server error.

post

/api/open_position/

HTTPcURLJavaScriptPython

POST /internal-api/neptune/api/open_position/ HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 312

{
  "amm_config_index": 3,
  "input_amount": 1,
  "is_base_0": true,
  "mint0": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
  "mint1": "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB",
  "slippage_bps": 50,
  "tick_lower_price": 0.8,
  "tick_upper_price": 1.2,
  "user_wallet": "EQdJjaPwUL6X3GjUp3ZQ1T3QA4XL9g9v3Z6rSUMGALMt",
  "with_metadata": true
}

{
  "result": {
    "amount_0": 1,
    "amount_1": 1,
    "liquidity": 1,
    "mint0": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "mint1": "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB",
    "tick_lower_index": 1,
    "tick_upper_index": 1,
    "transaction": "AAABAYui1UgtJHZBScK5yyV3MFlkebqQax1WtFUSMla/fc/sRbfP2zsXzPb65RtKOoylvJknEyPiPWh3PTG7IaxVpsMG+TucnHHBklH++x2lN8hIAgAAAQDB/lVjVn9HGyT5DXUmfXkxopXxXsTP89cx0jz2UbjAzQAAAAA=",
    "transfer_fee_0": 1,
    "transfer_fee_1": 1
  },
  "status": "success"
}

Get positions by owner

get

Get positions by owner

Returns all liquidity positions owned by the specified wallet address.

Path parameters

user_walletstringRequiredExample: EQdJjaPwUL6X3GjUp3ZQ1T3QA4XL9g9v3Z6rSUMGALMt

Responses

200

PPosition by owner

application/json

400

Bad request. (invalid pubkey)

application/json

500

Internal server error.

get

/api/pposition_by_owner/{user_wallet}/

HTTPcURLJavaScriptPython

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

{
  "result": {
    "positions": [
      {
        "data": {
          "bump": "binary",
          "fee_growth_inside_0_last_x64": 1,
          "fee_growth_inside_1_last_x64": 1,
          "liquidity": 1,
          "nft_mint": "adMCyoCgfkg7bQiJ9aBJ59H3BXLY3r5LNLfPpQfMzBe",
          "padding": [
            1
          ],
          "pool_id": "adMCyoCgfkg7bQiJ9aBJ59H3BXLY3r5LNLfPpQfMzBe",
          "recent_epoch": 1,
          "reward_infos": [
            {
              "growth_inside_last_x64": 1,
              "reward_amount_owed": 1
            }
          ],
          "tick_lower_index": 1,
          "tick_upper_index": 1,
          "token_fees_owed_0": 1,
          "token_fees_owed_1": 1
        },
        "harvest_data": {
          "token_fees_owed_0": 1,
          "token_fees_owed_1": 1
        },
        "key": "adMCyoCgfkg7bQiJ9aBJ59H3BXLY3r5LNLfPpQfMzBe"
      }
    ]
  },
  "status": "success"
}