pandascore_client
v1.0.0
Published
The PandaScore API offers real-time data, statistics, and odds for esports competitions, providing comprehensive information for developers building esports-related applications.
Downloads
3
Readme
PandascoreClient TypeScript SDK 1.0.0
Welcome to the PandascoreClient SDK documentation. This guide will help you get started with integrating and using the PandascoreClient SDK in your project.
Versions
- API version:
2.53.0
- SDK version:
1.0.0
About the API
The PandaScore API offers real-time data, statistics, and odds for esports competitions, providing comprehensive information for developers building esports-related applications.
Table of Contents
Setup & Configuration
Supported Language Versions
This SDK is compatible with the following versions: TypeScript >= 4.8.4
Installation
To get started with the SDK, we recommend installing using npm
:
npm install pandascore_client
Authentication
Access Token Authentication
The PandascoreClient API uses an Access Token for authentication.
This token must be provided to authenticate your requests to the API.
Setting the Access Token
When you initialize the SDK, you can set the access token as follows:
const sdk = new PandascoreClient({ token: 'YOUR_TOKEN' });
If you need to set or update the access token after initializing the SDK, you can use:
const sdk = new PandascoreClient();
sdk.token = 'YOUR_TOKEN';
Services
The SDK provides various services to interact with the API.
| Name | | :--------------------------------------------------------------------------------------------------- | | IncidentsService | | CodmwLeaguesService | | CodmwMatchesService | | CodmwPlayersService | | CodmwSeriesService | | CodmwTeamsService | | CodmwTournamentsService | | CounterStrikeGamesService | | CounterStrikeLeaguesService | | CounterStrikeMapsService | | CounterStrikeMatchesService | | CounterStrikeStatsService | | CounterStrikePlayersService | | CounterStrikeSeriesService | | CounterStrikeTeamsService | | CounterStrikeTournamentsService | | CounterStrikeWeaponsService | | Dota2AbilitiesService | | Dota2GamesService | | Dota2HeroesService | | Dota2ItemsService | | Dota2LeaguesService | | Dota2MatchesService | | Dota2StatsService | | Dota2PlayersService | | Dota2SeriesService | | Dota2TeamsService | | Dota2TournamentsService | | EaSportsFcLeaguesService | | EaSportsFcMatchesService | | EaSportsFcPlayersService | | EaSportsFcSeriesService | | EaSportsFcTeamsService | | EaSportsFcTournamentsService | | KogLeaguesService | | KogMatchesService | | KogPlayersService | | KogSeriesService | | KogTeamsService | | KogTournamentsService | | LeaguesService | | LivesService | | LoLWildRiftLeaguesService | | LoLWildRiftMatchesService | | LoLWildRiftPlayersService | | LoLWildRiftSeriesService | | LoLWildRiftTeamsService | | LoLWildRiftTournamentsService | | LoLChampionsService | | LoLGamesService | | LoLItemsService | | LoLLeaguesService | | LoLMasteriesService | | LoLMatchesService | | LoLStatsService | | LoLPlayersService | | LoLRunesService | | LoLSeriesService | | LoLTeamsService | | LoLSpellsService | | LoLTournamentsService | | MatchesService | | OwGamesService | | OwStatsService | | OwHeroesService | | OwLeaguesService | | OwMapsService | | OwMatchesService | | OwPlayersService | | OwSeriesService | | OwTeamsService | | OwTournamentsService | | PlayersService | | PubgLeaguesService | | PubgMatchesService | | PubgPlayersService | | PubgSeriesService | | PubgTeamsService | | PubgTournamentsService | | R6SiegeLeaguesService | | R6SiegeMatchesService | | R6SiegePlayersService | | R6SiegeSeriesService | | R6SiegeTeamsService | | R6SiegeTournamentsService | | RlLeaguesService | | RlMatchesService | | RlPlayersService | | RlSeriesService | | RlTeamsService | | RlTournamentsService | | SeriesService | | StarCraft2LeaguesService | | StarCraft2MatchesService | | StarCraft2PlayersService | | StarCraft2SeriesService | | StarCraft2TeamsService | | StarCraft2TournamentsService | | StarCraftBroodWarLeaguesService | | StarCraftBroodWarMatchesService | | StarCraftBroodWarPlayersService | | StarCraftBroodWarSeriesService | | StarCraftBroodWarTeamsService | | StarCraftBroodWarTournamentsService | | TeamsService | | TournamentsService | | ValorantAbilitiesService | | ValorantAgentsService | | ValorantGamesService | | ValorantLeaguesService | | ValorantMapsService | | ValorantMatchesService | | ValorantStatsService | | ValorantPlayersService | | ValorantSeriesService | | ValorantTeamsService | | ValorantTournamentsService | | ValorantWeaponsService | | VideogamesService |
Models
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
| Name | Description | | :--------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | NonDeletionIncident | | | FilterOverAdditionIncidents | | | RangeOverAdditionIncidents | | | Page | | | VideogameIdOrSlug | A videogame ID or slug | | Incident | | | FilterOverChangeIncidents | | | RangeOverChangeIncidents | | | DeletionIncident | | | FilterOverDeletionIncidents | | | RangeOverDeletionIncidents | | | FilterOverIncidents | | | RangeOverIncidents | | | League | | | FilterOverCodmwLeagues | | | RangeOverCodmwLeagues | | | SearchOverCodmwLeagues | | | Match | | | FilterOverCodmwMatches | | | RangeOverCodmwMatches | | | SearchOverCodmwMatches | | | Player | | | FilterOverCodmwPlayers | | | RangeOverCodmwPlayers | | | SearchOverCodmwPlayers | | | Serie | A serie, an occurrence of a league event | | FilterOverCodmwSeries | | | RangeOverCodmwSeries | | | SearchOverCodmwSeries | | | Team | | | FilterOverCodmwTeams | | | RangeOverCodmwTeams | | | SearchOverCodmwTeams | | | ShortTournament | | | FilterOverCodmwShortTournaments | | | RangeOverCodmwShortTournaments | | | SearchOverCodmwShortTournaments | | | CsgoGame | | | CsgoEvent | | | CsgoFullRound | | | MatchIdOrSlug | A match ID or slug | | FilterOverCsgoGames | | | RangeOverCsgoGames | | | SearchOverCsgoGames | | | FilterOverCsgoLeagues | | | RangeOverCsgoLeagues | | | SearchOverCsgoLeagues | | | CsgoMap | | | FilterOverCsgoMaps | | | RangeOverCsgoMaps | | | SearchOverCsgoMaps | | | FilterOverCsgoMatches | | | RangeOverCsgoMatches | | | SearchOverCsgoMatches | | | CsgoMatch | | | CsgoStatsForAllPlayersByMatch | | | CsgoStatsForPlayerByMatch | Player's aggregated statistics for a match | | PlayerIdOrSlug | A player ID or slug | | CsgoStatsForTeamByMatch | Team's aggregated statistics for a match | | TeamIdOrSlug | A team ID or slug | | CsgoStatsForPlayer | Player's aggregated statistics | | VideogameTitleIdOrSlug | A videogame title ID or slug | | CsgoStatsForPlayerBySerie | Player's aggregated statistics for a serie | | SerieIdOrSlug | A serie ID or slug | | CsgoStatsForTeamBySerie | Team's aggregated statistics for a serie | | CsgoStatsForTeam | Team's aggregated statistics | | CsgoStatsForPlayerByTournament | Player's aggregated statistics for a tournament | | TournamentIdOrSlug | A tournament ID or slug | | CsgoStatsForTeamByTournament | Team's aggregated statistics for a tournament | | FilterOverCsgoPlayers | | | RangeOverCsgoPlayers | | | SearchOverCsgoPlayers | | | FilterOverCsgoSeries | | | RangeOverCsgoSeries | | | SearchOverCsgoSeries | | | FilterOverCsgoTeams | | | RangeOverCsgoTeams | | | SearchOverCsgoTeams | | | FilterOverCsgoShortTournaments | | | RangeOverCsgoShortTournaments | | | SearchOverCsgoShortTournaments | | | CsgoWeapon | | | FilterOverCsgoWeapons | | | RangeOverCsgoWeapons | | | SearchOverCsgoWeapons | | | CsgoWeaponIdOrSlug | A weapon ID or slug | | Dota2Ability | | | FilterOverDota2Abilities | | | RangeOverDota2Abilities | | | SearchOverDota2Abilities | | | Dota2AbilityIdOrSlug | An ability ID or slug | | Dota2Game | | | Dota2Frame | | | FilterOverDota2Games | | | RangeOverDota2Games | | | SearchOverDota2Games | | | BaseDota2Game | | | Dota2Hero | | | FilterOverDota2Heroes | | | RangeOverDota2Heroes | | | SearchOverDota2Heroes | | | Dota2HeroIdOrSlug | A hero ID or slug | | Dota2Item | | | FilterOverDota2Items | | | RangeOverDota2Items | | | SearchOverDota2Items | | | Dota2ItemIdOrSlug | An item ID or slug | | FilterOverDota2Leagues | | | RangeOverDota2Leagues | | | SearchOverDota2Leagues | | | FilterOverDota2Matches | | | RangeOverDota2Matches | | | SearchOverDota2Matches | | | Dota2StatsForAllPlayersByMatch |