Vessel Finance API
  1. Market 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
          GET
        • Kline / Candlestick Data
          GET
        • Order Book
          GET
        • Recent Trades List
          GET
        • Average Price
          GET
        • AMM Pool Last 24h Data
          GET
      • Exchange Data
        • Ticker Info
        • Asset Info
        • Trade Fee
        • AMM Pool Info
    • 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. Market Data

AMM Pool Last 24h Data

Testnet Env
https://testnet.trade.vessel.finance
Testnet Env
https://testnet.trade.vessel.finance
GET
/api/v1/gateway/public/pool
Last modified:2024-10-28 03:58:59
AMM Pool Detailed Data provides the data about Automated Market Maker (AMM) pools, including their configuration parameters and liquidity.

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' \
--header 'VESSEL-API-KEY;' \
--header 'VESSEL-PASSPHRASE;' \
--header 'VESSEL-SIGNATURE;' \
--header 'VESSEL-TIMESTAMP;'

Responses

🟢200OK
application/json
Body
updatedTime
string 
required
The updated time (UTC) of the response data.
pools
array [object {14}] 
required
The information of pools.
poolId
string 
required
The unique identifier of the AMM pool.
baseTokenAddress
string 
required
The onchain address of base asset.
quoteTokenAddress
string 
required
The onchain address of quote asset.
baseTokenName
string 
required
The base asset name of the pool.
quoteTokenName
string 
required
The quote asset name of the pool.
tickSpacing
string 
required
The spacing between ticks in the pool.
baseTvl
string 
required
The locked amount of the base asset in the AMM pool.
quoteTvl
string 
required
The locked amount of the quote asset in the AMM pool.
baseTvlValue
string 
required
The locked USD value of the base asset in the pool.
quoteTvlValue
string 
required
The locked USD value of the quote asset in the pool.
feeValue24h
string 
required
The USD value generated in the pool last 24 hours.
tradeVolume24h
string 
required
The trading volume of the pool last 24 hours.
apr
string 
required
The estimated APR is the average APR over the last 24 hours’ fees and TVL. The actual APR may vary.
boost
null 
required
The boost weight in Vessel Voyage.
Example
{
  "updatedTime": "2024-10-12T08:11:06Z",
  "pools": [
    {
      "poolId": "1",
      "baseTokenAddress": "0x115d7113e5df03fd95242ab0183d343ff1ed13b3",
      "quoteTokenAddress": "0xc45c896946a5a182ad2ee3f0806a22bb92abc699",
      "baseTokenName": "WBTC",
      "quoteTokenName": "USDC",
      "tickSpacing": "10",
      "baseTvl": "3.0834",
      "quoteTvl": "77728.77",
      "baseTvlValue": "170080.3439999993",
      "quoteTvlValue": "77728.77",
      "feeValue24h": "119.213232",
      "tradeVolume24h": "66229.326",
      "apr": "0.7174747626",
      "boost": null
    },
    {
      "poolId": "2",
      "baseTokenAddress": "0x115d7113e5df03fd95242ab0183d343ff1ed13b3",
      "quoteTokenAddress": "0x46d8d2f5e81a5257e1c6b63933c49493c0042b26",
      "baseTokenName": "WBTC",
      "quoteTokenName": "USDT",
      "tickSpacing": "10",
      "baseTvl": "0.9189",
      "quoteTvl": "49035.042",
      "baseTvlValue": "50686.524",
      "quoteTvlValue": "49035.042",
      "feeValue24h": "0.10015824",
      "tradeVolume24h": "55.032",
      "apr": "0.4688695344",
      "boost": null
    }
  ]
}
Previous
Average Price
Next
Ticker Info
Built with