PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
I want to find out more Accept
Collapse Sidebar
  1. LEARN ROBLOX
  2. USER INTERFACE

Catalog API

Hide content
CONTENT
  1. LEARN ROBLOX
  2. USER INTERFACE

Catalog API

Jun 18 2019, 5:10 PM PST 5 min

Roblox offers formatted catalog item data for use in custom desktop and browser applications.

Getting Catalog Items

Catalog items can be obtained in JSON format where [params] is a serialized query object identical to that used on the Catalog page.

Example Format

Here’s an example of the Cuter Fox item returned in JSON format:

{"AssetId": 66747327,
"Name": "Cuter Fox",
"Url": "/Cuter-Fox-item?id=66747327",
"PriceInRobux": "50",
"Updated": "4 months ago",
"Favorited": "0 times",
"Sales": "0",
"Remaining": "",
"Creator": "Roblox",
"CreatorUrl": "/User.aspx?ID=1",
"PrivateSales": "",
"PriceView": 2,
"BestPrice": "",
"ContentRatingTypeID": 0,
"AssetTypeID": 8,
"CreatorID": 1,
"CreatedDate": "\/Date(1322616958803)\/",
"UpdatedDate": "\/Date(1322701833910)\/",
"IsForSale": true,
"IsPublicDomain": false,
"IsLimited": false,
"IsLimitedUnique": false,
"MinimumMembershipLevel": 1}
Field(s) Notes
Name This is in UTF-8 format.
CreatedDate, UpdatedDate These are in UTC format.
PrivateSales, BestPrice These will be empty except for limited edition items, in which case they will return the number of private sellers and the best price for the item, respectively.
MinimumMembershipLevel
  • 0 = Any membership
  • 1 = Builders Club only
  • 2 = Turbo Builders Club only
  • 3 = Outrageous Builders Club only
ContentRatingTypeID
  • 0 = No content rating type
  • 1 = 13+ rated item
AssetTypeID See Enum/AssetType|AssetType for a list of possible values.
PriceView This is mostly used by the website to display prices. The options are:
  • 0 = Free
  • 1 = Collectible
  • 2 = HasPrice
  • 3 = NotForSale

Query Parameters

Search parameters can be specified by appending a series of parameters and values to the URL, each separated by a &. For example:

Parameter Type Options and Values
Category byte Featured (=0), All (=1), Collectibles (=2), Clothing (=3), BodyParts (=4), Gear (=5), Models (=6), Plugins (=7), Decals (=8), Audio (=9), Meshes (=10), and Accessories (=11). Default is All.
CatalogContext byte Options are AvatarOnly (=1) or DevelopOnly (=2). The AvatarOnly option limits search results to categories and subcategories of the Catalog page while DevelopOnly limits search results to categories and subcategories of the Create page (Models, Decals, Audio, Meshes, and Plugins). Default is AvatarOnly.
CreatorID long Specifies the Player/UserId|UserID to filter in the search, for example 1 for Roblox. If you'd like to find group-created items, enter the group agent's ID, not the group ID.
CurrencyType byte All (=0), CustomRobux (=3), and Free (=5). Default is All. Use CustomRobux with custom PxMax and PxMin values. Specify Free for free items.
Gears byte Specifies the Enum/GearType|GearType for the search. The options are MeleeWeapons (=1), RangedWeapons (=2), Explosives (=3), PowerUps (=4), NavigationEnhancers (=5), MusicalInstruments (=6), SocialItems (=7), BuildingTools (=8), and Transport (=9). The recommended approach to filtering on gear types is to match the URL of a catalog page.
Genres byte Specifies the genre for the search. The options are TownAndCity (=1), Medieval (=2), SciFi (=3), Fighting (=4), Horror (=5), Naval (=6), Adventure (=7), Sports (=8), Comedy (=9), Western (=10), Military (=11), Building (=13), FPS (=14), and RPG (=15). The recommended approach to filtering on genres is to match the URL of a catalog page.
IncludeNotForSale boolean Includes items that have a price but are not currently available to take, for instance if they're off sale or prizes.
Keyword string Standard keyword search.
PageNumber int Specifies a page number in conjunction with ResultsPerPage to page through results.
PxMax int The maximum amount of Robux that an item can be priced in the query.
PxMin int The minimum amount of Robux that an item can be priced in the query.
ResultsPerPage int By default this is the same as what's currently shown on each catalog browse page. You can't specify a value larger than this maximum amount.
SortAggregation byte PastDay (=0), PastWeek (=1), PastMonth (=2), and AllTime (=3).
SortType byte Relevance (=0), MostFavorited (=1), Bestselling (=2), RecentlyUpdated (=3), PriceLowToHigh (=4), and PriceHighToLow (=5). Default is Relevance.
Subcategory byte Gear (=5), Hats (=9), Faces (=10), Pants (=14), Shirts (=12), TShirts (=13), Heads (=15), Accessories (=19), HairAccessories (=20), FaceAccessories (=21), NeckAccessories (=22), ShoulderAccessories (=23), FrontAccessories (=24), BackAccessories (=25), WaistAccessories (=26), ClimbAnimations (=28), FallAnimations (=30), IdleAnimations (=31), JumpAnimations (=32), RunAnimations (=33), SwimAnimations (=34), WalkAnimations (=35), Bundles (=37), AnimationBundles (=38), and EmoteAnimations (=39).

Example Endpoint Hits

This URL will search for 10 items in the “Models” subcategory within the “DevelopOnly” context, sorted by most recently updated.

The following URL will search for the first 10 “Gear” items within the default “AvatarOnly” context, sorted by all-time (“SortAggregation”) and relevance (“SortType”).

This URL will return no results because “CatalogContext=2” (DevelopOnly) is used with the incompatible “Subcategory=0” (Featured).

Tags:
  • avatar
  • catalog
  • items