Documentation
/
リファレンス
/
HTTP / WebSocket API リファレンス
/
rippledのパブリックメソッド
/
Accountメソッド
/
account_tx
最終更新:
編集

account_tx

[ソース]

account_txメソッドは、指定したアカウントに関連するトランザクションのリストを取得します。

リクエストのフォーマット

リクエストのフォーマットの例:

{
  "id": 2,
  "command": "account_tx",
  "account": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w",
  "ledger_index_min": -1,
  "ledger_index_max": -1,
  "binary": false,
  "limit": 2,
  "forward": false
}

試してみる >

リクエストには以下のパラメーターが含まれます。

Field型説明
account文字列アカウントの一意のIDであり、最も一般的なアカウントのアドレスが使用されます。
tx_type文字列(省略可) Clioのみ "Clawback"、"AccountSet"、"AccountDelete "など、特定のタイプのトランザクションのみを返します。 See Transaction Types. 新規: Clio v2.0 AMMのサポート: Clio v2.1.0
ledger_index_min整数API v1: （省略可能） 含めるトランザクションのレジャーのうち最古のものを指定するのに使用します。-1の値は、使用可能な検証済みレジャーのうち最古のバージョンを使用するよう、サーバに指示します。
API v2: v1と同じですが、サーバが持つレジャーの範囲を超えて値を指定するとlgrIdxMalformedエラーを返します。
ledger_index_max整数（省略可能） 含めるトランザクションのレジャーのうち最新のものを指定するのに使用します。-1の値は、使用可能な検証済みレジャーのうち最新のバージョンを使用するよう、サーバに指示します。
API v2: v1と同じですが、サーバが持つレジャーの範囲を超えて値を指定するとlgrIdxMalformedエラーを返します。
ledger_hash文字列API v1: （省略可能） 単一のレジャーからのみトランザクションを検索するのに使用します。（レジャーの指定をご覧ください）
ledger_index文字列または符号なし整数（省略可能） 単一のレジャーからのみトランザクションを検索するのに使用します。（レジャーの指定をご覧ください）
binaryブール値API v1: （省略可能） デフォルトはfalseです。trueに設定すると、JSONの代わりに16進文字列でトランザクションが返されます。
API v2: v1と同じですが、 真偽値以外の値を指定するとinvalidParamsエラーを返します。
forwardブール値API v1: （省略可能） デフォルトはfalseです。trueに設定すると、最も古いレジャーを先頭としてインデックスが付けられた値が返されます。そうしない場合、最新のレジャーを先頭として結果にインデックスが付けられます。（結果を示した各ページの中身は順序よく整理されていない場合がありますが、ページ全体としては順序付けされています。）
API v2: v1と同じですが、 真偽値以外の値を指定するとinvalidParamsエラーを返します。
limit整数（省略可能） デフォルトは変化します。取得するトランザクションの数を制限します。サーバはこの値を受け入れる必要はありません。
markerマーカー以前にページネーションされたレスポンスの値。そのレスポンスを停止した箇所からデータの取得を再開します。サーバが使用できるレジャーの範囲に変更があっても、この値は変わりません。
  • リクエスト内で次の各フィールドのうち1つ以上を使用する必要があります: ledger_index、ledger_hash、ledger_index_min、またはledger_index_max。
  • API v2： ledger_index と ledger_hash のどちらかを指定した場合、ledger_index_min と ledger_index_max を含めると invalidParams エラーが返ります。

照会されたデータの繰り返し

他のページネーションメソッドと同様に、markerフィールドを使用すると複数ページのデータが返されます。

複数のリクエストの合間に、"ledger_index_min": -1と"ledger_index_max": -1が変更されて、以前とは異なるレジャーバージョンを参照する場合があります。markerフィールドを使用すると、リクエストからのレジャー範囲に変更がある場合でも、マーカーが示すポイントがリクエストで指定されたレジャーの範囲外でない限り、安全にページネーションできます。

レスポンスのフォーマット

処理が成功したレスポンスの例:

