Skip to main content
GET
Get a wallet's earnings across all vaults on one chain

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId
string
required

ID of the environment

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Query Parameters

ownerAddress
string
required

Wallet address whose earnings to query. Valid blockchain wallet address, must be an alphanumeric string (underscores allowed for chains like Midnight, hyphens allowed for chains using base64url-encoded addresses like TON)

Maximum string length: 255
Pattern: ^[A-Za-z0-9_-]{18,100}$
Example:

"0xbF394748301603f18d953C90F0b087CBEC0E1834"

chainId
integer
required

Chain id to aggregate earnings on: an EVM chain id for chainName=EVM, or the Solana cluster id for chainName=SOL (101 for mainnet, the only Solana cluster with earnings data).

Required range: 1 <= x <= 2147483647
chainName
enum<string>
default:EVM

Chain family of ownerAddress and chainId. Only EVM and SOL are supported; any other value is rejected with a 400. Defaults to EVM so existing callers are unaffected.

Available options:
ETH,
EVM,
FLOW,
SOL,
ALGO,
STARK,
COSMOS,
BTC,
ECLIPSE,
SUI,
SPARK,
TRON,
APTOS,
TON,
STELLAR,
ALEO,
TEMPO,
MIDNIGHT

Response

Earnings across the wallet's vault positions on the chain

chainId
integer
required

Chain id the earnings were aggregated on: an EVM chain id, or the Solana cluster id.

ownerAddress
string
required

Valid blockchain wallet address, must be an alphanumeric string (underscores allowed for chains like Midnight, hyphens allowed for chains using base64url-encoded addresses like TON)

Maximum string length: 255
Pattern: ^[A-Za-z0-9_-]{18,100}$
Example:

"0xbF394748301603f18d953C90F0b087CBEC0E1834"

totalAssetsUsd
number
required

Sum of the USD position sizes. Vaults with no USD price are skipped rather than counted as zero.

totalPnlUsd
number
required

Sum of the USD earnings. Vaults with no USD price are skipped rather than counted as zero.

vaults
object[]
required

Per-vault breakdown behind the totals.