From 30e6767f5837a6104e50100281bc96158158a7e7 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Thu, 14 Aug 2025 14:49:26 -0700 Subject: [PATCH] Update account objects, ledger_data w/ separate list of short types --- .../account_objects/jsonrpc-response.json | 253 ++++ .../account_objects/ws-response.json | 256 ++++ .../ledger-entry-short-names.md | 39 + .../account-methods/account_objects.md | 1183 +---------------- .../ledger-methods/ledger_data.md | 24 +- sidebars.yaml | 3 +- 6 files changed, 578 insertions(+), 1180 deletions(-) create mode 100644 _api-examples/account_objects/jsonrpc-response.json create mode 100644 _api-examples/account_objects/ws-response.json create mode 100644 docs/references/http-websocket-apis/api-conventions/ledger-entry-short-names.md diff --git a/_api-examples/account_objects/jsonrpc-response.json b/_api-examples/account_objects/jsonrpc-response.json new file mode 100644 index 0000000000..fa011d4f5e --- /dev/null +++ b/_api-examples/account_objects/jsonrpc-response.json @@ -0,0 +1,253 @@ +{ + "result": { + "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "account_objects": [ + { + "Balance": { + "currency": "ASP", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "0" + }, + "Flags": 65536, + "HighLimit": { + "currency": "ASP", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "0" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "ASP", + "issuer": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z", + "value": "10" + }, + "LowNode": "0", + "PreviousTxnID": "BF7555B0F018E3C5E2A3FF9437A1A5092F32903BE246202F988181B9CED0D862", + "PreviousTxnLgrSeq": 1438879, + "index": "2243B0B630EA6F7330B654EFA53E27A7609D9484E535AB11B7F946DF3D247CE9" + }, + { + "Balance": { + "currency": "JOE", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "0" + }, + "Flags": 2228224, + "HighLimit": { + "currency": "JOE", + "issuer": "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2", + "value": "100" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "JOE", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "0" + }, + "LowNode": "0", + "PreviousTxnID": "8E488B0E939D4DACD62102A5BFA2FDC63679EFCC56F2FDA2FDF45283674BB711", + "PreviousTxnLgrSeq": 5989200, + "index": "273BD42DD72E7D84416ED759CEC92DACCD12A4502287E50BECF816233C021ED1" + }, + { + "Balance": { + "currency": "USD", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "0" + }, + "Flags": 131072, + "HighLimit": { + "currency": "USD", + "issuer": "rEhDDUUNxpXgEHVJtC2cjXAgyx5VCFxdMF", + "value": "1" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "USD", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "0" + }, + "LowNode": "0", + "PreviousTxnID": "B6B410172C0B65575D89E464AF5B99937CC568822929ABF87DA75CBD11911932", + "PreviousTxnLgrSeq": 6592159, + "index": "2CC2B211F6D1159B5CFD07AF8717A9C51C985E2497B2875C192EE87266AB0F81" + }, + { + "Balance": { + "currency": "USD", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "5" + }, + "Flags": 1114112, + "HighLimit": { + "currency": "USD", + "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", + "value": "0" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "USD", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "5" + }, + "LowNode": "0", + "PreviousTxnID": "2A5C5D95880A254A2C57BB5332558205BC33B9F2B38D359A170283CB4CBD080A", + "PreviousTxnLgrSeq": 39498567, + "index": "2DECFAC23B77D5AEA6116C15F5C6D4669EBAEE9E7EE050A40FE2B1E47B6A9419" + }, + { + "Balance": { + "currency": "EUR", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "0.793598266778297" + }, + "Flags": 1114112, + "HighLimit": { + "currency": "EUR", + "issuer": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", + "value": "0" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "EUR", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "1" + }, + "LowNode": "0", + "PreviousTxnID": "E9345D44433EA368CFE1E00D84809C8E695C87FED18859248E13662D46A0EC46", + "PreviousTxnLgrSeq": 5447146, + "index": "4513749B30F4AF8DA11F077C448128D6486BF12854B760E4E5808714588AA915" + }, + { + "Balance": { + "currency": "CNY", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "0" + }, + "Flags": 2228224, + "HighLimit": { + "currency": "CNY", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "3" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "CNY", + "issuer": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK", + "value": "0" + }, + "LowNode": "8", + "PreviousTxnID": "2FDDC81F4394695B01A47913BEC4281AC9A283CC8F903C14ADEA970F60E57FCF", + "PreviousTxnLgrSeq": 5949673, + "index": "578C327DA8944BDE2E10C9BA36AFA2F43E06C8D1E8819FB225D266CBBCFDE5CE" + }, + { + "Balance": { + "currency": "DYM", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "1.336889190631542" + }, + "Flags": 65536, + "HighLimit": { + "currency": "DYM", + "issuer": "rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E", + "value": "0" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "DYM", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "3" + }, + "LowNode": "0", + "PreviousTxnID": "6DA2BD02DFB83FA4DAFC2651860B60071156171E9C021D9E0372A61A477FFBB1", + "PreviousTxnLgrSeq": 8818732, + "index": "5A2A5FF12E71AEE57564E624117BBA68DEF78CD564EF6259F92A011693E027C7" + }, + { + "Balance": { + "currency": "BTC", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "0" + }, + "Flags": 131072, + "HighLimit": { + "currency": "BTC", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "3" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "BTC", + "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", + "value": "0" + }, + "LowNode": "43", + "PreviousTxnID": "03EDF724397D2DEE70E49D512AECD619E9EA536BE6CFD48ED167AE2596055C9A", + "PreviousTxnLgrSeq": 8317037, + "index": "767C12AF647CDF5FEB9019B37018748A79C50EDAF87E8D4C7F39F78AA7CA9765" + }, + { + "Balance": { + "currency": "USD", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "-11.68225001668339" + }, + "Flags": 131072, + "HighLimit": { + "currency": "USD", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "5000" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "USD", + "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", + "value": "0" + }, + "LowNode": "4a", + "PreviousTxnID": "8C55AFC2A2AA42B5CE624AEECDB3ACFDD1E5379D4E5BF74A8460C5E97EF8706B", + "PreviousTxnLgrSeq": 43251698, + "index": "826CF5BFD28F3934B518D0BDF3231259CBD3FD0946E3C3CA0C97D2C75D2D1A09" + }, + { + "Balance": { + "currency": "USD", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "0" + }, + "Flags": 2228224, + "HighLimit": { + "currency": "USD", + "issuer": "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2", + "value": "100" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "USD", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "0" + }, + "LowNode": "0", + "PreviousTxnID": "B1A7405C4A698E6A371E5B02836E779A942936AB754865FE82141E5280F09D1B", + "PreviousTxnLgrSeq": 5718137, + "index": "8DF1456AAB7470A760F6A095C156B457FF1038D43E6B11FD8011C2DF714E4FA1" + } + ], + "ledger_hash": "E471A081996BB5CBB666AC99085CB8E3CA4D59DFCEDC0060B8701DC45A0EE423", + "ledger_index": 98162290, + "limit": 10, + "marker": "F60ADF645E78B69857D2E4AEC8B7742FEABC8431BD8611D099B428C3E816DF93,94A9F05FEF9A153229E2E997E64919FD75AAE2028C8153E8EBDB4440BD3ECBB5", + "status": "success", + "validated": true + } +} diff --git a/_api-examples/account_objects/ws-response.json b/_api-examples/account_objects/ws-response.json new file mode 100644 index 0000000000..983e1b3aeb --- /dev/null +++ b/_api-examples/account_objects/ws-response.json @@ -0,0 +1,256 @@ +{ + "id": "example_account_objects", + "result": { + "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "account_objects": [ + { + "Balance": { + "currency": "ASP", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "0" + }, + "Flags": 65536, + "HighLimit": { + "currency": "ASP", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "0" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "ASP", + "issuer": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z", + "value": "10" + }, + "LowNode": "0", + "PreviousTxnID": "BF7555B0F018E3C5E2A3FF9437A1A5092F32903BE246202F988181B9CED0D862", + "PreviousTxnLgrSeq": 1438879, + "index": "2243B0B630EA6F7330B654EFA53E27A7609D9484E535AB11B7F946DF3D247CE9" + }, + { + "Balance": { + "currency": "JOE", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "0" + }, + "Flags": 2228224, + "HighLimit": { + "currency": "JOE", + "issuer": "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2", + "value": "100" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "JOE", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "0" + }, + "LowNode": "0", + "PreviousTxnID": "8E488B0E939D4DACD62102A5BFA2FDC63679EFCC56F2FDA2FDF45283674BB711", + "PreviousTxnLgrSeq": 5989200, + "index": "273BD42DD72E7D84416ED759CEC92DACCD12A4502287E50BECF816233C021ED1" + }, + { + "Balance": { + "currency": "USD", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "0" + }, + "Flags": 131072, + "HighLimit": { + "currency": "USD", + "issuer": "rEhDDUUNxpXgEHVJtC2cjXAgyx5VCFxdMF", + "value": "1" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "USD", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "0" + }, + "LowNode": "0", + "PreviousTxnID": "B6B410172C0B65575D89E464AF5B99937CC568822929ABF87DA75CBD11911932", + "PreviousTxnLgrSeq": 6592159, + "index": "2CC2B211F6D1159B5CFD07AF8717A9C51C985E2497B2875C192EE87266AB0F81" + }, + { + "Balance": { + "currency": "USD", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "5" + }, + "Flags": 1114112, + "HighLimit": { + "currency": "USD", + "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", + "value": "0" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "USD", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "5" + }, + "LowNode": "0", + "PreviousTxnID": "2A5C5D95880A254A2C57BB5332558205BC33B9F2B38D359A170283CB4CBD080A", + "PreviousTxnLgrSeq": 39498567, + "index": "2DECFAC23B77D5AEA6116C15F5C6D4669EBAEE9E7EE050A40FE2B1E47B6A9419" + }, + { + "Balance": { + "currency": "EUR", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "0.793598266778297" + }, + "Flags": 1114112, + "HighLimit": { + "currency": "EUR", + "issuer": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", + "value": "0" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "EUR", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "1" + }, + "LowNode": "0", + "PreviousTxnID": "E9345D44433EA368CFE1E00D84809C8E695C87FED18859248E13662D46A0EC46", + "PreviousTxnLgrSeq": 5447146, + "index": "4513749B30F4AF8DA11F077C448128D6486BF12854B760E4E5808714588AA915" + }, + { + "Balance": { + "currency": "CNY", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "0" + }, + "Flags": 2228224, + "HighLimit": { + "currency": "CNY", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "3" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "CNY", + "issuer": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK", + "value": "0" + }, + "LowNode": "8", + "PreviousTxnID": "2FDDC81F4394695B01A47913BEC4281AC9A283CC8F903C14ADEA970F60E57FCF", + "PreviousTxnLgrSeq": 5949673, + "index": "578C327DA8944BDE2E10C9BA36AFA2F43E06C8D1E8819FB225D266CBBCFDE5CE" + }, + { + "Balance": { + "currency": "DYM", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "1.336889190631542" + }, + "Flags": 65536, + "HighLimit": { + "currency": "DYM", + "issuer": "rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E", + "value": "0" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "DYM", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "3" + }, + "LowNode": "0", + "PreviousTxnID": "6DA2BD02DFB83FA4DAFC2651860B60071156171E9C021D9E0372A61A477FFBB1", + "PreviousTxnLgrSeq": 8818732, + "index": "5A2A5FF12E71AEE57564E624117BBA68DEF78CD564EF6259F92A011693E027C7" + }, + { + "Balance": { + "currency": "BTC", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "0" + }, + "Flags": 131072, + "HighLimit": { + "currency": "BTC", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "3" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "BTC", + "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", + "value": "0" + }, + "LowNode": "43", + "PreviousTxnID": "03EDF724397D2DEE70E49D512AECD619E9EA536BE6CFD48ED167AE2596055C9A", + "PreviousTxnLgrSeq": 8317037, + "index": "767C12AF647CDF5FEB9019B37018748A79C50EDAF87E8D4C7F39F78AA7CA9765" + }, + { + "Balance": { + "currency": "USD", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "-11.68225001668339" + }, + "Flags": 131072, + "HighLimit": { + "currency": "USD", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "5000" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "USD", + "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", + "value": "0" + }, + "LowNode": "4a", + "PreviousTxnID": "8C55AFC2A2AA42B5CE624AEECDB3ACFDD1E5379D4E5BF74A8460C5E97EF8706B", + "PreviousTxnLgrSeq": 43251698, + "index": "826CF5BFD28F3934B518D0BDF3231259CBD3FD0946E3C3CA0C97D2C75D2D1A09" + }, + { + "Balance": { + "currency": "USD", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", + "value": "0" + }, + "Flags": 2228224, + "HighLimit": { + "currency": "USD", + "issuer": "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2", + "value": "100" + }, + "HighNode": "0", + "LedgerEntryType": "RippleState", + "LowLimit": { + "currency": "USD", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", + "value": "0" + }, + "LowNode": "0", + "PreviousTxnID": "B1A7405C4A698E6A371E5B02836E779A942936AB754865FE82141E5280F09D1B", + "PreviousTxnLgrSeq": 5718137, + "index": "8DF1456AAB7470A760F6A095C156B457FF1038D43E6B11FD8011C2DF714E4FA1" + } + ], + "ledger_hash": "59D7E38286AD80C402EC1533BFE002285E792698EEFA06BD3D5AEAC618B56B0A", + "ledger_index": 98162008, + "limit": 10, + "marker": "F60ADF645E78B69857D2E4AEC8B7742FEABC8431BD8611D099B428C3E816DF93,94A9F05FEF9A153229E2E997E64919FD75AAE2028C8153E8EBDB4440BD3ECBB5|NONFH", + "validated": true, + "_nodepref": "nonfh" + }, + "status": "success", + "type": "response" +} diff --git a/docs/references/http-websocket-apis/api-conventions/ledger-entry-short-names.md b/docs/references/http-websocket-apis/api-conventions/ledger-entry-short-names.md new file mode 100644 index 0000000000..0aa266f05b --- /dev/null +++ b/docs/references/http-websocket-apis/api-conventions/ledger-entry-short-names.md @@ -0,0 +1,39 @@ +# Short Names of Ledger Entries + +Some API methods, specifically the [account_objects method][] and [ledger_data method][], allow filtering the ledger entries they return based on the type of ledger entry. The type field you specify can use either the canonical name of the [ledger entry](../../protocol/ledger-data/ledger-entry-types/index.md) or a short name, as in the following table. + +The "Ownable" column indicates whether the ledger entry type can appear in owner directories. Ledger entries that are not ownable cannot appear in `account_objects` responses and cannot be used as a `type` filter in that method. + +| Canonical Name | Short Name | Ownable | Related Amendment | +| -------------------- | --------------------- | ------- |---| +| `AccountRoot` | `account` | No | | +| `Amendments` | `amendments` | No | | +| `AMM` | `amm` | No | {% amendment-disclaimer name="AMM" compact=true /%} | +| `Bridge` | `bridge` | Yes | {% amendment-disclaimer name="XChainBridge" compact=true /%} | +| `Check` | `check` | Yes | {% amendment-disclaimer name="Checks" compact=true /%} | +| `Credential` | `credential` | Yes | {% amendment-disclaimer name="Credentials" compact=true /%} | +| `Delegate` | `delegate` | Yes | {% amendment-disclaimer name="PermissionDelegation" compact=true /%} | +| `DepositPreauth` | `deposit_preauth` | Yes | {% amendment-disclaimer name="DepositPreauth" compact=true /%} | +| `DID` | `did` | Yes | {% amendment-disclaimer name="DID" compact=true /%} | +| `DirectoryNode` | `directory` | No | | +| `Escrow` | `escrow` | Yes | | +| `FeeSettings` | `fee` | No | | +| `LedgerHashes` | `hashes` | No | | +| `MPToken` | `mptoken` | Yes | {% amendment-disclaimer name="MPTokensV1" compact=true /%} | +| `MPTokenIssuance` | `mpt_issuance` | Yes | {% amendment-disclaimer name="MPTokensV1" compact=true /%} | +| `NegativeUNL` | `nunl` | No | {% amendment-disclaimer name="NegativeUNL" compact=true /%} | +| `NFTokenOffer` | `nft_offer` | Yes | {% amendment-disclaimer name="NonFungibleTokensV1_1" compact=true /%} | +| `NFTokenPage` | `nft_page` | Yes | {% amendment-disclaimer name="NonFungibleTokensV1_1" compact=true /%} | +| `Offer` | `offer` | Yes | | +| `Oracle` | `oracle` | Yes | {% amendment-disclaimer name="PriceOracle" compact=true /%} | +| `PayChannel` | `payment_channel` | Yes | | +| `PermissionedDomain` | `permissioned_domain` | Yes | {% amendment-disclaimer name="PermissionedDomains" compact=true /%} | +| `RippleState` | `state` | Yes | | +| `SignerList` | `signer_list` | Yes | | +| `Ticket` | `ticket` | Yes | {% amendment-disclaimer name="TicketBatch" compact=true /%} | +| `XChainOwnedClaimID` | `xchain_owned_claim_id` | Yes | {% amendment-disclaimer name="XChainBridge" compact=true /%} | +| `XChainOwnedCreate``AccountClaimID` | `xchain_owned_``create_account_claim_id` | Yes | {% amendment-disclaimer name="XChainBridge" compact=true /%} | + + + +{% raw-partial file="/docs/_snippets/common-links.md" /%} diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md index b59a919901..f266f04007 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md @@ -1,6 +1,4 @@ --- -html: account_objects.html -parent: account-methods.html seo: description: Get all ledger objects owned by an account. labels: @@ -8,23 +6,11 @@ labels: - Data Retention --- # account_objects -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/AccountObjects.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/AccountObjects.cpp "Source") -The `account_objects` command returns the raw [ledger format][] for all ledger entries owned by an account. For a higher-level view of an account's trust lines and balances, see the [account_lines method][] instead. +The `account_objects` command returns _all_ ledger entries owned by an account, in their raw [ledger format][]. -The types of objects that may appear in the `account_objects` response include: - -- [Bridge entries](../../../protocol/ledger-data/ledger-entry-types/bridge.md) for cross-chain bridges. _(Requires the [XChainBridge amendment][] {% not-enabled /%})_ -- [Check entries](../../../protocol/ledger-data/ledger-entry-types/check.md) for pending Checks. -- [DepositPreauth entries](../../../protocol/ledger-data/ledger-entry-types/depositpreauth.md) for deposit preauthorizations. -- [Escrow entries](../../../../concepts/payment-types/escrow.md) for held payments that have not yet been executed or canceled. -- [NFTokenOffer entries](../../../protocol/ledger-data/ledger-entry-types/nftokenoffer.md) for offers to buy or sell an NFT. -- [NFTokenPage entries](../../../protocol/ledger-data/ledger-entry-types/nftokenpage.md) for collections of NFTs. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.11.0" %}New in: rippled 1.11.0{% /badge %} -- [Offer entries](../../../protocol/ledger-data/ledger-entry-types/offer.md) for orders that are currently live, unfunded, or expired but not yet removed. (See [Lifecycle of an Offer](../../../../concepts/tokens/decentralized-exchange/offers.md#lifecycle-of-an-offer) for more information.) -- [PayChannel entries](../../../protocol/ledger-data/ledger-entry-types/paychannel.md) for open payment channels. -- [RippleState entries](../../../protocol/ledger-data/ledger-entry-types/ripplestate.md) for trust lines where this account's side is not in the default state. -- The account's [SignerList](../../../protocol/ledger-data/ledger-entry-types/signerlist.md), if the account has [multi-signing](../../../../concepts/accounts/multi-signing.md) enabled. -- [Ticket entries](../../../../concepts/accounts/tickets.md) for Tickets. +There are other API methods that are specialized for getting certain types of ledger entry, such as the [account_lines method][] for trust lines, or [account_offers method][] for offers. These methods provide a processed view of the data that is more suitable for typical use cases. Use `account_objects` if you want to get ledger entries of types that don't have a specialized method, or if you want to get the entries in their canonical format. ## Request Format @@ -35,7 +21,7 @@ An example of the request format: {% tab label="WebSocket" %} ```json { - "id": 8, + "id": "example_account_objects", "command": "account_objects", "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "ledger_index": "validated", @@ -76,36 +62,16 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated The request includes the following parameters: -| `Field` | Type | Required? | Description | -|:-------------------------|:-----------------|:----------|-------------| -| `account` | String | Yes | A unique identifier for the account, most commonly the account's [Address][]. | -| `amount` | Object or String | No | The amount to be delivered by the held payment. | -| `deletion_blockers_only` | Boolean | No | If `true`, the response only includes objects that would block this account from [being deleted](../../../../concepts/accounts/deleting-accounts.md). The default is `false`. | -| `ledger_hash` | [Hash][] | No | The unique hash of the ledger version to use. (See [Specifying Ledgers][]) | -| `ledger_index` | [Ledger Index][] | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | -| `limit` | Number | No | The maximum number of objects to include in the results. Must be within the inclusive range `10` to `400` on non-admin connections. The default is `200`. | -| `marker` | [Marker][] | No | Value from a previous paginated response. Resume retrieving data where that response left off. | -| `transfer_rate` | Number | No | The fee to charge when users finish an escrow, initially set on the creation of an escrow contract, and updated on subsequent finish transactions. | -| `type` | String | No | Filter results to a specific type of ledger entry. This field accepts canonical ledger entry names (case insensitive) or short names. | +| `Field` | Type | Required? | Description | +|:-------------------------|:---------------------|:----------|-------------| +| `account` | String - [Address][] | Yes | Get ledger entries associated with this account. | +| `deletion_blockers_only` | Boolean | No | If `true`, only return ledger entries that would block this account from [being deleted](../../../../concepts/accounts/deleting-accounts.md). The default is `false`. | +| `ledger_hash` | [Hash][] | No | The unique hash of the ledger version to use. (See [Specifying Ledgers][]) | +| `ledger_index` | [Ledger Index][] | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `limit` | Number | No | The maximum number of ledger entries to include in the results. Must be within the inclusive range `10` to `400` on non-admin connections. The default is `200`. | +| `marker` | [Marker][] | No | Value from a previous paginated response. Resume retrieving data where that response left off. | +| `type` | String | No | Filter results to a specific type of ledger entry. This field accepts canonical names of [ledger entry types](../../../protocol/ledger-data/ledger-entry-types/index.md) (case insensitive) or [short names](../../api-conventions/ledger-entry-short-names.md). Ledger entry types that can't appear in an owner directory are not allowed. If omitted, return ledger entries of all types. | -Valid `type` field values are: - -| Canonical Name | Short Name | -| ---------------- | ----------------- | -| `Bridge` | `bridge` | -| `Check` | `check` | -| `DepositPreauth` | `deposit_preauth` | -| `Escrow` | `escrow` | -| `MPToken` | `mptoken` | -| `NFTokenOffer` | `nft_offer` | -| `NFTokenPage` | `nft_page` | -| `Offer` | `offer` | -| `PayChannel` | `payment_channel` | -| `RippleState` | `state` | -| `SignerList` | `signer_list` | -| `Ticket` | `ticket` | - -{% admonition type="info" name="Note" %}MPToken requires the [MPToken amendment][] {% not-enabled /%}.{% /admonition %} {% admonition type="info" name="Note" %}The commandline interface to the `account_objects` command doesn't accept the `type` field. Use the [json method][] to send the JSON-RPC format request on the commandline instead.{% /admonition %} ## Response Format @@ -115,1114 +81,15 @@ An example of a successful response: {% tabs %} {% tab label="WebSocket" %} -```json -{ - "id": 8, - "status": "success", - "type": "response", - "result": { - "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "account_objects": [ - { - "Balance": { - "currency": "ASP", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0" - }, - "Flags": 65536, - "HighLimit": { - "currency": "ASP", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "ASP", - "issuer": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z", - "value": "10" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": "BF7555B0F018E3C5E2A3FF9437A1A5092F32903BE246202F988181B9CED0D862", - "PreviousTxnLgrSeq": 1438879, - "index": "2243B0B630EA6F7330B654EFA53E27A7609D9484E535AB11B7F946DF3D247CE9" - }, - { - "Balance": { - "currency": "XAU", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0" - }, - "Flags": 3342336, - "HighLimit": { - "currency": "XAU", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "XAU", - "issuer": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z", - "value": "0" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": "79B26D7D34B950AC2C2F91A299A6888FABB376DD76CFF79D56E805BF439F6942", - "PreviousTxnLgrSeq": 5982530, - "index": "9ED4406351B7A511A012A9B5E7FE4059FA2F7650621379C0013492C315E25B97" - }, - { - "Balance": { - "currency": "USD", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0" - }, - "Flags": 1114112, - "HighLimit": { - "currency": "USD", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "USD", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "5" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": "6FE8C824364FB1195BCFEDCB368DFEE3980F7F78D3BF4DC4174BB4C86CF8C5CE", - "PreviousTxnLgrSeq": 10555014, - "index": "2DECFAC23B77D5AEA6116C15F5C6D4669EBAEE9E7EE050A40FE2B1E47B6A9419" - }, - { - "Balance": { - "currency": "MXN", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "481.992867407479" - }, - "Flags": 65536, - "HighLimit": { - "currency": "MXN", - "issuer": "rHpXfibHgSb64n8kK9QWDpdbfqSpYbM9a4", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "MXN", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "1000" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": "A467BACE5F183CDE1F075F72435FE86BAD8626ED1048EDEFF7562A4CC76FD1C5", - "PreviousTxnLgrSeq": 3316170, - "index": "EC8B9B6B364AF6CB6393A423FDD2DDBA96375EC772E6B50A3581E53BFBDFDD9A" - }, - { - "Balance": { - "currency": "EUR", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0.793598266778297" - }, - "Flags": 1114112, - "HighLimit": { - "currency": "EUR", - "issuer": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "EUR", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "1" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": "E9345D44433EA368CFE1E00D84809C8E695C87FED18859248E13662D46A0EC46", - "PreviousTxnLgrSeq": 5447146, - "index": "4513749B30F4AF8DA11F077C448128D6486BF12854B760E4E5808714588AA915" - }, - { - "Balance": { - "currency": "CNY", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0" - }, - "Flags": 2228224, - "HighLimit": { - "currency": "CNY", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "3" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "CNY", - "issuer": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK", - "value": "0" - }, - "LowNode": "0000000000000008", - "PreviousTxnID": "2FDDC81F4394695B01A47913BEC4281AC9A283CC8F903C14ADEA970F60E57FCF", - "PreviousTxnLgrSeq": 5949673, - "index": "578C327DA8944BDE2E10C9BA36AFA2F43E06C8D1E8819FB225D266CBBCFDE5CE" - }, - { - "Balance": { - "currency": "DYM", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "1.336889190631542" - }, - "Flags": 65536, - "HighLimit": { - "currency": "DYM", - "issuer": "rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "DYM", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "3" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": "6DA2BD02DFB83FA4DAFC2651860B60071156171E9C021D9E0372A61A477FFBB1", - "PreviousTxnLgrSeq": 8818732, - "index": "5A2A5FF12E71AEE57564E624117BBA68DEF78CD564EF6259F92A011693E027C7" - }, - { - "Balance": { - "currency": "CHF", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "-0.3488146605801446" - }, - "Flags": 131072, - "HighLimit": { - "currency": "CHF", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "CHF", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0" - }, - "LowNode": "000000000000008C", - "PreviousTxnID": "722394372525A13D1EAAB005642F50F05A93CF63F7F472E0F91CDD6D38EB5869", - "PreviousTxnLgrSeq": 2687590, - "index": "F2DBAD20072527F6AD02CE7F5A450DBC72BE2ABB91741A8A3ADD30D5AD7A99FB" - }, - { - "Balance": { - "currency": "BTC", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0" - }, - "Flags": 131072, - "HighLimit": { - "currency": "BTC", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "3" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0" - }, - "LowNode": "0000000000000043", - "PreviousTxnID": "03EDF724397D2DEE70E49D512AECD619E9EA536BE6CFD48ED167AE2596055C9A", - "PreviousTxnLgrSeq": 8317037, - "index": "767C12AF647CDF5FEB9019B37018748A79C50EDAF87E8D4C7F39F78AA7CA9765" - }, - { - "Balance": { - "currency": "USD", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "-16.00534471983042" - }, - "Flags": 131072, - "HighLimit": { - "currency": "USD", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "5000" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0" - }, - "LowNode": "000000000000004A", - "PreviousTxnID": "CFFF5CFE623C9543308C6529782B6A6532207D819795AAFE85555DB8BF390FE7", - "PreviousTxnLgrSeq": 14365854, - "index": "826CF5BFD28F3934B518D0BDF3231259CBD3FD0946E3C3CA0C97D2C75D2D1A09" - } - ], - "ledger_hash": "053DF17D2289D1C4971C22F235BC1FCA7D4B3AE966F842E5819D0749E0B8ECD3", - "ledger_index": 14378733, - "limit": 10, - "marker": "F60ADF645E78B69857D2E4AEC8B7742FEABC8431BD8611D099B428C3E816DF93,94A9F05FEF9A153229E2E997E64919FD75AAE2028C8153E8EBDB4440BD3ECBB5", - "validated": true - } -} -``` +{% code-snippet file="/_api-examples/account_objects/ws-response.json" language="json" /%} {% /tab %} {% tab label="JSON-RPC" %} -```json -200 OK -{ - "result": { - "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "account_objects": [ - { - "Balance": { - "currency": "ASP", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0" - }, - "Flags": 65536, - "HighLimit": { - "currency": "ASP", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "ASP", - "issuer": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z", - "value": "10" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": "BF7555B0F018E3C5E2A3FF9437A1A5092F32903BE246202F988181B9CED0D862", - "PreviousTxnLgrSeq": 1438879, - "index": "2243B0B630EA6F7330B654EFA53E27A7609D9484E535AB11B7F946DF3D247CE9" - }, - { - "Balance": { - "currency": "XAU", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0" - }, - "Flags": 3342336, - "HighLimit": { - "currency": "XAU", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "XAU", - "issuer": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z", - "value": "0" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": "79B26D7D34B950AC2C2F91A299A6888FABB376DD76CFF79D56E805BF439F6942", - "PreviousTxnLgrSeq": 5982530, - "index": "9ED4406351B7A511A012A9B5E7FE4059FA2F7650621379C0013492C315E25B97" - }, - { - "Balance": { - "currency": "USD", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0" - }, - "Flags": 1114112, - "HighLimit": { - "currency": "USD", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "USD", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "5" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": "6FE8C824364FB1195BCFEDCB368DFEE3980F7F78D3BF4DC4174BB4C86CF8C5CE", - "PreviousTxnLgrSeq": 10555014, - "index": "2DECFAC23B77D5AEA6116C15F5C6D4669EBAEE9E7EE050A40FE2B1E47B6A9419" - }, - { - "Balance": { - "currency": "MXN", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "481.992867407479" - }, - "Flags": 65536, - "HighLimit": { - "currency": "MXN", - "issuer": "rHpXfibHgSb64n8kK9QWDpdbfqSpYbM9a4", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "MXN", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "1000" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": "A467BACE5F183CDE1F075F72435FE86BAD8626ED1048EDEFF7562A4CC76FD1C5", - "PreviousTxnLgrSeq": 3316170, - "index": "EC8B9B6B364AF6CB6393A423FDD2DDBA96375EC772E6B50A3581E53BFBDFDD9A" - }, - { - "Balance": { - "currency": "EUR", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0.793598266778297" - }, - "Flags": 1114112, - "HighLimit": { - "currency": "EUR", - "issuer": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "EUR", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "1" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": "E9345D44433EA368CFE1E00D84809C8E695C87FED18859248E13662D46A0EC46", - "PreviousTxnLgrSeq": 5447146, - "index": "4513749B30F4AF8DA11F077C448128D6486BF12854B760E4E5808714588AA915" - }, - { - "Balance": { - "currency": "CNY", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0" - }, - "Flags": 2228224, - "HighLimit": { - "currency": "CNY", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "3" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "CNY", - "issuer": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK", - "value": "0" - }, - "LowNode": "0000000000000008", - "PreviousTxnID": "2FDDC81F4394695B01A47913BEC4281AC9A283CC8F903C14ADEA970F60E57FCF", - "PreviousTxnLgrSeq": 5949673, - "index": "578C327DA8944BDE2E10C9BA36AFA2F43E06C8D1E8819FB225D266CBBCFDE5CE" - }, - { - "Balance": { - "currency": "DYM", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "1.336889190631542" - }, - "Flags": 65536, - "HighLimit": { - "currency": "DYM", - "issuer": "rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "DYM", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "3" - }, - "LowNode": "0000000000000000", - "PreviousTxnID": "6DA2BD02DFB83FA4DAFC2651860B60071156171E9C021D9E0372A61A477FFBB1", - "PreviousTxnLgrSeq": 8818732, - "index": "5A2A5FF12E71AEE57564E624117BBA68DEF78CD564EF6259F92A011693E027C7" - }, - { - "Balance": { - "currency": "CHF", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "-0.3488146605801446" - }, - "Flags": 131072, - "HighLimit": { - "currency": "CHF", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "0" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "CHF", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0" - }, - "LowNode": "000000000000008C", - "PreviousTxnID": "722394372525A13D1EAAB005642F50F05A93CF63F7F472E0F91CDD6D38EB5869", - "PreviousTxnLgrSeq": 2687590, - "index": "F2DBAD20072527F6AD02CE7F5A450DBC72BE2ABB91741A8A3ADD30D5AD7A99FB" - }, - { - "Balance": { - "currency": "BTC", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "0" - }, - "Flags": 131072, - "HighLimit": { - "currency": "BTC", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "3" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0" - }, - "LowNode": "0000000000000043", - "PreviousTxnID": "03EDF724397D2DEE70E49D512AECD619E9EA536BE6CFD48ED167AE2596055C9A", - "PreviousTxnLgrSeq": 8317037, - "index": "767C12AF647CDF5FEB9019B37018748A79C50EDAF87E8D4C7F39F78AA7CA9765" - }, - { - "Balance": { - "currency": "USD", - "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value": "-16.00534471983042" - }, - "Flags": 131072, - "HighLimit": { - "currency": "USD", - "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value": "5000" - }, - "HighNode": "0000000000000000", - "LedgerEntryType": "RippleState", - "LowLimit": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value": "0" - }, - "LowNode": "000000000000004A", - "PreviousTxnID": "CFFF5CFE623C9543308C6529782B6A6532207D819795AAFE85555DB8BF390FE7", - "PreviousTxnLgrSeq": 14365854, - "index": "826CF5BFD28F3934B518D0BDF3231259CBD3FD0946E3C3CA0C97D2C75D2D1A09" - } - ], - "ledger_hash": "4C99E5F63C0D0B1C2283B4F5DCE2239F80CE92E8B1A6AED1E110C198FC96E659", - "ledger_index": 14380380, - "limit": 10, - "marker": "F60ADF645E78B69857D2E4AEC8B7742FEABC8431BD8611D099B428C3E816DF93,94A9F05FEF9A153229E2E997E64919FD75AAE2028C8153E8EBDB4440BD3ECBB5", - "status": "success", - "validated": true - } -} -``` +{% code-snippet file="/_api-examples/account_objects/jsonrpc-response.json" language="json" prefix="200 OK\n\n" /%} {% /tab %} {% tab label="Commandline" %} -```json -{ - "result" : { - "account" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "account_objects" : [ - { - "Balance" : { - "currency" : "ASP", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "0" - }, - "Flags" : 65536, - "HighLimit" : { - "currency" : "ASP", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "0" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "ASP", - "issuer" : "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z", - "value" : "10" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "BF7555B0F018E3C5E2A3FF9437A1A5092F32903BE246202F988181B9CED0D862", - "PreviousTxnLgrSeq" : 1438879, - "index" : "2243B0B630EA6F7330B654EFA53E27A7609D9484E535AB11B7F946DF3D247CE9" - }, - { - "Balance" : { - "currency" : "XAU", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "0" - }, - "Flags" : 3342336, - "HighLimit" : { - "currency" : "XAU", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "0" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "XAU", - "issuer" : "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z", - "value" : "0" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "79B26D7D34B950AC2C2F91A299A6888FABB376DD76CFF79D56E805BF439F6942", - "PreviousTxnLgrSeq" : 5982530, - "index" : "9ED4406351B7A511A012A9B5E7FE4059FA2F7650621379C0013492C315E25B97" - }, - { - "Balance" : { - "currency" : "USD", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "5" - }, - "Flags" : 1114112, - "HighLimit" : { - "currency" : "USD", - "issuer" : "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "value" : "0" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "USD", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "5" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "2A5C5D95880A254A2C57BB5332558205BC33B9F2B38D359A170283CB4CBD080A", - "PreviousTxnLgrSeq" : 39498567, - "index" : "2DECFAC23B77D5AEA6116C15F5C6D4669EBAEE9E7EE050A40FE2B1E47B6A9419" - }, - { - "Balance" : { - "currency" : "MXN", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "481.992867407479" - }, - "Flags" : 65536, - "HighLimit" : { - "currency" : "MXN", - "issuer" : "rHpXfibHgSb64n8kK9QWDpdbfqSpYbM9a4", - "value" : "0" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "MXN", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "1000" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "A467BACE5F183CDE1F075F72435FE86BAD8626ED1048EDEFF7562A4CC76FD1C5", - "PreviousTxnLgrSeq" : 3316170, - "index" : "EC8B9B6B364AF6CB6393A423FDD2DDBA96375EC772E6B50A3581E53BFBDFDD9A" - }, - { - "Balance" : { - "currency" : "EUR", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "0.793598266778297" - }, - "Flags" : 1114112, - "HighLimit" : { - "currency" : "EUR", - "issuer" : "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", - "value" : "0" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "EUR", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "1" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "E9345D44433EA368CFE1E00D84809C8E695C87FED18859248E13662D46A0EC46", - "PreviousTxnLgrSeq" : 5447146, - "index" : "4513749B30F4AF8DA11F077C448128D6486BF12854B760E4E5808714588AA915" - }, - { - "Balance" : { - "currency" : "CNY", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "0" - }, - "Flags" : 2228224, - "HighLimit" : { - "currency" : "CNY", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "3" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "CNY", - "issuer" : "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK", - "value" : "0" - }, - "LowNode" : "0000000000000008", - "PreviousTxnID" : "2FDDC81F4394695B01A47913BEC4281AC9A283CC8F903C14ADEA970F60E57FCF", - "PreviousTxnLgrSeq" : 5949673, - "index" : "578C327DA8944BDE2E10C9BA36AFA2F43E06C8D1E8819FB225D266CBBCFDE5CE" - }, - { - "Balance" : { - "currency" : "DYM", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "1.336889190631542" - }, - "Flags" : 65536, - "HighLimit" : { - "currency" : "DYM", - "issuer" : "rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E", - "value" : "0" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "DYM", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "3" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "6DA2BD02DFB83FA4DAFC2651860B60071156171E9C021D9E0372A61A477FFBB1", - "PreviousTxnLgrSeq" : 8818732, - "index" : "5A2A5FF12E71AEE57564E624117BBA68DEF78CD564EF6259F92A011693E027C7" - }, - { - "Balance" : { - "currency" : "CHF", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "-0.3488146605801446" - }, - "Flags" : 131072, - "HighLimit" : { - "currency" : "CHF", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "0" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "CHF", - "issuer" : "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value" : "0" - }, - "LowNode" : "000000000000008C", - "PreviousTxnID" : "722394372525A13D1EAAB005642F50F05A93CF63F7F472E0F91CDD6D38EB5869", - "PreviousTxnLgrSeq" : 2687590, - "index" : "F2DBAD20072527F6AD02CE7F5A450DBC72BE2ABB91741A8A3ADD30D5AD7A99FB" - }, - { - "Balance" : { - "currency" : "BTC", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "0" - }, - "Flags" : 131072, - "HighLimit" : { - "currency" : "BTC", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "3" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "BTC", - "issuer" : "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value" : "0" - }, - "LowNode" : "0000000000000043", - "PreviousTxnID" : "03EDF724397D2DEE70E49D512AECD619E9EA536BE6CFD48ED167AE2596055C9A", - "PreviousTxnLgrSeq" : 8317037, - "index" : "767C12AF647CDF5FEB9019B37018748A79C50EDAF87E8D4C7F39F78AA7CA9765" - }, - { - "Balance" : { - "currency" : "USD", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "-11.68225001668339" - }, - "Flags" : 131072, - "HighLimit" : { - "currency" : "USD", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "5000" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "USD", - "issuer" : "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value" : "0" - }, - "LowNode" : "000000000000004A", - "PreviousTxnID" : "8C55AFC2A2AA42B5CE624AEECDB3ACFDD1E5379D4E5BF74A8460C5E97EF8706B", - "PreviousTxnLgrSeq" : 43251698, - "index" : "826CF5BFD28F3934B518D0BDF3231259CBD3FD0946E3C3CA0C97D2C75D2D1A09" - }, - { - "Balance" : { - "currency" : "BTC", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "0.00111" - }, - "Flags" : 65536, - "HighLimit" : { - "currency" : "BTC", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "0" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "BTC", - "issuer" : "rpgKWEmNqSDAGFhy5WDnsyPqfQxbWxKeVd", - "value" : "10" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "74F2F2A731C1350492FA03F8C67AF6C05EEC391160AACC04BF99329D9EAB0052", - "PreviousTxnLgrSeq" : 585437, - "index" : "94A9F05FEF9A153229E2E997E64919FD75AAE2028C8153E8EBDB4440BD3ECBB5" - }, - { - "Balance" : { - "currency" : "BTC", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "-0.0008744482690504699" - }, - "Flags" : 131072, - "HighLimit" : { - "currency" : "BTC", - "issuer" : "rBJ3YjwXi2MGbg7GVLuTXUWQ8DjL7tDXh4", - "value" : "10" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "BTC", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "0" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "95221CD154317176B5748202A2E820D7A336597816E9787C27E3E4F25576877F", - "PreviousTxnLgrSeq" : 8208104, - "index" : "BC2AC65D7F9AD5CDAD131DEFE248727CA8A0FC219A33A3264E6202F50B4733C0" - }, - { - "Balance" : { - "currency" : "USD", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "0" - }, - "Flags" : 65536, - "HighLimit" : { - "currency" : "USD", - "issuer" : "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun", - "value" : "0" - }, - "HighNode" : "0000000000000002", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "USD", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "1" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "8C55AFC2A2AA42B5CE624AEECDB3ACFDD1E5379D4E5BF74A8460C5E97EF8706B", - "PreviousTxnLgrSeq" : 43251698, - "index" : "C493ABA2619D0FC6355BA862BC8312DF8266FBE76AFBA9636E857F7EAC874A99" - }, - { - "Balance" : { - "currency" : "CNY", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "-9.07619790068559" - }, - "Flags" : 2228224, - "HighLimit" : { - "currency" : "CNY", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "100" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "CNY", - "issuer" : "razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA", - "value" : "0" - }, - "LowNode" : "0000000000000005", - "PreviousTxnID" : "8EFE067DA1B2D57C485EFFCF875604548BA990EA00D019B466313D4CEE1E4668", - "PreviousTxnLgrSeq" : 8284705, - "index" : "C8554E6CE903505F631703E73D22D2D4D0662FDA9F524290997DF6B4D760C495" - }, - { - "Balance" : { - "currency" : "JPY", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "-7.292695098901099" - }, - "Flags" : 2228224, - "HighLimit" : { - "currency" : "JPY", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "0" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "JPY", - "issuer" : "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value" : "0" - }, - "LowNode" : "0000000000000076", - "PreviousTxnID" : "CE460D85F9AD93752E8EC8BCF4DFFE91DDF08B8C988836D64CB51EB7B447F672", - "PreviousTxnLgrSeq" : 5100078, - "index" : "CB1565898F19916A5EE49CC537B1D43CA075B9B96E82C6892E16EF6DFDEE7865" - }, - { - "Balance" : { - "currency" : "AUX", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "0" - }, - "Flags" : 3342336, - "HighLimit" : { - "currency" : "AUX", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "0" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "AUX", - "issuer" : "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z", - "value" : "0" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "A6964735A14272742E7E10EB5AB5A7CE693473BBB4DAFA488971A15E181132CF", - "PreviousTxnLgrSeq" : 5982528, - "index" : "C61E113C767A9E7B27CD944162FB63EAA24C38C8664E984759821C3ADFFE097E" - }, - { - "Balance" : { - "currency" : "USD", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "0.0004557360418801623" - }, - "Flags" : 1114112, - "HighLimit" : { - "currency" : "USD", - "issuer" : "r9vbV3EHvXWjSkeQ6CAcYVPGeq7TuiXY2X", - "value" : "0" - }, - "HighNode" : "0000000000000003", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "USD", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "1" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "F8F178712C0C3DA013A774A598B2A004BE6BA3D4542B8448D221A60D8A0D409A", - "PreviousTxnLgrSeq" : 38837233, - "index" : "D43180D7B2EEBB285C9D296590C4D5E5580C814F3026FC4D41FFDF3049FB547F" - }, - { - "Balance" : { - "currency" : "EUR", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "-12.41688780720394" - }, - "Flags" : 2228224, - "HighLimit" : { - "currency" : "EUR", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "100" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "EUR", - "issuer" : "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "value" : "0" - }, - "LowNode" : "000000000000008F", - "PreviousTxnID" : "1F0436C0688A8156EE2D7745B02C3F39C477A43F6BAD5D46C25A08949EF41739", - "PreviousTxnLgrSeq" : 5449071, - "index" : "F6B22B4D6A83B13A7F16E6A4A6EA8D3E26739C9D86C23DAC21C18E74B5E2C8CC" - }, - { - "Balance" : { - "currency" : "USD", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "-35" - }, - "Flags" : 2228224, - "HighLimit" : { - "currency" : "USD", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "500" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "USD", - "issuer" : "rfF3PNkwkq1DygW2wum2HK3RGfgkJjdPVD", - "value" : "0" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "99CB3C30FAEC301621951B944059C3C2EB78FDE7ED2E124A79901B6F2600E868", - "PreviousTxnLgrSeq" : 4339260, - "index" : "D23CF25053AC6A5106E9162A20AF52818EDC672CA77AD1625C0407A71D37102F" - }, - { - "Balance" : { - "currency" : "JOE", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "-5" - }, - "Flags" : 2228224, - "HighLimit" : { - "currency" : "JOE", - "issuer" : "rwUVoVMSURqNyvocPCcvLu3ygJzZyw8qwp", - "value" : "50" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "JOE", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "0" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "F5B48F7631779C6562AF07DC79E0E4E25A0696C38823417BF811DF27C5D88168", - "PreviousTxnLgrSeq" : 5736288, - "index" : "FEECE8973F75156412E1604C52B8B9C6BC9EF21FA4A0FAA8B779AC416D039B34" - }, - { - "Balance" : { - "currency" : "USD", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "0" - }, - "Flags" : 2228224, - "HighLimit" : { - "currency" : "USD", - "issuer" : "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2", - "value" : "100" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "USD", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "0" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "B1A7405C4A698E6A371E5B02836E779A942936AB754865FE82141E5280F09D1B", - "PreviousTxnLgrSeq" : 5718137, - "index" : "8DF1456AAB7470A760F6A095C156B457FF1038D43E6B11FD8011C2DF714E4FA1" - }, - { - "Balance" : { - "currency" : "JOE", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "0" - }, - "Flags" : 2228224, - "HighLimit" : { - "currency" : "JOE", - "issuer" : "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2", - "value" : "100" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "JOE", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "0" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "8E488B0E939D4DACD62102A5BFA2FDC63679EFCC56F2FDA2FDF45283674BB711", - "PreviousTxnLgrSeq" : 5989200, - "index" : "273BD42DD72E7D84416ED759CEC92DACCD12A4502287E50BECF816233C021ED1" - }, - { - "Balance" : { - "currency" : "015841551A748AD2C1F76FF6ECB0CCCD00000000", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "0" - }, - "Flags" : 2228224, - "HighLimit" : { - "currency" : "015841551A748AD2C1F76FF6ECB0CCCD00000000", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "10.01037626125837" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "015841551A748AD2C1F76FF6ECB0CCCD00000000", - "issuer" : "rs9M85karFkCRjvc6KMWn8Coigm9cbcgcx", - "value" : "0" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "2B3E313FBDE15988425AACA1EA2EAEBBBCB8020E4FBAA7159BA678E1C4F6B4C3", - "PreviousTxnLgrSeq" : 5982458, - "index" : "BA92A0B9EB8A75E84C5463BA1A055F2B1C1B7CC20BFDA7B027C685F75E06629D" - }, - { - "Balance" : { - "currency" : "USD", - "issuer" : "rrrrrrrrrrrrrrrrrrrrBZbvji", - "value" : "0" - }, - "Flags" : 131072, - "HighLimit" : { - "currency" : "USD", - "issuer" : "rEhDDUUNxpXgEHVJtC2cjXAgyx5VCFxdMF", - "value" : "1" - }, - "HighNode" : "0000000000000000", - "LedgerEntryType" : "RippleState", - "LowLimit" : { - "currency" : "USD", - "issuer" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "value" : "0" - }, - "LowNode" : "0000000000000000", - "PreviousTxnID" : "B6B410172C0B65575D89E464AF5B99937CC568822929ABF87DA75CBD11911932", - "PreviousTxnLgrSeq" : 6592159, - "index" : "2CC2B211F6D1159B5CFD07AF8717A9C51C985E2497B2875C192EE87266AB0F81" - } - ], - "ledger_hash" : "06BF4DBE7D57FBFEAFD70D4CA7B00ED6EF404B94C446767063A0EF58A937FC4E", - "ledger_index" : 56843766, - "status" : "success", - "validated" : true - } -} -``` +{% code-snippet file="/_api-examples/account_objects/jsonrpc-response.json" language="json" prefix="Loading: \"/etc/opt/ripple/rippled.cfg\"\n2025-Aug-14 19:51:30.882061715 UTC HTTPClient:NFO Connecting to 127.0.0.1:5005\n\n" /%} {% /tab %} {% /tabs %} @@ -1231,14 +98,18 @@ The response follows the [standard format][], with a successful result containin | `Field` | Type | Description | |:-----------------------|:--------------------------|:------------------------| -| `account` | String | Unique [Address][] of the account this request corresponds to | -| `account_objects` | Array | Array of objects owned by this account. Each object is in its raw [ledger format][]. | -| `ledger_hash` | String | (May be omitted) The identifying hash of the ledger that was used to generate this response. | -| `ledger_index` | Number - [Ledger Index][] | _(May be omitted)_ The ledger index of the ledger version that was used to generate this response. | -| `ledger_current_index` | Number - [Ledger Index][] | _(May be omitted)_ The ledger index of the current in-progress ledger version, which was used to generate this response. | +| `account` | String - [Address][] | The account this request corresponds to. | +| `account_objects` | Array | Array of ledger entries in this account's owner directory. This includes entries that are owned by this account and entries that are linked to this account but owned by someone else, such as escrows where this account is the destination. Each member is a ledger entry in its raw [ledger format][]. This may contain fewer entries than the maximum specified in the `limit` field. | +| `ledger_hash` | String | _(May be omitted)_ The identifying hash of the ledger that was used to generate this response. | +| `ledger_index` | Number - [Ledger Index][] | _(May be omitted)_ The ledger index of the ledger that was used to generate this response. | +| `ledger_current_index` | Number - [Ledger Index][] | _(May be omitted)_ The ledger index of the open ledger that was used to generate this response. | | `limit` | Number | _(May be omitted)_ The limit that was used in this request, if any. | -| `marker` | [Marker][] | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one. | -| `validated` | Boolean | If included and set to `true`, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change. | +| `marker` | [Marker][] | _(May be omitted)_ Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one. | +| `validated` | Boolean | _(May be omitted)_ If `true`, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change. | + +{% admonition type="warning" name="Caution" %} +The `account_objects` array may be empty even if there are additional ledger entries to retrieve. This is especially likely when using `type` to filter ledger entry types. If the response includes a `marker` field, there are additional pages of data; if the response does not include a `marker`, then this is the end of the data. This behavior is a consequence of how the API method iterates through the account's owner directory, and a precaution against requests putting excessive load on the server. +{% /admonition %} ## Possible Errors diff --git a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_data.md b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_data.md index 9a580b393e..d9772533cc 100644 --- a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_data.md +++ b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_data.md @@ -59,29 +59,7 @@ A request can include the following fields: | `binary` | Boolean | No | If `true`, return ledger entries as hexadecimal strings instead of JSON. The default is `false`. | | `limit` | Number | No | Limit the number of ledger entries to retrieve. The server may return fewer than this number of entries. Cannot be more than 2048 (when requesting binary) or 256 (when requesting JSON). Positive values outside this range are replaced with the closest valid option. The default is the maximum. | | `marker` | [Marker][] | No | Value from a previous paginated response. Resume retrieving data where that response left off. | -| `type` | String | No | Filter results to a specific type of ledger entry. This field accepts canonical ledger entry names (case insensitive) or short names. | - -Valid `type` field values are: - -| Canonical Name | Short Name | -| ----------------- | ----------------- | -| `AccountRoot` | `account` | -| `Amendments` | `amendments` | -| `AMM` | `amm` | -| `Check` | `check` | -| `DepositPreauth` | `deposit_preauth` | -| `DirectoryNode` | `directory` | -| `Escrow` | `escrow` | -| `FeeSettings` | `fee` | -| `LedgerHashes` | `hashes` | -| `MPToken` | `mptoken` | -| `MPTokenIssuance` | `mpt_issuance` | -| `NFTokenOffer ` | `nft_offer` | -| `Offer` | `offer` | -| `PayChannel` | `payment_channel` | -| `RippleState` | `state` | -| `SignerList` | `signer_list` | -| `Ticket` | `ticket` | +| `type` | String | No | Filter results to a specific type of ledger entry. This field accepts canonical names of [ledger entry types](../../../protocol/ledger-data/ledger-entry-types/index.md) (case insensitive) or [short names](../../api-conventions/ledger-entry-short-names.md). If omitted, return ledger entries of all types. | The `ledger` field is deprecated and may be removed without further notice. diff --git a/sidebars.yaml b/sidebars.yaml index a176098a19..961a672914 100644 --- a/sidebars.yaml +++ b/sidebars.yaml @@ -365,8 +365,8 @@ - page: docs/references/protocol/ledger-data/ledger-entry-types/nftokenpage.md - page: docs/references/protocol/ledger-data/ledger-entry-types/offer.md - page: docs/references/protocol/ledger-data/ledger-entry-types/oracle.md - - page: docs/references/protocol/ledger-data/ledger-entry-types/permissioneddomain.md - page: docs/references/protocol/ledger-data/ledger-entry-types/paychannel.md + - page: docs/references/protocol/ledger-data/ledger-entry-types/permissioneddomain.md - page: docs/references/protocol/ledger-data/ledger-entry-types/ripplestate.md - page: docs/references/protocol/ledger-data/ledger-entry-types/signerlist.md - page: docs/references/protocol/ledger-data/ledger-entry-types/ticket.md @@ -484,6 +484,7 @@ - page: docs/references/http-websocket-apis/api-conventions/rate-limiting.md - page: docs/references/http-websocket-apis/api-conventions/rippled-server-states.md - page: docs/references/http-websocket-apis/api-conventions/ctid.md + - page: docs/references/http-websocket-apis/api-conventions/ledger-entry-short-names.md - page: docs/references/http-websocket-apis/public-api-methods/index.md expanded: false items: