account_objects - XRPL

Example code for the account_objects JSON RPC method. Complete guide to using account_objects JSON-RPC in the GetBlock Web3 documentation.

This method returns the raw ledger format for all objects owned by an account including offers, trust lines, escrows, and payment channels.

Parameters

Parameter	Type	Required	Description
account	string	Yes	Account address
type	string	No	Filter by object type
ledger_hash	string	No	Ledger hash
ledger_index	string/number	No	Ledger index or shortcut
limit	number	No	Maximum results
marker	object	No	Pagination marker

Request Example

cURL

cURL

curl --location --request POST 'https://xrp.getblock.io/mainnet/' \
--header 'x-api-key: YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "method": "account_objects",
    "params": [{
        "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
        "type": "state"
    }],
    "id": "getblock.io"
}'

JavaScript (Axios)

Python

Rust

Response Example

{
    "result": {
        "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
        "account_objects": [
            {
                "Balance": {
                    "currency": "USD",
                    "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
                    "value": "100"
                },
                "LedgerEntryType": "RippleState"
            }
        ],
        "ledger_current_index": 63631836,
        "status": "success"
    }
}

Response Parameters

Parameter	Type	Description
account_objects	array	Ledger objects
LedgerEntryType	string	Object type
ledger_current_index	integer	Current ledger

Use Cases

• List all account objects

• Find open offers

• Check escrows

Error Handling

Error Code	Description
actNotFound	Account not found
invalidParams	Invalid parameters

SDK Integration

xrpl.js

xrpl.js example

const xrpl = require('xrpl');

async function getObjects() {
    const client = new xrpl.Client('wss://xrplcluster.com');
    await client.connect();
    
    const response = await client.request({
        command: 'account_objects',
        account: 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'
    });
    
    console.log('Objects:', response.result.account_objects.length);
    await client.disconnect();
}

getObjects();

xrpl-py