VRChat.API 1.6.1

VRChat API Library for C#

A C# client to interact with the unofficial VRChat API. Supports all REST calls specified in https://github.com/vrchatapi/specification.

Disclaimer

This is the official response of the VRChat Team (from Tupper more specifically) on the usage of the VRChat API.

Use of the API using applications other than the approved methods (website, VRChat application) are not officially supported. You may use the API for your own application, but keep these guidelines in mind:

• We do not provide documentation or support for the API.
• Do not make queries to the API more than once per 60 seconds.
• Abuse of the API may result in account termination.
• Access to API endpoints may break at any given time, with no warning.

As stated, this documentation was not created with the help of the official VRChat team. Therefore this documentation is not an official documentation of the VRChat API and may not be always up to date with the latest versions. If you find that a page or endpoint is not longer valid please create an issue and tell us so we can fix it.

Installation

Install with NuGet:

# With .NET CLI
dotnet add package VRChat.API --version <LATEST_VERSION>

# Or with Package Manager
Install-Package VRChat.API -Version <LATEST_VERSION>

Getting Started

The following example code authenticates you with the API, fetches your join-date, and prints the name of a world.

using System;
using System.Diagnostics;
using System.Threading.Tasks;
using VRChat.API.Api;
using VRChat.API.Client;
using VRChat.API.Model;

namespace Example
{
    class Program
    {
        static void Main(string[] args)
        {
            MainAsync().Wait();
            Console.ReadKey();
        }

        static async Task MainAsync()
        {
            // Configure API login credentials
            Configuration config = new Configuration();
            config.Username = "username";
            config.Password = "password";

            try
            {
                // Calling "GetCurrentUser" will log you in.
                AuthenticationApi authApi = new AuthenticationApi(config);
                var user = await authApi.GetCurrentUserAsync();
                Console.WriteLine($"Logged in user {user.DisplayName}, Current Avatar {user.CurrentAvatar}");

                UsersApi userApi = new UsersApi(config);
                var getUser = await userApi.GetUserAsync(user.Id);
                Console.WriteLine($"Found user {getUser.DisplayName}, joined {getUser.DateJoined}");

                WorldsApi worldApi = new WorldsApi(config);
                var world = await worldApi.GetWorldAsync("wrld_ba913a96-fac4-4048-a062-9aa5db092812");
                Console.WriteLine($"Found world {world.Name}, visits: {world.Visits}");
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling API: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Documentation for API Endpoints

All URIs are relative to https://api.vrchat.cloud/api/1

Documentation for Models

• Model.APIConfig
• Model.APIEventConfig
• Model.APIHealth
• Model.AddFavoriteRequest
• Model.Avatar
• Model.AvatarUnityPackageUrlObject
• Model.CreateAvatarRequest
• Model.CreateFileRequest
• Model.CreateFileVersionRequest
• Model.CreateWorldRequest
• Model.CurrentUser
• Model.DeploymentGroup
• Model.DeveloperType
• Model.DownloadURLList
• Model.DynamicContentRow
• Model.Error
• Model.Favorite
• Model.FavoriteGroup
• Model.FavoriteGroupVisibility
• Model.FavoriteType
• Model.File
• Model.FileData
• Model.FileStatus
• Model.FileUploadURL
• Model.FileVersion
• Model.FileVersionUploadStatus
• Model.FinishFileDataUploadRequest
• Model.FriendStatus
• Model.InfoPush
• Model.InfoPushData
• Model.InfoPushDataArticle
• Model.InfoPushDataArticleContent
• Model.InfoPushDataClickable
• Model.Instance
• Model.InstancePlatforms
• Model.InviteMessage
• Model.InviteMessageType
• Model.InviteRequest
• Model.InviteResponse
• Model.License
• Model.LicenseAction
• Model.LicenseGroup
• Model.LicenseType
• Model.LimitedUnityPackage
• Model.LimitedUser
• Model.LimitedWorld
• Model.MIMEType
• Model.ModerateUserRequest
• Model.Notification
• Model.NotificationType
• Model.PastDisplayName
• Model.Permission
• Model.PlayerModeration
• Model.PlayerModerationType
• Model.PublicAnnouncement
• Model.ReleaseStatus
• Model.Response
• Model.Subscription
• Model.SubscriptionPeriod
• Model.Success
• Model.Transaction
• Model.TransactionAgreement
• Model.TransactionStatus
• Model.TransactionSteamInfo
• Model.TransactionSteamWalletInfo
• Model.TwoFactorAuthCode
• Model.UnityPackage
• Model.UpdateAvatarRequest
• Model.UpdateFavoriteGroupRequest
• Model.UpdateInviteMessageRequest
• Model.UpdateUserRequest
• Model.UpdateWorldRequest
• Model.User
• Model.UserExists
• Model.UserState
• Model.UserStatus
• Model.UserSubscription
• Model.Verify2FAResult
• Model.VerifyAuthTokenResult
• Model.World
• Model.WorldMetadata
• Model.WorldPublishStatus

Contributing

Contributions are welcome, but do not add features that should be handled by the OpenAPI specification.

Join the Discord server to get in touch with us.