Allows interaction with the ScoreSaber Player API endpoints
- Source
Methods
(static) basicInfoById(playerId) → {Promise.<Array>}
Returns basic player info
| Name | Type | Description |
|---|---|---|
playerId | string | Player ID |
- Source
Returns a Promise with basic info on a player
- Type:
- Promise.<Array>
(static) count(search, countries) → {Promise.<Array>}
Returns an integer value of the number of players based on filters
| Name | Type | Description |
|---|---|---|
search | string | Query for specific terms |
countries | Array | Filter by ISO 3166-1 alpha-2 code |
- Source
Returns a Promise with a integer of the number of players found matching filtered results
- Type:
- Promise.<Array>
(static) fullInfoById(playerId) → {Promise.<Array>}
Returns full player info
| Name | Type | Description |
|---|---|---|
playerId | string | Player ID |
- Source
Returns a Promise with full info on a player
- Type:
- Promise.<Array>
(static) get(search, page, countries, withMetadata) → {Promise.<Array>}
Gets a list of players based on filters
| Name | Type | Description |
|---|---|---|
search | string | Query for specific terms |
page | number | Page of result |
countries | Array | Filter by ISO 3166-1 alpha-2 code |
withMetadata | boolean | True by default. Returns total number of results, page number, and items per page |
- Source
Returns a Promise with a list of players based on filters
- Type:
- Promise.<Array>
(static) scoresById(playerId, limit, sort) → {Promise.<Array>}
Returns a list of a players scores
| Name | Type | Description |
|---|---|---|
playerId | string | Player ID |
limit | number | Maximum number of results to be returned |
sort | string | The sort order. Valid values are |
- Source
Returns a Promise with full info on a player
- Type:
- Promise.<Array>