iconFold
登录 开始使用

REST API

用于图标和分类的只读 JSON API。 基础 URL： https://iconfold.com/api

身份验证

每个请求都需要 API 密钥。请在个人资料页创建密钥，并放在 X-API-Key 请求头中发送。也可以使用 Authorization: Bearer …。

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

速率限制

每个密钥每小时可发起 1,000 次请求。匿名请求按 IP 地址共享更低的限额。每个响应都包含 X-RateLimit-Limit；超出限额将返回 HTTP 429。

响应格式

响应为 JSON 格式，包含 data 字段；列表还包含带分页信息的 meta 字段。

{
  "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/zh/icon/fingerprint"
    }
  ],
  "meta": { "page": 1, "per_page": 24, "total": 173, "total_pages": 8 }
}

GET /icons

列出已发布的图标，支持与网站相同的筛选条件。

参数描述
page页码，默认 1
per_page1 到 100，默认 24
category分类标识
tag标签标识
styleoutline、bold、duotone、color…
colormonochrome、multicolor、red、blue…
licensefree 或 premium
sortpopular、newest、downloads、az
include_svg设为 1 可在每项中嵌入 SVG 代码（仅限免费图标）
GET https://iconfold.com/api/icons?category=weather&per_page=2

GET /icons/{id or slug}

单个图标及其标签、许可和 SVG 代码（免费图标，或你账户已拥有的高级图标）。

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

GET /categories

所有分类及其图标数量。

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

GET /search?q=

在名称、标签、关键词和分类中进行全文搜索，同样支持 /icons 的筛选条件。

参数描述
q搜索词，必填
GET https://iconfold.com/api/search?q=arrow

错误

错误使用标准 HTTP 状态码，响应体类似 {"error": {"code": 401, "message": "…"}}：缺少或无效密钥返回 401，访问未拥有的高级内容返回 403，无匹配结果返回 404，超出限额返回 429。