core-lightning/doc/schemas/lightning-listtransactions.json

{
  "$schema": "../rpc-schema-draft.json",
  "type": "object",
  "additionalProperties": false,
  "rpc": "listtransactions",
  "title": "Command to get the list of transactions that was stored in the wallet.",
  "description": [
    "The **listtransactions** command returns transactions tracked in the wallet. This includes deposits, withdrawals and transactions related to channels. A transaction may have multiple types, e.g., a transaction may both be a close and a deposit if it closes the channel and returns funds to the wallet."
  ],
  "request": {
    "required": [],
    "properties": {}
  },
  "response": {
    "required": [
      "transactions"
    ],
    "properties": {
      "transactions": {
        "type": "array",
        "items": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "hash",
            "rawtx",
            "blockheight",
            "txindex",
            "locktime",
            "version",
            "inputs",
            "outputs"
          ],
          "properties": {
            "hash": {
              "type": "txid",
              "description": [
                "The transaction id."
              ]
            },
            "rawtx": {
              "type": "hex",
              "description": [
                "The raw transaction."
              ]
            },
            "blockheight": {
              "type": "u32",
              "description": [
                "The block height of this tx."
              ]
            },
            "txindex": {
              "type": "u32",
              "description": [
                "The transaction number within the block."
              ]
            },
            "locktime": {
              "type": "u32",
              "description": [
                "The nLocktime for this tx."
              ]
            },
            "version": {
              "type": "u32",
              "description": [
                "The nVersion for this tx."
              ]
            },
            "inputs": {
              "type": "array",
              "description": [
                "Each input, in order."
              ],
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "txid",
                  "index",
                  "sequence"
                ],
                "properties": {
                  "txid": {
                    "type": "txid",
                    "description": [
                      "The transaction id spent."
                    ]
                  },
                  "index": {
                    "type": "u32",
                    "description": [
                      "The output spent."
                    ]
                  },
                  "sequence": {
                    "type": "u32",
                    "description": [
                      "The nSequence value."
                    ]
                  }
                }
              }
            },
            "outputs": {
              "type": "array",
              "description": [
                "Each output, in order."
              ],
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "index",
                  "amount_msat",
                  "scriptPubKey"
                ],
                "properties": {
                  "index": {
                    "type": "u32",
                    "description": [
                      "The 0-based output number."
                    ]
                  },
                  "amount_msat": {
                    "type": "msat",
                    "description": [
                      "The amount of the output."
                    ]
                  },
                  "scriptPubKey": {
                    "type": "hex",
                    "description": [
                      "The scriptPubKey."
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "json_example": [
    {
      "request": {
        "id": "example:listtransactions#1",
        "method": "listtransactions",
        "params": {}
      },
      "response": {
        "transactions": [
          {
            "hash": "05985072bbe20747325e69a159fe08176cc1bbc96d25e8848edad2dddc1165d0",
            "rawtx": "02000000027032912651fc25a3e0893acd5f9640598707e2dfef92143bb5a4020e335442800100000017160014a5f48b9aa3cb8ca6cc1040c11e386745bb4dc932ffffffffd229a4b4f78638ebcac10a68b0561585a5d6e4d3b769ad0a909e9b9afaeae24e00000000171600145c83da9b685f9142016c6f5eb5f98a45cfa6f686ffffffff01915a01000000000017a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf8700000000",
            "blockheight": 0,
            "txindex": 0,
            "locktime": 0,
            "version": 2,
            "inputs": [
              {
                "txid": "804254330e02a4b53b1492efdfe207875940965fcd3a89e0a325fc5126913270",
                "index": 1,
                "sequence": 4294967295
              },
              {
                "txid": "4ee2eafa9a9b9e900aad69b7d3e4d6a5851556b0680ac1caeb3886f7b4a429d2",
                "index": 0,
                "sequence": 4294967295
              }
            ],
            "outputs": [
              {
                "index": 0,
                "satoshis": "88721000msat",
                "scriptPubKey": "a9143a4dfd59e781f9c3018e7d0a9b7a26d58f8d22bf87"
              }
            ]
          }
        ]
      }
    }
  ],
  "errors": [
    "On failure, one of the following error codes may be returned:",
    "",
    "- -32602: Error in given parameters."
  ],
  "author": [
    "Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page,",
    "but many others did the hard work of actually implementing this rpc command."
  ],
  "see_also": [
    "lightning-newaddr(7)",
    "lightning-listfunds(7)"
  ],
  "resources": [
    "Main web site: <https://github.com/ElementsProject/lightning>"
  ]
}