Function accountsCategory

Returns {
    biteAccount: (accountId: string) => Promise<EmptyObject>;
    createScrobble: (
        params: CreateScrobbleParams,
    ) => Promise<
        {
            account: {
                __meta: { pleroma?: any; source?: any };
                accepts_chat_messages: boolean | null;
                acct: string;
                ap_id: string | null;
                avatar: string;
                avatar_default: boolean;
                avatar_description: string;
                avatar_static: string;
                background_image: string | null;
                birthday?: string;
                bot: boolean;
                created_at: string;
                custom_css: string;
                deactivated?: boolean;
                discoverable: boolean;
                display_name: string;
                domain: string;
                emojis: {
                    category: string | null;
                    shortcode: string;
                    static_url: string;
                    url: string;
                    visible_in_picker: boolean;
                }[];
                enable_rss: boolean;
                favicon?: string;
                fields: { name: string; value: string; verified_at: string
                | null }[];
                followers_count: number;
                following_count: number;
                fqn: string;
                group: boolean;
                header: string;
                header_default: boolean;
                header_description: string;
                header_static: string;
                hide_collections?: boolean;
                hide_favorites: boolean;
                hide_followers?: boolean;
                hide_followers_count?: boolean;
                hide_follows?: boolean;
                hide_follows_count?: boolean;
                id: string;
                identity_proofs: { name: string; value: string; verified_at: string }[];
                indexable: boolean | null;
                is_admin?: boolean;
                is_cat: boolean;
                is_moderator?: boolean;
                is_suggested?: boolean;
                last_status_at: string | null;
                limited?: boolean;
                local?: boolean;
                location?: string;
                locked: boolean;
                memorial: boolean | null;
                mention_policy: "none" | "only_known" | "only_contacts";
                moved:
                    | {
                        __meta: { pleroma?: any; source?: any };
                        accepts_chat_messages: boolean | null;
                        acct: string;
                        ap_id: string | null;
                        avatar: string;
                        avatar_default: boolean;
                        avatar_description: string;
                        avatar_static: string;
                        background_image: string | null;
                        birthday?: string;
                        bot: boolean;
                        created_at: string;
                        custom_css: string;
                        deactivated?: boolean;
                        discoverable: boolean;
                        display_name: string;
                        domain: string;
                        emojis: {
                            category: (...) | (...);
                            shortcode: string;
                            static_url: string;
                            url: string;
                            visible_in_picker: boolean;
                        }[];
                        enable_rss: boolean;
                        favicon?: string;
                        fields: { name: string; value: string; verified_at: (...)
                        | (...) }[];
                        followers_count: number;
                        following_count: number;
                        fqn: string;
                        group: boolean;
                        header: string;
                        header_default: boolean;
                        header_description: string;
                        header_static: string;
                        hide_collections?: boolean;
                        hide_favorites: boolean;
                        hide_followers?: boolean;
                        hide_followers_count?: boolean;
                        hide_follows?: boolean;
                        hide_follows_count?: boolean;
                        id: string;
                        identity_proofs: { name: string; value: string; verified_at: string }[];
                        indexable: boolean | null;
                        is_admin?: boolean;
                        is_cat: boolean;
                        is_moderator?: boolean;
                        is_suggested?: boolean;
                        last_status_at: string | null;
                        limited?: boolean;
                        local?: boolean;
                        location?: string;
                        locked: boolean;
                        memorial: boolean | null;
                        mention_policy: "none" | "only_known" | "only_contacts";
                        noindex: boolean | null;
                        note: string;
                        payment_options: (
                            | { href: ...; name: ...; object_id: ...; type: ... }
                            | {
                                amount_min: ...;
                                chain_id: ...;
                                object_id: ...;
                                price: ...;
                                type: ...;
                            }
                        )[];
                        permit_followback?: boolean;
                        pronouns: string[];
                        relationship?: {
                            blocked_by: boolean;
                            blocking: boolean;
                            domain_blocking: boolean;
                            endorsed: boolean;
                            followed_by: boolean;
                            following: boolean;
                            id: string;
                            languages: (...)
                            | (...);
                            muting: boolean;
                            muting_notifications: boolean;
                            note: string;
                            notifying: boolean;
                            requested: boolean;
                            showing_reblogs: boolean;
                        };
                        roles: {
                            color: string;
                            highlighted: boolean;
                            id: string;
                            name: string;
                            permissions: string;
                        }[];
                        speak_as_cat: boolean;
                        statuses_count: number;
                        subscribers_count: number;
                        suspended?: boolean;
                        url: string;
                        username: string;
                        verified?: boolean;
                    }
                    | null;
                noindex: boolean
                | null;
                note: string;
                payment_options: (
                    | {
                        href: string
                        | null;
                        name: string | null;
                        object_id: string | null;
                        type: "link";
                    }
                    | {
                        amount_min: number
                        | null;
                        chain_id: string | null;
                        object_id: string | null;
                        price: number | null;
                        type: "monero-subscription";
                    }
                )[];
                permit_followback?: boolean;
                pronouns: string[];
                relationship?: {
                    blocked_by: boolean;
                    blocking: boolean;
                    domain_blocking: boolean;
                    endorsed: boolean;
                    followed_by: boolean;
                    following: boolean;
                    id: string;
                    languages: string[]
                    | null;
                    muting: boolean;
                    muting_notifications: boolean;
                    note: string;
                    notifying: boolean;
                    requested: boolean;
                    showing_reblogs: boolean;
                };
                roles: {
                    color: string;
                    highlighted: boolean;
                    id: string;
                    name: string;
                    permissions: string;
                }[];
                speak_as_cat: boolean;
                statuses_count: number;
                subscribers_count: number;
                suspended?: boolean;
                url: string;
                username: string;
                verified?: boolean;
            } & WithMoved;
            album: string;
            artist: string;
            created_at: string;
            external_link: string
            | null;
            id: string;
            length: number | null;
            title: string;
        },
    >;
    followAccount: (
        accountId: string,
        params?: FollowAccountParams,
    ) => Promise<
        {
            blocked_by: boolean;
            blocking: boolean;
            domain_blocking: boolean;
            endorsed: boolean;
            followed_by: boolean;
            following: boolean;
            id: string;
            languages: string[]
            | null;
            muting: boolean;
            muting_notifications: boolean;
            note: string;
            notifying: boolean;
            requested: boolean;
            showing_reblogs: boolean;
        },
    >;
    getAccount: (
        accountId: string,
        params?: WithMutedParam,
    ) => Promise<Account>;
    getAccountAntennas: (accountId: string) => Promise<Antenna[]>;
    getAccountCircles: (accountId: string) => Promise<Antenna[]>;
    getAccountEndorsements: (
        accountId: string,
        params?: GetAccountEndorsementsParams,
    ) => Promise<PaginatedResponse<Account, true>>;
    getAccountExcludeAntennas: (
        accountId: string,
    ) => Promise<{ id: string; title: string }[]>;
    getAccountFavourites: (
        accountId: string,
        params?: PaginationParams,
    ) => Promise<PaginatedResponse<Status, true>>;
    getAccountFeaturedTags: (
        accountId: string,
    ) => Promise<
        {
            id: string;
            last_status_at: number
            | null;
            name: string;
            statuses_count: number;
            url?: string;
        }[],
    >;
    getAccountFollowers: (
        accountId: string,
        params?: GetAccountFollowersParams,
    ) => Promise<PaginatedResponse<Account, true>>;
    getAccountFollowing: (
        accountId: string,
        params?: GetAccountFollowingParams,
    ) => Promise<PaginatedResponse<Account, true>>;
    getAccountLists: (
        accountId: string,
    ) => Promise<
        {
            antennas: Antenna[];
            exclusive?: boolean;
            favourite?: boolean;
            id: string;
            notify?: boolean;
            replies_policy?: "none"
            | "list"
            | "followed";
            title: string;
        }[],
    >;
    getAccounts: (accountId: string[]) => Promise<Account[]>;
    getAccountStatuses: (
        accountId: string,
        params?: GetAccountStatusesParams,
    ) => Promise<PaginatedResponse<Status, true>>;
    getAccountSubscribers: (
        accountId: string,
        params?: GetAccountSubscribersParams,
    ) => Promise<PaginatedResponse<Account, true>>;
    getBirthdays: (day: number, month: number) => Promise<Account[]>;
    getFamiliarFollowers: (
        accountIds: string[],
    ) => Promise<{ accounts: Account[]; id: string }[]>;
    getRelationships: (
        accountIds: string[],
        params?: GetRelationshipsParams,
    ) => Promise<
        {
            blocked_by: boolean;
            blocking: boolean;
            domain_blocking: boolean;
            endorsed: boolean;
            followed_by: boolean;
            following: boolean;
            id: string;
            languages: string[]
            | null;
            muting: boolean;
            muting_notifications: boolean;
            note: string;
            notifying: boolean;
            requested: boolean;
            showing_reblogs: boolean;
        }[],
    >;
    getScrobbles: (
        accountId: string,
        params?: PaginationParams,
    ) => Promise<
        PaginatedResponse<
            {
                account: {
                    __meta: { pleroma?: any; source?: any };
                    accepts_chat_messages: boolean | null;
                    acct: string;
                    ap_id: string | null;
                    avatar: string;
                    avatar_default: boolean;
                    avatar_description: string;
                    avatar_static: string;
                    background_image: string | null;
                    birthday?: string;
                    bot: boolean;
                    created_at: string;
                    custom_css: string;
                    deactivated?: boolean;
                    discoverable: boolean;
                    display_name: string;
                    domain: string;
                    emojis: {
                        category: string | null;
                        shortcode: string;
                        static_url: string;
                        url: string;
                        visible_in_picker: boolean;
                    }[];
                    enable_rss: boolean;
                    favicon?: string;
                    fields: { name: string; value: string; verified_at: string
                    | null }[];
                    followers_count: number;
                    following_count: number;
                    fqn: string;
                    group: boolean;
                    header: string;
                    header_default: boolean;
                    header_description: string;
                    header_static: string;
                    hide_collections?: boolean;
                    hide_favorites: boolean;
                    hide_followers?: boolean;
                    hide_followers_count?: boolean;
                    hide_follows?: boolean;
                    hide_follows_count?: boolean;
                    id: string;
                    identity_proofs: { name: string; value: string; verified_at: string }[];
                    indexable: boolean | null;
                    is_admin?: boolean;
                    is_cat: boolean;
                    is_moderator?: boolean;
                    is_suggested?: boolean;
                    last_status_at: string | null;
                    limited?: boolean;
                    local?: boolean;
                    location?: string;
                    locked: boolean;
                    memorial: boolean | null;
                    mention_policy: "none" | "only_known" | "only_contacts";
                    moved:
                        | {
                            __meta: { pleroma?: any; source?: any };
                            accepts_chat_messages: boolean | null;
                            acct: string;
                            ap_id: string | null;
                            avatar: string;
                            avatar_default: boolean;
                            avatar_description: string;
                            avatar_static: string;
                            background_image: string | null;
                            birthday?: string;
                            bot: boolean;
                            created_at: string;
                            custom_css: string;
                            deactivated?: boolean;
                            discoverable: boolean;
                            display_name: string;
                            domain: string;
                            emojis: {
                                category: ...;
                                shortcode: ...;
                                static_url: ...;
                                url: ...;
                                visible_in_picker: ...;
                            }[];
                            enable_rss: boolean;
                            favicon?: string;
                            fields: { name: ...; value: ...; verified_at: ... }[];
                            followers_count: number;
                            following_count: number;
                            fqn: string;
                            group: boolean;
                            header: string;
                            header_default: boolean;
                            header_description: string;
                            header_static: string;
                            hide_collections?: boolean;
                            hide_favorites: boolean;
                            hide_followers?: boolean;
                            hide_followers_count?: boolean;
                            hide_follows?: boolean;
                            hide_follows_count?: boolean;
                            id: string;
                            identity_proofs: { name: ...; value: ...; verified_at: ... }[];
                            indexable: boolean | null;
                            is_admin?: boolean;
                            is_cat: boolean;
                            is_moderator?: boolean;
                            is_suggested?: boolean;
                            last_status_at: string | null;
                            limited?: boolean;
                            local?: boolean;
                            location?: string;
                            locked: boolean;
                            memorial: boolean | null;
                            mention_policy: "none" | "only_known" | "only_contacts";
                            noindex: boolean | null;
                            note: string;
                            payment_options: ((...) | (...))[];
                            permit_followback?: boolean;
                            pronouns: string[];
                            relationship?: {
                                blocked_by: ...;
                                blocking: ...;
                                domain_blocking: ...;
                                endorsed: ...;
                                followed_by: ...;
                                following: ...;
                                id: ...;
                                languages: ...;
                                muting: ...;
                                muting_notifications: ...;
                                note: ...;
                                notifying: ...;
                                requested: ...;
                                showing_reblogs: ...;
                            };
                            roles: {
                                color: ...;
                                highlighted: ...;
                                id: ...;
                                name: ...;
                                permissions: ...;
                            }[];
                            speak_as_cat: boolean;
                            statuses_count: number;
                            subscribers_count: number;
                            suspended?: boolean;
                            url: string;
                            username: string;
                            verified?: boolean;
                        }
                        | null;
                    noindex: boolean
                    | null;
                    note: string;
                    payment_options: (
                        | {
                            href: (...)
                            | (...);
                            name: (...) | (...);
                            object_id: (...) | (...);
                            type: "link";
                        }
                        | {
                            amount_min: (...)
                            | (...);
                            chain_id: (...) | (...);
                            object_id: (...) | (...);
                            price: (...) | (...);
                            type: "monero-subscription";
                        }
                    )[];
                    permit_followback?: boolean;
                    pronouns: string[];
                    relationship?: {
                        blocked_by: boolean;
                        blocking: boolean;
                        domain_blocking: boolean;
                        endorsed: boolean;
                        followed_by: boolean;
                        following: boolean;
                        id: string;
                        languages: (...)[]
                        | null;
                        muting: boolean;
                        muting_notifications: boolean;
                        note: string;
                        notifying: boolean;
                        requested: boolean;
                        showing_reblogs: boolean;
                    };
                    roles: {
                        color: string;
                        highlighted: boolean;
                        id: string;
                        name: string;
                        permissions: string;
                    }[];
                    speak_as_cat: boolean;
                    statuses_count: number;
                    subscribers_count: number;
                    suspended?: boolean;
                    url: string;
                    username: string;
                    verified?: boolean;
                } & WithMoved;
                album: string;
                artist: string;
                created_at: string;
                external_link: string
                | null;
                id: string;
                length: number | null;
                title: string;
            },
            true,
        >,
    >;
    loadActivities: (accountId: string) => Promise<EmptyObject>;
    lookupAccount: (acct: string, meta?: RequestMeta) => Promise<Account>;
    pinAccount: (
        accountId: string,
    ) => Promise<
        {
            blocked_by: boolean;
            blocking: boolean;
            domain_blocking: boolean;
            endorsed: boolean;
            followed_by: boolean;
            following: boolean;
            id: string;
            languages: string[]
            | null;
            muting: boolean;
            muting_notifications: boolean;
            note: string;
            notifying: boolean;
            requested: boolean;
            showing_reblogs: boolean;
        },
    >;
    remoteInteraction: (
        ap_id: string,
        profile: string,
    ) => Promise<{ url: string }>;
    removeAccountFromFollowers: (
        accountId: string,
    ) => Promise<
        {
            blocked_by: boolean;
            blocking: boolean;
            domain_blocking: boolean;
            endorsed: boolean;
            followed_by: boolean;
            following: boolean;
            id: string;
            languages: string[]
            | null;
            muting: boolean;
            muting_notifications: boolean;
            note: string;
            notifying: boolean;
            requested: boolean;
            showing_reblogs: boolean;
        },
    >;
    reportAccount: (
        accountId: string,
        params: ReportAccountParams,
    ) => Promise<
        {
            action_taken?: boolean;
            action_taken_at: string
            | null;
            category?: string;
            comment?: string;
            created_at?: string;
            forwarded?: boolean;
            id: string;
            rule_ids: string | null;
            status_ids: string | null;
            target_account: Account | null;
        },
    >;
    searchAccounts: (
        q: string,
        params?: SearchAccountParams,
        meta?: RequestMeta,
    ) => Promise<Account[]>;
    unfollowAccount: (
        accountId: string,
    ) => Promise<
        {
            blocked_by: boolean;
            blocking: boolean;
            domain_blocking: boolean;
            endorsed: boolean;
            followed_by: boolean;
            following: boolean;
            id: string;
            languages: string[]
            | null;
            muting: boolean;
            muting_notifications: boolean;
            note: string;
            notifying: boolean;
            requested: boolean;
            showing_reblogs: boolean;
        },
    >;
    unpinAccount: (
        accountId: string,
    ) => Promise<
        {
            blocked_by: boolean;
            blocking: boolean;
            domain_blocking: boolean;
            endorsed: boolean;
            followed_by: boolean;
            following: boolean;
            id: string;
            languages: string[]
            | null;
            muting: boolean;
            muting_notifications: boolean;
            note: string;
            notifying: boolean;
            requested: boolean;
            showing_reblogs: boolean;
        },
    >;
    updateAccountNote: (
        accountId: string,
        comment: string,
    ) => Promise<
        {
            blocked_by: boolean;
            blocking: boolean;
            domain_blocking: boolean;
            endorsed: boolean;
            followed_by: boolean;
            following: boolean;
            id: string;
            languages: string[]
            | null;
            muting: boolean;
            muting_notifications: boolean;
            note: string;
            notifying: boolean;
            requested: boolean;
            showing_reblogs: boolean;
        },
    >;
}

