Files
xrpl-dev-portal/content/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_current.md
2022-06-28 04:09:37 -07:00

2.0 KiB

html, parent, blurb, labels
html parent blurb labels
ledger_current.html ledger-methods.html Get the current working ledger version.
Blockchain

ledger_current

[Source]

The ledger_current method returns the unique identifiers of the current in-progress ledger. This command is mostly useful for testing, because the ledger returned is still in flux.

Request Format

An example of the request format:

WebSocket

{
   "id": 2,
   "command": "ledger_current"
}

JSON-RPC

{
    "method": "ledger_current",
    "params": [
        {}
    ]
}

Commandline

#Syntax: ledger_current
rippled ledger_current

Try it! >

The request contains no parameters.

Response Format

An example of a successful response:

WebSocket

{
  "id": 2,
  "status": "success",
  "type": "response",
  "result": {
    "ledger_current_index": 6643240
  }
}

JSON-RPC

200 OK

{
    "result": {
        "ledger_current_index": 8696233,
        "status": "success"
    }
}

Commandline

{
   "result" : {
      "ledger_current_index" : 56844050,
      "status" : "success"
   }
}

The response follows the [standard format][], with a successful result containing the following field:

Field Type Description
ledger_current_index Unsigned Integer - [Ledger Index][] The ledger index of this ledger version.

A ledger_hash field is not provided, because the hash of the current ledger is constantly changing along with its contents.

Possible Errors

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

{% include '_snippets/rippled_versions.md' %} {% include '_snippets/rippled-api-links.md' %}