GET Supported Privacy Pools
-------------------------------------------
OVERVIEW
-------------------------------------------
Endpoint: GET /api/v1/pools
Method: GET
Authentication: Not Required
Rate Limit: 100 requests/minute
PURPOSE:
Retrieves a comprehensive list of all privacy pools available on CipherX,
including their denominations, supported blockchain networks, and current
statistics such as total value locked (TVL) and anonymity set size.
-------------------------------------------
REQUEST DETAILS
-------------------------------------------
URL Parameters: None
Query Parameters: None
Headers:
Content-Type: application/json
Accept: application/json
EXAMPLE REQUEST:
GET https://api.cipherx.io/api/v1/pools
-------------------------------------------
RESPONSE STRUCTURE
-------------------------------------------
Response Format: JSON Array
Field Definitions:
| Field Name | Data Type | Description |
|---------------------|-----------|------------------------------------------------|
| poolId | string | Unique identifier for the privacy pool |
| denomination | string | Fixed deposit amount (e.g., "0.1", "1", "10") |
| currency | string | Token symbol (BNB, ETH, MATIC, etc.) |
| network | object | Blockchain network configuration (NetworkDTO) |
| totalDeposits | integer | Total number of deposits in this pool |
| anonymitySetSize | integer | Current anonymity set for privacy |
| tvl | string | Total Value Locked in pool |
| minDelay | integer | Minimum privacy delay in seconds (300) |
| feePercentage | number | Withdrawal fee percentage (1.0%) |
| merkleTreeHeight | integer | Merkle tree height (default: 20) |
| status | string | Pool status: "active", "paused", "full" |
| contractAddress | string | Smart contract address on blockchain |
| deployedAt | string | ISO 8601 timestamp of pool deployment |
| lastDepositAt | string | ISO 8601 timestamp of most recent deposit |
-------------------------------------------
EXAMPLE RESPONSE
-------------------------------------------
{
"success": true,
"timestamp": "2025-01-10T14:30:00.000Z",
"pools": [
{
"poolId": "cipherx-bsc-01",
"denomination": "0.1",
"currency": "BNB",
"network": {
"chainId": 56,
"networkName": "BNB Smart Chain Mainnet",
"shortCode": "BSC"
},
"totalDeposits": 847,
"anonymitySetSize": 423,
"tvl": "84.7",
"minDelay": 300,
"feePercentage": 1.0,
"merkleTreeHeight": 20,
"status": "active",
"contractAddress": "0xE4f77e1E0d6dE17c310FdFA2c088D40222Ab787b"
}
]
}Last updated

