account_objects
account_objects
コマンドは、アカウントが所有するすべてのレジャーエントリの生レジャーフォーマットを返します。アカウントのトラストラインと残高の概要については、account_linesメソッドをご覧ください。
アカウントのaccount_objects
レスポンスに含まれる可能性のあるオブジェクトのタイプには以下のものがあります。
- Bridgeエントリ: クロスチェーンブリッジ向けs. (XChainBridge amendmentが必要です )
- Checkエントリ: 保留中のCheck。
- DepositPreauthエントリ: 入金の事前承認。
- Escrowエントリ: 実行されていないかまたはキャンセルされていない保留中の支払い。
- NFTokenOfferエントリ: NFTを購入・売却するためのオファー。
- NFTokenPageエントリ: NFTの集合。
- Offerエントリ: 現在処理中であり、資金化されていない、または有効期限切れで削除されていない注文情報。(詳細は、オファーのライフサイクルをご覧ください。)
- PayChannelエントリ: 現在開いているペイメントチャネル。
- RippleStateエントリ: このアカウント側がデフォルト状態にないトラストライン。
- アカウントのSignerList: アカウントでマルチシグが有効な場合。
- Ticketエントリ: Ticket情報。
リクエストのフォーマット
リクエストのフォーマットの例:
{ "id": 1, "command": "account_objects", "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "ledger_index": "validated", "type": "state", "deletion_blockers_only": false, "limit": 10 }
リクエストには以下のパラメーターが含まれます。
Field | 型 | 必須? | 説明 |
---|---|---|---|
account | 文字列 | はい | アカウントの一意のIDであり、最も一般的にはアカウントのアドレスが使用されます。 |
deletion_blockers_only | Boolean | いいえ | true の場合、このアカウントが削除されるのをブロックするオブジェクトのみをレスポンスに含めます。デフォルトはfalse です。 |
ledger_hash | ハッシュ | いいえ | 使用するレジャーバージョンの20バイトの16進文字列。(レジャーの指定をご覧ください) |
ledger_index | レジャーインデックス | いいえ | 使用するレジャーのレジャーインデックス、またはレジャーを自動的に選択するためのショートカット文字列。(レジャーの指定ををご覧ください) |
limit | 符号なし整数 | いいえ | 結果に含めることができるオブジェクトの最大数。非管理者接続では10以上400以下の範囲で値を指定する必要があります。デフォルトでは200です。 |
marker | マーカー | いいえ | 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
type | 文字列 | いいえ | 指定されている場合、結果をフィルタリングしてこのタイプのレジャーオブジェクトのみが含まれるようにします。有効なタイプはbridge , check 、deposit_preauth 、escrow 、nft_offer , nft_page , offer 、payment_channel 、signer_list 、state (トラストライン)そしてticket です。 |
注記: account_objects
コマンドのコマンドラインインタフェースはtype
フィールドを受け付けません。代わりにコマンドラインでJSON-RPC形式のリクエストを送信するには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 } }
このレスポンスは標準フォーマットに従っており、正常に完了した場合は結果に次のフィールドが含まれます。
Field | 型 | 説明 |
---|---|---|
account | 文字列 | このリクエストに対応するアカウントの一意のアドレス。 |
account_objects | 配列 | このアカウントが所有するオブジェクトの配列。各オブジェクトは、生レジャーフォーマットです。 |
ledger_hash | 文字列 | (省略される場合があります)このレスポンスの生成に使用されたレジャーの識別用ハッシュ。 |
ledger_index | 数値 - レジャーインデックス | (省略される場合があります) このレスポンスの生成に使用されたレジャーバージョンのレジャーインデックス。 |
ledger_current_index | 数値 - レジャーインデックス | (省略される場合があります) このレスポンスの生成に使用された現在処理中のレジャーバージョンのレジャーインデックス。 |
limit | 数値 | (省略される場合があります) このリクエストで使用されていた制限(制限の使用がある場合)。 |
marker | マーカー | レスポンスがページネーションされていることを示す、サーバが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に追加のページがない場合は省略されます。 |
validated | 真偽値 | このフィールドが含まれていてtrue に設定されている場合、このレスポンス内の情報は検証済みのレジャーバージョンから取得されています。そうでない場合、情報は変更されることがあります。 |