Infrastructure/safetwitch-backend
0
Fork 0
mirror of https://codeberg.org/SafeTwitch/safetwitch-backend.git synced 2024-12-22 05:02:58 -05:00
Code Issues Activity

new instance: stream.whateveritworks.org

Browse source
This commit is contained in:
xbdm 2023-07-15 19:31:29 +00:00
parent 4376dc4e11
commit 71062f240d
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -16,7 +16,7 @@ Every endpoint can return a 500 status code, and it follows this schema:
}
```
### /api/users/:username
### https://streamapi.whateveritworks.org/api/users/xqc
**GET** - :username is any streamer
Gets a specific twitch streamer
@ -62,7 +62,7 @@ The request was successful, returns data of type [Streamer](https://codeberg.org
The streamer was not found
### /api/discover
### https://streamapi.whateveritworks.org/api/discover
**GET**
Gets the discover page of twitch, a list of categories
@ -93,7 +93,7 @@ The request was successful, returns a [CategoryData[]](https://codeberg.org/drag
}
```
### /api/discover/:game
### https://streamapi.whateveritworks.org/api/discover/Grand Theft Auto V
**GET** - :game is a name of a twitch category
Gets a specific twitch category
@ -144,7 +144,7 @@ The server found the category, returns data of type [CategoryPreview[]](https://
The category was not found
### /api/badges?streamerName=NAME
### https://streamapi.whateveritworks.org/api/badges?streamerName=xqc
**GET**
Gets global twitch chat badges
@ -178,7 +178,7 @@ Server retrieved the badges, returns type [Badge[]](hhttps://codeberg.org/dragon
}
```
### /api/search?query=SEARCHQUERY
### https://streamapi.whateveritworks.org/api/search?query=xqc
**GET** - SEARCHQUERY is any string
Searches for categories, streamers, tags, and live streamers. Returns data of type [SearchResult](https://codeberg.org/dragongoose/safetwitch-backend/src/branch/master/extractor/structs/parsed.go)
@ -271,7 +271,7 @@ The server found the search data, returns:
## Proxying Endpoints
### /proxy/img/:base64Url
### https://streamapi.whateveritworks.org/proxy/img/base64Url
**GET**
Proxies an image through the server
@ -287,7 +287,7 @@ Server returns the requested image
The requested image was invalid
### /proxy/stream/:username/hls.m3u8
### https://streamapi.whateveritworks.org/proxy/stream/xqc/hls.m3u8
**GET**
Gets the m3u8 manifest for a streamer. This manifest will contain all stream qualities if they are live
@ -310,7 +310,7 @@ The streamer is not live
}
```
### /proxy/stream/sub/:encodedUrl
### https://streamapi.whateveritworks.org/proxy/stream/sub/encodedUrl
**GET**
Returns the m3u8 manifest for a specific quality under the [master manifest](#/proxy/stream/:username/hls.m3u8)
@ -319,7 +319,7 @@ Returns the m3u8 manifest for a specific quality under the [master manifest](#/p
Returns the manifest file
### /proxy/stream/segment/:encodedUrl
### https://streamapi.whateveritworks.org/proxy/stream/segment/encodedUrl
**GET**
Gets a segment from one of the quality's manifest file. This is the actual video thats displayed on your screen