Retrieve scores

Query for scores

GET https://api.highscore.public-function.org/v1/board/:board

Query for scores of the highscore board.

Path Parameters

Name	Type	Description
board	string	Unique identifier of the highscore board.

Query Parameters

Name	Type	Description
offset	integer	Number of scores to skip.
limit	integer	Number of score positions.

Headers

Name	Type	Description
Highscore-Secret	string	Keep this one a secret
Highscore-Api-Key	string	Api key

200

{
    "scores": [
        {},
        {}
    ]
}

Query for scores around user

GET https://api.highscore.public-function.org/v1/board/:board/user/:user

Query for scores around the user.

Path Parameters

Name	Type	Description
user	string	Unique identifier of the user in your data model.
board	string	Unique identifier of the highscore board.

Query Parameters

Name	Type	Description
less	number	Number of highscore positions with fewer score points.
more	integer	Number of highscore positions with more score points.

Headers

Name	Type	Description
Highscore-Secret	string	Keep this one a secret
Highscore-Api-Key	string	Api key

200

[
    {
        "userId":"user1",
        "score": 50,
    },
]

Query for scores around position

GET https://api.highscore.public-function.org/v1/board/:board/position/:position

Query for scores around the highscore position.

Path Parameters

Name	Type	Description
position	integer	Position in highscore board.
board	string	Unique identifier of the highscore board.

Query Parameters

Name	Type	Description
more	integer	Number of highscore positions with more score points.
less	integer	Number of highscore positions with fewer score points.

Headers

Name	Type	Description
Highscore-Secret	string	Keep this one a secret
Highscore-Api-Key	string	Api Key

200 Cake successfully retrieved.

{    "name": "Cake's name",    "recipe": "Cake's recipe name",    "cake": "Binary cake"}

404 Could not find a cake matching this query.