tx

txメソッドは1つのトランザクションに関する情報を取得します。

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

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

{
  "id": 1,
  "command": "tx",
  "transaction": "C53ECF838647FA5A4C780377025FEC7999AB4182590510CA461444B207AB74A9",
  "binary": false,
  "api_version": 2
}

試してみる>

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

フィールド	型	必須?	説明
`ctid`	文字列	いいえ	検索するトランザクションのコンパクトトランザクション識別子。大文字の16進数のみを使用する必要があります。 (Clio v2.0以前では対応していません)
`transaction`	文字列	いいえ	検索するトランザクションの16進数の256ビットハッシュ
`binary`	真偽値	いいえ	`true` の場合、トランザクションデータとメタデータを16進数文字列へのバイナリシリアライズとして返します。`false` の場合、トランザクションデータとメタデータを JSON で返します。デフォルトは `false` 。
`min_ledger`	数値	いいえ	`max_ledger`と一緒に使うことで、このレジャーを起点として最大1000件までのレジャーインデックスの範囲を指定することができます(自身を含む)。サーバーがトランザクションを見つけられない場合、この範囲内のいずれのレジャーにも存在しないことになります。
`max_ledger`	数値	いいえ	`min_ledger`と一緒に使うと、このレジャーで終わる最大1000個のレジャーインデックスの範囲を指定できます(自身を含む)。サーバーがトランザクションを見つけられない場合、この範囲内のいずれのレジャーにも存在しないことになります。

ctidまたはtransactionのいずれか一方のみを提供する必要があります。

注意

このコマンドは、トランザクションがmin_ledgerからmax_ledgerの範囲外のレジャーに含まれている場合でも、トランザクションを見つけることができる場合があります。

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

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

{
  "result": {
    "tx_json": {
      "Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
      "DeliverMax": {
        "currency": "USD",
        "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
        "value": "1"
      },
      "Destination": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
      "Fee": "10",
      "Flags": 0,
      "Paths": [
        [
          {
            "account": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
            "currency": "USD",
            "issuer": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
            "type": 49
          }
        ],
        [
          {
            "account": "rD1jovjQeEpvaDwn9wKaYokkXXrqo4D23x",
            "currency": "USD",
            "issuer": "rD1jovjQeEpvaDwn9wKaYokkXXrqo4D23x",
            "type": 49
          },
          {
            "account": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY",
            "currency": "USD",
            "issuer": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY",
            "type": 49
          },
          {
            "account": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
            "currency": "USD",
            "issuer": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
            "type": 49
          }
        ]
      ],
      "SendMax": {
        "currency": "USD",
        "issuer": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
        "value": "1.01"
      },
      "Sequence": 88,
      "SigningPubKey": "02EAE5DAB54DD8E1C49641D848D5B97D1B29149106174322EDF98A1B2CCE5D7F8E",
      "TransactionType": "Payment",
      "TxnSignature": "30440220791B6A3E036ECEFFE99E8D4957564E8C84D1548C8C3E80A87ED1AA646ECCFB16022037C5CAC97E34E3021EBB426479F2ACF3ACA75DB91DCC48D1BCFB4CF547CFEAA0",
      "date": 416445410,
      "ledger_index": 348734
    },
    "ctid": "C005523E00000000",
    "hash": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7",
    "meta": {
      "AffectedNodes": [
        {
          "ModifiedNode": {
            "FinalFields": {
              "Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
              "Balance": "59328999119",
              "Flags": 0,
              "OwnerCount": 11,
              "Sequence": 89
            },
            "LedgerEntryType": "AccountRoot",
            "LedgerIndex": "E0D7BDE68B468FF0B8D948FD865576517DA987569833A05374ADB9A72E870A06",
            "PreviousFields": {
              "Balance": "59328999129",
              "Sequence": 88
            },
            "PreviousTxnID": "C26AA6B4F7C3B9F55E17CD0D11F12032A1C7AD2757229FFD277C9447A8815E6E",
            "PreviousTxnLgrSeq": 348700
          }
        },
        {
          "ModifiedNode": {
            "FinalFields": {
              "Balance": {
                "currency": "USD",
                "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
                "value": "-1"
              },
              "Flags": 131072,
              "HighLimit": {
                "currency": "USD",
                "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
                "value": "100"
              },
              "HighNode": "0",
              "LowLimit": {
                "currency": "USD",
                "issuer": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
                "value": "0"
              },
              "LowNode": "0"
            },
            "LedgerEntryType": "RippleState",
            "LedgerIndex": "EA4BF03B4700123CDFFB6EB09DC1D6E28D5CEB7F680FB00FC24BC1C3BB2DB959",
            "PreviousFields": {
              "Balance": {
                "currency": "USD",
                "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
                "value": "0"
              }
            },
            "PreviousTxnID": "53354D84BAE8FDFC3F4DA879D984D24B929E7FEB9100D2AD9EFCD2E126BCCDC8",
            "PreviousTxnLgrSeq": 343570
          }
        }
      ],
      "TransactionIndex": 0,
      "TransactionResult": "tesSUCCESS",
      "delivered_amount": "unavailable"
    },
    "validated": true,
    "ledger_index": 348734,
    "ledger_hash": "195F62F34EB2CCFA4C5888BA20387E82EB353DDB4508BAE6A835AF19FB8B0C09",
    "close_time_iso": "2013-03-12T23:16:50Z"
  },
  "api_version": 2,
  "status": "success",
  "type": "response"
}

