Difference between revisions of "API Docs/Draft"

From SponsorBlock
Jump to navigation Jump to search
(Formatting changes - moved some endpoints of of stat calls)
(Add segmentShift)
Line 708: Line 708:


403: Unauthorized (You are not a VIP)
403: Unauthorized (You are not a VIP)
-----
====='''POST''' <code>/api/segmentShift</code>=====
Shift all segments on a video
'''Input''' (Request Body):
<syntaxhighlight lang="ts">
{
  videoID: string, //local userID
  startTime: float,
  endTime: float
}
</syntaxhighlight>
'''Response''':
<syntaxhighlight lang="ts">
{
  Nothing (status code 200)
}
</syntaxhighlight>
'''Error codes''':
400: Bad Request (Your inputs are wrong/impossible)
403: Unauthorized (You are not a VIP)
-----
-----
===Admin Calls===
===Admin Calls===

Revision as of 06:16, 24 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

Get segments for a video.

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

Get segments for a video with anonymity

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

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" 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)
}

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" 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

Vote on a segment or vote to change the category of the segment.

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

Add view to segment

Input (URL Parameters):

{
  UUID: string
}

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 //the local user id
  value: Values to get from userInfo // optional
  // default values are:
  // ["userID", "userName", "minutesSaved", "segmentCount", "ignoredSegmentCount",
  // "viewCount", "ignoredViewCount", "warnings", "warningReason", "reputation",
  // "vip", "lastSegmentID"]
}

OR

{
  publicUserID: string
  value: Values to get from userInfo // optional
  // default values are:
  // ["userID", "userName", "minutesSaved", "segmentCount", "ignoredSegmentCount",
  // "viewCount", "ignoredViewCount", "warnings", "warningReason", "reputation",
  // "vip", "lastSegmentID"]
}

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 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 //the local user id
}

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 //the local user id
}

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 user id
  username: string, //optional
}

OR

Input (URL Parameters): Setting username as admin

Admin Only

{
  userID: string, //public user id
  username: string, //optional
  adminUserID: string //admin local user id
}

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


GET /api/segmentInfo

Get information about segments

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

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

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
}

Error codes:

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

404: Not Found


GET /api/lockCategories/:sha256HashPrefix

Get locked caterogies for video anonymously

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


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, // 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 delete existing locked categories 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 without affecting submitter's reputation

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)


POST /api/segmentShift

Shift all segments on a video

Input (Request Body):

{
  videoID: 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, //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.