https://github.com/therealshreyash/random-api-docs
The Official documentation for the Random API
https://github.com/therealshreyash/random-api-docs
docs flask image-manipulation python randomapi restapi
Last synced: about 2 months ago
JSON representation
The Official documentation for the Random API
- Host: GitHub
- URL: https://github.com/therealshreyash/random-api-docs
- Owner: TheRealShreyash
- Created: 2023-09-15T17:30:22.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-18T13:32:38.000Z (almost 2 years ago)
- Last Synced: 2024-08-18T14:42:59.470Z (almost 2 years ago)
- Topics: docs, flask, image-manipulation, python, randomapi, restapi
- Homepage: https://random-api-nu.vercel.app
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Random API Docs
## Useful Links
- The Official documentation for the [Random API](https://random-api-nu.vercel.app)
- List of endpoints we provide -> [Endpoints](https://random-api-nu.vercel.app/endpoints)
- Python Examples -> [Py Reference]()
- Javascript Examples -> [Js Reference]()
- Support at -> [Discord](https://dsc.gg/vistara-lounge)
## API Reference
#### Get the version
```http
GET /api/version
```
#### Get Quote
```http
GET /api/quote
```
| Endpoint | Response Type | Description |
| :------- | :------------ | :---------------------------- |
| `quote` | `JSON` | Returns a Quote from the API. |
Also serves the author of the quote in the response.
#### Get Roast
```http
GET /api/roast
```
| Endpoint | Response Type | Description |
| :------- | :------------ | :---------------------------- |
| `roast` | `JSON` | Returns a Roast from the API. |
Also serves the id of the roast so you can report something related to that roast to the [Developer](https://github.com/TheRealShreyash) by posting issues on this repo.
#### Get Question
```http
GET /api/question
```
| Endpoint | Response Type | Description |
| :--------- | :------------ | :------------------------------- |
| `question` | `JSON` | Returns a Question from the API. |
Also serves the id of the question so you can report something related to that question to the [Developer](https://github.com/TheRealShreyash) by posting issues on this repo.
#### Get Trivia
```http
GET /api/trivia
```
| Endpoint | Response Type | Description |
| :------- | :------------ | :----------------------------- |
| `trivia` | `JSON` | Returns a trivia from the API. |
#### Get Token
```http
GET /api/token
```
| Endpoint | Response Type | Description |
| :------- | :------------ | :-------------------------------- |
| `token` | `JSON` | Returns a 100% safe to use token. |
#### Get Naruto Quiz
```http
GET /api/naruto
```
| Endpoint | Response Type | Description |
| :------- | :------------ | :------------------------------------------------------------------------- |
| `naruto` | `JSON` | Returns a question with 3 options and correct option which is one of them. |
#### Get Beautified Image
```http
GET /api/beautify
```
| Endpoint | Response Type | Description |
| :--------- | :------------ | :--------------------------------------- |
| `beautify` | `IMAGE` | Returns a beautified image from the API. |
#### Get Blurred Image
```http
GET /api/blur
```
| Endpoint | Response Type | Description |
| :------- | :------------ | :------------------------------------ |
| `blur` | `IMAGE` | Returns a blurred image from the API. |
#### Get Greyscaled Image
```http
GET /api/greyscale
```
| Endpoint | Response Type | Description |
| :---------- | :------------ | :--------------------------------------- |
| `greyscale` | `IMAGE` | Returns a greyscaled image from the API. |
#### Get Pixelated Image
```http
GET /api/pixelate
```
| Endpoint | Response Type | Description |
| :--------- | :------------ | :-------------------------------------- |
| `pixelate` | `IMAGE` | Returns a pixelated image from the API. |
#### Get Qrcode
```http
GET /api/qrcode
```
| Endpoint | Response Type | Description |
| :------- | :------------ | :--------------------------------------- |
| `qrcode` | `IMAGE` | Returns a qrcode of an url from the API. |
## Author
- [TheRealShreyash](https://therealshreyash.github.io)
## Others
[](https://choosealicense.com/licenses/mit/)
[]()