# x.search

**stable** **2 credits** **may need a pack**

Search recent tweets by keyword or hashtag.

`GET /v1/x/search`

> [!NOTE] **May need a pack.** Free credits use only the open fetch path; the fallback path behind it needs a purchased pack and a verified email. See [pricing](https://onekey.dev/pricing).

## What you get

A list of X (Twitter) 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.

**Also works with:** [Multi-platform search](https://onekey.dev/docs/search-multi.md#multi-platform-search) as the X (Twitter) search leg · [Computed block](https://onekey.dev/docs/computed.md) (`engagement_rate`, `language`). Any [batch](https://onekey.dev/docs/batch.md) can include it.

**Also known as:** `/twitter/search/tweets` on APIs that nest their paths. See [Alternatives and equivalents](https://onekey.dev/docs/alternatives.md).

## What it costs

- **2 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 query (supports X search operators) | max 200 chars; must match `[^\x00-\x1f]{1,200}`; trimmed, repeated spaces collapsed |

## Request

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

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/x/search",
    params={"q": "nasa"},
    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: "nasa" });
const res = await fetch(`https://api.onekey.dev/v1/x/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 X (Twitter) response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": [
    {
      "content": {
        "id": "2104661418272575612",
        "text": "Damn, this is another huge milestone for SpaceX.  Something for the nascent Canadian launch industry to aspire to.  SpaceX started as a warehouse of dudes (and women) with a dream.  Everyone from NASA, SLA and Roscosmos laughed at them.  But now …",
        "url": "https://x.com/BurnerMcneil/status/2104661418272575612",
        "createdAt": "2026-09-28T19:55:59Z",
        "language": "en"
      },
      "author": {
        "id": "1822705914115145728",
        "username": "BurnerMcneil",
        "displayName": "Burner Mcneil",
        "avatarUrl": "https://pbs.twimg.com/profile_images/1886176151854350336/P2-FFH8a_200x200.jpg",
        "followers": 132,
        "verified": false
      },
      "engagement": {
        "likes": 0,
        "comments": 0,
        "shares": 0,
        "views": null,
        "bookmarks": 0,
        "quotes": 0
      }
    },
    {
      "content": {
        "id": "2104661402023498135",
        "text": "O DONALD TRUMP.👀🇺🇸🗽.\nRelação comercial com investimento no setor financeiro economia e econômico pela fábrica 🏭 do dólar comercial do Estados Unidos.\n@ILLUMINATI@MAÇONARIA.\nNASA SATÉLITE 🛰️.\nO departamento CHL👈POLÍCIA E HOMICÍDIO E IML no necrotério do hospital da clínicasSP.",
        "url": "https://x.com/xxxx3348/status/2104661402023498135",
        "createdAt": "2026-09-28T19:55:55Z",
        "language": "pt"
      },
      "author": {
        "id": "1636430917043404813",
        "username": "xxxx3348",
        "displayName": "illumicorp@153348-JOHNNY BRAVO.👀",
        "avatarUrl": "https://pbs.twimg.com/profile_images/2102601189254656000/CEbOjmth_200x200.jpg",
        "followers": 62,
        "verified": false
      },
      "engagement": {
        "likes": 0,
        "comments": 0,
        "shares": 0,
        "views": 1,
        "bookmarks": 0,
        "quotes": 0
      }
    }
  ],
  "metadata": {
    "platform": "x",
    "endpoint": "search",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 2,
    "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` | `content.id` | - |
| `text` | `content.text` | - |
| `url` | `content.url` | `safeUrl` |
| `created_timestamp` | `content.createdAt` | `toIsoDate` |
| `lang` | `content.language` | - |
| `author.id` | `author.id` | - |
| `author.screen_name` | `author.username` | - |
| `author.name` | `author.displayName` | - |
| `author.avatar_url` | `author.avatarUrl` | `safeUrl` |
| `author.followers` | `author.followers` | `toNumber` |
| `author.verification.verified` | `author.verified` | `toBoolean` |
| `likes` | `engagement.likes` | `toNumber` |
| `replies` | `engagement.comments` | `toNumber` |
| `reposts` | `engagement.shares` | `toNumber` |
| `views` | `engagement.views` | `toNumber` |
| `bookmarks` | `engagement.bookmarks` | `toNumber` |
| `quotes` | `engagement.quotes` | `toNumber` |

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