Skip to main content
The getAvatar utility is designed to retrieve an avatar image URL from an onchain identity provider for a given name. Consider the utility instead of the hook when you use it with Next.js or any Node.js backend. Supported providers:

​
Usage

Get Basename avatar: 
import { getAvatar } from '@coinbase/onchainkit/identity';
import { base, mainnet } from 'viem/chains';

const baseAvatar = await getAvatar({ ensName: 'paulcramer.eth', chain: base });
Get ENS avatar: 
import { getAvatar } from '@coinbase/onchainkit/identity';
import { mainnet } from 'viem/chains';

const ensAvatar = await getAvatar({ ensName: 'paulcramer.eth', chain: mainnet });

​
Returns

Promise<GetAvatarReturnType>

type GetAvatarReturnType = string | null;

​
Parameters

type GetAvatarParams = {
  /** The ENS or Basename to fetch the avatar for. */
  ensName: string;
  /** Optional chain for domain resolution */
  chain?: Chain;
};

type Chain = {
  id: number;
  name: string;
  // ... other chain properties
};
⌘I