Difference between revisions of "API Docs"

From SponsorBlock
Jump to navigation Jump to search
(Add link to sponsorblock.py)
(changes from draft)
(18 intermediate revisions by 2 users not shown)
Line 14: Line 14:
Database download: https://sponsor.ajay.app/database
Database download: https://sponsor.ajay.app/database


'''Libraries''': [https://www.npmjs.com/package/sponsorblock-api Node.js], [https://github.com/wasi-master/sponsorblock.py Python]
'''Libraries''': [https://www.npmjs.com/package/sponsorblock-api Node.js], [https://github.com/wasi-master/sponsorblock.py Python], [https://crates.io/crates/sponsor-block Rust]
-----Online Database Explorer (By Lartza): https://sb.ltn.fi/
-----Online Database Explorer (By Lartza): https://sb.ltn.fi/


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


<sub>[https://sponsor.ajay.app/database Database Dump] | [https://github.com/ajayyy/SponsorBlock/wiki/Webhooks Webhook Docs]</sub>
<sub>[https://sponsor.ajay.app/database Database Dump] | [https://github.com/ajayyy/SponsorBlock/wiki/Webhooks Webhook Docs] | [https://github.com/mchangrh/sb-openapi OpenAPI Docs]</sub>  
-----
-----
====='''GET''' <code>/api/skipSegments</code>=====
====='''GET''' <code>/api/skipSegments</code>=====
Line 29: Line 29:
   videoID: string,
   videoID: string,
    
    
   category: string, // Optional, defaults to "sponsor", can be repeated for multiple categories.
   category: string, // Optional, defaults to "sponsor", can be repeated for multiple categories. [1]
   // OR
   // OR
   categories: string[], // Optional, array of categories, will look like ["sponsor","intro"]
   categories: string[], // Optional [1]
    // 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.
   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
   // OR
   requiredSegments: string[], // Optional, array of required segment UUIDs  
   requiredSegments: string[], // Optional, array of required segment UUIDs


   service: string // Optional, default is 'YouTube'
  actionType: string // Optional, default skip. Can be repeated for multiple types. [3]
    // See https://github.com/ajayyy/SponsorBlock/wiki/Types#service
  // OR 
  actionTypes: string[] // Optional, array of action types
 
   service: string, // Optional, default is 'YouTube' [2]
  locked: int, // If segment is locked
  votes: int, // Votes on segment
  userID: string // Public userID of submitter
}
}
</syntaxhighlight>
</syntaxhighlight>
References: <ref name=":0">See [[Types]] for full list of possible categories. To get multiple, create an array with the format <code>["sponsor", intro"]</code>. </ref> <ref name=":1">Service to get segments for. See [https://wiki.sponsor.ajay.app/w/Types#service Types] for supported services</ref> <ref name=":2">Action Types: Possible values are "mute" and "skip" Select multiple with the format <code>["skip","mute]</code></ref>


'''Response''':
'''Response''':
Line 49: Line 56:
   UUID: string,
   UUID: string,
   category: string,
   category: string,
   videoDuration: float // Duration of video when submission occurred (to be used to determine when a submission is out of date)
   videoDuration: float // Duration of video when submission occurred (to be used to determine when a submission is out of date). 0 when unknown. +- 1 second
  userID: string // userID of submitter
}]
}]
</syntaxhighlight>
</syntaxhighlight>
Line 62: Line 70:
Get segments for a video with extra privacy
Get segments for a video with extra privacy


<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 since the server not know exactly what video you are looking for.
<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 since the server will not know exactly what video you are looking for.


'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
Line 69: Line 77:
   prefix: string, // Can be used instead of path
   prefix: string, // Can be used instead of path


   category: string, // Optional, defaults to "sponsor", can be repeated for multiple categories.
   category: string, // Optional, defaults to "sponsor", can be repeated for multiple categories. [1]
   // OR
   // OR
   categories: string[], // Optional, array of categories, will look like ["sponsor","intro"]
   categories: string[], // Optional, array of categories [1]
    // 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.
   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
   // OR
   requiredSegments: string[], // Optional, array of required segment UUIDs  
   requiredSegments: string[], // Optional, array of required segment UUIDs
 
  actionType: string // Optional, default skip. Can be repeated for multiple types. [3]
  // OR 
  actionTypes: string[] // Optional, array of action types [3]


   service: string // Optional, default is 'YouTube'.
   service: string // Optional, default is 'YouTube'. [2]
    // See https://github.com/ajayyy/SponsorBlock/wiki/Types#service
}
}
</syntaxhighlight>
</syntaxhighlight>
References: <ref name=":0" /> <ref name=":1" /> <ref name=":2" />


