# X / Twitter User Search (`twitter.search_users`)

Search X (Twitter) accounts by keyword (the People tab) and get profile records with follower, following and post counts.

Docs: https://primaryapi.com/docs/api-reference/twitter/search_users

- Endpoint: `POST https://api.primaryapi.com/v1/run/twitter.search_users`
- Category: Social · Platform: `twitter` · Kind: search · Status: live
- Price: 2 credits per call; up to 5 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=twitter.search_users`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `query` | string | yes |  | max 500 chars | Keyword matched against X handles, display names and bios (the People tab of X search): a topic ('ai agents'), a name ('Elon Musk') or a handle. |
| `cursor` | string | no |  |  | Opaque pagination cursor: pass the previous response's nextCursor. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `users` | object[] |  |
| `users[].id` | string \| null | Numeric user id (string) |
| `users[].username` | string \| null | Screen name without @ |
| `users[].name` | string \| null |  |
| `users[].bio` | string \| null |  |
| `users[].location` | string \| null |  |
| `users[].followers` | integer \| null |  |
| `users[].following` | integer \| null |  |
| `users[].posts` | integer \| null |  |
| `users[].listedCount` | integer \| null |  |
| `users[].verified` | boolean \| null |  |
| `users[].canDm` | boolean \| null |  |
| `users[].profileUrl` | string \| null |  |
| `users[].avatarUrl` | string \| null |  |
| `users[].coverUrl` | string \| null |  |
| `users[].createdUtc` | integer \| null | Account creation, UTC epoch seconds |
| `nextCursor` | string \| null | Pass back as `cursor` for the next page; null at the end |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

Pagination: pass the previous response’s `nextCursor` as `cursor` to get the next page; `nextCursor: null` means there are no more results.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/twitter.search_users" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"nasa"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "users": [
        {
          "id": "string",
          "username": "string",
          "name": "string",
          "bio": "string",
          "location": "string",
          "followers": 0,
          "following": 0,
          "posts": 0,
          "listedCount": 0,
          "verified": true,
          "canDm": true,
          "profileUrl": "https://example.com",
          "avatarUrl": "https://example.com",
          "coverUrl": "https://example.com",
          "createdUtc": 0
        }
      ],
      "nextCursor": null
    }
  },
  "provider": "PrimaryAPI",
  "credits": 2,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
  "nextCursor": null
}
```

## Pricing and reliability

- Usual price: 2 credits per call
- Price ceiling: up to 5 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=twitter.search_users`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

No matches → found=false (no_results), not billed.

