Icons8 Search API v5.0.0
Icon search API documentation
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 icons within elasticsearch (version 5)
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.
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
possible values: "icons8" (only icons from icons8 designers), "external" (only icons from marketplace authors), "all"
Include animated icons.
Return icons migrated from ouch
Whether an icon is coloured
should explicit icons be shown
replace name with synonyms in case of full match
200 - A successful response with a list of results.
Whether the response was successful
Meta-information about the request and collection size.
A suggestion for a correct search term if a misspelling is found in it
True if the suggestion was used in the search instead of the original term.
Resulting array of found icons for this platform and term.