@@ -9,27 +9,26 @@ Each API requires a URL and custom search parameters for that specific catalog.
99
1010## Creator Store API
1111
12- > [ !NOTE]
13- > We acknowledge that the toolbox-service API described below is not covered on the official Cloud APIs documentation. We are planning to better support Creator Store search with a cleaner API in future, stay tuned for updates.
12+ <Alert severity =" info " >
13+ The ` toolbox-service ` API described below is not currently covered on the official [ Cloud API] ( ../../cloud/reference/index.md ) documentation. Better support for Creator Store search with a cleaner API is underway.
14+ </Alert >
1415
1516You can query items from the Creator Store catalog using the following URL:
1617` https://apis.roblox.com/toolbox-service/v1/marketplace/{categoryId}[params] `
1718
1819You can replace ` [categoryId] ` and ` [params] ` with the appropriate [ query parameters] ( #query-parameters ) to customize your search.
1920
20- ### CategoryId
21+ Valid category IDs are:
2122
22- Valid categoryIds are:
23-
24- Audio = 3
25- Model = 10
26- Decal = 13
27- Animation = 24
28- Plugin = 38
29- MeshPart = 40
30- Video = 62
31- FontFamily = 73
32- Music = 300
23+ - Audio = ` 3 `
24+ - Model = ` 10 `
25+ - Decal = ` 13 `
26+ - Animation = ` 24 `
27+ - Plugin = ` 38 `
28+ - MeshPart = ` 40 `
29+ - Video = ` 62 `
30+ - FontFamily = ` 73 `
31+ - Music = ` 300 `
3332
3433### Query Parameters
3534
@@ -49,25 +48,12 @@ Use the following parameters to query the Creator Store:
4948 <tr>
5049 <td>categoryId (path)</td>
5150 <td>int</td>
52- <td>
53- Audio = 3 </br>
54- Model = 10 </br>
55- Decal = 13 </br>
56- Animation = 24 </br>
57- Plugin = 38 </br>
58- MeshPart = 40 </br>
59- Video = 62 </br>
60- FontFamily = 73 </br>
61- Music = 300 </br>
62- </td>
51+ <td>`3` = Audio<br />`10` = Model<br />`13` = Decal<br />`24` = Animation<br />`38` = Plugin<br />`40` = MeshPart<br />`62` = Video<br />`73` = FontFamily<br />`300` = Music<br /></td>
6352 </tr>
6453 <tr>
6554 <td>sortOrder</td>
6655 <td>int</td>
67- <td>
68- Asc = 1</br>
69- Desc = 2
70- </td>
56+ <td>`1` = Asc<br />`2` = Desc</td>
7157 </tr>
7258 <tr>
7359 <td>limit</td>
@@ -102,10 +88,7 @@ Use the following parameters to query the Creator Store:
10288 <tr>
10389 <td>creatorType</td>
10490 <td>int</td>
105- <td>
106- 1 = User</br>
107- 2 = Group
108- </td>
91+ <td>`1` = User<br />`2` = Group</td>
10992 </tr>
11093 <tr>
11194 <td>creatorTargetId</td>
@@ -125,11 +108,7 @@ Use the following parameters to query the Creator Store:
125108 <tr>
126109 <td>sortDirection</td>
127110 <td>int</td>
128- <td>
129- None = 0</br>
130- Ascending = 1</br>
131- Descending = 2
132- </td>
111+ <td>`0` = None<br />`1` = Ascending<br />`2` = Descending</td>
133112 </tr>
134113 <tr>
135114 <td>artist</td>
@@ -144,23 +123,12 @@ Use the following parameters to query the Creator Store:
144123 <tr>
145124 <td>audioTypes</td>
146125 <td>array[int]</td>
147- <td>Music = 0</br>SoundEffect = 1 </td>
126+ <td>`0` = Music<br />`1` = SoundEffect </td>
148127 </tr>
149128 <tr>
150129 <td>uiSortIntent</td>
151130 <td>int</td>
152- <td>
153- Relevance = 1</br>
154- Trending = 6</br>
155- AllTime = 7</br>
156- Top = 8</br>
157- Duration = 9</br>
158- DateCreated = 10</br>
159- DateModified = 11</br>
160- Creator = 12</br>
161- Name = 13</br>
162- What sort order to rank the results by
163- </td>
131+ <td>What sort order to rank the results by<br /><br />`1` = Relevance<br />`6` = Trending<br />`7` = AllTime<br />`8` = Top<br />`9` = Duration<br />`10` = DateCreated<br />`11` = DateModified<br />`12` = Creator<br />`13` = Name</td>
164132 </tr>
165133 <tr>
166134 <td>includeOnlyVerifiedCreators</td>
@@ -180,7 +148,7 @@ Use the following parameters to query the Creator Store:
180148 </tbody >
181149</table >
182150
183- For more detailed documentation regarding the toolbox-service, please refer to the updated documentation at creator store API .
151+ For more details regarding ` toolbox-service ` , please refer to the updated documentation below .
184152
185153This is a sample response from the endpoint:
186154
@@ -210,7 +178,7 @@ This is a sample response from the endpoint:
210178}
211179```
212180
213- To get back the asset metadata, you would go over the data array and extract the ids, call the GetItemDetails endpoint on toolbox-service like this:
181+ To get back the asset metadata, you can go over the data array and extract the IDs with the ` GetItemDetails ` endpoint on ` toolbox-service ` like this:
214182
215183``` bash
216184GET https://apis.roblox.com/toolbox-service/v1/items/details? assetIds={assetId1}%2C{assetId2}
@@ -343,7 +311,7 @@ Use the following parameters to query the Marketplace:
343311 <tr >
344312 <td>CreatorType</td>
345313 <td>byte</td>
346- <td>`1` = User or `2` = Group. </td>
314+ <td>`1` = User<br /> `2` = Group</td>
347315 </tr >
348316 <tr >
349317 <td>CreatorName</td>
@@ -363,7 +331,7 @@ Use the following parameters to query the Marketplace:
363331 <tr >
364332 <td>Genres</td>
365333 <td>byte</td>
366- <td>Specifies the genre for the search. The recommended approach to filtering on genres is to match the URL of a catalog page. <br />`1` = TownAndCity<br />`2` = Medieval<br />`3` = SciFi<br />`4` = Fighting<br />`5` = Horror<br />`6` = Naval<br />`7` = Adventure<br />`8` = Sports<br />`9` = Comedy<br />`10` = Western<br />`11` = Military<br />`13` = Building<br />`14` = FPS<br />`15` = RPG</td>
334+ <td>Specifies the genre for the search. The recommended approach to filtering on genres is to match the URL of a catalog page.<br /> <br />`1` = TownAndCity<br />`2` = Medieval<br />`3` = SciFi<br />`4` = Fighting<br />`5` = Horror<br />`6` = Naval<br />`7` = Adventure<br />`8` = Sports<br />`9` = Comedy<br />`10` = Western<br />`11` = Military<br />`13` = Building<br />`14` = FPS<br />`15` = RPG</td>
367335 </tr >
368336 <tr >
369337 <td>Keyword</td>
@@ -398,56 +366,7 @@ Use the following parameters to query the Marketplace:
398366 <tr >
399367 <td>Subcategory</td>
400368 <td>byte</td>
401- <td>
402- `0` = Featured<br />
403- `1` = All<br />
404- `2` = Collectibles<br />
405- `3` = Clothing<br />
406- `4` = BodyParts<br />
407- `5` = Gear<br />
408- `9` = Hats<br />
409- `10` = Faces<br />
410- `12` = Shirts<br />
411- `13` = TShirts<br />
412- `14` = Pants<br />
413- `15` = Heads<br />
414- `19` = Accessories<br />
415- `20` = HairAccessories<br />
416- `21` = FaceAccessories<br />
417- `22` = NeckAccessories<br />
418- `23` = ShoulderAccessories<br />
419- `24` = FrontAccessories<br />
420- `25` = BackAccessories<br />
421- `26` = WaistAccessories<br />
422- `27` = AvatarAnimations<br />
423- `37` = Bundles<br />
424- `38` = AnimationBundles <br />
425- `39` = EmoteAnimations<br />
426- `40` = CommunityCreations<br />
427- `41` = Melee<br />
428- `42` = Ranged<br />
429- `43` = Explosive<br />
430- `44` = PowerUp<br />
431- `45` = Navigation<br />
432- `46` = Musical<br />
433- `47` = Social<br />
434- `48` = Building<br />
435- `49` = Transport<br />
436- `54` = HeadAccessories<br />
437- `55` = ClassicTShirts<br />
438- `56` = ClassicShirts<br />
439- `57` = ClassicPants<br />
440- `58` = TShirtAccessories<br />
441- `59` = ShirtAccessories<br />
442- `60` = PantsAccessories<br />
443- `61` = JacketAccessories<br />
444- `62` = SweaterAccessories<br />
445- `63` = ShortsAccessories<br />
446- `64` = ShoesBundles<br />
447- `65` = DressSkirtAccessories<br />
448- `66` = DynamicHeads<br />
449- </td>
450-
369+ <td>`0` = Featured<br />`1` = All<br />`2` = Collectibles<br />`3` = Clothing<br />`4` = BodyParts<br />`5` = Gear<br />`9` = Hats<br />`10` = Faces<br />`12` = Shirts<br />`13` = TShirts<br />`14` = Pants<br />`15` = Heads<br />`19` = Accessories<br />`20` = HairAccessories<br />`21` = FaceAccessories<br />`22` = NeckAccessories<br />`23` = ShoulderAccessories<br />`24` = FrontAccessories<br />`25` = BackAccessories<br />`26` = WaistAccessories<br />`27` = AvatarAnimations<br />`37` = Bundles<br />`38` = AnimationBundles <br />`39` = EmoteAnimations<br />`40` = CommunityCreations<br />`41` = Melee<br />`42` = Ranged<br />`43` = Explosive<br />`44` = PowerUp<br />`45` = Navigation<br />`46` = Musical<br />`47` = Social<br />`48` = Building<br />`49` = Transport<br />`54` = HeadAccessories<br />`55` = ClassicTShirts<br />`56` = ClassicShirts<br />`57` = ClassicPants<br />`58` = TShirtAccessories<br />`59` = ShirtAccessories<br />`60` = PantsAccessories<br />`61` = JacketAccessories<br />`62` = SweaterAccessories<br />`63` = ShortsAccessories<br />`64` = ShoesBundles<br />`65` = DressSkirtAccessories<br />`66` = DynamicHeads</td>
451370 </tr >
452371</tbody >
453372</table >
@@ -470,7 +389,7 @@ API responses return in a JSON format. The response provides asset details in th
470389<tbody >
471390 <tr >
472391 <td>assetType</td>
473- <td>One of the following asset type values (only returned if the item is an asset).<br />`2` = T-Shirt<br />`8` = Hat<br />`11` = Shirt<br />`12` = Pants<br />`17` = Head<br />`18` = Face<br />`19` = Gear<br />`25` = Arms<br />`26` = Legs<br />`27` = Torso<br />`28` = RightArm<br />`29` = LeftArm<br />`30` = LeftLeg<br />`31` = RightLeg<br />`41` = HairAccessory<br />`42` = FaceAccessory<br />`43` = NeckAccessory<br />`44` = ShoulderAccessory<br />`45` = FrontAccessory<br />`46` = BackAccessory<br />`47` = WaistAccessory<br />`48` = ClimbAnimation<br />`49` = DeathAnimation<br />`50` = FallAnimation<br />`51` = IdleAnimation<br />`52` = JumpAnimation<br />`53` = RunAnimation<br />`54` = SwimAnimation<br />`55` = WalkAnimation<br />`56` = PoseAnimation<br />`61` = EmoteAnimation</td>
392+ <td>One of the following asset type values (only returned if the item is an asset).<br /><br /> `2` = T-Shirt<br />`8` = Hat<br />`11` = Shirt<br />`12` = Pants<br />`17` = Head<br />`18` = Face<br />`19` = Gear<br />`25` = Arms<br />`26` = Legs<br />`27` = Torso<br />`28` = RightArm<br />`29` = LeftArm<br />`30` = LeftLeg<br />`31` = RightLeg<br />`41` = HairAccessory<br />`42` = FaceAccessory<br />`43` = NeckAccessory<br />`44` = ShoulderAccessory<br />`45` = FrontAccessory<br />`46` = BackAccessory<br />`47` = WaistAccessory<br />`48` = ClimbAnimation<br />`49` = DeathAnimation<br />`50` = FallAnimation<br />`51` = IdleAnimation<br />`52` = JumpAnimation<br />`53` = RunAnimation<br />`54` = SwimAnimation<br />`55` = WalkAnimation<br />`56` = PoseAnimation<br />`61` = EmoteAnimation</td>
474393 </tr >
475394 <tr >
476395 <td>bundleType</td>
0 commit comments