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.5colorcombo.com/api/search?name=Catan

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.
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.
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.