Introduction

VRChat.community Frequently asked questions Contributing

SDKs

TypeScript JavaScript Python Dart .NET Java Rust

Guides

Instances Short Links Websocket API

User World Group

API Reference

Login and/or Get Current User Info GET Logout PUT Cancel pending enabling of time-based 2FA codes DELETE Check User Exists GET Confirm Email GET Create Global Avatar Moderation POST Delete Global Avatar Moderation DELETE Delete Moderation Report DELETE Delete User PUT Disable 2FA DELETE Enable time-based 2FA codes POST Get Global Avatar Moderations GET Get Moderation Reports GET Get 2FA Recovery codes GET Register User Account POST Resend Email Confirmation POST Submit Moderation Report POST Verify Auth Token GET Verify Login Place GET Verify Pending 2FA code POST Verify 2FA code with Recovery code POST Verify 2FA code POST Verify 2FA email code POST

Search All Worlds GET Get World by ID GET Get World Instance GET Create World POST Delete World DELETE List Active Worlds GET List Favorited Worlds GET List Recent Worlds GET Get World Metadata GET Get World Publish Status GET Publish World PUT Unpublish World DELETE Update World PUT

Search Avatars GET Get Avatar GET Get Own Avatar GET Select Avatar PUT Create Avatar POST Delete Avatar DELETE Delete generated Impostor DELETE Enqueue Impostor generation POST Get Avatar Styles GET List Favorited Avatars GET Get Impostor Queue Stats GET List Licensed Avatars GET Select Fallback Avatar PUT Update Avatar PUT

Search All Users GET Get User by ID GET Add User Tags POST Check User Persistence Exists GET Delete All User Persistence Data DELETE Delete User Persistence DELETE Get User Group Blocks GET Get User Group Invited GET Get User Mutual Friends GET Get User Mutual Groups GET Get User Mutuals GET Get user's permissions for all joined groups. GET Get User by Username GET Get User Feedback GET Get User Group Instances for a specific Group GET Get User Group Instances GET Get User Group Requests GET Get User Groups GET Get User Note GET Get User Notes GET Get user's current represented group GET Remove User Tags POST Update User Badge PUT Update User Note POST Update User Info PUT

Create a calendar event POST Delete a calendar event DELETE Discover calendar events GET Follow a calendar event POST List calendar events GET List featured calendar events GET List followed calendar events GET Download calendar event as ICS GET Get a calendar event GET List a group's calendar events GET Get next calendar event GET Search for calendar events GET Update a calendar event PUT

Get Active Licenses GET Get Balance Earnings GET Get Balance GET Get Bulk Gift Purchases GET Get Current Subscriptions GET Get Economy Account GET Get License Group GET Get Product Listing (alternate) GET Get Product Listing GET Get User Product Listings GET Get Product Purchases GET Get Recent Subscription GET Get Steam Transaction GET List Steam Transactions GET Get Store Shelves GET Get Store GET List Subscriptions GET Get Tilia Status GET Get Tilia TOS Agreement Status GET List Token Bundles GET Get User Credits Eligiblity GET Get User Subscription Eligiblity GET Purchase Product Listing POST Update Tilia TOS Agreement Status PUT

Add Favorite POST Clear Favorite Group DELETE Show Favorite Group GET List Favorite Groups GET Get Favorite Limits GET List Favorites GET Remove Favorite DELETE Update Favorite Group PUT

Create File Version POST Create File POST Delete File Version DELETE Delete File DELETE Download File Version GET Finish FileData Upload PUT Get AdminAssetBundle GET Get Content Agreement Status GET Get File Version Analysis Security GET Get File Version Analysis Standard GET Get File Version Analysis GET Check FileData Upload Status GET Show File GET List Files GET Set Group Gallery File Order PUT Start FileData Upload PUT Submit Content Agreement POST Update Asset Review Notes PUT Upload gallery image POST Upload icon POST Upload gallery image, icon, emoji or sticker POST

