v0.4.2 · stable
⌘K
Getting started

Quickstart · live in 15 minutes

Last updated · 2026-05-12 · v0.4.2 · 8 min read

Prerequisites

  • Node >= 20 — we test against LTS only
  • npm account — the package is published to the public registry
  • API key — grab one from the TradeOS dashboard

Install

terminal
npm i @tradeos/react

Embed the flow

Drop the snippet into any page. The hosted flow loads on demand and renders inside an iframe sized to its container.

index.html
<div id="tradeos-root"></div>
<script
  src="https://cdn.tradeos.app/embed.js"
  data-tenant="YOUR_TENANT_ID"
  data-flow="quote"
  defer
></script>
iNoteThe hosted flow loads on demand — zero render impact until opened.

Configuration

All configuration is done via data-* attributes on the embed script tag.

KeyDescription
data-tenantYour tenant ID from the dashboard. Required.
data-flowFlow type to render: "quote", "booking", or "callback". Defaults to "quote".
data-themeTheme preset: "light", "dark", or "auto". Defaults to "auto".
data-on-completeGlobal callback function name invoked when the flow finishes. Receives a QuoteResult object.
✓TipStart with the hosted flow. Drop a tier when you need more control.
!WarningFinance brokerage requires FCA authorisation or Appointed Representative status.

Where next