Hyrule Compendium API

AVERTISSEMENT : les versions v1 et v2 seront interrompues le 29 septembre 2024. Veuillez consulter le guide de migration pour mettre à jour vos applications.

---

---

Concept

Le recueil Hyrule est une encyclopédie de tous les objets interactifs du monde d'Hyrule. Avec cette brillante API, vous pouvez accéder à ses données et les intégrer dans votre propre application.

Vous pouvez voir un élément spécifique, tous les éléments d'une catégorie ou toutes les données de notre base de données. Voici un exemple de requête et de réponse, récupérant des données sur le lynel à crinière blanche :

 $ 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/v3/entry/white-maned_lynel/image"
    }
}

Pour commencer, consultez la documentation.

Assistance et suggestions

Si vous rencontrez un dysfonctionnement ou avez des suggestions, ouvrez un problème ou une pull request.

Exécution locale

Les instructions pour l'exécution locale peuvent être trouvées [https://gadhagod.github.io/Hyrule-Compendium-API/#/self-hosting].