Retrieve all channels with their details

farcasterChannel.getChannelList

Overview

Returns a list of all channels with their details

Parameters

name	type	required	Note
limit	number	false	default: 25, max: 200
cursor	string	false	ex) eyJwYWdlIjoyfQ==

Usage

Typescript

let res = await Lum0x.farcasterChannel.getChannelList({
    limit: 5
});
console.log(JSON.stringify(res, null, 2));

Response

{
  "channels": [
    {
      "id": "blank",
      "url": "https://warpcast.com/~/channel/blank",
      "name": "blank",
      "description": "",
      "follower_count": 5,
      "object": "channel",
      "image_url": "https://imagedelivery.net/BXluQx4ige9GuW0Ia56BHw/15060c1c-5a79-4e09-6ad3-e08ac9d0af00/original",
      "created_at": 1724297562,
      "parent_url": "https://warpcast.com/~/channel/blank",
      "lead": {
        "object": "user",
        "fid": 210698,
        "custody_address": "0x73de29a64dc4006b6b4c9e295ae76198202445bc",
        "username": "blankspace",
        "display_name": "𝙗𝙡𝙖𝙣𝙠",
        "pfp_url": "https://imagedelivery.net/BXluQx4ige9GuW0Ia56BHw/a306ecda-649f-4cbd-0f78-3eec6e536c00/original",
        "profile": {
          "bio": {
            "text": "(art + design), dev // ⫘⫘⫘ @444437 ⫘⫘⫘"
          }
        },
        "follower_count": 3192,
        "following_count": 1088,
        "verifications": [
          "0x5d2b7f517ea0c3a68e58c32f97b2b2c080ea3d6f"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0x5d2b7f517ea0c3a68e58c32f97b2b2c080ea3d6f"
          ],
          "sol_addresses": []
        },
        "active_status": "inactive",
        "power_badge": true
      },
      "moderator": null
    },
    {
      "id": "chbb",
      "url": "https://warpcast.com/~/channel/chbb",
      "name": "chbb",
      "description": "",
      "follower_count": 1,
      "object": "channel",
      "image_url": "https://i.imgur.com/Enzqljz.png",
      "created_at": 1724289404,
      "parent_url": "https://warpcast.com/~/channel/chbb",
      "lead": {
        "object": "user",
        "fid": 839886,
        "custody_address": "0xf31fc8b515b7099c53bc4b3bbc86349d72713dc0",
        "username": "odin17",
        "display_name": "Bankeradao",
        "pfp_url": "https://imagedelivery.net/BXluQx4ige9GuW0Ia56BHw/429ae1bd-7f99-430f-6370-f5827c419200/rectcrop3",
        "profile": {
          "bio": {
            "text": ""
          }
        },
        "follower_count": 2,
        "following_count": 5,
        "verifications": [
          "0x1466f5596c439142b6f39723eed27c117a97f8ed"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0x1466f5596c439142b6f39723eed27c117a97f8ed"
          ],
          "sol_addresses": []
        },
        "active_status": "inactive",
        "power_badge": false
      },
      "moderator": null
    },
    {
      "id": "nouns-reviews",
      "url": "https://warpcast.com/~/channel/nouns-reviews",
      "name": "nouns-reviews",
      "description": "Review nounish media, products, props, and more. Keep it constructive. The goal is to source constructive criticism and give flowers.",
      "follower_count": 1,
      "object": "channel",
      "image_url": "https://imagedelivery.net/BXluQx4ige9GuW0Ia56BHw/3755b3be-f771-492d-8886-b482de21f500/original",
      "created_at": 1724271616,
      "parent_url": "https://warpcast.com/~/channel/nouns-reviews",
      "lead": {
        "object": "user",
        "fid": 18560,
        "custody_address": "0x77f273801d51a1374427eb2bef80389052e0e94a",
        "username": "carlosjmelgar",
        "display_name": "orCarlos - Noun 976",
        "pfp_url": "https://imagedelivery.net/BXluQx4ige9GuW0Ia56BHw/cb61af4c-6d55-4b19-1adc-f65b9269c500/rectcrop3",
        "profile": {
          "bio": {
            "text": "Doing Nounish, Optimistic and Based thangz"
          }
        },
        "follower_count": 1899,
        "following_count": 571,
        "verifications": [
          "0xca72c93172ba6eff168e59e7f17c3c7a8fea9b62"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0xca72c93172ba6eff168e59e7f17c3c7a8fea9b62"
          ],
          "sol_addresses": []
        },
        "active_status": "inactive",
        "power_badge": true
      },
      "moderator": null
    },
    {
      "id": "startrek",
      "url": "https://warpcast.com/~/channel/startrek",
      "name": "startrek",
      "description": "",
      "follower_count": 1,
      "object": "channel",
      "image_url": "https://i.imgur.com/6HZKy0O.png",
      "created_at": 1724268521,
      "parent_url": "https://warpcast.com/~/channel/startrek",
      "lead": {
        "object": "user",
        "fid": 6142,
        "custody_address": "0xe42c855d75c6cfc9cb8a1f6367de508990963ea8",
        "username": "trav",
        "display_name": "trav 🎩🔵🧾",
        "pfp_url": "https://i.imgur.com/4sDLQmH.jpg",
        "profile": {
          "bio": {
            "text": "I dream about tokens. I like musical chairs."
          }
        },
        "follower_count": 1409,
        "following_count": 578,
        "verifications": [
          "0x4ac4ec3fa79585de9487561e1ff9aa76ae1a009b"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0x4ac4ec3fa79585de9487561e1ff9aa76ae1a009b"
          ],
          "sol_addresses": []
        },
        "active_status": "inactive",
        "power_badge": false
      },
      "moderator": null
    },
    {
      "id": "pkokcurated",
      "url": "https://warpcast.com/~/channel/pkokcurated",
      "name": "curated art",
      "description": "We're bringing the best of digital art from across web3, curated by some of the finest curators, in this curated channel. \n\nAlso working on establishing a patrons program to reward creators",
      "follower_count": 12,
      "object": "channel",
      "image_url": "https://imagedelivery.net/BXluQx4ige9GuW0Ia56BHw/037a4710-611c-4416-d733-eecdb5ecb800/original",
      "created_at": 1724268202,
      "parent_url": "https://warpcast.com/~/channel/pkokcurated",
      "lead": {
        "object": "user",
        "fid": 833785,
        "custody_address": "0x0a13a0ae5bc4e64be75d68037d63e39bff4574c3",
        "username": "pkok",
        "display_name": "PKOK ART",
        "pfp_url": "https://imagedelivery.net/BXluQx4ige9GuW0Ia56BHw/742a4f72-91dc-46a4-02d0-3e322b8c9300/rectcrop3",
        "profile": {
          "bio": {
            "text": "Arthouse into creating, curating & collecting art  |  /pkok /pkokcurated  |  pkok.art (coming soon)  |  founder @sunnysangwan     "
          }
        },
        "follower_count": 80,
        "following_count": 65,
        "verifications": [
          "0x64890f10a5b02bf10f170ddde4540b858005bb8f"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0x64890f10a5b02bf10f170ddde4540b858005bb8f"
          ],
          "sol_addresses": []
        },
        "active_status": "inactive",
        "power_badge": false
      },
      "moderator": {
        "object": "user",
        "fid": 440220,
        "custody_address": "0x2b08616f12d84aa2fdd795b6d14d48a284040d9f",
        "username": "notabot",
        "display_name": "Not A Bot",
        "pfp_url": "https://i.imgur.com/tjgOEAe.jpg",
        "profile": {
          "bio": {
            "text": ""
          }
        },
        "follower_count": 1886,
        "following_count": 0,
        "verifications": [],
        "verified_addresses": {
          "eth_addresses": [],
          "sol_addresses": []
        },
        "active_status": "inactive",
        "power_badge": false
      }
    }
  ],
  "next": {
    "cursor": "eyJwYWdlIjoyfQ%3D%3D"
  }
}

