app.bsky.unspecced.searchActorsSkeleton

Backend Actors (profile) search, returns only skeleton.

class atproto_client.models.app.bsky.unspecced.search_actors_skeleton.Params

Bases: ParamsModelBase

Parameters model for app.bsky.unspecced.searchActorsSkeleton.

field cursor: str | None = None
field limit: int | None = None

Limit.

Constraints:
  • ge = 1

  • le = 100

field q: str [Required]

Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax.

field typeahead: bool | None = None

If true, acts as fast/simple โ€˜typeaheadโ€™ query.

field viewer: Did | None = None
class atproto_client.models.app.bsky.unspecced.search_actors_skeleton.ParamsDict

Bases: TypedDict

q: str

Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax.

cursor: NotRequired[str | None]

Optional pagination mechanism; may not necessarily allow scrolling through entire result set.

limit: NotRequired[int | None]

Limit.

typeahead: NotRequired[bool | None]

If true, acts as fast/simple โ€˜typeaheadโ€™ query.

viewer: NotRequired[Did | None]

DID of the account making the request (not included for public/unauthenticated queries). Used to boost followed accounts in ranking.

class atproto_client.models.app.bsky.unspecced.search_actors_skeleton.Response

Bases: ResponseModelBase

Output data model for app.bsky.unspecced.searchActorsSkeleton.

field actors: List[models.AppBskyUnspeccedDefs.SkeletonSearchActor] [Required]

Actors.

field cursor: str | None = None

Cursor.

field hits_total: int | None = None