Skip to content

Latest commit

 

History

History
311 lines (205 loc) · 9.57 KB

SystemApi.md

File metadata and controls

311 lines (205 loc) · 9.57 KB
Raw

vrchat_dart_generated.api.SystemApi

Load the API package

import 'package:vrchat_dart_generated/api.dart';

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 'package:vrchat_dart_generated/api.dart';

final api = VrchatDartGenerated().getSystemApi();
final String variant = variant_example; // 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.
final String branch = branch_example; // String | Specifies which git branch the site should load frontend source code from.

try {
    final response = api.getCSS(variant, branch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling SystemApi->getCSS: $e\n');
}

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']
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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

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 'package:vrchat_dart_generated/api.dart';

final api = VrchatDartGenerated().getSystemApi();

try {
    final response = api.getConfig();
    print(response);
} catch on DioException (e) {
    print('Exception when calling SystemApi->getConfig: $e\n');
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCurrentOnlineUsers

int 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 'package:vrchat_dart_generated/api.dart';

final api = VrchatDartGenerated().getSystemApi();

try {
    final response = api.getCurrentOnlineUsers();
    print(response);
} catch on DioException (e) {
    print('Exception when calling SystemApi->getCurrentOnlineUsers: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

int

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

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 'package:vrchat_dart_generated/api.dart';

final api = VrchatDartGenerated().getSystemApi();

try {
    final response = api.getHealth();
    print(response);
} catch on DioException (e) {
    print('Exception when calling SystemApi->getHealth: $e\n');
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getInfoPush

List 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 "any of" 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 "all of" search.

Example

import 'package:vrchat_dart_generated/api.dart';

final api = VrchatDartGenerated().getSystemApi();
final String require = require_example; // String | Tags to include (comma-separated). All of the tags needs to be present.
final String include = include_example; // String | Tags to include (comma-separated). Any of the tags needs to be present.

try {
    final response = api.getInfoPush(require, include);
    print(response);
} catch on DioException (e) {
    print('Exception when calling SystemApi->getInfoPush: $e\n');
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getJavaScript

String getJavaScript(variant, branch)

Download JavaScript

Fetches the JavaScript code to the frontend React website.

Example

import 'package:vrchat_dart_generated/api.dart';

final api = VrchatDartGenerated().getSystemApi();
final String variant = variant_example; // 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.
final String branch = branch_example; // String | Specifies which git branch the site should load frontend source code from.

try {
    final response = api.getJavaScript(variant, branch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling SystemApi->getJavaScript: $e\n');
}

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']
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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSystemTime

DateTime 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 'package:vrchat_dart_generated/api.dart';

final api = VrchatDartGenerated().getSystemApi();

try {
    final response = api.getSystemTime();
    print(response);
} catch on DioException (e) {
    print('Exception when calling SystemApi->getSystemTime: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

DateTime

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]