API Documentation

Please note: The API can be used to embed this site into your own code. If you just want to search for a video, return to the homepage.

Call: GET `/api/:version/:videoid`

Accepted query string parameters: `includeRaw` (set to include the `rawraw` field), `stream` (stream service objects as they are processed, rather than all at the end)

Current versions available: v2, v3, v4, v5. Documentation below only applies to the latest version.

Changelog

API version 2 -> 3:

The error field is no longer a boolean; it now contains either an error message or null.

API version v3 -> 4:

The rawraw field is now only provided if you set the includeRaw parameter.

API version v4 -> 5:

The deprecated capcount field has been removed. Previously, it was guaranteed to be a positive non-zero number if the video was archived.
The available field is now a list of link objects (see below) to allow returning multiple URLs.
The streaming protocol has been updated to support streaming the list of URLs.

Fields (non-streamed mode)

id (str): The interpreted video ID.
status (str): bad.id if invalid ID.
keys (list[YouTubeService]): An array with all the server responses.
api_version (int): The API version. Breaking API changes are made by incrementing this.
verdict (dict): The verdict of the response. Has video, metaonly, and comments field, that are set to true if any archive was found where that was saved. Also has human_friendly field that has a simple verdict that can be used by people.

Streaming protocol

A stream of JSONL: one json object followed by a newline, then the next, etc. The order of what is sent:

Object of internal class name to on-screen name. Use this to pre-populate the list. The internal class name may be useful for e.g. element IDs where the usable character set is limited.
Link objects. Finalized service objects, as scrapers finish. (You can use the type field to differentiate.)
Null, to show that we are finished generating the service objects.
A verdict.

NOTE: In both cases, the rawraw field is only set if you set the includeRaw parameter. Example: /api/v4/dQw4w9WgXcQ?includeRaw=true. Please only enable this if you have to, as it will slow down loading.

YouTube Video Finder

API Documentation

Call: GET /api/:version/:videoid

Accepted query string parameters: includeRaw (set to include the rawraw field), stream (stream service objects as they are processed, rather than all at the end)

Call: GET `/api/:version/:videoid`

Accepted query string parameters: `includeRaw` (set to include the `rawraw` field), `stream` (stream service objects as they are processed, rather than all at the end)