vortex

Resolve the games detected on a Vortex client

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.

post/vortex/detected-games

Request

  • Base URL: https://api.nexusmods.com/v3
  • URL: https://api.nexusmods.com/v3/vortex/detected-games
  • Auth: one of:
    • API key in header apikey
    • HTTP bearer

Request body

steamStoreListingId[] required

Steam app ids.

gogStoreListingId[] required

GOG product ids.

epicStoreListingId[] required

Epic Games Store listings, each as <namespace>:<catalogItemId>.

Example request

{
  "steam": [
    "489830"
  ],
  "gog": [
    "1711230643"
  ],
  "epic": [
    "ada3ab8da0e44e6a8a0b5e1a4e2b4f1c:61d52ce4d09d41e48800c22784d13ae8"
  ]
}

Response

The detected games that resolved to a Nexus Mods game.

Example response

{
  "data": {
    "games": [
      {
        "game_uid": "igdb-472",
        "game_id": "1704",
        "image_url": "https://images.igdb.com/igdb/image/upload/t_cover_big/co1tnw.jpg",
        "store_ids": {
          "steam": [
            "489830"
          ],
          "gog": [],
          "epic": []
        },
        "extension": {
          "name": "Example Vortex Extension",
          "version": "1.2.0",
          "author_name": "ExampleAuthor",
          "author_user_id": "54321",
          "uploaded_at": "2023-11-14T22:13:20Z",
          "mod_id": "12345",
          "file_id": "99999",
          "image_url": "https://staticdelivery.nexusmods.com/mods/1/images/12345-0-1700000000.jpg"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.