Skip to main content
Retrieve information about a specific instance using either its ID or UUID. This endpoint returns details about the instance including its tax rate, collected taxes, and associated NPCs and Agent NPCs. This endpoint is useful for getting the current state of your game instance, including its economic status and population. 
// Retrieve the instance using its UUID
UUID uuid = UUID.fromString("your-instance-uuid");
Instance instance = PixocracySDK.InstanceManager().retrieveInstance(uuid);

// Access instance properties
double taxRate = instance.getTaxRate();
double collectedTaxes = instance.getCollectedTaxes();
List<NPC> npcs = instance.getNpcs();
List<AgentNPC> agentNpcs = instance.getAgentNpcs();