VRChat API: Difference between revisions
No edit summary |
m (cite community resources) |
||
| Line 32: | Line 32: | ||
==Official resources== | ==Official resources== | ||
VRChat's API status can officially be queried here: {{VRC link|https://status.vrchat.com/|VRChat server status}} | VRChat's API status can officially be queried here: {{VRC link|https://status.vrchat.com/|VRChat server status}} | ||
== Documentation == | |||
VRChat does not officially document its API or provide support for it<ref>[https://hello.vrchat.com/creator-guidelines VRChat Creator Guidelines] under API Usage / Bots; retrieved January 10, 2025.</ref>. However, community-driven efforts have made API documentation and SDK libraries available for various programming languages. You can find these resources at: | |||
* [https://vrchatapi.github.io VRChat API Documentation] | |||
* [https://github.com/vrchatapi GitHub] | |||
==See also== | ==See also== | ||
Latest revision as of 23:05, 10 January 2025
[Reason: Please expand and proofread, while following the Manual of Style.]
VRChat's application programmer interface (API) is official VRChat data from VRChat's servers, and streamlined to your account, through VRChat client, the VRChat website, or using the VRChat app. The API can also be queried externally.
What is the VRChat API?
VRChat briefly explains what their application programmer interfaces does, and gives examples of information it maintains, on their Developer Blog from 2019:
There are three major parts to VRChat — the client, which handles all of the fun virtual reality stuff, the network layer, which handles the high-speed low-drag communication between users in the virtual realms, and the API, which is responsible for permanent information storage like “who our users are” and “where our users are” and “keeping tabs on a truly spectacular collection of petabytes of avatars loose conglomerations of dynamic bones and particle animations.” [1]
Data in VRChat's API
Information from VRChat's API includes the following:
- Login and authentication
- Being able to sign in via Steam, Meta, PICO, etc.
- Signing directly through your VRChat account
- Social and friends list
- Live instance data (and switching instances)
- Data regarding invites, and notifications
- Joining and leaving instances
- Favorite friends lists
- SDK asset uploads
- Your worlds and avatars
- Favorite avatars, worlds, etc.
- Searching for worlds and avatars
- Realtime player state changes
- Status updates, changing bios
- Practically anything account-related
- Changing avatars
- Switching instances (and live instance data)
Official resources
VRChat's API status can officially be queried here: 
VRChat server status
Documentation
VRChat does not officially document its API or provide support for it[2]. However, community-driven efforts have made API documentation and SDK libraries available for various programming languages. You can find these resources at:
See also
References
- ↑ Developer Blog — Websockets published by VRChat on Medium; retrieved November 28, 2024.
- ↑ VRChat Creator Guidelines under API Usage / Bots; retrieved January 10, 2025.
