Documentos avançados da API | Documentação | Reverse WHOIS API | WhoisXML API

Fazer solicitações

API endpoint

POST https://reverse-whois.whoisxmlapi.com/api/v2
Leva até um minuto para ativar sua conta após o registro.

Observe que os resultados da pesquisa são limitados a 10.000 registros. Se você quiser obter resultados mais relevantes, tente otimizar sua consulta de pesquisa ou usar a pesquisa avançada.

Coleção Postman

O Postman é um aplicativo de desktop e da Web que permite fazer solicitações a uma API a partir de uma interface gráfica de usuário. Recomendamos usar o Postman com os endpoints do WhoisXML APIs ao explorar a funcionalidade das APIs, bem como quando estiver solucionando problemas com seu aplicativo.

A coleção WhoisXML API Postman está disponível nos seguintes links:

A coleção inclui um ambiente pré-configurado. Você precisará configurar a variável api_key para enviar cada solicitação. Obtenha sua chave API pessoal na página My products. Se você tiver dúvidas relacionadas à API, entre em contato conosco.

Exemplo de corpo de solicitação POST

{
    "apiKey": "API_KEY",
    "searchType": "current",
    "mode": "purchase",
    "advancedSearchTerms": [{
        "field": "RegistrantContact.Organization",
        "term": "Airbnb, Inc.",
        "exactMatch": true
    },
    {
        "field": "RegistrantContact.Country",
        "term": "UNITED STATES",
        "exclude": true
    }]
}

A pesquisa básica requer menos configuração e produz resultados mais amplos. A pesquisa avançada permite pesquisar em campos específicos do WHOIS.

Você pode fornecer até quatro termos de pesquisa em uma solicitação. Com vários termos de pesquisa, o resultado inclui domínios que correspondem a todos eles.

O termo de pesquisa inclui um campo exato do registro WHOIS do domínio, um dos seguintes:

Common fields

DomainName,
NameServers,
WhoisServer,
Status,
RegistrarName,
Email

O E-mail permite pesquisar em RegistrantContact.Email, AdminContact.Email, BillingContact.Email, TechContact.Email em uma única consulta.

Registrant contact fields

RegistrantContact.City,
RegistrantContact.Country,
RegistrantContact.Email,
RegistrantContact.Fax,
RegistrantContact.FaxExtension,
RegistrantContact.Name,
RegistrantContact.Organization,
RegistrantContact.PostalCode,
RegistrantContact.State,
RegistrantContact.StreetAddress,
RegistrantContact.Telephone,
RegistrantContact.TelephoneExtension

Admin contact fields

AdminContact.City,
AdminContact.Country,
AdminContact.Email,
AdminContact.Fax,
AdminContact.FaxExtension,
AdminContact.Name,
AdminContact.Organization,
AdminContact.PostalCode,
AdminContact.State,
AdminContact.StreetAddress,
AdminContact.Telephone,
AdminContact.TelephoneExtension

Billing contact fields

BillingContact.City,
BillingContact.Country,
BillingContact.Email,
BillingContact.Fax,
BillingContact.FaxExtension,
BillingContact.Name,
BillingContact.Organization,
BillingContact.PostalCode,
BillingContact.State,
BillingContact.StreetAddress,
BillingContact.Telephone,
BillingContact.TelephoneExtension

Technical contact fields

TechContact.City,
TechContact.Country,
TechContact.Email,
TechContact.Fax,
TechContact.FaxExtension,
TechContact.Name,
TechContact.Organization,
TechContact.PostalCode,
TechContact.State,
TechContact.StreetAddress,
TechContact.Telephone,
TechContact.TelephoneExtension

Headers

X-Authentication-Token

Você pode usar esse header (cabeçalho) ou o parâmetro apiKey para chamadas de API.

Obtenha sua chave API pessoal na página My products.

Parâmetros de entrada para pesquisa avançada

Para pesquisa avançada, em vez do bloco basicSearchTerms, use o bloco advancedSearchTerms com o seguinte formato:

advancedSearchTerms.field

Required. Qual campo WHOIS deve ser pesquisado.

advancedSearchTerms.term

Required. Cadeia de pesquisa. Não diferencia maiúsculas de minúsculas.

advancedSearchTerms.exclude

Optional. Boolean. Exclua o termo se ele não deve fazer parte da pesquisa.

Acceptable values: false | true

Default: false

advancedSearchTerms.exactMatch

Optional. Boolean. Se o campo deve corresponder exatamente ao termo de pesquisa. Se for false, o campo poderá conter um termo de pesquisa como uma substring.

Acceptable values: false | true

Default: false

Observe que, atualmente, o parâmetro é compatível apenas com os seguintes campos: NameServers, Status, RegistrantContact.Name, RegistrantContact.OrganizationRegistrantContact.StreetAddress, AdminContact.Name, AdminContact.Organization, AdminContact.StreetAddress, BillingContact.Name,  BillingContact.Organization, BillingContact.StreetAddress, TechContact.Name, TechContact.Organization, TechContact.Street

Para todos os outros campos, ele é ignorado e interpretado como true.

Em vez disso, você pode usar a pesquisa curinga final para encontrar correspondências parciais.

Pesquisa curinga

Observe que o número de solicitações curinga é limitado a 5 por minuto.

Você pode usar curingas para pesquisar em campos específicos. Observe que os curingas iniciais e finais não podem ser usados juntos para todos os campos, exceto "domainName". Nesse caso, o curinga final será removido. Para o campo "domainName", curingas intermediários não poderão ser usados ​​se os caracteres iniciais e finais estiverem presentes. Nesse caso, o curinga intermediário será removido. Observe que essas consultas podem ser lentas.

{
    "apiKey": "API_KEY",
    "searchType": "current",
    "mode": "purchase",
    "advancedSearchTerms": [{
        "field": "RegistrantContact.Organization",
        "term": "Air*bnb*"
    }]
}

Exemplo de uso de curingas

{
    "apiKey": "API_KEY",
    "searchType": "current",
    "mode": "purchase",
    "advancedSearchTerms": [{
        "field": "DomainName",
        "term": "facebook."
    }]
}

- retorna 0 domínios

{
    "apiKey": "API_KEY",
    "searchType": "current",
    "mode": "purchase",
    "advancedSearchTerms": [{
        "field": "DomainName",
        "term": "facebook.*"
    }]
}

- retorna mais de 400 domínios