ledger

[Source]

Retrieve information about the public ledger.

Request Format

An example of the request format:

curl --location 'https://xrp.nownodes.io' \
--header 'Content-Type: application/json' \
--header 'api-key: API_KEY' \
--data '{
    "method": "ledger",
    "params": [
        {
            "ledger_index": "validated",
            "transactions": false,
            "expand": false,
            "owner_funds": false
        }
    ]
}'

The request can contain the following parameters:

Field	Type	Required?	Description
ledger_hash	[Hash][]	No	A 32-byte hex string for the ledger version to use. (See [Specifying Ledgers][]).
ledger_index	[Ledger Index][]	No	The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][])
transactions	Boolean	No	If true, return information on transactions in the specified ledger version. The default is false. Ignored if you did not specify a ledger version.
expand	Boolean	No	Provide full JSON-formatted information for transaction/account information instead of only hashes. The default is false. Ignored unless you request transactions, accounts, or both.
owner_funds	Boolean	No	If true, include owner_funds field in the metadata of OfferCreate transactions in the response. The default is false. Ignored unless transactions are included and expand is true.
binary	Boolean	No	If true, and transactions and expand are both also true, return transaction information in binary format (hexadecimal string) instead of JSON format.
queue	Boolean	No	If true, and the command is requesting the current ledger, includes an array of queued transactions in the results.

The ledger field is deprecated and may be removed without further notice. The full, accounts, and type fields (admin-only) are also deprecated; the Clio server does not implement these parameters.

Response Format

An example of a successful response:

{
    "result": {
        "ledger": {
            "account_hash": "640DA6DF331970751A31D8827DF58EB88C6D5CF8BF46821E6C8278408D852B84",
            "close_flags": 0,
            "close_time": 768688511,
            "close_time_human": "2024-May-10 20:35:11.000000000 UTC",
            "close_time_iso": "2024-05-10T20:35:11Z",
            "close_time_resolution": 10,
            "closed": true,
            "ledger_hash": "5CD77FE6E88EE2014A49D870FC239C16F13197E61ECFAFDA8BE5F8422CD24243",
            "ledger_index": "87899579",
            "parent_close_time": 768688510,
            "parent_hash": "BD4B8571A8A33EE9A818D1520B8720F1F0F56B204AE76999ACDC777A91A99E91",
            "total_coins": "99987599078872179",
            "transaction_hash": "8DE8E7ADEE11C448B73328630315313777BA2F323706F181D089BD3EE3B27F6E"
        },
        "ledger_hash": "5CD77FE6E88EE2014A49D870FC239C16F13197E61ECFAFDA8BE5F8422CD24243",
        "ledger_index": 87899579,
        "status": "success",
        "validated": true
    }
}

The response follows the [standard format][], with a successful result containing information about the ledger, including the following fields:

Field	Type	Description
ledger	Object	The complete ledger header data of this ledger, with some additional fields added for convenience.
ledger.account_hash	String	Hash of all account state information in this ledger, as hexadecimal.
ledger.close_flags	Number	A bit-map of flags relating to the closing of this ledger.
ledger.close_time	Number	The time this ledger was closed, in [seconds since the Ripple Epoch][].
ledger.close_time_human	String	The time this ledger was closed, in human-readable format. Always uses the UTC time zone.
ledger.close_time_resolution	Number	Ledger close times are rounded to within this many seconds.
ledger.closed	Boolean	Whether or not this ledger has been closed.
ledger.ledger_hash	String	Unique identifying hash of the entire ledger.
ledger.ledger_index	String	The [Ledger Index][] of this ledger, as a quoted integer.
ledger.parent_close_time	Number	The time at which the previous ledger was closed.
ledger.parent_hash	String	The unique identifying hash of the ledger that came immediately before this one, as hexadecimal.
ledger.total_coins	String	Total number of XRP drops in the network, as a quoted integer. (This decreases as transaction costs destroy XRP.)
ledger.transaction_hash	String	Hash of the transaction information included in this ledger.
ledger.transactions	Array	(Omitted unless requested) Transactions applied in this ledger version. By default, members are the transactions' identifying [Hash][] strings. If the request specified expand as true, members are full representations of the transactions instead, in either JSON or binary depending on whether the request specified binary as true.
ledger_hash	String	The unique identifying hash of the entire ledger, as hexadecimal.
ledger_index	Number	The [Ledger Index][] of this ledger.
validated	Boolean	(May be omitted) If true, this is a validated ledger version. If omitted or set to false, this ledger's data is not final.
queue_data	Array	(Omitted unless requested with the queue parameter) Array of objects describing queued transactions, in the same order as the queue. If the request specified expand as true, members contain full representations of the transactions, in either JSON or binary depending on whether the request specified binary as true.

The ledger.accountState field (omitted unless requested with "full": true or "accounts": true) is deprecated.

The following deprecated fields have been removed: accepted, hash (use ledger_hash instead), seqNum (use ledger_index instead), totalCoins (use total_coins instead).

Updated in: rippled 1.12.0

Each member of the queue_data array represents one transaction in the queue. Some fields of this object may be omitted because they have not yet been calculated. The fields of this object are as follows:

Field	Value	Description
account	String	The [Address][] of the sender for this queued transaction.
tx	String or Object	By default, this is a String containing the identifying hash of the transaction. If transactions are expanded in binary format, this is an object whose only field is tx_blob, containing the binary form of the transaction as a decimal string. If transactions are expanded in JSON format, this is an object containing the transaction object including the transaction's identifying hash in the hash field.
retries_remaining	Number	How many times this transaction can be retried before being dropped.
preflight_result	String	The tentative result from preliminary transaction checking. This is always tesSUCCESS.
last_result	String	(May be omitted) If this transaction was left in the queue after getting a retriable (ter) result, this is the exact ter result code it got.
auth_change	Boolean	(May be omitted) Whether this transaction changes this address's ways of authorizing transactions.
fee	String	(May be omitted) The Transaction Cost of this transaction, in [drops of XRP][].
fee_level	String	(May be omitted) The transaction cost of this transaction, relative to the minimum cost for this type of transaction, in [fee levels][].
max_spend_drops	String	(May be omitted) The maximum amount of [XRP, in drops][], this transaction could potentially send or destroy.

If the request specified "owner_funds": true and expanded transactions, the response has a field owner_funds in the metaData object of each [OfferCreate transaction][]. The purpose of this field is to make it easier to track the funding status of offers with each new validated ledger. This field is defined slightly differently than the version of this field in Order Book subscription streams:

Field	Value	Description
owner_funds	String	Numeric amount of the TakerGets currency that the Account sending this OfferCreate transaction has after the execution of all transactions in this ledger. This does not check whether the currency amount is frozen.

Possible Errors

• Any of the [universal error types][].

• 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.

• noPermission - If you specified full or accounts as true, but are not connected to the server as an admin (usually, admin requires connecting on localhost).