GET
Get an owned holding including zero positions

Authorizations

Authorization
string
header
required

Account-bound token for the public API resource.

Scopes

account:read

Read account data.

Headers

Tuyo-API-Version
string
required

Required dated public API contract.

Allowed value: "2026-10-20"
Tuyo-Request-Reason
string

Optional, percent-encoded short explanation of why the request is made (e.g. the end-user goal relayed by an AI agent). Stored for audit; truncated to 2048 characters after decoding.

Path Parameters

id
string
required
Pattern: ^holding_(?:cash|group|vault)_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query Parameters

include
enum<string>[]
Required array length: 1 - 100 elements
Available options:
yield,
earnings
at
string<date-time>

Read holdings as they were at this instant: balances at the last block before it on each network, vault shares converted at that block, valued at prices of that time. Must not be in the future. Only include=yield is accepted and yields are then omitted; card locks are reconstructed from settlement records.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Response

Successful response.

id
any
required
kind
string
required
Allowed value: "cash"
group
any
required
quantity
any
required
value
any
required
cash
object
required
location
any[]