Color theme

Items

Base: /api/items

Item catalogue with search and icons

Handler: ItemsHandler
GET /api/items

List items

Returns every item of the running server (Hytale 0.7.0: 4008) with type, name and icon.

Parameters

Name Type Required Description
q string No Search in ID and name (case-insensitive)
type string No Comma-separated types: weapon, armor, tool, glider, utility, consumable, block, misc

Response Example

[
  {
    "id": "hytale:sword_iron",
    "name": "Iron Sword",
    "translationKey": "sword_iron",
    "icon": "<base64>",
    "maxStack": 1,
    "maxDurability": 100,
    "itemLevel": 1,
    "consumable": false,
    "dropsOnDeath": true,
    "categories": [
      "weapon"
    ],
    "type": "weapon"
  }
]

cURL

curl -X GET 'http://localhost:5550/api/items?q=sword&type=weapon' \
  -H 'X-Admin-Token: YOUR_TOKEN'

Internal Behavior

Iterates the live item asset map; icons are cached as base64.
GET /api/items/search

Search items

Same as the list, meant for search requests.

Parameters

Name Type Required Description
q string No Search term
type string No Type filter as above

Response Example

[
  {
    "id": "hytale:sword_iron",
    "name": "Iron Sword",
    "type": "weapon"
  }
]

cURL

curl -X GET 'http://localhost:5550/api/items/search?q=sword&type=weapon' \
  -H 'X-Admin-Token: YOUR_TOKEN'

Internal Behavior

Uses the same code path as /api/items.