API Reference

Client

Events

User

World

Avatar

Favorite

File

Moderation

Notification

Exceptions

errors.RequestErrors

exception vrcpy.errors.RequestErrors.NoSession

Exception raised when no aiohttp session has been made and a call was made

exception vrcpy.errors.RequestErrors.SessionExists

Exception raised when trying to make second new session without closing first

exception vrcpy.errors.RequestErrors.RequestError

Exception raised when all request retry attempts fail

exception vrcpy.errors.RequestErrors.RateLimit

Exception raised when received a 429 http response

exception vrcpy.errors.RequestErrors.Unauthorized

Exception raised with regular 401 responses

errors.VRChatErrors

exception vrcpy.errors.VRChatErrors.ServiceUnavailable

Exception raised when 503 recieved

errors.ClientErrors

exception vrcpy.errors.ClientErrors.OutOfDate

Exception raised when apiKey is not in config

exception vrcpy.errors.ClientErrors.MissingCredentials

Exception raised when Client.login is called without username+password

exception vrcpy.errors.ClientErrors.MfaRequired

Exception raised when needing mfa code to login

exception vrcpy.errors.ClientErrors.MfaInvalid

Exception raised when mfa code is invalid

exception vrcpy.errors.ClientErrors.InvalidEventFunction

Exception raised when trying to apply vrcpy.Client.event decorator on a func with an invalid event name

exception vrcpy.errors.ClientErrors.InvalidAuthToken

Exception raised when AuthToken isn’t valid

errors.ObjectErrors

exception vrcpy.errors.ObjectErrors.IntegretyError

Exception raised when BaseObject._object_integrety fails

exception vrcpy.errors.ObjectErrors.NotFriends

Exception raised when user and current user aren’t friends, and method requires them to be

exception vrcpy.errors.ObjectErrors.AlreadyFriends

Exception raised when user and current user are already friends

exception vrcpy.errors.ObjectErrors.InvalidGroupName

Exception raised when favorite group name is invalid

exception vrcpy.errors.ObjectErrors.NotOwned

Exception raised when operation performed on something unowned, and method requires it to be

Utility Helpers

class vrcpy.util.TaskWrapReturn(loop, coro, *args, task_name=None, **kwargs)