gadhagod / hyrule-compendium-api

An API serving data on all in-game items and regions in Breath of the Wild and Tears of the Kingdom.

Hyrule Compendium API

An API serving data on all in-game items and regions in Breath of the Wild and Tears of the Kingdom

---

Concept

The Hyrule compendium is an encyclopedia of all the in-game interactive items in the world of Hyrule. With this brilliant API, you can access its data and embed it into your own application.

You can see a specific item, all items in a category, or all data in our database. Here is an example request and response, retrieving data on the white-maned lynel:

$ curl https://botw-compendium.herokuapp.com/api/v3/entry/white-maned_lynel
{
    "data": {
        "name": "white-maned lynel",
        "id": 123,
        "category": "monsters",
        "description": "These fearsome monsters have lived in Hyrule since ancient times. Their ability to breathe fire makes White-Maned Lynels among the toughest of the species; each one of their attacks is an invitation to the grave. There are so few eyewitness accounts of this breed because a White-Maned Lynel is not one to let even simple passersby escape with their lives.",
        "common_locations":[
            "Hyrule Field",
            "Hebra Mountains"
        ]
        "drops": [
            "lynel horn",
            "lynel hoof",
            "lynel guts"
        ],
        "image": "https://botw-compendium.herokuapp.com/api/v2/entry/white-maned_lynel/image"
    }
}

To get started, check out the documentation.

Support and Suggestions

If you come across a malfunction or have any suggestions open an issue or a pull request.

Running locally

Instructions for running locally can be found [https://gadhagod.github.io/Hyrule-Compendium-API/#/self-hosting].

hyrule-compendium-api's Issues

TOTK imgs returning server error

Missing images

I know the images are in development so you may or may not be aware of these, but just wanted to point them out in case you weren't.

I came across 3 missing images:
https://botw-compendium.herokuapp.com/api/v2/entry/golden_bow/image
https://botw-compendium.herokuapp.com/api/v2/entry/golden_claymore/image
https://botw-compendium.herokuapp.com/api/v2/entry/luminous_ore_deposit/image

I also came across 1 broken image. The image is actually there and works just fine but the url in the entry has a typo:
https://botw-compendium.herokuapp.com/api/v2/entry/rare_or_deposit/image ('ore' is misspelled and is missing the 'e')

Recipe list

Hi! Great work with this! I was wondering if you were planning on getting the images more standardized like the ones from https://zelda.fandom.com/wiki/Food#Breath_of_the_Wild. Also, do you have any plans for adding a recipe list?

Fix local hosting instructions

The local hosting instructions are quite out of date now, because of file name and other kinds of changes.

500 error

The API is currently throwing a 500 at https://botw-compendium.herokuapp.com/api/v2 endpoint

Golden Enemies

Hello, i'm sorry to bother you but i was simply wondering if the golden variants of the enemies would show up here, i have been searching for them and i cannot find them, are they simply not in the compendium in the main game? my apologies if so

Add DLC images

DLC images are nonexistent.

Mispelling on Fire-Breath Lizalfos Description

On the description for the fire-breath lizalfos, it is spelled incorrectly

Missing images for `food` subcategory of `creatures`

V3 Roadmap

The new version of the Hyrule Compendium API will serve data on more than just the compendium entries. It will contain the following categories of data:

• in-game compendium (/compendium)
• geographical regions (/regions) (#29)
• recipes (/recipes) (#27)

The goal is to make this API more than just the compendium; it should be able to give data on all (or many) aspects of the game, not just the in-game items.

Recipes

Recipes will be divided based on their base ingredient (e.g seafood). Multi-dimensional arrays will be used to represent possible ingredients to tackle the problem of substitutable ingredients.

Possible example recipe response:

{
  "name": "meat and rice bowl",
  "image": "https://botw-compendium.herokuapp.com/api/v3/recipes/recipe/meat-and-rice-bowl",
  "category": "meat",
  "hearts_recovered": 4.0, // hearts recovered from consumption
  "ingredients": [["raw meat", "raw bird drumstick"], ["rock salt"], ["hylian rice"]] // array of arrays, each inner array represents possible ingredients
  "effect": "attack", // enhancing effect of dish (empty if none)
  "duration": 60, // duration of effect in seconds (0 if no effect)
}

Map

Data on each region, including encompassed shrines and settlements, will be provided.

• Breath of the Wild regions
• Tears of the Kingdom regions

Compendium

• The compendium entries will have a field dlc that specifies if it is a master-mode exclusive. The /master_mode endpoint will remain to avoid ID conflicts.
• The food and non_food keys in the creatures category response will be removed. Each creature entry will have a boolean property edible instead.
• /all(endpoint to get all entries) will not have keys for each category.
• attack and defense keys of items of the equipment category will be nested in the properties key like so:

{
  // ...
  "properties": {
    "attack": 14,
     "defense": 0
  }

• Tears of the Kingdom entries (by setting ?game=totk or ?game=2) (#36)
• Tears of the Kingdom images

Code Changes

These changes will not affect the usage of the API. It will improve performance and clean up code.

• Separate branches for API versions
• Use Flask blueprints instead of Flask().add_url_rule
• Improve queries to reduce API latency
  • Instead of executing multiple queries, using UNION is a better solution
• Create staging app to test changes

Additional Tasks

• Documentation

Feel free to chime in on this thread.

The creatures category returns non-creature content

I was looking around the dataset and I noticed that there is a lot of "non-creature" content returned by the creatures endpoint. For instance, you get stuff like "golden claymore" with id 262 in the non-food sub-category. I'm a bit confused about what your concept of a "creature" is within the domain of this API.

It also doesn't match the data in the creatures json file which only have 83 entries. Is this a bug?

"common_locations" missing on specific items routes

Add images to API

Hope to add images to the API very soon. The entry endpoint will have an additional key, image, that has a URL of the image (hosted on the same heroku server). That URL will be /entry/<entry>/image, which will serve the image in a png of jpeg format.

Problems with the hyphen of "non-food"

When I do a request, I can't retrieve the data of an entry who is in the category "non-food". The hyphen in the category create errors. I don't know how to fix it. I'm using JavaScript.