{
  "id": 2,
  "result": {
    "account": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w",
    "ledger_index_max": 57111999,
    "ledger_index_min": 55886305,
    "limit": 2,
    "marker": {
      "ledger": 57111981,
      "seq": 16
    },
    "transactions": [
      {
        "meta": {
          "AffectedNodes": [
            {
              "ModifiedNode": {
                "FinalFields": {
                  "Account": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w",
                  "Balance": "3732969177079",
                  "Flags": 131072,
                  "OwnerCount": 0,
                  "Sequence": 702817
                },
                "LedgerEntryType": "AccountRoot",
                "LedgerIndex": "140FA03FE8C39540CA8189BC7A7956795C712BC0A542C6409C041150703C8574",
                "PreviousFields": {
                  "Balance": "3713891690008"
                },
                "PreviousTxnID": "D58864C16344ADCC15995C7986CFC607CB693E88F84D2E019F0A35FB29749202",
                "PreviousTxnLgrSeq": 57111994
              }
            },
            {
              "ModifiedNode": {
                "FinalFields": {
                  "Account": "rw2ciyaNshpHe7bCHo4bRWq6pqqynnWKQg",
                  "Balance": "40010160",
                  "Flags": 131072,
                  "OwnerCount": 0,
                  "Sequence": 466334
                },
                "LedgerEntryType": "AccountRoot",
                "LedgerIndex": "CC20FEBEA6D2AF969EC46F2BD92684D9FBABC3F238E841B5E056FE4EBF4379A9",
                "PreviousFields": {
                  "Balance": "19117497271",
                  "Sequence": 466333
                },
                "PreviousTxnID": "F6B8274D3D419A95A59681E5F55578084C395FF9051924360CA3EA745F5581E8",
                "PreviousTxnLgrSeq": 57111993
              }
            }
          ],
          "TransactionIndex": 25,
          "TransactionResult": "tesSUCCESS",
          "delivered_amount": "19077487071"
        },
        "tx": {
          "Account": "rw2ciyaNshpHe7bCHo4bRWq6pqqynnWKQg",
          "Amount": "19077487071",
          "Destination": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w",
          "DestinationTag": 1,
          "Fee": "40",
          "Flags": 2147483648,
          "LastLedgerSequence": 57112020,
          "Sequence": 466333,
          "SigningPubKey": "0381575032E254BF4D699C3D8D6EFDB63B3A71F97475C6F6885BC7DAEEE55D9A01",
          "TransactionType": "Payment",
          "TxnSignature": "3045022100CFC5FD057C7C685C690637AD1E639E2642BBC00EFD8E06E3F6C72FA924BC99D40220317D0708E814F69F874D641B6732E37A53B1220B493B2B8390D9EF51E8062515",
          "date": 649200260,
          "hash": "46BF0B576677B0DEA2D94591424A57A2DE8E3D89383631E16F40D09A513C656C",
          "inLedger": 57111998,
          "ledger_index": 57111998
        },
        "validated": true
      },
      {
        "meta": {
          "AffectedNodes": [
            {
              "ModifiedNode": {
                "FinalFields": {
                  "Account": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w",
                  "Balance": "3713891690008",
                  "Flags": 131072,
                  "OwnerCount": 0,
                  "Sequence": 702817
                },
                "LedgerEntryType": "AccountRoot",
                "LedgerIndex": "140FA03FE8C39540CA8189BC7A7956795C712BC0A542C6409C041150703C8574",
                "PreviousFields": {
                  "Balance": "3714441690048",
                  "Sequence": 702816
                },
                "PreviousTxnID": "FDD5007913B39027BAF10B31144DBC1F7DC147528DF31FF048A06DC5D3108BD6",
                "PreviousTxnLgrSeq": 57111981
              }
            },
            {
              "ModifiedNode": {
                "FinalFields": {
                  "Account": "r9dU6Z7P2i7MrDi1VUZ7uyq6J77eg86YtB",
                  "Balance": "2629998983",
                  "Flags": 0,
                  "OwnerCount": 0,
                  "Sequence": 10
                },
                "LedgerEntryType": "AccountRoot",
                "LedgerIndex": "27B96FE681B33825CC95DA197358B30D3A1721F2125F2D76022D46B2418ABA0A",
                "PreviousFields": {
                  "Balance": "2079998983"
                },
                "PreviousTxnID": "44A47AC04C0C7237C32BE9A532B578D07641705D3A59DB9B3C5B6225001E39B7",
                "PreviousTxnLgrSeq": 56613857
              }
            }
          ],
          "TransactionIndex": 16,
          "TransactionResult": "tesSUCCESS",
          "delivered_amount": "550000000"
        },
        "tx": {
          "Account": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w",
          "Amount": "550000000",
          "Destination": "r9dU6Z7P2i7MrDi1VUZ7uyq6J77eg86YtB",
          "Fee": "40",
          "Flags": 2147483648,
          "LastLedgerSequence": 57112016,
          "Sequence": 702816,
          "SigningPubKey": "020A46D8D02AC780C59853ACA309EAA92E7D8E02DD72A0B6AC315A7D18A6C3276A",
          "TransactionType": "Payment",
          "TxnSignature": "3045022100D589029EF63F9E528F6100C7A36D26AFFF84085EC9AC16DA8E30E11F390D4E87022011466E0FE4A90B89142EE47E535545EEA4A2D65E0BD234DFB447721218B59C9B",
          "date": 649200241,
          "hash": "D58864C16344ADCC15995C7986CFC607CB693E88F84D2E019F0A35FB29749202",
          "inLedger": 57111994,
          "ledger_index": 57111994
        },
        "validated": true
      }
    ],
    "validated": true
  },
  "status": "success",
  "type": "response"
}

