REST API

Autenticação

Toda requisição precisa de uma chave de API. Crie uma na sua página de perfil e envie no cabeçalho X-API-Key. Authorization: Bearer … também funciona.

curl -H "X-API-Key: iv_your_key_here" "https://iconfold.com/api/icons?per_page=5"

Limites de uso

Cada chave pode fazer 1,000 requisições por hora. Requisições anônimas compartilham um limite menor por endereço IP. Toda resposta inclui X-RateLimit-Limit; ultrapassar retorna HTTP 429.

Formato de resposta

As respostas são JSON com um campo data e, nas listas, um campo meta com a paginação.

{
  "data": [
    {
      "id": 109,
      "name": "Home",
      "slug": "fingerprint",
      "category": "UI & UX",
      "style": "outline",
      "license": "Free for commercial use",
      "premium": false,
      "downloads": 1204,
      "svg_url": "https://iconfold.com/svg/fingerprint.svg",
      "url": "https://iconfold.com/pt/icon/fingerprint"
    }
  ],
  "meta": { "page": 1, "per_page": 24, "total": 173, "total_pages": 8 }
}

GET /icons

Lista os ícones publicados. Aceita os mesmos filtros do site.

GET https://iconfold.com/api/icons?category=weather&per_page=2

GET /icons/{id or slug}

Um ícone com tags, licença e código SVG (ícones grátis ou ícones premium que sua conta possui).

GET https://iconfold.com/api/icons/fingerprint

GET /categories

Todas as categorias com a contagem de ícones.

GET https://iconfold.com/api/categories

GET /search?q=

Busca de texto completo em nomes, tags, palavras-chave e categorias. Também aceita os filtros de /icons.

GET https://iconfold.com/api/search?q=arrow

Erros

Os erros usam códigos de status HTTP padrão com um corpo como {"error": {"code": 401, "message": "…"}}: 401 para chave ausente ou inválida, 403 para conteúdo premium que você não possui, 404 quando nada corresponde e 429 quando você excede o limite.