Check Open Positions

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 /v2/wallets/:address?include=earn

Required Parameters:

Parameter	Description	Example
address	Wallet address	`0x1234567890123456789012345678901234567890`

Optional Parameters:

Parameter	Type	Default	Description
`includeHistory`	boolean	`true`	Include paginated transaction history.
`withActions`	boolean	`true`	Include raw investment actions inside each earn position.

Slim Request:

GET /v2/wallets/0x1234567890123456789012345678901234567890?include=earn&includeHistory=false&withActions=false

Use the slim request when the client needs the calculated position, principal, and profit but does not consume raw actions or wallet history.

Response Format

The response returns yield positions under earn.positions and an aggregate under earn.summary. By default it also includes raw actions and paginated wallet activity under history; the slim request omits both without changing the position accounting. Example Response:

{
  "earn": {
    "positions": [{
      "spotPosition": {
        "currentPosition": {
          "value": "10048700",
          "decimals": 6,
          "humanized": "10.0487",
          "symbol": "USDC"
        },
        "profit": {
          "value": "48700",
          "afterFees": "43830",
          "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,
        "grossAPY": 0.0417,
        "netAPY": 0.0396,
        "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": {
      "totalProfitInUSD": 0.05,
      "totalUnderlyingBalanceUSD": 10.05
    }
  }
}

Understanding the Response

earn.positions[].spotPosition.currentPosition

Raw balance as a BigInt string in the token’s smallest unit (e.g. "10000000" = 10 USDC)

earn.positions[].spotPosition.underlyingBalanceUSD

USD value of the position

earn.positions[].spotPosition.profit

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.

value: the gross figure, before Pods fees.
afterFees: the same figure net of the performance and markup fees — value × (1 - (performanceFeeBps + markupFeeBps) / 10000). Display this one. Fees apply to profit only, so when value is negative afterFees equals it exactly. See Fees for the full rules.

earn.positions[].spotPosition.cumulativeProfit

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.

earn.positions[].spotPosition APY fields

apy: Current APY as a decimal (e.g. 0.0417 = 4.17%)
grossAPY: APY before performance fees are deducted (decimal). May be null when not applicable.
netAPY: APY after performance fees are deducted (decimal). May be null when not applicable.
avgApy: Time-weighted average APY since inception
inceptionApy: APY since the strategy launched

earn.positions[].spotPosition pending amounts

For strategies with queued (request-based) investment flows, these arrays contain pending amounts not yet settled on-chain:

requestedToLend: Array of amounts pending deposit (e.g. a request-lend action that is PENDING)
requestedToWithdraw: Array of amounts pending withdrawal (e.g. a request-withdraw action that is PENDING)

Each entry has the same shape as currentPosition (value, decimals, humanized, symbol). These fields are only present on strategies that support the request-lend / request-withdraw action flow.

strategy

Full strategy object (same metadata exposed by GET /v2/strategies/:strategyId) including protocol, network, asset details, and fee

earn.summary.totalUnderlyingBalanceUSD

Total portfolio value in USD across all positions

UI Integration Example

Example UI showing active yield positions

Next Steps

Withdraw

Learn how to withdraw from a position

New Deposit

Open a new yield position

Overview

Guides

Integrations

Agents

Check Open Positions

Retrieve Current Positions

Response Format

Understanding the Response

UI Integration Example

Next Steps

Withdraw

New Deposit

​Retrieve Current Positions

​Response Format

​Understanding the Response

​UI Integration Example

​Next Steps

Withdraw

New Deposit

Retrieve Current Positions

Response Format

Understanding the Response

UI Integration Example

Next Steps