Documentation Index
Fetch the complete documentation index at: https://developers.paxoslabs.com/llms.txt
Use this file to discover all available pages before exploring further.
Most read-only data your UI needs to render deposit and withdrawal flows — minimum order sizes, per-asset fees, and SLAs — is returned inline on the discovery response (GET /v2/amplify/vaults). Three dedicated helpers cover what isn’t on the discovery response: previewing the fee for a specific redemption, reading up-to-the-block supply-cap utilization, and reading a user’s current position.
None of these requires an RPC connection.
Dedicated Helpers
| Endpoint | Description |
|---|
GET /v2/amplify/calculateWithdrawalFee | Compute the fee a user would be charged for a specific offerAmount + wantAsset redemption |
GET /v2/amplify/supplyCaps | Up-to-the-block totalSupplyInBase, supplyCap, and percentageFilled per chain deployment. null cap / percentage means the vault is uncapped |
GET /v2/amplify/userPositions | A user’s shareBalance, positionValueInBase, baseAssetAddress, and exchangeRateToBase per chain deployment |
Fields Returned by /v2/amplify/vaults
The following per-deployment fields are already present on the discovery response — there are no separate endpoints for them:
| Field | Shape | Description |
|---|
depositSupplyCap | { raw, formatted, decimals, hasCap } | Maximum total deposit. hasCap=false means the cap is maxUint256 (effectively uncapped) |
minimumWithdrawalOrderSize | { raw, formatted, decimals } | Minimum shareAmount accepted by /v2/amplify/withdraw |
assets[].depositFees / assets[].withdrawFees | { bps, percentage } | Per-asset fees (basis points + human-readable percentage) |
assets[].withdrawalSLAs | Protobuf duration strings (e.g. "86400s") | Expected delay, expiry buffer, queue and accountant-rate SLAs |
Common Error Responses
| Status | Meaning |
|---|
| 400 | Invalid parameters |
| 404 | Account or fee module not found for the given vaultAddress + chainId |
| 503 | Upstream service unavailable |
