Icons8 Search API v5.0.0

Icon search API documentation

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.

Parameters

term required string

Term to search by.

suggest optional boolean

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.

amount optional number at least 1

How many objects to return at most.

offset optional number

How many object to skip from the beginning of the result collection.

platform optional string

Filter by platform with this API code. Accepts a comma-separated list of platform API codes

category optional string

Comma-delimited list of category API codes

language optional string default en

Language in which to return the results

token optional string

Api token

authors optional string default icons8

possible values: "icons8" (only icons from icons8 designers), "external" (only icons from marketplace authors), "all"

isAnimated optional boolean

Include animated icons.

isOuch optional boolean

Return icons migrated from ouch

isColor optional boolean

Whether an icon is coloured

allowExplicit optional boolean

should explicit icons be shown

replaceNameWithSynonyms optional boolean

replace name with synonyms in case of full match

Responses

200 - A successful response with a list of results.

Body

success optional boolean

Whether the response was successful

parameters optional object

Meta-information about the request and collection size.

suggestion optional string

A suggestion for a correct search term if a misspelling is found in it

isSuggestionApplied optional string

True if the suggestion was used in the search instead of the original term.

icons optional array of object

Resulting array of found icons for this platform and term.