Overview

Nexus.gg Referral API 1.1.0

Seamlessly integrate the Nexus creator program into your native checkout process

Contact

• engineering@nexus.gg

Information

• OpenAPI version: 3.0.0

Operations

GET

/

GET

/player/{playerId}

GET

/player/{playerId}/code

GET

/code/{code}

POST

/

DELETE

/{referralId}

Authentication

PublicApiKeyAuth

Send your public API key (nexus_pk_...) in the X-SHARED-SECRET header. Generate one in the Publisher Dashboard.

X-SHARED-SECRET: nexus_pk_your_key_here

Public keys authenticate the read-only referral lookups (by player, by code, and a player’s current code), so they are safe to ship inside a game client. A request with a missing, inactive, or wrong-type key is rejected with 401 Unauthorized.

Security scheme type: apiKey

Header parameter name: X-SHARED-SECRET

PrivateApiKeyAuth

Send your secret API key (nexus_sk_...) in the X-SHARED-SECRET header. Generate one in the Publisher Dashboard.

X-SHARED-SECRET: nexus_sk_your_key_here

Private keys authenticate listing, creating, and deleting referrals, so keep them server-side only. A request with a missing, inactive, or wrong-type key is rejected with 401 Unauthorized.

Security scheme type: apiKey

Header parameter name: X-SHARED-SECRET