Skip to main content
Sign In
revolution.fanDocs
Get API Key

revolution.fan / docs

Platform Documentation

Everything you need to build on live-event data with real fan identity and door-scan verified attendance.

TypeScript SDKDrop in. Fan graph included.One import gives you verified fan identity, $FAN balance, attendance history, and real-time event context.TypeScript · React Native · Node.jsRead docs Python SDKMarketplace client for Python.Query and subscribe to the Data Marketplace from notebooks, analytics pipelines, and backend services.Python · Jupyter · PandasRead docs Data MarketplaceQuery consented, verified fan profiles.License clean behavioural data segmented by genre, venue, city, and spend. Every row is consent-gated.B2B · Anonymised · Consent-gatedRead docs Seller PortalList your fan data.Submit your first-party fan data schema, have it classified, and publish it to the buyer catalog. Payouts are not built yet.Self-serve · API · No payout yetRead docs Event StreamThe live-event API layer.WebSocket streams for check-ins, drop events, autograph requests, and venue triggers, firing at door-scan.WebSockets · Webhooks · Real-timeRead docs Live StreamingGo live in 60 seconds.Browser-based WebRTC streaming or OBS/RTMP, no external platform. Set a $FAN paywall or stream free.WebRTC · RTMP · $FAN PaywallRead docs

Quick Start

The SDKs are not published to npm or PyPI yet, build them from the monorepo. Full instructions are in the SDK docs.

git clone https://github.com/tokenevents/revolution-fan

# TypeScript / JavaScript  (package name on release: @revolution-fan/sdk)
cd revolution-fan/packages/sdk && npm install && npm run build

# Python  (package name on release: revolution-fan)
pip install -e revolution-fan/sdks/python
import { Revolution } from '@revolution-fan/sdk';

const rev = new Revolution({ apiKey: 'rev_live_xxxx' });

// Discover tonight's events in Austin
const { items } = await rev.events.list({ region: 'atx', featured: true });
console.log(items[0].title); // "Khruangbin at Stubb's"

Get your API key at the developers portal. Free keys include read access to events, artists, and venues. Pro and Enterprise keys unlock commerce, marketplace queries, and the Event Stream.

Try the Sandbox, No Key Required

Want to explore the Data Marketplace before signing up? The public sandbox lets you run live queries against synthetic fan data with no API key.

Open Sandbox

Authentication

All requests require an API key. Three auth schemes are supported depending on key type:

bearerAuthorization: Bearer <key>Fan apps, artist/venue portals, admin
marketplaceX-Marketplace-Key: <key>B2B data buyers: labels, promoters, agencies
scannerX-Scanner-Key: <key>Venue RFID / QR check-in scanners
const rev = new Revolution({
  apiKey: 'rev_live_xxxx',
  authScheme: 'bearer',        // default
  defaultRegion: 'atx',        // optional
  timeout: 10_000,             // ms
});

Base URLs

Productionhttps://api.revolution.fan/api/v1
Staginghttps://revolution-fan-production.up.railway.app/api/v1

Rate Limits

Free1,000 req/dayEvents, venues, artists (read)
Pro50,000 req/day+ Commerce, attendance
Enterprise10,000,000 req/day+ Marketplace, Event Stream, priority support

OpenAPI / Postman

The full OpenAPI 2.0 spec is available at runtime. Import it into Swagger UI or Postman. A ready-made Postman collection covering all endpoints is available in the repo.

# OpenAPI spec
curl https://revolution-fan-production.up.railway.app/api/v1/openapi.yaml

# Postman collection, import from the repo
# docs/postman_collection.json
SDK docs Data MarketplaceGet API key