vrchatapi (original) (raw)

Project description

VRChat API Library for Python

A Python client to interact with the unofficial VRChat API. Supports all REST calls specified in the API specification.

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:

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.

Getting Started

First add the package to to your project:

pip install vrchatapi

Below is an example on how to login to the API and fetch your own user information.

Step 1. We begin with creating a Configuration, which contains the username and password for authentication.

import vrchatapi from vrchatapi.api import authentication_api from vrchatapi.exceptions import UnauthorizedException from vrchatapi.models.two_factor_auth_code import TwoFactorAuthCode from vrchatapi.models.two_factor_email_code import TwoFactorEmailCode

configuration = vrchatapi.Configuration( username = 'username', password = 'password', )

Step 2. VRChat consists of several API's (WorldsApi, UsersApi, FilesApi, NotificationsApi, FriendsApi, etc...)

Here we enter a context of the API Client and instantiate the Authentication API which is required for logging in.

Enter a context with an instance of the API client

with vrchatapi.ApiClient(configuration) as api_client: # Set our User-Agent as per VRChat Usage Policy api_client.user_agent = "ExampleProgram/0.0.1 my@email.com"

# Instantiate instances of API classes
auth_api = authentication_api.AuthenticationApi(api_client)

try:
    # Step 3. Calling getCurrentUser on Authentication API logs you in if the user isn't already logged in.
    current_user = auth_api.get_current_user()
except UnauthorizedException as e:
    if e.status == 200:
        if "Email 2 Factor Authentication" in e.reason:
            # Step 3.5. Calling email verify2fa if the account has 2FA disabled
            auth_api.verify2_fa_email_code(two_factor_email_code=TwoFactorEmailCode(input("Email 2FA Code: ")))
        elif "2 Factor Authentication" in e.reason:
            # Step 3.5. Calling verify2fa if the account has 2FA enabled
            auth_api.verify2_fa(two_factor_auth_code=TwoFactorAuthCode(input("2FA Code: ")))
        current_user = auth_api.get_current_user()
    else:
        print("Exception when calling API: %s

", e) except vrchatapi.ApiException as e: print("Exception when calling API: %s ", e)

print("Logged in as:", current_user.display_name)

See Examples for more example usage on getting started.

Contributing

Contributions are welcome, but do not add features that should be handled by the OpenAPI specification.

Join the Discord server to get in touch with us.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

Filter files by name, interpreter, ABI, and platform.

If you're not sure about the file name format, learn more about wheel file names.

Copy a direct link to the current filters

File details

Details for the file vrchatapi-1.20.7.tar.gz.

File metadata

File hashes

Hashes for vrchatapi-1.20.7.tar.gz | Algorithm | Hash digest | | | ----------- | ---------------------------------------------------------------- | | | SHA256 | 3dda81427fd99b78800978f5de65c72495dfe94b2a4cacf21349606303627720 | | | MD5 | 133bc16386b5e28d693b9f94879a6883 | | | BLAKE2b-256 | bee1acc6d3015c6792fdb1d1f5ab9e2bb3c3bd3504be4947a491385fb9be5812 | |

See more details on using hashes here.

File details

Details for the file vrchatapi-1.20.7-py3-none-any.whl.

File metadata

File hashes

Hashes for vrchatapi-1.20.7-py3-none-any.whl | Algorithm | Hash digest | | | ----------- | ---------------------------------------------------------------- | | | SHA256 | 9cf246b300fb5154a8d7b5cb251255dac5d044ac41d63ca3469c5b680b431c2b | | | MD5 | 72241fc8fb7a3b8ac3236ea76b1fa69a | | | BLAKE2b-256 | e3fc6b9cac17edae6d18c33704f90d07e4be628d7b1eac9598d7a59a244f3f12 | |

See more details on using hashes here.