> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neynar.com/llms.txt
> Use this file to discover all available pages before exploring further.

# searchUser

Search for Usernames

> **Group:** User APIs

Use this when you need: **Search for Usernames**.

## Usage

```ts theme={"system"}
import { NeynarAPIClient, Configuration } from "@neynar/nodejs-sdk";

const client = new NeynarAPIClient(
  new Configuration({ apiKey: "YOUR_NEYNAR_API_KEY" })
);

const res = await client.searchUser({
  q: "example", // required
  // xNeynarExperimental: true, 
  // viewerFid: 123, 
  // limit: 123, 
  // cursor: "example", 
});
console.log(res);
```

## Parameters

| Parameter             | Type      | Required | Description |
| --------------------- | --------- | :------: | ----------- |
| `q`                   | `string`  |     ✅    | -           |
| `xNeynarExperimental` | `boolean` |     ❌    | -           |
| `viewerFid`           | `number`  |     ❌    | -           |
| `limit`               | `number`  |     ❌    | -           |
| `cursor`              | `string`  |     ❌    | -           |

## Response

Returns a `RequestArgs` object.

## Error Handling

```ts theme={"system"}
try {
  const res = await client.searchUser({
    q: "example"
  });
  // use res
} catch (err) {
  // Axios/HTTP errors, invalid params, auth issues, etc.
  console.error(err);
}
```

## Related API Reference

📖 **API Reference:** [searchUser](/reference/search-user)

For detailed information about the HTTP endpoint, request/response schemas, and additional examples, see the complete API documentation.

## Tips

* Provide a **viewerFid** when supported to respect mutes/blocks and include `viewer_context`.
* Keep requests scoped (e.g., use `limit`) to improve latency.
* Cache results where sensible.