Ticketlayer SDKs
Ticketlayer ships two official TypeScript SDKs, one per API surface. Both are
generated from the same OpenAPI documents that power the API reference, so
their types always match the contract, and each sends the dated API version
(TL-Version) it was generated against.
Which packages are on npm today
| Package | What | npm |
|---|---|---|
@ticketlayer/backstage | Backstage API client (servers, staff tools, embed loader) | Published, 0.1.x |
@ticketlayer/live | Live API client for browsers, React Native and servers (/server) | Not yet: publishes when its release workflow runs |
@ticketlayer/elements | The tl-* web components | Not yet: same |
@ticketlayer/elements-react | React wrappers for the elements | Not yet: same |
@ticketlayer/backstage-sdk was the old name of the Backstage package and is
no longer maintained; use @ticketlayer/backstage. Until the three Live
packages publish, the browser path that works is the CDN build
(cdn.staging.t9r.dev/v1/ticketlayer.js); see the
HTML quickstart.
Backstage SDK - @ticketlayer/backstage
The server-side SDK for the Backstage API: events, venues, inventory,
sales channels, orders, customers, payments, webhooks, organisations and the
full admin surface. Use it in Node.js backends and internal tooling with an
organisation API key, or in staff apps with a Stagedoor token. It also
carries @ticketlayer/backstage/embed, the loader for Backstage widgets in
your own app.
npm install @ticketlayer/backstage
See the getting started guide and the full reference.
Live SDK - @ticketlayer/live
The buyer-facing SDK for the Live API: sessions, listings, the cart, the
hosted checkout modal, customer sign-in and orders. It runs in the browser
and React Native, publishes itself on window.Ticketlayer for the
Elements, and has a stateless server entry
(@ticketlayer/live/server) for Next.js and edge runtimes.
npm install @ticketlayer/live
See the Next.js quickstart and the full reference.
Reference is auto-generated
These reference pages are generated from each package's TypeScript source
with TypeDoc (npm run docs:sdk:gen in the docs repository) and refreshed
whenever the SDKs are rebuilt.