PlayersService

A list of all methods in the PlayersService service. Click on the method name to view detailed information about that method.

Methods	Description
get_players	List players
get_players_playerIdOrSlug	Get a single player by ID or by slug
get_players_playerIdOrSlug_leagues	List leagues for the given player. Only leagues from the player's current videogame.
get_players_playerIdOrSlug_matches	List matches for the given player. Only matches from the player's current videogame.
get_players_playerIdOrSlug_series	List series for the given player. Only series from the player's current videogame.
get_players_playerIdOrSlug_tournaments	List tournaments for the given player. Only tournaments from the player's current videogame.

get_players

List players

HTTP Method: GET
Endpoint: /players

Parameters

Name	Type	Required	Description
filter	FilterOverPlayers	❌	Options to filter results. String fields are case sensitive For more information on filtering, see docs.
range	RangeOverPlayers	❌	Options to select results within ranges For more information on ranges, see docs.
sort	any[]	❌	Options to sort results For more information on sorting, see docs.
search	SearchOverPlayers	❌	Options to search results For more information on searching, see docs.
page	Page	❌	Pagination in the form of `page=2` or `page[size]=30&page[number]=2`
perPage	number	❌	Equivalent to `page[size]`

Return Type

Player[]

Example Usage Code Snippet

import {
  FilterOverPlayers,
  Page,
  PandascoreClient,
  RangeOverPlayers,
  SearchOverPlayers,
  VideogameId,
} from 'pandascore_client';

(async () => {
  const pandascoreClient = new PandascoreClient({
    token: 'YOUR_TOKEN',
  });

  const videogameId = VideogameId._1;

  const filterOverPlayers: FilterOverPlayers = {
    active: true,
    birthday: ['adipisicin'],
    firstName: ['culpa'],
    id: [6],
    lastName: ['consec'],
    modifiedAt: ['ea'],
    name: ['cupidat'],
    nationality: ['nostrud'],
    role: ['ipsum anim'],
    slug: ['90dzb1'],
    teamId: [3],
    videogameId: [videogameId],
  };

  const rangeOverPlayers: RangeOverPlayers = {
    birthday: ['irure '],
    firstName: ['tempor'],
    id: [1],
    lastName: ['enim officia no'],
    modifiedAt: ['aliqua s'],
    name: ['enim ipsum i'],
    nationality: ['dodolore ve'],
    role: ['volupta'],
    slug: ['tnv0'],
  };

  const searchOverPlayers: SearchOverPlayers = {
    birthday: 'minim dolor qui',
    firstName: 'enim sint proid',
    lastName: 'exercitatio',
    name: 'et sed proiden',
    nationality: 'elit sit',
    role: 'magna ',
    slug: '5ts',
  };
  const page = 1;

  const { data } = await pandascoreClient.players.getPlayers({
    filter: filterOverPlayers,
    range: rangeOverPlayers,
    sort: [[]],
    search: searchOverPlayers,
    page: page,
    perPage: 50,
  });

  console.log(data);
})();

get_players_playerIdOrSlug

Get a single player by ID or by slug

HTTP Method: GET
Endpoint: /players/{player_id_or_slug}

Parameters

Name	Type	Required	Description
playerIdOrSlug	PlayerIdOrSlug	✅	A player ID or slug

Return Type

Player

Example Usage Code Snippet

import { PandascoreClient, PlayerIdOrSlug } from 'pandascore_client';

(async () => {
  const pandascoreClient = new PandascoreClient({
    token: 'YOUR_TOKEN',
  });

  const playerIdOrSlug = 9;

  const { data } = await pandascoreClient.players.getPlayersPlayerIdOrSlug();

  console.log(data);
})();

get_players_playerIdOrSlug_leagues

List leagues for the given player. Only leagues from the player's current videogame.

HTTP Method: GET
Endpoint: /players/{player_id_or_slug}/leagues

Parameters

Name	Type	Required	Description
playerIdOrSlug	PlayerIdOrSlug	✅	A player ID or slug
filter	FilterOverLeagues	❌	Options to filter results. String fields are case sensitive For more information on filtering, see docs.
range	RangeOverLeagues	❌	Options to select results within ranges For more information on ranges, see docs.
sort	any[]	❌	Options to sort results For more information on sorting, see docs.
search	SearchOverLeagues	❌	Options to search results For more information on searching, see docs.
page	Page	❌	Pagination in the form of `page=2` or `page[size]=30&page[number]=2`
perPage	number	❌	Equivalent to `page[size]`

