The API provides readonly access to the adventure data hosted at this site. There are two API endpoints, both of which are described below.

Returns a paginated list of all adventures. Use the page query parameter to select the page (1-indexed, default 1). Note that the order of adventures is non-deterministic. The seed used for sorting changes once a week. Make sure to include the seed parameter retrieved with the response when querying further pages. You can use the q parameter to filter adventures by a search query. You can also filter adventures by specific fields similar to using the sidebar on the search page. The following fields are available:

• authors string
• edition string
• environments string
• items string
• publisher string
• setting string
• commonMonsters string
• bossMonsters string
• numPages integer
• minStartingLevel integer
• maxStartingLevel integer
• startingLevelRange string
• soloable boolean
• pregeneratedCharacters boolean
• handouts boolean
• tacticalMaps boolean
• foundIn string
• partOf string
• year integer

The type of the field determines the filter parameter format.

• string You can specify multiple values by joining them with a ~. If a value itself contains a ~, escape it by ~~. You also have to escape ? by ??.
  Example: Adventures with Gnolls or Pegasuses: https://adventurelookup.com/api/adventures?commonMonsters=Gnoll~Pegasus
  For some adventures, the value might be unknown. To also include these when using the filter, append ~? to the parameter: https://adventurelookup.com/api/adventures?commonMonsters=Gnoll~Pegasus~?
• integer You can specify the minimum (inclusive) and maximum (inclusive).
  Example: Adventures written between 1990 and 2005: https://adventurelookup.com/api/adventures?year=≥1990~≤2005
  For some adventures, the value might be unknown. To also include these when using the filter, append ~? to the parameter: https://adventurelookup.com/api/adventures?year=≥1990~≤2005~?
• boolean Use 1 for "yes" and 0 for "no".
  Example: Adventures that include handouts: https://adventurelookup.com/api/adventures?handouts=1

The sortBy parameter can be used to sort the adventures. Possible values are:

• (nothing): Best matches first. Will sort randomly if no query is provided (since there really is no "best match" when not using a search query).
• reviews: Adventures sorted by reviews
• title: Sort by title
• numPages-desc Most pages
• numPages-asc Least pages
• createdAt-desc Recently added
• createdAt-asc Least recently added
• random Random sorting. To seed the random generator and make pagination possible, provide a seed in the seed parameter. The seed can be any string, e.g. the current date.

Returns detailed data for an adventure specified by its id. In contrast to the other endpoint, this also includes reviews for the adventure.

This API is quite new. Please create an issue in the AdventureLookup GitHub repository if you have any feedback or want to expand this documentation.