Skip to main content
In this section, we’ll learn how to retrieve the current yield positions for an address.
Prerequisites:

​
Retrieve Current Positions

Use the following endpoint to retrieve all the current yield positions of an address: 
GET /wallets/:wallet
Required Parameters:
ParameterDescriptionExample
walletWallet address0x1234567890123456789012345678901234567890
Example Request: 
GET /wallets/0x1234567890123456789012345678901234567890

​
Response Format

The response returns an array of yield positions with spot performance data and the full strategy object for each. Example Response: 
{
  "positions": [
    {
      "spotPosition": {
        "currentPosition": {
          "value": "10048700",
          "decimals": 6,
          "humanized": "10.0487",
          "symbol": "USDC"
        },
        "profit": {
          "value": "48700",
          "decimals": 6,
          "humanized": "0.0487",
          "symbol": "USDC"
        },
        "cumulativeProfit": {
          "value": "48700",
          "decimals": 6,
          "humanized": "0.0487",
          "symbol": "USDC"
        },
        "principal": {
          "value": "10000000",
          "decimals": 6,
          "humanized": "10.00",
          "symbol": "USDC"
        },
        "underlyingBalanceUSD": 10.05,
        "apy": 0.0417,
        "avgApy": 0.0412,
        "inceptionApy": 0.0385
      },
      "strategy": {
        "id": "Aave-USDC-polygon",
        "protocol": "Aave",
        "assetName": "USDC",
        "network": "polygon",
        "networkId": "137",
        "asset": "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174",
        "assetDecimals": 6,
        "apy": 0.0417,
        "paused": false,
        "fee": "0",
        "availableActions": ["lend", "withdraw"]
      }
    }
  ],
  "summary": {
    "totalUnderlyingBalanceUSD": 10.05
  }
}

​
Understanding the Response

Raw balance as a BigInt string in the token’s smallest unit (e.g. "10000000" = 10 USDC)
USD value of the position
Current gain or loss of the position relative to the cost basis still invested, taking into account adjustments such as partial withdrawals. This reflects the true economic result of the open position — what the client has effectively earned on the capital that remains deployed.
A simpler accumulated view of the overall result: the current position value minus the total net amount moved by the client (deposits minus withdrawals). This does not adjust for the changing cost basis and gives a straightforward picture of how much value has been generated since inception.
  • apy: Current APY as a decimal (e.g. 0.0417 = 4.17%)
  • avgApy: Time-weighted average APY since inception
  • inceptionApy: APY since the strategy launched
Full strategy object (same shape as GET /strategies/:id) including protocol, network, asset details, and fee
Total portfolio value in USD across all positions

​
UI Integration Example

Active yield positions in UI Example UI showing active yield positions

​
Next Steps

Withdraw

Learn how to withdraw from a position

New Deposit

Open a new yield position