nexus-mods-api 1.0.0

Typed sync and async Python clients for the Nexus Mods APIs

nexus-mods-api

Unofficial, typed synchronous and asynchronous Python clients for all three Nexus Mods APIs:

• REST v1 with hand-written Pydantic v2 models
• GraphQL v2 with typed execution and convenience queries
• REST v3 generated from a checked-in, SHA-256-pinned OpenAPI specification

Authentication supports manual application-specific API keys, WebSocket SSO, and OAuth 2.0 Authorization Code with PKCE. OAuth applications do not use a client secret.

Installation

python -m pip install nexus-mods-api

Python 3.12 or newer is required. Install the optional WebSocket dependency for SSO:

python -m pip install "nexus-mods-api[sso]"

Quick start

from nexusmods_api import ApiKeyAuth, NexusClient, NexusConfig

config = NexusConfig(
    application_name="your-registered-app",
    application_version="1.0.0",
)

with NexusClient(config, ApiKeyAuth.from_value("your-api-key")) as client:
    games = client.v1.get_games()

Equivalent native async clients are available for applications that already use an event loop. The aggregate clients lazily construct their REST v1, GraphQL v2, and REST v3 clients.

Documentation

The authoritative documentation is maintained as AsciiDoc, starting at the documentation overview. It includes installation, sync and async usage, all authentication flows, API guides, error handling, rate limits, code generation, testing, and releases.

Version 1.0.0 completed both the mocked conformance suite and live acceptance tests for manual API key, SSO, and OAuth with maintainer-owned Nexus Mods application registrations.

License

MIT — see LICENSE.

About Modding Forge

nexus-mods-api is built for the Python tooling behind Modding Forge.

This project is not affiliated with or endorsed by Nexus Mods.