VRChat API: Difference between revisions
From VRChat Wiki
m (Minor; bolded first words of article.) |
(Added "What is VRChat API" and "References" heading; official noticebox.) |
||
| Line 1: | Line 1: | ||
{{Stub}} | {{Noticebox/Official}}{{Stub|Please expand and proofread, while following the [[VRCWiki:Manual of Style|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. | '''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: | |||
<blockquote>''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'''.” <ref>[https://medium.com/vrchat/developer-blog-websockets-b5f0b424d379 Developer Blog — Websockets] published by VRChat on ''Medium''; retrieved November 28, 2024.</ref>''</blockquote> | |||
==Data in VRChat's API== | ==Data in VRChat's API== | ||
| Line 7: | Line 12: | ||
Information from VRChat's API includes the following: | Information from VRChat's API includes the following: | ||
* Login and authentication | *Login and authentication | ||
** Being able to sign in via Steam, Meta, PICO, etc. | **Being able to sign in via Steam, Meta, PICO, etc. | ||
** Signing directly through your VRChat account | **Signing directly through your VRChat account | ||
* Social and friends list | *Social and friends list | ||
** Live instance data (and switching instances) | **Live instance data (and switching instances) | ||
** Data regarding invites, and notifications | **Data regarding invites, and notifications | ||
** Joining and leaving instances | **Joining and leaving instances | ||
** Favorite friends lists | **Favorite friends lists | ||
* SDK asset uploads | *SDK asset uploads | ||
** Your worlds and avatars | **Your worlds and avatars | ||
** Favorite avatars, worlds, etc. | **Favorite avatars, worlds, etc. | ||
** Searching for worlds and avatars | **Searching for worlds and avatars | ||
* Realtime player state changes | *Realtime player state changes | ||
** Status updates, changing bios | **Status updates, changing bios | ||
** Practically anything account-related | **Practically anything account-related | ||
** Changing avatars | **Changing avatars | ||
** Switching instances (and live instance data) | **Switching instances (and live instance data) | ||
* Data being externally streamed to you, via an instance (Udon; Untrusted URLs) | *Data being externally streamed to you, via an instance (Udon; Untrusted URLs) | ||
** Video player data | **Video player data | ||
** Image loading data | **Image loading data | ||
** String loading data | **String loading data | ||
==Official resources== | ==Official resources== | ||
| Line 34: | Line 39: | ||
==See also== | ==See also== | ||
* [[Instances]] | *[[Instances]] | ||
* [[VRChat account]] | *[[VRChat account]] | ||
==References== | |||
<references /> | |||
Revision as of 20:33, 28 November 2024
It is reviewed and approved by the VRCWiki Team. Learn how to contribute to this page by reading the Contribution Guide.
You can help the VRChat Wiki by improving it.
[Reason: Please expand and proofread, while following the Manual of Style.]
[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)
- Data being externally streamed to you, via an instance (Udon; Untrusted URLs)
- Video player data
- Image loading data
- String loading data
Official resources
VRChat's API status can officially be queried here: 
VRChat server status
See also
References
- ↑ Developer Blog — Websockets published by VRChat on Medium; retrieved November 28, 2024.
