Skip to main content

GraphQL Reference

This page summarizes the current GraphQL surface from the real backend and frontend schema files.

Example queries

QueryPurpose
getPlansByStatusPaginated live plan list by status
getPlanByIdFetch one plan
getAllFollowerDetailsPaginated follower details for a contract
getPerpTradePositionsHistorical position view with summary data for an address and platform
getSimulationPlansPaginated simulation plan list
simulationFetch one simulation
simulationsPaginated simulations
simulationResearchesPaginated simulation research records
simulationPlansBySimulationGet plans belonging to a simulation
simulationPlanDetailsBySimulationDetailed per-plan view
simulationLeaderSelectionsLeader selections for a simulation or plan

Example mutations

MutationPurpose
createPlanCreate a live plan
updatePlanUpdate a live plan
startPlanStart a plan
endPlanEnd a plan
createSimulationCreate an auto simulation record
createSimulationPlanCreate a manual simulation plan
createSimulationResearchCreate a research batch
playAutoSimulationStart an auto simulation
playSimulationPlanStart or resume a simulation plan
cancelSimulationCancel a simulation
updateSimulationBotUpdate a simulation bot
batchCreateSimulationBotsCreate multiple simulation bots
stopSimulationBotStop a simulation bot

Example subscriptions

SubscriptionPurpose
planCreatedNotify the UI about newly created plans
planUpdatedNotify the UI about plan changes
botCreated / botUpdatedBot state updates
missionCreated / missionUpdatedMission lifecycle updates
taskCreated / taskUpdatedTask lifecycle updates
newLogLog stream updates

The backend constants also define simulationProgressUpdated, but treat the exact published shape as implementation-sensitive until a dedicated public schema example is added.