Icons8 Developers

Moose API v1.0.0

This is a public version of the Moose API. Please check this thread to keep in touch.

#

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 images


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

Get list of images by query

#

Parameters

type optional string one of photo​collage​background​


query required string

Text search query


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.


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


#

Responses

200 - Search images
#

Body

total optional integer


images optional array of object


id optional string


type optional string


title optional string

first description


urls optional object


thumb optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



small optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



medium optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



large optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string




assets optional object


models optional array of string


objects optional array of string


background optional string



categories optional array of string


descriptions optional array of string


tags optional array of string



#

List images


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

Get list of images

#

Parameters

type optional string one of photo​collage​background​


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.


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


#

Responses

200 - List images
#

Body

total optional integer


images optional array of object


id optional string


type optional string


title optional string

first description


urls optional object


thumb optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



small optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



medium optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



large optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string




assets optional object


models optional array of string


objects optional array of string


background optional string



categories optional array of string


descriptions optional array of string


tags optional array of string



#

High-resolution image


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

Get a link to a high resolution asset of image

#

Parameters

id required string


#

Responses

200 - High-resolution image
#

Body

width optional integer


height optional integer


url optional string


#

Image similars


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

Get list of similars images by id

#

Parameters

id required string


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.


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

Query and result language


#

Responses

200 - Image similars
#

Body

total optional integer


images optional array of object


id optional string


type optional string


title optional string

first description


urls optional object


thumb optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



small optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



medium optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



large optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string




assets optional object


models optional array of string


objects optional array of string


background optional string



categories optional array of string


descriptions optional array of string


tags optional array of string



#

Image by id


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

Get image by id

#

Parameters

id required string


fields optional string default id,urls

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


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

Query and result language


#

Responses

200 - Image by id
#

Body

id optional string


type optional string


title optional string

first description


urls optional object


thumb optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



small optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



medium optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



large optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string




assets optional object


models optional array of string


objects optional array of string


background optional string



categories optional array of string


descriptions optional array of string


tags optional array of string


#

Search assets


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

Get list of assets by query

#

Parameters

type optional string one of model​object​


query required string

Text search query


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.


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


#

Responses

200 - Search assets
#

Body

total optional integer


assets optional array of object


id optional string


type optional string


urls optional object


thumb optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



small optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



medium optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string




tags optional array of string



#

List assets


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

Get list of assets

#

Parameters

type optional string one of model​object​


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 assets
#

Body

total optional integer


assets optional array of object


id optional string


type optional string


urls optional object


thumb optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



small optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



medium optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string




tags optional array of string



#

High-resolution asset


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

Get a link to a high resolution asset of image

#

Parameters

id required string


#

Responses

200 - High-resolution asset
#

Body

width optional integer


height optional integer


url optional string


#

Asset similars


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

Get list of similars assets by id

#

Parameters

id required string


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.


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

Query and result language


#

Responses

200 - Asset similars
#

Body

total optional integer


assets optional array of object


id optional string


type optional string


urls optional object


thumb optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



small optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



medium optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string




tags optional array of string



#

Asset by id


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

Get asset by id

#

Parameters

id required string


fields optional string default id,urls

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


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

Query and result language


#

Responses

200 - Asset by id
#

Body

id optional string


type optional string


urls optional object


thumb optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



small optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string



medium optional object

Get a link to a high resolution asset of image


width optional integer


height optional integer


url optional string




tags optional array of string