3 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

CatalogSearchParams

The CatalogSearchParams data type stores the parameters of a catalog search via AvatarEditorService:SearchCatalogAsync().

When accessing the value of the CatalogSearchParams.BundleTypes or CatalogSearchParams.AssetTypes property the returned table will be read-only to avoid confusion when not directly accessing the CatalogSearchParams instance.

For example, you can use these properties as follows:

local params = CatalogSearchParams.new()
params.SearchKeyword = "Test"
params.MinPrice = 5000
params.MaxPrice = 10000
params.BundleTypes = {Enum.BundleType.Animations, Enum.BundleType.BodyParts}

local types = params.BundleTypes
for _, val in types do
  print(val)
end
-- table.insert(types, Enum.BundleType.Animations) -- This would not work because the table is read only

Properties

CatalogSearchParams.SearchKeyword

The keyword to search for catalog results with.

CatalogSearchParams.MinPrice

The minimum item price to search for.

CatalogSearchParams.MaxPrice

The maximum item price to search for.

CatalogSearchParams.SortType

The order in which to sort the results, represented by a CatalogSortType.

CatalogSearchParams.SortAggregation

The time period to use to aggregate the sort results by, represented by a CatalogSortAggregation. This only applies when the sort type is CatalogSortType.MostFavorited or CatalogSortType.BestSelling. It does not apply for other sort types.

CatalogSearchParams.CategoryFilter

The category to filter the search by, represented by a CatalogCategoryFilter.

CatalogSearchParams.SalesTypeFilter

The sales type to filter the search by, represented by a SalesTypeFilter. Use SalesTypeFilter.TimedOptions to return only items that have timed options available.

CatalogSearchParams.BundleTypes

An array containing BundleType values to filter the search by.

CatalogSearchParams.AssetTypes

An array containing AvatarAssetType values to filter the search by.

CatalogSearchParams.IncludeOffSale

Whether off sale items should be included in the results.

CatalogSearchParams.CreatorName

Search for items with the given creator name. Specify whether to search users, groups, or both with CatalogSearchParams.CreatorType.

CatalogSearchParams.CreatorType

Search for items created by the given creator type. When unspecified, it defaults to returning creations from both CreatorTypeFilter.User and CreatorTypeFilter.Group. Searching by CatalogSearchParams.CreatorId with CreatorTypeFilter.All results in a HTTP 400 Bad Request error.

CatalogSearchParams.CreatorId

Search for items created by the single creator ID. Specify user or group with CatalogSearchParams.CreatorType. Searching by creator ID and creator name is not supported; specify one, not both.

CatalogSearchParams.Limit

Specifies the number of items to return. Accepts 10, 28, 30, 60, and 120. Defaults to 30.