# roblox.catalog_search

**stable** **Advanced**

Search the Roblox avatar catalog.

`GET /v1/roblox/catalog_search`

## What you get

A list of Roblox results in Onekey's unified shape, in `data` (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free `404 not_found` instead.

## What it costs

- **Advanced · 5 credits** for a fresh fetch, charged only when it succeeds.
- **Free when served from cache (0.2 credit for a cached response over 100 KB).**
- **Free** if the request is invalid (never charged) or the source fails or reports not found (refunded).

## Parameters

| Name | Type | Required | Default | What it is | Constraints |
| --- | --- | --- | --- | --- | --- |
| `q` | string | yes | (required) | Search keyword | max 50 chars; must match `[A-Za-z0-9_ ]{2,50}`; trimmed, repeated spaces collapsed |

## Request

```bash
curl "https://api.onekey.dev/v1/roblox/catalog_search?q=hat" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/roblox/catalog_search",
    params={"q": "hat"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ q: "hat" });
const res = await fetch(`https://api.onekey.dev/v1/roblox/catalog_search?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## Recorded response

A real Roblox response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "18711508268",
        "name": "Hat",
        "description": "Hat",
        "type": "Asset"
      },
      "listing": {
        "price": 95
      },
      "author": {
        "username": "Cebrail's Studio",
        "id": "33201221"
      },
      "engagement": {
        "likes": 418
      },
      "content": {
        "createdAt": "2024-07-29T17:51:15Z"
      }
    },
    {
      "entity": {
        "id": "102849446502026",
        "name": "✅ Hat ",
        "description": "⭐ PLEASE FAVORITE\n\n✅ TRY IT ON! 🐻- FITS ALL HAIRS!\n\n⚠️ LIMITED TIME ONLY, GOING OFFSALE\nFIND MORE HERE: https://www.roblox.com/catalog?Category=1&CreatorName=Rare%20Finds&CreatorType=Group&salesTypeFilter=1\n\nPOPULAR black hat black cowboy hat black rodeo hat black fedora black outlaw hat black ranger hat grey hat grey fur hat grey furry hat cute gray hat cute hat comfortable hat grey wool hat bear hat cozy hat wool hat y2k hat grunge hat silver hat grey cowboy hat gray cowbboy hat grey rangers hat rodeo  smily smiling blush face cute face happy face warrior ninja pretty beautiful weapon angel classic band wavy trendy kawai mystery heart hearts light shiny sakura sigma head designer y2k anime dark emo grudge stylish cute cool crazy funny troll matching fashion aesthetic hot oversized fluffy furry comfy cozy warm preppy aura limited classic hat royal verified skibidi uwu miku spike shadow alpha void beta famous skeleton skull grey silver ",
        "type": "Asset"
      },
      "listing": {
        "price": 95
      },
      "author": {
        "username": "Rare Finds",
        "id": "34180412"
      },
      "engagement": {
        "likes": 211
      },
      "content": {
        "createdAt": "2024-10-03T20:24:31Z"
      }
    }
  ],
  "metadata": {
    "platform": "roblox",
    "endpoint": "catalog_search",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `id` | `entity.id` | `toString` |
| `name` | `entity.name` | - |
| `description` | `entity.description` | - |
| `price` | `listing.price` | `toNumber` |
| `creatorName` | `author.username` | - |
| `creatorTargetId` | `author.id` | `toString` |
| `itemType` | `entity.type` | - |
| `favoriteCount` | `engagement.likes` | `toNumber` |
| `itemCreatedUtc` | `content.createdAt` | `toIsoDate` |

## Caching and freshness

- Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
- Between 2 minutes and 15 minutes the cached copy is still served instantly and marked `stale: true` while Onekey refreshes it in the background.
- If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
- A "not found" is remembered for 1 minute and is free.
- The cache is shared across all customers, which is what keeps repeat calls cheap.

## What can go wrong

| Status | Code | What to do |
| --- | --- | --- |
| 401 | `unauthorized` | Check the `x-api-key` header. |
| 402 | `insufficient_credits` | [Add credits](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | Unknown endpoint path. |
| 422 | `invalid_params` | Fix the parameters using the table above. Free. |
| 429 | `rate_limited` | Wait `Retry-After` seconds, then retry. |
| 502 | `upstream_error` | The source failed. Refunded; retry with backoff. |

See [Errors](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).