One API for web, app and gateway

Sign in with email / handle / phone / Epic ID + password. Returns a bearer token.

{
  "identifier": "string",
  "password": "string"
}

Send a 6-digit sign-in code over WhatsApp (delivered by the gateway).

{
  "phone": "+9689…"
}

Verify the code and receive a bearer token.

{
  "phone": "+9689…",
  "code": "123456"
}

Revoke the current token.

The signed-in player: card, division, clan progress, active entries, unread count and linked accounts (Epic Games, Discord, Twitch: ids and names).

Upload a profile photo (multipart/form-data, field "file", max 4 MB). Re-encoded server-side; location/camera data removed. DELETE removes it.

Your invite code and link (/r/{code}), how many joined and how many counted (finished a first cup), Recruiter trophies, who invited you and your recruits.

"Were you invited?": add the inviter’s code or @handle. Allowed in the first week, before finishing a cup, once.

{
  "code": "invite code or handle"
}

Public profile, trophies and cup history.

Nitro: the season counting now (dates, rules), its top list and reserves; with a player token also `me` (points, rank, cups, toSeat, statement with multiplier and clan bonus) and `seats` (their Nitro cup seat: offered, confirmed, reserve …, pot and partner after the draw).

Answer your Nitro cup seat. A seat given up goes to the next reserve; errors noSeat, nitroDrawn.

{
  "answer": "take | giveUp"
}

Season ranking. Query: scope=all|clan, country=OM, limit, offset.

Latest notifications, written in the player’s language (query: lang=ar|en overrides their setting). Each has priority (normal|critical), ref and actions (buttons).

Answer a notification’s button: accept/decline a team invite or lineup seat, approve a join request, ready up, confirm a reported score.

{
  "ref": "note.ref",
  "action": "accept|decline|approve|ready|confirm"
}

The live help page: questions and answers generated from the platform’s rules plus the Council’s own. Query: lang=ar|en.

Mark all notifications as read.

Report a fair-play problem (cheating, teaming, toxicity, smurfing, dispute, other). JSON, or multipart/form-data with up to 3 screenshots in files (private to the reporter and the Referees). Reporters hear back as a notification.

{
  "kind": "cheating|teaming|toxicity|smurfing|dispute|other",
  "body": "string (10+ chars)",
  "target": "@handle or Epic name?",
  "tournamentId": "uuid?",
  "matchId": "uuid?",
  "links": "[url]?"
}

Polls you can see, newest first, with tallies and your vote (sign in to see clan and tier polls). Query: open=1 for polls still taking votes. openBallot=true means admins can see who picked what.

Vote, or change your vote, while the poll is open.

{
  "optionId": "o1"
}

The players who finished the most cups lately (Hermes’ weekly Top Participants). Query: days=7|30 (default 7), limit (default 10).

Permanent teams: ?mine=1 (signed in) lists yours with your role and status; otherwise the public list by Glory, ?q= searches names and tags.

Start a team; you become its captain. The name may be Arabic; hue is the badge colour 0–359 (0 is red).

{
  "name": "string (3–24)",
  "tag": "string (2–5, letters/digits)",
  "bio": "string?",
  "country": "ISO code?",
  "hue": "number?",
  "openToRequests": "boolean?"
}

One team: members (as each player chose to show them), cups, and for its members the join code; the captain also sees invites and requests waiting.

Team actions, the same rules as the website: update (as POST /squads), invite { handle }, respond { accept }, request, answer { userId, approve }, remove { userId }, captain { userId }, leave, disband { confirmTag }. Returns the team afterwards (null after leave or disband).

Ask to join a team with its join code; the captain approves (an open team may take you straight away).

{
  "code": "string"
}

Captain uploads the team logo (multipart/form-data, field "file"). DELETE removes it.

