Skip to content
TixFin

Developers

Build with the TixFin API

A read-only REST API with typed schemas, an OpenAPI spec and official clients — for pulling events, tickets and orders into your own systems.

Where you build

Environment Modes

  • 01

    Develop

    Internal developer environment for fast iteration and permissive testing.

  • 02

    Beta

    Public testing environment with isolated infrastructure, bug reporting, and blocked live sales.

  • 03

    Staging

    Production-like pre-release environment with billing-governed plan changes instead of instant switching.

  • 04

    Prod

    Live platform for real customers, real activations, and monthly billing in production.

Quick start

First Sync in Minutes

Create an API key for your project, pick the endpoint groups it may read, and pull events, the ticket catalog, tickets and orders. The API is designed for quick integration.

  • OpenAPI documented
  • Typed responses
example.tsTypeScript
import { TixfinPartnerClient } from "@tixfin/partner-api-client";

const client = new TixfinPartnerClient({
  projectId: "YOUR_PROJECT_ID",
  apiKey: "YOUR_API_KEY", // "prefix.secret"
});

const events = await client.listEvents({ page: 0, size: 20 });
const event = await client.getEvent(events.items[0].id);

const tickets = await client.listTickets({
  eventId: event.id,
  status: "PAID",
});
// tickets.items, tickets.total, tickets.page, tickets.size

Clients

REST API with OpenAPI Spec

Use an official client, generate your own from the spec, or call the endpoints with any HTTP client.

  • @tixfin/partner-api-client

    TypeScript / JavaScript

    Official client with full types, paginated list methods and a typed error class. Ships as ESM and CommonJS.

  • tixfin-partner-api

    Python

    Official client with the same four resources and the same error model.

  • OpenAPI 3

    OpenAPI

    The machine-readable spec behind both clients — generate a client in the language you work in.

  • cURL · REST

    Any HTTP client

    Plain JSON over HTTPS with an API key header. No SDK required.

Everything else

Developer Resources

Start Building Today

Request Partner API access for your project, or start free in the beta.