v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Get World by ID

Get information about a specific World. Works unauthenticated but when so will always return 0 for certain fields.

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

GET
/worlds/{worldId}

Path Parameters

worldIdstring

Must be a valid world ID.

Response Body

curl -X GET "https://api.vrchat.cloud/api/1/worlds/string"
fetch("https://api.vrchat.cloud/api/1/worlds/string")
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://api.vrchat.cloud/api/1/worlds/string"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "https://api.vrchat.cloud/api/1/worlds/string"

response = requests.request("GET", url)

print(response.text)
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;

HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://api.vrchat.cloud/api/1/worlds/string"))
  .GET()
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}
using System;
using System.Net.Http;
using System.Text;

var client = new HttpClient();
var response = await client.GetAsync("https://api.vrchat.cloud/api/1/worlds/string");
var responseBody = await response.Content.ReadAsStringAsync();
{
  "authorId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
  "authorName": "string",
  "capacity": 8,
  "recommendedCapacity": 4,
  "created_at": "2019-08-24T14:15:22Z",
  "defaultContentSettings": {
    "drones": true,
    "emoji": true,
    "pedestals": true,
    "prints": true,
    "stickers": true,
    "props": true
  },
  "description": "string",
  "favorites": 12024,
  "featured": false,
  "heat": 5,
  "id": "wrld_ba913a96-fac4-4048-a062-9aa5db092812",
  "imageUrl": "string",
  "instances": [
    [
      null,
      null
    ]
  ],
  "labsPublicationDate": "none",
  "name": "string",
  "namespace": "string",
  "occupants": 47,
  "organization": "vrchat",
  "popularity": 8,
  "previewYoutubeId": "string",
  "privateOccupants": 1,
  "publicOccupants": 46,
  "publicationDate": "none",
  "releaseStatus": "public",
  "storeId": "esto_713b247d-2b5d-41a0-bba3-50db28dc1498",
  "tags": [
    "string"
  ],
  "thumbnailImageUrl": "string",
  "unityPackages": [
    {
      "id": "unp_52b12c39-4163-457d-a4a9-630e7aff1bff",
      "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",
      "impostorizerVersion": "0.17.0",
      "performanceRating": "Excellent",
      "platform": "standalonewindows",
      "pluginUrl": "",
      "pluginUrlObject": {},
      "unitySortNumber": 20180414000,
      "unityVersion": "2022.3.6f1",
      "worldSignature": "AHiPAWerwCpeYrxDthF5TU2SdUWEWnm43UAn8PKRXlS8k8tVRQ==",
      "impostorUrl": "string",
      "scanStatus": "string",
      "variant": "string"
    }
  ],
  "updated_at": "2019-08-24T14:15:22Z",
  "urlList": [
    "string"
  ],
  "version": 68,
  "visits": 9988675,
  "udonProducts": [
    "prod_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"
  ]
}

{
  "error": {
    "message": "World wrld_ba913a96-fac4-4048-a062-9aa5db092812 not found",
    "status_code": 404
  }
}