https://gadhagod.github.io/Hyrule-Compendium-API/

An API serving data on all in-game items and regions in Breath of the Wild and Tears of the Kingdom.
https://gadhagod.github.io/Hyrule-Compendium-API/

botw breath-of-the-wild hyrule-compendium hyrule-compendium-api rockset tears-of-the-kingdom totk zelda

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://gadhagod.github.io/Hyrule-Compendium-API/
• Owner: gadhagod
• License: mit
• Created: 2021-01-03T01:36:26.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-09-04T23:09:16.000Z (10 months ago)
• Last Synced: 2024-05-18T19:21:36.218Z (about 2 months ago)
• Topics: botw, breath-of-the-wild, hyrule-compendium, hyrule-compendium-api, rockset, tears-of-the-kingdom, totk, zelda
• Language: TypeScript
• Homepage: https://gadhagod.github.io/Hyrule-Compendium-API/#/
• Size: 41.8 MB
• Stars: 177
• Watchers: 8
• Forks: 27
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-docsify - Hyrule Compendium API - A web API serving data on items from the video game _The Legend of Zelda: Breath of the Wild_. (Showcase)

README

        






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](http://gadhagod.github.io/Hyrule-Compendium-API).

## Support and Suggestions

If you come across a malfunction or have any suggestions open an [issue](https://github.com/gadhagod/Hyrule-Compendium-API/issues) or a [pull request](https://github.com/gadhagod/Hyrule-Compendium-API/pulls).

## Running locally

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