pl-api
    Preparing search index...

    Interface SearchParams

    interface SearchParams {
        account_id?: string;
        exclude_unreviewed?: boolean;
        following?: boolean;
        limit?: number;
        max_id?: string;
        min_id?: string;
        offset?: number;
        resolve?: boolean;
        since_id?: string;
        type?: "accounts" | "statuses" | "groups" | "hashtags";
        with_relationships?: boolean;
    }

    Hierarchy

    Index

    Properties

    account_id? exclude_unreviewed? following? limit? max_id? min_id? offset? resolve? since_id? type? with_relationships?

    Properties

    account_id?: string

    String. If provided, will only return statuses authored by this account.

    exclude_unreviewed?: boolean

    Boolean. Filter out unreviewed tags? Defaults to false. Use true when trying to find trending tags.

    following?: boolean

    Boolean. Only include accounts that the user is following? Defaults to false.

    limit?: number

    Integer. Maximum number of results to return.

    max_id?: string

    String. All results returned will be lesser than this ID. In effect, sets an upper bound on results.

    min_id?: string

    String. Returns results immediately newer than this ID. In effect, sets a cursor at this ID and paginates forward.

    offset?: number

    Integer. Skip the first n results.

    resolve?: boolean

    Boolean. Only relevant if type includes accounts. If true and (a) the search query is for a remote account (e.g., someaccount@someother.server) and (b) the local server does not know about the account, WebFinger is used to try and resolve the account at someother.server. This provides the best recall at higher latency. If false only accounts the server knows about are returned.

    since_id?: string

    String. All results returned will be greater than this ID. In effect, sets a lower bound on results.

    type?: "accounts" | "statuses" | "groups" | "hashtags"

    String. Specify whether to search for only accounts, hashtags, statuses

    with_relationships?: boolean

    Embed relationships into accounts. Supported by Pleroma.

    Settings

    Member Visibility

    On This Page

    Properties