Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

A python wrapper for the Nexus API.

Project description

A python wrapper for the Nexus API.


  • Retrieve information regarding colour-specific themes for games;
  • Access resources specific to a user:
    • Get user details;
    • Get user’s endorsements;
    • Get, add and delete user’s tracked mods.
  • Retrieve game information;
  • Access mod information:
    • Get latest added mods;
    • Get latest updated mods;
    • Get all updated mods in a specific period of time;
    • Get trending mods;
    • Search for a specific mod;
    • Get mod details;
    • Get mod’s changelogs;
    • Endorse or abstain from endorsing a mod.
  • Access a mod’s files:
    • List a mod’s files;
    • Get a mod’s file details;
    • Generate a download link for a mod’s file.


To install pynxm, use pip:

pip install pynxm

Users will also need an api key to login with, generate one for your account here.

Application developers that wish to use Nexus’ Single Sign-On (SSO) will need an application slug and a connection token, please contact a Nexus Community Manager for more information.

Quick Examples

Connect to Nexus:

>>> api_key = "my-api-key"
>>> nxm = pynxm.Nexus(api_key)

Track a new mod:

>>> game = "fallout3"
>>> mod_id = "00000"
>>> nxm.user_tracked_add(game, mod_id)

Endorse a mod:

>>> game = "newvegas"
>>> mod_id = "99999"
>>> nxm.mod_endorse(game, mod_id)


For more information check out pynxm’s API documentation at

You can supplement pynxm’s API docs with the Nexus API documentation.


Please use the GitHub issue tracker to submit bugs or request features.


Setup a virtualenv, install flit and run:

flit install -s

This will install an editable version of pynxm and all dev packages.

To run the checks and tests:


And to publish:

flit publish

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pynxm, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size pynxm-0.1.0-py2.py3-none-any.whl (24.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pynxm-0.1.0.tar.gz (13.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page