When performing a catalog search, there is a property in the CatalogSearchParams data type to specify the limit of how many items to return. This property is a number data type, but the SearchCatalog method will only accept the following numbers when performing a search: 10, 28, 30, 60, and 120.
The CatalogSearchParams page should document the Limit property and the accepted values.
Hey @UnderMyWheel! Thanks for flagging this missing property and providing the specific method details.
I’ve updated our documentation to add the limit property and it should update on our next documentation push. Feel free to flag any more issues here or, if you’d like, make contributions directly to our doc site through GitHub - Roblox/creator-docs: Open Source Creator Documentation.
About to use this right now, and the documentation is slightly unclear on whether or not it’s the total number of items in the entire collection to return, or the total number of items to return *per page* in the entire collection. As I was double checking on the functionality of this system, I saw this post and thought to let you know it could be more clear in that context.
From
Limit
Specifies the number of items to return. Accepts 10, 28, 30, 60, and 120. Defaults to 30.
to:
Limit
Specifies the number of items to return per page. Accepts 10, 28, 30, 60, and 120. Defaults to 30.
, would be helpful for future readers’ context. Other than that, great update, thanks for implementing this! I’m not sure if a github request to change this context would be approprite, because I don’t know the functionality yet, but yeah.