Loklak Search（官方域名 loklak.net）是一个免费、开源的搜索引擎，本文是一份完整的搜索 API 参考指南：从健康检查、搜索请求、分页过滤到自建部署，5 分钟即可让你的应用接入 Loklak 搜索 API，并以 JSON / XML / Atom 三种格式获取搜索结果。

什么是 Loklak Search？为什么选择开源搜索 API？

Loklak Search 是一个去中心化的开源搜索引擎：爬虫与索引都可以部署在你自己的服务器上，API 接口与公共实例完全一致，无需注册账号、不产生费用、不采集个人数据。

✅核心优势

• 完全开源：可自行查看与托管，数据源由你掌控
• 去中心化：每个实例相互独立，不受单一平台策略约束
• 三种返回格式：JSON / XML / Atom，适配 Web 应用、脚本与订阅类场景

💡 关于本仓库：它是 loklak.net 的域名仓库。CNAME 为域名配置，index.html 会把浏览器 302 重定向到 loklak.org 的搜索页面。

快速开始：5 分钟跑通第一个搜索 API 请求

第 1 步：健康检查。对/api/health发起 GET 请求，返回OK表示服务可用：

curl "https://loklak.org/api/health"

第 2 步：发送第一个搜索请求。/api/search.json的q参数即搜索词：

curl "https://loklak.org/api/search.json?q=open%20source&pageSize=5"

第 3 步：解析响应。JSON 响应的核心结构如下：

{ "query": "open source", "docs": [ { "text": "文档摘要", "title": "结果标题", "url": "结果页面地址", "date": "2025-12-01T08:30:00Z", "category": "web", "language": "en", "location": "Berlin, Germany" } ], "response": { "numFound": 128, "start": 0, "time": 15 } }

三个主要搜索端点：JSON、XML、Atom

三者共用同一套q查询参数与过滤参数，只需按需选择返回格式。

搜索 API 参数参考表：分页、过滤与地理位置

高级搜索语法：让结果更精准的 5 个技巧

在q参数中直接书写高级条件，可与上表的过滤参数叠加使用：

辅助端点：自动补全、热门与状态检查

接入最佳实践与常见问题

1. 频率与缓存：搜索结果在服务端存在索引缓存，建议不要高频轮询，本地加一层 5–10 分钟的缓存即可。
2. 分页终止条件：offset+pageSize组合翻页，当offset≥response.numFound时停止拉取。
3. 错误处理：遇到 5xx 或超时时采用指数退避重试；若使用自建实例，可降级切换到备用实例。
4. 自建部署：在自己服务器上部署后，索引与数据源完全可控，接入代码无需改动，只需替换端点地址。
5. License 合规：项目采用 LGPL v3 授权，集成时请遵守 LICENSE 条款。

本仓库文件索引

• index.html：loklak.net 入口页，302 重定向至搜索站点
• CNAME：域名解析配置
• LICENSE：LGPL v3 授权条款