Get Stablecoin Liquidity Pool Distribution
1. Overview & Typical Use
Returns all liquidity pools containing a specified stablecoin (SunSwap v1/v2, SunCurve), including TVL and token composition.
- Typical use: viewing liquidity distribution of a stablecoin across DEXes.
- When not to use: to query an overview of all liquidity pools, use “Get All Stablecoin Liquidity Pool Info”.
2. Endpoint & Authentication
GET /api/stableCoin/tvl
For Base URL and authentication, see Common Network & Authentication.
3. Request
Fields
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
token | string | No | — | Stablecoin contract address; if omitted, returns all pools |
4. Response
Fields
Top-level
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
sunswapv1 | array | Required | SunSwap V1 pool list | — |
sunswapv2 | array | Required | SunSwap V2 pool list | — |
sun | array | Required | SunCurve pool list | — |
Pool array element
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
poolAddress | string | Required | Liquidity pool contract address | — |
poolName | string | Required | Pool name | — |
project | string | Required | Project name | — |
liquidity | string | Required | Pool liquidity (native units, not USD) | Token units |
tvl | string | Required | Total value locked | USD |
volume24Hours | string | Optional | 24-hour trading volume | USD |
tokens | array | Required | Array of token details in the pool | — |
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 decimals | — |
tokenType | string | Required | Token type (trc20/trc10 etc.) | — |
vip | boolean | Required | Whether it is a VIP token | — |
issuerAddr | string | Required | Token issuer address | — |
tokenLogo | string | Required | Token logo URL | — |
tokenLevel | string | Required | Token level: 0 (UNKNOWN), 1 (NEUTRAL), 2 (OK), 3 (SUSPICIOUS), 4 (UNSAFE) | — |
tokenCanShow | integer | Required | Whether displayable (1 = yes) | — |
5. Errors
For HTTP status codes, see Common Errors. Key points for this endpoint:
- Empty result is not an error: when no pools exist, each array is empty as a normal response.
Last updated on: