Leaderboard API docs

Leaderboard API lets you manage teams, scores and leaderboards

Leaderboard API OpenAPI Spec

Get the most up-to-date Open API specification for leaderboard API here: https://api.leaderboardapi.com/swagger

Swagger

GET https://api.leaderboardapi.com/swagger

Get the latest up-t-date open api specification for the leaderboard API.

Path Parameters

Name	Type	Description
	string

200

openapi: 3.0.0
info:
  title: Leaderboard API
  description: A simple leaderboard API that helps manage teams, games and players.
  version: 1.0.0
servers:
  - url: http://api.example.com/v1
    description: Optional server description, e.g. Main (production) server
  - url: http://staging-api.example.com
    description: Optional server description, e.g. Internal staging server for testing
paths:
  /liveness:
    get:
      description: Returns the readiness of the service
      operationId: ping
      x-eov-operation-id: ping
      x-eov-operation-handler: healthcheck
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                properties:
                  status:
                    type: string
                    example: OK
        "401":
          $ref: "#/components/responses/401"
        "404":
          $ref: "#/components/responses/404"
        "500":
          $ref: "#/components/responses/500"
  

Client credentials

In order to generate valid client credentials, visit https://leaderboardapi.com/dashboard after you've signed up.

Sign up to Leaderboard API here

Liveness

GET https://api.leaderboardapi.com/liveness

Liveness probe endpoint to check if the API is online and live.

200

{ "message": "OK" }

500

Token

GET https://api.leaderboardapi.com/token

This endpoint allows you to get an authorization token

Headers

Name	Type	Description
x-client-secret	string	Your client secret
x-client-id	string	Your client id

200 Successfully generated auth token.

{ authToken: <your_auth_token_jwt> }

401 Request lacks valid authentication credentials

{ "message": "Invalid Credentials" }

Team

GET https://api.leaderboardapi.com/team/:id

Get a team (by id) or get all teams that belong to your client-id (your client id is generated when you sign up and used to get a valid authorization token).

Path Parameters

Name	Type	Description
id	string	teamId

Headers

Name	Type	Description
Authorization	string	Bearer token

200

{
  "teamName": "Greenbay Packers",
  "id": "001456732910846354678",
  "createdAt": "",
  "modifiedAt": ""
}

Leaderboard

POST https://api.leaderboardapi.com/leaderboard

Path Parameters

Name	Type	Description
	string

200

Team

POST https://api.leaderboardapi.com/team

Teams belong to leaderboards. You will need to create a leaderboard before creating teams.

Headers

Name	Type	Description
Authorization	string	Bearer token JWT

Request Body

Name	Type	Description
leaderboardId	string	leaderboard id the team belongs to
teamName	string	team name

201

{
  "teamName": "A Team",
  "id": "001456732910846354678",
  "createdAt": "",
  "modifiedAt": ""
}

401

{
  "message": "Not Authorized"
}

Team

PUT /v1/team/:id

Path Parameters

Name	Type	Description
id	string	teamId associated with the team being PUT

Headers

Name	Type	Description
Authorization	string	Bearer token

Request Body

Name	Type	Description
team	object	team details you'd like to update

200

Team

DELETE /v1/team/:id

Path Parameters

Name	Type	Description
id	string	teamId

Headers

Name	Type	Description
Authorization	string	Bearer token

201

no response

401

{
  "message": "Not Authorized"
}

Leaderboard

POST /v1/leaderboard

Create a new leaderboard

Headers

Name	Type	Description
Authorization	string	Bearer token

Request Body

Name	Type	Description
teams	array	teams to add to the leaderboard

201

{
  "name": "leaderboard name",
  "id": "123789345678",
  "createdAt": "",
  "modifiedAt": ""
}