Domain Subdomains

Paginate direct child names under a parent domain.

omnigraphenssdkenskitcurl

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

GraphQL

query DomainSubdomains($name: InterpretedName!) {
  domain(by: {name: $name}) {
    canonical { name { interpreted beautified } }
    subdomains(first: 10, order: {
       by: NAME,
       dir: ASC
    }) {
      edges {
        node {
          canonical { name { interpreted beautified } }
        }
      }
    }
  }
}

Variables

{
  "name": "base.eth"
}

Output

{
  "data": {
    "domain": {
      "canonical": {
        "name": {
          "interpreted": "base.eth",
          "beautified": "base.eth"
        }
      },
      "subdomains": {
        "edges": [
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "¢¢¢¢¢¢¢¢¢¢.base.eth",
                  "beautified": "¢¢¢¢¢¢¢¢¢¢.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "¢¢¢¢¢.base.eth",
                  "beautified": "¢¢¢¢¢.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "¢hampagne¢arey.base.eth",
                  "beautified": "¢hampagne¢arey.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          }
        ]
      }
    }
  }
}

Output matches a point in time snapshot GraphQL response from our alpha ENSNode instance. Live output depends on the configuration of your ENSNode instance and ENS state updates.

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.alpha.ensnode.io"
}).extend(omnigraph);

const DomainSubdomainsQuery = graphql(`
  query DomainSubdomains($name: InterpretedName!) {
    domain(by: {name: $name}) {
      canonical { name { interpreted beautified } }
      subdomains(first: 10, order: {
         by: NAME,
         dir: ASC
      }) {
        edges {
          node {
            canonical { name { interpreted beautified } }
          }
        }
      }
    }
  }
`);

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

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

Output

{
  "data": {
    "domain": {
      "canonical": {
        "name": {
          "interpreted": "base.eth",
          "beautified": "base.eth"
        }
      },
      "subdomains": {
        "edges": [
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "¢¢¢¢¢¢¢¢¢¢.base.eth",
                  "beautified": "¢¢¢¢¢¢¢¢¢¢.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "¢¢¢¢¢.base.eth",
                  "beautified": "¢¢¢¢¢.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "¢hampagne¢arey.base.eth",
                  "beautified": "¢hampagne¢arey.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          }
        ]
      }
    }
  }
}

Output matches a point in time snapshot GraphQL response from our alpha ENSNode instance. Live output depends on the configuration of your ENSNode instance and ENS state updates.

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.alpha.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.alpha.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.alpha.ensnode.io"
}).extend(omnigraph);

const DomainSubdomainsQuery = graphql(`
  query DomainSubdomains($name: InterpretedName!) {
    domain(by: {name: $name}) {
      canonical { name { interpreted beautified } }
      subdomains(first: 10, order: {
         by: NAME,
         dir: ASC
      }) {
        edges {
          node {
            canonical { name { interpreted beautified } }
          }
        }
      }
    }
  }
`);

function DomainSubdomainsResult() {
  const [result] = useOmnigraphQuery({
    query: DomainSubdomainsQuery,
    variables:     {
      name: asInterpretedName("base.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}>
      <DomainSubdomainsResult />
    </OmnigraphProvider>
  );
}

Output

{
  "data": {
    "domain": {
      "canonical": {
        "name": {
          "interpreted": "base.eth",
          "beautified": "base.eth"
        }
      },
      "subdomains": {
        "edges": [
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "¢¢¢¢¢¢¢¢¢¢.base.eth",
                  "beautified": "¢¢¢¢¢¢¢¢¢¢.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "¢¢¢¢¢.base.eth",
                  "beautified": "¢¢¢¢¢.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "¢hampagne¢arey.base.eth",
                  "beautified": "¢hampagne¢arey.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          }
        ]
      }
    }
  }
}

Output matches a point in time snapshot GraphQL response from our alpha ENSNode instance. Live output depends on the configuration of your ENSNode instance and ENS state updates.

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.alpha.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.alpha.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.alpha.ensnode.io/api/omnigraph" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "query DomainSubdomains($name: InterpretedName!) { domain(by: {name: $name}) { canonical { name { interpreted beautified } } subdomains(first: 10, order: { by: NAME, dir: ASC }) { edges { node { canonical { name { interpreted beautified } } } } } } }",
  "variables": {"name":"base.eth"}
}'

Response

{
  "data": {
    "domain": {
      "canonical": {
        "name": {
          "interpreted": "base.eth",
          "beautified": "base.eth"
        }
      },
      "subdomains": {
        "edges": [
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "¢¢¢¢¢¢¢¢¢¢.base.eth",
                  "beautified": "¢¢¢¢¢¢¢¢¢¢.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "¢¢¢¢¢.base.eth",
                  "beautified": "¢¢¢¢¢.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "¢hampagne¢arey.base.eth",
                  "beautified": "¢hampagne¢arey.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          },
          {
            "node": {
              "canonical": {
                "name": {
                  "interpreted": "$$$$$$$$$$$$$$.base.eth",
                  "beautified": "$$$$$$$$$$$$$$.base.eth"
                }
              }
            }
          }
        ]
      }
    }
  }
}

Output matches a point in time snapshot GraphQL response from our alpha ENSNode instance. Live output depends on the configuration of your ENSNode instance and ENS state updates.

Back to Examples