pl-api
    Preparing search index...

    Interface PublicTimelineParams

    interface PublicTimelineParams {
        instance?: string;
        language?: string;
        limit?: number;
        local?: boolean;
        max_id?: string;
        min_id?: string;
        only_events?: boolean;
        only_media?: boolean;
        remote?: boolean;
        since_id?: string;
        with_muted?: boolean;
    }

    Hierarchy (View Summary)

    • PaginationParams
    • WithMutedParam
    • OnlyEventsParam
    • OnlyMediaParam
    • LanguageParam
      • PublicTimelineParams
    Index

    Properties

    instance? language? limit? local? max_id? min_id? only_events? only_media? remote? since_id? with_muted?

    Properties

    instance?: string

    Boolean. Show only statuses from the given domain.

    Requires features['instanceTimeline'].

    language?: string

    Fetch a translation in given language

    Requires features['fetchStatusesWithTranslation'].

    limit?: number

    Integer. Maximum number of results to return.

    local?: boolean

    Boolean. Show only local statuses? Defaults to false.

    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.

    only_events?: boolean

    Boolean. Filter out statuses without events.

    Requires features['events'].

    only_media?: boolean

    Boolean. Show only statuses with media attached? Defaults to false.

    remote?: boolean

    Boolean. Show only remote statuses? Defaults to false.

    since_id?: string

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

    with_muted?: boolean

    Boolean. Also show statuses from muted users. Default to false.

    Requires features['timelinesWithMuted'].

    Settings

    Member Visibility

    On This Page

    Properties