# Boltz Docs

## Home

- [Welcome to the Home of Boltz Docs](https://docs.boltz.exchange/readme): This documentation is written for anyone looking to learn about Boltz, how to integrate Boltz Swaps via the public API or use Boltz with one of the clients

## Boltz API

- [Introduction](https://docs.boltz.exchange/api/readme): Boltz exposes a RESTful HTTP API that can be used to query information like supported pairs as well as to create and monitor swaps. All swap clients, like Boltz Web App, use Boltz API under the hood.
- [Libraries](https://docs.boltz.exchange/api/libraries): Integrating Boltz API is involved and not to be underestimated. To save on time and resources, we highly recommend exploring the different library options for Boltz API below.
- [REST API v2](https://docs.boltz.exchange/api/api-v2): This page introduces Boltz API v2, the latest and recommended API for all integrations.
- [REST API v1 (deprecated)](https://docs.boltz.exchange/api/api-v1): This page lists all available endpoints of the deprecated Boltz API v1.
- [Swap Types & States](https://docs.boltz.exchange/api/lifecycle): Boltz offers several different swap types. This document describes the types and different states a particular swap type traverses.
- [Claim & Refund Transactions](https://docs.boltz.exchange/api/claiming-swaps): This document gives an overview of how Boltz API clients craft claim and refund transactions and touches on emergency procedures for rescuing funds of failed swaps.
- [Magic Routing Hints](https://docs.boltz.exchange/api/magic-routing-hints): This page describes the mechanism that encodes a BIP21 into the routing hints section of an invoice, mainly for Boltz-powered wallets like Aqua to pay each other directly without a Boltz swap.
- [Claim covenants](https://docs.boltz.exchange/api/claim-covenants): To reduce the interactivity requirements of Reverse Swaps, one can make use of covenants. For instance this allows a mobile wallet provider to claim Reverse Swaps for its users while they are offline.
- [Don't trust. Verify!](https://docs.boltz.exchange/api/dont-trust-verify): This document gives an overview of how Boltz API clients should verify information generated by Boltz and other general measurements that should be undertaken to minimize trust.
- [0-conf](https://docs.boltz.exchange/api/0-conf): The use of 0-conf can make swaps a lot faster by utilizing transactions that are not included in a block yet. But accepting 0-conf transactions doesn't come without unwarranted risk.
- [Common Mistakes](https://docs.boltz.exchange/api/common-mistakes): This document collects frequently encountered misunderstandings and common mistakes when integrating Boltz API.
- [Webhooks](https://docs.boltz.exchange/api/webhooks): Get notified about swap status updates
- [BOLT12](https://docs.boltz.exchange/api/bolt12): Information about swaps with the new BOLT12 standard and some accompanying tips & tricks for how to handle BOLT12 offers.
- [Pro](https://docs.boltz.exchange/api/pro): Boltz Pro is the same as our main site, but with the crucial difference that fees are variable and set based on our liquidity needs
- [Referral Program](https://docs.boltz.exchange/api/referral-program): Boltz operates a referral program which provides eligible partners with rewards for impactful, high quality integrations of Boltz API
- [Backend Deployment](https://docs.boltz.exchange/api/deployment): Deploying Boltz backend has to be done with great care since it will have full control over the Lightning Node it is connected to. With great power comes great responsibility.
- [Regtest Environment](https://docs.boltz.exchange/api/regtest): This document describes how to set up a Docker regtest environment for Boltz Backend development.

## Boltz Client

- [Introduction](https://docs.boltz.exchange/boltz-client/readme)
- [Wallets](https://docs.boltz.exchange/boltz-client/wallets)
- [Autoswap](https://docs.boltz.exchange/boltz-client/autoswap)
- [Configuration](https://docs.boltz.exchange/boltz-client/configuration)
- [gRPC API](https://docs.boltz.exchange/boltz-client/grpc)

## Boltz Web App

- [Run from Source](https://docs.boltz.exchange/web-app/readme): We encourage our technical users to check the code and run the web app locally from source following the instructions below.
- [Install as App](https://docs.boltz.exchange/web-app/pwa): For improved censorship resistance and privacy, Boltz is not available in app stores, but can be installed as Progressive Web App (PWA) on all Android and iOS devices, as well as desktop computers.
- [URL Parameters](https://docs.boltz.exchange/web-app/urlparams): To prefill certain inputs of the the site, URL query parameters can be used. Those parameters are documented here.

## Boltz BTCPay Plugin

- [Introduction](https://docs.boltz.exchange/boltz-btcpay-plugin/readme): The Boltz BTCPay Plugin allows any merchant to accept Lightning payments in a non-custodial way without running a Lightning node or fully manage liquidity of an existing Lightning node.
- [Limitations](https://docs.boltz.exchange/boltz-btcpay-plugin/limitations): This page lists know limitations of the Boltz BTCPay Plugin
- [Regtest Setup](https://docs.boltz.exchange/boltz-btcpay-plugin/regtest-setup)