GET Endpoints

Base Route

0. Get server time
   • Endpoint: /, /time
   • Description: Retrieve the server time.

Player Routes

1. Get all players

   • Endpoint: /players
   • Description: Retrieve a list of all players and their general details (e.g., id, name, email, gold, created_at, last_login).

2. Get player by ID

   • Endpoint: /players/{player_id}
   • Description: Retrieve details of a specific player by id.

3. Get player by email

   • Endpoint: /players/email/{email}
   • Description: Retrieve a specific player by their unique email (indexed for quick lookup).

4. Get worlds of a player

   • Endpoint: /players/{player_id}/worlds
   • Description: Retrieve all worlds a player has joined by looking up entries in player_world.

5. Get cities owned by a player

   • Endpoint: /players/{player_id}/cities
   • Description: Retrieve all cities owned by a player by using owner_id in city.

World Routes

6. Get all worlds

   • Endpoint: /worlds
   • Description: Retrieve a list of all worlds and their configurations (e.g., id, name, description, seed, action_speed, etc.).

7. Get world by ID

   • Endpoint: /worlds/{world_id}
   • Description: Retrieve details of a specific world by id.

8. Get active worlds

   • Endpoint: /worlds/active
   • Description: Retrieve all worlds where STATUS is 1 (active).

9. Get players in a world

   • Endpoint: /worlds/{world_id}/players
   • Description: Retrieve all players associated with a given world using player_world.

10. Get islands in a world

    • Endpoint: /worlds/{world_id}/islands
    • Description: Retrieve all islands within a specific world.

Island Routes

11. Get all islands

    • Endpoint: /islands
    • Description: Retrieve a list of all islands with their positions and associated world.

12. Get island by ID

    • Endpoint: /islands/{island_id}
    • Description: Retrieve details of a specific island by id.

13. Get cities on an island

    • Endpoint: /islands/{island_id}/cities
    • Description: Retrieve all cities located on a specific island.

City Routes

14. Get all cities

    • Endpoint: /cities
    • Description: Retrieve a list of all cities, including coordinates, owner, and island details.

15. Get city by ID

    • Endpoint: /cities/{city_id}
    • Description: Retrieve details of a specific city by id.

16. Get cities in a world

    • Endpoint: /worlds/{world_id}/cities
    • Description: Retrieve all cities within a specified world (through island → city relationships).

Building Routes

17. Get all buildings

    • Endpoint: /buildings
    • Description: Retrieve a list of all buildings with names, levels, and city associations.

18. Get buildings in a city

    • Endpoint: /cities/{city_id}/buildings
    • Description: Retrieve all buildings in a specific city.

19. Get building by ID

    • Endpoint: /buildings/{building_id}
    • Description: Retrieve details of a specific building by id.

20. Get building prerequisites

    • Endpoint: /buildings/{building_id}/prerequisites
    • Description: Retrieve all prerequisite buildings for a specified building by building_prerequisite.

Unit Routes

21. Get all units

    • Endpoint: /units
    • Description: Retrieve a list of all units with their attributes (e.g., name, description, type, training_time, damage, etc.).

22. Get units in a city

    • Endpoint: /cities/{city_id}/units
    • Description: Retrieve all units stationed in a city and their quantities using city_unit.

23. Get unit by ID

    • Endpoint: /units/{unit_id}
    • Description: Retrieve details of a specific unit by id.

Battle Routes

24. Get all battles

    • Endpoint: /battles
    • Description: Retrieve a list of all battles with attacker and defender details, time, winner, loser, and loot.

25. Get battle by ID

    • Endpoint: /battles/{battle_id}
    • Description: Retrieve details of a specific battle by id.

26. Get battles of a player

    • Endpoint: /players/{player_id}/battles
    • Description: Retrieve all battles involving a specified player as either attacker or defender.

27. Get units in a battle

    • Endpoint: /battles/{battle_id}/units
    • Description: Retrieve all units involved in a specific battle, including their quantities and which side they fought on.

Miscellaneous Routes

28. Get building requirements
    • Endpoint: /buildings/{building_id}/requirements
    • Description: Retrieve the resources required to build or upgrade a specific building based on building_requirement.