Get DeFi Pool Overview

1. Overview & Typical Use

Returns the current overview metrics for a specific DeFi pool: token composition with liquidity, 24-hour volume, TVL, and a pool URL. Only pools on the platform whitelist are supported; invalid pools return an empty object ({}).

• Typical use: display a pool summary card with current TVL, volume, and token ratios.
• When not to use: to get historical TVL trends use “Get DeFi Pool TVL Change”; to list all pools use “Get DeFi Pool Info”.

2. Endpoint & Authentication

GET /api/stableCoin/pool/overview

For Base URL and authentication, see Common Network & Authentication.

3. Request

curl -s 'https://apilist.tronscanapi.com/api/stableCoin/pool/overview?pool=TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE' \
  -H 'TRON-PRO-API-KEY: <your-key>'

4. Response

{
  "tokens": [
    {
      "tokenId": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
      "tokenAbbr": "USDT",
      "tokenName": "Tether USD",
      "tokenDecimal": 6,
      "tokenType": "trc20",
      "vip": true,
      "issuerAddr": "THPvaUhoh2Qn2y9THCZML3H815hhFhn5YC",
      "tokenLogo": "https://static.tronscan.org/production/logo/usdtlogo.png",
      "tokenLevel": "2",
      "tokenCanShow": 1,
      "liquidity": "62500000000000",
      "liquidityPercent": "0.5"
    }
  ],
  "volume24Hours": "12500000.00",
  "tvl": "125000000.50",
  "poolUrl": "https://sun.io/#/3pool"
}

5. Errors

For HTTP status codes, see Common Errors. Key points for this endpoint:

• Invalid or non-whitelisted pool address returns an empty object {}.