hyper's cobalt instance list

Home - Instances - Services - API - Projects - FAQ - Source Code

API Usage

This is a simple API to access the list of instances. You don’t need to scrap the page itself.

To access it, you can call https://instances.hyper.lol/instances.json. This JSON file is created when the script runs. The script runs at the top of every hour and completes within 20 minutes.

Please set a proper user agent when making requests! I block common user agents (like curl, python-requests, Go-http-client etc) due to many bots hitting this server. I want to know what project or who is using this API!

Example

When calling the API, it will return a JSON array that contains all instances. Here is a snippet of what information an instance has:

{
  "api_online": true,
  "cors": 1,
  "frontend_online": true,
  "commit": "abd9f2e",
  "services": {
    "youtube": true,
    "rutube": true,
    "tumblr": true,
    "bilibili": true,
    "pinterest": true,
    "instagram": true,
    "soundcloud": true,
    "youtube_music": true,
    "odnoklassniki": true,
    "dailymotion": true,
    "twitter": true,
    "vimeo": true,
    "streamable": true,
    "vk": true,
    "tiktok": true,
    "reddit": true,
    "twitch_clips": true,
    "youtube_shorts": true
  },
  "version": "7.14.2",
  "branch": "current",
  "score": 100,
  "protocol": "https",
  "name": "kityune",
  "startTime": 1716834847977,
  "api": "api.cobalt.tools",
  "frontEnd": "cobalt.tools"
}

What are each keys?

This section explains what each key in the JSON mean for an instance.

Some of these keys are pulled directly from the API of an instance. You can view them yourself at <API URL>/api/serverInfo.

• version: The version the instance is running.
• commit: The commit the instance is running.
• branch: This the branch the instance is running.
• name: The “name” of the instance.
• api: The API URL of the instance.
• cors: If the instance has CORS enabled/disabled.
• startTime: The time the instance started up.
• score: The test score of the instance. This is a percentage.
• api_online: Whether or not the API is online.
• frontend_online: Whether or not the frontend is online.
• protocol: What protocol the instance uses (http/https).
• frontEnd: The frontend URL of the instance.

Services

In the services JSON, each service is listed. If it’s able to download media for it, it’s set to true. If it failed, it’s set to false.