help@rskworld.in +91 93305 39277
RSK World
  • Home
  • Development
    • Web Development
    • Mobile Apps
    • Software
    • Games
    • Project
  • Technologies
    • Data Science
    • AI Development
    • Cloud Development
    • Blockchain
    • Cyber Security
    • Dev Tools
    • Testing Tools
  • Blog
  • About
  • Contact

Theme Settings

Color Scheme
Display Options
Font Size
100%
Back to Project
RSK World
sports-analysis
RSK World
sports-analysis
Sports Analysis Dataset - Game Footage + Player Tracking + Event Annotations + OpenCV + Video Analysis
sports-analysis
  • .github
  • assets
  • data
  • docs
  • examples
  • scripts
  • .gitignore577 B
  • ADVANCED_FEATURES.md7.1 KB
  • CHANGELOG.md3.5 KB
  • CONTRIBUTING.md1 KB
  • DATA_SUMMARY.md4.1 KB
  • ERROR_CHECK_REPORT.md3.6 KB
  • GITHUB_RELEASE_GUIDE.md4.3 KB
  • LICENSE1.3 KB
  • PROJECT_SUMMARY.md3.8 KB
  • README.md2.7 KB
  • RELEASE_NOTES.md5.6 KB
  • api.html10.3 KB
  • config.json1.6 KB
  • dashboard.html9.6 KB
  • explorer.html8.8 KB
  • index.html95.9 KB
  • package.json1.3 KB
  • server.js7.9 KB
  • sports-analysis.png2.7 MB
  • sports-analysis.zip13.6 KB
  • sports-analysis.zip.info514 B
api.html
api.html
Raw Download
Find: Go to:
<!DOCTYPE html>
<html lang="en">
<head>
    <!--
    RSK World
    Founder: Molla Samser
    Designer & Tester: Rima Khatun
    Email: help@rskworld.in
    Phone: +91 93305 39277
    Address: Nutanhat, Mongolkote, Purba Burdwan, West Bengal, India, 713147
    Website: https://rskworld.in/
    -->
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>API Documentation - Sports Analysis Dataset | RSK World</title>
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css">
    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css" rel="stylesheet">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/themes/prism.min.css">
    <link rel="stylesheet" href="assets/css/style.css">
</head>
<body>
    <!--
    RSK World
    Founder: Molla Samser
    Designer & Tester: Rima Khatun
    Email: help@rskworld.in
    Phone: +91 93305 39277
    Address: Nutanhat, Mongolkote, Purba Burdwan, West Bengal, India, 713147
    Website: https://rskworld.in/
    -->
    <nav class="navbar navbar-expand-lg navbar-dark bg-dark">
        <div class="container-fluid">
            <a class="navbar-brand" href="index.html">
                <i class="fas fa-video text-secondary"></i> RSK World
            </a>
            <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav">
                <span class="navbar-toggler-icon"></span>
            </button>
            <div class="collapse navbar-collapse" id="navbarNav">
                <ul class="navbar-nav ms-auto">
                    <li class="nav-item">
                        <a class="nav-link" href="index.html">Home</a>
                    </li>
                    <li class="nav-item">
                        <a class="nav-link" href="dashboard.html">Dashboard</a>
                    </li>
                    <li class="nav-item">
                        <a class="nav-link" href="explorer.html">Data Explorer</a>
                    </li>
                    <li class="nav-item">
                        <a class="nav-link active" href="api.html">API</a>
                    </li>
                </ul>
            </div>
        </div>
    </nav>

    <div class="container mt-4 mb-5">
        <div class="row">
            <div class="col-12">
                <h1 class="mb-4"><i class="fas fa-code text-primary"></i> REST API Documentation</h1>
                <p class="lead">Programmatic access to the Sports Analysis Dataset through RESTful API endpoints.</p>
            </div>
        </div>

        <!-- Base URL -->
        <div class="card mb-4">
            <div class="card-header bg-primary text-white">
                <h5 class="mb-0">Base URL</h5>
            </div>
            <div class="card-body">
                <code>http://localhost:3000/api</code>
                <p class="mt-2 mb-0 text-muted">All API endpoints are relative to this base URL.</p>
            </div>
        </div>

        <!-- Endpoints -->
        <div class="card mb-4">
            <div class="card-header bg-success text-white">
                <h5 class="mb-0">GET /api/games</h5>
            </div>
            <div class="card-body">
                <p>Retrieve all games in the dataset.</p>
                <h6>Response:</h6>
                <pre><code class="language-json">{
  "success": true,
  "count": 2,
  "data": [
    {
      "game_id": "game_001",
      "sport": "Football",
      "date": "2026-01-15",
      "venue": "Stadium A",
      "duration_minutes": 90
    }
  ]
}</code></pre>
            </div>
        </div>

        <div class="card mb-4">
            <div class="card-header bg-info text-white">
                <h5 class="mb-0">GET /api/games/:gameId</h5>
            </div>
            <div class="card-body">
                <p>Get detailed information about a specific game.</p>
                <h6>Parameters:</h6>
                <ul>
                    <li><code>gameId</code> - The ID of the game (e.g., "game_001")</li>
                </ul>
                <h6>Response:</h6>
                <pre><code class="language-json">{
  "success": true,
  "data": {
    "game_id": "game_001",
    "sport": "Football",
    "date": "2026-01-15",
    "venue": "Stadium A",
    "teams": {
      "team_a": "Team Red",
      "team_b": "Team Blue"
    }
  }
}</code></pre>
            </div>
        </div>

        <div class="card mb-4">
            <div class="card-header bg-warning text-white">
                <h5 class="mb-0">GET /api/events</h5>
            </div>
            <div class="card-body">
                <p>Retrieve all events with optional filtering.</p>
                <h6>Query Parameters:</h6>
                <ul>
                    <li><code>gameId</code> - Filter by game ID</li>
                    <li><code>eventType</code> - Filter by event type (goal, foul, etc.)</li>
                    <li><code>sport</code> - Filter by sport</li>
                </ul>
                <h6>Example:</h6>
                <code>GET /api/events?gameId=game_001&eventType=goal</code>
            </div>
        </div>

        <div class="card mb-4">
            <div class="card-header bg-danger text-white">
                <h5 class="mb-0">GET /api/tracking/:gameId</h5>
            </div>
            <div class="card-body">
                <p>Get player tracking data for a specific game.</p>
                <h6>Parameters:</h6>
                <ul>
                    <li><code>gameId</code> - The ID of the game</li>
                </ul>
            </div>
        </div>

        <div class="card mb-4">
            <div class="card-header bg-secondary text-white">
                <h5 class="mb-0">GET /api/stats</h5>
            </div>
            <div class="card-body">
                <p>Get aggregated statistics for the dataset.</p>
                <h6>Response:</h6>
                <pre><code class="language-json">{
  "success": true,
  "stats": {
    "total_games": 2,
    "total_events": 7,
    "total_players": 16,
    "sports": ["Football", "Basketball"]
  }
}</code></pre>
            </div>
        </div>

        <!-- Code Examples -->
        <div class="card mb-4">
            <div class="card-header bg-dark text-white">
                <h5 class="mb-0"><i class="fas fa-code"></i> Code Examples</h5>
            </div>
            <div class="card-body">
                <h6>JavaScript (Fetch API)</h6>
                <pre><code class="language-javascript">// Get all games
