VRChat API

https://vrchat.community
Admin
VRChat API is an unofficial but comprehensive API for integrating with VRChat, providing endpoints...
Tokens:363,874
Snippets:1,550
Trust Score:5.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get Instance using Go

Source: https://vrchat.community/reference/get-instance

A Go example for retrieving instance details. This code snippet shows how to make the GET request and handle the JSON response.

```go
package main

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

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

	client := &http.Client{}

	req, err := http.NewRequest("GET", url, nil)
	if err != nil {
		fmt.Println("Error creating request:", err)
		return
	}

	req.Header.Set("cookie", "auth=YOUR_AUTH_TOKEN")

	resp, err := client.Do(req)
	if err != nil {
		fmt.Println("Error sending request:", err)
		return
	}
	defer resp.Body.Close()

	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		fmt.Println("Error reading response body:", err)
		return
	}

	fmt.Println(string(body))
}

```

--------------------------------

### Getting Started and Authentication

Source: https://vrchat.community/dotnet

Example code for authenticating with the VRChat API using username, password, and a two-factor secret, and performing basic user and world lookups.

```APIDOC
## Getting Started

The following example code authenticates you with the API and logs you in. If you use manual or email-based two-factor authentication, scroll to the Manual Authentication section below for an example.
```csharp
using System;
using VRChat.API.Client;

// WithApplication or WithUserAgent is required or VRChat will reject your requests
IVRChat vrchat = new VRChatClientBuilder() // More options available
    .WithUsername("username")
    .WithPassword("password")
    .WithTwoFactorSecret("twoFactorSecret")
    .WithApplication(name: "Example", version: "1.0.0", contact: "CONTACT_EMAIL")
    .Build();

// Reccomended to set up 2FA on your account for seamless login

// There is also IVRChat.TryLoginAsync()
var currentUser = await vrchat.LoginAsync();
Console.WriteLine($"Logged in as {currentUser.DisplayName}!");

var user = await vrchat.Users.GetUserAsync("usr_f2049d71-e76b-42d2-a8bd-43deec9c004e");
Console.WriteLine($"Found user {user.DisplayName}, joined at {user.DateJoined}");

var world = await vrchat.Worlds.GetWorldAsync("wrld_ba913a96-fac4-4048-a062-9aa5db092812");
Console.WriteLine($"Found world {world.Name}, with {world.Visits} visits");
```

The builder is quite flexible and will let you customize as you see fit.
Recommended
It's recommended to set up 2FA on your account with a TOTP secret for seamless automated login.
### Authentication with Cookies
You can set authentication cookies yourself by attaching them during the client building process:
```csharp
IVRChat vrchat = new VRChatClientBuilder()
    .WithUsername("username")
    .WithPassword("password")
    .WithTwoFactorSecret("twoFactorSecret")
    .WithApplication(name: "Example", version: "1.0.0", contact: "CONTACT_EMAIL")
    .WithAuthCookie("auth cookie", "twoFactorAuth cookie")
    .Build();
```
```

--------------------------------

### Get Instance using C#

Source: https://vrchat.community/reference/get-instance

C# code example for fetching instance data. This uses HttpClient to make the GET request and includes necessary headers for authentication.

```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;

public class GetInstanceExample
{
    public static async Task Main(string[] args)
    {
        string worldId = "string";
        string instanceId = "string";
        string authToken = "YOUR_AUTH_TOKEN";

        using (HttpClient client = new HttpClient())
        {
            client.DefaultRequestHeaders.Add("cookie", $"auth={authToken}");
            client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));

            string url = $"https://api.vrchat.cloud/api/1/instances/{worldId}:{instanceId}";

            try
            {
                HttpResponseMessage response = await client.GetAsync(url);
                response.EnsureSuccessStatusCode(); // Throw an exception if the status code is not success

                string responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseBody);
            }
            catch (HttpRequestException e)
            {
                Console.WriteLine($"Request error: {e.Message}");
            }
        }
    }
}

```

--------------------------------

### Successful 2FA Setup Response

Source: https://vrchat.community/reference/enable2fa

Example of a successful response when initiating 2FA setup, providing QR code data and a secret key.

```json
{
  "qrCodeDataUrl": "string",
  "secret": "string"
}

```

--------------------------------

### Get User Product Listings (cURL)

Source: https://vrchat.community/reference/get-product-listings

