Reference data

Search every catalogue by name

One query across every catalogue: metals, minerals, ingredients, potions, gems, the milieux, animals, plants and creatures of Biomes, and the reference pages of Hearth, Passage and Bearer. Exact names first, then prefixes, then substrings (aliases and synonyms count). The go-to endpoint for a chat bot's !lookup command.

get/search

Request

  • Base URL: https://michaelghelfistudios.com/api/v1
  • URL: https://michaelghelfistudios.com/api/v1/search
  • Auth: none declared

Query parameters

qstring required

Name search, case- and accent-insensitive. Best matches first.

kindstring

Restrict to some catalogues, comma-separated (metal,mineral).

limitinteger
lang'en' | 'fr' | 'all'

Language of the texts: en (default), fr, or all to get every text as an { "en", "fr" } object.

Response

Best matches first.

successtrue

Changes

No recorded changes to this operation across all 1 revision of this API.