Frame Analytics API
Send Analytics
- API Keys
- Blog
- Community
Farcaster Development Kit
- Getting Started
- GETCast by Hash
- GETCasts
- POSTSend Cast
- DELDelete Cast
- POSTAdd Reaction to Cast
- DELDelete Reaction to Cast
- GETChannels List
- GETChannel By Name
- POSTFollow FID
- DELUnfollow FID
- GETUser By FID
- GETUsers
- Getting Started
- POSTSigners
- POSTRegister Signer with Warpcast
- POSTPoll Warpcast Signer
- GETGet Signers
Info
Casts
Reactions
Links
User Data
Username Proofs
Verifications
FIDs
Storage
Onchain API
Events
Dev Tools
Farcaster API
Farcaster Auth
Hub API Reference
Frame Analytics API
Send Analytics
POST
/
interactions
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
object
object
Add Example Value
frame_id
string
*
frame_id
Required
string
custom_id
string
custom_id
string
data
object
*
data
Required
object
untrustedData
object
untrustedData
object
fid
integer
fid
integer
url
string
url
string
messageHash
string
messageHash
string
timestamp
integer
timestamp
integer
network
integer
network
integer
buttonIndex
integer
buttonIndex
integer
inputText
string
inputText
string
castId
object
castId
object
fid
integer
fid
integer
hash
string
hash
string
trustedData
object
trustedData
object
messageBytes
string
messageBytes
string
curl --request POST \
--url https://api.pinata.cloud/farcaster/frames/interactions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"frame_id": "my-custom-frame",
"custom_id": "user_123",
"data": {
"untrustedData": {
"fid": 2,
"url": "https://fcpolls.com/polls/1",
"messageHash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
"timestamp": 1706243218,
"network": 1,
"buttonIndex": 2,
"inputText": "hello world",
"castId": {
"fid": 226,
"hash": "0xa48dd46161d8e57725f5e26e34ec19c13ff7f3b9"
}
},
"trustedData": {
"messageBytes": "d2b1ddc6c88e865a33cb1a565e0058d757042974..."
}
}
}'
"OK"
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
frame_id
string
requiredcustom_id
string
data
object
requireddata.untrustedData
object
data.untrustedData.fid
integer
data.untrustedData.url
string
data.untrustedData.messageHash
string
data.untrustedData.timestamp
integer
data.untrustedData.network
integer
data.untrustedData.buttonIndex
integer
data.untrustedData.inputText
string
data.untrustedData.castId
object
data.untrustedData.castId.fid
integer
data.untrustedData.castId.hash
string
data.trustedData
object
data.trustedData.messageBytes
string
Response
200 - application/json
The response is of type object
.
curl --request POST \
--url https://api.pinata.cloud/farcaster/frames/interactions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"frame_id": "my-custom-frame",
"custom_id": "user_123",
"data": {
"untrustedData": {
"fid": 2,
"url": "https://fcpolls.com/polls/1",
"messageHash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
"timestamp": 1706243218,
"network": 1,
"buttonIndex": 2,
"inputText": "hello world",
"castId": {
"fid": 226,
"hash": "0xa48dd46161d8e57725f5e26e34ec19c13ff7f3b9"
}
},
"trustedData": {
"messageBytes": "d2b1ddc6c88e865a33cb1a565e0058d757042974..."
}
}
}'
"OK"