Domain By Name

Load a domain by interpreted name, including v1/v2 discriminated fields and subregistry on ENSv2.

omnigraphenssdkenskitcurl

Run in ENSAdmin Open an interactive playground to execute this example on our sepolia-v2 ENSNode instance.

GraphQL

query DomainByName($name: InterpretedName!) {
  domain(by: {name: $name}) {
    __typename
    id
    label { interpreted hash }
    canonical { name { interpreted } node path { id } }
    owner { address }
    subregistry { contract { chainId address } }

    ... on ENSv1Domain {
      rootRegistryOwner { address }
    }
  }
}

Variables

{
  "name": "roppp.eth"
}

Output

{
  "data": {
    "domain": {
      "__typename": "ENSv2Domain",
      "id": "11155111-0x64c81210d0e580cfc7746f3fb910bf0e8f6378e1-88275407146030613359050872632052369891139576190404928761656352489271755538432",
      "label": {
        "interpreted": "roppp",
        "hash": "0xc32a1c1f67a98f2a48153a0e85ddb762207044cc7beb9517b6da41c1a4cc166b"
      },
      "subregistry": null,
      "owner": {
        "address": "0x801d2e48d378f161dba7ad7ad002ad557714c191"
      },
      "canonical": {
        "name": {
          "interpreted": "roppp.eth"
        },
        "node": "0x39095c3dfb872d6441c95547f88591e7fb97014eef30cabe3df12a9b2a64dbe8",
        "path": [
          {
            "id": "11155111-0x835f0b284e78cd3f358bcf6cba3b53809f09b79e-35894389512221139346028120028875095598761990588366713962827482865183915769856"
          },
          {
            "id": "11155111-0x64c81210d0e580cfc7746f3fb910bf0e8f6378e1-88275407146030613359050872632052369891139576190404928761656352489271755538432"
          }
        ]
      }
    }
  }
}

Output matches a GraphQL Response snapshot; live output depends on your ENSNode instance.

Run in StackBlitz Opens an editable StackBlitz project with this snippet.

TypeScript

import { createEnsNodeClient } from "enssdk/core";
import { asInterpretedName } from "enssdk";
import { graphql, omnigraph } from "enssdk/omnigraph";

const client = createEnsNodeClient({
  url: process.env.ENSNODE_URL || "https://api.v2-sepolia.ensnode.io"
}).extend(omnigraph);

const DomainByNameQuery = graphql(`
  query DomainByName($name: InterpretedName!) {
    domain(by: {name: $name}) {
      __typename
      id
      label { interpreted hash }
      canonical { name { interpreted } node path { id } }
      owner { address }
      subregistry { contract { chainId address } }

      ... on ENSv1Domain {
        rootRegistryOwner { address }
      }
    }
  }
`);

const result = await client.omnigraph.query({
  query: DomainByNameQuery,
  variables:   {
    name: asInterpretedName("roppp.eth"),
  },
});

if (result.errors) throw new Error(JSON.stringify(result.errors));
console.log(JSON.stringify(result.data, null, 2));

Output

{
  "data": {
    "domain": {
      "__typename": "ENSv2Domain",
      "id": "11155111-0x64c81210d0e580cfc7746f3fb910bf0e8f6378e1-88275407146030613359050872632052369891139576190404928761656352489271755538432",
      "label": {
        "interpreted": "roppp",
        "hash": "0xc32a1c1f67a98f2a48153a0e85ddb762207044cc7beb9517b6da41c1a4cc166b"
      },
      "subregistry": null,
      "owner": {
        "address": "0x801d2e48d378f161dba7ad7ad002ad557714c191"
      },
      "canonical": {
        "name": {
          "interpreted": "roppp.eth"
        },
        "node": "0x39095c3dfb872d6441c95547f88591e7fb97014eef30cabe3df12a9b2a64dbe8",
        "path": [
          {
            "id": "11155111-0x835f0b284e78cd3f358bcf6cba3b53809f09b79e-35894389512221139346028120028875095598761990588366713962827482865183915769856"
          },
          {
            "id": "11155111-0x64c81210d0e580cfc7746f3fb910bf0e8f6378e1-88275407146030613359050872632052369891139576190404928761656352489271755538432"
          }
        ]
      }
    }
  }
}

Output matches a GraphQL Response snapshot; live output depends on your ENSNode instance.

enssdk package manager setup

npm pnpm

# 1. Create project
mkdir -p my-ens-script/src && cd my-ens-script
npm init -y && touch src/index.ts
npm pkg set type=module scripts.start="tsx src/index.ts"
# 2. Install dependencies
npm install enssdk@1.15.1 && npm install -D tsx typescript @types/node
# 3. Paste the TypeScript snippet above into src/index.ts
# 4. Run
ENSNODE_URL=https://api.v2-sepolia.ensnode.io npm start

# 1. Create project
mkdir -p my-ens-script/src && cd my-ens-script
pnpm init && touch src/index.ts
pnpm pkg set type=module scripts.start="tsx src/index.ts"
# 2. Install dependencies
pnpm add enssdk@1.15.1 && pnpm add -D tsx typescript @types/node
# 3. Paste the TypeScript snippet above into src/index.ts
# 4. Run
ENSNODE_URL=https://api.v2-sepolia.ensnode.io pnpm start

See the enssdk docs for gql.tada plugin and tsconfig setup.

Run in StackBlitz Opens an editable StackBlitz project with this snippet.

TSX (React)

