API v1

JSON for the modlists on this site.

Endpoints

Method Path Returns
GET /api/v1/modlists/ Every modlist
GET /api/v1/modlists/{slug}/ One modlist and its profiles
GET /api/v1/modlists/{slug}/archives/ The archives a modlist downloads
GET /api/v1/games/{game_name}/shared-mods/ Mods two or more of a game's modlists share
GET /api/v1/games/{game_name}/known/ Plugins and DLLs a game's modlists install

Conventions

Method
Every endpoint is a GET.
Data
A modlist's data comes from its newest stored version.
Links
Links to this site are root-relative paths.
Sizes
Bytes.
Times
UTC, ISO 8601.
Success
200 with {"status": "success", "data": {...}}
Not found
404 for an unknown slug or game, a game with no modlists, or an out-of-range ?min.

Error body

{"status": "error", "error": "The requested URL was not found on the server. ...", "meta": {"request_id": "44ced1b3-0505-4d83-8477-a7f2bce1eea5"}}

Game identifiers

{game_name} is Wabbajack's game identifier.

{game_name} Game
fallout4 Fallout 4
falloutnewvegas Fallout New Vegas
skyrimspecialedition Skyrim Special Edition

GET /api/v1/modlists/

Every modlist, sorted by game, then title.

Modlist fields

Field Type Meaning
slug string The modlist's identifier here; the {slug} in the paths below.
title string Display name.
url string The modlist in this API.
page_url string The modlist's page on the site.
game string A game identifier.
version string The modlist's version.
date_updated string When that version was published.
installed_size integer The finished install, in bytes.
archive_count integer The number of archives the installer downloads.
nsfw boolean Wabbajack marks the modlist NSFW.
official boolean Wabbajack marks the modlist official.
Example response 
{
  "status": "success",
  "data": {
    "modlists": [
      {
        "slug": "themidnightride",
        "title": "The Midnight Ride",
        "url": "/api/v1/modlists/themidnightride/",
        "page_url": "/modlist/themidnightride/",
        "game": "fallout4",
        "version": "26.7.26",
        "date_updated": "2026-07-26T02:47:18.4117807Z",
        "installed_size": 214748364800,
        "archive_count": 1412,
        "nsfw": false,
        "official": true
      }
    ]
  }
}

GET /api/v1/modlists/{slug}/

One modlist and its profiles.

Parameters

{slug}
path; a slug from the modlist list.

Fields

Also slug, title, game, version, date_updated, nsfw, official, installed_size and page_url, as in the list.

Field Type Meaning
machine_url string The modlist's ID in the Wabbajack repository.
author string The modlist's author.
description string The modlist's own description.
maintainers string[] Maintainer accounts.
tags string[] Wabbajack's tags for the modlist.
readme_url, website_url, discord_url, image_url string | null Links the modlist publishes.
download_size integer The .wabbajack file itself, in bytes.
archives_size integer Everything the installer downloads, in bytes.
wabbajack_version string The Wabbajack version that compiled the modlist.
archives_url string The modlist's archives in this API.
profiles object[] Mod Organizer 2 profiles: name, slug and files.
profiles[].files object[] The profile's Mod Organizer 2 files: filename, and a url that returns the file as plain text.
Example response 
{
  "status": "success",
  "data": {
    "slug": "themidnightride",
    "machine_url": "TheMidnightRide",
    "title": "The Midnight Ride",
    "game": "fallout4",
    "version": "26.7.26",
    "date_updated": "2026-07-26T02:47:18.4117807Z",
    "author": "ModdingLinked",
    "description": "A modlist.",
    "maintainers": ["github/Ungeziefi"],
    "tags": ["Stability"],
    "nsfw": false,
    "official": true,
    "readme_url": "https://example.invalid/readme",
    "website_url": null,
    "discord_url": "https://discord.gg/x",
    "image_url": null,
    "download_size": 52428800,
    "archives_size": 107374182400,
    "installed_size": 214748364800,
    "wabbajack_version": "2.2.2.0",
    "page_url": "/modlist/themidnightride/",
    "archives_url": "/api/v1/modlists/themidnightride/archives/",
    "profiles": [
      {
        "name": "The Midnight Ride",
        "slug": "themidnightride",
        "files": [
          {
            "filename": "modlist.txt",
            "url": "/modlist/themidnightride/profile/themidnightride/file/modlist.txt"
          }
        ]
      }
    ]
  }
}

GET /api/v1/modlists/{slug}/archives/

Every archive the modlist downloads, in the order its .wabbajack file lists them.

Parameters

{slug}
path; a slug from the modlist list.

Fields

