Skip to main content
POST
Restore swaps

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

XPUB search accepted by POST /v2/swap/restore and /restore/index. Supports the XPUB variant used by the TypeScript bindings; explicit public-key and EVM-address variants are not supported.

xpub
string
required

Extended public key from which client swap keys are derived.

derivationPath
string | null

Child-key base path. Boltz defaults to m/44/0/0/0; SDK callers pass m when the supplied XPUB is already the swap-account key.

gapLimit
integer<int32> | null

Consecutive unused-key scan limit. Boltz defaults to 50 and accepts values in 1..=150.

Required range: 1 <= x <= 150

Response

Matching swaps in deterministic creation order.

createdAt
integer<int64>
required

Unix creation timestamp in seconds.

Required range: x >= 0
from
string
required
id
string
required
preimageHash
string
required

Canonical Boltz restore field. Older SDK bindings ignore this top-level field, while newer clients need it to reconstruct submarine refunds.

status
string
required
to
string
required
type
enum<string>
required

Swap kind in a restore result.

Available options:
submarine,
reverse,
chain
claimDetails
object | null

Client-side claim material returned by swap restoration.

invoice
string | null
refundDetails
object | null

Client-side refund material returned by swap restoration.