StarCraftBroodWarPlayersService
A list of all methods in the StarCraftBroodWarPlayersService
service. Click on the method name to view detailed information about that method.
Methods | Description |
---|---|
get_starcraft_brood_war_players | List players for the StarCraft Brood War videogame |
get_starcraft_brood_war_players
List players for the StarCraft Brood War videogame
- HTTP Method:
GET
- Endpoint:
/starcraft-brood-war/players
Parameters
Name | Type | Required | Description |
---|---|---|---|
filter | FilterOverStarcraftBroodWarPlayers | ❌ | Options to filter results. String fields are case sensitive For more information on filtering, see docs. |
range | RangeOverStarcraftBroodWarPlayers | ❌ | 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 | SearchOverStarcraftBroodWarPlayers | ❌ | 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 {
FilterOverStarcraftBroodWarPlayers,
Page,
PandascoreClient,
RangeOverStarcraftBroodWarPlayers,
SearchOverStarcraftBroodWarPlayers,
VideogameId,
} from 'pandascore_client';
(async () => {
const pandascoreClient = new PandascoreClient({
token: 'YOUR_TOKEN',
});
const videogameId = VideogameId._1;
const filterOverStarcraftBroodWarPlayers: FilterOverStarcraftBroodWarPlayers = {
active: true,
birthday: ['consequat '],
firstName: ['dolore'],
id: [9],
lastName: ['adipi'],
modifiedAt: ['id no'],
name: ['ex dolor'],
nationality: ['ad tempor m'],
role: ['reprehende'],
slug: ['fx5dlw'],
teamId: [5],
videogameId: [videogameId],
};
const rangeOverStarcraftBroodWarPlayers: RangeOverStarcraftBroodWarPlayers = {
birthday: ['nisi adipisicin'],
firstName: ['voluptat'],
id: [7],
lastName: ['proident'],
modifiedAt: ['officia id'],
name: ['adipisici'],
nationality: ['qui Ut'],
role: ['exercitatio'],
slug: ['65'],
};
const searchOverStarcraftBroodWarPlayers: SearchOverStarcraftBroodWarPlayers = {
birthday: 'qui enim',
firstName: 'cillum ut temp',
lastName: 'pariatur fugia',
name: 'ullamco ',
nationality: 'proiden',
role: 'officia',
slug: 'fepvp',
};
const page = 1;
const { data } = await pandascoreClient.starCraftBroodWarPlayers.getStarcraftBroodWarPlayers({
filter: filterOverStarcraftBroodWarPlayers,
range: rangeOverStarcraftBroodWarPlayers,
sort: [[]],
search: searchOverStarcraftBroodWarPlayers,
page: page,
perPage: 50,
});
console.log(data);
})();
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs