vlresports - Valorant Esports API

vlresports is an open-source project that aims to provide a scraping API for the vlr.gg website to gather information about players and teams in the competitive Valorant scene. Please note that this project is not associated with vlr.gg or Riot Games.

• Introduction
• Features
• Installation
• Usage
• API Endpoints
• Contributing
• License

vlresports is designed to facilitate access to essential data from the competitive Valorant scene. By scraping vlr.gg, it allows users to retrieve information about professional players, teams, and other relevant statistics. The goal of this project is to make it easier for developers and enthusiasts to access and utilize data for their applications, analysis, or research related to Valorant esports.

• 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.

To install vlresports, follow these steps:

1. Clone the repository to your local machine.
2. Install the necessary dependencies using npm.
3. Run the API server locally or deploy it to your preferred hosting platform.

git clone https://github.com/Orloxx23/vlresports.git

cd vlresports

npm install

npm start

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}

Please refer to the API documentation for more detailed usage instructions and examples. If you want more technical documentation, you can go to Deep Wiki/vlresports

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. Includes per-agent statistics; use ?timespan=30d|60d|90d|all to change the window (default 60d).
• 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/events/{event_id}: Retrieve full details of an event (stages, participating teams with rosters, prize distribution and bracket). Use ?stage=<slug> (e.g. playoffs) to pick which stage's bracket and teams to return; valid slugs come in stages[].slug. Group stages return groups (standings per group) instead of a bracket.
• GET /api/v1/events/{event_id}/matches: Retrieve all matches of an event. Filter with ?stage=<slug> and/or ?status=upcoming|live|completed.
• GET /api/v1/events/{event_id}/stats: Retrieve the per-player statistics table of an event (rating, ACS, K/D, clutches, etc.). Supports ?stage=<slug>.
• GET /api/v1/events/{event_id}/agents: Retrieve agent pick rates per map for an event, with attack/defense win rates.
• GET /api/v1/matches: Retrieve information about upcoming matches or matches being played.
• GET /api/v1/matches/{match_id}: Retrieve full details of a match (teams, score, picks/bans, per-map results and player stats).
  • Rounds timeline per map: winner, side and win method (elim, boom, defuse, time) with its icon URL.
  • Optional query param ?tabs=performance,economy (or ?tabs=all) to include the vlr.gg Performance tab (multikills, clutches, duel matrices) and Economy tab (buy types, banks, round-by-round economy), both aggregated and per map. Each tab adds one extra request to vlr.gg, so only ask for what you need.
• GET /api/v1/results: Retrieve information about past match results.

Contributions to vlresports are welcome and greatly appreciated. If you wish to contribute, please follow the guidelines outlined in the CONTRIBUTING.md file.

vlresports is open-source and available under the Apache 2.0 License.

We hope you find vlresports useful for your Valorant esports-related projects. If you have any questions, suggestions, or issues, feel free to raise them in the GitHub repository's issue tracker. Happy coding!