Endpoint Index

Version: 1.1.0 Last Updated: 2026-01-01 Description: Complete index of all API endpoints for AI agents

Categories

Category Description
query Read-only operations to query game state
transaction Write operations to perform actions
webapp Web Application API endpoints (PHP/Symfony)
modding Cosmetic mod management and integration endpoints

Query Patterns

Pattern Description
single Get single entity by ID
list List all entities (with pagination)
filtered Get entities filtered by relationship
transaction Submit transaction to perform action

Consensus Network API Endpoints

Base URL: http://localhost:1317

Player

ID Method Path Paginated Entity Schema Protocol
player-by-id GET /structs/player/{id} No Player entities.md query-protocol.md
player-list GET /structs/player Yes Player entities.md query-protocol.md

Planet

ID Method Path Paginated Entity Schema Protocol
planet-by-id GET /structs/planet/{id} No Planet entities.md query-protocol.md
planet-list GET /structs/planet Yes Planet entities.md query-protocol.md
planet-by-player GET /structs/planet_by_player/{playerId} No Planet entities.md query-protocol.md

Struct

ID Method Path Paginated Entity Schema Protocol
struct-by-id GET /structs/struct/{id} No Struct entities.md query-protocol.md
struct-list GET /structs/struct Yes Struct entities.md query-protocol.md

Fleet

ID Method Path Paginated Entity Schema Protocol
fleet-by-id GET /structs/fleet/{id} No Fleet entities.md query-protocol.md
fleet-list GET /structs/fleet Yes Fleet entities.md query-protocol.md

Guild

ID Method Path Paginated Entity Schema Protocol
guild-by-id GET /structs/guild/{id} No Guild entities.md query-protocol.md
guild-list GET /structs/guild Yes Guild entities.md query-protocol.md

Reactor

ID Method Path Paginated Entity Schema Protocol
reactor-by-id GET /structs/reactor/{id} No Reactor entities.md query-protocol.md
reactor-list GET /structs/reactor Yes Reactor entities.md query-protocol.md

Substation

ID Method Path Paginated Entity Schema Protocol
substation-by-id GET /structs/substation/{id} No Substation entities.md query-protocol.md
substation-list GET /structs/substation Yes Substation entities.md query-protocol.md

Provider

ID Method Path Paginated Entity Schema Protocol
provider-by-id GET /structs/provider/{id} No Provider entities.md query-protocol.md
provider-list GET /structs/provider Yes Provider entities.md query-protocol.md

Agreement

ID Method Path Paginated Entity Schema Protocol
agreement-by-id GET /structs/agreement/{id} No Agreement entities.md query-protocol.md
agreement-list GET /structs/agreement Yes Agreement entities.md query-protocol.md
agreement-by-provider GET /structs/agreement_by_provider/{providerId} No Agreement entities.md query-protocol.md

Allocation

ID Method Path Paginated Entity Schema Protocol
allocation-by-id GET /structs/allocation/{id} No Allocation entities.md query-protocol.md
allocation-list GET /structs/allocation Yes Allocation entities.md query-protocol.md
allocation-by-source GET /structs/allocation_by_source/{sourceId} No Allocation entities.md query-protocol.md
allocation-by-destination GET /structs/allocation_by_destination/{destinationId} No Allocation entities.md query-protocol.md

Address

ID Method Path Paginated Entity Schema Protocol
address-by-address GET /structs/address/{address} No Address entities.md query-protocol.md
address-list GET /structs/address Yes Address entities.md query-protocol.md
address-by-player GET /structs/address_by_player/{playerId} No Address entities.md query-protocol.md

Permission

ID Method Path Paginated Entity Schema Protocol
permission-by-id GET /structs/permission/{permissionId} No Permission entities.md query-protocol.md
permission-list GET /structs/permission Yes Permission entities.md query-protocol.md
permission-by-object GET /structs/permission/object/{objectId} No Permission entities.md query-protocol.md
permission-by-player GET /structs/permission/player/{playerId} No Permission entities.md query-protocol.md

System

ID Method Path Paginated Entity Schema Protocol
block-height GET /blockheight No BlockHeight game-state.md query-protocol.md
params GET /structs/params No Params entities.md query-protocol.md

Transaction

ID Method Path Entity Schema Protocol
submit-transaction POST /cosmos/tx/v1beta1/txs Transaction actions.md action-protocol.md

Web Application API Endpoints

Base URL: http://localhost:8080

ID Method Path Entity Schema Protocol
webapp-player-by-id GET /api/player/{player_id} Player responses.md query-protocol.md
webapp-player-ore-stats GET /api/player/{player_id}/ore/stats Player responses.md query-protocol.md
webapp-planet-by-id GET /api/planet/{planet_id} Planet entities.md query-protocol.md
webapp-planet-shield-health GET /api/planet/{planet_id}/shield/health Planet responses.md query-protocol.md
webapp-guild-by-id GET /api/guild/{guild_id} Guild entities.md query-protocol.md
webapp-guild-count GET /api/guild/count Guild responses.md query-protocol.md
webapp-struct-by-id GET /api/struct/{struct_id} Struct entities.md query-protocol.md
webapp-timestamp GET /api/timestamp Timestamp responses.md query-protocol.md

Modding API Endpoints

Base URL: http://localhost:8080

ID Method Path Entity Schema Protocol
cosmetic-mod-list GET /api/cosmetic-mods CosmeticMod responses.md cosmetic-mod-integration.md
cosmetic-mod-get GET /api/cosmetic-mods/{modId} CosmeticMod responses.md cosmetic-mod-integration.md
cosmetic-mod-install POST /api/cosmetic-mods/install CosmeticMod responses.md cosmetic-mod-integration.md
cosmetic-mod-validate POST /api/cosmetic-mods/validate CosmeticMod responses.md cosmetic-mod-integration.md
cosmetic-struct-type GET /api/cosmetic/struct-type/{structTypeId} StructType responses.md cosmetic-mod-integration.md
struct-type-with-cosmetics GET /api/struct-type/{structTypeId}/full StructType responses.md cosmetic-mod-integration.md