👋 Introduction

Boltz exposes a RESTful HTTP API that can be used to query information such as supported pairs as well as to create and monitor swaps. All swap clients, such as Boltz Web App, use Boltz API under the hood.

Instances

We offer Boltz on regtest for development & testing purposes and our production service on mainnet. Our testnet deployment is deprecated and we currently do not provide support for it.

Our REST APIs can be accessed at:

• Mainnet: https://api.boltz.exchange/
• Mainnet via Tor: http://boltzzzbnus4m7mta3cxmflnps4fp7dueu2tgurstbvrbt6xswzcocyd.onion/api/

Lightning Nodes

We operate the following lightning nodes: CLN | LND

In the following sections we'll describe the available clients, SDKs, and libraries for our API, the REST API itself, walk through swap types & states, how to craft transactions, handle refunds and more.

For AI Agents & LLMs

These docs are also published in an LLM-friendly format following the llms.txt convention:

• /llms.txt: table of contents with a short description of each page, suitable for letting a model decide which page to fetch.
• /llms-full.txt: the entire documentation concatenated into a single plain-text file, suitable for loading into a model's context.
• Per-page Markdown sources: append .md to any page URL (for example /api-v2.md or /lifecycle.md) to get the raw Markdown.