Searching icons

You can search icons using /search API query.

Query

API query is /search.

Required parameter:

• query, string. Search query. Case insensitive.

Optional parameters:

• limit, number. Search results limit.
• start, number. Start index of result. See below.
• prefix, string. Icon set prefix if you want to get result only for one icon set.
• prefixes, string. Comma separated list of icon set prefixes. You can use partial prefixes that end with "-", such as "mdi-" matches "mdi-light".
• category, string. Limit search to icon sets from specific category.

Limit and start

If your UI uses pagination, please consider saving API resources by not sending unnecessary search queries.

You can use the following logic:

• Set limit to number of icons that fit in first 2 pages.
• If numer of icons in result matches limit, it means there are more icons to show.
• If there are more icons to show, when visitor clicks second page, retrieve the rest of results by setting limit to 999. You can also set start to number of icons retrieved in first query, but that doesn't change much because search function on server can't just resume from old state, so it checks all icons anyway.

Changing limit

There are limits on what you can set limit property to:

• Minimum value: 32.
• Default value, used if property is not set: 64.
• Maximum value: 999.

You can change limits in API code in src/http/responses/search.ts.

Response

Response is a simple object with the following properties:

• icons, string[] - list of icons. Each icon name includes icon set prefix + name: "mdi-light:home"
• total, number - number of results. Same length of icons property.
• limit, number - results limit set by search. If matches total, there are more results available.
• start, number - index of first result.
• collections, Record<string,IconifyInfo> - info blocks for icon sets used in results.
• request - copy of request parameters. All values in this object are string, as they are passed to query.

Examples

