Methods

search(...)

Search for wallpapers using filters.

api.search(q="nature", categories=[Category.general], purities=[Purity.sfw])

Parameters:

Parameter	Type	Description
q	str	Query term
categories	list	List of Category enums
purities	list	List of Purity enums
sorting	Sorting	Sorting method
order	Order	Sorting direction
top_range	TopRange	Used with toplist
atleast	tuple	Minimum resolution (width, height)
resolutions	list	Exact resolutions list
ratios	list	Aspect ratio list
colors	Color	Dominant color filter
page	int	Page number
seed	str	Random seed

Returns: JSON with wallpaper search results.

---

wallpaper(wallpaper_id)

Fetch wallpaper metadata.

Returns: JSON data of wallpaper info.

---

is_wallpaper_exists(wallpaper_id)

Check if a wallpaper ID exists.

Returns: True or False.

---

download_wallpaper(wallpaper_id, file_path, chunk_size=4096)

Downloads the wallpaper to the specified path.

Returns: Absolute file path if file_path is set, otherwise bytes.

---

tag(tag_id)

Get metadata for a specific tag.

Returns: JSON with tag details.

---

settings()

Get user settings (requires API key).

Returns: JSON or None.

---

collections(user_name)

Get collections of a specific user.

Returns: JSON with collection info.

---

collection_wallpapers(user_name, collection_id, page=None)

Get wallpapers from a specific collection.

---

my_collections()

Get collections of the authenticated user (requires API key).