Reference

Our API is based around REST. It is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your token in any public website's client-side code). JSON is returned by all API responses, including errors.

Base URL

https://api.vtubers.tv

API Versioning

We expose different versions of our API. You should specify which version to use by including it in the request path like https://api.vtubers.tv/v{version_number}. Omitting the version number from the route will return a JSON route with all the versions you can use.

You can find the change log for the newest API version here.

Authentication

Authenticating with the API can be in two ways:

1. Using a app token found in the developer dashboard. For more information on apps see apps vs users.
2. Using a user token. This is obtained by using the OAuth2 flow. For more information on OAuth2 see OAuth2.

For all authentication types, authentication is performed with the Authorization HTTP header in the format Authorization: TOKEN_TYPE TOKEN.

Example Bot Token Authorization Header

Authorization: Bot 414eb1aea45bd7b60c7cabfa4ad742da

Example User Token Authorization Header

Authorization: User ca165b92dcbba8777a095d41d6114041e99e6d472b509e59e0a08e79834e7abf

Encryption

All HTTP-layer services and protocols must use TLS 1.2 or higher. We recommend using the latest version of TLS to ensure the highest level of security.