vrchat_dart_generated 1.0.6

The generated API used by vrchat_dart. Generated from https://github.com/vrchatapi/specification.

vrchat_dart_generated (EXPERIMENTAL)

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

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
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 Configuration
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

Documentation For Models

• Config
• ConfigAnnouncements
• ConfigDownloadUrls
• ConfigDynamicWorldRows
• ConfigEvents
• CurrentUser
• DeploymentGroup
• DeveloperType
• Error
• InlineObject
• InlineObject1
• InlineObject2
• InlineResponse200
• InlineResponse2001
• InlineResponse2001Success
• InlineResponse2002
• InlineResponse2003
• InlineResponse2004
• InlineResponse401
• LimitedUser
• Notification
• NotificationType
• Response
• Success
• User
• UserState
• UserStatus

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

Author

[e-mail]