Documentação da API

Acesse nossa API RESTful para integrar ferramentas de diagnóstico de rede IPv6 em suas aplicações. Todos os endpoints retornam respostas JSON e suportam tanto IPv4 quanto IPv6.

URL Base

Bash

https://ping6.net/api/v1

Apenas HTTPS

Todas as solicitações de API devem usar HTTPS para comunicação segura.

CORS Habilitado

Solicitações cross-origin são suportadas de qualquer domínio.

Autenticação

A maioria dos endpoints está disponível sem autenticação. Para limites de taxa mais altos e acesso a recursos premium, use uma chave API.

Anônimo

Nenhuma autenticação necessária. Sujeito a limites de taxa mais baixos.

Chave API

Inclua sua chave API no cabeçalho X-API-Key para limites de taxa mais altos.

Bash

curl -X GET "https://ping6.net/api/v1/ping/google.com" \
  -H "X-API-Key: your-api-key-here"

Limites de Taxa

As solicitações de API são limitadas para garantir uso justo e disponibilidade do serviço.

Nível	Solicitações	Notas
Anônimo	100 / minute	Limitação baseada em IP. Compartilhada entre todos os usuários anônimos do mesmo IP.
Chave API	1,000 / minute	Por chave API. Entre em contato para limites mais altos.

Cabeçalhos de Limite de Taxa

X-RateLimit-LimitSolicitações máximas permitidas por janela

X-RateLimit-RemainingSolicitações restantes na janela atual

X-RateLimit-ResetTimestamp Unix quando o limite é reiniciado

Tratamento de Erros

A API usa códigos de resposta HTTP convencionais para indicar sucesso ou falha.

Código	Status	Descrição
400	Bad Request	Parâmetros de solicitação inválidos ou corpo de solicitação mal formado.
401	Unauthorized	Chave API inválida ou ausente para endpoints protegidos.
404	Not Found	O recurso ou endpoint solicitado não existe.
429	Too Many Requests	Limite de taxa excedido. Aguarde antes de fazer mais solicitações.
500	Internal Server Error	Erro do servidor. Por favor, tente novamente mais tarde ou entre em contato com o suporte.

JSON

{
  "error": {
    "code": "INVALID_ADDRESS",
    "message": "The provided address is not a valid IPv6 address",
    "details": {
      "address": "invalid-address"
    }
  }
}

Endpoints da API

GET/myip

Obter Meu Endereço IP

Retorna o endereço IP público do cliente que faz a solicitação. Detecta automaticamente se a conexão é IPv4 ou IPv6.

Example Response

JSON

{
  "ip": "2001:db8:85a3::8a2e:370:7334",
  "version": 6,
  "isIPv6": true
}

Code Examples

cURL

curl -X GET "https://ping6.net/api/v1/myip" \
  -H "Accept: application/json"

GET/validate

Validar Endereço IPv6

Valida um endereço IPv6 e retorna informações detalhadas sobre seu formato, tipo e representações canônicas.

Parameters

Name	Type	In	Description
`address`*	string	query	O endereço IPv6 a validar

Example Response

JSON

{
  "valid": true,
  "type": "Documentation",
  "compressed": "2001:db8::1",
  "expanded": "2001:0db8:0000:0000:0000:0000:0000:0001"
}

Code Examples

cURL

curl -X GET "https://ping6.net/api/v1/validate?address=2001:db8::1" \
  -H "Accept: application/json"

GET/dns/{hostname}

Consulta DNS

Consulte registros DNS para um nome de host usando resolvedores DNS configuráveis. Suporta todos os tipos de registros comuns com foco especial em registros AAAA para IPv6.

Parameters

Name	Type	In	Description
`hostname`*	string	path	O nome do host a consultar
`type`	enum: AAAA \| A \| MX \| TXT \| NS \| CNAME \| SOA \| PTR	query	Tipo de registro DNS a consultar(default: `AAAA`)
`resolver`	enum: cloudflare \| google \| quad9	query	Resolvedor DNS a usar para a consulta(default: `cloudflare`)

Example Response

JSON

{
  "hostname": "google.com",
  "records": [
    {
      "type": "AAAA",
      "value": "2607:f8b0:4004:800::200e",
      "ttl": 300
    }
  ],
  "resolver": "cloudflare",
  "queryTime": 23
}

Code Examples

cURL

curl -X GET "https://ping6.net/api/v1/dns/google.com?type=AAAA&resolver=cloudflare" \
  -H "Accept: application/json"

GET/ping/{target}Beta

Ping ao Alvo

Envie solicitações de eco ICMP para um endereço IPv6 ou nome de host e receba estatísticas de latência. Requer autenticação com chave API.

Parameters

Name	Type	In	Description
`target`*	string	path	Endereço IPv6 ou nome de host para fazer ping
`count`	string	query	Número de pacotes ping a enviar (1-10)(default: `4`)

Example Response

JSON

{
  "target": "2001:4860:4860::8888",
  "ip": "2001:4860:4860::8888",
  "results": [
    {
      "seq": 1,
      "ttl": 117,
      "rtt": 12.4
    },
    {
      "seq": 2,
      "ttl": 117,
      "rtt": 11.8
    },
    {
      "seq": 3,
      "ttl": 117,
      "rtt": 12.1
    },
    {
      "seq": 4,
      "ttl": 117,
      "rtt": 11.9
    }
  ],
  "stats": {
    "transmitted": 4,
    "received": 4,
    "loss": 0,
    "min": 11.8,
    "avg": 12.05,
    "max": 12.4
  }
}

Code Examples

cURL

curl -X GET "https://ping6.net/api/v1/ping/2001:4860:4860::8888?count=4" \
  -H "Accept: application/json" \
  -H "X-API-Key: your-api-key"

GET/traceroute/{target}Beta

Traceroute

Rastreie o caminho da rede até um destino, mostrando cada salto ao longo da rota com informações de latência. Requer autenticação com chave API.

Parameters

Name	Type	In	Description
`target`*	string	path	Endereço IPv6 ou nome de host para rastrear
`maxHops`	string	query	Número máximo de saltos a rastrear (1-64)(default: `30`)

Example Response

JSON

{
  "target": "google.com",
  "ip": "2607:f8b0:4004:800::200e",
  "hops": [
    {
      "hop": 1,
      "ip": "2001:db8::1",
      "hostname": "router.local",
      "rtt": 1.2
    },
    {
      "hop": 2,
      "ip": "2001:db8:1::1",
      "hostname": "isp-gateway.net",
      "rtt": 5.4
    },
    {
      "hop": 3,
      "ip": "2607:f8b0:4004:800::200e",
      "hostname": "google.com",
      "rtt": 12.8
    }
  ]
}

Code Examples

cURL

curl -X GET "https://ping6.net/api/v1/traceroute/google.com?maxHops=30" \
  -H "Accept: application/json" \
  -H "X-API-Key: your-api-key"