Skip to main content

Mod Manager / Launcher Integration

For third-party tools (Vortex-style managers, launchers, Discord bots) that browse mods across all games on AyakaMods.

Getting a key​

This tier is issued manually so we can attach fair-use limits.

  1. Contact AyakaMods staff to request API access (link on the main site once live).
  2. Tell us: your tool's name, what it does, and roughly its expected request volume.
  3. Staff review and issue you an unrestricted key (zero game bindings = browses all public games).

There is no wizard for this tier - it is a short request-and-issue flow.

What your key can do​

  • List and read mods across every public game: GET mods/
  • Read categories, versions, updates, reviews, comments
  • Resolve download URLs per version

Typical flow​

  1. GET mod-games/ - list games you can offer.
  2. GET mods/?game_id=...&order=download_count - browse a game's mods. (You may filter by game_id on this tier since you are unrestricted.)
  3. GET mods/{id}/versions/ - list versions for install/update.
  4. GET mod-versions/{id}/download?file={fileId} - fetch the file, with your key.

Rules​

  • Always fetch downloads through the API download endpoint, never a cached raw URL - see Acceptable Use.
  • Respect rate limits (returned per key).
  • Attribute AyakaMods as the source in your UI.