Skip to content

Latest commit

 

History

History
27 lines (21 loc) · 979 Bytes

onchainfundmgmt.md

File metadata and controls

27 lines (21 loc) · 979 Bytes
Raw

Please use this documentation for understanding the API params and responses only. For detailed understanding of all aspects, please refer to c-lightning repo or view the help pages on your node.

Help command example: $ lightning-cli help getinfo

Required params are route params. Optional params are query params.

For POST APIs all params will be passed in the body

On-Chain fund management API documentation

Back to Readme

newaddr

  • Type: GET
  • Sample request URL: https://localhost:3001/v1/newaddr
  • Required Params: None
  • Optional Params: addrType (bech32 or p2sh-segwit)
  • Response: "address"

withdraw

  • Type: POST
  • Sample request URL: https://localhost:3001/v1/withdraw
  • Required Params: address(Any Bitcoin accepted type, including bech32), satoshis
  • Optional Params: feeRate(review c-lightning documentation for the options), minconf
  • Response: "tx", "txid"