Application Directory
The application directory allows users to find fun and entertaining applications with special filters to tailor their experience and the kind of applications that are shown.
Application Directory Entry Object
Application Directory Entry Structure
| Field | Type | Description |
|---|---|---|
| guild_count | integer | Approximate number of guilds the application is in |
| carousel_items? | array[carousel items object] | The media to show with the application |
| supported_locales | array[string] | The locales supported by the application |
| external_urls? | array[external url object] | External links related to the application |
| popular_application_command_ids? | array[snowflake] | The IDs of the application's most popular application commands (max 5) |
| popular_application_commands? | array[application command object] | The application's most popular application commands (max 5) |
| detailed_description? | string | The detailed overview of the application |
| short_description | string | The short overview of the application |
| short_description_localizations? | ?map[string, string] | The short overview of the application for each locale |
| detailed_description_localizations? | ?map[string, string] | The detailed overview of the application for each locale |
Application Directory Carousel Item Structure
| Field | Type | Description |
|---|---|---|
| type | integer | The type of media |
| url | string | Source URL of the media |
| proxy_url | string | A proxied URL of the media |
Application Directory Carousel Item Type
| Value | Name | Description |
|---|---|---|
| 1 | IMAGE | Supports both static images and gifs |
| 2 | VIDEO | Supports both static videos and YouTube |
Application Directory External URL Structure
| Field | Type | Description |
|---|---|---|
| name | string | The name to display for the link |
| url | string | The URL to redirect the user to |
Application Directory Item Type
| Value | Name | Description |
|---|---|---|
| 1 | APPLICATION | A regular application that's shown |
| 2 | LINK | A directory entry that redirects to a link |
| 3 | APPLICATION_BANNER | A promotional application banner |
Application Directory Request Surface
| Value | Name | Description |
|---|---|---|
| 1 | APPLICATION_DIRECTORY | Application directory |
| 2 | APP_LAUNCHER_IN_TEXT | App Launcher |
| 3 | APP_LAUNCHER_IN_VOICE_BANNER | App Launcher within a voice context |
Application Directory Category Object
Application Directory Category Structure
| Field | Type | Description |
|---|---|---|
| id | integer | The numerical ID associated with the category |
| name | string | The category label |
Endpoints
Get Application Directory Categories
GET/application-directory-static/categoriesReturns a list of application directory category objects representing the available application categories.
Query String Params
| Field | Type | Description |
|---|---|---|
| locale? | string | The language to return categories in (default "en-US") |
Get Application Directory Collections
GET/application-directory-static/collectionsReturns a list of the available application directory collection objects.
Query String Params
| Field | Type | Description |
|---|---|---|
| surface? | integer | The request surface, used for analytics |
| active_state? 1 | integer | Filter applications by their directory active state (default ACTIVE) |
| platform? | integer | The platform to filter by |
| locale? | string | The language to return collections in (default "en-US") |
| cache? 1 | boolean | Whether to return cached results (default true) |
1 Only usable by Discord employees.
Application Directory Collection Structure
| Field | Type | Description |
|---|---|---|
| id | string | The ID of the collection |
| type | integer | The type of entry item it is |
| position | integer | The hierarchical order to make the collection appear in |
| platforms | integer | The platforms the collection supports |
| active_state | integer | Returns the active state of the application |
| flags | integer | The application flags |
| title | string | The collection's title |
| description | string | Short description of the collection |
| application_directory_collection_items | array[application directory collection item object] | The applications in the collection |
Application Directory Collection Item Structure
| Field | Type | Description |
|---|---|---|
| id | snowflake | The ID of the collection item |
| type | integer | The type of item |
| position | integer | The position of the item in the collection |
| flags | integer | The application flags |
| image_hash | ?string | The image hash of the item's banner image |
| application | application object | The application in the collection item |
Application Directory Active State Type
| Value | Name | Description |
|---|---|---|
| 0 | PREVIEW | Inactive and hidden from public view |
| 1 | ACTIVE | Active and can be seen by the public |
Application Directory Platform Flags
| Value | Name | Description |
|---|---|---|
| 1 << 0 | IOS | Application supports iOS clients |
| 1 << 1 | ANDROID | Application supports Android clients |
| 1 << 2 | WEB | Application supports web clients |
Get Application Directory Application
GET/application-directory-static/applications/{application.id}Returns a partial application object for the given ID.
Query String Params
| Field | Type | Description |
|---|---|---|
| locale? | string | The language to return application details in (default "en-US") |
| nocache? | boolean | Whether to bypass cache for the response (default false) |
| with_localizations? | boolean | Whether to also return localizations for the detailed and short descriptions (default false) |
Get Application Directory Application Embed
GET/application-directory/applications/{application.id}/embedReturns a partial application object for the given ID.
Query String Params
| Field | Type | Description |
|---|---|---|
| with_localizations? | boolean | Whether to also return localizations for the detailed and short descriptions (default false) |
Get Application Directory Similar Applications
GET/application-directory-static/applications/{application.id}/similarReturns applications similar to the given application ID.
Query String Params
| Field | Type | Description |
|---|---|---|
| guild_id? | string | The ID of the guild the request originated from |
| page? | integer | The page to fetch results from (max 1000, default 1) |
| locale? | string | The language to return similar applications in (default "en-US") |
Response Body
| Field | Type | Description |
|---|---|---|
| applications | array[application] | Applications that are similar to the current application |
| num_pages | integer | The number of pages containing similar applications (max 1000) |
| load_id | string | The unique identifier for the application directory recommendations |
Search Applications Directory
GET/application-directory-static/searchReturns the application directory search results.
Query String Params
| Field | Type | Description |
|---|---|---|
| query? | string | The query to match (max 100 characters) |
| guild_id? | string | The ID of the guild the request originated from |
| page? | integer | The page to fetch results from (max 1000, default 1) |
| page_size? | integer | The limit of items per page (1-100) |
| category_id? | integer | The category to filter results by |
| locale? | string | The language to return search results in (default "en-US") |
| min_user_install_command_count? | integer | The minimum amount of application user installs to filter by (max 100) (default 0) |
| exclude_apps_with_custom_install_url? | boolean | Whether to exclude applications with custom_install_url (default false) |
| exclude_non_embedded_apps? | boolean | Whether to exclude applications without the EMBEDDED flag (default false) |
| exclude_embedded_apps_without_primary_entry_point_app_command? | boolean | Whether to exclude embedded applications without a primary entry point command (default false) |
| source? | integer | Where the request came from |
Response Body
| Field | Type | Description |
|---|---|---|
| results | results object | The results of the search |
| num_pages | integer | The total number of pages the search yielded (max 1000) |
| counts_by_category | map[integer, integer] | Total results per directory category ID |
| type | integer | The type of entry item it is |
| load_id | string | The unique identifier for the application directory search |
Application Directory Search Results Structure
| Field | Type | Description |
|---|---|---|
| type | integer | The type of entry |
| data | application object | The application associated with the result |