!> Super Important! Using this API is allowed for non malicious usage. Abuse of the API may result in account termination!
?> These docs are for SDK version 2018.05.04.09.53 and build tag build-18-05-18-noah-salmon
Sections of the documentation which are labeled Outdated means the the article or endpoint is no longer supported be the current API version or we are still working on making sure the endpoint is still working.
Sections labeled Soon are work in progress articles and will be added to the documentation on future updates.
Sections labeled BETA are API endpoints found in the beta client of VRChat, and are subject to change as the features are finalized.
-
VRChatJava (Java) https://github.com/VRChatAPI/VRChatJavaoutdated -
VRChat.Net (C#) https://github.com/VRChatAPI/VRChat.Net
Right now there are 3 different options
- Dev API - https://dev-api.vrchat.cloud/api/1/ (Not Documented)
- Beta API - https://beta-api.vrchat.cloud/api/1/ (Not Documented)
- Release API - https://api.vrchat.cloud/api/1/
In the docs we just use the Release but you can manually change it if needed
VRChat uses the HTTP procotol to get basic information from the server and send information to the server.
Most of the APIs require you to be authenticated.
There are two ways to authenticate (technically one)
- Send the Authorization header with Basic authentication
- After calling the any API with Basic authentication save and reuse the returned
authcookie.
The second option is probably more recommended
Every API requires you to give a special API key. To get it simply call the Remote Config endpoint.
The API key is passed in a query string named apiKey
?> Last Known key is JlE5Jldo5Jibnk5O5hTx6XVqsJu4WJ26