11interface InstanceBase {
2+ /**
3+ * World ID of the instance.
4+ */
25 worldId : string
6+ /**
7+ * Name of the instance.
8+ *
9+ * Usually a 5 digit number, can also be a custom name.
10+ *
11+ * Max length is 41 characters.
12+ *
13+ * Allowed characters are:
14+ * - a-z
15+ * - A-Z
16+ * - 0-9
17+ * - _ (underscore)
18+ * - \- (dash)
19+ */
320 name : string
21+ /**
22+ * Region of the instance.
23+ *
24+ * | Region | Hosted in | Token |
25+ * | --- | --- | --- |
26+ * | USA, West | San José | us |
27+ * | USA, East | Washington D.C. | use |
28+ * | Europe | Amsterdam | eu |
29+ * | Japan | Tokyo | jp |
30+ *
31+ */
432 region ?: 'eu' | 'jp' | 'us' | 'use'
533 /**
634 * @deprecated Removed from VRChat instances
@@ -9,17 +37,39 @@ interface InstanceBase {
937}
1038
1139interface InstancePublic extends InstanceBase {
40+ /**
41+ * Type of the instance.
42+ */
1243 type : 'public'
1344}
1445
1546interface InstanceUser extends InstanceBase {
47+ /**
48+ * Type of the instance.
49+ */
1650 type : 'friends+' | 'friends' | 'invite+' | 'invite'
51+ /**
52+ * User ID of the user who created the instance.
53+ *
54+ * @example usr_00000000-0000-0000-0000-000000000000
55+ */
1756 userId : string
1857}
1958
2059interface InstanceGroup extends InstanceBase {
60+ /**
61+ * Type of the instance.
62+ */
2163 type : 'groupPublic' | 'group+' | 'group'
64+ /**
65+ * Group ID of the group who created the instance.
66+ *
67+ * @example grp_00000000-0000-0000-0000-000000000000
68+ */
2269 groupId : string
70+ /**
71+ * Wether the group requires users to be 18 years or older to join.
72+ */
2373 require18yo : boolean
2474}
2575
0 commit comments