Consultas externas de catálogo

Você pode pesquisar os ativos da Roblox fora do Studio acessando o API externo do catálogo. Use o API do Mercado do criador para consultar os ativos do Studio, como malhas, modelos e áudio e o API do Mercado para consultar ativos do avatar no Mercado.

Cada API requer uma URL e parâmetros de pesquisa personalizados para aquele catálogo específico. Se tanto a URL quanto os parâmetros estiverem válidos, a API devolve um formato JSON com os resultados da sua pesquisa.

API do Marketplace do criador

Você pode consultar itens do catálogo do Marketplace do criador usando a seguinte URL: https://search.roblox.com/catalog/json?[params]

Você pode substituir [params] com os parâmetros de consulta adequados para personalizar a sua pesquisa.

Parâmetros de consulta

Você pode especificar os parâmetros de pesquisa anexando uma série de parâmetros e valores à URL, cada um separado por um &.

Use os seguintes parâmetros para consultar o catálogo do Mercado do criador:

A URL a seguir irá pesquisar 10 itens na subcategoria "Modelos", classificado por atualizados recentemente.

https://search.roblox.com/catalog/json? Category=6&SortType=3&ResultsPerPage=10

Campos de resposta

Respostas API são devolvidas em formato JSON. A resposta traz detalhes de ativo com os seguintes campos primários:

A seguir está um exemplo de saída de retorno esperado para um item individual:

{
    "AssetId": 3374795585,
    "Name": "Rat",
    "Description": "",
    "AbsoluteUrl": "https://www.roblox.com/catalog/3374795585/Rat",
    "Price": "",
    "Updated": "8 months ago",
    "Favorited": "80 times",
    "Sales": "1,613",
    "Remaining": "",
    "Creator": "ROBLOX",
    "CreatorAbsoluteUrl": "https://www.roblox.com/users/1/profile",
    "PrivateSales": "",
    "PriceView": 0,
    "BestPrice": "",
    "ContentRatingTypeID": 0,
    "IsServerSideThumbnailLookupInCatalogEnabled": true,
    "AudioUrl": null,
    "IsLargeItem": false,
    "IsThumbnailFinal": true,
    "IsThumbnailUnapproved": false,
    "ThumbnailUrl": "https://t1.rbxcdn.com/745a4be8c2366db2e55d0a67678434dc",
    "BcOverlayUrl": null,
    "LimitedOverlayUrl": null,
    "DeadlineOverlayUrl": null,
    "LimitedAltText": null,
    "NewOverlayUrl": null,
    "SaleOverlayUrl": null,
    "IosOverlayUrl": null,
    "XboxOverlayUrl": null,
    "GooglePlayOverlayUrl": null,
    "AmazonOverlayUrl": null,
    "IsTransparentBackground": false,
    "IsNewRobuxIconEnabled": true,
    "AssetTypeID": 10,
    "CreatorID": 1,
    "CreatedDate": "/Date(1561635090927)/",
    "UpdatedDate": "/Date(1562003916210)/",
    "IsForSale": false,
    "IsPublicDomain": true,
    "IsLimited": false,
    "IsLimitedUnique": false,
    "MinimumMembershipLevel": 0,
    "OffSaleDeadline": null,
    "ProductId": 586905093
}

API do Mercado

Você pode consultar itens de avatar do Mercado usando a seguinte URL: https://catalog.roblox.com/v2/search/items/details?[params]

Você pode substituir [params] com os parâmetros de consulta adequados para personalizar a sua pesquisa.

Parâmetros de consulta

Você pode especificar os parâmetros de pesquisa anexando uma série de parâmetros e valores à URL, cada um separado por um &.

Use os seguintes parâmetros para consultar o Mercado:

A URL a seguir irá pesquisar os primeiros itens de "Equipamento" classificados por todo o tempo ("ClassificaçãoAgregação") e relevância ("TipoClassificação") criado pela Roblox ("IDAlvoCriador"):

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

Campos de resposta

Respostas API são devolvidas em formato JSON. A resposta fornece detalhes na chave datausando os seguintes campos:

A seguir está um exemplo de saída de retorno esperado para um item individual:

{
    "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
        }
    ]
}