Everything you need to know about the boardapi is right here
Overview
In order to access the boardapi, you will need to register for an api key, which should be included in the header of every request.
Once you have your key, you will be able to access the data of over 21,000 boardgames.
Endpoints
There are currently three main endpoints:
- /boardgames
- /gamename
- /random
More information can be found on each endpoint below.
Query Parameters
There are currently nine query parameters you can use to customise and filter your request. All query params must be formatted as follows;
"/boardgames?queryparam=value"Eg.
"/boardgames?maxplayers=4" or "/boardgames?playtime=120"Query parameters can be chained together using "&";
"/boardgames?maxplayers=4&playtime=120"| Field | Description | Type |
|---|---|---|
gamedescription | Returns the description for each boardgame as a string if true. On the primary endpoint, this is set to false by default for better readability of large data sets. However, in the /gamname and /random endpoints, it is a permanent fixture. | Boolean |
maxplayers | Returns all boardgames where the max_players field equals the given value. | Integer |
playtime | Returns all boardgames where the play_time field equals the given value. Value should be entered in minutes only. Eg. 60 for 1 hour. | Integer |
yearpublished | Returns all boardgames where the year_published field equals the given value. | Integer |
gamecategory | Returns all boardgames where the game_category array contains the given value. | String |
gamemechanic | Returns all boardgames where the game_mechanic array contains the given value. | String |
gamedesigner | Returns all boardgames where the game_designer array contains the given value. | Integer |
page | Returns the given page. | Integer |
pagesize | Amends the total amount of results returned from the API. By default, this is set to 50 and cannot exceed 100. | Integer |
Note: The above query parameters are currently only available for use on the /boardgames primary endpoint. Compatibility with the /random endpoint will be implemented soon.