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

{
  "primary_name_status": "normalized",
  "impersonation_estimate": "unlikely",
  "primary_name": "vitalik.eth",
  "display_name": "<string>",
  "nameguard_report": {
    "rating": 2,
    "risk_count": 123,
    "highest_risk": {
      "check": "normalized",
      "status": 0,
      "message": "<string>",
      "check_name": "<string>"
    },
    "name": "<string>",
    "namehash": "<string>",
    "normalization": "normalized",
    "inspected": true,
    "checks": [
      {
        "check": "normalized",
        "status": 0,
        "message": "<string>",
        "check_name": "<string>"
      }
    ],
    "labels": [
      {
        "rating": 2,
        "risk_count": 123,
        "highest_risk": {
          "check": "normalized",
          "status": 0,
          "message": "<string>",
          "check_name": "<string>"
        },
        "label": "<string>",
        "labelhash": "<string>",
        "normalization": "normalized",
        "checks": [
          {
            "check": "normalized",
            "status": 0,
            "message": "<string>",
            "check_name": "<string>"
          }
        ],
        "graphemes": [
          {
            "rating": 2,
            "risk_count": 123,
            "highest_risk": {
              "check": "normalized",
              "status": 0,
              "message": "<string>",
              "check_name": "<string>"
            },
            "normalization": "normalized",
            "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>"
  }
}
curl --request GET \
  --url https://api.nameguard.io/secure-primary-name/{network_name}/{address}

Path Parameters

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

Query Parameters

​
return_nameguard_report
boolean
default:false

Response

Successful Response

Reverse lookup result.

​
primary_name_status
enum<string>
required

The status of a secure primary ENS name lookup performed by NameGuard.

  • normalized: The ENS primary name was found and it is normalized.
  • no_primary_name: The ENS primary name was not found.
  • unnormalized: The ENS primary name was found, but it is not normalized.
  • uninspected: The name was exceptionally long and was not inspected for performance reasons.
Available options:
normalized,
no_primary_name,
unnormalized,
uninspected
​
impersonation_estimate
enum<string> | null
required

Impersonation estimate of the primary_name.

  • null if primary_name is null
Available options:
unlikely,
potential
​
primary_name
string | null
required

Primary ENS name for the Ethereum address.

  • null if primary_name_status is any value except normalized
Example:

"vitalik.eth"

​
display_name
string
required

ENS beautified version of primary_name.

  • if primary_name is null then provides a fallback display_name of "Unnamed [first four hex digits of Ethereum address]", e.g. "Unnamed c2a6"
Example:

"vitalik.eth"

​
nameguard_report
NameGuardReport · object
required

NameGuard report for the primary_name.

  • if address has a primary name and return_nameguard_report is True, then return a NameGuardReport for the primary name. Else, NameGuard will return null