Search and fetch Icons8 icons, and list icon categories and platforms (icon styles).
Every request needs an API key. Pass it in the Api-Key header or in the token query parameter. Get a key on the API keys page.
List icons, and get a single icon with its SVG source or its meta information.
Get a list of all icons.
This request counts as a meta request.
Maximum amount of objects to return.
Page number (with this limit)
Amount of objects that are skipped from the beginning of the collection.
API code of a platform to filter by
API code of a category to filter by
Language in which to fetch results.
Include explicit icons in the response. Defaults to true
If true returns only animated icons, is false returns only static ones.
User API key
Comma-separated list of additional fields to include in the response. Currently supports only tags.
import { request } from 'undici'
const { statusCode, body } = await request('https://api-icons.icons8.com/publicApi/icons?limit=10&offset=20', {
headers: {
'Api-Key': 'YOUR_SECRET_TOKEN'
}
})
{
"success": true,
"docs": [
{
"id": "fsoiqMUp0O4v",
"name": "Car",
"description": "",
"isFree": false,
"isAnimated": false,
"platform": "fluent",
"platformName": "Fluent",
"publishedAt": 1586500600997,
"commonId": "D3e5F4hXcNEZ",
"commonName": "car",
"categoryName": "Transport",
"tags": [
"Auto",
"Automobile",
"Car",
"Sedan",
"Vehicle"
],
"subcategory": "cars",
"subcategoryName": "Cars",
"category": "transport",
"previewUrl": "https://img.icons8.com/?id=9671&format=png&size=100",
"needBackground": false,
"suggestedBackgroundColor": "#FFFFFF"
}
],
"total": 42,
"limit": 10,
"offset": 20,
"page": 3,
"pages": 5
}Default Response
Get a single icon by its id.
This request counts as a download request, due to the response containing the icon SVG source.
Id of the requested icon.
Language in which to fetch results.
User API key
import { request } from 'undici'
const { statusCode, body } = await request('https://api-icons.icons8.com/publicApi/icons/icon?id=9671', {
headers: {
'Api-Key': 'YOUR_SECRET_TOKEN'
}
})
{
"success": true,
"icon": {
"id": "fsoiqMUp0O4v",
"name": "Car",
"description": "",
"isFree": false,
"isAnimated": false,
"platform": "fluent",
"platformName": "Fluent",
"publishedAt": 1586500600997,
"commonId": "D3e5F4hXcNEZ",
"commonName": "car",
"categoryName": "Transport",
"tags": [
"Auto",
"Automobile",
"Car",
"Sedan",
"Vehicle"
],
"subcategory": "cars",
"subcategoryName": "Cars",
"category": "transport",
"previewUrl": "https://img.icons8.com/?id=9671&format=png&size=100",
"needBackground": false,
"suggestedBackgroundColor": "#FFFFFF",
"svg": "<svg xmlns=\"...\" viewBox=\"...\">...</svg>"
}
}Default Response
Get a single icon meta information by its id.
This request counts as a meta request.
Id of the requested icon.
Language in which to fetch results.
User API key
import { request } from 'undici'
const { statusCode, body } = await request('https://api-icons.icons8.com/publicApi/icons/iconMeta?id=9671', {
headers: {
'Api-Key': 'YOUR_SECRET_TOKEN'
}
})
{
"success": true,
"icon": {
"id": "fsoiqMUp0O4v",
"name": "Car",
"description": "",
"isFree": false,
"isAnimated": false,
"platform": "fluent",
"platformName": "Fluent",
"publishedAt": 1586500600997,
"commonId": "D3e5F4hXcNEZ",
"commonName": "car",
"categoryName": "Transport",
"tags": [
"Auto",
"Automobile",
"Car",
"Sedan",
"Vehicle"
],
"subcategory": "cars",
"subcategoryName": "Cars",
"category": "transport",
"previewUrl": "https://img.icons8.com/?id=9671&format=png&size=100",
"needBackground": false,
"suggestedBackgroundColor": "#FFFFFF"
}
}A successful response with a single icon.
List icon categories with their subcategories.
List icon platforms. A platform is an icon style, for example ios7 or color.