API Query Kingdom kingdom

gm.query.kingdom

Endpoint: gm.query.kingdom

Syntax

gm.query.kingdom [search_terms...] [type_flags...] [sort:field[:order]]

Description

Search for kingdoms using text search and type filters with AND logic (all criteria must match). Without specifying status keywords, defaults to showing only active kingdoms.

Parameters

Parameter	Type	Required	Description
search_terms	string	No	Text to search in kingdom names and IDs
type_flags	flags	No	Filter by kingdom types (see Type Flags below)
sort:field[:order]	string	No	Sort results by field (see Sorting Options below)

Type Flags

Status:

• active - Active kingdoms (default)
• eliminated - Destroyed/eliminated kingdoms
• empty - Kingdoms with no clans

Relationships:

• player - Player's kingdom
• atwar - Kingdoms currently at war

Sorting Options

• sort:id - Sort by StringId (default)
• sort:name - Sort alphabetically by name
• sort:clans - Sort by number of clans
• sort:heroes - Sort by number of heroes
• sort:fiefs - Sort by number of fiefs
• sort:strength - Sort by military strength
• sort:ruler - Sort by ruler name
• sort:[type_flag] - Sort by any type flag (e.g., sort:atwar)

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

• sort:strength:desc - Sort strongest first
• sort:clans:desc - Sort most clans first
• sort:fiefs:desc - Sort most fiefs first

Examples

Find kingdoms at war:

gm.query.kingdom atwar

Search for Empire kingdom:

gm.query.kingdom empire

Find eliminated kingdoms:

gm.query.kingdom eliminated

Sort kingdoms by military strength (strongest first):

gm.query.kingdom sort:strength:desc

Sort kingdoms at war by clan count:

gm.query.kingdom atwar sort:clans:desc

Sort by atwar type (kingdoms at war first):

gm.query.kingdom sort:atwar

Find active kingdoms sorted by fiefs:

gm.query.kingdom active sort:fiefs:desc

Output

Success:

Found N kingdom(s) matching [criteria]:
[Name] ([StringId]) - Culture: [Culture], Ruler: [RulerName], Ruling Clan: [ClanName], Clans: [Count], Fiefs: [Count]

Notes

NOTE: Without specifying status keywords, the command defaults to showing only active kingdoms. Use eliminated to search destroyed kingdoms.

TIP: Use this command before kingdom management commands to find exact StringIds.

TIP: Sort by strength to identify the most powerful kingdoms in the game.

Related Commands

• gm.query.kingdom_any - Search with OR logic
• gm.query.kingdom_info - Get detailed kingdom information
• API-Query-Overview - All query commands

Last Updated: 2025-12-16