Inspect Multiple Names

Inspects up to 250 names at a time with NameGuard.

Provides a ConsolidatedNameGuardReport for each name provided in request.names, including:

1. The details of all checks performed on a name that consolidates all checks performed on labels and graphemes in this name.

Each ConsolidatedNameGuardReport returned represents an equivalent set of checks as a NameGuardReport. However:

1. A NameGuardReport contains a lot of additional data that isn’t always needed / desired when a ConsolidatedNameGuardReport will do.
2. When NameGuard only needs to return a ConsolidatedNameGuardReport, some special performance optimizations are possible (and completely safe) that help to accelerate responses in many cases.

This endpoint will attempt automated labelhash resolution through the ENS Subgraph, using the network specified in request.network_name.

cURL

curl --request POST \
  --url https://api.nameguard.io/bulk-inspect-names \
  --header 'Content-Type: application/json' \
  --data '{
  "names": [
    "vitalìk.eth",
    "nick.eth"
  ],
  "network_name": "mainnet"
}'

Body

application/json

names

string[]

required

Example:

["vitalìk.eth", "nick.eth"]

network_name

enum<string>

required

Available options:

mainnet,

sepolia

Response

200

application/json

Successful Response

Bulk name analysis results.

results

object[]

required

Name analysis result without information about individual checks and labels.

Show child attributes

results.rating

enum<integer>

required

The rating of a name/label/grapheme based on multiple conducted checks.

• pass: All checks passed.
• warn: At least one check failed with a WARN status but no check failed with an ALERT status.
• alert: At least one check failed with an ALERT status.

Available options:

2,

3,

4

Example:

3

results.risk_count

integer

required

The number of checks that have a status of alert or warn.

Example:

2

results.highest_risk

object | null

required

The check considered to be the highest risk. If no check has a status of alert or warn, this field is null.

Show child attributes

results.highest_risk.check

enum<string>

required

The type of a check.

Common:

• normalized: A name/label/grapheme is ENSIP-15 normalized.

Grapheme:

• confusables: A grapheme is visually confusable.
• invisible: A grapheme is invisible.
• typing_difficulty: A grapheme is difficult to type.
• font_support: A grapheme is not supported by common fonts.

Label:

• mixed_scripts: A label contains multiple scripts.
• namewrapper_compatible: TODO
• punycode_compatible_label: A label is compatible with Punycode.
• unknown_label: A label is unknown.

Name:

• impersonation_risk: A name might be used for impersonation.
• punycode_compatible_name: A name is compatible with Punycode.
• namewrapper_fuses: The NameWrapper configuration of a name is safe.
• decentralized_name: A name is decentralized.

Available options:

normalized,

confusables,

invisible,

typing_difficulty,

font_support,

mixed_scripts,

namewrapper_compatible,

punycode_compatible_label,

unknown_label,

impersonation_risk,

punycode_compatible_name,

namewrapper_fuses,

decentralized_name

Example:

"confusables"

results.highest_risk.status

enum<integer>

required

The status of a conducted check.

• skip: This check was skipped because it was not applicable.
• info: This check is informational only.
• pass: This check passed.
• warn: This check failed, this is a minor issue.
• alert: This check failed, this is a major issue.

Available options:

0,

1,

2,

3,

4

Example:

3

results.highest_risk.message

string

required

A message describing the result of the check.

results.highest_risk.check_name

string

required

The human-readable name of the check.

results.name

string

required

The analyzed name. Can contain labelhashes when some labels are unknown.

Example:

"vitalìk.eth"

results.namehash

string

required

The namehash of the name in hex format prefixed with 0x.

Example:

"0xd48fd5598e605861cbd8e45419b41b83739bff52eaef0e283181bbe0a43a5b32"

results.normalization

enum<string>

required

The ENSIP-15 normalization status of a name or label.

• normalized: The name or label is normalized.
• unnormalized: The name or label is not normalized.
• unknown: The name or label is unknown because it cannot be looked up from its hash.

Available options:

normalized,

unnormalized,

unknown

results.title

string

required

A human-readable title based on the rating.

results.subtitle

string

required

A human-readable subtitle based on the rating.

results.beautiful_name

string | null

required

Beautified version of name.