Page cover

GET Pool Deposits Information

-------------------------------------------
OVERVIEW
-------------------------------------------

Endpoint: GET /api/v1/pools/{poolId}/deposits
Method: GET
Authentication: Not Required
Rate Limit: 50 requests/minute

PURPOSE:
Retrieves paginated information about deposits in a specific privacy pool,
including anonymized statistics without revealing individual user identities.

-------------------------------------------
REQUEST DETAILS
-------------------------------------------

URL Parameters:
| Parameter | Type   | Required | Description                          |
|-----------|--------|----------|--------------------------------------|
| poolId    | string | Yes      | Unique pool identifier               |

Query Parameters:
| Parameter | Type    | Default | Description                              |
|-----------|---------|---------|------------------------------------------|
| page      | integer | 1       | Page number for pagination               |
| pageSize  | integer | 50      | Number of results per page (max: 200)    |

EXAMPLE REQUEST:
  GET https://api.cipherx.io/api/v1/pools/cipherx-bsc-01/deposits?page=1&pageSize=50

-------------------------------------------
EXAMPLE RESPONSE
-------------------------------------------

{
  "success": true,
  "poolId": "cipherx-bsc-01",
  "pagination": {
    "currentPage": 1,
    "pageSize": 50,
    "totalDeposits": 847,
    "totalPages": 17
  },
  "deposits": [
    {
      "leafIndex": 846,
      "depositedAt": "2025-01-10T15:15:32.847Z",
      "blockNumber": 45678901,
      "confirmations": 18,
      "commitmentHash": "0x1b29c3e4f7a8d9e0...",
      "isWithdrawn": false,
      "status": "confirmed"
    }
  ]
}

Last updated