Getting Profiles

Find and load a single profile#

flatApi.findProfile(id: AnyAccountId): Promise<ProfileData | undefined>

Example:

flatApi.findProfile('3osmnRNnrcScHsgkTJH1xyBF5kGjpbWHsGrqM31BJpy4vwn8')

Output:

{
    "id": "3osmnRNnrcScHsgkTJH1xyBF5kGjpbWHsGrqM31BJpy4vwn8",
    "struct": {
        "id": "3osmnRNnrcScHsgkTJH1xyBF5kGjpbWHsGrqM31BJpy4vwn8",
        "followersCount": 473,
        "followingAccountsCount": 16,
        "followingSpacesCount": 337,
        "reputation": 112873,
        "hasProfile": true,
        "createdByAccount": "3osmnRNnrcScHsgkTJH1xyBF5kGjpbWHsGrqM31BJpy4vwn8",
        "createdAtBlock": 717415,
        "createdAtTime": 1601225712000,
        "isUpdated": true,
        "updatedByAccount": "3osmnRNnrcScHsgkTJH1xyBF5kGjpbWHsGrqM31BJpy4vwn8",
        "updatedAtBlock": 717425,
        "updatedAtTime": 1601225772000,
        "contentId": "bafyreihqm342gynm5ubkb3is4736t5tdgu7znkm6k5ew44mys7ab34wqvu"
    },
    "content": {
        "about": "Subsocial official account.",
        "avatar": "Qmasp4JHhQWPkEpXLHFhMAQieAH1wtfVRNHWZ5snhfFeBe",
        "name": "Subsocial",
        "summary": "Subsocial official account.",
        "isShowMore": false
    }
}

🆃 AnyAccountId: AccountId | string

🆃 ProfileData: CommonData < SocialAccountWithId, ProfileContent > & { profile?: Profile }

Find and load an array of profiles#

flatApi.findProfiles(ids: AnyAccountId[]): Promise<ProfileData[]>

Find and load structs and contents separately#

Get structs#

flatApi.findProfileStructs(ids: AnyAccountId[]): Promise<ProfileStruct[]>
flatApi.findProfileStruct(id: AnyAccountId): Promise<ProfileStruct | undefined>

Example:

flatApi.findProfileStruct('3osmnRNnrcScHsgkTJH1xyBF5kGjpbWHsGrqM31BJpy4vwn8')

Output:

{
  "id": "3osmnRNnrcScHsgkTJH1xyBF5kGjpbWHsGrqM31BJpy4vwn8",
  "followersCount": 473,
  "followingAccountsCount": 16,
  "followingSpacesCount": 337,
  "reputation": 112873,
  "hasProfile": true,
  "createdByAccount": "3osmnRNnrcScHsgkTJH1xyBF5kGjpbWHsGrqM31BJpy4vwn8",
  "createdAtBlock": 717415,
  "createdAtTime": 1601225712000,
  "isUpdated": true,
  "updatedByAccount": "3osmnRNnrcScHsgkTJH1xyBF5kGjpbWHsGrqM31BJpy4vwn8",
  "updatedAtBlock": 717425,
  "updatedAtTime": 1601225772000,
  "contentId": "bafyreihqm342gynm5ubkb3is4736t5tdgu7znkm6k5ew44mys7ab34wqvu"
}

Get contents#

Find and load off-chain information about profiles from IPFS by a given cid.

Profile information only exists if there is a corresponding JSON file that represents the profile's content on IPFS.

flatApi.subsocial.ipfs.findProfiles(cids: IpfsCid[]): Promise<ContentResult<ProfileContent>>
flatApi.subsocial.ipfs.findProfile(cid: IpfsCid): Promise<ProfileContent | undefined>

Example:

import { convertToDerivedContent } from "@subsocial/api/flat-subsocial/utils";

(async () => {
  convertToDerivedContent(await res.subsocial.ipfs.findProfile("bafyreihqm342gynm5ubkb3is4736t5tdgu7znkm6k5ew44mys7ab34wqvu"))
})()

Output:

{
  "bafyreihqm342gynm5ubkb3is4736t5tdgu7znkm6k5ew44mys7ab34wqvu": {
    "about": "Subsocial official account.",
    "avatar": "Qmasp4JHhQWPkEpXLHFhMAQieAH1wtfVRNHWZ5snhfFeBe",
    "name": "Subsocial",
    "summary": "Subsocial official account.",
    "isShowMore": false
  }
}

🆃 IpfsCid: string | CID | IpfsCid

🆃 ContentResult <T>: Record<CidAsStr, T>

🆃 ProfileContent: { about: string; avatar: string; name: string }