SEO API 文件
SEO API 只做一件事:給一個網域,回傳它的註冊資訊和流量。本頁介紹 REST 介面、每個回應欄位、計費方式、給 AI Agent 用的 MCP 服務,以及命令列工具。
API
快速開始
- 使用 Google 登入 即可獲得 10 免費點數。
- 在控制台建立一個 API key,數量不限。
- 在 Authorization 標頭裡帶上 key,呼叫下面的介面。
curl "https://seo-api.org/api/v1/domain?domain=example.com" \
-H "Authorization: Bearer YOUR_API_KEY"驗證
每個請求都要以 Authorization: Bearer YOUR_API_KEY 的形式帶上 key。無法設定 Authorization 標頭的客戶端可以改用 x-api-key: YOUR_API_KEY。key 以 seo_ 開頭。同一帳號下的所有 key 共用點數餘額;在控制台撤銷 key 後立即失效。key 只能放在伺服器或 Agent 配置裡,不要寫進瀏覽器程式碼。
狀態與計費
只有 status 為 ready 時才扣 1 點數。24 小時內再次查詢同一網域免費,不論用的是哪個 key、哪種方式。
- pending: 我們之前沒有這個網域的資料,已經排進採集佇列。伺服器最多等 15 秒再回應;請在
retryAfterSeconds之後再查。免費。 - empty: 網域已採集,但面板裡沒有它的流量,體量很小或剛上線的網站常見這種情況。註冊資訊照常回傳。免費。
- failed: 採集失敗,原因見
message。免費。
錯誤碼
錯誤使用標準 HTTP 狀態碼,外加一個穩定的錯誤碼,可以據此分支處理。
{
"ok": false,
"error": {
"code": "BILLING.INSUFFICIENT_CREDITS",
"message": "Insufficient credits"
}
}SEO_API.MISSING_API_KEY
HTTP401
含義沒有 Authorization 標頭,也沒有 x-api-key 標頭。
SEO_API.INVALID_API_KEY
HTTP401
含義key 不存在或已被撤銷。
SEO_API.INVALID_DOMAIN
HTTP400
含義缺少 domain 參數,或者它不是網域(IP 會被拒絕)。
BILLING.INSUFFICIENT_CREDITS
HTTP402
含義帳號點數用完了。24 小時內的重複查詢仍然可用。
SYSTEM.INTERNAL_SERVER_ERROR
HTTP500
含義我們這邊出了問題,請稍候再重試。