このレスポンスは標準フォーマットに従っており、正常に完了した場合は結果に次のフィールドが含まれます。

Field型説明
account文字列関連するアカウントを識別する一意のアドレス。
ledger_index_min整数 - レジャーインデックストランザクションで実際に検索された最古のレジャーのレジャーインデックス。
ledger_index_max整数 - レジャーインデックストランザクションで実際に検索された最新のレジャーのレジャーインデックス。
limit整数リクエストで使用されるlimit値。（サーバによって強制される実際の制限値とは異なる場合があります。）
markerマーカーレスポンスがページネーションされていることを示す、サーバが定義した値。この値を次のコールに渡して、このコールで終わった箇所から再開します。
transactions配列以降で説明する、リクエストの基準を満たすトランザクションの配列。
validatedブール値このフィールドが含まれていてtrueに設定されている場合、このレスポンス内の情報は検証済みのレジャーバージョンから取得されています。そうでない場合、情報は変更されることがあります。

注記: サーバから返されるledger_index_minおよびledger_index_maxの値がリクエストで指定したものとは異なる場合があります。例えば、サーバに手元の指定したバージョンがない場合など。

各トランザクションのオブジェクトには以下のフィールドが含まれます。含まれるフィールドは、JSONまたは16進文字列（"binary":true）フォーマットのどちらでリクエストされたかによって異なります。

Field型説明
ledger_index整数このトランザクションを含むレジャーバージョンのレジャーインデックス。
metaオブジェクト（JSON）または文字列（バイナリ）binaryがTrueの場合、これは16進文字列のトランザクションメタデータです。そうでない場合、トランザクションメタデータはJSONフォーマットになります。
txオブジェクト（JSONモードのみ）トランザクションを定義するJSONオブジェクト。
tx_blob文字列（バイナリモードのみ）トランザクションを表す一意のハッシュ化された文字列。
validatedブール値トランザクションが検証済みのレジャーに含まれるかどうか。検証済みのレジャーに含まれていないトランザクションはすべて、変更される場合があります。

考えられるエラー

  • いずれかの汎用エラータイプ。
  • invalidParams - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
  • actMalformed - リクエストのaccountフィールドに指定したアドレスが、正しいフォーマットではありません。
  • lgrIdxMalformed - ledger_index_minまたはledger_index_maxで指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
  • lgrIdxsInvalid - リクエストでledger_index_minの前にあるledger_index_maxを指定したか、ネットワークと同期されていないためにサーバに検証済みレジャーの範囲が存在しません。
前のページ
次のページ