Games

The games APIs further extend applications resources to power advanced game detection and rich presence features.

Detectable Application Object

Detectable Application Structure

Field	Type	Description
id	snowflake	The ID of the application
name	string	The name of the application
icon_hash?	?string	The application's icon hash
cover_image_hash?	?string	The application's default rich presence invite cover image hash
aliases	array[string]	Other names the application's game is associated with
executables	array[application executable object]	The unique executables of the application's game
themes	array[string]	The themes of the application's game
hook	boolean	Whether the Discord client is allowed to hook into the application's game directly
overlay	boolean	Whether the application's game supports the Discord overlay (default false)
overlay_methods	?integer	The methods of overlaying that the application's game supports
overlay_warn	boolean	Whether the Discord overlay is known to be problematic with this application's game (default false)
overlay_compatibility_hook	boolean	Whether to use the compatibility hook for the overlay (default false)
linked_applications?	array[linked application object]	The other applications linked to this application

Linked Application Structure

Field	Type	Description
id	snowflake	The ID of the application
type	integer	The type of linked application

Linked Application Type

Value	Name	Description
1	LINKED	Application is linked
2	OFFICIAL	Application is official
3	NVIDIA	Application is on NVIDIA GeForce NOW

Example Detectable Application

{
  "aliases": ["PUBG: BATTLEGROUNDS", "PUBG"],
  "executables": [
    {
      "is_launcher": false,
      "name": "win64/tslgame_be.exe",
      "os": "win32"
    },
    {
      "is_launcher": false,
      "name": "win64/tslgame.exe",
      "os": "win32"
    },
    {
      "is_launcher": false,
      "name": "tslgame.exe",
      "os": "win32"
    },
    {
      "is_launcher": false,
      "name": "win64/tslgame_uc.exe",
      "os": "win32"
    },
    {
      "is_launcher": false,
      "name": "tslgame_be.exe",
      "os": "win32"
    }
  ],
  "hook": true,
  "id": "356873622985506820",
  "name": "PLAYERUNKNOWN'S BATTLEGROUNDS",
  "overlay": true,
  "overlay_compatibility_hook": true,
  "overlay_methods": null,
  "overlay_warn": false,
  "themes": ["Action", "Warfare"]
}

Application Executable Object

Application Executable Structure

Field	Type	Description
os	string	The operating system the executable can be found on
name	string	The name of the executable
is_launcher	boolean	Whether the executable is for a game launcher

Example Application Executable

{
  "os": "win32",
  "name": "spaceship looter/spaceship_looter.exe",
  "is_launcher": false
}

Application SKU Object

Application SKU Structure

Field	Type	Description
id	?string	The ID of the game
sku	?string	The SKU of the game
distributor	string	The distributor of the game

Distributor Type

Value	Description
discord	Discord Store
steam	Steam
twitch	Twitch
uplay	Ubisoft Connect
battlenet	Battle.net
origin	Origin
gog	GOG.com
epic	Epic Games Store
microsoft	Microsoft Store
igdb	IGDB.com
glyph	Glyph.net
google_play	Google Play Store
nvidia_gdn_app	NVIDIA Cloud Gaming
gop	Gameopedia
roblox	Roblox Game
gdco	GameDiscover.co
xbox	Xbox Store
playstation	PlayStation Store
opencritic	OpenCritic

Example Application SKU

{
  "id": "445220",
  "sku": "445220",
  "distributor": "steam"
}

Game Object

This structure is a superset of the detectable application object above with the following additional fields:

Field	Type	Description
supplemental_game_data?	game data object	The supplemental game data
genres?	array[integer]	The genres of the game
platforms?	array[integer]	The platforms that the game is available on
websites?	array[game website object]	The websites relating to the game
companies	array[company object]	The companies working on the game
screenshot_hashes?	array[string]	The game's screenshot hashes
screenshot_urls?	array[string]	The URLs to the game screenshots
trailers?	array[store asset object]	The game trailers
l30_rank?	integer	The popularity rank of the game over a 30-day window

Game Website Structure

Field	Type	Description
url	string	The URL of the website
category	integer	The category of website

Game Website Category

