pl-api
    Preparing search index...

    Function instanceCategory

    • Parameters

      Returns {
          getCustomEmojis: () => Promise<
              {
                  category: string
                  | null;
                  shortcode: string;
                  static_url: string;
                  url: string;
                  visible_in_picker: boolean;
              }[],
          >;
          getFrontendConfigurations: () => Promise<
              { [key: string]: { [key: string]: any } },
          >;
          getInstance: () => Promise<
              Readonly<
                  {
                      account_domain: string;
                      api_versions: { [key: string]: number };
                      blockchains?: {
                          chain_id: string | null;
                          chain_metadata: {
                              description: string;
                              is_forwarding_required: boolean;
                              payment_amount_min: number;
                          };
                          features: { subscriptions: boolean };
                      }[];
                      configuration: {
                          accounts: | {
                              allow_custom_css: boolean;
                              max_featured_tags: number;
                              max_profile_fields: number;
                          }
                          | null;
                          chats: { max_characters: number };
                          groups: {
                              max_characters_description: number;
                              max_characters_name: number;
                          };
                          limited_federation?: boolean;
                          media_attachments: {
                              image_matrix_limit?: number;
                              image_size_limit?: number;
                              supported_mime_types?: string[];
                              video_duration_limit?: number;
                              video_frame_rate_limit?: number;
                              video_matrix_limit?: number;
                              video_size_limit?: number;
                          };
                          polls: {
                              max_characters_per_option: number;
                              max_expiration: number;
                              max_options: number;
                              min_expiration: number;
                          };
                          reactions: { max_reactions: number };
                          statuses: {
                              characters_reserved_per_url?: number;
                              max_characters: number;
                              max_media_attachments: number;
                          };
                          timelines_access: {
                              hashtag_feeds: {
                                  local: "disabled"
                                  | "public"
                                  | "authenticated";
                                  remote: "disabled" | "public" | "authenticated";
                              };
                              live_feeds: {
                                  bubble: "disabled"
                                  | "public"
                                  | "restricted"
                                  | "authenticated";
                                  local: "disabled" | "public" | "restricted" | "authenticated";
                                  remote: "disabled" | "public" | "restricted" | "authenticated";
                                  wrenched: "disabled" | "public" | "restricted" | "authenticated";
                              };
                              trending_link_feeds: {
                                  local: "disabled"
                                  | "public"
                                  | "authenticated";
                                  remote: "disabled" | "public" | "authenticated";
                              };
                          };
                          translation: { enabled: boolean };
                          urls: {
                              about: string | null;
                              privacy_policy: string | null;
                              status?: string;
                              streaming?: string;
                              terms_of_service: string | null;
                          };
                          vapid: { public_key: string };
                      };
                      contact: { contact_account?: Account; email: string };
                      description: string;
                      domain: string;
                      feature_quote: boolean;
                      icons: { size: string; src: string }[];
                      languages: string[];
                      pleroma: {
                          metadata: {
                              account_activation_required: boolean;
                              birthday_min_age: number;
                              birthday_required: boolean;
                              description_limit: number;
                              federation: {
                                  enabled: boolean;
                                  mrf_policies?: string[];
                                  mrf_simple: {
                                      accept: string[];
                                      avatar_removal: string[];
                                      banner_removal: string[];
                                      federated_timeline_removal: string[];
                                      followers_only: string[];
                                      media_nsfw: string[];
                                      media_removal: string[];
                                      reject: string[];
                                      reject_deletes: string[];
                                      report_removal: string[];
                                  };
                                  mrf_simple_info: {
                                      accept: [(...), (...)][];
                                      avatar_removal: [(...), (...)][];
                                      banner_removal: [(...), (...)][];
                                      federated_timeline_removal: [(...), (...)][];
                                      followers_only: [(...), (...)][];
                                      media_nsfw: [(...), (...)][];
                                      media_removal: [(...), (...)][];
                                      reject: [(...), (...)][];
                                      reject_deletes: [(...), (...)][];
                                      report_removal: [(...), (...)][];
                                  };
                              };
                              fields_limits: {
                                  max_fields: number;
                                  name_length: number;
                                  value_length: number;
                              };
                              markup: { allow_headings: boolean; allow_inline_images: boolean };
                              migration_cooldown_period?: number;
                              multitenancy: {
                                  domains?: { domain: ...; id: ...; public: ... }[];
                                  enabled: boolean;
                              };
                              post_formats: string[];
                              restrict_unauthenticated: {
                                  activities: { local: boolean; remote: boolean };
                                  profiles: { local: boolean; remote: boolean };
                                  timelines: {
                                      bubble: boolean;
                                      federated: boolean;
                                      local: boolean;
                                      wrenched: boolean;
                                  };
                              };
                              translation: {
                                  allow_remote: boolean;
                                  allow_unauthenticated: boolean;
                                  source_languages?: string[];
                                  target_languages?: string[];
                              };
                          };
                          oauth_consumer_strategies: string[];
                          stats: { mau?: number };
                          vapid_public_key: string;
                      };
                      registrations: {
                          approval_required: boolean;
                          enabled: boolean;
                          message?: string;
                          min_age: number
                          | null;
                          reason_required: boolean | null;
                          url: string | null;
                      };
                      rules: {
                          hint: string;
                          id: string;
                          text: string;
                          translations?: { [key: string]: { hint: string; text: string } };
                      }[];
                      stats: {
                          domain_count?: number;
                          status_count?: number;
                          user_count?: number;
                      };
                      thumbnail: { url: string };
                      title: string;
                      usage: { users: { active_month: number } };
                      version: string;
                  },
              >,
          >;
          getInstanceActivity: () => Promise<
              {
                  logins: string;
                  registrations: string;
                  statuses: string;
                  week: string;
              }[],
          >;
          getInstanceDomainBlocks: () => Promise<
              {
                  comment?: string;
                  digest: string;
                  domain: string;
                  severity: "silence"
                  | "suspend";
              }[],
          >;
          getInstanceExtendedDescription: () => Promise<
              { content: string; updated_at: string },
          >;
          getInstancePeers: () => Promise<string[]>;
          getInstancePrivacyPolicy: () => Promise<
              { content: string; updated_at: string },
          >;
          getInstanceRules: () => Promise<
              {
                  hint: string;
                  id: string;
                  text: string;
                  translations?: { [key: string]: { hint: string; text: string } };
              }[],
          >;
          getInstanceTermsOfService: () => Promise<
              {
                  content: string;
                  effective: boolean;
                  effective_date: string;
                  succeeded_by: string
                  | null;
              },
          >;
          getInstanceTermsOfServiceForDate: (
              date: string,
          ) => Promise<
              {
                  content: string;
                  effective: boolean;
                  effective_date: string;
                  succeeded_by: string
                  | null;
              },
          >;
          getInstanceTranslationLanguages: () => Promise<{ [k: string]: string[] }>;
          profileDirectory: (params?: ProfileDirectoryParams) => Promise<Account[]>;
      }

      • getCustomEmojis: () => Promise<
            {
                category: string
                | null;
                shortcode: string;
                static_url: string;
                url: string;
                visible_in_picker: boolean;
            }[],
        >

        View all custom emoji Returns custom emojis that are available on the server.

      • getFrontendConfigurations: () => Promise<{ [key: string]: { [key: string]: any } }>

        Dump frontend configurations

        Requires featuresFeatures.frontendConfigurations.

      • getInstance: () => Promise<
            Readonly<
                {
                    account_domain: string;
                    api_versions: { [key: string]: number };
                    blockchains?: {
                        chain_id: string | null;
                        chain_metadata: {
                            description: string;
                            is_forwarding_required: boolean;
                            payment_amount_min: number;
                        };
                        features: { subscriptions: boolean };
                    }[];
                    configuration: {
                        accounts: | {
                            allow_custom_css: boolean;
                            max_featured_tags: number;
                            max_profile_fields: number;
                        }
                        | null;
                        chats: { max_characters: number };
                        groups: {
                            max_characters_description: number;
                            max_characters_name: number;
                        };
                        limited_federation?: boolean;
                        media_attachments: {
                            image_matrix_limit?: number;
                            image_size_limit?: number;
                            supported_mime_types?: string[];
                            video_duration_limit?: number;
                            video_frame_rate_limit?: number;
                            video_matrix_limit?: number;
                            video_size_limit?: number;
                        };
                        polls: {
                            max_characters_per_option: number;
                            max_expiration: number;
                            max_options: number;
                            min_expiration: number;
                        };
                        reactions: { max_reactions: number };
                        statuses: {
                            characters_reserved_per_url?: number;
                            max_characters: number;
                            max_media_attachments: number;
                        };
                        timelines_access: {
                            hashtag_feeds: {
                                local: "disabled"
                                | "public"
                                | "authenticated";
                                remote: "disabled" | "public" | "authenticated";
                            };
                            live_feeds: {
                                bubble: "disabled"
                                | "public"
                                | "restricted"
                                | "authenticated";
                                local: "disabled" | "public" | "restricted" | "authenticated";
                                remote: "disabled" | "public" | "restricted" | "authenticated";
                                wrenched: "disabled" | "public" | "restricted" | "authenticated";
                            };
                            trending_link_feeds: {
                                local: "disabled"
                                | "public"
                                | "authenticated";
                                remote: "disabled" | "public" | "authenticated";
                            };
                        };
                        translation: { enabled: boolean };
                        urls: {
                            about: string | null;
                            privacy_policy: string | null;
                            status?: string;
                            streaming?: string;
                            terms_of_service: string | null;
                        };
                        vapid: { public_key: string };
                    };
                    contact: { contact_account?: Account; email: string };
                    description: string;
                    domain: string;
                    feature_quote: boolean;
                    icons: { size: string; src: string }[];
                    languages: string[];
                    pleroma: {
                        metadata: {
                            account_activation_required: boolean;
                            birthday_min_age: number;
                            birthday_required: boolean;
                            description_limit: number;
                            federation: {
                                enabled: boolean;
                                mrf_policies?: string[];
                                mrf_simple: {
                                    accept: string[];
                                    avatar_removal: string[];
                                    banner_removal: string[];
                                    federated_timeline_removal: string[];
                                    followers_only: string[];
                                    media_nsfw: string[];
                                    media_removal: string[];
                                    reject: string[];
                                    reject_deletes: string[];
                                    report_removal: string[];
                                };
                                mrf_simple_info: {
                                    accept: [(...), (...)][];
                                    avatar_removal: [(...), (...)][];
                                    banner_removal: [(...), (...)][];
                                    federated_timeline_removal: [(...), (...)][];
                                    followers_only: [(...), (...)][];
                                    media_nsfw: [(...), (...)][];
                                    media_removal: [(...), (...)][];
                                    reject: [(...), (...)][];
                                    reject_deletes: [(...), (...)][];
                                    report_removal: [(...), (...)][];
                                };
                            };
                            fields_limits: {
                                max_fields: number;
                                name_length: number;
                                value_length: number;
                            };
                            markup: { allow_headings: boolean; allow_inline_images: boolean };
                            migration_cooldown_period?: number;
                            multitenancy: {
                                domains?: { domain: ...; id: ...; public: ... }[];
                                enabled: boolean;
                            };
                            post_formats: string[];
                            restrict_unauthenticated: {
                                activities: { local: boolean; remote: boolean };
                                profiles: { local: boolean; remote: boolean };
                                timelines: {
                                    bubble: boolean;
                                    federated: boolean;
                                    local: boolean;
                                    wrenched: boolean;
                                };
                            };
                            translation: {
                                allow_remote: boolean;
                                allow_unauthenticated: boolean;
                                source_languages?: string[];
                                target_languages?: string[];
                            };
                        };
                        oauth_consumer_strategies: string[];
                        stats: { mau?: number };
                        vapid_public_key: string;
                    };
                    registrations: {
                        approval_required: boolean;
                        enabled: boolean;
                        message?: string;
                        min_age: number
                        | null;
                        reason_required: boolean | null;
                        url: string | null;
                    };
                    rules: {
                        hint: string;
                        id: string;
                        text: string;
                        translations?: { [key: string]: { hint: string; text: string } };
                    }[];
                    stats: {
                        domain_count?: number;
                        status_count?: number;
                        user_count?: number;
                    };
                    thumbnail: { url: string };
                    title: string;
                    usage: { users: { active_month: number } };
                    version: string;
                },
            >,
        >

        View server information Obtain general information about the server.

      • getInstanceActivity: () => Promise<
            {
                logins: string;
                registrations: string;
                statuses: string;
                week: string;
            }[],
        >

        Weekly activity Instance activity over the last 3 months, binned weekly.

      • getInstanceDomainBlocks: () => Promise<
            {
                comment?: string;
                digest: string;
                domain: string;
                severity: "silence"
                | "suspend";
            }[],
        >

        View moderated servers Obtain a list of domains that have been blocked.

      • getInstanceExtendedDescription: () => Promise<{ content: string; updated_at: string }>

        View extended description Obtain an extended description of this server

      • getInstancePeers: () => Promise<string[]>

        List of connected domains Domains that this instance is aware of.

      • getInstancePrivacyPolicy: () => Promise<{ content: string; updated_at: string }>

        View privacy policy Obtain the contents of this server's privacy policy.

      • getInstanceRules: () => Promise<
            {
                hint: string;
                id: string;
                text: string;
                translations?: { [key: string]: { hint: string; text: string } };
            }[],
        >

        List of rules Rules that the users of this service should follow.

      • getInstanceTermsOfService: () => Promise<
            {
                content: string;
                effective: boolean;
                effective_date: string;
                succeeded_by: string
                | null;
            },
        >

        View terms of service Obtain the contents of this server's terms of service, if configured.

      • getInstanceTermsOfServiceForDate: (
            date: string,
        ) => Promise<
            {
                content: string;
                effective: boolean;
                effective_date: string;
                succeeded_by: string
                | null;
            },
        >

        View a specific version of the terms of service Obtain the contents of this server's terms of service, for a specified date, if configured.

      • getInstanceTranslationLanguages: () => Promise<{ [k: string]: string[] }>

        View translation languages Translation language pairs supported by the translation engine used by the server.

      • profileDirectory: (params?: ProfileDirectoryParams) => Promise<Account[]>

        View profile directory List accounts visible in the directory.

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

        Requires featuresFeatures.profileDirectory.