Paxos Labs API
The Paxos Labs API V2 provides REST (and GraphQL) endpoints for analytics and data across Paxos onchain products. All list endpoints support cursor-based pagination and a flexible filter query parameter.
Authentication
Include your API key in the x-api-key header:
x-api-key: pxl_<public_id>_<secret>
Base URL
https://api.paxoslabs.com
Endpoints
Amplify — Analytics
| Endpoint | Method | Description |
|---|
/v2/amplify/vaultAssets | GET | List depositable/withdrawable assets for accounts |
/v2/amplify/vaultApys | GET | Historical and current account APY data |
/v2/amplify/vaultTvls | GET | Historical and current account TVL data |
/v2/amplify/vaultCompositions | GET | Current asset composition for accounts |
/v2/amplify/withdrawalRequests | GET | Withdrawal requests filtered by status, chain, asset |
/v2/amplify/withdrawalVolumes | GET | Historical withdrawal volume by time interval |
/v2/amplify/liquidityShortfalls | GET | Current liquidity shortfalls across accounts |
Amplify — Discovery & Configuration
| Endpoint | Method | Description |
|---|
/v2/amplify/vaults | GET | Accounts grouped by name with per-chain deployments, contract addresses, per-asset fees, supply caps, min order size, and SLAs |
Amplify — Transaction Preparation (Calldata)
| Endpoint | Method | Description |
|---|
/v2/core/permit | GET | Detect authorization method (permit / approval / already approved) |
/v2/amplify/deposit | GET | Prepare deposit transaction calldata |
/v2/amplify/withdraw | GET | Prepare withdrawal order calldata |
/v2/amplify/withdraw/cancel | GET | Prepare cancel-withdrawal calldata |
Amplify — Display Helpers
| Endpoint | Method | Description |
|---|
/v2/amplify/calculateWithdrawalFee | GET | Preview the withdrawal fee for a specific offerAmount + wantAsset pair |
/v2/amplify/supplyCaps | GET | Read total deposits, supply cap, and percentage filled (per chain deployment) |
/v2/amplify/userPositions | GET | Read a user’s share balance, position value in base, and current exchange rate per chain |
Address Book
| Endpoint | Method | Description |
|---|
/v2/addressBookEntries | GET | Known address entries filtered by chain, address, or name |
Webhooks
Coming Soon — Webhook subscriptions for real-time event notifications are under active development.
pageSize (default 25, max 100) and pageToken. Omit pageToken for the first page; use the returned nextPageToken for subsequent pages.
Filtering
List endpoints accept a filter query string using =, !=, AND, and OR operators:
filter=chainId=1 AND status=PENDING
