StarCraft2LeaguesService
A list of all methods in the StarCraft2LeaguesService
service. Click on the method name to view detailed information about that method.
Methods | Description |
---|---|
get_starcraft_2_leagues | List StarCraft 2 leagues |
get_starcraft_2_leagues
List StarCraft 2 leagues
- HTTP Method:
GET
- Endpoint:
/starcraft-2/leagues
Parameters
Name | Type | Required | Description |
---|---|---|---|
filter | FilterOverStarcraft2Leagues | ❌ | Options to filter results. String fields are case sensitive For more information on filtering, see docs. |
range | RangeOverStarcraft2Leagues | ❌ | 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 | SearchOverStarcraft2Leagues | ❌ | 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 {
FilterOverStarcraft2Leagues,
Page,
PandascoreClient,
RangeOverStarcraft2Leagues,
SearchOverStarcraft2Leagues,
} from 'pandascore_client';
(async () => {
const pandascoreClient = new PandascoreClient({
token: 'YOUR_TOKEN',
});
const filterOverStarcraft2Leagues: FilterOverStarcraft2Leagues = {
id: [4],
modifiedAt: ['ad'],
name: ['utex est'],
slug: ['luoez'],
url: ['consequat '],
};
const rangeOverStarcraft2Leagues: RangeOverStarcraft2Leagues = {
id: [7],
modifiedAt: ['et ex in'],
name: ['consectetur e'],
slug: ['q'],
url: ['veniam ut c'],
};
const searchOverStarcraft2Leagues: SearchOverStarcraft2Leagues = {
name: 'in ei',
slug: 'kb1dlt',
url: 'aute ',
};
const page = 1;
const { data } = await pandascoreClient.starCraft2Leagues.getStarcraft2Leagues({
filter: filterOverStarcraft2Leagues,
range: rangeOverStarcraft2Leagues,
sort: [[]],
search: searchOverStarcraft2Leagues,
page: page,
perPage: 50,
});
console.log(data);
})();
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs