Pular para o conteúdo principal
Todos os endpoints usam autenticação por chave de API no header X-API-Key. Veja as páginas de cada endpoint para detalhes completos de requisição e resposta.

URL base

https://api.bunny.build/api/v1

Autenticação

HeaderObrigatórioDescrição
X-API-KeySimSua chave de API (começa com bun_)
Content-TypeCondicionalapplication/json (obrigatório em requisições POST)
AcceptRecomendadoapplication/json

Exemplo de headers

X-API-Key: bun_aBcDeFgHiJkLmNoPqRsTuVwXyZ123456
Content-Type: application/json
Accept: application/json

Limite de taxa

As respostas incluem headers de limite de taxa:
HeaderDescrição
X-RateLimit-LimitRequisições por minuto
X-RateLimit-RemainingRequisições restantes
X-RateLimit-ResetSegundos até o reset
Em 429, o servidor pode enviar Retry-After (segundos).

Formato de erro

Erros retornam um corpo JSON:
{
  "detail": "Mensagem de erro"
}
Erros de validação (422) podem retornar um array de objetos em detail com loc, msg, type.

Códigos de status HTTP

CódigoSignificado
200Sucesso
400Bad Request: Entrada inválida
401Unauthorized: Chave de API ausente ou inválida
402Payment Required: Cota excedida
403Forbidden: Conta desativada
404Not Found
422Unprocessable Entity: Erro de validação
429Too Many Requests: Limite de taxa excedido
500Internal Server Error

Endpoints

POST /barcode

Gerar uma imagem de código de barras.

GET /cep-lookup/:cep

Consultar um CEP brasileiro.

GET /cnpj-data/:cnpj

Buscar dados públicos de uma empresa pelo CNPJ.

GET /currency-exchange

Obter taxa de câmbio em tempo real.

GET /domain-availability/:domain

Verificar disponibilidade de domínio.

GET /ip-classify

Classificar um endereço IP por tipo de rede.

GET /ip-lookup

Consultar dados de geo e rede de um IP.

POST /random-password/generate

Gerar uma senha aleatória segura.

GET /temporary-email

Verificar se um e-mail usa domínio descartável.

POST /translate

Traduzir texto entre idiomas.

POST /url-checker

Verificar segurança e disponibilidade de uma URL.

GET /validate-cpf-cnpj

Validar número de CPF ou CNPJ.

POST /wpp-url/generate

Gerar link de clique para o WhatsApp.