Farcaster API V2
- User
- Signer
- Cast
- Feed
- Reaction
- Notifications
- Channel
- Follows
- Storage
- Mini Apps
- Notifications
- Developer Hosted Frames
- Neynar Hosted Frames
- GETMini apps catalog
- GETRelevant mini apps
- GETMeta tags from URL
- POSTSignature packet
- Agents
- Fname
- Webhook
- Action
- Mute
- Block
- Ban
- Onchain
- Login
- Metrics
Onchain
Farcaster Hub API
- Info
- Casts
- Reactions
- Links
- UserData
- Fids
- Storage
- Usernames
- Verifications
- OnChainEvents
- Message
- HubEvents
Neynar SDK
- Getting Started with Neynar NodeJS SDK
- SDK v1 to v2 migration guide
Signature packet
Post a mini app action that has been signed with a developer managed signer
The POST request to the post_url has a timeout of 5 seconds.
curl --request POST \
--url https://api.neynar.com/v2/farcaster/frame/developer_managed/action \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"cast_hash": "0xfe90f9de682273e05b201629ad2338bdcd89b6be",
"action": {
"version": "<string>",
"title": "<string>",
"image": "<string>",
"button": {
"title": "<string>",
"index": 123,
"action_type": "post",
"target": "<string>",
"post_url": "<string>"
},
"input": {
"text": "Draw a purple ringed planet"
},
"state": {
"serialized": "%7B%22counter%22%3A1%7D"
},
"transaction": {
"hash": "0xa80de157a3ab4648db1ecfab7e6355b342215bc549f6e37be9e6da527cc024f7"
},
"address": "<string>",
"frames_url": "<string>",
"post_url": "<string>"
},
"signature_packet": {
"untrustedData": {
"fid": 3,
"url": "<string>",
"messageHash": "<string>",
"timestamp": "<string>",
"network": 123,
"buttonIndex": 123,
"inputText": "<string>",
"state": "<string>",
"transactionId": "<string>",
"address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"castId": {
"fid": 3,
"hash": "<string>"
}
},
"trustedData": {
"messageBytes": "<string>"
}
}
}'{
"version": "<string>",
"image": "<string>",
"frames_url": "<string>",
"buttons": [
{
"title": "<string>",
"index": 123,
"action_type": "post",
"target": "<string>",
"post_url": "<string>"
}
],
"post_url": "<string>",
"title": "<string>",
"image_aspect_ratio": "<string>",
"input": {
"text": "<string>"
},
"state": {
"serialized": "<string>"
}
}Authorizations
API key to authorize requests
Body
Index of the button
The action type of a mini app button. Action types "mint" & "link" are to be handled on the client side only and so they will produce a no/op for POST /farcaster/frame/action.
post, post_redirect, tx, link, mint Title of the button
Target of the button
Used specifically for the tx action type to post a successful transaction hash
URL of the mini apps
URL of the post to get the next mini app
Input text for the mini app
"Draw a purple ringed planet"
State for the mini app in a serialized format
"%7B%22counter%22%3A1%7D"
Transaction hash
"0xa80de157a3ab4648db1ecfab7e6355b342215bc549f6e37be9e6da527cc024f7"
The connected wallet address of the interacting user.
The Mini app Signature Packet (https://docs.farcaster.xyz/developers/frames/spec#frame-signature-packet)
Untrusted data from the user
The unique identifier of a farcaster user (unsigned integer)
3
URL of the mini app
Message hash
Timestamp
Network
Index of the button
Input text
State
Transaction ID
Ethereum address
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
Cast Hash
Response
Mini app v1 object
Version of the mini app, 'next' for v2, 'vNext' for v1
URL of the image
Launch URL of the mini app
Index of the button
The action type of a mini app button. Action types "mint" & "link" are to be handled on the client side only and so they will produce a no/op for POST /farcaster/frame/action.
post, post_redirect, tx, link, mint Title of the button
Target of the button
Used specifically for the tx action type to post a successful transaction hash
Post URL to take an action on this mini app
Mini app v1 object
Version of the mini app, 'next' for v2, 'vNext' for v1
URL of the image
Launch URL of the mini app
Index of the button
The action type of a mini app button. Action types "mint" & "link" are to be handled on the client side only and so they will produce a no/op for POST /farcaster/frame/action.
post, post_redirect, tx, link, mint Title of the button
Target of the button
Used specifically for the tx action type to post a successful transaction hash
Post URL to take an action on this mini app
Mini app v2 object
Version of the mini app, 'next' for v2, 'vNext' for v1
URL of the image
Launch URL of the mini app
Button title of a mini app
0.0.0, 0.0.1, 1, next 3251251251232512512user_dehydrated The unique identifier of a farcaster user (unsigned integer)
3
Ethereum address
"0x5a927ac639636e534b678e81768ca19e2c6280b7"
Basic data structure of every oembed response see https://oembed.com/
rich The HTML required to display the resource. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities. The markup should be valid XHTML 1.0 Basic.
The width in pixels required to display the HTML.
The height in pixels required to display the HTML.
A text title, describing the resource.
The name of the author/owner of the resource.
A URL for the author/owner of the resource.
The name of the resource provider.
The url of the resource provider.
The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not.
A URL to a thumbnail image representing the resource. The thumbnail must respect any maxwidth and maxheight parameters. If this parameter is present, thumbnail_width and thumbnail_height must also be present.
The width of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_height must also be present.
The height of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_width must also be present.
Was this page helpful?
curl --request POST \
--url https://api.neynar.com/v2/farcaster/frame/developer_managed/action \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"cast_hash": "0xfe90f9de682273e05b201629ad2338bdcd89b6be",
"action": {
"version": "<string>",
"title": "<string>",
"image": "<string>",
"button": {
"title": "<string>",
"index": 123,
"action_type": "post",
"target": "<string>",
"post_url": "<string>"
},
"input": {
"text": "Draw a purple ringed planet"
},
"state": {
"serialized": "%7B%22counter%22%3A1%7D"
},
"transaction": {
"hash": "0xa80de157a3ab4648db1ecfab7e6355b342215bc549f6e37be9e6da527cc024f7"
},
"address": "<string>",
"frames_url": "<string>",
"post_url": "<string>"
},
"signature_packet": {
"untrustedData": {
"fid": 3,
"url": "<string>",
"messageHash": "<string>",
"timestamp": "<string>",
"network": 123,
"buttonIndex": 123,
"inputText": "<string>",
"state": "<string>",
"transactionId": "<string>",
"address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"castId": {
"fid": 3,
"hash": "<string>"
}
},
"trustedData": {
"messageBytes": "<string>"
}
}
}'{
"version": "<string>",
"image": "<string>",
"frames_url": "<string>",
"buttons": [
{
"title": "<string>",
"index": 123,
"action_type": "post",
"target": "<string>",
"post_url": "<string>"
}
],
"post_url": "<string>",
"title": "<string>",
"image_aspect_ratio": "<string>",
"input": {
"text": "<string>"
},
"state": {
"serialized": "<string>"
}
}