Skip to main content

vault_info

POST
Returns information about a vault.It lets you check the vault's asset composition, its owner and the details of the issued shares.

📘 This method is available on rippled 3.1.0 and later.

param[0]
parametersobjectrequired
vault_idstring
The ID of a Vault ledger entry.
ownerstring
The account address of the vault owner. Pass it together with seq.
seqinteger
The sequence number of the transaction that created the vault. Pass it together with owner.
ledger_hashstring
The hash of the ledger version to use. Pass a 32-byte hex string.
ledger_indexoneOf
Specifies the ledger version to use. Pass a ledger index as an integer, or use one of the shortcut strings below.
  • validated: Uses the most recent ledger version validated by the network.
  • closed: Uses the most recent ledger version the server has closed. It may not be validated.
  • current: Uses the in-progress ledger version the server is currently building.
The ledger index of the version to use.
Responses
Detailed vault information.
Accountstring
The pseudo-account address of the vault.
Information about the asset the vault handles.
currencystring
The currency code. Omitted for MPTs.
issuerstring
The address of the asset issuer. Omitted for XRP and MPTs.
mpt_issuance_idstring
The MPT identifier. Omitted for XRP and trust line tokens.
AssetsAvailablestring
The amount of assets available in the vault.
AssetsMaximumstring
The maximum amount of assets the vault can hold. A value of 0 means there is no cap.
AssetsTotalstring
The total amount of assets in the vault.
Flagsinteger
A bit-map of flags set on the vault.
LossUnrealizedstring
The amount of loss that has not been realized yet.
ShareMPTIDstring
The identifier of the MPTokenIssuance that represents the vault shares.
WithdrawalPolicystring
The withdrawal policy of the vault.
Scaleinteger
The number of decimal places used to calculate shares.For trust line tokens it is between 0 and 18; for XRP and MPTs it is fixed at 0.
indexstring
The ID that identifies the vault ledger entry.
Issuance information for the vault shares.
DomainIDstring
The ID of the permissioned domain the shares belong to. Omitted for public vaults.
Flagsinteger
A bit-map of flags set on the share issuance.
Issuerstring
The address of the share issuer. It is the same as the vault's pseudo-account.
LedgerEntryTypestring
The ledger entry type. Always returns MPTokenIssuance.
OutstandingAmountstring
The total amount of shares issued.
OwnerNodestring
The reference page in the owner directory.
PreviousTxnIDstring
The ID of the transaction that most recently modified this entry.
PreviousTxnLgrSeqinteger
The ledger index of the ledger containing the transaction that most recently modified this entry.
Sequenceinteger
The sequence number of the transaction that created the shares.
AssetScaleinteger
The number of decimal places used to calculate shares.
mpt_issuance_idstring
The MPT identifier. It is the same as the vault's ShareMPTID.
indexstring
The ID that identifies the share ledger entry.
ledger_hashstring
The hash of the ledger version used. Returned when a validated ledger version was queried.
ledger_indexinteger
The ledger index of the version used. Returned when a validated ledger version was queried.
ledger_current_indexinteger
The ledger index of the in-progress ledger. Returned when the current ledger was queried.
validatedboolean
Whether the response was derived from a validated ledger version.
codestringrequired
Code identifying the cause of the failed request.
messagestringrequired
Detailed message including the name and value of the invalid parameter.
{
  "code": "ERROR_CODE",
  "message": "Unauthorized"
}
cURL
curl -X POST 'https://xrpl-mainnet.nodit.io' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo' \
  -d '{
    "method": "vault_info",
    "params": [
      {
        "owner": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
        "seq": 42
      }
    ]
  }'