Guide

Getting Started with VenueOS

VenueOS provides a comprehensive API for venue revenue optimization. This guide walks you through setup, data ingestion, and your first simulation.

1

Install

pip install venueos

2

Initialize Client

from venueos import VenueOS

client = VenueOS(
    api_key="vos_live_...",
    venue="ubs-arena"
)

3

Ingest Data

client.ingest(
    tickets="data/tickets.csv",
    pos="data/pos.csv",
    crm="data/crm.csv",
    staffing="data/staffing.csv"
)

4

Run Simulation

results = client.simulate(
    pricing=0.8,
    staffing=0.6,
    inventory=0.5,
    promo=0.3
)
print(f"Projected Revenue: ${results.total_revenue:,.0f}")

API Reference

Core endpoints for the VenueOS platform.

GET /api/games List all events

GET /api/game/{id} Event details with sections

POST /api/simulate Run simulation

GET /api/recommendations Get AI recommendations

POST /api/calibration/run Trigger calibration

GET /api/fan-predict/pools Prediction markets

WS /api/ws/telemetry Live telemetry stream

VENUEOS CSV Schemas

Standard data formats accepted by the VenueOS ingest pipeline.

tickets.csv

# Ticket transaction records
timestamp, section, fan_id, price, event_id, zone, row

pos.csv

# Point-of-sale transactions
timestamp, section, item_type, amount, stand_id, quantity

crm.csv

# Customer relationship data
fan_id, segment, ltv, churn_risk, games_attended

staffing.csv

# Staffing deployment records
section, role, count, date, hourly_cost

Simulation Engine

The VenueOS Monte Carlo simulation engine generates revenue projections by modeling fan behavior, staffing efficiency, and pricing elasticity across all venue sections. Configure simulations with four primary control parameters: pricing aggressiveness, staffing density, inventory allocation, and promotional intensity.

Recommendations

AI-generated recommendations follow a controlled lifecycle: submit, review, approve, execute, and reconcile. The control plane enforces role-based access, freshness windows, and immutable audit trails for every recommendation action.

WebSocket

Connect to the live telemetry stream for real-time venue data including section occupancy, POS transaction velocity, and staffing utilization.

const ws = new WebSocket("wss://api.venueos.ai/api/ws/telemetry");

ws.onmessage = (event) => {
    const pulse = JSON.parse(event.data);
    console.log(pulse.section, pulse.occupancy);
};

Authentication

All API requests require a bearer token passed in the Authorization header. Tokens are scoped to specific venues and enforce role-based access control as defined in the shared authorization policy.

Authorization: Bearer vos_live_sk_...