xrpl-dev-portal/ledger_entry.md at b560c8ab9f51d10367c292587ea9620c28b9f282

ARCHIVE/xrpl-dev-portal

Fork 0

mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-26 22:55:49 +00:00

Files

mDuo13 45e0f2f70f rippled APIs: reorg methods to separate files

2018-01-22 16:27:33 -08:00

8.1 KiB

Raw Blame History

ledger_entry

[Source]

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

Note: There is no commandline version of this method. You can use the json command to access this method from the commandline instead.

Request Format

An example of the request format:

WebSocket

{
  "id": 3,
  "command": "ledger_entry",
  "type": "account_root",
  "account_root": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
  "ledger_index": "validated"
}

JSON-RPC

{
    "method": "ledger_entry",
    "params": [
        {
            "account_root": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
            "ledger_index": "validated",
            "type": "account_root"
        }
    ]
}

Try it! >

This method can retrieve several different types of data. You can select which type of item to retrieve by passing the appropriate parameters. Specifically, you should provide exactly one of the following fields:

index - Retrieve any type of ledger object by its unique ID
account_root - Retrieve an AccountRoot object. This is roughly equivalent to the account_info command.
directory - Retrieve a DirectoryNode, which contains a list of other ledger objects
offer - Retrieve an Offer object, which defines an offer to exchange currency
ripple_state - Retrieve a RippleState object, which tracks a (non-XRP) currency balance between two accounts.

If you specify more than one of the above items, the server retrieves only of them; it is undefined which it chooses.

The full list of parameters recognized by this method is as follows:

`Field`	Type	Description
`index`	String	(Optional) Specify the unique identifier of a single ledger entry to retrieve.
`account_root`	String - [Address][]	(Optional) Specify an AccountRoot object to retrieve.
`directory`	Object or String	(Optional) Specify a DirectoryNode. (DirectoryNode objects each contain a list of IDs for things contained in them.) If a string, interpret as the unique index to the directory, in hex. 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 Directory.
`directory.dir_root`	String	(Required if `directory` is specified as an object and `directory.owner` is not provided) Unique index identifying the directory to retrieve, as a hex string.
`directory.owner`	String	(Required if `directory` is specified as an object and `directory.dir_root` is not provided) Unique address of the account associated with this directory
`offer`	Object or String	(Optional) Specify an Offer object to retrieve. If a string, interpret as the unique index to the Offer. If an object, requires the sub-fields `account` and `seq` to uniquely identify the offer.
`offer.account`	String - [Address][]	(Required if `offer` specified) The account that placed the offer.
`offer.seq`	Unsigned Integer	(Required if `offer` specified) The sequence number of the transaction that created the Offer object.
`ripple_state`	Object	(Optional) 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` specified) 2-length array of account [Address][]es, defining the two accounts linked by this RippleState object
`ripple_state.currency`	String	(Required if `ripple_state` specified) [Currency Code][] of the RippleState object to retrieve.
`binary`	Boolean	(Optional) If true, return the requested ledger object's contents as a hex string. Otherwise, return data in JSON format. The default is `true` if searching by `index` and `false` otherwise.
`ledger_hash`	String	(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
`ledger_index`	String or Unsigned Integer	(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)

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

Response Format

An example of a successful response: