Hyrule Compendium API

Beginner's Pick Games & Comics / No Auth Required Beginner HTTPS

Free to Use

87 A

Metadata Score Metadata estimate · not endpoint-tested

Visit Official Site Compare Alternatives

Overview

Hyrule Compendium API provides data on every interactive item in The Legend of Zelda: Breath of the Wild, including creatures, equipment, materials, monsters, and treasure. It requires no authentication, so you can start making requests immediately. Use it to build fan apps, quiz games, or encyclopedias for Zelda fans.

Beginner Tip

No API key needed — just send a GET request to https://botw-compendium.herokuapp.com/api/v3/compendium/entry/{entry} with the item name or ID to get started instantly.

Available Data

The kind of data this API exposes, based on its documentation. We could not call the endpoint to confirm the exact field names.

Hyrule Compendium data via REST API

Example Response

Illustrative shape only — we were not able to call this endpoint (it requires credentials or exposes no public sample URL), so the fields below show the kind of data this API returns rather than a recorded response.

JSON Response · Illustrative

{
  "id": 1,
  "name": "Hyrule Compendium",
  "data": "Data on all interactive items from The Legend of Zelda: BOTW",
  "source": "Hyrule Compendium"
}

Field Reference

id Numeric compendium ID for the entry, matching its in-game order.

name The name of the item as it appears in the in-game Hyrule Compendium.

category Category of the entry such as creatures, equipment, materials, monsters, or treasure.

description In-game description text shown in the compendium.

common_locations List of regions in Hyrule where this item is commonly found.

drops Items dropped by this creature or enemy when defeated.

Implementation Example

Calls a real endpoint of this API. Replace any placeholder credentials with your own key.

Request

const url = "https://botw-compendium.herokuapp.com/api/v3/compendium/entry/lynel";
const response = await fetch(url);
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();
console.log(data);

What Can You Build?

Note: These code examples are AI-generated and unverified. Always refer to the official API documentation for accurate usage.

Common Errors & Troubleshooting

Generated guidance based on this API's documentation, not observed by us. Treat it as a starting point and check against the provider's own error reference.

404 Not Found The entry name or ID does not exist in the compendium.

✓ Use the /all endpoint to list all valid entry names and IDs before querying specific ones.

Cold start delay The API is hosted on a free tier and may spin down when inactive.

✓ Implement a timeout and retry strategy; the first request may take 10-30 seconds to respond.

Unexpected null fields Some items have incomplete data for fields like drops or locations.

✓ Always check for null or empty arrays before rendering data in your UI.

Metadata Score Breakdown

Estimated from metadata — endpoint not independently tested

This score is estimated from observable metadata — HTTPS support, authentication model, declared CORS, and documentation reachability — because the API requires authentication or exposes no publicly testable endpoint. The five-signal breakdown is only shown for live-tested APIs.

Metadata estimate · endpoint not independently tested

How is this scored? →