Users
As the foundation of Lux's ecosystem, users are central to our multiplayer internet experience. Every user on Lux contributes to transforming static websites into vibrant, interactive spaces. This page details the various user endpoints you can leverage to manage accounts programmatically. We'll explore how to query, create, update, and delete user profiles within the Lux environment.
The user model
The user model encompasses all essential information about a Lux user, including their username, avatar customizations, and contact details. It also maintains references to shared spaces they've joined and tracks their activity status across the Lux network, enabling seamless multiplayer interactions throughout the web.
Properties
- Name
id- Type
- string
- Description
Unique identifier for the user.
- Name
username- Type
- string
- Description
The unique username of the user.
- Name
email- Type
- string
- Description
The unique email for the user.
- Name
wallet- Type
- string
- Description
The unique public wallet address for the user.
- Name
avatar- Type
- string
- Description
The avatar image URL for the user.
- Name
dob- Type
- string
- Description
The birthday of the user.
- Name
status- Type
- string
- Description
The editable status of the user.
- Name
bio- Type
- string
- Description
The editable bio for the user.
- Name
verified- Type
- boolean
- Description
The verification status of the email for the user.
- Name
public_flags- Type
- integer
- Description
The public flags for the user.
- Name
banned_until- Type
- timestamp
- Description
Timestamp of when the user is banned until.
- Name
created_at- Type
- timestamp
- Description
Timestamp of when the user was created.
- Name
updated_at- Type
- timestamp
- Description
Timestamp of when the user was last updated.
Get a user
This endpoint allows you to retrieve a user by providing their Lux id. Refer to the list at the top of this page to see which properties are included with user objects.
Request
curl https://api.lux.gg/v1/users/1344387816333352652 \
-H "Authorization: {token}"
Response
{
"id": "1344387816333352652",
"username": "tino",
"email": "tino@lux.gg",
"wallet": "KtWwxWwQDwoQASN1SrGCWHcqBMfpspRXeccCFauqAPX",
"avatar": "https://cdn.lux.gg/avatars/1344387816333352652/2b88c176c528fd7303dd398ba6dc6255.png",
"status": "i like green eggs and ham",
"bio": "sometimes when im bored i stare directly at the sun for a few hours",
"verified": true,
"dob": "2000-04-07",
"public_flags": 0,
"banned_until": null,
"created_at": 2025-02-26 19:17:12.848375,
"updated_at": 2025-02-26 19:17:12.848375
}
Get current user
This endpoint allows you to retrieve the current user by providing the @me directive. Refer to the list at the top of this page to see which properties are included with user objects.
Request
curl https://api.lux.gg/v1/users/@me \
-H "Authorization: {token}"
Response
{
"id": "1344387816333352652",
"username": "tino",
"email": "tino@lux.gg",
"wallet": "KtWwxWwQDwoQASN1SrGCWHcqBMfpspRXeccCFauqAPX",
"avatar": "https://cdn.lux.gg/avatars/1344387816333352652/2b88c176c528fd7303dd398ba6dc6255.png",
"status": "i like green eggs and ham",
"bio": "sometimes when im bored i stare directly at the sun for a few hours",
"verified": true,
"dob": "2000-04-07",
"public_flags": 0,
"banned_until": null,
"created_at": 2025-02-26 19:17:12.848375,
"updated_at": 2025-02-26 19:17:12.848375
}