• biteAccount: (accountId: string) => Promise<EmptyObject>

  Bite the given user.

  Requires featuresFeatures.bites.

  See

  https://github.com/purifetchi/Toki/blob/master/Toki/Controllers/MastodonApi/Bite/BiteController.cs

• createScrobble: (
      params: CreateScrobbleParams,
  ) => Promise<
      {
          account: {
              __meta: { pleroma?: any; source?: any };
              accepts_chat_messages: boolean | null;
              acct: string;
              ap_id: string | null;
              avatar: string;
              avatar_default: boolean;
              avatar_description: string;
              avatar_static: string;
              background_image: string | null;
              birthday?: string;
              bot: boolean;
              created_at: string;
              custom_css: string;
              deactivated?: boolean;
              discoverable: boolean;
              display_name: string;
              domain: string;
              emojis: {
                  category: string | null;
                  shortcode: string;
                  static_url: string;
                  url: string;
                  visible_in_picker: boolean;
              }[];
              enable_rss: boolean;
              favicon?: string;
              fields: { name: string; value: string; verified_at: string
              | null }[];
              followers_count: number;
              following_count: number;
              fqn: string;
              group: boolean;
              header: string;
              header_default: boolean;
              header_description: string;
              header_static: string;
              hide_collections?: boolean;
              hide_favorites: boolean;
              hide_followers?: boolean;
              hide_followers_count?: boolean;
              hide_follows?: boolean;
              hide_follows_count?: boolean;
              id: string;
              identity_proofs: { name: string; value: string; verified_at: string }[];
              indexable: boolean | null;
              is_admin?: boolean;
              is_cat: boolean;
              is_moderator?: boolean;
              is_suggested?: boolean;
              last_status_at: string | null;
              limited?: boolean;
              local?: boolean;
              location?: string;
              locked: boolean;
              memorial: boolean | null;
              mention_policy: "none" | "only_known" | "only_contacts";
              moved:
                  | {
                      __meta: { pleroma?: any; source?: any };
                      accepts_chat_messages: boolean | null;
                      acct: string;
                      ap_id: string | null;
                      avatar: string;
                      avatar_default: boolean;
                      avatar_description: string;
                      avatar_static: string;
                      background_image: string | null;
                      birthday?: string;
                      bot: boolean;
                      created_at: string;
                      custom_css: string;
                      deactivated?: boolean;
                      discoverable: boolean;
                      display_name: string;
                      domain: string;
                      emojis: {
                          category: (...) | (...);
                          shortcode: string;
                          static_url: string;
                          url: string;
                          visible_in_picker: boolean;
                      }[];
                      enable_rss: boolean;
                      favicon?: string;
                      fields: { name: string; value: string; verified_at: (...)
                      | (...) }[];
                      followers_count: number;
                      following_count: number;
                      fqn: string;
                      group: boolean;
                      header: string;
                      header_default: boolean;
                      header_description: string;
                      header_static: string;
                      hide_collections?: boolean;
                      hide_favorites: boolean;
                      hide_followers?: boolean;
                      hide_followers_count?: boolean;
                      hide_follows?: boolean;
                      hide_follows_count?: boolean;
                      id: string;
                      identity_proofs: { name: string; value: string; verified_at: string }[];
                      indexable: boolean | null;
                      is_admin?: boolean;
                      is_cat: boolean;
                      is_moderator?: boolean;
                      is_suggested?: boolean;
                      last_status_at: string | null;
                      limited?: boolean;
                      local?: boolean;
                      location?: string;
                      locked: boolean;
                      memorial: boolean | null;
                      mention_policy: "none" | "only_known" | "only_contacts";
                      noindex: boolean | null;
                      note: string;
                      payment_options: (
                          | { href: ...; name: ...; object_id: ...; type: ... }
                          | {
                              amount_min: ...;
                              chain_id: ...;
                              object_id: ...;
                              price: ...;
                              type: ...;
                          }
                      )[];
                      permit_followback?: boolean;
                      pronouns: string[];
                      relationship?: {
                          blocked_by: boolean;
                          blocking: boolean;
                          domain_blocking: boolean;
                          endorsed: boolean;
                          followed_by: boolean;
                          following: boolean;
                          id: string;
                          languages: (...)
                          | (...);
                          muting: boolean;
                          muting_notifications: boolean;
                          note: string;
                          notifying: boolean;
                          requested: boolean;
                          showing_reblogs: boolean;
                      };
                      roles: {
                          color: string;
                          highlighted: boolean;
                          id: string;
                          name: string;
                          permissions: string;
                      }[];
                      speak_as_cat: boolean;
                      statuses_count: number;
                      subscribers_count: number;
                      suspended?: boolean;
                      url: string;
                      username: string;
                      verified?: boolean;
                  }
                  | null;
              noindex: boolean
              | null;
              note: string;
              payment_options: (
                  | {
                      href: string
                      | null;
                      name: string | null;
                      object_id: string | null;
                      type: "link";
                  }
                  | {
                      amount_min: number
                      | null;
                      chain_id: string | null;
                      object_id: string | null;
                      price: number | null;
                      type: "monero-subscription";
                  }
              )[];
              permit_followback?: boolean;
              pronouns: string[];
              relationship?: {
                  blocked_by: boolean;
                  blocking: boolean;
                  domain_blocking: boolean;
                  endorsed: boolean;
                  followed_by: boolean;
                  following: boolean;
                  id: string;
                  languages: string[]
                  | null;
                  muting: boolean;
                  muting_notifications: boolean;
                  note: string;
                  notifying: boolean;
                  requested: boolean;
                  showing_reblogs: boolean;
              };
              roles: {
                  color: string;
                  highlighted: boolean;
                  id: string;
                  name: string;
                  permissions: string;
              }[];
              speak_as_cat: boolean;
              statuses_count: number;
              subscribers_count: number;
              suspended?: boolean;
              url: string;
              username: string;
              verified?: boolean;
          } & WithMoved;
          album: string;
          artist: string;
          created_at: string;
          external_link: string
          | null;
          id: string;
          length: number | null;
          title: string;
      },
  >

  Creates a new Listen activity for an account

  Requires featuresFeatures.scrobbles

  See

  https://docs.pleroma.social/backend/development/API/pleroma_api/#post-apiv1pleromascrobble

