Vault

vault is a collection of wallets on all the supported chains each vault has a set of policies for transfer, trade, and defi transactions vault list get api/external/vaults/ list vaults in your organization that the api user has access to with pagination and optional filters get /api/external/vaults/?limit={limit}\&page={page}\&reverse={reverse}&{filters} request (query params) { "limit" number, "page" number, "reverse" boolean, "params" record\<string, string> } response { "count" number, "next" string | null, "previous" string | null, "results" vault\[] } help text \ (optional) `limit` page size; defaults to `20` \ (optional) `page` 1 indexed page number; defaults to `1` \ (optional) `reverse` when `true`, reverses chronological order (default `false`) \ (optional) `params` additional filters accepted by the api (e g , `vaulttype`, `vaultname`, `orgid`) example request get /api/external/vaults/?limit=10\&page=1\&reverse=false\&vaulttype=default sdk function getvaults(params? record\<string, string>, page? number, limit? number, reverse? boolean) promise\<vault\[]> vault get get api/external/vaults/{vaultid}/ fetch a single vault record by id request (path param) { "vaultid" string } response vault help text \ (required) `vaultid` identifier returned by vault list/create endpoints (e g , `vault 123`) example request get /api/external/vaults/vault 123/ sdk function getvaultbyid(vaultid string) promise\<vault> vault create post api/external/vaults/ create a new vault using a template and optional chains selection this internally creates addresses(wallets) on all selected chains request { "vaultname" string, "templateid" string, "chains" string\[], "testnetvault" boolean } response vault help text \ (required) `vaultname` display name for the vault \ (required) `templateid` identifier of the policy/template configured in primevault \ (optional) `chains` array of chain identifiers to enable (e g , `\["ethereum", "polygon"]`); defaults to all chains enabled for the org \ (optional) `testnetvault` boolean to create a testnet only vault example request { "vaultname" "treasury vault", "templateid" "tmpl 001", "chains" \["ethereum", "polygon"], "testnetvault" false, // optional } sdk function createvault(request createvaultrequest) promise\<vault> vault balances get api/external/vaults/{vaultid}/detailed balances/ retrieve token by token balances (including token metadata) for a specific vault this returns balances across chains request (path param) { "vaultid" string } response detailedbalanceresponse // array of { symbol, balance, name?, chain?, tokenaddress? } help text \ (required) `vaultid` identifier of the vault whose balances you need must belong to your org example request get /api/external/vaults/vault 123/detailed balances/ sdk function getdetailedbalances(vaultid string) promise\<detailedbalanceresponse>