Live standings of a points cup (the cup page refreshes from here every 15 s while it's live).

List cups. Query: view=upcoming|live|results|all.

The cup calendar: published cups plus the editions recurring series will make (projected: true, no slug yet), with titles already numbered. Query: days=30 (up to 120).

Cup detail: entries, standings, your team and match key when unlocked.

Messages from the organisers for you (everyone entered, or privately for your team: lobby codes, delays, instructions) and your conversation with them. Reading marks their replies as seen.

Write to the organisers about this cup. Their answer comes back as a notification (and on WhatsApp).

{
  "body": "string (≤ 1000)"
}

Enter a cup (solo) or create a team (returns a squad code).

{
  "teamName": "string (team modes)"
}

A full cup: join its waitlist (first come, first served). When a seat frees up the entry is made for you and you get a must-see note. Returns your position.

{
  "teamName": "string (team cups)"
}

Leave the waitlist.

During ready-up: stand by so a freed seat comes to you first (solo players are readied up automatically when they get it).

{
  "on": "boolean (default true)"
}

Join a team with a squad code.

{
  "squadCode": "ABC123"
}

Ready up during the ready-up window.

Leave a team before rosters lock.

Knockout / groups cups: group tables and fixtures, the knockout tree by round, the third-place match and your own match.

Captains report a head-to-head series score. The other captain confirms it, or reports a different score (→ dispute for the Referees).

{
  "scoreA": "number",
  "scoreB": "number"
}

The opposing captain accepts the reported score; the winner moves on.

The opposing captain rejects the reported score.

{
  "reason": "string?"
}

Clan Arena members: recent V-Bucks transfers (both ways) and how many are left today.

Clan Arena members: send spendable V-Bucks to another member by member number, at once. Errors: clanOnly, noMember, self, transferAmount, transferLimit, notEnough, transfersOff.

{
  "to": "#0042",
  "amount": "100"
}

Your wallet: spendable V-Bucks and cash (cash in cents with its currency), credits ready / on the way (unlocksAt) / locked (requires: epic|phone|clan|firstCup), Item Shop gift orders and cash payouts with their status, and stipends (clan tier or personal: amount, frequency daily|weekly|monthly) with their activity rules.

Claim cash from the wallet. The amount is held until the Council pays or declines (declined = money back).

{
  "amount": "number (in the platform currency)",
  "method": "bank|paypal|stcpay|wallet|other",
  "account": "string"
}

Today’s Fortnite Item Shop: items with EN/AR names, type (outfit, pickaxe, emote, glider, wrap, bundle…), rarity, series, price in V-Bucks, image, section, bundle contents and whether it can be gifted.

Send a basket from today’s shop as a gift request, paid from the wallet. The Council approves and gifts it to your Epic account, or declines (V-Bucks back).

{
  "offerIds": "string[] (1–10)",
  "note": "string?"
}

What the community has won: V-Bucks, Battle Passes and cash (in cents of `currency`), including the lifetime figures from before the platform. For posters (the rewards strip) and apps.

The services catalogue (coaching, scrims, replay reviews, account help…) with each service’s questions (fields: key, label/labelAr, type text|long|number|select|epic|phone|date, required, options). With a player token each service also has access: open|clanOnly|tierTooLow|full|alreadyOpen|closed.

One service and its questions.

Ask for a service. Answers are keyed by field key; a wrong answer returns 422 invalidAnswers with fields [{ key, error: required|invalid|tooLong }]. A price is held from the wallet (held) and returned if declined or cancelled.

{
  "answers": "{ [fieldKey]: string }"
}

Your service requests, newest first: status new|in_review|approved|done|rejected|cancelled, answers, V-Bucks held and the Council’s note.

Cancel a request the Council hasn’t approved yet (V-Bucks back).

Translate a chat message (to: ar | en) with Arena AI; kept once per message and language. Returns the text, or an id to poll at /api/v1/ai/tasks/{id}.

{
  "to": "ar | en"
}

Rooms you can open, with unread counts.

Messages. Query: before, after, limit.

Send a message.

{
  "body": "string",
  "replyTo": "number?"
}

Live updates (Server-Sent Events: messages, sync).

Mark a room as read.

Toggle a reaction.

{
  "emoji": "🔥 | 👑 | 😂 | 💀 | 🎯 | 👏 | GG"
}

Delete your message (Referees: any message).

"Ask Arena": a question for Arena AI, answered from the platform's rules, cups and (signed in) the player's own account. Returns an id; poll GET /api/v1/assistant/{id} (answers usually take 5–10 s). Signed-in players get 40 questions a day, visitors 8.

{
  "question": "string (3–500)",
  "locale": "en | ar"
}

The answer: status pending/running/done/failed, then answer and up to 3 links inside the platform. Only the person who asked can read it.

Council only: Arena AI drafts the other language (Modern Standard Arabic or English) of a text. Poll GET /api/v1/ai/tasks/{id}.

{
  "text": "string",
  "to": "ar | en"
}

A translation or answer you asked for: status and output.

The player's latest coach card from Arena AI (headline and three tips in both languages, from their recent cups).

"Coach me": a new card from the player's recent cups (poll GET /api/v1/ai/tasks/{id}); at most three a day.

Your Arena Guard record: strikes in the last 30 days, a chat mute if any, and the decisions of the last 90 days with their reasons in both languages.

Appeal a guard decision; a Referee looks again.

{
  "text": "string (5–600)"
}

Report someone else's chat message: Arena AI looks at once, and a Referee sees the outcome. Posting a message can answer 423 "muted" or 400 "guardBlocked_<category>" (header X-Guard-Until when muted).

{
  "reason": "string?"
}

The AI executor (the worker next to Hermes) takes the next Arena AI tasks, most urgent first: { id, kind, tier fast|writer, messages, maxTokens }. wait=0–25 holds the request until work arrives.

The executor posts the model's answer for a task it took (or why it couldn't); the platform checks it and applies it.

