AR.IO LogoAR.IO Documentation

Farcaster Frames

Retrieve and interact with Farcaster Frames using Arweave transactions.

Handle a Farcaster initial Frame request.

Responds to a Farcaster initial Frame GET request by returning the content of a specified Arweave transaction or data item.

GET
/local/farcaster/frame/{txId}

Path Parameters

txIdstring
Match^[0-9a-zA-Z_-]{43}$

Response Body

curl -X GET "https://ardrive.net/local/farcaster/frame/string"
{
  "format": 0,
  "id": "string",
  "last_tx": "string",
  "owner": "string",
  "tags": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "target": "string",
  "quantity": "string",
  "data": "string",
  "data_tree": [
    "string"
  ],
  "data_root": "string",
  "reward": "string",
  "signature": "string"
}

Handle a Farcaster response Frame request.

Responds to a Farcaster response Frame POST request by returning the content of a specified Arweave transaction or data item.

POST
/local/farcaster/frame/{txId}

Path Parameters

txIdstring
Match^[0-9a-zA-Z_-]{43}$

Response Body

curl -X POST "https://ardrive.net/local/farcaster/frame/string"
{
  "format": 0,
  "id": "string",
  "last_tx": "string",
  "owner": "string",
  "tags": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "target": "string",
  "quantity": "string",
  "data": "string",
  "data_tree": [
    "string"
  ],
  "data_root": "string",
  "reward": "string",
  "signature": "string"
}

How is this guide?