List nearby entities
Lists entities within a radius of the bot, optionally filtered by type.
Lists entities within a radius of the bot, optionally filtered by type.
AuthorizationBearer <token>
Preferred API authentication. Use a JWT with the api audience.
In: header
Path Parameters
instance_id*string
Format
uuidbot_id*string
Format
uuidQuery Parameters
radius*|
Maximum radius in blocks from the bot. Server clamps to an implementation-defined maximum.
entity_types?array<string>
Optional filter: if non-empty, only entities whose namespaced type is in this list are returned.
include_players?boolean
If true, include players in the result. Defaults to true.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/bots/497f6eca-6276-4993-bfeb-53cbbbba6f08/live/world/entities?radius=0.1"{ "entities": [ { "entityId": 0, "entityType": "string", "position": { "x": 0.1, "y": 0.1, "z": 0.1, "dimension": "string" }, "distance": 0.1, "displayName": "string", "isPlayer": true, "health": 0.1 } ]}How is this page?