app.bsky.unspecced.search_actors_skeleton¶

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

Parameters model for app.bsky.unspecced.searchActorsSkeleton.

field cursor: str | None = None¶: Optional pagination mechanism; may not necessarily allow scrolling through entire result set.

field limit: int | None = 25¶

Limit.

Constraints:

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: str | None = 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.ParamsDict(*args, **kwargs)¶

Bases: dict

cursor: typing_extensions.NotRequired[str | None]¶: Optional pagination mechanism; may not necessarily allow scrolling through entire result set.

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.

typeahead: typing_extensions.NotRequired[bool | None]¶: If true, acts as fast/simple ‘typeahead’ query.

viewer: typing_extensions.NotRequired[str | 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¶

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

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

field hits_total: int | None = None¶: Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.