models/io.github.kikin81.atproto.app.bsky.feed/SearchPostsRequest

SearchPostsRequest

data class SearchPostsRequest(val author: <Error class: unknown class>? = null, val cursor: String? = null, val domain: String? = null, val lang: <Error class: unknown class>? = null, val limit: Long? = null, val mentions: <Error class: unknown class>? = null, val q: String, val since: String? = null, val sort: String? = null, val tag: List<String>? = null, val until: String? = null, val url: <Error class: unknown class>? = null)

Find posts matching search criteria, returning views of those posts. Note that this API endpoint may require authentication (eg, not public) for some service providers and implementations.

Constructors

SearchPostsRequest

constructor(author: <Error class: unknown class>? = null, cursor: String? = null, domain: String? = null, lang: <Error class: unknown class>? = null, limit: Long? = null, mentions: <Error class: unknown class>? = null, q: String, since: String? = null, sort: String? = null, tag: List<String>? = null, until: String? = null, url: <Error class: unknown class>? = null)

Properties

author

val author: <Error class: unknown class>? = null

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

cursor

val cursor: String? = null

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

domain

val domain: String? = null

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

lang

val lang: <Error class: unknown class>? = null

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

limit

val limit: Long? = null

mentions

val mentions: <Error class: unknown class>? = null

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

val q: String

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

since

val since: String? = null

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

val sort: String? = null

Specifies the ranking order of results.

tag

val tag: List<String>? = null

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

val until: String? = null

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

val url: <Error class: unknown class>? = null

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