ROroblox
Creator Store

Search Creator Store Assets

Changed on

Search Creator Store for assets.

post/toolbox-service/v2/assets:search

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/toolbox-service/v2/assets:search
  • Auth
    • none
    • or API key in cookie .ROBLOSECURITY
    • or API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token scopes: creator-store-product:read

Request body

searchCategoryType'Audio' | 'Place' | 'Model' | 'Decal' | 'Plugin' | 'MeshPart' | 'Video' | 'FontFamily'

This represents a "subset" of Toolbox.Service.CategoryType options and represent the full set of "categories" (or asset types) that can be searched upon from the toolbox search API.

querystring nullable

The search terms used to filter the results. Only one of 'query' and 'image' can be present in a query.

imagestring byte nullable

The image file to search by. The image must be base64 encoded to be used in the search. Only one of 'query' and 'image' can be present in a query.

userIdinteger nullable

The User ID of the creator. Only one of 'userId' and 'groupId' can be present in a query.

groupIdinteger nullable

The Group ID of the creator. Only one of 'userId' and 'groupId' can be present in a query.

pageTokenstring nullable

The identifier for the desired search results page. Only one of 'pageNumber' and 'pageToken' can be present in a query.

pageNumberinteger nullable

The page number to retrieve, starting from 0. Only one of 'pageNumber' and 'pageToken' can be present in a query.

maxPageSizeinteger

The number of assets to be returned. Cannot be larger than 100.

sortDirection'None' | 'Ascending' | 'Descending'

Represents the direction in which to sort the results

sortCategory'Relevance' | 'Trending' | 'Top' | 'AudioDuration' | 'CreateTime' | 'UpdatedTime' | 'Ratings'

The category to sort the search results by.

includeOnlyVerifiedCreatorsboolean

Whether the results should only include assets created by verified creators.

minPriceCentsinteger nullable

The minimum price of the asset in cents. If included, must be greater than or equal to 0.

maxPriceCentsinteger nullable

The maximum price of the asset in cents. If included, must be greater than or equal to 0.

facetsstring[] nullable

Additional keywords to query by.

tagsstring[] nullable

The tags to filter by.

categoryPathstring nullable

The category path to filter by.

swimlanestring nullable

Optional swimlane identifier (e.g. "trending", "essential", "priced").

searchView'IDs' | 'Core' | 'Full'

This view controls which fields are populated in the search response. A lighter view will result in faster response times and higher reliability.

Response

OK

nextPageTokenstring nullable

The page token to view the next page of results.

totalResultsinteger required

The total number of results for the given search query.

filteredKeywordstring nullable

The filtered keyword that was used to search for assets, if applicable.

Changes

  • 5dcfa33df56aRevision changes
    • info

      added the new Place enum value to the request property //// (media type: application/json-patch+json)

    • info

      added the new Place enum value to the request property //// (media type: application/json)

    • info

      added the new Place enum value to the request property //// (media type: text/json)

    • info

      added the new Place enum value to the request property //// (media type: application/*+json)

  • ddc1ae212d79Revision changes
    • warning

      the request property's max was set to 9223372036854775808.00 (media type: application/json-patch+json)

    • warning

      the request property's max was set to 9223372036854775808.00 (media type: application/json)

    • warning

      the request property's max was set to 9223372036854775808.00 (media type: text/json)

    • warning

      the request property's max was set to 9223372036854775808.00 (media type: application/*+json)

    • warning

      the request property's max was set to 9223372036854775808.00 (media type: application/json-patch+json)

    • warning

      the request property's max was set to 9223372036854775808.00 (media type: application/json)

    • warning

      the request property's max was set to 9223372036854775808.00 (media type: text/json)

    • warning

      the request property's max was set to 9223372036854775808.00 (media type: application/*+json)

    • info

      the response property became required for the status

    • info

      the response property // became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property became required for the status