Skip to main content
GET
Returns one vault group with its pockets read from the chain. A vault group is one vault product with two to four currency pockets. Each pocket is a vault of its own that holds one settlement token (stablecoin), for example one in USDC and one in EURC. All pockets examine their depositors against the same register for the life of the group, are run by one operator, and are published together under the group’s risk disclosure. A deposit goes into one pocket and stays in its currency. Nothing converts between pockets, so the group’s value is reported per currency in tvlByCurrency. Only on a group that mixes exactly EUR and USD is approximateTotal filled in, at the ECB euro reference rate of its date, labelled as an approximation. You see your own groups, and the groups other operators published on the same network and in the same environment. On another operator’s group only its published pockets with a deployed address are listed. Creating a group, adding a currency, publishing and the operator’s batched pocket actions are done in the Issuer Portal.

Path Parameters

string
required
Vault group ID, as groups[].id on List Vaults or groupId on a pocket’s vault row.

Query Parameters

string
Wallet to read a position for in every pocket. address is accepted too. Any value that is not a 0x address is ignored, and each pocket’s holder is then null.

Response Fields

object
The example shortens each pocket’s vault row and its onChain and holder blocks.

Error Codes