Skip to content

SystemApi.md

Latest commit

 

History

History
441 lines (336 loc) · 14.5 KB

SystemApi.md

File metadata and controls

441 lines (336 loc) · 14.5 KB
Raw

SystemApi

All URIs are relative to https://api.vrchat.cloud/api/1

Method HTTP request Description
getCSS GET /css/app.css Download CSS
getConfig GET /config Fetch API Config
getCurrentOnlineUsers GET /visits Current Online Users
getHealth GET /health Check API Health
getInfoPush GET /infoPush Show Information Notices
getJavaScript GET /js/app.js Download JavaScript
getSystemTime GET /time Current System Time

getCSS

String getCSS(variant, branch)

Download CSS

Fetches the CSS code to the frontend React website.

Example

// Import classes:
import io.github.vrchatapi.ApiClient;
import io.github.vrchatapi.ApiException;
import io.github.vrchatapi.Configuration;
import io.github.vrchatapi.models.*;
import io.github.vrchatapi.api.SystemApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.vrchat.cloud/api/1");

    SystemApi apiInstance = new SystemApi(defaultClient);
    String variant = "public"; // String | Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
    String branch = "main"; // String | Specifies which git branch the site should load frontend source code from.
    try {
      String result = apiInstance.getCSS(variant, branch);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SystemApi#getCSS");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
variant String Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management. [optional] [default to public] [enum: public, internal]
branch String Specifies which git branch the site should load frontend source code from. [optional] [default to main]

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/css, application/json

HTTP response details

Status code Description Response headers
200 Note: VRChat uses 302 Redirect to Cloudfront. The implementing library must support and follow redirects natively. -
400 Error response when trying to download non-public and non-main JavaScript or CSS without Admin Credentials. -

getConfig

APIConfig getConfig()

Fetch API Config

API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.

Example

// Import classes:
import io.github.vrchatapi.ApiClient;
import io.github.vrchatapi.ApiException;
import io.github.vrchatapi.Configuration;
import io.github.vrchatapi.models.*;
import io.github.vrchatapi.api.SystemApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.vrchat.cloud/api/1");

    SystemApi apiInstance = new SystemApi(defaultClient);
    try {
      APIConfig result = apiInstance.getConfig();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SystemApi#getConfig");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

APIConfig

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Returns the API's config. * Set-Cookie -

getCurrentOnlineUsers

Integer getCurrentOnlineUsers()

Current Online Users

Returns the current number of online users. NOTE: The response type is not a JSON object, but a simple JSON integer.

Example

// Import classes:
import io.github.vrchatapi.ApiClient;
import io.github.vrchatapi.ApiException;
import io.github.vrchatapi.Configuration;
import io.github.vrchatapi.models.*;
import io.github.vrchatapi.api.SystemApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.vrchat.cloud/api/1");

    SystemApi apiInstance = new SystemApi(defaultClient);
    try {
      Integer result = apiInstance.getCurrentOnlineUsers();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SystemApi#getCurrentOnlineUsers");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

Integer

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

getHealth

APIHealth getHealth()

Check API Health

Gets the overall health status, the server name, and the current build version tag of the API. DEPRECATED: VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.

Example

// Import classes:
import io.github.vrchatapi.ApiClient;
import io.github.vrchatapi.ApiException;
import io.github.vrchatapi.Configuration;
import io.github.vrchatapi.models.*;
import io.github.vrchatapi.api.SystemApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.vrchat.cloud/api/1");

    SystemApi apiInstance = new SystemApi(defaultClient);
    try {
      APIHealth result = apiInstance.getHealth();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SystemApi#getHealth");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

APIHealth

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Returns the API's health. -

getInfoPush

List<InfoPush> getInfoPush(require, include)

Show Information Notices

IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an &quot;any of&quot; search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an &quot;all of&quot; search.

Example

// Import classes:
import io.github.vrchatapi.ApiClient;
import io.github.vrchatapi.ApiException;
import io.github.vrchatapi.Configuration;
import io.github.vrchatapi.models.*;
import io.github.vrchatapi.api.SystemApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.vrchat.cloud/api/1");

    SystemApi apiInstance = new SystemApi(defaultClient);
    String require = "require_example"; // String | Tags to include (comma-separated). All of the tags needs to be present.
    String include = "include_example"; // String | Tags to include (comma-separated). Any of the tags needs to be present.
    try {
      List<InfoPush> result = apiInstance.getInfoPush(require, include);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SystemApi#getInfoPush");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
require String Tags to include (comma-separated). All of the tags needs to be present. [optional]
include String Tags to include (comma-separated). Any of the tags needs to be present. [optional]

Return type

List<InfoPush>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Returns a list of InfoPush objects. -

getJavaScript

String getJavaScript(variant, branch)

Download JavaScript

Fetches the JavaScript code to the frontend React website.

Example

// Import classes:
import io.github.vrchatapi.ApiClient;
import io.github.vrchatapi.ApiException;
import io.github.vrchatapi.Configuration;
import io.github.vrchatapi.models.*;
import io.github.vrchatapi.api.SystemApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.vrchat.cloud/api/1");

    SystemApi apiInstance = new SystemApi(defaultClient);
    String variant = "public"; // String | Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
    String branch = "main"; // String | Specifies which git branch the site should load frontend source code from.
    try {
      String result = apiInstance.getJavaScript(variant, branch);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SystemApi#getJavaScript");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
variant String Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management. [optional] [default to public] [enum: public, internal]
branch String Specifies which git branch the site should load frontend source code from. [optional] [default to main]

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/javascript, application/json

HTTP response details

Status code Description Response headers
200 Note: VRChat uses 302 Redirect to Cloudfront. The implementing library must support and follow redirects natively. -
400 Error response when trying to download non-public and non-main JavaScript or CSS without Admin Credentials. -

getSystemTime

OffsetDateTime getSystemTime()

Current System Time

Returns the current time of the API server. NOTE: The response type is not a JSON object, but a simple JSON string.

Example

// Import classes:
import io.github.vrchatapi.ApiClient;
import io.github.vrchatapi.ApiException;
import io.github.vrchatapi.Configuration;
import io.github.vrchatapi.models.*;
import io.github.vrchatapi.api.SystemApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.vrchat.cloud/api/1");

    SystemApi apiInstance = new SystemApi(defaultClient);
    try {
      OffsetDateTime result = apiInstance.getSystemTime();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SystemApi#getSystemTime");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

OffsetDateTime

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -