Page cover

GET Deposit Estimate

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

Endpoint: GET /api/v1/deposit/estimate
Method: GET
Authentication: Not Required
Rate Limit: 100 requests/minute

PURPOSE:
Calculates and returns estimated costs, fees, and privacy parameters for
a planned deposit into a CipherX privacy pool.

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

Query Parameters:
| Parameter     | Type   | Required | Description                              |
|---------------|--------|----------|------------------------------------------|
| poolId        | string | Yes      | Target pool identifier                   |
| amount        | string | Yes      | Deposit amount in pool denomination      |
| includeGas    | boolean| No       | Include gas estimates (default: true)    |

EXAMPLE REQUEST:
  GET https://api.cipherx.io/api/v1/deposit/estimate?poolId=cipherx-bsc-01&amount=0.1

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

{
  "success": true,
  "poolId": "cipherx-bsc-01",
  "denomination": "0.1",
  "currency": "BNB",
  "estimatedDeposit": {
    "baseAmount": "0.1",
    "protocolFee": "0",
    "gasEstimate": "0.00045",
    "totalCost": "0.10045",
    "totalCostUSD": "68.30"
  },
  "privacyParameters": {
    "minPrivacyDelay": 300,
    "recommendedDelay": 900,
    "currentAnonymitySet": 423
  }
}

Last updated