Skip to main content

src/lib/neynar-api

creatorvault-miniapp

creatorvault-miniapp / src/lib/neynar-api

src/lib/neynar-api

Interfaces​

FarcasterProfile​

Defined in: lib/neynar-api.ts:20

Properties​

avatar​

avatar: string

Defined in: lib/neynar-api.ts:23

bio?​

optional bio: string

Defined in: lib/neynar-api.ts:26

custodyAddress?​

optional custodyAddress: string | null

Defined in: lib/neynar-api.ts:29

displayName​

displayName: string

Defined in: lib/neynar-api.ts:22

fetchedAt?​

optional fetchedAt: number

Defined in: lib/neynar-api.ts:31

fid​

fid: number

Defined in: lib/neynar-api.ts:27

followers​

followers: number

Defined in: lib/neynar-api.ts:24

following​

following: number

Defined in: lib/neynar-api.ts:25

username​

username: string

Defined in: lib/neynar-api.ts:21

verifiedAddresses?​

optional verifiedAddresses: string[]

Defined in: lib/neynar-api.ts:28

verifiedEthAddresses?​

optional verifiedEthAddresses: string[]

Defined in: lib/neynar-api.ts:30

FarcasterUser​

Defined in: lib/neynar-api.ts:7

Properties​

display_name​

display_name: string

Defined in: lib/neynar-api.ts:10

fid​

fid: number

Defined in: lib/neynar-api.ts:8

follower_count​

follower_count: number

Defined in: lib/neynar-api.ts:12

following_count​

following_count: number

Defined in: lib/neynar-api.ts:13

pfp_url​

pfp_url: string

Defined in: lib/neynar-api.ts:11

username​

username: string

Defined in: lib/neynar-api.ts:9

verified_addresses​

verified_addresses: object

Defined in: lib/neynar-api.ts:14

eth_addresses​

eth_addresses: string[]

sol_addresses​

sol_addresses: string[]

Functions​

getFarcasterUserByAddress()​

getFarcasterUserByAddress(address): Promise<FarcasterProfile | null>

Defined in: lib/neynar-api.ts:80

Fetch Farcaster user by verified wallet address via backend proxy Backend handles API authentication and CORS

Parameters​

address​

string

Returns​

Promise<FarcasterProfile | null>

getFarcasterUserByFid()​

getFarcasterUserByFid(fid): Promise<FarcasterProfile | null>

Defined in: lib/neynar-api.ts:39

Fetch Farcaster user by FID (Farcaster ID) Note: Currently not implemented in backend proxy Use getFarcasterUserByAddress instead

Parameters​

fid​

number

Returns​

Promise<FarcasterProfile | null>

getFarcasterUserByUsername()​

getFarcasterUserByUsername(username): Promise<FarcasterProfile | null>

Defined in: lib/neynar-api.ts:71

Fetch Farcaster user by username Note: Currently not implemented in backend proxy Use getFarcasterUserByAddress instead

Parameters​

username​

string

Returns​

Promise<FarcasterProfile | null>