Send Boop POST Delete Friend Request DELETE Send Friend Request POST Check Friend Status GET List Friends GET Unfriend DELETE

Add Group Gallery Image POST Add Role to GroupMember PUT Create a post in a Group POST Ban Group Member POST Block Group POST Cancel Group Join Request DELETE Cancel Group Transfer DELETE Create Group Announcement POST Create Group Gallery POST Invite User to Group POST Create GroupRole POST Create Group POST Decline Invite from Group PUT Delete Group Announcement DELETE Delete Group Gallery Image DELETE Delete Group Gallery DELETE Delete User Invite DELETE Delete a Group post DELETE Delete Group Role DELETE Delete Group DELETE Get Group Announcement GET Get Group Audit Log Entry Types GET Get Group Audit Logs GET Get Group Bans GET Get Group Gallery Images GET Get Group Instances GET Get Group Invites Sent GET Get Group Member GET List Group Members GET List Group Permissions GET Get posts from a Group GET Get Group Join Requests GET Get Group Role Templates GET Get Group Roles GET Get Group Transferability GET Get Group by ID GET Initiate or Accept Group Transfer POST Join Group POST Kick Group Member DELETE Leave Group POST Remove Role from GroupMember DELETE Respond Group Join request PUT Search Group Members GET Search Group GET Unban Group Member DELETE Update Group Gallery PUT Update Group Member PUT Edits a Group post PUT Update Group Representation PUT Update Group Role PUT Update Group PUT

Close Instance DELETE Create Instance POST Get Instance By Short Name GET Get Instance GET List Recent Locations GET Get Instance Short Name GET

Consume Own Inventory Item PUT Delete Own Inventory Item DELETE Equip Own Inventory Item PUT List Inventory Collections GET List Inventory Drops GET Get Inventory Template GET Get Inventory GET Get Own Inventory Item GET Get User Inventory Item GET Share Inventory Item Direct POST Share Inventory Item by Pedestal GET Spawn Inventory Item GET Unequip Own Inventory Slot DELETE Update Own Inventory Item PUT

Get Invite Message GET List Invite Messages GET Invite Myself To Instance POST Invite User with photo POST Invite User POST Request Invite with photo POST Request Invite POST Reset Invite Message DELETE Respond Invite with photo POST Respond Invite POST Update Invite Message PUT

Show jam submissions GET Show jam information GET Show jams list GET

Accept Friend Request PUT Acknowledge NotificationV2 POST Clear All Notifications PUT Delete All NotificationV2s DELETE Delete NotificationV2 DELETE Delete Notification PUT Get NotificationV2 GET List NotificationV2s GET Show notification GET List Notifications GET Mark Notification As Read PUT Reply NotificationV2 POST Respond NotificationV2 POST

Clear All Player Moderations DELETE Search Player Moderations GET Moderate User POST Unmoderate User PUT

Delete Print DELETE Edit Print POST Get Print GET Get Own Prints GET Upload Print POST

Create Prop POST Delete Prop DELETE Get Prop Publish Status GET Get Prop GET List Props GET Publish Prop PUT Unpublish Prop DELETE Update Prop PUT

Get Assigned Permissions GET Fetch API Config GET Download CSS GET Current Online Users GET Check API Health GET Show Information Notices GET Download JavaScript GET Get Permission GET Current System Time GET

VRChat.communityAPI documentation, SDKs, and more

Java

A Java SDK for interacting with the VRChat API, allowing developers to create applications that can access and manipulate VRChat data.

vrchatapi/vrchatapi-java

18

Last updated on

Want to contribute to this page?

This page is a bit short and could use more detail. If you have knowledge, examples, or improvements to add, consider contributing to help expand it.Edit this page

.NET

A .NET client to interact with the unofficial VRChat API. Supports all REST calls specified in the VRChat API specification.

Rust

A Rust SDK for interacting with the VRChat API, allowing developers to create applications that can access and manipulate VRChat data.