An Unofficial REST API for vlr.gg, a site for Valorant Esports match and news coverage.
Built by Andre Saddler
All endpoints are relative to https://vlrggapi.vercel.app.
- Method:
GET - Description: Fetches the latest news articles related to Valorant Esports.
- Example:
GET https://vlrggapi.vercel.app/news - Response Example:
{
"data": {
"status": 200,
"segments": [
{
"title": "Riot introduces changes to Premier, adds new Invite Division",
"description": "Riot looks to streamline Premier promotions and Challengers qualification with upcoming changes.",
"date": "April 23, 2024",
"author": "thothgow",
"url_path": "https://vlr.gg/336099/riot-introduces-changes-to-premier-adds-new-invite-division"
},
{
"title": "jakee announces competitive retirement",
"description": "From Collegiate to the Tier 1 stage, the Controller main had seen it all.",
"date": "April 21, 2024",
"author": "ChickenJoe",
"url_path": "https://vlr.gg/334341/jakee-announces-competitive-retirement"
}
]
}
}-
Method:
GET -
Description: Fetches player statistics for a specific region and timespan.
-
Query Parameters:
region: Region shortname (e.g., "na" for North America).timespan: Time span in days (e.g., "30" for the last 30 days, or "all" for all time).
-
Example:
GET https://vlrggapi.vercel.app/stats?region=na×pan=30 -
Response Example:
{
"data": {
"status": 200,
"segments": [
{
"player": "corey",
"org": "TTR",
"rating": "1.18",
"average_combat_score": "235.2",
"kill_deaths": "1.19",
"kill_assists_survived_traded": "72%",
"average_damage_per_round": "158.4",
"kills_per_round": "0.81",
"assists_per_round": "0.29",
"first_kills_per_round": "0.19",
"first_deaths_per_round": "0.13",
"headshot_percentage": "26%",
"clutch_success_percentage": "28%"
},
{
"player": "wedid",
"org": "TTR",
"rating": "1.15",
"average_combat_score": "216.1",
"kill_deaths": "1.11",
"kill_assists_survived_traded": "72%",
"average_damage_per_round": "141.0",
"kills_per_round": "0.76",
"assists_per_round": "0.39",
"first_kills_per_round": "0.07",
"first_deaths_per_round": "0.10",
"headshot_percentage": "32%",
"clutch_success_percentage": "19%"
}
]
}
}- Method:
GET - Description: Fetches rankings for a specific region.
- Query Parameters:
region: Region shortname (e.g., "na" for North America).
- Example:
GET https://vlrggapi.vercel.app/rankings?region=na - Response Example:
{
"status": 200,
"data": [
{
"rank": "1",
"team": "M80",
"country": "Canada",
"last_played": "4d ago",
"last_played_team": "vs. Turtle Tr",
"last_played_team_logo": "//owcdn.net/img/63d552c5dd028.png",
"record": "4-1",
"earnings": "$104,850",
"logo": "//owcdn.net/img/63d91e60a84bc.png"
},
{
"rank": "2",
"team": "Sentinels",
"country": "United States",
"last_played": "22h ago",
"last_played_team": "vs. Evil Geniuses",
"last_played_team_logo": "//owcdn.net/img/62a409ad29351.png",
"record": "7-3",
"earnings": "$295,500",
"logo": "//owcdn.net/img/62875027c8e06.png"
}
]
}- Method:
GET - Description: Fetches matches based on the query parameter provided.
- Query Parameters:
q: Type of matches to fetch ("upcoming", "live_score", "results").
- Examples:
- Upcoming matches:
GET https://vlrggapi.vercel.app/match?q=upcoming - Live scores:
GET https://vlrggapi.vercel.app/match?q=live_score - Match results:
GET https://vlrggapi.vercel.app/match?q=results
- Upcoming matches:
- Response Example for
q=upcoming:
{
"data": {
"status": 200,
"segments": [
{
"team1": "G2 Esports",
"team2": "Leviatán",
"flag1": "flag_us",
"flag2": "flag_cl",
"time_until_match": "51m from now",
"match_series": "Regular Season: Week 3",
"match_event": "Champions Tour 2024: Americas Stage 1",
"unix_timestamp": "2024-04-24 21:00:00",
"match_page": "https://www.vlr.gg/314642/g2-esports-vs-leviat-n-champions-tour-2024-americas-stage-1-w3"
}
]
}
}- Response Example for
q=live_score:
{
"data": {
"status": 200,
"segments": [
{
"team1": "Team 1 Name",
"team2": "Team 2 Name",
"flag1": "Country Flag of Team 1",
"flag2": "Country Flag of Team 2",
"team1_logo": "URL to Team 1 logo",
"team2_logo": "URL to Team 2 logo",
"score1": "Team 1 Score",
"score2": "Team 2 Score",
"team1_round_ct": "Team 1 CT-side rounds",
"team1_round_t": "Team 1 T-side rounds",
"team2_round_ct": "Team 2 CT-side rounds",
"team2_round_t": "Team 2 T-side rounds",
"map_number": "Current map number in the series",
"current_map": "Current map being played",
"time_until_match": "LIVE",
"match_event": "Event name",
"match_series": "Match series",
"unix_timestamp": "Match start time in UNIX timestamp",
"match_page": "URL to the match page"
}
]
}
}- Response Example for
q=results:
{
"data": {
"status": 200,
"segments": [
{
"team1": "Team Vitality",
"team2": "Gentle Mates",
"score1": "0",
"score2": "2",
"flag1": "flag_eu",
"flag2": "flag_fr",
"time_completed": "2h 44m ago",
"round_info": "Regular Season-Week 4",
"tournament_name": "Champions Tour 2024: EMEA Stage 1",
"match_page": "/318931/team-vitality-vs-gentle-mates-champions-tour-2024-emea-stage-1-w4",
"tournament_icon": "https://owcdn.net/img/65ab59620a233.png"
}
]
}
}- Method:
GET - Description: Returns the health status of the API and vlr.gg website.
- Example:
GET https://vlrggapi.vercel.app/health - Response Example:
{
"https://vlrggapi.vercel.app": {
"status": "Healthy",
"status_code": 200
},
"https://vlr.gg": {
"status": "Healthy",
"status_code": 200
}
}The response includes the status ("Healthy" or "Unhealthy") and the HTTP status code for both the API and the vlr.gg website. If a site is unreachable, the status will be "Unhealthy" and the status_code will be null.
git clone https://github.com/axsddlr/vlrggapi/
cd vlrggapi
pip3 install -r requirements.txtpython3 main.py
Feel free to submit a pull request or an issue!
The MIT License (MIT)