Hyrule Compendium

About Hyrule Compendium

The Hyrule Compendium API provides data on in-game items and regions from The Legend of Zelda: Breath of the Wild and Tears of the Kingdom. It exposes an encyclopedia-style dataset covering entries such as monsters, materials, and locations, with details including name, category, description, common locations, and drops for each item.

The API returns JSON responses and supports retrieving a single entry, all entries within a category, or the full compendium database. Each entry can also include an associated image accessible via its own endpoint.

It is intended for developers building applications that incorporate Zelda game data, such as reference tools, companion apps, or fan projects. The project is open source under the MIT license and accepts issues and pull requests for bug reports and suggestions; instructions for self-hosting are provided in the documentation.

Key features

• Serves data on all in-game items and regions from Breath of the Wild and Tears of the Kingdom
• Retrieve a specific item entry by name
• Retrieve all items within a category
• Retrieve all data in the compendium database
• Provides item images via a dedicated image endpoint
• Supports self-hosting for local instances

Frequently asked questions