Skip to content

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

satsrouting-api-docs

Documentation for the Satsrouting.exchange API, adapted from the official Boltz API documentation (https://api.docs.boltz.exchange/). Please note that actually only Liquid, Lightning e Bitcoin on-chain are supported.

Structure

satsrouting-api-docs/
├── README.md
├── .gitignore
└── docs/                      
    ├── index.md
    ├── libraries.md
    ├── api-v2.md
    ├── api-v1.md
    ├── lifecycle.md
    ├── swap-limits-and-fees.md
    ├── renegotiating.md
    ├── claiming-swaps.md
    ├── commitment-swaps.md
    ├── swap-restore.md
    ├── asset-rescue.md
    ├── common-mistakes.md
    ├── dont-trust-verify.md
    ├── magic-routing-hints.md
    ├── 0-conf.md
    ├── webhooks.md
    ├── bolt12.md
    ├── pro.md
    ├── claim-covenants.md
    ├── partner-program.md
    └── backend-development.md

Document index

Page Topic
index.md Introduction, mainnet/Tor endpoints, Lightning nodes
libraries.md Official clients/SDKs recommended for integration
api-v2.md REST API v2 reference + Submarine/Reverse/Chain Swap examples, WebSocket, HMAC authentication
api-v1.md REST API v1 reference (deprecated)
lifecycle.md Swap types and the states each swap traverses during its lifecycle
swap-limits-and-fees.md Fee structure, amount calculations, limits
renegotiating.md How to salvage a Chain Swap that failed due to an incorrect amount
claiming-swaps.md Building claim and refund transactions, Taproot, EVM, legacy swaps
commitment-swaps.md Locking funds before knowing the exact amount (EVM)
swap-restore.md Recovering swaps via the Rescue Key (mnemonic/xpub)
asset-rescue.md Cooperative recovery of Liquid assets sent by mistake
common-mistakes.md Common integration mistakes
dont-trust-verify.md How clients should verify information returned by the API
magic-routing-hints.md Direct sender→receiver payments without going through a swap
0-conf.md Handling zero-confirmation transactions
webhooks.md Status notifications via webhook
bolt12.md BOLT12 support (offers, BIP-353)
pro.md Pro: dynamic fees based on liquidity
claim-covenants.md Liquid covenants to reduce Reverse Swap interactivity
partner-program.md Partner program for integrations
backend-development.md Setting up a regtest development environment for the backend

About

SatsRouting non-custodial swaps API Docs

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors