Exosphere.Bsky.Unspecced (Exosphere v0.6.0)

Copy Markdown View Source

XRPC client functions for the app.bsky.unspecced namespace.

Generated from vendored lexicons — DO NOT EDIT.

Endpoints

  • get_age_assurance_state — query: app.bsky.unspecced.getAgeAssuranceState
  • get_config — query: app.bsky.unspecced.getConfig
  • get_onboarding_suggested_starter_packs — query: app.bsky.unspecced.getOnboardingSuggestedStarterPacks
  • get_onboarding_suggested_starter_packs_skeleton — query: app.bsky.unspecced.getOnboardingSuggestedStarterPacksSkeleton
  • get_onboarding_suggested_users_skeleton — query: app.bsky.unspecced.getOnboardingSuggestedUsersSkeleton
  • get_popular_feed_generators — query: app.bsky.unspecced.getPopularFeedGenerators
  • get_post_thread_other_v2 — query: app.bsky.unspecced.getPostThreadOtherV2
  • get_post_thread_v2 — query: app.bsky.unspecced.getPostThreadV2
  • get_suggested_feeds — query: app.bsky.unspecced.getSuggestedFeeds
  • get_suggested_feeds_skeleton — query: app.bsky.unspecced.getSuggestedFeedsSkeleton
  • get_suggested_onboarding_users — query: app.bsky.unspecced.getSuggestedOnboardingUsers
  • get_suggested_starter_packs — query: app.bsky.unspecced.getSuggestedStarterPacks
  • get_suggested_starter_packs_skeleton — query: app.bsky.unspecced.getSuggestedStarterPacksSkeleton
  • get_suggested_users — query: app.bsky.unspecced.getSuggestedUsers
  • get_suggested_users_for_discover — query: app.bsky.unspecced.getSuggestedUsersForDiscover
  • get_suggested_users_for_discover_skeleton — query: app.bsky.unspecced.getSuggestedUsersForDiscoverSkeleton
  • get_suggested_users_for_explore — query: app.bsky.unspecced.getSuggestedUsersForExplore
  • get_suggested_users_for_explore_skeleton — query: app.bsky.unspecced.getSuggestedUsersForExploreSkeleton
  • get_suggested_users_for_see_more — query: app.bsky.unspecced.getSuggestedUsersForSeeMore
  • get_suggested_users_for_see_more_skeleton — query: app.bsky.unspecced.getSuggestedUsersForSeeMoreSkeleton
  • get_suggested_users_skeleton — query: app.bsky.unspecced.getSuggestedUsersSkeleton
  • get_suggestions_skeleton — query: app.bsky.unspecced.getSuggestionsSkeleton
  • get_tagged_suggestions — query: app.bsky.unspecced.getTaggedSuggestions
  • get_trending_topics — query: app.bsky.unspecced.getTrendingTopics
  • get_trends — query: app.bsky.unspecced.getTrends
  • get_trends_skeleton — query: app.bsky.unspecced.getTrendsSkeleton
  • init_age_assurance — procedure: app.bsky.unspecced.initAgeAssurance
  • search_actors_skeleton — query: app.bsky.unspecced.searchActorsSkeleton
  • search_posts_skeleton — query: app.bsky.unspecced.searchPostsSkeleton
  • search_starter_packs_skeleton — query: app.bsky.unspecced.searchStarterPacksSkeleton

Summary

Functions

Returns the current state of the age assurance process for an account. This is used to check if the user has completed age assurance or if further action is required.

Get miscellaneous runtime configuration.

Get a list of suggested starterpacks for onboarding

Get a skeleton of suggested starterpacks for onboarding. Intended to be called and hydrated by app.bsky.unspecced.getOnboardingSuggestedStarterPacks

Get a skeleton of suggested users for onboarding. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedOnboardingUsers

An unspecced view of globally popular feed generators.

