API.md

# API Documentation

<!--
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/
-->

## Sports Analysis Dataset API

This document describes the data structure and format for the Sports Analysis Dataset.

### Data Structure

#### Video Files
- **Format**: MP4, MOV
- **Resolution**: 1080p/720p
- **Frame Rate**: 30 FPS
- **Location**: `videos/` directory

#### Player Tracking Data

```json
{
"player_id": "string",
"position": {
"x": "number",
"y": "number"
},
"timestamp": "ISO 8601",
"team": "string",
"jersey_number": "number"
}
```

#### Event Annotations

```json
{
"event_type": "goal|foul|substitution|timeout|penalty",
"timestamp": "ISO 8601",
"player_id": "string",
"location": {
"x": "number",
"y": "number"
},
"description": "string"
}
```

#### Performance Metrics

```csv
player_id,distance_covered,speed,acceleration,heart_rate
```

### Usage Examples

#### OpenCV Player Tracking

```python
import cv2
import json

# Load video
cap = cv2.VideoCapture('videos/game_001.mp4')

# Load tracking data
with open('annotations/tracking_001.json') as f:
tracking_data = json.load(f)
```

#### Event Detection

```python
import json

# Load event annotations
with open('annotations/events_001.json') as f:
events = json.load(f)

# Filter by event type
goals = [e for e in events if e['event_type'] == 'goal']
```

## Contact

**RSK World**
- Email: help@rskworld.in
- Phone: +91 93305 39277
- Website: https://rskworld.in/

---

© 2026 RSK World. All rights reserved.