VRChat API

From VRChat Wiki
Revision as of 20:33, 28 November 2024 by DAG-XR (talk | contribs) (Added "What is VRChat API" and "References" heading; official noticebox.)
VRLogo.png
V · EThis is an official VRChat information page!
It is reviewed and approved by the VRCWiki Team. Learn how to contribute to this page by reading the Contribution Guide.
Vrrat posed-right.png
V · EThis page is a stub.
You can help the VRChat Wiki by improving it.
[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: Official VRChat source VRChat server status

See also

References

  1. Developer Blog — Websockets published by VRChat on Medium; retrieved November 28, 2024.