Nexus Mods API

A compressed digest of https://api.nexusmods.com/openapi.yaml (v3, ~130 KB). Work from this file; open the spec only for what it leaves out (see When this file is not enough).

Auth

Read the key from NEXUS_API_KEY, then NEXUSMODS_API_KEY. If neither is set, stop and tell the user to set one of them as an environment variable, with a key created at https://www.nexusmods.com/settings/api-keys.

Every v1, v2 and v3 call sends the key as header apikey: <key> and a descriptive User-Agent (e.g. <tool-name>/<version>). v3 bodies are JSON (Content-Type: application/json); responses wrap the payload in data.

Writes need confirmation

Before any call that publishes or cannot be undone, list the exact request bodies, every optional field included with the value you will send or its default, and wait for the user's go-ahead: creating a file or file version, adding a changelog, editing the mod page, quarantining a version.

IDs

v3 path {id}s are global IDs, not the numbers in site URLs.