vrchat_dart_generated (EXPERIMENTAL)

VRChat API Banner

VRChat API Documentation

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.

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

This Dart package is automatically generated by the OpenAPI Generator project:

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

Requirements

  • Dart 2.12.0 or later OR Flutter 1.26.0 or later
  • Dio 4.0.0+

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  vrchat_dart_generated: 1.0.0

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  vrchat_dart_generated:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  vrchat_dart_generated:
    path: /path/to/vrchat_dart_generated

Getting Started

Please follow the installation procedure and then run the following:

import 'package:vrchat_dart_generated/vrchat_dart_generated.dart';


final api = VrchatDartGenerated().getAuthenticationApi();
final String userId = userId_example; // String | 

try {
    final response = await api.deleteUserById(userId);
    print(response);
} catch on DioError (e) {
    print("Exception when calling AuthenticationApi->deleteUserById: $e\n");
}

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
AuthenticationApideleteUserByIdPUT /user/{userId}/deleteDelete User
AuthenticationApigetCurrentUserGET /auth/userLogin and/or Get Current User Info
AuthenticationApilogoutPUT /logoutLogout
AuthenticationApiverify2FAPOST /auth/twofactorauth/totp/verifyVerify 2FA code
AuthenticationApiverifyAuthTokenGET /authVerify Auth Token
AuthenticationApiverifyRecoveryCodePOST /auth/twofactorauth/otp/verifyVerify 2FA code with Recovery code
FilesApicreateFilePOST /fileCreate File
FilesApicreateFileVersionPOST /file/{fileId}Create File Version
FilesApideleteFileDELETE /file/{fileId}Delete File
FilesApideleteFileVersionDELETE /file/{fileId}/{versionId}Delete File Version
FilesApidownloadFileVersionGET /file/{fileId}/{versionId}Download File Version
FilesApifinishFileDataUploadPUT /file/{fileId}/{versionId}/{fileType}/finishFinish FileData Upload
FilesApigetFileGET /file/{fileId}Show File
FilesApigetFileDataUploadStatusGET /file/{fileId}/{versionId}/{fileType}/statusCheck FileData Upload Status
FilesApigetFilesGET /filesList Files
FilesApistartFileDataUploadPUT /file/{fileId}/{versionId}/{fileType}/startStart FileData Upload
FriendsApideleteFriendRequestDELETE /user/{userId}/friendRequestDelete Friend Request
FriendsApifriendPOST /user/{userId}/friendRequestSend Friend Request
FriendsApigetFriendStatusGET /user/{userId}/friendStatusCheck Friend Status
FriendsApigetFriendsGET /auth/user/friendsList Friends
FriendsApiunfriendDELETE /auth/user/friends/{userId}Unfriend
NotificationsApiacceptFriendRequestPUT /auth/user/notifications/{notificationId}/acceptAccept Friend Request
NotificationsApiclearNotificationsPUT /auth/user/notifications/clearClear All Notifications
NotificationsApideleteNotificationPUT /auth/user/notifications/{notificationId}/hideDelete Notification
NotificationsApigetNotificationsGET /auth/user/notificationsList Notifications
NotificationsApimarkNotificationAsReadPUT /auth/user/notifications/{notificationId}/seeMark As Read
SystemApigetConfigGET /configFetch API Config
SystemApigetCurrentOnlineUsersGET /visitsCurrent Online Users
SystemApigetHealthGET /healthCheck API Health
SystemApigetSystemTimeGET /timeCurrent System Time
UsersApigetUserGET /users/{userId}Get User by ID
UsersApigetUserByNameGET /users/{username}/nameGet User by Username
UsersApisearchActiveUsersGET /users/activeSearch Active Users
UsersApisearchUsersGET /usersSearch All Users
UsersApiupdateUserPUT /users/{userId}Update User Info
WorldsApisearchWorldsGET /worldsSearch all worlds

Documentation For Models

Documentation For Authorization

apiKeyCookie

  • Type: API key
  • API key parameter name: apiKey
  • Location:

apiKeyQuery

  • Type: API key
  • API key parameter name: apiKey
  • Location: URL query string

authCookie

  • Type: API key
  • API key parameter name: auth
  • Location:

authHeader

  • Type: HTTP basic authentication

twoFactorAuthCookie

  • Type: API key
  • API key parameter name: twoFactorAuth
  • Location:

Author

me@ruby.js.org

Libraries

vrchat_dart_generated