'''Response'''
'''Response'''
Line 110: Line 122:
   startTime: float,
   startTime: float,
   endTime: float,
   endTime: float,
   category: string,
   category: string, // [1]
   userID: string, // This should be a randomly generated UUID stored locally (not the public one)
   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"
   userAgent: string, // "Name of Client/Version" or "[BOT] Name of Bot/Version" ex. "Chromium/1.0.0"
   service: string, // Optional, default is 'YouTube'.
   service: string, // Optional, default is 'YouTube'. [2]
    // 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)
   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"
   actionType: string // Optional, default is "skip". [3]
}
}
</syntaxhighlight>
</syntaxhighlight>
References: <ref name=":0" /> <ref name=":1" /> <ref name=":2" />


'''OR'''
'''OR'''
Line 128: Line 141:
   userID: string, // This should be a randomly generated UUID stored locally (not the public one)
   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"
   userAgent: string, // "Name of Client/Version" or "[BOT] Name of Bot/Version" ex. "Chromium/1.0.0"
   service: string, // Optional, default is 'YouTube'.
   service: string, // Optional, default is 'YouTube'.[2]
    // 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)
   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
   segments: [{ // 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
     category: string,
     category: string, // [1]
     actionType: string // Optional, defaults to "skip", can also be "mute"
     actionType: string // Optional, defaults to "skip". [3]
   }]
   }]
}
}
</syntaxhighlight>
</syntaxhighlight>
References: <ref name=":0" /> <ref name=":1" /> <ref name=":2" />


'''Response''':
'''Response''':
Line 161: Line 175:


Creators of the segment and VIPs can remove the segment or change the category with only one vote.
Creators of the segment and VIPs can remove the segment or change the category with only one vote.
<div class="toccolours mw-collapsible mw-collapsed" style="width:400px;">
<div style="font-weight:bold;">VIP voting notes</div>
<div class="mw-collapsible-content">
VIP upvotes will:
* lock the segment
* remove "hidden" property
* remove "shadowHidden" property
</div></div>


'''Input: Normal Vote''' (URL Parameters):
'''Input: Normal Vote''' (URL Parameters):
Line 178: Line 201:
   UUID: string, // UUID of the segment being voted on
   UUID: string, // UUID of the segment being voted on
   userID: string, // Local userID
   userID: string, // Local userID
   category: string // Category to change this submission to
   category: string // Category to change this submission to [1]
} </syntaxhighlight>
} </syntaxhighlight>
References: <ref name=":0" />


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   Nothing (status code 200)
   Nothing (status code 200)
