Skip to content
Have I Been Squatted logo Have I Been Squatted logo Have I Been Squatted Docs

Lookup

Lookup endpoints stream newline-delimited JSON objects as work completes. Each line is a message with an op field and operation-specific data, as described in the OpenAPI specification for each path below.

For client examples that read the stream, see handling streaming responses on the API overview.

Squat

Section titled “Squat”

Summary: Look up typosquatted permutations for a domain.

Behavior: Streams newline-delimited JSON objects as work completes. Each line is a message with an op field and operation-specific data. A 200 response uses application/x-ndjson with streaming line-delimited lookup result messages. Missing, invalid, or unauthorized keys yield 401 or 403; rate limits yield 429.

Scope: lookup:squat

Path parameter: domain (FQDN; in curl examples below, replace the {domain} segment in the URL with that value)

Terminal window
export API_TOKEN="YOUR_API_TOKEN"


curl -N "https://api.haveibeensquatted.com/v1/lookup/squat/{domain}" \
  -H "Authorization: Bearer $API_TOKEN"

NXDOMAIN

Section titled “NXDOMAIN”

Summary: Look up unregistered permutations for a domain.

Behavior: Same streaming model as squat: newline-delimited JSON per line, op plus data. 200 responses carry line-delimited lookup result messages. Errors follow the same 401, 403, and 429 patterns as other authenticated endpoints.

Scope: lookup:nxdomain

Path parameter: domain (FQDN; in curl examples below, replace the {domain} segment in the URL with that value)

Terminal window
export API_TOKEN="YOUR_API_TOKEN"


curl -N "https://api.haveibeensquatted.com/v1/lookup/nxdomain/{domain}" \
  -H "Authorization: Bearer $API_TOKEN"