Example of how to make a GET request to retrieve a user's product listings using cURL. Ensure you replace 'string' with a valid user ID and provide your authentication token.

```shell
curl -X GET "https://api.vrchat.cloud/api/1/user/string/listings" \
  --cookie "auth="

```

--------------------------------

### Get Instance using Java

Source: https://vrchat.community/reference/get-instance

Java code snippet for making a GET request to retrieve instance information. This example uses the standard Java HTTP client.

```java
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class GetInstance {

    public static void main(String[] args) {
        String worldId = "string";
        String instanceId = "string";
        String authToken = "YOUR_AUTH_TOKEN";

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(String.format("https://api.vrchat.cloud/api/1/instances/%s:%s", worldId, instanceId)))
                .header("cookie", "auth=" + authToken)
                .header("accept", "application/json")
                .GET()
                .build();

        try {
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
            System.out.println("Status Code: " + response.statusCode());
            System.out.println("Response Body: " + response.body());
        } catch (IOException | InterruptedException e) {
            e.printStackTrace();
        }
    }
}

```

--------------------------------

### C# Example for Get User Group Instances

Source: https://vrchat.community/reference/get-user-group-instances

This C# code provides an example of fetching user group instances using the VRChat API. It utilizes `HttpClient` for the request and requires an API token for authentication.

```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;

public class GetUserGroupInstances
{
    public static async Task Main(string userId)
    {
        using (HttpClient client = new HttpClient())
        {
            client.DefaultRequestHeaders.Add("Content-Type", "application/json");
            client.DefaultRequestHeaders.Add("Authorization", "Bearer YOUR_API_TOKEN");

            HttpResponseMessage response = await client.GetAsync($"https://api.vrchat.cloud/api/1/users/{userId}/instances/groups");
            string responseBody = await response.Content.ReadAsStringAsync();
            Console.WriteLine(responseBody);
        }
    }
}
```

--------------------------------

### Download File Version (JavaScript)

Source: https://vrchat.community/reference/download-file-version

Example of downloading a file version using JavaScript. This snippet demonstrates making a GET request with authentication.

```javascript
const VRChatAPI = require('vrchatapi');

const api = new VRChatAPI({
    cookie: 'auth=<token>'
});

async function downloadFile() {
    try {
        const fileId = 'file_00000000-0000-0000-0000-000000000000';
        const versionId = 1;
        const response = await api.downloadFile(fileId, versionId);
        console.log('File downloaded successfully:', response);
    } catch (error) {
        console.error('Error downloading file:', error);
    }
}

downloadFile();

```

--------------------------------

### List User Notifications (JavaScript)

Source: https://vrchat.community/reference/get-notifications

Example of how to fetch user notifications using JavaScript. This snippet demonstrates a basic GET request to the notifications endpoint.

```javascript
const response = await fetch("https://api.vrchat.cloud/api/1/auth/user/notifications", {
  "method": "GET",
  "headers": {
    "accept": "application/json",
    "cookie": "auth="
  }
});
const json = await response.json();

console.log(json);

```

--------------------------------

### Basic SDK Usage and Configuration

Source: https://vrchat.community/python

Demonstrates how to import the SDK, set up configuration with credentials, create an ApiClient, and initialize an endpoint client like AuthenticationApi. Ensure to set a User-Agent string as required by VRChat.

```python
import vrchatapi
from vrchatapi.api import authentication_api

configuration = vrchatapi.Configuration(
    username="your_username_or_email",
    password="your_password",
)

# Build an ApiClient from the configuration (credentials + HTTP session state).
with vrchatapi.ApiClient(configuration) as api_client:
    # VRChat requires app name + version + contact info in User-Agent.
    api_client.user_agent = "ExampleProgram/0.0.1 my@email.com"

    # Create the AuthenticationApi endpoint client using this shared ApiClient.
    # You can do this for other endpoint clients similarly.
    auth_api = authentication_api.AuthenticationApi(api_client)

```

--------------------------------

### Install Keyv File Adapter

Source: https://vrchat.community/javascript

Install the keyv-file package to enable persistent session storage.

```bash
npm install keyv-file
```

--------------------------------

### Get Store Shelves Response Example

Source: https://vrchat.community/reference/get-store-shelves

Example JSON response structure for the 'Get Store Shelves' API endpoint.

