Skip to content
Artbucket

Search open source icon sets

GET
/api/v1/icons
curl --request GET \
  --url 'http://localhost:3000/api/v1/icons?group=Interface&limit=60' \
  --header 'Authorization: Bearer <token>'

Iconify’s icon sets (Tabler, Lucide, Material Symbols, Simple Icons and some 200 more), the popular ones first, each with its author, license and a few sample names. Sets their authors no longer maintain are left out.

Scope: read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
string

Words in the set’s name, author or license

group
string
Allowed values: Interface Logos Emoji Flags Other

Only this kind of set

limit
integer
default: 60 >= 1 <= 300

Page size

Responses

Section titled “Responses”

200

Section titled “200”

Matching sets

Media typeapplication/json
object
data
required
Array<object>
object
prefix
required

Iconify’s name for it: tabler, lucide, simple-icons

string
name
required
string
total
required

Icons in it

integer
>= -9007199254740991 <= 9007199254740991
author
required
Any of:
object
name
required
string
url
string
license
required
Any of:
object
title
required
string
spdx
string
url
string
samples
required

A few of its icons’ names

Array<string>
category
required
string | null
palette
required

Its icons carry their own colors; false: drawn in one color

boolean
height
required

The grid it is drawn on, in px

number | null
total
required

Matches before limit

integer
>= -9007199254740991 <= 9007199254740991
Examplegenerated
{
  "data": [
    {
      "prefix": "example",
      "name": "example",
      "total": 1,
      "author": {
        "name": "example",
        "url": "example"
      },
      "license": {
        "title": "example",
        "spdx": "example",
        "url": "example"
      },
      "samples": [
        "example"
      ],
      "category": "example",
      "palette": true,
      "height": 1
    }
  ],
  "total": 1
}

default

Section titled “default”

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}