# KaleidoSwap Documentation

## Docs

- [Error Handling](https://docs.kaleidoswap.com/api-reference/error-handling.md)
- [Getting Started](https://docs.kaleidoswap.com/api-reference/getting-started.md)
- [Introduction](https://docs.kaleidoswap.com/api-reference/introduction.md): Overview of the KaleidoSwap API for RGB Lightning DEX operations, swap protocol, and market data
- [Create Channel Order](https://docs.kaleidoswap.com/api-reference/lsps1/create-order.md): Create a new Lightning channel with optional RGB asset allocation
- [Estimate Channel Fees](https://docs.kaleidoswap.com/api-reference/lsps1/estimate-fees.md): Calculate channel opening fees without creating an order
- [Get LSP Information](https://docs.kaleidoswap.com/api-reference/lsps1/get-info.md): Retrieve Lightning Service Provider capabilities and configuration
- [Get Network Information](https://docs.kaleidoswap.com/api-reference/lsps1/get-network-info.md): Retrieve blockchain network details including current height
- [Get Order Status](https://docs.kaleidoswap.com/api-reference/lsps1/get-order.md): Retrieve the current status and details of a channel order
- [Handle Rate Decision](https://docs.kaleidoswap.com/api-reference/lsps1/handle-rate-decision.md): Handle user decision on rate change for LSPS1 orders. User can either accept the new market rate or request a refund.
- [Retry Delivery](https://docs.kaleidoswap.com/api-reference/lsps1/retry-delivery.md): Endpoint for clients to queue their order for immediate retry of asset delivery.
- [Market APIs](https://docs.kaleidoswap.com/api-reference/market-apis.md): Fetch assets, trading pairs, quotes, and fee estimates from the KaleidoSwap maker
- [Get Trading Pairs](https://docs.kaleidoswap.com/api-reference/market/get-pairs.md): Retrieve all available trading pairs and their limits
- [Get Price Quote](https://docs.kaleidoswap.com/api-reference/market/get-quote.md): Request a quote for swapping between two assets
- [List Available Assets](https://docs.kaleidoswap.com/api-reference/market/list-assets.md): Get all RGB assets supported by the platform
- [RGB LSPS1 APIs](https://docs.kaleidoswap.com/api-reference/rgb-lsps1-apis.md): Channel ordering and liquidity management via the RGB Lightning Service Provider Specification
- [Swap APIs](https://docs.kaleidoswap.com/api-reference/swap-apis.md): Atomic HTLC swap initiation, execution, and status — used by the desktop app and direct node integrations
- [Create Swap Order](https://docs.kaleidoswap.com/api-reference/swap-orders/create-swap-order.md): Create a new swap order with on-chain or Lightning settlement
- [Get Order History](https://docs.kaleidoswap.com/api-reference/swap-orders/get-order-history.md): Retrieve paginated swap order history with optional filtering
- [Get Order Analytics](https://docs.kaleidoswap.com/api-reference/swap-orders/get-order-stats.md): Retrieve aggregate statistics about swap orders
- [Get Swap Order Status](https://docs.kaleidoswap.com/api-reference/swap-orders/get-swap-order-status.md): Retrieve detailed status of a swap order
- [Handle Swap Order Rate Decision](https://docs.kaleidoswap.com/api-reference/swap-orders/handle-swap-order-rate-decision.md): Handle user decision on rate change for swap orders. User can either accept the new market rate or request a refund.
- [Swap Protocol](https://docs.kaleidoswap.com/api-reference/swap-protocol.md): How KaleidoSwap swap models work — atomic HTLC swaps and order-based swaps
- [Execute Swap](https://docs.kaleidoswap.com/api-reference/swaps/confirm-swap.md): Confirm and execute a previously initiated swap
- [Get Node Information](https://docs.kaleidoswap.com/api-reference/swaps/get-node-info.md): Retrieve Lightning node public key and network details
- [Get Swap Status](https://docs.kaleidoswap.com/api-reference/swaps/get-swap-status.md): Check the current status of an atomic swap
- [Initiate Atomic Swap](https://docs.kaleidoswap.com/api-reference/swaps/initiate-swap.md): Start an atomic swap between RGB assets
- [Channels And LSP Flows](https://docs.kaleidoswap.com/cli/channels-lsp.md): Open Lightning channels directly or use KaleidoSwap LSP channel-order workflows from the Kaleido CLI
- [Command Reference](https://docs.kaleidoswap.com/cli/command-reference.md): Full command map for the Kaleido CLI, including nested command groups and the most important flags
- [Getting Started](https://docs.kaleidoswap.com/cli/getting-started.md): Install the Kaleido CLI, run first-time setup, and configure your default API and node endpoints
- [CLI Overview](https://docs.kaleidoswap.com/cli/introduction.md): Use the Kaleido CLI to manage local RGB Lightning nodes and interact with KaleidoSwap from the terminal
- [Market And Swaps](https://docs.kaleidoswap.com/cli/market-and-swaps.md): Browse KaleidoSwap markets, request quotes, and run order, atomic, or local node swap flows from the CLI
- [Node Environments](https://docs.kaleidoswap.com/cli/node-environments.md): Create, run, switch, and maintain named local RGB Lightning Node environments with the Kaleido CLI
- [Wallet, Assets, And Payments](https://docs.kaleidoswap.com/cli/wallet-assets-payments.md): Manage BTC, RGB assets, Lightning invoices, and node backups through the Kaleido CLI
- [Channel Backups](https://docs.kaleidoswap.com/desktop-app/channels/channel-backups.md): How to create and restore Lightning channel backups in the KaleidoSwap Desktop App
- [Channel Requests](https://docs.kaleidoswap.com/desktop-app/channels/channel-requests.md): How to request inbound channels from a Lightning Service Provider (LSP) in the Kaleidoswap Desktop App
- [Opening Channels](https://docs.kaleidoswap.com/desktop-app/channels/opening-channel.md): Step-by-step instructions for opening a channel in the Kaleidoswap Desktop App
- [Order New Channel](https://docs.kaleidoswap.com/desktop-app/channels/order-new-channel.md): Step-by-step instructions for ordering a new channel from a Lightning Service Provider (LSP) in the Kaleidoswap Desktop App
- [Installation Guide](https://docs.kaleidoswap.com/desktop-app/getting-started/installation.md): Step-by-step instructions for installing KaleidoSwap Desktop App on macOS, Windows, and Linux
- [Desktop App Introduction](https://docs.kaleidoswap.com/desktop-app/getting-started/introduction.md): Learn about the KaleidoSwap Desktop App for managing Bitcoin and RGB assets on Lightning Network
- [RGB Lightning Node Hosting](https://docs.kaleidoswap.com/desktop-app/getting-started/node-hosting.md): Learn how to self-host a RGB Lightning Node for use with KaleidoSwap
- [Verify Binary Downloads](https://docs.kaleidoswap.com/desktop-app/getting-started/verify-binaries.md): How to verify the authenticity of KaleidoSwap Desktop App binaries using GPG detached signatures
- [Additional Resources](https://docs.kaleidoswap.com/desktop-app/support/additional-resources.md): Useful links and external resources for KaleidoSwap users and developers
- [Frequently Asked Questions](https://docs.kaleidoswap.com/desktop-app/support/faq.md): Frequently asked questions about the Kaleidoswap Desktop App
- [Settings](https://docs.kaleidoswap.com/desktop-app/support/settings.md): Configuring the KaleidoSwap Desktop App settings
- [Asset Swaps](https://docs.kaleidoswap.com/desktop-app/trading/asset-swaps.md): Step-by-step instructions for performing an asset swap in the KaleidoSwap Desktop App
- [Creating a New Wallet](https://docs.kaleidoswap.com/desktop-app/wallet/creating-wallet.md): Step-by-step instructions for creating a new wallet in the Kaleidoswap Desktop App
- [Deposit To Your Wallet](https://docs.kaleidoswap.com/desktop-app/wallet/deposits.md): Step-by-step instructions for depositing funds to your wallet in the Kaleidoswap Desktop App
- [Initializing with Mnemonic Backup](https://docs.kaleidoswap.com/desktop-app/wallet/initializing-mnemonic.md): Step-by-step instructions for initializing a new wallet with a mnemonic backup in the Kaleidoswap Desktop App
- [Unlocking Your Wallet](https://docs.kaleidoswap.com/desktop-app/wallet/unlocking-wallet.md): Step-by-step instructions for unlocking your wallet in the Kaleidoswap Desktop App
- [Withdrawals](https://docs.kaleidoswap.com/desktop-app/wallet/withdrawals.md): Step-by-step instructions for withdrawing funds from your wallet in the Kaleidoswap Desktop App
- [Client Reference](https://docs.kaleidoswap.com/sdk/api-reference.md): Reference for KaleidoClient, MakerClient, and RlnClient
- [Best Practices](https://docs.kaleidoswap.com/sdk/best-practices.md): Development guidelines for building with the KaleidoSwap SDK
- [Changelog](https://docs.kaleidoswap.com/sdk/changelog.md): SDK and API version history for KaleidoSwap
- [Error Handling](https://docs.kaleidoswap.com/sdk/error-handling.md): Exception hierarchy and error management patterns
- [Examples](https://docs.kaleidoswap.com/sdk/examples.md): Common integration examples for the Kaleido SDK
- [Getting Started](https://docs.kaleidoswap.com/sdk/getting-started.md): Install and configure the Kaleido SDK for TypeScript or Python
- [How to Create Swaps](https://docs.kaleidoswap.com/sdk/how-to-swap.md): Step-by-step guide for creating and executing swap orders and atomic swaps.
- [SDK Overview](https://docs.kaleidoswap.com/sdk/introduction.md): Build applications on KaleidoSwap with our Python and TypeScript SDKs
- [Maker API Compatibility](https://docs.kaleidoswap.com/sdk/maker-api-compatibility.md): SDK and Maker API compatibility information
- [RLN API Compatibility](https://docs.kaleidoswap.com/sdk/rln-api-compatibility.md): SDK and RGB Lightning Node API compatibility information
- [Troubleshooting](https://docs.kaleidoswap.com/sdk/troubleshooting.md): Common issues and solutions
- [Types](https://docs.kaleidoswap.com/sdk/types.md): Core types and config used by the Kaleido SDK
- [Utilities](https://docs.kaleidoswap.com/sdk/utilities.md): Helper functions for amount conversion, precision handling, and asset mapping
- [WebSocket](https://docs.kaleidoswap.com/sdk/websocket.md): Real-time quote streaming via WebSocket
- [Architecture Overview](https://docs.kaleidoswap.com/whats-kaleidoswap/architecture.md): Understanding KaleidoSwap's decentralized architecture
- [How It Works](https://docs.kaleidoswap.com/whats-kaleidoswap/background.md): Understanding the technologies powering KaleidoSwap — Bitcoin, Lightning Network, and RGB Protocol
- [Glossary](https://docs.kaleidoswap.com/whats-kaleidoswap/glossary.md): Key terms and concepts for RGB, Lightning Network, and KaleidoSwap
- [Welcome to KaleidoSwap](https://docs.kaleidoswap.com/whats-kaleidoswap/introduction.md): Trade RGB assets on the Lightning Network — desktop, browser, and beyond
- [Key Features](https://docs.kaleidoswap.com/whats-kaleidoswap/key-features.md): Core capabilities and features of KaleidoSwap
- [Quickstart](https://docs.kaleidoswap.com/whats-kaleidoswap/quickstart.md): Get started with KaleidoSwap in minutes
- [Troubleshooting Guide](https://docs.kaleidoswap.com/whats-kaleidoswap/troubleshooting.md): Common issues and solutions for KaleidoSwap Desktop App, API, and SDK

## OpenAPI Specs

- [openapi](https://docs.kaleidoswap.com/openapi.json)

## Optional

- [Download Desktop App](https://github.com/kaleidoswap/desktop-app/releases)
- [GitHub](https://github.com/kaleidoswap)