account_lines

[ソース]

account_linesメソッドは、アカウントのトラストラインに関する情報(XRP以外のあらゆる通貨の残高と資産など)を返します。取得された情報はすべて、特定バージョンのレジャーに関連付けられています。

要求フォーマット

要求フォーマットの例:

{
 "id": 1,
 "command": "account_lines",
 "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
}
{
   "method": "account_lines",
   "params": [
       {
           "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
       }
   ]
}

試してみる

要求には以下のパラメーターを指定できます。

Field 説明
account 文字列 アカウントの一意のIDであり、通常はアカウントのアドレスです。
ledger_hash 文字列 (省略可) 使用するレジャーバージョンの20バイトの16進文字列。(レジャーの指定を参照してください)
ledger_index 文字列または符号なし整数 (省略可) 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。(レジャーの指定を参照してください)
peer 文字列 (省略可) 2番目のアカウントのアドレス。指定されている場合は、2つのアカウントを結ぶトラストラインだけが出力されます。
limit 整数 (省略可、デフォルト値は可変)取得するトランザクションの数を制限します。サーバーはこの値に従う必要はありません。10以上400以下の範囲で値を指定する必要があります。新規: rippled 0.26.4
marker マーカー (省略可) 以前にページネーションされた応答の値。その応答を停止した箇所からデータの取得を再開します。新規: rippled 0.26.4

以下のパラメーターは廃止予定であり、今後予告なしに削除される可能性があります。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
           }
       ]
   }
}
200 OK
{
   "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": "rs9M85karFkCRjvc6KMWn8Coigm9cbcgcx",
               "balance": "0",
               "currency": "015841551A748AD2C1F76FF6ECB0CCCD00000000",
               "limit": "10.01037626125837",
               "limit_peer": "0",
               "no_ripple": true,
               "quality_in": 0,
               "quality_out": 0
           }
       ],
       "status": "success"
   }
}

この応答は標準フォーマットに従っており、正常に完了した場合には、アカウントのアドレスとトラストラインオブジェクトの配列が含まれています。具体的には、結果オブジェクトには以下のフィールドが含まれます。

Field 説明
account 文字列 この要求に対応するアカウントの一意のアドレス。トラストラインのための「パースペクティブアカウント」です。
lines 配列 トラストラインオブジェクトからなる配列。以下で説明します。トラストラインの数が多い場合は、一度にlimitの数までのトラストラインが返されます。
ledger_current_index 整数 ledger_hashまたはledger_indexが指定されている場合は省略)このデータの取得時に使用したレジャーバージョンのシーケンス番号。新規: rippled 0.26.4-sp1
ledger_index 整数 ledger_current_indexが代わりに指定されている場合は省略)要求に指定され、このデータの取得時に使用されたレジャーバージョンのシーケンス番号。新規: rippled 0.26.4-sp1
ledger_hash 文字列 (省略される場合があります)要求に指定され、このデータの取得時に使用されたレジャーバージョンの16進数ハッシュ。新規: rippled 0.26.4-sp1
marker マーカー 応答がページネーションされていることを示す、サーバーが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。この後に追加のページがない場合は省略されます。新規: rippled 0.26.4

各トラストラインオブジェクトには以下のフィールドの組み合わせが含まれています。

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 ブール値 (省略される場合があります)このアカウントでこのラインに対しNoRippleフラグが有効な場合は、true。省略されている場合は、falseと同じです。
no_ripple_peer ブール値 (省略される場合があります)ピアアカウントでこのラインに対しNoRippleフラグが有効な場合はtrue。省略されている場合は、falseと同じです。
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フィールドが受け入れられない場合。