account_lines
account_lines
メソッドは、アカウントのトラストラインに関する情報(XRP以外のあらゆる通貨の残高と資産など)を返します。取得された情報はすべて、特定バージョンのレジャーに関連付けられています。
リクエストのフォーマット
リクエストのフォーマットの例:
{ "id": 1, "command": "account_lines", "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59" }
リクエストには以下のパラメーターを指定できます。
Field | 型 | 説明 |
---|---|---|
account | 文字列 | トラストラインを検索するアカウント。 |
ledger_hash | 文字列 | (省略可) 使用するレジャーバージョンの20バイトの16進文字列。(レジャーの指定をご覧ください) |
ledger_index | 文字列または整数 | (省略可) 使用するレジャーのレジャーインデックス、またはレジャーを自動的に選択するためのショートカット文字列。(レジャーの指定をご覧ください) |
peer | 文字列 | (省略可) 2番目のアカウントのアドレス。指定されている場合は、2つのアカウントを結ぶトラストラインだけが出力されます。 |
limit | 整数 | (省略可、デフォルト値は可変)取得するトラストラインの数を制限します。サーバはこの値を受け入れる必要はありません。10以上400以下の範囲で値を指定する必要があります。 |
marker | マーカー | (省略可) 以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。 |
以下のパラメーターは廃止予定であり、今後予告なしに削除される可能性があります。ledger
およびpeer_index
。
レスポンスのフォーマット
処理が成功したレスポンスの例:
{ "id": 1, "status": "success", "type": "response", "result": { "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "lines": [ { "account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z", "balance": "0", "currency": "ASP", "limit": "0", "limit_peer": "10", "quality_in": 0, "quality_out": 0 }, { "account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z", "balance": "0", "currency": "XAU", "limit": "0", "limit_peer": "0", "no_ripple": true, "no_ripple_peer": true, "quality_in": 0, "quality_out": 0 }, { "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", "balance": "3.497605752725159", "currency": "USD", "limit": "5", "limit_peer": "0", "no_ripple": true, "quality_in": 0, "quality_out": 0 } ] } }
このレスポンスは標準フォーマットに従っており、正常に完了した場合には、アカウントのアドレスとトラストラインオブジェクトの配列が含まれています。具体的には、結果オブジェクトには以下のフィールドが含まれます。
Field | 型 | 説明 |
---|---|---|
account | 文字列 | このリクエストに対応するアカウントの一意のアドレス。トラストラインのための「パースペクティブアカウント」です。 |
lines | 配列 | トラストラインオブジェクトからなる配列。以下で説明します。トラストラインの数が多い場合は、一度にlimit の数までのトラストラインが返されます。 |
ledger_current_index | 整数 - レジャーインデックス | (ledger_hash またはledger_index が指定されている場合は省略) この情報の取得時に使用した、現行のオープンレジャーのレジャーインデックス。 |
ledger_index | 整数 - レジャーインデックス | (ledger_current_index が指定されている場合は省略) このデータの取得時に使用されたレジャーバージョンのレジャーインデックス。 |
ledger_hash | 文字列 - ハッシュ | (省略される場合があります) このデータの取得時に使用されたレジャーバージョンの識別用ハッシュ。 |
marker | マーカー | レスポンスがページネーションされていることを示す、サーバが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に追加のページがない場合は省略されます |
各トラストラインオブジェクトには以下のフィールドの組み合わせが含まれています。
Field | 型 | 説明 |
---|---|---|
account | 文字列 | このトラストラインの相手側の一意のアドレス。 |
balance | 文字列 | 現在このラインに対して保留されている残高(数値)の表示。残高がプラスの場合はパースペクティブアカウントがその額を保有しており、マイナスの場合はパースペクティブアカウントがその額を借用しています。 |
currency | 文字列 | このトラストラインが保有できる通貨を示す通貨コード。 |
limit | 文字列 | このアカウントがピアアカウントからの借用を希望する特定の通貨の上限額。 |
limit_peer | 文字列 | 相手側アカウントがパースペクティブアカウントからの借用を希望する特定の通貨の上限額。 |
quality_in | 符号なし整数 | このアカウントが、このトラストラインの入金時残高を評価する際のレート(この数値対10億単位の比率)。(たとえば5億の場合は0.5:1の比率を表します。)特殊なケースとして、0は1:1の比率として扱われます。 |
quality_out | 符号なし整数 | このアカウントが、このトラストラインの出金時残高を評価する際のレート(この数値対10億単位の比率)。(たとえば5億の場合は0.5:1の比率を表します。)特殊なケースとして、0は1:1の比率として扱われます。 |
no_ripple | 真偽値 | (省略される場合があります)true の場合、このアカウントはこのトラストラインのNo Rippleフラグを有効にしています。もしfalse であれば、このアカウントはNo Rippleフラグを無効にしていますが、これはデフォルト値ではありません。。省略された場合、そのアカウントはこのトラストラインのNo Rippleフラグは無効で、Default Rippleが有効となります。 |
no_ripple_peer | 真偽値 | (省略される場合があります)true の場合、ピアアカウントはこのトラストラインでNo Rippleフラグを有効にしています。もしfalse なら、このアカウントはNo Rippleフラグを無効にしていますが、このアカウントはDefault Rippleフラグも無効にしているため、デフォルト値とはみなされません。省略された場合、そのアカウントはこのトラストラインのNo Rippleフラグが無効で、Default Rippleが有効です。 |
authorized | 真偽値 | (省略される場合があります)このアカウントがこのトラストラインを承認した場合は、true 。省略されている場合は、false と同じです。 |
peer_authorized | 真偽値 | (省略される場合があります)ピアアカウントがこのトラストラインを承認した場合はtrue 。省略されている場合は、false と同じです。 |
freeze | 真偽値 | (省略される場合があります)このアカウントがこのトラストラインを凍結した場合はtrue 。省略されている場合は、false と同じです。 |
freeze_peer | 真偽値 | (省略される場合があります)ピアアカウントがこのトラストラインを凍結した場合は、true 。省略されている場合は、false と同じです。 |