Difference between revisions of "API Docs/Draft"

From SponsorBlock
Jump to navigation Jump to search
m (remove database mirror by lartza)
m (switch syntaxhighlight to TS)
Line 18: Line 18:
====='''GET''' <code>/api/skipSegments</code>=====
====='''GET''' <code>/api/skipSegments</code>=====
'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   videoID: string,
   videoID: string,
Line 32: Line 32:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
[{ // Array of this object
[{ // Array of this object
   segment: float[], //[0, 15.23] start and end time in seconds
   segment: float[], //[0, 15.23] start and end time in seconds
Line 51: Line 51:


'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   category: string, // Optional, defaults to "sponsor", can be repeated for multiple categories.
   category: string, // Optional, defaults to "sponsor", can be repeated for multiple categories.
Line 64: Line 64:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
[{ // Array of this object
[{ // Array of this object
   "videoID": string,
   "videoID": string,
Line 73: Line 73:
       category: string
       category: string
   }]
   }]
 
}]
}]
</syntaxhighlight>
</syntaxhighlight>
Line 85: Line 84:


'''Input Option 1 (URL Parameters)''':
'''Input Option 1 (URL Parameters)''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   videoID: string,
   videoID: string,
Line 100: Line 99:


'''Input Option 2 (JSON Body)''':
'''Input Option 2 (JSON Body)''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   videoID: string,
   videoID: string,
Line 117: Line 116:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   Nothing (status code 200)
   Nothing (status code 200)
Line 136: Line 135:


'''Input: Normal Vote''' (URL Parameters):
'''Input: Normal Vote''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   UUID: string, //id of the sponsor being voted on
   UUID: string, //id of the sponsor being voted on
Line 147: Line 146:


'''Input: Category Vote''' (URL Parameters):
'''Input: Category Vote''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   UUID: string, //id of the sponsor being voted on
   UUID: string, //id of the sponsor being voted on
Line 162: Line 161:


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


Line 169: Line 169:


'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   UUID: string
   UUID: string
Line 176: Line 176:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   Nothing (status code 200)
   Nothing (status code 200)
Line 183: Line 183:


'''Error codes''':
'''Error codes''':
400: Bad Request (Your inputs are wrong/impossible)
400: Bad Request (Your inputs are wrong/impossible)
-----
-----
====='''GET''' <code>/api/userInfo</code>=====
====='''GET''' <code>/api/userInfo</code>=====
'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   userID: string //the local user id
   userID: string //the local user id
Line 193: Line 194:
</syntaxhighlight>
</syntaxhighlight>
'''OR'''
'''OR'''
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   publicUserID: string
   publicUserID: string
Line 200: Line 201:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   userID: string, // the public user ID
   userID: string, // the public user ID
Line 217: Line 218:


'''Error codes''':
'''Error codes''':
400: Bad inputs
400: Bad inputs
-----
-----
====='''GET''' <code>/api/getViewsForUser</code>=====
====='''GET''' <code>/api/getViewsForUser</code>=====
'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   userID: string //the local user id
   userID: string //the local user id
Line 235: Line 237:


'''Error codes''':
'''Error codes''':
404: Not Found
404: Not Found
-----
-----
Line 240: Line 243:


'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   userID: string //the local user id
   userID: string //the local user id
Line 259: Line 262:


'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   userID: string, //local user id normally, public user id if adminUserID is specified
   userID: string, //local user id normally, public user id if adminUserID is specified
Line 269: Line 272:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   Nothing (status code 200)
   Nothing (status code 200)
Line 276: Line 279:


'''Error codes''':
'''Error codes''':
400: Bad Request (Your inputs are wrong/impossible)
400: Bad Request (Your inputs are wrong/impossible)
-----
-----
Line 281: Line 285:


'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   userID: string //the local user id
   userID: string //the local user id
Line 288: Line 292:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   userName: string //will send back hashed userID if no username has been set
   userName: string //will send back hashed userID if no username has been set
Line 302: Line 306:


'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   sortType: int //0 for by minutes saved, 1 for by view count, 2 for by total submissions
   sortType: int //0 for by minutes saved, 1 for by view count, 2 for by total submissions
