haysberg / vlrggapi

An Unofficial REST API for vlr.gg, a site for Valorant Pro Esports match results and news.

Home Page:vlrggapi.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

vlrggapi

An Unofficial REST API for vlr.gg, a site for Valorant Esports match and news coverage.

Built by Andre Saddler

Current Endpoints

All endpoints are relative to https://vlrggapi.vercel.app.

/news

  • Method: GET
  • Cached Time: 300 seconds (5 Minutes)
  • Response:
    {
        "data": {
            "status": 200,
            'segments': [
                {
                    'title': str,
                    'description': str,
                    'date': str,
                    'author': str,
                    'url_path': str
                }
            ],
        }
    }

/matches/results

  • Method: GET
  • Cached Time: 300 seconds (5 Minutes)
  • Response:
    {
        "data": {
            "status": 200,
            'segments': [
                {
                  "team1": str,
                  "team2": str,
                  "score1": str,
                  "score2": str,
                  "time_completed": str,
                  "round_info": str,
                  "tournament_name": str,
                  "match_page": str,
                  "tournament_icon": str
                }
            ],
        }
    }

/rankings/<region>

  • Method: GET
  • Region: north-america, europe, asia-pacific, latin-america, oceania, korea, mena
  • Cached Time: 300 seconds (5 Minutes)
  • Response:
    {
        "data": {
            "status": 200,
            'segments': [
                {
                    'rank': str,
                    'team': str,
                    'country': str,
                    'streak': str,
                    'record': str,
                    'winnings': str,
                    'logo': str,
                    'url_path': str
                }
            ],
        }
    }

/stats/<region>

  • Method: GET
  • Cached Time: 300 seconds (5 Minutes)
  • Region: na, eu, ap, sa, oce, mn
  • Response:
    {
        "data": {
            "status": 200,
            'segments': [
                {
                  'title': str,
                  "player": str,
                  "org": str,
                  "average_combat_score": str,
                  "kill_deaths": str,
                  "average_damage_per_round": str,
                  "kills_per_round": str,
                  "assists_per_round": str,
                  "first_kills_per_round": str,
                  "first_deaths_per_round": str,
                  "headshot_percentage": str,
                  "clutch_success_percentage": str
                }
            ],
        }
    }

Installation

Source

To work on the project, you will need to have Poetry installed. Please follow the docs to do so.

git clone https://github.com/axsddlr/vlrggapi/
cd vlrggapi
poetry install

Usage

poetry python3 main.py

Built With

Contributing

Feel free to submit a pull request or an issue!

License

The MIT License (MIT)

About

An Unofficial REST API for vlr.gg, a site for Valorant Pro Esports match results and news.

vlrggapi.vercel.app

License:MIT License


Languages

Language:Python 94.4%Language:Dockerfile 5.3%Language:Procfile 0.3%