Value	Name	Description
1	OFFICIAL	Official game website
2	WIKIA	Fandom
3	WIKIPEDIA	Wikipedia
4	FACEBOOK	Facebook
5	TWITTER	Twitter
6	TWITCH	Twitch
8	INSTAGRAM	Instagram
9	YOUTUBE	YouTube
10	IPHONE	iPhone
11	IPAD	iPad
12	ANDROID	Android
13	STEAM	Steam
14	REDDIT	Subreddit
15	ITCH	Itch.io
16	EPICGAMES	Epic Games Store
17	GOG	GOG
18	DISCORD	Discord server
19	BLUESKY	Bluesky
20	BATTLENET	Battle.net
21	RIOT	Riot Games
22	ROBLOX	Roblox
23	MINECRAFT	Minecraft

Company Structure

Field	Type	Description
name	string	The name of the company
roles	array[integer]	The roles of the company

Game Data Structure

Field	Type	Description
application_id	snowflake	The ID of the game application
igdb_game_id	?string	The ID of the game on IGDB
name	string	The name of the application
summary?	?string	The summary of the game
summary_localized?	?string	The localized summary of the game
websites?	array[game website object]	The websites relating to the game
themes?	array[integer]	The themes of the game
genres?	array[integer]	The genres of the game
platforms?	array[integer]	The platforms that the game is available on
artwork_urls?	array[string]	The URLs to the game artworks
screenshot_urls?	array[string]	The URLs to the game screenshots
icon_hash?	?string	The game's icon hash
cover_image_url?	?string	The URL to the game's default rich presence invite cover image
first_release_date?	?ISO8601 timestamp	When the game first released
publisher_names?	array[string]	The names of the game publishers
developer_names?	array[string]	The names of the game developers
trailers?	array[store asset object]	The game trailers
shop_collection_ids?	array[snowflake]	The IDs of the storefront collections
steam_release_status?	integer	The game release status on Steam
reviews?	game data reviews	The reviews of the game
opencritic_url?	string	The URL to reviews on OpenCritic
steam_id?	string	The ID of the game on Steam
announcements_channel_id?	snowflake	The ID of the announcements channel
l30_rank	integer	The popularity rank of the game over a 30-day window
game_flags?	integer	The game's flags

Game Data Reviews Structure

Field	Type	Description
steam?	game data steam reviews object	The reviews on Steam
opencritic?	game data opencritic reviews object	The reviews on OpenCritic

Game Data Steam Reviews Structure

Field	Type	Description
rating?	float	Overall positive review ratio for the game across all time, as a value between 0 and 1
rating_count?	integer	Total number of reviews submitted across all time
recent_rating?	float	Positive review ratio calculated from reviews submitted in the last 30 days, as a value between 0 and 1
recent_rating_count?	integer	Total number of reviews submitted in the last 30 days
localized_rating?	float	Positive review ratio filtered to reviews written in the user's locale, as a value between 0 and 1
localized_rating_count?	integer	Total number of reviews written in the user's locale

Game Data OpenCritic Reviews Structure

Field	Type	Description
top_critic_rating	?integer	The rating on OpenCritic
top_critic_rating_count	?integer	Number of reviews on OpenCritic
tier	?integer	The tier of the game on OpenCritic

OpenCritic Tier

Value	Name	Description
1	MIGHTY	Mighty
2	STRONG	Strong
3	FAIR	Fair
4	WEAK	Weak

Game Theme Type

Value	Name	Description
0	THRILLER	Thriller
1	SCIENCE_FICTION	Science fiction
2	ACTION	Action
3	HORROR	Horror
4	SURVIVAL	Survival
5	FANTASY	Fantasy
6	HISTORICAL	Historical
7	STEALTH	Stealth
8	COMEDY	Comedy
9	BUSINESS	Business
10	DRAMA	Drama
11	NON_FICTION	Non fiction
12	KIDS	Kids
13	SANDBOX	Sandbox
14	OPEN_WORLD	Open world
15	WARFARE	Warfare
16	EDUCATIONAL	Educational
17	MYSTERY	Mystery
18	PARTY	Party
19	ROMANCE	Romance
20	EROTIC	Erotic

Game Platform Type

Value	Name	Description
0	DESKTOP	Game is available on desktop
1	XBOX	Game is available on Xbox
2	PLAYSTATION	Game is available on PlayStation
3	IOS	Game is available on iOS
4	ANDROID	Game is available on Android
5	NINTENDO	Game is available on Nintendo Switch
6	LINUX	Game is available on Linux
7	MACOS	Game is available on macOS

Steam Release Status

Value	Name	Description
1	PRE_RELEASE	Pre-release
2	DAY_OF_RELEASE	Day of release
3	POST_RELEASE	Post-release
4	RETIRED_ABANDONED	Retired/abandoned
6	CHILD_APP	Child application

Game Flags

