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

Analyze

Analyze

Section titled “Analyze”

Summary: Analyze a domain for infrastructure and threat signals.

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 analysis messages. Unauthenticated or unauthorized requests return 401 or 403; rate limits return 429.

Scope: analyze

Path parameter: domain (FQDN to analyze; in the curl example below, replace the {domain} segment in the URL with that value; see the OpenAPI specification and the DomainPath schema there).

Terminal window
export API_TOKEN="YOUR_API_TOKEN"


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

For stream consumption examples, see handling streaming responses.