Vessel Finance API
  1. Exchange Data
Vessel Finance API
  • Introduction
  • General Info
  • HMAC Signature Guide
  • Poseidon Signature Guide
  • Internal Transfer Signature Guide
  • Error Code
  • Vessel REST API
    • Public
      • Market Data
        • 24hr Ticker Statistics
        • Kline / Candlestick Data
        • Order Book
        • Recent Trades List
        • Average Price
        • AMM Pool Last 24h Data
      • Exchange Data
        • Ticker Info
          GET
        • Asset Info
          GET
        • Trade Fee
          GET
        • AMM Pool Info
          GET
    • User
      • Asset
        • User Asset
        • Withdraw
        • Withdraw History
        • Deposit History
        • Claim History
        • Internal Transfer (Send)
        • Internal Transfer History
      • Order
        • Place Order
        • Cancel Order
        • Open Orders
        • Completed Orders
        • All Orders
        • Query Order
        • Modify Order
      • AMM
        • Add Liquidity
        • Remove Liquidity
        • Collect Fee
        • AMM Position
        • AMM Action History
      • Account
        • User Profile
        • User Trade List
  • Vessel WebSocket
    • Market
      • Order Book
      • K Line
      • Recent Trades
      • 24hr Ticker Statistics
      • Ticker Setting Upade
    • User
      • Authorize
      • Balance
      • Account
  1. Exchange Data

AMM Pool Info

Testnet Env
https://testnet.trade.vessel.finance
Testnet Env
https://testnet.trade.vessel.finance
GET
/api/v1/gateway/public/pool/detail
Last modified:2024-10-28 04:01:00
AMM Pool Info provides information concerning Automated Market Maker (AMM) pools.

Request

Header Params
VESSEL-API-KEY
string 
required
Default:
{{API_KEY}}
VESSEL-PASSPHRASE
string 
required
Default:
{{API_PASSPHRASE}}
VESSEL-SIGNATURE
string 
required
Use signRequest script to generate
VESSEL-TIMESTAMP
string 
required
Use signRequest script to set

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://testnet.trade.vessel.finance/api/v1/gateway/public/pool/detail' \
--header 'VESSEL-API-KEY;' \
--header 'VESSEL-PASSPHRASE;' \
--header 'VESSEL-SIGNATURE;' \
--header 'VESSEL-TIMESTAMP;'

Responses

🟢200OK
application/json
Body
pools
array [object {8}] 
required
Contains information regarding the AMM pools matching the provided query parameters (if any) or all available pools (if no parameters are provided).
poolId
string 
required
Unique identifier of the AMM pool.
symbol
string 
required
Trading symbol associated with the AMM pool.
minTick
string 
required
Minimum allowable price for liquidity provision in a pool.
maxTick
string 
required
Maximum allowable price for liquidity provision in a pool.
tickSpacing
string 
required
Interval between tick values for the AMM pool.
maxPositionSize
string 
required
Maximum permissible number of liquidity provider positions within the AMM pool.
operatorFeeRate
string 
required
Percentage of fees allocated to the pool operator.
priceRange
string 
required
Example
{
  "pools": [
    {
      "poolId": "1",
      "symbol": "WBTCUSDC",
      "minTick": "300",
      "maxTick": "600000",
      "tickSpacing": "10",
      "maxPositionSize": "20",
      "operatorFeeRate": "10",
      "priceRange": "0.05,0.1,0.25,0.5"
    },
    {
      "poolId": "2",
      "symbol": "WBTCUSDT",
      "minTick": "200",
      "maxTick": "600000",
      "tickSpacing": "10",
      "maxPositionSize": "20",
      "operatorFeeRate": "9",
      "priceRange": "0.05,0.1,0.25,0.5"
    }
  ]
}
Previous
Trade Fee
Next
User
Built with