Documentação da API

Autenticação

Todas as requisições à API exigem um token Bearer no cabeçalho Authorization. Obtenha sua chave de API no Painel da API após assinar um plano de API.

Authorization: Bearer YOUR_API_KEY

Início rápido

curl "https://webtrackly.com/api/v1/packages/?type=technology&q=wordpress" \
     -H "Authorization: Bearer YOUR_API_KEY"

URL base: https://webtrackly.com/api/v1/

Formato: JSON

Método: GET

Paginação: ?page=1 (20 por página)

Formato de resposta

Endpoints de listagem retornam resultados paginados. As informações de limite de requisições são incluídas nos cabeçalhos da resposta.

{
  "results": [...],
  "count": 1511,
  "page": 1,
  "pages": 76,
  "has_next": true
}

Cabeçalhos de resposta

Cabeçalho	Descrição
X-RateLimit-Limit	Limite mensal de chamadas
X-RateLimit-Remaining	Chamadas restantes neste mês
X-RateLimit-Used	Chamadas usadas neste mês

Pacotes

GET /api/v1/packages/

Liste todos os pacotes de domínios (arquivos de zona e dados de tecnologia). Suporta filtros e busca.

Parâmetro	Tipo	Descrição
type	string	Filtrar por tipo: zone, technology, detailed
zone	string	Filtrar por TLD da zona (ex.: com, net)
technology	string	Filtrar por nome da tecnologia
q	string	Buscar por nome
page	int	Número da página (padrão: 1)

GET /api/v1/packages/{slug}/

Obtenha informações detalhadas sobre um pacote específico, incluindo domínios de exemplo.

{
  "slug": "com-zone",
  "name": ".com Zone File",
  "package_type": "zone",
  "zone": "com",
  "domain_count": 150000000,
  "price": "49.00",
  "updated_at": "2026-03-08",
  "sample_domains": ["example.com", "test.com", ...]
}

Conjuntos de dados

GET /api/v1/datasets/

Liste todos os conjuntos de dados premium. Suporta busca.

Parâmetro	Tipo	Descrição
q	string	Buscar por nome ou descrição
page	int	Número da página (padrão: 1)

GET /api/v1/datasets/{slug}/

Obtenha detalhes do conjunto de dados, incluindo dados de exemplo.

{
  "slug": "ecommerce-domains-2026",
  "name": "E-commerce Domains 2026",
  "description": "...",
  "record_count": 500000,
  "price": "99.00",
  "sample": [...]
}

Conta

GET /api/v1/account/

Obtenha informações da sua assinatura de API, estatísticas de uso e a lista de chaves de API.

{
  "subscription": {
    "plan": "API Professional",
    "status": "active",
    "calls_limit": 100000,
    "calls_used": 1523,
    "calls_remaining": 98477,
    "expires_at": "2026-04-08"
  },
  "keys": [
    {"key": "wt_live_abc...xyz", "name": "Production", "is_active": true}
  ]
}

Limites de requisições

As chamadas de API são contabilizadas mensalmente. Os limites dependem do seu plano de assinatura de API.

Plano	Chamadas/mês	Preço
API Starter	10,000	$29/mês
API Professional	100,000	$99/mês
API Enterprise	1,000,000	$299/mês

Os resultados são paginados com no máximo 20 itens por página para evitar a extração de dados em massa. Ver planos

Erros

Código	Descrição
401	Chave de API ausente ou inválida
403	Chave de API desativada ou assinatura expirada
404	Recurso não encontrado
429	Limite mensal de chamadas de API excedido

{"error": "Rate limit exceeded", "limit": 10000, "used": 10000}

Exemplos de código

Python

import requests

API_KEY = "YOUR_API_KEY"
BASE = "https://webtrackly.com/api/v1"
headers = {"Authorization": f"Bearer {API_KEY}"}

# Search technology packages
r = requests.get(f"{BASE}/packages/", headers=headers,
                 params={"type": "technology", "q": "wordpress"})
for pkg in r.json()["results"]:
    print(f"{pkg['name']}: {pkg['domain_count']} domains")

# Check usage
r = requests.get(f"{BASE}/account/", headers=headers)
info = r.json()["subscription"]
print(f"Used {info['calls_used']}/{info['calls_limit']}")

JavaScript

const API_KEY = 'YOUR_API_KEY';
const BASE = 'https://webtrackly.com/api/v1';
const headers = { 'Authorization': `Bearer ${API_KEY}` };

// Search packages
const res = await fetch(`${BASE}/packages/?type=zone&q=com`, { headers });
const data = await res.json();
data.results.forEach(pkg =>
    console.log(`${pkg.name}: ${pkg.domain_count} domains`)
);

// Check rate limits from headers
console.log('Remaining:', res.headers.get('X-RateLimit-Remaining'));

PHP

$apiKey = 'YOUR_API_KEY';
$base = 'https://webtrackly.com/api/v1';

$ch = curl_init("$base/packages/?type=technology&q=wordpress");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer $apiKey"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);

foreach ($result['results'] as $pkg) {
    echo "- {$pkg['name']}: {$pkg['domain_count']} domains\n";
}

cURL

# List zone packages
curl "https://webtrackly.com/api/v1/packages/?type=zone" \
     -H "Authorization: Bearer YOUR_API_KEY"

# Get package details
curl "https://webtrackly.com/api/v1/packages/com-zone/" \
     -H "Authorization: Bearer YOUR_API_KEY"

# Check account usage
curl "https://webtrackly.com/api/v1/account/" \
     -H "Authorization: Bearer YOUR_API_KEY"

API do WebTrackly v1