Boltz Web App

Appearance

🔍 URL query parameters ​

To prefill certain inputs of the the site, URL query parameters can be used. Those parameters are documented here.

Destination ​

destination prefills either the onchain address or invoice input field. The inferred asset takes precedence over receiveAsset and in case a lightning invoice is set, its amount takes precedence over all other inputs to set the amount.

Assets ​

sendAsset and receiveAsset can be used to set the assets. Possible values are:

  • LN
  • BTC
  • L-BTC
  • RBTC
  • TBTC (Arbitrum)
  • WBTC (Arbitrum)
  • USDT0 (Arbitrum)
  • USDT0-BERA
  • USDT0-CFX
  • USDT0-ETH
  • USDT0-FLR
  • USDT0-HBAR
  • USDT0-HYPE
  • USDT0-INK
  • USDT0-MEGAETH
  • USDT0-MNT
  • USDT0-MON
  • USDT0-MORPH
  • USDT0-OP
  • USDT0-PLASMA
  • USDT0-POL
  • USDT0-RBTC
  • USDT0-SEI
  • USDT0-SOL
  • USDT0-STABLE
  • USDT0-TEMPO
  • USDT0-TRON
  • USDT0-UNI
  • USDT0-XLAYER
  • USDC (Arbitrum)
  • USDC-AVAX
  • USDC-BASE
  • USDC-CODEX
  • USDC-ETH
  • USDC-INK
  • USDC-LINEA
  • USDC-MON
  • USDC-OP
  • USDC-PLUME
  • USDC-POL
  • USDC-SEI
  • USDC-SOL
  • USDC-SONIC
  • USDC-UNI
  • USDC-WORLD
  • USDC-XDC

Amounts ​

sendAmount or receiveAmount set the respective amounts. Value is denominated in satoshis and sendAmount takes precedence.

Language ​

When no language has been set before, the default can be set with lang. Available values are:

  • English: en
  • German: de
  • Spanish: es
  • Portuguese: pt
  • Chinese: zh
  • Japanese: ja

Fiat currency ​

fiatCurrency sets the currency used for the fiat amount hint. The value is case-insensitive, overrides any previously persisted selection, and is removed from the URL after being applied. Available values are:

  • USD
  • EUR

Backup ​

On the swap status page, backup selects which rescue key backup method is shown when a backup of the rescue key is required. By default the downloadable rescue file is offered; the value below opens the 12 word mnemonic backup instead. Available value is:

  • mnemonic

Parent origin ​

parentOrigin sets the target origin for postMessage notifications sent to the parent window when the app is embedded as an iframe. It must be used alongside embedded=true. When a swap reaches a final status (success or failure), the app sends a message to window.parent with the swap ID and status:

json
{
    "type": "boltz-swap-status",
    "swapId": "abc123",
    "status": "invoice.settled"
}

The parent page should listen for these messages and validate the origin:

javascript
window.addEventListener("message", (event) => {
    if (event.origin !== "https://boltz.exchange") return;
    if (event.data?.type === "boltz-swap-status") {
        // Handle swap completion
    }
});