Neynar Documentation
Hub HTTP APIs
Casts
| Version | Type | Method | Credits |
|---|---|---|---|
| v1 | GET |
/v1/castById | 1 |
| /v1/castsByFid | 200 | ||
| /v1/castsByParent | 200 |
Reactions
| Version | Type | Method | Credits |
|---|---|---|---|
| v1 | GET |
/v1/reactionById | 1 |
| /v1/reactionsByFid | 200 | ||
| /v1/reactionsByCast | 150 | ||
| /v1/reactionsByTarget | 150 |
Follows
| Version | Type | Method | Credits |
|---|---|---|---|
| v1 | GET |
/v1/linkById | 1 |
| /v1/linksByFid | 200 | ||
| /v1/linksByTargetFid | 200 |
User
| Version | Type | Method | Credits |
|---|---|---|---|
| v1 | GET |
/v1/userDataByFid | 1 |
| /v1/fids | 2000 | ||
| /v1/storageLimitsByFid | 5 | ||
| /v1/userNameProofByName | 2 | ||
| /v1/userNameProofsByFid | 2 | ||
| /v1/verificationsByFid | 5 | ||
| /v1/onChainSignersByFid | 15 |
Messages
| Version | Type | Method | Credits |
|---|---|---|---|
| v1 | POST |
/v1/submitMessage | 150 |
| /v1/validateMessage | 4 |
Events
| Version | Type | Method | Credits |
|---|---|---|---|
| v1 | GET |
/v1/onChainIdRegistryEventByAddress | 2 |
| /v1/eventById | 1 | ||
| /v1/events | 2000 |
Hub gRPC APIs
WIP Hub gRPC APIs and Hub gRPC streaming pricing will be added soon.
Neynar APIs
User
| Version | Type | Method | Credits | Multiplier |
|---|---|---|---|---|
| v2 | GET |
/v2/farcaster/user/search | 10 | |
| /v2/farcaster/user/bulk | 1 | number of fids | ||
| /v2/farcaster/user/bulk-by-address | 1 | number of addresses | ||
| /v2/farcaster/user/custody-address | 1 | |||
| /v2/farcaster/user/active | 1 | page limit | ||
PATCH |
/v2/farcaster/user | 20 | ||
POST |
/v2/farcaster/user/verification | 10 | ||
| /v2/farcaster/user/follow | 10 | |||
DELETE |
/v2/farcaster/user/verification | 10 | ||
| /v2/farcaster/user/follow | 10 | |||
| /v2/farcaster/reaction | 10 |
Cast
| Version | Type | Method | Credits | Multiplier |
|---|---|---|---|---|
| v2 | GET |
/v2/farcaster/cast | 2 | |
| /v2/farcaster/casts | 50 | |||
POST |
/v2/farcaster/cast | 150 | ||
DELETE |
/v2/farcaster/cast | 10 |
Feed
| Version | Type | Method | Credits | Multiplier |
|---|---|---|---|---|
| v2 | GET |
/v2/farcaster/feed | 4 | page limit |
| /v2/farcaster/feed/following | 4 | page limit | ||
| /v2/farcaster/feed/channels | 4 | page limit | ||
| /v2/farcaster/feed/frames | 4 | page limit | ||
| /v2/farcaster/feed/user/{fid}/popular | 4 | page limit | ||
| /v2/farcaster/feed/user/{fid}/replies_and_recasts | 4 | page limit |
Reactions
| Version | Type | Method | Credits | Multiplier |
|---|---|---|---|---|
| v2 | GET |
/v2/farcaster/reactions/user | 2 | page limit |
GET |
/v2/farcaster/reactions/cast | 2 | page limit | |
POST |
/v2/farcaster/reaction | 10 |
Frame
| Version | Type | Method | Credits | Multiplier |
|---|---|---|---|---|
| v2 | POST |
/v2/farcaster/frame/action | 20 | |
| /v2/farcaster/frame/validate | 0 |
Notifications
| Version | Type | Method | Credits | Multiplier |
|---|---|---|---|---|
| v2 | GET |
/v2/farcaster/notifications | 5 | page limit |
| /v2/farcaster/notifications/parent_url | 5 | page limit | ||
| /v2/farcaster/notifications/channel | 5 | page limit |
Channel
| Version | Type | Method | Credits | Multiplier |
|---|---|---|---|---|
| v2 | GET |
/v2/farcaster/channel/list | 2 | page limit |
| /v2/farcaster/channel/search | 20 | |||
| /v2/farcaster/channel | 2 | |||
| /v2/farcaster/channel/followers | 1 | page limit | ||
| /v2/farcaster/channel/users | 1 | page limit | ||
| /v2/farcaster/channel/trending | 4 | page limit |
Follows
| Version | Type | Method | Credits | Multiplier |
|---|---|---|---|---|
| v2 | GET |
v2/farcaster/followers/relevant | 20 |
fname
| Version | Type | Method | Credits | Multiplier |
|---|---|---|---|---|
| v2 | GET |
/v2/farcaster/fname/availability | 1 |
Storage
| Version | Type | Method | Credits | Multiplier |
|---|---|---|---|---|
| v2 | GET |
/v2/farcaster/storage/allocations | 1 | |
| /v2/farcaster/storage/usage | 1 |
Signer
| Version | Type | Method | Credits | Multiplier |
|---|---|---|---|---|
| v2 | GET |
/v2/farcaster/signer | 0 | |
GET |
/v2/farcaster/signer/developer_managed | 0 | ||
POST |
/v2/farcaster/signer | 2 | ||
| /v2/farcaster/signer/signed_key | 5 | |||
| /v2/farcaster/signer/developer_managed/signed_key | 5 |
20,000 Credits per monthly active signer per month, where active signer = signers used by developer to write to the protocol in specific time periodMessage
| Version | Type | Method | Credits |
|---|---|---|---|
| v2 | POST |
v2/farcaster/message | 150 |
Webhooks
| Event type | Filter | Credits |
|---|---|---|
| user.created | 5 | |
| user.updated | fids | 10 |
| cast.created | fids | 15 |
| mention_fids | 15 | |
| author_fids | 15 | |
| root_parent_urls | 15 | |
| parent_url | 15 | |
| embeds | 15 | |
| reaction.created | fids | 15 |
| target_fids | 15 | |
| reaction.deleted | fids | 15 |
| target_fids | 15 | |
| follow.created | fids | 15 |
| target_fids | 15 | |
| follow.deleted | fids | 15 |
| target_fids | 15 |