API Query Settlement settlement

Query settlement

Endpoint: gm.query.settlement

Syntax

gm.query.settlement [search] [type keywords] [sort parameters]

Parameters

Parameter	Type	Required	Description
search	string	No	Search term to match settlement names or IDs
type keywords	string	No	Filter by settlement types and properties
sort	string	No	Sort results (e.g., sort:name, sort:prosperity:desc)

Type Keywords

Settlement Types:

• town / city - Towns and cities
• castle - Castles only
• village - Villages only
• hideout - Bandit hideouts

Ownership:

• player / playerowned - Player-owned settlements

Status:

• besieged / siege - Under siege
• raided - Being raided

Culture:

• empire, vlandia, sturgia, aserai, khuzait, battania, nord

Prosperity Level:

• low / lowprosperity - Low prosperity
• medium / mediumprosperity - Medium prosperity
• high / highprosperity - High prosperity

Sort Options

• sort:name - Sort by settlement name
• sort:prosperity - Sort by prosperity level
• sort:owner - Sort by owner name
• sort:kingdom - Sort by kingdom
• sort:culture - Sort by culture
• Add :desc for descending order (e.g., sort:prosperity:desc)

Examples

Find all castles:

gm.query.settlement castle

Find Empire castles sorted by prosperity:

gm.query.settlement castle empire sort:prosperity:desc

Find player-owned towns:

gm.query.settlement player town sort:name

Search for specific settlement:

gm.query.settlement pen

Logic

This command uses AND logic - all specified criteria must match. Use gm.query.settlement_any for OR logic.

Related Commands

• API-Query-Settlement-settlement_any - Query with OR logic
• API-Query-Settlement-settlement_info - Get detailed settlement info
• API-Query-Overview - Query command overview

Last Updated: 2025-12-23