Fetch Accounts

This guide will help you with fetching Account data from the Lens API.

Lens Account data is comprised of:

To illustrate how to fetch accounts, we will use the following fragment, which includes some of the most common fields of an Account:

fragment Account on Account {  address  username  metadata {    name    picture  }}

In the end of this guide, we will expand on some of the fields that are not fully covered in the example above.

query {  account(    request: {      username: "lens/wagmi"
      # OR      # address: EvmAddress
      # OR      # legacyProfileId: LegacyProfileId # e.g., "0x05"
      # OR      # txHash: TxHash    }  ) {    address    username    metadata {      name      picture    }  }}

query {  accounts(request: {    usernames: ["lens/wagmi", "lens/ape"]    # addresses: ["0x1234…", "0x5678…"]    # legacyProfileIds: ["0x05", "0x06"]  }) {    address    username    metadata {      name      picture    }  }}

query {  searchAccounts(request: {    query: "bob"  }) {    items {      address      username      metadata {        name        picture      }    }    pageInfo {      prev      next    }  }}

See the Pagination guide for more information on how to handle paginated results.

In this section we will expand on some of the Account fields that are not covered in the examples above.

Although briefly mentioned in the examples, the metadata field is a rich object that can include a variety of information about the account.

It contains the Account Metadata object that was linked to the Account at the time of creation or update. This object can include the following fields:

type AccountMetadata {  # A bag of attributes.  attributes: [MetadataAttribute!]!
  # The profile bio as markdown.  bio: String
  # The profile cover picture.  coverPicture: URI
  # A unique identifier.  id: String!
  # The profile display name.  name: String
  # The profile picture.  picture: URI}

The Lens team has implemented a series of measures to uphold the integrity of the Lens ecosystem. The Account Score is a probability-based measure that evaluates an account's signal strength, helping to reduce the impact of spammy behavior on the user experience. This score is calculated using a set of ML algorithms that consider factors like follower graphs, content, and other variables. Higher scores suggest a positive and active presence within the ecosystem.

fragment Account on Account {  # ...
  score}

The Lens API schema allows fetching detailed account data when requests are made by a logged-in user (i.e., with an Access Token in the request headers). When the Account fragment includes the operations field, it provides insights into the user's interactions with the account and available actions.

fragment Account on Account {  address  username  metadata {    name    picture  }  operations {    isFollowedByMe    isFollowingMe    canFollow    canUnfollow    isMutedByMe    isBlockedByMe    hasBlockedMe    canBlock    canUnblock    hasReported  }}