v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
MetricsAPI Reference
Discord

Search All Worlds

Search and list any worlds by query filters.

Requests made through this page are proxied through an intermediary server due to Cross-Origin Resource Sharing restrictions.

GET
/worlds

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Query Parameters

featured?boolean

Filters on featured results.

sort?string

The sort order of the results.

Default"popularity"
Value in"popularity" | "heat" | "trust" | "shuffle" | "random" | "favorites" | "reportScore" | "reportCount" | "publicationDate" | "labsPublicationDate" | "created" | "_created_at" | "updated" | "_updated_at" | "order" | "relevance" | "magic" | "name"
user?string

Set to me for searching own worlds.

Value in"me"
userId?string

Filter by UserID.

n?integer

The number of objects to return.

Default60
Range1 <= value <= 100
order?string

Result ordering

Default"descending"
Value in"ascending" | "descending"
offset?integer

A zero-based offset from the default object sorting from where search results start.

Range0 <= value
search?string

Filters by world name.

tag?string

Tags to include (comma-separated). Any of the tags needs to be present.

Length1 <= length
notag?string

Tags to exclude (comma-separated).

Length1 <= length
releaseStatus?string

Filter by ReleaseStatus.

Default"public"
Value in"public" | "private" | "hidden" | "all"
maxUnityVersion?string

The maximum Unity version supported by the asset.

minUnityVersion?string

The minimum Unity version supported by the asset.

platform?string

The platform the asset supports.

noplatform?string

The platform the asset does not support.

fuzzy?boolean
avatarSpecific?boolean

Only search for avatar worlds.

Response Body

application/json

application/json

curl -X GET "https://api.vrchat.cloud/api/1/worlds?featured=true&sort=popularity&user=me&userId=string&n=60&order=descending&offset=0&search=string&tag=string&notag=string&releaseStatus=public&maxUnityVersion=string&minUnityVersion=string&platform=standalonewindows&noplatform=string&fuzzy=true&avatarSpecific=true"
[
  {
    "authorId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
    "authorName": "string",
    "capacity": 8,
    "recommendedCapacity": 16,
    "created_at": "2019-08-24T14:15:22Z",
    "defaultContentSettings": {
      "drones": true,
      "emoji": true,
      "pedestals": true,
      "prints": true,
      "stickers": true,
      "props": true
    },
    "favorites": 12024,
    "visits": 9988675,
    "heat": 5,
    "id": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd",
    "imageUrl": "string",
    "labsPublicationDate": "none",
    "name": "string",
    "occupants": 47,
    "organization": "vrchat",
    "popularity": 8,
    "previewYoutubeId": "string",
    "publicationDate": "none",
    "releaseStatus": "public",
    "storeId": "esto_713b247d-2b5d-41a0-bba3-50db28dc1498",
    "tags": [
      "string"
    ],
    "thumbnailImageUrl": "string",
    "unityPackages": [
      {
        "created_at": "2019-08-24T14:15:22Z",
        "platform": "standalonewindows",
        "unityVersion": "2022.3.6f1"
      }
    ],
    "updated_at": "2019-08-24T14:15:22Z",
    "udonProducts": [
      "prod_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"
    ]
  }
]

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