The Suave JS SDK is a lightweight library that allows you to integrate Suave’s cross-chain swap functionality directly into your application.The SDK encapsulates the logic for fetching the cheapest cross-chain swap routes and executing these swaps. While the Routing API can retreive these routes, the SDK is the best method for executing on those routes.The Suave SDK includes UI components, React hooks, pure JS helper functions and everything you need to make communication with our APIs a breeze.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Suave Docs","colors":{"primary":"#7F56D9","light":"#07C983","dark":"#07C983"},"favicon":"/favicon.svg","logo":{"light":"https://mintcdn.com/suave/tjkg_y2xg-GO4Glm/logo/light.svg?fit=max\u0026auto=format\u0026n=tjkg_y2xg-GO4Glm\u0026q=85\u0026s=a5a14b2e64ebbcb9c977644fb1d2b0f9","dark":"https://mintcdn.com/suave/tjkg_y2xg-GO4Glm/logo/dark.svg?fit=max\u0026auto=format\u0026n=tjkg_y2xg-GO4Glm\u0026q=85\u0026s=5d7ca245acdc634ea51df18024fcccda"},"api":{"openapi":["openapi.yml"]},"footer":{"socials":{"twitter":"https://twitter.com/@suave_money_","github":"https://github.com/suave-money","linkedin":"https://www.linkedin.com/company/suavemoney/"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"suave","hasAudioNarration":false,"actualSubdomain":"suave","customDomains":["docs.suave.money"],"gitSource":{"type":"github","owner":"suave-money","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c4baa72b99776ad7d4f2","collectionId":"d370e4f2-2626-437c-879d-401d5cf7f0bb","schemaVersion":"v2"},"entitlements":{},"buildId":"6a20c4baa72b99776ad7d4f2:success","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Documentation","count":26},{"language":"default","tag":"Suave Checkout","count":20},{"language":"default","tag":"API Documentation","count":10},{"language":"default","tag":"SDK Documentation","count":8},{"language":"default","tag":"Suave Aggregator","count":6},{"language":"default","tag":"Payment webhooks","count":4},{"language":"default","tag":"Functionality","count":4},{"language":"default","tag":"Routing","count":3},{"language":"default","tag":"SDK Guide","count":3},{"language":"default","tag":"Payment API","count":2}]},"assistantConfig":{},"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":"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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"table{width:100%}tbody,thead{width:100%;display:table}th{text-align:left}"}],"page":{"pagePath":"checkout.suave.money/sdk/overview","slug":"/checkout.suave.money/sdk/overview","pageMetadata":{"title":null,"description":null,"href":"/checkout.suave.money/sdk/overview","hidden":false},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`suave-sdk`,children:`Suave SDK`}),`\n`,_jsx(_components.p,{children:`The Suave JS SDK is a lightweight library that allows you to integrate Suave’s cross-chain swap functionality directly into your application.`}),`\n`,_jsxs(_components.p,{children:[`The SDK encapsulates the logic for fetching the cheapest cross-chain swap routes and executing these swaps. While the `,_jsx(_components.strong,{children:`Routing API`}),` can retreive these routes, the SDK is the best method for executing on those routes.`]}),`\n`,_jsx(_components.p,{children:`The Suave SDK includes UI components, React hooks, pure JS helper functions and everything you need to make communication with our APIs a breeze.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":null,"description":null,"href":"/checkout.suave.money/sdk/overview","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Suave SDK","slug":"suave-sdk","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"suave","siteName":"Suave Docs","title":"Overview - Suave Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-08T00:30:45.705Z","originalFileLocation":"checkout.suave.money/sdk/overview.mdx"},"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=\"application-name\" content=\"Suave Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/suave/V4Iuedio_MWCEOt1/_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/suave/V4Iuedio_MWCEOt1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/suave/V4Iuedio_MWCEOt1/_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/suave/V4Iuedio_MWCEOt1/_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/suave/V4Iuedio_MWCEOt1/_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/suave/V4Iuedio_MWCEOt1/_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/suave/V4Iuedio_MWCEOt1/_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/suave/V4Iuedio_MWCEOt1/_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/suave/V4Iuedio_MWCEOt1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Overview - Suave Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Suave Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.suave.money/checkout.suave.money/sdk/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://suave.mintlify.app/_mintlify/api/og/v2?division=SDK+Documentation\u0026amp;title=Overview\u0026amp;theme=c54b1b36b1535e313191935e\u0026amp;signature=4a6b675a0464f1f1e63da394c03c70453a34d073c4e0aef05c1692828f37831e\">\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=\"Overview - Suave Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://suave.mintlify.app/_mintlify/api/og/v2?division=SDK+Documentation\u0026amp;title=Overview\u0026amp;theme=c54b1b36b1535e313191935e\u0026amp;signature=4a6b675a0464f1f1e63da394c03c70453a34d073c4e0aef05c1692828f37831e\">\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/suave/V4Iuedio_MWCEOt1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Suave Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7F56D9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.suave.money/checkout.suave.money/sdk/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/checkout.suave.money/sdk/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.suave.money/#organization\",\"name\":\"Suave Docs\",\"url\":\"https://docs.suave.money\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/suave/tjkg_y2xg-GO4Glm/logo/light.svg?fit=max\u0026auto=format\u0026n=tjkg_y2xg-GO4Glm\u0026q=85\u0026s=a5a14b2e64ebbcb9c977644fb1d2b0f9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.suave.money#website\",\"name\":\"Suave Docs\",\"url\":\"https://docs.suave.money\",\"publisher\":{\"@id\":\"https://docs.suave.money/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.suave.money/checkout.suave.money/sdk/overview#webpage\",\"url\":\"https://docs.suave.money/checkout.suave.money/sdk/overview\",\"name\":\"Overview\",\"dateModified\":\"2026-02-08T00:30:45.705Z\",\"isPartOf\":{\"@id\":\"https://docs.suave.money#website\"},\"breadcrumb\":{\"@id\":\"https://docs.suave.money/checkout.suave.money/sdk/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.suave.money/checkout.suave.money/sdk/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Suave Checkout\",\"item\":\"https://docs.suave.money/checkout.suave.money/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Overview\",\"item\":\"https://docs.suave.money/checkout.suave.money/sdk/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.suave.money/checkout.suave.money/sdk/overview#article\",\"headline\":\"Overview\",\"name\":\"Overview\",\"url\":\"https://docs.suave.money/checkout.suave.money/sdk/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.suave.money/checkout.suave.money/sdk/overview#webpage\"},\"dateModified\":\"2026-02-08T00:30:45.705Z\",\"publisher\":{\"@id\":\"https://docs.suave.money/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.suave.money#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Suave Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Suave Docs","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Suave Aggregator","pages":[{"title":"Overview","href":"/suave.ag/overview"},{"group":"SDK Guide","pages":[{"title":"Installation","href":"/suave.ag/sdk/install"},{"title":"Request Routes \u0026 Quotes","href":"/suave.ag/sdk/request"},{"title":"Execute Routes \u0026 Quotes","href":"/suave.ag/sdk/execute"}]},{"group":"API Reference","pages":[{"title":"Cross-chain swap routes","openapi":"POST /v1/routes","href":"/suave.ag/api/routes"},{"title":"Get supported tokens","openapi":"GET /v1/tokens","href":"/suave.ag/api/get-tokens"}]}]},{"group":"Suave Checkout","pages":[{"title":"Introduction","href":"/checkout.suave.money/introduction"},{"title":"Use Cases","href":"/checkout.suave.money/use-cases"},{"group":"API Documentation","pages":[{"title":"Authentication","href":"/checkout.suave.money/api/authentication"},{"title":"Data types","href":"/checkout.suave.money/api/data-types"},{"group":"Quote API","pages":[{"title":null,"href":"/checkout.suave.money/api/quote/overview"},{"title":"Get Routing","openapi":"GET /api/v1/quote","href":"/checkout.suave.money/api/quote/get"}]},{"group":"Payment API","pages":[{"title":"Create Payment Link","openapi":"POST /api/v1/payment_link","href":"/checkout.suave.money/api/endpoint/create"},{"title":"Get Payment Order","openapi":"GET /api/v1/payment/{id}","href":"/checkout.suave.money/api/endpoint/get"}]},{"group":"Payment webhooks","pages":[{"title":null,"href":"/checkout.suave.money/api/webhook/overview"},{"title":"Get Webhooks","openapi":"GET /api/v1/webhook_subscription","href":"/checkout.suave.money/api/webhook/get"},{"title":"Create Webhook","openapi":"POST /api/v1/webhook_subscription","href":"/checkout.suave.money/api/webhook/create"},{"title":"Delete Webhook","openapi":"DELETE /api/v1/webhook_subscription/{id}","description":"Delete a webhook subscription with the given ID.","href":"/checkout.suave.money/api/webhook/delete"}]}]},{"group":"SDK Documentation","pages":[{"title":null,"href":"/checkout.suave.money/sdk/overview"},{"title":null,"description":null,"href":"/checkout.suave.money/sdk/getting-started"},{"group":"Functionality","pages":[{"group":"Routing","pages":[{"title":null,"href":"/checkout.suave.money/sdk/get-routes"},{"title":null,"href":"/checkout.suave.money/sdk/get-routes-streaming"},{"title":null,"href":"/checkout.suave.money/sdk/execute-route"}]},{"title":null,"href":"/checkout.suave.money/sdk/quotes"}]},{"group":"React","pages":[{"title":null,"href":"/checkout.suave.money/sdk/hooks"},{"title":null,"href":"/checkout.suave.money/sdk/components"}]}]}]}]},{"anchor":"Demo","href":"https://checkout.suave.money/demo","icon":"computer-classic"},{"anchor":"Contact us","href":"mailto:team@suave.money","icon":"envelope"}]},"basePath":"","title":"Overview - Suave Docs","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":[],"chunks":[]}