Field Type Meaning
modlist object The modlist: slug, title, url.
version string The modlist version the archives belong to.
archives[].filename string The archive's filename.
archives[].name string The mod name when the source provides one, otherwise the filename.
archives[].size integer In bytes.
archives[].archive_hash string Wabbajack's xxHash64 of the archive, base64-encoded.
archives[].source_type string One of nexus, http, google_drive, mega, mediafire, manual, wabbajack_cdn or game_file, a file from the game install.
archives[].mod_url string | null Links to the mod.
archives[].file_url string | null Links to this file.
archives[].mod_version string | null The mod's version, when the source provides one.
archives[].mo2_folders string[] The Mod Organizer 2 mod folders built from the archive.
Example response 
{
  "status": "success",
  "data": {
    "modlist": {
      "slug": "themidnightride",
      "title": "The Midnight Ride",
      "url": "/api/v1/modlists/themidnightride/"
    },
    "version": "26.7.26",
    "archives": [
      {
        "filename": "UFO4P-4598-2-1-5.7z",
        "name": "Unofficial Fallout 4 Patch",
        "size": 115343360,
        "archive_hash": "ObVYhfLLgsg=",
        "source_type": "nexus",
        "mod_url": "https://www.nexusmods.com/fallout4/mods/4598",
        "file_url": "https://www.nexusmods.com/fallout4/mods/4598?tab=files&file_id=7",
        "mod_version": "2.1.5",
        "mo2_folders": ["Unofficial Fallout 4 Patch"]
      },
      {
        "filename": "Data_DLCRobot.esm",
        "name": "Data_DLCRobot.esm",
        "size": 1812,
        "archive_hash": "0o3x9+jxQCI=",
        "source_type": "game_file",
        "mod_url": null,
        "file_url": null,
        "mod_version": null,
        "mo2_folders": []
      }
    ]
  }
}

GET /api/v1/games/{game_name}/shared-mods/

Mods downloaded by two or more of the game's modlists, most-shared first.

Parameters

{game_name}
path; a game identifier.
?min=N
query, optional; the mods at least N modlists share, from 2 up to the game's modlist count. Defaults to 2.

Fields

Field Type Meaning
game string The game identifier asked for.
min_lists integer The N in effect.
modlists object[] All of the game's modlists: slug, title, url.
mods[].name, mods[].url string, string | null The mod and its link.
mods[].files object[] The mod's archives across the modlists: filename, url.
mods[].modlists object[] The modlists that download the mod.

Archives with the same mod_url are one mod, so versions of a Nexus mod match. Without a mod_url, source and filename must match.

Example response 
{
  "status": "success",
  "data": {
    "game": "fallout4",
    "min_lists": 2,
    "modlists": [
      {"slug": "otherlist", "title": "Other List", "url": "/api/v1/modlists/otherlist/"},
      {"slug": "themidnightride", "title": "The Midnight Ride", "url": "/api/v1/modlists/themidnightride/"}
    ],
    "mods": [
      {
        "name": "Unofficial Fallout 4 Patch",
        "url": "https://www.nexusmods.com/fallout4/mods/4598",
        "files": [
          {
            "filename": "UFO4P-4598-2-1-5.7z",
            "url": "https://www.nexusmods.com/fallout4/mods/4598?tab=files&file_id=7"
          }
        ],
        "modlists": [
          {"slug": "otherlist", "title": "Other List", "url": "/api/v1/modlists/otherlist/"},
          {"slug": "themidnightride", "title": "The Midnight Ride", "url": "/api/v1/modlists/themidnightride/"}
        ]
      }
    ]
  }
}

GET /api/v1/games/{game_name}/known/

Every plugin and DLL the game's modlists install, with the mod folders that ship each.

Parameters

{game_name}
path; a game identifier.

Fields

Field Type Meaning
game string The game identifier asked for.
modlists object[] All of the game's modlists: slug, title, url.
files[].filename string The plugin or DLL. Filenames match case-insensitively.
files[].kind string plugin or dll.
files[].providers object[] The mod folders that contain the file. Same-named folders across modlists are one provider.
providers[].mod string The mod folder's name.
providers[].links object[] The downloads that feed the folder: name, url.
providers[].modlists object[] The modlists that install the folder.
Example response 
{
  "status": "success",
  "data": {
    "game": "fallout4",
    "modlists": [
      {"slug": "themidnightride", "title": "The Midnight Ride", "url": "/api/v1/modlists/themidnightride/"}
    ],
    "files": [
      {
        "filename": "f4se_plugin.dll",
        "kind": "dll",
        "providers": [
          {
            "mod": "F4SE",
            "links": [{"name": "f4se.7z", "url": "https://f4se.silverlock.org/f4se.7z"}],
            "modlists": [
              {"slug": "themidnightride", "title": "The Midnight Ride", "url": "/api/v1/modlists/themidnightride/"}
            ]
          }
        ]
      }
    ]
  }
}