openapi.json

{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"servers":[{"url":"/api"}],"paths":{"/apps/status":{"get":{"tags":["Apps"],"summary":"Get the status of all available apps.","operationId":"apps_status_apps_status_get","responses":{"200":{"description":"\nReturns a JSON list with the current status of all available apps\n```\n{\n  \"data\": [\n    {\n      \"id\": \"btcpayserver\",\n      \"version\": \"v1.13.0\",\n      \"installed\": false,\n      \"configured\": false,\n      \"status\": \"offline\",\n      \"local_ip\": null,\n      \"http_port\": null,\n      \"https_port\": null,\n      \"https_forced\": null,\n      \"https_self_signed\": null,\n      \"hidden_service\": null,\n      \"address\": null,\n      \"auth_method\": null,\n      \"details\": null,\n      \"error\": null\n    },\n    {\n      \"id\": \"btc-rpc-explorer\",\n      \"version\": \"v3.4.0\",\n      \"installed\": false,\n      \"configured\": false,\n      \"status\": \"offline\",\n      \"local_ip\": null,\n      ...\n    },\n    ...\n  ],\n  \"errors\": [\n    {\n      \"id\": \"rtl\",\n      \"error\": \"App status script execution failed.\n├╴at /home/blitzapi/blitz_api/app/apps/impl/raspiblitz.py:92:10\n├╴script_name: /home/admin/config.scripts/bonus.rtl.sh status\n│\n╰─▶ 500: Something went wrong!\n    ╰╴at /home/blitzapi/blitz_api/app/apps/impl/raspiblitz.py:92:10\"\n    },\n    ...\n  ]\n}\n```\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppStatusQueryResult"}}}}},"security":[{"JWTBearer":[]}]}},"/apps/update-cache":{"post":{"tags":["Apps"],"summary":"Update the app status cache. Results will be broadcasted to SSE clients.","operationId":"apps_update_cache_apps_update_cache_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"JWTBearer":[]}]}},"/apps/status/{id}":{"get":{"tags":["Apps"],"summary":"Get the status of a single app by id.","operationId":"apps_status_apps_status__id__get","security":[{"JWTBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppStatus"}}}},"404":{"description":"If no or an invalid app id is given."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/apps/status_advanced/{id}":{"get":{"tags":["Apps"],"summary":"Get the advanced status of a single app by id.","description":"Some apps might give status information that is computationally\n    to expensive to include in the normal status endpoint.\n\n    Available app ids for this endpoint:\n    - electrs\n\n> ℹ️  _This endpoint is not implemented on all platforms_","operationId":"apps_status_advanced_apps_status_advanced__id__get","security":[{"JWTBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","required":true,"title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"If no or an invalid app id is given."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/apps/install/{app_id}":{"post":{"tags":["Apps"],"summary":"Install an app","description":"Attempts to install an app. The installation process results are\n    not returned on this endpoint. Instead, the results are communicated via the SSE\n    channels. This call only verifies if the app is available for installation on the\n    given platform.","operationId":"apps_install_apps_install__app_id__post","security":[{"JWTBearer":[]}],"parameters":[{"name":"app_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/AppId"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"If the app is already installed or not available for the platform."},"404":{"description":"If no or an invalid app id is given."},"423":{"description":"If an app install task is already running."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/apps/uninstall":{"post":{"tags":["Apps"],"summary":"Uninstall app","description":"Attempts to uninstall an app. The uninstallation process results are\n    not returned on this endpoint. Instead, the results are communicated via the SSE\n    channels. This call only verifies if the app is available for uninstallation on the\n    given platform.","operationId":"apps_uninstall_apps_uninstall_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppUninstallInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"If the app is already installed."},"404":{"description":"If no or an invalid app id is given."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"JWTBearer":[]}]}},"/bitcoin/btc-info":{"get":{"tags":["Bitcoin Core"],"summary":"Bitcoin.Btc-Info","description":"Get general information about bitcoin core. Combines most important information from `getblockchaininfo` and `getnetworkinfo`","operationId":"bitcoin_btc_info_bitcoin_btc_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BtcInfo"}}}}},"security":[{"JWTBearer":[]}]}},"/bitcoin/get-block-count":{"get":{"tags":["Bitcoin Core"],"summary":"Get the current block count","description":"See documentation on [bitcoincore.org](https://bitcoincore.org/en/doc/0.21.0/rpc/blockchain/getblockcount/)","operationId":"bitcoin_get_block_count_bitcoin_get_block_count_get","responses":{"200":{"description":"A JSON String with relevant information.\n\n```json\n{\n  \"result\": 682621,\n  \"error\": null,\n  \"id\": 0\n}\n","content":{"application/json":{"schema":{}}}}},"security":[{"JWTBearer":[]}]}},"/bitcoin/get-blockchain-info":{"get":{"tags":["Bitcoin Core"],"summary":"Get the current blockchain status","description":"See documentation on [bitcoincore.org](https://bitcoincore.org/en/doc/0.21.0/rpc/blockchain/getblockchaininfo/)","operationId":"bitcoin_get_blockchain_info_bitcoin_get_blockchain_info_get","responses":{"200":{"description":"A JSON String with relevant information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockchainInfo"}}}}},"security":[{"JWTBearer":[]}]}},"/bitcoin/estimate-fee":{"get":{"tags":["Bitcoin Core"],"summary":"Get current fee estimation from Bitcoin Core","description":"Estimates the fee for the given parameters.\n    See documentation on [bitcoin.org](https://developer.bitcoin.org/reference/rpc/estimatesmartfee.html)","operationId":"bitcoin_estimate_fee_bitcoin_estimate_fee_get","security":[{"JWTBearer":[]}],"parameters":[{"name":"target_conf","in":"query","required":false,"schema":{"type":"integer","description":"Confirmation target in blocks.","default":6,"title":"Target Conf"},"description":"Confirmation target in blocks."},{"name":"mode","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FeeEstimationMode","description":"Whether to return a more conservative estimate which also satisfies a longer history. A conservative estimate potentially returns a higher feerate and is more likely to be sufficient for the desired target, but is not as responsive to short term drops in the prevailing fee market.","default":"conservative"},"description":"Whether to return a more conservative estimate which also satisfies a longer history. A conservative estimate potentially returns a higher feerate and is more likely to be sufficient for the desired target, but is not as responsive to short term drops in the prevailing fee market."}],"responses":{"200":{"description":"The estimated fee in satoshis","content":{"application/json":{"schema":{"type":"integer","title":"Response Bitcoin Estimate Fee Bitcoin Estimate Fee Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/bitcoin/get-network-info":{"get":{"tags":["Bitcoin Core"],"summary":"Get information about the network","description":"See documentation on [bitcoincore.org](https://bitcoincore.org/en/doc/0.21.0/rpc/network/getnetworkinfo/)","operationId":"bitcoin_get_network_info_bitcoin_get_network_info_get","responses":{"200":{"description":"A JSON String with relevant information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkInfo"}}}}},"security":[{"JWTBearer":[]}]}},"/bitcoin/get-raw-transaction":{"get":{"tags":["Bitcoin Core"],"summary":"Get information about a raw transaction","description":"See documentation on [bitcoincore.org](https://bitcoincore.org/en/doc/22.0.0/rpc/rawtransactions/getrawtransaction/)","operationId":"bitcoin_get_raw_transaction_bitcoin_get_raw_transaction_get","security":[{"JWTBearer":[]}],"parameters":[{"name":"txid","in":"query","required":true,"schema":{"type":"string","minLength":64,"maxLength":64,"description":"The transaction id","title":"Txid"},"description":"The transaction id"}],"responses":{"200":{"description":"A JSON String with relevant information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RawTransaction"}}}},"400":{"description":"Invalid transaction id or -txindex not enabled"},"404":{"description":"No such mempool or blockchain transaction."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/bitcoin/block-sub":{"get":{"tags":["Bitcoin Core"],"summary":"Subscribe to incoming blocks.","description":"Similar to Bitcoin Core getblock\n\nSSE endpoint to receive new block information as soon as it is appended to chain.\n\nIf verbosity is 0, returns a string that is serialized, hex-encoded data for block 'hash'.<br>\nIf verbosity is 1, returns an Object with information about block <hash>.<br>\nIf verbosity is 2, returns an Object with information about block <hash> and information about each transaction.<br>","operationId":"bitcoin_block_sub_bitcoin_block_sub_get","security":[{"JWTBearer":[]}],"parameters":[{"name":"verbosity","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Verbosity"}}],"responses":{"200":{"description":"A JSON object with information about the new block.","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/lightning/add-invoice":{"post":{"tags":["Lightning"],"summary":"Addinvoice adds a new Invoice to the database.","description":"For additional information see [LND docs](https://api.lightning.community/#addinvoice)","operationId":"lightning_add_invoice_lightning_add_invoice_post","security":[{"JWTBearer":[]}],"parameters":[{"name":"value_msat","in":"query","required":true,"schema":{"type":"integer","minimum":0,"description":"The amount of msat of the invoice","title":"Value Msat"},"description":"The amount of msat of the invoice"},{"name":"memo","in":"query","required":false,"schema":{"type":"string","description":"The memo of the invoice","default":"","title":"Memo"},"description":"The memo of the invoice"},{"name":"expiry","in":"query","required":false,"schema":{"type":"integer","description":"Expiry time in seconds","default":3600,"title":"Expiry"},"description":"Expiry time in seconds"},{"name":"is_keysend","in":"query","required":false,"schema":{"type":"boolean","description":"LND only: Whether this invoice is a keysend invoice.","default":false,"title":"Is Keysend"},"description":"LND only: Whether this invoice is a keysend invoice."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}}}},"423":{"description":"LND only: Wallet is locked. Unlock via /lightning/unlock-wallet."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/lightning/get-balance":{"get":{"tags":["Lightning"],"summary":"Get the current on chain and channel balances of the lighting wallet.","operationId":"lightning_get_balance_lightning_get_balance_get","responses":{"200":{"description":"\nA JSON String with on chain wallet balances with on-chain balances in\n**sat** and channel balances in **msat**. Detailed description is in\nthe schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletBalance"}}}},"423":{"description":"LND only: Wallet is locked. Unlock via /lightning/unlock-wallet."}},"security":[{"JWTBearer":[]}]}},"/lightning/get-fee-revenue":{"get":{"tags":["Lightning"],"summary":"Returns the daily, weekly and monthly fee revenue earned.","description":"Currently, year and total fees are always null. Backends don't return these values by default. Implementation in BlitzAPI remains a [to-do](https://github.com/fusion44/blitz_api/issues/64).","operationId":"lightning_get_fee_revenue_lightning_get_fee_revenue_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeRevenue"}}}},"423":{"description":"LND only: Wallet is locked. Unlock via /lightning/unlock-wallet."}},"security":[{"JWTBearer":[]}]}},"/lightning/list-all-tx":{"get":{"tags":["Lightning"],"summary":"Lists all on-chain transactions, payments and invoices in the wallet","description":"Returns a list with all on-chain transaction, payments and invoices combined into one list. The index of each tx is only valid for each identical set of parameters.","operationId":"lightning_list_all_tx_lightning_list_all_tx_get","security":[{"JWTBearer":[]}],"parameters":[{"name":"successful_only","in":"query","required":false,"schema":{"type":"boolean","description":"If set, only successful transaction will be returned in the response.","default":false,"title":"Successful Only"},"description":"If set, only successful transaction will be returned in the response."},{"name":"index_offset","in":"query","required":false,"schema":{"type":"integer","description":"The index of an transaction that will be used as either the start or end of a query to determine which invoices should be returned in the response.","default":0,"title":"Index Offset"},"description":"The index of an transaction that will be used as either the start or end of a query to determine which invoices should be returned in the response."},{"name":"max_tx","in":"query","required":false,"schema":{"type":"integer","description":"The max number of transaction to return in the response to this query. Will return all transactions when set to 0 or null.","default":0,"title":"Max Tx"},"description":"The max number of transaction to return in the response to this query. Will return all transactions when set to 0 or null."},{"name":"reversed","in":"query","required":false,"schema":{"type":"boolean","description":"If set, the transactions returned will result from seeking backwards from the specified index offset. This can be used to paginate backwards.","default":false,"title":"Reversed"},"description":"If set, the transactions returned will result from seeking backwards from the specified index offset. This can be used to paginate backwards."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GenericTx"},"title":"Response Lightning List All Tx Lightning List All Tx Get"}}}},"423":{"description":"LND only: Wallet is locked. Unlock via /lightning/unlock-wallet."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/lightning/list-invoices":{"get":{"tags":["Lightning"],"summary":"Lists all invoices from the wallet. Modeled after LND implementation.","operationId":"lightning_list_invoices_lightning_list_invoices_get","security":[{"JWTBearer":[]}],"parameters":[{"name":"pending_only","in":"query","required":false,"schema":{"type":"boolean","description":"If set, only invoices that are not settled and not canceled will be returned in the response.","default":false,"title":"Pending Only"},"description":"If set, only invoices that are not settled and not canceled will be returned in the response."},{"name":"index_offset","in":"query","required":false,"schema":{"type":"integer","description":"The index of an invoice that will be used as either the start or end of a query to determine which invoices should be returned in the response.","default":0,"title":"Index Offset"},"description":"The index of an invoice that will be used as either the start or end of a query to determine which invoices should be returned in the response."},{"name":"num_max_invoices","in":"query","required":false,"schema":{"type":"integer","description":"The max number of invoices to return in the response to this query. This will return all invoices when set to 0 or null.","default":0,"title":"Num Max Invoices"},"description":"The max number of invoices to return in the response to this query. This will return all invoices when set to 0 or null."},{"name":"reversed","in":"query","required":false,"schema":{"type":"boolean","description":"If set, the invoices returned will result from seeking backwards from the specified index offset. This can be used to paginate backwards.","default":false,"title":"Reversed"},"description":"If set, the invoices returned will result from seeking backwards from the specified index offset. This can be used to paginate backwards."}],"responses":{"200":{"description":"A list of all invoices created.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"},"title":"Response Lightning List Invoices Lightning List Invoices Get"}}}},"423":{"description":"LND only: Wallet is locked. Unlock via /lightning/unlock-wallet."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/lightning/list-onchain-tx":{"get":{"tags":["Lightning"],"summary":"Lists all onchain transactions from the wallet","operationId":"lightning_list_onchain_tx_lightning_list_onchain_tx_get","responses":{"200":{"description":"A list of all on-chain transactions made.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OnChainTransaction"},"type":"array","title":"Response Lightning List Onchain Tx Lightning List Onchain Tx Get"}}}},"423":{"description":"LND only: Wallet is locked. Unlock via /lightning/unlock-wallet."}},"security":[{"JWTBearer":[]}]}},"/lightning/list-payments":{"get":{"tags":["Lightning"],"summary":"Returns a list of all outgoing payments. Modeled after LND implementation.","operationId":"lightning_list_payments_lightning_list_payments_get","security":[{"JWTBearer":[]}],"parameters":[{"name":"include_incomplete","in":"query","required":false,"schema":{"type":"boolean","description":"If true, then return payments that have not yet fully completed. This means that pending payments, as well as failed payments will show up if this field is set to true. This flag doesn't change the meaning of the indices, which are tied to individual payments.","default":true,"title":"Include Incomplete"},"description":"If true, then return payments that have not yet fully completed. This means that pending payments, as well as failed payments will show up if this field is set to true. This flag doesn't change the meaning of the indices, which are tied to individual payments."},{"name":"index_offset","in":"query","required":false,"schema":{"type":"integer","description":"The index of a payment that will be used as either the start or end of a query to determine which payments should be returned in the response. The index_offset is exclusive. In the case of a zero index_offset, the query will start with the oldest payment when paginating forwards, or will end with the most recent payment when paginating backwards.","default":0,"title":"Index Offset"},"description":"The index of a payment that will be used as either the start or end of a query to determine which payments should be returned in the response. The index_offset is exclusive. In the case of a zero index_offset, the query will start with the oldest payment when paginating forwards, or will end with the most recent payment when paginating backwards."},{"name":"max_payments","in":"query","required":false,"schema":{"type":"integer","description":"The maximal number of payments returned in the response to this query.","default":0,"title":"Max Payments"},"description":"The maximal number of payments returned in the response to this query."},{"name":"reversed","in":"query","required":false,"schema":{"type":"boolean","description":"If set, the payments returned will result from seeking backwards from the specified index offset. This can be used to paginate backwards. The order of the returned payments is always oldest first (ascending index order).","default":false,"title":"Reversed"},"description":"If set, the payments returned will result from seeking backwards from the specified index offset. This can be used to paginate backwards. The order of the returned payments is always oldest first (ascending index order)."}],"responses":{"200":{"description":"A list of all payments made.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Payment"},"title":"Response Lightning List Payments Lightning List Payments Get"}}}},"423":{"description":"LND only: Wallet is locked. Unlock via /lightning/unlock-wallet."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/lightning/new-address":{"post":{"tags":["Lightning"],"summary":"Generate a new on-chain address","description":"Generate a wallet new address. Address-types has to be one of:\n* **p2wkh**:  Pay to witness key hash (bech32)\n* **np2wkh**: Pay to nested witness key hash (LND only)\n\n> ℹ️ _CLN only supports and returns p2wkh (bech32) addresses_","operationId":"lightning_new_address_lightning_new_address_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewAddressInput"}}},"required":true},"responses":{"200":{"description":"The newly generated wallet address","content":{"application/json":{"schema":{"type":"string","title":"Response Lightning New Address Lightning New Address Post"}}}},"423":{"description":"LND only: Wallet is locked. Unlock via /lightning/unlock-wallet."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"JWTBearer":[]}]}},"/lightning/send-coins":{"post":{"tags":["Lightning"],"summary":"Attempt to send on-chain funds.","description":"__send-coins__ executes a request to send coins to a particular address.\n\n### LND:\nIf neither __target_conf__, or __sat_per_vbyte__ are set, then the internal wallet will consult its fee model to determine a fee for the default confirmation target.\n\n> 👉 See [https://api.lightning.community/?shell#sendcoins](https://api.lightning.community/?shell#sendcoins)\n\n### c-lightning:\n* Set __target_conf__ ==1: interpreted as urgent (aim for next block)\n* Set __target_conf__ >=2: interpreted as normal (next 4 blocks or so, **default**)\n* Set __target_cont__ >=10: interpreted as slow (next 100 blocks or so)\n* If __sat_per_vbyte__ is set then __target_conf__ is ignored and vbytes (sipabytes) will be used.\n\n> 👉 See [https://lightning.readthedocs.io/lightning-txprepare.7.html](https://lightning.readthedocs.io/lightning-txprepare.7.html)\n\n### Sending all onchain funds\n> ℹ️ Keep the following points in mind when sending all onchain funds:\n\n* The response object currently will state __\"amount\": 0__ even if __send_all__ is set to __true__ and the transaction was successfully submitted to the mempool. [GitHub issue](https://github.com/fusion44/blitz_api/issues/196)\n* If __send_all__ is set to __true__, the __amount__ field must be set to __0__.\n* If the __amount__ field is greater than __0__, the __send_all__ field must be __false__.\n  * The API will return an error if neither or both conditions are met at the same time.\n* If __send_all__ is set to __true__ the amount of satoshis to send will be calculated by subtracting the fee from the wallet balance.\n* If the wallet balance is not sufficient to cover the fee, the call will fail.\n* The call will __not__ close any channels.\n* The implementation may keep a reserve of funds if there are still open channels.","operationId":"lightning_send_coins_lightning_send_coins_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCoinsInput"}}},"required":true},"responses":{"200":{"description":"Either an error or a SendCoinsResponse object on success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCoinsResponse"}}}},"412":{"description":"When not enough funds are available."},"423":{"description":"LND only: Wallet is locked. Unlock via /lightning/unlock-wallet."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"JWTBearer":[]}]}},"/lightning/open-channel":{"post":{"tags":["Lightning"],"summary":"open a new lightning channel","description":"__open-channel__ attempts to open a channel with a peer.\n\n### LND:\n_target_conf_: The target number of blocks that the funding transaction should be confirmed by.\n\n### c-lightning:\n* Set _target_conf_ ==1: interpreted as urgent (aim for next block)\n* Set _target_conf_ >=2: interpreted as normal (next 4 blocks or so, **default**)\n* Set _target_cont_ >=10: interpreted as slow (next 100 blocks or so)\n\n> 👉 See [https://lightning.readthedocs.io/lightning-txprepare.7.html](https://lightning.readthedocs.io/lightning-txprepare.7.html)","operationId":"lightning_open_channel_lightning_open_channel_post","security":[{"JWTBearer":[]}],"parameters":[{"name":"local_funding_amount","in":"query","required":true,"schema":{"type":"integer","title":"Local Funding Amount"}},{"name":"node_URI","in":"query","required":true,"schema":{"type":"string","title":"Node Uri"}},{"name":"target_confs","in":"query","required":false,"schema":{"type":"integer","default":3,"title":"Target Confs"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Lightning Open Channel Lightning Open Channel Post"}}}},"412":{"description":"When not enough funds are available."},"423":{"description":"LND only: Wallet is locked. Unlock via /lightning/unlock-wallet."},"504":{"description":"When the peer is not reachable."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/lightning/list-channels":{"get":{"tags":["Lightning"],"summary":"Returns a list of open channels","operationId":"lightning_list_channels_lightning_list_channels_get","responses":{"200":{"description":"A list of all open channels.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Channel"},"type":"array","title":"Response Lightning List Channels Lightning List Channels Get"}}}},"423":{"description":"LND only: Wallet is locked. Unlock via /lightning/unlock-wallet."}},"security":[{"JWTBearer":[]}]}},"/lightning/close-channel":{"post":{"tags":["Lightning"],"summary":"close a channel","description":"For additional information see [LND docs](https://api.lightning.community/#closechannel)","operationId":"lightning_close_channel_lightning_close_channel_post","security":[{"JWTBearer":[]}],"parameters":[{"name":"channel_id","in":"query","required":true,"schema":{"type":"string","title":"Channel Id"}},{"name":"force_close","in":"query","required":true,"schema":{"type":"boolean","title":"Force Close"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Lightning Close Channel Lightning Close Channel Post"}}}},"423":{"description":"LND only: Wallet is locked. Unlock via /lightning/unlock-wallet."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/lightning/send-payment":{"post":{"tags":["Lightning"],"summary":"Attempt to pay a payment request.","description":"This endpoints attempts to pay a payment request.\n\nIntermediate status updates will be sent via the SSE channel. This endpoint returns the last success or error message from the node.","operationId":"lightning_send_payment_lightning_send_payment_post","security":[{"JWTBearer":[]}],"parameters":[{"name":"pay_req","in":"query","required":true,"schema":{"type":"string","title":"Pay Req"}},{"name":"timeout_seconds","in":"query","required":false,"schema":{"type":"integer","default":5,"title":"Timeout Seconds"}},{"name":"fee_limit_msat","in":"query","required":false,"schema":{"type":"integer","default":8000,"title":"Fee Limit Msat"}},{"name":"amount_msat","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount Msat"}}],"responses":{"200":{"description":"Either an error or a Payment object on success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}}},"400":{"description":"Possible error messages:* invalid bech32 string* amount must be specified when paying a zero amount invoice* amount must not be specified when paying a non-zero amount invoice"},"409":{"description":"[LND only] When attempting to pay an already paid invoice. CLN will return the payment object of the previously paid invoice. Info: [GitHub](https://github.com/fusion44/blitz_api/issues/131)"},"423":{"description":"LND only: Wallet is locked. Unlock via /lightning/unlock-wallet."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/lightning/get-info":{"get":{"tags":["Lightning"],"summary":"Request information about the currently running lightning node.","operationId":"lightning_get_info_lightning_get_info_get","responses":{"200":{"description":"Either an error or a LnInfo object on success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LnInfo"}}}},"423":{"description":"LND only: Wallet is locked. Unlock via /lightning/unlock-wallet."}},"security":[{"JWTBearer":[]}]}},"/lightning/decode-pay-req":{"get":{"tags":["Lightning"],"summary":"DecodePayReq takes an encoded payment request string and attempts to decode it, returning a full description of the conditions encoded within the payment request.","operationId":"lightning_decode_pay_req_lightning_decode_pay_req_get","security":[{"JWTBearer":[]}],"parameters":[{"name":"pay_req","in":"query","required":true,"schema":{"type":"string","description":"The payment request string to be decoded","title":"Pay Req"},"description":"The payment request string to be decoded"}],"responses":{"200":{"description":"A fully decoded payment request or a HTTP status 400 if the payment request cannot be decoded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequest"}}}},"423":{"description":"LND only: Wallet is locked. Unlock via /lightning/unlock-wallet."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/lightning/unlock-wallet":{"post":{"tags":["Lightning"],"summary":"Unlocks a locked wallet.","operationId":"lightning_unlock_wallet_lightning_unlock_wallet_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnlockWalletInput"}}},"required":true},"responses":{"200":{"description":"\n`True` if ok, `False` otherwise\n\n### LND:\nThis call will wait until the LND daemon is fully ready to accept calls. Internally it'll call GetInfo every\n0.1 seconds and returns True for the first successful call.\n\n> ℹ️ _After the unlock the LND-gRPC server takes a bit of time to boot up._\n\n### Core Lightning:\n\n> ℹ️ _Platform: Native_ CLN doesn't support wallet locking and will return True immediately.\n\n> ℹ️ _Platform: RaspiBlitz_ RaspiBlitz has its own locking implementation on top of CLN. Will unlock and return True if successful. Might take a few seconds. If it takes longer than 60 seconds it'll return an error.\n","content":{"application/json":{"schema":{"type":"boolean","title":"Response Lightning Unlock Wallet Lightning Unlock Wallet Post"}}}},"401":{"description":"Either JWT token is not ok OR wallet password is wrong, observe the detail message."},"412":{"description":"Wallet already unlocked"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"JWTBearer":[]}]}},"/system/login":{"post":{"tags":["System"],"summary":"Logs the user in with the current password","operationId":"system_login_system_login_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginInput"}}},"required":true},"responses":{"200":{"description":"JWT token for the current session.","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/system/refresh-token":{"post":{"tags":["System"],"summary":"Endpoint to refresh an authentication token","operationId":"system_refresh_token_system_refresh_token_post","responses":{"200":{"description":"Returns a fresh JWT token.","content":{"application/json":{"schema":{}}}}},"security":[{"JWTBearer":[]}]}},"/system/change-password":{"post":{"tags":["System"],"summary":"Endpoint to change your password","operationId":"system_change_password_system_change_password_post","security":[{"JWTBearer":[]}],"parameters":[{"name":"old_password","in":"query","required":true,"schema":{"type":"string","title":"Old Password"}},{"name":"new_password","in":"query","required":true,"schema":{"type":"string","title":"New Password"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ℹ️ Used in **RaspiBlitz only**. Password A, B or C. Must be one of `[\"a\", \"b\", \"c\"]`","title":"Type"},"description":"ℹ️ Used in **RaspiBlitz only**. Password A, B or C. Must be one of `[\"a\", \"b\", \"c\"]`"}],"responses":{"200":{"description":"if 200 OK - password change worked","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/system/get-system-info":{"get":{"tags":["System"],"summary":"Get system status information","operationId":"system_get_system_info_system_get_system_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemInfo"}}}},"423":{"description":"Wallet is locked. Unlock via /lightning/unlock-wallet"}},"security":[{"JWTBearer":[]}]}},"/system/hardware-info":{"get":{"tags":["System"],"summary":"Get hardware status information.","operationId":"system_hardware_info_system_hardware_info_get","responses":{"200":{"description":"Returns a JSON string with hardware information:\n\n```JSON\n{\n  \"cpu_overall_percent\": 15.8,\n  \"cpu_per_cpu_percent\": [\n    11.8,\n    6.1,\n    12.5\n  ],\n  \"vram_total_bytes\": 25134919680,\n  \"vram_available_bytes\": 17240051712,\n  \"vram_used_bytes\": 6044856320,\n  \"vram_usage_percent\": 31.4,\n  \"swap_ram_total_bytes\": 2147479552,\n  \"swap_used_bytes\": 0,\n  \"swap_usage_bytes\": 0,\n  \"temperatures_celsius\": {\n    \"coretemp\": [\n      [\n        \"Core 1\",\n        51,\n        84,\n        100\n      ],\n      [\n        \"Core 2\",\n        53,\n        84,\n        100\n      ],\n      [\n        \"Core 3\",\n        50,\n        84,\n        100\n      ]\n    ]\n  },\n  \"boot_time_timestamp\": 1623486468,\n  \"disk_io_read_count\": 254574,\n  \"disk_io_write_count\": 133353,\n  \"disk_io_read_bytes\": 5306839040,\n  \"disk_io_write_bytes\": 5593076736,\n  \"disks\": [\n    {\n      \"device\": \"/dev/sda1\",\n      \"mountpoint\": \"/boot/efi\",\n      \"filesystem_type\": \"vfat\",\n      \"partition_total_bytes\": 535805952,\n      \"partition_used_bytes\": 8228864,\n      \"partition_free_bytes\": 527577088,\n      \"partition_percent\": 1.5\n    },\n    {\n      \"device\": \"/dev/sda2\",\n      \"mountpoint\": \"/\",\n      \"filesystem_type\": \"ext4\",\n      \"partition_total_bytes\": 250438021120,\n      \"partition_used_bytes\": 177157742592,\n      \"partition_free_bytes\": 60487389184,\n      \"partition_percent\": 74.5\n    }\n  ],\n  \"networks\": [\n    {\n      \"interface_name\": \"lo\",\n      \"address\": \"127.0.0.1\",\n      \"mac_address\": \"00:00:00:00:00:00\"\n    },\n    {\n      \"interface_name\": \"enp4s0\",\n      \"address\": \"192.168.1.23\",\n      \"mac_address\": \"35:a3:5c:6a:4a:f0\"\n    }\n  ],\n  \"networks_bytes_sent\": 137088249,\n  \"networks_bytes_received\": 1603400654\n}\n```\n","content":{"application/json":{"schema":{}}}}},"security":[{"JWTBearer":[]}]}},"/system/connection-info":{"get":{"tags":["System"],"summary":"Get credential information to connect external apps.","operationId":"system_connection_info_system_connection_info_get","responses":{"200":{"description":"Returns a JSON string with credential information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionInfo"}}}}},"security":[{"JWTBearer":[]}]}},"/system/get-debug-logs-raw":{"get":{"tags":["System"],"summary":"Get raw system logs as a text string.","description":"This endpoint will gather latest system logs and return it in a\nraw string. This endpoint will **not** return immediately because\nit gathers all data on time of the request.","operationId":"system_get_debug_logs_raw_system_get_debug_logs_raw_get","responses":{"200":{"description":"\nThe latest system log as a string of text.\n\nReturns a `HTTP_INTERNAL_SERVER_ERROR` with status code 500 if script execution fails on server.\n\nExample output in `raw_data`:\n\n```\n***************************************************************\n* RASPIBLITZ DEBUG LOGS\n***************************************************************\nblitzversion: 1.7.0\nchainnetwork: bitcoin / main\n 15:27:34 up  4:10,  3 users,  load average: 1.23, 1.36, 1.38\n\n*** BLOCKCHAIN SYSTEMD STATUS ***\n● bitcoind.service - Bitcoin daemon\n   Loaded: loaded (/etc/systemd/system/bitcoind.service; enabled; vendor preset: enabled)\n   Active: active (running) since Tue 2021-09-14 11:16:51 BST; 4h 10min ago\n  Process: 1718 ExecStartPre=/home/admin/config.scripts/blitz.systemd.sh log blockchain STARTED (code=exited, status=0/SUCCESS)\n  Process: 1724 ExecStart=/usr/local/bin/bitcoind -daemon -conf=/home/bitcoin/.bitcoin/bitcoin.conf -pid=/mnt/hdd/bitcoin/bitcoind.pid (code=exited, status=0/SUCCESS)\n Main PID: 1765 (bitcoind)\n    Tasks: 12 (limit: 4533)\n   CGroup: /system.slice/bitcoind.service\n           └─1765 /usr/local/bin/bitcoind -daemon -conf=/home/bitcoin/.bitcoin/bitcoin.conf -pid=/mnt/hdd/bitcoin/bitcoind.pid\n\nSep 14 11:16:50 raspberrypi systemd[1]: Starting Bitcoin daemon...\nSep 14 11:16:51 raspberrypi systemd[1]: Started Bitcoin daemon.\n\n*** LAST BLOCKCHAIN ERROR LOGS ***\nsudo journalctl -u bitcoind -b --no-pager -n8\n-- Logs begin at Tue 2021-09-14 11:15:58 BST, end at Tue 2021-09-14 15:27:35 BST. --\nSep 14 11:16:50 raspberrypi systemd[1]: Starting Bitcoin daemon...\nSep 14 11:16:51 raspberrypi systemd[1]: Started Bitcoin daemon.\n\n*** LAST BLOCKCHAIN 20 INFO LOGS ***\nsudo tail -n 20 /mnt/hdd/bitcoin/debug.log\n2021-09-14T14:26:27Z Rolling forward 00000000000000000082dcdfb99c8b663828fd40fd68f343a17f766e1dee9bdc (499641)\n2021-09-14T14:26:30Z Rolling forward 0000000000000000003c2cc296d753717135a38cfea6bc3ddba640aac063fb3b (499642)\n2021-09-14T14:26:34Z Rolling forward 00000000000000000005869d321a8f2046d1e47f55b97920c9e4bb8a971db40b (499643)\n2021-09-14T14:26:37Z Rolling forward 0000000000000000002d429f39afec70c938e888c3417d690bbc85e83529991c (499644)\n2021-09-14T14:26:40Z Rolling forward 00000000000000000024c0bdbec66a889778c00bc69be0a96cbbd98b75c3ce09 (499645)\n2021-09-14T14:26:43Z Rolling forward 00000000000000000082756af6724e3200ea9089cb4244cb2d94c83c3cd137d7 (499646)\n2021-09-14T14:26:47Z Rolling forward 0000000000000000007f3bf2c37dc14630153b93bc2c34542deadb34a5eb201f (499647)\n2021-09-14T14:26:51Z Rolling forward 0000000000000000003b9296ea38abd68e97beb0c5ed56a8255e6b379a02032b (499648)\n2021-09-14T14:26:54Z Rolling forward 000000000000000000146931cda4713b5ded152c9ae57effe37f216d5a5f31b6 (499649)\n2021-09-14T14:26:57Z Rolling forward 000000000000000000684318d6fc7266f8eb5dc349a170413a0c0ce2334da08f (499650)\n2021-09-14T14:27:00Z Rolling forward 000000000000000000846d905295c15c98f9dc8c8f3ab44bbb997cca9a8e4c83 (499651)\n2021-09-14T14:27:04Z Rolling forward 00000000000000000082bfa88de1c4e6501462e231f0aa54f552f36bdf34fdd3 (499652)\n2021-09-14T14:27:08Z Rolling forward 000000000000000000acce35f2b4ba5256f016da6024abb09ad60b6dcbd0ed83 (499653)\n2021-09-14T14:27:11Z Rolling forward 000000000000000000ae0edf99df2db7e05a0f18e3e5a3e0dfc67013dadc526f (499654)\n2021-09-14T14:27:14Z Rolling forward 00000000000000000087cec98103a704a4594831e8173fa3c916b3c537456ab7 (499655)\n2021-09-14T14:27:17Z Rolling forward 000000000000000000102d751e4c7e2de8f12e04cd4b44fe8179d492b29ea0e2 (499656)\n2021-09-14T14:27:21Z Rolling forward 0000000000000000001a98320ee19986cfb19f30bb1d1deb0cfc21ed9fa3c7ae (499657)\n2021-09-14T14:27:24Z Rolling forward 0000000000000000005ad979367405af6ad75465a8900089cb3bd7b53ff4dc9d (499658)\n2021-09-14T14:27:28Z Rolling forward 0000000000000000005bd3de0386b9c24f92e363a04da33b6b6ac7450997f4aa (499659)\n2021-09-14T14:27:32Z Rolling forward 0000000000000000009fd25eaf6245cd8a0a8869bbe28145f39e4de14dd62825 (499660)\n\n*** LND SYSTEMD STATUS ***\n● lnd.service - LND Lightning Daemon\n   Loaded: loaded (/etc/systemd/system/lnd.service; enabled; vendor preset: enabled)\n   Active: active (running) since Tue 2021-09-14 11:20:13 BST; 4h 7min ago\n  Process: 7000 ExecStartPre=/home/admin/config.scripts/blitz.systemd.sh log lightning STARTED (code=exited, status=0/SUCCESS)\n Main PID: 7002 (lnd)\n    Tasks: 10 (limit: 4533)\n   CGroup: /system.slice/lnd.service\n           └─7002 /usr/local/bin/lnd --tor.active --tor.streamisolation --tor.v3 --tor.socks=9070 --tor.control=9071 --listen=127.0.0.1:9735\n\nSep 14 11:20:13 raspberrypi systemd[1]: Starting LND Lightning Daemon...\nSep 14 11:20:13 raspberrypi systemd[1]: Started LND Lightning Daemon.\n\n*** LAST LND ERROR LOGS ***\nsudo journalctl -u lnd -b --no-pager -n12\n-- Logs begin at Tue 2021-09-14 11:15:58 BST, end at Tue 2021-09-14 15:27:35 BST. --\nSep 14 11:16:51 raspberrypi systemd[1]: Starting LND Lightning Daemon...\nSep 14 11:16:51 raspberrypi systemd[1]: Started LND Lightning Daemon.\nSep 14 11:19:13 raspberrypi lnd[1772]: unable to create chain control: unable to connect to bitcoind: -28: Loading block index...\nSep 14 11:19:13 raspberrypi systemd[1]: lnd.service: Main process exited, code=exited, status=1/FAILURE\nSep 14 11:19:13 raspberrypi systemd[1]: lnd.service: Failed with result 'exit-code'.\nSep 14 11:20:13 raspberrypi systemd[1]: lnd.service: Service RestartSec=1min expired, scheduling restart.\nSep 14 11:20:13 raspberrypi systemd[1]: lnd.service: Scheduled restart job, restart counter is at 1.\nSep 14 11:20:13 raspberrypi systemd[1]: Stopped LND Lightning Daemon.\nSep 14 11:20:13 raspberrypi systemd[1]: Starting LND Lightning Daemon...\nSep 14 11:20:13 raspberrypi systemd[1]: Started LND Lightning Daemon.\n\n*** LAST 30 LND INFO LOGS ***\nsudo tail -n 30 /mnt/hdd/lnd/logs/bitcoin/mainnet/lnd.log\n2021-09-14 11:16:51.708 [INF] LTND: Version: 0.12.1-beta commit=v0.12.1-beta, build=production, logging=default, debuglevel=debug\n2021-09-14 11:16:51.709 [INF] LTND: Active chain: Bitcoin (network=mainnet)\n2021-09-14 11:16:51.709 [INF] LTND: Opening the main database, this might take a few minutes...\n2021-09-14 11:16:51.709 [INF] LTND: Opening bbolt database, sync_freelist=true, auto_compact=false\n2021-09-14 11:16:51.724 [INF] CHDB: Checking for schema update: latest_version=20, db_version=20\n2021-09-14 11:16:51.724 [INF] LTND: Database now open (time_to_open=15.109685ms)!\n2021-09-14 11:16:51.763 [INF] RPCS: Password RPC server listening on 0.0.0.0:10009\n2021-09-14 11:16:51.769 [INF] RPCS: Password gRPC proxy started at 0.0.0.0:8080\n2021-09-14 11:16:51.769 [INF] LTND: Waiting for wallet encryption password. Use `lncli create` to create a wallet, `lncli unlock` to unlock an existing wallet, or `lncli changepassword` to change the password of an existing wallet and unlock it.\n2021-09-14 11:19:12.895 [INF] LNWL: Opened wallet\n2021-09-14 11:19:13.126 [INF] CHRE: Primary chain is set to: bitcoin\n2021-09-14 11:19:13.257 [ERR] LTND: unable to create chain control: unable to connect to bitcoind: -28: Loading block index...\n2021-09-14 11:19:13.257 [INF] LTND: Shutdown complete2021-09-14 11:20:14.120 [INF] LTND: Version: 0.12.1-beta commit=v0.12.1-beta, build=production, logging=default, debuglevel=debug\n2021-09-14 11:20:14.121 [INF] LTND: Active chain: Bitcoin (network=mainnet)\n2021-09-14 11:20:14.121 [INF] LTND: Opening the main database, this might take a few minutes...\n2021-09-14 11:20:14.121 [INF] LTND: Opening bbolt database, sync_freelist=true, auto_compact=false\n2021-09-14 11:20:14.133 [INF] CHDB: Checking for schema update: latest_version=20, db_version=20\n2021-09-14 11:20:14.133 [INF] LTND: Database now open (time_to_open=11.654861ms)!\n2021-09-14 11:20:14.172 [INF] RPCS: Password RPC server listening on 0.0.0.0:10009\n2021-09-14 11:20:14.177 [INF] RPCS: Password gRPC proxy started at 0.0.0.0:8080\n2021-09-14 11:20:14.177 [INF] LTND: Waiting for wallet encryption password. Use `lncli create` to create a wallet, `lncli unlock` to unlock an existing wallet, or `lncli changepassword` to change the password of an existing wallet and unlock it.\n\n*** NGINX SYSTEMD STATUS ***\n● nginx.service - A high performance web server and a reverse proxy server\n   Loaded: loaded (/lib/systemd/system/nginx.service; enabled; vendor preset: enabled)\n  Drop-In: /etc/systemd/system/nginx.service.d\n           └─raspiblitz.conf\n   Active: active (running) since Tue 2021-09-14 11:16:37 BST; 4h 10min ago\n     Docs: man:nginx(8)\n Main PID: 905 (nginx)\n    Tasks: 5 (limit: 4533)\n   CGroup: /system.slice/nginx.service\n           ├─905 nginx: master process /usr/sbin/nginx -g daemon on; master_process on;\n           ├─911 nginx: worker process\n           ├─913 nginx: worker process\n           ├─914 nginx: worker process\n           └─915 nginx: worker process\n\nSep 14 11:16:36 raspberrypi systemd[1]: Starting A high performance web server and a reverse proxy server...\nSep 14 11:16:37 raspberrypi systemd[1]: Started A high performance web server and a reverse proxy server.\n\n*** LAST NGINX LOGS ***\nsudo journalctl -u nginx -b --no-pager -n20\n-- Logs begin at Tue 2021-09-14 11:15:58 BST, end at Tue 2021-09-14 15:27:35 BST. --\nSep 14 11:16:36 raspberrypi systemd[1]: Starting A high performance web server and a reverse proxy server...\nSep 14 11:16:37 raspberrypi systemd[1]: Started A high performance web server and a reverse proxy server.\n--> CHECK CONFIG: sudo nginx -t\n\n\n*** LAST 20 TOUCHSCREEN LOGS ***\nsudo tail -n 20 /home/pi/.cache/lxsession/LXDE-pi/run.log\nPlaying WAVE '/usr/share/piwiz/srprompt.wav' : Signed 16 bit Little Endian, Rate 22050 Hz, Mono\nPlaying WAVE '/usr/share/piwiz/srprompt.wav' : Signed 16 bit Little Endian, Rate 22050 Hz, Mono\n** Message: 01:44:02.973: wlan0: Received scan results\nPlaying WAVE '/usr/share/piwiz/srprompt.wav' : Signed 16 bit Little Endian, Rate 22050 Hz, Mono\nPlaying WAVE '/usr/share/piwiz/srprompt.wav' : Signed 16 bit Little Endian, Rate 22050 Hz, Mono\nPlaying WAVE '/usr/share/piwiz/srprompt.wav' : Signed 16 bit Little Endian, Rate 22050 Hz, Mono\nPlaying WAVE '/usr/share/piwiz/srprompt.wav' : Signed 16 bit Little Endian, Rate 22050 Hz, Mono\n** Message: 01:45:03.021: wlan0: Received scan results\nPlaying WAVE '/usr/share/piwiz/srprompt.wav' : Signed 16 bit Little Endian, Rate 22050 Hz, Mono\nPlaying WAVE '/usr/share/piwiz/srprompt.wav' : Signed 16 bit Little Endian, Rate 22050 Hz, Mono\nPlaying WAVE '/usr/share/piwiz/srprompt.wav' : Signed 16 bit Little Endian, Rate 22050 Hz, Mono\nPlaying WAVE '/usr/share/piwiz/srprompt.wav' : Signed 16 bit Little Endian, Rate 22050 Hz, Mono\n** Message: 01:46:02.982: wlan0: Received scan results\nPlaying WAVE '/usr/share/piwiz/srprompt.wav' : Signed 16 bit Little Endian, Rate 22050 Hz, Mono\nPlaying WAVE '/usr/share/piwiz/srprompt.wav' : Signed 16 bit Little Endian, Rate 22050 Hz, Mono\nPlaying WAVE '/usr/share/piwiz/srprompt.wav' : Signed 16 bit Little Endian, Rate 22050 Hz, Mono\nPlaying WAVE '/usr/share/piwiz/srprompt.wav' : Signed 16 bit Little Endian, Rate 22050 Hz, Mono\n** Message: 01:47:02.989: wlan0: Received scan results\nPlaying WAVE '/usr/share/piwiz/srprompt.wav' : Signed 16 bit Little Endian, Rate 22050 Hz, Mono\nPlaying WAVE '/usr/share/piwiz/srprompt.wav' : Signed 16 bit Little Endian, Rate 22050 Hz, Mono\n\n\n*** LAST 20 LOOP LOGS ***\nsudo journalctl -u loopd -b --no-pager -n20\n-- Logs begin at Tue 2021-09-14 11:15:58 BST, end at Tue 2021-09-14 15:27:35 BST. --\n-- No entries --\n\n- RTL is OFF by config\n\n*** LAST 20 ElectRS LOGS ***\nsudo journalctl -u electrs -b --no-pager -n20\n-- Logs begin at Tue 2021-09-14 11:15:58 BST, end at Tue 2021-09-14 15:27:35 BST. --\n-- No entries --\n\n*** ElectRS Status ***\n##### STATUS ELECTRS SERVICE\nconfigured=0\nserviceInstalled=0\ninfoSync='Service not installed'\nserviceRunning=0\ntipSynced=0\ninitialSynced=0\nelectrumResponding=0\ninfoSync='Not running - check: sudo journalctl -u electrs'\n\n\n*** LAST 20 LIT LOGS ***\nsudo journalctl -u litd -b --no-pager -n20\n-- Logs begin at Tue 2021-09-14 11:15:58 BST, end at Tue 2021-09-14 15:27:36 BST. --\n-- No entries --\n\n\n*** LAST 20 BTCPayServer LOGS ***\nsudo journalctl -u btcpayserver -b --no-pager -n20\n-- Logs begin at Tue 2021-09-14 11:15:58 BST, end at Tue 2021-09-14 15:27:36 BST. --\n-- No entries --\n\n\n*** LAST 20 LNbits LOGS ***\nsudo journalctl -u lnbits -b --no-pager -n20\n-- Logs begin at Tue 2021-09-14 11:15:58 BST, end at Tue 2021-09-14 15:27:36 BST. --\n-- No entries --\n\n\n*** LAST 20 Thunderhub LOGS ***\nsudo journalctl -u thunderhub -b --no-pager -n20\n-- Logs begin at Tue 2021-09-14 11:15:58 BST, end at Tue 2021-09-14 15:27:36 BST. --\n-- No entries --\n\n\n*** LAST 20 SPECTER LOGS ***\nsudo journalctl -u cryptoadvance-specter -b --no-pager -n20\n-- Logs begin at Tue 2021-09-14 11:15:58 BST, end at Tue 2021-09-14 15:27:36 BST. --\n-- No entries --\n\n\n*** LAST 20 SPHINX LOGS ***\nsudo journalctl -u sphinxrelay -b --no-pager -n20\n-- Logs begin at Tue 2021-09-14 11:15:58 BST, end at Tue 2021-09-14 15:27:36 BST. --\n-- No entries --\n\n\n*** MOUNTED DRIVES ***\nFilesystem     Type      Size  Used Avail Use% Mounted on\n/dev/root      ext4       29G  3.8G   25G  14% /\ndevtmpfs       devtmpfs  1.9G     0  1.9G   0% /dev\ntmpfs          tmpfs     1.9G     0  1.9G   0% /dev/shm\ntmpfs          tmpfs     1.9G   33M  1.9G   2% /run\ntmpfs          tmpfs     5.0M     0  5.0M   0% /run/lock\ntmpfs          tmpfs     1.9G     0  1.9G   0% /sys/fs/cgroup\ntmpfs          tmpfs      32M     0   32M   0% /var/cache/raspiblitz\n/dev/mmcblk0p1 vfat      253M   30M  223M  12% /boot\n/dev/sda1      ext4      916G  170G  700G  20% /mnt/hdd\ntmpfs          tmpfs     385M     0  385M   0% /run/user/1000\ntmpfs          tmpfs     385M     0  385M   0% /run/user/1001\n\n\n*** DATADRIVE ***\n# RASPIBLITZ DATA DRIVE Status\n\n# BASICS\nisMounted=1\nisBTRFS=0\nhddRaspiData=1\nisSSD=1\ndatadisk='sda'\ndatapartition='sda1'\nhddBlocksBitcoin=1\nhddBlocksLitecoin=0\nhddBytes=1000141693440\nhddGigaBytes=931\nhddUsedInfo='170G (20%)'\nhddDataFreeKB=733759240\nhddAdapterUSB=''\nhddAdapterUSAP=0\n\n# RAID\nisRaid=0\nraidCandidates=0\n\n# SWAP\nisSwapExternal=1\nSwapExternalPath='/mnt/hdd/swapfile'\n\n\n*** NETWORK ***\nlocalip=192.168.0.103\ndhcp=1\nnetwork_device=eth0\n\n*** HARDWARE TEST RESULTS ***\nUndervoltageReports in Logs: 0\n\n*** SYSTEM STATUS (can take some seconds to gather) ***\nlocalIP='192.168.0.102'\ntempCelsius='63.2'\nuptime=15042\nupsStatus='OFF'\nstartcountBlockchain=1\nbitcoinActive=1\nbitcoinErrorShort='Loading block index'\nbitcoinErrorFull='error code: -28 error message: Loading block index...'\nstartcountLightning=2\nlndActive=1\nlndRPCReady=0\nwalletOpened=0\nwalletReady=0\nwalletLocked=1\nlndRPCReady=0\nblitzTUIActive=0\nblitzTUIRestarts=0\nscriptRuntime=0\n\n*** OPTION: SHARE THIS DEBUG OUTPUT ***\nAn easy way to share this debug output on GitHub or on a support chat\nuse the following command and share the resulting link:\n/home/admin/XXdebugLogs.sh | nc termbin.com 9999\n```\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RawDebugLogData"}}}}},"security":[{"JWTBearer":[]}]}},"/system/hardware-info-sub":{"get":{"tags":["System"],"summary":"Subscribe to hardware status information.","operationId":"system_hardware_info_sub_system_hardware_info_sub_get","responses":{"200":{"description":"Yields a JSON string with hardware information every 2 seconds\n\n```JSON\n{\n  \"cpu_overall_percent\": 15.8,\n  \"cpu_per_cpu_percent\": [\n    11.8,\n    6.1,\n    12.5\n  ],\n  \"vram_total_bytes\": 25134919680,\n  \"vram_available_bytes\": 17240051712,\n  \"vram_used_bytes\": 6044856320,\n  \"vram_usage_percent\": 31.4,\n  \"swap_ram_total_bytes\": 2147479552,\n  \"swap_used_bytes\": 0,\n  \"swap_usage_bytes\": 0,\n  \"temperatures_celsius\": {\n    \"coretemp\": [\n      [\n        \"Core 1\",\n        51,\n        84,\n        100\n      ],\n      [\n        \"Core 2\",\n        53,\n        84,\n        100\n      ],\n      [\n        \"Core 3\",\n        50,\n        84,\n        100\n      ]\n    ]\n  },\n  \"boot_time_timestamp\": 1623486468,\n  \"disk_io_read_count\": 254574,\n  \"disk_io_write_count\": 133353,\n  \"disk_io_read_bytes\": 5306839040,\n  \"disk_io_write_bytes\": 5593076736,\n  \"disks\": [\n    {\n      \"device\": \"/dev/sda1\",\n      \"mountpoint\": \"/boot/efi\",\n      \"filesystem_type\": \"vfat\",\n      \"partition_total_bytes\": 535805952,\n      \"partition_used_bytes\": 8228864,\n      \"partition_free_bytes\": 527577088,\n      \"partition_percent\": 1.5\n    },\n    {\n      \"device\": \"/dev/sda2\",\n      \"mountpoint\": \"/\",\n      \"filesystem_type\": \"ext4\",\n      \"partition_total_bytes\": 250438021120,\n      \"partition_used_bytes\": 177157742592,\n      \"partition_free_bytes\": 60487389184,\n      \"partition_percent\": 74.5\n    }\n  ],\n  \"networks\": [\n    {\n      \"interface_name\": \"lo\",\n      \"address\": \"127.0.0.1\",\n      \"mac_address\": \"00:00:00:00:00:00\"\n    },\n    {\n      \"interface_name\": \"enp4s0\",\n      \"address\": \"192.168.1.23\",\n      \"mac_address\": \"35:a3:5c:6a:4a:f0\"\n    }\n  ],\n  \"networks_bytes_sent\": 137088249,\n  \"networks_bytes_received\": 1603400654\n}\n```\n","content":{"application/json":{"schema":{}}}}},"security":[{"JWTBearer":[]}]}},"/system/health":{"get":{"tags":["System"],"summary":"Returns info about the systems health","operationId":"system_health_system_health_get","security":[{"JWTBearer":[]}],"parameters":[{"name":"verbose","in":"query","required":false,"schema":{"type":"boolean","description":"Returns info about each subsytem running on this node if true. Currently not implemented.","default":false,"title":"Verbose"},"description":"Returns info about each subsytem running on this node if true. Currently not implemented."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemHealthInfo"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/system/reboot":{"post":{"tags":["System"],"summary":"Reboots the system","description":"Attempts to reboot the system.\n    Will send a `system_reboot_initiated` SSE message immediately to\n    all connected clients.","operationId":"system_reboot_system_reboot_post","responses":{"200":{"description":"True if successful. False on failure.\n    A failure will also send an error message with id `system_reboot_error`\n    to all connected clients.\n    ","content":{"application/json":{"schema":{"type":"boolean","title":"Response System Reboot System Reboot Post"}}}}},"security":[{"JWTBearer":[]}]}},"/system/shutdown":{"post":{"tags":["System"],"summary":"Shuts the system down","description":"Attempts to shutdown the system.\n    Will send a `system_shutdown_initiated` SSE message immediately to all\n    connected clients.","operationId":"system_shutdown_system_shutdown_post","responses":{"200":{"description":"True if successful. False on failure.\n    A failure will also send an error message with id system_shutdown_error\n    to all connected clients.\n    ","content":{"application/json":{"schema":{"type":"boolean","title":"Response System Shutdown System Shutdown Post"}}}}},"security":[{"JWTBearer":[]}]}},"/setup/status":{"get":{"tags":["RaspiBlitz Setup"],"summary":"Get Status","operationId":"get_status_setup_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/setup/setup-start-info":{"get":{"tags":["RaspiBlitz Setup"],"summary":"Setup Start Info","operationId":"setup_start_info_setup_setup_start_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/setup/setup-start-done":{"post":{"tags":["RaspiBlitz Setup"],"summary":"Setup Start Done","operationId":"setup_start_done_setup_setup_start_done_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartDoneData"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/setup/setup-final-info":{"get":{"tags":["RaspiBlitz Setup"],"summary":"Setup Final Info","operationId":"setup_final_info_setup_setup_final_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"JWTBearer":[]}]}},"/setup/setup-final-done":{"post":{"tags":["RaspiBlitz Setup"],"summary":"Setup Final Done","operationId":"setup_final_done_setup_setup_final_done_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"JWTBearer":[]}]}},"/setup/shutdown":{"get":{"tags":["RaspiBlitz Setup"],"summary":"Get Shutdown","operationId":"get_shutdown_setup_shutdown_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/setup/setup-sync-info":{"post":{"tags":["RaspiBlitz Setup"],"summary":"Setup Sync Info","operationId":"setup_sync_info_setup_setup_sync_info_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"JWTBearer":[]}]}},"/":{"get":{"summary":"Index","operationId":"index__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/sse/subscribe":{"get":{"summary":"Stream","operationId":"stream_sse_subscribe_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"AMPRecord":{"properties":{"root_share":{"type":"string","title":"Root Share"},"set_id":{"type":"string","title":"Set Id"},"child_index":{"type":"integer","title":"Child Index"}},"type":"object","required":["root_share","set_id","child_index"],"title":"AMPRecord"},"APIPlatform":{"type":"string","enum":["raspiblitz","native_python","unknown"],"title":"APIPlatform"},"Amp":{"properties":{"root_share":{"type":"string","title":"Root Share"},"set_id":{"type":"string","title":"Set Id"},"child_index":{"type":"integer","title":"Child Index"},"hash":{"type":"string","title":"Hash"},"preimage":{"type":"string","title":"Preimage"}},"type":"object","required":["root_share","set_id","child_index","hash","preimage"],"title":"Amp"},"AppId":{"type":"string","enum":["albyhub","btcpayserver","btc-rpc-explorer","electrs","jam","lnbits","mempool","rtl","thunderhub"],"title":"AppId"},"AppOnlineStatus":{"type":"string","enum":["online","offline"],"title":"AppOnlineStatus"},"AppStatus":{"properties":{"id":{"$ref":"#/components/schemas/AppId","description":"Id of the applications"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version","description":"Version of the application"},"installed":{"type":"boolean","title":"Installed","description":"Whether the application is installed","default":false},"configured":{"type":"boolean","title":"Configured","description":"Whether the application is configured","default":false},"status":{"$ref":"#/components/schemas/AppOnlineStatus","description":"Whether the application is online","default":"offline"},"local_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Local Ip","description":"The local network IP of the application"},"http_port":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Http Port","description":"The http port of the application"},"https_port":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Https Port","description":"The https port of the application"},"https_forced":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Https Forced","description":"Whether https is forced for this application"},"https_self_signed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Https Self Signed","description":"Whether the https certificate is self signed"},"hidden_service":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hidden Service","description":"Whether the application is reachable via a tor hidden service"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"The full address where this application is reachable"},"auth_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Auth Method","description":"The authentication method this application uses"},"details":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Details","description":"Additional application specific details\n\n        This field can contain values for the following app ids:\n        - `mempool`: `is_indexed`, `index_info`\n        - `btc-rpc-explorer`: `is_indexed`, `index_info`\n        - `electrs`: `initial_sync_done`, `block_height`,\n                                   `blockheightPercent`, `info_sync`,\n                                   `electrum_responding`,\n        "},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error","description":"Last known encountered error for this app."}},"type":"object","required":["id"],"title":"AppStatus"},"AppStatusQueryError":{"properties":{"id":{"$ref":"#/components/schemas/AppId","description":"The app id"},"error":{"type":"string","title":"Error","description":"The error description"}},"type":"object","required":["id","error"],"title":"AppStatusQueryError"},"AppStatusQueryResult":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AppStatus"},"type":"array","title":"Data","description":"Contains the successfully queried app statuses","default":[]},"errors":{"items":{"$ref":"#/components/schemas/AppStatusQueryError"},"type":"array","title":"Errors","description":"Contains the error messages for unsuccessful queries","default":[]},"timestamp":{"type":"integer","title":"Timestamp","description":"The UTC timestamp of when the data was fetched","default":0}},"type":"object","title":"AppStatusQueryResult"},"AppUninstallInput":{"properties":{"app_id":{"$ref":"#/components/schemas/AppId","description":"Id of the applications"},"keep_data":{"type":"boolean","title":"Keep Data","description":"Whether to keep the app data","default":true}},"type":"object","required":["app_id"],"title":"AppUninstallInput"},"Bip9Data":{"properties":{"status":{"type":"string","title":"Status","description":"One of \"defined\", \"started\", \"locked_in\", \"active\", \"failed\""},"bit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bit","description":"the bit(0-28) in the block version field used to signal this softfork(only for `started` status)"},"start_time":{"type":"integer","title":"Start Time","description":"The minimum median time past of a block at which the bit gains its meaning"},"timeout":{"type":"integer","title":"Timeout","description":"The median time past of a block at which the deployment is considered failed if not yet locked in"},"since":{"type":"integer","title":"Since","description":"Height of the first block to which the status applies"},"min_activation_height":{"type":"integer","title":"Min Activation Height","description":"Minimum height of blocks for which the rules may be enforced"},"statistics":{"anyOf":[{"$ref":"#/components/schemas/Bip9Statistics"},{"type":"null"}],"description":"numeric statistics about BIP9 signalling for a softfork(only for `started` status)"},"height":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Height","description":"Height of the first block which the rules are or will be enforced(only for `buried` type, or `bip9` type with `active` status)"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"True if the rules are enforced for the mempool and the next block"}},"type":"object","required":["status","start_time","timeout","since","min_activation_height"],"title":"Bip9Data"},"Bip9Statistics":{"properties":{"period":{"type":"integer","title":"Period","description":"The length in blocks of the BIP9 signalling period"},"threshold":{"type":"integer","title":"Threshold","description":"The number of blocks with the version bit set required to activate the feature"},"elapsed":{"type":"integer","title":"Elapsed","description":"The number of blocks elapsed since the beginning of the current period"},"count":{"type":"integer","title":"Count","description":"The number of blocks with the version bit set in the current period"},"possible":{"type":"boolean","title":"Possible","description":"False if there are not enough blocks left in this period to pass activation threshold"}},"type":"object","required":["period","threshold","elapsed","count","possible"],"title":"Bip9Statistics"},"BlockchainInfo":{"properties":{"chain":{"type":"string","title":"Chain","description":"Current network name(main, test, regtest)"},"blocks":{"type":"integer","title":"Blocks","description":"The height of the most-work fully-validated chain. The genesis block has height 0"},"headers":{"type":"integer","title":"Headers","description":"The current number of headers we have validated"},"best_block_hash":{"type":"string","title":"Best Block Hash","description":"The hash of the currently best block"},"difficulty":{"type":"number","title":"Difficulty","description":"The current difficulty"},"mediantime":{"type":"integer","title":"Mediantime","description":"Median time for the current best block"},"verification_progress":{"type":"number","title":"Verification Progress","description":"Estimate of verification progress[0..1]"},"initial_block_download":{"type":"boolean","title":"Initial Block Download","description":"Estimate of whether this node is in Initial Block Download mode"},"chainwork":{"type":"string","title":"Chainwork","description":"total amount of work in active chain, in hexadecimal"},"size_on_disk":{"type":"integer","title":"Size On Disk","description":"The estimated size of the block and undo files on disk"},"pruned":{"type":"boolean","title":"Pruned","description":"If the blocks are subject to pruning"},"prune_height":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Prune Height","description":"Lowest-height complete block stored(only present if pruning is enabled)"},"automatic_pruning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Automatic Pruning","description":"Whether automatic pruning is enabled(only present if pruning is enabled)"},"prune_target_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Prune Target Size","description":"The target size used by pruning(only present if automatic pruning is enabled)"},"warnings":{"type":"string","title":"Warnings","description":"Any network and blockchain warnings","default":""},"softforks":{"items":{"$ref":"#/components/schemas/SoftFork"},"type":"array","title":"Softforks","description":"Status of softforks"}},"type":"object","required":["chain","blocks","headers","best_block_hash","difficulty","mediantime","verification_progress","initial_block_download","chainwork","size_on_disk","pruned","softforks"],"title":"BlockchainInfo"},"BtcInfo":{"properties":{"blocks":{"type":"integer","title":"Blocks","description":"The height of the most-work fully-validated chain. The genesis block has height 0"},"headers":{"type":"integer","title":"Headers","description":"The current number of headers we have validated"},"verification_progress":{"type":"number","title":"Verification Progress","description":"Estimate of verification progress[0..1]"},"difficulty":{"type":"number","title":"Difficulty","description":"The current difficulty"},"size_on_disk":{"type":"integer","title":"Size On Disk","description":"The estimated size of the block and undo files on disk"},"networks":{"items":{"$ref":"#/components/schemas/BtcNetwork"},"type":"array","title":"Networks","description":"Which networks are in use (ipv4, ipv6 or onion)","default":[]},"version":{"type":"integer","title":"Version","description":"The bitcoin core server version"},"subversion":{"type":"string","title":"Subversion","description":"The server subversion string"},"connections_in":{"type":"integer","title":"Connections In","description":"The number of inbound connections"},"connections_out":{"type":"integer","title":"Connections Out","description":"The number of outbound connections"}},"type":"object","required":["blocks","headers","verification_progress","difficulty","size_on_disk","version","subversion","connections_in","connections_out"],"title":"BtcInfo"},"BtcLocalAddress":{"properties":{"address":{"type":"string","title":"Address","description":"Network address"},"port":{"type":"integer","title":"Port","description":"Network port"},"score":{"type":"integer","title":"Score","description":"Relative score"}},"type":"object","required":["address","port","score"],"title":"BtcLocalAddress"},"BtcNetwork":{"properties":{"name":{"type":"string","title":"Name","description":"Which network is in use (ipv4, ipv6 or onion)"},"limited":{"type":"boolean","title":"Limited","description":"Is the network limited using - onlynet?"},"reachable":{"type":"boolean","title":"Reachable","description":"Is the network reachable?"},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy","description":"host:port of the proxy that is used for this network, or empty if none","default":""},"proxy_randomize_credentials":{"type":"boolean","title":"Proxy Randomize Credentials","description":"Whether randomized credentials are used"}},"type":"object","required":["name","limited","reachable","proxy_randomize_credentials"],"title":"BtcNetwork"},"Chain":{"properties":{"chain":{"type":"string","title":"Chain"},"network":{"type":"string","title":"Network"}},"type":"object","required":["chain","network"],"title":"Chain"},"Channel":{"properties":{"channel_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Id"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"peer_publickey":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Peer Publickey"},"peer_alias":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Peer Alias"},"balance_local":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Balance Local"},"balance_remote":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Balance Remote"},"balance_capacity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Balance Capacity"}},"type":"object","required":["channel_id","active","peer_publickey","peer_alias","balance_local","balance_remote","balance_capacity"],"title":"Channel"},"ChannelUpdate":{"properties":{"signature":{"type":"string","title":"Signature"},"chain_hash":{"type":"string","title":"Chain Hash"},"chan_id":{"type":"integer","title":"Chan Id"},"timestamp":{"type":"integer","title":"Timestamp"},"message_flags":{"type":"integer","title":"Message Flags"},"channel_flags":{"type":"integer","title":"Channel Flags"},"time_lock_delta":{"type":"integer","title":"Time Lock Delta"},"htlc_minimum_msat":{"type":"integer","title":"Htlc Minimum Msat"},"base_fee":{"type":"integer","title":"Base Fee"},"fee_rate":{"type":"integer","title":"Fee Rate"},"htlc_maximum_msat":{"type":"integer","title":"Htlc Maximum Msat"},"extra_opaque_data":{"type":"string","title":"Extra Opaque Data"}},"type":"object","required":["signature","chain_hash","chan_id","timestamp","message_flags","channel_flags","time_lock_delta","htlc_minimum_msat","base_fee","fee_rate","htlc_maximum_msat","extra_opaque_data"],"title":"ChannelUpdate"},"ConnectionInfo":{"properties":{"lnd_admin_macaroon":{"type":"string","title":"Lnd Admin Macaroon","description":"lnd macaroon with admin rights in hexstring format","default":""},"lnd_invoice_macaroon":{"type":"string","title":"Lnd Invoice Macaroon","description":"lnd macaroon that only creates invoices in hexstring format","default":""},"lnd_readonly_macaroon":{"type":"string","title":"Lnd Readonly Macaroon","description":"lnd macaroon with only read-only rights in hexstring format","default":""},"lnd_tls_cert":{"type":"string","title":"Lnd Tls Cert","description":"lnd tls cert in hexstring format","default":""},"lnd_rest_onion":{"type":"string","title":"Lnd Rest Onion","description":"lnd rest api onion address","default":""},"lnd_btcpay_connection_string":{"type":"string","title":"Lnd Btcpay Connection String","description":"connect BtcPay server locally to your lnd lightning node","default":""},"lnd_zeus_connection_string":{"type":"string","title":"Lnd Zeus Connection String","description":"connect Zeus app to your lnd lightning node","default":""},"cl_rest_zeus_connection_string":{"type":"string","title":"Cl Rest Zeus Connection String","description":"connect Zeus app to your core lightning node over rest","default":""},"cl_rest_macaroon":{"type":"string","title":"Cl Rest Macaroon","description":"core lightning rest macaroon","default":""},"cl_rest_onion":{"type":"string","title":"Cl Rest Onion","description":"core lightning rest onion address","default":""}},"type":"object","title":"ConnectionInfo"},"CustomRecordsEntry":{"properties":{"key":{"type":"integer","title":"Key"},"value":{"type":"string","title":"Value"}},"type":"object","required":["key","value"],"title":"CustomRecordsEntry"},"Feature":{"properties":{"name":{"type":"string","title":"Name"},"is_required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Required"},"is_known":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Known"}},"type":"object","required":["name","is_required","is_known"],"title":"Feature"},"FeaturesEntry":{"properties":{"key":{"type":"integer","title":"Key"},"value":{"$ref":"#/components/schemas/Feature"}},"type":"object","required":["key","value"],"title":"FeaturesEntry"},"FeeEstimationMode":{"type":"string","enum":["conservative","economical"],"title":"FeeEstimationMode"},"FeeRevenue":{"properties":{"day":{"type":"integer","title":"Day","description":"Fee revenue earned in the last 24 hours"},"week":{"type":"integer","title":"Week","description":"Fee revenue earned in the last 7days"},"month":{"type":"integer","title":"Month","description":"Fee revenue earned in the last month"},"year":{"type":"integer","title":"Year","description":"Fee revenue earned in the last year.Might be null if not implemented by backend."},"total":{"type":"integer","title":"Total","description":"Fee revenue earned in the last year.Might be null if not implemented by backend"}},"type":"object","required":["day","week","month"],"title":"FeeRevenue"},"GenericTx":{"properties":{"index":{"type":"integer","title":"Index","description":"The index of the transaction.","default":0},"id":{"type":"string","title":"Id","description":"\nUnique identifier for this transaction.\n\nDepending on the type of the transaction it will be different:\n#### On-chain\nThe transaction hash\n\n#### Lightning Invoice and Payment\nThe payment request\n"},"category":{"$ref":"#/components/schemas/TxCategory","description":"Whether this is an onchain (**onchain**) or lightning (**ln**) transaction."},"type":{"$ref":"#/components/schemas/TxType","description":"Whether this is an outgoing (**send**) transaction or an incoming(**receive**) transaction."},"amount":{"type":"integer","title":"Amount","description":"\nThe value of the transaction, depending on the category in satoshis or millisatoshis.\n\n#### On-chain\nTransaction amount in satoshis\n\n#### Lightning Invoice\n* value in millisatoshis of the invoice if *unsettled*\n* amount in millisatoshis paid if invoice is *settled*\n\n#### Lightning Payment\n* amount sent in millisatoshis\n\n"},"time_stamp":{"type":"integer","title":"Time Stamp","description":"\nThe unix timestamp in seconds for the transaction.\n\nThe timestamp can mean different things in different situations:\n\n#### Lightning Invoice\n* Creation date for in-flight or failed invoices\n* Settle date for succeeded invoices\n\n#### On-chain\n* Creation date for transaction waiting in the mempool\n* Timestamp of the block where this transaction is included\n\n#### Lightning Payment\n\n"},"comment":{"type":"string","title":"Comment","description":"Optional comment for this transaction","default":""},"status":{"$ref":"#/components/schemas/TxStatus","description":"\nThe status of the transaction. Depending on the transaction category this can be different values:\n\nMay have different meanings in different situations:\n#### unknown\nAn unknown state was found.\n\n#### in_flight\n* A lightning payment is being sent\n* An invoice is waiting for the incoming payment\n* An on-chain transaction is waiting in the mempool\n\n#### succeeded\n* A lighting payment was successfully sent\n* An incoming payment was received for an invoice\n* An on-chain transaction was included in a block\n\n#### failed\n* A lightning payment attempt which could not be completed (no route found, insufficient funds, ...)\n* An invoice is expired or some other error happened\n"},"block_height":{"type":"integer","title":"Block Height","description":"Block height, if included in a block. Only applicable for category **onchain**."},"num_confs":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Num Confs","description":"Number of confirmations. Only applicable for category **onchain**."},"total_fees":{"type":"integer","title":"Total Fees","description":"Total fees paid for this transaction"}},"type":"object","required":["id","category","type","amount","time_stamp","status"],"title":"GenericTx"},"HTLCAttempt":{"properties":{"attempt_id":{"type":"integer","title":"Attempt Id"},"status":{"$ref":"#/components/schemas/HTLCStatus"},"route":{"$ref":"#/components/schemas/Route"},"attempt_time_ns":{"type":"integer","title":"Attempt Time Ns"},"resolve_time_ns":{"type":"integer","title":"Resolve Time Ns"},"failure":{"$ref":"#/components/schemas/HTLCAttemptFailure"},"preimage":{"type":"string","title":"Preimage"}},"type":"object","required":["attempt_id","status","route","attempt_time_ns","resolve_time_ns","failure","preimage"],"title":"HTLCAttempt"},"HTLCAttemptFailure":{"properties":{"code":{"type":"integer","title":"Code"},"channel_update":{"$ref":"#/components/schemas/ChannelUpdate"},"htlc_msat":{"type":"integer","title":"Htlc Msat"},"onion_sha_256":{"type":"string","title":"Onion Sha 256"},"cltv_expiry":{"type":"integer","title":"Cltv Expiry"},"flags":{"type":"integer","title":"Flags"},"failure_source_index":{"type":"integer","title":"Failure Source Index"},"height":{"type":"integer","title":"Height"}},"type":"object","required":["code","channel_update","htlc_msat","onion_sha_256","cltv_expiry","flags","failure_source_index","height"],"title":"HTLCAttemptFailure"},"HTLCStatus":{"type":"string","enum":["in_flight","succeeded","failed"],"title":"HTLCStatus"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Hop":{"properties":{"chan_id":{"type":"integer","title":"Chan Id"},"chan_capacity":{"type":"integer","title":"Chan Capacity"},"amt_to_forward":{"type":"integer","title":"Amt To Forward"},"fee":{"type":"integer","title":"Fee"},"expiry":{"type":"integer","title":"Expiry"},"amt_to_forward_msat":{"type":"integer","title":"Amt To Forward Msat"},"fee_msat":{"type":"integer","title":"Fee Msat"},"pub_key":{"type":"string","title":"Pub Key"},"tlv_payload":{"type":"boolean","title":"Tlv Payload"}},"type":"object","required":["chan_id","chan_capacity","amt_to_forward","fee","expiry","amt_to_forward_msat","fee_msat","pub_key","tlv_payload"],"title":"Hop"},"HopHint":{"properties":{"node_id":{"type":"string","title":"Node Id","description":"The public key of the node at the start of the channel."},"chan_id":{"type":"string","title":"Chan Id","description":"The unique identifier of the channel."},"fee_base_msat":{"type":"integer","title":"Fee Base Msat","description":"The base fee of the channel denominated in msat."},"fee_proportional_millionths":{"type":"integer","title":"Fee Proportional Millionths","description":"The fee rate of the channel for sending onesatoshi across it denominated in msat"},"cltv_expiry_delta":{"type":"integer","title":"Cltv Expiry Delta","description":"The time-lock delta of the channel."}},"type":"object","required":["node_id","chan_id","fee_base_msat","fee_proportional_millionths","cltv_expiry_delta"],"title":"HopHint"},"Invoice":{"properties":{"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo","description":"Optional memo to attach along with the invoice. Used for record keeping purposes for the invoice's creator, and will also be set in the description field of the encoded payment request if the description_hash field is not being used."},"r_preimage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"R Preimage","description":"The hex-encoded preimage(32 byte) which will allow settling an incoming HTLC payable to this preimage."},"r_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"R Hash","description":"The hash of the preimage."},"value_msat":{"type":"integer","title":"Value Msat","description":"The value of this invoice in milli satoshis."},"settled":{"type":"boolean","title":"Settled","description":"Whether this invoice has been fulfilled","default":false},"creation_date":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Creation Date","description":"When this invoice was created. Not available with CLN."},"settle_date":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Settle Date","description":"When this invoice was settled. Not available with pending invoices."},"expiry_date":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expiry Date","description":"The time at which this invoice expires"},"payment_request":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Request","description":"A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient."},"description_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description Hash","description":"Hash(SHA-256) of a description of the payment. Used if the description of payment(memo) is too long to naturally fit within the description field of an encoded payment request."},"expiry":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expiry","description":"Payment request expiry time in seconds. Default is 3600 (1 hour)."},"fallback_addr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fallback Addr","description":"Fallback on-chain address."},"cltv_expiry":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cltv Expiry","description":"Delta to use for the time-lock of the CLTV extended to the final hop."},"route_hints":{"anyOf":[{"items":{"$ref":"#/components/schemas/RouteHint"},"type":"array"},{"type":"null"}],"title":"Route Hints","description":"Route hints that can each be individually used to assist in reaching the invoice's destination."},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private","description":"Whether this invoice should include routing hints for private channels."},"add_index":{"type":"string","title":"Add Index","description":"The index of this invoice. Each newly created invoice will increment this index making it monotonically increasing. CLN and LND handle ids differently. LND will generate an auto incremented integer id, while CLN will use a user supplied string id. To unify both, we auto generate an id for CLN and use the add_index for LND.For `LND` this will be an `integer` in string form. This is auto generated by LND. For `CLN` this will be a `string`. If the invoice was generated by BlitzAPI, this will be a [Firebase-like PushID](https://firebase.blog/posts/2015/02/the-2120-ways-to-ensure-unique_68). If generated by some other method, it'll be the string supplied by the user at the time of creation of the invoice."},"settle_index":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Settle Index","description":"The `settle` index of this invoice. Each newly settled invoice will increment this index making it monotonically increasing. "},"amt_paid_sat":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amt Paid Sat","description":"The amount that was accepted for this invoice, in satoshis. This will ONLY be set if this invoice has been settled. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well."},"amt_paid_msat":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amt Paid Msat","description":"The amount that was accepted for this invoice, in millisatoshis. This will ONLY be set if this invoice has been settled. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well."},"state":{"$ref":"#/components/schemas/InvoiceState","description":"The state the invoice is in."},"htlcs":{"anyOf":[{"items":{"$ref":"#/components/schemas/InvoiceHTLC"},"type":"array"},{"type":"null"}],"title":"Htlcs","description":"List of HTLCs paying to this invoice[EXPERIMENTAL]."},"features":{"anyOf":[{"items":{"$ref":"#/components/schemas/FeaturesEntry"},"type":"array"},{"type":"null"}],"title":"Features","description":"List of features advertised on the invoice."},"is_keysend":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Keysend","description":"[LND only] Indicates if this invoice was a spontaneous payment that arrived via keysend[EXPERIMENTAL]."},"payment_addr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Addr","description":"The payment address of this invoice. This value will be used in MPP payments, and also for newer invoices that always require the MPP payload for added end-to-end security."},"is_amp":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Amp","description":"Signals whether or not this is an AMP invoice."}},"type":"object","required":["value_msat","add_index","state"],"title":"Invoice"},"InvoiceHTLC":{"properties":{"chan_id":{"type":"integer","title":"Chan Id","description":"The channel ID over which the HTLC was received."},"htlc_index":{"type":"integer","title":"Htlc Index","description":"The index of the HTLC on the channel."},"amt_msat":{"type":"integer","title":"Amt Msat","description":"The amount of the HTLC in msat."},"accept_height":{"type":"integer","title":"Accept Height","description":"The block height at which this HTLC was accepted."},"accept_time":{"type":"integer","title":"Accept Time","description":"The time at which this HTLC was accepted."},"resolve_time":{"type":"integer","title":"Resolve Time","description":"The time at which this HTLC was resolved."},"expiry_height":{"type":"integer","title":"Expiry Height","description":"The block height at which this HTLC expires."},"state":{"$ref":"#/components/schemas/InvoiceHTLCState","description":"The state of the HTLC."},"custom_records":{"items":{"$ref":"#/components/schemas/CustomRecordsEntry"},"type":"array","title":"Custom Records","description":"Custom tlv records.","default":[]},"mpp_total_amt_msat":{"type":"integer","title":"Mpp Total Amt Msat","description":"The total amount of the mpp payment in msat."},"amp":{"$ref":"#/components/schemas/Amp","description":"Details relevant to AMP HTLCs, only populated if this is an AMP HTLC."}},"type":"object","required":["chan_id","htlc_index","amt_msat","accept_height","accept_time","resolve_time","expiry_height","state","mpp_total_amt_msat"],"title":"InvoiceHTLC"},"InvoiceHTLCState":{"type":"string","enum":["accepted","settled","canceled"],"title":"InvoiceHTLCState"},"InvoiceState":{"type":"string","enum":["open","settled","canceled","accepted"],"title":"InvoiceState"},"LnInfo":{"properties":{"implementation":{"type":"string","title":"Implementation","description":"Lightning software implementation (LND, CLN)"},"version":{"type":"string","title":"Version","description":"The version of the software that the node is running."},"commit_hash":{"type":"string","title":"Commit Hash","description":"The SHA1 commit hash that the daemon is compiled with."},"identity_pubkey":{"type":"string","title":"Identity Pubkey","description":"The identity pubkey of the current node."},"identity_uri":{"type":"string","title":"Identity Uri","description":"The complete URI (pubkey@physicaladdress:port) the current node."},"alias":{"type":"string","title":"Alias","description":"The alias of the node."},"color":{"type":"string","title":"Color","description":"The color of the current node in hex code format."},"num_pending_channels":{"type":"integer","title":"Num Pending Channels","description":"Number of pending channels."},"num_active_channels":{"type":"integer","title":"Num Active Channels","description":"Number of active channels."},"num_inactive_channels":{"type":"integer","title":"Num Inactive Channels","description":"Number of inactive channels."},"num_peers":{"type":"integer","title":"Num Peers","description":"Number of peers."},"block_height":{"type":"integer","title":"Block Height","description":"The node's current view of the height of the best block. Only available with LND."},"block_hash":{"type":"string","title":"Block Hash","description":"The node's current view of the hash of the best block. Only available with LND.","default":""},"best_header_timestamp":{"type":"integer","title":"Best Header Timestamp","description":"Timestamp of the block best known to the wallet. Only available with LND."},"synced_to_chain":{"type":"boolean","title":"Synced To Chain","description":"Whether the wallet's view is synced to the main chain. Only available with LND."},"synced_to_graph":{"type":"boolean","title":"Synced To Graph","description":"Whether we consider ourselves synced with the public channel graph. Only available with LND."},"chains":{"items":{"$ref":"#/components/schemas/Chain"},"type":"array","title":"Chains","description":"A list of active chains the node is connected to","default":[]},"uris":{"items":{"type":"string"},"type":"array","title":"Uris","description":"The URIs of the current node.","default":[]},"features":{"items":{"$ref":"#/components/schemas/FeaturesEntry"},"type":"array","title":"Features","description":"Features that our node has advertised in our init message node announcements and invoices. Not yet implemented with CLN","default":[]}},"type":"object","required":["implementation","version","commit_hash","identity_pubkey","identity_uri","alias","color","num_pending_channels","num_active_channels","num_inactive_channels","num_peers","block_height"],"title":"LnInfo"},"LoginInput":{"properties":{"password":{"type":"string","minLength":8,"title":"Password"},"one_time_password":{"anyOf":[{"type":"string","maxLength":6,"minLength":6,"pattern":"^[0-9]+$"},{"type":"null"}],"title":"One Time Password"}},"type":"object","required":["password"],"title":"LoginInput"},"MPPRecord":{"properties":{"payment_addr":{"type":"string","title":"Payment Addr"},"total_amt_msat":{"type":"integer","title":"Total Amt Msat"}},"type":"object","required":["payment_addr","total_amt_msat"],"title":"MPPRecord"},"NetworkInfo":{"properties":{"version":{"type":"integer","title":"Version","description":"The bitcoin core server version"},"subversion":{"type":"string","title":"Subversion","description":"The server subversion string"},"protocol_version":{"type":"integer","title":"Protocol Version","description":"The protocol version"},"local_services":{"type":"string","title":"Local Services","description":"The services we offer to the network, hex formatted"},"local_services_names":{"items":{"type":"string"},"type":"array","title":"Local Services Names","description":"The services we offer to the network, in human-readable form","default":[]},"local_relay":{"type":"boolean","title":"Local Relay","description":"True if transaction relay is requested from peers"},"time_offset":{"type":"integer","title":"Time Offset","description":"The time offset"},"connections":{"type":"integer","title":"Connections","description":"The total number of connections"},"connections_in":{"type":"integer","title":"Connections In","description":"The number of inbound connections"},"connections_out":{"type":"integer","title":"Connections Out","description":"The number of outbound connections"},"network_active":{"type":"boolean","title":"Network Active","description":"Whether p2p networking is enabled"},"networks":{"items":{"$ref":"#/components/schemas/BtcNetwork"},"type":"array","title":"Networks","description":"Information per network"},"relay_fee":{"type":"number","title":"Relay Fee","description":"Minimum relay fee for transactions in BTC/kB"},"incremental_fee":{"type":"number","title":"Incremental Fee","description":"Minimum fee increment for mempool limiting or BIP 125 replacement in BTC/kB"},"local_addresses":{"items":{"$ref":"#/components/schemas/BtcLocalAddress"},"type":"array","title":"Local Addresses","description":"List of local addresses","default":[]},"warnings":{"type":"string","title":"Warnings","description":"Any network and blockchain warnings","default":""}},"type":"object","required":["version","subversion","protocol_version","local_relay","time_offset","connections","connections_in","connections_out","network_active","networks","relay_fee","incremental_fee"],"title":"NetworkInfo"},"NewAddressInput":{"properties":{"type":{"$ref":"#/components/schemas/OnchainAddressType","description":"Address-types has to be one of: * p2wkh:  Pay to witness key hash (bech32) * np2wkh: Pay to nested witness key hash"}},"type":"object","required":["type"],"title":"NewAddressInput"},"OnChainTransaction":{"properties":{"tx_hash":{"type":"string","title":"Tx Hash","description":"The transaction hash"},"amount":{"type":"integer","title":"Amount","description":"The transaction amount, denominated in satoshis"},"num_confirmations":{"type":"integer","title":"Num Confirmations","description":"The number of confirmations"},"block_height":{"type":"integer","title":"Block Height","description":"The height of the block this transaction was included in"},"time_stamp":{"type":"integer","title":"Time Stamp","description":"Timestamp of this transaction"},"total_fees":{"type":"integer","title":"Total Fees","description":"Fees paid for this transaction"},"dest_addresses":{"items":{"type":"string"},"type":"array","title":"Dest Addresses","description":"Addresses that received funds for this transaction","default":[]},"label":{"type":"string","title":"Label","description":"An optional label that was set on transaction broadcast.","default":""}},"type":"object","required":["tx_hash","amount","num_confirmations","block_height","time_stamp","total_fees"],"title":"OnChainTransaction"},"OnchainAddressType":{"type":"string","enum":["p2wkh","np2wkh"],"title":"OnchainAddressType"},"Payment":{"properties":{"payment_hash":{"type":"string","title":"Payment Hash","description":"The payment hash"},"payment_preimage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Preimage","description":"The payment preimage"},"value_msat":{"type":"integer","title":"Value Msat","description":"The value of the payment in milli-satoshis"},"payment_request":{"type":"string","title":"Payment Request","description":"The optional payment request being fulfilled."},"status":{"$ref":"#/components/schemas/PaymentStatus","description":"The status of the payment.","default":"unknown"},"fee_msat":{"type":"integer","title":"Fee Msat","description":"The fee paid for this payment in msat"},"creation_time_ns":{"type":"integer","title":"Creation Time Ns","description":"The time in UNIX nanoseconds at which the payment was created."},"htlcs":{"items":{"$ref":"#/components/schemas/HTLCAttempt"},"type":"array","title":"Htlcs","description":"The HTLCs made in attempt to settle the payment.","default":[]},"payment_index":{"type":"integer","title":"Payment Index","description":"The payment index. Only set with LND, 0 otherwise.","default":0},"label":{"type":"string","title":"Label","description":"The payment label. Only set with CLN, empty otherwise.","default":""},"failure_reason":{"$ref":"#/components/schemas/PaymentFailureReason","description":"The failure reason","default":"FAILURE_REASON_NONE"}},"type":"object","required":["payment_hash","value_msat","fee_msat","creation_time_ns"],"title":"Payment"},"PaymentFailureReason":{"type":"string","enum":["FAILURE_REASON_NONE","FAILURE_REASON_TIMEOUT","FAILURE_REASON_NO_ROUTE","FAILURE_REASON_ERROR","FAILURE_REASON_INCORRECT_PAYMENT_DETAILS","FAILURE_REASON_INSUFFICIENT_BALANCE"],"title":"PaymentFailureReason"},"PaymentRequest":{"properties":{"destination":{"type":"string","title":"Destination"},"payment_hash":{"type":"string","title":"Payment Hash"},"num_satoshis":{"type":"integer","title":"Num Satoshis","description":"Deprecated. User num_msat instead","deprecated":true},"timestamp":{"type":"integer","title":"Timestamp"},"expiry":{"type":"integer","title":"Expiry"},"description":{"type":"string","title":"Description"},"description_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description Hash"},"fallback_addr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fallback Addr"},"cltv_expiry":{"type":"integer","title":"Cltv Expiry"},"route_hints":{"items":{"$ref":"#/components/schemas/RouteHint"},"type":"array","title":"Route Hints","description":"A list of [HopHint] for the RouteHint","default":[]},"payment_addr":{"type":"string","title":"Payment Addr","description":"The payment address in hex format","default":""},"num_msat":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Msat"},"features":{"items":{"$ref":"#/components/schemas/FeaturesEntry"},"type":"array","title":"Features","default":[]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Optional requested currency of the payment. ","default":""}},"type":"object","required":["destination","payment_hash","timestamp","expiry","description","description_hash","fallback_addr","cltv_expiry","num_msat"],"title":"PaymentRequest"},"PaymentStatus":{"type":"string","enum":["unknown","in_flight","succeeded","failed"],"title":"PaymentStatus"},"RawDebugLogData":{"properties":{"raw_data":{"type":"string","title":"Raw Data","description":"The raw debug log text"},"github_issues_url":{"type":"string","title":"Github Issues Url","description":"Link to the Raspiblitz issue tracker","default":"https://www.github.com/rootzoll/raspiblitz/issues"}},"type":"object","required":["raw_data"],"title":"RawDebugLogData"},"RawTransaction":{"properties":{"in_active_chain":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"In Active Chain","description":"Whether specified block is in the active chain or not (only present with explicit 'blockhash' argument)"},"txid":{"type":"string","title":"Txid","description":"The transaction id (same as provided)"},"hash":{"type":"string","title":"Hash","description":"The transaction hash (differs from txid for witness transactions)"},"size":{"type":"integer","title":"Size","description":"The serialized transaction size"},"vsize":{"type":"integer","title":"Vsize","description":"The virtual transaction size (differs from size for witness transactions)"},"weight":{"type":"integer","title":"Weight","description":"The transaction's weight (between vsize*4 - 3 and vsize*4)"},"version":{"type":"integer","title":"Version","description":"The version"},"locktime":{"type":"integer","title":"Locktime","description":"The lock time"},"vin":{"items":{"type":"object"},"type":"array","title":"Vin","description":"The transaction's inputs"},"vout":{"items":{"type":"object"},"type":"array","title":"Vout","description":"The transaction's outputs"},"blockhash":{"type":"string","title":"Blockhash","description":"The block hash"},"confirmations":{"type":"integer","title":"Confirmations","description":"The number of confirmations"},"blocktime":{"type":"integer","title":"Blocktime","description":"The block time in seconds since epoch (Jan 1 1970 GMT)"}},"type":"object","required":["txid","hash","size","vsize","weight","version","locktime","vin","vout","blockhash","confirmations","blocktime"],"title":"RawTransaction"},"Route":{"properties":{"total_time_lock":{"type":"integer","title":"Total Time Lock"},"total_fees":{"type":"integer","title":"Total Fees"},"total_amt":{"type":"integer","title":"Total Amt"},"hops":{"items":{"$ref":"#/components/schemas/Hop"},"type":"array","title":"Hops"},"total_fees_msat":{"type":"integer","title":"Total Fees Msat"},"total_amt_msat":{"type":"integer","title":"Total Amt Msat"},"mpp_record":{"anyOf":[{"$ref":"#/components/schemas/MPPRecord"},{"type":"null"}]},"amp_record":{"anyOf":[{"$ref":"#/components/schemas/AMPRecord"},{"type":"null"}]},"custom_records":{"items":{"$ref":"#/components/schemas/CustomRecordsEntry"},"type":"array","title":"Custom Records"}},"type":"object","required":["total_time_lock","total_fees","total_amt","hops","total_fees_msat","total_amt_msat","mpp_record","amp_record","custom_records"],"title":"Route"},"RouteHint":{"properties":{"hop_hints":{"items":{"$ref":"#/components/schemas/HopHint"},"type":"array","title":"Hop Hints","description":"A list of hop hints that when chained together can assist in reaching a specific destination.","default":[]}},"type":"object","title":"RouteHint"},"SendCoinsInput":{"properties":{"address":{"type":"string","title":"Address","description":"The base58 or bech32 encoded bitcoin address to send coins to on-chain"},"target_conf":{"type":"integer","title":"Target Conf","description":"The number of blocks that the transaction *should* confirm in, will be used for fee estimation"},"sat_per_vbyte":{"type":"integer","title":"Sat Per Vbyte","description":"A manual fee expressed in sat/vbyte that should be used when crafting the transaction (default: 0)"},"min_confs":{"type":"integer","title":"Min Confs","description":"The minimum number of confirmations each one of your outputs used for the transaction must satisfy","default":1},"label":{"type":"string","title":"Label","description":"A label for the transaction. Ignored by CLN backend.","default":""},"send_all":{"type":"boolean","title":"Send All","description":"Send all available on-chain funds from the wallet. Will be executed `amount` is **0**","default":false},"amount":{"type":"integer","minimum":0.0,"title":"Amount","description":"The number of bitcoin denominated in satoshis to send. Must not be set when `send_all` is true.","default":0}},"type":"object","required":["address"],"title":"SendCoinsInput"},"SendCoinsResponse":{"properties":{"txid":{"type":"string","title":"Txid","description":"The transaction ID for this onchain payment"},"address":{"type":"string","title":"Address","description":"The base58 or bech32 encoded bitcoin address where the onchain funds where sent to"},"amount":{"type":"integer","minimum":0.0,"title":"Amount","description":"The number of bitcoin denominated in satoshis which where sent"},"fees":{"type":"integer","minimum":0.0,"title":"Fees","description":"The number of bitcoin denominated in satoshis which where paid as fees"},"label":{"type":"string","title":"Label","description":"The label used for the transaction. Ignored by CLN backend.","default":""},"send_all":{"type":"boolean","title":"Send All","description":"If this transaction was a `send_all` transaction.","default":false}},"type":"object","required":["txid","address","amount"],"title":"SendCoinsResponse"},"SoftFork":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the softfork"},"type":{"type":"string","title":"Type","description":"One of \"buried\", \"bip9\""},"active":{"type":"boolean","title":"Active","description":"True **if** the rules are enforced for the mempool and the next block"},"bip9":{"anyOf":[{"$ref":"#/components/schemas/Bip9Data"},{"type":"null"}],"description":"Status of bip9 softforks(only for \"bip9\" type)"},"height":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Height","description":"Height of the first block which the rules are or will be enforced (only for `buried` type, or `bip9` type with `active` status)"}},"type":"object","required":["name","type","active"],"title":"SoftFork"},"StartDoneData":{"properties":{"hostname":{"type":"string","title":"Hostname","default":""},"forceFreshSetup":{"type":"boolean","title":"Forcefreshsetup","default":false},"keepBlockchain":{"type":"boolean","title":"Keepblockchain","default":true},"lightning":{"type":"string","title":"Lightning","default":""},"passwordA":{"type":"string","title":"Passworda","default":""},"passwordB":{"type":"string","title":"Passwordb","default":""},"passwordC":{"type":"string","title":"Passwordc","default":""}},"type":"object","title":"StartDoneData"},"SubSystemHealthInfo":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the subsystem"},"health":{"type":"boolean","title":"Health","description":"Whether this system is healthy or not"},"message":{"type":"string","title":"Message","description":"Optional message describing the systems health","default":""}},"type":"object","required":["name","health"],"title":"SubSystemHealthInfo"},"SystemHealthInfo":{"properties":{"healthy":{"type":"boolean","title":"Healthy","description":""},"message":{"type":"string","title":"Message","description":"","default":""},"subsystems":{"items":{"$ref":"#/components/schemas/SubSystemHealthInfo"},"type":"array","title":"Subsystems","description":"Health information of running subsystems","default":[]}},"type":"object","required":["healthy"],"title":"SystemHealthInfo"},"SystemInfo":{"properties":{"alias":{"type":"string","title":"Alias","description":"Name of the node (same as Lightning alias)","default":""},"color":{"type":"string","title":"Color","description":"The color of the current node in hex code format"},"platform":{"$ref":"#/components/schemas/APIPlatform","description":"The platform this API is running on.","default":"raspiblitz"},"platform_version":{"type":"string","title":"Platform Version","description":"The version of this platform","default":""},"code_version":{"type":"string","title":"Code Version","description":"[RaspiBlitz only] The code version.","default":""},"api_version":{"type":"string","title":"Api Version","description":"Version of the API software on this system."},"tor_web_ui":{"type":"string","title":"Tor Web Ui","description":"WebUI TOR address","default":""},"tor_api":{"type":"string","title":"Tor Api","description":"API TOR address","default":""},"lan_web_ui":{"type":"string","title":"Lan Web Ui","description":"WebUI LAN address","default":""},"lan_api":{"type":"string","title":"Lan Api","description":"API LAN address","default":""},"ssh_address":{"type":"string","title":"Ssh Address","description":"Address to ssh into on local LAN (e.g. `ssh admin@192.168.1.28`"},"chain":{"type":"string","title":"Chain","description":"The current chain this node is connected to (mainnet, testnet or signet)"}},"type":"object","required":["color","api_version","ssh_address","chain"],"title":"SystemInfo"},"TxCategory":{"type":"string","enum":["onchain","ln"],"title":"TxCategory"},"TxStatus":{"type":"string","enum":["unknown","in_flight","succeeded","failed"],"title":"TxStatus"},"TxType":{"type":"string","enum":["unknown","send","receive"],"title":"TxType"},"UnlockWalletInput":{"properties":{"password":{"type":"string","title":"Password","description":"The wallet password"}},"type":"object","required":["password"],"title":"UnlockWalletInput"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WalletBalance":{"properties":{"onchain_confirmed_balance":{"type":"integer","title":"Onchain Confirmed Balance","description":"Confirmed onchain balance (more than 3 confirmations) in sat"},"onchain_total_balance":{"type":"integer","title":"Onchain Total Balance","description":"Total combined onchain balance in sat"},"onchain_unconfirmed_balance":{"type":"integer","title":"Onchain Unconfirmed Balance","description":"Unconfirmed onchain balance (less than 3 confirmations) in sat"},"channel_local_balance":{"type":"integer","title":"Channel Local Balance","description":"Sum of channels local balances in msat"},"channel_remote_balance":{"type":"integer","title":"Channel Remote Balance","description":"Sum of channels remote balances in msat."},"channel_unsettled_local_balance":{"type":"integer","title":"Channel Unsettled Local Balance","description":"Sum of channels local unsettled balances in msat."},"channel_unsettled_remote_balance":{"type":"integer","title":"Channel Unsettled Remote Balance","description":"Sum of channels remote unsettled balances in msat."},"channel_pending_open_local_balance":{"type":"integer","title":"Channel Pending Open Local Balance","description":"Sum of channels pending local balances in msat."},"channel_pending_open_remote_balance":{"type":"integer","title":"Channel Pending Open Remote Balance","description":"Sum of channels pending remote balances in msat."}},"type":"object","required":["onchain_confirmed_balance","onchain_total_balance","onchain_unconfirmed_balance","channel_local_balance","channel_remote_balance","channel_unsettled_local_balance","channel_unsettled_remote_balance","channel_pending_open_local_balance","channel_pending_open_remote_balance"],"title":"WalletBalance"}},"securitySchemes":{"JWTBearer":{"type":"http","scheme":"bearer"}}}}