Collect Fee

Testnet Env

https://testnet.trade.vessel.finance

POST

/api/v1/amm/collectFee

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

Collect Fee allows users to collect fees from their positions within an Automated Market Maker (AMM) pool. Users must provide the pool ID, price tick range, and nonce for authentication. Upon successful execution, the API returns the amounts of base and quote assets collected as fees from the position.

Request

Header Params

VESSEL-TIMESTAMP

integer

required

VESSEL-API-KEY

string

required

Default:

VESSEL-PASSPHRASE

string

required

Default:

VESSEL-SIGNATURE

string

required

Use signRequest script to generate

Body Params application/json

poolId

string

required

The unique identifier of the AMM pool.

tickIndexL

string

required

The minimum price tick index

tickIndexR

string

required

The maximum price tick index.

nonce

string

required

A unique identifier for the request, typically a Unix timestamp indicating the time at which the request was made. It helps prevent replay attacks by ensuring that each request is unique.

signature

string

required

The cryptographic signature generated using the Poseidon algorithm. Refer to the Poseidon Signature Guide for details on generating the signature.

Example

{
    "poolId": 0,
    "tickIndexL": 0,
    "tickIndexR": 0,
    "baseAmount": 0,
    "quoteAmount": 0,
    "nonce": "string",
    "signature": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://testnet.trade.vessel.finance/api/v1/amm/collectFee' \
--header 'VESSEL-TIMESTAMP;' \
--header 'VESSEL-TIMESTAMP;' \
--header 'VESSEL-API-KEY;' \
--header 'VESSEL-PASSPHRASE;' \
--header 'VESSEL-SIGNATURE;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "poolId": 0,
    "tickIndexL": 0,
    "tickIndexR": 0,
    "baseAmount": 0,
    "quoteAmount": 0,
    "nonce": "string",
    "signature": "string"
}'

Responses

🟢200OK

application/json

Body

baseAssetAmount

string

required

The fee collected from the position in terms of base asset.

quoteAssetAmount

string

required

The fee collected from the position in terms of quote asset.

Examples

SuccessException

{
    "baseAssetAmount": "0.1",
    "quoteAssetAmount": "100.23"
}

Modified at 2024-10-15 06:23:56

Remove Liquidity

AMM Position