API Reference
Retrieve a cast by hash
Welcome
API Reference
- POSTCreate a free API key
- GETRetrieve feed items
- GETRetrieve a cast by hash
- GETRetrieve a cast by short hash and username
- GETRetrieve casts in a thread
- GETRetrieve casts by FID
- GETRetrieve reactions for a cast
- GETRetrieve likes for a cast
- GETRetrieve recasters for a cast
- GETRetrieve followers by FID
- GETRetrieve following by FID
- GETRetrieve user by connected address
- GETRetrieve user by custody address
- GETRetrieve user by FID
- GETRetrieve multiple users by FID
- GETRetrieve user by username
- GETGet Farcaster storage by FID
- POSTSend a Farcaster message
- GETRetrieve notifications for a user
- POSTMark notifications as seen
- GETRetrieve count of unseen notifications
- GETSearch for users by match
- GETRetrieve address passes
- GETRetrieve signed key requests
- POSTComplete a marketplace listing
- GETRetrieve marketplace listings
- GETRetrieve marketplace statistics
- GETRetrieve a specific marketplace listing
- GETRetrieve marketplace activities
- GETRetrieve marketplace offers
- GETRetrieve a specific marketplace offer
- GETRetrieve the best offer for a listing
- GETRetrieve an appraisal for a listing
- POSTSubmit an appraisal for a listing
- POSTBuy a marketplace listing
- POSTCancel a marketplace listing
- POSTComplete a marketplace offer
- POSTCancel a marketplace offer
- POSTAccept a marketplace offer
- GETRetrieve a metadata signature
- GETRetrieve signers
- GETRetrieve a cast frame
- POSTCreate a cast frame
API Reference
Retrieve a cast by hash
GET
/
farcaster
/
v2
/
cast
curl --request GET \
--url https://build.wield.xyz/farcaster/v2/cast \
--header 'API-KEY: <api-key>'
{
"result": {
"cast": {
"hash": "<string>",
"threadHash": "<string>",
"text": "<string>",
"embeds": {
"images": [
"<string>"
],
"urls": [
"<string>"
]
},
"mentions": [
"<string>"
],
"mentionsPositions": [
123
],
"external": true,
"author": {
"fid": "<string>",
"followingCount": 123,
"followerCount": 123,
"pfp": {
"url": "<string>",
"verified": true
},
"bio": {
"text": "<string>",
"mentions": [
"<string>"
]
},
"external": true,
"custodyAddress": "<string>",
"displayName": "<string>",
"username": "<string>",
"registeredAt": "2023-11-07T05:31:56Z",
"isFollowing": true,
"isFollowedBy": true
},
"parentAuthor": {
"fid": "<string>",
"followingCount": 123,
"followerCount": 123,
"pfp": {
"url": "<string>",
"verified": true
},
"bio": {
"text": "<string>",
"mentions": [
"<string>"
]
},
"external": true,
"custodyAddress": "<string>",
"displayName": "<string>",
"username": "<string>",
"registeredAt": "2023-11-07T05:31:56Z",
"isFollowing": true,
"isFollowedBy": true
},
"timestamp": "2023-11-07T05:31:56Z",
"replies": {
"count": 123
},
"reactions": {
"count": 123
},
"recasts": {
"count": 123,
"recasters": [
"<string>"
]
},
"isSelfLike": true,
"isSelfRecast": true,
"childCast": {},
"childrenCasts": [
{}
]
}
},
"source": "v2"
}
Headers
Free API key needed to authorize requests, grab one at docs.wield.xyz
Query Parameters
Response
200 - application/json
Successful response
Example:
"v2"
curl --request GET \
--url https://build.wield.xyz/farcaster/v2/cast \
--header 'API-KEY: <api-key>'
{
"result": {
"cast": {
"hash": "<string>",
"threadHash": "<string>",
"text": "<string>",
"embeds": {
"images": [
"<string>"
],
"urls": [
"<string>"
]
},
"mentions": [
"<string>"
],
"mentionsPositions": [
123
],
"external": true,
"author": {
"fid": "<string>",
"followingCount": 123,
"followerCount": 123,
"pfp": {
"url": "<string>",
"verified": true
},
"bio": {
"text": "<string>",
"mentions": [
"<string>"
]
},
"external": true,
"custodyAddress": "<string>",
"displayName": "<string>",
"username": "<string>",
"registeredAt": "2023-11-07T05:31:56Z",
"isFollowing": true,
"isFollowedBy": true
},
"parentAuthor": {
"fid": "<string>",
"followingCount": 123,
"followerCount": 123,
"pfp": {
"url": "<string>",
"verified": true
},
"bio": {
"text": "<string>",
"mentions": [
"<string>"
]
},
"external": true,
"custodyAddress": "<string>",
"displayName": "<string>",
"username": "<string>",
"registeredAt": "2023-11-07T05:31:56Z",
"isFollowing": true,
"isFollowedBy": true
},
"timestamp": "2023-11-07T05:31:56Z",
"replies": {
"count": 123
},
"reactions": {
"count": 123
},
"recasts": {
"count": 123,
"recasters": [
"<string>"
]
},
"isSelfLike": true,
"isSelfRecast": true,
"childCast": {},
"childrenCasts": [
{}
]
}
},
"source": "v2"
}