{
  "content": "string?",
  "error": "string?",
  "model": "string?"
}

Create or enrich a player from WhatsApp / Instagram (never overwrites website edits). Invites: referralCode (the code or @handle they were given) or referredByPhone records who invited them; ownReferralCode keeps their Hermes code. Returns their own code and link.

{
  "phone": "+9689…",
  "instagram": "handle",
  "displayName": "string",
  "epicId": "string?",
  "country": "OM",
  "platform": "pc|playstation|xbox|switch|mobile",
  "locale": "ar|en",
  "referralCode": "string?",
  "referredByPhone": "+9689…?",
  "ownReferralCode": "string?"
}

Bulk migrate up to 500 existing players per call. Idempotent. Keeps Hermes invite codes (ownReferralCode) and who invited whom (referralCode / referredByPhone), in any order.

{
  "players": "[{ phone, displayName, epicId, ownReferralCode, referralCode, … }]"
}

Look a player up by phone, instagram, epicId or handle: status, entries, tryout, and their invite code, link and counts.

One match of a points cup from a replay: every player’s placement and kills. Players are matched by Epic account id or Epic name (old names too); team rows are built from them (best placement, summed kills) and teams the replay misses keep what the Council entered. A resent replaySha is ignored. Returns matched and unmatched names; 422 duplicatePlacement lists the clashing teams.

{
  "tournament": "slug",
  "match": "number",
  "replaySha": "string?",
  "players": "[{ epicAccountId?, epicId?, placement, kills, damage? }]"
}

A player reports a fair-play problem over WhatsApp / Instagram (with clip links); it lands in the Referees’ queue.

{
  "phone": "+9689…",
  "kind": "cheating|teaming|toxicity|smurfing|other",
  "body": "string",
  "target": "@handle or Epic name?",
  "tournament": "slug?",
  "links": "[url]?"
}

Studio jobs for Hermes (also sent as render_request / publish_request outbox messages). Query: status=requested,approved.

Hermes delivers the rendered files for a requested piece (https links from its media library, images or videos, up to 10) and caption drafts; the Council reviews them in the studio.

{
  "assets": "[{ url, kind: image|video, label? }]",
  "captionEn": "string?",
  "captionAr": "string?"
}

Hermes suggests Fortnite news from the feeds it watches (Epic news, server status, patch notes), up to 20 at a time. Each waits on the Council's News page to be edited and published, or dismissed; a repeated id is ignored.

{
  "items": "[{ id, source, url?, imageUrl?, title, titleAr?, body, bodyAr?, urgent? }]"
}

Hermes reports an approved piece as published (each target with the platform’s id and/or permalink; at least one is required) or failed.

{
  "status": "published|failed",
  "receipts": "[{ target, id?, url?, error? }]",
  "error": "string?"
}

Enter a player into a cup or join a team by squad code. With waitlist: true a full cup puts the player on its waitlist instead (202 with their position).

{
  "phone": "+9689…",
  "tournament": "slug",
  "teamName": "string?",
  "waitlist": "boolean?",
  "squadCode": "string?"
}

Query: phone or instagram. Whether the player is verified (معتمد), the checklist (epic, phone, friendAccount) and their last request (pending / approved / rejected with the Council note).

The approval form collected on WhatsApp / Instagram joins the Council verification queue; the decision comes back as outbox verification_update. Errors: elig_epic, friendRequest, verifyPending, alreadyVerified.

{
  "phone": "+9689…",
  "friendRequest": "boolean",
  "note": "string?"
}

Ready up for a cup (the reply to a ready_up message). Only in the ready-up window and for a full team; errors: notEntered, checkinClosed, rosterIncomplete.

{
  "phone": "+9689…",
  "tournament": "slug"
}

Leave a cup ("I can’t make it") before it locks, freeing the seat; errors: notEntered, locked, inBracket.

