shipapis
StarSubmit an APISubmit API

Hyrule Compendium

Data on every item, monster and creature in Zelda: BOTW

🎮 GamesUNMONITOREDchecked 29 min ago
AUTH NONECORS ✓AGENT ✓HTTPS ✓COMMERCIAL ?

The Hyrule Compendium API serves entries from The Legend of Zelda: Breath of the Wild—monsters, materials, equipment and more—with descriptions, locations, drops and images. Fetch an entry by name for JSON. Fan-made and keyless; it has moved off Heroku to api.hyrule-compendium.com.

—HOW IT'S SCORED ⓘ
▶ Run liveDocs ↗
Status badge · for your READMEshipapis health badge: — · unmonitored
Uptime history
—%90 days
—%30 days
—P50 · ms
—P95 · ms
operationalpartialdownno data
Live response samplecaptured by our last successful check
GET https://api.hyrule-compendium.com/v3/compendium/entry/white-maned_lynel

{
  "data": {
    "name": "white-maned lynel",
    "category": "monsters",
    "id": 123,
    "common_locations": [
      "Hyrule Field",
      "Hebra Mountains"
    ],
    "drops": [
      "lynel horn",
      "lynel hoof",
      "lynel guts"
    ],
    "dlc": false
  },
  "status": 200
}
Call itcurl · fetch · python
curl "https://api.hyrule-compendium.com/v3/compendium/entry/white-maned_lynel"
const res = await fetch("https://api.hyrule-compendium.com/v3/compendium/entry/white-maned_lynel");
const data = await res.json();
console.log(data);
import requests

res = requests.get("https://api.hyrule-compendium.com/v3/compendium/entry/white-maned_lynel")
print(res.json())
Endpoints · 6On scheduleFULL DOCS ↗
First rollup pending — GET /v3/compendium/entry/white-maned_lynel has been probed
GET/v3/compendium/entry/white-maned_lynelPROBED

Data on every item, monster and creature in Zelda: BOTW

GET/v3

V3 — documented GET route.

GET/v3/1

V3 details by ID (example: 1).

GET/v3?limit=10

V3 — documented GET route.

GET/v3/search?q=test

Search by query parameters.

GET/v3/

V3 — documented GET route.

Machine-readable spec

We probe a documented GET and expect 2xx JSON — full uptime and health score. Export includes every documented route below.

Response-shape history

Stable. No schema drift observed since monitoring began — the response shape has not changed under our checks.

Hyrule Compendium: common questions

Is Hyrule Compendium free to use?

Yes — Hyrule Compendium is a free games API. Free tier: Free — no API key. Whether the free tier allows commercial use is unclear — check the provider docs.

Does Hyrule Compendium need an API key?

No — Hyrule Compendium needs no API key or signup. You can call it straight away; rate limits still apply (Unpublished).

Can I call Hyrule Compendium from the browser?

Yes — Hyrule Compendium returns CORS headers over HTTPS, so front-end code can fetch it directly with no backend proxy. Use the fetch snippet on this page, or hit "Run live" to try it now.

Is Hyrule Compendium up right now?

As of our last scheduled check, Hyrule Compendium is unmonitored. We re-probe it every sweep — the status badge and uptime chart above always show the latest.