# roblox.group_search

**stable** **Advanced**

Search Roblox groups by keyword.

`GET /v1/roblox/group_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/group_search?q=roblox" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/roblox/group_search",
    params={"q": "roblox"},
    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: "roblox" });
const res = await fetch(`https://api.onekey.dev/v1/roblox/group_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": "7",
        "name": "Roblox",
        "description": "Official fan club of Roblox!",
        "stats": {
          "members": 13507894
        }
      },
      "ext": {
        "open": true
      }
    },
    {
      "entity": {
        "id": "1127093",
        "name": "Roblox High School: Fan Club",
        "description": "The official group for all fans of Roblox High School 2 and Roblox High School: Legacy! Join this group to receive FREE in-game items in both games.\n🎮 RHS2: www.roblox.com/games/2098516465/RHS2\n⌛ RHS Legacy: www.roblox.com/games/9689581/RHS-Legacy\n\nNotice: As of 2024, we are no longer actively updating the RHS games. We've worked on RHS for over 10 years, so it's finally come time for us to move on to brand new projects.\n\nWhile there will be no more major updates, the RHS games aren’t going anywhere, and our staff will continue to moderate and maintain both games for the foreseeable future. (If you need to contact our Moderation Staff, please reach out via our Community Server)\n\nThank you to everyone who’s been a part of this amazing journey!",
        "stats": {
          "members": 7013554
        }
      },
      "ext": {
        "open": true
      }
    }
  ],
  "metadata": {
    "platform": "roblox",
    "endpoint": "group_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` | - |
| `memberCount` | `entity.stats.members` | `toNumber` |
| `publicEntryAllowed` | `ext.open` | `toBoolean` |

## 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).