Skip to content

Latest commit

 

History

History
62 lines (51 loc) · 3.6 KB

socialfollowers-api.md

File metadata and controls

62 lines (51 loc) · 3.6 KB
description layout
Learn all the detailed references of SocialFollowers API that provide a given user's social followers information, including the input filters, supported chains, and output fields.
title description tableOfContents outline pagination
visible
true
visible
true
visible
true
visible
true
visible
true

SocialFollowers API

The SocialFollowers APIs deliver on-chain and off-chain user-level followers data pertaining to users of Farcaster network.

Inputs

filter

Name Type Description
blockNumber Int_Comparator_Exp Blocknumber when the follows occured onchain.
dappName SocialDappName_Comparator_Exp Social DApp name – farcaster
dappSlug SocialDappSlug_Comparator_Exp Social DApp slug (contract version) – farcaster_optimism, farcaster_goerli
followerProfileId String_Comparator_Exp Farcaster follower FID
followingProfileId String_Comparator_Exp Farcaster following FID
followerSince Time_Comparator_Exp Time the follows was started
identity Identity_Comparator_Exp Identity: blockchain address, domain name, social identity

blockchain

{% hint style="info" %} For SocialFollowers API, it will return Farcaster followers data from all onchain and offchain sources.

You just need to specify the input to ALL for the query to work. {% endhint %}

Enum Description
ALL -

Outputs

Name Type Description
blockchain EveryBlockchain Blockchain associated with the social identity.
blockNumber Int Blocknumber when the follows occured onchain.
dappName String Social DApp name – farcaster
dappSlug String Social DApp slug (contract version) – farcaster_optimism, farcaster_goerli
followerAddress Wallet Nested Query – Follower identity details, e.g. 0x address, Farcaster, ENS, etc.
followerProfileId String Farcaster follower FID.
followerSince Time Timestamp when follows occured onchain.
followingAddress Wallet Nested Query – Following identity details, e.g. 0x address, Farcaster, ENS, etc.
followingProfileId String Farcaster following FID.
id ID Airstack Internal ID.