Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add pro API usage #804

Merged
merged 1 commit into from
Feb 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
- [⚠️ Common Mistakes](common-mistakes.md)
- [🪝 Webhooks](webhooks.md)
- [⚡ BOLT12](bolt12.md)
- [🏅 Pro](pro.md)
- [🤝 Referral Program](referral-program.md)
- [🚢 Backend Deployment](deployment.md)
- [🐳 Regtest Environment](regtest.md)
Expand Down
27 changes: 27 additions & 0 deletions docs/pro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
description: >-
Boltz Pro is the same as our main site, but with the crucial difference that
michael1011 marked this conversation as resolved.
Show resolved Hide resolved
fees are variable and set based on our liquidity needs
---

# 🏅 Pro

Boltz Pro is an experimental service designed to dynamically adjust swap fees
based on our liquidity needs, helping maintain balance between our wallets and
Lightning channels. We temporarily offer incentives (like 0% or even negative
fees) to encourage users to conduct swaps that work in favor of our liquidity
needs.

## Web Usage

A web app for Boltz Pro is available on
[pro.boltz.exchange](https://pro.boltz.exchange/).

### API Usage

The Boltz Pro API uses the
[exact same endpoints and methods as the normal one](api-v2.md). Only two things
need to be done to use Pro:

- add a `Referral` header to all pair related `GET` requests and set it to `pro`
- set the `referralId` to `pro` when creating swaps