Skip to content

API Query Item item

SolWayward edited this page Dec 22, 2025 · 2 revisions

gm.query.item

Endpoint: gm.query.item

Syntax

gm.query.item [search_terms...] [type_flags...] [tier_flags...] [sort:field[:order]]

Description

Search and list items based on search terms, type filters, tier levels, and sorting options. Supports AND logic (all specified filters must match). Essential for finding equipment, weapons, armor, and other items.

Parameters

Parameter Type Required Description
search_terms string No Text to match against item name, ID, or tier
type_flags flags No Filter by item types (see Type Flags below)
tier_flags flags No Filter by tier level (tier0 through tier6)
sort:field[:order] string No Sort results (see Sorting Options below)

Type Flags

Weapons:

  • weapon - All weapons
  • 1h / onehanded - One-handed weapons
  • 2h / twohanded - Two-handed weapons
  • ranged - All ranged weapons (bows and crossbows)
  • bow - Bows only
  • crossbow - Crossbows only
  • polearm - Polearm weapons
  • thrown - Throwing weapons
  • shield - Shields

Ammunition:

  • arrows - Arrow ammunition
  • bolts - Crossbow bolts

Armor:

  • armor - All armor pieces
  • head / headarmor - Head armor (helmets)
  • body / bodyarmor - Body armor (chest pieces)
  • leg / legarmor - Leg armor (boots)
  • hand / handarmor - Hand armor (gloves)
  • cape - Capes and cloaks

Mounts:

  • mount - Horses
  • horsearmor - Horse armor/barding

Other:

  • food - Food items
  • trade / goods - Trade goods
  • banner - Banner items
  • civilian - Civilian equipment (clothing, trade goods)
  • combat - Combat equipment (weapons, protective armor)

Tier Flags

  • tier0 - Tier 0 items
  • tier1 - Tier 1 items
  • tier2 - Tier 2 items
  • tier3 - Tier 3 items
  • tier4 - Tier 4 items
  • tier5 - Tier 5 items
  • tier6 - Tier 6 items

Sorting Options

  • sort:id - Sort by StringId (default)
  • sort:name - Sort alphabetically by name
  • sort:tier - Sort by tier level (0-6)
  • sort:value - Sort by gold value
  • sort:type - Sort by item type category

Add :desc for descending order or :asc for ascending (default):

  • sort:name:desc - Sort Z to A
  • sort:value:desc - Sort by value, highest first
  • sort:tier:asc - Sort by tier, lowest first

Examples

Basic search:

gm.query.item sword

Filter by type:

gm.query.item armor
gm.query.item weapon 1h
gm.query.item bow

Filter by tier:

gm.query.item tier3
gm.query.item sword tier4
gm.query.item armor tier5

Sort results:

gm.query.item sort:name
gm.query.item sort:value:desc
gm.query.item bow sort:tier

Combined filtering:

gm.query.item imperial bow tier5
gm.query.item armor combat tier4
gm.query.item weapon 1h tier3

Complex queries:

gm.query.item imperial bow tier5 sort:value:desc
gm.query.item battanian armor tier3 sort:name
gm.query.item sword combat tier4 sort:value

Civilian vs combat equipment:

gm.query.item civilian sort:name
gm.query.item combat tier5 sort:value:desc
gm.query.item armor civilian tier2

Output

Success:

Found N item(s) matching [criteria]:
[StringId]    [Name]    Type: [Type]    Value: [Gold]    Tier: [Tier]

Example output:

Found 3 item(s) matching search: 'imperial', types: bow, tier: 5:
imperial_bow_5    Imperial Bow    Type: Bow    Value: 15000    Tier: 5
imperial_longbow_5    Imperial Longbow    Type: Bow    Value: 18000    Tier: 5
imperial_shortbow_5    Imperial Shortbow    Type: Bow    Value: 12000    Tier: 5

Notes

TIP: Start broad with item type, then narrow with tier filtering to find appropriate equipment.

TIP: Use sort:value:desc to find the most expensive (usually best) items in a category.

NOTE: Civilian and combat filters help distinguish between cosmetic and functional equipment.

Related Commands

Last Updated: 2025-12-16

Quick Links

🏠 Home | Quick Reference | Syntax Guide


Hero Commands
Clan Commands
Kingdom Commands
Settlement Commands
Item Commands
Troop Commands
Caravan Commands
Bandit Commands
Query Commands

Clone this wiki locally