{
  "phone": "+9689…",
  "tournament": "slug"
}

Submit a Clan Arena tryout.

{
  "phone": "+9689…",
  "message": "string",
  "answers": "{ hours, bestPlacement, role }"
}

Query: phone (or instagram) and tournament. What the organisers sent this player about the cup (lobby codes, updates) and their conversation.

A player’s WhatsApp / Instagram message to the organisers about a cup; it lands in the Council inbox.

{
  "phone": "+9689…",
  "tournament": "slug",
  "body": "string (≤ 1000)"
}

Query: phone (or instagram). “My Nitro points”: the player’s points, place, statement and seat, with the season list (same shape as /api/v1/nitro).

The player answers their Nitro cup seat from WhatsApp (the reply to a nitro_seat message). Proven numbers only.

{
  "phone": "+9689…",
  "answer": "take | giveUp"
}

A Clan Arena member sends V-Bucks to another member (member number), same limits as the website. Proven numbers only; confirm the recipient’s name with the player first.

{
  "phone": "+9689…",
  "to": "#0042",
  "amount": "100"
}

Integrity partner: a clan member who played sends one link to their replay files within the window; errors clanOnly, notPlayed, replayWindow, replaySlotsFull, replayAlready.

{
  "phone": "+9689…",
  "tournament": "slug",
  "url": "https://…"
}

Query: phone (or instagram), proven numbers only. The player’s wallet, so the assistant can answer “how many V-Bucks do I have?” and “where is my gift?”.

A player picks items from today’s shop on WhatsApp / Instagram; the gift request (paid from their wallet) joins the Council’s queue.

{
  "phone": "+9689…",
  "offerIds": "string[] (1–10)",
  "note": "string?"
}

A player claims cash on WhatsApp (proven number only); it joins the Council’s payout queue.

{
  "phone": "+9689…",
  "amount": "number",
  "method": "bank|paypal|stcpay|wallet|other",
  "account": "string"
}

Feed the day’s Item Shop (when Hermes already builds the daily shop post). GET returns today’s shop.

{
  "day": "YYYY-MM-DD?",
  "items": "[{ offerId, name, nameAr?, type, rarity, price, image?, section?, giftable? }]"
}

The services catalogue for the assistant’s menu, with each service’s questions. With phone (or instagram) each service also says whether that player can ask for it now (access).

A player asks for a service on WhatsApp / Instagram (create or enrich the player first). Same rules and queue as the website; 422 invalidAnswers lists the answers to ask again. Status changes come back through the outbox as service_update.

{
  "phone": "+9689…",
  "answers": "{ [fieldKey]: string }"
}

Query: phone (or instagram). The player’s service requests and where each one is.

Messages to deliver: otp, ready_up (ready-up is open for a full team: ask the player to reply, then POST /gateway/checkin), roster_incomplete (to a captain whose team is short when ready-up opens), verification_update (approved / rejected with the Council note), match_key, match_ready, bracket_draw, tournament_results, tournament_announced, announcement, referral_joined, referral_counted, cup_message, cup_reply, wallet_update (gift or payout status), service_update (service request status), social_post (channel "social": public posts in EN/AR with a link and image).

Acknowledge delivery.

{
  "items": "[{ id, status: sent|failed, error? }]"
}

For an operator key (made by the Founder on Council → Gateway): the Council account it acts as (@hermes), the queues waiting (count, oldest, urgent), and every Council action with its scope, the power it needs, and whether this key may use it now.

One page of a queue, oldest first: gifts, payouts (account masked), verify, tryouts, reports, services or guard. ?limit= up to 50. Money requests list linked accounts (same device, payout account or Epic account).

A short player summary: role, tier, Glory, Epic (and whether it is proven), verified, open reports, wallet, linked accounts. No phone, email or payout details.

Does one Council action as the key’s account, under every Council rule (powers, conflicts of interest, linked accounts, decided once, audit log). Money actions (gift.approve, gift.gifted, payout.approve, payout.paid, wallet.grant, cup.finalize) need council:money. Errors: forbidden, linkedToYou, grantedByYou, resetByYou, ownRequest, alreadyDecided, notFound.

{
  "action": "gift.approve | gift.gifted | gift.reject | payout.approve | payout.paid | payout.reject | wallet.grant | verification.approve | verification.reject | application.approve | application.reject | report.resolve | report.dismiss | service.decide | guard.uphold | guard.overturn | chat.mute | cup.status | cup.finalize",
  "id": "uuid (most actions)",
  "note": "string?"
}