ledger_entry

[Source]

The ledger_entry method returns a single ledger entry from the XRP Ledger in its raw format. See ledger format for information on the different types of entries you can retrieve.

Request Format

This method can retrieve several different types of data. You can select which type of item to retrieve by passing the appropriate parameters, comprised of the general and type-specific fields listed below, and following the standard request formatting. (For example, a WebSocket request always has the command field and optionally an id field, and a JSON-RPC request uses the method and params fields.)

Note

There is no commandline syntax for this method. You can use the json method to access this method from the commandline instead.

General Fields

Field	Type	Description
`binary`	Boolean	(Optional) If `true`, return the requested ledger entry's contents as a hex string in the XRP Ledger's binary format. Otherwise, return data in JSON format. The default is `false`.
`ledger_hash`	String	(Optional) A 20-byte hex string for the ledger version to use. (See Specifying Ledgers)
`ledger_index`	String or Unsigned Integer	(Optional) The ledger index of the ledger to use, or a shortcut string (e.g. "validated" or "closed" or "current") to choose a ledger automatically. (See Specifying Ledgers)
`include_deleted`	Boolean	(Optional, Clio servers only) If set to true and the queried object has been deleted, return its complete data as it was prior to its deletion. If set to false or not provided, and the queried object has been deleted, return `objectNotFound` (current behavior).

The generator and ledger parameters are deprecated and may be removed without further notice.

In addition to the general fields above, you must specify exactly 1 of the following fields to indicate what type of entry to retrieve, along with its sub-fields as appropriate. The valid fields are:

ledger_entry

Caution

If you specify more than 1 of these type-specific fields in a request, the server retrieves results for only 1 of them. It is not defined which one the server chooses, so you should avoid doing this.

Get Ledger Object by ID

Retrieve any type of ledger object by its unique ID.

Field	Type	Description
`index`	String	The ledger entry ID of a single entry to retrieve from the ledger, as a 64-character (256-bit) hexadecimal string.

{
  "command": "ledger_entry",
  "index": "7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4",
  "ledger_index": "validated"
}

Try it! >

Tip

You can use this type of request to get any singleton ledger entry, if it exists in the ledger data, because its ID is always the same. For example:

Amendments - 7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4
FeeSettings - 4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A651
Recent History LedgerHashes - B4979A36CDC7F3D3D5C31A4EAE2AC7D7209DDA877588B9AFC66799692AB0D66B
NegativeUNL - 2E8A59AA9D3B5B186B0B9E0F62E6C02587CA74A4D778938E957B6357D364B244

Get AccountRoot Object

Retrieve an AccountRoot entry by its address. This is roughly equivalent to the account_info method.

Field	Type	Description
`account_root`	String - Address	The classic address of the AccountRoot entry to retrieve.

{
  "id": "example_get_accountroot",
  "command": "ledger_entry",
  "account_root": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
  "ledger_index": "validated"
}

Try it! >

Get AMM Object

(Added by the AMM amendment)

Retrieve an Automated Market-Maker (AMM) object from the ledger. This is similar to amm_info method, but the ledger_entry version returns only the ledger entry as stored.

Field	Type	Description
`amm`	Object or String	The AMM to retrieve. If you specify a string, it must be the object ID of the AMM, as hexadecimal. If you specify an object, it must contain `asset` and `asset2` sub-fields.
`amm.asset`	Object	One of the two assets in this AMM's pool, as a currency object without an amount.
`amm.asset2`	Object	The other of the two assets in this AMM's pool, as a currency object without an amount.

{
  "id": 3,
  "command": "ledger_entry",
  "amm": {
    "asset": {
      "currency": "XRP"
    },
    "asset2": {
      "currency" : "TST",
      "issuer" : "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd"
    }
  },
  "ledger_index": "validated"
}

Try it! >

Get Bridge Object

(Requires the XChainBridge amendment )

Retrieve a Bridge entry, which represents a single cross-chain bridge that connects the XRP Ledger with another blockchain.

Field	Type	Description
`bridge_account`	String	The account that submitted the `XChainCreateBridge` transaction on the blockchain.
`bridge`	Object	The Bridge to retrieve. Includes the door accounts and assets on the issuing and locking chain.

{
  "id": "example_get_bridge",
  "command": "ledger_entry",
  "bridge_account": "rnQAXXWoFNN6PEqwqsdTngCtFPCrmfuqFJ",
  "bridge": {
    "IssuingChainDoor": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
    "IssuingChainIssue": {
      "currency": "XRP"
    },
    "LockingChainDoor": "rnQAXXWoFNN6PEqwqsdTngCtFPCrmfuqFJ",
    "LockingChainIssue": {
      "currency": "XRP"
    }
  },
  "ledger_index": "validated"
}

Try it! >

