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.
Equivalent to SDK’s getWithdrawalRequests().
Endpoint
GET https://api.paxoslabs.com/v2/amplify/withdrawalRequests
Query Parameters
| Parameter | Type | Required | Description |
|---|
filter | string | Yes | Filter expression — must include userAddress=0x.... Optionally add AND chainId=1, AND status=PENDING, etc. |
pageSize | int | No | Results per page (default 20) |
pageToken | string | No | Pagination token from previous response |
Example Request
USER_ADDRESS="0x..."
curl -s "https://api.paxoslabs.com/v2/amplify/withdrawalRequests?filter=userAddress%3D${USER_ADDRESS}&pageSize=20" \
-H "x-api-key: $AMPLIFY_API_KEY" | jq
Response
{
"withdrawalRequests": [
{
"orderIndex": "42",
"userAddress": "0x...",
"vaultAddress": "0x...",
"chainId": 1,
"offerAmount": "1000000000000000000",
"wantAsset": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"status": "PENDING",
"createdAt": "2025-01-15T10:30:00Z",
"fulfilledAt": null
}
],
"nextPageToken": null
}
Response Types
| Field | Type | Description |
|---|
orderIndex | string | WithdrawQueue order index |
userAddress | address | Address that submitted the order |
vaultAddress | address | BoringVault address |
chainId | int | Chain ID |
offerAmount | string | Account shares offered (18 decimals, as string) |
wantAsset | address | Token address the user wants to receive |
status | string | Order status (see below) |
createdAt | string | ISO 8601 timestamp of order creation |
fulfilledAt | string? | ISO 8601 timestamp of fulfillment (null if pending) |
Status Values
| Status | Description |
|---|
PENDING | Order submitted, awaiting fulfillment by the account operator |
COMPLETE | Fulfilled — want asset sent to receiver |
PENDING_REFUND | Cancellation in progress — shares being returned |
REFUNDED | Cancelled — shares returned to refund receiver |
