Search for channels based on id or name

farcasterChannel.getChannelSearch

Overview

Returns a list of channels based on id or name

Parameters

name	type	required	Note
q	string	true	ex) lum0x

Usage

Typescript

let res = await Lum0x.farcasterChannel.getChannelSearch({
    q: "founders"
});
console.log(JSON.stringify(res, null, 2));

Response

{
  "channels": [
    {
      "id": "founders",
      "url": "https://farcaster.group/founders",
      "name": "Founders",
      "description": "A space for founders",
      "follower_count": 185965,
      "object": "channel",
      "image_url": "https://warpcast.com/~/channel-images/founders.png",
      "created_at": 1697505197,
      "parent_url": "https://farcaster.group/founders",
      "lead": {
        "object": "user",
        "fid": 3,
        "custody_address": "0x6b0bda3f2ffed5efc83fa8c024acff1dd45793f1",
        "username": "dwr.eth",
        "display_name": "Dan Romero",
        "pfp_url": "https://res.cloudinary.com/merkle-manufactory/image/fetch/c_fill,f_png,w_256/https://lh3.googleusercontent.com/MyUBL0xHzMeBu7DXQAqv0bM9y6s4i4qjnhcXz5fxZKS3gwWgtamxxmxzCJX7m2cuYeGalyseCA2Y6OBKDMR06TWg2uwknnhdkDA1AA",
        "profile": {
          "bio": {
            "text": "Working on Farcaster and Warpcast."
          }
        },
        "follower_count": 475914,
        "following_count": 3380,
        "verifications": [
          "0xd7029bdea1c17493893aafe29aad69ef892b8ff2"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0xd7029bdea1c17493893aafe29aad69ef892b8ff2"
          ],
          "sol_addresses": []
        },
        "active_status": "inactive",
        "power_badge": true
      },
      "hosts": [
        {
          "object": "user",
          "fid": 3,
          "custody_address": "0x6b0bda3f2ffed5efc83fa8c024acff1dd45793f1",
          "username": "dwr.eth",
          "display_name": "Dan Romero",
          "pfp_url": "https://res.cloudinary.com/merkle-manufactory/image/fetch/c_fill,f_png,w_256/https://lh3.googleusercontent.com/MyUBL0xHzMeBu7DXQAqv0bM9y6s4i4qjnhcXz5fxZKS3gwWgtamxxmxzCJX7m2cuYeGalyseCA2Y6OBKDMR06TWg2uwknnhdkDA1AA",
          "profile": {
            "bio": {
              "text": "Working on Farcaster and Warpcast."
            }
          },
          "follower_count": 475914,
          "following_count": 3380,
          "verifications": [
            "0xd7029bdea1c17493893aafe29aad69ef892b8ff2"
          ],
          "verified_addresses": {
            "eth_addresses": [
              "0xd7029bdea1c17493893aafe29aad69ef892b8ff2"
            ],
            "sol_addresses": []
          },
          "active_status": "inactive",
          "power_badge": true
        },
        {
          "object": "user",
          "fid": 368422,
          "custody_address": "0x16d25ca06a054fc7752e1ae63ca8b23ce6fa2da4",
          "username": "automod",
          "display_name": "automod",
          "pfp_url": "https://i.imgur.com/K1SLPRA.jpg",
          "profile": {
            "bio": {
              "text": "automod.sh — power tools for your channel. Setup in < 2min."
            }
          },
          "follower_count": 4872,
          "following_count": 65,
          "verifications": [],
          "verified_addresses": {
            "eth_addresses": [],
            "sol_addresses": []
          },
          "active_status": "inactive",
          "power_badge": false
        }
      ],
      "moderator": null
    },
    {
      "id": "foundersforum",
      "url": "https://warpcast.com/~/channel/foundersforum",
      "name": "foundersforum",
      "description": "",
      "follower_count": 24,
      "object": "channel",
      "image_url": "https://i.imgur.com/QnZcpYc.png",
      "created_at": 1715696902,
      "parent_url": "https://warpcast.com/~/channel/foundersforum",
      "lead": {
        "object": "user",
        "fid": 1285,
        "custody_address": "0x322d3353c3bd12f9a5308f90c808364326274178",
        "username": "benersing",
        "display_name": "Ben  🟪",
        "pfp_url": "https://i.imgur.com/qdfZSol.gif",
        "profile": {
          "bio": {
            "text": "Principal at Cobalt Ventures. Write @ TheItinerant.io ; BenErsing.com Host: /venturecapital /finance /adventures"
          }
        },
        "follower_count": 112637,
        "following_count": 1166,
        "verifications": [
          "0xc4abbd82cb52a7e7e991e030344799acfe013c95"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0xc4abbd82cb52a7e7e991e030344799acfe013c95"
          ],
          "sol_addresses": [
            "CFkrFNYe4LNGYoKGagxYYy7VCGEpoub5xGioxoVwZPGT"
          ]
        },
        "active_status": "inactive",
        "power_badge": true
      },
      "hosts": [
        {
          "object": "user",
          "fid": 1285,
          "custody_address": "0x322d3353c3bd12f9a5308f90c808364326274178",
          "username": "benersing",
          "display_name": "Ben  🟪",
          "pfp_url": "https://i.imgur.com/qdfZSol.gif",
          "profile": {
            "bio": {
              "text": "Principal at Cobalt Ventures. Write @ TheItinerant.io ; BenErsing.com Host: /venturecapital /finance /adventures"
            }
          },
          "follower_count": 112637,
          "following_count": 1166,
          "verifications": [
            "0xc4abbd82cb52a7e7e991e030344799acfe013c95"
          ],
          "verified_addresses": {
            "eth_addresses": [
              "0xc4abbd82cb52a7e7e991e030344799acfe013c95"
            ],
            "sol_addresses": [
              "CFkrFNYe4LNGYoKGagxYYy7VCGEpoub5xGioxoVwZPGT"
            ]
          },
          "active_status": "inactive",
          "power_badge": true
        }
      ],
      "moderator": null
    }
  ]
}

Field	Channel ID	URL	Name	Description	Follower Count	Image URL	Created At	Parent URL	Lead User Details	Host User Details	Moderator Details
Channel Object	founders	Link	Founders	A space for founders	185,965		2023-10-17	Link	Username: dwr.eth Display Name: Dan Romero Follower Count: 475,914 Profile Picture:	Username: dwr.eth Display Name: Dan Romero Follower Count: 475,914 Profile Picture: Bio: automod.sh — power tools for your channel. Setup in < 2min. Follower Count: 4872 Profile Picture:	None
Channel Object	foundersforum	Link	foundersforum	(빈 값)	24		2024-04-09	Link	Username: benersing Display Name: Ben 🟪 Follower Count: 112,637 Profile Picture:	Username: benersing Display Name: Ben 🟪 Follower Count: 112,637 Profile Picture:	None

Field Description

• Channel ID: The unique identifier of the channel.

• URL: The link to the channel.

• Name: The name of the channel.

• Description: The description of the channel. If there is no description, it is shown as an empty value.

• Follower Count: The number of followers of the channel.

• Image URL: The URL of the channel's representative image.

• Created At: The date the channel was created, represented as a Unix timestamp.

• Parent URL: The URL of the parent channel.

• Lead User Details: Details about the user leading the channel, including username, display name, follower count, and profile picture URL.

• Host User Details: Details about the host user of the channel, including username, display name, follower count, profile picture URL, and bio.

• Moderator Details: Details about the channel's moderators. If there are no moderators, it is shown as None.