• followAccount: (
      accountId: string,
      params?: FollowAccountParams,
  ) => Promise<
      {
          blocked_by: boolean;
          blocking: boolean;
          domain_blocking: boolean;
          endorsed: boolean;
          followed_by: boolean;
          following: boolean;
          id: string;
          languages: string[]
          | null;
          muting: boolean;
          muting_notifications: boolean;
          note: string;
          notifying: boolean;
          requested: boolean;
          showing_reblogs: boolean;
      },
  >

  Follow account Follow the given account. Can also be used to update whether to show reblogs or enable notifications.

  See

  https://docs.joinmastodon.org/methods/accounts/#follow

• getAccount: (accountId: string, params?: WithMutedParam) => Promise<Account>

  Get account View information about a profile.

  See

  https://docs.joinmastodon.org/methods/accounts/#get

• getAccountAntennas: (accountId: string) => Promise<Antenna[]>

  Get antennas containing this account User antennas that you have added this account to. Requires featuresFeatures.antennas.

• getAccountCircles: (accountId: string) => Promise<Antenna[]>

  Get circles including this account User circles that you have added this account to. Requires featuresFeatures.circles.

• getAccountEndorsements: (
      accountId: string,
      params?: GetAccountEndorsementsParams,
  ) => Promise<PaginatedResponse<Account, true>>

  Endorsements Returns endorsed accounts

  Requires featuresFeatures.accountEndorsements.

  See

  • https://docs.pleroma.social/backend/development/API/pleroma_api/#apiv1pleromaaccountsidendorsements
  • https://docs.joinmastodon.org/methods/accounts/endorsements

