API Documentation - TournamentPro

Documentation

Filters:

# 🚀 TournamentPro API Documentation

Welcome to the **TournamentPro** API documentation. This guide provides all the necessary technical details for developers to integrate with our tournament ecosystem, live scoring, advertisement tracking, and payment systems.

---

## 🔐 Authentication

### Public Access
Most read-only and tracking endpoints are public and do not require an API key to ensure maximum speed and compatibility.
- **Type:** `Unauthenticated`
- **Throttling:** 60 requests per minute per IP.

### Authorized Access
Organizer-specific analytics and management APIs require an **API Token**. 
- **Type:** `Authenticated`
- **Available for:** Pro and Enterprise plans.
- **Header:** `Authorization: Bearer YOUR_TOKEN`.

---

## 🏆 Tournament & Match APIs
*Module: Tournament*

### 1. Fetch Live Match Data
- **Endpoint:** `/matches/{match_id}/data`
- **Method:** `GET`
- **Auth:** `Public (Unauthenticated)`
- **Description:** Returns the current state of a match, including scores for both teams, current striker/bowler, and a chronological list of events (wickets, runs, etc.).
- **Response Format:**
```json
{
    "status": "live",
    "team1_score": 145,
    "team2_score": 112,
    "team1_wickets": 4,
    "team2_wickets": 8,
    "current_striker": "John Doe",
    "current_bowler": "Jane Smith",
    "events": [
        {
            "id": 1,
            "type": "RUNS",
            "description": "4 runs scored by John Doe",
            "time": "12:45",
            "team_side": "team1",
            "value": "+4"
        }
    ]
}
```

---

## 📊 Advertisement Tracking API
*Module: Advertising*

### 1. Record Impression
- **Endpoint:** `/api/ads/track/impression`
- **Method:** `POST`
- **Auth:** `Public (Unauthenticated)`
- **Payload:**
```json
{
    "campaign_id": 123,
    "creative_id": 456,
    "user_agent": "Mozilla/5.0...",
    "referrer": "https://example.com"
}
```

### 2. Record Click
- **Endpoint:** `/api/ads/track/click`
- **Method:** `POST`
- **Auth:** `Public (Unauthenticated)`
- **Payload:**
```json
{
    "campaign_id": 123,
    "creative_id": 456,
    "user_agent": "Mozilla/5.0..."
}
```

### 3. Record Conversion
- **Endpoint:** `/api/ads/track/conversion`
- **Method:** `POST`
- **Auth:** `Public (Unauthenticated)`
- **Payload:**
```json
{
    "campaign_id": 123,
    "conversion_value": 1500.00,
    "conversion_type": "registration"
}
```

---

## 📈 Analytics API
*Module: Analytics*

### Get Campaign Performance
- **Endpoint:** `/api/ads/campaigns/{campaign_id}/analytics`
- **Method:** `GET`
- **Auth:** `Private (Authenticated)`
- **Response:**
```json
{
    "impressions": 1500,
    "clicks": 120,
    "ctr": "8.00%",
    "conversions": 15,
    "revenue": 4500.00
}
```

---

## ⚓ Webhooks (Payment Integration)
*Module: Payments*

### 💳 Stripe Webhook
- **Endpoint:** `/api/payments/stripe/webhook`
- **Method:** `POST`
- **Auth:** `Unauthenticated (Secure Signatures)`
- **Events:** `checkout.session.completed`, `payment_intent.succeeded`

### 📱 PhonePe Webhook
- **Endpoint:** `/api/payments/phonepe/webhook`
- **Method:** `POST`
- **Auth:** `Unauthenticated (Secure Signatures)`
- **Headers:** Requires `X-VERIFY` header for checksum validation.

---

## 🛠️ Developer Resources
*Module: Meta*

- **Base URL:** `https://tournamentpro.com/api`
- **Content-Type:** `application/json`
- **Rate Limits:** We strictly enforce rate limits to protect our infrastructure. Please handle `429 Too Many Requests` status codes gracefully.

---

*Last Updated: May 16, 2026*

Documentation

No results found for your search.