Products

Icons8 Renderer API v1.0.0

Dynamic icon rendering service that generates icons in multiple formats (PNG, SVG, PDF, WebP, JPG, GIF, APNG). Customize size, color, and format with simple URL patterns or query parameters.

#

Security definitions

You can authenticate using one of the following methods:

  • An Api-Key header. For example, Api-Key: YOUR_API_KEY.
  • A token query parameter. For example, if you want to make a request to a resource with URL /endpoint, you can specify your key as /endpoint?token=YOUR_API_KEY

Make sure that each request you perform includes your API key in one of the specified formats. Otherwise, the request will fail.

#

Render icon by ID



Renders an icon by its ID from the Icons8 database. Supports multiple output formats with customizable size and color.

Example: /?id=1337&format=png&size=128&color=ff0000

#

Parameters

id required string

Icon ID from Icons8 database


format optional string default png one of png​svg​svg.editable​pdf​gif​apng​webp​jpg​eps​aep​json​

Output format for the icon. Animated formats (gif, apng, aep, json) only work with animated icons.


size optional string matches /(^[0-9]+$)|(^[0-9]+(x|X)$)/

Icon size in pixels (e.g., '100', '256') or multiplier format ('2x', '3x', '4x').


color optional string matches /^$|([a-fA-F0-9]{6},?){1,2}/

Icon color in hex format without '#'. Supports single color (e.g., 'ff0000') or gradient with two colors separated by comma (e.g., 'ff0000,00ff00'). Gradients only work with gradient-style icon sets.


#

Responses

200 - Successfully returns the rendered icon as binary image data. The icon will be displayed here.
#

Body

body optional string

Successfully returns the icon in the requested format.


#

Render icon by name



Renders an icon using its name and format.

Example: /android.png or /home.svg

#

Parameters

name required string

Icon name (e.g., 'android', 'home', 'settings')


format required string one of png​svg​pdf​gif​apng​webp​jpg​

File format extension


#

Responses

200 - Successfully returns the icon in the requested format.
#

Body

body optional string

Successfully returns the icon in the requested format.


#

Render icon with specific size



Renders an icon with a specific size.

Example: /128/android.png or /64/home.svg

#

Parameters

size required string matches /(^[0-9]+$)|(^[0-9]+(x|X)$)/

Icon size in pixels or multiplier format ('2x', '3x', '4x')


name required string

Icon name


format required string one of png​svg​pdf​gif​apng​webp​jpg​

File format extension


#

Responses

200 - Successfully returns the icon in the requested format.
#

Body

body optional string

Successfully returns the icon in the requested format.


#

Render icon with specific color



Renders an icon with a custom color. Only works with non-color icons.

Example: /ff0000/android.png (red icon) or /00ff00/home.svg (green icon)

#

Parameters

color required string matches /([a-fA-F0-9]{6})/

Hex color code without '#' (e.g., 'ff0000' for red)


name required string

Icon name


format required string one of png​svg​pdf​gif​apng​webp​jpg​

File format extension


#

Responses

200 - Successfully returns the icon in the requested format.
#

Body

body optional string

Successfully returns the icon in the requested format.


#

Render icon with color and size



Renders an icon with custom color and size.

Example: /ff0000/128/android.png (red icon, 128px)

#

Parameters

color required string matches /([a-fA-F0-9]{6})/

Hex color code without '#'


size required string

Icon size in pixels


name required string

Icon name


format required string one of png​svg​pdf​gif​apng​webp​jpg​

File format extension


#

Responses

200 - Successfully returns the icon in the requested format.
#

Body

body optional string

Successfully returns the icon in the requested format.


#

Render icon with size and platform



Renders an icon with specific size and platform style. Platform determines the icon style (e.g., ios7, material, fluency, color, windows).

Example: /128/ios7/android.png or /64/material/home.svg

#

Parameters

size required string

Icon size in pixels


platform required string

Icon platform/style (e.g., 'ios7', 'material', 'fluency', 'color', 'windows')


name required string

Icon name


format required string one of png​svg​pdf​gif​apng​webp​jpg​

File format extension


#

Responses

200 - Successfully returns the icon in the requested format.
#

Body

body optional string

Successfully returns the icon in the requested format.


#

Render icon with color, size, and platform



Renders an icon with custom color, size, and platform style. Platform determines the icon style (e.g., ios7, material, fluency). Parameters can be in any order except the filename with extension must be last.

Example: /ff0000/128/ios7/android.png or /00ff00/64/material/home.svg

#

Parameters

color required string matches /([a-fA-F0-9]{6})/

Hex color code without '#'


size required string

Icon size in pixels


platform required string

Icon platform/style (e.g., 'ios7', 'material', 'fluency', 'color', 'windows')


name required string

Icon name


format required string one of png​svg​pdf​gif​apng​webp​jpg​

File format extension


#

Responses

200 - Successfully returns the icon in the requested format.
#

Body

body optional string

Successfully returns the icon in the requested format.


#

Render icon with gradient (two colors)



Renders an icon with a gradient using two colors. Only works with gradient-style icon sets. Parameters can be in any order except the filename with extension must be last.

Example: /ff0000/00ff00/128/ios7/android.png (red-to-green gradient, 128px, ios7 style)

#

Parameters

color1 required string matches /([a-fA-F0-9]{6})/

First hex color code for gradient start


color2 required string matches /([a-fA-F0-9]{6})/

Second hex color code for gradient end


size required string

Icon size in pixels


platform required string

Icon platform/style


name required string

Icon name


format required string one of png​svg​pdf​gif​apng​webp​jpg​

File format extension


#

Responses

200 - Successfully returns the icon in the requested format.
#

Body

body optional string

Successfully returns the icon in the requested format.