gamersclub-api
v2.11.0
Published
Simple and private Gamers Club API
Downloads
4
Maintainers
Readme
GamersClub API
GamersClub API es una librería en NodeJS que permite obtener información de partidos, torneos, players y teams de la plataforma Gamers Club.
Gamers Club al no proporcionar una API, la librería lo que hace es scrapear directamente la web, parsear la información y devolverla en un formato que se pueda trabajar.
Instalación
La librería se instala vía npm
npm install gamersclub-api
Uso
Simplemente importamos el objeto GC para luego inicializarlo pasando como único parámetro el Session ID (Ver abajo como obtenerla)
const GC = require('gamersclub-api');
const gc = new GC(sessionId);
Para ver detalladamente su funcionalidad, en la carpeta examples van a encontrar un ejemplo de cómo utilizarla correctamente.
Obtener cookie de Gamers Club
Una vez logueados en Gamers Club con nuestra cuenta de Steam, en Chrome realizamos lo siguiente:
- Apretamos F12
- Vamos a la pestaña "Application"
- En la sección "Storage" a la izquierda, apretamos en donde dice "Cookies" y luego apretamos "https://gamersclub.com.br"
- Ahi nos va a mostrar una tabla, a nosotros nos importa la que dice "gclubsess". Cuando la encontramos, vamos a copiar toda la cadena que está en la columna "Value" de esa fila
- Una vez copiado eso, lo ponemos en la librería y listo! :)
Métodos
| Nombre | Retorna | | ------ | ------ | | initBrowser(browser?) | Promise() | | getMatch(tournamentId, matchId) | Match() | | getTeam(teamId) | Team() | | getTeamMatches(teamId) | Team() with matches | | getTournament(tournamentId) | Tournament() | | getEndedTournaments(page) | ArrayList of Tournament() |
Clases
Match
- String id - ID del match
- Tournament tournament - Torneo al que pertenece el match
- Bool live - Si el partido está en vivo o no
- String team1 - Nombre del equipo 1
- String team2 - Nombre del equipo 2
- Integer score1 - Score del equipo 1
- Integer score2 - Score del equipo 2
- Bool finished - Si el partido ya finalizó
- String best_of - Tipo de match (BO1, BO3, etc.)
- String date - Fecha del partido
- String hour - Hora del partido
- String maps - Mapas del match (Si son más de 1 se separan por comas)
Player
- String id - ID del player
- String name - Nombre del player
- String level - Nivel del player
- String avatar - Avatar que tiene en Gamers Club
- String role - Rol que juega dentro del equipo
Team
- String id - ID del team
- String logo - Logo del team
- String name - Nombre del team
- String tag - Tag del team
- Array[Player] players - Players que pertenecen al team
- Array[Match] matches - Partidos del equipo
Tournament
- String id - ID del torneo
- String name - Nombre del torneo
- String beginning - Inicio del torneo
- String ending - Finalización del torneo
- String prize - Premio
- String groups - HTML de los grupos
- String table - HTML de la tabla