Endpoints

Inspect Labelhash GET

Inspects the name `[{labelhash}].{parent_name}`.

Parent may be a name with any number of labels. The default parent is “eth”.

This is a convenience endpoint to generate a NameGuardReport in cases when you only have:

The labelhash of the “childmost” label of a name.
The complete parent name of the “childmost” label.

NameGuard always inspects names, rather than labelhashes. So this endpoint will first attempt to resolve the “childmost” label associated with the provided labelhash through the ENS Subgraph, using the network specified in network_name.

If this label resolution fails the resulting NameGuardReport will be equivalent to requesting a NameGuardReport for the name [{labelhash}].{parent_name} which will contain (at least) one label with an unknown Normalization.

If this label resolution succeeds the resulting NameGuardReport will be equivalent to requesting a NameGuardReport for the name {label}.{parent_name}.

GET

inspect-labelhash

{network_name}

{labelhash}

{parent_name}

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

{
  "rating": 3,
  "risk_count": 2,
  "highest_risk": {
    "check": "confusables",
    "status": 3,
    "message": "<string>",
    "check_name": "<string>"
  },
  "name": "vitalìk.eth",
  "namehash": "0xd48fd5598e605861cbd8e45419b41b83739bff52eaef0e283181bbe0a43a5b32",
  "normalization": "normalized",
  "checks": [
    {
      "check": "confusables",
      "status": 3,
      "message": "<string>",
      "check_name": "<string>"
    }
  ],
  "labels": [
    {
      "rating": 3,
      "risk_count": 2,
      "highest_risk": {
        "check": "confusables",
        "status": 3,
        "message": "<string>",
        "check_name": "<string>"
      },
      "label": "vitalìk",
      "labelhash": "0x41459971a5b847d0eef67bc11e2845f1074a2aed1ac6a357378b18fba50816e4",
      "normalization": "normalized",
      "checks": [
        {
          "check": "confusables",
          "status": 3,
          "message": "<string>",
          "check_name": "<string>"
        }
      ],
      "graphemes": [
        {
          "rating": 3,
          "risk_count": 2,
          "highest_risk": {
            "check": "confusables",
            "status": 3,
            "message": "<string>",
            "check_name": "<string>"
          },
          "normalization": "normalized",
          "grapheme": "v",
          "grapheme_name": "Latin Small Letter V",
          "grapheme_type": "simple_letter",
          "grapheme_script": "Latin",
          "grapheme_description": "A-Z letter",
          "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>"
}

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

Path Parameters

network_name

enum<string>

required

Available options:

mainnet,

sepolia

labelhash

string

required

Labelhash should be a decimal or a hex (prefixed with 0x) string.

Example:

"0x3276e4878615389906712b876ce1455b8f5d1c5ea3ffcf7a705e0d32fafae9c5"

parent_name

string

required

Parent name of the labelhash (default empty).

Example:

"eth"

Response

200

application/json

Successful Response

Full name analysis result with information about individual checks and labels.

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

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.

name

string

required

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

Example:

"vitalìk.eth"

namehash

string

required

The 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

checks

object[]

required

A list of checks that were performed on the name.

The result of a conducted check.

labels

object[]

required

The analyzed labels of the name.

Label analysis result.

labels.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

labels.risk_count

integer

required

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

Example:

2

labels.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.

labels.label

string

required

The analyzed label. If the label is unknown, this field is [labelhash].

Example:

"vitalìk"

labels.labelhash

string

required

The labelhash of the label in hex format prefixed with 0x.

Example:

"0x41459971a5b847d0eef67bc11e2845f1074a2aed1ac6a357378b18fba50816e4"

labels.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

labels.checks

object[]

required

A list of checks that were performed on the label.

The result of a conducted check.

labels.graphemes

object[] | null

required

A list of graphemes that were analyzed in the label. If the label is unknown, this field is null.

Grapheme analysis result.

labels.graphemes.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

labels.graphemes.risk_count

integer

required

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

Example:

2

labels.graphemes.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.

labels.graphemes.normalization

enum<string>

required

The ENSIP-15 normalization status of a grapheme. This check does not consider the context of the grapheme and is not equivalent to ens_normalize(grapheme). A normalized grapheme can be combined with other normalized graphemes to form an unnormalized label. The position of a grapheme in a label can also affect the normalization status of the label.

normalized: The grapheme is normalized.
unnormalized: The grapheme is not normalized.

Available options:

normalized,

unnormalized

labels.graphemes.grapheme

string

required

The analyzed grapheme.

Example:

"v"

labels.graphemes.grapheme_name

string

required

The name of the grapheme.

Example:

"Latin Small Letter V"

labels.graphemes.grapheme_type

string

required

The type of the grapheme. If all characters in the grapheme have the same type, that type is returned. Otherwise, special is returned.

simple_letter - [a-z]
simple_number - [0-9]
other_letter - a letter (single-char grapheme) in any script that is not simple; LC class http://www.unicode.org/reports/tr44/#GC_Values_Table
other_number - a digit (single-char grapheme) in any script that is not simple; N class http://www.unicode.org/reports/tr44/#GC_Values_Table
hyphen - a hyphen
dollarsign - a dollar sign
underscore - an underscore
emoji - an emoji or emoji ZWJ sequence
invisible - zero width joiner or non-joiner
special - for any grapheme that doesn't match one of the other classifications or if characters have different types

Example:

"simple_letter"

labels.graphemes.grapheme_script

string

required

Script name of the grapheme computed from the script names of its characters.

Example:

"Latin"

labels.graphemes.grapheme_description

string

required

Description of the grapheme type.

Example:

"A-Z letter"

labels.graphemes.title

string

required

A human-readable title based on the rating.

labels.graphemes.subtitle

string

required

A human-readable subtitle based on the rating.

labels.canonical_label

string | null

required

The canonical form of the analyzed label.

null if the canonical form of any grapheme is not known
null if the result would be unnormalized, even if the canonical form of all graphemes is known
[labelhash] if the label is unknown

Example:

"vitalik"

labels.title

string

required

A human-readable title based on the rating.

labels.subtitle

string

required

A human-readable subtitle based on the rating.

labels.beautiful_label

string | null

required

Beautified version of label.

canonical_name

string | null

required

The canonical form of the analyzed name.

null if the canonical form of any label is not known
can contain labelhashes when some labels are unknown

Example:

"vitalik.eth"

title

string

required

A human-readable title based on the rating.

subtitle

string

required

A human-readable subtitle based on the rating.

beautiful_name

string | null

required

Beautified version of name.

Inspect Namehash GET Reverse lookup of an Ethereum address to a primary name

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

{
  "rating": 3,
  "risk_count": 2,
  "highest_risk": {
    "check": "confusables",
    "status": 3,
    "message": "<string>",
    "check_name": "<string>"
  },
  "name": "vitalìk.eth",
  "namehash": "0xd48fd5598e605861cbd8e45419b41b83739bff52eaef0e283181bbe0a43a5b32",
  "normalization": "normalized",
  "checks": [
    {
      "check": "confusables",
      "status": 3,
      "message": "<string>",
      "check_name": "<string>"
    }
  ],
  "labels": [
    {
      "rating": 3,
      "risk_count": 2,
      "highest_risk": {
        "check": "confusables",
        "status": 3,
        "message": "<string>",
        "check_name": "<string>"
      },
      "label": "vitalìk",
      "labelhash": "0x41459971a5b847d0eef67bc11e2845f1074a2aed1ac6a357378b18fba50816e4",
      "normalization": "normalized",
      "checks": [
        {
          "check": "confusables",
          "status": 3,
          "message": "<string>",
          "check_name": "<string>"
        }
      ],
      "graphemes": [
        {
          "rating": 3,
          "risk_count": 2,
          "highest_risk": {
            "check": "confusables",
            "status": 3,
            "message": "<string>",
            "check_name": "<string>"
          },
          "normalization": "normalized",
          "grapheme": "v",
          "grapheme_name": "Latin Small Letter V",
          "grapheme_type": "simple_letter",
          "grapheme_script": "Latin",
          "grapheme_description": "A-Z letter",
          "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>"
}

NameGuard

SDK

API

Inspect Labelhash GET

Inspects the name `[{labelhash}].{parent_name}`.

Path Parameters

Response