Earn

List one external wallet's positions

Returns one strict keyset page of live positions for an end-user wallet in the active partner project. A wallet outside that scope answers 404. Live fields are absent when provider hydration is unavailable, never replaced with zero.

get/v1/earn/external-wallet/positions/{ownerAddress}

Path parameters

ownerAddressstring required

Query parameters

limitinteger
beforestring

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Response

External-wallet position page

Example response

{
  "data": {
    "ownerAddress": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
    "positions": [
      {
        "id": "earn_position_example",
        "ownerAddress": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
        "provider": "kamino",
        "providerReference": "7uib8xGAwkaPz4ZGCA6t8sSEid5Yp9ty13PHUweTypx",
        "label": "Allez USDC",
        "tokenMint": "4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU",
        "shareMint": "hXm2xSRF5PLKGMrTvAWqKhR76MuJX5dAabeSChkjqu2",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "closedAt": "2025-01-01T00:00:00.000Z",
        "shares": "25.42",
        "withdrawableShares": "25.42",
        "tokenValue": "25.42"
      }
    ]
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Changes

Changed in 1 of the 12 revisions of this API.1