# place.stream.live.searchActorsTypeahead

> Published by [did:web:longos.iameli.link](https://lexicon.garden/identity/did:web:longos.iameli.link)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:web:longos.iameli.link/place.stream.live.searchActorsTypeahead)
- [Documentation](https://lexicon.garden/lexicon/did:web:longos.iameli.link/place.stream.live.searchActorsTypeahead/docs)
- [Examples](https://lexicon.garden/lexicon/did:web:longos.iameli.link/place.stream.live.searchActorsTypeahead/examples)

## Definitions

### `place.stream.live.searchActorsTypeahead`

**Type**: `query`

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

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

### `place.stream.live.searchActorsTypeahead#actor`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes | The actor's DID |
| `handle` | `string` (handle) | Yes | The actor's handle |

## Raw Schema

```json
{
  "id": "place.stream.live.searchActorsTypeahead",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "actors"
          ],
          "properties": {
            "actors": {
              "type": "array",
              "items": {
                "ref": "#actor",
                "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."
    },
    "actor": {
      "type": "object",
      "required": [
        "did",
        "handle"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did",
          "description": "The actor's DID"
        },
        "handle": {
          "type": "string",
          "format": "handle",
          "description": "The actor's handle"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```