Skip to content
Artbucket

Browse an icon set

GET
/api/v1/icons/{prefix}
curl --request GET \
  --url 'http://localhost:3000/api/v1/icons/example?offset=0&limit=96' \
  --header 'Authorization: Bearer <token>'

A page of the set’s icons, each drawn as the SVG an import would store, and its categories to narrow by.

Scope: read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
prefix
required
string

The set, as Iconify names it: tabler, lucide, simple-icons

Query Parameters

Section titled “Query Parameters”
q
string

Words in the icon’s name

category
string

One of the set’s categories

offset
integer
0

Icons to skip

limit
integer
default: 96 >= 1 <= 200

Page size

Responses

Section titled “Responses”

200

Section titled “200”

The set and a page of its icons

Media typeapplication/json
object
set
required
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
categories
required

The set’s own categories, to narrow by

Array<string>
total
required

Matching icons before offset and limit

integer
>= -9007199254740991 <= 9007199254740991
data
required
Array<object>
object
name
required
string
svg
required

The file an import stores

string
Examplegenerated
{
  "set": {
    "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
  },
  "categories": [
    "example"
  ],
  "total": 1,
  "data": [
    {
      "name": "example",
      "svg": "example"
    }
  ]
}

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"
  }
}