API overview

Use the Nodana API to create and operate Phoenixd nodes from your application or scripts.

Base URL

https://api.nodana.io/v1

All endpoint paths are relative to this base URL. The API determines your account from your API key. Send JSON request bodies with Content-Type: application/json; responses use JSON except for 204 No Content.

Authentication

Use your API key in the Bearer header. Replace YOUR_API_KEY with your key. See Authentication for permissions and key management.

Make a request

List the nodes in your account.

$ curl "https://api.nodana.io/v1/nodes" \
    -H "Authorization: Bearer YOUR_API_KEY"

Example response for an account with no nodes (200 OK):

{
  "nodes": []
}

API basics

• Authentication: API keys, Bearer headers, and permissions.
• Error handling: status codes, error responses, and retries.
• Rate limiting: request limits and retry headers.

Node operations and payments

The Nodana API controls node creation and lifecycle. To create Lightning invoices or send payments, call your node's Phoenixd API using its endpoint and Phoenixd password. A Nodana API key and a Phoenixd password are separate credentials. See Phoenixd API Reference for how to choose the right API and a link to the official Phoenixd reference.

Expand API Reference in the sidebar for node operations with curl examples and responses. IDs, endpoints, credentials, and timestamps in examples are illustrative.

For a compact plain-text summary of the bearer-key endpoints, see the Nodana API text reference.