YepAPI — API 參考資料
基礎 URL: https://api.yepapi.com
身分驗證: x-api-key 標頭
回應格式: { ok: true, data: {...} } 或 { ok: false, error: { code, message } }
速率限制: 60 次請求/分鐘
SEO — 關鍵字
| 方法 | 路徑 | 費用 | 必填參數 | 說明 |
|---|---|---|---|---|
| POST | /v1/seo/keywords | $0.15 | keywords[]、location | 大量指標:搜尋量、CPC、難度、意圖、趨勢(最多 100 個) |
| POST | /v1/seo/keywords/ideas | $0.03 | keyword、location | 從種子關鍵字取得建議 |
| POST | /v1/seo/keywords/related | $0.03 | keyword、location | 種子關鍵字的相關關鍵字 |
回傳:volume、cpc、difficulty (0-100)、intent (informational/commercial/navigational/transactional)、trend (12 個月陣列)
SERP
| 方法 | 路徑 | 費用 | 必填參數 | 說明 |
|---|---|---|---|---|
| POST | /v1/serp/google | $0.01 | query、location | Google 自然搜尋結果 |
| POST | /v1/serp/google/news | $0.01 | query、location | Google 新聞結果 |
| POST | /v1/serp/google/maps | $0.01 | query、location | Google 地圖/本地結果 |
回傳:results[],包含 title、url、snippet、position。地圖端點額外回傳 rating、reviews、address、phone。
網域分析
| 方法 | 路徑 | 費用 | 必填參數 | 說明 |
|---|---|---|---|---|
| POST | /v1/seo/domain/overview | $0.01 | domain | 流量、關鍵字、反向連結、網域排名 |
| POST | /v1/seo/domain/keywords | $0.04 | domain | 網域排名的關鍵字 |
| POST | /v1/seo/domain/backlinks | $0.05 | domain | 網域反向連結檔案 |
回傳:概覽給出 traffic、keywords_count、backlinks、domain_rank。關鍵字給出 keyword、position、volume、url。
競爭者
| 方法 | 路徑 | 費用 | 必填參數 | 說明 |
|---|---|---|---|---|
| POST | /v1/seo/competitors | $0.04 | domain | 依關鍵字重疊程度找出競爭者網域 |
| POST | /v1/seo/keyword-gap | $0.04 | domain、competitor | 兩個網域之間的關鍵字缺口 |
回傳:競爭者給出 domain、overlap、traffic。缺口給出 keyword、your_position、competitor_position、volume。
反向連結
| 方法 | 路徑 | 費用 | 必填參數 | 說明 |
|---|---|---|---|---|
| POST | /v1/seo/backlinks | $0.05 | target | 指向網域/URL 的個別反向連結 |
| POST | /v1/seo/backlinks/summary | $0.03 | target | 匯總指標 + dofollow 比例 |
| POST | /v1/seo/referring-domains | $0.03 | target | 參照網域及其權重 |
回傳:摘要給出 total_backlinks、dofollow_ratio、domain_rank。反向連結給出 source_url、anchor、type、domain_rank。
頁面內分析與趨勢
| 方法 | 路徑 | 費用 | 必填參數 | 說明 |
|---|---|---|---|---|
| POST | /v1/seo/page-audit | $0.03 | url | 技術 SEO 審計(中繼資料、標題、連結、圖片) |
| POST | /v1/seo/lighthouse | $0.05 | url | Lighthouse 分數(效能、無障礙、SEO、最佳做法) |
| POST | /v1/seo/trends | $0.02 | keywords[] | Google 趨勢隨時間變化的興趣(最多 5 個關鍵字) |
回傳:頁面審計給出 issues[]、meta、headings、links、images。Lighthouse 給出 performance、accessibility、seo、best_practices (0-100)。趨勢給出 interest_over_time[]。
AI 可見性
| 方法 | 路徑 | 費用 | 必填參數 | 說明 |
|---|---|---|---|---|
| POST | /v1/seo/ai/chatgpt | $0.05 | query | ChatGPT 對品牌/查詢的回應 |
| POST | /v1/seo/ai/gemini | $0.05 | query | Gemini 對品牌/查詢的回應 |
回傳:response (文字)、mentions[]、sentiment。
網頁爬蟲
| 方法 | 路徑 | 費用 | 必填參數 | 說明 |
|---|---|---|---|---|
| POST | /v1/scrape | $0.01 | url | 爬取為 Markdown/HTML/純文字 |
| POST | /v1/scrape/js | $0.02 | url | JS 渲染爬取(無頭瀏覽器) |
| POST | /v1/scrape/stealth | $0.03 | url | 反機器人繞過(住宅代理) |
| POST | /v1/scrape/ai-extract | $0.03 | url、prompt | AI 驅動的結構化提取 |
可選參數:format ("markdown"/"html"/"text")、waitFor (CSS 選擇器)、timeout (毫秒)。
回傳:content (字串)、metadata (title、description、url)。
YouTube
| 方法 | 路徑 | 費用 | 必填參數 | 說明 |
|---|---|---|---|---|
| POST | /v1/youtube/search | $0.01 | query | 搜尋影片、頻道、播放清單 |
| POST | /v1/youtube/video | $0.02 | videoId | 完整影片中繼資料與格式 |
| POST | /v1/youtube/transcript | $0.01 | videoId | 含時間戳記的文字稿 |
| POST | /v1/youtube/channel | $0.01 | channelId 或 handle | 頻道概覽 |
| POST | /v1/youtube/comments | $0.01 | videoId | 留言與回覆 |
回傳:搜尋給出 results[],包含 videoId、title、views、published。文字稿給出 segments[],包含 text、start、duration。
AI 聊天
| 方法 | 路徑 | 費用 | 必填參數 | 說明 |
|---|---|---|---|---|
| POST | /v1/ai/chat | 可變 | model、messages[] | 與 69 個 AI 模型聊天 |
| GET | /v1/ai/models | 免費 | — | 列出可用模型與定價 |
通用可選欄位
SEO 端點:location (預設 "us")、language (預設 "en")、limit、offset。
爬蟲端點:format、waitFor、timeout。
錯誤碼
| 代碼 | HTTP | 意義 |
|---|---|---|
INVALID_API_KEY | 401 | 遺失或無效的金鑰 |
REVOKED_API_KEY | 401 | 金鑰已撤銷 |
NO_CREDITS | 402 | 餘額不足 |
RATE_LIMITED | 429 | 超過每分鐘 60 次請求 |
VALIDATION_ERROR | 400 | 請求主體格式錯誤 |
UPSTREAM_ERROR | 502 | 上游供應商錯誤 |
MODEL_NOT_FOUND | 400 | 無效的 AI 模型 |
AI_UPSTREAM_ERROR | 502 | AI 供應商錯誤 |
STREAM_ERROR | 502 | SSE 中斷 |
NOT_FOUND | 404 | 找不到端點 |
INTERNAL_ERROR | 500 | 伺服器錯誤 |
連結
- 文件:https://docs.yepapi.com
- 儀表板:https://yepapi.com/dashboard
- API 金鑰:https://yepapi.com/dashboard/api-keys
- 完整參考:https://docs.yepapi.com/llms-full.txt
- MCP 伺服器:
npx -y @yepapi/mcp