Catalog v2

Reference for the Catalog v2 endpoints on Roblox.

Base URL: https://catalog.roblox.com

Endpoints

Method	Path	Name
`GET`	`/v2/search/items/details`	`getSearchItemsDetails`

`getSearchItemsDetails`

GET /v2/search/items/details

Search for catalog items.

Usage

import { fetchApi } from 'rozod';
import { getSearchItemsDetails } from 'rozod/lib/endpoints/catalogv2';

const data = await fetchApi(getSearchItemsDetails, {
  Taxonomy: /* string */,
  AssetTypeIds: /* number */,
  BundleTypeIds: /* number */,
  CategoryFilter: /* unknown */,
  SortAggregation: /* unknown */,
  SortType: /* unknown */,
  CreatorType: /* unknown */,
  CreatorTargetId: /* integer */,
  CreatorName: /* string */,
  MaxPrice: /* integer */,
  MinPrice: /* integer */,
  Keyword: /* string */,
  IncludeNotForSale: /* boolean */,
  TriggeredByTopicDiscovery: /* boolean */,
  SalesTypeFilter: /* unknown */,
  Topics: /* string */,
  cursor: /* string? */,
  sortOrder: /* unknown? = "Desc" */
});

Parameters

Name	Type	Required	Description
`Taxonomy`	`string`	Yes
`AssetTypeIds`	`number`	Yes
`BundleTypeIds`	`number`	Yes
`CategoryFilter`	`unknown`	Yes
`SortAggregation`	`unknown`	Yes
`SortType`	`unknown`	Yes
`CreatorType`	`unknown`	Yes
`CreatorTargetId`	`integer`	Yes
`CreatorName`	`string`	Yes
`MaxPrice`	`integer`	Yes
`MinPrice`	`integer`	Yes
`Keyword`	`string`	Yes
`IncludeNotForSale`	`boolean`	Yes
`TriggeredByTopicDiscovery`	`boolean`	Yes
`SalesTypeFilter`	`unknown`	Yes
`Topics`	`string`	Yes	The input topics format is split by ”,”. E.g “topics=cat,hat,red”.
`cursor`	`string?`	No	The paging cursor for the previous or next page.
`sortOrder`	`unknown? = "Desc"`	No	The order the results are sorted in.

Response

Field	Type	Description
`keyword`	`string`
`elasticsearchDebugInfo`	`object`	See below
`previousPageCursor`	`string`
`nextPageCursor`	`string`
`data`	`object[]`	See below

elasticsearchDebugInfo fields:

Field	Type	Description
`elasticsearchQuery`	`string`
`isFromCache`	`boolean`
`indexName`	`string`
`isTerminatedEarly`	`boolean`
`isForceTerminationEnabledByRequest`	`boolean`
`searchResultDataSource`	`string`
`searchResultRelevanceScore`	`string`
`searchResultEngagementScore`	`string`

data[] item fields:

Field	Type	Description
`bundledItems`	`object[]`	See below
`taxonomy`	`object[]`	See below
`itemCreatedUtc`	`string`
`id`	`number`
`itemType`	`“Asset"	"Bundle”`
`assetType`	`1	2
`bundleType`	`1	2
`isRecolorable`	`boolean`
`name`	`string`
`description`	`string`
`productId`	`number`
`itemStatus`	`1	2
`itemRestrictions`	`1	2
`creatorHasVerifiedBadge`	`boolean`
`creatorType`	`string`
`creatorTargetId`	`number`
`creatorName`	`string`
`price`	`number`
`lowestPrice`	`number`
`lowestResalePrice`	`number`
`priceStatus`	`string`
`unitsAvailableForConsumption`	`number`
`favoriteCount`	`number`
`offSaleDeadline`	`string`
`collectibleItemId`	`string`
`totalQuantity`	`number`
`saleLocationType`	`“NotApplicable"	"ShopOnly"
`hasResellers`	`boolean`
`isOffSale`	`boolean`
`quantityLimitPerUser`	`number`
`supportsHeadShapes`	`boolean`
`timedOptions`	`object[]`	See below

bundledItems[] item fields:

Field	Type	Description
`owned`	`boolean`
`id`	`number`
`name`	`string`
`type`	`string`
`supportsHeadShapes`	`boolean`
`assetType`	`number`

taxonomy[] item fields:

Field	Type	Description
`taxonomyId`	`string`
`taxonomyName`	`string`

timedOptions[] item fields:

Field	Type	Description
`days`	`number`
`price`	`number`
`selected`	`boolean`

Errors

Status	Description
400	1: Category subcategory selection not supported. 2: Creator id not found. 3: Creator type not found or cannot search by CreatorTargetId with CreatorType.All 4: Genre not found. 5: Sort combination not supported. 6: Invalid price range. 10: StartRequest is invalid.
403	7: User is unauthorized. 22: In-experience search is denied for this place or universe.
429	8: The flood limit has been exceeded. 8: The flood limit has been exceeded.
503	18: Search request timed out