Return Type

League[]

Example Usage Code Snippet

import { FilterOverLeagues, Page, PandascoreClient, PlayerIdOrSlug, RangeOverLeagues, SearchOverLeagues } from 'pandascore_client';

(async () => {
  const pandascoreClient = new PandascoreClient({
	token: 'YOUR_TOKEN'});

  const playerIdOrSlug = 9;

const filterOverLeagues: FilterOverLeagues = {
  id: [7],
  modifiedAt: ["offici"],
  name: ["ad ut"],
  slug: ["p_"],
  url: ["esse aliqu"]
};

const rangeOverLeagues: RangeOverLeagues = {
  id: [10],
  modifiedAt: ["ut nulla"],
  name: ["ea mol"],
  slug: ["pmjvmw-84d"],
  url: ["ea aliquip"]
};

const searchOverLeagues: SearchOverLeagues = {
  name: "Duis dolo",
  slug: "-teig",
  url: "adipisicing"
};
const page = 1;

  const { data } = await pandascoreClient.players.getPlayersPlayerIdOrSlugLeagues(
  ,
  {
		filter: filterOverLeagues,
		range: rangeOverLeagues,
    sort: [[]],
		search: searchOverLeagues,
		page: page,
    perPage: 50,
  }
);

  console.log(data);
})();

get_players_playerIdOrSlug_matches

List matches for the given player. Only matches from the player's current videogame.

HTTP Method: GET
Endpoint: /players/{player_id_or_slug}/matches

Parameters

Name	Type	Required	Description
playerIdOrSlug	PlayerIdOrSlug	✅	A player ID or slug
filter	FilterOverMatches	❌	Options to filter results. String fields are case sensitive For more information on filtering, see docs.
range	RangeOverMatches	❌	Options to select results within ranges For more information on ranges, see docs.
sort	any[]	❌	Options to sort results For more information on sorting, see docs.
search	SearchOverMatches	❌	Options to search results For more information on searching, see docs.
page	Page	❌	Pagination in the form of `page=2` or `page[size]=30&page[number]=2`
perPage	number	❌	Equivalent to `page[size]`

Return Type

Match[]

Example Usage Code Snippet

import { FilterOverMatches, MatchStatus, MatchType, MatchWinnerType, Page, PandascoreClient, PlayerIdOrSlug, RangeOverMatches, SearchOverMatches } from 'pandascore_client';

(async () => {
  const pandascoreClient = new PandascoreClient({
	token: 'YOUR_TOKEN'});

  const playerIdOrSlug = 9;
const matchType = MatchType.ALLGAMESPLAYED;

const teamIdOrSlug = 10;;

const matchStatus = MatchStatus.CANCELED;

const videogameId = VideogameId._1;;

const filterOverMatchesVideogameTitle = 6;

const filterOverMatchesVideogameVersion = "1125897835.45";

const opponentId = 7;

const matchWinnerType = MatchWinnerType.PLAYER;

const filterOverMatches: FilterOverMatches = {
  beginAt: ["ani"],
  detailedStats: true,
  draw: true,
  endAt: ["ad ut com"],
  finished: true,
  forfeit: true,
  future: true,
  id: [3],
  leagueId: [9],
  matchType: [matchType],
  modifiedAt: ["aute sit"],
  name: ["exercitation te"],
  notStarted: true,
  numberOfGames: [8],
  opponentId: [filterOverMatchesOpponentId],
  opponentsFilled: true,
  past: true,
  running: true,
  scheduledAt: ["esse aute n"],
  serieId: [10],
  slug: ["HiGqjR9"],
  status: [matchStatus],
  tournamentId: [3],
  unscheduled: true,
  videogame: [videogameIdOrSlug],
  videogameTitle: [filterOverMatchesVideogameTitle],
  videogameVersion: [filterOverMatchesVideogameVersion],
  winnerId: [opponentId],
  winnerType: [matchWinnerType]
};
const matchType1 = MatchType.ALLGAMESPLAYED;

const matchStatus1 = MatchStatus.CANCELED;

const opponentId1 = 7;

const matchWinnerType1 = MatchWinnerType.PLAYER;

const rangeOverMatches: RangeOverMatches = {
  beginAt: ["al"],
  detailedStats: [true],
  draw: [true],
  endAt: ["do d"],
  forfeit: [true],
  id: [6],
  matchType: [matchType1],
  modifiedAt: ["dolore ve"],
  name: ["dolore "],
  numberOfGames: [10],
  scheduledAt: ["nisi sed aut"],
  slug: ["bAjOZ"],
  status: [matchStatus1],
  tournamentId: [3],
  winnerId: [opponentId1],
  winnerType: [matchWinnerType1]
};
const matchType12 = MatchType.ALLGAMESPLAYED;

const matchStatus12 = MatchStatus.CANCELED;

const matchWinnerType12 = MatchWinnerType.PLAYER;

const searchOverMatches: SearchOverMatches = {
  matchType: matchType12,
  name: "nulla veniam ",
  slug: "WfL1ZPQ",
  status: matchStatus12,
  winnerType: matchWinnerType12
};
const page = 1;

  const { data } = await pandascoreClient.players.getPlayersPlayerIdOrSlugMatches(
  ,
  {
		filter: filterOverMatches,
		range: rangeOverMatches,
    sort: [[]],
		search: searchOverMatches,
		page: page,
    perPage: 50,
  }
);

  console.log(data);
})();

