Honeycluster Docs – Get raw ledger state data

Returns the raw contents of the specified ledger. Results are paginated for large data sets.

{ "result": { "ledger_hash": "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652", "ledger_index": 89012345, "marker": "0000000000000000000000000000000000000000000000000000000000000000", "state": [ { "data": "110061220000000024000000012500000003", "index": "00001A2969BE1FC85F1D7A55282FA2E6D95C71D2E4B9C0FDD47992D7D4BEAAAE", "type": "AccountRoot" } ] }, "status": "success", "type": "response", "id": 1 }

Field	Type	Description
`command` required	string	WebSocket command name
`id`	object	Client-supplied identifier to correlate requests with responses.
`ledger_index`	object	A ledger index (sequence number) or shortcut string identifying which ledger to use.
`ledger_hash`	string	256-bit hex hash identifying a specific ledger version.
`binary`	boolean	If true, return data in binary (hex) format instead of JSON.
`limit`	integer	Maximum number of results to return. Clio servers may return more than this.
`marker`	object	Opaque pagination marker from a previous response. Pass unchanged to fetch the next page.
`type`	string	Filter results by ledger entry type.
`api_version`	object	API version for the response format. Version 2 is the default for rippled 2.0+.

Field

Type

Description

command

required

string

WebSocket command name

id

object

Client-supplied identifier to correlate requests with responses.

ledger_index

object

A ledger index (sequence number) or shortcut string identifying which ledger to use.

ledger_hash

string

256-bit hex hash identifying a specific ledger version.

binary

boolean

If true, return data in binary (hex) format instead of JSON.

limit

integer

Maximum number of results to return. Clio servers may return more than this.

marker

object

Opaque pagination marker from a previous response. Pass unchanged to fetch the next page.

type

string

Filter results by ledger entry type.

api_version

object

API version for the response format. Version 2 is the default for rippled 2.0+.

Field	Type	Description
`result`	object
`status`	enum<string>	Available `successerror`
`type`	string
`id`	stringnumber	Echo of the client-provided correlation ID

Field

Type

Description

result

object

status

enum<string>

Available

successerror

type

string

id

stringnumber

Echo of the client-provided correlation ID

const ws = new WebSocket('wss://honeycluster.io'); ws.addEventListener('open', () => { const request = { "command": "ledger_data", "id": 1, "ledger_index": "validated", "limit": 5, "binary": false }; ws.send(JSON.stringify(request)); }); ws.addEventListener('message', (event: MessageEvent<string>) => { const response: unknown = JSON.parse(event.data); console.log(response); ws.close(); });