Modbot Docs
APIAPI referencePlaces

Get world

GET/api/worlds

One world: what its page said, the instances that have run in it, and how busy it was. Read from Modbot's own tables; nothing here calls VRChat. known is false when Modbot has only ever seen the id. name is null when the world page has not been read yet — ordinary for a few minutes after a new world turns up, and permanent for a private or deleted one. Time and visitors come from the desktop client's presence reports and exist only while a moderator's client was in the instance; instances opened come from the group's own instance list and are complete.

Needs the ViewAnalytics permission.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Query Parameters

id*string

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/worlds?id=string"
{  "worldId": "string",  "known": true,  "name": null,  "description": null,  "authorId": null,  "authorName": null,  "imageUrl": null,  "thumbnailImageUrl": null,  "capacity": null,  "recommendedCapacity": null,  "tags": [    "string"  ],  "releaseStatus": null,  "publishedAt": null,  "updatedAt": null,  "firstSeenAt": null,  "lastSeenAt": null,  "lastReadAt": null,  "readError": null,  "counts": {    "minutesSeen": 0.1,    "visitors": 0,    "arrivals": 0,    "lastSeenAt": null  },  "instances": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "location": "string",      "worldId": "string",      "worldName": null,      "worldThumbnailImageUrl": null,      "vrChatInstanceId": null,      "instanceName": null,      "groupAccessType": null,      "region": null,      "openedAt": "2019-08-24T14:15:22Z",      "closedAt": null,      "closedBy": null,      "peopleNow": null,      "peakPeople": null,      "minutesOpen": 0.1,      "worldCapacity": null,      "worldPlatforms": null,      "closedByModerator": false,      "peopleNowUnsure": false,      "peakPeopleUnsure": false    }  ],  "instancesTotal": 0,  "instancesOpenNow": 0,  "visitorsPerDay": [    {      "day": "2019-08-24",      "value": 0.1    }  ],  "instancesPerDay": [    {      "day": "2019-08-24",      "value": 0.1    }  ],  "now": "2019-08-24T14:15:22Z"}

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.