Wallpapers

All actions for the "/wallpapers" endpoint.

Create a wallpaper

POST https://api.lolwallpapers.net/beta/wallpapers

Request Body

Name	Type	Description
image	string	The image to upload.
purity	number	Either "0" (SFW) or "1" (Sketchy).
artists	array	An array of artists IDs.
tags	array	An array of tags names. (3 tags at least) Maximum tags name length: 20 characters
source	string	A valid URL that leads to the source (where the wallpaper was found).

201 Wallpaper successfully created.

{
    "status": "success",
    "data": {
        "id": "gqOG"
    }
}

400 Validation failed.

Image: Must comply to the following criteria:

• Landscape orientation/mode.

• A minimum of 1280 width and 720 height.

• JPEG/PNG format only.

• Maximum filesize 20MB.

Tags: Must contain at least one child of the parent tag "Artwork" ("Official" or "Fan made") and two other tags minimum.

Get a list of wallpapers

GET https://api.lolwallpapers.net/beta/wallpapers

Query Parameters

Name	Type	Description
search	string	Search through all tags name (not strict).
width	number	Filter by image width.
height	number	Filter by image height.
artists	array	Filter by the passed artists IDs.
tags	array	Filter by the passed tags names.
uploaders	array	Filter by the passed users IDs.
colors	array	Filter by the passed colors (hex. format).
purity	number	Filter by the passed purity: 0 = SFW 1 = Sketchy
sort	string	Sort by: - views - downloads - created_at (default) - updated_at
order	string	Order by: - desc (default) - asc
limit	number	The amount of wallpapers to display per page. Default: 20 Minimum: 1 Maximum: 50
page	number	The page to display. Default: 1 Minimum: 1

200 Success.

{
    "status": "success",
    "data": [
        {
            "id": "Mja9",
            "uploader": {
                "id": "Q6lB",
                "display_name": "Administrator"
            },
            "purity": 0,
            "source": null,
            "media": {
                "filesize": 1384162,
                "format": "jpeg",
                "dimensions": {
                    "width": 1680,
                    "height": 1050
                },
                "colors": [
                    "9d8d64",
                    "372111",
                    "5b391b",
                    "d6bb74",
                    "dbdbd5"
                ],
                "thumbnails": {
                    "small": "http://img.lolwallpapers.net/users/Q6lB/wallpapers/Mja9/small.jpeg",
                    "medium": "http://img.lolwallpapers.net/users/Q6lB/wallpapers/Mja9/medium.jpeg",
                    "large": "http://img.lolwallpapers.net/users/Q6lB/wallpapers/Mja9/large.jpeg",
                    "full": "http://img.lolwallpapers.net/users/Q6lB/wallpapers/Mja9/full.jpeg"
                }
            },
            "is_published": true,
            "has_liked": false,
            "created_at": 1596476517,
            "updated_at": 1596476517
        }
    ]
}

400 Validation failed.

For performance reason, the response will not contain the following fields:

• artists

• tags

• stats

Get a wallpaper

GET https://api.lolwallpapers.net/beta/wallpapers/:id

Path Parameters

Name	Type	Description
id	string	The wallpaper unique ID.

200

Edit a wallpaper

PATCH https://api.lolwallpapers.net/beta/wallpapers/:id

Path Parameters

Name	Type	Description
id	string	The wallpaper unique ID.

Request Body

Name	Type	Description
purity	string	Either "0" (SFW) or "1" (Sketchy).
artists	array	An array of artists IDs (or an empty array if you want to unset all artists from this wallpaper).
tags	array	An array of tags names.
source	string	A valid URL that leads to the source (where the wallpaper was found).

200

Delete a wallpaper by ID

DELETE https://api.lolwallpapers.net/beta/wallpapers/:id

Path Parameters

Name	Type	Description
id	string	The wallpaper ID.

200

403 You're not allowed to delete this wallpaper.

The user must be the uploader of the wallpaper to be able to delete it.

Download a wallpaper

GET https://api.lolwallpapers.net/beta/wallpapers/:id/download

This will downloads the image and use the assigned tags names as filename.

Path Parameters

Name	Type	Description
id	string	The wallpaper ID.

200

Get similar wallpapers

GET https://api.lolwallpapers.net/beta/wallpapers/:id/similar

Returns a minimum of 10 similar wallpapers.

Path Parameters

Name	Type	Description
id	string	The wallpaper ID.

200

Like a wallpaper

POST https://api.lolwallpapers.net/beta/wallpapers/:id/download

Path Parameters

Name	Type	Description
id	string	The wallpaper ID.

200

If the user has already liked the wallpaper, his "like" will be removed.