• getAccountExcludeAntennas: (accountId: string) => Promise<{ id: string; title: string }[]>

  Get antennas excluding this account Requires featuresFeatures.antennas.

• getAccountFavourites: (
      accountId: string,
      params?: PaginationParams,
  ) => Promise<PaginatedResponse<Status, true>>

  Returns favorites timeline of any user

  Requires featuresFeatures.publicFavourites.

  See

  https://docs.pleroma.social/backend/development/API/pleroma_api/#apiv1pleromaaccountsidfavourites

• getAccountFeaturedTags: (
      accountId: string,
  ) => Promise<
      {
          id: string;
          last_status_at: number
          | null;
          name: string;
          statuses_count: number;
          url?: string;
      }[],
  >

  Get account’s featured tags Tags featured by this account.

  Requires featuresFeatures.featuredTags.

  See

  https://docs.joinmastodon.org/methods/accounts/#featured_tags

• getAccountFollowers: (
      accountId: string,
      params?: GetAccountFollowersParams,
  ) => Promise<PaginatedResponse<Account, true>>

  Get account’s followers Accounts which follow the given account, if network is not hidden by the account owner.

  See

  https://docs.joinmastodon.org/methods/accounts/#followers

• getAccountFollowing: (
      accountId: string,
      params?: GetAccountFollowingParams,
  ) => Promise<PaginatedResponse<Account, true>>

  Get account’s following Accounts which the given account is following, if network is not hidden by the account owner.

  See

  https://docs.joinmastodon.org/methods/accounts/#following

