Phoenixd API reference

Use your Phoenixd API to control the node itself: creating Lightning invoices, checking balances and payments, and sending payments. These requests go to your node's endpoint, not to the Nodana API.

Nodana gives each node an endpoint and Phoenixd credentials when you create it. Use the node's password to authenticate requests to that endpoint. Keep the password in your backend or a trusted secret store; do not put it in browser code.

Use the restricted password (http-password-limited-access) for creating invoices, decoding them and reading payment information. Sending payments requires the full-access password (http-password).

The official Phoenixd API reference documents the available endpoints, request fields, and responses.

Example: list payments

Use your node's endpoint and Phoenixd password to list incoming payments. This example includes Phoenixd's all, limit, and offset options:

Use /payments/outgoing to list outgoing payments.

Replace the example URL with your node's endpoint and the placeholder password with its Phoenixd password. Keep the password out of shared scripts and logs.

Use the Nodana API for hosting and lifecycle actions such as creating, listing, starting, stopping, updating, and deleting nodes. A Nodana API key manages Nodana resources and is not a Phoenixd password.