Get vault allocation

Get where one vault's assets sit.

GEThttps://api-v2.syncrone.fi/api/catalog/allocation/{network}/{vaultId}

One vault's allocation on its newest daily bar: markets, child vaults, strategies, loans, wallets and idle, each as a share of NAV, with utilization and trailing max drawdowns.

← Vaults API overview

Try it#

GET/allocation/mainnet/0x98C23E9d8f34FEFb1B7BD6a91B7FF122F4e16F5c

API keyx-api-key

Kept in this browser tab only, and sent to Syncrone with each request. No key yet? Create one ↗

Example vaults

Parameters

networkpathrequired

vaultIdpathrequired

selectquery

Response

Paste an API key, then press Send. The parameters are pre-filled with a real example.

curl

curl "https://api-v2.syncrone.fi/api/catalog/allocation/mainnet/0x98C23E9d8f34FEFb1B7BD6a91B7FF122F4e16F5c" \
  -H "x-api-key: $SYNCRONE_API_KEY"

Parameters#

Name	Type	Description
networkpathrequired	`string`	Network name (`mainnet`, `base`, `arbitrum`…), CAIP-2 id (`eip155:1`) or chain id (`1`).
vaultIdpathrequired	`string`	Vault address (the share or receipt token, any case). A vault listed without an address is addressed by its `slug`.
selectquery	`string[]`composition \| utilizationRate \| maxDrawdown \| withdrawalPauseRatio \| detailedVault	Sections to return. Repeat the parameter or separate with commas. Default: every section but `detailedVault`.

Response#

200 returns JSON with these fields. APY values are fractions (0.04 = 4%); timestamps are Unix seconds.

Field	Type	Description
vaultId	`string`	The vault's id, as in the path.
network	`string`	Network name.
composition[]	`object \| null`	Where the vault's assets sit on its newest daily bar, read from its own contracts at that bar's block. Null when there is no row (see `compositionStatus`).
composition[].name	`string`	The market, child vault, strategy, wallet or idle balance.
composition[].allocation	`number`	Share of NAV as a fraction (0.25 = 25%). Debts and amounts owed back are negative, so the shares sum to 1.
composition[].kind	`string`	`market`, `vault`, `idle`, `loans`, `custody`, `debt`, `fee` or `other`.
composition[].vaultId	`string \| null`	The child vault address, or the market id, when the position is one.
composition[].asset.positionValueInAsset	`string`	Value in the vault's asset, base units.
composition[].asset.positionValueInUsd	`string \| null`	Value in USD at the bar's asset price.
composition[].legs[]	`object`	For a leveraged position netted in one protocol market: each side, with `role` `collateral`, `supply` or `debt`.
compositionStatus	`string`	`available`; `pending` (read daily, no row yet); `not_applicable` (fixed-term, staking and yield tokens hold nothing to allocate); `no_reader`.
compositionAsOf	`object \| null`	`timestamp` (the bar, unix seconds), `blockNumber`, `blockTimestamp`, `source` (`reader`: the vault's contracts; `rates`: a single lending market split into lent and idle from its rate bar) and `reader`.
utilizationRate	`number \| null`	Invested share of the composition (not idle); for a lending market without one, its own utilization.
utilizationRateSource	`string \| null`	`composition` or `rates` (the market's own reported utilization); null with no value.
maxDrawdown	`object`	`mdd30days`, `mdd90days`, `mdd365days`: worst peak-to-trough drop of the daily share price, as a positive fraction.
withdrawalPauseRatio	`null`	Not tracked yet; always null.

Errors#

Status	Meaning
400	Invalid query or path parameter, or unknown network.
401	Missing or rejected API key.
404	No vault with this id on this network.
429	Too many requests from the docs playground. Wait a minute.
500	The service failed.

Error bodies carry error and, for invalid parameters, details.

← PreviousList vault allocations Next →Get vault historical data