Skip to main content
High-yield wallets are an accounting layer that track principal, recognized yield (withdrawable), and estimated accrued yield (projected). This guide walks through creating a high-yield wallet, viewing its state, and understanding the key response fields you will use in a dashboard. Creating a high-yield wallet is idempotent via requestId. The response includes per-chain deposit addresses you can sweep to from your existing custody.

Create a high-yield wallet

curl -X POST "$BASE_URL/high-yield-wallets" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "requestId": "123e4567-e89b-12d3-a456-426614174000",
    "label": "My High-Yield Wallet",
    "type": "gammaResearchDeltaNetural"
  }'
200 response
{
  "id": "66f62666-4073-4bea-8a8c-410201477e21",
  "createdAt": "2025-09-14T03:32:40.467+00:00",
  "label": "My High-Yield Wallet",
  "type": "gammaResearchDeltaNetural",
  "withdrawableBalance": 0,
  "recognizedYield": 0,
  "estimatedAccruedYield": 0,
  "averageApyLast30dBps": null,
  "yieldRecognitionPeriodDays": 10,
  "nextExpectedYieldRecognitionAt": "2025-09-24T00:00:00.000Z",
  "depositAddresses": {
    "arbitrum": {
      "address": "0xa57671a38142a5636eA88b01F935Eaff425B6688"
    },
    "bsc": {
      "address": "0xa57671a38142a5636eA88b01F935Eaff425B6688"
    },
    "solana": {
      "address": "BAHHuqpgMt5vbHnTkjo1DzjhRo5a2zN6QX2jw66YeGzn"
    }
  }
}
After creation, transfer stablecoins from your existing wallets to the corresponding depositAddresses[chain].address. As deposits settle and are swept into the liquidity pool, the high-yield snapshots update and your withdrawable balance grows when yield is recognized.

Get a high-yield wallet by id

curl -X GET "$BASE_URL/high-yield-wallets/$WALLET_ID" \
  -H "Authorization: Bearer $TOKEN"
200 response
{
  "id": "92ff592c-a5d1-4053-a745-53f140cc2851",
  "createdAt": "2025-09-11T21:50:36.372+00:00",
  "label": "Treasury Wallet",
  "type": "gammaResearchDeltaNetural",
  "withdrawableBalance": 95000.0,
  "recognizedYield": 5000.0,
  "estimatedAccruedYield": 120.5,
  "averageApyLast30dBps": 400,
  "yieldRecognitionPeriodDays": 10,
  "nextExpectedYieldRecognitionAt": "2025-09-21T00:00:00.000Z",
  "depositAddresses": {
    "arbitrum": {
      "address": "0x21246509968c4d24611f414560971AEc2e3A079B"
    },
    "bsc": {
      "address": "0x21246509968c4d24611f414560971AEc2e3A079B"
    },
    "solana": {
      "address": "BskNLCLegEBsLySuTRmGJJoozyAUmeApSvd73b2hg7QM"
    }
  }
}
Key fields:
  • withdrawableBalance: what your users can actually withdraw today (principal + recognized yield).
  • recognizedYield: total yield that has been recognized and is withdrawable.
  • estimatedAccruedYield: projected yield that may be recognized at the next recognition event (forward-looking, not withdrawable).
  • averageApyLast30dBps: 30-day average APY at the latest snapshot, expressed in basis points (e.g., 400 = 4%).

List high-yield wallets

curl -X GET "$BASE_URL/high-yield-wallets?page=1&pageSize=20" \
  -H "Authorization: Bearer $TOKEN"
200 response
{
  "highYieldWallets": [
    {
      "id": "92ff592c-a5d1-4053-a745-53f140cc2851",
      "createdAt": "2025-09-11T21:50:36.372+00:00",
      "label": "Treasury Wallet",
      "type": "gammaResearchDeltaNetural",
      "withdrawableBalance": 95000.0,
      "recognizedYield": 5000.0,
      "estimatedAccruedYield": 120.5,
      "averageApyLast30dBps": 400,
      "yieldRecognitionPeriodDays": 10,
      "nextExpectedYieldRecognitionAt": "2025-09-21T00:00:00.000Z"
    }
  ],
  "page": 1,
  "pageSize": 20,
  "total": 1
}
Use this endpoint to power wallet selection menus and high-level portfolio views in your dashboard.