Skip to content

Latest commit

 

History

History
207 lines (194 loc) · 11.5 KB

README.md

File metadata and controls

207 lines (194 loc) · 11.5 KB
Raw

Note

In Oct 2024, Roblox released a Legacy API Overview page which documents nearly all of the API sites detailed below. We recommend you start there.

Roblox API Sites

Site Description
accountinformation.roblox.com All endpoints for acessing/modifying account information
accountsettings.roblox.com All endpoints for account/user settings
adconfiguration.roblox.com Roblox Ad Configuration related endpoints
ads.roblox.com Ads configuration endpoints
assetdelivery.roblox.com Serves asset content
auth.roblox.com All endpoints that tamper with authentication sessions
avatar.roblox.com Endpoints relating to the customization of player avatars
badges.roblox.com Endpoints for badges and badge awards management
billing.roblox.com Real money transactions and interaction
catalog.roblox.com Catalog items browsing and searching. Content and user based catalog items recommendations
chat.roblox.com All chat and party related endpoints
clientsettings.roblox.com Used by various Roblox clients to retrieve configuration information
clientsettingscdn.roblox.com Used by various Roblox clients to retrieve configuration information
client-telemetry.roblox.com Handles client telemetry
contentstore.roblox.com ApiSite to front the TemporaryStore for files before uploading to S3
contacts.roblox.com Contacts and userTag management
develop.roblox.com Game development configuration endpoints
economy.roblox.com Endpoints related to transactions and currency
economycreatorstats.roblox.com Roblox.EconomyCreatorStats.Api endpoints.
engagementpayouts.roblox.com For engagement-based payout information
ephemeralcounters.api.roblox.com Handles ephemeral counters
followings.roblox.com Establishes follow relationship between subscriber entities (users, groups, etc) and source entities (games, groups, assets, etc.)
friends.roblox.com Friends, followers, and contacts management
gameinternationalization.roblox.com Manages internationalization of games such as translating in game content.
gamejoin.roblox.com All endpoints around launching a game
gamepersistence.roblox.com Endpoints for the in-game datastore system for storing data for games
games.roblox.com All endpoints for game discovery, and details
groups.roblox.com Groups management
groupsmoderation.roblox.com Group Moderation
inventory.roblox.com All endpoints for viewing (but not granting) ownership of items
itemconfiguration.roblox.com Configure Items (bundles and avatar assets)
lms.roblox.com Status of the Latency Measurement Service
locale.roblox.com User locale management
localizationtables.roblox.com Handles managing of localization tables
metrics.roblox.com Record metrics across Roblox
notifications.roblox.com All notification stream endpoints
premiumfeatures.roblox.com This API is for premium features and anything pertaining to account add ons
presence.roblox.com All endpoints for managing presence
privatemessages.roblox.com All messages page endpoints
publish.roblox.com All endpoints handling file uploads
realtime.roblox.com Purpose of API here
share.roblox.com Purpose of Api here
search.roblox.com Legacy item search endpoints.
textfilter.roblox.com High volume text filtering
thumbnails.roblox.com Endpoints for requesting thumbnails
thumbnailsresizer.roblox.com Validate and resize thumbnails to requested dimensions
trades.roblox.com Endpoints for trading collectible items
translationroles.roblox.com Manages translation roles of developers in game localization
translations.roblox.com Endpoints for requesting translations
twostepverification.roblox.com Platform interface for the two step verification system
usermoderation.roblox.com Endpoints for performing actions/operations related to User Moderation
users.roblox.com APIs for direct Roblox user information.
voice.roblox.com APIs for Voice calls

Deprecated or poorly documented APIs

Search APIs

Returns a list of suggested content based on autocomplete.

https://apis.roblox.com/games-autocomplete/v1/get-suggestion/(partial name)

Thumbnail APIs

Asset Thumbnails

  • https://www.roblox.com/item-thumbnails?params=[{assetId:1818}]

    [{
  id: 1818,
  name: "Crossroads",
  url: "/Crossroads-place?id=1818",
  thumbnailFinal: true,
  thumbnailUrl: "https://t7.rbxcdn.com/134692bb990302f51fb8f52cfcdd8083",
  bcOverlayUrl: null,
  limitedOverlayUrl: null,
  deadlineOverlayUrl: null,
  limitedAltText: null,
  newOverlayUrl: null,
  imageSize: "large",
  saleOverlayUrl: null,
  iosOverlayUrl: null,
  transparentBackground: false
}]

    You can specify the small image size (110x110) with params=[{assetId:1818,imageSize:small}]. Otherwise it will default to large (420x420)

    Both of these APIs support JSONP, so this code can be embedded in any web page:

    $.getJSON('https://www.roblox.com/item-thumbnails?params=[{assetId:1818}]&jsoncallback=?', function(json) {
    alert(json[0].name);
});

Avatar Thumbnails

  • https://www.roblox.com/avatar-thumbnails?params=[{userId:261}]
    • Returns JSON
    [{
    "id": 261,
    "name": "Shedletsky",
    "url": "https://www.roblox.com/users/261/profile",
    "thumbnailFinal": true,
    "thumbnailUrl": "https://tr.rbxcdn.com/152bbbb5ba5953e40c91dd7e3dd0cf44/60/60/AvatarHeadshot/Png",
    "bcOverlayUrl": null,
    "substitutionType": 0
}]

Outfit Thumbnails

Valid Thumbnail Sizes

48x48 60x62 75x75 100x100 110x110 160x100 250x250 352x352 420x230 420x420
/Game/Tools/ThumbnailAsset.ashx x x x x
/Asset-Thumbnail/Json x x x x x x x x x x
/Thumbs/Asset.ashx x x x x x x x x x x
/Thumbs/Avatar.ashx x x x x x x x x x x
/Thumbs/RawAsset.ashx x x x x x x x x x x
thumbnailFormatId 2 24 280 41 47 163 114 124 8 254

User APIs

Get a user's profile games

  • https://www.roblox.com/users/profile/playergames-json?userId=261

    {
    "Title": "Games",
    "Games": [{
        "CreatorID": 0,
        "CreatorName": "Shedletsky",
        "CreatorAbsoluteUrl": "https://www.roblox.com/users/261/profile",
        "Plays": 65437,
        "Price": 0,
        "ProductID": 0,
        "IsOwned": false,
        "IsVotingEnabled": true,
        "TotalUpVotes": 79,
        "TotalDownVotes": 34,
        "TotalBought": 0,
        "UniverseID": 150387,
        "HasErrorOcurred": false,
        "Favorites": 1728,
        "Description": "In a dystopian future, Robloxia is overrun by killbots.",
        "GameDetailReferralUrl": "https://www.roblox.com/games/refer?PlaceId=119445489&Position=1&PageType=Profile",
        "Thumbnail": {
            "Final": true,
            "Url": "https://t7.rbxcdn.com/ebfb8e2733d4e06b32db6c33b2f17ba3",
            "RetryUrl": null,
	"UserId": 0,
	"EndpointType": "Avatar"
        },
        "UseDataSrc": false,
    "IsAsyncThumbnailEnabled": false,
    "GamePageResources": null,
        "Name": "Timmy and the Killbots",
        "PlaceID": 48891,
        "PlayerCount": 0,
        "ImageId": 0
    }]
}

Asset APIs

Upload an asset

POST /Data/Upload.ashx?assetid=1818 HTTP/1.1
Host: data.roblox.com
Cookie: .ROBLOSECURITY=*
Content-Type: application/xml; charset=utf-8
Content-Length: 17

<roblox></roblox>

Returns an assetVersionId

Setup APIs

Mobile version check

Downloads and version endpoints