GET
/
channels
/
{name}
curl --request GET \
  --url https://api.pinata.cloud/v3/farcaster/channels/{name} \
  --header 'Authorization: Bearer <token>'
{
  "channel": {
    "created_at": 1706890562,
    "description": "Build on IPFS and Farcaster at Scale | https://docs.pinata.cloud/farcaster/farcaster-api/getting-started",
    "follower_count": 544,
    "hosts": [
      {
        "active_status": "inactive",
        "custody_address": "0x62402434701e0ce0ae4ea4b3caf68230a6ddbe43",
        "display_name": "Kyle Tut",
        "fid": 20591,
        "follower_count": 473,
        "following_count": 22,
        "notes": {
          "active_status": "Warpcast has transitioned from active badges to power badges, Neynar will deprecate this key in the user object in the next few weeks"
        },
        "object": "user",
        "pfp_url": "https://i.imgur.com/TLMFnH6.jpg",
        "power_badge": true,
        "profile": {
          "bio": {
            "text": "Everyone is from somewhere. Cofounder and CEO of Pinata. https://www.pinata.cloud/farcaster"
          }
        },
        "username": "kyletut",
        "verifications": [
          "0x5ba9355a10611ed4339526472a59befed3549bad"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0x5ba9355a10611ed4339526472a59befed3549bad"
          ],
          "sol_addresses": []
        }
      },
      {
        "active_status": "inactive",
        "custody_address": "0x7f9a6992a54dc2f23f1105921715bd61811e5b71",
        "display_name": "Justin Hunter",
        "fid": 4823,
        "follower_count": 26787,
        "following_count": 924,
        "notes": {
          "active_status": "Warpcast has transitioned from active badges to power badges, Neynar will deprecate this key in the user object in the next few weeks"
        },
        "object": "user",
        "pfp_url": "https://i.seadn.io/gae/lhGgt7yK1JiBVYz_HBxcAmYLRtP03aw5xKX4FgmFT9Ai7kLD5egzlLvb0lkuRNl28shtjr07DC8IHzLUkTqlWUMndUzC9R5_MSxH3g?w=500&auto=format",
        "power_badge": true,
        "profile": {
          "bio": {
            "text": "Writer. Building @pinatacloud. Tinkering with a Farcaster native alternative to GoodReads: https://readcast.xyz \\ https://polluterofminds.com"
          }
        },
        "username": "polluterofminds",
        "verifications": [
          "0xcdcdc174901b12e87cc82471a2a2bd6181c89392",
          "0x1612c6dff0eb5811108b709a30d8150495ce9cc5"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0xcdcdc174901b12e87cc82471a2a2bd6181c89392",
            "0x1612c6dff0eb5811108b709a30d8150495ce9cc5"
          ],
          "sol_addresses": []
        }
      },
      {
        "active_status": "inactive",
        "custody_address": "0x456131161f83c7d7fda15b32a5f7c21fd4e27e96",
        "display_name": "Steve",
        "fid": 6023,
        "follower_count": 5095,
        "following_count": 937,
        "notes": {
          "active_status": "Warpcast has transitioned from active badges to power badges, Neynar will deprecate this key in the user object in the next few weeks"
        },
        "object": "user",
        "pfp_url": "https://p765cpbvm0.execute-api.eu-central-1.amazonaws.com/p1/renderer/Minteeble/chain/base/collection/6e0b39a5-8569-4e67-b330-d352593c9629/image/176.png",
        "power_badge": true,
        "profile": {
          "bio": {
            "text": "Head of Developer Relations at /pinata | Technical Writer | Building honeythread.xyz | Tinkering Photocaster | stevedylan.dev/links"
          }
        },
        "username": "stevedylandev.eth",
        "verifications": [
          "0xad73eafcac4f4c6755dfc61770875fb8b6bc8a25"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0xad73eafcac4f4c6755dfc61770875fb8b6bc8a25"
          ],
          "sol_addresses": []
        }
      }
    ],
    "id": "pinata",
    "image_url": "https://i.imgur.com/u4mGk5b.gif",
    "lead": {
      "active_status": "inactive",
      "custody_address": "0x62402434701e0ce0ae4ea4b3caf68230a6ddbe43",
      "display_name": "Kyle Tut",
      "fid": 20591,
      "follower_count": 473,
      "following_count": 22,
      "notes": {
        "active_status": "Warpcast has transitioned from active badges to power badges, Neynar will deprecate this key in the user object in the next few weeks"
      },
      "object": "user",
      "pfp_url": "https://i.imgur.com/TLMFnH6.jpg",
      "power_badge": true,
      "profile": {
        "bio": {
          "text": "Everyone is from somewhere. Cofounder and CEO of Pinata. https://www.pinata.cloud/farcaster"
        }
      },
      "username": "kyletut",
      "verifications": [
        "0x5ba9355a10611ed4339526472a59befed3549bad"
      ],
      "verified_addresses": {
        "eth_addresses": [
          "0x5ba9355a10611ed4339526472a59befed3549bad"
        ],
        "sol_addresses": []
      }
    },
    "name": "pinata",
    "object": "channel",
    "parent_url": "https://warpcast.com/~/channel/pinata",
    "url": "https://warpcast.com/~/channel/pinata"
  }
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

name
string
required

Display name for the channel you are trying to fetch

Response

200 - application/json

The response is of type object.