Neynar Documentation

Hook for Reading User Information

You can use this hook to read the authenticated user’s profile information from other components inside your app.

import { useProfile } from '@farcaster/auth-kit';

function App() {
  const {
    isAuthenticated,
    profile: { username, fid, bio, displayName, pfpUrl },
  } = useProfile();

return (
    <div>
      {isAuthenticated ? (
        <p>
          Hello, {username}! Your fid is: {fid}
        </p>
      ) : (
        <p>You're not signed in.</p>
      )}
    </div>
  );
}

Returns

{
  isAuthenticated: boolean;
  profile?: {
      fid?: number;
      username?: string;
      bio?: string;
      displayName?: string;
      pfpUrl?: string;
      custody?: Hex;
      verifications?: Hex[];
  },
};