Get DirectoryNode Object

Retrieve a DirectoryNode, which contains a list of other ledger objects. Can be provided as string (object ID of the Directory) or as an object.

Field	Type	Description
`directory`	Object or String	The DirectoryNode to retrieve. If a string, must be the object ID of the directory, as hexadecimal. If an object, requires either `dir_root` or `owner` as a sub-field, plus optionally a `sub_index` sub-field.
`directory.sub_index`	Unsigned Integer	(Optional) If provided, jumps to a later "page" of the DirectoryNode.
`directory.dir_root`	String	(Optional) Unique index identifying the directory to retrieve, as a hex string.
`directory.owner`	String	(Optional) Unique address of the account associated with this directory.

{
  "id": 3,
  "command": "ledger_entry",
  "directory": {
    "owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
    "sub_index": 0
  },
  "ledger_index": "validated"
}

Try it! >

Get Offer Object

Retrieve an Offer entry, which defines an offer to exchange currency. Can be provided as string (unique index of the Offer) or as an object.

Field	Type	Description
`offer`	Object or String	If a string, interpret as ledger entry ID of the Offer to retrieve. If an object, requires the sub-fields `account` and `seq` to uniquely identify the offer.
`offer.account`	String - Address	(Required if `offer` is specified as an object) The account that placed the offer.
`offer.seq`	Unsigned Integer	(Required if `offer` is specified as an object) The Sequence Number of the transaction that created the Offer entry.

{
  "id": "example_get_offer",
  "command": "ledger_entry",
  "offer": {
    "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
    "seq": 359
  },
  "ledger_index": "validated"
}

Try it! >

Get Oracle Object

(Requires the PriceOracle amendment)

Retrieve an Oracle entry, which represents a single price oracle that can store token prices.

Field	Type	Required?	Description
`oracle`	Object	Yes	The oracle identifier.
`oracle.account`	String - Address	Yes	The account that controls the `Oracle` object.
`oracle.oracle_document_id`	Number	Yes	A unique identifier of the price oracle for the `Account`

{
  "id": "example_get_oracle",
  "command": "ledger_entry",
  "oracle" : {
    "account": "rNZ9m6AP9K7z3EVg6GhPMx36V4QmZKeWds",
    "oracle_document_id":  34
  },
  "ledger_index": "validated"
}

Try it! >

Get RippleState Object

Retrieve a RippleState entry, which tracks a (non-XRP) currency balance between two accounts.

Field	Type	Description
`ripple_state`	Object	Object specifying the RippleState (trust line) object to retrieve. The `accounts` and `currency` sub-fields are required to uniquely specify the RippleState entry to retrieve.
`ripple_state.accounts`	Array	(Required if `ripple_state` is specified) 2-length array of account Addresses, defining the two accounts linked by this RippleState entry.
`ripple_state.currency`	String	(Required if `ripple_state` is specified) Currency Code of the RippleState entry to retrieve.

{
  "id": "example_get_ripplestate",
  "command": "ledger_entry",
  "ripple_state": {
    "accounts": [
      "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
      "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW"
    ],
    "currency": "USD"
  },
  "ledger_index": "validated"
}

Try it! >

Get Check Object

Retrieve a Check entry, which is a potential payment that can be cashed by its recipient.

Field	Type	Description
`check`	String	The object ID of a Check entry to retrieve.

{
  "id": "example_get_check",
  "command": "ledger_entry",
  "check": "C4A46CCD8F096E994C4B0DEAB6CE98E722FC17D7944C28B95127C2659C47CBEB",
  "ledger_index": "validated"
}

Try it! >

Get Escrow Object

Retrieve an Escrow entry, which holds XRP until a specific time or condition is met. Can be provided as string (object ID of the Escrow) or as an object.

Field	Type	Description
`escrow`	Object or String	The Escrow to retrieve. If a string, must be the object ID of the Escrow, as hexadecimal. If an object, requires `owner` and `seq` sub-fields.
`escrow.owner`	String - Address	(Required if `escrow` is specified as an object) The owner (sender) of the Escrow object.
`escrow.seq`	Unsigned Integer	(Required if `escrow` is specified as an object) The Sequence Number of the transaction that created the Escrow object.

{
  "id": "example_get_escrow",
  "command": "ledger_entry",
  "escrow": {
    "owner": "rL4fPHi2FWGwRGRQSH7gBcxkuo2b9NTjKK",
    "seq": 126
  },
  "ledger_index": "validated"
}

Try it! >

Get PayChannel Object

Retrieve a PayChannel entry, which holds XRP for asynchronous payments.

Field	Type	Description
`payment_channel`	String	The object ID of the PayChannel to retrieve.

