Modbot Docs

List live instances

GET/api/live

Read 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.

AuthorizationBearer <token>

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}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.