GET /api/search

Supported formats: json

Returns a list of Game Objects filtered by the parameters.

Example

This is an example where the search is narrowed by the name.

GEThttps://www.boardgameatlas.com/api/search?name=Catan&client_id=W0AQGbjlZE

Parameters

These are all the posible parameters to add to the search request to filter or change the results based on how each function.

ParameterTypeExampleDetails
limitNumber10Limits the number of results returned. The max limit is 100. The default is 30.
skipNumber10Skips the number of results provided. It's generally used for paging results.
idsArraySVQRjsXrhj,OIXt3DmJU0The exact ids of the games you want returned comma separated. If they exist, this will return the associated games.
listidStringY0m2bJsZMfThe list id from a user created game list. You can get user game lists from /api/lists.
nameStringLast StandName of a board game to search for. This search is based on the start of the strings.
exactBooleantrueUse to make the name field only return games that match the name exactly.
designerStringTrent EllingsenName of a board game designer to search for. This is an exact match parameter.
publisherString5 Color ComboName of the board game publisher to search for. This is an exact match parameter.
artistStringDimitri BielakName of an artist for a board game to search for. This is an exact match parameter.
mechanicsStringvZsDDAdOoe,WPytek5P8lA list of mechanic ids to search for. Get this list with /api/game/mechanics.
categoriesStringhBqZ3Ar4RJ,eX8uuNlQkQA list of category ids to search for. Get this list with /api/game/categories.
order_byStringyear_publishedProvide the name of another parameter and it will order the results according to it. The possible values include popularity, price, discount, reddit_week_count, reddit_day_count, name, year_publisher, min_age, min_playtime, max_playtime, min_players, max_players
ascendingBooleanfalseThis determines which direction the list is shown in based on the order_by parameter.
min_playersInt2Minimum number of players exactly matching the number.
max_playersInt4Maximum number of players exactly matching the number.
min_playtimeInt10Minimum number of minutes exactly matching the number.
max_playtimeInt30Maximum number of minutes exactly matching the number.
min_ageInt10Minimum age exactly matching the number.
year_publishedInt2018The year that a game was published.
gt_min_playersInt2Greater than the provided minimum number of players. The example will return 3 or more.
gt_max_playersInt4Greater than the provided maximum number of players. The example will return 5 or more.
gt_min_playtimeInt10Greater than the provided minimum minutes of playtime. The example will return 11 or more.
gt_max_playtimeInt30Greater than the provided maximum minutes of playtime. The example will return 31 or more.
gt_min_ageInt10Greater than the provided minimum recommended player age. The example will return 11 or more.
gt_year_publishedInt2017Greater than the provided year published. The example will return 2018 or more.
gt_priceFloat20Greater than game's lowest listed price.
gt_msrpFloat25Greater than game's listed MSRP price.
gt_discountFloat0.5Greater than game's listed discount percent of price compared to MSRP. The example would return games with a discount of greater than 50%.
gt_reddit_countInt30Greater than the number of times the game has been mentioned on /r/boardgames since we started tracking that data in September 2018.
gt_reddit_week_countInt10Greater than the number of times the game has been mentioned on /r/boardgames in the past 7 days.
gt_reddit_day_countInt5Greater than the number of times the game has been mentioned on /r/boardgames in the past 24 hours.
lt_min_playersInt3Less than the provided minimum number of players. The example will return 2 or less.
lt_max_playersInt5Less than the provided maximum number of players. The example will return 4 or less.
lt_min_playtimeInt10Less than the provided minimum minutes of playtime. The example will return 9 or less.
lt_max_playtimeInt30Less than the provided maximum minutes of playtime. The example will return 29 or less.
lt_min_ageInt10Less than the provided minimum recommended player age. The example will return 9 or less.
lt_year_publishedInt2017Less than the provided year published. The example will return 2016 or less.
lt_priceFloat20Less than game's lowest listed price.
lt_msrpFloat25Less than game's listed MSRP price.
lt_discountFloat0.5Less than game's listed discount percent of price compared to MSRP. The example would return games with a discount of less than 50%.
lt_reddit_countInt30Less than the number of times the game has been mentioned on /r/boardgames since we started tracking that data in September 2018.
lt_reddit_week_countInt10Less than the number of times the game has been mentioned on /r/boardgames in the past 7 days.
lt_reddit_day_countInt5Less than the number of times the game has been mentioned on /r/boardgames in the past 24 hours.
fieldsStringname,description,image_urlThis performs a select on the database where it will only return the parameters that are specified instead of the entire object.