このレスポンスは標準フォーマットに従っており、正常に完了した場合は結果にTransactionオブジェクトフィールドと以下の追加のフィールドが含まれています。

`Field`	型	説明
`ctid`	文字列	検索するトランザクションのコンパクトトランザクション識別子。大文字の16進数のみを使用する必要があります。 (Clio v2.0以前では対応していません)
`date`	数値	トランザクションが適用されたレジャーの閉鎖時間。[Ripple Epoch][]からの秒数で表されます。
`hash`	文字列	トランザクションの一意の[識別ハッシュ][]
`inLedger`	数値	(非推奨) `ledger_index`の別名。
`ledger_index`	数値	トランザクションが含まれるレジャーのレジャーインデックス。
`meta`	オブジェクト (JSON)	(JSONモード) Transaction metadata。トランザクションの結果を詳細に表示します。
`meta_blob`	文字列 (バイナリ)	(バイナリモード) Transaction metadata。トランザクションの結果を詳細に表示します。
`tx_blob`	文字列 (バイナリ)	(バイナリモード) トランザクションデータを16進数の文字列で表したもの。
`tx_json`	オブジェクト (JSON)	(JSONモード) トランザクションデータをJSONで表したもの。
`validated`	真偽値	`true`の場合、このデータは検証済みのレジャーバージョンからのものです。`false`の場合、このデータはまだ検証されていません。

Not Foundレスポンス

サーバがトランザクションを見つけられない場合、txnNotFoundエラーを返します。これは2つのことを意味する可能性があります。

トランザクションはどのレジャーバージョンにも含まれておらず、送信されていません。
トランザクションは、サーバが保持していないレジャーバージョンに含まれていました。

txnNotFound単体では、トランザクションの最終的な結果を知るためには不十分です。

さらに可能性を絞り込むために、リクエストにmin_ledgerとmax_ledgerフィールドを指定してレジャーの範囲を指定することができます。リクエストにmin_ledgerとmax_ledgerフィールドを指定した場合、txnNotFoundレスポンスには以下のフィールドが含まれます。

フィールド	型	説明
`searched_all`	真偽値	(リクエストに`min_ledger`と`max_ledger`が指定されていない場合は省略) サーバが指定されたすべてのレジャーバージョンを検索できた場合は`true`。サーバが指定されたすべてのレジャーバージョンを持っていないため、トランザクションがそれらのいずれかに含まれているかどうかを確認できない場合は`false`。

リクエストされたレジャー範囲を完全に検索したtxnNotFoundレスポンスの例:

{
  "error": "txnNotFound",
  "error_code": 29,
  "error_message": "Transaction not found.",
  "id": 1,
  "request": {
    "binary": false,
    "command": "tx",
    "id": 1,
    "max_ledger": 54368673,
    "min_ledger": 54368573,
    "transaction": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7"
  },
  "searched_all": true,
  "status": "error",
  "type": "response"
}

考えられるエラー

汎用エラータイプのすべて。
invalidParams - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
txnNotFound - トランザクションが存在しないか、またはrippledで使用できない古いレジャーバージョンのトランザクションです。
excessiveLgrRange - リクエストのmin_ledgerとmax_ledgerフィールドの差が1000を超えています。
invalidLgrRange - 指定されたmin_ledgerがmax_ledgerより大きいか、それらのパラメータのいずれかが有効なレジャーインデックスではありません。