get_players_playerIdOrSlug_series

List series for the given player. Only series from the player's current videogame.

HTTP Method: GET
Endpoint: /players/{player_id_or_slug}/series

Parameters

Name	Type	Required	Description
playerIdOrSlug	PlayerIdOrSlug	✅	A player ID or slug
filter	FilterOverSeries	❌	Options to filter results. String fields are case sensitive For more information on filtering, see docs.
range	RangeOverSeries	❌	Options to select results within ranges For more information on ranges, see docs.
sort	any[]	❌	Options to sort results For more information on sorting, see docs.
search	SearchOverSeries	❌	Options to search results For more information on searching, see docs.
page	Page	❌	Pagination in the form of `page=2` or `page[size]=30&page[number]=2`
perPage	number	❌	Equivalent to `page[size]`

Return Type

Serie[]

Example Usage Code Snippet

import { FilterOverSeries, OpponentType, Page, PandascoreClient, PlayerIdOrSlug, RangeOverSeries, SearchOverSeries } from 'pandascore_client';

(async () => {
  const pandascoreClient = new PandascoreClient({
	token: 'YOUR_TOKEN'});

  const playerIdOrSlug = 9;
const filterOverSeriesVideogameTitle = 7;

const opponentId = 7;

const opponentType = OpponentType.PLAYER;

const filterOverSeries: FilterOverSeries = {
  beginAt: ["sunt cillum dol"],
  endAt: ["dolor"],
  id: [5],
  leagueId: [7],
  modifiedAt: ["deserunt"],
  name: ["laboris"],
  season: ["proident"],
  slug: ["_9"],
  videogameTitle: [filterOverSeriesVideogameTitle],
  winnerId: [opponentId],
  winnerType: [opponentType],
  year: [123]
};
const opponentId1 = 7;

const opponentType1 = OpponentType.PLAYER;

const rangeOverSeries: RangeOverSeries = {
  beginAt: ["sint c"],
  endAt: ["ex dolore tempo"],
  id: [6],
  leagueId: [6],
  modifiedAt: ["lab"],
  name: ["animea labore e"],
  season: ["ipsum i"],
  slug: ["8"],
  winnerId: [opponentId1],
  winnerType: [opponentType1],
  year: [123]
};
const opponentType12 = OpponentType.PLAYER;

const searchOverSeries: SearchOverSeries = {
  name: "fugia",
  season: "aute al",
  slug: "cc3u_",
  winnerType: opponentType12
};
const page = 1;

  const { data } = await pandascoreClient.players.getPlayersPlayerIdOrSlugSeries(
  ,
  {
		filter: filterOverSeries,
		range: rangeOverSeries,
    sort: [[]],
		search: searchOverSeries,
		page: page,
    perPage: 50,
  }
);

  console.log(data);
})();

