useProfileDetails

The useProfileDetails hook fetches and manages the profile details for a given Ethereum address or ENS name, including ENS data and primary list information.

Add to your project

import { useProfileDetails } from 'ethereum-identity-kit'
 
export default function ProfileComponent() {
  const { ens, address, primaryList, detailsLoading, refreshProfileDetails } = useProfileDetails({
    addressOrName: 'vitalik.eth',
  })
 
  if (detailsLoading) return <div>Loading...</div> // Create your own loading states
 
  // --- Your component code here ---
}

Parameters

Parameter	Description	Required	Default Value
`addressOrName`	Ethereum Address or ENS name to fetch profile details for.	Yes	-
`list`	List number to fetch profile details for; overrides `addressOrName` if provided.	No	-
`prefetchedData`	Prefetched profile data to use initially.	No	-
`refetchPrefetchedData`	Function to refetch prefetched profile data.	No	-

⚠️

Either addressOrName or list must be provided. If both are provided, list will take precedence.

Return Values

The hook provides comprehensive profile data including ENS information, address, and primary list number. Use refreshProfileDetails to manually update the data when needed.

Return Value	Description
`ens`	ENS data for the profile, including name and records.
`address`	Ethereum address associated with the profile.
`primaryList`	Primary list number associated with the profile.
`detailsLoading`	Boolean indicating if the profile details are currently loading.
`refreshProfileDetails`	Function to manually refresh the profile details.

Translation Provider useProfileStats