API Docs/Draft
If you end up using the API, I'd love to know about how you're using it. Tell me about it by making a GitHub issue or emailing me :)
The API and database follow this license unless you have explicit permission. Attribution Template
Public API available at https://sponsor.ajay.app.
While this is a free unlimited use API, please don't abuse it. I have limited resources.
Database download: https://sponsor.ajay.app/database
Libraries: NPM
Online Database Explorer (By Lartza): https://sb.ltn.fi/
Database Mirror (5 min update time, provided by Lartza): https://sb.ltn.fi/database/
GET /api/skipSegments
Get segments for a video.
Input (URL Parameters):
{
videoID: string,
category: string, // Optional, defaults to "sponsor", can be repeated for multiple categories.
// OR
categories: string[], // Optional, array of categories, will look like ["sponsor","intro"]
// See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
requiredSegment: string, // Segment UUID to require to be retrieved, even if they don't meet the minimum vote threshold. Can be repeated for multiple segments.
// OR
requiredSegments: string[], // Optional, array of required segment UUIDs
service: string // Optional, default is 'YouTube'
// See https://github.com/ajayyy/SponsorBlock/wiki/Types#service
}
Response:
[{ // Array of this object
segment: float[], //[0, 15.23] start and end time in seconds
UUID: string,
category: string,
videoDuration: float // Duration of video when submission occurred (to be used to determine when a submission is out of date)
}]
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
404: Not Found
GET /api/skipSegments/:sha256HashPrefix
Get segments for a video with extra privacy
sha256HashPrefix is a hash of the YouTube videoID. It should be the first 4 - 32 characters (4 is recommended). This provides extra privacy by potentially finding more than just the video you are looking for since the server not know exactly what video you are looking for.
Input (URL Parameters):
{
prefix: string, // Can be used instead of path
category: string, // Optional, defaults to "sponsor", can be repeated for multiple categories.
// OR
categories: string[], // Optional, array of categories, will look like ["sponsor","intro"]
// See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
requiredSegment: string, // Segment UUID to require to be retrieved, even if they don't meet the minimum vote threshold. Can be repeated for multiple segments.
// OR
requiredSegments: string[], // Optional, array of required segment UUIDs
service: string // Optional, default is 'YouTube'.
// See https://github.com/ajayyy/SponsorBlock/wiki/Types#service
}
Response
[{ // Array of this object
videoID: string,
hash: string, // Full hash of the videoID
segments: [{ // Array of this object
segment: float[], // [0, 15.23] start and end time in seconds
UUID: string,
category: string
}]
}]
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
404: Not Found
POST /api/skipSegments
Create a segment on a video
Input (URL Parameters):
{
videoID: string,
startTime: float,
endTime: float,
category: string,
userID: string, // This should be a randomly generated UUID stored locally (not the public one)
userAgent: string, // "Name of Client/Version" or "[BOT] Name of Bot/Version" ex. "Chromium/1.0.0"
service: string, // Optional, default is 'YouTube'.
// See https://github.com/ajayyy/SponsorBlock/wiki/Types#service
videoDuration: float, // Optional, duration of video, will attempt to retrieve from the YouTube API if missing (to be used to determine when a submission is out of date)
actionType: string // Optional, default is "skip". can also be "mute"
}
OR
Input (JSON Body):
{
videoID: string,
userID: string, // This should be a randomly generated UUID stored locally (not the public one)
userAgent: string, // "Name of Client/Version" or "[BOT] Name of Bot/Version" ex. "Chromium/1.0.0"
service: string, // Optional, default is 'YouTube'.
// See https://github.com/ajayyy/SponsorBlock/wiki/Types#service
videoDuration: float, // Optional, duration of video, will attempt to retrieve from the YouTube API if missing (to be used to determine when a submission is out of date)
segments: [{ // Array of this object
segment: float[], // [0, 15.23] start and end time in seconds
category: string,
actionType: string // Optional, defaults to "skip", can also be "mute"
}]
}
Response:
{
Nothing (status code 200)
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
403: Rejected by auto moderator (Reason will be sent in the response)
429: Rate Limit (Too many for the same user or IP)
409: Duplicate
POST /api/voteOnSponsorTime
Vote on a segment or vote to change the category of the segment.
Creators of the segment and VIPs can remove the segment or change the category with only one vote.
Input: Normal Vote (URL Parameters):
{
UUID: string, // UUID of the segment being voted on
userID: string, // Local userID
type: int // 0 for downvote, 1 for upvote, 20 to undo vote
}
OR
Input: Category Vote (URL Parameters):
{
UUID: string, // UUID of the segment being voted on
userID: string, // Local userID
category: string // Category to change this submission to
}
Response:
{
Nothing (status code 200)
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
403: Reason given in request (moderation)
POST /api/viewedVideoSponsorTime
Add view to segment
Input (URL Parameters):
{
UUID: string // UUID of segment viewed
}
Response:
{
Nothing (status code 200)
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
GET /api/userInfo
Get information about a user
Input (URL Parameters):
{
userID: string // local UserID
// OR
publicUserID: string // Public userID
value: string[] // Optional, Values to get from userInfo
// default values are
// ["userID", "userName", "minutesSaved", "segmentCount", "ignoredSegmentCount",
// "viewCount", "ignoredViewCount", "warnings", "warningReason", "reputation",
// "vip", "lastSegmentID"]
}
Response:
{
userID: string, // Public userID
userName: string, // Public userID if not set
minutesSaved: float, // Minutes saved
segmentCount: int, // Total number of segments excluding ignored/ hidden segments
ignoredSegmentCount: int, // Total number of ignored/ hidden segments
viewCount: int, // Total number of views excluding view on ignored/ hidden segments
ignoredViewCount: int, // Total number of view on ignored/ hidden segments
warnings: int, // Currently enabled warnings
reputation: float,
vip: boolean, // VIP status
lastSegmentID: string // UUID of last submitted segment
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
GET /api/getViewsForUser
Get the number of views a user has on all their segments
Input (URL Parameters):
{
userID: string // Local userID
}
Response:
{
viewCount: int
}
Error codes:
404: Not Found
GET /api/getSavedTimeForUser
Get the total time saved from all the user's segments
Input (URL Parameters):
{
userID: string // Local userID
}
Response:
{
timeSaved: float // In minutes
}
Error codes:
404: Not Found
POST /api/setUsername
Set a username for a userID
Input (URL Parameters): Setting username for self
{
userID: string, // Local userID
username: string, // Optional
}
OR
Input (URL Parameters): Setting username as admin
{
userID: string, // Public userID
username: string, // Optional
adminUserID: string // Admin's local userID
}
Response:
{
Nothing (status code 200)
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
403: Unauthorized (You are not an admin)
GET /api/getUsername
Get current username
Input (URL Parameters):
{
userID: string // Local userID
}
Response:
{
userName: string // Public userID if no username has been set
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
GET /api/segmentInfo
Get information about segments
Input (URL Parameters):
{
// Only the first 10 entries will be processed
UUID: string, // Can be repeated for multiple segments
// OR
UUIDs: string[] // Looks like ["a...0", "b...1"]
}
Response:
[{ // Array of this object
videoID: string,
startTime: float,
endTime: float,
votes: int,
locked: int, // Status of lock - If upvoted by a VIP, the segment is locked
UUID: string,
userID: string, // PublicID of submitted
timeSubmitted: int,
views: int, // Number of reported views on the segment
category: string, // See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
service: string, // See https://github.com/ajayyy/SponsorBlock/wiki/Types#service
videoDuration: int,
hidden: int, // If the segment has 2 downvotes or was downvoted by a VIP
reputation: int, // Reputation of submitter at time of submission
shadowHidden: int, // If the submitter is shadowbanned
userAgent: string // userAgent of the submitter
}]
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
404: Not Found
GET /api/userID
List all users matching the username search
Input (URL Parameters):
{
username: string, // search string for username
// case sensitive
// minimum for non-exact search is 3 characters, maximum is 64 characters
exact: boolean // searches for exact username with no wildcard at end
}
Response:
[{ // Array of this object - maximum 10 results
userName: string,
userID: string
}]
Error codes:
400: Bad Request (Your inputs are wrong/impossible) or exceed the character limits
404: Not Found
GET /api/lockCategories
Get locked categories for a video
Input (URL Parameters):
{
videoID: string
}
Response:
{
categories: string[],
// See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
reason: string // Specified reason for the lock
// Only the most recent reason will be returned
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
404: Not Found
GET /api/lockCategories/:sha256HashPrefix
Get locked categories for a video with extra privacy
sha256HashPrefix is a hash of the YouTube videoID. It should be the first 4 - 32 characters (4 is recommended). This provides extra privacy by potentially finding more than just the video you are looking for. This makes the server not know exactly what video you are looking for.
Input (URL Parameters):
{
prefix: sha256HashPrefix // Optional if not sent through path
}
Response:
[{ // Array of this object
videoID: string,
hash: string, // The full hash of the videoID
categories": string[],
// See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
reason: string // Specified reason for the lock
}]
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
404: Not Found
Stats Calls
GET /api/getTopUsers
Get top submitters
Input (URL Parameters):
{
sortType: int
// 0 for by minutes saved
// 1 for by view count
// 2 for by total submissions
}
Response:
{
userNames: string[],
viewCounts: int[],
totalSubmissions: int[],
minutesSaved: float[]
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
GET /api/getTotalStats
Get total stats
Input (URL Parameters):
{
countContributingUsers: boolean // Optional, default false
}
Response:
{
userCount: int, // Only if countContributingUsers was true
activeUsers: int, // Sum of public install stats from Chrome webstore and Firefox addons store
apiUsers: int, // 48-hour active API users (https://github.com/ajayyy/PrivacyUserCount)
viewCount: int,
totalSubmissions: int,
minutesSaved: float
}
Error codes:
None
GET /api/getDaysSavedFormatted
Get days saved by all skips
Input:
{
Nothing
}
Response:
{
daysSaved: float (2 decimal places)
}
Error codes:
None
VIP Calls
These can only be called by the users added to the VIP table.
GET /api/isUserVIP
If the user is a VIP
Input (URL Parameters):
{
userID: string, // Local userID
}
Response:
{
hashedUserID: string, // Public userID
vip: boolean
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
POST /api/lockCategories
Create a category lock on the video, disallowing further submissions for that category
Input (Request Body):
{
videoID: string,
userID: string, // Local userID
categories: string[], // Categories to lock
// See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
reason: string // Reason for lock
}
Response:
{
Nothing (status code 200)
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
403: Unauthorized (You are not a VIP)
DELETE /api/lockCategories
Delete existing category locks on that video
Input (Request Body):
{
videoID: string,
userID: string, // Local userID
categories: string[] // Categories to remove locks for
// See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
}
Response:
{
message: "Removed lock categories entrys for video videoID"
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
403: Unauthorized (You are not a VIP)
POST /api/shadowBanUser
Shadow banned submissions are hidden for everyone but the IP that originally submitted it. Shadow banning a user shadow bans all future submissions.
Input (URL Parameters):
{
userID: string, // Public userID of the user you want to shadowBan
adminUserID: string, // Local userID of VIP or Admin
enabled: boolean, // Optional, default true, enable or disable ban
unHideOldSubmissions: boolean // Optional, should all previous submissions be banned as well?
}
Response:
{
Nothing (status code 200)
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
403: Unauthorized (You are not a VIP)
409: User already shadowbanned
POST /api/warnUser
Temporary ban that shows a warning asking them to contact us.
If a user is re-warned but there is still a non-expired warning, it is reenabled
Input (Request Body):
{
issuerUserID: string, // Issuer userID (Local userID)
userID: string, // Public userID you are warning
enabled: boolean // Optional, default true
}
Response:
{
Nothing (status code 200)
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
403: Unauthorized (You are not a VIP)
409: User already warned
POST /api/clearCache
Clear redis cache for video.
Input (Request Body):
{
userID: string, // Local userID
videoID: string
}
Response:
{
Cache cleared on video videoID (status code 200)
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
403: Unauthorized (You are not a VIP)
POST /api/purgeAllSegments
Hide all segments on a video without affecting submitters' reputation
Input (Request Body):
{
userID: string, // Local userID
videoID: string
}
Response:
{
Nothing (status code 200)
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
403: Unauthorized (You are not a VIP)
POST /api/segmentShift
Shift all segments on a video
Input (Request Body):
{
videoID: string,
userID: string, // Local userID
startTime: float,
endTime: float
}
Response:
{
Nothing (status code 200)
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
403: Unauthorized (You are not a VIP)
Admin Calls
These can only be called by the server administrator, set in the config.
POST /api/addUserAsVIP
VIPs have extra privileges and their votes count more.
Input (Request Body):
{
userID: string, // Public userID of the user you want to add to the VIP list
adminUserID: string, // Admin's local userID
enabled: boolean // Optional, to be able to add and remove users
}
Response:
{
Nothing (status code 200)
}
Error codes:
400: Bad Request (Your inputs are wrong/impossible)
403: Unauthorized (You are not an admin)
Legacy API
https://github.com/ajayyy/SponsorBlock/wiki/Legacy-API
Local userID vs Public userID
The local userID should be a randomly generated and saved client side and must be 32 characters (or more). If it is not 32 characters or more, you will not be able to vote or submit. The public userID is what is used as an identifier in the database. This is the local userID with a SHA 256 hash 5000 times.