get_players_playerIdOrSlug_tournaments

List tournaments for the given player. Only tournaments from the player's current videogame.

HTTP Method: GET
Endpoint: /players/{player_id_or_slug}/tournaments

Parameters

Name	Type	Required	Description
playerIdOrSlug	PlayerIdOrSlug	✅	A player ID or slug
filter	FilterOverShortTournaments	❌	Options to filter results. String fields are case sensitive For more information on filtering, see docs.
range	RangeOverShortTournaments	❌	Options to select results within ranges For more information on ranges, see docs.
sort	any[]	❌	Options to sort results For more information on sorting, see docs.
search	SearchOverShortTournaments	❌	Options to search results For more information on searching, see docs.
page	Page	❌	Pagination in the form of `page=2` or `page[size]=30&page[number]=2`
perPage	number	❌	Equivalent to `page[size]`

Return Type

ShortTournament[]

Example Usage Code Snippet

import { FilterOverShortTournaments, OpponentType, Page, PandascoreClient, PlayerIdOrSlug, RangeOverShortTournaments, SearchOverShortTournaments, SearchOverValorantShortTournamentsTier2 } from 'pandascore_client';

(async () => {
  const pandascoreClient = new PandascoreClient({
	token: 'YOUR_TOKEN'});

  const playerIdOrSlug = 9;
const searchOverValorantShortTournamentsTier2 = SearchOverValorantShortTournamentsTier2.A;

const filterOverShortTournamentsVideogameTitle = 5;

const opponentId = 7;

const opponentType = OpponentType.PLAYER;

const filterOverShortTournaments: FilterOverShortTournaments = {
  beginAt: ["pariat"],
  detailedStats: true,
  endAt: ["eli"],
  hasBracket: true,
  id: [4],
  liveSupported: true,
  modifiedAt: ["cillu"],
  name: ["Excepteur do"],
  prizepool: ["in ut veniam "],
  serieId: [10],
  slug: ["z160_"],
  tier: [searchOverValorantShortTournamentsTier2],
  videogameTitle: [filterOverShortTournamentsVideogameTitle],
  winnerId: [opponentId],
  winnerType: [opponentType]
};
const searchOverValorantShortTournamentsTier21 = SearchOverValorantShortTournamentsTier2.A;

const opponentId1 = 7;

const opponentType1 = OpponentType.PLAYER;

const rangeOverShortTournaments: RangeOverShortTournaments = {
  beginAt: ["et"],
  detailedStats: [true],
  endAt: ["commo"],
  hasBracket: [true],
  id: [1],
  modifiedAt: ["nul"],
  name: ["enim "],
  prizepool: ["qui ull"],
  serieId: [3],
  slug: ["vyokv"],
  tier: [searchOverValorantShortTournamentsTier21],
  winnerId: [opponentId1],
  winnerType: [opponentType1]
};
const searchOverValorantShortTournamentsTier212 = SearchOverValorantShortTournamentsTier2.A;

const opponentType12 = OpponentType.PLAYER;

const searchOverShortTournaments: SearchOverShortTournaments = {
  name: "sunt minim",
  prizepool: "utid magna es",
  slug: "50l9n",
  tier: searchOverValorantShortTournamentsTier212,
  winnerType: opponentType12
};
const page = 1;

  const { data } = await pandascoreClient.players.getPlayersPlayerIdOrSlugTournaments(
  ,
  {
		filter: filterOverShortTournaments,
		range: rangeOverShortTournaments,
    sort: [[]],
		search: searchOverShortTournaments,
		page: page,
    perPage: 50,
  }
);

  console.log(data);
})();

Build Your Own SDKs with liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →

get_players​

get_players_playerIdOrSlug​

get_players_playerIdOrSlug_leagues​

get_players_playerIdOrSlug_matches​

get_players_playerIdOrSlug_series​

get_players_playerIdOrSlug_tournaments​

Build Your Own SDKs with liblab

get_players

get_players_playerIdOrSlug

get_players_playerIdOrSlug_leagues

get_players_playerIdOrSlug_matches

get_players_playerIdOrSlug_series

get_players_playerIdOrSlug_tournaments