Skip to main content
GET
/
pending-withdraws
/
{userAddress}
cURL
curl --request GET \
  --url https://api.example.com/pending-withdraws/{userAddress}
{
  "withdraws": [
    {
      "id": "<string>",
      "amountUusdc": "<string>",
      "claimedAmountUusdc": "<string>",
      "remainingUusdc": "<string>",
      "scheduledAt": "<string>",
      "lockedAt": "<string>",
      "unclaimedAt": "<string>"
    }
  ],
  "totalPending": "<string>",
  "totalFillLocked": "<string>",
  "totalUnclaimed": "<string>",
  "totalAvailableUnclaimed": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.bison.markets/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Get all pending withdrawals for a user, including their status and claimable amounts.
To avoid ambiguity, we denote the smallest possible multiple of USDC (0.000001 USDC) as one uusdc, which stands for µUSDC (micro-USDC), and denote the smallest possible multiple of a contract (0.01 contract) as one ccontract (centicontract).User-facing USDC balances are specified as fixed-point strings (e.g. "1.2625" for USDC). Contract quantities in the API and SDK are specified as integer ccontracts strings (e.g. "1050" for 10.50 contracts at precision 2).

​
Path Parameters

​
userAddress
string
required
User’s Ethereum wallet address.

​
Response

​
withdraws
array
List of withdrawal records.
​
totalPending
string
Total amount in pending status in µUSDC (integer string).
​
totalFillLocked
string
Total amount in fill-locked status in µUSDC (integer string).
​
totalUnclaimed
string
Total amount in unclaimed status in µUSDC (integer string).
​
totalAvailableUnclaimed
string
Total amount available to claim right now in µUSDC (integer string). Use this value to determine if the user can call /get-withdraw-authorization.

​
Withdrawal Statuses

StatusDescription
pendingScheduled, waiting for system processing
fill-lockedBeing processed by the system
unclaimedReady to claim on-chain
claimedSuccessfully withdrawn

​
Example Request

GET /pending-withdraws/0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266

​
Example Response

{
  "withdraws": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "chain": "base",
      "amountUusdc": "50000000",
      "claimedAmountUusdc": "0",
      "remainingUusdc": "50000000",
      "status": "unclaimed",
      "scheduledAt": "2024-11-09T15:30:00.000Z",
      "lockedAt": "2024-11-09T15:35:00.000Z",
      "unclaimedAt": "2024-11-09T15:40:00.000Z"
    },
    {
      "id": "661f9511-f30c-52e5-b827-557766551111",
      "chain": "base",
      "amountUusdc": "25000000",
      "claimedAmountUusdc": "0",
      "remainingUusdc": "25000000",
      "status": "pending",
      "scheduledAt": "2024-11-09T16:00:00.000Z",
      "lockedAt": null,
      "unclaimedAt": null
    }
  ],
  "totalPending": "25000000",
  "totalFillLocked": "0",
  "totalUnclaimed": "50000000",
  "totalAvailableUnclaimed": "50000000"
}

​
Usage

Check this endpoint to:
  1. Monitor withdrawal progress: See when scheduled withdrawals become claimable
  2. Determine claimable amount: Use totalAvailableUnclaimed to know how much can be claimed
  3. Track partial claims: View claimedAmountUusdc and remainingUusdc for partial claim tracking
When totalAvailableUnclaimed !== "0", the user can call /get-withdraw-authorization to get a claim signature.

Path Parameters

​
userAddress
string
required

Response

User pending withdraws retrieved successfully

​
withdraws
object[]
required
​
totalPending
string
required
​
totalFillLocked
string
required
​
totalUnclaimed
string
required
​
totalAvailableUnclaimed
string
required