-
Notifications
You must be signed in to change notification settings - Fork 0
API Query Item item
Endpoint: gm.query.item
gm.query.item [search_terms...] [type_flags...] [tier_flags...] [sort:field[:order]]
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.
| 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) |
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)
-
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
-
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
Basic search:
gm.query.item swordFilter by type:
gm.query.item armor
gm.query.item weapon 1h
gm.query.item bowFilter by tier:
gm.query.item tier3
gm.query.item sword tier4
gm.query.item armor tier5Sort results:
gm.query.item sort:name
gm.query.item sort:value:desc
gm.query.item bow sort:tierCombined filtering:
gm.query.item imperial bow tier5
gm.query.item armor combat tier4
gm.query.item weapon 1h tier3Complex 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:valueCivilian vs combat equipment:
gm.query.item civilian sort:name
gm.query.item combat tier5 sort:value:desc
gm.query.item armor civilian tier2Success:
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
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.
-
gm.query.item_any- Search with OR logic -
gm.query.item_info- Get detailed item information -
gm.query.modifiers- List quality modifiers -
API-Query-Overview- All query commands
Last Updated: 2025-12-16
🏠 Home | Quick Reference | Syntax Guide
Hero Commands
- gm.hero.abort_pregnancy
- gm.hero.add_gold
- gm.hero.add_hero_to_party
- gm.hero.create_companions
- gm.hero.create_lord
- gm.hero.create_party
- gm.hero.divorce
- gm.hero.edit_appearance
- gm.hero.edit_party
- gm.hero.equip_hero
- gm.hero.export_character
- gm.hero.generate_lords
- gm.hero.give_birth
- gm.hero.heal
- gm.hero.import_character
- gm.hero.impregnate
- gm.hero.imprison
- gm.hero.kill
- gm.hero.list_appearances
- gm.hero.list_characters
- gm.hero.list_developments
- gm.hero.list_traits
- gm.hero.load_appearance
- gm.hero.load_character
- gm.hero.load_development
- gm.hero.load_traits
- gm.hero.marry
- gm.hero.open_inventory
- gm.hero.release
- gm.hero.remove_clan
- gm.hero.rename
- gm.hero.save_appearance
- gm.hero.save_development
- gm.hero.save_traits
- gm.hero.set_age
- gm.hero.set_clan
- gm.hero.set_culture
- gm.hero.set_gold
- gm.hero.set_relation
- gm.hero.start_convrsation
Clan Commands
- gm.clan.add_gold
- gm.clan.add_gold_leader
- gm.clan.add_hero
- gm.clan.add_renown
- gm.clan.create_clan
- gm.clan.create_minor_clan
- gm.clan.destroy
- gm.clan.edit_banner
- gm.clan.equip_heroes
- gm.clan.generate_clans
- gm.clan.give_gold
- gm.clan.rename
- gm.clan.set_culture
- gm.clan.set_gold
- gm.clan.set_leader
- gm.clan.set_renown
- gm.clan.set_tier
- gm.clan.sync_kingdom_colors
Kingdom Commands
- gm.kingdom.add_clan
- gm.kingdom.call_ally_to_war
- gm.kingdom.create_kingdom
- gm.kingdom.declare_alliance
- gm.kingdom.declare_war
- gm.kingdom.destroy
- gm.kingdom.edit_banner
- gm.kingdom.equip_heroes
- gm.kingdom.generate_kingdoms
- gm.kingdom.get_tribute_info
- gm.kingdom.make_peace
- gm.kingdom.pay_tribute
- gm.kingdom.remove_clan
- gm.kingdom.rename
- gm.kingdom.set_ruler
- gm.kingdom.sync_vassal_banners
- gm.kingdom.trade_agreement
Settlement Commands
- gm.settlement.add_militia
- gm.settlement.fill_garrison
- gm.settlement.give_food
- gm.settlement.give_gold
- gm.settlement.rename
- gm.settlement.reset_names
- gm.settlement.set_culture
- gm.settlement.set_hearths
- gm.settlement.set_loyalty
- gm.settlement.set_prosperity
- gm.settlement.set_security
- gm.settlement.set_village_bound_settlement
- gm.settlement.set_village_trade_bound_settlement
- gm.settlement.spawn_wanderer
- gm.settlement.upgrade_buildings
Item Commands
- gm.item.add
- gm.item.equip
- gm.item.equip_slot
- gm.item.list_equipped
- gm.item.list_inventory
- gm.item.load_equipment
- gm.item.load_equipment_both
- gm.item.load_equipment_civilian
- gm.item.remove
- gm.item.remove_all
- gm.item.remove_equipped
- gm.item.remove_equipped_modifier
- gm.item.save_equipment
- gm.item.save_equipment_both
- gm.item.save_equipment_civilian
- gm.item.set_equipped_modifier
- gm.item.set_inventory_modifier
- gm.item.transfer
- gm.item.unequip
- gm.item.unequip_all
- gm.item.unequip_slot
Query Commands
- gm.query.character_objects
- gm.query.character_objects_any
- gm.query.character_objects_info
- gm.query.clan
- gm.query.clan_any
- gm.query.clan_info
- gm.query.culture
- gm.query.culture_info
- gm.query.hero
- gm.query.hero_any
- gm.query.hero_info
- gm.query.item
- gm.query.item_any
- gm.query.item_info
- gm.query.kingdom
- gm.query.kingdom_any
- gm.query.kingdom_info
- gm.query.modifier_info
- gm.query.modifiers
- gm.query.settlement
- gm.query.settlement_any
- gm.query.settlement_info
- gm.query.troop
- gm.query.troop_any
- gm.query.troop_info