```json
[
  {
    "highlightListing": {
      "active": true,
      "buyerRefundable": true,
      "description": "string",
      "displayName": "string",
      "duration": 0,
      "durationType": "string",
      "groupIcon": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
      "groupId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
      "groupName": "string",
      "hasAvatar": true,
      "hasUdon": true,
      "hydratedProducts": [
        {
          "archived": true,
          "created": "2019-08-24T14:15:22Z",
          "description": "string",
          "displayName": "string",
          "groupAccess": false,
          "groupAccessRemove": false,
          "groupId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
          "groupRoleId": "grol_459d3911-f672-44bc-b84d-e54ffe7960fe",
          "id": "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4",
          "imageId": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
          "parentListings": [
            "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4"
          ],
          "productType": "inventory",
          "sellerDisplayName": "string",
          "sellerId": "string",
          "tags": [
            "string"
          ],
          "updated": "2019-08-24T14:15:22Z",
          "useForSubscriberList": false
        }
      ],
      "id": "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4",
      "imageId": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
      "imageUrl": "string",
      "listingType": "duration",
      "listingVariants": [
        {
          "effectiveFrom": "2019-08-24T14:15:22Z",
          "listingVariantId": "listvar_e8658b56-1662-436c-935a-afcf6a7d4fed",
          "nonRefundable": true,
          "quantity": 0,
          "sellerVariant": true,
          "unitPriceTokens": 0
        }
      ],
      "permanent": true,
      "priceTokens": 0,
      "productIds": [
        "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4"
      ],
      "productType": "inventory",
      "products": [
        {}
      ],
      "quantifiable": true,
      "recurrable": true,
      "refundable": true,
      "sellerDisplayName": "string",
      "sellerId": "string",
      "soldByVrc": true,
      "stackable": true,
      "storeIds": [
        "string"
      ],
      "subtitle": "string",
      "tags": [
        "string"
      ],
      "vrcPlusDiscountPrice": 0,
      "whenToExpire": "2019-08-24T14:15:22Z"
    },
    "highlightListingId": "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4",
    "id": "ess_964dd7aa-f881-4ba1-adf7-261e906b9189",
    "listingIds": [
      "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4"
    ],
    "listings": [
      {
        "active": true,
        "buyerRefundable": true,
        "description": "string",
        "displayName": "string",
        "duration": 0,
        "durationType": "string",
        "groupIcon": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
        "groupId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
        "groupName": "string",
        "hasAvatar": true,
        "hasUdon": true,
        "hydratedProducts": [
          {
            "archived": true,
            "created": "2019-08-24T14:15:22Z",
            "description": "string",
            "displayName": "string",
            "groupAccess": false,
            "groupAccessRemove": false,
            "groupId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
            "groupRoleId": "grol_459d3911-f672-44bc-b84d-e54ffe7960fe",
            "id": "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4",
            "imageId": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
            "parentListings": [
              "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4"
            ],
            "productType": "inventory",
            "sellerDisplayName": "string",
            "sellerId": "string",
            "tags": [
              "string"
            ],
            "updated": "2019-08-24T14:15:22Z",
            "useForSubscriberList": false
          }
        ],
        "id": "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4",
        "imageId": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
        "imageUrl": "string",
        "listingType": "duration",
        "listingVariants": [
          {
            "effectiveFrom": "2019-08-24T14:15:22Z",

```

--------------------------------

### Installation

Source: https://vrchat.community/dotnet

Install the VRChat API client using the .NET CLI.

```APIDOC
## Installation

Install with NuGet:
```
dotnet add package VRChat.API
```

### Dependency Injection Package

If you're working with Dependency Injection like ASP.NET Core or Discord.Net, make sure to also install the DI package:
```
dotnet add package VRChat.API.Extensions.Hosting
```
```

--------------------------------

### Get Inventory using cURL

Source: https://vrchat.community/reference/get-inventory

Example of how to make a GET request to the inventory endpoint using cURL. Ensure you replace 'auth=' with your actual authentication token.

```curl
curl -X GET "https://api.vrchat.cloud/api/1/inventory" \
  --cookie "auth="

```

--------------------------------

### Create File - Response Example

Source: https://vrchat.community/reference/create-file

This is an example of a successful response when creating a file. It includes the file ID, name, extension, owner, and version details.

