Skip to main content
The RGB Lightning DEX API allows interaction with an RGB Lightning Service Provider (RGB-LSP) that provides liquidity on request and enables swap functionalities. The swap protocol operates on a taker-maker model, where clients can subscribe to trading pairs, receive real-time price updates, and initiate swaps. The API also supports the RGB LSPS1 (Lightning Service Provider Specification) for managing channels and liquidity services.

​
Key Features

  • RGB LSPS1 (Lightning Service Provider Specification) Support: Liquidity services and swap functionalities.
  • Real-time Market Data: WebSocket-based subscription for price updates.
  • Swap Protocol: Taker-maker model for initiating and executing swaps.
  • Asset and Trading Pair Management: Comprehensive API for fetching supported assets and pairs.
Proceed to Getting Started to begin.

​
Using the SDK

Instead of calling the REST API directly, you can use the official KaleidoSwap SDKs that wrap these endpoints with type safety and convenience methods:

TypeScript SDK

Auto-generated typed client from the OpenAPI spec with client.maker.* and client.rln.* sub-clients

Python SDK

Async Python client with Pydantic models, using the same sub-client architecture