Authentication
Secure your plugin requests using OAuth 2.0 and scoped bearer tokens. NexusPlay enforces strict rate limits of 1,200 requests per minute for verified developer accounts.
Generate a client ID and secret from the NexusPlay Developer Console. Exchange these credentials for an access token via the `/auth/token` endpoint. Tokens expire after 3600 seconds and must be refreshed using the provided refresh token. All API calls to `/library` and `/mods` require the `launcher:read` and `launcher:write` scopes.
Endpoints
Interact directly with the launcher's local library database and remote mod repository. All routes return JSON payloads with standard HTTP status codes.
GET /v2/library
Retrieve a paginated list of installed titles, including launch arguments, update status, and disk usage metrics. Supports filtering by platform (Steam, Epic, GOG) and install path.
POST /v2/mods/deploy
Push a compiled `.nexus` mod package to a target game directory. Handles dependency resolution, file conflict alerts, and automatic backup creation before injection.
PATCH /v2/games/{id}/config
Update launch parameters, resolution overrides, and custom shader profiles for a specific title. Changes persist across launcher restarts and sync to cloud saves.
Webhooks
Subscribe to launcher lifecycle events and trigger automated workflows in your plugin architecture. NexusPlay delivers HTTPS POST payloads to your registered callback URLs.
Configure webhook listeners for events like `game.launch`, `mod.install_complete`, and `library.sync_failed`. Each payload includes a `X-Nexus-Signature` header for HMAC-SHA256 verification. Implement a 200 OK response within 3 seconds to prevent retry queues from accumulating. Use the `/webhooks/test` endpoint to simulate event triggers during development.