Expand description
Roblox HTTP flows and strict launch-URI construction.
Structsยง
- Game
Response ๐ - One gameโs details.
- Games
Envelope ๐ - The games API response.
- Presence
Detail - Presence plus the game an in-game account is playing. Roblox omits the place for accounts the viewing session isnโt allowed to see.
- Presence
Envelope ๐ - The presence API response.
- Presence
Response ๐ - One userโs presence.
- Profile
- A Roblox userโs public profile.
- Thumbnail
Envelope ๐ - The thumbnails API response.
- Thumbnail
Response ๐ - One avatar image.
- Universe
Response ๐ - The place universe API response.
- User
Response ๐ - A user from the users API.
Enumsยง
- Roblox
Error - Why a Roblox request failed. Displays as a user-facing message.
Constantsยง
- AUTH_
URL ๐ - Returns the user a session belongs to.
- GAMES_
URL ๐ - Game details, by universe ID.
- PLACE_
LAUNCHER_ ๐URL - Roblox place launcher, passed to the client in the launch URI.
- PLACE_
UNIVERSE_ ๐URL - The universe a place belongs to.
- PRESENCE_
URL ๐ - User presence. Requires a signed-in session.
- THUMBNAIL_
URL ๐ - Avatar headshot images.
- TICKET_
URL ๐ - Issues one-time authentication tickets for launching the Roblox client.
- USERS_
URL ๐ - Public user profiles, by ID.
Staticsยง
- TRACKER_
SEQUENCE ๐ - Keeps browser tracker IDs distinct for joins in the same instant.
Functionsยง
- authenticated_
profile - Returns the profile of the user a session belongs to, validating the session.
- build_
join_ uri - Builds a
roblox-player:URI that joins the place as the sessionโs user. - clean_
game_ ๐name - Trims a Roblox-supplied game name and caps its length for display.
- cookie_
header ๐ - Builds the session cookie header, marked sensitive so it isnโt logged.
- fetch_
game_ names - Looks up game names by universe ID. Failures return no names because theyโre display-only.
- fetch_
place_ universe - Finds the universe for a place.
Ok(None)means Roblox has no universe for that place. - fetch_
presence - Returns each requested userโs presence state.
- fetch_
presence_ details - Returns each requested userโs presence and game, retrying once with the CSRF token Roblox returns on the first request.
- join_
uri ๐ - Formats the launch URI for a ticket and place.
- parse_
games_ ๐response - Keeps names for requested universes only.
- parse_
place_ id - Extracts a place ID from digits or an
https://www.roblox.com/games/<id>/รขโฌยฆlink. - parse_
presence_ ๐response - Maps each requested user to a presence. Users missing from the response are
Unknown, and game details are kept only for users in game. - profile_
with_ ๐avatar - Adds the userโs avatar headshot URL. A missing avatar isnโt an error.
- public_
profile - Returns a userโs public profile, rejecting a response for a different user.