HyruleCompendium SDK

Hyrule Compendium API client, generated from the OpenAPI spec.

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

Learn more about Hyrule Compendium API at botw-compendium.herokuapp.com.

This is an unofficial SDK for the Hyrule Compendium public API, generated by Voxgig with @voxgig/sdkgen. It is not affiliated with, endorsed by, or sponsored by the upstream API provider.

Learn more about Voxgig SDKs at voxgig.com/sdk.

Metadata kindly supplied by www.freepublicapis.com.

TypeScript, Python, PHP, Golang, Ruby, Lua SDKs, a CLI, an interactive REPL, and an MCP server for AI agents — all generated from one OpenAPI spec by @voxgig/sdkgen.

Entities, not endpoints

This SDK exposes the API as a small set of semantic entities — Category, CompendiumEntry, MasterMode and Region — that you call directly, instead of assembling URL paths and query strings. Entities are Capitalised to mark them as the primary surface, each with the operations they support (list, load):

const client = new HyruleCompendiumSDK()
const category = await client.Category().load()

Thinking in entities keeps the mental model small — for people and AI agents alike — rather than reasoning about raw HTTP routes and query parameters.

Offline unit testing

Every SDK ships a built-in test mode that swaps the HTTP transport for an in-memory mock, so your unit tests run fully offline — no server, no network, and no credentials:

TypeScript

const client = HyruleCompendiumSDK.test()
const category = await client.Category().load({ id: 'test01' })
// category is a bare Category populated with mock data
console.log(category)

Python

client = HyruleCompendiumSDK.test()
category = client.Category().load({"id": "test01"})
print(category)

PHP

// Seed fixture data so offline calls resolve without a live server.
$client = HyruleCompendiumSDK::test([
    "entity" => ["category" => ["test01" => ["id" => "test01"]]],
]);
$category = $client->Category()->load(["id" => "test01"]);

Golang

client := sdk.Test()
result, err := client.Category(nil).Load(
    map[string]any{"id": "test01"}, nil,
)

Ruby

# Seed fixture data so offline calls resolve without a live server.
client = HyruleCompendiumSDK.test({
  "entity" => { "category" => { "test01" => { "id" => "test01" } } },
})
category = client.Category.load({ "id" => "test01" })

Lua

local client = sdk.test()
local result, err = client:Category():load({ id = "test01" })

Packages

Quickstart

TypeScript

import { HyruleCompendiumSDK } from '@voxgig-sdk/hyrule-compendium'

const client = new HyruleCompendiumSDK()


// Load a specific mastermode (returns a MasterMode)
const mastermode = await client.MasterMode().load({
  entry: 'example_entry',
})
console.log(mastermode)

See the TypeScript README for the full guide.

Surfaces

Use it from an AI agent (MCP)

The generated MCP server exposes every operation in this SDK as an MCP tool that Claude, Cursor or Cline can call directly. Build and register it:

cd go-mcp && go build -o hyrule-compendium-mcp .

Then add it to your agent’s MCP config (Claude Desktop, Cursor, etc.):

{
  "mcpServers": {
    "hyrule-compendium": {
      "command": "/abs/path/to/hyrule-compendium-mcp"
    }
  }
}

Entities

The API exposes 4 entities:

The operations available across these entities are load, list — see each entity’s own list above for exactly which it supports.

Quickstart in other languages

Python

from hyrulecompendium_sdk import HyruleCompendiumSDK

client = HyruleCompendiumSDK()


# Load a specific category (returns the record, raises on error)
category = client.Category().load({"id": "example_id"})
print(category)

PHP

<?php
require_once 'hyrulecompendium_sdk.php';

$client = new HyruleCompendiumSDK();


// Load a specific category (returns the bare record; throws on error)
$category = $client->Category()->load(["id" => "example_id"]);
print_r($category);

Golang

import sdk "github.com/voxgig-sdk/hyrule-compendium-sdk/go"

client := sdk.New()


// Load a specific mastermode
masterMode, err := client.MasterMode(nil).Load(
    map[string]any{"entry": "example_entry"}, nil,
)
if err != nil {
    panic(err)
}
fmt.Println(masterMode)

Ruby

require_relative "HyruleCompendium_sdk"

client = HyruleCompendiumSDK.new


# Load a specific category (returns the bare record; raises on error)
category = client.Category.load({ "id" => "example_id" })
puts category

Lua

local sdk = require("hyrule-compendium_sdk")

local client = sdk.new()


-- Load a specific category
local category, err = client:Category():load({ id = "example_id" })
print(category)

Direct and prepare

For endpoints the entity model doesn’t cover, use the low-level methods:

• direct(fetchargs) — build and send an HTTP request in one step.
• prepare(fetchargs) — build the request without sending it.

Both accept a map with path, method, params, query, headers, and body. See the How-to guides below.

How-to guides

Make a direct API call

When the entity interface does not cover an endpoint, use direct:

TypeScript:

const result = await client.direct({
  path: '/api/resource/{id}',
  method: 'GET',
  params: { id: 'example' },
})
if (result instanceof Error) {
  throw result
}
console.log(result.data)

Python:

result = client.direct({
    "path": "/api/resource/{id}",
    "method": "GET",
    "params": {"id": "example"},
})

PHP:

$result = $client->direct([
    "path" => "/api/resource/{id}",
    "method" => "GET",
    "params" => ["id" => "example"],
]);

Go:

result, err := client.Direct(map[string]any{
    "path":   "/api/resource/{id}",
    "method": "GET",
    "params": map[string]any{"id": "example"},
})
if err != nil {
    panic(err)
}
fmt.Println(result)

Ruby:

result = client.direct({
  "path" => "/api/resource/{id}",
  "method" => "GET",
  "params" => { "id" => "example" },
})

Lua:

local result, err = client:direct({
  path = "/api/resource/{id}",
  method = "GET",
  params = { id = "example" },
})

Advanced

Everyday use only needs the sections above. This explains the internals behind every call — relevant when writing custom features.

Every SDK call runs the same five-stage pipeline:

1. Point — resolve the API endpoint from the operation definition.
2. Spec — build the HTTP specification (URL, method, headers, body).
3. Request — send the HTTP request.
4. Response — receive and parse the response.
5. Result — extract the result data for the caller.

A feature hook fires at each stage (e.g. PrePoint, PreSpec, PreRequest), so features can inspect or modify the pipeline without forking the SDK.

Features

Pass custom features via the extend option at construction time.

Per-language documentation

• TypeScript
• Python
• PHP
• Golang
• Ruby
• Lua

Upstream API

This SDK is generated from the upstream OpenAPI specification. It is an unofficial client and is not affiliated with the API provider.

• Upstream API: https://github.com/gadhagod/Hyrule-Compendium-API

Security

Please report security issues to security@voxgig.com. See SECURITY.md. Do not open public issues for suspected vulnerabilities.

Generated from the Hyrule Compendium API OpenAPI spec by @voxgig/sdkgen.