> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kaleidoswap.com/llms.txt
> Use this file to discover all available pages before exploring further.

# RLN API

> Which RGB Lightning Node (RLN) API version each Node SDK release targets, with the node-side endpoint categories client.rln exposes

The RLN (RGB Lightning Node) API is provided directly by your configured RGB Lightning Node. It enables wallet operations, Lightning channel management, and node-to-node swap coordination.

## Compatibility

**Node SDK v0.1.23** is generated against **RGB Lightning Node API v0.10.0** (the `kaleidoswap/rgb-lightning-node` fork).

The SDK automatically supports the most recent RLN API release. Always keep your SDK and RGB Lightning Node updated to ensure full compatibility and access to the latest features and security improvements. See the [changelog](https://docs.kaleidoswap.com/cli/node-sdk/changelog.md) for version history.

> [!NOTE]
>
> To check the latest RLN API changes and updates, refer to the [RGB Lightning Node](https://github.com/kaleidoswap/rgb-lightning-node) or your node documentation.

## Categories

| Category | Purpose | Examples |
| - | - | - |
| **Wallet** | BTC and RGB asset management | Balance queries, transfers, asset operations |
| **Channels** | Lightning Network channel operations | Open, close, monitor, backup channels |
| **Invoices** | Payment request management | Create, list, and monitor invoices |
| **Payments** | Payment execution | Pay invoices, coordinate swaps, node-to-node transactions |
| **Node Info** | Node status and configuration | Pubkey, sync status, capabilities |

These are reached through `client.rln`, which requires a `nodeUrl` / `node_url` on the client: without one, TypeScript throws `ConfigError` and Python raises `NodeNotConfiguredError`. See [Getting Started](https://docs.kaleidoswap.com/cli/node-sdk/getting-started.md) for the setup and the node checks, and the [Client Reference](https://docs.kaleidoswap.com/cli/node-sdk/api-reference.md) for every method.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.