Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 3.37 KB

README.md

File metadata and controls

69 lines (48 loc) · 3.37 KB
Raw

VRChat API Library for JavaScript/TypeScript

A JavaScript/TypeScript/NodeJS 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:

  • 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.

Getting Started

First add the package to to your project:

npm install vrchat

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, as well as an options dictionary, which contains the user agent header.
const vrchat = require("vrchat");

const configuration = new vrchat.Configuration({
    username: "username",
    password: "password"
});

const options = { headers: { "User-Agent": "ExampleProgram/0.0.1 [email protected]"}};

// Step 2. VRChat consists of several API's (WorldsApi, UsersApi, FilesApi, NotificationsApi, FriendsApi, etc...)
// Here we instantiate the Authentication API which is required for logging in.
const AuthenticationApi = new vrchat.AuthenticationApi(configuration);

// Step 3. Calling getCurrentUser on Authentication API logs you in if the user isn't already logged in.
AuthenticationApi.getCurrentUser(options).then(async resp => {
    var currentUser = resp.data;

    // Step 3.5. Calling email verify2fa if the account has 2FA disabled
    if (currentUser["requiresTwoFactorAuth"] && currentUser["requiresTwoFactorAuth"][0] === "emailOtp") {
        await AuthenticationApi.verify2FAEmailCode({ code: "123456" }, options)
        currentUser = (await AuthenticationApi.getCurrentUser(options)).data;
    }

    // Step 3.5. Calling verify2fa if the account has 2FA enabled
    if (currentUser["requiresTwoFactorAuth"] && currentUser["requiresTwoFactorAuth"][0] === "totp") {
        await AuthenticationApi.verify2FA({ code: "123456" }, options)
        currentUser = (await AuthenticationApi.getCurrentUser(options)).data;
    }
    
    console.log(`Logged in as: ${currentUser.displayName}`);
});

See example.js 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.