Skip to main content
GET
/
inspect-name
/
{network_name}
/
{name}
curl --request GET \
  --url https://api.nameguard.io/inspect-name/{network_name}/{name}

{
  "risk_count": 123,
  "highest_risk": {
    "message": "<string>",
    "check_name": "<string>"
  },
  "name": "<string>",
  "namehash": "<string>",
  "inspected": true,
  "checks": [
    {
      "message": "<string>",
      "check_name": "<string>"
    }
  ],
  "labels": [
    {
      "risk_count": 123,
      "highest_risk": {
        "message": "<string>",
        "check_name": "<string>"
      },
      "label": "<string>",
      "labelhash": "<string>",
      "checks": [
        {
          "message": "<string>",
          "check_name": "<string>"
        }
      ],
      "graphemes": [
        {
          "risk_count": 123,
          "highest_risk": {
            "message": "<string>",
            "check_name": "<string>"
          },
          "grapheme": "<string>",
          "grapheme_name": "<string>",
          "grapheme_type": "<string>",
          "grapheme_script": "<string>",
          "grapheme_description": "<string>",
          "unicode_version": "15.0",
          "title": "<string>",
          "subtitle": "<string>"
        }
      ],
      "canonical_label": "vitalik",
      "title": "<string>",
      "subtitle": "<string>",
      "beautiful_label": "<string>"
    }
  ],
  "canonical_name": "vitalik.eth",
  "title": "<string>",
  "subtitle": "<string>",
  "beautiful_name": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.namekit.io/llms.txt

Use this file to discover all available pages before exploring further.

curl --request GET \
  --url https://api.nameguard.io/inspect-name/{network_name}/{name}

Path Parameters

​
network_name
enum<string>
required
Available options:
mainnet,
sepolia
​
name
string
required

Name should be url-encoded (except when using the Swagger UI). Name can be empty.

Example:

"vitalìk.eth"

Response

Successful Response

NameGuard report that contains the full results of all checks on all labels in a name.

​
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

​
risk_count
integer
required

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

Example:

2

​
highest_risk
GenericCheckResult · object
required

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

​
name
string
required

The name that NameGuard inspected. Some labels in this name may be represented as "[labelhash]" if and only if all of the following is true:

  1. The query sent to NameGuard when requesting the report represented the label as a "[labelhash]".
  2. The decoded label of "[labelhash]" was not found within the ENS Subgraph for the specified network.
Examples:

"vitalìk.eth"

"[af498306bb191650e8614d574b3687c104bc1cd7e07c522954326752c6882770].eth"

​
namehash
string
required

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

Example:

"0xd48fd5598e605861cbd8e45419b41b83739bff52eaef0e283181bbe0a43a5b32"

​
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
​
inspected
boolean
required

Whether or not the name was inspected. If false then the name was exceptionally long and was not inspected for performance reasons

Example:

true

​
checks
GenericCheckResult · object[]
required

The results of all checks performed by NameGuard on name.

​
labels
LabelGuardReport · object[] | null
required

The analyzed labels of the name.

  • null if and only if inspected field is false
​
canonical_name
string | null
required

The canonical form of the analyzed name.

  • null if the canonical form of any label is not known or inspected field is false
  • can contain labelhashes when some labels are unknown
Example:

"vitalik.eth"

​
title
string
required
read-only

A human-readable title based on the rating.

​
subtitle
string
required
read-only

A human-readable subtitle based on the rating.

​
beautiful_name
string | null
required

Beautified version of name.