Skip to main content
Retrieve subnames using filters like label search, owner, metadata, and pagination.

​
Usage

client.getFilteredSubnames({ parentName: "myensname.eth",  metadata: { "sender": "0x123..." }, });

​
Request Parameters

export interface QuerySubnamesRequest {
  parentName?: string;
  parentNames?: string;
  labelSearch?: string;
  page?: number;
  size?: number;
  metadata?: Record<string, string>;
  owner?: string;
}
  • parentName or parentNames: ENS name(s) to search under (required)
  • labelSearch: Substring to match subname labels (optional)
  • page: Page number for pagination (default: 1)
  • size: Number of items per page (optional)
  • metadata: Metadata key-value filters (optional)
  • owner: Filter by Ethereum address (optional)
You must provide either parentName or parentNames.

​
Response

​
PagedResponse
object

​
Example

{
  "page": 1,
  "size": 2,
  "totalItems": 42,
  "items": [
    {
      "id": "01J9Q3TF3C2Z2S2X9K0V3Q6Y2B",
      "fullName": "ns.myensname.eth",
      "parentName": "myensname.eth",
      "label": "ns",
      "texts": { "name": "Namespace" },
      "addresses": { "60": "0x1234567890abcdef1234567890abcdef12345678" },
      "metadata": { "sender": "0x1234567890abcdef1234567890abcdef12345678" },
      "contenthash": null,
      "namehash": "0x5f16f2e6b2b3d1e7c3a91e8f27f5b9c3c2b7f6e2a1c0d9e8f6a5b4c3d2e1f0a9",
      "owner": "0x1234567890abcdef1234567890abcdef12345678"
    },
    {
      "id": "01J9Q3TH3D4A5B6C7D8E9F0G1H",
      "fullName": "blog.myensname.eth",
      "parentName": "myensname.eth",
      "label": "blog",
      "texts": { "url": "https://example.com" },
      "addresses": {},
      "metadata": {},
      "contenthash": "ipfs://bafybeigdyrztxotk3kxne",
      "namehash": "0xa9f0e1d2c3b4a5f6e8d9c0a1e2f6b7c2c3b9f5f7e8a1c3d7e1b2b3e6f2f6155f",
      "owner": null
    }
  ]
}
⌘I