{
  "id": "example_get_paychannel",
  "command": "ledger_entry",
  "payment_channel": "C7F634794B79DB40E87179A9D1BF05D05797AE7E92DF8E93FD6656E8C4BE3AE7",
  "ledger_index": "validated"
}

Try it! >

Get DepositPreauth Object

Retrieve a DepositPreauth entry, which tracks preauthorization for payments to accounts requiring Deposit Authorization.

Field	Type	Description
`deposit_preauth`	Object or String	Specify the DepositPreauth to retrieve. If a string, must be the ledger entry ID of the DepositPreauth entry, as hexadecimal. If an object, requires `owner` and `authorized` sub-fields.
`deposit_preauth.owner`	String - Address	(Required if `deposit_preauth` is specified as an object) The account that provided the preauthorization.
`deposit_preauth.authorized`	String - Address	(Required if `deposit_preauth` is specified as an object) The account that received the preauthorization.

{
  "id": "example_get_deposit_preauth",
  "command": "ledger_entry",
  "deposit_preauth": {
    "owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
    "authorized": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX"
  },
  "ledger_index": "validated"
}

Try it! >

Get Ticket Object

Retrieve a Ticket entry, which represents a sequence number set aside for future use. (Added by the TicketBatch amendment)

Field	Type	Description
`ticket`	Object or String	The Ticket to retrieve. If a string, must be the ledger entry ID of the Ticket, as hexadecimal. If an object, the `account` and `ticket_seq` sub-fields are required to uniquely specify the Ticket entry.
`ticket.account`	String - Address	(Required if `ticket` is specified as an object) The owner of the Ticket.
`ticket.ticket_seq`	Number	(Required if `ticket` is specified as an object) The Ticket Sequence number of the Ticket to retrieve.

{
  "id": "example_get_ticket",
  "command": "ledger_entry",
  "ticket": {
    "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
    "ticket_seq": 389
  },
  "ledger_index": "validated"
}

Try it! >

Get NFT Page

Return an NFT Page in its raw ledger format.

Field	Type	Description
`nft_page`	String	The ledger entry ID of an NFT Page to retrieve.

{
    "id": "example_get_nft_page",
    "command": "ledger_entry",
    "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F01DFFFFFFFFFFFFFFFFFFFFFFFF",
    "ledger_index": "validated"
}

Try it! >

Response Format

The response follows the standard format, with a successful result containing the following fields:

Field	Type	Description
`index`	String	The unique ID of this ledger entry.
`ledger_index`	Unsigned Integer	The ledger index of the ledger that was used when retrieving this data.
`node`	Object	(Omitted if `"binary": true` specified.) Object containing the data of this ledger entry, according to the ledger format.
`node_binary`	String	(Omitted unless `"binary":true` specified) The binary representation of the ledger object, as hexadecimal.
`deleted_ledger_index`	String	(Clio server only, returned if `include_deleted` parameter is set.) The ledger index where the ledger entry object was deleted.

An example of a successful response:

{
  "id": "example_get_accountroot",
  "result": {
    "index": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8",
    "ledger_hash": "31850E8E48E76D1064651DF39DF4E9542E8C90A9A9B629F4DE339EB3FA74F726",
    "ledger_index": 61966146,
    "node": {
      "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
      "AccountTxnID": "4E0AA11CBDD1760DE95B68DF2ABBE75C9698CEB548BEA9789053FCB3EBD444FB",
      "Balance": "424021949",
      "Domain": "6D64756F31332E636F6D",
      "EmailHash": "98B4375E1D753E5B91627516F6D70977",
      "Flags": 9568256,
      "LedgerEntryType": "AccountRoot",
      "MessageKey": "0000000000000000000000070000000300",
      "OwnerCount": 12,
      "PreviousTxnID": "4E0AA11CBDD1760DE95B68DF2ABBE75C9698CEB548BEA9789053FCB3EBD444FB",
      "PreviousTxnLgrSeq": 61965653,
      "RegularKey": "rD9iJmieYHn8jTtPjwwkW2Wm9sVDvPXLoJ",
      "Sequence": 385,
      "TransferRate": 4294967295,
      "index": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8"
    },
    "validated": true
  },
  "status": "success",
  "type": "response"
}

Possible Errors

Any of the universal error types.
deprecatedFeature - The request specified a removed field, such as generator.
entryNotFound - The requested ledger entry does not exist in the ledger.
invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
lgrNotFound - The ledger specified by the ledger_hash or ledger_index does not exist, or it does exist but the server does not have it.
malformedAddress - The request improperly specified an Address field.
malformedCurrency - The request improperly specified a Currency Code field.
malformedOwner - The request improperly specified the escrow.owner sub-field.
malformedRequest - The request provided an invalid combination of fields, or provided the wrong type for one or more fields.
unknownOption - The fields provided in the request did not match any of the expected request formats.