```JSON
{
  "id": "file_00000000-0000-0000-0000-000000000000",
  "name": "Avatar - Test Avatar - Unity package - 2017․4․28f1_3_standalonewindows_Release",
  "extension": ".unitypackage",
  "mimeType": "application/gzip",
  "ownerId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
  "tags": [],
  "versions": [
    {
      "created_at": "2019-08-15T11:04:37.910Z",
      "status": "complete",
      "version": 0
    },
    {
      "created_at": "2019-08-15T11:04:49.702Z",
      "delta": {
        "category": "queued",
        "fileName": "Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage.delta",
        "md5": "",
        "sizeInBytes": 0,
        "status": "none",
        "uploadId": "",
        "url": "https://s3.us-east-1.amazonaws.com/files.vrchat.cloud/Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage.delta"
      },
      "file": {
        "category": "multipart",
        "fileName": "Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage",
        "md5": "xxxxxxxxxxxxxxxxxxx==",
        "sizeInBytes": 303055180,
        "status": "complete",
        "uploadId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "url": "https://s3.us-east-1.amazonaws.com/files.vrchat.cloud/Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage"
      },
      "signature": {
        "category": "simple",
        "fileName": "Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage.signature",
        "md5": "xxxxxxxxxxxxxxxx==",
        "sizeInBytes": 532748,
        "status": "complete",
        "uploadId": "",
        "url": "https://s3.us-east-1.amazonaws.com/files.vrchat.cloud/Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage.signature"
      },
      "status": "complete",
      "version": 1
    }
  ]
}
```

--------------------------------

### Get Current User with cURL

Source: https://vrchat.community/reference/get-current-user

This example shows how to make a GET request to the /api/1/auth/user endpoint using cURL. Ensure you include the Authorization header with your credentials.

```curl
curl -X GET "https://api.vrchat.cloud/api/1/auth/user" \
  -H "Authorization: Basic Og=="
```

--------------------------------

### Install VRChat.API NuGet Package

Source: https://vrchat.community/dotnet

Install the main VRChat API client package using the .NET CLI.

```bash
dotnet add package VRChat.API
```

--------------------------------

### Get Bulk Gift Purchases - Success Response Example

Source: https://vrchat.community/reference/get-bulk-gift-purchases

An example of a successful response body when retrieving bulk gift purchases. This indicates an empty list of purchases.

```json
[
  {}
]

```

--------------------------------

### Install VRChat.API Dependency Injection Package

Source: https://vrchat.community/dotnet

Install the extension package for .NET Dependency Injection, useful for frameworks like ASP.NET Core.

```bash
dotnet add package VRChat.API.Extensions.Hosting
```

--------------------------------

### HTTP GET Request with Redirect

Source: https://vrchat.community/shortlinks

Example of an HTTP GET request to a VRChat short domain that results in a 302 Found redirect. Ensure a User-Agent header is included for API endpoints.

```http
GET /VRCHAT.0000 HTTP/1.1
Host: vrc.group
User-Agent: example/4.2.67 example@vrchat.community; https://discord.gg/vrchat; https://github.com/vrchatapi/vrchat.community
Accept: */*

HTTP/1.1 302 Found
Date: Mon, 06 Apr 2026 21:52:45 GMT
Content-Length: 0
Connection: keep-alive
Location: https://vrchat.com/api/1/groups/redirect/VRCHAT.0000


```

--------------------------------

### Get Instance using JavaScript

Source: https://vrchat.community/reference/get-instance

Demonstrates fetching instance data with JavaScript. This example uses the 'fetch' API and requires a valid world ID, instance ID, and authentication cookie.

```javascript
const worldId = "string";
const instanceId = "string";

fetch(`https://api.vrchat.cloud/api/1/instances/${worldId}:${instanceId}`, {
  method: "GET",
  headers: {
    "accept": "application/json",
    "cookie": "auth=YOUR_AUTH_TOKEN"
  }
})
  .then(response => {
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    return response.json();
  })
  .then(data => {
    console.log(data);
  })
  .catch(error => {
    console.error("Error fetching instance data:", error);
  });

```

--------------------------------

### Get Content Agreement Status cURL Example

Source: https://vrchat.community/reference/get-content-agreement-status

Use this cURL command to send a GET request to the agreement endpoint. Ensure you replace placeholder values with actual data and include the authorization cookie.

```curl
curl -X GET "https://api.vrchat.cloud/api/1/agreement?agreementCode=content.copyright.owned&contentId=avtr_c38a1615-5bf5-42b4-84eb-a8b6c37cbd11&version=1" \
  --cookie "auth="

