StarCraft2PlayersService

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

Methods	Description
get_starcraft_2_players	List players for the StarCraft 2 videogame

get_starcraft_2_players

List players for the StarCraft 2 videogame

• HTTP Method: GET
• Endpoint: /starcraft-2/players

Parameters

Name	Type	Required	Description
filter	FilterOverStarcraft2Players	❌	Options to filter results. String fields are case sensitive For more information on filtering, see docs.
range	RangeOverStarcraft2Players	❌	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	SearchOverStarcraft2Players	❌	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 {
  FilterOverStarcraft2Players,
  Page,
  PandascoreClient,
  RangeOverStarcraft2Players,
  SearchOverStarcraft2Players,
  VideogameId,
} from 'pandascore_client';

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

  const videogameId = VideogameId._1;

  const filterOverStarcraft2Players: FilterOverStarcraft2Players = {
    active: true,
    birthday: ['Utirure en'],
    firstName: ['nulla'],
    id: [8],
    lastName: ['tempor do'],
    modifiedAt: ['iru'],
    name: ['officia in '],
    nationality: ['Duisin'],
    role: ['laboris nisi ad'],
    slug: ['6akrbwuj'],
    teamId: [7],
    videogameId: [videogameId],
  };

  const rangeOverStarcraft2Players: RangeOverStarcraft2Players = {
    birthday: ['do cupidatat a'],
    firstName: ['dolor la'],
    id: [5],
    lastName: ['velit sit '],
    modifiedAt: ['repreh'],
    name: ['labore l'],
    nationality: ['magna amet Dui'],
    role: ['mollit Duis'],
    slug: ['s1'],
  };

  const searchOverStarcraft2Players: SearchOverStarcraft2Players = {
    birthday: 'eiusm',
    firstName: 'enim si',
    lastName: 'consequat s',
    name: 'proiden',
    nationality: 'fugiat eu sint',
    role: 'nulla',
    slug: '7-mandz0',
  };
  const page = 1;

  const { data } = await pandascoreClient.starCraft2Players.getStarcraft2Players({
    filter: filterOverStarcraft2Players,
    range: rangeOverStarcraft2Players,
    sort: [[]],
    search: searchOverStarcraft2Players,
    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 →