View source for API Docs

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 [https://github.com/ajayyy/SponsorBlock/wiki/Database-and-API-License this license] unless you have explicit permission. [https://gist.github.com/ajayyy/4b27dfc66e33941a45aeaadccb51de71 Attribution Template]

Public API available at https://sponsor.ajay.app. 

<sub>While this is a free unlimited use API, please don't abuse it. I have limited resources.</sub>

Database download: https://sponsor.ajay.app/database

'''Libraries''': [https://www.npmjs.com/package/sponsorblock-api NPM]
-----Online Database Explorer (By Lartza): https://sb.ltn.fi/

Database Mirror (5 min update time, provided by Lartza): https://sb.ltn.fi/database.db

Slim Database Mirror (5 min update time, provided by Lartza): https://sb.ltn.fi/database_slim.db

<sub>[https://sponsor.ajay.app/database Database Dump] | [https://github.com/ajayyy/SponsorBlock/wiki/Webhooks Webhook Docs]</sub>
-----
====='''GET''' <code>/api/skipSegments</code>=====
'''Input''' (URL Parameters):

<source lang="js">{
  videoID: string,
  category: string, // Optional, defaults to "sponsor", can be repeated for multiple categories.
    // See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
  categories: string[], // Optional, use this instead of "category" if you want multiple categories. Will look like ["sponsor","intro"]

  requiredSegments: string[], // Optional, list of segment UUIDs to require be retrieved, even if they don't meet the minimum vote threshold, can be replaced with "requiredSegment" and repeated for multiple segments like category.

  service: string // Optional, default is 'YouTube'. See https://github.com/ajayyy/SponsorBlock/wiki/Types#service
} </source> '''Response''':

<source lang="js">[{ // 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)
}] </source> '''Error codes''':

400: Bad Request (Your inputs are wrong/impossible)

404: Not Found
-----
====='''GET''' <code>/api/skipSegments/:sha256HashPrefix</code>=====
<code>sha256HashPrefix</code> is a hash of the YouTube <code>videoID</code>. 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):

<source lang="js">{
  category: string, // Optional, defaults to "sponsor", can be repeated for multiple categories.
  // See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
  categories: string[], // Optional, use this instead of "category" if you want multiple categories. Will look like ["sponsor","intro"]

  requiredSegments: string[], // Optional, list of segment UUIDs to require be retrieved, even if they don't meet the minimum vote threshold, can be replaced with "requiredSegment" and repeated for multiple segments like category.

  service: string // Optional, default is 'YouTube'. See https://github.com/ajayyy/SponsorBlock/wiki/Types#service
} </source> '''Response''':

<source lang="js">[{ // Array of this object
   "videoID": string,
   "hash": string, // The full hash
   "segments": [{ // Array of this object
       segment: float[], //[0, 15.23] start and end time in seconds
       UUID: string,
       category: string
   }]
   
}] </source> '''Error codes''':

400: Bad Request (Your inputs are wrong/impossible)

404: Not Found
-----
====='''POST''' <code>/api/skipSegments</code>=====
'''Input Option 1 (URL Parameters)''':

<source lang="js">{
  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" or "[BOT] Name of Bot"


  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)
} </source><nowiki> </nowiki>'''Input Option 2 (JSON Body)''':

<source lang="js">{
  videoID: string,
  userID: string, // This should be a randomly generated UUID stored locally (not the public one)
  userAgent: string, // "Name of Client" or "[BOT] Name of Bot"

  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
  }]
} </source><nowiki> </nowiki>'''Response''':

<source lang="js">{
  Nothing (status code 200)
} </source> '''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''' <code>/api/voteOnSponsorTime</code>=====
'''Input: Normal Vote''' (URL Parameters):

<source lang="js">{
  UUID: string, //id of the sponsor being voted on
  userID: string, //the local user id
  type: int //0 for downvote, 1 for upvote
} </source> OR

'''Input: Category Vote''' (URL Parameters):

<source lang="js">{
  UUID: string, //id of the sponsor being voted on
  userID: string, //the local user id
  category: string //the name of the category to change this submission to
} </source> '''Response''':

<source lang="js">{
  Nothing (status code 200)
} </source> '''Error codes''':

400: Bad Request (Your inputs are wrong/impossible)

403: Reason given in request (moderation)
-----
====='''POST''' <code>/api/viewedVideoSponsorTime</code>=====
'''Input''' (URL Parameters):

<source lang="js">{
  UUID: string
} </source> '''Response''':

<source lang="js">{
  Nothing (status code 200)
} </source> '''Error codes''':

