API Documentation
Ways to get the APIs
-
Cloud: create.roblox.com/docs/cloud
-
Swagger:
accountsettings.roblox.com/docs(change category) -
GitHub (matthewdean) - categories, links opens in Swagger
-
DevTools: F12 > Network > Fetch/XHR
Reference
View Enums (Asset, Bundle types)Methods
[G] – GET
[P] – POST
Response Codes
200
Valid
302
Invalid (Redirect)
401
Invalid
403
Banned
429
Rate Limit
[JSON] response.json()
[HEADERS] response.headers
[STATUS] response.status
Cookie Requirement
C+
Yes
C-
No
C=
Private Profile Only
Account
{UserId} : User ID | without {}
Query Params
[LIM] &limit=
[CNT] &count=
[CSR] &cursor=
[NSR] &nextCursor=
[ESI] &exclusiveStartId=
G
C+
Valid Status
https://users.roblox.com/v1/users/authenticated
Returns: [STATUS]
G
C+
Banned Check
https://usermoderation.roblox.com/v1/not-approved
Returns: [JSON]
G
C+
Account Information
https://www.roblox.com/my/settings/json
['UserId']
['Name']
['DisplayName']
['AccountAgeInDays']
['IsPremium']
['CanTrade']
['MyAccountSecurityModel']['IsEmailSet']
['MyAccountSecurityModel']['IsEmailVerified']
['MyAccountSecurityModel']['IsTwoStepEnabled']
['IsAccountPinEnabled']
['UserAbove13']
P
C+
Profile Information
https://apis.roblox.com/profile-platform-api/v1/profiles/get
G
C+
Robux
https://economy.roblox.com/v1/users/{UserId}/currency
Returns: [JSON]['robux']
G
C+
Billing
https://billing.roblox.com/v1/credit
Returns: [JSON]['robuxAmount']
G
C+
Transactions For Year
https://economy.roblox.com/v2/users/{UserId}/transaction-totals?timeFrame=Year&transactionType=summary
['pendingRobuxTotal'], ['outgoingRobuxTotal']
G
C+
LIM
CSR
Transactions For All Time
https://economy.roblox.com/v2/users/{UserId}/transactions?transactionType=2
['currency']['amount'] for item in [JSON]['data']
G
C=
Rap (Recent Average Price)
https://inventory.roblox.com/v1/users/{UserId}/assets/collectibles
['recentAveragePrice'] for item in [JSON]['data']
G
C+
Cards
https://apis.roblox.com/payments-gateway/v1/payment-profiles
Returns: len([JSON])
G
C=
CNT
ESI
Gamepasses
https://apis.roblox.com/game-passes/v1/users/{UserId}/game-passes
['name'], ['gamePassId'] for item in [JSON]['gamePasses']
G
C=
LIM
CSR
Badges
https://badges.roblox.com/v1/users/{UserId}/badges
['name'], ['id'] for item in [JSON]['data']
G
C=
Badges (Faster)
https://badges.roblox.com/v1/users/{UserId}/badges/awarded-dates?badgeIds=
['id'] for item in [JSON]['data']
G
C-
LIM
CSR
Favorite Places
https://games.roblox.com/v2/users/{UserId}/favorite/games
['name'], ['rootPlace']['id'] for item in [JSON]['data']
G
C+
Places Weekly Playtime
https://apis.roblox.com/parental-controls-api/v1/parental-controls/get-top-weekly-screentime-by-universe
G
C=
LIM
CSR
Bundles
https://catalog.roblox.com/v1/users/{UserId}/bundles/1
['name'], ['id'] for item in [JSON]['data']
G
C-
Groups
https://groups.roblox.com/v1/users/{UserId}/groups/roles?includeLocked=true
['role']['rank'], ['group']['id'] for item in [JSON]['data']
G
C+
Inventory Privacy
https://apis.roblox.com/user-settings-api/v1/user-settings/settings-and-options
[JSON]['whoCanSeeMyInventory']['currentValue']
G
C+
Trade Privacy
https://accountsettings.roblox.com/v1/trade-privacy
[JSON]['tradePrivacy']
G
C+
NSR
Sessions
https://apis.roblox.com/token-metadata-service/v1/sessions
[JSON]['sessions']
G
C+
Phone
https://accountinformation.roblox.com/v1/phone
[JSON]['phone']
G
C+
Age Group
https://apis.roblox.com/user-settings-api/v1/account-insights/age-group
[JSON]['ageGroupTranslationKey']
13-: Label.AgeBandUnder13
13+: Label.AgeBandOver13
18-: Label.AgeBandUnder18
18+: Label.AgeBandOver18
13+: Label.AgeBandOver13
18-: Label.AgeBandUnder18
18+: Label.AgeBandOver18
G
C+
Verified Age
https://apis.roblox.com/age-verification-service/v1/age-verification/verified-age
[JSON]['isVerified']
G
C+
Verified Voice
https://voice.roblox.com/v1/settings
[JSON]['isVerifiedForVoice']
G
C-
Friends Count
https://friends.roblox.com/v1/users/{UserId}/friends/count
[JSON]['count']
G
C-
Followers Count
https://friends.roblox.com/v1/users/{UserId}/followers/count
[JSON]['count']
G
C-
Followings Count
https://friends.roblox.com/v1/users/{UserId}/followings/count
[JSON]['count']
G
C-
Roblox Badges
https://accountinformation.roblox.com/v1/users/{UserId}/roblox-badges
['name'] for item in [JSON]
P
C-
Check Reged Usernames
https://users.roblox.com/v1/usernames/users
['requestedUsername'] for item in [JSON]['data']
P
C+
X-CSRF-Token
https://auth.roblox.com/v2/logout
[HEADERS]['X-CSRF-Token']
P
C+
Authentication Ticket
https://auth.roblox.com/v1/authentication-ticket
[HEADERS]['rbx-authentication-ticket']
P
C-
Set Cookie
https://auth.roblox.com/v1/authentication-ticket/redeem
[HEADERS]['Set-Cookie'] (first one might be empty, get second)
Group
{GroupId} : Group ID | without {}
G
C+
Group Pending For Year
https://apis.roblox.com/transaction-records/v1/groups/{GroupId}/revenue/summary/year
[JSON]['pendingRobux']
G
C+
Group Funds
https://economy.roblox.com/v1/groups/{GroupId}/currency
[JSON]['robux']
Place
{PlaceId} : Place ID ‾\/‾ without {}
{UniverseId} : Universe ID _/
Query Params
[UIS] ?universeIds=
[LIM] &limit=
[PGS] &pageSize=
[PGT] &pageToken=
G
C-
Universe ID
https://apis.roblox.com/universes/v1/places/{PlaceId}/universe
['universeId'] in [JSON]
G
C-
UIS
Place Information
https://games.roblox.com/v1/games
['name'] in [JSON]['data']
G
C-
PGS
PGT
Gamepasses
https://apis.roblox.com/game-passes/v1/universes/{UniverseId}/game-passes
['name'], ['id'] in [JSON]['gamePasses']
G
C-
LIM
CSR
Badges
https://badges.roblox.com/v1/universes/{UniverseId}/badges
['name'], ['id'] in [JSON]['data']
G
C-
LIM
LIM
Products
https://apis.roblox.com/experience-store/v1/universes/{UniverseId}/store
['Name'], ['ProductId'] in [JSON]['developerProducts']