#181·nakama

Match History API

Author: handcircusCreated Apr 3, 2018Updated Apr 6, 2026

Description

Having a match history API would enable a lot of useful functionality for Nakama-powered titles. These include:

  • The ability to query their previous match results (similar to Clash Royale's History functionality). This is particularly useful to watch replays, see how they fared with different decks/loadouts, to contact previous opponents (to invite them to clans etc) and more
  • The ability to query match results of a particular user. Ie see results of matches of top user on leaderboard.
  • The ability to query matches between specific opponents (ie User A vs User B). How am I doing when competing with friends?
  • The ability to view results of specific matches (to support similar system to Clash's TV Royale). Maybe use tags?
  • Allowing matches to be reported for cheating

API Suggestions

Match history cold be queried with the following options:

  • Unique ID for match category (allowing filtering, similar to leaderboards)
  • Optional filter list of required opponents (1 or more).
  • Optional tag (to allow featured matches to be listed ala TV Royale)

Match history could be posted with the following options:

  • Unique ID for match category (allowing filtering, similar to leaderboards)
  • Flexible metadata (ie match conditions, level selected etc).
  • Date
  • (Optional) Replay data? If this was separate from metadata would allow bulky replay data to be removed after say X hours
  • A list of all opponents in the match (Nakama user handles)
  • For each opponent:
  • ... Score
  • ... Status (win/lose/draw/quit...)
  • ... Flexible Metadata (allowing storage of equipment used, abilities used or other data)