API Overview

The Virtual Stadium API provides programmatic access to channel management, moderation features, and integration capabilities. Use these endpoints to create channels, manage user permissions, and integrate Virtual Stadium functionality into your applications.

#What Is the Virtual Stadium API?

The Virtual Stadium API is a RESTful service that enables you to:

• Create and manage chat channels programmatically for live events
• Integrate moderation features into your existing systems
• Handle user authentication and authorization
• Access real-time messaging capabilities for sporting events
• Configure channel hierarchies and relationships
• Manage event-driven notifications and triggers

#Getting Started

Before making API calls, ensure you have:

1. Valid JWT token with appropriate permissions
2. API access enabled for your organization
3. Base URL and endpoint information
4. Understanding of your integration requirements

#Base URLs and Environment

#Available API Categories

#1. Channel Management

Create, update, and manage chat channels for live events and ongoing discussions.

Key Features:

• Single and batch channel creation
• Channel hierarchy management
• Event-driven messaging configuration
• Expiration and lifecycle management

Main Endpoints:

• POST /channel/create - Create single channel
• POST /channel/create/batch - Create multiple channels
• PUT /channel/{id} - Update channel configuration
• DELETE /channel/{id} - Delete channel

#2. User Management

Handle user authentication, permissions, and role assignments.

Key Features:

• JWT-based authentication
• Role-based access control
• User profile management
• Organization-level permissions

#3. Moderation Operations

Content filtering, message moderation, and user actions.

Key Features:

• Real-time message moderation
• Automated content filtering
• Manual moderation workflows
• User ban and restriction management

#4. Analytics and Reporting

Access insights and analytics data for channels and user activity.

Key Features:

• Channel activity metrics
• User engagement statistics
• Message volume analytics
• Export capabilities

#Data Format and Standards

#Request/Response Format

• Content-Type: application/json
• Character Encoding: UTF-8
• Date Format: Unix timestamps for datetime fields
• ID Format: String identifiers with specific validation rules

#Validation Rules

• Channel IDs: Maximum 128 characters, alphanumeric and specific punctuation
• Required Fields: All endpoints specify required vs optional parameters
• Data Types: Strict typing for all request parameters

#Error Handling

The API uses standard HTTP status codes and provides structured error responses:

{
    "success": false,
    "error": "Error category description",
    "details": "Specific error details",
    "code": "ERROR_CODE"
}

Common Error Scenarios:

• 400 Bad Request: Invalid request parameters or format
• 401 Unauthorized: Missing or invalid authentication
• 403 Forbidden: Insufficient permissions for operation
• 404 Not Found: Requested resource does not exist

#Interactive Documentation

Explore the complete API specification with interactive examples:

Swagger UI Documentation →

The interactive documentation includes:

• Complete endpoint specifications
• Request/response examples
• Authentication testing capabilities
• Parameter validation

#Support and Resources

#Documentation

• Authentication Guide - JWT setup and validation
• Channel Creation - Detailed endpoint documentation
• Integration Examples - Complete integration workflows
• Getting Identifiers - How to obtain Sportradar entity IDs

#Technical Support

• Integration Support: Contact the Virtual Stadium development team
• Custom Features: Discuss enterprise features and customizations

#Best Practices

• Use descriptive identifiers for easier debugging
• Implement proper error handling and retry logic
• Test with non-production channels before going live