• getAccountLists: (
      accountId: string,
  ) => Promise<
      {
          antennas: Antenna[];
          exclusive?: boolean;
          favourite?: boolean;
          id: string;
          notify?: boolean;
          replies_policy?: "none"
          | "list"
          | "followed";
          title: string;
      }[],
  >

  Get lists containing this account User lists that you have added this account to.

  See

  https://docs.joinmastodon.org/methods/accounts/#lists

• getAccounts: (accountId: string[]) => Promise<Account[]>

  Get multiple accounts View information about multiple profiles.

  Requires featuresFeatures.getAccounts.

  See

  https://docs.joinmastodon.org/methods/accounts/#index

• getAccountStatuses: (
      accountId: string,
      params?: GetAccountStatusesParams,
  ) => Promise<PaginatedResponse<Status, true>>

  Get account’s statuses Statuses posted to the given account.

  See

  https://docs.joinmastodon.org/methods/accounts/#statuses

• getAccountSubscribers: (
      accountId: string,
      params?: GetAccountSubscribersParams,
  ) => Promise<PaginatedResponse<Account, true>>

  Subscriptions to the given user.

  Requires featuresFeatures.subscriptions.

• getBirthdays: (day: number, month: number) => Promise<Account[]>

  Birthday reminders Birthday reminders about users you follow.

  Requires featuresFeatures.birthdays.

