Discover Instances

Returns instances to discover, in an order that changes between requests.

Authorization

authCookie

auth<token>

Auth Token via Cookie

In: cookie

Query Parameters

n?integer

The number of instances to return.

Range1 <= value <= 50

region?string

Return only instances in this region.

Value in"eu" | "jp" | "us" | "use"

platform?string

The platform to discover instances for.

Value in"android" | "ios" | "standalonewindows" | "web"

worldId?array<>

Return only instances of these worlds.

groupId?array<>

Return only instances of these groups.

vibe?array<>

category?string

Response Body

`application/json`

curl -X GET "https://api.vrchat.cloud/api/1/instances/discover"

{
  "attributionId": "attr_01a12109-4fd5-7269-aee5-295794df2520",
  "instances": [
    {
      "active": true,
      "capacity": 8,
      "categoryId": "icat_44bc6a70-493f-4f84-8a3b-1f290c864c2a",
      "creationLanguages": [
        null
      ],
      "description": "string",
      "disabledPropAbilities": [
        null
      ],
      "displayName": "string",
      "displayVibeId": "ivib_2d8445c4-f47b-4635-b565-467fc32c4003",
      "dominantLanguage": "string",
      "full": false,
      "groupAccessType": "members",
      "id": "12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)",
      "instanceId": "12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)",
      "languageRatio": {},
      "languages": [
        "en"
      ],
      "languagesIso639": [
        "eng"
      ],
      "location": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd:12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)",
      "minimumAvatarPerformance": "string",
      "n_users": 6,
      "ownerId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
      "permanent": false,
      "photonRegion": "eu",
      "platforms": {
        "android": 1,
        "ios": 1,
        "standalonewindows": 5
      },
      "queueEnabled": true,
      "queueSize": 6,
      "recommendedCapacity": 6,
      "region": "us",
      "roleRestricted": true,
      "shortName": "02u7yz8j",
      "tags": [
        "language_eng",
        "language_jpn",
        "show_social_rank"
      ],
      "type": "hidden",
      "userCount": 6,
      "userIcons": [
        "https://api.vrchat.cloud/api/1/image/file_12ca2b06-c08d-4023-b06f-b60691d9946e/1/256"
      ],
      "vibeIds": [
        "ivib_2d8445c4-f47b-4635-b565-467fc32c4003"
      ],
      "world": {
        "authorId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
        "authorName": "string",
        "capacity": 8,
        "created_at": "2019-08-24T14:15:22Z",
        "defaultContentSettings": {
          "drones": true,
          "emoji": true,
          "pedestals": true,
          "prints": true,
          "props": true,
          "stickers": true
        },
        "description": "string",
        "disabledPropAbilities": [
          null
        ],
        "favorites": 12024,
        "featured": false,
        "heat": 5,
        "id": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd",
        "imageUrl": "string",
        "instances": [
          [
            null,
            null,
            null
          ]
        ],
        "isHypeTrainEligible": true,
        "labsPublicationDate": "none",
        "name": "string",
        "namespace": "string",
        "occupants": 47,
        "organization": "vrchat",
        "popularity": 8,
        "previewYoutubeId": "string",
        "privateOccupants": 1,
        "publicOccupants": 46,
        "publicationDate": "none",
        "recommendedCapacity": 4,
        "releaseStatus": "public",
        "slimInstances": [
          null
        ],
        "storeId": "esto_713b247d-2b5d-41a0-bba3-50db28dc1498",
        "tags": [
          "string"
        ],
        "thumbnailImageUrl": "string",
        "udonProducts": [
          "prod_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"
        ],
        "unityPackages": [
          {
            "assetUrl": "https://api.vrchat.cloud/api/1/file/file_cd0caa7b-69ba-4715-8dfe-7d667a9d2537/65/file",
            "assetUrlObject": {},
            "assetVersion": 4,
            "created_at": "2020-09-10T06:13:27.777Z",
            "id": "unp_52b12c39-4163-457d-a4a9-630e7aff1bff",
            "impostorUrl": "string",
            "impostorizerVersion": "0.17.0",
            "performanceRating": "Excellent",
            "platform": "standalonewindows",
            "pluginUrl": "",
            "pluginUrlObject": {},
            "scanStatus": "string",
            "transpilerVersion": "1.0.0",
            "unitySortNumber": 20180414000,
            "unityVersion": "2022.3.6f1",
            "variant": "string",
            "worldSignature": "AHiPAWerwCpeYrxDthF5TU2SdUWEWnm43UAn8PKRXlS8k8tVRQ=="
          }
        ],
        "updated_at": "2019-08-24T14:15:22Z",
        "urlList": [
          "string"
        ],
        "version": 68,
        "visits": 9988675
      },
      "worldId": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd"
    }
  ]
}

{
  "error": {
    "message": "imageUrl must be a URL˸ 'string'‚ assetUrl must be a URL˸ 'string'",
    "status_code": 400
  }
}

{
  "error": {
    "message": "\"Missing Credentials\"",
    "status_code": 401
  }
}

Discover Instances

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

Example Invalid Field

Example Missing Seller

Example Require Not An Array

`application/json`

`application/json`

`application/json`