Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.35 KB

README.md

File metadata and controls

35 lines (24 loc) · 1.35 KB
Raw

StatsVLR-API

✨ Features

  • Scraping data from vlr.gg efficiently and securely.
  • Providing a simple and intuitive API to access player and team information.
  • Regular updates to keep the data current and relevant.
  • Lightweight and easy to integrate into other projects.

🎯 Usage

Once you have the API server up and running, you can interact with it using HTTP requests. The API provides endpoints for accessing players' and teams' data. Here's a basic example of how to use the API with cURL:

# Get information about a specific player
curl -X GET http://localhost:5000/api/v1/players/{player_id}

# Get information about a specific team
curl -X GET http://localhost:5000/api/v1/teams/{team_id}

📚 API Endpoints

The following are the main endpoints provided by the API:

  • GET /api/v1/players: Retrieve information about all players.
  • GET /api/v1/players/{player_id}: Retrieve information about a specific player.
  • GET /api/v1/teams: Retrieve information about all teams.
  • GET /api/v1/teams/{team_id}: Retrieve information about a specific team.
  • GET /api/v1/events: Retrieve information about all events.
  • GET /api/v1/matches: Retrieve information about upcoming matches or matches being played.
  • GET /api/v1/results: Retrieve information about past match results.
  • GET /api/v1/news: Retrieve information about news.