• getFamiliarFollowers: (accountIds: string[]) => Promise<{ accounts: Account[]; id: string }[]>

  Find familiar followers Obtain a list of all accounts that follow a given account, filtered for accounts you follow.

  Requires featuresFeatures.familiarFollowers.

  See

  https://docs.joinmastodon.org/methods/accounts/#familiar_followers

• getRelationships: (
      accountIds: string[],
      params?: GetRelationshipsParams,
  ) => Promise<
      {
          blocked_by: boolean;
          blocking: boolean;
          domain_blocking: boolean;
          endorsed: boolean;
          followed_by: boolean;
          following: boolean;
          id: string;
          languages: string[]
          | null;
          muting: boolean;
          muting_notifications: boolean;
          note: string;
          notifying: boolean;
          requested: boolean;
          showing_reblogs: boolean;
      }[],
  >

  Check relationships to other accounts Find out whether a given account is followed, blocked, muted, etc.

  See

  https://docs.joinmastodon.org/methods/accounts/#relationships

• getScrobbles: (
      accountId: string,
      params?: PaginationParams,
  ) => Promise<
      PaginatedResponse<
          {
              account: {
                  __meta: { pleroma?: any; source?: any };
                  accepts_chat_messages: boolean | null;
                  acct: string;
                  ap_id: string | null;
                  avatar: string;
                  avatar_default: boolean;
                  avatar_description: string;
                  avatar_static: string;
                  background_image: string | null;
                  birthday?: string;
                  bot: boolean;
                  created_at: string;
                  custom_css: string;
                  deactivated?: boolean;
                  discoverable: boolean;
                  display_name: string;
                  domain: string;
                  emojis: {
                      category: string | null;
                      shortcode: string;
                      static_url: string;
                      url: string;
                      visible_in_picker: boolean;
                  }[];
                  enable_rss: boolean;
                  favicon?: string;
                  fields: { name: string; value: string; verified_at: string
                  | null }[];
                  followers_count: number;
                  following_count: number;
                  fqn: string;
                  group: boolean;
                  header: string;
                  header_default: boolean;
                  header_description: string;
                  header_static: string;
                  hide_collections?: boolean;
                  hide_favorites: boolean;
                  hide_followers?: boolean;
                  hide_followers_count?: boolean;
                  hide_follows?: boolean;
                  hide_follows_count?: boolean;
                  id: string;
                  identity_proofs: { name: string; value: string; verified_at: string }[];
                  indexable: boolean | null;
                  is_admin?: boolean;
                  is_cat: boolean;
                  is_moderator?: boolean;
                  is_suggested?: boolean;
                  last_status_at: string | null;
                  limited?: boolean;
                  local?: boolean;
                  location?: string;
                  locked: boolean;
                  memorial: boolean | null;
                  mention_policy: "none" | "only_known" | "only_contacts";
                  moved:
                      | {
                          __meta: { pleroma?: any; source?: any };
                          accepts_chat_messages: boolean | null;
                          acct: string;
                          ap_id: string | null;
                          avatar: string;
                          avatar_default: boolean;
                          avatar_description: string;
                          avatar_static: string;
                          background_image: string | null;
                          birthday?: string;
                          bot: boolean;
                          created_at: string;
                          custom_css: string;
                          deactivated?: boolean;
                          discoverable: boolean;
                          display_name: string;
                          domain: string;
                          emojis: {
                              category: ...;
                              shortcode: ...;
                              static_url: ...;
                              url: ...;
                              visible_in_picker: ...;
                          }[];
                          enable_rss: boolean;
                          favicon?: string;
                          fields: { name: ...; value: ...; verified_at: ... }[];
                          followers_count: number;
                          following_count: number;
                          fqn: string;
                          group: boolean;
                          header: string;
                          header_default: boolean;
                          header_description: string;
                          header_static: string;
                          hide_collections?: boolean;
                          hide_favorites: boolean;
                          hide_followers?: boolean;
                          hide_followers_count?: boolean;
                          hide_follows?: boolean;
                          hide_follows_count?: boolean;
                          id: string;
                          identity_proofs: { name: ...; value: ...; verified_at: ... }[];
                          indexable: boolean | null;
                          is_admin?: boolean;
                          is_cat: boolean;
                          is_moderator?: boolean;
                          is_suggested?: boolean;
                          last_status_at: string | null;
                          limited?: boolean;
                          local?: boolean;
                          location?: string;
                          locked: boolean;
                          memorial: boolean | null;
                          mention_policy: "none" | "only_known" | "only_contacts";
                          noindex: boolean | null;
                          note: string;
                          payment_options: ((...) | (...))[];
                          permit_followback?: boolean;
                          pronouns: string[];
                          relationship?: {
                              blocked_by: ...;
                              blocking: ...;
                              domain_blocking: ...;
                              endorsed: ...;
                              followed_by: ...;
                              following: ...;
                              id: ...;
                              languages: ...;
                              muting: ...;
                              muting_notifications: ...;
                              note: ...;
                              notifying: ...;
                              requested: ...;
                              showing_reblogs: ...;
                          };
                          roles: {
                              color: ...;
                              highlighted: ...;
                              id: ...;
                              name: ...;
                              permissions: ...;
                          }[];
                          speak_as_cat: boolean;
                          statuses_count: number;
                          subscribers_count: number;
                          suspended?: boolean;
                          url: string;
                          username: string;
                          verified?: boolean;
                      }
                      | null;
                  noindex: boolean
                  | null;
                  note: string;
                  payment_options: (
                      | {
                          href: (...)
                          | (...);
                          name: (...) | (...);
                          object_id: (...) | (...);
                          type: "link";
                      }
                      | {
                          amount_min: (...)
                          | (...);
                          chain_id: (...) | (...);
                          object_id: (...) | (...);
                          price: (...) | (...);
                          type: "monero-subscription";
                      }
                  )[];
                  permit_followback?: boolean;
                  pronouns: string[];
                  relationship?: {
                      blocked_by: boolean;
                      blocking: boolean;
                      domain_blocking: boolean;
                      endorsed: boolean;
                      followed_by: boolean;
                      following: boolean;
                      id: string;
                      languages: (...)[]
                      | null;
                      muting: boolean;
                      muting_notifications: boolean;
                      note: string;
                      notifying: boolean;
                      requested: boolean;
                      showing_reblogs: boolean;
                  };
                  roles: {
                      color: string;
                      highlighted: boolean;
                      id: string;
                      name: string;
                      permissions: string;
                  }[];
                  speak_as_cat: boolean;
                  statuses_count: number;
                  subscribers_count: number;
                  suspended?: boolean;
                  url: string;
                  username: string;
                  verified?: boolean;
              } & WithMoved;
              album: string;
              artist: string;
              created_at: string;
              external_link: string
              | null;
              id: string;
              length: number | null;
              title: string;
          },
          true,
      >,
  >

  Requests a list of current and recent Listen activities for an account

  Requires featuresFeatures.scrobbles

  See

  https://docs.pleroma.social/backend/development/API/pleroma_api/#get-apiv1pleromaaccountsidscrobbles

