Check a domain and its alternate-TLD siblings

Checks the given domain and, for a simple label.tld query, its common alternate TLDs (e.g. querying acme.com also returns acme.ai, acme.io, ...). Streams newline-delimited JSON (NDJSON): one 'header' event, then one 'row' event per domain, a 'primary_done' marker after the queried domain, and a final 'done' event. Buy-now/aftermarket prices are hidden unless the caller has a verified, signed-in session; new-registration pricing is always included.

post/api/domain/search

Request

  • Base URL: https://name.ai
  • URL: https://name.ai/api/domain/search
  • Auth: one of:
    • none
    • OAuth 2 (authorization code, authorization URL https://name.ai/oauth/authorize, token URL https://name.ai/api/oauth/token, scopes: pricing:read)

Headers

Idempotency-Keystring

Client-generated unique key (e.g. a UUID) for safe retries. Scoped to the caller. On /api/tools/whois a repeat within 24h replays the stored response without a second lookup or quota hit (Idempotent-Replayed: true); on /api/domain/search the operation is idempotent by nature and the key is echoed.

Request body

qstring required

Domain to check, e.g. "example.ai".

Example request

{
  "q": "example.ai"
}

Response

NDJSON stream of search events. Include a Bearer access token (scope pricing:read — see /AUTH.md) to unmask aftermarket/marketplace prices; omit it for the same response with those prices hidden. Deprecation/Sunset/Link headers appear only once the operation is deprecated (see x-deprecation-policy).

Changes

No recorded changes to this operation across all 1 revision of this API.