(NOTE: this endpoint is under development and WILL change without notice. Don't use it until it is moved out of unspecced or your application WILL break) Get additional posts under a thread e.g. replies hidden by threadgate. Based on an anchor post at any depth of the tree, returns top-level replies below that anchor. It does not include ancestors nor the anchor itself. This should be called after exhausting app.bsky.unspecced.getPostThreadV2. Does not require auth, but additional metadata and filtering will be applied for authed requests.

(NOTE: this endpoint is under development and WILL change without notice. Don't use it until it is moved out of unspecced or your application WILL break) Get posts in a thread. It is based in an anchor post at any depth of the tree, and returns posts above it (recursively resolving the parent, without further branching to their replies) and below it (recursive replies, with branching to their replies). Does not require auth, but additional metadata and filtering will be applied for authed requests.

Get a list of suggested feeds

Get a skeleton of suggested feeds. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedFeeds

Get a list of suggested users for onboarding

Get a list of suggested starterpacks

Get a skeleton of suggested starterpacks. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedStarterpacks

Get a list of suggested users

Get a list of suggested users for the Discover page

Get a skeleton of suggested users for the Discover page. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedUsersForDiscover

Get a list of suggested users for the Explore page

Get a skeleton of suggested users for the Explore page. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedUsersForExplore

Get a list of suggested users for the See More page

Get a skeleton of suggested users for the See More page. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedUsersForSeeMore

Get a skeleton of suggested users. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedUsers

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

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

Get a list of trending topics

Get the current trends on the network

Get the skeleton of trends on the network. Intended to be called and then hydrated through app.bsky.unspecced.getTrends

Initiate age assurance for an account. This is a one-time action that will start the process of verifying the user's age.

Backend Actors (profile) search, returns only skeleton.

Backend Posts search, returns only skeleton

Backend Starter Pack search, returns only skeleton.

Functions

get_age_assurance_state(client)

@spec get_age_assurance_state(Exosphere.ATProto.XRPC.Client.t()) ::
  {:ok, map()} | {:error, term()}

Returns the current state of the age assurance process for an account. This is used to check if the user has completed age assurance or if further action is required.

get_config(client)

@spec get_config(Exosphere.ATProto.XRPC.Client.t()) :: {:ok, map()} | {:error, term()}

Get miscellaneous runtime configuration.

get_onboarding_suggested_starter_packs(client, params \\ [])

@spec get_onboarding_suggested_starter_packs(
  Exosphere.ATProto.XRPC.Client.t(),
  map() | keyword()
) ::
  {:ok, map()} | {:error, term()}

Get a list of suggested starterpacks for onboarding

## Parameters

  • limit (integer, optional)

get_onboarding_suggested_starter_packs_skeleton(client, params \\ [])

@spec get_onboarding_suggested_starter_packs_skeleton(
  Exosphere.ATProto.XRPC.Client.t(),
  map() | keyword()
) :: {:ok, map()} | {:error, term()}

Get a skeleton of suggested starterpacks for onboarding. Intended to be called and hydrated by app.bsky.unspecced.getOnboardingSuggestedStarterPacks

## Parameters

  • limit (integer, optional)
  • viewer (string, optional): DID of the account making the request (not included for public/unauthenticated queries).

get_onboarding_suggested_users_skeleton(client, params \\ [])

@spec get_onboarding_suggested_users_skeleton(
  Exosphere.ATProto.XRPC.Client.t(),
  map() | keyword()
) ::
  {:ok, map()} | {:error, term()}

Get a skeleton of suggested users for onboarding. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedOnboardingUsers

## Parameters

  • category (string, optional): Category of users to get suggestions for.
  • limit (integer, optional)
  • viewer (string, optional): DID of the account making the request (not included for public/unauthenticated queries).

get_post_thread_other_v2(client, params \\ [])

@spec get_post_thread_other_v2(Exosphere.ATProto.XRPC.Client.t(), map() | keyword()) ::
  {:ok, map()} | {:error, term()}

(NOTE: this endpoint is under development and WILL change without notice. Don't use it until it is moved out of unspecced or your application WILL break) Get additional posts under a thread e.g. replies hidden by threadgate. Based on an anchor post at any depth of the tree, returns top-level replies below that anchor. It does not include ancestors nor the anchor itself. This should be called after exhausting app.bsky.unspecced.getPostThreadV2. Does not require auth, but additional metadata and filtering will be applied for authed requests.

## Parameters

  • anchor (string, required): Reference (AT-URI) to post record. This is the anchor post.

get_post_thread_v2(client, params \\ [])

@spec get_post_thread_v2(Exosphere.ATProto.XRPC.Client.t(), map() | keyword()) ::
  {:ok, map()} | {:error, term()}

(NOTE: this endpoint is under development and WILL change without notice. Don't use it until it is moved out of unspecced or your application WILL break) Get posts in a thread. It is based in an anchor post at any depth of the tree, and returns posts above it (recursively resolving the parent, without further branching to their replies) and below it (recursive replies, with branching to their replies). Does not require auth, but additional metadata and filtering will be applied for authed requests.

## Parameters

  • above (boolean, optional): Whether to include parents above the anchor.
  • anchor (string, required): Reference (AT-URI) to post record. This is the anchor post, and the thread will be built around it. It can be any post in the tree, not necessarily a root post.
  • below (integer, optional): How many levels of replies to include below the anchor.
  • branchingFactor (integer, optional): Maximum of replies to include at each level of the thread, except for the direct replies to the anchor, which are (NOTE: currently, during unspecced phase) all returned (NOTE: later they might be paginated).
  • sort (string, optional): Sorting for the thread replies.

get_suggested_feeds(client, params \\ [])

@spec get_suggested_feeds(Exosphere.ATProto.XRPC.Client.t(), map() | keyword()) ::
  {:ok, map()} | {:error, term()}

Get a list of suggested feeds

## Parameters

  • limit (integer, optional)

get_suggested_feeds_skeleton(client, params \\ [])

@spec get_suggested_feeds_skeleton(
  Exosphere.ATProto.XRPC.Client.t(),
  map() | keyword()
) ::
  {:ok, map()} | {:error, term()}

Get a skeleton of suggested feeds. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedFeeds

## Parameters

  • limit (integer, optional)
  • viewer (string, optional): DID of the account making the request (not included for public/unauthenticated queries).

get_suggested_onboarding_users(client, params \\ [])

@spec get_suggested_onboarding_users(
  Exosphere.ATProto.XRPC.Client.t(),
  map() | keyword()
) ::
  {:ok, map()} | {:error, term()}

Get a list of suggested users for onboarding

## Parameters

  • category (string, optional): Category of users to get suggestions for.
  • limit (integer, optional)

get_suggested_starter_packs(client, params \\ [])

@spec get_suggested_starter_packs(
  Exosphere.ATProto.XRPC.Client.t(),
  map() | keyword()
) ::
  {:ok, map()} | {:error, term()}

Get a list of suggested starterpacks

## Parameters

  • limit (integer, optional)

get_suggested_starter_packs_skeleton(client, params \\ [])

@spec get_suggested_starter_packs_skeleton(
  Exosphere.ATProto.XRPC.Client.t(),
  map() | keyword()
) ::
  {:ok, map()} | {:error, term()}

Get a skeleton of suggested starterpacks. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedStarterpacks

## Parameters

  • limit (integer, optional)
  • viewer (string, optional): DID of the account making the request (not included for public/unauthenticated queries).

get_suggested_users(client, params \\ [])

@spec get_suggested_users(Exosphere.ATProto.XRPC.Client.t(), map() | keyword()) ::
  {:ok, map()} | {:error, term()}

Get a list of suggested users

## Parameters

  • category (string, optional): Category of users to get suggestions for.
  • limit (integer, optional)

get_suggested_users_for_discover(client, params \\ [])

@spec get_suggested_users_for_discover(
  Exosphere.ATProto.XRPC.Client.t(),
  map() | keyword()
) ::
  {:ok, map()} | {:error, term()}

Get a list of suggested users for the Discover page

## Parameters

  • limit (integer, optional)

get_suggested_users_for_discover_skeleton(client, params \\ [])

@spec get_suggested_users_for_discover_skeleton(
  Exosphere.ATProto.XRPC.Client.t(),
  map() | keyword()
) ::
  {:ok, map()} | {:error, term()}

Get a skeleton of suggested users for the Discover page. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedUsersForDiscover

## Parameters

  • limit (integer, optional)
  • viewer (string, optional): DID of the account making the request (not included for public/unauthenticated queries).

get_suggested_users_for_explore(client, params \\ [])

@spec get_suggested_users_for_explore(
  Exosphere.ATProto.XRPC.Client.t(),
  map() | keyword()
) ::
  {:ok, map()} | {:error, term()}

Get a list of suggested users for the Explore page

## Parameters

  • category (string, optional): Category of users to get suggestions for.
  • limit (integer, optional)

get_suggested_users_for_explore_skeleton(client, params \\ [])

@spec get_suggested_users_for_explore_skeleton(
  Exosphere.ATProto.XRPC.Client.t(),
  map() | keyword()
) ::
  {:ok, map()} | {:error, term()}

Get a skeleton of suggested users for the Explore page. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedUsersForExplore

## Parameters

  • category (string, optional): Category of users to get suggestions for.
  • limit (integer, optional)
  • viewer (string, optional): DID of the account making the request (not included for public/unauthenticated queries).

get_suggested_users_for_see_more(client, params \\ [])

@spec get_suggested_users_for_see_more(
  Exosphere.ATProto.XRPC.Client.t(),
  map() | keyword()
) ::
  {:ok, map()} | {:error, term()}

Get a list of suggested users for the See More page

## Parameters

  • category (string, optional): Category of users to get suggestions for.
  • limit (integer, optional)

get_suggested_users_for_see_more_skeleton(client, params \\ [])

@spec get_suggested_users_for_see_more_skeleton(
  Exosphere.ATProto.XRPC.Client.t(),
  map() | keyword()
) ::
  {:ok, map()} | {:error, term()}

Get a skeleton of suggested users for the See More page. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedUsersForSeeMore

## Parameters

  • category (string, optional): Category of users to get suggestions for.
  • limit (integer, optional)
  • viewer (string, optional): DID of the account making the request (not included for public/unauthenticated queries).

get_suggested_users_skeleton(client, params \\ [])

@spec get_suggested_users_skeleton(
  Exosphere.ATProto.XRPC.Client.t(),
  map() | keyword()
) ::
  {:ok, map()} | {:error, term()}

Get a skeleton of suggested users. Intended to be called and hydrated by app.bsky.unspecced.getSuggestedUsers

## Parameters

  • category (string, optional): Category of users to get suggestions for.
  • limit (integer, optional)
  • viewer (string, optional): DID of the account making the request (not included for public/unauthenticated queries).

get_suggestions_skeleton(client, params \\ [])

@spec get_suggestions_skeleton(Exosphere.ATProto.XRPC.Client.t(), map() | keyword()) ::
  {:ok, map()} | {:error, term()}

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

## Parameters

  • cursor (string, optional)
  • limit (integer, optional)
  • relativeToDid (string, optional): DID of the account to get suggestions relative to. If not provided, suggestions will be based on the viewer.
  • viewer (string, optional): DID of the account making the request (not included for public/unauthenticated queries). Used to boost followed accounts in ranking.

get_tagged_suggestions(client)

@spec get_tagged_suggestions(Exosphere.ATProto.XRPC.Client.t()) ::
  {:ok, map()} | {:error, term()}

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

## Parameters

get_trends(client, params \\ [])

@spec get_trends(Exosphere.ATProto.XRPC.Client.t(), map() | keyword()) ::
  {:ok, map()} | {:error, term()}

Get the current trends on the network

## Parameters

  • limit (integer, optional)

init_age_assurance(client, body \\ %{})

@spec init_age_assurance(Exosphere.ATProto.XRPC.Client.t(), map()) ::
  {:ok, map()} | {:error, term()}

Initiate age assurance for an account. This is a one-time action that will start the process of verifying the user's age.

search_actors_skeleton(client, params \\ [])

@spec search_actors_skeleton(Exosphere.ATProto.XRPC.Client.t(), map() | keyword()) ::
  {:ok, map()} | {:error, term()}

Backend Actors (profile) search, returns only skeleton.

## Parameters

  • cursor (string, optional): Optional pagination mechanism; may not necessarily allow scrolling through entire result set.
  • limit (integer, optional)
  • q (string, 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.
  • typeahead (boolean, optional): If true, acts as fast/simple 'typeahead' query.
  • viewer (string, optional): DID of the account making the request (not included for public/unauthenticated queries). Used to boost followed accounts in ranking.

search_posts_skeleton(client, params \\ [])

@spec search_posts_skeleton(Exosphere.ATProto.XRPC.Client.t(), map() | keyword()) ::
  {:ok, map()} | {:error, term()}

Backend Posts search, returns only skeleton

## Parameters

  • author (string, optional): Filter to posts by the given account. Handles are resolved to DID before query-time.
  • cursor (string, optional): Optional pagination mechanism; may not necessarily allow scrolling through entire result set.
  • domain (string, optional): Filter to posts with URLs (facet links or embeds) linking to the given domain (hostname). Server may apply hostname normalization.
  • lang (string, optional): Filter to posts in the given language. Expected to be based on post language field, though server may override language detection.
  • limit (integer, optional)
  • mentions (string, optional): Filter to posts which mention the given account. Handles are resolved to DID before query-time. Only matches rich-text facet mentions.
  • q (string, required): Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.
  • since (string, optional): 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).
  • sort (string, optional): Specifies the ranking order of results.
  • tag (array, optional): 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.
  • until (string, optional): 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).
  • url (string, optional): Filter to posts with links (facet links or embeds) pointing to this URL. Server may apply URL normalization or fuzzy matching.
  • viewer (string, optional): DID of the account making the request (not included for public/unauthenticated queries). Used for 'from:me' queries.

search_starter_packs_skeleton(client, params \\ [])

@spec search_starter_packs_skeleton(
  Exosphere.ATProto.XRPC.Client.t(),
  map() | keyword()
) ::
  {:ok, map()} | {:error, term()}

Backend Starter Pack search, returns only skeleton.

## Parameters

  • cursor (string, optional): Optional pagination mechanism; may not necessarily allow scrolling through entire result set.
  • limit (integer, optional)
  • q (string, required): Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.
  • viewer (string, optional): DID of the account making the request (not included for public/unauthenticated queries).