import { OmnigraphProvider, useOmnigraphQuery, graphql } from "enskit/react/omnigraph";
import { createEnsNodeClient } from "enssdk/core";
import { asInterpretedName } from "enssdk";
import { omnigraph } from "enssdk/omnigraph";

const client = createEnsNodeClient({
  url: import.meta.env.VITE_ENSNODE_URL || "https://api.v2-sepolia.ensnode.io"
}).extend(omnigraph);

const DomainByNameQuery = graphql(`
  query DomainByName($name: InterpretedName!) {
    domain(by: {name: $name}) {
      __typename
      id
      label { interpreted hash }
      canonical { name { interpreted } node path { id } }
      owner { address }
      subregistry { contract { chainId address } }

      ... on ENSv1Domain {
        rootRegistryOwner { address }
      }
    }
  }
`);

function DomainByNameResult() {
  const [result] = useOmnigraphQuery({
    query: DomainByNameQuery,
    variables:     {
      name: asInterpretedName("roppp.eth"),
    },
  });
  const { data, fetching, error } = result;
  if (!data && fetching) return <p>Loading…</p>;
  if (error) return <p>Error: {error.message}</p>;
  if (!data) return <p>No data returned.</p>;
  const formatted = JSON.stringify(
    data,
    (_, value) => (typeof value === "bigint" ? value.toString() : value),
    2,
  );
  return <code>{formatted}</code>;
}

export default function App() {
  return (
    <OmnigraphProvider client={client}>
      <DomainByNameResult />
    </OmnigraphProvider>
  );
}

Output

{
  "data": {
    "domain": {
      "__typename": "ENSv2Domain",
      "id": "11155111-0x64c81210d0e580cfc7746f3fb910bf0e8f6378e1-88275407146030613359050872632052369891139576190404928761656352489271755538432",
      "label": {
        "interpreted": "roppp",
        "hash": "0xc32a1c1f67a98f2a48153a0e85ddb762207044cc7beb9517b6da41c1a4cc166b"
      },
      "subregistry": null,
      "owner": {
        "address": "0x801d2e48d378f161dba7ad7ad002ad557714c191"
      },
      "canonical": {
        "name": {
          "interpreted": "roppp.eth"
        },
        "node": "0x39095c3dfb872d6441c95547f88591e7fb97014eef30cabe3df12a9b2a64dbe8",
        "path": [
          {
            "id": "11155111-0x835f0b284e78cd3f358bcf6cba3b53809f09b79e-35894389512221139346028120028875095598761990588366713962827482865183915769856"
          },
          {
            "id": "11155111-0x64c81210d0e580cfc7746f3fb910bf0e8f6378e1-88275407146030613359050872632052369891139576190404928761656352489271755538432"
          }
        ]
      }
    }
  }
}

Output matches a GraphQL Response snapshot; live output depends on your ENSNode instance.

enskit package manager setup

npm pnpm

# 1. Create project
npm create vite@latest my-ens-app -- --template react-ts --no-interactive --no-immediate
cd my-ens-app
# 2. Install dependencies
npm install
npm install enskit@1.15.1 enssdk@1.15.1
# 3. Copy the TSX snippet above into src/App.tsx
# 4. Run
VITE_ENSNODE_URL=https://api.v2-sepolia.ensnode.io npm run dev

# 1. Create project
pnpm create vite@latest my-ens-app --template react-ts --no-interactive --no-immediate
cd my-ens-app
# 2. Install dependencies
pnpm install
pnpm add enskit@1.15.1 enssdk@1.15.1
# 3. Copy the TSX snippet above into src/App.tsx
# 4. Run
VITE_ENSNODE_URL=https://api.v2-sepolia.ensnode.io pnpm run dev

See the enskit docs for gql.tada plugin and provider setup.

cURL

# POST JSON to your ENSNode Omnigraph endpoint (same path enssdk uses).
curl -sS -X POST "https://api.v2-sepolia.ensnode.io/api/omnigraph" \
  -H "Content-Type: application/json" \
  -d @- <<'EOF'
{
  "query": "query DomainByName($name: InterpretedName!) { domain(by: {name: $name}) { __typename id label { interpreted hash } canonical { name { interpreted } node path { id } } owner { address } subregistry { contract { chainId address } } ... on ENSv1Domain { rootRegistryOwner { address } } } }",
  "variables": {
    "name": "roppp.eth"
  }
}
EOF

Response

{
  "data": {
    "domain": {
      "__typename": "ENSv2Domain",
      "id": "11155111-0x64c81210d0e580cfc7746f3fb910bf0e8f6378e1-88275407146030613359050872632052369891139576190404928761656352489271755538432",
      "label": {
        "interpreted": "roppp",
        "hash": "0xc32a1c1f67a98f2a48153a0e85ddb762207044cc7beb9517b6da41c1a4cc166b"
      },
      "subregistry": null,
      "owner": {
        "address": "0x801d2e48d378f161dba7ad7ad002ad557714c191"
      },
      "canonical": {
        "name": {
          "interpreted": "roppp.eth"
        },
        "node": "0x39095c3dfb872d6441c95547f88591e7fb97014eef30cabe3df12a9b2a64dbe8",
        "path": [
          {
            "id": "11155111-0x835f0b284e78cd3f358bcf6cba3b53809f09b79e-35894389512221139346028120028875095598761990588366713962827482865183915769856"
          },
          {
            "id": "11155111-0x64c81210d0e580cfc7746f3fb910bf0e8f6378e1-88275407146030613359050872632052369891139576190404928761656352489271755538432"
          }
        ]
      }
    }
  }
}

Output matches a GraphQL Response snapshot; live output depends on your ENSNode instance.

Back to Examples