Thumbnails

From RoAPI

User thumbnails[edit | edit source]

thumbnails.roblox.com[edit | edit source]

Endpoints[edit | edit source]

To generate user thumbnails, use the URL https://thumbnails.roblox.com/v1/users/TYPE?userIds=USER_IDS&size=SIZE&format=FORMAT&isCircular=IS_CIRCULAR where:

  • TYPE is either avatar, avatar-bust, or avatar-headshot
  • USER_IDS is a list of user IDs
  • SIZE is a width and height value, separated by an x: 30x30
  • FORMAT is either png or jpeg
  • IS_CIRCULAR is either true or false

Here's an example URL:https://thumbnails.roblox.com/v1/users/avatar-headshot?userIds=968108160%2C261%2C1%2C2&size=420x420&format=Png&isCircular=true

These endpoints return the following data:
{
  "data": [
    {
      "targetId": 1,
      "state": "Completed",
      "imageUrl": "https://tr.rbxcdn.com/HASH/WIDTH/HEIGHT/TYPE/FORMAT"
    }
  ]
}
Each item in the data list consists of the following:
Field Name Type Explanation
targetId int One of the user IDs that was passed to the endpoint.
state str Completed, InReview, Pending, Error, Moderated, or Blocked
imageUrl str? The target image URL.

www.roblox.com[edit | edit source]

Deprecated - When possible, try to use endpoints on thumbnails.roblox.com.

Endpoints[edit | edit source]

To generate user thumbnails using www.roblox.com's thumbnail endpoints, use the URL https://www.roblox.com/TYPE-thumbnail/KIND?userId=USER_ID&width=WIDTH&height=HEIGHT&format=FORMAT where:

  • TYPE is either avatar, headshot, or bust
  • KIND is either image or json
  • USER_ID is a User ID
  • WIDTH is the width of the image (must be one of the allowed sizes)
  • HEIGHT is the height of the image (must be one of the allowed sizes)
  • FORMAT is either png or jpeg
If KIND is image, this endpoint will immediately redirect to a CDN link. If KIND is json, the following data is returned:
{
  "Url": "https://tr.rbxcdn.com/HASH/HEIGHT/WIDTH/AvatarTYPE/FORMAT",
  "Final": true
}
This is what that data consists of:
Field Name Type Explanation
Url str? A CDN link to an image.
Final bool Whether this is a "final" thumbnail image.

Avatar.ashx[edit | edit source]

To generate user thumbnails using Avatar.ashx, use the endpoint https://www.roblox.com/Thumbs/Avatar.ashx?x=SIZE_X&y=SIZE_Y&username=USERNAME . It can only generate headshots.

This endpoint requires one of the valid headshot thumbnail sizes and will not resize images. It redirects immediately to a CDN link so no parsing is required.

Asset thumbnails[edit | edit source]