Line 309: Line 313:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   userNames: array [string],
   userNames: string[],
   viewCounts: array [int],
   viewCounts: int[],
   totalSubmissions: array [int],
   totalSubmissions: int[],
   minutesSaved: array [float]
   minutesSaved: float[]
}
}
</syntaxhighlight>
</syntaxhighlight>


'''Error codes''':
'''Error codes''':
400: Bad Request (Your inputs are wrong/impossible)
400: Bad Request (Your inputs are wrong/impossible)
-----
-----
Line 324: Line 329:
'''Input''' (URL Parameters):
'''Input''' (URL Parameters):


<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   "countContributingUsers": boolean //Optional, default false
   "countContributingUsers": boolean //Optional, default false
Line 331: Line 336:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   userCount: int, // Only if countContributingUsers was true
   userCount: int, // Only if countContributingUsers was true
Line 343: Line 348:


'''Error codes''':
'''Error codes''':
None
None
-----
-----
Line 348: Line 354:


'''Input''':
'''Input''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   Nothing
   Nothing
Line 355: Line 361:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   daysSaved: float (2 decimal places)
   daysSaved: float (2 decimal places)
Line 367: Line 373:


'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   UUID: string, // Can be used instead of UUIDs, can be repeated to fetch multiple segments
   UUID: string, // Can be used instead of UUIDs, can be repeated to fetch multiple segments
Line 375: Line 381:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
[{ // Array of this object
[{ // Array of this object
   videoID: string,
   videoID: string,
Line 397: Line 403:


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


Line 404: Line 411:


'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   username: string, // search string for username
   username: string, // search string for username
Line 414: Line 421:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
[{ // Array of this object - maximum 10 results
[{ // Array of this object - maximum 10 results
   userName: string,
   userName: string,
Line 422: Line 429:


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


Line 429: Line 437:


'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   videoID: string
   videoID: string
Line 436: Line 444:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   "categories": string[],
   "categories": string[],
Line 445: Line 453:


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


Line 453: Line 462:


'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   "prefix": sha256HashPrefix // optional if not sent through path
   "prefix": sha256HashPrefix // optional if not sent through path
Line 460: Line 469:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
[{ // Array of this object
[{ // Array of this object
   "videoID": string,
   "videoID": string,
Line 471: Line 480:


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


Line 480: Line 490:


'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   userID: string, // private userID
   userID: string, // private userID
Line 487: Line 497:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   hashedUserID: string,
   hashedUserID: string,
Line 495: Line 505:


'''Error codes''':
'''Error codes''':
400: Bad Request (Your inputs are wrong/impossible)
400: Bad Request (Your inputs are wrong/impossible)
-----
-----
Line 501: Line 512:


'''Input''' (Request Body):
'''Input''' (Request Body):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   videoID: string,
   videoID: string,
Line 511: Line 522:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   Nothing (status code 200)
   Nothing (status code 200)
Line 518: Line 529:


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


Line 526: Line 538:


'''Input''' (Request Body):
'''Input''' (Request Body):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   videoID: string,
   videoID: string,
Line 535: Line 547:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   message: "Removed lock categories entrys for video {videoID}"
   message: "Removed lock categories entrys for video videoID"
}
}
</syntaxhighlight>
</syntaxhighlight>


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


Line 550: Line 563:


'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   userID: string, //public userID of the user you want to shadowBan
   userID: string, //public userID of the user you want to shadowBan
Line 560: Line 573:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   Nothing (status code 200)
   Nothing (status code 200)
Line 567: Line 580:


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


Line 579: Line 593:


'''Input''' (Request Body):
'''Input''' (Request Body):
<syntaxhighlight lang="js">  
<syntaxhighlight lang="ts"> {
{
   issuerUserID: string, // your userID
   issuerUserID: string, // your userID
   userID: string, // public userID you are warning
   userID: string, // public userID you are warning
Line 588: Line 601:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   Nothing (status code 200)
   Nothing (status code 200)
Line 595: Line 608:


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


Line 603: Line 617:


'''Input''' (Request Body):
'''Input''' (Request Body):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   userID: string, // your userID
   userID: string, // your userID
Line 611: Line 625:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   Cache cleared on video videoID (status code 200)
   Cache cleared on video videoID (status code 200)
Line 618: Line 632:


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


Line 626: Line 641:


'''Input''' (Request Body):
'''Input''' (Request Body):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   userID: string, // your userID
   userID: string, // your userID
Line 634: Line 649:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   Nothing (status code 200)
   Nothing (status code 200)
Line 641: Line 656:


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


Line 651: Line 667:


'''Input''' (Request Body):
'''Input''' (Request Body):
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   userID: string, //public userID of the user you want to add to the VIP list
   userID: string, //public userID of the user you want to add to the VIP list
Line 660: Line 676:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   Nothing (status code 200)
   Nothing (status code 200)
Line 667: Line 683:


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



Revision as of 18:51, 5 August 2021

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/

Database Dump | Webhook Docs


GET /api/skipSegments

Input (URL Parameters):

{
  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
}

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

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):

{
  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
}

Response:

[{ // 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
   }]
}]

Error codes:

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

404: Not Found


POST /api/skipSegments

Input Option 1 (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" 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)
}

Input Option 2 (JSON Body):

{
  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
  }]
}

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

Input: Normal Vote (URL Parameters):

{
  UUID: string, //id of the sponsor being voted on
  userID: string, //the local user id
  type: int //0 for downvote, 1 for upvote
}

OR

Input: Category Vote (URL Parameters):

{
  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
}

Response:

{
  Nothing (status code 200)
}

Error codes:

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

403: Reason given in request (moderation)


POST /api/viewedVideoSponsorTime

Input (URL Parameters):

{
  UUID: string
}

Response:

{
  Nothing (status code 200)
}

Error codes:

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


GET /api/userInfo

Input (URL Parameters):

{
  userID: string //the local user id
}

OR

{
  publicUserID: string
}

Response:

{
  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
}

Error codes:

400: Bad inputs


GET /api/getViewsForUser

Input (URL Parameters):

{
  userID: string //the local user id
}

Response:

{
  viewCount: int
}

Error codes:

404: Not Found


GET /api/getSavedTimeForUser

Input (URL Parameters):

{
  userID: string //the local user id
}

Response:

{
  timeSaved: float //in minutes
}

Error codes: 404: Not Found


POST /api/setUsername

Input (URL Parameters):

{
  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
}

Response:

{
  Nothing (status code 200)
}

Error codes:

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


GET /api/getUsername

Input (URL Parameters):

{
  userID: string //the local user id
}

Response:

{
  userName: string //will send back hashed userID if no username has been set
}

Error codes:

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


Stats Calls

GET /api/getTopUsers

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

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

Input:

{
  Nothing
}

Response:

{
  daysSaved: float (2 decimal places)
}

Error codes: None


GET /api/segmentInfo

Input (URL Parameters):

{
  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"]
}

Response:

[{ // 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,
  userAgent: string
}]

Error codes:

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

404: Not Found


GET /api/userID

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 // if explicitly set to true, searches for exact username
}

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

Input (URL Parameters):

{
  videoID: string
}

Response:

{
  "categories": string[],
  // See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
  "reason": string
}

Error codes:

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

404: Not Found


GET /api/lockCategories/:sha256HashPrefix

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
   "categories": string[],
   // See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
   "reason": string
}]

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 /api/isUserVIP

Input (URL Parameters):

{
  userID: string, // private userID
}

Response:

{
  hashedUserID: string,
  vip: boolean
}

Error codes:

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


POST /api/lockCategories

Will block new segment submissions of the specified category on that video.

Input (Request Body):

{
  videoID: string,
  userID: string,
  categories: string[],
  reason: string
}

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

Will block new segment submissions of the specified category on that video.

Input (Request Body):

{
  videoID: string,
  userID: string,
  categories: string[]
}

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, //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?
}

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/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, // your 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)


POST /api/clearCache

Clear redis cache for video.

Input (Request Body):

{
  userID: string, // your userID
  videoID: string // video ID to clear cache of
}

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

Input (Request Body):

{
  userID: string, // your userID
  videoID: string // video ID to hide segments of
}

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, //your userID as an admin
  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.