Discovery

Discovery is a feature that allows users to find and join new communities on Discord, open to all guilds that meet the requirements. Discovery happens within the client or the marketing page.

Discord utilizes Algolia to power search for discovery. You can search for guilds by name, description, keywords, and more. Reference the Algolia Search documentation for more information on how to search. A proxied version of the Algolia Search API is available, with limited parameter support.

These credentials are for production only.

Application ID: NKTZZ4AIZU
API Key: aca0d7082e4e63af5ba5917d5e96bed0

A partial guild object returned from discovery, Get Emoji Guild, and Get Sticker Guild endpoints.

¹ The presence of these fields is dependent on the endpoint used to retrieve the guild. Get Emoji Guild will return emoji-related fields, and Get Sticker Guild will return sticker-related fields.

² These fields are only returned when using the Get Discovery Slug endpoint.

³ These fields are only returned when searching discovery.

{
  "id": "752630786561409076",
  "name": "Elite Creative",
  "description": "The largest Fortnite Creative server across the globe. Join a Creative community offering events, 1v1s. and more!",
  "icon": "278da1c7740e394657c1179f4782aef1",
  "splash": "2b4ae5cdd71038b4880b1b57a6e5dacb",
  "banner": "57e939e67aebaf232d28205603020b55",
  "approximate_presence_count": 21125,
  "approximate_member_count": 155455,
  "premium_subscription_count": 17,
  "preferred_locale": "en-US",
  "auto_removed": false,
  "discovery_splash": "9d7ec672b89b320ef7a51e5b6ae453b8",
  "primary_category_id": 1,
  "vanity_url_code": "creative",
  "is_published": true,
  "keywords": [
    "Fortnite",
    "Creative",
    "Fortnite Creative",
    "Boxfights",
    "Zonewars",
    "Buildfights",
    "1v1",
    "EU",
    "NA",
    "Creator"
  ],
  "features": [
    "ANIMATED_BANNER",
    "ANIMATED_ICON",
    "AUTO_MODERATION",
    "BANNER",
    "COMMUNITY",
    "DISCOVERABLE",
    "ENABLED_DISCOVERABLE_BEFORE",
    "GUILD_ONBOARDING_EVER_ENABLED",
    "GUILD_WEB_PAGE_VANITY_URL",
    "INVITE_SPLASH",
    "NEWS",
    "PREVIEW_ENABLED",
    "RAID_ALERTS_ENABLED",
    "ROLE_ICONS",
    "VANITY_URL",
    "WELCOME_SCREEN_ENABLED"
  ],
  "emojis": [],
  "emoji_count": 339
}

A guild's progress on meeting the requirements of joining discovery.

¹ Certain guilds, such as those that are verified, are exempt from discovery requirements. These guilds will not have a fully populated discovery requirements object, and are guaranteed to receive only sufficient and sufficient_without_grace_period.

{
  "guild_id": "1046920999469330512",
  "safe_environment": true,
  "healthy": true,
  "health_score_pending": false,
  "size": true,
  "nsfw_properties": {
    "channels": ["1060703057651978261"],
    "channels_banned_keywords": {
      "1060703057651978261": ["risque"]
    },
    "name": "Alien Network",
    "name_banned_keywords": ["alien"],
    "description": "Where the 👽s 👽 and sometimes very 👽 things happen 😨.",
    "description_banned_keywords": ["👽"]
  },
  "protected": true,
  "sufficient": false,
  "sufficient_without_grace_period": true,
  "valid_rules_channel": true,
  "retention_healthy": true,
  "engagement_healthy": true,
  "age": true,
  "minimum_age": 56,
  "health_score": {
    "avg_nonnew_participators": "1738",
    "avg_nonnew_communicators": "348",
    "num_intentful_joiners": "834",
    "perc_ret_w1_intentful": 0.37651924871356596
  },
  "minimum_size": 1000,
  "grace_period_end_date": "2037-07-01T17:47:49.974000+00:00"
}

A guild's discovery settings.

{
  "guild_id": "1046920999469330512",
  "primary_category_id": 49,
  "keywords": ["test"],
  "emoji_discoverability_enabled": true,
  "partner_actioned_timestamp": null,
  "partner_application_timestamp": null,
  "is_published": false,
  "reasons_to_join": [
    { "reason": "Alien", "emoji_id": null, "emoji_name": "👽" },
    { "reason": "Alien", "emoji_id": null, "emoji_name": "👽" },
    { "reason": "Alien", "emoji_id": null, "emoji_name": "👽" },
    { "reason": "Alien", "emoji_id": null, "emoji_name": "👽" }
  ],
  "social_links": ["https://twitter.com/alien"],
  "about": "Alien\nAlien\nAlien\nAlien\nAlien\nAlien",
  "category_ids": [48]
}

{
  "id": 1,
  "name": "Gaming",
  "is_primary": true
}

Returns a list of discoverable guild objects representing the guilds that are available for the current user to discover.

¹ Only one of guild_ids, application_ids, or categories may be specified. If both are specified, only guild_ids or application_ids is respected.

² Pagination parameters are ignored if guild_ids or application_ids are specified.

Returns a list of discoverable guild objects representing the guilds that match the query. This endpoint is a proxy for searching using the Algolia API. See the Algolia Search documentation for more information.

Returns information about a guild's landing web page or monetization store page. This endpoint requires the guild to either be discoverable and published or have the CREATOR_STORE_PAGE guild feature.

Returns a list of discovery category objects representing the available discovery categories.

Checks if a discovery search term is allowed.

{ "valid": true }

Returns the discovery requirements object for the guild. Requires the MANAGE_GUILD permission.

Returns the discovery metadata object for the guild. Requires the MANAGE_GUILD permission.

Replaces the discovery metadata for the guild. Requires the MANAGE_GUILD permission. Returns the updated discovery metadata object on success.

Adds a discovery subcategory to the guild. Requires the MANAGE_GUILD permission. Returns a 204 empty response on success.

Removes a discovery subcategory from the guild. Requires the MANAGE_GUILD permission. Returns a 204 empty response on success.