Line 194: Line 219:
403: Reason given in request (moderation)
403: Reason given in request (moderation)
-----
-----
====='''POST''' <code>/api/viewedVideoSponsorTime</code>=====
====='''POST''' <code>/api/viewedVideoSponsorTime</code>=====
Add view to segment
Add view to segment
Line 225: Line 251:
   publicUserID: string // Public userID
   publicUserID: string // Public userID


   value: string[] // Optional, Values to get from userInfo
   values: string[] // Optional, Values to get from userInfo
     // default values are
     // default values are
     // ["userID", "userName", "minutesSaved", "segmentCount", "ignoredSegmentCount",
     // ["userID", "userName", "minutesSaved", "segmentCount", "ignoredSegmentCount",
     // "viewCount", "ignoredViewCount", "warnings", "warningReason", "reputation",
     // "viewCount", "ignoredViewCount", "warnings", "warningReason", "reputation",
     // "vip", "lastSegmentID"]
     // "vip", "lastSegmentID"]
  // OR
  value: string // Optional, Value to get from userInfo, can be repeated for multiple values
}
}
</syntaxhighlight>
</syntaxhighlight>
Line 244: Line 272:
   warnings: int, // Currently enabled warnings
   warnings: int, // Currently enabled warnings
   reputation: float,  
   reputation: float,  
   vip: boolean, // VIP status
   vip: int, // VIP status
   lastSegmentID: string // UUID of last submitted segment
   lastSegmentID: string // UUID of last submitted segment
}
</syntaxhighlight>
'''Error codes''':
400: Bad Request (Your inputs are wrong/impossible)
-----
====='''GET''' <code>/api/userStats</code>=====
Get stats for a user
'''Input''' (URL Parameters):
<syntaxhighlight lang="ts">
{
  userID: string // local UserID
  // OR
  publicUserID: string // Public userID
  fetchCategoryStats: boolean // default false, display category stats
  fetchActionTypeStats: boolean // default false, display type stats
}
</syntaxhighlight>
'''Response''':
<syntaxhighlight lang="ts">
{
  userID: string // hashed userID
  userName: string // userName
  overallStats: {
    minutesSaved: integer // same as userInfo
    segmentCount: integer // same as userInfo
  }
  // IF CHOSEN
  categoryCount: { // # of segments per category
    sponsor: integer
    intro: integer
    outro: integer
    interaction: integer
    selfpromo: integer
    music_offtopic: integer
    preview: integer
    poi_highlight: integer
  }
  // IF CHOSEN
  actionTypeCount: { // # of segments per type
    skip: integer
    mute: integer
  }
}
}
</syntaxhighlight>
</syntaxhighlight>
Line 285: Line 361:


'''Response''':
'''Response''':
<syntaxhighlight lang="js">
<syntaxhighlight lang="ts">
{
{
   timeSaved: float // In minutes
   timeSaved: float // In minutes
Line 373: Line 449:
   timeSubmitted: int,
   timeSubmitted: int,
   views: int, // Number of reported views on the segment
   views: int, // Number of reported views on the segment
   category: string, // See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
   category: string, // [1]
   service: string, // See https://github.com/ajayyy/SponsorBlock/wiki/Types#service
   service: string, // [2]
   videoDuration: int,
   videoDuration: int,
   hidden: int, // If the segment has 2 downvotes or was downvoted by a VIP
   hidden: int, // If the segment has 2 downvotes or was downvoted by a VIP
   reputation: int, // Reputation of submitter at time of submission
   reputation: int, // Reputation of submitter at time of submission
   shadowHidden: int, // If the submitter is shadowbanned
   shadowHidden: int, // If the submitter is shadowbanned
   userAgent: string // userAgent of the submitter
   userAgent: string // userAgent of the submitter,
  actionType: string // [3]
}]
}]
</syntaxhighlight>
</syntaxhighlight>
References: <ref name=":0" /> <ref name=":1" /> <ref name=":2" />


'''Error codes''':
'''Error codes''':
Line 429: Line 508:
<syntaxhighlight lang="ts">
<syntaxhighlight lang="ts">
{
{
   categories: string[],
   categories: string[], // [1]
    // See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
   reason: string // Specified reason for the lock
   reason: string // Specified reason for the lock
     // Only the most recent reason will be returned
     // Only the most recent reason will be returned
}
}
</syntaxhighlight>
</syntaxhighlight>
References: <ref name=":0" />


'''Error codes''':
'''Error codes''':
Line 459: Line 539:
   videoID: string,
   videoID: string,
   hash: string, // The full hash of the videoID
   hash: string, // The full hash of the videoID
   categories": string[],
   categories": string[], // [1]
  // See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
   reason: string // Specified reason for the lock
   reason: string // Specified reason for the lock
}]
}]
</syntaxhighlight>
</syntaxhighlight>
References: <ref name=":0" />


'''Error codes''':
'''Error codes''':


