API Query Settlement settlement_info

Query settlement_info

Endpoint: gm.query.settlement_info

Syntax

gm.query.settlement_info <settlementId>

Parameters

Parameter	Type	Required	Description
settlementId	string	Yes	Settlement identifier (StringId or partial name match)

Description

Get detailed information about a specific settlement including type, owner, kingdom, culture, prosperity, security, loyalty, and other properties.

Examples

Get detailed info about Pen Cannoc:

gm.query.settlement_info pen

Output:

Settlement Information:
ID: town_V1
Name: Pen Cannoc
Type: City
Owner: {Owner Name}
Kingdom: {Kingdom Name}
Culture: {Culture Name}
Prosperity: 5000
Security: 50
Loyalty: 75
Food Stocks: 1200
Under Siege: No
Notables: 5
Types: Town, City, PlayerOwned
Position: X=123.4, Y=567.8

Get info by settlement ID:

gm.query.settlement_info town_empire_1

Village info:

gm.query.settlement_info village_EN1

Output for village:

Settlement Information:
ID: village_EN1
Name: {Village Name}
Type: Village
Owner: {Owner Name}
Kingdom: {Kingdom Name}
Culture: {Culture Name}
Hearth: 800
Bound Town: {Town Name}
Under Siege: No
Types: Village
Position: X=123.4, Y=567.8

Related Commands

• API-Query-Settlement-settlement - Search settlements with AND logic
• API-Query-Settlement-settlement_any - Search settlements with OR logic
• API-Query-Overview - Query command overview
• API-Settlement-Overview - Settlement management commands

Last Updated: 2025-12-23