Value	Name	Description
1 << 0	GAME_PROFILE_DISABLED	The game profile is disabled

Game Claim Object

Game Claim Structure

Field	Type	Description
game_id	snowflake	The ID of the unclaimed game application
application_id	snowflake	The ID of the application
claim_status	string	The game claim status
third_party_urls?	array[third party URL object]	The URLs to third-party sources
updated_at	ISO8601 timestamp	When the game claim was updated
invite_proof	string	The code for invite ownership proof

Third Party URL Structure

Field	Type	Description
distributor	string	The distributor of the game
url	string	The URL of the game

Game Claim Status

Value	Description
not_started	Game claim is not started
ready_to_process	Game claim is ready to process
fetching_official_guild	Official guild is being fetched
has_fetched_official_guild	Official guild is fetched
awaiting_verification_code	Awaiting verification code
verification_passed	Verification was passed
claim_approved	Game claim was approved
claim_rejected	Game claim was rejected
claim_revoked	Game claim was revoked
failed_no_game	The game was found
failed_no_application	The application was found
failed_no_team	The team was found
failed_to_fetch_official_guild_from_third_parties	Failed to fetch official guild
failed_no_official_guild_found	Official guild was not found
failed_multiple_official_guilds_found	Multiple official guilds were found
failed_invite_proof_missing	Invite proof is missing
failed_invite_proof_invalid	Invite proof is invalid
failed_official_guild_owner_not_found	Owner of official guild owner is not found
failed_official_guild_owner_not_on_team	Owner of official guild owner is not on team
failed_official_guild_owner_mfa_not_enabled	Owner of official guild owner does not have MFA enabled
failed_verification_code_sent_too_recently	Verification code was sent too recently
failed_verification_code_not_sent	Verification code was not sent
failed_verification_code_invalid	Verification code is invalid
failed_unknown	Unknown

Endpoints

Get Application Game Claims

GET/applications/{application.id}/game-claims

Returns a list of game claim objects for the given application ID.

Get Application Game Claim

GET/applications/{application.id}/game-claims/{game_claim.id}

Returns a game claim object for the given application ID.

Create Application Game Claim

PUT/applications/{application.id}/game-claims/{game.id}

Creates a game claim for the given application ID. Returns a game claim object on success. May fire a Guild Official Game Applications Update Gateway event.

Query String Params

Field	Type	Description
verification_code?	string	The verification code (max 8 characters)
reset_verification?	boolean	Whether to reset verification (default false)
resend_verification_code?	boolean	Whether to resend the verification code (default false)
full_name?	string	Full legal name of the applicant (max 100 characters)
business_email?	string	Business email of the applicant (max 320 characters)
business_role?	string	Business role of the applicant (max 100 characters)
business_website?	string	The business website (max 256 characters)

Modify Application Game Claim

PATCH/applications/{application.id}/game-claims/{game_claim.id}

Modifies the game claim. Returns a game claim object on success.

JSON Params

Field	Type	Description
announcements_channel_id?	?snowflake	The ID of the announcements channel

Delete Application Game Claim

DELETE/applications/{application.id}/game-claims/{game_claim.id}

Deletes the given game claim. Returns a 204 empty response.

Get Detectable Non Game Applications

GET/applications/non-games/detectable

Returns a list of detectable application objects representing non-games that can be detected by Discord for rich presence.

Get Detectable Games

GET/games/detectable

Returns a list of detectable application objects representing games that can be detected by Discord for rich presence.

Get Detectable Game Exclusions

GET/games/detectable/exclusions

Returns the patterns which should be ignored when detecting games.

Response Body

Field	Type	Description
executables	array[string]	Names of ignored processes
patterns	array[string]	Regular expression patterns to match against process names

Get Games

GET/games

Returns a list of game objects for the given application IDs.

Query String Params

Field	Type	Description
game_ids	array[snowflake]	The IDs of the applications (1-25)
with_supplemental_data?	boolean	Whether to include supplemental game data (default true)

Get Game

GET/games/{game.id}

Returns a game object for the given application ID.

Query String Params

Field	Type	Description
with_supplemental_data?	boolean	Whether to include supplemental game data (default true)

Get Game Announcements

GET/games/{game.id}/announcements

Returns messages in the game's announcements channel.

Query String Params

Field	Type	Description
limit	integer	Max number of messages to return (1-50, default 50)

Response Body

Field	Type	Description
guild_id	?snowflake	The ID of the guild
channel_id	?snowflake	The ID of the channel
messages	array[message object]	The messages in the announcements channel