Types

All the custom types used in the package.

Sort

Type: String

Available Values

• newest

• rating

Operator

Type: String

Available Values

• min

• max

• equal

DeviceType

Type: String

Available Values

• desktop

• phone

URL

PARAMETER	TYPE	DESCRIPTION
image	String	Link to the image.
thumbnail	String	Link to the thumbnail version of the image.
webpage	String	A link to the webpage where the image is held.

BySortOptions

PARAMETER	TYPE	DEFAULTS TO	DESCRIPTION
height	Number	N/A	Height of a wallpaper.
operator	Operator	equal	Filter out with respect to the Height and Width.
page	Number	1	Different sets of results.
ratio	[Number, Number]	N/A	[Min, Max] ratios of the wallpaper size. Applicable only to 'phone' type.
type	DeviceType	desktop	Type of the device.
width	Number	N/A	Width of a wallpaper.

Wallpaper

PARAMETER	TYPE	DEFAULTS TO	DESCRIPTION
level	level	1	The quantity of info returned for each wallpaper.
sort	sort	newest	How are the wallpapers sorted.
page	Number	1	Page number, there are 30 wallpapers per page.
width	Number	N/A	Width of the wallpaper.
height	Number	N/A	Height of the wallpaper.
operator	operator	equal	The type of resolution filter.

List

PARAMETER	TYPE	DESCRIPTION
id	Number	ID of the Category or Sub-Category.
name	String	Name of the Category or Sub-Category.
wallpaperCount	desktop: Number phone: Number	Number of wallpapers in each type.

WallpaperInfo

PARAMETER	TYPE	DESCRIPTION
wallpaper	Wallpaper	Refer type
tag	Array<NameID>	Tags attached to the wallpaper.

QueryCount

PARAMETER	TYPE	DESCRIPTION
percentUsed	String	Percentage of API calls used.
used	Number	Number of used API calls.
unused	Number	Number of unused API calls.

File

PARAMETER	TYPE	DESCRIPTION
size	Number	Size of the file in MegaBytes (MB)
type	'jpg' | 'png' | String	Type of the file.

NameID

PARAMETER	TYPE	DESCRIPTION
id	Number	ID of the preceding object.
name	String	Name of the preceding object.

GetWallpaperOptions

PARAMETER	TYPE	DEFAULTS TO	DESCRIPTION
height	Number	N/A	Height of the wallpaper.
operator	Operator	equal	Filter out with respect to height and width.
page	Number	1	Different sets of results.
ratio	[Number, Number]	N/A	[Min, Max] ratios of the wallpaper size. Applicable only to 'phone' type.
sort	Sort	N/A	A sorting method.
type	DeviceType	desktop	Type of the device.
width	Number	N/A	Width of the wallpaper.