Creator Store Queries

You can search Roblox's assets outside Studio by accessing the Creator Store API. Use the Creator Store API to query Studio assets, such as meshes, models, and audio, and the Marketplace API to query avatar assets on the Marketplace.

Each API requires a URL and custom search parameters for that specific catalog. If both URL and parameters are valid, the API returns a JSON format with the results of your search.

Creator Store API

You can query items from the Creator Store catalog using the following URL: https://apis.roblox.com/toolbox-service/v1/marketplace/{categoryId}[params]

You can replace [categoryId] and [params] with the appropriate query parameters to customize your search.

Valid category IDs are:

• Audio = 3
• Model = 10
• Decal = 13
• Animation = 24
• Plugin = 38
• MeshPart = 40
• Video = 62
• FontFamily = 73
• Music = 300

Query Parameters

You can specify search parameters by appending a series of parameters and values to the URL, each separated by a &.

Use the following parameters to query the Creator Store:

For more details regarding toolbox-service, please refer to the updated documentation below.

This is a sample response from the endpoint:

{
  "totalResults": int,
  "filteredKeyword": string,
  "spellCheckerResult": {
    "correctionState": int,
    "correctedQuery": string,
    "userQuery": string
  },
  "queryFacets": {
    "appliedFacets": Array[string],
    "availableFacets": Array[string]
  },
  "imageSearchStatus": int,
  "previousPageCursor": string,
  "nextPageCursor": string,
  "data": [
    {
      "id": int,
      "name": string,
      "searchResultSource": string
    }
  ]
}

To get back the asset metadata, you can go over the data array and extract the IDs with the GetItemDetails endpoint on toolbox-service like this:

GET https://apis.roblox.com/toolbox-service/v1/items/details?assetIds={assetId1}%2C{assetId2}

Response Fields

This is the response you should expect to get back from that endpoint:

{
  "data": [
    {
      "asset": {
        "audioDetails": {
           "audioType": Array[int],
           "artist": string,
           "title": string,
           "musicAlbum": string,
           "musicGenre": string,
           "soundEffectCategory": string,
           "soundEffectSubcategory": string,
           "tags": Array[string] 
        },
        "id": int64,
        "name": string,
        "typeId": int,
        "assetSubTypes": Array[string],
        "assetGenres": Array[string],
        "ageGuidelines":{
          "ageGuideline: int,
          "blood": {
             "realism": int,
             "level": int
           },
          "violence": {
            "intensity": int
           },
          "profanity": {
            "presence": int
           },
          "alcohol": {
            "presence": int
           },
          "romance": {
            "type": int
           }
        },
        "isEndorsed": bool,
        "description": string,
        "duration": int,
        "hasScripts": bool?,
        "createdUtc": string($date-time),
        "updatedUtc": string($date-time),
        "creatingUniverseId": int64?,
        "isAssetHashApproved": bool,
        "visibilityStatus": int?,
        "socialLinks": [{
           "linkType": int,
           "url": string,
           "title": string
        }]
      },
      "creator": {
        "id": int64,
        "name": string,
        "type": int,
        "isVerifiedCreator": bool,
        "latestGroupUpdaterUserId": int64?,
        "latestGroupUpdaterUserName": string
      },
      "voting": {
        "showVotes": bool,
        "upVotes": int64,
        "downVotes": int64,
        "canVote": bool,
        "userVote": bool?,
        "hasVoted": bool,
        "voteCount": int64,
        "upVotePercent": int
      },
      "product": {
        "productId": int64,
        "price": int64?,
        "isForSaleOrIsPublicDomain": bool
      },
      "fiatProduct": {
        "purchasePrice": {
          "currencyCode": string,
          "quantity": {
            "significand": int64,
            "exponent": int
          }
        },
        "published": bool,
        "purchasable": bool
      }
    }
  ]
}

Marketplace API

You can query avatar items from the Marketplace using the following URL: https://catalog.roblox.com/v1/search/items/details?[params]

You can replace [params] with the appropriate query parameters to customize your search.

Query Parameters

You can specify search parameters by appending a series of parameters and values to the URL, each separated by a &.

Use the following parameters to query the Marketplace:

The following URL will search for the first 10 "Gear" items in "Accessories" sorted by all-time ("SortAggregation") and relevance ("SortType") created by Roblox ("CreatorTargetId"):

https://catalog.roblox.com/v1/search/items/details?Category=11&Subcategory=5&CreatorTargetId=1&SortType=0&SortAggregation=5&Limit=10

Response Fields

API responses return in a JSON format. The response provides asset details in the data key using the following fields:

The following is an example of expected return output for a single item:

{
	"keyword": null,
	"previousPageCursor": null,
	"nextPageCursor": "2_1_c541d05046b5c1c78a5d386b5e302243",
	"data": [
    {
        "id":527373900,
        "itemType":
        "Asset",
        "assetType":42,
        "name":"Restless Souls Bandana",
        "description":"This bandana won't help you blend in with ghosts, but at least you'll be stylish.",
        "productId":41270974,
        "genres":[
          "Scary",
          "Adventure"
          ],
        "itemStatus":[],
        "itemRestrictions":[],
        "creatorType":"User",
        "creatorTargetId":1,
        "creatorName":"Roblox",
        "price":300,
        "favoriteCount":15943,
        "offSaleDeadline":null
        }
	]
}