```

--------------------------------

### Successful Response Example

Source: https://vrchat.community/reference/get-group-next-calendar-event

This is an example of a successful JSON response when retrieving a group's next calendar event. It contains details about the event such as title, description, start and end times, and owner information.

```json
{
  "accessType": "group",
  "category": "performance",
  "closeInstanceAfterEndMinutes": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "durationInMs": 0,
  "endsAt": "2019-08-24T14:15:22Z",
  "featured": true,
  "guestEarlyJoinMinutes": 0,
  "hostEarlyJoinMinutes": 0,
  "id": "cal_6b182f0c-61ef-4bdf-97fe-94f63bcba27b",
  "imageId": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
  "imageUrl": "string",
  "interestedUserCount": 0,
  "isDraft": true,
  "languages": [
    "eng"
  ],
  "ownerId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
  "platforms": [
    "android"
  ],
  "roleIds": [
    "grol_459d3911-f672-44bc-b84d-e54ffe7960fe"
  ],
  "startsAt": "2019-08-24T14:15:22Z",
  "tags": [
    "string"
  ],
  "title": "string",
  "type": "event",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userInterest": {
    "createdAt": "2019-08-24T14:15:22Z",
    "isFollowing": true,
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "usesInstanceOverflow": true
}

```

--------------------------------

### Installation

Source: https://vrchat.community/typescript

Install the VRChat.js SDK using npm.

```APIDOC
## Install

To use the VRChat.js SDK, you need to install it using one of the following methods:

npm
pnpm
yarn
bun

```
npm install vrchat
```
```

--------------------------------

### Basic Usage

Source: https://vrchat.community/typescript

Import the VRChat class and create an instance with application details.

```APIDOC
## Usage

You can import the VRChat class from the SDK and create an instance of it, providing your application details such as name, version, and contact information.

```typescript
import { VRChat } from "vrchat";

const vrchat = new VRChat({
  /**
   * When using the VRChat API, you must provide an application name, version, and contact information.
   * This is used to identify your application to VRChat, and to provide support if needed.
   */
  application: {
    name: "Example",
    version: "1.5.1",
    /**
     * An email, or a URL to a support page.
     */
    contact: "you@example.com",
  },
});
```
```

--------------------------------

### Java Example for Get User Group Instances

Source: https://vrchat.community/reference/get-user-group-instances

This Java code snippet illustrates how to retrieve user group instances via the VRChat API. It uses the Apache HttpClient library for making the GET request and includes authorization.

```java
import java.io.IOException;
import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class GetUserGroupInstances {

    public static void main(String[] args) throws IOException {

        CloseableHttpClient client = HttpClients.createDefault();
        HttpGet request = new HttpGet("https://api.vrchat.cloud/api/1/users/string/instances/groups");

        request.addHeader("Content-Type", "application/json");
        request.addHeader("Authorization", "Bearer YOUR_API_TOKEN");

        CloseableHttpResponse response = client.execute(request);

        try {
            HttpEntity entity = response.getEntity();
            String result = EntityUtils.toString(entity);
            System.out.println(result);
        } finally {
            client.close();
            response.close();
        }
    }
}
```

--------------------------------

### Get Instance using cURL

Source: https://vrchat.community/reference/get-instance

Example of how to retrieve instance information using cURL. Ensure you replace 'string:string' with valid world and instance IDs and provide your authentication token.

```curl
curl -X GET "https://api.vrchat.cloud/api/1/instances/string:string" \
  --cookie "auth="

```

--------------------------------

### Get Product Listing (cURL)

Source: https://vrchat.community/reference/get-product-listing

Use this cURL command to fetch a product listing. Ensure you replace 'string' with a valid product ID and provide your authentication token in the cookie.

```bash
curl -X GET "https://api.vrchat.cloud/api/1/listing/string" \
  --cookie "auth="

