pkg.gl

Documentation for API Endpoints

All URIs are relative to https://api.neynar.com/v2

Class	Method	HTTP request	Description
BlockApi	BlockList	Get /farcaster/block/list	Get fids that a user has blocked or has been blocked by
CastApi	Cast	Get /farcaster/cast	Retrieve cast for a given hash or Warpcast URL
CastApi	CastConversation	Get /farcaster/cast/conversation	Retrieve the conversation for a given cast
CastApi	CastSearch	Get /farcaster/cast/search	Search for casts
CastApi	Casts	Get /farcaster/casts	Gets information about an array of casts
CastApi	ComposerList	Get /farcaster/cast/composer_actions/list	Fetches all composer actions on Warpcast
CastApi	DeleteCast	Delete /farcaster/cast	Delete a cast
CastApi	PostCast	Post /farcaster/cast	Posts a cast
ChannelApi	ActiveChannels	Get /farcaster/channel/user	Get channels that a user is active in
ChannelApi	ChannelDetails	Get /farcaster/channel	Retrieve channel details by id or parent_url
ChannelApi	ChannelDetailsBulk	Get /farcaster/channel/bulk	(Bulk) Retrieve channels by id or parent_url
ChannelApi	ChannelFollowers	Get /farcaster/channel/followers	Retrieve followers for a given channel
ChannelApi	ChannelUsers	Get /farcaster/channel/users	Retrieve users who are active in a channel
ChannelApi	ListAllChannels	Get /farcaster/channel/list	Retrieve all channels with their details
ChannelApi	SearchChannels	Get /farcaster/channel/search	Search for channels based on id or name
ChannelApi	TrendingChannels	Get /farcaster/channel/trending	Retrieve trending channels based on activity
ChannelApi	UserChannels	Get /farcaster/user/channels	Retrieve all channels that a given fid follows
FeedApi	Feed	Get /farcaster/feed	Retrieve casts based on filters
FeedApi	FeedChannels	Get /farcaster/feed/channels	Retrieve feed based on channel ids
FeedApi	FeedFollowing	Get /farcaster/feed/following	Retrieve feed based on who a user is following
FeedApi	FeedForYou	Get /farcaster/feed/for_you	Retrieve a personalized For You feed for a user
FeedApi	FeedFrames	Get /farcaster/feed/frames	Retrieve feed of casts with Frames, reverse chronological order
FeedApi	FeedParentUrls	Get /farcaster/feed/parent_urls	Retrieve feed based on parent urls
FeedApi	FeedTrending	Get /farcaster/feed/trending	Retrieve trending casts
FeedApi	FeedUserCasts	Get /farcaster/feed/user/casts	Retrieve casts for a user
FeedApi	FeedUserPopular	Get /farcaster/feed/user/popular	Retrieve 10 most popular casts for a user
FeedApi	FeedUserRepliesRecasts	Get /farcaster/feed/user/replies_and_recasts	Retrieve recent replies and recasts for a user
FnameApi	FnameAvailability	Get /farcaster/fname/availability	Check if a given fname is available
FollowsApi	FollowersV2	Get /farcaster/followers	Retrieve followers for a given user
FollowsApi	FollowingV2	Get /farcaster/following	Retrieve a list of users followed by a user
FollowsApi	RelevantFollowers	Get /farcaster/followers/relevant	Retrieve relevant followers for a given user
FrameApi	DeleteNeynarFrame	Delete /farcaster/frame	Delete a frame
FrameApi	FetchNeynarFrames	Get /farcaster/frame/list	Retrieve a list of frames
FrameApi	FrameFromUrl	Get /farcaster/frame/crawl	Fetches the frame meta tags from the URL
FrameApi	LookupNeynarFrame	Get /farcaster/frame	Retrieve a frame by UUID or URL
FrameApi	PostFrameAction	Post /farcaster/frame/action	Posts a frame action, cast action or a cast composer action
FrameApi	PostFrameDeveloperManagedAction	Post /farcaster/frame/developer_managed/action	Posts a frame signature packet
FrameApi	PublishNeynarFrame	Post /farcaster/frame	Create a new frame
FrameApi	UpdateNeynarFrame	Put /farcaster/frame	Update an existing frame
FrameApi	ValidateFrame	Post /farcaster/frame/validate	Validates a frame action against Farcaster Hub
FrameApi	ValidateFrameAnalytics	Get /farcaster/frame/validate/analytics	Retrieve analytics for the frame
FrameApi	ValidateFrameList	Get /farcaster/frame/validate/list	Retrieve a list of all the frames validated by a user
MuteApi	AddMute	Post /farcaster/mute	Adds a mute for a fid
MuteApi	DeleteMute	Delete /farcaster/mute	Deletes a mute for a fid
MuteApi	MuteList	Get /farcaster/mute/list	Get fids that a user has muted
NotificationsApi	MarkNotificationsAsSeen	Post /farcaster/notifications/seen	Mark notifications as seen
NotificationsApi	Notifications	Get /farcaster/notifications	Retrieve notifications for a given user
NotificationsApi	NotificationsChannel	Get /farcaster/notifications/channel	Retrieve notifications for a user in given channels
NotificationsApi	NotificationsParentUrl	Get /farcaster/notifications/parent_url	Retrieve notifications for a user in given parent_urls
ReactionApi	DeleteReaction	Delete /farcaster/reaction	Delete a reaction
ReactionApi	PostReaction	Post /farcaster/reaction	Posts a reaction
ReactionApi	ReactionsCast	Get /farcaster/reactions/cast	Fetches reactions for a given cast
ReactionApi	ReactionsUser	Get /farcaster/reactions/user	Fetches reactions for a given user
SignerApi	CreateSigner	Post /farcaster/signer	Creates a signer and returns the signer status
SignerApi	DeveloperManagedSigner	Get /farcaster/signer/developer_managed	Fetches the status of a signer by public key
SignerApi	FetchAuthorizationUrl	Get /farcaster/login/authorize	Fetch authorization url
SignerApi	PublishMessage	Post /farcaster/message	Publish a message to farcaster
SignerApi	RegisterSignedKey	Post /farcaster/signer/signed_key	Register Signed Key
SignerApi	RegisterSignedKeyForDeveloperManagedSigner	Post /farcaster/signer/developer_managed/signed_key	Registers Signed Key
SignerApi	Signer	Get /farcaster/signer	Fetches the status of a signer
StorageApi	BuyStorage	Post /farcaster/storage/buy	Buy storage for an fid
StorageApi	StorageAllocations	Get /farcaster/storage/allocations	Fetches storage allocations for a given user
StorageApi	StorageUsage	Get /farcaster/storage/usage	Fetches storage usage for a given user
SubscribersApi	SubscribedTo	Get /farcaster/user/subscribed_to	Fetch what a given fid is subscribed to
SubscribersApi	Subscribers	Get /farcaster/user/subscribers	Fetch subscribers for a given fid
SubscribersApi	SubscriptionsCreated	Get /farcaster/user/subscriptions_created	Fetch created subscriptions for a given fid
UserApi	ActiveUsers	Get /farcaster/user/active	Fetch active users
UserApi	FarcasterUserVerificationDelete	Delete /farcaster/user/verification	Removes verification for an eth address for the user
UserApi	FarcasterUserVerificationPost	Post /farcaster/user/verification	Adds verification for an ethereum address or contract for the user
UserApi	FollowUser	Post /farcaster/user/follow	Follow a user
UserApi	GetFreshFid	Get /farcaster/user/fid	Fetches fid to assign it new user
UserApi	LookupUserByCustodyAddress	Get /farcaster/user/custody-address	Lookup a user by custody-address
UserApi	PowerUsers	Get /farcaster/user/power	Fetch power user objects
UserApi	RegisterUser	Post /farcaster/user	Register account on farcaster
UserApi	UnfollowUser	Delete /farcaster/user/follow	Unfollow a user
UserApi	UpdateUser	Patch /farcaster/user	Update user profile
UserApi	UserBulk	Get /farcaster/user/bulk	Fetch users based on FIDs
UserApi	UserBulkByAddress	Get /farcaster/user/bulk-by-address	Fetches users based on Eth or Sol addresses
UserApi	UserPowerLite	Get /farcaster/user/power_lite	Fetch power user FIDs
UserApi	UserSearch	Get /farcaster/user/search	Search for Usernames
WebhookApi	DeleteWebhook	Delete /farcaster/webhook	Delete a webhook
WebhookApi	FetchWebhooks	Get /farcaster/webhook/list	Fetch a list of webhooks associated to a user
WebhookApi	LookupWebhook	Get /farcaster/webhook	Fetch a webhook
WebhookApi	PublishWebhook	Post /farcaster/webhook	Create a webhook
WebhookApi	UpdateWebhook	Put /farcaster/webhook	Update a webhook
WebhookApi	UpdateWebhookActiveStatus	Patch /farcaster/webhook	Update webhook active status

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

# README

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

Author