List live instances
/api/liveRead from Modbot's own tables; nothing here calls VRChat. Every open group instance is listed with its head count whether or not a moderator is in it. people is filled only while a moderator's client is watching; otherwise lastSeen holds who was there when watching last stopped, at lastWatchedAt. voice lists the Discord server's voice channels with somebody in them.
Needs the ViewLiveInstances permission.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Response Body
application/json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/live"{ "instances": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "worldId": "string", "worldName": null, "worldImageUrl": null, "vrChatInstanceId": null, "instanceName": null, "groupAccessType": null, "region": null, "openedAt": "2019-08-24T14:15:22Z", "headCount": null, "watching": [ { "userId": "string", "displayName": null, "since": "2019-08-24T14:15:22Z" } ], "people": [ { "userId": "string", "displayName": null, "arrivedAt": null, "hereBefore": null, "standing": "string", "priorActions": 0, "flags": [ "string" ], "trustRank": null } ], "lastWatchedAt": null, "lastSeen": [ { "userId": "string", "displayName": null, "arrivedAt": null, "hereBefore": null, "standing": "string", "priorActions": 0, "flags": [ "string" ], "trustRank": null } ], "worldCapacity": null, "worldPlatforms": null, "headCountUnsure": false } ], "generatedAt": "2019-08-24T14:15:22Z", "voice": null, "tally": null}Live updates polling GET
Returns events after `after` at once when there are any, up to `limit` (default 100, at most 500); otherwise waits up to `wait` seconds (default 30, at most 60) for one and returns an empty list. No `after` means from now. Send the returned `cursor` back as `after`; `more` means poll again straight away. See https://docs.modbot.co/api/live-updates/.
Count flagged people in instances GET
How many flagged people are in the group's open instances right now, by the same rules and the same "who is present" as the Live page: the number beside Live in the sidebar. Counts only instances a moderator is watching, because nobody else knows who is in one. Read from Modbot's own tables; nothing here calls VRChat. Needs the `ViewLiveInstances` permission.