```

--------------------------------

### Get User Mutual Friends Response (Success)

Source: https://vrchat.community/reference/get-mutual-friends

Example of a successful JSON response containing a list of mutual friends.

```json
[
  {
    "avatarThumbnail": "https://api.vrchat.cloud/api/1/image/file_aae83ed9-d42d-4d72-9f4b-9f1e41ed17e1/1/256",
    "currentAvatarImageUrl": "https://api.vrchat.cloud/api/1/file/file_ae46d521-7281-4b38-b365-804b32a1d6a7/1/file",
    "currentAvatarTags": [
      "string"
    ],
    "currentAvatarThumbnailImageUrl": "https://api.vrchat.cloud/api/1/image/file_aae83ed9-d42d-4d72-9f4b-9f1e41ed17e1/1/256",
    "displayName": "string",
    "id": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
    "imageUrl": "string",
    "profilePicOverride": "string",
    "status": "active",
    "statusDescription": "string"
  }
]

```

--------------------------------

### Get User Mutual Friends (cURL)

Source: https://vrchat.community/reference/get-mutual-friends

Example using cURL to fetch mutual friends. Requires an authorization cookie.

```shell
curl -X GET "https://api.vrchat.cloud/api/1/users/string/mutuals/friends" \
  --cookie "auth="

```

--------------------------------

### Go Example for Get User Group Instances

Source: https://vrchat.community/reference/get-user-group-instances

This Go program shows how to retrieve user group instances from the VRChat API. It utilizes the 'net/http' package for making the request and includes authorization.

```go
package main

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

func main() {

	client := &http.Client{}

	req, err := http.NewRequest("GET", "https://api.vrchat.cloud/api/1/users/string/instances/groups", nil)

	if err != nil {
		fmt.Println(err)
		return
	}

	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "Bearer YOUR_API_TOKEN")

	resp, err := client.Do(req)

	if err != nil {
		fmt.Println(err)
		return
	}

	defer resp.Body.Close()

	body, err := ioutil.ReadAll(resp.Body)

	if err != nil {
		fmt.Println(err)
		return
	}

	fmt.Println(string(body))
}
```

--------------------------------

### Get Store Shelves (cURL)

Source: https://vrchat.community/reference/get-store-shelves

Example of how to retrieve store shelves using cURL. Requires a store ID and an authorization cookie.

```bash
curl -X GET "https://api.vrchat.cloud/api/1/economy/store/shelves?storeId=esto_713b247d-2b5d-41a0-bba3-50db28dc1498" \
  --cookie "auth="

```

--------------------------------

### Get User Product Listings Response (200 OK)

Source: https://vrchat.community/reference/get-product-listings

Example JSON response when successfully retrieving a user's product listings. This structure details various attributes of the listings, including product information and pricing.

```json
[
  {
    "active": true,
    "buyerRefundable": true,
    "description": "string",
    "displayName": "string",
    "duration": 0,
    "durationType": "string",
    "groupIcon": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
    "groupId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
    "groupName": "string",
    "hasAvatar": true,
    "hasUdon": true,
    "hydratedProducts": [
      {
        "archived": true,
        "created": "2019-08-24T14:15:22Z",
        "description": "string",
        "displayName": "string",
        "groupAccess": false,
        "groupAccessRemove": false,
        "groupId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
        "groupRoleId": "grol_459d3911-f672-44bc-b84d-e54ffe7960fe",
        "id": "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4",
        "imageId": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
        "parentListings": [
          "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4"
        ],
        "productType": "inventory",
        "sellerDisplayName": "string",
        "sellerId": "string",
        "tags": [
          "string"
        ],
        "updated": "2019-08-24T14:15:22Z",
        "useForSubscriberList": false
      }
    ],
    "id": "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4",
    "imageId": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
    "imageUrl": "string",
    "listingType": "duration",
    "listingVariants": [
      {
        "effectiveFrom": "2019-08-24T14:15:22Z",
        "listingVariantId": "listvar_e8658b56-1662-436c-935a-afcf6a7d4fed",
        "nonRefundable": true,
        "quantity": 0,
        "sellerVariant": true,
        "unitPriceTokens": 0
      }
    ],
    "permanent": true,
    "priceTokens": 0,
    "productIds": [
      "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4"
    ],
    "productType": "inventory",
    "products": [
      {}
    ],
    "quantifiable": true,
    "recurrable": true,
    "refundable": true,
    "sellerDisplayName": "string",
    "sellerId": "string",
    "soldByVrc": true,
    "stackable": true,
    "storeIds": [
      "string"
    ],
    "subtitle": "string",
    "tags": [
      "string"
    ],
    "vrcPlusDiscountPrice": 0,
    "whenToExpire": "2019-08-24T14:15:22Z"
  }
]

