Use the Hyrule Compendium API to Enhance the Legend of Zelda

Today is the day that Legend of Zelda fans have been waiting for! The Legend of Zelda: Tears of the Kingdom is here and Nintendo fans all over the world are going to be locked inside all weekend long exploring the gargantuan map, following the story and the many side quests. In honor of friends who have disappeared, today we will feature a Zelda API. The Hyrule Compendium API provides an endpoint that returns details about items and creatures in the Legend of Zelda: Breath of the Wild universe. 

‍Provider Website: https://gadhagod.github.io/Hyrule-Compendium-API/#/
Provider Enrichment Docs: https://gadhagod.github.io/Hyrule-Compendium-API/#/
Endpoint: curl https://botw-compendium.herokuapp.com/api/v2/entry/White-maned_Lynel
Token / Registration Required: No

‍

How To Enrich A Spreadsheet With the Hyrule Compendium:

For this example, my data looks like this. It is a list of items I wanted to know more about.

Step 0. For the API, we need to remove the spaces with underscores. We use the Find and Replace functionality to do that.

Step 1. In Gigasheet, head to the Enrichments function and select Custom Enrichment. First we paste in the HTTP request from the Hyrule Compendium API.

‍Step 2. On the next screen we’ll insert the column variable from our Gigasheet sheet for the prompt. In this case, we highlight the creature name, “White-maned lynel”, in the input, and then select our Hyrule Items column and click +Insert Column Reference. Then click Next.

‍Step 3. In this screen we see a preview of the results. Gigasheet makes requests for the first three rows and shows the response. At this point select the fields you want to be inserted into your sheet. We recommend hitting Select All since you can easily delete columns in Gigasheet.

‍Step 4. Finally, confirm the number of requests is to your liking, and when ready click Run to kickoff the custom enrichment process. It’s ok to leave or close the sheet; the custom enrichment will keep running and you’ll receive an email once the job has been completed. You can monitor the progress of your enrichment, or cancel the job at the top of the sheet. 

‍Step 5. Once completed, Gigasheet will send a completion toast and refresh the page. The result will show generation of new columns based on the Hyrule Compendium API.