v1.0.0

OpenAPI 2.0

Illustrations API

Find more info here

Icons8 Team

Public API for accessing illustrations, styles, tags, and categories

Server

https://api-illustrations.icons8.com/api

Client Libraries

Node.js undici

Illustrations

Illustrations operations

Illustrations Operations

get/v2/illustrations/search
get/v2/illustrations
get/v2/illustrations/{id}
get/v2/illustrations/{id}/hi-res

Search illustrations

Search illustrations by query

Query Parameters

query
Type: string
required

Text search query
styles
Type: array of string

Coma separated styles
type
Type: "illustration" or "component"enum
mediaFormat
Type: "png" or "svg"enum

Filter by media resources
orderBy
Type: "relevant" or "random"enum
locale
Type: stringenum

Query and result language

values
enrufrdeitjpesbrcnko
page
Type: integerFormat: int32
min:
1

Page number
perPage
Type: integerFormat: int32
min:
1
max:
100

Number of results per page. Max: 100
fields
Type: string

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

Responses

application/json
application/json
application/json

get/v2/illustrations/search

import { request } from 'undici'

const { statusCode, body } = await request('https://api-illustrations.icons8.com/api/v2/illustrations/search?query=&type=illustration&mediaFormat=png&orderBy=relevant&locale=en&page=1&perPage=10&fields=id%2CmediaResources%2Curls', {
  headers: {
    'Api-Key': 'YOUR_SECRET_TOKEN'
  }
})

Show Schema

{
  "total": 8709,
  "illustrations": [
    {
      "id": "5dbac2cc01d036001536920e",
      "free": false,
      "type": "illustration",
      "heading": "Eco technologies",
      "description": null,
      "author": {
        "icons8Id": "oZpGJx8ts63Q",
        "name": "Thierry Fousse",
        "url": "https://dribbble.com/thierryfousse"
      },
      "styles": [
        "Flame"
      ],
      "categories": [
        "Technologies",
        "Biotech",
        "Ecology",
        "Greentech",
        "Nature",
        "Plants"
      ],
      "tags": [
        "technologies",
        "unplug",
        "plug",
        "eco",
        "plant",
        "nature",
        "windmill",
        "potted plant",
        "houseplant",
        "electricity",
        "plants",
        "plant in pot",
        "economic",
        "plant clipart",
        "electric",
        "electric plant",
        "eco tech",
        "eco technology",
        "ventilator",
        "electric plug"
      ],
      "mediaResources": [
        "svg",
        "png",
        "png-hd"
      ],
      "urls": {
        "thumb": {
          "width": 256,
          "height": 256,
          "url": "https://ouch-prod-var-cdn.icons8.com/bn/illustrations/thumbs/example.png"
        },
        "small": {
          "width": 456,
          "height": 456,
          "url": "https://ouch-prod-var-cdn.icons8.com/bn/illustrations/thumbs/example.png"
        },
        "medium": {
          "width": 512,
          "height": 512,
          "url": "https://ouch-prod-var-cdn.icons8.com/bn/illustrations/thumbs/example.png"
        },
        "large": {
          "width": 912,
          "height": 912,
          "url": "https://ouch-prod-var-cdn.icons8.com/bn/illustrations/thumbs/example.png"
        }
      },
      "createdAt": 1572520653260
    }
  ]
}

Paged illustrations response

List illustrations

List illustrations with filters

Query Parameters

type
Type: "illustration" or "component"enum
mediaFormat
Type: "png" or "svg"enum

Filter by media resources
author
Type: string
styles
Type: array of string

Coma separated styles
categories
Type: array of string

Coma separated categories
tags
Type: array of string

Coma separated tags
orderBy
Type: "latest" or "oldest" or "random"enum
locale
Type: stringenum

Query and result language

values
enrufrdeitjpesbrcnko
page
Type: integerFormat: int32
min:
1

Page number
perPage
Type: integerFormat: int32
min:
1
max:
100

Number of results per page. Max: 100
fields
Type: string

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

Responses

application/json
application/json

get/v2/illustrations

import { request } from 'undici'

const { statusCode, body } = await request('https://api-illustrations.icons8.com/api/v2/illustrations?type=illustration&mediaFormat=png&orderBy=latest&locale=en&page=1&perPage=10&fields=id%2CmediaResources%2Curls', {
  headers: {
    'Api-Key': 'YOUR_SECRET_TOKEN'
  }
})

Show Schema

