Introduction

The Archievery API lets a Roblox game server report what happened in a round — who won, who scored, who showed up — and have that land in a clan's XP, ranks and medals without anyone opening the dashboard.

The public API is not released yet. This documentation is being written alongside it. Every URL, header name, limit and key format on these pages is a placeholder marked TODO and will change. Do not build against it.

Who this is for

The primary consumer is a Roblox game server. Luau is the default language in every example on this site, and the request shapes assume HttpService.

The API is equally callable from anything that speaks HTTP — a Discord bot, a leaderboard site, a CI job — but the design decisions (clan-scoped keys, XP-first endpoints) come from the Roblox case.

What it covers

Area	Status
Awarding and reading XP	Planned for launch
Reading clan, member and rank data	Planned for launch
Setting a member's rank	Planned for launch
Medals	Planned for launch
Blacklist reads	Under discussion
Webhooks	Not planned for v1 — the API does not emit events
Official SDKs	Not planned for v1

TODO: confirm which of these actually ship at launch. The list above is a proposal, not a commitment.

What it is not

It is not a replacement for the dashboard. Clan creation, ownership transfer, rank structure editing and billing all stay in the dashboard, and there are no plans to expose them.

It is not a user-facing API. A key identifies a clan, not a person — see Authentication. There is no OAuth flow for third-party apps acting on behalf of an Archievery user.

Conventions on this site

• Every code sample defaults to Luau. Pick a different language from the tabs on any block and the choice follows you across the whole site.
• Values in accent — like YOUR_CLAN_API_KEY or CLAN_ID — are placeholders you replace.
• Endpoints marked Deprecated still work. They are never hidden, because people land on them from old code.

Next

Start with the Quickstart — one Luau call, end to end.