YepAPI — Referência da API
URL Base: https://api.yepapi.com
Autenticação: header x-api-key
Resposta: { ok: true, data: {...} } ou { ok: false, error: { code, message } }
Limite de taxa: 60 req/min
SEO — Palavras-chave
| Método | Caminho | Custo | Obrigatório | Descrição |
|---|---|---|---|---|
| POST | /v1/seo/keywords | $0.15 | keywords[], location | Métricas em lote: volume, CPC, dificuldade, intenção, tendências (até 100) |
| POST | /v1/seo/keywords/ideas | $0.03 | keyword, location | Sugestões de palavras-chave a partir de uma semente |
| POST | /v1/seo/keywords/related | $0.03 | keyword, location | Palavras-chave relacionadas à semente |
Retorna: volume, cpc, difficulty (0-100), intent (informational/commercial/navigational/transactional), trend (array de 12 meses)
SERP
| Método | Caminho | Custo | Obrigatório | Descrição |
|---|---|---|---|---|
| POST | /v1/serp/google | $0.01 | query, location | Resultados orgânicos do Google |
| POST | /v1/serp/google/news | $0.01 | query, location | Resultados do Google News |
| POST | /v1/serp/google/maps | $0.01 | query, location | Resultados do Google Maps / locais |
Retorna: results[] com title, url, snippet, position. Maps adiciona rating, reviews, address, phone.
Análise de Domínio
| Método | Caminho | Custo | Obrigatório | Descrição |
|---|---|---|---|---|
| POST | /v1/seo/domain/overview | $0.01 | domain | Tráfego, palavras-chave, backlinks, rank do domínio |
| POST | /v1/seo/domain/keywords | $0.04 | domain | Palavras-chave para as quais um domínio rankeia |
| POST | /v1/seo/domain/backlinks | $0.05 | domain | Perfil de backlinks do domínio |
Retorna: overview fornece traffic, keywords_count, backlinks, domain_rank. Keywords fornece keyword, position, volume, url.
Concorrentes
| Método | Caminho | Custo | Obrigatório | Descrição |
|---|---|---|---|---|
| POST | /v1/seo/competitors | $0.04 | domain | Domínios concorrentes por sobreposição de palavras-chave |
| POST | /v1/seo/keyword-gap | $0.04 | domain, competitor | Lacuna de palavras-chave entre dois domínios |
Retorna: competitors fornece domain, overlap, traffic. Gap fornece keyword, your_position, competitor_position, volume.
Backlinks
| Método | Caminho | Custo | Obrigatório | Descrição |
|---|---|---|---|---|
| POST | /v1/seo/backlinks | $0.05 | target | Backlinks individuais para domínio/URL |
| POST | /v1/seo/backlinks/summary | $0.03 | target | Métricas agregadas + proporção dofollow |
| POST | /v1/seo/referring-domains | $0.03 | target | Domínios de referência com autoridade |
Retorna: summary fornece total_backlinks, dofollow_ratio, domain_rank. Backlinks fornece source_url, anchor, type, domain_rank.
On-Page & Tendências
| Método | Caminho | Custo | Obrigatório | Descrição |
|---|---|---|---|---|
| POST | /v1/seo/page-audit | $0.03 | url | Auditoria técnica de SEO (meta, cabeçalhos, links, imagens) |
| POST | /v1/seo/lighthouse | $0.05 | url | Pontuações Lighthouse (performance, a11y, SEO, boas práticas) |
| POST | /v1/seo/trends | $0.02 | keywords[] | Interesse no Google Trends ao longo do tempo (até 5 palavras-chave) |
Retorna: page-audit fornece issues[], meta, headings, links, images. Lighthouse fornece performance, accessibility, seo, best_practices (0-100). Trends fornece interest_over_time[].
Visibilidade em IA
| Método | Caminho | Custo | Obrigatório | Descrição |
|---|---|---|---|---|
| POST | /v1/seo/ai/chatgpt | $0.05 | query | O que o ChatGPT diz sobre uma marca/consulta |
| POST | /v1/seo/ai/gemini | $0.05 | query | O que o Gemini diz sobre uma marca/consulta |
Retorna: response (texto), mentions[], sentiment.
Scraping Web
| Método | Caminho | Custo | Obrigatório | Descrição |
|---|---|---|---|---|
| POST | /v1/scrape | $0.01 | url | Scrape para markdown/HTML/texto |
| POST | /v1/scrape/js | $0.02 | url | Scrape renderizado por JS (navegador headless) |
| POST | /v1/scrape/stealth | $0.03 | url | Bypass anti-bot (proxies residenciais) |
| POST | /v1/scrape/ai-extract | $0.03 | url, prompt | Extração estruturada por IA |
Opcional: format ("markdown"/"html"/"text"), waitFor (seletor CSS), timeout (ms).
Retorna: content (string), metadata (title, description, url).
YouTube
| Método | Caminho | Custo | Obrigatório | Descrição |
|---|---|---|---|---|
| POST | /v1/youtube/search | $0.01 | query | Pesquisar vídeos, canais, playlists |
| POST | /v1/youtube/video | $0.02 | videoId | Metadados completos do vídeo + formatos |
| POST | /v1/youtube/transcript | $0.01 | videoId | Transcrição com timestamps |
| POST | /v1/youtube/channel | $0.01 | channelId ou handle | Visão geral do canal |
| POST | /v1/youtube/comments | $0.01 | videoId | Comentários e respostas |
Retorna: search fornece results[] com videoId, title, views, published. Transcript fornece segments[] com text, start, duration.
Chat com IA
| Método | Caminho | Custo | Obrigatório | Descrição |
|---|---|---|---|---|
| POST | /v1/ai/chat | variável | model, messages[] | Chat com 69 modelos de IA |
| GET | /v1/ai/models | grátis | — | Listar modelos disponíveis + preços |
Campos Opcionais Comuns
Endpoints de SEO: location (padrão "us"), language (padrão "en"), limit, offset.
Endpoints de scraping: format, waitFor, timeout.
Códigos de Erro
| Código | HTTP | Significado |
|---|---|---|
INVALID_API_KEY | 401 | Chave ausente ou inválida |
REVOKED_API_KEY | 401 | Chave revogada |
NO_CREDITS | 402 | Saldo insuficiente |
RATE_LIMITED | 429 | Limite de 60 req/min excedido |
VALIDATION_ERROR | 400 | Corpo da requisição inválido |
UPSTREAM_ERROR | 502 | Erro do provedor |
MODEL_NOT_FOUND | 400 | Modelo de IA inválido |
AI_UPSTREAM_ERROR | 502 | Erro do provedor de IA |
STREAM_ERROR | 502 | SSE interrompido |
NOT_FOUND | 404 | Endpoint não encontrado |
INTERNAL_ERROR | 500 | Erro do servidor |
Links
- Docs: https://docs.yepapi.com
- Dashboard: https://yepapi.com/dashboard
- Chaves de API: https://yepapi.com/dashboard/api-keys
- Referência Completa: https://docs.yepapi.com/llms-full.txt
- Servidor MCP:
npx -y @yepapi/mcp