chitose.app.bsky.unspecced package#

Submodules#

chitose.app.bsky.unspecced.defs module#

class chitose.app.bsky.unspecced.defs.SkeletonSearchActor(did: str)#

Bases: Object

to_dict() → dict[str, Any]#
class chitose.app.bsky.unspecced.defs.SkeletonSearchPost(uri: str)#

Bases: Object

to_dict() → dict[str, Any]#

chitose.app.bsky.unspecced.get_suggestions_skeleton module#

chitose.app.bsky.unspecced.get_tagged_suggestions module#

class chitose.app.bsky.unspecced.get_tagged_suggestions.Suggestion(tag: str, subject_type: Literal['actor', 'feed'], subject: str)#

Bases: Object

to_dict() → dict[str, Any]#

chitose.app.bsky.unspecced.search_actors_skeleton module#

chitose.app.bsky.unspecced.search_posts_skeleton module#

Module contents#

class chitose.app.bsky.unspecced.Unspecced_(call: Callable[[str, list[tuple[str, str | None | int | list[str]]], bytes | dict[str, Any] | None, dict[str, str]], bytes], subscribe: Callable[[str, list[tuple[str, str | None | int | list[str]]], Callable[[str | bytes], None]], None])#

Bases: object

We recommend calling methods in this class via the chitose.BskyAgent class instead of creating instances of this class directly.

An unspecced view of globally popular feed generators.

get_suggestions_skeleton(viewer: str | None = None, limit: int | None = None, cursor: str | None = None, relative_to_did: str | None = None) → bytes#

Get a skeleton of suggested actors. Intended to be called and then hydrated through app.bsky.actor.getSuggestions

Parameters:

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

  • relative_to_did – DID of the account to get suggestions relative to. If not provided, suggestions will be based on the viewer.

get_tagged_suggestions() → bytes#

Get a list of suggestions (feeds and users) tagged with categories

search_actors_skeleton(q: str, viewer: str | None = None, typeahead: bool | None = None, limit: int | None = None, cursor: str | None = None) → bytes#

Backend Actors (profile) search, returns only skeleton.

Parameters:

  • q – 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.

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

  • typeahead – If true, acts as fast/simple ‘typeahead’ query.

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

search_posts_skeleton(q: str, sort: Literal['top', 'latest'] | None = None, since: str | None = None, until: str | None = None, mentions: str | None = None, author: str | None = None, lang: str | None = None, domain: str | None = None, url: str | None = None, tag: list[str] | None = None, viewer: str | None = None, limit: int | None = None, cursor: str | None = None) → bytes#

Backend Posts search, returns only skeleton

Parameters:

  • q – Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.

  • sort – Specifies the ranking order of results.

  • since – Filter results for posts after the indicated datetime (inclusive). Expected to use ‘sortAt’ timestamp, which may not match ‘createdAt’. Can be a datetime, or just an ISO date (YYYY-MM-DD).

  • until – Filter results for posts before the indicated datetime (not inclusive). Expected to use ‘sortAt’ timestamp, which may not match ‘createdAt’. Can be a datetime, or just an ISO date (YYY-MM-DD).

  • mentions – Filter to posts which mention the given account. Handles are resolved to DID before query-time. Only matches rich-text facet mentions.

  • author – Filter to posts by the given account. Handles are resolved to DID before query-time.

  • lang – Filter to posts in the given language. Expected to be based on post language field, though server may override language detection.

  • domain – Filter to posts with URLs (facet links or embeds) linking to the given domain (hostname). Server may apply hostname normalization.

  • url – Filter to posts with links (facet links or embeds) pointing to this URL. Server may apply URL normalization or fuzzy matching.

  • tag – Filter to posts with the given tag (hashtag), based on rich-text facet or tag field. Do not include the hash (#) prefix. Multiple tags can be specified, with ‘AND’ matching.

  • viewer – DID of the account making the request (not included for public/unauthenticated queries). Used for ‘from:me’ queries.

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

On this page
Show Source