Icons8 Developers

Ouch API v1.0.0

This is a public version of the Ouch API.

#

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.

#

Search illustrations


GET https://api-illustrations.icons8.com/api/v2/illustrations/search?query=example123&token=YOUR_API_KEY

Get list of illustrations by query

#

Parameters

query required string

Text search query


type optional string one of illustration​component​


orderBy optional string default relevant one of relevant​random​


locale optional string default en one of en​ru​fr​de​it​jp​es​br​cn​ko​

Query and result language


page optional integer default 1

Page number


perPage optional integer default 10

Number of results per page. Max: 100


fields optional string default id,urls

Return only specified fields. Example: "id,urls(thumb)". Please request only needed fields.


#

Responses

200 - Search illustrations
#

Body

total optional integer


illustrations optional array of object


id optional string


type optional string


heading optional string


description optional string


author optional object


name optional string


url optional string



styles optional array of string


categories optional array of string


tags optional array of string


urls optional object


thumb optional object

Get a link to a high resolution asset of illustration


width optional integer


height optional integer


url optional string



small optional object

Get a link to a high resolution asset of illustration


width optional integer


height optional integer


url optional string



medium optional object

Get a link to a high resolution asset of illustration


width optional integer


height optional integer


url optional string



large optional



createdAt optional integer



#

List illustrations


GET https://api-illustrations.icons8.com/api/v2/illustrations?token=YOUR_API_KEY

Get list of illustrations

#

Parameters

type optional string one of illustration​component​


author optional string


styles optional array of string

Coma separated styles


categories optional array of string

Coma separated categories


tags optional array of string

Coma separated tags


orderBy optional string default latest one of latest​oldest​random​


locale optional string default en one of en​ru​fr​de​it​jp​es​br​cn​ko​

Query and result language


page optional integer default 1

Page number


perPage optional integer default 10

Number of results per page. Max: 100


fields optional string default id,urls

Return only specified fields. Example: "id,urls(thumb)". Please request only needed fields.


#

Responses

200 - List illustrations
#

Body

total optional integer


illustrations optional array of object


id optional string


type optional string


heading optional string


description optional string


author optional object


name optional string


url optional string



styles optional array of string


categories optional array of string


tags optional array of string


urls optional object


thumb optional object

Get a link to a high resolution asset of illustration


width optional integer


height optional integer


url optional string



small optional object

Get a link to a high resolution asset of illustration


width optional integer


height optional integer


url optional string



medium optional object

Get a link to a high resolution asset of illustration


width optional integer


height optional integer


url optional string



large optional



createdAt optional integer



#

High-resolution illustration


GET https://api-illustrations.icons8.com/api/v2/illustrations/{id}/hi-res?token=YOUR_API_KEY

Get a link to a high resolution asset of illustration

#

Parameters

id required string

ID


mediaFormat optional string default png one of png​svg​png-hd​


#

Responses

200 - High-resolution illustration
#

Body

width optional integer


height optional integer


url optional string


#

Illustration by id


GET https://api-illustrations.icons8.com/api/v2/illustrations/{id}?token=YOUR_API_KEY

Get illustration by id

#

Parameters

id required string

ID


locale optional string default en one of en​ru​fr​de​it​jp​es​br​cn​ko​

Query and result language


fields optional string default id,urls

Return only specified fields. Example: "id,urls(thumb)". Please request only needed fields.


#

Responses

200 - Illustration by id
#

Body

id optional string


type optional string


heading optional string


description optional string


author optional object


name optional string


url optional string



styles optional array of string


categories optional array of string


tags optional array of string


urls optional object


thumb optional object

Get a link to a high resolution asset of illustration


width optional integer


height optional integer


url optional string



small optional object

Get a link to a high resolution asset of illustration


width optional integer


height optional integer


url optional string



medium optional object

Get a link to a high resolution asset of illustration


width optional integer


height optional integer


url optional string



large optional



createdAt optional integer


#

List styles


GET https://api-illustrations.icons8.com/api/v2/styles?token=YOUR_API_KEY

Get list of styles

#

Responses

200 - List styles
#

Body

total optional integer


styles optional array of object


title optional string


illustrationsCount optional integer



#

List tags


GET https://api-illustrations.icons8.com/api/v2/tags?token=YOUR_API_KEY

Get list of tags

#

Parameters

locale optional string default en one of en​ru​fr​de​it​jp​es​br​cn​ko​

Query and result language


page optional integer default 1

Page number


perPage optional integer default 10

Number of results per page. Max: 100


#

Responses

200 - List tags
#

Body

total optional integer


tags optional array of object


title optional string


illustrationsCount optional integer



#

Get categories tree


GET https://api-illustrations.icons8.com/api/v2/categories?token=YOUR_API_KEY

Get full tree of categories

#

Parameters

locale optional string default en one of en​ru​fr​de​it​jp​es​br​cn​ko​

Query and result language


#

Responses

200 - Get categories tree
#

Body

categories optional array of object


title optional string


illustrationsCount optional integer


children optional array of