# Account search

- Method: `GET`
- Path: `/users/search`
- Tier: Basic
- HTML docs: https://docs.ruma.fun/reference/get-users-search/
- Interactive docs: https://docs.ruma.fun/#endpoint=get-users-search

## Description

Search tracked accounts by display name or handle. Returns matching accounts ordered by relevance. Use q for the query string and limit (max 50) to cap results.

## cURL Example

```bash
curl --request GET \
  --url 'https://api.ruma.fun/api/v1/public/users/search?q=string' \
  --header 'X-API-Key: YOUR_API_KEY'
```

## Path Parameters

No path parameters for this endpoint.

## Query Parameters

- `q` (string, required): Search query. For tokens this matches symbol, name, or contract address; for accounts it matches display name or handle.
- `limit` (integer, optional): Maximum number of results to return (default 10, max 50).

## Response

OK

- `query` (string): Normalized query string that was searched.
- `total` (integer): Number of accounts returned in this response.
- `users` (array<object>): Matching accounts ordered by relevance.
- `users[].author_id` (integer (int64)): Internal Ruma author identifier.
- `users[].avatar_url` (string): URL of the account's avatar image.
- `users[].bot_score` (number (double)): Model score based on the quality of the account's smart-money followers.
- `users[].cohort` (integer): Cohort classification id for the account.
- `users[].display_name` (string): Display name of the account.
- `users[].followers` (integer (int64)): Total follower count for the account.
- `users[].name` (string): Account name.
- `users[].profile_url` (string): Normalized query string that was searched.
- `users[].screen_name` (string): Screen name or handle on the source platform.
- `users[].smart_followers_score` (number (double)): Model score based on the quality of the account's smart-money followers.
- `users[].smart_money_score` (number (double)): Model score based on the quality of the account's smart-money followers.
- `users[].source` (string): Source platform for the account (e.g. twitter).
- `users[].source_user_id` (string): Identifier for the account on the source platform.
- `users[].verified` (boolean): Whether the account is verified on the source platform.

Media type: `application/json`

## JSON Response

```json
{
  "query": "string",
  "total": 0,
  "users": [
    {
      "author_id": 0,
      "avatar_url": "string",
      "bot_score": 0,
      "cohort": 0,
      "display_name": "string",
      "followers": 0,
      "name": "string",
      "profile_url": "string",
      "screen_name": "string",
      "smart_followers_score": 0,
      "smart_money_score": 0,
      "source": "string",
      "source_user_id": "string",
      "verified": false
    }
  ]
}
```