v6 documentation is incomplete, want to contribute?

Introduction

VRChat.community Frequently asked questions Contributing

SDKs

TypeScript JavaScript Python Dart .NET Java Rust

Guides

Instances Websocket API

API Reference

Login and/or Get Current User Info GET

Cancel pending enabling of time-based 2FA codes DELETE

Check User Exists GET

Confirm Email GET

Delete User PUT

Disable 2FA DELETE

Enable time-based 2FA codes POST

Get Global Avatar Moderations GET

Get 2FA Recovery codes GET

Register User Account POST

Resend Email Confirmation 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 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 User Persistence DELETE

Get User by Username GET

Get User Feedback 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

Search Active Users GET

Update User Badge PUT

Update User Info PUT

Update User Note POST

Create a calendar event POST

Delete a calendar event DELETE

Follow a calendar event POST

List calendar events GET

List featured calendar events GET

List followed calendar events GET

Get a calendar event GET

Download calendar event as ICS GET

List a group's calendar events GET

Search for calendar events GET

Update a calendar event PUT

Get Active Licenses GET

Get Admin Transactions GET

Get Admin Transactions GET

Get Balance GET

Get Balance Earnings GET

Get Current Subscriptions GET

Get Economy Account GET

Get License Group GET

Get Product Listing GET

Get User Product Listings GET

Get Steam Transaction GET

List Steam Transactions GET

Get Store Shelves GET

List Subscriptions GET

Get Tilia Status GET

Get Tilia TOS Agreement Status GET

List Token Bundles GET

Get User Subscription Eligiblity GET

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 POST

Create File Version POST

Delete File DELETE

Delete File Version DELETE

Download File Version GET

Finish FileData Upload PUT

Get AdminAssetBundle GET

Get File Version Analysis GET

Get File Version Analysis Security GET

Get File Version Analysis Standard GET

Check FileData Upload Status GET

Start FileData Upload PUT

Upload gallery image POST

Upload icon POST

Upload gallery image, icon, emoji or sticker 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

Cancel Group Join Request DELETE

Create Group POST

Create Group Announcement POST

Create Group Gallery POST

Invite User to Group POST

Create GroupRole POST

Delete Group DELETE

Delete Group Announcement DELETE

Delete Group Gallery DELETE

Delete Group Gallery Image DELETE

Delete User Invite DELETE

Delete a Group post DELETE

Delete Group Role DELETE

Get Group by ID GET

Get Group Announcement 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

Join Group POST

Kick Group Member DELETE

Leave Group POST

Remove Role from GroupMember DELETE

Respond Group Join request PUT

Search Group GET

Unban Group Member DELETE

Update Group PUT

Update Group Gallery PUT

Update Group Member PUT

Edits a Group post PUT

Update Group Representation PUT

Update Group Role PUT

Close Instance DELETE

Create Instance POST

Get Instance GET

Get Instance By Short Name GET

List Recent Locations GET

Get Instance Short Name GET

Get Inventory GET

List Inventory Drops GET

Get Inventory Template GET

Get Own Inventory Item GET

Share Inventory Item Direct POST

Share Inventory Item by Pedestal GET

Spawn Inventory Item GET

Update Own Inventory Item PUT

Get Invite Message GET

List Invite Messages GET

Invite Myself To Instance POST

Invite User POST

Invite User with photo POST

Request Invite POST

Request Invite with photo POST

Reset Invite Message DELETE

Respond Invite POST

Respond Invite with photo POST

Update Invite Message PUT

Show jam information GET

Show jam submissions GET

Show jams list GET

Accept Friend Request PUT

Clear All Notifications PUT

Delete Notification PUT

Show notification GET

List Notifications GET

Mark Notification As Read PUT

Clear All Player Moderations DELETE

Search Player Moderations GET

Moderate User POST

Unmoderate User PUT

Delete Print DELETE

Edit Print POST

Get Own Prints GET

Upload Print POST

Create Permission POST

Delete Permission DELETE

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

Get Permissions GET

Current System Time GET

Update Permission PUT

VRChat.community

API documentation, SDKs, and more

MetricsAPI Reference

Python

vrchatapi/vrchatapi-python

74

Want to contribute to this page? Edit it on GitHub!

Installation

pip install vrchatapi

On this page