A Node.js wrapper for the WhoisJSON API - Get WHOIS information in JSON format
bash
npm i @whoisjson/whoisjson
`
Usage
First, sign up for a free API key to get started with 1000 monthly requests.
`typescript
import { WhoisJson } from '@whoisjson/whoisjson';
// Initialize the client
const whois = new WhoisJson({
apiKey: 'YOUR_API_KEY'
});
// Get WHOIS information for a domain
async function getDomainInfo() {
try {
// WHOIS lookup
const whoisInfo = await whois.lookup('example.com');
console.log('WHOIS Info:', whoisInfo);
// DNS lookup
const dnsInfo = await whois.nslookup('example.com');
console.log('DNS Info:', dnsInfo);
// SSL certificate info
const sslInfo = await whois.ssl('example.com');
console.log('SSL Info:', sslInfo);
// Check domain availability
const availabilityInfo = await whois.checkDomainAvailability('example.com');
console.log('Domain Availability:', availabilityInfo);
} catch (error) {
console.error('Error:', error);
}
}
`
Response Examples
$3
`typescript
{
domain: "example.com",
available: true
}
`
$3
`typescript
{
server: "gamma",
name: "example.com",
idnName: "example.com",
status: [
"clientDeleteProhibited",
"clientTransferProhibited"
],
nameserver: [
"dns1.example.com",
"dns2.example.com"
],
ips: "93.184.216.34",
created: "1995-08-14T04:00:00Z",
changed: "2024-02-14T08:00:00Z",
expires: "2025-08-13T04:00:00Z",
registered: true,
dnssec: "signedDelegation",
whoisserver: "whois.example.com",
contacts: {
owner: [{
handle: "REDACTED FOR PRIVACY",
name: "REDACTED FOR PRIVACY",
email: "REDACTED FOR PRIVACY",
country: "US"
}]
},
registrar: {
id: "123",
name: "Example Registrar, Inc.",
email: "support@example.com",
url: "https://example.com",
phone: "+1.2345678900"
}
}
`
$3
`typescript
{
domain: "example.com",
records: {
a: ["93.184.216.34"],
aaaa: ["2606:2800:220:1:248:1893:25c8:1946"],
mx: [
{
priority: 10,
exchange: "mail.example.com"
}
],
ns: [
"ns1.example.com",
"ns2.example.com"
],
txt: ["v=spf1 include:_spf.example.com ~all"],
soa: {
mname: "ns1.example.com",
rname: "hostmaster.example.com",
serial: 2024021401,
refresh: 7200,
retry: 3600,
expire: 1209600,
minimum: 3600
}
}
}
`
$3
`typescript
{
domain: "example.com",
valid: true,
issuer: {
organization: "Let's Encrypt",
commonName: "R3",
countryName: "US"
},
subject: {
commonName: "example.com"
},
validFrom: "2024-01-01T00:00:00Z",
validTo: "2024-04-01T00:00:00Z",
serialNumber: "123456789",
version: 3,
signatureAlgorithm: "SHA256withRSA",
subjectAlternativeNames: [
"example.com",
"www.example.com"
]
}
`
API Reference
$3
Creates a new WhoisJson client instance.
#### Parameters
- config (Object):
- apiKey (string): Your WhoisJSON API key
- baseUrl (string, optional): Custom API base URL
$3
Get WHOIS information for a domain.
#### Parameters
- domain (string): The domain name to lookup
#### Returns
Promise that resolves with the WHOIS information.
$3
Get DNS records for a domain.
#### Parameters
- domain (string): The domain name to lookup
#### Returns
Promise that resolves with the DNS records information.
$3
Get SSL certificate information for a domain.
#### Parameters
- domain (string): The domain name to check
#### Returns
Promise that resolves with the SSL certificate information.
$3
Check if a domain is available for registration.
#### Parameters
- domain` (string): The domain name to check