Skip to main content
POST
/
v2
/
portfolio-wallets
/
yield
Get portfolio yield metrics for a period
curl --request POST \
  --url https://sandbox.trybraid.xyz/v2/portfolio-wallets/yield \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "periodStartIso": "2026-02-05T00:00:00.000Z",
  "periodEndIso": "2026-02-05T23:59:00.000Z",
  "portfolioWalletIds": [
    "9d1a1c83-3a1c-4c14-9c5a-0c9a57a4a7db"
  ]
}
'
{ "period": { "start": "2026-02-05T00:00:00.000Z", "end": "2026-02-05T23:59:00.000Z" }, "global": { "generated": 1240.35, "withdrawn": 430.2, "accruedDelta": 810.15 }, "portfolioWallets": { "9d1a1c83-3a1c-4c14-9c5a-0c9a57a4a7db": { "generated": 1240.35, "withdrawn": 430.2, "accruedDelta": 810.15 } } }

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
periodStartIso
string<date-time>

Start of the period (ISO8601). If omitted, lifetime is used.

​
periodEndIso
string<date-time>

End of the period (ISO8601). If omitted, lifetime to now is used.

​
portfolioWalletIds
string<uuid>[]

Optional list of wallet IDs to include. If omitted, global metrics across all wallets are returned and portfolioWallets is empty.

Response

Yield metrics

​
period
object
​
global
object
​
portfolioWallets
object