The API Calldata path lets you prepare Amplify transactions with plain HTTP requests. The server handles ABI encoding, address resolution, and contract selection — you get back a transaction object ready to sign and broadcast from any language or platform.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.
This path is ideal when you want server-side calldata generation without
managing ABIs or contract addresses locally. For a TypeScript SDK with
built-in wallet integrations, see the SDK
path. For full control
over contract calls, see Direct Contract
Integration.
Using an AI coding assistant? Paste the Calldata AI
Reference
into Cursor, Copilot, or Claude for a condensed single-page reference.
Skill-aware tools (Claude Code, Cursor, Windsurf) auto-discover the
amplify-earn-api-calldata Agent Skill at
/.well-known/agent-skills/index.json.When to Use This Path
- Server-side transaction builders — construct deposit/withdraw transactions from a backend in any language
- Custodial wallets and multisig services — fetch calldata via API, then route to your signing infrastructure
- Non-JS stacks — Python, Go, Rust, or any HTTP client; no npm packages required
- Prototyping — test the full deposit/withdraw flow with
curlbefore writing application code
Prerequisites
- A Paxos Labs API key (format:
pxl_<public_id>_<secret>) - An EVM wallet or signer capable of submitting raw transactions
- An HTTP client (
curl,fetch,requests, etc.)
Endpoints at a Glance
Transaction Preparation
| Endpoint | Description |
|---|---|
GET /v2/core/permit | Detect authorization method (permit / approval / already approved) |
GET /v2/amplify/deposit | Prepare deposit calldata |
GET /v2/amplify/withdraw | Prepare withdrawal order calldata |
GET /v2/amplify/withdraw/cancel | Prepare cancel-withdrawal calldata |
Discovery
| Endpoint | Description |
|---|---|
GET /v2/amplify/vaults | Accounts grouped by name with per-chain deployments, contract addresses, per-asset deposit/withdraw flags, fees, SLAs, and supply caps |
Display Helpers
| Endpoint | Description |
|---|---|
GET /v2/amplify/calculateWithdrawalFee | Withdrawal fee preview |
GET /v2/amplify/supplyCaps | Supply cap utilization (totalSupplyInBase, supplyCap, percentageFilled) per chain |
GET /v2/amplify/userPositions | User share balance and position value in the vault base asset per chain |
Getting Started
Authentication & Response Formats
API key usage, base URL, response format options, and error handling.
Account Discovery
Find available accounts and their contract addresses, fees, and supported
assets.
Deposits
End-to-end deposit flow: authorize, prepare calldata, sign and submit.
Withdrawals
Prepare and submit withdrawal orders via API.
Cancellations
Cancel pending withdrawal orders.
Display Helpers
Read deposit caps, supply, fees, and share values via API.
Learning Path
- Authentication — Set up your API key and understand response formats
- Discovery — Find the right account and its contract addresses
- Deposits — Execute your first deposit
- Withdrawals — Submit withdrawal orders
- Cancellations — Cancel pending withdrawals
- Display Helpers — Read account state for your UI