最終更新:
編集

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が有効となります。更新: rippled 1.7.0
no_ripple_peer真偽値(省略される場合があります)trueの場合、ピアアカウントはこのトラストラインでNo Rippleフラグを有効にしています。もしfalseなら、このアカウントはNo Rippleフラグを無効にしていますが、このアカウントはDefault Rippleフラグも無効にしているため、デフォルト値とはみなされません。省略された場合、そのアカウントはこのトラストラインのNo Rippleフラグが無効で、Default Rippleが有効です。更新: rippled 1.7.0
authorized真偽値(省略される場合があります)このアカウントがこのトラストラインを承認した場合は、true。省略されている場合は、falseと同じです。
peer_authorized真偽値(省略される場合があります)ピアアカウントがこのトラストラインを承認した場合はtrue。省略されている場合は、falseと同じです。
freeze真偽値(省略される場合があります)このアカウントがこのトラストラインを凍結した場合はtrue。省略されている場合は、falseと同じです。
freeze_peer真偽値(省略される場合があります)ピアアカウントがこのトラストラインを凍結した場合は、true。省略されている場合は、falseと同じです。

考えられるエラー

  • いずれかの汎用エラータイプ
  • invalidParams - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
  • actNotFound - リクエストのaccountフィールドに指定されているアドレスが、レジャーのアカウントに対応していません。
  • lgrNotFound - ledger_hashまたはledger_indexで指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
  • actMalformed - 指定されているmarkerフィールドが受け入れられない場合。