• loadActivities: (accountId: string) => Promise<EmptyObject>

  Load latest activities from outbox

  Requires featuresFeatures.loadActivities

• lookupAccount: (acct: string, meta?: RequestMeta) => Promise<Account>

  Lookup account ID from Webfinger address Quickly lookup a username to see if it is available, skipping WebFinger resolution.

  Requires featuresFeatures.accountLookup.

  See

  https://docs.joinmastodon.org/methods/accounts/#lookup

• pinAccount: (
      accountId: string,
  ) => Promise<
      {
          blocked_by: boolean;
          blocking: boolean;
          domain_blocking: boolean;
          endorsed: boolean;
          followed_by: boolean;
          following: boolean;
          id: string;
          languages: string[]
          | null;
          muting: boolean;
          muting_notifications: boolean;
          note: string;
          notifying: boolean;
          requested: boolean;
          showing_reblogs: boolean;
      },
  >

  Feature account on your profile Add the given account to the user’s featured profiles.

  See

  https://docs.joinmastodon.org/methods/accounts/#pin

• remoteInteraction: (ap_id: string, profile: string) => Promise<{ url: string }>

  Interact with profile or status from remote account

  Requires featuresFeatures.remoteInteractions.

  See

  https://docs.pleroma.social/backend/development/API/pleroma_api/#apiv1pleromaremote_interaction

