Skip to main content
GET
/
virtual-users
/
portfolio
Virtual Users Portfolio
curl --request GET \
  --url https://api.octav.fi/v1/virtual-users/portfolio \
  --header 'Authorization: Bearer <token>'
[
  {
    "address": "<string>",
    "networth": "<string>",
    "cashBalance": "<string>",
    "dailyIncome": "<string>",
    "dailyExpense": "<string>",
    "fees": "<string>",
    "feesFiat": "<string>",
    "lastUpdated": "<string>",
    "assetByProtocols": {},
    "chains": {}
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
addresses
string
required

Comma-separated virtual user addresses (from the list endpoint). Format: virtual:. Max 10.

​
aggregated
boolean
default:false

Return a single reduced portfolio across all virtual users

​
waitForSync
boolean
default:false

Wait for fresh data if cache is stale

​
includeImages
boolean
default:false

Include image URLs for chains, assets, and protocols

​
includeExplorerUrls
boolean
default:false

Include blockchain explorer URLs for assets and transactions

Response

Successful response — same schema as GET /portfolio

​
address
string

The virtual user address (virtual:)

​
networth
string

Total portfolio net worth in USD

​
cashBalance
string

Available cash balance

​
dailyIncome
string

Income generated today

​
dailyExpense
string

Expenses incurred today

​
fees
string

Total fees in native asset

​
feesFiat
string

Total fees in USD

​
lastUpdated
string

Last sync timestamp (milliseconds since epoch)

​
assetByProtocols
object

Assets organized by protocol

​
chains
object

Assets organized by blockchain