--- openapi: 3.0.3 info: title: Nexus Mods API version: 3.0.0 description: "## Overview\nBuild tools and integrations for the Nexus Mods platform using our API.\n\n* Access mod data, user information, and platform features to power your own applications, services, and workflows.\n* Use our OpenAPI specification to explore and integrate the API.\n\n### I want to\n#### upload a mod\n* **Using GitHub to manage your mod workflow?** Try our [GitHub action](https://github.com/marketplace/actions/upload-to-nexus-mods)\n \ and [sample workflow](https://github.com/Nexus-Mods/API-Example)!\n* Or get started at [creating a new upload session](#tag/uploads/operation/createUpload).\n\n### Legacy APIs \nLegacy integrations may still be using our [v1 API](https://app.swaggerhub.com/apis-docs/NexusMods/nexus-mods_public_api_params_in_form_data/1.0#/).\n\n### API Stability\n\nEndpoints are marked with badges indicating their stability level:\n\n| Badge | Meaning |\n| ----- | ------- |\n| *(none)* | **Stable** - Production ready. No breaking changes. |\n| Beta | Feature complete but may have minor changes before stabilisation. |\n| Experimental | May change significantly or be removed. Not recommended for production. |\n\nStable endpoints may receive additive enhancements (new optional fields/parameters)\nthat won't break existing integrations.\n\n### Deprecation Policy\n\n**Stable endpoints:** If a field or endpoint needs to change, it will be marked as\n`deprecated` with a minimum **90-day deprecation period** and migration guidance.\n\n**Beta endpoints:** Changes will be marked as `deprecated` with a minimum **10-day\ndeprecation period** and migration guidance.\n\nDeprecated fields continue to function during the deprecation period.\n\n### Upcoming Changes\n\n| Date | Change |\n| ---- | ------ |\n| 2026-11-23 | `description` is limited to 255 characters on [create mod file](#tag/mod-files/operation/createModFile) and [create a new mod file version](#tag/mod-files/operation/createModFileVersion). Longer descriptions will be rejected. |\n| 2026-12-01 | `md5` becomes required on [create upload](#tag/uploads/operation/createUpload). Single-part uploads that omit it will be rejected. |\n" contact: name: Nexus Mods url: https://nexusmods.com x-logo: url: https://api-docs.nexusmods.com/logo-light.png altText: Nexus Mods tags: - name: collections description: Collection management - name: content-settings description: A user's content preferences and blocks - name: mod-bugs description: Mod bug report triage - name: mod-files description: Mod file management - name: mods description: Mod management - name: uploads description: Upload management servers: - url: https://api.nexusmods.com/v3 description: Production server security: - ApiKeyAuth: [] - BearerJwtAuth: [] paths: "/collections/{id}": patch: tags: - collections summary: Edit collection description: "Update the core details of a collection such as the name, summary, description, and category. " operationId: editCollection parameters: - name: id in: path required: true description: The unique identifier for the collection. schema: type: integer requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/EditCollectionRequest" responses: "204": description: Successfully updated the collection. "400": "$ref": "#/components/responses/BadRequest" "403": "$ref": "#/components/responses/Forbidden" "404": description: The collection was not found. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "422": "$ref": "#/components/responses/ValidationFailed" "/content-settings": get: tags: - content-settings x-badges: - name: Experimental color: orange summary: Get my content settings description: | The authenticated user's content settings: whether they see adult content, whether adult images are blurred, and the tags and users they have blocked. A user who has never changed these settings gets the defaults: adult content hidden and adult images blurred, with nothing blocked. operationId: getContentSettings security: - ApiKeyAuth: [] - BearerJwtAuth: [] responses: "200": description: The user's content settings. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/ContentSettings" "401": "$ref": "#/components/responses/Unauthorized" "/games/{game_domain}/trending-mods": get: tags: - mods x-badges: - name: Experimental color: orange summary: Get trending mods for a game description: "Public feed of the top 5 trending mods for a game over the past\n`game.hot_mods_days` days, ranked by total endorsements. \nExcludes adult and unpublished mods.\n" operationId: getTrendingMods security: [] parameters: - name: game_domain in: path required: true description: "Game domain name (e.g. `skyrimspecialedition`). " schema: type: string responses: "200": description: Top trending mods. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/TrendingModsResponse" "404": "$ref": "#/components/responses/GameNotFound" "/games/{game_domain}/dlcs": get: tags: - mods x-badges: - name: Experimental color: orange summary: Get available DLCs for a game description: List of DLCs available for a game. operationId: getGameDlcs security: [] parameters: - name: game_domain in: path required: true description: "Game domain name (e.g. `skyrimspecialedition`). " schema: type: string responses: "200": description: DLCs available for the game. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/GameDlcsResponse" "404": "$ref": "#/components/responses/GameNotFound" "/games/{game_domain}/mods/{game_scoped_id}": get: tags: - mods x-badges: - name: Experimental color: orange summary: Get mod description: | Retrieve specified mod, from a specified game. A credential is optional. An adult mod is withheld with a 451 when the caller is not age verified and the request comes from a country that requires age verification, or from an unknown country. It is withheld with a 403 from an authenticated user whose preferences exclude adult content. operationId: getMod security: - ApiKeyAuth: [] - BearerJwtAuth: [] - {} parameters: - name: game_domain in: path required: true description: | Game domain name. This is the human readable game name which appears in URLs on the site e.g. `skyrimspecialedition` and `fallout4`. schema: type: string - name: game_scoped_id in: path required: true description: | The game-scoped identifier for the mod. This is the mod identifier which appears in URLs on the site e.g. `12604` from path `/skyrimspecialedition/mods/12604`. schema: type: string pattern: "^[0-9]+$" responses: "200": description: Mod details content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/GetModDetails" "400": "$ref": "#/components/responses/BadRequest" "404": "$ref": "#/components/responses/NotFound" "403": "$ref": "#/components/responses/Forbidden" "451": "$ref": "#/components/responses/AgeVerificationRequired" "422": description: The mod id is not a number. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "/games/{game_domain}/mod-file-versions/{game_scoped_id}": get: tags: - mods summary: Get mod file version by game-scoped ID description: "Retrieve a specific mod file version for a game by its game-scoped identifier. " operationId: getModFileVersionByGameScopedId x-badges: - name: Experimental color: orange parameters: - name: game_domain in: path required: true description: | Game domain name. This is the human readable game name which appears in URLs on the site e.g. `skyrimspecialedition` and `fallout4`. schema: type: string - name: game_scoped_id in: path required: true description: "The game-scoped identifier for the mod file version. " schema: type: string responses: "200": description: The mod file version. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/ModFileVersion" "400": "$ref": "#/components/responses/BadRequest" "404": "$ref": "#/components/responses/NotFound" "403": "$ref": "#/components/responses/Forbidden" "/games/{game_domain}/mod-file-versions/{game_scoped_id}/download-link": get: tags: - mods summary: Get download links for a mod file version description: | Issue signed CDN download links for a mod file version, and record the download. Premium users, files with direct download enabled and official files are always eligible. Other users must pass the `key` and `expires` values the website generates for them; a missing pair is rejected with 403, an invalid key with 400 and an expired one with 410. Quarantined files and mods under moderation are never downloadable. Links expire after four hours. operationId: getModFileVersionDownloadLink x-badges: - name: Experimental color: orange parameters: - name: game_domain in: path required: true description: | Game domain name. This is the human readable game name which appears in URLs on the site e.g. `skyrimspecialedition` and `fallout4`. schema: type: string - name: game_scoped_id in: path required: true description: "The game-scoped identifier for the mod file version. " schema: type: string pattern: "^[0-9]+$" - name: key in: query required: false description: Free-user download key generated by the website. Required with `expires` unless the user is otherwise eligible. schema: type: string - name: expires in: query required: false description: Unix timestamp at which `key` stops being valid. Required with `key` unless the user is otherwise eligible. schema: type: integer - name: collection_id in: query required: false description: The collection the download was started from, recorded against the download. schema: type: integer - name: Application-Name in: header required: false description: The client making the request, recorded against the download. schema: type: string - name: Application-Version in: header required: false description: The version of the client making the request, recorded against the download. schema: type: string responses: "200": description: Signed download links, one per available CDN location. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/ModFileVersionDownloadLinks" "400": description: The free-user download key is invalid. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "401": "$ref": "#/components/responses/Unauthorized" "403": description: The file is quarantined, the mod is unavailable or under moderation, or the user is not eligible without a download key. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "404": description: The game or mod file version was not found. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "410": description: The free-user download key has expired. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "422": description: The request failed validation, e.g. a non-numeric file ID. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "/mods/{id}": get: tags: - mods summary: Retrieve specified mod by id description: | A credential is optional. An adult mod is withheld with a 451 when the caller is not age verified and the request comes from a country that requires age verification, or from an unknown country. It is withheld with a 403 from an authenticated user whose preferences exclude adult content. operationId: getModById security: - ApiKeyAuth: [] - BearerJwtAuth: [] - {} x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier for the mod. schema: type: string responses: "200": description: Mod details content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/GetModDetails" "400": "$ref": "#/components/responses/BadRequest" "404": "$ref": "#/components/responses/NotFound" "403": "$ref": "#/components/responses/Forbidden" "451": "$ref": "#/components/responses/AgeVerificationRequired" patch: tags: - mods summary: Edit mod details description: | Update a mod page's summary and/or description. Only the fields present in the request are changed; omitted fields are left as they are. Text is stored in the same encoding the mod page editor uses, so the result is identical to saving the same text from the website. The caller must be on the mod's team or an admin. A mod under moderation review can only be edited by its team when staff have allowed edits. operationId: editMod x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier for the mod. schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/EditModRequest" responses: "204": description: Successfully updated the mod. "400": "$ref": "#/components/responses/BadRequest" "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/ModNotFound" "422": "$ref": "#/components/responses/ValidationFailed" "/mods/{id}/files": get: tags: - mods summary: Get mod files description: "Retrieve all mod files for a given mod. " operationId: getModFiles x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier for the mod. schema: type: string responses: "200": description: The mod's mod files. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/ModFilesResponse" "400": description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/ProblemDetails" "403": "$ref": "#/components/responses/ModForbidden" "404": "$ref": "#/components/responses/ModNotFound" "/mods/{id}/changelogs": post: tags: - mods x-badges: - name: Experimental color: orange summary: Add changelog entries for a mod version description: | Appends changelog text for a version of a mod. This is additive only: repeated calls for the same version append further text rather than replacing what's already there. operationId: addModChangelogEntries parameters: - name: id in: path required: true description: The unique identifier for the mod. schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/AddModChangelogEntriesRequest" responses: "201": description: The created changelog entries. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/AddModChangelogEntriesSuccess" "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/ModNotFound" "422": "$ref": "#/components/responses/ValidationFailed" "/mods/{id}/toggle-legacy-mod-requirements": put: tags: - mods summary: Toggle legacy mod requirements for a mod description: | Sets whether the given mod should use the legacy mod-level requirements. When `enabled` is `true`, the mod uses legacy mod-level requirements; when `false`, it uses file-to-file requirements. operationId: toggleLegacyModRequirements x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier for the mod. schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/ToggleLegacyModRequirementsRequest" responses: "204": description: Successfully updated the mod's legacy mod requirements enabled state. "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/ModNotFound" "409": description: The mod has been removed. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "422": "$ref": "#/components/responses/ValidationFailed" "/team-mods": get: tags: - mods summary: List my team mods description: | Mods the authenticated user owns or has been given access to as a team member, with each mod's bug tracker setting and open bug report count, ordered by name. These are the mods whose bug reports the user can triage through the mod bug endpoints. Removed mods are not included. operationId: getMyTeamMods x-badges: - name: Experimental color: orange parameters: - name: affiliation in: query required: false description: | Only return mods with this affiliation: * `owner` - mods the user uploaded * `contributor` - mods the user has been given access to schema: "$ref": "#/components/schemas/TeamModAffiliation" - name: page in: query required: false description: Page number (1-indexed). schema: type: integer default: 1 minimum: 1 - name: page_size in: query required: false description: Number of results per page. schema: type: integer default: 20 minimum: 1 maximum: 100 responses: "200": description: A page of the user's team mods. content: application/json: schema: type: object required: - data - meta properties: data: "$ref": "#/components/schemas/TeamModsData" meta: "$ref": "#/components/schemas/PaginationMeta" "401": "$ref": "#/components/responses/Unauthorized" "422": description: Unprocessable - invalid query parameters. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "/mod-bugs": get: tags: - mod-bugs summary: List my team mods' bug reports description: | Bug reports across every mod the authenticated user owns or is a team member of (see `getMyTeamMods`), including private reports. Reports hidden by moderators and reports on removed mods are not included. To work through reports while changing them (for example, triaging every `new` report), use `sort=oldest` with `after_id` set to the last id you have seen, rather than page numbers: a report whose status changes drops out of a status filter and would shift every later page. operationId: getMyModBugs x-badges: - name: Experimental color: orange parameters: - name: mod_id in: query required: false description: Only return reports for this mod (the mod's unique identifier). schema: type: string - name: state in: query required: false description: | Only return reports in this state: * `open` - `new`, `known_issue`, `investigating` and `needs_more_info` * `closed` - `fixed`, `duplicate`, `not_a_bug` and `wont_fix` schema: "$ref": "#/components/schemas/ModBugState" - name: status in: query required: false description: Only return reports with this status. schema: "$ref": "#/components/schemas/ModBugStatus" - name: priority in: query required: false description: Only return reports with this priority. schema: "$ref": "#/components/schemas/ModBugPriority" - name: updated_since in: query required: false description: Only return reports created or replied to at or after this time. schema: type: string format: date-time - name: after_id in: query required: false description: Only return reports with an id greater than this one. schema: type: string - name: sort in: query required: false description: | Order of the results: * `last_activity` - most recently created or replied to first * `newest` - most recently created first * `oldest` - oldest first, by id schema: type: string enum: - last_activity - newest - oldest default: last_activity - name: page in: query required: false description: Page number (1-indexed). schema: type: integer default: 1 minimum: 1 - name: page_size in: query required: false description: Number of results per page. schema: type: integer default: 20 minimum: 1 maximum: 100 responses: "200": description: A page of bug reports. content: application/json: schema: type: object required: - data - meta properties: data: "$ref": "#/components/schemas/ModBugsData" meta: "$ref": "#/components/schemas/PaginationMeta" "401": "$ref": "#/components/responses/Unauthorized" "422": description: Unprocessable - invalid query parameters. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "/mod-bugs/{id}": get: tags: - mod-bugs summary: Get a mod bug report description: | A bug report and its replies. Only the mod's team can read reports through this endpoint. Replies hidden by moderators are not included. operationId: getModBug x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier of the bug report. schema: type: string responses: "200": description: The bug report and its replies. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/ModBugWithReplies" "401": "$ref": "#/components/responses/Unauthorized" "403": "$ref": "#/components/responses/NotOnModTeam" "404": "$ref": "#/components/responses/ModBugNotFound" patch: tags: - mod-bugs summary: Update a mod bug report description: | Changes a bug report's status, priority or fixed version. Only the mod's team can update a report. Fields left out are not changed. operationId: updateModBug x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier of the bug report. schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/UpdateModBugRequest" responses: "204": description: The bug report was updated. "401": "$ref": "#/components/responses/Unauthorized" "403": "$ref": "#/components/responses/NotOnModTeam" "404": "$ref": "#/components/responses/ModBugNotFound" "422": "$ref": "#/components/responses/ValidationFailed" "/mod-bugs/{id}/replies": post: tags: - mod-bugs summary: Reply to a mod bug report description: | Posts a reply to a bug report as the authenticated user. Only the mod's team can reply through this endpoint. The reply is public and, like a reply posted on the website, notifies the reporter and the mod's team. operationId: createModBugReply x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier of the bug report. schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/CreateModBugReplyRequest" responses: "201": description: The reply was posted. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/ModBugReply" "401": "$ref": "#/components/responses/Unauthorized" "403": description: The user is not on the mod's team, the report is locked, the mod's bug tracker is disabled, or the user is blocked from interacting with the mod. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "404": "$ref": "#/components/responses/ModBugNotFound" "422": "$ref": "#/components/responses/ValidationFailed" "/mod-files/{id}": get: tags: - mods summary: Get mod file description: "Retrieve a single mod file by its identifier. " operationId: getModFile x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier for the mod file. schema: type: string responses: "200": description: The mod file. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/ModFileWithAggregates" "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/ModFileNotFound" put: tags: - mods summary: Update a mod file description: Updates the name of an existing mod file by its ID. operationId: updateModFile x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier of the mod file to update. schema: type: string requestBody: description: The new data for the mod file. required: true content: application/json: schema: "$ref": "#/components/schemas/UpdateModFileRequest" responses: "204": description: Successfully updated the mod file. "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/ModFileNotFound" "422": "$ref": "#/components/responses/ValidationFailed" "/mod-file-versions/{id}/quarantine": post: tags: - mods summary: Quarantine a mod file version description: | Marks a mod file version as quarantined, so it can no longer be downloaded. Restricted to authorised moderation services: only a client_credentials service token carrying the `mod_file:quarantine` scope is accepted. Requests with no token, a user token or an API key receive 401; a service token without the scope receives 403. Idempotent: quarantining an already-quarantined file succeeds and reports `already_quarantined: true`. A file manually verified by staff is never overridden (409 is returned instead) — staff re-verification is also the route for reversing a quarantine. With `place_mod_under_review`, the file's mod is also placed under moderator review and reported to the moderation team; `mod_review` says what happened. This is best-effort: if it fails, the file stays quarantined, the call still succeeds and `mod_review` is `failed`. Reversing the quarantine does not release the mod, nor the reverse. operationId: quarantineModFileVersion x-badges: - name: Experimental color: orange security: - ServiceJwtAuth: - mod_file:quarantine parameters: - name: id in: path required: true description: The unique identifier for the mod file version. schema: type: string pattern: "^[0-9]+$" requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/QuarantineModFileVersionRequest" responses: "200": description: The file is quarantined. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/QuarantineModFileVersionSuccess" "401": "$ref": "#/components/responses/ServiceCredentialRequired" "403": "$ref": "#/components/responses/InsufficientServiceScope" "404": "$ref": "#/components/responses/ModFileVersionNotFound" "409": description: The file has been manually verified by staff and cannot be quarantined automatically. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "422": "$ref": "#/components/responses/ValidationFailed" "/mod-file-versions/{id}/dependencies": get: tags: - mods summary: Get mod file version dependencies description: | Retrieve the **raw** dependencies for a given mod file version with both the version-range dependencies and the DLC dependencies, returned exactly as authored and stored. The version ranges here are **not** resolved into the concrete candidate mod file versions that currently satisfy them. To get resolved candidates grouped by mod file, use the materialized endpoint. operationId: getModFileVersionDependencies x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier for the mod file version. schema: type: string responses: "200": description: The mod file version's dependencies. content: application/json: schema: "$ref": "#/components/schemas/ModFileVersionDependenciesResponse" "400": "$ref": "#/components/responses/BadRequest" "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/ModFileVersionNotFound" "/mod-file-versions/{id}/dependencies/ranges": get: tags: - mods summary: Get mod file version dependency ranges description: | Retrieve dependency ranges for a given mod file version. Each dependency definition contains a set of version ranges within mod files that satisfy the dependency. operationId: getModFileVersionDependencyRanges x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier for the mod file version. schema: type: string responses: "200": description: The mod file version's dependency ranges. content: application/json: schema: "$ref": "#/components/schemas/ModFileVersionDependencyRangesResponse" "400": "$ref": "#/components/responses/BadRequest" "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/ModFileVersionNotFound" put: tags: - mods summary: Update mod file version dependency ranges description: | Replace all dependency range definitions for a given mod file version. Each dependency definition contains an array of version ranges. Ranges within the same definition represent alternatives (OR). Separate definitions are independent requirements (AND). A range is defined by a min_version_id (required) and an optional max_version_id. Both must refer to versions within the same mod file. When max_version_id is null the range is open-ended (no upper bound). operationId: setModFileVersionDependencyRanges x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier for the mod file version (i.e. the version to create dependency ranges for). schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/UpdateModFileVersionDependencyRangesRequest" responses: "204": description: Successfully updated the mod file version dependency ranges. "400": "$ref": "#/components/responses/BadRequest" "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/ModFileVersionNotFound" "409": description: The mod has been removed. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "422": "$ref": "#/components/responses/ValidationFailed" "/mod-file-versions/{id}/dependencies/dlc": get: tags: - mods summary: Get mod file version DLC dependencies description: Retrieve the DLC dependencies for a given mod file version. operationId: getModFileVersionDlcDependencies x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier for the mod file version. schema: type: string responses: "200": description: The mod file version's DLC dependencies. content: application/json: schema: "$ref": "#/components/schemas/ModFileVersionDlcDependenciesResponse" "400": "$ref": "#/components/responses/BadRequest" "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/ModFileVersionNotFound" put: tags: - mods summary: Update mod file version DLC dependencies description: | Replace all DLC dependency definitions for a given mod file version. Each definition contains an array of DLC ids. DLCs within the same definition represent alternatives (OR). Separate definitions are independent requirements (AND). Each DLC id must reference a DLC available for the mod file version's game, as listed by the game DLCs endpoint. Sending an empty array of definitions removes all DLC dependencies from the version. operationId: setModFileVersionDependencyDlc x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier for the mod file version (i.e. the version to set DLC dependencies for). schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/UpdateModFileVersionDlcDependenciesRequest" responses: "204": description: Successfully updated the mod file version DLC dependencies. "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/ModFileVersionNotFound" "409": description: The mod has been removed. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "422": "$ref": "#/components/responses/ValidationFailed" "/mod-file-versions/{id}/dependencies/ranges/materialized": get: tags: - mods summary: Get a mod file versions materialized version-range dependencies description: | Retrieve materialized dependencies for a given mod file version. Resolves the stored dependency ranges into concrete candidate versions grouped by mod file. operationId: getModFileVersionDependencyRangesMaterialized x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier for the mod file version. schema: type: string responses: "200": description: The mod file version's materialized version-range dependencies. content: application/json: schema: "$ref": "#/components/schemas/ModFileVersionDependencyRangesMaterializedResponse" "400": "$ref": "#/components/responses/BadRequest" "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/ModFileVersionNotFound" "/mod-file-versions/dependencies/materialized/batch": post: tags: - mods summary: Batch get mod file version materialized dependency candidates description: | Resolves the materialized dependency candidates for a set of source mod file versions — the versions a client could install or recommend to satisfy each source version's dependencies. Each row is one candidate version for one source version's dependency definition. Rows sharing a `definition_id` are OR-alternatives (any one satisfies that dependency); rows sharing a `mod_file_id` are versions of the same mod file (update group/chain). Only candidates on published, non-moderated mods are included. Results are paged with a stable order, so the full candidate set can be fetched across pages. Source version ids with no resolvable candidates contribute no rows. `meta.total_count` is only meaningful on a non-empty page; a page past the end returns no candidates and `total_count` 0. operationId: getModFileVersionDependencyCandidatesBatch deprecated: true x-badges: - name: Deprecated color: red requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/ModFileVersionDependencyCandidatesBatchRequest" responses: "200": description: A page of materialized dependency candidate rows. content: application/json: schema: type: object required: - data - meta properties: data: "$ref": "#/components/schemas/ModFileVersionDependencyCandidatesBatchResponse" meta: "$ref": "#/components/schemas/PaginationMeta" "400": "$ref": "#/components/responses/BadRequest" "422": "$ref": "#/components/responses/ValidationFailed" "/mod-file-versions/dependencies/ranges/materialized/batch": post: tags: - mods summary: Batch get mod file version materialized dependency candidates description: | Resolves the materialized dependency candidates for a set of source mod file versions — the versions a client could install or recommend to satisfy each source version's dependencies. Each row is one candidate version for one source version's dependency definition. Rows sharing a `definition_id` are OR-alternatives (any one satisfies that dependency); rows sharing a `mod_file_id` are versions of the same mod file (update group/chain). Only candidates on published, non-moderated mods are included. Results are paged with a stable order, so the full candidate set can be fetched across pages. Source version ids with no resolvable candidates contribute no rows. `meta.total_count` is only meaningful on a non-empty page; a page past the end returns no candidates and `total_count` 0. operationId: getModFileVersionDependencyRangesMaterializedBatch x-badges: - name: Experimental color: orange requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/ModFileVersionDependencyCandidatesBatchRequest" responses: "200": description: A page of materialized dependency candidate rows. content: application/json: schema: type: object required: - data - meta properties: data: "$ref": "#/components/schemas/ModFileVersionDependencyCandidatesBatchResponse" meta: "$ref": "#/components/schemas/PaginationMeta" "400": "$ref": "#/components/responses/BadRequest" "422": "$ref": "#/components/responses/ValidationFailed" "/mod-file-versions/batch": post: tags: - mods summary: Batch get mod file version details description: | Resolves a set of mod file versions to their mod file (update group/chain) along with the identifying details — name, version, and position within the chain. Only versions on visible mods are returned (non-moderated mods, excluding not-published, publish-with-game and wastebinned), matching the dependency candidates endpoint. Unknown version ids and versions on non-visible mods contribute no rows. operationId: getModFileVersionsBatch x-badges: - name: Experimental color: orange requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/ModFileVersionsBatchRequest" responses: "200": description: The resolved mod file version detail rows. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/ModFileVersionsBatchResponse" "400": "$ref": "#/components/responses/BadRequest" "422": "$ref": "#/components/responses/ValidationFailed" "/mods/batch": post: tags: - mods summary: Batch get mod display details description: | Resolves a set of composite mod unique ids to their mod-level display details — name, summary, status, thumbnail and adult flag. The ids are the same id space as the `mod_id` returned by the dependency candidates and mod file version batch endpoints. Unknown ids contribute no rows. Mods that exist but are moderated / hidden / removed are returned with their `status`, so a now-unavailable mod can be told apart from one that never existed. Result order is not guaranteed. operationId: getModsBatch x-badges: - name: Experimental color: orange requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/ModsBatchRequest" responses: "200": description: The resolved mod detail rows. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/ModsBatchResponse" "400": "$ref": "#/components/responses/BadRequest" "422": "$ref": "#/components/responses/ValidationFailed" "/mods/search": post: tags: - mods x-badges: - name: Experimental color: orange summary: Search mods description: | Search published mods, sorted and optionally filtered by game and by creation or update time. A credential is optional. With one, mods by authors and with tags the user has blocked are left out. Adult mods are left out when the user's adult content preference is off. In a country that requires age verification, or when the country is unknown, they are also left out unless the user is age verified. The `adult` filter narrows the results further, to adult mods only or to mods that are not adult. operationId: searchMods security: - ApiKeyAuth: [] - BearerJwtAuth: [] - {} requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/ModsSearchRequest" responses: "200": description: A page of mods. content: application/json: schema: type: object required: - data - meta properties: data: "$ref": "#/components/schemas/ModsSearchResponse" meta: "$ref": "#/components/schemas/ModsSearchPaginationMeta" "401": description: The credential is invalid or expired. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "422": "$ref": "#/components/responses/ValidationFailed" "/mod-files/{id}/versions": get: tags: - mods summary: Get mod file versions description: "Retrieve all versions for a given mod file. " operationId: getModFileVersions x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier for the mod file. schema: type: string responses: "200": description: The mod file's versions. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/ModFileVersionsResponse" "400": description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/ProblemDetails" "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/ModFileNotFound" post: tags: - mod-files x-badges: - name: Experimental color: orange - name: Upcoming change color: orange summary: Create a new mod file version description: | > ⚠️ **Upcoming changes to this operation** > > - `CreateModFileVersionRequest.description` (request): `maxLength: 255` will be enforced from 2026-11-23 Creates a new version of an existing mod file from the upload specified in the request. The new version is inserted after `previous_version_id`, or after the latest version if that is omitted. operationId: createModFileVersion parameters: - name: id in: path required: true description: The unique identifier for the mod file to add a version to. schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/CreateModFileVersionRequest" responses: "201": description: The created mod file version. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/CreateModFileVersionSuccess" "400": "$ref": "#/components/responses/BadRequest" "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/NotFound" "422": description: Unprocessable Content content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "/mod-file-versions/{id}": get: tags: - mods summary: Get mod file version description: "Retrieve a single mod file version by its identifier. " operationId: getModFileVersion x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier for the mod file version. schema: type: string responses: "200": description: The mod file version. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/ModFileVersionWithStats" "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/ModFileVersionNotFound" "/mod-file-versions/{id}/download-repacked": post: tags: - mods summary: Download the repacked archive operationId: downloadRepackedModFileVersion x-badges: - name: Experimental color: orange parameters: - name: id in: path required: true description: The unique identifier for the mod file version. schema: type: string - name: Application-Name in: header required: false description: The client making the request, recorded against the download. schema: type: string - name: Application-Version in: header required: false description: The version of the client making the request, recorded against the download. schema: type: string responses: "200": description: A link to the repacked archive. content: application/json: schema: "$ref": "#/components/schemas/DownloadRepackedModFileVersionResponse" "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/ModFileVersionNotFound" "/mod-file-versions/move": post: tags: - mods summary: Move multiple mod file versions description: | Moves one or more mod file versions to a new position relative to another version, which may be in a different mod file. Versions are inserted in the order given by `version_ids`. `version_ids` is expected to be ordered from earliest to latest version. **Example:** Given a mod file with versions `[v1.0.0, v1.1.0, v2.0.0]` (earliest to latest), moving `[v1.0.1, v1.0.2]` with `relative_placement: "after"` targeting `v1.0.0` produces `[v1.0.0, v1.0.1, v1.0.2, v1.1.0, v2.0.0]`. operationId: moveModFileVersions x-badges: - name: Experimental color: orange requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/MoveModFileVersionsRequest" responses: "200": description: The versions were moved successfully. content: application/json: schema: "$ref": "#/components/schemas/MoveModFileVersionsResponse" "400": description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/ProblemDetails" "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/ModFileNotFound" "422": "$ref": "#/components/responses/ValidationFailed" "/mod-file-versions/move-to-new-mod-file": post: tags: - mods summary: Move multiple mod file versions into a new mod file description: | Moves one or more mod file versions into a new mod file with the specified name. Versions are inserted in the order given by `version_ids`. `version_ids` is expected to be ordered from earliest to latest version. operationId: moveModFileVersionsToNewModFile x-badges: - name: Experimental color: orange requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/MoveModFileVersionsToNewModFileRequest" responses: "200": description: The new mod file was created, and the versions were moved successfully. content: application/json: schema: "$ref": "#/components/schemas/MoveModFileVersionsToNewModFileResponse" "400": description: Bad Request content: application/json: schema: "$ref": "#/components/schemas/ProblemDetails" "403": "$ref": "#/components/responses/Forbidden" "404": "$ref": "#/components/responses/ModFileNotFound" "422": "$ref": "#/components/responses/ValidationFailed" "/uploads/{id}": get: tags: - uploads summary: Get upload description: | Get the state of an upload session. ### Next steps * Once the `state` is `available`, the upload can become a mod file version - either the first version of a [new mod file](#tag/mod-files/operation/createModFile), or a [new version of an existing mod file](#tag/mod-files/operation/createModFileVersion). ### FAQ * How do I create an upload? * Use [create upload](#tag/uploads/operation/createUpload) to start a new upload session. operationId: getUpload parameters: - name: id in: path required: true description: The unique identifier for the upload. schema: type: string format: uuid responses: "200": description: Upload content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/GetUploadSuccess" "400": "$ref": "#/components/responses/BadRequest" "404": "$ref": "#/components/responses/NotFound" "403": "$ref": "#/components/responses/Forbidden" "/uploads": post: tags: - uploads x-badges: - name: md5 required from 2026-12-01 color: orange summary: Create upload description: | Creates a new upload session. This allows you to upload the data for a new mod file version. ⚠️ Files larger than 100 MiB must use a [multi part upload](#tag/uploads/operation/createMultipartUpload). ### Next steps * Call `PUT` with your file data to the returned `presigned_url`. Recommended for files up to 100 MiB. * ⚠️ You must send a `Content-Disposition` header of `attachment; filename=""`, using the `filename` from your request. This value is part of the presigned URL signature, so the upload is rejected if the header is missing or does not match. * Once all data is uploaded, [finalise the upload](#tag/uploads/operation/finaliseUpload). ### Content integrity (`md5`) Supplying `md5` binds the presigned URL to that one file. The digest forms part of the URL signature, so the URL cannot be reused to upload different content, and storage rejects a body that does not match it. ⚠️ `md5` is **optional today and becomes required on or after 2026-12-01**. Send it now to avoid a breaking change later. * `md5` in your request body is the **hex** digest — the 32 characters `md5sum` prints, in upper or lower case. * Your `PUT` must also carry a `Content-MD5` header holding the **base64** encoding of the same digest (`openssl dgst -md5 -binary | base64`). As with `Content-Disposition`, this value is part of the signature, so the upload is rejected if it is missing or does not match. * Retrying the same bytes to the same URL still succeeds, so this does not affect resumed or repeated uploads. operationId: createUpload requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/CreateSinglePartUploadRequest" responses: "201": description: Upload ID and presigned URL content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/CreateUploadSuccess" "400": "$ref": "#/components/responses/BadRequest" "403": "$ref": "#/components/responses/Forbidden" "422": description: Unprocessable Entity content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "/uploads/multipart": post: tags: - uploads summary: Create multipart upload description: "Creates a new multipart upload session. This allows you to upload the data for a new mod file version.\n\n\U0001F4A1 Files smaller than 100 MiB can use the simpler [single part upload](#tag/uploads/operation/createUpload).\n\n### Next steps\nMultipart upload uses the [Amazon S3 multipart upload specification](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html).\n\n* Call `PUT` with your file data to each `part_presigned_urls`.\n * Each part must be `part_size_bytes` bytes, apart from the final part which may be smaller.\n \ * Retrieve the `ETag` response header value from each part upload.\n* Once all parts are uploaded, call `POST` to the `complete presigned_url` with [XML post data](#multipart-resources) describing\n the `ETag` for each part.\n* Once multipart complete is called, [finalise the upload](#tag/uploads/operation/finaliseUpload).\n\n### Multipart resources\n\nSample XML for completing the multipart upload:\n\n```xml\n \ \n \ \n \ 1 \n \ a54357aff0632cce46d942af68356b38 \n \ \n \ \n \ 2 \n \ 0c78aef83f66abc1fa1e8477f296d394 \n \ \n \ \n \ 3 \n \ acbd18db4cc2f85cedef654fccc4a4d8 \n \ \n\n```\n\n### Content integrity (`crc64nvme`)\n\nSupplying `crc64nvme` binds the `complete_presigned_url` to one file: storage computes the CRC-64/NVME of the assembled object on completion and rejects it on mismatch, so the whole file is verified end-to-end, not just each part. Send the same value in an `x-amz-checksum-crc64nvme` header on your `POST` to `complete_presigned_url`. It is optional today; omit it to complete exactly as before.\n" operationId: createMultipartUpload requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/CreateUploadRequest" responses: "201": description: Upload ID and presigned URL content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/CreateMultipartUploadSuccess" "403": "$ref": "#/components/responses/Forbidden" "400": "$ref": "#/components/responses/BadRequest" "422": description: Unprocessable Content content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "/uploads/{id}/finalise": post: tags: - uploads summary: Finalise upload description: | Closes the upload session once all data is uploaded. Sessions must be closed before the upload can become a mod file version. ### Next steps * Wait for the upload to be ready. Use [get upload](#tag/uploads/operation/getUpload) to check that `state` is `available`. * Use it as the first version of a [new mod file](#tag/mod-files/operation/createModFile), or as a [new version of an existing mod file](#tag/mod-files/operation/createModFileVersion). operationId: finaliseUpload parameters: - name: id in: path required: true description: The unique identifier for the upload. schema: type: string format: uuid responses: "200": description: Upload content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/FinaliseUploadSuccess" "400": "$ref": "#/components/responses/BadRequest" "404": "$ref": "#/components/responses/NotFound" "422": description: Unprocessable Entity content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "403": "$ref": "#/components/responses/Forbidden" "/collections": post: tags: - collections summary: Create a collection description: "Creates a collection and claims an upload using the upload_id from a finalised [upload session](#tag/uploads/operation/createUpload). " operationId: createCollection requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/CreateCollectionRequest" responses: "200": description: Upload content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/CreateCollectionSuccess" "400": "$ref": "#/components/responses/BadRequest" "404": "$ref": "#/components/responses/NotFound" "422": description: Unprocessable Entity content: application/problem+json: schema: anyOf: - "$ref": "#/components/schemas/ProblemDetails" - "$ref": "#/components/schemas/ValidationProblem" "403": "$ref": "#/components/responses/Forbidden" "/collections/{id}/revisions": post: tags: - collections summary: Create a collection revision description: "Creates a collection revision and claims an upload using the upload_id from a finalised [upload session](#tag/uploads/operation/createUpload). " operationId: createCollectionRevision parameters: - name: id in: path required: true description: The unique identifier for the collection this revision will belong to. schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/CreateCollectionRevisionRequest" responses: "200": description: Upload content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/CreateCollectionRevisionSuccess" "400": "$ref": "#/components/responses/BadRequest" "404": "$ref": "#/components/responses/NotFound" "422": description: Unprocessable Entity content: application/problem+json: schema: anyOf: - "$ref": "#/components/schemas/ProblemDetails" - "$ref": "#/components/schemas/ValidationProblem" "403": "$ref": "#/components/responses/Forbidden" "/mod-files": post: tags: - mod-files x-badges: - name: Experimental color: orange - name: Upcoming change color: orange summary: Create mod file description: | > ⚠️ **Upcoming changes to this operation** > > - `CreateModFileRequest.description` (request): `maxLength: 255` will be enforced from 2026-11-23 Creates a new mod file using the data from a finalised [upload session](#tag/uploads/operation/createUpload). Note that this is for entirely new files, not new versions of existing files. operationId: createModFile requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/CreateModFileRequest" responses: "201": description: ModFile content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/CreateModFileSuccess" "422": description: Unprocessable Entity content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "400": "$ref": "#/components/responses/BadRequest" "404": "$ref": "#/components/responses/NotFound" "403": "$ref": "#/components/responses/Forbidden" "/mod-file-update-groups/{group_id}/versions": post: tags: - mod-files summary: Create a new update group version (updates a mod file) description: | Creates a new version of an update group (tied to a mod file) from the upload specified in the request. The new version is inserted after `previous_version_id`, or after the latest version if that is omitted. **Deprecated** since 2026-06-11. Use "Create a new mod file version" (`POST /mod-files/{id}/versions`, operationId `createModFileVersion`) instead. This endpoint is stable, so it remains available for a minimum 90-day deprecation period from the deprecation date: it will be removed on or after 2026-09-09. operationId: createUpdateGroupVersion deprecated: true parameters: - name: group_id in: path required: true description: The unique identifier for the update group. schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/CreateUpdateGroupVersionRequest" responses: "201": description: UpdateGroupVersion content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/CreateUpdateGroupVersionSuccess" "400": "$ref": "#/components/responses/BadRequest" "404": "$ref": "#/components/responses/NotFound" "403": "$ref": "#/components/responses/Forbidden" "422": description: Unprocessable Content content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" "/vortex/extensions": get: tags: - vortex x-badges: - name: Experimental color: orange summary: Get Vortex extensions, themes, and translations description: | Returns Vortex extensions, themes, and translations, split into three lists. Extensions are classified from their code (`info.json`): a `game` extension targets a specific game (and carries a `game_id`), otherwise it is `other`. Themes and translations are not game-specific and carry no `type`. When `game_ids` is provided, the `extensions` list is filtered to game extensions for those Nexus Mods game IDs. Themes and translations are always returned in full. operationId: getVortexExtensions security: [] parameters: - name: game_ids in: query required: false description: | Comma-separated list of Nexus Mods game IDs to filter game extensions by. When omitted, all game extensions are returned. Non-game extensions (themes, translations, other) are unaffected by this filter. Example: `1,2,3` schema: type: string example: "1,2,3" responses: "200": description: Vortex extensions. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/VortexData" "400": "$ref": "#/components/responses/InvalidParameters" "/vortex/detected-games": post: tags: - vortex x-badges: - name: Experimental color: orange summary: Resolve the games detected on a Vortex client description: | Takes the store listings a Vortex client found installed and returns the Nexus Mods games they belong to, with the Vortex game extension for each game where one exists. Listings that match no game, or a game not on Nexus Mods, are left out. Several listings of one game (for example two Steam app ids, or the same game on Steam and GOG) return one entry. operationId: resolveDetectedGames requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/DetectedGamesRequest" responses: "200": description: The detected games that resolved to a Nexus Mods game. content: application/json: schema: type: object required: - data properties: data: "$ref": "#/components/schemas/DetectedGames" "401": "$ref": "#/components/responses/Unauthorized" "422": description: Unprocessable - the request body failed schema validation. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: apikey description: Get your personal API key from https://www.nexusmods.com/settings/api-keys BearerJwtAuth: type: http scheme: bearer bearerFormat: JWT description: "A signed JWT sent as `Authorization: Bearer `." ServiceJwtAuth: type: http scheme: bearer bearerFormat: JWT description: "A client_credentials service JWT (no user claim) sent as `Authorization: Bearer `, issued by the users service to a provisioned service account. Carries `scope` rather than user permissions; endpoints declaring this scheme accept only service tokens." schemas: ProblemDetails: type: object description: An RFC 9457 Problem Details object. required: - type - title - status - detail - instance properties: type: type: string format: uri description: A URI reference that identifies the problem type. title: type: string description: A short, human-readable summary of the problem type. status: type: integer description: The HTTP status code. example: 404 detail: type: string description: A human-readable explanation specific to this occurrence of the problem. instance: type: string format: uri description: A URI reference that identifies the specific occurrence of the problem. ValidationProblem: description: RFC 9457 Problem Details extended with validation errors. allOf: - "$ref": "#/components/schemas/ProblemDetails" - type: object required: - errors properties: errors: type: array description: List of validation errors. items: "$ref": "#/components/schemas/ValidationProblemItem" ValidationProblemItem: type: object description: A single validation error with a JSON pointer to the problematic field. required: - detail - pointer properties: detail: type: string description: Human-readable description of the validation error. pointer: type: string description: A JSON Pointer (RFC 6901) to the field that caused the error. example: "/collection_data/collection_manifest/mods/0/source/mod_id" PaginationMeta: type: object description: Pagination metadata for paginated responses. required: - page - page_size - total_count properties: page: type: integer description: Current page number (1-indexed). example: 1 page_size: type: integer description: Number of items per page. example: 20 total_count: type: integer description: Total number of items matching the query across all pages. example: 4123 CursorPaginationMeta: type: object description: Pagination metadata for cursor-paginated responses. required: - page_size - next_cursor properties: page_size: type: integer description: The maximum number of items requested for this page. example: 100 next_cursor: type: string nullable: true description: Pass as `cursor` to fetch the next page. Null when there are no more items. EditCollectionRequest: type: object properties: name: type: string description: Name of the collection. minLength: 3 maxLength: 36 nullable: false summary: type: string description: Collection summary. maxLength: 255 nullable: false description: type: string description: Description of the collection. nullable: false category_id: type: integer nullable: true description: ID of the parent category. EditModRequest: type: object properties: summary: type: string description: Short description shown on mod tiles and at the top of the mod page. Line breaks and runs of whitespace are collapsed to single spaces; must not be blank once collapsed. minLength: 1 maxLength: 350 nullable: false description: type: string description: Full mod page description, in BBCode. Must not be blank. minLength: 1 nullable: false TrendingModsResponse: type: object required: - mods properties: mods: type: array items: "$ref": "#/components/schemas/TrendingMod" TrendingMod: type: object description: A trending mod entry in the public marketing feed. required: - name - mod_page_url properties: name: type: string description: The mod name. author: type: string nullable: true description: The display name of the user who uploaded the mod. summary: type: string nullable: true description: Short summary shown on the mod listing. picture_url: type: string nullable: true description: URL of the mod's main image. mod_page_url: type: string description: Canonical URL of the mod page on nexusmods.com. GameDlcsResponse: type: object required: - dlcs properties: dlcs: type: array items: "$ref": "#/components/schemas/Dlc" Dlc: type: object description: A DLC available for a game. required: - id - name - thumbnail_url properties: id: type: string description: The DLC identifier, scoped to the game. example: "1" name: type: string description: The DLC display name. example: Dragonborn thumbnail_url: type: string description: Thumbnail image URL. GetModDetails: allOf: - "$ref": "#/components/schemas/Mod" Mod: type: object required: - id - name - description - game_scoped_id - game_id - adult_content - version - author - uploader - category - status - stats - tags - primary_image - gallery_images - main_file_version properties: id: type: string description: The unique identifier for the mod. game_scoped_id: type: string description: The game-scoped identifier for the mod. game_id: type: string description: The unique identifier for game this mod belongs to. name: type: string description: Mod name. description: type: string nullable: true description: Mod description as raw BBCode. version: type: string description: The mod's current version string. author: type: string description: Free-text author credit set by the uploader. adult_content: type: boolean description: Whether the mod contains adult content. uploader: allOf: - "$ref": "#/components/schemas/ModUploader" nullable: true description: The user who uploaded the mod. category: allOf: - "$ref": "#/components/schemas/ModCategory" nullable: true description: The mod's category, or null if uncategorised. stats: "$ref": "#/components/schemas/ModStats" tags: type: array description: The mod's active tags. items: "$ref": "#/components/schemas/ModTag" status: "$ref": "#/components/schemas/ModStatus" primary_image: allOf: - "$ref": "#/components/schemas/ModImage" nullable: true description: The mod's primary image, or null if the mod has none or is under moderation or removed by staff. gallery_images: type: array description: | The mod's gallery, in the order the authors arranged it. Empty when the mod is under moderation or removed by staff. items: "$ref": "#/components/schemas/ModGalleryImage" main_file_version: allOf: - "$ref": "#/components/schemas/ModMainFileVersion" nullable: true description: The primary main file version, or the newest if none is primary, among those whose `security_scan_status` is `cleared`. Null when there is none. ModUploader: type: object description: The user who uploaded a mod. required: - id - name properties: id: type: string description: The unique identifier for the user. name: type: string nullable: true description: The user's name, or null if the account no longer exists. ModCategory: type: object description: A mod category within a game. required: - id - name properties: id: type: string description: The game-scoped category identifier. name: type: string description: The category name. ModStats: type: object description: Aggregate counters for a mod. required: - downloads - unique_downloads - views - endorsements properties: downloads: type: integer description: Total downloads. unique_downloads: type: integer description: Unique downloads. views: type: integer description: Page views. endorsements: type: integer description: Number of endorsements. ModTag: type: object description: A tag applied to a mod. required: - id - name properties: id: type: string description: The unique identifier for the tag. name: type: string description: The tag name. ModImage: type: object description: | An image in each available size. For an adult mod, show the blurred versions when the user has chosen to blur adult images. There is no blurred full-size image. required: - url - thumbnail_url - large_thumbnail_url - blurred_thumbnail_url - blurred_large_thumbnail_url properties: url: type: string description: The full-size image. thumbnail_url: type: string description: A small thumbnail. large_thumbnail_url: type: string description: A large thumbnail, sized for previews. blurred_thumbnail_url: type: string description: Blurred version of the small thumbnail. blurred_large_thumbnail_url: type: string description: Blurred version of the large thumbnail. ModGalleryImage: description: An image from the mod's gallery, as uploaded by the mod's authors. allOf: - "$ref": "#/components/schemas/ModImage" - type: object required: - id - title properties: id: type: string description: The unique identifier for the image within its game. title: type: string description: The image title. Empty string when the image has none. ModFile: type: object description: A mod file - the persistent, updatable file on a mod page. Its versions are mod file versions. required: - id - name properties: id: type: string description: The unique identifier for the mod file. readOnly: true name: type: string description: The name of the mod file. ModFileWithAggregates: description: A mod file enriched with aggregate stats across its versions. allOf: - "$ref": "#/components/schemas/ModFile" - type: object required: - is_active - last_file_uploaded_at - versions_count - archived_count - removed_count properties: is_active: type: boolean description: True if the mod file has at least one version with an active category (main, update, optional, or miscellaneous). last_file_uploaded_at: type: string format: date-time nullable: true description: The most recent file upload date across all versions. Null if the mod file has no versions. versions_count: type: integer description: The total number of versions in the mod file. archived_count: type: integer description: The number of archived versions in the mod file. removed_count: type: integer description: The number of removed versions in the mod file. ModFileWithMod: description: A mod file with its associated mod. allOf: - "$ref": "#/components/schemas/ModFile" - type: object required: - mod properties: mod: "$ref": "#/components/schemas/MinimalMod" ModFileVersion: type: object description: A single version of a mod file, merging the physical file and its position within the mod file. required: - id - file - position - game_scoped_id - name - version - category - uploaded_at - manifest_url - supports_mod_managers - security_scan_status - size_in_bytes properties: id: type: string description: The unique identifier for the mod file version. file: "$ref": "#/components/schemas/ModFile" position: type: string format: decimal description: Position within the mod file. game_scoped_id: type: string description: The game-scoped identifier for the mod file version. name: type: string description: The name of the mod file version. version: type: string description: The version string of the mod file version. category: "$ref": "#/components/schemas/ModFileCategory" uploaded_at: type: string format: date-time description: The date and time the version was uploaded. manifest_url: type: string nullable: true description: | Public URL of the archive's manifest (file paths, sizes and hashes). Null when there is none. May briefly return 404 while a new upload is still processing. is_primary: type: boolean description: Whether this version is the primary file for the mod. The primary file represents the default download file for a mod page. There can be at most one primary file per mod. Defaults to false if omitted. supports_mod_managers: type: boolean description: Whether the author allows this file to be installed with a mod manager. security_scan_status: "$ref": "#/components/schemas/SecurityScanStatus" size_in_bytes: type: integer format: int64 description: The size of the archive, in bytes. ModFileVersionStats: type: object description: Download counters for a mod file version. required: - downloads - unique_downloads properties: downloads: type: integer description: Total downloads of this version. unique_downloads: type: integer description: Downloads of this version by distinct users. ModFileVersionWithStats: description: A mod file version with its download counters and description. allOf: - "$ref": "#/components/schemas/ModFileVersion" - type: object required: - stats - description properties: stats: "$ref": "#/components/schemas/ModFileVersionStats" description: type: string nullable: true description: The author's description of this version. Null when there is none. ModFilesResponse: type: object required: - mod_files properties: mod_files: type: array items: "$ref": "#/components/schemas/ModFileWithAggregates" ModFileVersionsResponse: type: object required: - versions properties: versions: type: array items: "$ref": "#/components/schemas/ModFileVersionWithStats" ModFileCategory: type: string enum: - main - update - optional - old_version - miscellaneous - removed - archived - unknown MinimalMod: type: object description: A minimal representation of a mod. required: - id - game_scoped_id - name - game properties: id: type: string description: The unique identifier for the mod. game_scoped_id: type: string description: The game-scoped identifier for the mod. name: type: string description: The name of the mod. game: "$ref": "#/components/schemas/MinimalGame" thumbnail_url: type: string nullable: true description: The URL of the mod's thumbnail image. status: "$ref": "#/components/schemas/ModStatus" adult_content: type: boolean nullable: true description: Whether the mod is marked as adult content. ModMainFileVersion: type: object description: The version of a mod's main file to download by default. required: - id - game_scoped_id - is_primary - supports_mod_managers - count properties: id: type: string description: The unique identifier for the mod file version. game_scoped_id: type: string description: The game-scoped identifier for the mod file version. is_primary: type: boolean description: Whether the author marked this version as the mod's primary file. supports_mod_managers: type: boolean description: Whether the author allows this file to be installed with a mod manager. count: type: integer minimum: 1 description: The number of the mod's main file versions that have cleared the security scan, including this one. `1` means the mod has no other main file to choose from. ModStatus: type: string description: The effective visibility status of a mod. enum: - published - not_published - hidden - under_moderation - removed - removed_by_staff SecurityScanStatus: type: string description: | Whether the file's security scan allows it to be downloaded. - `cleared`: the file is cleared for download. - `pending`: the scan has not finished. - `quarantined`: the file has been quarantined as possible malware and can't be downloaded. - `unverified`: the file has not been scanned, or its scan could not complete. enum: - cleared - pending - quarantined - unverified MinimalGame: type: object description: A minimal representation of a game. required: - id - name - domain_name properties: id: type: string description: The unique identifier for the game. name: type: string description: The name of the game. domain_name: type: string description: The URL-friendly slug for the game. example: skyrimspecialedition TeamModAffiliation: type: string description: How the user is related to a mod. enum: - owner - contributor ModBugTracker: type: string description: | The mod's bug tracker setting: * `disabled` - no bug reports * `open` - anyone can read reports; users who downloaded the mod can file them * `team_reports_only` - anyone can read reports; only the mod's team can file them * `private` - only the mod's team can read or file reports enum: - disabled - open - team_reports_only - private TeamModsData: type: object required: - mods properties: mods: type: array items: "$ref": "#/components/schemas/TeamMod" TeamMod: type: object description: A mod the user owns or is a team member of. required: - mod - affiliation - bug_tracker - open_bug_count properties: mod: "$ref": "#/components/schemas/MinimalMod" affiliation: "$ref": "#/components/schemas/TeamModAffiliation" bug_tracker: "$ref": "#/components/schemas/ModBugTracker" open_bug_count: type: integer description: Number of bug reports in the `open` state, excluding reports hidden by moderators. example: 4 ModBugStatus: type: string description: | The status of a bug report. `new`, `known_issue`, `investigating` and `needs_more_info` are open; the rest are closed. enum: - new - known_issue - investigating - needs_more_info - fixed - duplicate - not_a_bug - wont_fix ModBugState: type: string description: Whether a bug report's status is open or closed. enum: - open - closed ModBugPriority: type: string description: The priority the mod's team gave a bug report. enum: - not_set - low - medium - high ModBugUser: type: object description: A user who filed or replied to a bug report. required: - id - name properties: id: type: string description: The unique identifier for the user. name: type: string nullable: true description: The user's name, or null if the account no longer exists. ModBugDownloadedVersion: type: object description: The file the reporter said they downloaded. required: - file_name - version properties: file_name: type: string description: The name of the file. version: type: string nullable: true description: The version of the file, if the reporter gave one. ModBug: type: object description: A bug report filed against a mod. required: - id - mod - title - description - status - priority - is_private - is_locked - reporter - downloaded_version - fixed_version - reply_count - created_at - last_activity_at - url properties: id: type: string description: The unique identifier for the bug report. mod: "$ref": "#/components/schemas/MinimalMod" title: type: string description: The title of the bug report. description: type: string description: The body of the bug report as plain text, which may contain BBCode. status: "$ref": "#/components/schemas/ModBugStatus" priority: "$ref": "#/components/schemas/ModBugPriority" is_private: type: boolean description: Whether only the reporter and the mod's team can see the report. is_locked: type: boolean description: Whether replies are closed. reporter: "$ref": "#/components/schemas/ModBugUser" downloaded_version: allOf: - "$ref": "#/components/schemas/ModBugDownloadedVersion" nullable: true description: The file the reporter said they downloaded, if they gave one. fixed_version: type: string nullable: true description: The version the mod's team said fixes the bug, if any. reply_count: type: integer description: Number of replies, excluding replies hidden by moderators. created_at: type: string format: date-time description: When the report was filed. last_activity_at: type: string format: date-time description: When the report was filed or last replied to, whichever is later. url: type: string format: uri description: The mod's bug reports page on the website. ModBugsData: type: object required: - bugs properties: bugs: type: array items: "$ref": "#/components/schemas/ModBug" ModBugReply: type: object description: A reply to a bug report. required: - id - author - content - created_at properties: id: type: string description: The unique identifier for the reply. author: "$ref": "#/components/schemas/ModBugUser" content: type: string description: The reply as plain text, which may contain BBCode. created_at: type: string format: date-time description: When the reply was posted. ModBugWithReplies: description: A bug report with its replies, oldest first. allOf: - "$ref": "#/components/schemas/ModBug" - type: object required: - replies properties: replies: type: array items: "$ref": "#/components/schemas/ModBugReply" UpdateModBugRequest: type: object description: The fields to change. At least one must be given. properties: status: "$ref": "#/components/schemas/ModBugStatus" priority: "$ref": "#/components/schemas/ModBugPriority" fixed_version: type: string nullable: true maxLength: 255 description: The version that fixes the bug. Null clears it. CreateModBugReplyRequest: type: object required: - content properties: content: type: string minLength: 1 maxLength: 5000 description: The reply as plain text. BBCode is supported; HTML is shown as text. ToggleLegacyModRequirementsRequest: type: object required: - enabled properties: enabled: type: boolean description: Whether legacy mod-level requirements should be used for this mod. UpdateModFileRequest: type: object required: - name properties: name: type: string description: The name of the mod file. maxLength: 255 pattern: "^[a-zA-Z0-9 _'().-]+$" AddModChangelogEntriesRequest: type: object required: - version - changelog properties: version: type: string description: The version string these entries apply to. maxLength: 50 pattern: "^[a-zA-Z0-9.-]+$" changelog: type: string description: The changelog text to add for this version. minLength: 1 maxLength: 65535 AddModChangelogEntriesSuccess: type: object required: - version - changelog properties: version: type: string description: The version string these entries apply to. changelog: type: string description: The changelog text that was added for this version. QuarantineModFileVersionRequest: type: object required: - reason properties: reason: type: string description: Why the file is being quarantined (recorded in service logs). minLength: 1 maxLength: 1000 place_mod_under_review: type: boolean description: | Also place the file's mod under moderator review once the file is quarantined (or was already). The mod is hidden from the public and its authors cannot edit it until a moderator has reviewed it. A mod already under review is left as it is. default: false QuarantineModFileVersionSuccess: type: object required: - id - status - already_quarantined - mod_review - mod_review_reported properties: id: type: string description: The unique identifier for the mod file version. status: type: string description: The file's scan status after the call. Always `quarantined`. already_quarantined: type: boolean description: True when the file was already quarantined and nothing changed. mod_review: "$ref": "#/components/schemas/ModReviewOutcome" mod_review_reported: type: boolean description: True when this call reported the mod to the moderation team. Only a call that places the mod under review reports it. ModReviewOutcome: type: string description: | What happened to the file's mod when the caller asked for it to be placed under moderator review. `not_requested`: the caller did not ask. `placed_under_review`: the mod is now hidden from the public and locked for moderator review. `already_under_review`: the mod was already under review, so nothing changed. `failed`: the mod could not be placed under review; the file is still quarantined. enum: - not_requested - placed_under_review - already_under_review - failed DownloadRepackedModFileVersionResponse: type: object required: - download_url - expires_at properties: download_url: type: string description: The URL to initiate the download of the repacked archive. expires_at: type: string format: date-time description: The date and time when the download URL will expire. ModFileVersionDownloadLinks: type: object required: - links - expires_at properties: links: type: array description: Download links, with the user's preferred CDN location first. items: "$ref": "#/components/schemas/ModFileVersionDownloadLink" expires_at: type: string format: date-time description: The date and time when the download links will expire. ModFileVersionDownloadLink: type: object required: - name - short_name - url properties: name: type: string description: The CDN location's display name. short_name: type: string description: The CDN location's short name. url: type: string description: The signed URL to download the file from. MoveModFileVersionsRequest: type: object required: - version_ids - target properties: version_ids: type: array description: | The unique identifiers for the mod file versions to move. Versions are inserted in this order, and `version_ids` is expected to be ordered from earliest to latest version. items: type: string minItems: 1 target: "$ref": "#/components/schemas/MoveToPosition" MoveModFileVersionsResponse: type: object description: The result of a bulk move operation. required: - versions - target_mod_file properties: versions: type: array description: The updated versions reflecting their new mod file and order. items: "$ref": "#/components/schemas/ModFileVersion" modified_source_mod_files: type: array description: "A list of source mod files that had versions removed but still contain other versions. " items: "$ref": "#/components/schemas/ModFileWithAggregates" deleted_source_mod_file_ids: type: array description: | A list of IDs for any source mod files that were automatically deleted because they became empty as a result of this move. items: type: string target_mod_file: "$ref": "#/components/schemas/ModFileWithAggregates" MoveModFileVersionsToNewModFileRequest: type: object required: - version_ids - mod_file_name properties: version_ids: type: array description: | The unique identifiers for the mod file versions to move. Versions are inserted in this order, and `version_ids` is expected to be ordered from earliest to latest version. items: type: string minItems: 1 mod_file_name: type: string description: The name of the new mod file. maxLength: 255 pattern: "^[a-zA-Z0-9 _'().-]+$" MoveModFileVersionsToNewModFileResponse: type: object description: The result of a bulk move operation. required: - versions - new_mod_file properties: versions: type: array description: The updated versions reflecting their new mod file and order. items: "$ref": "#/components/schemas/ModFileVersion" modified_source_mod_files: type: array description: "A list of source mod files that had versions removed but still contain other versions. " items: "$ref": "#/components/schemas/ModFileWithAggregates" deleted_source_mod_file_ids: type: array description: | A list of IDs for any source mod files that were automatically deleted because they became empty as a result of this move. items: type: string new_mod_file: "$ref": "#/components/schemas/ModFileWithAggregates" MoveToPosition: type: object description: Place the moved versions earlier (`before`) or later (`after`) with respect to the target version. required: - target_version_id - relative_placement properties: target_version_id: type: string description: The unique identifier of the version to position relative to. relative_placement: "$ref": "#/components/schemas/RelativePlacement" RelativePlacement: type: string description: "`before`: earlier than the target. `after`: later than the target." enum: - before - after UpdateModFileVersionDependencyRangesRequest: type: object required: - dependency_definitions properties: dependency_definitions: type: array items: "$ref": "#/components/schemas/ModFileVersionDependencyRangeDefinitionInput" ModFileVersionDependencyRangeDefinitionInput: type: object required: - ranges properties: ranges: type: array items: "$ref": "#/components/schemas/ModFileVersionDependencyRangeInput" UpdateModFileVersionDlcDependenciesRequest: type: object required: - dlc_dependency_definitions properties: dlc_dependency_definitions: type: array description: | The full set of DLC dependency definitions for the version. Replaces any existing definitions. An empty array clears all DLC dependencies. items: "$ref": "#/components/schemas/ModFileVersionDlcDependencyDefinitionInput" ModFileVersionDlcDependencyDefinitionInput: type: object required: - dlc_ids properties: dlc_ids: type: array description: | The DLC ids that satisfy this definition (OR-alternatives). Must be non-empty and contain no duplicates. Each id must reference a DLC available for the version's game. items: type: string ModFileVersionDependencyRangeInput: type: object required: - min_version_id properties: min_version_id: type: string description: The ID of the mod file version representing the lower bound of the range. max_version_id: type: string nullable: true description: The ID of the mod file version representing the upper bound of the range. Null means open-ended (no upper bound). ModFileVersionDependencyRangesResponse: type: object required: - dependency_definitions properties: dependency_definitions: type: array items: "$ref": "#/components/schemas/ModFileVersionDependencyDefinitionWithRanges" ModFileVersionDependencyDefinitionWithRanges: type: object required: - id - ranges properties: id: type: string description: The unique identifier for the dependency definition. ranges: type: array items: "$ref": "#/components/schemas/ModFileVersionDependencyRange" ModFileVersionDependencyRange: type: object required: - id - target_mod_file - min_version - max_version properties: id: type: string description: The unique identifier for the dependency range. target_mod_file: "$ref": "#/components/schemas/ModFileWithMod" min_version: "$ref": "#/components/schemas/ModFileVersion" max_version: nullable: true allOf: - "$ref": "#/components/schemas/ModFileVersion" ModFileVersionDependenciesResponse: type: object required: - dependency_definitions - dlc_dependency_definitions properties: dependency_definitions: type: array description: Raw (non-materialized) mod-file version-range dependency definitions, as authored. These are the stored min/max version bounds, not the resolved candidate versions. Use the materialized endpoint to resolve them. items: "$ref": "#/components/schemas/ModFileVersionDependencyDefinitionWithRanges" dlc_dependency_definitions: type: array description: DLC dependency definitions. items: "$ref": "#/components/schemas/ModFileVersionDlcDependencyDefinition" ModFileVersionDlcDependenciesResponse: type: object required: - dlc_dependency_definitions properties: dlc_dependency_definitions: type: array description: DLC dependency definitions. items: "$ref": "#/components/schemas/ModFileVersionDlcDependencyDefinition" ModFileVersionDlcDependencyDefinition: type: object required: - id - dlc_targets properties: id: type: string description: The unique identifier for the DLC dependency definition. dlc_targets: type: array description: The DLCs that satisfy this definition (OR-alternatives). items: "$ref": "#/components/schemas/ModFileVersionDlcTarget" ModFileVersionDlcTarget: type: object required: - id - dlc_id - name properties: id: type: string description: The unique identifier for the DLC dependency target. dlc_id: type: string description: The DLC identifier. name: type: string description: The DLC name. ModFileVersionDependencyRangesMaterializedResponse: type: object required: - dependencies properties: dependencies: type: array description: Materialized version-range dependencies (each stored range resolved to its candidate versions). items: "$ref": "#/components/schemas/MaterializedModFileVersionDependency" MaterializedModFileVersionDependency: type: object description: A materialized dependency definition with its resolved candidate mod files and versions. required: - id - candidate_mod_files properties: id: type: string description: The unique identifier for the dependency definition. candidate_mod_files: type: array items: "$ref": "#/components/schemas/DependencyCandidateModFile" DependencyCandidateModFile: type: object description: A mod file with its associated mod and candidate versions. required: - id - name - mod - candidate_versions properties: id: type: string description: The unique identifier for the mod file. name: type: string description: The name of the mod file. mod: "$ref": "#/components/schemas/MinimalMod" candidate_versions: type: array items: "$ref": "#/components/schemas/ModFileVersion" ModFileVersionDependencyCandidatesBatchRequest: type: object required: - version_ids properties: version_ids: type: array description: | The source mod file version ids to resolve dependency candidates for. These are the installed/enabled versions whose dependencies are being matched. items: type: string minItems: 1 maxItems: 5000 page: type: integer description: Page number (1-indexed). default: 1 minimum: 1 page_size: type: integer description: Number of candidate rows per page. default: 1000 minimum: 1 maximum: 5000 ModFileVersionDependencyCandidatesBatchResponse: type: object required: - candidates properties: candidates: type: array items: "$ref": "#/components/schemas/ModFileVersionDependencyCandidate" ModFileVersionDependencyCandidate: type: object description: | A single materialized dependency candidate row. Rows sharing the same (`source_version_id`, `definition_id`) are OR-alternatives for one dependency of the source version. Rows sharing the same `mod_file_id` belong to the same update group/chain. required: - source_version_id - definition_id - mod_file_id - version_id - position - category - mod_status - mod_id properties: source_version_id: type: string description: The requesting (installed/enabled) mod file version id. definition_id: type: string description: The dependency definition id. Rows sharing this id are OR-alternatives. mod_file_id: type: string description: The mod file (update group/chain) the candidate belongs to. version_id: type: string description: The candidate mod file version id. position: type: string format: decimal description: Position within the mod file. Higher = newer within the chain. category: "$ref": "#/components/schemas/ModFileCategory" mod_status: "$ref": "#/components/schemas/ModStatus" mod_id: type: string description: The id of the mod the candidate belongs to. ModFileVersionsBatchRequest: type: object required: - version_ids properties: version_ids: type: array description: The mod file version ids to resolve details for. items: type: string minItems: 1 maxItems: 2000 ModFileVersionsBatchResponse: type: object required: - versions properties: versions: type: array items: "$ref": "#/components/schemas/ModFileVersionDetail" ModFileVersionDetail: type: object description: | Lightweight mod file version detail used to resolve an installed file's mod file (update group) and to hydrate recommended candidates. required: - id - mod_id - mod_file_id - name - version - position - manifest_url properties: id: type: string description: The mod file version id. mod_id: type: string description: The id of the mod this version belongs to. mod_file_id: type: string description: The id of the mod file (update group/chain) this version belongs to. name: type: string description: The name of the mod file version. version: type: string description: The version string of the mod file version. position: type: string format: decimal description: Position within the mod file. Higher = newer within the chain. manifest_url: type: string nullable: true description: | Public URL of the archive's manifest (file paths, sizes and hashes). Null when there is none. May briefly return 404 while a new upload is still processing. ModsBatchRequest: type: object required: - mod_ids properties: mod_ids: type: array description: | Composite mod UIDs (gameId << 32 | modId) to resolve. Same id space as the `mod_id` returned by the dependency candidates and mod file version batch endpoints. items: type: string minItems: 1 maxItems: 2000 ModsBatchResponse: type: object required: - mods properties: mods: type: array items: "$ref": "#/components/schemas/ModDetail" ModDetail: type: object description: | Mod-level display details. The game-scoped mod id and game id can be derived from `id` by bit-decomposition (modId = id & 0xFFFFFFFF, gameId = id >> 32); `game_id` is also returned directly for convenience. required: - id - game_id - name - summary - status - adult_content properties: id: type: string description: Composite mod UID. Echoes the request value so the caller can key results back. game_id: type: string description: The id of the game this mod belongs to. name: type: string description: Mod display name. summary: type: string description: | Sanitised short summary (plain text, as shown on mod cards). Empty string when the mod has none. status: "$ref": "#/components/schemas/ModStatus" thumbnail_url: type: string nullable: true description: | Mod thumbnail image URL. Null when the mod has no image, or when suppressed because the mod is under moderation or removed by staff. adult_content: type: boolean description: Whether the mod is flagged as adult content. ModsSearchRequest: type: object description: A mod search. Every field is optional. additionalProperties: false properties: query: type: string minLength: 2 maxLength: 100 description: | Text to find in mod names, with at least 2 characters other than spaces. Each space-separated word must appear in the name, as typed: punctuation matches as written. Case is ignored for the letters A to Z only. Combines with `filters`. Mods are not searched by name when left out. filters: allOf: - "$ref": "#/components/schemas/ModsSearchFilters" default: {} sort: allOf: - "$ref": "#/components/schemas/ModsSearchSort" default: {} pagination: allOf: - "$ref": "#/components/schemas/ModsSearchPagination" default: {} ModsSearchFilters: type: object description: Which mods to search. Every field is optional. additionalProperties: false properties: games: type: array description: Restrict to these games, by domain name. All games when left out. maxItems: 100 items: type: string maxLength: 64 example: - skyrimspecialedition created_at: description: Only mods whose `created_at` is in this range. allOf: - "$ref": "#/components/schemas/DateTimeRange" updated_at: description: Only mods whose `updated_at` is in this range. allOf: - "$ref": "#/components/schemas/DateTimeRange" exclude_mods: type: array description: IDs of mods to leave out. maxItems: 2000 items: type: string pattern: "^[0-9]+$" example: - "7318624273618" adult: type: string enum: - include - exclude - only description: | Whether to include adult mods, leave them out, or return adult mods only. Defaults to `include`. Adult mods that age verification or the user's adult content preference leave out are never returned, so `only` returns no mods for a user who cannot see adult content. supports_mod_managers: type: boolean description: | `true` returns only mods that can be installed with a mod manager, `false` only mods that cannot. Mods are not filtered on mod manager support when left out. requirements: type: array description: | Only mods that have at least one of these kinds of requirement. Mods are not filtered on requirements when left out. maxItems: 4 uniqueItems: true items: "$ref": "#/components/schemas/ModsSearchRequirement" example: - mod - external exclude_requirements: type: array description: | Leaves out mods that have any of these kinds of requirement; mods with no requirements are kept. Combines with `requirements`, which still picks from the mods left. Mods are not filtered on requirements when left out. maxItems: 4 uniqueItems: true items: "$ref": "#/components/schemas/ModsSearchRequirement" example: - dlc DateTimeRange: type: object description: | A time range: `gte` is the earliest time included, and `lt` the time the range ends before. Give either or both; no other operators (such as `lte` or `gt`) are accepted. Times need a UTC offset, as in `2026-04-01T00:00:00Z`. additionalProperties: false minProperties: 1 properties: gte: type: string format: date-time description: Included when at or after this time. example: "2026-04-01T00:00:00Z" lt: type: string format: date-time description: Included when before this time. Must be after `gte`. example: "2026-10-01T00:00:00Z" ModsSearchSort: type: object description: The order of the results. additionalProperties: false properties: field: type: string enum: - new - updated - endorsements - downloads default: endorsements description: | `new` orders by `created_at`, `updated` by `updated_at`, `endorsements` by endorsement count and `downloads` by total downloads. A mod never updated has an `updated_at` equal to its `created_at`. Sorting never leaves mods out: `filters` choose the mods, so the most endorsed mods created since a time are `endorsements` with `created_at.gte`. direction: type: string enum: - asc - desc default: desc ModsSearchRequirement: type: string enum: - mod - file - external - dlc description: | A kind of requirement a mod can have: `mod` for another mod, `file` for a specific mod file, `external` for something hosted outside Nexus Mods, and `dlc` for a DLC or expansion of the game. ModsSearchPagination: description: Pages by cursor (`type` `cursor`, the default) or by number (`type` `page`). The response `meta` has the same `type`. oneOf: - "$ref": "#/components/schemas/ModsSearchCursorPagination" - "$ref": "#/components/schemas/ModsSearchPagePagination" ModsSearchPagePagination: type: object description: Pages by number, up to page 100. additionalProperties: false required: - type properties: type: type: string enum: - page page: type: integer default: 1 minimum: 1 maximum: 100 description: Page number, starting at 1. Use cursor pagination to go further. page_size: "$ref": "#/components/schemas/ModsSearchPageSize" ModsSearchCursorPagination: type: object description: Pages by cursor, with no page limit. additionalProperties: false properties: type: type: string enum: - cursor default: cursor cursor: type: string minLength: 1 maxLength: 512 description: | The `next_cursor` of the previous page. Leave it out for the first page. Send the same filters, sort and direction as that request; a cursor sent with any of them changed is rejected. Filters count as the same when they select the same mods, so the order of `games` and `exclude_mods` and the time zone of a `created_at` or `updated_at` time do not matter, and leaving out `adult` is the same as sending its default. `page_size` may change. Results are not a snapshot, so a mod that moves between requests can be repeated or missed. Cursors are for paging, not for storing. page_size: "$ref": "#/components/schemas/ModsSearchPageSize" ModsSearchPageSize: type: integer default: 20 minimum: 1 maximum: 100 description: Number of mods per page. ModsSearchPaginationMeta: description: Pagination for the returned page, of the same `type` as the request. oneOf: - "$ref": "#/components/schemas/ModsSearchPagePaginationMeta" - "$ref": "#/components/schemas/ModsSearchCursorPaginationMeta" ModsSearchPagePaginationMeta: description: Pagination for a page requested by number. allOf: - "$ref": "#/components/schemas/PaginationMeta" - type: object required: - type properties: type: type: string enum: - page ModsSearchCursorPaginationMeta: description: Pagination for a page requested by cursor. allOf: - "$ref": "#/components/schemas/CursorPaginationMeta" - type: object required: - type - total_count properties: type: type: string enum: - cursor total_count: type: integer description: Number of mods that match the search. example: 4123 ModsSearchResponse: type: object required: - mods properties: mods: type: array items: "$ref": "#/components/schemas/ModSummary" ModSummary: type: object description: A mod in search results. required: - id - game_scoped_id - game - name - summary - version - author - category - thumbnail_url - blurred_thumbnail_url - endorsements - downloads - unique_downloads - file_size_kilobytes - created_at - updated_at - adult - supports_vortex properties: id: type: string description: Composite mod UID (gameId << 32 | modId). example: "7318624273618" game_scoped_id: type: string description: The game-scoped identifier for the mod. example: "1234" game: "$ref": "#/components/schemas/ModSummaryGame" name: type: string summary: type: string nullable: true description: The mod's summary, as plain text. version: type: string nullable: true author: "$ref": "#/components/schemas/ModSummaryAuthor" category: nullable: true allOf: - "$ref": "#/components/schemas/ModSummaryCategory" thumbnail_url: type: string nullable: true blurred_thumbnail_url: type: string nullable: true description: Blurred version of the thumbnail. endorsements: type: integer downloads: type: integer description: Total downloads. unique_downloads: type: integer description: Downloads by distinct users. file_size_kilobytes: type: integer description: Size of the mod's primary file, in kilobytes. created_at: type: string format: date-time updated_at: type: string format: date-time adult: type: boolean description: Whether the mod is flagged as adult content. supports_vortex: type: boolean description: Whether the mod can be installed with Vortex. ModSummaryGame: type: object required: - id - domain_name - name properties: id: type: string example: "1704" domain_name: type: string example: skyrimspecialedition name: type: string example: Skyrim Special Edition ModSummaryAuthor: type: object description: The mod's uploader. required: - id - name properties: id: type: string example: "42" name: type: string ModSummaryCategory: type: object required: - id - name properties: id: type: string example: "7" name: type: string example: Gameplay BlockedAuthor: type: object description: A user whose content another user has blocked. required: - id - name properties: id: type: string description: The unique identifier for the user, comparable with a mod's `uploader.id`. name: type: string nullable: true description: The user's name, or null if the account no longer exists. ContentSettings: type: object description: The content a user has chosen to see, blur or block across the site. required: - adult - blur_adult_images - blocked_tags - blocked_authors properties: adult: type: boolean description: Whether the user has chosen to see adult content. blur_adult_images: type: boolean description: Whether adult images should be blurred until the user reveals them. blocked_tags: type: array description: | Tags the user has blocked. Content carrying any of these tags should be shown as blocked. Empty when the user has blocked no tags. items: "$ref": "#/components/schemas/ModTag" blocked_authors: type: array description: | Users whose content this user has blocked. Content they uploaded should be shown as blocked. Empty when the user has blocked no one. items: "$ref": "#/components/schemas/BlockedAuthor" CreateModFileRequest: type: object required: - upload_id - mod_id - name - version - file_category properties: upload_id: type: string format: uuid description: The unique identifier for the upload. mod_id: type: string description: | The unique identifier for the mod this file belongs to. * Use [get mod](#tag/mods/operation/getMod) to get the game scoped ID for a mod using the data from a site URL e.g. `/skyrimspecialedition/mods/12604`. name: type: string description: Mod file name. maxLength: 50 pattern: "^[a-zA-Z0-9 _'().-]+$" version: type: string description: Mod file version. maxLength: 50 pattern: "^[a-zA-Z0-9.-]+$" description: type: string description: |- Description of the mod file. > ⚠️ **Upcoming change:** `maxLength: 255` will be enforced from 2026-11-23. nullable: true file_category: "$ref": "#/components/schemas/NewModFileCategory" primary_mod_manager_download: type: boolean description: Whether this file is the default download for mod managers. Only a main file can be the default; `true` with another category is rejected with a 422. default: false allow_mod_manager_download: type: boolean description: Whether mod manager downloads are enabled for this file. default: true show_requirements_pop_up: type: boolean description: Whether to show a requirements popup when downloading this file. default: false update_mod_version: type: boolean description: Whether to update the mod's version to match this file's version. default: false CreateUploadRequest: type: object required: - size_bytes - filename properties: size_bytes: type: integer format: int64 nullable: false description: Size of the archive being uploaded, in bytes. filename: type: string nullable: false description: | Filename for the archive being uploaded. This is the name sent in the `Content-Disposition` header when you upload the data, not the name of the mod file version created from it. crc64nvme: type: string nullable: true description: | Optional. A CRC-64/NVME checksum of the complete file, base64-encoded — the value for the `x-amz-checksum-crc64nvme` header. `null` is treated the same as omitting the field. When supplied it binds the `complete_presigned_url` to this one object: storage computes the CRC-64/NVME across the assembled parts on completion and rejects the upload if it does not match, giving end-to-end integrity for the whole file. Your `POST` to `complete_presigned_url` must send the same value in an `x-amz-checksum-crc64nvme` header. CRC-64/NVME is the only algorithm storage validates against a whole multipart object; MD5 is not available here because the multipart `ETag` is a hash of the part digests, not of the file. pattern: "^[A-Za-z0-9+/]{11}=$" CreateSinglePartUploadRequest: type: object required: - size_bytes - filename properties: size_bytes: type: integer format: int64 nullable: false description: Size of the archive being uploaded, in bytes. filename: type: string nullable: false description: | Filename for the archive being uploaded. This is the name sent in the `Content-Disposition` header when you upload the data, not the name of the mod file version created from it. md5: type: string nullable: true description: | ⚠️ **Optional today, required on or after 2026-12-01.** From that date, single-part uploads that omit it are rejected. Hex MD5 digest of the file - the 32 hex characters `md5sum` prints. Accepted in upper or lower case, and `null` is treated the same as omitting the field. Binds the presigned URL to this one file, so it cannot be reused to upload different content. Your `PUT` must send the same digest base64-encoded in a `Content-MD5` header (`openssl dgst -md5 -binary | base64`). pattern: "^[0-9a-fA-F]{32}$" CreateUploadSuccess: type: object allOf: - "$ref": "#/components/schemas/Upload" required: - presigned_url properties: presigned_url: type: string description: Presigned URL. CreateMultipartUploadSuccess: type: object allOf: - "$ref": "#/components/schemas/Upload" required: - part_size_bytes - part_presigned_urls - complete_presigned_url properties: part_size_bytes: type: integer format: int64 description: Size of each part in bytes. part_presigned_urls: type: array items: type: string description: Presigned URLs for each upload part. complete_presigned_url: type: string description: Presigned URL to complete upload. FinaliseUploadSuccess: allOf: - "$ref": "#/components/schemas/Upload" GetUploadSuccess: allOf: - "$ref": "#/components/schemas/Upload" CreateModFileSuccess: allOf: - "$ref": "#/components/schemas/UploadModFile" Upload: type: object required: - id - user - state properties: id: type: string format: uuid description: The unique identifier for the upload. user: "$ref": "#/components/schemas/UploadUser" state: "$ref": "#/components/schemas/UploadState" UploadUser: type: object required: - id properties: id: type: string description: The unique identifier for the user who owns this upload. UploadModFile: type: object required: - id - game_scoped_id - name - file_category properties: id: type: string description: The unique identifier for the mod file. game_scoped_id: type: string description: The game-scoped identifier for the mod file. name: type: string description: Mod file name. file_category: "$ref": "#/components/schemas/NewModFileCategory" UploadState: type: string enum: - created - available NewModFileCategory: type: string enum: - main - optional - miscellaneous CreateUpdateGroupVersionRequest: type: object required: - upload_id - name - version - file_category properties: upload_id: type: string format: uuid description: The unique identifier for the upload. name: type: string description: Mod file name maxLength: 50 pattern: "^[a-zA-Z0-9 _'().-]+$" description: type: string description: Description of the mod file nullable: true version: type: string description: Mod file version maxLength: 50 pattern: "^[a-zA-Z0-9.-]+$" file_category: "$ref": "#/components/schemas/NewModFileCategory" primary_mod_manager_download: type: boolean description: Whether this file is the default download for mod managers. If omitted, a main file takes over as the default download when the version it replaces was the default. Only a main file can be the default; `true` with another category is rejected with a 422. allow_mod_manager_download: type: boolean description: Whether mod manager downloads are enabled for this file. show_requirements_pop_up: type: boolean description: Whether to show a requirements popup when downloading this file. archive_existing_file: type: boolean description: Whether to archive the existing file when uploading a new version. default: false previous_version_id: type: string nullable: true description: The version of this mod file to insert the new version directly after. If omitted, the new version is inserted after the latest version. CreateUpdateGroupVersionSuccess: allOf: - "$ref": "#/components/schemas/UploadModFile" CreateModFileVersionRequest: type: object required: - upload_id - name - version - file_category properties: upload_id: type: string format: uuid description: The unique identifier for the upload. name: type: string description: Mod file name maxLength: 50 pattern: "^[a-zA-Z0-9 _'().-]+$" description: type: string description: |- Description of the mod file > ⚠️ **Upcoming change:** `maxLength: 255` will be enforced from 2026-11-23. nullable: true version: type: string description: Mod file version maxLength: 50 pattern: "^[a-zA-Z0-9.-]+$" file_category: "$ref": "#/components/schemas/NewModFileCategory" primary_mod_manager_download: type: boolean description: Whether this file is the default download for mod managers. If omitted, a main file takes over as the default download when the version it replaces was the default. Only a main file can be the default; `true` with another category is rejected with a 422. allow_mod_manager_download: type: boolean description: Whether mod manager downloads are enabled for this file. show_requirements_pop_up: type: boolean description: Whether to show a requirements popup when downloading this file. update_mod_version: type: boolean description: Whether to update the mod's version to match this file's version. default: false archive_existing_file: type: boolean description: Whether to archive the existing file when uploading a new version. default: false previous_version_id: type: string nullable: true description: The version of this mod file to insert the new version directly after. If omitted, the new version is inserted after the latest version. CreateModFileVersionSuccess: type: object required: - file - version properties: file: "$ref": "#/components/schemas/UploadModFile" version: "$ref": "#/components/schemas/CreatedModFileVersion" CreatedModFileVersion: type: object required: - id - position properties: id: type: string description: The unique identifier for the created mod file version. position: type: string format: decimal description: Position within the mod file. CreateCollectionRequest: type: object required: - upload_id - collection_data properties: upload_id: type: string format: uuid nullable: false description: The unique identifier for the upload to claim against this new collection. collection_data: "$ref": "#/components/schemas/CollectionPayload" CreateCollectionSuccess: type: object required: - id - slug - revision_id - revision_number - revision_status properties: id: type: string description: The unique identifier for the collection. slug: type: string description: The slug for the collection. revision_id: type: string description: The unique identifier for the initial collection revision. revision_number: type: integer description: The revision number. revision_status: "$ref": "#/components/schemas/RevisionStatus" CreateCollectionRevisionRequest: type: object required: - upload_id - collection_data properties: upload_id: type: string format: uuid nullable: false description: The unique identifier for the upload to claim against this new collection. collection_data: "$ref": "#/components/schemas/CollectionPayload" CreateCollectionRevisionSuccess: type: object required: - id - collection_id - revision_number - revision_status properties: id: type: string description: The unique identifier for the revision. collection_id: type: string description: The unique identifier for the collection this revision belongs to. revision_number: type: integer description: The revision number. revision_status: "$ref": "#/components/schemas/RevisionStatus" CollectionPayload: type: object description: The data payload used to create a collection revision. required: - adult_content - collection_manifest - collection_schema_id properties: adult_content: type: boolean description: Whether the collection includes adult content. collection_manifest: "$ref": "#/components/schemas/CollectionManifest" collection_schema_id: type: integer description: Collection schema id. CollectionManifest: type: object description: The JSON manifest that defines a collection. required: - info - mods properties: info: "$ref": "#/components/schemas/CollectionManifestInfo" mods: type: array items: "$ref": "#/components/schemas/CollectionManifestMod" description: List of mod resources for the manifest. CollectionManifestInfo: type: object description: The info section of the JSON manifest. required: - author - name - domain_name properties: author: type: string description: The collection author's name. author_url: type: string nullable: true description: The url of the author's profile. name: type: string description: The name of the collection. minLength: 3 maxLength: 36 description: type: string nullable: true description: A description of the collection. summary: type: string nullable: true description: A short summary of the collection. maxLength: 255 domain_name: type: string description: The domain name of the game. game_versions: type: array nullable: true items: type: string description: A list of game versions that this revision has been tested with. CollectionManifestMod: type: object description: Defines a mod to be used in a collection as part of the manifest. required: - name - version - optional - domain_name - source properties: name: type: string description: The name of the mod. version: type: string description: The mod version. optional: type: boolean description: Whether the mod is required for this collection. domain_name: type: string description: The domain name of the game for the mod. source: "$ref": "#/components/schemas/CollectionManifestModSource" author: type: string nullable: true description: The name of the mod author. CollectionManifestModSource: type: object description: Source information for a mod (nexus or other) as part of the manifest. required: - type properties: type: "$ref": "#/components/schemas/ModSource" mod_id: type: string description: The identifier of the mod source for this collection manifest. file_id: type: string description: The identifier of the mod file version associated with the mod in this collection manifest. md5: type: string nullable: true description: An MD5 hash of the file for verification. file_size: type: integer nullable: true description: The file size in kb. update_policy: "$ref": "#/components/schemas/UpdatePolicy" logical_filename: type: string nullable: true description: Logical file name of the mod resource. file_expression: type: string nullable: true description: File expression of the mod resource. url: type: string nullable: true description: The direct url of the file. adult_content: type: boolean nullable: true description: Does the mod include adult content. ModSource: type: string description: Used to define the source of a mod. Useful for informing Collections how to retrieve mods. enum: - nexus - direct - browse - manual - bundle RevisionStatus: type: string description: The status of a collection revision. enum: - draft - published - retracted UpdatePolicy: type: string description: Available update policies of a file resource enum: - exact - latest - prefer DetectedGamesRequest: type: object description: The store listings a Vortex client found installed, by store. required: - steam - gog - epic properties: steam: type: array description: Steam app ids. items: "$ref": "#/components/schemas/StoreListingId" maxItems: 10000 example: - "489830" gog: type: array description: GOG product ids. items: "$ref": "#/components/schemas/StoreListingId" maxItems: 10000 example: - "1711230643" epic: type: array description: Epic Games Store listings, each as `:`. items: "$ref": "#/components/schemas/StoreListingId" maxItems: 10000 example: - ada3ab8da0e44e6a8a0b5e1a4e2b4f1c:61d52ce4d09d41e48800c22784d13ae8 StoreListingId: type: string minLength: 1 maxLength: 128 description: A game's id on a store. DetectedGames: type: object required: - games properties: games: type: array description: One entry per Nexus Mods game, in game id order. items: "$ref": "#/components/schemas/DetectedGame" DetectedGame: type: object description: A Nexus Mods game with at least one of its store listings installed. required: - game_uid - game_id - image_url - store_ids - is_favourite - extension properties: game_uid: type: string description: The game's id in the games catalogue. example: igdb-472 game_id: type: string description: The Nexus Mods game ID. example: "1704" image_url: type: string nullable: true description: Cover art for the game. Null if unavailable. example: https://images.igdb.com/igdb/image/upload/t_cover_big/co1tnw.jpg store_ids: "$ref": "#/components/schemas/DetectedGameStoreIds" is_favourite: type: boolean description: Whether the caller has the game in their favourite games. example: false extension: nullable: true description: The Vortex game extension for the game, or null when there is none. allOf: - "$ref": "#/components/schemas/VortexAsset" DetectedGameStoreIds: type: object description: The requested listings that matched the game, by store. required: - steam - gog - epic properties: steam: type: array items: type: string example: - "489830" gog: type: array items: type: string example: [] epic: type: array items: type: string example: [] VortexData: type: object required: - extensions - themes - translations properties: extensions: type: array description: | Vortex extensions, classified as `game` or `other`. Filtered by `game_ids` when provided. items: "$ref": "#/components/schemas/VortexExtension" themes: type: array description: All Vortex themes. items: "$ref": "#/components/schemas/VortexAsset" translations: type: array description: All Vortex translations. items: "$ref": "#/components/schemas/VortexTranslation" VortexAsset: type: object description: | Common Vortex asset data, forwarded from the mod page. Uniqueness is `mod_id` + `file_id` (one mod per extension, one file per version). required: - name - version - author_name - author_user_id - uploaded_at - mod_id - file_id - image_url properties: name: type: string description: The mod name. example: Example Vortex Extension version: type: string description: The file version string. example: 1.2.0 author_name: type: string description: Username of the uploader. example: ExampleAuthor author_user_id: type: string description: Nexus Mods user ID of the uploader. example: "54321" uploaded_at: type: string format: date-time description: ISO 8601 timestamp of when the file was uploaded. example: "2023-11-14T22:13:20Z" mod_id: type: string description: The Nexus Mods mod ID. example: "12345" file_id: type: string description: The Nexus Mods file ID. example: "99999" image_url: type: string nullable: true description: | URL of the image: the mod page image, or the game artwork for game extensions. Null if unavailable. example: https://staticdelivery.nexusmods.com/mods/1/images/12345-0-1700000000.jpg VortexExtension: description: | A Vortex extension, classified from its code (`info.json`). A `game` extension targets a specific game and carries a `game_id`; all others are `other`. allOf: - "$ref": "#/components/schemas/VortexAsset" - type: object required: - type properties: type: type: string enum: - game - other description: | `game` if code analysis determined the extension targets a specific game (see `game_id`); otherwise `other`. example: game game_id: type: string nullable: true description: | The Nexus Mods game ID, determined by code analysis. Present only when `type` is `game`. example: "1" VortexTranslation: description: "A Vortex translation, with the language it translates into. " allOf: - "$ref": "#/components/schemas/VortexAsset" - type: object required: - locale properties: locale: type: string nullable: true description: | BCP 47 language tag the translation's strings are in (e.g. `pt-BR`). Null when a locale could not be determined for it. example: pt-BR responses: BadRequest: description: Bad Request content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" InvalidParameters: description: Bad Request - invalid parameters content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" Unauthorized: description: Unauthorized content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" ServiceCredentialRequired: description: No usable service credential - the request carries no token, a user token, an API key or a malformed token. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" Forbidden: description: Forbidden content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" InsufficientServiceScope: description: The service token does not carry the required scope. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" ModForbidden: description: Access to the mod is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" AgeVerificationRequired: description: The content is adult content, which is not available from the caller's country without age verification. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" NotOnModTeam: description: The user is not on the mod's team. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" NotFound: description: Not Found content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" ModNotFound: description: The mod was not found. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" ModFileNotFound: description: The mod file was not found. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" ModFileVersionNotFound: description: The mod file version was not found. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" GameNotFound: description: Game not found. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" ModBugNotFound: description: The bug report was not found. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails" ValidationFailed: description: The request body failed validation. content: application/problem+json: schema: "$ref": "#/components/schemas/ProblemDetails"