ROroblox
Assets
Avatars

Search for catalog items.

Changed on

This endpoint is for search by item type ids.

get/v2/search/items/details

Request

  • Base URL
    https://catalog.roblox.com
  • URL
    https://catalog.roblox.com/v2/search/items/details
  • Auth
    • none
    • or API key in cookie .ROBLOSECURITY

Query parameters

Taxonomystring
AssetTypeIdsinteger[]
BundleTypeIdsinteger[]
CategoryFilter0 | 1 | 2 | 3 | 4 | 5 | 6 | 7

The category filter types, representing generic collections of catalog items requested by client. ['None' = 0, 'Featured' = 1, 'Collectibles' = 2, 'CommunityCreations' = 3, 'Landing' = 4, 'Premium' = 5, 'Recommended' = 6, 'HighDefinition' = 7]

SortAggregation0 | 1 | 2 | 3 | 4 | 5

['Past12Hours' = 0, 'PastDay' = 1, 'Past3Days' = 2, 'PastWeek' = 3, 'PastMonth' = 4, 'AllTime' = 5]

SortType0 | 1 | 2 | 3 | 4 | 5

Price values to be consolidated after roll out to api site. ['Relevance' = 0, 'Favorited' = 1, 'Sales' = 2, 'Created' = 3, 'Updated' = 3, 'PriceAsc' = 4, 'PriceDesc' = 5]

CreatorType0 | 1 | 2

['All' = 0, 'User' = 1, 'Group' = 2]

CreatorTargetIdinteger
CreatorNamestring
MaxPriceinteger
MinPriceinteger
Keywordstring
IncludeNotForSaleboolean
TriggeredByTopicDiscoveryboolean
SalesTypeFilter0 | 1 | 2 | 3 | 4

The Sales Type filter options for search. ['Unknown' = 0, 'All' = 1, 'Collectibles' = 2, 'Premium' = 3, 'TimedOptions' = 4]

Topicsstring

The input topics format is split by ",". E.g "topics=cat,hat,red".

limit10 | 28 | 30 | 60 | 120

The number of results per request.

cursorstring

The paging cursor for the previous or next page.

sortOrder'Desc'

The order the results are sorted in.

Response

OK

keywordstring

Keyword used for search query.

previousPageCursorstring
nextPageCursorstring

Changes

  • bcfdc20689cdRevision changes
    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      removed the optional property /// from the response with the status (media type: text/json)

  • 85e5f0ce799dRevision changes
    • warning

      added the new 96.00 enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new 96.00 enum value to the // response property for the response status (media type: text/json)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: text/json)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: text/json)