Quickstart

1. Get an API key

Use an issued Pirehub API key with the scope required by the endpoint. A key starts with ph_live_ and is shown here only as a placeholder:

ph_live_your_public_id.your_secret

Keep the complete key on your server. Do not commit it, log it, include it in a URL, or expose it in browser code.

2. Send a lookup request

Send a POST request to the WHOIS endpoint. The API accepts a registrable domain, subdomain, or HTTP(S) URL and normalizes it before lookup.

curl --request POST \
  --url https://www.ntanduy.com/api/v1/domain/whois \
  --header 'Content-Type: application/json' \
  --header 'x-pirehub-api-key: ph_live_your_public_id.your_secret' \
  --data '{"domain":"https://www.example.com/about"}'

const response = await fetch('https://www.ntanduy.com/api/v1/domain/whois', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-pirehub-api-key': process.env.PIREHUB_API_KEY,
  },
  body: JSON.stringify({ domain: 'https://www.example.com/about' }),
})

const payload = await response.json()

if (!payload.success) {
  throw new Error(`${payload.error.code}: ${payload.error.message}`)
}

console.log(payload.data)

import os
import requests

response = requests.post(
    "https://www.ntanduy.com/api/v1/domain/whois",
    headers={"x-pirehub-api-key": os.environ["PIREHUB_API_KEY"]},
    json={"domain": "https://www.example.com/about"},
    timeout=15,
)
response.raise_for_status()
print(response.json()["data"])

3. Read the response

{
  "success": true,
  "data": {
    "domain": "example.com",
    "query_domain": "www.example.com",
    "registered": true,
    "registrar": "Example Registrar, Inc.",
    "creation_date": "2020-01-10T00:00:00.000Z",
    "expiration_date": "2027-01-10T00:00:00.000Z",
    "status": ["client transfer prohibited"],
    "dnssec": "unsigned",
    "name_servers": ["ns1.example.net", "ns2.example.net"],
    "meta": {
      "cached": false
    }
  }
}

domain is the registrable root domain, while query_domain is the normalized hostname that you submitted. Optional registry fields may be null or absent.

An unregistered domain is still a successful lookup: the API returns HTTP 200 with data.registered set to false.

Next steps

Authentication

Learn about headers, scopes, and rate limits.

WHOIS guide

Learn about normalization, cache state, and fresh lookups.

DNS guide

Resolve normalized DNS records through supported resolvers.

Errors

Handle errors and retries safely.

Getting started

Network intelligence

Video tools

Payment utilities

Screenshot tools

Social embeds

Web data

1. Get an API key

2. Send a lookup request

3. Read the response

Next steps

Authentication

WHOIS guide

DNS guide

Errors

​1. Get an API key

​2. Send a lookup request

​3. Read the response

​Next steps

Authentication

WHOIS guide

DNS guide

Errors

1. Get an API key

2. Send a lookup request

3. Read the response

Next steps