Giter VIP home page Giter VIP logo

lee95michael / hyrule-compendium-api Goto Github PK

View Code? Open in Web Editor NEW

This project forked from gadhagod/hyrule-compendium-api

0.0 0.0 0.0 42.81 MB

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

Home Page: https://gadhagod.github.io/Hyrule-Compendium-API/#/

License: MIT License

Shell 0.13% Python 34.31% TypeScript 63.32% SQL 2.22% Procfile 0.02%

hyrule-compendium-api's Introduction

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 People

Contributors

gadhagod avatar yancemcfinn avatar pyloverr avatar shaunikm avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.