Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

Disclaimer

This is the official response of the VRChat Team (from Tupper more specifically) on the usage of the VRChat API.

Use of the API using applications other than the approved methods (website, VRChat application) are not officially supported. You may use the API for your own application, but keep these guidelines in mind:

We do not provide documentation or support for the API.

Do not make queries to the API more than once per 60 seconds.

Abuse of the API may result in account termination.

Access to API endpoints may break at any given time, with no warning.

As stated, this documentation was not created with the help of the official VRChat team. Therefore this documentation is not an official documentation of the VRChat API and may not be always up to date with the latest versions. If you find that a page or endpoint is not longer valid please create an issue and tell us so we can fix it.

Get in touch with us!

https://discord.gg/qjZE9C9fkB#vrchat-api

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

API version: 1.0.0
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.RustClientCodegen For more information, please visit https://github.com/VRChatAPI

Installation

Put the package under your project folder and add the following to Cargo.toml under [dependencies]:

    openapi = { path = "./generated" }

Documentation for API Endpoints

All URIs are relative to https://api.vrchat.cloud/api/1

Class	Method	HTTP request	Description
AuthenticationApi	delete_user_by_id	PUT /user/{userId}/delete	Delete User
AuthenticationApi	get_current_user	GET /auth/user	Login and/or Get Current User Info
AuthenticationApi	logout	PUT /logout	Logout
AuthenticationApi	verify2_fa	POST /auth/twofactorauth/totp/verify	Verify 2FA code
AuthenticationApi	verify_auth_token	GET /auth	Verify Auth Token
AuthenticationApi	verify_recovery_code	POST /auth/twofactorauth/otp/verify	Verify 2FA code with Recovery code
FilesApi	create_file	POST /file	Create File
FilesApi	create_file_version	POST /file/{fileId}	Create File Version
FilesApi	delete_file	DELETE /file/{fileId}	Delete File
FilesApi	delete_file_version	DELETE /file/{fileId}/{versionId}	Delete File Version
FilesApi	download_file_version	GET /file/{fileId}/{versionId}	Download File Version
FilesApi	finish_file_data_upload	PUT /file/{fileId}/{versionId}/{fileType}/finish	Finish FileData Upload
FilesApi	get_file	GET /file/{fileId}	Show File
FilesApi	get_file_data_upload_status	GET /file/{fileId}/{versionId}/{fileType}/status	Check FileData Upload Status
FilesApi	get_files	GET /files	List Files
FilesApi	start_file_data_upload	PUT /file/{fileId}/{versionId}/{fileType}/start	Start FileData Upload
FriendsApi	delete_friend_request	DELETE /user/{userId}/friendRequest	Delete Friend Request
FriendsApi	friend	POST /user/{userId}/friendRequest	Send Friend Request
FriendsApi	get_friend_status	GET /user/{userId}/friendStatus	Check Friend Status
FriendsApi	get_friends	GET /auth/user/friends	List Friends
FriendsApi	unfriend	DELETE /auth/user/friends/{userId}	Unfriend
NotificationsApi	accept_friend_request	PUT /auth/user/notifications/{notificationId}/accept	Accept Friend Request
NotificationsApi	clear_notifications	PUT /auth/user/notifications/clear	Clear All Notifications
NotificationsApi	delete_notification	PUT /auth/user/notifications/{notificationId}/hide	Delete Notification
NotificationsApi	get_notifications	GET /auth/user/notifications	List Notifications
NotificationsApi	mark_notification_as_read	PUT /auth/user/notifications/{notificationId}/see	Mark As Read
SystemApi	get_config	GET /config	Fetch API Config
SystemApi	get_current_online_users	GET /visits	Current Online Users
SystemApi	get_health	GET /health	Check API Health
SystemApi	get_system_time	GET /time	Current System Time
UsersApi	get_user	GET /users/{userId}	Get User by ID
UsersApi	get_user_by_name	GET /users/{username}/name	Get User by Username
UsersApi	search_active_users	GET /users/active	Search Active Users
UsersApi	search_users	GET /users	Search All Users
UsersApi	update_user	PUT /users/{userId}	Update User Info
WorldsApi	search_worlds	GET /worlds	Search all worlds

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

me@ruby.js.org