Search Icons8 icons by a term, with filters by platform (icon style), category, author and other icon attributes.
Pass your API key in the Api-Key header or in the token query parameter. Requests without a key still work but get a warning in message. Get a key on the API keys page.
Search icons by a term, with filters by platform, category, author and other icon attributes.
Search icons by a term. Filter the results by platform, category, author and icon attributes, and page through them with amount and offset.
Term to search by.
Give suggestions based on the term, if results contain less than 10 icons. The suggestion is given in the "suggestion" field of response. If no icons are found for the original term, the suggestion will be applied automatically, giving search results for the suggestion instead of the original term. "isSuggestionApplied" in the response will become true in this case.
Searching by group with an opportunity to use more than 1 arg
How many objects to return at most.
How many object to skip from the beginning of the result collection.
Filter by platform with this API code. Accepts a comma-separated list of platform API codes
Comma-delimited list of category API codes
Language in which to return the results
Api token
possible values: "icons8" (only icons from icons8 designers), "external" (only icons from marketplace authors), "all"
ApiCode of icons author
Include animated icons.
Return icons migrated from ouch
Whether an icon is coloured
Platform to rank by
Shows free or paid icons
enables or desables spellchecker
should explicit icons be shown
replace name with synonyms in case of full match
import { request } from 'undici'
const { statusCode, body } = await request('https://search.icons8.com/api/iconsets/v5/search?term=cart&suggest=false&group=ui%2Cios&platform=ios7%2Cplumpy%2Ccolor&language=en&authors=icons8&isOuch=false&isColor=true&isFree=true&spellcheck=true&allowExplicit=true&replaceNameWithSynonyms=false', {
headers: {
'Api-Key': 'YOUR_SECRET_TOKEN'
}
})
{
"success": true,
"parameters": {
"amount": 10,
"countAll": 9004,
"language": "en",
"foundLanguage": "ru",
"offset": 0,
"term": "car",
"searchTranslations": {
"en": "Shopping Cart",
"ru": "Корзина",
"de": "Warenkorb",
"es": "Carrito de compras",
"ja": "ショッピングカート",
"it": "Carrello della spesa",
"hi": "शॉपिंग कार्ट",
"fr": "Caddie",
"pt": "Carrinho de compras",
"pl": "Koszyk na zakupy",
"ar": "عربة التسوق",
"ko": "쇼핑 카트",
"zh": "购物车"
}
},
"suggestion": "car",
"isSuggestionApplied": "true",
"icons": [
{
"id": "pgnkAal3-Ns3",
"name": "Car",
"commonName": "car",
"category": "Transport",
"subcategory": "Transport",
"platform": "ios7",
"isAnimated": false,
"isFree": true,
"isExternal": true,
"isColor": true,
"isExplicit": false,
"authorId": "",
"authorApiCode": "icons8",
"sourceFormat": "svg",
"sizeInBytes": 1024,
"previewUrl": "https://img.icons8.com/?id=9671&format=png&size=100"
}
],
"message": "Caution: you are not using an API key. It's OK for now, but please get one at https://developers.icons8.com. We switch off the anonymous access on January 1, 2021."
}A successful response with a list of results.