400: Bad Request (Your inputs are wrong/impossible)
-----
====='''GET''' <code>/api/userInfo</code>=====
'''Input''' (URL Parameters):

<source lang="js">{
  userID: string //the local user id
} </source> '''OR'''

<source lang="js">{
  publicUserID: string
} </source> '''Response''':

<source lang="js">{
  userID: string, // the public user ID
  userName: string,
  minutesSaved: float,
  segmentCount: int,
  ignoredSegmentCount: int,
  viewCount: int,
  ignoredViewCount: int,
  warnings: int,
  reputation: float,
  vip: boolean,
  lastSegmentID: string
} </source> '''Error codes''':

400: Bad inputs
-----
====='''GET''' <code>/api/getViewsForUser</code>=====
'''Input''' (URL Parameters):

<source lang="js">{
  userID: string //the local user id
} </source> '''Response''':

<source lang="js">{
  viewCount: int
} </source> '''Error codes''':

404: Not Found
-----
====='''GET''' <code>/api/getSavedTimeForUser</code>=====
'''Input''' (URL Parameters):

<source lang="js">{
  userID: string //the local user id
} </source> '''Response''':

<source lang="js">{
  timeSaved: float //in minutes
} </source> '''Error codes''':

404: Not Found
-----
====='''POST''' <code>/api/setUsername</code>=====
'''Input''' (URL Parameters):

<source lang="js">{
  userID: string, //local user id normally, public user id if adminUserID is specified
  username: string,
  //optional
  adminUserID: string //This is if you want to change someone elses username from the admin account
} </source> '''Response''':

<source lang="js">{
  Nothing (status code 200)
} </source> '''Error codes''':

400: Bad Request (Your inputs are wrong/impossible)
-----
====='''GET''' <code>/api/getUsername</code>=====
'''Input''' (URL Parameters):

<source lang="js">{
  userID: string //the local user id
} </source> '''Response''':

<source lang="js">{
  userName: string //will send back hashed userID if no username has been set
} </source> '''Error codes''':

400: Bad Request (Your inputs are wrong/impossible)
-----
===Stats Calls===
====='''GET''' <code>/api/getTopUsers</code>=====
'''Input''' (URL Parameters):

<source lang="js">{
  sortType: int //0 for by minutes saved, 1 for by view count, 2 for by total submissions
} </source> '''Response''':

<source lang="js">{
  userNames: array [string],
  viewCounts: array [int],
  totalSubmissions: array [int],
  minutesSaved: array [float]
} </source> '''Error codes''':

400: Bad Request (Your inputs are wrong/impossible)
-----
====='''GET''' <code>/api/getTotalStats</code>=====
'''Input''' (URL Parameters):

<source lang="js">{
  "countContributingUsers": boolean //Optional, default false
} </source> '''Response''':

<source lang="js">{
  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
} </source> '''Error codes''':

None
-----
====='''GET''' <code>/api/getDaysSavedFormatted</code>=====
'''Input''':

<source lang="js">{
  Nothing
} </source> '''Response''':

<source lang="js">{
  daysSaved: float (2 decimal places)
} </source> '''Error codes''':

None
-----
====='''GET''' <code>/api/segmentInfo</code>=====
'''Input''' (URL Parameters):

<source lang="js">{
  UUID: string, // Can be used instead of UUIDs, can be repeated to fetch multiple segments
  UUIDs: string[] // Can be used instead of UUID. Maximum 10 entries. Will look like ["a...0", "b...1"]
} </source> '''Response''':

<source lang="js">[{ // Array of this object
  videoID: string,
  startTime: float,
  endTime: fload,
  votes: int,
  locked: int,
  UUID: string,
  userID: string,
  timeSubmitted: int,
  views: int,
  category: string,
  service: string,
  videoDuration: int,
  hidden: int,
  reputation: int,
  shadowHidden: int
}] </source> '''Error codes''':

400: Bad Request (Your inputs are wrong/impossible)

404: Not Found
-----
====='''GET''' <code>/api/userID</code>=====
'''Input''' (URL Parameters):

<source lang="js">{
  username: string, // search string for username
  // case sensitive
  // minimum for non-exact search is 3 characters, maximum is 64 characters
  exact: Boolean // if explicitly set to true, searches for exact username
} </source> '''Response''':

<source lang="js">[{ // Array of this object - maximum 10 results
  userName: string,
  userID: string
}] </source> '''Error codes''':

400: Bad Request (Your inputs are wrong/impossible) or exceed the character limits

404: Not Found
-----
====='''GET''' <code>/api/lockCategories</code>=====
'''Input''' (URL Parameters):