fetch('http://localhost:3000/api/games')
  .then(response => response.json())
  .then(data => console.log(data));

// Get specific game
fetch('http://localhost:3000/api/games/game_001')
  .then(response => response.json())
  .then(data => console.log(data));

// Get events with filters
fetch('http://localhost:3000/api/events?eventType=goal&sport=Football')
  .then(response => response.json())
  .then(data => console.log(data));</code></pre>

                <h6 class="mt-4">Python (requests)</h6>
                <pre><code class="language-python">import requests

# Get all games
response = requests.get('http://localhost:3000/api/games')
games = response.json()
print(games)

# Get specific game
response = requests.get('http://localhost:3000/api/games/game_001')
game = response.json()
print(game)

# Get filtered events
params = {'eventType': 'goal', 'sport': 'Football'}
response = requests.get('http://localhost:3000/api/events', params=params)
events = response.json()
print(events)</code></pre>

                <h6 class="mt-4">cURL</h6>
                <pre><code class="language-bash"># Get all games
curl http://localhost:3000/api/games

# Get specific game
curl http://localhost:3000/api/games/game_001

# Get filtered events
curl "http://localhost:3000/api/events?eventType=goal&sport=Football"</code></pre>
            </div>
        </div>

        <!-- API Server Info -->
        <div class="alert alert-info">
            <h5><i class="fas fa-info-circle"></i> Running the API Server</h5>
            <p>To use the API, start the Node.js server:</p>
            <pre><code class="language-bash">npm install
node server.js</code></pre>
            <p class="mb-0">The API will be available at <code>http://localhost:3000/api</code></p>
        </div>
    </div>

    <footer class="bg-dark text-white py-4 mt-5">
        <div class="container">
            <div class="row">
                <div class="col-md-6">
                    <h5><i class="fas fa-video text-secondary"></i> Sports Analysis Dataset</h5>
                    <p class="mb-0">RESTful API for programmatic data access.</p>
                </div>
                <div class="col-md-6 text-md-end">
                    <p class="mb-1"><strong>RSK World</strong></p>
                    <p class="mb-1">
                        <i class="fas fa-envelope"></i> help@rskworld.in<br>
                        <i class="fas fa-phone"></i> +91 93305 39277<br>
                        <i class="fas fa-globe"></i> <a href="https://rskworld.in/" class="text-white">rskworld.in</a>
                    </p>
                </div>
            </div>
            <hr class="my-3">
            <div class="text-center">
                <p class="mb-0">
                    &copy; 2026 RSK World. All rights reserved. | 
                    Founder: Molla Samser | Designer & Tester: Rima Khatun
                </p>
            </div>
        </div>
    </footer>

    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/prism.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/components/prism-json.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/components/prism-javascript.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/components/prism-python.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/components/prism-bash.min.js"></script>
</body>
</html>
275 lines•10.3 KB
markup

About RSK World

Founded by Molla Samser, with Designer & Tester Rima Khatun, RSK World is your one-stop destination for free programming resources, source code, and development tools.

Founder: Molla Samser
Designer & Tester: Rima Khatun

Development

  • Game Development
  • Web Development
  • Mobile Development
  • AI Development
  • Development Tools

Legal

  • Terms & Conditions
  • Privacy Policy
  • Disclaimer

Contact Info

Nutanhat, Mongolkote
Purba Burdwan, West Bengal
India, 713147

+91 93305 39277

hello@rskworld.in
support@rskworld.in

© 2026 RSK World. All rights reserved.

Content used for educational purposes only. View Disclaimer