PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience

Useful Web APIs and User Info

Useful Web APIs and User Info

Jul 12 2018, 8:24 PM PST 5 min

This is a user-compiled list of useful APIs on the Roblox website.

Unless an API is located at api.roblox.com, it may be subject to change without warning.

A list of Roblox-supported APIs can be found at http://api.roblox.com/docs

Image APIs

Builders Club Icon

https://www.roblox.com/Thumbs/BCOverlay.ashx?username=Roblox

User Thumbnail

Regular

https://www.roblox.com/Thumbs/Avatar.ashx?x=100&y=100&username=Roblox
https://www.roblox.com/Thumbs/Avatar.ashx?x=100&y=100&userId=1

Endpoints

https://www.roblox.com/bust-thumbnail/image?userId=1&width=420&height=420&format=png

https://www.roblox.com/headshot-thumbnail/image?userId=1&width=420&height=420&format=png

https://www.roblox.com/outfit-thumbnail/image?userOutfitId=1&width=420&height=420&format=png

Bust

https://www.roblox.com/bust-thumbnail/json?userId=1&height=180&width=180

{
    "Url": "https://t7.rbxcdn.com/55927a0871baa4126a63b7588df6749b",
    "Final": true
}

Headshot

https://www.roblox.com/headshot-thumbnail/json?userId=1&width=180&height=180

{
    "Url": "https://t0.rbxcdn.com/defe810d23755417afd7136602367301",
    "Final": true
}

Asset thumbnail

https://www.roblox.com/Thumbs/Asset.ashx?width=110&height=110&assetId=1818

Group thumbnail

game:GetService("GroupService"):GetGroupInfoAsync(groupId).EmblemUrl

Friendship APIs

Check if two users are friends

https://www.roblox.com/Game/LuaWebService/HandleSocialRequest.ashx?method=IsFriendsWith&playerId=261&userId=156

<Value Type="boolean">true</Value>

Check if a user is best friends with another user

https://www.roblox.com/Game/LuaWebService/HandleSocialRequest.ashx?method=IsBestFriendsWith&playerId=261&userId=156

<Value Type="boolean">false</Value>

Get a user’s best friends

