# so.sprk.actor.searchActorsTypeahead

> Published by [sprk.so](https://lexicon.garden/identity/did:plc:cveom2iroj3mt747sd4qqnr2)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:cveom2iroj3mt747sd4qqnr2/so.sprk.actor.searchActorsTypeahead)
- [Documentation](https://lexicon.garden/lexicon/did:plc:cveom2iroj3mt747sd4qqnr2/so.sprk.actor.searchActorsTypeahead/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:cveom2iroj3mt747sd4qqnr2/so.sprk.actor.searchActorsTypeahead/examples)

## Definitions

### `so.sprk.actor.searchActorsTypeahead`

**Type**: `query`

Find actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `q` | `string` | No | Search query prefix; not a full query string. |
| `limit` | `integer` | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `actors` | `array` | Yes |  |

## Raw Schema

```json
{
  "id": "so.sprk.actor.searchActorsTypeahead",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "actors"
          ],
          "properties": {
            "actors": {
              "type": "array",
              "items": {
                "ref": "so.sprk.actor.defs#profileViewBasic",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "q": {
            "type": "string",
            "description": "Search query prefix; not a full query string."
          },
          "limit": {
            "type": "integer",
            "default": 10,
            "maximum": 100,
            "minimum": 1
          }
        }
      },
      "description": "Find actor suggestions for a prefix search term. Expected use is for auto-completion during text field entry. Does not require auth."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```