mirror of
https://github.com/ajayyy/SponsorBlock.git
synced 2025-12-14 23:47:04 +03:00
Changes by blabdude - Add userID endpoint
27
API-Docs.md
27
API-Docs.md
@@ -435,6 +435,33 @@ __________________________________________________________________
|
||||
|
||||
__________________________________________________________________
|
||||
|
||||
##### **GET** `/api/userID`
|
||||
|
||||
**Input** (URL Parameters):
|
||||
```js
|
||||
{
|
||||
username: string, // search string for username
|
||||
// minimum for non-exact search is 3 characters, maximum is 64 characters
|
||||
exact: Boolean // if explicitly set to true, searches for exact username
|
||||
}
|
||||
```
|
||||
|
||||
**Response**:
|
||||
```js
|
||||
[{ // 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
|
||||
|
||||
__________________________________________________________________
|
||||
|
||||
### VIP Calls
|
||||
|
||||
These can only be called by the users added to the VIP table.
|
||||
|
||||
Reference in New Issue
Block a user