Field	Channel ID	URL	Name	Description	Follower Count	Image URL	Created At	Parent URL	Lead User Details	Moderator Details
Channel Object	blank	Link	blank	(빈 값)	5		2024-05-22	Link	Username: blankspace Display Name: 𝙗𝙡𝙖𝙣𝙠 Follower Count: 3192 Profile Picture:	None
Channel Object	chbb	Link	chbb	(빈 값)	1		2024-05-21	Link	Username: odin17 Display Name: Bankeradao Follower Count: 2 Profile Picture:	None
Channel Object	nouns-reviews	Link	nouns-reviews	Review nounish media, products, props, and more. Keep it constructive. The goal is to source constructive criticism and give flowers.	1		2024-05-20	Link	Username: carlosjmelgar Display Name: orCarlos - Noun 976 Follower Count: 1899 Profile Picture:	None
Channel Object	startrek	Link	startrek	(빈 값)	1		2024-05-19	Link	Username: trav Display Name: trav 🎩🔵🧾 Follower Count: 1409 Profile Picture:	None
Channel Object	pkokcurated	Link	curated art	We're bringing the best of digital art from across web3, curated by some of the finest curators, in this curated channel. Also working on establishing a patrons program to reward creators	12		2024-05-19	Link	Username: pkok Display Name: PKOK ART Follower Count: 80 Profile Picture:	Username: notabot Display Name: Not A Bot Follower Count: 1886 Profile Picture:

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.

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