Skip to main content

Endpoints

All paths are relative to /api/. Read endpoints are what a mod browser needs; write endpoints are gated by your key's scopes.

Games

MethodPathScopeNotes
GETmod-games/game:readGames visible to your key. Scoped key = just your game(s).
GETmod-games/{game_id}/game:readOne game. 403 if out of scope.

Categories

MethodPathScopeNotes
GETmod-categories/mod_category:readCategory tree.
GETmod-categories/flattened/mod_category:readFlat list (easy dropdown).
GETmod-categories/{category_id}/mod_category:readOne category.

Mods

MethodPathScopeNotes
GETmods/mod:readPaginated list. Filters below.
GETmods/{mod_id}/mod:readOne mod, verbose. 403 if out of scope.
GETmods/{mod_id}/updates/mod:readPaginated changelog/update posts.
GETmods/{mod_id}/reviews/mod_rating:readPaginated reviews.
GETmods/{mod_id}/versions/mod:readAll versions (versioned mods only).

List filters (query string on GET mods/):

  • page (int)
  • prefix_id (int)
  • type (free | paid)
  • creator_id (int) - mods by one author
  • order (last_update | mod_date | rating_weighted | download_count | title)
  • direction (asc | desc)

You do not pass game_id - scope is applied server-side.

Versions & downloads

MethodPathScopeNotes
GETmod-versions/{version_id}/mod:readOne version.
GETmod-versions/{version_id}/download?file={attachment_id}mod:readLocal file: streams it. External: 302 redirect to the external URL.

How download info appears on a version result:

  • External mod - download_url (string) + optional download_urls (string[] mirrors). Point the user at those.
  • Local (hosted) mod - files[], each { id, filename, size, download_url }. That download_url is the API download endpoint - call it with your key to stream the bytes.
Always call the download endpoint

Do not cache or hand out a raw storage URL. Always fetch through mod-versions/{id}/download with your key so access stays revocable. See Acceptable Use.

Updates / Reviews / Comments

MethodPathScope
GETmod-updates/ , mod-updates/{id}/mod:read
GETmod-reviews/ , mod-reviews/{id}/mod_rating:read
GETmod-comments/ , mod-comments/{id}/mod:read

Write endpoints (optional)

Only usable if your key has write scopes. Developer keys are read-only (mod:read + game:read) by default; write access is a manual upgrade.

  • POST mods/ - create a mod (requires game_id in body; must be your game or 403).
  • POST mods/{mod_id}/ - edit.
  • DELETE mods/{mod_id}/ - delete (soft by default).
  • POST mod-versions/ - publish a new version of a mod.