Skip to content
Prerelease Docs
/
/
/
Updated APIs
Edit

Updated APIs

This page describes updates to existing RPC methods introduced by XLS-68: Sponsored Fees and Reserves.

(Requires the Sponsor amendment )

account_objects

The account_objects method adds a new optional filter parameter to query sponsored objects.

FieldTypeRequired?Description
sponsoredBooleanNoIf true, returns only sponsored objects (objects with a Sponsor, HighSponsor, or LowSponsor field). If false, returns only non-sponsored objects. If omitted, returns all objects (existing behavior).

Request Format

An example of the request format:

{
  "id": 1,
  "command": "account_objects",
  "account": "rN7n7otQDd6FczFgLdlqtyMVrn3HMfXpf",
  "sponsored": true,
  "ledger_index": "validated",
  "type": "state"
}

Response Format

An example of a successful response:

{
  "id": 1,
  "result": {
    "account": "rN7n7otQDd6FczFgLdlqtyMVrn3HMfXpf",
    "account_objects": [
      {
        "Balance": {
          "currency": "USD",
          "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
          "value": "100"
        },
        "Flags": 65536,
        "HighLimit": {
          "currency": "USD",
          "issuer": "rN7n7otQDd6FczFgLdlqtyMVrn3HMfXpf",
          "value": "1000"
        },
        "HighNode": "0000000000000000",
        "HighSponsor": "rSponsor1VktvzBz8JF2oJC6qaww6RZ7Lw",
        "LedgerEntryType": "RippleState",
        "LowLimit": {
          "currency": "USD",
          "issuer": "rfkDkFai4jUfCvAJiZ5Vm7XvvWjYvDqeYo",
          "value": "0"
        },
        "LowNode": "0000000000000000",
        "PreviousTxnID": "1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF",
        "PreviousTxnLgrSeq": 12345678,
        "index": "ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890"
      }
    ],
    "ledger_hash": "FEDCBA0987654321FEDCBA0987654321FEDCBA0987654321FEDCBA0987654321",
    "ledger_index": 56789012,
    "validated": true
  },
  "status": "success",
  "type": "response"
}