Honeycluster Docs – Get ledger objects owned by an account

Account Methods

Get ledger objects owned by an account

wss://honeycluster.io

rpc method: account_objects

Returns the raw ledger objects owned by an account. Can be filtered by type (offers, escrows, checks, etc.).

Try it now

Response · account_objects WS Response

{
  "result": {
    "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
    "account_objects": [
      {
        "Flags": 0,
        "LedgerEntryType": "Offer",
        "TakerGets": "5000000",
        "TakerPays": {
          "currency": "USD",
          "issuer": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
          "value": "2.5"
        }
      }
    ],
    "ledger_index": 89012345
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request Message

account_objects WS Request

application/json

Get ledger objects owned by an account

Field	Type	Description
`command` required	string	WebSocket command name
`id`	object	Client-supplied identifier to correlate requests with responses.
`account`	string	The account whose owned ledger objects to retrieve.
`type`	enum<string>	Filter by a specific type of ledger object. Available `checkdeposit_preauthescrownft_offernft_pageofferpayment_channelsigner_list`
`deletion_blockers_only`	boolean	If true, only return objects that would prevent this account from being deleted.
`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.
`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.
`api_version`	object	API version for the response format. Version 2 is the default for rippled 2.0+.

Example

Json

{
  "command": "account_objects",
  "id": 1,
  "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
  "type": "offer",
  "ledger_index": "validated",
  "limit": 10
}

Response Message

account_objects WS Response

application/json

WebSocket response for account_objects

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

Example

Json

{
  "result": {
    "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
    "account_objects": [
      {
        "Flags": 0,
        "LedgerEntryType": "Offer",
        "TakerGets": "5000000",
        "TakerPays": {
          "currency": "USD",
          "issuer": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
          "value": "2.5"
        }
      }
    ],
    "ledger_index": 89012345
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request

Payload · JSON

const ws = new WebSocket('wss://honeycluster.io');

ws.addEventListener('open', () => {
  const request = {
    "command": "account_objects",
    "id": 1,
    "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
    "type": "offer",
    "ledger_index": "validated",
    "limit": 10
  };
  ws.send(JSON.stringify(request));
});

ws.addEventListener('message', (event: MessageEvent<string>) => {
  const response: unknown = JSON.parse(event.data);
  console.log(response);
  ws.close();
});

Response · account_objects WS Response

{
  "result": {
    "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
    "account_objects": [
      {
        "Flags": 0,
        "LedgerEntryType": "Offer",
        "TakerGets": "5000000",
        "TakerPays": {
          "currency": "USD",
          "issuer": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
          "value": "2.5"
        }
      }
    ],
    "ledger_index": 89012345
  },
  "status": "success",
  "type": "response",
  "id": 1
}