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
Fields
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pool | string | Yes | — | Pool contract address (must be a platform whitelist pool) |
4. Response
Fields
Top-level
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
tokens | array | Required | Token list with current liquidity | — |
volume24Hours | string | Required | 24-hour trading volume in USD | USD |
tvl | string | Required | Current total value locked in USD | USD |
poolUrl | string | Required | Pool page URL | — |
tokens[] element
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
tokenId | string | Required | Token contract address | — |
tokenAbbr | string | Required | Token abbreviation | — |
tokenName | string | Required | Token name | — |
tokenDecimal | integer | Required | Token decimal precision | — |
tokenType | string | Required | Token standard (e.g., trc20) | — |
vip | boolean | Required | Whether the token is VIP-tagged | — |
issuerAddr | string | Optional | Token issuer address | — |
tokenLogo | string | Optional | Token logo URL | — |
tokenLevel | string | Optional | Token level: 0 (UNKNOWN), 1 (NEUTRAL), 2 (OK), 3 (SUSPICIOUS), 4 (UNSAFE) | — |
tokenCanShow | integer | Optional | Display flag: 1 = show | — |
liquidity | string | Required | Current token liquidity (minimum unit) | minimum unit (divide by 10^tokenDecimal) |
liquidityPercent | string | Required | Token’s share of pool TVL | decimal |
5. Errors
For HTTP status codes, see Common Errors. Key points for this endpoint:
- Invalid or non-whitelisted pool address returns an empty object
{}.
Last updated on: