SimilarwebAPI | Documentação de APIs

A SimilarwebAPI oferece 27 endpoints de dados somente leitura sob /v1/similarweb. Use a mesma conta, chave de API, saldo e histórico de uso das outras APIs RequestBeam. A disponibilidade depende de um gateway ativado e das permissões da chave; a documentação não confirma disponibilidade em produção.

Autenticação

Envie sua chave de API RequestBeam, não credenciais de terceiros:

http

Authorization: Bearer YOUR_API_KEY

Exemplo de requisição

Todas as operações públicas usam GET com parâmetros de consulta e sem corpo de requisição. Mantenha exatamente a capitalização de caminhos e parâmetros documentada.

Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.

Nos endpoints que aceitam datas, um intervalo explícito from/to válido e completo tem prioridade. Se o endpoint aceita latest, o valor informado ainda deve passar pelas validações existentes de formato e do endpoint, mas é ignorado na seleção do intervalo e não é enviado ao Similarweb; nenhum latest padrão é adicionado. Sem um intervalo explícito, as regras existentes de latest, valores padrão e janelas permanecem inalteradas. As restrições de History continuam válidas; endpoints que não aceitam latest continuam rejeitando esse campo.

bash

curl --get "https://api.apihop.ai/v1/similarweb/websites/incoming-referrals" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "key=example.com" \
  --data-urlencode "country=999" \
  --data-urlencode "page=1"

Referências de entrada usam um único nome de host no parâmetro minúsculo key, não keys. Esse key é um parâmetro de consulta de negócio para o site de destino, não uma credencial de API; é permitido somente em rotas GET Similarweb explicitamente autorizadas. A autenticação continua usando Authorization, e outros campos de credenciais na consulta permanecem proibidos. As linhas são retornadas em Records, não em Data. Veja a referência completa dos endpoints para os campos exatos de cada operação.

Cobertura

Pesquisa: sugestões de palavras-chave, páginas no ranking, palavras-chave de sites, pesquisa orgânica e paga, palavras-chave de marca.
Tráfego de sites: engajamento, visitas, geografia, composição de dispositivos, canais e tráfego social.
Relações: backlinks, referências de entrada, tráfego de saída e sites semelhantes.
Histórico: séries separadas de visitas mensais, taxa de rejeição, duração da visita e páginas por visita.

Respostas

Respostas bem-sucedidas preservam o corpo JSON nativo, sem um novo envelope success/data. Nomes de campos, campos desconhecidos, arrays vazios e precisão numérica permanecem iguais. Endpoints diferentes podem retornar Data, Records ou outra estrutura nativa; não presuma um campo universal de linhas.

Um resultado vazio bem-sucedido não significa que o domínio não tenha tráfego. Requisições com falha não devem ser tratadas como dados vazios. Preserve X-Request-Id e o horário da requisição para diagnóstico.

Cobrança e paginação

O preço padrão é $0.0005 por requisição bem-sucedida, ou $0.50 por 1,000 requisições, nos 27 endpoints. A cobrança é por requisição, não por linha; um resultado vazio bem-sucedido ainda conta como uma requisição. Cada página seguinte é uma requisição separada. Preços específicos da conta têm precedência quando configurados. Requisições com parâmetros inválidos, autorização ausente ou saldo insuficiente não prosseguem como chamadas bem-sucedidas faturáveis. Requisições com falha no provedor não são cobradas.

Sua conta deve ter pelo menos $0.10 disponíveis antes de uma chamada, conforme a política de saldo mínimo da plataforma. A tarifa padrão permanece $0.0005 por requisição bem-sucedida.

Use apenas os campos de paginação documentados para o endpoint selecionado. A paginação geralmente começa em 1; backlinks usam Page e PageSize, enquanto outras tabelas podem usar page, pageSize ou rowsPerPage. Não envie campos de tamanho de página não suportados.

Erros

Erros da plataforma usam a estrutura abaixo; code é um código de negócio da plataforma, não um status HTTP:

json

{"success":false,"error":{"code":10000,"message":"Invalid request parameters"},"requestId":"..."}

Os status HTTP comuns incluem 400 consulta inválida, 401 chave de API inválida, 402 saldo insuficiente, 403 acesso ao gateway negado, 429 limite de taxa e 5xx falha temporária do provedor ou serviço. Não repita requisições malformadas sem alterá-las.