// Shows a full-width banner under the navbar: "Private preview" on the v3 pages, // "Partner access" on the RFQ pages, and "Still available" on the v2 pages under /deprecated. // Mintlify loads every .js in the docs root on every page, including the API Reference // pages it generates from an OpenAPI document, which have no MDX to carry a banner. // Exchange Data and the program pages are open to everyone, so they get none. ;(function () { var ID = "site-banner" var root = document.documentElement var LOCK = '' var ARCHIVE = '' var PEOPLE = '' var LP_PROGRAM = 'Liquidity Provider Program' // The invite in mobile-app/src/utils/constants.ts (DISCORD_INVITE_URL). var DISCORD = 'Discord' // style.css shows one wording per banner width so the banner stays on one line. // The breakpoints come from measuring each wording in its font. Change a wording // and remeasure. var BANNERS = [ { kind: "preview", path: /^\/(index)?$|^\/api\/|^\/api-reference\/(catalog|authentication|accounts|execution|streaming|throttle)\//, icon: LOCK, label: "Private preview", long: "The v3 API is open to select members. We’ll announce public availability by email and in " + DISCORD + ".", medium: "Open to select members. Updates by email and in " + DISCORD + ".", short: "Open to select members.", }, { kind: "rfq", path: /^\/api-reference\/rfq(\/|$)|^\/fees\/?$/, icon: PEOPLE, label: "Partner access", long: "RFQ is available only to select partners in our " + LP_PROGRAM + ".", medium: "Only for select partners in our " + LP_PROGRAM + ".", short: "Liquidity Provider Program only.", }, { kind: "legacy", path: /^\/deprecated(\/|$)/, icon: ARCHIVE, label: "Still available", long: "The v2 API is not being sunset and remains available for use for the foreseeable future.", medium: "Not being sunset. Available for the foreseeable future.", short: "Not being sunset.", }, ] function build(b) { var banner = document.createElement("div") banner.id = ID banner.setAttribute("role", "note") banner.setAttribute("data-kind", b.kind) banner.innerHTML = '" return banner } // Mintlify's layout makes room for a site banner when // and --banner-height are set: the content padding, the sidebar offset, and the sticky // API example panel all shift. The panel's shift is a fixed 2.5rem, so style.css holds // the banner to that height. Mintlify sets the state to "hidden" when docs.json has no // banner, so the state is reasserted whenever it changes. function setState(visible) { var state = visible ? "visible" : "hidden" if (root.getAttribute("data-banner-state") !== state) root.setAttribute("data-banner-state", state) if (visible) root.style.setProperty("--banner-height", "2.5rem") else root.style.removeProperty("--banner-height") } function sync() { var path = window.location.pathname var wanted = BANNERS.filter(function (b) { return b.path.test(path) })[0] var existing = document.getElementById(ID) var navbar = document.getElementById("navbar") if (!wanted) { if (existing) existing.remove() setState(false) return } if (!navbar) return setState(true) var current = existing && existing.getAttribute("data-kind") === wanted.kind && existing.parentElement === navbar && navbar.lastElementChild === existing if (current) return if (existing) existing.remove() navbar.appendChild(build(wanted)) } // Mintlify navigates client-side and re-renders on each page, so the banner is // re-checked on every DOM change rather than once on load. new MutationObserver(sync).observe(root, { childList: true, subtree: true, attributes: true, attributeFilter: ["data-banner-state"], }) window.addEventListener("popstate", sync) sync() })()

Query Parameters

Response