This project is an OPEN Open Source Project
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.
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.
https://discord.gg/qjZE9C9fkB#vrchat-api
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.
Put the package under your project folder and add the following to Cargo.toml under [dependencies]:
openapi = { path = "./generated" }
All URIs are relative to https://api.vrchat.cloud/api/1
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AuthenticationApi | deleteuserbyid | PUT /user/{userId}/delete | Delete User *AuthenticationApi* | getcurrentuser | GET /auth/user | Login and/or Get Current User Info *AuthenticationApi* | logout | PUT /logout | Logout *AuthenticationApi* | verify2fa | POST /auth/twofactorauth/totp/verify | Verify 2FA code AuthenticationApi | verifyauthtoken | GET /auth | Verify Auth Token AuthenticationApi | verifyrecoverycode | POST /auth/twofactorauth/otp/verify | Verify 2FA code with Recovery code FilesApi | createfile | POST /file | Create File *FilesApi* | createfileversion | POST /file/{fileId} | Create File Version *FilesApi* | deletefile | DELETE /file/{fileId} | Delete File FilesApi | deletefileversion | DELETE /file/{fileId}/{versionId} | Delete File Version FilesApi | downloadfileversion | GET /file/{fileId}/{versionId} | Download File Version FilesApi | finishfiledataupload | PUT /file/{fileId}/{versionId}/{fileType}/finish | Finish FileData Upload *FilesApi* | getfile | GET /file/{fileId} | Show File FilesApi | getfiledatauploadstatus | GET /file/{fileId}/{versionId}/{fileType}/status | Check FileData Upload Status FilesApi | getfiles | GET /files | List Files *FilesApi* | startfiledataupload | PUT /file/{fileId}/{versionId}/{fileType}/start | Start FileData Upload FriendsApi | deletefriendrequest | DELETE /user/{userId}/friendRequest | Delete Friend Request FriendsApi | friend | POST /user/{userId}/friendRequest | Send Friend Request FriendsApi | getfriendstatus | GET /user/{userId}/friendStatus | Check Friend Status FriendsApi | getfriends | GET /auth/user/friends | List Friends *FriendsApi* | unfriend | DELETE /auth/user/friends/{userId} | Unfriend *NotificationsApi* | acceptfriendrequest | PUT /auth/user/notifications/{notificationId}/accept | Accept Friend Request *NotificationsApi* | clearnotifications | PUT /auth/user/notifications/clear | Clear All Notifications NotificationsApi | deletenotification | PUT /auth/user/notifications/{notificationId}/hide | Delete Notification *NotificationsApi* | getnotifications | GET /auth/user/notifications | List Notifications NotificationsApi | marknotificationasread | PUT /auth/user/notifications/{notificationId}/see | Mark As Read *SystemApi* | getconfig | GET /config | Fetch API Config SystemApi | getcurrentonlineusers | GET /visits | Current Online Users *SystemApi* | gethealth | GET /health | Check API Health SystemApi | getsystemtime | GET /time | Current System Time UsersApi | getuser | GET /users/{userId} | Get User by ID *UsersApi* | getuserbyname | GET /users/{username}/name | Get User by Username UsersApi | searchactiveusers | GET /users/active | Search Active Users UsersApi | searchusers | GET /users | Search All Users *UsersApi* | updateuser | PUT /users/{userId} | Update User Info WorldsApi | search_worlds | GET /worlds | Search all worlds
To get access to the crate's generated documentation, use:
cargo doc --open
me@ruby.js.org