400: Bad Request (Your inputs are wrong/impossible)
400: Bad Request (Your inputs are wrong/impossible)
404: Not Found
-----
====='''GET''' <code>/api/lockReason</code>=====
Get reason for lock(s)
'''Input''' (URL Parameters):
<syntaxhighlight lang="ts">
{
  videoID: string
 
  // Categories to get reasons for, defaults to all [1]
  category: string
  // OR
  categories: string[]
}
</syntaxhighlight>
References: <ref name=":0" />
'''Response''':
<syntaxhighlight lang="ts">
[{ // Array of this object
  category: string
  locked: integer
  reason: string
}]
</syntaxhighlight>
'''Error codes''':
400: Bad Request (Your inputs are wrong/impossible)
-----
====='''GET''' <code>/api/searchSegments</code>=====
Get all segments of a video based on specified filters. Note: It is suggested that you don't use this for knowing which segments to skip on your client, as thresholds and values that determine which segments are the best change over time. Using [https://wiki.sponsor.ajay.app/index.php/API_Docs#GET_.2Fapi.2FskipSegments /api/skipSegments] ensures that you will always get the best segments.
'''Input''' (URL Parameters) '''OR''' (JSON Body):
<syntaxhighlight lang="ts">
{
  // See skipSegments
  videoID: string
  category: string // [1]
  // OR
  categories: string[]
  actionType: string // [3]
  // OR
  actionTypes: string[]
 
  service: string // [2]
  // End SkipSegments
  page: int // Page to start from (default 0)
 
  // Vote/ view thresholds, inclusive, default includes all segments
  minVotes: int
  maxVotes: int
  minViews: int
  maxViews: int
  // Default true - if false, don't show segments that match type
  locked: boolean
  hidden: boolean
  ignored: boolean // hidden or below vote threshold
}
</syntaxhighlight>
References: <ref name=":0" /> <ref name=":1" /> <ref name=":2" />
'''Response''':
<syntaxhighlight lang="ts">
{
  segmentCount: int, // Total number of segments matching query
  page: int, // Page number
  segments: [{ // Array of this object, max 10
    // see segmentInfo
    UUID: string,
    timeSubmitted: int,
    startTime: int,
    endTime: int,
    category: int, // [1]
    actionType: int, // [3]
    votes: int,
    views: int,
    locked: int,
    hidden: int,
    shadowHidden: int,
    userID: string, // UUID of user
  }]
}
</syntaxhighlight>
References: <ref name=":0" /> <ref name=":2" />
'''Error codes''':
400: Bad Request (Your inputs are wrong/impossible)
404: Not Found
-----
====='''GET''' <code>/api/status/:value</code>=====
Get status of server
'''Input:''' (URL path)
Can be any key value in response, requests without path will return all values.
'''Response''':
<syntaxhighlight lang="ts">
{
  uptime: int, // Uptime of server in seconds
  commit: string, // Full SHA hash of latest git commit, development or test
  db: int, // Current database version
  startTime: int, // Unix time that request was received
  processTime: int, // Seconds between startTime and sending response
  loadavg: int[] // 5 and 15 minute loadavg
}
</syntaxhighlight>
'''Error codes''':


404: Not Found
404: Not Found
Line 526: Line 730:
None
None
-----
-----
===== '''GET''' <code>/api/getDaysSavedFormatted</code>=====
====='''GET''' <code>/api/getDaysSavedFormatted</code>=====
Get days saved by all skips
Get days saved by all skips


Line 579: Line 783:
   videoID: string,
   videoID: string,
   userID: string, // Local userID
   userID: string, // Local userID
   categories: string[], // Categories to lock
   categories: string[], // [1]
    // See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
   reason: string // Reason for lock
   reason: string // Reason for lock
}
}
</syntaxhighlight>
</syntaxhighlight>
References: <ref name=":0" />


'''Response''':
'''Response''':
Line 598: Line 803:
403: Unauthorized (You are not a VIP)
403: Unauthorized (You are not a VIP)
-----
-----
====='''DELETE''' <code>/api/lockCategories</code>=====
===== '''DELETE''' <code>/api/lockCategories</code>=====
Delete existing category locks on that video
Delete existing category locks on that video


Line 606: Line 811:
   videoID: string,
   videoID: string,
   userID: string, // Local userID
   userID: string, // Local userID
   categories: string[] // Categories to remove locks for
   categories: string[] // [1]
    // See https://github.com/ajayyy/SponsorBlock/wiki/Types#category
}
}
</syntaxhighlight>
</syntaxhighlight>
References: <ref name=":0" />


