Game API ^{Documentation}

Scores - Fetch

Returns a list of scores either for a user or globally for a game.

/scores/

Name	Required?	Type	Description
`game_id`	Yes	`string`	The ID of your game.
`limit`	No	`integer`	The number of scores you'd like to return.
`table_id`	No	`integer`	The ID of the score table.
`username`	No	`string`	The user's username.
`user_token`	No	`string`	The user's token.
`guest`	No	`string`	A guest's name
`better_than`	No	`integer`	Fetch only scores better than this score sort value.
`worse_than`	No	`integer`	Fetch only scores worse than this score sort value.

Name	Type	Description
`success`	`boolean`	Whether the request succeeded or failed. Example: `true`
`message`	`string`	If the request was not successful, this contains the error message. Example: `Unknown fatal error occurred.`

All values below will get returned for every score that gets returned. They can occur multiple times.

Name	Type	Description
`score`	`string`	The score string. Example: `234 Coins`
`sort`	`integer`	The score's numerical sort value. Example: `234`
`extra_data`	`string`	Any extra data associated with the score. Example: `Level 2`
`user`	`string`	If this is a user score, this is the display name for the user. Example: `nilllzz`
`user_id`	`integer`	If this is a user score, this is the user's ID. Example: `17741`
`guest`	`string`	If this is a guest score, this is the guest's submitted name. Example: `guestname`
`stored`	`string (date)`	Returns when the score was logged by the user. Example: `1 week ago`
`stored_timestamp`	`int`	Returns the timestamp (in seconds) of when the score was logged by the user. Example: `1502471604`

The default value for limit is 10 scores. The maximum amount of scores you can retrieve is 100.
If table_id is left blank, the scores from the primary score table will be returned.
Only pass in the username and user_token if you would like to retrieve scores for just that user. Leave the user information blank to retrieve all scores.
guest allows you to fetch scores by a specific guest name.
Only pass either the username/user_token pair or the guest (or none), never both.
Scores are returned in the order of the score table's sorting direction. e.g. for descending tables the bigger scores are returned first.

/scores/?game_id=xxxxx&limit=10&table_id=12345
/scores/?game_id=xxxxx&limit=1&table_id=12345&username=myusername&user_token=mytoken

Affected parameter	Description	Error `message`
`table_id`	`table_id` does not refer to a table of the game	The high score table ID you passed in does not belong to this game or has been deleted.
`username` / `user_token` / `guest`	Provided user info and guest info	'username' and 'guest' are mutually exclusive
`better-than` / `worse-than`	Only one of `better-than` and `worse-than` can be used	'better-than' and 'worse-than' are mutually exclusive

Version	Description
1.2	Added `stored_timestamp` result field Added `better_than` and `worse_than` parameters Added `guest` score retrieval
1.0	First implementation