json{
   "icons": [
       "material-symbols:add-home",
       "material-symbols:add-home-outline",
       "material-symbols:add-home-outline-rounded",
       "material-symbols:add-home-rounded",
       "material-symbols:add-home-work",
       "material-symbols:add-home-work-outline",
       "material-symbols:add-home-work-outline-rounded",
       "material-symbols:add-home-work-rounded",
       "material-symbols:add-to-home-screen",
       "material-symbols:add-to-home-screen-outline",
       "material-symbols:add-to-home-screen-outline-rounded",
       "material-symbols:add-to-home-screen-outline-sharp",
       "material-symbols:add-to-home-screen-rounded",
       "material-symbols:add-to-home-screen-sharp",
       "material-symbols:broadcast-on-home",
       "material-symbols:broadcast-on-home-outline",
       "material-symbols:broadcast-on-home-outline-rounded",
       "material-symbols:broadcast-on-home-outline-sharp",
       "material-symbols:broadcast-on-home-rounded",
       "material-symbols:broadcast-on-home-sharp",
       "material-symbols:digital-out-of-home",
       "material-symbols:emergency-home",
       "material-symbols:emergency-home-outline",
       "material-symbols:emergency-home-outline-rounded",
       "material-symbols:emergency-home-rounded",
       "material-symbols:garage-home",
       "material-symbols:garage-home-outline",
       "material-symbols:home",
       "material-symbols:home-app-logo",
       "material-symbols:home-iot-device",
       "material-symbols:home-iot-device-outline",
       "material-symbols:home-max",
       "material-symbols:home-max-dots",
       "material-symbols:home-max-dots-outline",
       "material-symbols:home-max-outline",
       "material-symbols:home-max-outline-rounded",
       "material-symbols:home-max-rounded",
       "material-symbols:home-mini",
       "material-symbols:home-mini-outline",
       "material-symbols:home-outline",
       "material-symbols:home-outline-rounded",
       "material-symbols:home-pin",
       "material-symbols:home-repair-service",
       "material-symbols:home-repair-service-outline",
       "material-symbols:home-repair-service-outline-rounded",
       "material-symbols:home-repair-service-outline-sharp",
       "material-symbols:home-repair-service-rounded",
       "material-symbols:home-repair-service-sharp",
       "material-symbols:home-rounded",
       "material-symbols:home-speaker",
       "material-symbols:home-speaker-outline",
       "material-symbols:home-storage",
       "material-symbols:home-storage-outline",
       "material-symbols:home-storage-outline-rounded",
       "material-symbols:home-storage-outline-sharp",
       "material-symbols:home-storage-rounded",
       "material-symbols:home-storage-sharp",
       "material-symbols:home-work",
       "material-symbols:home-work-outline",
       "material-symbols:home-work-outline-rounded",
       "material-symbols:home-work-rounded",
       "material-symbols:in-home-mode",
       "material-symbols:location-home",
       "ic:baseline-add-home"
   ],
   "total": 64,
   "limit": 64,
   "start": 0,
   "collections": {
       "material-symbols": {
           "name": "Material Symbols",
           "total": 8413,
           "author": {
               "name": "Google",
               "url": "https://github.com/google/material-design-icons"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0",
               "url": "https://github.com/google/material-design-icons/blob/master/LICENSE"
           },
           "samples": ["downloading", "privacy-tip", "filter-drama-outline"],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "ic": {
           "name": "Google Material Icons",
           "total": 10955,
           "version": "1.0.32",
           "author": {
               "name": "Material Design Authors",
               "url": "https://github.com/material-icons/material-icons"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0",
               "url": "https://github.com/material-icons/material-icons/blob/master/LICENSE"
           },
           "samples": [
               "baseline-notifications-active",
               "outline-person-outline",
               "twotone-videocam-off"
           ],
           "height": 24,
           "category": "General",
           "palette": false
       }
   },
   "request": {
       "query": "home",
       "pretty": "1"
   }
}

/search?query=home&pretty=1

json{
   "icons": [
       "ph:arrows-horizontal",
       "ph:arrows-horizontal-bold",
       "ph:arrows-horizontal-duotone",
       "ph:arrows-horizontal-fill",
       "ph:arrows-horizontal-light",
       "ph:arrows-horizontal-thin",
       "carbon:arrows-horizontal",
       "tabler:arrows-horizontal",
       "pixelarticons:arrows-horizontal",
       "humbleicons:arrows-horizontal",
       "nimbus:arrows-horizontal",
       "line-md:arrows-horizontal",
       "line-md:arrows-horizontal-alt"
   ],
   "total": 13,
   "limit": 999,
   "start": 0,
   "collections": {
       "material-symbols": {
           "name": "Material Symbols",
           "total": 8413,
           "author": {
               "name": "Google",
               "url": "https://github.com/google/material-design-icons"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0",
               "url": "https://github.com/google/material-design-icons/blob/master/LICENSE"
           },
           "samples": ["downloading", "privacy-tip", "filter-drama-outline"],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "ic": {
           "name": "Google Material Icons",
           "total": 10955,
           "version": "1.0.32",
           "author": {
               "name": "Material Design Authors",
               "url": "https://github.com/material-icons/material-icons"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0",
               "url": "https://github.com/material-icons/material-icons/blob/master/LICENSE"
           },
           "samples": [
               "baseline-notifications-active",
               "outline-person-outline",
               "twotone-videocam-off"
           ],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "mdi": {
           "name": "Material Design Icons",
           "total": 7134,
           "author": {
               "name": "Austin Andrews",
               "url": "https://github.com/Templarian/MaterialDesign"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0",
               "url": "https://github.com/Templarian/MaterialDesign/blob/master/LICENSE"
           },
           "samples": ["account-check", "bell-alert-outline", "calendar-edit"],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "ph": {
           "name": "Phosphor",
           "total": 6282,
           "version": "1.4.2",
           "author": {
               "name": "Phosphor Icons",
               "url": "https://github.com/phosphor-icons/phosphor-icons"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/phosphor-icons/phosphor-icons/blob/master/LICENSE"
           },
           "samples": [
               "folder-notch-open-duotone",
               "check-square-offset-thin",
               "pencil-line-fill"
           ],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "carbon": {
           "name": "Carbon",
           "total": 1859,
           "version": "11.10.0",
           "author": {
               "name": "IBM",
               "url": "https://github.com/carbon-design-system/carbon/tree/main/packages/icons"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0"
           },
           "samples": ["user-certification", "humidity", "edit-off"],
           "height": 32,
           "displayHeight": 16,
           "category": "General",
           "palette": false
       },
       "bi": {
           "name": "Bootstrap Icons",
           "total": 1851,
           "version": "1.9.1",
           "author": {
               "name": "The Bootstrap Authors",
               "url": "https://github.com/twbs/icons"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/twbs/icons/blob/main/LICENSE.md"
           },
           "samples": ["graph-up", "card-image", "code-slash"],
           "height": 16,
           "category": "General",
           "palette": false
       },
       "tabler": {
           "name": "Tabler Icons",
           "total": 2925,
           "version": "1.109.0",
           "author": {
               "name": "Paweł Kuna",
               "url": "https://github.com/tabler/tabler-icons"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/tabler/tabler-icons/blob/master/LICENSE"
           },
           "samples": ["alien", "device-desktop", "photo"],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "uil": {
           "name": "Unicons",
           "total": 1206,
           "version": "4.0.1",
           "author": {
               "name": "Iconscout",
               "url": "https://github.com/Iconscout/unicons"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0",
               "url": "https://github.com/Iconscout/unicons/blob/master/LICENSE"
           },
           "samples": ["arrow-circle-right", "chat-bubble-user", "edit-alt"],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "clarity": {
           "name": "Clarity",
           "total": 1103,
           "author": {
               "name": "VMware",
               "url": "https://github.com/vmware/clarity"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/vmware/clarity-assets/blob/master/LICENSE"
           },
           "samples": [
               "help-outline-badged",
               "heart-broken-solid",
               "shield-outline-alerted"
           ],
           "height": 36,
           "displayHeight": 18,
           "category": "General",
           "palette": false
       },
       "majesticons": {
           "name": "Majesticons",
           "total": 760,
           "version": "2.1.2",
           "author": {
               "name": "Gerrit Halfmann",
               "url": "https://github.com/halfmage/majesticons"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/halfmage/majesticons/blob/main/LICENSE"
           },
           "samples": ["chats-line", "home", "edit-pen-4-line"],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "ant-design": {
           "name": "Ant Design Icons",
           "total": 789,
           "version": "4.2.1",
           "author": {
               "name": "HeskeyBaozi",
               "url": "https://github.com/ant-design/ant-design-icons"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/ant-design/ant-design-icons/blob/master/LICENSE"
           },
           "samples": ["pushpin-filled", "pie-chart-outlined", "shopping-twotone"],
           "height": 16,
           "category": "General",
           "palette": false
       },
       "gg": {
           "name": "css.gg",
           "total": 704,
           "version": "2.0.0",
           "author": {
               "name": "Astrit",
               "url": "https://github.com/astrit/css.gg"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/astrit/css.gg/blob/master/LICENSE"
           },
           "samples": ["align-left", "server", "overflow"],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "pixelarticons": {
           "name": "Pixelarticons",
           "total": 480,
           "version": "1.7.0",
           "author": {
               "name": "Gerrit Halfmann",
               "url": "https://github.com/halfmage/pixelarticons"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/halfmage/pixelarticons/blob/master/LICENSE"
           },
           "samples": ["drag-and-drop", "arrows-horizontal", "heart"],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "humbleicons": {
           "name": "Humbleicons",
           "total": 235,
           "version": "1.9.0",
           "author": {
               "name": "Jiří Zralý",
               "url": "https://github.com/zraly/humbleicons"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/zraly/humbleicons/blob/master/license"
           },
           "samples": ["aid", "droplet", "rss"],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "uim": {
           "name": "Unicons Monochrome",
           "total": 296,
           "version": "4.0.1",
           "author": {
               "name": "Iconscout",
               "url": "https://github.com/Iconscout/unicons"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0",
               "url": "https://github.com/Iconscout/unicons/blob/master/LICENSE"
           },
           "samples": ["airplay", "circle-layer", "lock-access"],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "uit": {
           "name": "Unicons Thin Line",
           "total": 214,
           "version": "4.0.1",
           "author": {
               "name": "Iconscout",
               "url": "https://github.com/Iconscout/unicons"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0",
               "url": "https://github.com/Iconscout/unicons/blob/master/LICENSE"
           },
           "samples": ["circuit", "favorite", "toggle-on"],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "uis": {
           "name": "Unicons Solid",
           "total": 189,
           "version": "4.0.1",
           "author": {
               "name": "Iconscout",
               "url": "https://github.com/Iconscout/unicons"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0",
               "url": "https://github.com/Iconscout/unicons/blob/master/LICENSE"
           },
           "samples": ["analysis", "check", "user-md"],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "fluent": {
           "name": "Fluent UI System Icons",
           "total": 11814,
           "version": "1.1.179",
           "author": {
               "name": "Microsoft Corporation",
               "url": "https://github.com/microsoft/fluentui-system-icons"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/microsoft/fluentui-system-icons/blob/master/LICENSE"
           },
           "samples": [
               "zoom-out-24-filled",
               "drink-coffee-24-regular",
               "photo-filter-24-regular"
           ],
           "displayHeight": 24,
           "category": "General",
           "palette": false
       },
       "icon-park-outline": {
           "name": "IconPark Outline",
           "total": 2658,
           "version": "1.4.2",
           "author": {
               "name": "ByteDance",
               "url": "https://github.com/bytedance/IconPark"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0",
               "url": "https://github.com/bytedance/IconPark/blob/master/LICENSE"
           },
           "samples": ["add-one", "english-mustache", "basketball-clothes"],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "icon-park-solid": {
           "name": "IconPark Solid",
           "total": 1965,
           "version": "1.4.2",
           "author": {
               "name": "ByteDance",
               "url": "https://github.com/bytedance/IconPark"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0",
               "url": "https://github.com/bytedance/IconPark/blob/master/LICENSE"
           },
           "samples": ["add-one", "english-mustache", "basketball-clothes"],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "icon-park-twotone": {
           "name": "IconPark TwoTone",
           "total": 1944,
           "version": "1.4.2",
           "author": {
               "name": "ByteDance",
               "url": "https://github.com/bytedance/IconPark"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0",
               "url": "https://github.com/bytedance/IconPark/blob/master/LICENSE"
           },
           "samples": ["add-one", "english-mustache", "basketball-clothes"],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "icon-park": {
           "name": "IconPark",
           "total": 2658,
           "version": "1.4.2",
           "author": {
               "name": "ByteDance",
               "url": "https://github.com/bytedance/IconPark"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0",
               "url": "https://github.com/bytedance/IconPark/blob/master/LICENSE"
           },
           "samples": ["add-one", "english-mustache", "basketball-clothes"],
           "height": 24,
           "category": "General",
           "palette": true
       },
       "jam": {
           "name": "Jam Icons",
           "total": 940,
           "author": {
               "name": "Michael Amprimo",
               "url": "https://github.com/michaelampr/jam"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/michaelampr/jam/blob/master/LICENSE"
           },
           "samples": ["chevrons-square-up-right", "luggage-f", "rubber"],
           "height": 24,
           "category": "General",
           "palette": false
       },
       "heroicons": {
           "name": "HeroIcons",
           "total": 876,
           "version": "2.0.13",
           "author": {
               "name": "Refactoring UI Inc",
               "url": "https://github.com/tailwindlabs/heroicons"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/tailwindlabs/heroicons/blob/master/LICENSE"
           },
           "samples": ["camera", "building-library", "receipt-refund"],
           "height": [24, 20],
           "category": "General",
           "palette": false
       },
       "fa6-solid": {
           "name": "Font Awesome Solid",
           "total": 1388,
           "version": "6.2.0",
           "author": {
               "name": "Dave Gandy",
               "url": "https://github.com/FortAwesome/Font-Awesome"
           },
           "license": {
               "title": "CC BY 4.0",
               "spdx": "CC-BY-4.0",
               "url": "https://creativecommons.org/licenses/by/4.0/"
           },
           "samples": ["location-pin", "gem", "folder"],
           "height": 32,
           "displayHeight": 16,
           "category": "General",
           "palette": false
       },
       "nimbus": {
           "name": "Nimbus",
           "total": 140,
           "version": "0.2.9",
           "author": {
               "name": "Linkedstore S.A.",
               "url": "https://github.com/TiendaNube/nimbus-icons"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/TiendaNube/nimbus-icons/blob/develop/LICENSE"
           },
           "samples": ["barcode", "mail", "calendar"],
           "height": 16,
           "category": "General",
           "palette": false
       },
       "line-md": {
           "name": "Material Line Icons",
           "total": 395,
           "version": "0.2.7",
           "author": {
               "name": "Vjacheslav Trushkin",
               "url": "https://github.com/cyberalien/line-md"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/cyberalien/line-md/blob/master/license.txt"
           },
           "samples": [
               "loading-twotone-loop",
               "beer-alt-twotone-loop",
               "image-twotone"
           ],
           "height": 24,
           "category": "Animated Icons",
           "palette": false
       },
       "openmoji": {
           "name": "OpenMoji",
           "total": 4064,
           "author": {
               "name": "OpenMoji",
               "url": "https://github.com/hfg-gmuend/openmoji"
           },
           "license": {
               "title": "CC BY-SA 4.0",
               "spdx": "CC-BY-SA-4.0",
               "url": "https://creativecommons.org/licenses/by-sa/4.0/"
           },
           "samples": ["bicycle", "bow-and-arrow", "full-moon-face"],
           "height": 18,
           "category": "Emoji",
           "palette": true
       },
       "twemoji": {
           "name": "Twitter Emoji",
           "total": 3668,
           "author": {
               "name": "Twitter",
               "url": "https://github.com/twitter/twemoji"
           },
           "license": {
               "title": "CC BY 4.0",
               "spdx": "CC-BY-4.0",
               "url": "https://creativecommons.org/licenses/by/4.0/"
           },
           "samples": ["anguished-face", "duck", "crossed-swords"],
           "height": 36,
           "displayHeight": 18,
           "category": "Emoji",
           "palette": true
       },
       "noto": {
           "name": "Noto Emoji",
           "total": 3449,
           "author": {
               "name": "Google Inc",
               "url": "https://github.com/googlefonts/noto-emoji"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0",
               "url": "https://github.com/googlefonts/noto-emoji/blob/main/LICENSE"
           },
           "samples": ["beaming-face-with-smiling-eyes", "computer-mouse", "dove"],
           "height": 16,
           "category": "Emoji",
           "palette": true
       },
       "fluent-emoji": {
           "name": "Fluent Emoji",
           "total": 2980,
           "author": {
               "name": "Microsoft Corporation",
               "url": "https://github.com/microsoft/fluentui-emoji"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/microsoft/fluentui-emoji/blob/main/LICENSE"
           },
           "samples": ["avocado", "ticket", "yin-yang"],
           "height": 32,
           "displayHeight": 24,
           "category": "Emoji",
           "palette": true
       },
       "fluent-emoji-flat": {
           "name": "Fluent Emoji Flat",
           "total": 2980,
           "author": {
               "name": "Microsoft Corporation",
               "url": "https://github.com/microsoft/fluentui-emoji"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/microsoft/fluentui-emoji/blob/main/LICENSE"
           },
           "samples": ["avocado", "ticket", "yin-yang"],
           "height": 32,
           "displayHeight": 24,
           "category": "Emoji",
           "palette": true
       },
       "fluent-emoji-high-contrast": {
           "name": "Fluent Emoji High Contrast",
           "total": 1545,
           "author": {
               "name": "Microsoft Corporation",
               "url": "https://github.com/microsoft/fluentui-emoji"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/microsoft/fluentui-emoji/blob/main/LICENSE"
           },
           "samples": ["avocado", "ticket", "yin-yang"],
           "height": 32,
           "displayHeight": 24,
           "category": "Emoji",
           "palette": false
       },
       "noto-v1": {
           "name": "Noto Emoji (v1)",
           "total": 2162,
           "author": {
               "name": "Google Inc",
               "url": "https://github.com/googlefonts/noto-emoji"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0",
               "url": "https://github.com/googlefonts/noto-emoji/blob/main/LICENSE"
           },
           "samples": ["face-with-open-mouth", "no-littering", "scissors"],
           "height": 16,
           "category": "Emoji",
           "palette": true
       },
       "emojione": {
           "name": "Emoji One (Colored)",
           "total": 1834,
           "version": "2.3.0",
           "author": {
               "name": "Emoji One",
               "url": "https://github.com/EmojiTwo/emojitwo"
           },
           "license": {
               "title": "CC BY 4.0",
               "spdx": "CC-BY-4.0",
               "url": "https://creativecommons.org/licenses/by/4.0/"
           },
           "samples": [
               "anxious-face-with-sweat",
               "cloud-with-snow",
               "studio-microphone"
           ],
           "height": 32,
           "displayHeight": 16,
           "category": "Emoji",
           "palette": true
       },
       "emojione-monotone": {
           "name": "Emoji One (Monotone)",
           "total": 1403,
           "version": "2.2.7",
           "author": {
               "name": "Emoji One",
               "url": "https://github.com/EmojiTwo/emojitwo"
           },
           "license": {
               "title": "CC BY 4.0",
               "spdx": "CC-BY-4.0",
               "url": "https://creativecommons.org/licenses/by/4.0/"
           },
           "samples": ["face-with-tongue", "envelope", "frog-face"],
           "height": 32,
           "displayHeight": 16,
           "category": "Emoji",
           "palette": false
       },
       "emojione-v1": {
           "name": "Emoji One (v1)",
           "total": 1262,
           "version": "1.5.2",
           "author": {
               "name": "Emoji One",
               "url": "https://github.com/joypixels/emojione-legacy"
           },
           "license": {
               "title": "CC BY-SA 4.0",
               "spdx": "CC-BY-SA-4.0",
               "url": "https://creativecommons.org/licenses/by-sa/4.0/"
           },
           "samples": ["face-savoring-food", "panda-face", "artist-palette"],
           "height": 32,
           "displayHeight": 16,
           "category": "Emoji",
           "palette": true
       },
       "game-icons": {
           "name": "Game Icons",
           "total": 4046,
           "author": {
               "name": "GameIcons",
               "url": "https://github.com/game-icons/icons"
           },
           "license": {
               "title": "CC BY 3.0",
               "spdx": "CC-BY-3.0",
               "url": "https://github.com/game-icons/icons/blob/master/license.txt"
           },
           "samples": ["diamond-trophy", "thrown-spear", "rank-3"],
           "height": 32,
           "displayHeight": 16,
           "category": "Thematic",
           "palette": false
       },
       "la": {
           "name": "Line Awesome",
           "total": 1544,
           "version": "1.2.1",
           "author": {
               "name": "Icons8",
               "url": "https://github.com/icons8/line-awesome"
           },
           "license": {
               "title": "Apache 2.0",
               "spdx": "Apache-2.0",
               "url": "https://www.apache.org/licenses/LICENSE-2.0"
           },
           "samples": ["archive-solid", "female-solid", "check-circle"],
           "category": "Archive / Unmaintained",
           "palette": false
       },
       "entypo": {
           "name": "Entypo+",
           "total": 321,
           "author": {
               "name": "Daniel Bruce",
               "url": "https://github.com/chancancode/entypo-plus"
           },
           "license": {
               "title": "CC BY-SA 4.0",
               "spdx": "CC-BY-SA-4.0",
               "url": "https://creativecommons.org/licenses/by-sa/4.0/"
           },
           "samples": ["bell", "image", "erase"],
           "height": 20,
           "category": "Archive / Unmaintained",
           "palette": false
       },
       "foundation": {
           "name": "Foundation",
           "total": 283,
           "version": "3.0.0",
           "author": {
               "name": "Zurb",
               "url": "https://github.com/zurb/foundation-icon-fonts"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT"
           },
           "samples": ["graph-trend", "indent-more", "lock"],
           "height": 20,
           "category": "Archive / Unmaintained",
           "palette": false
       },
       "icons8": {
           "name": "Icons8 Windows 10 Icons",
           "total": 234,
           "version": "1.0.0",
           "author": {
               "name": "Icons8",
               "url": "https://github.com/icons8/windows-10-icons"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT"
           },
           "samples": ["checked", "create-new", "group"],
           "category": "Archive / Unmaintained",
           "palette": false
       },
       "heroicons-outline": {
           "name": "HeroIcons v1 Outline",
           "total": 230,
           "version": "1.0.6",
           "author": {
               "name": "Refactoring UI Inc",
               "url": "https://github.com/tailwindlabs/heroicons"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/tailwindlabs/heroicons/blob/master/LICENSE"
           },
           "samples": ["color-swatch", "library", "receipt-refund"],
           "height": 24,
           "category": "Archive / Unmaintained",
           "palette": false
       },
       "heroicons-solid": {
           "name": "HeroIcons v1 Solid",
           "total": 230,
           "version": "1.0.6",
           "author": {
               "name": "Refactoring UI Inc",
               "url": "https://github.com/tailwindlabs/heroicons"
           },
           "license": {
               "title": "MIT",
               "spdx": "MIT",
               "url": "https://github.com/tailwindlabs/heroicons/blob/master/LICENSE"
           },
           "samples": ["color-swatch", "library", "receipt-refund"],
           "height": 20,
           "category": "Archive / Unmaintained",
           "palette": false
       },
       "fa-solid": {
           "name": "Font Awesome 5 Solid",
           "total": 1001,
           "version": "5.15.4",
           "author": {
               "name": "Dave Gandy",
               "url": "https://github.com/FortAwesome/Font-Awesome"
           },
           "license": {
               "title": "CC BY 4.0",
               "spdx": "CC-BY-4.0",
               "url": "https://creativecommons.org/licenses/by/4.0/"
           },
           "samples": ["search-plus", "paste", "comment-dots"],
           "height": 32,
           "displayHeight": 16,
           "category": "Archive / Unmaintained",
           "palette": false
       }
   },
   "request": {
       "query": "arrows-horizontal",
       "pretty": "1",
       "limit": "999"
   }
}

/search?query=arrows-horizontal&pretty=1&limit=999

Error response

If no matches found, search returns object with no icons:

json{
 "icons": [],
 "total": 0,
 "limit": 64,
 "start": 0,
 "collections": {},
 "request": {
   "query": "zzzz",
   "pretty": "1"
 }
}

If query is invalid, such as missing query parameter, server returns 400 HTTP error.

If search engine is disabled, /search route is not handled, server returns 404 HTTP error.

Type

Type for API response:

tsimport type { IconifyInfo } from "@iconify/types";

export interface APIv2SearchResponse {
 // List of icons, including prefixes
 icons: string[];

 // Number of results. If same as `limit`, more results are available
 total: number;

 // Number of results shown
 limit: number;

 // Index of first result
 start: number;

 // Info about icon sets
 collections: Record<string, IconifyInfo>;

 // Copy of request, values are string
 request: Record<keyof APIv2SearchParams, string>;
}