For the complete documentation index, see llms.txt. This page is also available as Markdown.

vault_info

Retrieves information about a Single Asset Vault, its owner, available assets, and details of its issued shares. Identify the vault either by vault_id or by owner and seq.

This method will use 20 Compute Units.


Reference: Here

Parameters

  • vault_id (string, optional) The ledger entry ID of the Vault to be returned.

  • owner (string, optional) The account address of the Vault owner. Use together with seq.

  • seq (number, optional) The transaction sequence number that created the vault. Use together with owner.

  • ledger_hash (string, optional) The unique hash of the ledger version to use.

  • ledger_index (number or string, optional) The ledger index of the ledger to use, or a shortcut string such as validated.

Returns

  • vault (object) The vault description object: Account (the vault's pseudo-account), Asset (currency and issuer, or mpt_issuance_id), AssetsAvailable, AssetsMaximum, AssetsTotal, Flags, index, LossUnrealized, Owner, Scale, ShareMPTID, WithdrawalPolicy, optional Data, LEVersion, VaultKind, RedemptionDate and SubscriptionDate, plus shares (the MPTokenIssuance entry for the vault's shares).

  • ledger_hash, ledger_index or ledger_current_index, validated The ledger version used.

// Result
// Illustrative example from xrpl.org (devnet data)
{
  "result": {
    "ledger_hash": "DC8D26A6DC85C70A112F5D798A3B5AF599A730098AFCC20CE18BFE6ADA5E66F9",
    "ledger_index": 3279463,
    "status": "success",
    "validated": true,
    "vault": {
      "Account": "rQhUcbJoDfvgXr1EkMwarLP5QT3XinEBDg",
      "Asset": {
        "mpt_issuance_id": "002F830036E4E56185F871D70CFFC7BDD554F897606BB6D3"
      },
      "Data": "50726976617465207661756C7420666F72207475746F7269616C73",
      "Flags": 65536,
      "LedgerEntryType": "Vault",
      "Owner": "rJdYtgaiEgzL7xD2QdPKg5xoHkWc7CZjvm",
      "OwnerNode": "0",
      "PreviousTxnID": "F73B073028D7EF14C5DD907591E579EBFEDBA891F4AE0B951439C240C42AE0D4",
      "PreviousTxnLgrSeq": 3113735,
      "Sequence": 3113728,
      "ShareMPTID": "00000001FCE5D5E313303F3D0C700789108CC6BE7D711493",
      "WithdrawalPolicy": 1,
      "index": "9E48171960CD9F62C3A7B6559315A510AE544C3F51E02947B5D4DAC8AA66C3BA",
      "shares": {
        "DomainID": "17060E04AD63975CDE5E4B0C6ACB95ABFA2BA1D569473559448B6E556F261D4A",
        "Flags": 60,
        "Issuer": "rQhUcbJoDfvgXr1EkMwarLP5QT3XinEBDg",
        "LedgerEntryType": "MPTokenIssuance",
        "MPTokenMetadata": "7B226163223A2264656669222C226169223A7B226578616D706C655F696E666F223A2274657374227D...",
        "OutstandingAmount": "0",
        "OwnerNode": "0",
        "PreviousTxnID": "F73B073028D7EF14C5DD907591E579EBFEDBA891F4AE0B951439C240C42AE0D4",
        "PreviousTxnLgrSeq": 3113735,
        "Sequence": 1,
        "index": "F231A0382544EC0ABE810A9D292F3BD455A21CD13CC1DFF75EAFE957A1C8CAB4",
        "mpt_issuance_id": "00000001FCE5D5E313303F3D0C700789108CC6BE7D711493"
      }
    }
  }
}

Over WebSocket, send {"id":1,"command":"vault_info","vault_id":"9E48171960CD9F62C3A7B6559315A510AE544C3F51E02947B5D4DAC8AA66C3BA","ledger_index":"validated"} to wss://mainnet.xrpl.validationcloud.io/v1/<YOUR_API_KEY_HERE>.

The SingleAssetVault amendment is not yet enabled on XRPL mainnet (checked with feature on 28 September 2026), so there are no vaults to look up and a live call returns entryNotFound. The method is routed and billed as above and will return real data once the amendment activates.

Last updated

Was this helpful?