YepAPI — API リファレンス
ベース URL: https://api.yepapi.com
認証: x-api-key ヘッダー
レスポンス: { ok: true, data: {...} } または { ok: false, error: { code, message } }
レート制限: 60 req/min
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 | ドメインのバックリンクプロフィール |
戻り値: overview は 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 | 2つのドメイン間のキーワードギャップ |
戻り値: 競合は 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 | オーソリティを含む参照ドメイン |
戻り値: summary は 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 Trends の時系列関心度(最大5キーワード) |
戻り値: page-audit は issues[], meta, headings, links, images を返す。Lighthouse は performance, accessibility, seo, best_practices (0-100) を返す。Trends は 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。
Web スクレイピング
| メソッド | パス | コスト | 必須項目 | 説明 |
|---|---|---|---|---|
| POST | /v1/scrape | $0.01 | url | マークダウン/HTML/テキストにスクレイピング |
| POST | /v1/scrape/js | $0.02 | url | JavaScript レンダリングによるスクレイピング(ヘッドレスブラウザ) |
| POST | /v1/scrape/stealth | $0.03 | url | アンチボットバイパス(レジデンシャルプロキシ) |
| POST | /v1/scrape/ai-extract | $0.03 | url, prompt | AI による構造化抽出 |
オプション: format ("markdown"/"html"/"text"), waitFor (CSS セレクター), timeout (ms)。
戻り値: 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 | コメントと返信 |
戻り値: search は 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 req/min 超過 |
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 | サーバーエラー |
リンク
- Docs: https://docs.yepapi.com
- Dashboard: https://yepapi.com/dashboard
- API Keys: https://yepapi.com/dashboard/api-keys
- Full Reference: https://docs.yepapi.com/llms-full.txt
- MCP Server:
npx -y @yepapi/mcp