VRChat API: Difference between revisions
From VRChat Wiki
Added "See also" heading; included Instances and VRChat account. |
m Category:Needs images |
||
| (11 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
<languages/> | |||
<translate> | |||
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. | <!--T:1--> | ||
'''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. | |||
== | <!--T:2--> | ||
==About== | |||
[[File:API Team2021.webp|thumb|Seven API team members, pose for a in-game photo in a server room. Photo from 2021.]] | |||
VRChat briefly explains what their application programmer interfaces does, and gives examples of information it maintains, on their Developer Blog from 2019<ref>[https://medium.com/vrchat/developer-blog-websockets-b5f0b424d379 Developer Blog — Websockets] published by VRChat on ''Medium''; retrieved November 28, 2024.</ref>: | |||
<!--T:3--> | |||
{{Quote|''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'''." ''}} | |||
==Data== <!--T:4--> | |||
<!--T:10--> | |||
Information from VRChat's API includes the following: | Information from VRChat's API includes the following: | ||
* Login and authentication | <!--T:5--> | ||
** Being able to sign in via Steam, Meta, PICO, etc. | *Login and authentication | ||
** Signing directly through your VRChat account | **Being able to sign in via Steam, Meta, PICO, etc. | ||
* Social and friends list | **Signing directly through your VRChat account | ||
** Live instance data (and switching instances) | *Social and friends list | ||
** Data regarding invites, and notifications | **Live instance data (and switching instances) | ||
** Joining and leaving instances | **Data regarding invites, and notifications | ||
** Favorite friends lists | **Joining and leaving instances | ||
* SDK asset uploads | **Favorite friends lists | ||
** Your worlds and avatars | *SDK asset uploads | ||
** Favorite avatars, worlds, etc. | **Your worlds and avatars | ||
** Searching for worlds and avatars | **Favorite avatars, worlds, etc. | ||
* Realtime player state changes | **Searching for worlds and avatars | ||
** Status updates, changing bios | *Realtime player state changes | ||
** Practically anything account-related | **Status updates, changing bios | ||
** Changing avatars | **Practically anything account-related | ||
** Switching instances (and live instance data) | **Changing avatars | ||
**Switching instances (and live instance data) | |||
<!--T:6--> | |||
==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}} | ||
<!--T:7--> | |||
== 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: | |||
<!--T:11--> | |||
* [https://vrchat.community VRChat.community - API documentation & SDKs] | |||
* [https://github.com/vrchatapi GitHub] | |||
<!--T:8--> | |||
==See also== | ==See also== | ||
* [[Instances]] | *[[Special:MyLanguage/Instances|Instances]] | ||
* [[VRChat account]] | *[[Special:MyLanguage/VRChat account|VRChat account]] | ||
==References== <!--T:9--> | |||
<!--T:12--> | |||
<references /> | |||
</translate> | |||
[[Category:Needs images]] | |||
Latest revision as of 05:41, 15 April 2026
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.
About
VRChat briefly explains what their application programmer interfaces does, and gives examples of information it maintains, on their Developer Blog from 2019[1]:
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."
Data
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.
