Game Objects
Game Objects represent individual board games that exist. Games are the main object for the API and you can find all the details about them in this document.
Game Object Example
This is an example of the full object.https://api.boardgameatlas.com/api/search?ids=TAAifFP590&client_id=
Properties
These are all the properties that are found in the Game Object.
Property | Type | Example | Details |
---|---|---|---|
id | String | TAAifFP590 | The id of the game in the 5CC database. |
name | String | Root | The name of the game. |
names | Array | ['Catan'] | A list of any alternate spellings or different languages for the game name. |
year_published | Int | 2018 | The year the game was published. |
min_players | Int | 2 | The minimum number of players in the game. |
max_players | Int | 4 | The maximum number of players in the game. |
min_playtime | Int | 30 | Minimum minutes of playtime in the game. |
max_playtime | Int | 45 | Maximum minutes of playtime in the game. |
min_age | Int | 10 | Minimum recommended age for the game. |
description | String | "<h1>This game is fantastic</h1>" | The provided description for the game. |
description_preview | String | "This game is fantastic" | The provided description for the game with all html tags removed. |
thumb_url | String | https://www.5cc.co... | A small sized image of the game. |
image_url | String | https://www.5cc.co... | A large sized image of the game. |
url | String | https.../game/TAAifFP590 | The link to the game's page. |
price | Float | 19.99 | The lowest current price of the game |
msrp | Float | 24.99 | The listed msrp of the game |
discount | Float | 0.50 | The percent discount the game's current price compared to the msrp. This example shows a 50% discount. |
primary_publisher | String | 5 Color Combo | The designated primary publisher for the board game. Typically it's the current US publisher. |
publishers | Array | ['5 Color Combo'] | All listed publishers for the game. |
mechanics | Array | [{ id: "3k2jr01k" }, { id: "e2ji01j10"}] | These are the ids for the mechanics of the game. Get the names with /api/docs/game/mechanics |
categories | Array | [{ id: "3k2jr01k" }, { id: "e2ji01j10"}] | These are the ids for the categories of the game. Get the names with /api/docs/game/categories |
designers | Array | ['Trent Ellingsen'] | A list of names of all the designers for the board game. |
developers | Array | ['Eddie Kesicki'] | A list of names of all the developers for the board game. (People who work on balance and small adjustments) |
artists | Array | ['Chris McCoy'] | A list of names of all the artists for the board game. |
reddit_all_time_count | Int | 814 | The number of times the game has been mentioned as bold text on /r/boardgames in comments since September 2018. |
reddit_week_count | Int | 42 | The number of times the game has been mentioned as bold text on /r/boardgames in comments since 7 days ago. |
reddit_day_count | Int | 33 | The number of times the game has been mentioned as text (bold or not bold) on /r/boardgames in comments since since 1 day ago. |