AMM Position

Testnet Env

https://testnet.trade.vessel.finance

GET

/api/v1/amm/user/positions

Last modified:2024-10-15 06:23:56

Request

Query Params

poolId

string

optional

The unique identifier of the AMM pool to query.

Header Params

VESSEL-API-KEY

string

required

Default:

VESSEL-PASSPHRASE

string

required

Default:

VESSEL-SIGNATURE

string

required

Use signRequest script to generate

VESSEL-TIMESTAMP

string

required

Use signRequest script to set

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://testnet.trade.vessel.finance/api/v1/amm/user/positions?poolId' \
--header 'VESSEL-API-KEY;' \
--header 'VESSEL-PASSPHRASE;' \
--header 'VESSEL-SIGNATURE;' \
--header 'VESSEL-TIMESTAMP;'

Responses

🟢200OK

application/json

Body

positions

array [object {8}]

required

poolId

string

optional

Unique identifier for the liquidity pool

symbolId

string

optional

Identifier for the trading pair symbol

tickR

string

optional

Upper tick boundary of the position

tickL

string

optional

Lower tick boundary of the position

baseAmount

string

optional

Amount of base asset in the position

quoteAmount

string

optional

Amount of quote asset in the position

baseFeeAmount

string

optional

Amount of base asset collected as fees

quoteFeeAmount

string

optional

Amount of quote asset collected as fees

Examples

SuccessException

{
  "positions": [
    {
      "poolId": "2",
      "symbolId": "5",
      "tickR": "210",
      "tickL": "200",
      "baseAmount": "0",
      "quoteAmount": "0.1",
      "baseFeeAmount": "0",
      "quoteFeeAmount": "0"
    }
  ]
}

Collect Fee

AMM Action History