Skip to main content

Desktop App

Atomic swaps via the desktop application

Web App

Order-based swaps from your browser

Developer

Integrate KaleidoSwap into your application

​
Desktop App Quickstart

1

Download & Install

Download the latest release for your platform:
Always verify the binary signatures before installing. Learn how →
2

Create Wallet

Launch KaleidoSwap and create a new wallet:
  1. Click “Create New Wallet”
  2. Save your 12-word recovery phrase securely
  3. Set a strong password
  4. Confirm your seed phrase
Never share your recovery phrase! Anyone with access to it can steal your funds.
3

Deposit Funds

Get your Bitcoin address and deposit funds:
  1. Navigate to “Wallet” → “Receive”
  2. Copy your Bitcoin address
  3. Send BTC to this address from your exchange or wallet
  4. Wait for confirmations (usually 10-60 minutes)
4

Open a Channel

Connect to a Lightning Service Provider:
  1. Go to “Channels” → “Open Channel”
  2. Select an LSP or use the default
  3. Choose channel capacity (recommended: 1M sats minimum)
  4. Select RGB assets to allocate (e.g., USDT)
  5. Confirm and wait for channel to open
5

Make Your First Swap

Execute an atomic swap:
  1. Go to “Swap” tab
  2. Select assets: BTC → USDT (or vice versa)
  3. Enter amount to swap
  4. Review the quote
  5. Confirm swap
  6. Wait for completion (usually less than 30 seconds)
Congratulations! You’ve completed your first atomic RGB asset swap on Lightning Network.

​
Web App Quickstart

The web app currently uses order-based swaps — you create an order, pay, and wait for the maker to fulfill it. This is different from the desktop app’s atomic swaps.
1

Open the Web App

Navigate to the KaleidoSwap web app in your browser — no installation needed.
2

Connect Your Wallet

Connect a supported wallet:
WalletBest For
AlbyLightning payments
XverseBitcoin & Ordinals
BitMaskRGB asset management
RateBitcoin Layer 2 with built-in swaps
Don’t have a wallet? Install the Rate extension for a complete Bitcoin Layer 2 experience.
3

Select Assets & Amount

Choose the asset pair (e.g., BTC → USDT), enter the amount, and provide your recipient address where you want to receive the swapped asset.
4

Create Order & Pay

Review the quote, confirm the order, and pay the deposit invoice shown on the order page.
5

Wait for Execution

After payment is detected, the maker will execute your swap. Track progress on the order page.

Web App Guide

Full web app documentation with detailed trading guides →

​
Developer Quickstart

​
Python SDK

pip install kaleidoswap-sdk

Python SDK Documentation

Explore the complete SDK documentation →

​
TypeScript SDK

npm install kaleidoswap-sdk

TypeScript SDK Documentation

Explore the complete SDK documentation →

​
API Quick Reference

curl https://api.staging.kaleidoswap.com/api/v1/pairs

API Reference

View complete API documentation →

​
Next Steps

Desktop App Guide

Advanced features: channels, backups, and more

Web App Guide

Full web app trading guide

Rate Extension

Bitcoin Layer 2 wallet extension

SDK Examples

Real-world code examples for common workflows

API Documentation

Deep dive into REST API endpoints

Join Community

Get help and connect with other users

​
Available Networks

API URL: https://api.staging.kaleidoswap.com/api/v1
  • Test environment for development
  • Free testnet BTC available
  • Latest features
For production use, contact the KaleidoSwap team for access to mainnet endpoints.