Fetch the API configuration required for clients to function properly. This includes important values such as the clientApiKey, which is used for other API endpoints.

fetchAPIConfig(): Promise<APIConfig>

• No parameters

• Promise<APIConfig>: A promise that resolves to an APIConfig object containing the API configuration details.

// Example: Fetch the API configuration
const apiConfig = await vrchatApi.systemApi.fetchAPIConfig();
console.log(apiConfig.clientApiKey);

Retrieve the current number of users online in VRChat. This is a simple method that returns an integer representing the online user count.

currentOnlineUsers(): Promise<number>

• No parameters

• Promise<number>: A promise that resolves to a number representing the current online user count.

// Example: Get the current number of online users
const onlineUserCount = await vrchatApi.systemApi.currentOnlineUsers();
console.log(`Current online users: ${onlineUserCount}`);

Retrieve the current system time from the API server. This can be used to synchronize time-sensitive operations with the server's time.

currentSystemTime(): Promise<string>

• No parameters

• Promise<string>: A promise that resolves to a string representing the current system time in ISO 8601 format.

// Example: Get the current system time from the API server
const systemTime = await vrchatApi.systemApi.currentSystemTime();
console.log(`Current system time: ${systemTime}`);

Status: Early Access (Still Under Development)

The Information Push System (IPS) is used by VRChat to push dynamic information to the client. This is primarily used for quick-menu info banners and alerts, such as notifying users to update to the latest version.

showInformationNotices(): void

• No parameters

This endpoint is still under development and may not be available. Please check back later for updates.

Fetches the CSS code for the VRChat frontend React website.

downloadCSS(): void

• No parameters

This endpoint is still under development and may not be available. Please check back later for updates.

Fetches the JavaScript code for the VRChat frontend React website.

downloadJavaScript(): void

• No parameters

This endpoint is still under development and may not be available. Please check back later for updates.

Deprecated: This endpoint is deprecated and will be removed in the future.

Retrieve the health status of the API. The response type is not a JSON object but a simple JSON integer.

checkAPIHealth(): void

• No parameters

This endpoint is deprecated and may not function as expected. Please avoid using this endpoint.