Find the swaps whose client keys derive from an xpub, with the details needed to claim or refund them. Pass the derivation path your keys use. Does not return swapAuth.
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.
Client-side refund material returned by swap restoration.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"KaleidoSwap Documentation","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/kaleidoswap/jZkXeFEXDE4-8PkF/assets/logos/kaleidoswap-full-logo-horizontal-onlight.svg?fit=max\u0026auto=format\u0026n=jZkXeFEXDE4-8PkF\u0026q=85\u0026s=8cf2002b5e2b8ea1cfb0523af2525f09","dark":"https://mintcdn.com/kaleidoswap/jZkXeFEXDE4-8PkF/assets/logos/kaleidoswap-full-logo-horizontal.svg?fit=max\u0026auto=format\u0026n=jZkXeFEXDE4-8PkF\u0026q=85\u0026s=1d5d02f344b0a00783670693d8d928ec"},"favicon":"https://mintcdn.com/kaleidoswap/jZkXeFEXDE4-8PkF/assets/logos/kaleidoswap-favicon.ico?fit=max\u0026auto=format\u0026n=jZkXeFEXDE4-8PkF\u0026q=85\u0026s=7a218e79e2eff3be0d975a63e39bf5af","api":{"playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"},"server":"https://maker.signet.kaleidoswap.com"}},"navbar":{"links":[{"href":"/sdk/installation","label":"Build"}],"primary":{"type":"button","label":"Download the Apps","href":"https://kaleidoswap.com/products"}},"footer":{"socials":{"x":"https://x.com/kaleidoswap","github":"https://github.com/kaleidoswap","telegram":"https://t.me/kaleidoswap"}},"integrations":{"posthog":{"apiKey":"phc_g3NF1o9hsu8tFROxZaRT9JfD1BdBEQYfIIcrkVzTkps","apiHost":"https://eu.i.posthog.com","sessionRecording":true}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"whats-kaleidoswap/introduction"},{"language":"cn","navbar":{"links":[{"href":"/cn/sdk/installation","label":"构建"}],"primary":{"type":"button","label":"下载应用","href":"https://kaleidoswap.com/products"}},"href":"cn/whats-kaleidoswap/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kaleidoswap","hasAudioNarration":false,"actualSubdomain":"kaleidoswap","customDomains":["docs.kaleidoswap.com"],"gitSource":{"type":"github","owner":"kaleidoswap","repo":"docs","deployBranch":"main","contentDirectory":"mintlify-docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae21c728ead5bbc3c1d7030","collectionId":"ce7c4641-3d9a-4f3c-9cc2-027b7777d86f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae21c728ead5bbc3c1d7030"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae2233ab344d78ea3e3a604","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"API Reference","count":42},{"language":"en","tag":"Reference","count":28},{"language":"en","tag":"CLI","count":28},{"language":"cn","tag":"参考","count":25},{"language":"en","tag":"Desktop App","count":24},{"language":"en","tag":"SDK","count":24},{"language":"cn","tag":"简介","count":24},{"language":"cn","tag":"桌面应用","count":24},{"language":"en","tag":"Introduction","count":22},{"language":"cn","tag":"SDK","count":17},{"language":"en","tag":"AI Tools","count":11},{"language":"en","tag":"Node SDK","count":11},{"language":"cn","tag":"AI 工具","count":11},{"language":"cn","tag":"CLI","count":11},{"language":"en","tag":"Extensions","count":10},{"language":"cn","tag":"浏览器扩展","count":10},{"language":"en","tag":"Guides","count":9},{"language":"cn","tag":"API 参考","count":9},{"language":"en","tag":"Wallet Operations","count":8},{"language":"cn","tag":"钱包操作","count":8},{"language":"cn","tag":"概览","count":8},{"language":"default","tag":"Chain swaps","count":7},{"language":"default","tag":"Atomic RGB swaps","count":5},{"language":"default","tag":"Reverse swaps","count":5},{"language":"default","tag":"Chain data","count":4},{"language":"default","tag":"Recovery","count":4},{"language":"default","tag":"Service","count":4},{"language":"default","tag":"Submarine swaps","count":4},{"language":"default","tag":"Lightning channels (LSPS1)","count":3},{"language":"default","tag":"Swap status","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"main img,main img.rounded{display:block;margin-left:auto;margin-right:auto;border-radius:.5rem;box-shadow:0 4px 8px -1px rgb(0 0 0/.12),0 12px 28px -4px rgb(0 0 0/.18)}.dark main img,.dark main img.rounded{border-radius:.5rem;box-shadow:0 4px 8px -1px rgb(0 0 0/.45),0 14px 34px -4px rgb(0 0 0/.65)}main :is(p, figure) :is(a, div, span):has(img[src*=\"/desktop-app/\"]),main :is(p, figure):has(img[src*=\"/desktop-app/\"]){padding:0!important;background:0 0!important;border:0!important;box-shadow:none!important}main img[src*=\"/desktop-app/\"],main img[src*=\"/extension/\"]{display:block;height:auto;border-radius:.5rem;box-shadow:0 4px 8px -1px rgb(0 0 0/.12),0 12px 28px -4px rgb(0 0 0/.18)}main img[src*=\"/desktop-app/\"]{margin:1.5rem auto;padding:0!important;background:0 0!important;border:0!important;width:min(100%,800px);max-width:800px}.dark main img[src*=\"/desktop-app/\"],.dark main img[src*=\"/extension/\"]{box-shadow:0 4px 8px -1px rgb(0 0 0/.45),0 14px 34px -4px rgb(0 0 0/.65)}main img[src*=\"/extension/\"]{margin-left:auto;margin-right:auto;max-width:360px}"}],"page":{"pagePath":"api-reference/recovery/restore-swaps","slug":"/api-reference/recovery/restore-swaps","pageMetadata":{"title":"Restore swaps","description":"Find the swaps whose client keys derive from an xpub, with the details needed to claim or refund them. Pass the derivation path your keys use. Does not return `swapAuth`.","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/restore","href":"/api-reference/recovery/restore-swaps","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Find the swaps whose client keys derive from an xpub, with the details needed to claim or refund them. Pass the derivation path your keys use. Does not return \", _jsx(_components.code, {\n children: \"swapAuth\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Restore swaps","description":"Find the swaps whose client keys derive from an xpub, with the details needed to claim or refund them. Pass the derivation path your keys use. Does not return `swapAuth`.","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/restore","href":"/api-reference/recovery/restore-swaps","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Recovery"],"summary":"Restore swaps","operationId":"restore","requestBody":"515564d2-b72d-4a21-bd05-4317cef14409","responses":{"200":"13d5c7be-d676-4fcb-b80c-830d890de9e7","400":"7d92ee5d-321a-4ce2-a7c7-3bc53219c014","422":"10794a81-2e8b-4e9c-8dea-65714d1b67d9","503":"363ad570-32d7-4bdc-87d4-3e1554bc0091"},"description":"Find the swaps whose client keys derive from an xpub, with the details needed to claim or refund them. Pass the derivation path your keys use. Does not return `swapAuth`.","method":"post","type":"path","servers":["5a853f64-bde2-49c1-8aad-ff97a3fd5e5f"],"security":[],"path":"/v2/swap/restore","baseUrlOptions":["https://maker.signet.kaleidoswap.com"],"title":"Restore swaps","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"XPUB search accepted by `POST /v2/swap/restore` and `/restore/index`. Supports the XPUB variant used by the TypeScript bindings; explicit\npublic-key and EVM-address variants are not supported.","required":["xpub"],"properties":{"xpub":{"type":"string","description":"Extended public key from which client swap keys are derived.","isRequired":true,"uniqueKey":"xpub","typeLabel":"string"},"derivationPath":{"oneOf":[{"type":"string","description":"Child-key base path. Boltz defaults to `m/44/0/0/0`; SDK callers pass\n`m` when the supplied XPUB is already the swap-account key.","uniqueKey":"derivationPath.oneOf.0","typeLabel":"string"},{"type":"null","description":"Child-key base path. Boltz defaults to `m/44/0/0/0`; SDK callers pass\n`m` when the supplied XPUB is already the swap-account key.","uniqueKey":"derivationPath.oneOf.1","typeLabel":"null"}],"uniqueKey":"derivationPath","typeLabel":"string | null"},"gapLimit":{"oneOf":[{"type":"integer","format":"int32","description":"Consecutive unused-key scan limit. Boltz defaults to 50 and accepts\nvalues in `1..=150`.","maximum":150,"minimum":1,"uniqueKey":"gapLimit.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Consecutive unused-key scan limit. Boltz defaults to 50 and accepts\nvalues in `1..=150`.","maximum":150,"minimum":1,"uniqueKey":"gapLimit.oneOf.1","typeLabel":"null"}],"uniqueKey":"gapLimit","typeLabel":"integer\u003cint32> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"xpub":"\u003cstring>","derivationPath":"\u003cstring>","gapLimit":75}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"13d5c7be-d676-4fcb-b80c-830d890de9e7":{"description":"Matching swaps in deterministic creation order.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"One element returned by `POST /v2/swap/restore`.","required":["id","type","status","createdAt","from","to","preimageHash"],"properties":{"createdAt":{"type":"integer","format":"int64","description":"Unix creation timestamp in seconds.","minimum":0,"isRequired":true,"uniqueKey":"items.[INDEX].createdAt","typeLabel":"integer\u003cint64>"},"from":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].from","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].id","typeLabel":"string"},"preimageHash":{"type":"string","description":"Canonical Boltz restore field. Older SDK bindings ignore this top-level\nfield, while newer clients need it to reconstruct submarine refunds.","isRequired":true,"uniqueKey":"items.[INDEX].preimageHash","typeLabel":"string"},"status":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].status","typeLabel":"string"},"to":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].to","typeLabel":"string"},"type":{"type":"string","description":"Swap kind in a restore result.","enum":["submarine","reverse","chain"],"isRequired":true,"uniqueKey":"items.[INDEX].type","typeLabel":"enum\u003cstring>"},"claimDetails":{"oneOf":[{"type":"object","description":"Client-side claim material returned by swap restoration.","required":["type","tree","keyIndex","lockupAddress","serverPublicKey","timeoutBlockHeight","preimageHash"],"properties":{"keyIndex":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.keyIndex","typeLabel":"integer\u003cint32>"},"lockupAddress":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.lockupAddress","typeLabel":"string"},"preimageHash":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.preimageHash","typeLabel":"string"},"serverPublicKey":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.serverPublicKey","typeLabel":"string"},"timeoutBlockHeight":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.timeoutBlockHeight","typeLabel":"integer\u003cint32>"},"tree":{"type":"object","description":"`swapTree` returned on every swap creation + status response.","required":["claimLeaf","refundLeaf"],"properties":{"claimLeaf":{"type":"object","description":"One tapscript leaf — leaf-version byte (`196` / `0xc4` for elements,\n`192` / `0xc0` for Bitcoin) plus the hex script.","required":["version","output"],"properties":{"output":{"type":"string","description":"Hex-encoded leaf script.","isRequired":true,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.tree.claimLeaf.output","typeLabel":"string"},"version":{"type":"integer","format":"int32","description":"Tapscript leaf-version byte.","minimum":0,"isRequired":true,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.tree.claimLeaf.version","typeLabel":"integer\u003cint32>"}},"isRequired":true,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.tree.claimLeaf","typeLabel":"object"},"refundLeaf":{"type":"object","description":"One tapscript leaf — leaf-version byte (`196` / `0xc4` for elements,\n`192` / `0xc0` for Bitcoin) plus the hex script.","required":["version","output"],"properties":{"output":{"type":"string","description":"Hex-encoded leaf script.","isRequired":true,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.tree.refundLeaf.output","typeLabel":"string"},"version":{"type":"integer","format":"int32","description":"Tapscript leaf-version byte.","minimum":0,"isRequired":true,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.tree.refundLeaf.version","typeLabel":"integer\u003cint32>"}},"isRequired":true,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.tree.refundLeaf","typeLabel":"object"}},"isRequired":true,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.tree","typeLabel":"object"},"type":{"type":"string","description":"UTXO detail discriminator used by canonical Boltz restore responses.","enum":["utxo"],"isRequired":true,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.type","typeLabel":"enum\u003cstring>"},"amount":{"oneOf":[{"type":"integer","format":"int64","minimum":0,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","minimum":0,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.amount","typeLabel":"integer\u003cint64> | null"},"blindingKey":{"oneOf":[{"type":"string","description":"Omitted for Liquid, whose lockups the maker mints **unconfidential**\non purpose, so no output blinding key exists to return; and for\nBitcoin, which has no such field.","uniqueKey":"items.[INDEX].claimDetails.oneOf.0.blindingKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"Omitted for Liquid, whose lockups the maker mints **unconfidential**\non purpose, so no output blinding key exists to return; and for\nBitcoin, which has no such field.","uniqueKey":"items.[INDEX].claimDetails.oneOf.0.blindingKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.blindingKey","typeLabel":"string | null"},"transaction":{"oneOf":[{"type":"object","description":"Funding outpoint included once the relevant lockup exists.","required":["id","vout"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.transaction.oneOf.0.id","typeLabel":"string"},"vout":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.transaction.oneOf.0.vout","typeLabel":"integer\u003cint32>"}},"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.transaction.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"items.[INDEX].claimDetails.oneOf.0.transaction.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].claimDetails.oneOf.0.transaction","typeLabel":"object | null"}},"uniqueKey":"items.[INDEX].claimDetails.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"items.[INDEX].claimDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].claimDetails","typeLabel":"object | null"},"invoice":{"oneOf":[{"type":"string","uniqueKey":"items.[INDEX].invoice.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"items.[INDEX].invoice.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].invoice","typeLabel":"string | null"},"refundDetails":{"oneOf":[{"type":"object","description":"Client-side refund material returned by swap restoration.","required":["type","tree","keyIndex","lockupAddress","serverPublicKey","timeoutBlockHeight"],"properties":{"keyIndex":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.keyIndex","typeLabel":"integer\u003cint32>"},"lockupAddress":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.lockupAddress","typeLabel":"string"},"serverPublicKey":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.serverPublicKey","typeLabel":"string"},"timeoutBlockHeight":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.timeoutBlockHeight","typeLabel":"integer\u003cint32>"},"tree":{"type":"object","description":"`swapTree` returned on every swap creation + status response.","required":["claimLeaf","refundLeaf"],"properties":{"claimLeaf":{"type":"object","description":"One tapscript leaf — leaf-version byte (`196` / `0xc4` for elements,\n`192` / `0xc0` for Bitcoin) plus the hex script.","required":["version","output"],"properties":{"output":{"type":"string","description":"Hex-encoded leaf script.","isRequired":true,"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.tree.claimLeaf.output","typeLabel":"string"},"version":{"type":"integer","format":"int32","description":"Tapscript leaf-version byte.","minimum":0,"isRequired":true,"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.tree.claimLeaf.version","typeLabel":"integer\u003cint32>"}},"isRequired":true,"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.tree.claimLeaf","typeLabel":"object"},"refundLeaf":{"type":"object","description":"One tapscript leaf — leaf-version byte (`196` / `0xc4` for elements,\n`192` / `0xc0` for Bitcoin) plus the hex script.","required":["version","output"],"properties":{"output":{"type":"string","description":"Hex-encoded leaf script.","isRequired":true,"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.tree.refundLeaf.output","typeLabel":"string"},"version":{"type":"integer","format":"int32","description":"Tapscript leaf-version byte.","minimum":0,"isRequired":true,"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.tree.refundLeaf.version","typeLabel":"integer\u003cint32>"}},"isRequired":true,"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.tree.refundLeaf","typeLabel":"object"}},"isRequired":true,"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.tree","typeLabel":"object"},"type":{"type":"string","description":"UTXO detail discriminator used by canonical Boltz restore responses.","enum":["utxo"],"isRequired":true,"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.type","typeLabel":"enum\u003cstring>"},"amount":{"oneOf":[{"type":"integer","format":"int64","minimum":0,"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","minimum":0,"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.amount","typeLabel":"integer\u003cint64> | null"},"blindingKey":{"oneOf":[{"type":"string","description":"Omitted for Liquid, whose lockups the maker mints **unconfidential**\non purpose, so no output blinding key exists to return; and for\nBitcoin, which has no such field.","uniqueKey":"items.[INDEX].refundDetails.oneOf.0.blindingKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"Omitted for Liquid, whose lockups the maker mints **unconfidential**\non purpose, so no output blinding key exists to return; and for\nBitcoin, which has no such field.","uniqueKey":"items.[INDEX].refundDetails.oneOf.0.blindingKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.blindingKey","typeLabel":"string | null"},"transaction":{"oneOf":[{"type":"object","description":"Funding outpoint included once the relevant lockup exists.","required":["id","vout"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.transaction.oneOf.0.id","typeLabel":"string"},"vout":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.transaction.oneOf.0.vout","typeLabel":"integer\u003cint32>"}},"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.transaction.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"items.[INDEX].refundDetails.oneOf.0.transaction.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].refundDetails.oneOf.0.transaction","typeLabel":"object | null"}},"uniqueKey":"items.[INDEX].refundDetails.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"items.[INDEX].refundDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].refundDetails","typeLabel":"object | null"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"createdAt":1,"from":"\u003cstring>","id":"\u003cstring>","preimageHash":"\u003cstring>","status":"\u003cstring>","to":"\u003cstring>","type":"submarine","claimDetails":{"keyIndex":1,"lockupAddress":"\u003cstring>","preimageHash":"\u003cstring>","serverPublicKey":"\u003cstring>","timeoutBlockHeight":1,"tree":{"claimLeaf":{"output":"\u003cstring>","version":1},"refundLeaf":{"output":"\u003cstring>","version":1}},"type":"utxo","amount":1,"blindingKey":"\u003cstring>","transaction":{"id":"\u003cstring>","vout":1}},"invoice":"\u003cstring>","refundDetails":{"keyIndex":1,"lockupAddress":"\u003cstring>","serverPublicKey":"\u003cstring>","timeoutBlockHeight":1,"tree":{"claimLeaf":{"output":"\u003cstring>","version":1},"refundLeaf":{"output":"\u003cstring>","version":1}},"type":"utxo","amount":1,"blindingKey":"\u003cstring>","transaction":{"id":"\u003cstring>","vout":1}}}]}},"exampleType":"generated"}},"exampleType":"generated"},"7d92ee5d-321a-4ce2-a7c7-3bc53219c014":{"description":"Invalid XPUB, derivation path, or gap limit.","content":{"application/json":{"schema":{"type":"object","description":"Boltz-shaped error envelope.","required":["error"],"properties":{"error":{"type":"string","description":"Stable machine-readable error code, e.g. `pair_hash_mismatch`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Optional human-readable detail. Present on 4xx; absent on 5xx.","uniqueKey":"details.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional human-readable detail. Present on 4xx; absent on 5xx.","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"10794a81-2e8b-4e9c-8dea-65714d1b67d9":{"description":"Recovery scan safety limit reached.","content":{"application/json":{"schema":{"type":"object","description":"Boltz-shaped error envelope.","required":["error"],"properties":{"error":{"type":"string","description":"Stable machine-readable error code, e.g. `pair_hash_mismatch`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Optional human-readable detail. Present on 4xx; absent on 5xx.","uniqueKey":"details.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional human-readable detail. Present on 4xx; absent on 5xx.","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"363ad570-32d7-4bdc-87d4-3e1554bc0091":{"description":"Database unavailable.","content":{"application/json":{"schema":{"type":"object","description":"Boltz-shaped error envelope.","required":["error"],"properties":{"error":{"type":"string","description":"Stable machine-readable error code, e.g. `pair_hash_mismatch`.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"oneOf":[{"type":"string","description":"Optional human-readable detail. Present on 4xx; absent on 5xx.","uniqueKey":"details.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional human-readable detail. Present on 4xx; absent on 5xx.","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ef808ff2-9e4b-464d-8588-2bdca29ddbbf":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}}},"servers":{"5a853f64-bde2-49c1-8aad-ff97a3fd5e5f":{"url":"https://maker.signet.kaleidoswap.com","description":"Signet (Mutinynet)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"openapi.json"},"subdomain":"kaleidoswap","siteName":"KaleidoSwap Documentation","title":"Restore swaps - KaleidoSwap Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/recovery/restore-swaps","matchLevel":0},"cn":{"href":"/api-reference/recovery/restore-swaps","matchLevel":0}}},"lastModified":"2026-10-28T16:31:00.462Z","originalFileLocation":"api-reference/recovery/restore-swaps.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Find the swaps whose client keys derive from an xpub, with the details needed to claim or refund them. Pass the derivation path your keys use. Does not return swapAuth.\">\u003cmeta data-mint-head name=\"application-name\" content=\"KaleidoSwap Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kaleidoswap/Pdo8Pj4dmhUA96o_/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/kaleidoswap/Pdo8Pj4dmhUA96o_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kaleidoswap/Pdo8Pj4dmhUA96o_/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/kaleidoswap/Pdo8Pj4dmhUA96o_/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/kaleidoswap/Pdo8Pj4dmhUA96o_/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kaleidoswap/Pdo8Pj4dmhUA96o_/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kaleidoswap/Pdo8Pj4dmhUA96o_/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/kaleidoswap/Pdo8Pj4dmhUA96o_/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/kaleidoswap/Pdo8Pj4dmhUA96o_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Restore swaps - KaleidoSwap Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Find the swaps whose client keys derive from an xpub, with the details needed to claim or refund them. Pass the derivation path your keys use. Does not return swapAuth.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"KaleidoSwap Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.kaleidoswap.com/api-reference/recovery/restore-swaps\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kaleidoswap.mintlify.app/_mintlify/api/og/v2?division=Recovery\u0026amp;title=Restore+swaps\u0026amp;description=Find+the+swaps+whose+client+keys+derive+from+an+xpub%2C+with+the+details+needed+to+claim+or+refund+them.+Pass+the+derivation+path+your+keys+use.+Does+not+return+%60\u0026amp;theme=cfe07bcada45289f816a9e3e\u0026amp;signature=6ab37fddc4c9f8a45004b46f721463dbf9b2ee93461f89f2f5f580abb2656971\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Restore swaps - KaleidoSwap Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Find the swaps whose client keys derive from an xpub, with the details needed to claim or refund them. Pass the derivation path your keys use. Does not return swapAuth.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kaleidoswap.mintlify.app/_mintlify/api/og/v2?division=Recovery\u0026amp;title=Restore+swaps\u0026amp;description=Find+the+swaps+whose+client+keys+derive+from+an+xpub%2C+with+the+details+needed+to+claim+or+refund+them.+Pass+the+derivation+path+your+keys+use.+Does+not+return+%60\u0026amp;theme=cfe07bcada45289f816a9e3e\u0026amp;signature=6ab37fddc4c9f8a45004b46f721463dbf9b2ee93461f89f2f5f580abb2656971\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/kaleidoswap/Pdo8Pj4dmhUA96o_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"KaleidoSwap Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.kaleidoswap.com/api-reference/recovery/restore-swaps\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/recovery/restore-swaps.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.kaleidoswap.com/#organization\",\"name\":\"KaleidoSwap Documentation\",\"url\":\"https://docs.kaleidoswap.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kaleidoswap/jZkXeFEXDE4-8PkF/assets/logos/kaleidoswap-full-logo-horizontal-onlight.svg?fit=max\u0026auto=format\u0026n=jZkXeFEXDE4-8PkF\u0026q=85\u0026s=8cf2002b5e2b8ea1cfb0523af2525f09\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.kaleidoswap.com#website\",\"name\":\"KaleidoSwap Documentation\",\"url\":\"https://docs.kaleidoswap.com\",\"publisher\":{\"@id\":\"https://docs.kaleidoswap.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.kaleidoswap.com/api-reference/recovery/restore-swaps#webpage\",\"url\":\"https://docs.kaleidoswap.com/api-reference/recovery/restore-swaps\",\"name\":\"Restore swaps\",\"description\":\"Find the swaps whose client keys derive from an xpub, with the details needed to claim or refund them. Pass the derivation path your keys use. Does not return swapAuth.\",\"dateModified\":\"2026-10-28T16:31:00.462Z\",\"isPartOf\":{\"@id\":\"https://docs.kaleidoswap.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.kaleidoswap.com/api-reference/recovery/restore-swaps#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.kaleidoswap.com/api-reference/recovery/restore-swaps#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"KaleidoSwap Documentation\",\"item\":\"https://docs.kaleidoswap.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Restore swaps\",\"item\":\"https://docs.kaleidoswap.com/api-reference/recovery/restore-swaps\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.kaleidoswap.com/api-reference/recovery/restore-swaps#apireference\",\"headline\":\"Restore swaps\",\"name\":\"Restore swaps\",\"description\":\"Find the swaps whose client keys derive from an xpub, with the details needed to claim or refund them. Pass the derivation path your keys use. Does not return swapAuth.\",\"url\":\"https://docs.kaleidoswap.com/api-reference/recovery/restore-swaps\",\"mainEntityOfPage\":{\"@id\":\"https://docs.kaleidoswap.com/api-reference/recovery/restore-swaps#webpage\"},\"dateModified\":\"2026-10-28T16:31:00.462Z\",\"publisher\":{\"@id\":\"https://docs.kaleidoswap.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.kaleidoswap.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"KaleidoSwap Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"KaleidoSwap Documentation","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":"/whats-kaleidoswap/introduction"}]},{"tab":"Desktop App","pages":[{"title":"Desktop App","href":"/desktop-app/getting-started/introduction"}]},{"tab":"Extensions","pages":[{"title":"Extensions","href":"/extensions/introduction"}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/sdk/introduction"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli/introduction"}]},{"tab":"AI Tools","pages":[{"title":"AI Tools","href":"/ai-tools/introduction"}]},{"tab":"API Reference","groups":[{"group":"Introduction","icon":"flag","pages":[{"title":"Maker API","sidebarTitle":"Overview","href":"/api-reference/introduction"},{"title":"API Conventions","sidebarTitle":"Conventions","href":"/api-reference/getting-started"},{"title":"Swap Flow","sidebarTitle":"Swap Flow","href":"/api-reference/swap-protocol"}]},{"group":"Service","icon":"server","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/health","href":"/api-reference/service/health-check"},{"title":"Get maker info","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/info","href":"/api-reference/service/get-maker-info"},{"title":"Get Lightning nodes","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/nodes","href":"/api-reference/service/get-lightning-nodes"},{"title":"Get maker version","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/version","href":"/api-reference/service/get-maker-version"}]},{"group":"Pairs and quotes","icon":"tags","pages":[{"title":"Get a quote","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/quote","href":"/api-reference/pairs-and-quotes/get-a-quote"},{"title":"List pairs","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/{type}/pairs","href":"/api-reference/pairs-and-quotes/list-pairs"}]},{"group":"Submarine swaps","icon":"bolt","pages":[{"title":"Create a submarine swap","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/submarine","href":"/api-reference/submarine-swaps/create-a-submarine-swap"},{"title":"Get the preimage","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/submarine/{id}/preimage","href":"/api-reference/submarine-swaps/get-the-preimage"},{"title":"Cooperative refund (submarine)","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/submarine/{id}/refund","href":"/api-reference/submarine-swaps/cooperative-refund-submarine"},{"title":"Get the lockup transaction","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/submarine/{id}/transaction","href":"/api-reference/submarine-swaps/get-the-lockup-transaction"}]},{"group":"Reverse swaps","icon":"arrow-rotate-left","pages":[{"title":"Create a reverse swap","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/reverse","href":"/api-reference/reverse-swaps/create-a-reverse-swap"},{"title":"Cooperative claim (reverse)","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/reverse/{id}/claim","href":"/api-reference/reverse-swaps/cooperative-claim-reverse"},{"title":"Abandon a reverse swap","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/reverse/{id}/refund","href":"/api-reference/reverse-swaps/abandon-a-reverse-swap"},{"title":"Get the lockup transaction","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/reverse/{id}/transaction","href":"/api-reference/reverse-swaps/get-the-lockup-transaction"},{"title":"Get the direct payment URI","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/reverse/{invoice}/bip21","href":"/api-reference/reverse-swaps/get-the-direct-payment-uri"}]},{"group":"Chain swaps","icon":"link","pages":[{"title":"Create a chain swap","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/chain","href":"/api-reference/chain-swaps/create-a-chain-swap"},{"title":"Cooperative claim of your lockup","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/chain/{id}/claim","href":"/api-reference/chain-swaps/cooperative-claim-of-your-lockup"},{"title":"Get a re-quote","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/chain/{id}/quote","href":"/api-reference/chain-swaps/get-a-re-quote"},{"title":"Accept a re-quote","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/chain/{id}/quote","href":"/api-reference/chain-swaps/accept-a-re-quote"},{"title":"Cooperative refund (chain)","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/chain/{id}/refund","href":"/api-reference/chain-swaps/cooperative-refund-chain"},{"title":"Get the lockup transactions","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/chain/{id}/transactions","href":"/api-reference/chain-swaps/get-the-lockup-transactions"},{"title":"Accept or reject a re-quote","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/{id}/rate-decision","href":"/api-reference/chain-swaps/accept-or-reject-a-re-quote"}]},{"group":"Swap status","icon":"signal","pages":[{"title":"Get several statuses","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/status","href":"/api-reference/swap-status/get-several-statuses"},{"title":"Get swap status","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/{id}","href":"/api-reference/swap-status/get-swap-status"},{"title":"Status stream (WebSocket)","description":"Upgrades to a WebSocket that streams status updates for the swaps you subscribe to. The envelope is Boltz-compatible:\n\n```json\n→ { \"op\": \"subscribe\", \"channel\": \"swap.update\", \"args\": [\"01J7Q...\"] }\n← { \"event\": \"subscribe\",\"channel\": \"swap.update\", \"args\": [\"01J7Q...\"],\n \"timestamp\": \"1716124800123\" }\n← { \"event\": \"update\", \"channel\": \"swap.update\",\n \"args\": [ { \"id\": \"01J7Q...\", \"status\": \"invoice.set\" } ],\n \"timestamp\": \"1716124800124\" }\n← { \"event\": \"update\", \"channel\": \"swap.update\",\n \"args\": [ { \"id\": \"01J7Q...\", \"status\": \"transaction.confirmed\" } ],\n \"timestamp\": \"1716124800456\" }\n→ { \"op\": \"unsubscribe\", \"channel\": \"swap.update\", \"args\": [\"01J7Q...\"] }\n→ { \"op\": \"ping\" }\n← { \"event\": \"pong\" }\n```","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/ws","href":"/api-reference/swap-status/status-stream-websocket"}]},{"group":"Recovery","icon":"life-ring","pages":[{"title":"Restore swaps","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/restore","href":"/api-reference/recovery/restore-swaps"},{"title":"Get the highest used index","description":"The highest client derivation index used by a stored swap for an xpub, or `-1` when none is found within the gap limit.","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/restore/index","href":"/api-reference/recovery/get-the-highest-used-index"},{"title":"Request a recovery challenge","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/{id}/auth/challenge","href":"/api-reference/recovery/request-a-recovery-challenge"},{"title":"Recover swapAuth","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/{id}/auth/recover","href":"/api-reference/recovery/recover-swapauth"}]},{"group":"Atomic RGB swaps","icon":"atom","pages":[{"title":"List atomic pairs","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/atomic/pairs","href":"/api-reference/atomic-rgb-swaps/list-atomic-pairs"},{"title":"Get an atomic quote","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/atomic/quote","href":"/api-reference/atomic-rgb-swaps/get-an-atomic-quote"},{"title":"Get atomic swap status","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/atomic/{id}","href":"/api-reference/atomic-rgb-swaps/get-atomic-swap-status"},{"title":"Complete the swap","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/atomic/{id}/complete","href":"/api-reference/atomic-rgb-swaps/complete-the-swap"},{"title":"Submit the request","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/atomic/{id}/request","href":"/api-reference/atomic-rgb-swaps/submit-the-request"}]},{"group":"Pay-through","icon":"paper-plane","pages":[{"title":"Create a pay-through order","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/pay","href":"/api-reference/pay-through/create-a-pay-through-order"}]},{"group":"Lightning channels (LSPS1)","icon":"network-wired","pages":[{"title":"Get channel options","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/lsps1/info","href":"/api-reference/lightning-channels-lsps1/get-channel-options"},{"title":"Order a channel","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/lsps1/order","href":"/api-reference/lightning-channels-lsps1/order-a-channel"},{"title":"Get a channel order","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/lsps1/order/{id}","href":"/api-reference/lightning-channels-lsps1/get-a-channel-order"}]},{"group":"Chain data","icon":"cubes","pages":[{"title":"Get fee estimates","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/chain/fees","href":"/api-reference/chain-data/get-fee-estimates"},{"title":"Get chain heights","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/chain/heights","href":"/api-reference/chain-data/get-chain-heights"},{"title":"Get fee estimate for one currency","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/chain/{currency}/fee","href":"/api-reference/chain-data/get-fee-estimate-for-one-currency"},{"title":"Get chain height for one currency","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/chain/{currency}/height","href":"/api-reference/chain-data/get-chain-height-for-one-currency"}]},{"group":"Reference","icon":"book","pages":[{"title":"Maker API FAQ","sidebarTitle":"FAQ","href":"/api-reference/faq"},{"title":"Maker API Errors and Troubleshooting","sidebarTitle":"Troubleshooting","href":"/api-reference/troubleshooting"},{"title":"Maker API: Additional Resources","sidebarTitle":"Additional Resources","href":"/api-reference/additional-resources"}]}]},{"tab":"Wallet Engine","pages":[{"title":"Wallet Engine","href":"/wallet-engine/introduction"}]}],"global":{"anchors":[{"anchor":"Access Extension Beta","icon":"puzzle-piece","href":"https://kaleidoswap.com/products/extension/beta"},{"anchor":"Download Desktop App","icon":"download","href":"https://github.com/kaleidoswap/desktop-app/releases"},{"anchor":"Build with the SDK","icon":"code","href":"/sdk/installation"},{"anchor":"Website","icon":"globe","href":"https://kaleidoswap.com"},{"anchor":"GitHub","icon":"github","href":"https://github.com/kaleidoswap"}]}},{"language":"cn","navbar":{"links":[{"href":"/cn/sdk/installation","label":"构建"}],"primary":{"type":"button","label":"下载应用","href":"https://kaleidoswap.com/products"}},"tabs":[{"tab":"概览","pages":[{"title":"概览","href":"/cn/whats-kaleidoswap/introduction"}]},{"tab":"桌面应用","pages":[{"title":"桌面应用","href":"/cn/desktop-app/getting-started/introduction"}]},{"tab":"浏览器扩展","pages":[{"title":"浏览器扩展","href":"/cn/extensions/introduction"}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/cn/sdk/introduction"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cn/cli/introduction"}]},{"tab":"AI 工具","pages":[{"title":"AI 工具","href":"/cn/ai-tools/introduction"}]},{"tab":"API 参考","groups":[{"group":"简介","icon":"flag","pages":[{"title":"总览","sidebarTitle":"总览","href":"/cn/api-reference/introduction"},{"title":"比特币交换 API:快速开始","sidebarTitle":"快速开始","href":"/cn/api-reference/getting-started"}]},{"group":"指南","icon":"book-open","pages":[{"title":"原子交换协议","sidebarTitle":"交换协议","href":"/cn/api-reference/swap-protocol"}]},{"group":"接口端点","icon":"code","pages":[{"title":"闪电通道订单 API","sidebarTitle":"通道订单","href":"/cn/api-reference/rgb-lsps1-apis"},{"title":"市场 API","href":"/cn/api-reference/market-apis"},{"title":"交换 API","href":"/cn/api-reference/swap-apis"},{"group":"Chain data","pages":[{"title":"Get fee estimates","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/chain/fees","href":"/api-reference/chain-data/get-fee-estimates"},{"title":"Get chain heights","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/chain/heights","href":"/api-reference/chain-data/get-chain-heights"},{"title":"Get fee estimate for one currency","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/chain/{currency}/fee","href":"/api-reference/chain-data/get-fee-estimate-for-one-currency"},{"title":"Get chain height for one currency","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/chain/{currency}/height","href":"/api-reference/chain-data/get-chain-height-for-one-currency"}]},{"group":"Service","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/health","href":"/api-reference/service/health-check"},{"title":"Get maker info","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/info","href":"/api-reference/service/get-maker-info"},{"title":"Get Lightning nodes","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/nodes","href":"/api-reference/service/get-lightning-nodes"},{"title":"Get maker version","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/version","href":"/api-reference/service/get-maker-version"}]},{"group":"Lightning channels (LSPS1)","pages":[{"title":"Get channel options","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/lsps1/info","href":"/api-reference/lightning-channels-lsps1/get-channel-options"},{"title":"Order a channel","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/lsps1/order","href":"/api-reference/lightning-channels-lsps1/order-a-channel"},{"title":"Get a channel order","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/lsps1/order/{id}","href":"/api-reference/lightning-channels-lsps1/get-a-channel-order"}]},{"group":"Pairs and quotes","pages":[{"title":"Get a quote","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/quote","href":"/api-reference/pairs-and-quotes/get-a-quote"},{"title":"List pairs","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/{type}/pairs","href":"/api-reference/pairs-and-quotes/list-pairs"}]},{"group":"Atomic RGB swaps","pages":[{"title":"List atomic pairs","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/atomic/pairs","href":"/api-reference/atomic-rgb-swaps/list-atomic-pairs"},{"title":"Get an atomic quote","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/atomic/quote","href":"/api-reference/atomic-rgb-swaps/get-an-atomic-quote"},{"title":"Get atomic swap status","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/atomic/{id}","href":"/api-reference/atomic-rgb-swaps/get-atomic-swap-status"},{"title":"Complete the swap","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/atomic/{id}/complete","href":"/api-reference/atomic-rgb-swaps/complete-the-swap"},{"title":"Submit the request","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/atomic/{id}/request","href":"/api-reference/atomic-rgb-swaps/submit-the-request"}]},{"group":"Chain swaps","pages":[{"title":"Create a chain swap","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/chain","href":"/api-reference/chain-swaps/create-a-chain-swap"},{"title":"Cooperative claim of your lockup","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/chain/{id}/claim","href":"/api-reference/chain-swaps/cooperative-claim-of-your-lockup"},{"title":"Get a re-quote","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/chain/{id}/quote","href":"/api-reference/chain-swaps/get-a-re-quote"},{"title":"Accept a re-quote","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/chain/{id}/quote","href":"/api-reference/chain-swaps/accept-a-re-quote"},{"title":"Cooperative refund (chain)","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/chain/{id}/refund","href":"/api-reference/chain-swaps/cooperative-refund-chain"},{"title":"Get the lockup transactions","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/chain/{id}/transactions","href":"/api-reference/chain-swaps/get-the-lockup-transactions"},{"title":"Accept or reject a re-quote","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/{id}/rate-decision","href":"/api-reference/chain-swaps/accept-or-reject-a-re-quote"}]},{"group":"Pay-through","pages":[{"title":"Create a pay-through order","description":"Pay an address on another layer from Lightning. The maker returns a hold invoice; once it is paid, the maker sends the payout to `destination` and then settles the hold. Track it with `GET /v2/swap/{id}`. **The payout leg is controlled by the maker, not locked.** Send an `Idempotency-Key` to make retries safe; check `/v2/version` for `pay_through_idempotency_v1` first. Returns `503 pay_through_disabled` when the maker has not enabled it.","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/pay","href":"/api-reference/pay-through/create-a-pay-through-order"}]},{"group":"Recovery","pages":[{"title":"Restore swaps","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/restore","href":"/api-reference/recovery/restore-swaps"},{"title":"Get the highest used index","description":"The highest client derivation index used by a stored swap for an xpub, or `-1` when none is found within the gap limit.","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/restore/index","href":"/api-reference/recovery/get-the-highest-used-index"},{"title":"Request a recovery challenge","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/{id}/auth/challenge","href":"/api-reference/recovery/request-a-recovery-challenge"},{"title":"Recover swapAuth","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/{id}/auth/recover","href":"/api-reference/recovery/recover-swapauth"}]},{"group":"Reverse swaps","pages":[{"title":"Create a reverse swap","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/reverse","href":"/api-reference/reverse-swaps/create-a-reverse-swap"},{"title":"Cooperative claim (reverse)","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/reverse/{id}/claim","href":"/api-reference/reverse-swaps/cooperative-claim-reverse"},{"title":"Abandon a reverse swap","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/reverse/{id}/refund","href":"/api-reference/reverse-swaps/abandon-a-reverse-swap"},{"title":"Get the lockup transaction","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/reverse/{id}/transaction","href":"/api-reference/reverse-swaps/get-the-lockup-transaction"},{"title":"Get the direct payment URI","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/reverse/{invoice}/bip21","href":"/api-reference/reverse-swaps/get-the-direct-payment-uri"}]},{"group":"Swap status","pages":[{"title":"Get several statuses","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/status","href":"/api-reference/swap-status/get-several-statuses"},{"title":"Get swap status","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/{id}","href":"/api-reference/swap-status/get-swap-status"},{"title":"Status stream (WebSocket)","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/ws","href":"/api-reference/swap-status/status-stream-websocket"}]},{"group":"Submarine swaps","pages":[{"title":"Create a submarine swap","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/submarine","href":"/api-reference/submarine-swaps/create-a-submarine-swap"},{"title":"Get the preimage","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/submarine/{id}/preimage","href":"/api-reference/submarine-swaps/get-the-preimage"},{"title":"Cooperative refund (submarine)","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/swap/submarine/{id}/refund","href":"/api-reference/submarine-swaps/cooperative-refund-submarine"},{"title":"Get the lockup transaction","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/swap/submarine/{id}/transaction","href":"/api-reference/submarine-swaps/get-the-lockup-transaction"}]}]},{"group":"参考","icon":"book","pages":[{"title":"比特币交换 API 常见问题","sidebarTitle":"常见问题","href":"/cn/api-reference/faq"},{"title":"交换 API 错误与故障排查","sidebarTitle":"故障排查","href":"/cn/api-reference/troubleshooting"},{"title":"比特币交换 API:更多资源","sidebarTitle":"更多资源","href":"/cn/api-reference/additional-resources"}]}]},{"tab":"钱包引擎","pages":[{"title":"钱包引擎","href":"/cn/wallet-engine/introduction"}]}],"global":{"anchors":[{"anchor":"体验扩展 Beta","icon":"puzzle-piece","href":"https://kaleidoswap.com/products/extension/beta"},{"anchor":"下载桌面应用","icon":"download","href":"https://github.com/kaleidoswap/desktop-app/releases"},{"anchor":"使用 SDK 构建","icon":"code","href":"/cn/sdk/installation"},{"anchor":"官网","icon":"globe","href":"https://kaleidoswap.com"},{"anchor":"GitHub","icon":"github","href":"https://github.com/kaleidoswap"}]}}]},"title":"Restore swaps - KaleidoSwap Documentation","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}