Gamezop Leaderboards API

Some games may have multiple types of scores. You can use Gamezop Leaderboard APIs to distinguish them from one another.

Understanding Leaderboards

Let's say there's an endless runner game with 2 modes: "easy" and "hard". If you wanted to create leaderboards for the game for your users, it would only be fair that there are 2 separate leaderboards — one for the easy mode, and one for the hard mode.

To be able to do that, you need to distinguish which mode the user was playing in when we post a score to your webhook. This is where Leaderboards come in. Scores are not recorded against a game, they are recorded against a Leaderboards. A game may have more than one Leaderboard. Once again, please note these are not user-facing leaderboards within games. This is way to add context to the scores we broadcast to you.

Most games have a single Leaderboard. This document is useful if you're taking a game from us which has multiple Leaderboards.

---

Get all Leaderboards for a game

The Leaderboards API can be used to fetch details of all the Leaderboards that can be made for a particular game.

API endpoint

GET https://pub.gamezop.com/v2/leaderboards/info?code={game-code}

The API returns a list of all Leaderboard IDs for any game, along with a description of what that Leaderboard captures.

Query parameters

Name	Description
code*	Unique code assigned to each game — this is the code value received in the All Games API

Sample response

The response contains an array of leaderboards objects. Each object contains the following:

Key	Description
leaderboardId	A unique identifier for the leaderboard
name
description

Note: If you send an invalid game-code in the request, you will get a null array.