🏠Request Structure

Understanding the request structure is the most important thing, so it is kept as simple as possible.

Base Url

The base url to retrieve the api is this:

https://kawaii.red/api/

The output urls are under the domain api.kawaii.red this cannot be used as base url.

Main Endpoint

The main endpoint categorizes the sub endpoints, there are the following main endpoints:

Text Endpoint:

https://kawaii.red/api/txt/

Image Endpoint:

https://kawaii.red/api/png/

GIF Endpoint:

https://kawaii.red/api/gif/

Stats Endpoint:

https://kawaii.red/api/stats/

Sub Endpoint

This is the true endpoint here you define exactly what you want from the API.

https://kawaii.red/api/gif/kiss/

To see a list of all endpoints either add the term "endpoints" as sub endpoint or look at the category list:

📝pageText🌅pageImage🎬pageGIF📊pageStats

Token

The token is essential to associate your api requests to you and to display the stats correctly.

https://kawaii.red/api/gif/kiss?token=token

If you want to know more check here:

🔑pageToken

Type

Type is an optional argument that affects the output of the api, you can choose between json and text.

https://kawaii.red/api/gif/kiss?token=token&type=type

If you want to know more check here:

pageRequest Structure

The default type is json.

Filter

Filter is an optional argument that affects the output of the api, you can basically filter out every response.

https://kawaii.red/api/gif/kiss?token=token&filter=filter

If you want to know more check here:

🗃️pageFilter

The filter must be a array of integers.

Using multiple arguments

If you want to use more than one argument, which occurs as soon as you use the type or the filter, you have to separate them with a &.

https://kawaii.red/api/gif/kiss?token=token&type=type&filter=filter

The omission of the & can lead to the fact that only one argument is recognized.

Last updated