API v1.0No auth · CORS enabled · Edge cached

Documentation

Everything to integrate 18,039 icons — one endpoint, any color, size, or format. Copy, paste, ship.

Base URLhttps://hylab.vercel.app

Quick start

Get an icon

By name

GET /api/icons/home

Customize

Color, size, format

?color=7c9a82&size=32

Use it

Any stack

<img src="…/home?color=7c9a82" />

Endpoints

GET/api/icons

List icons with pagination and optional filters.

Query

page1Page number

limit50Items per page — max 100

category—Category slug — e.g. navigation, action

set—Family — e.g. tabler, lucide, phosphor (alias: source)

EXAMPLEhttps://hylab.vercel.app/api/icons?set=tabler&category=navigation&page=1&limit=20

GET/api/icons/:name

Get a single icon by name with on-the-fly customization.

Path params

name *Icon name — e.g. home, search, heart — path

Query

colorcurrentColorHex without # — e.g. 7c9a82

size24Pixels — 1 to 512

stroke2Stroke width — 0.5 to 4

formatsvgsvg · png · webp

EXAMPLEhttps://hylab.vercel.app/api/icons/home?color=7c9a82&size=32&format=svg

GET/api/icons/search

Search by name, tags, or category.

Path params

q *Query string — query

EXAMPLEhttps://hylab.vercel.app/api/icons/search?q=arrow

GET/api/icons/categories

All categories with counts — filterable by family.

Query

set—Filter categories to a family — e.g. ?set=tabler

EXAMPLEhttps://hylab.vercel.app/api/icons/categories?set=tabler

GET/api/icons/sets

All icon sets (sources) with counts — filterable by category.

Query

category—Filter families to a category — e.g. ?category=navigation

EXAMPLEhttps://hylab.vercel.app/api/icons/sets?category=navigation

Customization

Query params for /api/icons/:nameAll optional

colorstringcurrentColorHex without # — applied to stroke and fill.

sizenumber24Width & height — 1 to 512.

strokenumber2Stroke width — 0.5 to 4.

fillbooleanfalseFill shape instead of stroke only.

formatstringsvgsvg, png, or webp.

SVG

Vector, scalable — best for web

PNG

Raster, transparent background

WebP

Modern, smaller than PNG

Code examples

HTML

<img src="https://hylab.vercel.app/api/icons/home?color=7c9a82&size=32" alt="Home" />

Icon sets & categories

Sources — 10 libraries, 18,039 icons

Tabler

MIT · consistent stroke

5,093

Remix

Line & fill variants

3,229

Carbon

IBM Design Language

2,665

Lucide

Feather successor

1,582

Phosphor

6 weights

1,512

Iconoir

No frameworks

1,383

BoxIcons

Simple line

814

CSS.gg

Pure CSS

704

Octicons

GitHub Primer

733

Heroicons

Tailwind Labs

324

AI agent prompt

System prompt for Cursor, Copilot, Windsurf, Claude…

You are an AI coding assistant that helps developers integrate icons using HyLab Icons API.

Base URL: https://hylab.vercel.app

Endpoints:
GET /api/icons/:name?color=7c9a82&size=32&format=svg&stroke=2
GET /api/icons?set=tabler&category=navigation&page=1&limit=20
GET /api/icons/search?q=arrow
GET /api/icons/categories?set=tabler
GET /api/icons/sets?category=navigation

Families (10): tabler (5093), remix (3229), carbon (2665), lucide (1582), phosphor (1512), iconoir (1383), boxicons (814), octicons (733), cssgg (704), heroicons (324)
Categories: navigation, action, communication, social, files, media, interface, status, commerce, charts, layout, development, weather, miscellaneous

Browse: /browse?set=tabler or /browse?set=tabler&category=navigation — shareable URL

Usage:
- List family only: GET /api/icons?set=phosphor
- Family + category: GET /api/icons?set=tabler&category=action
- Search: GET /api/icons/search?q=arrow
- Then return: https://hylab.vercel.app/api/icons/{name}?color={color}&size={size}
HTML: <img src="URL" alt="name" />

Add to .cursorrules, AGENTS.md or .github/copilot-instructions.md

Rate limits & caching

Cache-Control: public, max-age=3600 · CORS * · PNG/WebP via sharp

Browse 18k icons →