Skip to main content
POST
/
observe
query full world state, optionally filtered by viewer visibility
curl --request POST \
  --url http://localhost:3917/observe
{
  "entities": [
    {
      "generation": 1,
      "health": [
        60,
        60
      ],
      "id": 1,
      "team": 2,
      "transform": {
        "position": [
          5,
          1,
          0
        ],
        "rotation": [
          0,
          0,
          0,
          1
        ],
        "scale": [
          1,
          1,
          1
        ]
      }
    },
    {
      "generation": 1,
      "health": [
        100,
        100
      ],
      "id": 2,
      "physics_body": "Kinematic",
      "team": 1,
      "transform": {
        "position": [
          0.0833,
          1,
          0
        ],
        "rotation": [
          0,
          0,
          0,
          1
        ],
        "scale": [
          1,
          1,
          1
        ]
      },
      "velocity": {
        "angular": [
          0,
          0,
          0
        ],
        "linear": [
          1,
          0,
          0
        ]
      }
    }
  ],
  "entity_count": 2,
  "tick": 65
}

Query Parameters

​
viewer
integer<int32>

If set, only return entities visible to this observer entity id.

Required range: x >= 0

Response

200 - application/json

Full world state (all entities, current tick).

​
entities
object[]
required
​
entity_count
integer<int32>
required
Required range: x >= 0
​
tick
integer<int64>
required
Required range: x >= 0