• removeAccountFromFollowers: (
      accountId: string,
  ) => Promise<
      {
          blocked_by: boolean;
          blocking: boolean;
          domain_blocking: boolean;
          endorsed: boolean;
          followed_by: boolean;
          following: boolean;
          id: string;
          languages: string[]
          | null;
          muting: boolean;
          muting_notifications: boolean;
          note: string;
          notifying: boolean;
          requested: boolean;
          showing_reblogs: boolean;
      },
  >

  Remove account from followers Remove the given account from your followers.

  See

  https://docs.joinmastodon.org/methods/accounts/#remove_from_followers

• reportAccount: (
      accountId: string,
      params: ReportAccountParams,
  ) => Promise<
      {
          action_taken?: boolean;
          action_taken_at: string
          | null;
          category?: string;
          comment?: string;
          created_at?: string;
          forwarded?: boolean;
          id: string;
          rule_ids: string | null;
          status_ids: string | null;
          target_account: Account | null;
      },
  >

  File a report

  See

  https://docs.joinmastodon.org/methods/reports/#post

• searchAccounts: (
      q: string,
      params?: SearchAccountParams,
      meta?: RequestMeta,
  ) => Promise<Account[]>

  Search for matching accounts Search for matching accounts by username or display name.

  See

  https://docs.joinmastodon.org/methods/accounts/#search

• unfollowAccount: (
      accountId: string,
  ) => Promise<
      {
          blocked_by: boolean;
          blocking: boolean;
          domain_blocking: boolean;
          endorsed: boolean;
          followed_by: boolean;
          following: boolean;
          id: string;
          languages: string[]
          | null;
          muting: boolean;
          muting_notifications: boolean;
          note: string;
          notifying: boolean;
          requested: boolean;
          showing_reblogs: boolean;
      },
  >

  Unfollow account Unfollow the given account.

  See

  https://docs.joinmastodon.org/methods/accounts/#unfollow

• unpinAccount: (
      accountId: string,
  ) => Promise<
      {
          blocked_by: boolean;
          blocking: boolean;
          domain_blocking: boolean;
          endorsed: boolean;
          followed_by: boolean;
          following: boolean;
          id: string;
          languages: string[]
          | null;
          muting: boolean;
          muting_notifications: boolean;
          note: string;
          notifying: boolean;
          requested: boolean;
          showing_reblogs: boolean;
      },
  >

  Unfeature account from profile Remove the given account from the user’s featured profiles.

  See

  https://docs.joinmastodon.org/methods/accounts/#unpin

• updateAccountNote: (
      accountId: string,
      comment: string,
  ) => Promise<
      {
          blocked_by: boolean;
          blocking: boolean;
          domain_blocking: boolean;
          endorsed: boolean;
          followed_by: boolean;
          following: boolean;
          id: string;
          languages: string[]
          | null;
          muting: boolean;
          muting_notifications: boolean;
          note: string;
          notifying: boolean;
          requested: boolean;
          showing_reblogs: boolean;
      },
  >

  Set private note on profile Sets a private note on a user.

  See

  https://docs.joinmastodon.org/methods/accounts/#note