VRChat.API
1.16.5
See the version list below for details.
dotnet add package VRChat.API --version 1.16.5
NuGet\Install-Package VRChat.API -Version 1.16.5
<PackageReference Include="VRChat.API" Version="1.16.5" />
paket add VRChat.API --version 1.16.5
#r "nuget: VRChat.API, 1.16.5"
// Install VRChat.API as a Cake Addin
#addin nuget:?package=VRChat.API&version=1.16.5
// Install VRChat.API as a Cake Tool
#tool nuget:?package=VRChat.API&version=1.16.5
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 VRChat.API.Api;
using VRChat.API.Client;
using VRChat.API.Model;
// Authentication credentials
Configuration Config = new Configuration();
Config.Username = "username";
Config.Password = "password";
// Create instances of API's we'll need
AuthenticationApi AuthApi = new AuthenticationApi(Config);
UsersApi UserApi = new UsersApi(Config);
WorldsApi WorldApi = new WorldsApi(Config);
try
{
// Calling "GetCurrentUser(Async)" logs you in if you are not already logged in.
CurrentUser CurrentUser = AuthApi.GetCurrentUser();
Console.WriteLine("Logged in as {0}, Current Avatar {1}", CurrentUser.DisplayName, CurrentUser.CurrentAvatar);
User OtherUser = UserApi.GetUser("usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469");
Console.WriteLine("Found user {0}, joined {1}", OtherUser.DisplayName, OtherUser.DateJoined);
World World = WorldApi.GetWorld("wrld_ba913a96-fac4-4048-a062-9aa5db092812");
Console.WriteLine("Found world {0}, visits: {1}", World.Name, World.Visits);
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling API: {0}", e.Message);
Console.WriteLine("Status Code: {0}", e.ErrorCode);
Console.WriteLine(e.ToString());
}
Documentation
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.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- JsonSubTypes (>= 1.9.0)
- Newtonsoft.Json (>= 13.0.1)
- Polly (>= 7.2.3)
- RestSharp (>= 108.0.2)
- System.ComponentModel.Annotations (>= 5.0.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on VRChat.API:
Package | Downloads |
---|---|
VRChat.API.Client
Fluent interface API around VRChat.API, allowing for fluent usage of the library in enterprise-grade environments. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.17.4 | 44 | 5/21/2024 |
1.17.3 | 114 | 4/29/2024 |
1.17.2 | 103 | 4/23/2024 |
1.17.1 | 106 | 4/21/2024 |
1.17.0 | 104 | 4/15/2024 |
1.16.8 | 106 | 4/14/2024 |
1.16.7 | 139 | 3/22/2024 |
1.16.6 | 136 | 2/24/2024 |
1.16.5 | 121 | 2/11/2024 |
1.16.4 | 91 | 2/2/2024 |
1.16.3 | 87 | 1/26/2024 |
1.16.2 | 127 | 1/5/2024 |
1.16.0 | 12,768 | 12/30/2023 |
1.15.0 | 201 | 10/4/2023 |
1.14.0 | 139 | 9/21/2023 |
1.13.0 | 122 | 9/19/2023 |
1.12.0 | 21,341 | 5/31/2023 |
1.11.1 | 439 | 2/19/2023 |
1.11.0 | 261 | 2/11/2023 |
1.9.1 | 557 | 11/17/2022 |
1.9.0 | 298 | 11/17/2022 |
1.8.0 | 331 | 11/4/2022 |
1.7.7 | 407 | 10/16/2022 |
1.7.6 | 357 | 10/16/2022 |
1.7.4 | 471 | 9/8/2022 |
1.7.3 | 402 | 9/3/2022 |
1.7.2 | 492 | 7/6/2022 |
1.7.1 | 572 | 4/27/2022 |
1.7.0 | 441 | 4/15/2022 |
1.6.10 | 434 | 4/9/2022 |
1.6.9 | 527 | 1/27/2022 |
1.6.8 | 444 | 1/22/2022 |
1.6.7 | 432 | 1/20/2022 |
1.6.6 | 439 | 1/16/2022 |
1.6.5 | 337 | 12/19/2021 |
1.6.4-rc1 | 534 | 12/5/2021 |
1.6.3 | 3,310 | 11/26/2021 |
1.6.2 | 2,376 | 11/26/2021 |
1.6.1 | 2,224 | 11/25/2021 |
1.6.0 | 3,175 | 11/25/2021 |
1.5.3 | 299 | 11/23/2021 |
1.5.3-rc01 | 170 | 11/23/2021 |
1.0.0 | 298 | 11/23/2021 |
Automated deployment