Skip to main content
GET
/
v2
/
amplify
/
userPositions
List user positions in a vault
curl --request GET \
  --url https://api.example.com/v2/amplify/userPositions \
  --header 'x-api-key: <api-key>'
{
  "userPositions": [
    {
      "vaultAddress": "0xbbbb000000000000000000000000000000000001",
      "chainId": 84532,
      "shareBalance": "0.1",
      "positionValueInBase": "0.101811",
      "baseAssetAddress": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
      "exchangeRateToBase": "1.018116"
    }
  ],
  "nextPageToken": "eyJvZmZzZXQiOjI1fQ==",
  "tokenMetadata": {}
}

Documentation Index

Fetch the complete documentation index at: https://developers.paxoslabs.com/llms.txt

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

Authorizations

​
x-api-key
string
header
required

API key in format: pxl_<public_id>_

Query Parameters

​
pageSize
number
default:25

Maximum items per page. Default: 25. Min: 1, max: 100.

Required range: 1 <= x <= 100
Example:

25

​
pageToken
string

Opaque token for the next page. Omit for the first page.

​
userAddress
string
required

User wallet address (hex address). Required.

Example:

"0xdEADdE9539A00Bbd9A8494f45EB38aEe89d7C001"

​
filter
string

Filter string. Optional flags: vaultAddress (hex), chainId (number). Example: vaultAddress=0xbbbb000000000000000000000000000000000001 AND chainId=84532

Example:

"vaultAddress=0xbbbb000000000000000000000000000000000001 AND chainId=84532"

Response

List of user position entries

​
userPositions
object[]
required

One entry per chain deployment.

​
nextPageToken
string | null
required

Token for the next page. null when there are no more results. Always present.

Example:

"eyJvZmZzZXQiOjI1fQ=="

​
tokenMetadata
object
required

Address metadata map keyed by lowercase token/address. Missing metadata is represented as null.