Assets
GET /assets/{id}/versions
Retrieves asset information for the specified asset ID. The authenticated user must be able to manage the asset.
Parameters
id | long | The ID of the asset. |
placeId | long? | The ID of the place. |
page | int | (Optional)The page to retrieve. |
Returns
[{
"Id":536133191,
"AssetId":226132918,
"VersionNumber":3,
"RawContentId":2619739106,
"ParentAssetVersionId":536132109,
"CreatorType":1,
"CreatorTargetId":80502178,
"CreatingUniverseId":null,
"Created":"2015-07-13T11:51:12.9073098-05:00",
"Updated":"2015-07-13T11:51:12.9073098-05:00"
}]
Response Error
403 | Access to asset is denied |
409 | For PlatformException |
GET /v2/assets/{id}/versions
Retrieves asset information for the specified asset ID. The authenticated user must be able to manage the asset
or have granted asset permissions. (if nextPageCursor is null, there is no more items)
Parameters
id | long | The ID of the asset. |
placeId | long? | The ID of the place. |
cursor | string | (Optional) cursor to fetch next page. |
sortOrder | SortOrder | (Optional) Sorting order of asset version, defaults to descending. |
limit | int | (Optional) Size of page to fetch. |
Returns
{
"previousPageCursor": null,
"nextPageCursor": "4",
"data": [{
"Id": 2147905864,
"AssetId": 2147765363,
"VersionNumber": 8,
"ParentAssetVersionId": 2147905863,
"CreatorType": 1,
"CreatorTargetId": 23265213,
"CreatingUniverseId": 2147757210,
"Created": "2019-10-16T21:44:42.417Z",
"Updated": "2019-10-16T21:44:42.417Z"
}]
}
Response Error
400 | Invalid request |
404 | Asset not found |
409 | For PlatformException |
500 | Internal server error |
502 | Bad Gateway |
Currency
GET /currency/balance
Returns the Robux and Ticket balances for the currently authenticated user.
Returns
{
"robux":10
}
Friends
GET /users/{userId}/friends
Retrieves a paged list of friends for the specified user.
Parameters
userId | long | The ID of the user. |
page | int | (Optional) The page to retrieve. Value is set to 1 by default. |
Returns
[{
"Id":12345678,
"Username":"user",
"AvatarUri":"",
"AvatarFinal":true,
"IsOnline":true
}]
IncomingItems
GET /incoming-items/counts
Get number of incoming items.
Returns
{"unreadMessageCount": 1, "friendRequestsCount": 2}
Response Error
403 | Forbidden |
404 | NotFound |
Marketplace
GET /marketplace/productinfo
Returns the product info for the specified asset.
Parameters
assetId | long | The ID of the asset. |
Returns
{
"TargetId":123456789,
"ProductType":"User Product",
"AssetId":123456789,
"ProductId":24870409,
"Name":"Hat",
"Description":"",
"AssetTypeId":8,
"Creator":{"Id":1,"Name":"ROBLOX"},
"IconImageAssetId":0,
"Created":"2015-06-25T20:07:49.147Z",
"Updated":"2015-07-11T20:07:51.863Z",
"PriceInRobux":350,
"PriceInTickets":null,
"Sales":0,
"IsNew":true,
"IsForSale":true,
"IsPublicDomain":false,
"IsLimited":false,
"IsLimitedUnique":false,
"Remaining":null,
"MinimumMembershipLevel":0
}
GET /marketplace/game-pass-product-info
Returns the product info for the specified game pass.
Parameters
gamePassId | long | The ID of the asset. |
Returns
{
"TargetId":123456789,
"ProductType":"Game Pass",
"AssetId":123456789,
"ProductId":24870409,
"Name":"Hat",
"Description":"",
"AssetTypeId":8,
"Creator":{"Id":1,"Name":"ROBLOX"},
"IconImageAssetId":0,
"Created":"2015-06-25T20:07:49.147Z",
"Updated":"2015-07-11T20:07:51.863Z",
"PriceInRobux":350,
"PriceInTickets":null,
"Sales":0,
"IsNew":true,
"IsForSale":true,
"IsPublicDomain":false,
"IsLimited":false,
"IsLimitedUnique":false,
"Remaining":null,
"MinimumMembershipLevel":0
}
Ownership
GET /ownership/hasasset
Checks if a user owns the specified asset.
Parameters
userId | int | The ID of the user. |
assetId | long | The ID of the asset. |
Returns
true/false
Reference
GET /reference/deviceinfo
Get device info.
Returns
{
"PlatformType": "platform name",
"DeviceType": "device type",
"OperatingSystemType": "OS type"
}
UserBlock
POST /userblock/block
Block a user; prevent communication between the current user and the user specified.
Parameters
userId | long | UserId of the user to be blocked |
Returns
{
"success":true
}
Response Error
400 | Bad Request: Invalid user id |
POST /userblock/unblock
Unblock a user; allow communication between the current user and the user specified.
Parameters
userId | long | UserId of the user to be unblocked |
Returns
{
"success":true
}
Response Error
400 | Bad Request: Invalid user id |
Users
GET /users/{userId}
Retrieves user information for the specified user ID.
Parameters
userId | int | The ID of the user. |
Returns
{
"Id": 12345678,
"Username": "user name"
}
Response Error
400 | Invalid userId |
GET /users/get-by-username
Retrieves user information for the specified username.
Parameters
username | string | The name of the user. |
Returns
{"Id": 12345678, "Username":"user name"}
Response Error
Invalid username | |
User not found |
GET /users/{userId}/canmanage/{assetId}
Returns whether the user can manage a given asset.
Parameters
userId | long | The ID of the user. |
assetId | long | The ID of the asset. |
Returns
{
"Success": true,
"CanManage": false
}
Response Error
Unknown user or asset | |
Invalid/negative userId: {userId} or assetId: {assetId} |