欢迎使用 GFW 域名工具的 API。本 API 提供了一系列端点,允许您以编程方式获取经过处理的 GFW 域名列表、原始 GFWList 内容以及为 iKuai 路由器定制的 CSV 文件。 所有 API 端点都基于 HTTPS GET
请求,并受益于边缘缓存,以提供快速、可靠的响应。
1. 获取纯净域名列表
该端点返回一个经过处理的、纯文本格式的 GFW 域名列表。列表经过以下处理:
移除了注释、白名单规则和无效条目。
提取了根域名(例如,
||google.com/search
会被处理为google.com
)。去除了重复项并按字母顺序排序。
端点:
GET /api/gfwlist_processed
方法:
GET
响应格式:
text/plain
缓存: 公共缓存,最长 30 分钟 (
public, max-age=1800
)
示例请求 (cURL)
curl https://gfw.api.yangzihome.space/api/gfwlist_processed
示例响应
0rz.tw
1000giri.net
10beasts.net
123rf.com
12bet.com
...
(更多域名)
...
2. 获取原始 GFWList 内容
该端点直接从上游源获取未经任何修改的、Base64 编码的 GFWList 内容。这对于需要自行解析 GFWList 规则的应用程序非常有用。
端点:
GET /api/gfwlist_raw
方法:
GET
响应格式:
text/plain
缓存: 公共缓存,最长 1 小时 (
public, max-age=3600
)
示例请求 (cURL)
curl https://gfw.api.yangzihome.space/api/gfwlist_raw
示例响应 (Base64 编码文本)
ISBHaXRodWIgUmVwb3NpdG9yeTogaHR0cHM6Ly9naXRodWIuY29tL2dmd2xpc3QvZ2Z3bGlzdAoh
IFByb2plY3QgcGFnZTogaHR0cHM6Ly9lbi53aWtpcGVkaWEub3JnL3dpa2kvR0ZXTC8KISBOb3Rl
...
(更多 Base64 编码内容)
...
3. 生成 iKuai 兼容的 CSV 文件
这是一个功能强大的端点,专门用于生成可直接导入 iKuai 路由器的“域名分流”规则的 CSV 文件。它会自动对域名进行分类,并将同一分类下的域名分块聚合到单条规则中,大大简化了 iKuai 上的管理工作。
端点:
GET /api/gfwlist.csv
方法:
GET
响应格式:
text/csv
行为: 触发文件下载,文件名为
gfwlist_ikuai_grouped.csv
。
查询参数
您可以通过 URL 查询参数自定义生成的 CSV 文件内容:
示例请求 (cURL)
基础请求 (使用默认参数):
# 下载文件并保存为 gfwlist_ikuai.csv
curl "https://gfw.api.yangzihome.space/api/gfwlist.csv" -o gfwlist_ikuai.csv
自定义参数请求: 假设您希望规则从 ID 100 开始,并应用于 wan1
端口。
# 自定义起始ID和端口
curl "https://gfw.api.yangzihome.space/api/gfwlist.csv?start_id=100&interface=wan1" -o gfwlist_custom.csv
示例生成的 CSV 内容片段
id,enabled,comment,domain,interface,src_addr,week,time
1,yes,"VPN/代理工具 (1)","azirevpn.com,bandwagonhost.com,...",wan3,"内网",1234567,00:00-23:59
2,yes,"VPN/代理工具 (2)","...","wan3,"内网",1234567,00:00-23:59
3,yes,"云服务/CDN/存储 (1)","akamaized.net,akamaitech.net,...",wan3,"内网",1234567,00:00-23:59
...