A JSON rest service for interacting with Board game geek (including geeklists). The service wraps retrying BGG until data is returned (or timeouts occur) and filters out unwanted games based on headers passed.
The API suite consists of the following endpoints:
/collection/<username>
If the user is not found the service will return a 404.
/geeklist/<geek_list>
If the geeklist is not found or empty the service will return a 404.
/search/<string>
Requests are cached on the Board Game Geek library. Each API request is cached for a duration of 24 hours.
Each game is cached individually. When a collection or geeklist is loaded we first check the sqlite db for cached entries, those not found are retrieved and stored in the cache for the next request. By default we cache games for a week.
The collection and geek list APIs can be filtered and the response reduced using the following headers.
| Header Name | Value Type | Description |
|---|---|---|
| Bgg-Filter-Player-Count | Int | Number of players game must support |
| Bgg-Filter-Min-Duration | Int | Game must last at least this long |
| Bgg-Filter-Max-Duration | Int | Game must not last longer than this |
| Bgg-Filter-Using-Recommended-Players | Boolean | Whether or not to use user recommended player counts |
| Bgg-Include-Expansions | Boolean | Do we include expansions or not in the game list |
| Bgg-Filter-Max-Complexity | Float | Maximum game difficulty (out of 5) |
| Bgg-Filter-Mechanic | String | Game mechanic, as defined by BGG, e.g. "[Cooperative Play]" |
| Bgg-Field-Whitelist | String | Comma separated list of fields to include in the game response list |