Interact with the BeatLeader Clan API endpoints
- Source
Methods
(static) get(searchOptions) → {Promise}
Retrieves a list of clans based on filters
| Name | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
searchOptions | Object | Filters to narrow search. See options in table below
|
- Source
A promise with a list of clans
- Type:
- Promise
(static) getById(id, searchOptions, primary) → {Promise}
Fetches details of a specific clan identified by its ID.
| Name | Type | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | number | ID of the clan to retrieve details for | ||||||||||||||||||||
searchOptions | Object | Filters to narrow search. See options in table below
| ||||||||||||||||||||
primary | boolean | Whether to include only players for whom this clan is primary, default is false |
- Source
A promise with a clan
- Type:
- Promise
(static) getByTag(tag, searchOptions, primary) → {Promise}
Retrieves details of a specific clan by tag
| Name | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
tag | string | Tag of the clans to retrieve details for | ||||||||||||||||||||||||
searchOptions | Object | Filters to narrow search. See options in table below
| ||||||||||||||||||||||||
primary | boolean | Whether to include only players for whom this clan is primary, default is false |
- Source
A promise with a clan
- Type:
- Promise
(static) getGlobalMap() → {Promise}
Fetches a global map showing clan captured maps and rankings.
- Source
A promise with the Global Map
- Type:
- Promise
(static) getMapsById(id, searchOptions) → {Promise}
Fetches ranked maps(maps that can be captured on the global map) for where players of clan made scores identified by its ID, with optional sorting and filtering.
| Name | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ID of the clans to retrieve details for | ||||||||||||||||||||||||
searchOptions | Object | Filters to narrow search. See options in table below
|
- Source
A promise with a list of ranked maps
- Type:
- Promise
(static) getMapsByTag(tag, searchOptions) → {Promise}
Retrieves a list of clans based on filters
| Name | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
tag | string | Tag of the clans to retrieve details for | ||||||||||||||||||||||||
searchOptions | Object | Filters to narrow search. See options in table below
|
- Source
A promise with a list of ranked maps
- Type:
- Promise