Developer documentation

Build with XDCID

Resolve human-readable .xdc names, look up primary names, check availability, and read public profiles on XDC mainnet.

NetworkXDC mainnet

Chain ID50

OpenAPI specification Try a name lookup View TypeScript SDK

Public API

Read-only endpoints

These endpoints require no API key. Names are canonicalized to lowercase and may be supplied as either a bare label or a complete .xdc name.

GET/api/v1/names/{name}?years=1

Name lookup

Returns the canonical name, owner, resolved address, availability, registration price, expiry, and profile records.

GET/api/v1/reverse/{address}

Reverse lookup

Returns the verified primary XDCID name for a wallet address, or null when no current record exists.

GET/api/v1/addresses/{address}/names

Owned names

Returns the verified primary ID and every active XDCID name currently owned by a wallet.

TypeScript SDK

Resolve XDCID directly on-chain

The read-only SDK provides name validation, forward and reverse resolution, availability, pricing, expiry, and profile lookups with XDC RPC fallback. It never requests a private key or wallet signature.

The source is available now and is compiled with this project. Public npm installation instructions will be added after the package is released.

import { createXdcidClient } from "@xdcid/sdk";

const xdcid = createXdcidClient();
const result = await xdcid.resolveName("alice.xdc");

View SDK source →Read the SDK guide →

Success format

Versioned responses

Every application JSON response identifies the API version. Clients should ignore response fields they do not recognize.

{
  "version": "v1",
  "data": {
    "name": "alice.xdc",
    "available": false,
    "resolvedAddress": "0x..."
  }
}

Error format

Consistent failures

Invalid input returns HTTP 400, rate limits may return 429, and temporary XDC RPC failures return 503.

{
  "version": "v1",
  "error": {
    "code": "INVALID_NAME",
    "message": "Invalid XDCID name"
  }
}

XDC AI Gateway

Paid agent capabilities

The XDCID service is available through XDC AI for 0.001 USDC per call. Agents should use the service URL published by XDC AI; protected upstream credentials remain server-side and are never required by callers.

Resolve

Resolve an XDCID name to its owner, payment address, and expiry.

Reverse

Find the verified primary XDCID name for an XDC address.

Availability

Check whether a name is available and retrieve its registration price.

Profile

Read the public profile records attached to an XDCID name.

Owned names

List every active XDCID name owned by an address, including its verified primary ID.

Compatibility policy

New optional fields may be added within v1. Removing fields, renaming fields, changing their types, or changing documented behavior requires a new API version.

View the complete schemas and status codes →