<source lang="js">{
  videoID: string
} </source> '''Response''':

<source lang="js">{
  "categories": string[],
  // See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
  "reason": string
} </source> '''Error codes''':

400: Bad Request (Your inputs are wrong/impossible) 404: Not Found
-----
====='''GET''' <code>/api/lockCategories/:sha256HashPrefix</code>=====
<code>sha256HashPrefix</code> is a hash of the YouTube <code>videoID</code>. 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):

<source lang="js">{
  "prefix": sha256HashPrefix // optional if not sent through path
} </source> '''Response''':

<source lang="js">[{ // Array of this object
   "videoID": string,
   "hash": string, // The full hash
   "categories": string[],
   // See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
   "reason": string
}] </source><nowiki> </nowiki>'''Error codes''':

400: Bad Request (Your inputs are wrong/impossible) 404: Not Found
-----
===VIP Calls===
These can only be called by the users added to the VIP table.
====='''GET''' <code>/api/isUserVIP</code>=====
'''Input''' (URL Parameters):

<source lang="js">{
  userID: string, // private userID
} </source> '''Response''':

<source lang="js">{
  hashedUserID: string,
  vip: boolean
} </source> '''Error codes''':

400: Bad Request (Your inputs are wrong/impossible)
-----
====='''POST''' <code>/api/lockCategories</code> (<code>/api/noSegments</code> deprecated)=====
Will block new segment submissions of the specified category on that video.

'''Input''' (Request Body):

<source lang="js">{
  videoID: string,
  userID: string,
  categories: string[],
  reason: string
} </source> '''Response''':

<source lang="js">{
  Nothing (status code 200)
} </source> '''Error codes''':

400: Bad Request (Your inputs are wrong/impossible)

403: Unauthorized (You are not a VIP)
-----
====='''DELETE''' <code>/api/lockCategories</code> (<code>/api/noSegments</code> deprecated)=====
Will block new segment submissions of the specified category on that video.

'''Input''' (Request Body):

<source lang="js">{
  videoID: string,
  userID: string,
  categories: string[]
} </source> '''Response''':

<source lang="js">{
  message: "Removed lock categories entrys for video {videoID}"
} </source> '''Error codes''':

400: Bad Request (Your inputs are wrong/impossible)

403: Unauthorized (You are not a VIP)
-----
====='''POST''' <code>/api/shadowBanUser</code>=====
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):

<source lang="js">{
  userID: string, //public userID of the user you want to shadowBan
  adminUserID: string, //your userID as an admin
  enabled: boolean, //optional, to be able to add and remove users
  unHideOldSubmissions: boolean //optional, should all previous submissions be banned as well?
} </source> '''Response''':

<source lang="js">{
  Nothing (status code 200)
} </source> '''Error codes''':

400: Bad Request (Your inputs are wrong/impossible)

403: Unauthorized (You are not a VIP)

409: User already warned
-----
====='''POST''' <code>/api/warnUser</code>=====
Temporary ban that shows a warning asking them to contact us.

'''Input''' (Request Body):

<source lang="js">{
  issuerUserID: string, // your userID
  userID: string, // public userID you are warning
  enabled: boolean //optional, default true
} </source> '''Response''':

<source lang="js">{
  Nothing (status code 200)
} </source> '''Error codes''':

400: Bad Request (Your inputs are wrong/impossible)

403: Unauthorized (You are not a VIP)
-----
====='''POST''' <code>/api/clearCache</code>=====
Clear redis cache for video.

'''Input''' (Request Body):

<source lang="js">{
  userID: string, // your userID
  videoID: string // video ID to clear cache of
} </source> '''Response''':

<source lang="js">{
  Cache cleared on video videoID (status code 200)
} </source> '''Error codes''':

400: Bad Request (Your inputs are wrong/impossible)

403: Unauthorized (You are not a VIP)
-----
====='''POST''' <code>/api/purgeAllSegments</code>=====
Hide all segments on a video

'''Input''' (Request Body):

<source lang="js">{
  userID: string, // your userID
  videoID: string // video ID to hide segments of
} </source> '''Response''':

<source lang="js">{
  Nothing (status code 200)
} </source> '''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''' <code>/api/addUserAsVIP</code>=====
VIPs have extra privileges and their votes count more.

'''Input''' (Request Body):

<source lang="js">{
  userID: string, //public userID of the user you want to add to the VIP list
  adminUserID: string, //your userID as an admin
  enabled: boolean //optional, to be able to add and remove users
} </source> '''Response''':

<source lang="js">{
  Nothing (status code 200)
} </source> '''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.