API.md

API Reference

Overview

This document describes the available REST endpoints, request/response formats, and data models.

Endpoints

GET /countries

• Description: Retrieve a list of countries.
• Response:

  [
    {
      "id": 1,
      "name": "England",
      "code": "ENG"
    }
  ]

GET /leagues

• Description: Retrieve a list of leagues.
• Response:

  [
    {
      "id": 10,
      "name": "Premier League",
      "countryId": 1
    }
  ]

GET /matches

• Description: Retrieve a list of matches.
• Response:

  [
    {
      "id": 100,
      "homeTeam": "Team A",
      "awayTeam": "Team B",
      "date": "2024-06-01T15:00:00Z"
    }
  ]

GET /livescores

• Description: Retrieve live scores.
• Response:

  [
    {
      "matchId": 100,
      "score": "2-1",
      "status": "LIVE"
    }
  ]

Data Models

See src/interfaces/ for TypeScript interfaces.