https://www.roblox.com/friends/json?userId=261&currentPage0&pageSize##20&imgWidth=110&imgHeight=110&imgFormat=jpeg&friendsType=BestFriends
`

{
  "UserId": 261,
  "TotalFriends": 15,
  "CurrentPage": 0,
  "PageSize": 20,
  "TotalPages": 1,
  "FriendsType": "BestFriends",
  "Friends": [{
    "UserId": 916,
    "Username": "Matt Dusek",
    "AvatarUri": "https://t7.rbxcdn.com/795ccf5d624d3a9c1a53eaa7d7ec09d4",
    "AvatarFinal": true,
    "IsBestFriend": true,
    "OnlineStatus": {
      "LocationOrLastSeen": "1/23/2015 7:00 PM",
      "ImageUrl": "~/images/offline.png",
      "AlternateText": "Matt Dusek is offline (last seen at 1/23/2015 7:00:04 PM."
    },
    "InvitationId": 0,
    "FriendshipStatus": 4
  }]
}

User APIs

Check if a username has been taken

https://www.roblox.com/UserCheck/DoesUsernameExist?username=Shedletsky

{
    "success" :true
}

Get username from ID

https://api.roblox.com/Users/261

{
    "Id": 261,
    "Username": "Shedletsky"
}

Get ID from username

https://api.roblox.com/users/get-by-username?username=Roblox

{
    "Id": 1,
    "Username": "Roblox"
}

Get a user’s body part colors

https://www.roblox.com/Asset/BodyColors.ashx?userId=261

<?xml version="1.0" encoding="utf-8" ?>
<roblox xmlns:xmime="https://www.w3.org/2005/05/xmlmime" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://www.roblox.com/roblox.xsd" version="4">
    <External>null</External>
    <External>nil</External>
    <Item class="BodyColors">
        <Properties>
            <int name="HeadColor">24</int>
            <int name="LeftArmColor">24</int>
            <int name="LeftLegColor">24</int>
            <string name="Name">Body Colors</string>
            <int name="RightArmColor">24</int>
            <int name="RightLegColor">24</int>
            <int name="TorsoColor">1003</int>
            <bool name="archivable">true</bool>
        </Properties>
    </Item>
</roblox>

Get AssetIds being worn by a user

https://www.roblox.com/Asset/AvatarAccoutrements.ashx?userId=261

https://www.roblox.com/Asset/BodyColors.ashx?userId=261;https://www.roblox.com/Asset/?id=42070576;https://www.roblox.com/Asset/?id=1078076;https://www.roblox.com/Asset/?id=1882759

Get AssetVersionIds being worn by a user

https://www.roblox.com/Asset/CharacterFetch.ashx?userId=261&placeId=1818

https://www.roblox.com/Asset/BodyColors.ashx?userId=261;https://www.roblox.com/Asset/?versionid=25379590;https://www.roblox.com/Asset/?versionid=77449723;https://www.roblox.com/Asset/?versionid=100748238;https://www.roblox.com/Asset/?versionid=197094072

Get a user’s places

https://www.roblox.com/Contests/Handlers/Showcases.ashx?userId=261

{
  "Error": "",
  "Count": "114",
  "UserIsAtMaxShowcases": "false",
  "Showcase": [
    {
      "ID": 145723245,
      "Name": "Shedletsky's Place Number: 113"
    },
    {
      "ID": 137687040,
      "Name": "King's Landing Nigh-Infinite Terrain Demo"
    }
  ]
}

Get a user’s Roblox badges

https://www.roblox.com/badges/roblox?userId=261&imgWidth=110&imgHeight=110&imgFormat=png

{
  "UserId": 261,
  "RobloxBadges": [{
    "ImageUri": "https://images.rbxcdn.com/5eb20917cf530583e2641c0e1f7ba95e.png",
    "Name": "Friendship"
  }, {
    "ImageUri": "https://images.rbxcdn.com/8d77254fc1e6d904fd3ded29dfca28cb.png",
    "Name": "Combat Initiation"
  }, {
    "ImageUri": "https://images.rbxcdn.com/0a010c31a8b482731114810590553be3.png",
    "Name": "Warrior"
  }, {
    "ImageUri": "https://images.rbxcdn.com/139a7b3acfeb0b881b93a40134766048.png",
    "Name": "Bloxxer"
  }, {
    "ImageUri": "https://images.rbxcdn.com/01044aca1d917eb20bfbdc5e25af1294.png",
    "Name": "Inviter"
  }, {
    "ImageUri": "https://images.rbxcdn.com/b66bc601e2256546c5dd6188fce7a8d1.png",
    "Name": "Homestead"
  }, {
    "ImageUri": "https://images.rbxcdn.com/49f3d30f5c16a1c25ea0f97ea8ef150e.png",
    "Name": "Bricksmith"
  }, {
    "ImageUri": "https://images.rbxcdn.com/b7e6cabb5a1600d813f5843f37181fa3.png",
    "Name": "Veteran"
  }, {
    "ImageUri": "https://images.rbxcdn.com/7df6357ab1eb2dcf5267d2c5184732ab.png",
    "Name": "Outrageous Builders Club"
  }, {
    "ImageUri": "https://images.rbxcdn.com/6c2a598114231066a386fa716ac099c4.png",
    "Name": "Welcome To The Club"
  }]
}

Asset APIs

Get comments on an asset

https://www.roblox.com/API/Comments.ashx?rqtype=getComments&assetID207206653&startIndex=0

{
  "isMod": false,
  "totalCount": 2123,
  "data": [{
    "ID": 141134671,
    "Date": "1 minute",
    "Author": "SpearmintBoy",
    "AuthorID": 341792,
    "Content": "Here is the trade t-shirt for this: id=207865600",
    "AuthorOwnsAsset": true
  }]
}

Get parts of a package

https://www.roblox.com/Game/GetAssetIdsForPackageId?packageId=27133145

[27132957,27132990,27133013,27133040,27133055]

Check if a user owns an asset

https://api.roblox.com/Ownership/HasAsset?userId=261&assetId1818

local assetId = 1818
local result = game:GetService("BadgeService"):UserHasBadge(player.userId, assetId)
print(result) --> false

Get information about an asset

https://api.roblox.com/Marketplace/ProductInfo?assetId=1818

{
    "AssetId": 1818,
    "ProductId": 1305046,
    "Name": "Crossroads",
    "Description": "The classic Roblox level is back!",
    "AssetTypeId": 9,
    "Creator": {
        "Id": 1,
        "Name": "Roblox"
    },
    "IconImageAssetId": 0,
    "Created": "2007-05-01T01:07:04.78Z",
    "Updated": "2013-07-01T16:40:24.527Z",
    "PriceInRobux": null,
    "PriceInTickets": null,
    "Sales": 0,
    "IsNew": false,
    "IsForSale": false,
    "IsPublicDomain": false,
    "IsLimited": false,
    "IsLimitedUnique": false,
    "Remaining": null,
    "MinimumMembershipLevel": 0,
    "ContentRatingTypeId": 0
}

Get an asset’s latest AssetVersionId

https://www.roblox.com/studio/plugins/info?assetId=1818

Download an asset


Group APIs

Get information about a group

https://api.roblox.com/groups/2

{
  "Name": "LOL",
  "Id": 2,
  "Owner": {
    "Name": "Shedletsky",
    "Id": 261
  },
  "EmblemUrl": "https://www.roblox.com/asset/?id=13757475",
  "Description": "LOL is dedicated to spreading lulz on Roblox. We make hilarious places and run hilarious user ads.",
  "Roles": [{
    "Name": "Cheezburgers",
    "Rank": 1
  }, {
    "Name": "Lieutenant of LOL",
    "Rank": 253
  }, {
    "Name": "LOLCATS",
    "Rank": 254
  }, {
    "Name": "God of LOL",
    "Rank": 255
  }]
}

Check if a user is in a group

https://www.roblox.com/Game/LuaWebService/HandleSocialRequest.ashx?method=IsInGroup&playerid=261&groupid=57

<Value Type="boolean">false</Value>

Get a user’s rank number

https://www.roblox.com/Game/LuaWebService/HandleSocialRequest.ashx?method=GetGroupRank&playerid=261&groupid=57

<Value Type="integer">0</Value>

Get a user’s rank name

https://www.roblox.com/Game/LuaWebService/HandleSocialRequest.ashx?method=GetGroupRole&playerid=261&groupid=57

Guest

Get a group’s ranks

https://www.roblox.com/api/groups/1/RoleSets/

[{
    "ID": 169,
    "Name": "Member",
    "Rank": 1
}, {
    "ID": 143227,
    "Name": "Dude",
    "Rank": 180
}, {
    "ID": 143226,
    "Name": "Hunk",
    "Rank": 200
}, {
    "ID": 94,
    "Name": "Admin",
    "Rank": 254
}, {
    "ID": 28,
    "Name": "Owner",
    "Rank": 255
}]

Get a user’s primary group

https://www.roblox.com/Groups/GetPrimaryGroupInfo.ashx?users=Shedletsky,builderman

{
    "Shedletsky": {
        "GroupId": 685397,
        "GroupName": "The IronNoob Forums",
        "RoleSetName": "Forum Owner",
        "RoleSetRank": 254
    }
}

Place APIs

Get game passes for a place

https://www.roblox.com/Game/GetGamePassesPaged?placeId=177052655&startIndex1&maxRows=3

{
  "data": [{
    "PassID": 177131975,
    "PassName": "VIP",
    "TotalSales": 38807,
    "PriceInRobux": 25,
    "PriceInTickets": 0,
    "Description": "Support the game and get a shiny gold [VIP] name tag.",
    "UserOwns": false,
    "PassItemURL": "/VIP-item?id=177131975",
    "ProductID": 21177271,
    "TotalUpVotes": 79,
    "TotalDownVotes": 58,
    "UserVote": null,
    "TotalFavorites": 114,
    "IsFavoritedByUser": false
  }],
  "totalItems": 1
}

See also

Tags:
  • api
  • rest
  • web