[ Web Proxy ]
URL:
Viewing: https://vrchatapi.github.io [Back]  [Original]
VRChat.community
Metrics
SDKs

Introduction

VRChat.communityFrequently asked questionsContributing

Guides

InstancesShort LinksWebsocket API

SDKs

TypeScriptJavaScriptPythonDart.NETJavaRust

API Reference

Economy
Create Product Listing POSTCreate Product POSTDelete Product Listing DELETEDelete Product DELETEGet Active Licenses GETGet Balance Earnings GETGet Balance GETGet Bulk Gift Purchases GETGet Current Subscriptions GETGet Earnings Metrics GETGet Economy Account GETGet Economy Balances GETGet Economy Payout Status GETGet Economy Payouts GETGet License Group GETGet Product Listing (alternate) GETGet Product Listing GETGet User Product Listings GETGet Product Purchase History GETGet Product Purchase Stacks GETGet Product Purchase GETGet Product Purchases GETGet Recent Subscription GETGet Seller Eligibility GETGet Steam Transaction GETList Steam Transactions GETGet Store Shelves GETGet Store GETList Subscriptions GETGet Tilia Status GETGet Tilia TOS Agreement Status GETList Token Bundles GETGet User Credits Eligibility GETGet User Subscription Eligibility GETGet User Tilia KYC GETList Stores GETList User Products GETPurchase Product Listing POSTUpdate Product Listing PUTUpdate Product PUTUpdate Tilia TOS Agreement Status PUT
Groups
Add Group Gallery Image POSTAdd Role to GroupMember PUTCreate a post in a Group POSTBan Group Member POSTBlock Group POSTCancel Group Join Request DELETECancel Group Transfer DELETECreate Group Announcement POSTCreate Group Gallery POSTInvite User to Group POSTCreate GroupRole POSTCreate Group POSTDecline Invite from Group PUTDelete Group Announcement DELETEDelete Group Gallery Image DELETEDelete Group Gallery DELETEDelete User Invite DELETEDelete a Group post DELETEDelete Group Role DELETEDelete Group DELETEGet Group Announcement GETGet Group Audit Log Entry Types GETGet Group Audit Logs GETGet Group Bans GETGet Group Gallery Images GETGet Group Instances GETGet Group Invites Sent GETGet Group Member GETList Group Members GETList Group Permissions GETGet posts from a Group GETGet Group Join Requests GETGet Group Role Templates GETGet Group Roles GETGet Group Transferability GETGet Group by ID GETInitiate or Accept Group Transfer POSTJoin Group POSTKick Group Member DELETELeave Group POSTRemove Role from GroupMember DELETERespond Group Join request PUTSearch Group Members GETSearch Group GETUnban Group Member DELETEUpdate Group Gallery PUTUpdate Group Member PUTEdits a Group post PUTUpdate Group Representation PUTUpdate Group Role PUTUpdate Group PUT
Icon for VRChat.community [Icon for VRChat.community]
VRChat.communityAPI documentation, SDKs, and more
Search
K
MetricsSDKs
Discord
VRChat.community

VRChat.community

A community-driven project that provides documentation, tools, and resources for developers working with the VRChat API. This project fills the gap left by VRChat's lack of API documentation, tooling and support.

Edit this page
Aries Clark's avatar [Aries Clark's avatar]French Fox's avatar [French Fox's avatar]Prince Lumine's avatar [Prince Lumine's avatar]Vinyarion's avatar [Vinyarion's avatar]JelleJurre's avatar [JelleJurre's avatar]BarricadeBandit's avatar [BarricadeBandit's avatar]1+

Last updated on

VRChat's API is not officially supported or documented by VRChat. This documentation project is maintained on a best-effort basis by the community and attempts to smooth over API breakage by quickly updating when endpoints change. Use responsibly and be aware that endpoints may still break without notice.

Abuse of the API may result in account termination. For their official stance, refer to VRChat's Creator Guidelines.

Resources

Communities

Discord

Discord

Join the VRChat.community server to discuss development, ask questions, and get help from the community.

VRChat Group

Join the VRChat group for events & hangouts with like-minded creators.

Documentation

API Reference

Complete documentation of all VRChat API endpoints with examples and schemas.

WebSocket API

Real-time event streaming documentation for VRChat's pipeline system.

FAQ

Frequently asked questions and common issues with solutions.

SDKs & Libraries

Official SDKs are available for multiple programming languages:

JavaScript

Python

.NET

Dart

Java

Rust

Contributing

This project is open-source and is always looking for contributors. Whether it's fixing documentation errors, adding new endpoints, or improving SDKs, your help is appreciated!

Learn how to contribute by visiting our contributing guide.

Frequently asked questions

Common questions and answers about the VRChat API, including authentication, rate limits, unofficial status, and best practices for developers building VRChat integrations.

On this page

ResourcesCommunitiesDocumentationSDKs & LibrariesContributing
Web Proxy Viewer  |  New URL  |  Original Page