{
  "total": 8709,
  "illustrations": [
    {
      "id": "5dbac2cc01d036001536920e",
      "free": false,
      "type": "illustration",
      "heading": "Eco technologies",
      "description": null,
      "author": {
        "icons8Id": "oZpGJx8ts63Q",
        "name": "Thierry Fousse",
        "url": "https://dribbble.com/thierryfousse"
      },
      "styles": [
        "Flame"
      ],
      "categories": [
        "Technologies",
        "Biotech",
        "Ecology",
        "Greentech",
        "Nature",
        "Plants"
      ],
      "tags": [
        "technologies",
        "unplug",
        "plug",
        "eco",
        "plant",
        "nature",
        "windmill",
        "potted plant",
        "houseplant",
        "electricity",
        "plants",
        "plant in pot",
        "economic",
        "plant clipart",
        "electric",
        "electric plant",
        "eco tech",
        "eco technology",
        "ventilator",
        "electric plug"
      ],
      "mediaResources": [
        "svg",
        "png",
        "png-hd"
      ],
      "urls": {
        "thumb": {
          "width": 256,
          "height": 256,
          "url": "https://ouch-prod-var-cdn.icons8.com/bn/illustrations/thumbs/example.png"
        },
        "small": {
          "width": 456,
          "height": 456,
          "url": "https://ouch-prod-var-cdn.icons8.com/bn/illustrations/thumbs/example.png"
        },
        "medium": {
          "width": 512,
          "height": 512,
          "url": "https://ouch-prod-var-cdn.icons8.com/bn/illustrations/thumbs/example.png"
        },
        "large": {
          "width": 912,
          "height": 912,
          "url": "https://ouch-prod-var-cdn.icons8.com/bn/illustrations/thumbs/example.png"
        }
      },
      "createdAt": 1572520653260
    }
  ]
}

Paged illustrations response

Illustration by id

Get illustration by ID

Path Parameters

id
Type: string
required

ID

Query Parameters

locale
Type: stringenum

Query and result language

values
enrufrdeitjpesbrcnko
fields
Type: string

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

Responses

application/json
application/json
application/json

get/v2/illustrations/{id}

import { request } from 'undici'

const { statusCode, body } = await request('https://api-illustrations.icons8.com/api/v2/illustrations/5a26a7d177840430d1af749e?locale=en&fields=id%2CmediaResources%2Curls', {
  headers: {
    'Api-Key': 'YOUR_SECRET_TOKEN'
  }
})

Show Schema

{
  "id": "5d1a04e39e78e00015a598f3",
  "free": false,
  "type": "illustration",
  "heading": "Solar panels as eco technology",
  "description": null,
  "author": {
    "icons8Id": "IkN6IH6CvAcL",
    "name": "Sara Maese",
    "url": "http://www.saramaese.com/"
  },
  "styles": [
    "Pluto"
  ],
  "categories": [
    "Objects",
    "Building",
    "Ecology",
    "Greentech",
    "People",
    "Technologies",
    "Web Element",
    "Waiting"
  ],
  "tags": [
    "waiting",
    "garden",
    "process",
    "technologies",
    "watering",
    "eco",
    "nature",
    "gardening",
    "solar panels",
    "watering can",
    "house",
    "gardener",
    "watering pot",
    "solar battery",
    "house clipart",
    "solar",
    "closer to nature",
    "watering plant",
    "nature clipart",
    "watering flower",
    "eco tech",
    "eco technology",
    "working in nature",
    "working in garden"
  ],
  "mediaResources": [
    "svg",
    "png",
    "png-hd"
  ],
  "urls": {
    "thumb": {
      "width": 256,
      "height": 206,
      "url": "https://ouch-prod-var-cdn.icons8.com/bn/illustrations/thumbs/example.png"
    },
    "small": {
      "width": 566,
      "height": 456,
      "url": "https://ouch-prod-var-cdn.icons8.com/bn/illustrations/thumbs/example.png"
    },
    "medium": {
      "width": 512,
      "height": 412,
      "url": "https://ouch-prod-var-cdn.icons8.com/bn/illustrations/thumbs/example.png"
    },
    "large": {
      "width": 1133,
      "height": 912,
      "url": "https://ouch-prod-var-cdn.icons8.com/bn/illustrations/thumbs/example.png"
    }
  },
  "createdAt": 1561986276424
}

Single illustration response

High-resolution illustration

Get high-resolution illustration asset. png is a 912 px preview, free for everyone. png-hd (the original png) and svg of a paid illustration need your Icons8 API key; without it the API answers 401.

Path Parameters

id
Type: string
required

ID

Query Parameters

mediaFormat
Type: "png" or "svg" or "png-hd"enum

Responses

application/json
application/json
application/json
application/json

get/v2/illustrations/{id}/hi-res

import { request } from 'undici'

const { statusCode, body } = await request('https://api-illustrations.icons8.com/api/v2/illustrations/5a26a7d177840430d1af749e/hi-res?mediaFormat=png', {
  headers: {
    'Api-Key': 'YOUR_SECRET_TOKEN'
  }
})

Show Schema

{
  "url": "https://ouch-prod-src-cdn.icons8.com/bn/illustrations/thumbs/example.png",
  "width": 1133,
  "height": 912
}

High-resolution asset response

Styles (Collapsed)

Styles operations

Styles Operations

get/v2/styles

Tags (Collapsed)

Tags operations

Tags Operations

get/v2/tags

Categories (Collapsed)

Categories operations

Categories Operations

get/v2/categories