API Docs - CubieLookup

Documentação oficial da API RESTful de consultas públicas.

1. Autenticação

A API utiliza o padrão Bearer Token. Para acessar as rotas /api/*, inclua sua API Key no cabeçalho (header) Authorization da requisição HTTP.

Authorization: Bearer SUA_API_KEY_AQUI

2. Rotas & Outputs

Abaixo estão todas as rotas mapeadas exatamente de acordo com os campos da engine. Clique no botão "Ver Exemplo" para visualizar o retorno real.

Método / Rota Descrição & Output
GET /api/ip/:ip

Consulta de geolocalização e provedor. Dica: Use "meu-ip" para pegar seu próprio IP.

Ver exemplo de saída (JSON) 
{
  "success": true,
  "ip": "8.8.8.8",
  "version": "IPv4",
  "network": "8.8.8.0/24",
  "country": "United States",
  "country_code": "US",
  "continent": "North America",
  "continent_code": "NA",
  "region": "California",
  "city": "Mountain View",
  "coordinates": { ... },
  "timezone": "America/Los_Angeles",
  "isp": "Google LLC",
  "asn": "AS15169",
  "as_name": "GOOGLE",
  "as_domain": "google.com",
  "usage_type": "Data Center/Web Hosting/Transit",
  "zip": "94043",
  "metro": 807,
  "eu": false,
  "asn_info": { ... },
  "country_info": { ... }
}
GET /api/asn/:asn

Informações de roteamento, país e organização do ASN.

Ver exemplo de saída (JSON) 
{
  "success": true,
  "asn": "AS15169",
  "handle": "AS15169",
  "description": "GOOGLE",
  "country_code": "US",
  "country": "United States",
  "continent": "North America",
  "continent_code": "NA",
  "origin": "...",
  "category": "ISP",
  "network_role": "Transit",
  "website": "https://www.google.com"
}
GET /api/bin/:bin

Consulta pelo prefixo (6 dígitos) emissor do cartão.

Ver exemplo de saída (JSON) 
{
  "success": true,
  "bin": "411111",
  "brand": "Visa",
  "type": "Credit",
  "category": "Classic",
  "issuer": "JPMorgan Chase Bank",
  "issuerPhone": "1-800-432-3117",
  "issuerUrl": "http://www.chase.com",
  "isoCode2": "US",
  "isoCode3": "USA",
  "countryName": "United States"
}
GET /api/card/:number

Validação completa do cartão (13-19 dígitos).

Ver exemplo de saída (JSON) 
{
  "success": true,
  "card": "4111111111111111",
  "valid": true,
  "brand": "Visa",
  "type": "Credit",
  "category": "Classic",
  "issuer": "JPMorgan Chase Bank",
  "issuerPhone": "1-800-432-3117",
  "issuerUrl": "http://www.chase.com",
  "isoCode2": "US",
  "isoCode3": "USA",
  "countryName": "United States"
}
GET /api/cep/:cep

Endereçamento baseado em CEP (8 dígitos).

Ver exemplo de saída (JSON) 
{
  "success": true,
  "cep": "01001000",
  "street": "Praça da Sé",
  "neighborhood": "Sé",
  "cityId": "3550308",
  "cityName": "São Paulo",
  "state": "SP",
  "stateFull": "São Paulo"
}
GET /api/ddd/:ddd

Consulta do código de área regional (2 dígitos).

Ver exemplo de saída (JSON) 
{
  "success": true,
  "ddd": "81",
  "state": "PE",
  "state_full": "Pernambuco",
  "area": "Região Metropolitana do Recife e Agreste"
}
GET /api/ddi/:ddi

Código de discagem internacional do país.

Ver exemplo de saída (JSON) 
{
  "success": true,
  "ddi": "55",
  "cc": "BR",
  "country": "Brazil",
  "continent": "South America",
  "capital": "Brasília"
}
GET /api/mac/:mac

Retorna dados de OUI (fabricante e registro) do endereço MAC.

Ver exemplo de saída (JSON) 
{
  "success": true,
  "mac": "00-1A-2B-3C-4D-5E",
  "registry": "MA-L",
  "org": "Fabricante Exemplo Inc.",
  "address": "123 Rua do Fabricante, Cidade, País"
}
GET /api/cpf/:cpf

Enriquecido via algorítmo: retorna validação e região base.

Ver exemplo de saída (JSON) 
{
  "success": true,
  "valid": true,
  "region": "Pernambuco, Rio Grande do Norte, Paraiba ou Alagoas"
}
GET /api/cnpj/:cnpj

Validação e extração de branch type (Matriz/Filial).

Ver exemplo de saída (JSON) 
{
  "success": true,
  "valid": true,
  "branch_type": "Matriz"
}
GET /api/key

Status de autorização e limite das cotas de consumo.

Ver exemplo de saída (JSON) 
{
  "success": true,
  "suspended": false,
  "suspension_reason": null,
  "expiresIn": null,
  "createdIn": "2024-04-10T12:00:00.000Z",
  "quota": {
    "bin": 1000,
    "card": 500,
    "cep": 1000,
    "ddd": 1000,
    "ddi": 500,
    "mac": 500,
    "asn": 200,
    "ip": 100,
    "cpf": 2000,
    "cnpj": 1000
  }
}
Retornar para CubieLookup