API Query Settlement settlement_any

Query settlement_any

Endpoint: gm.query.settlement_any

Syntax

gm.query.settlement_any [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

Examples

Find castles OR cities:

gm.query.settlement_any castle city

Output:

Found X settlement(s) matching ANY of types: castle, city:
[List of matching settlements]

Find Empire OR Vlandia settlements:

gm.query.settlement_any empire vlandia sort:name

Logic

This command uses OR logic - matches if ANY criteria matches. Use gm.query.settlement for AND logic (all criteria must match).

Related Commands

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

Last Updated: 2025-12-23