'''Response''':
'''Response''':
Line 626: Line 832:
====='''POST''' <code>/api/shadowBanUser</code>=====
====='''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.
Shadow banned submissions are hidden for everyone but the IP that originally submitted it. Shadow banning a user shadow bans all future submissions.
User can be re-shadowbanned if segments were not previously hidden


'''Input''' (URL Parameters):
'''Input''' (URL Parameters):
Line 633: Line 841:
   adminUserID: string, // Local userID of VIP or Admin
   adminUserID: string, // Local userID of VIP or Admin
   enabled: boolean, // Optional, default true, enable or disable ban
   enabled: boolean, // Optional, default true, enable or disable ban
   unHideOldSubmissions: boolean // Optional, should all previous submissions be banned as well?
   unHideOldSubmissions: boolean, // Optional, should all previous submissions be banned as well?
  categories: string // Optional, defaults to all categories, in the format "["sponsor", "selfpromo"]" etc...
}
}
</syntaxhighlight>
</syntaxhighlight>
Line 650: Line 859:
403: Unauthorized (You are not a VIP)
403: Unauthorized (You are not a VIP)


409: User already shadowbanned
409: Duplicate (User already shadowbanned & unHideOldSubmissions not changed)
-----
-----
====='''POST''' <code>/api/warnUser</code>=====
===== '''POST''' <code>/api/warnUser</code>=====
Temporary ban that shows a warning asking them to contact us.
Temporary ban that shows a warning asking them to contact us.


Line 711: Line 920:
{
{
   userID: string, // Local userID
   userID: string, // Local userID
   videoID: string
   videoID: string,
  service: string // Service of video, defaults to YouTube
}
}
</syntaxhighlight>
</syntaxhighlight>
Line 785: Line 995:
===Local userID vs Public userID===
===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.
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.
=== References ===
<references />

Revision as of 19:32, 28 November 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: Node.js, Python, Rust


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 | OpenAPI Docs


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. [1]
  // OR
  categories: string[], // Optional [1]

  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

  actionType: string // Optional, default skip. Can be repeated for multiple types. [3]
  // OR  
  actionTypes: string[] // Optional, array of action types

  service: string, // Optional, default is 'YouTube' [2]
  locked: int, // If segment is locked
  votes: int, // Votes on segment
  userID: string // Public userID of submitter
}

References: [1] [2] [3]

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). 0 when unknown. +- 1 second
   userID: string // userID of submitter
}]

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 will 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. [1]
  // OR
  categories: string[], // Optional, array of categories [1]

  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

  actionType: string // Optional, default skip. Can be repeated for multiple types. [3]
  // OR  
  actionTypes: string[] // Optional, array of action types [3]

  service: string // Optional, default is 'YouTube'. [2]
}

References: [1] [2] [3]

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, // [1]
  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'. [2]
  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". [3]
}

References: [1] [2] [3]

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'.[2]
  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, // [1]
     actionType: string // Optional, defaults to "skip". [3]
  }]
}

References: [1] [2] [3]

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.

VIP voting notes

VIP upvotes will:

  • lock the segment
  • remove "hidden" property
  • remove "shadowHidden" property

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 [1]
}

References: [1]

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

  values: string[] // Optional, Values to get from userInfo
    // default values are
    // ["userID", "userName", "minutesSaved", "segmentCount", "ignoredSegmentCount",
    // "viewCount", "ignoredViewCount", "warnings", "warningReason", "reputation",
    // "vip", "lastSegmentID"]
  // OR
  value: string // Optional, Value to get from userInfo, can be repeated for multiple values
}

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: int, // VIP status
  lastSegmentID: string // UUID of last submitted segment
}

Error codes:

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


GET /api/userStats

Get stats for a user

Input (URL Parameters):

{
  userID: string // local UserID
  // OR
  publicUserID: string // Public userID

  fetchCategoryStats: boolean // default false, display category stats
  fetchActionTypeStats: boolean // default false, display type stats
}

Response:

{
  userID: string // hashed userID
  userName: string // userName
  overallStats: {
    minutesSaved: integer // same as userInfo
    segmentCount: integer // same as userInfo
  }
  // IF CHOSEN
  categoryCount: { // # of segments per category
    sponsor: integer
    intro: integer
    outro: integer
    interaction: integer
    selfpromo: integer
    music_offtopic: integer
    preview: integer
    poi_highlight: integer
  }
  // IF CHOSEN
  actionTypeCount: { // # of segments per type
    skip: integer
    mute: integer
  }
}

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, // [1]
  service: string, // [2]
  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,
  actionType: string // [3]
}]

References: [1] [2] [3]

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[], // [1]
  reason: string // Specified reason for the lock
    // Only the most recent reason will be returned
}

References: [1]

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[], // [1]
   reason: string // Specified reason for the lock
}]

References: [1]

Error codes:

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

404: Not Found


GET /api/lockReason

Get reason for lock(s)

Input (URL Parameters):

{
  videoID: string
  
  // Categories to get reasons for, defaults to all [1]
  category: string
  // OR
  categories: string[]
}

References: [1]

Response:

[{ // Array of this object
  category: string
  locked: integer
  reason: string
}]

Error codes:

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


GET /api/searchSegments

Get all segments of a video based on specified filters. Note: It is suggested that you don't use this for knowing which segments to skip on your client, as thresholds and values that determine which segments are the best change over time. Using /api/skipSegments ensures that you will always get the best segments.

Input (URL Parameters) OR (JSON Body):

{
  // See skipSegments
  videoID: string

  category: string // [1]
  // OR
  categories: string[]

  actionType: string // [3]
  // OR
  actionTypes: string[]
  
  service: string // [2]
  // End SkipSegments

  page: int // Page to start from (default 0)
  
  // Vote/ view thresholds, inclusive, default includes all segments
  minVotes: int
  maxVotes: int

  minViews: int
  maxViews: int

  // Default true - if false, don't show segments that match type
  locked: boolean
  hidden: boolean
  ignored: boolean // hidden or below vote threshold
}

References: [1] [2] [3]

Response:

{
  segmentCount: int, // Total number of segments matching query
  page: int, // Page number
  segments: [{ // Array of this object, max 10
    // see segmentInfo
    UUID: string,
    timeSubmitted: int,
    startTime: int,
    endTime: int,
    category: int, // [1]
    actionType: int, // [3]
    votes: int,
    views: int,
    locked: int,
    hidden: int,
    shadowHidden: int,
    userID: string, // UUID of user
  }]
}

References: [1] [3]

Error codes:

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

404: Not Found


GET /api/status/:value

Get status of server

Input: (URL path)

Can be any key value in response, requests without path will return all values.

Response:

{
  uptime: int, // Uptime of server in seconds
  commit: string, // Full SHA hash of latest git commit, development or test
  db: int, // Current database version
  startTime: int, // Unix time that request was received
  processTime: int, // Seconds between startTime and sending response
  loadavg: int[] // 5 and 15 minute loadavg
}

Error codes:

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[], // [1]
  reason: string // Reason for lock
}

References: [1]

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

References: [1]

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.

User can be re-shadowbanned if segments were not previously hidden

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?
  categories: string // Optional, defaults to all categories, in the format "["sponsor", "selfpromo"]" etc...
}

Response:

{
  Nothing (status code 200)
}

Error codes:

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

403: Unauthorized (You are not a VIP)

409: Duplicate (User already shadowbanned & unHideOldSubmissions not changed)


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,
  service: string // Service of video, defaults to YouTube
}

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.

References

  1. 1.00 1.01 1.02 1.03 1.04 1.05 1.06 1.07 1.08 1.09 1.10 1.11 1.12 See Types for full list of possible categories. To get multiple, create an array with the format ["sponsor", intro"].
  2. 2.0 2.1 2.2 2.3 2.4 2.5 Service to get segments for. See Types for supported services
  3. 3.0 3.1 3.2 3.3 3.4 3.5 3.6 Action Types: Possible values are "mute" and "skip" Select multiple with the format ["skip","mute]