Console

POSTvault_info

XRP Ledger Mainnethttps://xrpl-mainnet.nodit.io/

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

Request Body
methodstringrequired
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_indexinteger

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
Accountstring

The pseudo-account address of the vault.

Assetobject

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.

sharesobject

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.

X-API-KEY
RequestCU25
cURL
curl -X POST "https://xrpl-mainnet.nodit.io/" \
  -H "X-API-KEY: {YOUR_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
  "method": "vault_info",
  "params": [
    {
      "owner": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
      "seq": 42
    }
  ]
}'
Response
Example · 200
{
  "result": {
    "ledger_hash": "17ACB57A0F73B5160713E81FE72B2AC9F6064541004E272BD09F257D57C30C02",
    "ledger_index": 98765432,
    "validated": true,
    "vault": {
      "Account": "rE54zDvgnghAoPopCgvtiqWNq3dU5y836S",
      "Asset": {
        "currency": "XRP"
      },
      "AssetsAvailable": "5000000000",
      "AssetsMaximum": "0",
      "AssetsTotal": "5000000000",
      "Flags": 0,
      "LossUnrealized": "0",
      "Scale": 0,
      "ShareMPTID": "0000002A5F7A9C0E2D4F6B8A0C1E3D5F7A9B0C2E",
      "WithdrawalPolicy": "vaultStrategyFirstComeFirstServe",
      "index": "0E1B3D5F7A9C0E2D4F6B8A0C1E3D5F7A9B0C2E4D6F8A0B1C3E5D7F9A0B2C4E6D",
      "shares": {
        "AssetScale": 0,
        "Flags": 0,
        "Issuer": "rE54zDvgnghAoPopCgvtiqWNq3dU5y836S",
        "LedgerEntryType": "MPTokenIssuance",
        "OutstandingAmount": "5000000000",
        "OwnerNode": "0",
        "PreviousTxnID": "1B3D5F7A9C0E2D4F6B8A0C1E3D5F7A9B0C2E4D6F8A0B1C3E5D7F9A0B2C4E6D8F",
        "PreviousTxnLgrSeq": 98765000,
        "Sequence": 42,
        "index": "2C4E6A8B0D1F3A5C7E9B0D2F4A6C8E0B1D3F5A7C9E0B2D4F6A8C0E1B3D5F7A9C",
        "mpt_issuance_id": "0000002A5F7A9C0E2D4F6B8A0C1E3D5F7A9B0C2E"
      }
    }
  }
}

Last updated