```

--------------------------------

### Get Recent Subscription (cURL)

Source: https://vrchat.community/reference/get-recent-subscription

Example using cURL to fetch the most recent user subscription. Ensure you include your authorization cookie.

```shell
curl -X GET "https://api.vrchat.cloud/api/1/user/subscription/recent" \
  --cookie "auth="

```

--------------------------------

### List Files API Response Example

Source: https://vrchat.community/reference/get-files

This is an example of the JSON response when listing files. It details file properties and version information.

```json
[
  {
    "animationStyle": "bats",
    "extension": ".unitypackage",
    "frames": 2,
    "framesOverTime": 1,
    "id": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
    "loopStyle": "linear",
    "maskTag": "circle",
    "mimeType": "image/jpeg",
    "modifiedThumbnailFileName": "thumbnails/file_00000000-0000-0000-0000-000000000000.ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff.1.modified-thumbnail-256.png",
    "name": "Example File",
    "ownerId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
    "tags": [
      "string"
    ],
    "versions": [
      {
        "created_at": "2019-08-24T14:15:22Z",
        "deleted": true,
        "delta": {
          "category": "multipart",
          "fileName": "string",
          "md5": "string",
          "sizeInBytes": 0,
          "status": "complete",
          "uploadId": "",
          "url": "string"
        },
        "file": {
          "category": "multipart",
          "fileName": "string",
          "md5": "string",
          "sizeInBytes": 0,
          "status": "complete",
          "uploadId": "",
          "url": "string"
        },
        "signature": {
          "category": "multipart",
          "fileName": "string",
          "md5": "string",
          "sizeInBytes": 0,
          "status": "complete",
          "uploadId": "",
          "url": "string"
        },
        "status": "complete",
        "version": 0
      }
    ]
  }
]

```

--------------------------------

### Get Prop by ID (cURL)

Source: https://vrchat.community/reference/get-prop

Example using cURL to fetch a Prop object by its ID. Ensure you include the authorization cookie.

```shell
curl -X GET "https://api.vrchat.cloud/api/1/props/prop_829ba6f6-b837-49d9-b9a9-056b82103b58" \
  --cookie "auth="

```

--------------------------------

### Install VRChat.js SDK using npm

Source: https://vrchat.community/javascript

Install the VRChat.js SDK using npm. This is the first step to using the SDK in your JavaScript project.

```bash
npm install vrchat
```

--------------------------------

### Get User Notes (cURL)

Source: https://vrchat.community/reference/get-user-notes

Example of how to fetch user notes using cURL. Ensure you replace 'auth=' with your actual authentication token.

```shell
curl -X GET "https://api.vrchat.cloud/api/1/userNotes" \
  --cookie "auth="

```

--------------------------------

### Get Instance using Python

Source: https://vrchat.community/reference/get-instance

Python script to fetch instance data. It uses the 'requests' library and requires a valid world ID, instance ID, and authentication token.

```python
import requests

world_id = "string"
instance_id = "string"
auth_token = "YOUR_AUTH_TOKEN"

url = f"https://api.vrchat.cloud/api/1/instances/{world_id}:{instance_id}"

headers = {
    "accept": "application/json"
}

cookies = {
    "auth": auth_token
}

try:
    response = requests.get(url, headers=headers, cookies=cookies)
    response.raise_for_status()  # Raise an exception for bad status codes
    instance_data = response.json()
    print(instance_data)
except requests.exceptions.RequestException as e:
    print(f"Error fetching instance data: {e}")

```

--------------------------------

### Example InfoPush Response

Source: https://vrchat.community/reference/get-info-push

This is an example JSON response from the infoPush endpoint, detailing a build configuration notice with version information.

```json
[
  {
    "id": "build-config",
    "createdAt": "2021-08-21T04:27:05+00:00",
    "data": {
      "version": "2021.3.4"
    },
    "hash": "a76e7da333c6a5a8f7ec2adee064cac9",
    "isEnabled": true,
    "priority": 1000,
    "releaseStatus": "public",
    "tags": [
      "high-priority",
      "user-all"
    ],
    "updatedAt": "2021-09-18T04:37:29+00:00"
  }
]
```
Tokens:
Raw