Introduction#

The Gamearly API lets your project integrate tightly with the Gamearly platform: link your users with their Gamearly accounts, create custom API quests, report task completions so players earn XP and rewards, verify game ownership, and stream in-game events back for analytics and event-driven quests.

Base URL#

Every endpoint in this documentation lives under a single host:

https://api.gamearly.com/v1

There is no separate sandbox host and no second set of credentials. To try things safely, add "test": true to any write call — see Test mode.

Your first call#

Every request carries a project API key in the X-Api-Key header. Your project has two — a public key for your game build and a private key for your server. This call needs the private one; Authentication explains the split in one table.

curlNode.jsPython

curl https://api.gamearly.com/v1/quests/list \
  -H "X-Api-Key: $GAMEARLY_PRIVATE_KEY"

const res = await fetch("https://api.gamearly.com/v1/quests/list", {
  headers: { "X-Api-Key": process.env.GAMEARLY_PRIVATE_KEY },
});
const quests = await res.json();

import os, requests

res = requests.get(
    "https://api.gamearly.com/v1/quests/list",
    headers={"X-Api-Key": os.environ["GAMEARLY_PRIVATE_KEY"]},
)
quests = res.json()

Full request and response shapes for every endpoint are in the API reference, which includes a console for firing real requests.

Versioning#

Latest: v1
Docs for the current version: https://api.gamearly.com/documentation

Migration guides#

Guides to move from one version to another, and how to resolve breaking changes.

From v0 to v1#

No breaking changes.