socials-api.md

description	layout
Learn all the detailed references of Socials API that provide a given user's web3 social 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

Socials API

The Socials APIs deliver on-chain and off-chain user-level data pertaining to users on the Farcaster network.

Inputs

filter

Name	Type	Description
dappName	SocialDappName_Comparator_Exp	Social DApp name – farcaster
dappSlug	SocialDappSlug_Comparator_Exp	Social DApp slug (contract version) –farcaster_optimism, farcaster_goerli
followerCount	Int_Comparator_Exp	Total number of followers
followingCount	Int_Comparator_Exp	Total number of followings
identity	Identity_Comparator_Exp	Identity: blockchain address, domain name, social identity
isDefault	Boolean_Comparator_Exp	True/false if the profile is set to default on the corresponding dApp
profileName	String_Comparator_Exp	Profile name on the social app (prefix not required)
socialCapitalRank	Int_Comparator_Exp	Filter by social capital rank of a user.
socialCapitalScore	Float_Comparator_Exp	Filter by social capital score of a user.
updatedAt	Time_Comparator_Exp	Last timestamp when Lens/Farcaster profile was updated
userAssociatedAddresses	Address_Comparator_Exp	Any associated Wallet address
userId	String_Comparator_Exp	user ID on the social app (prefix not required)
profileCreatedAtBlockTimestamp	Time_Comparator_Exp	block timestamp when Lens/Farcaster profile was created

blockchain

{% hint style="info" %} For Socials API, it will return Farcaster data from all onchain and offchain sources, not specifically Ethereum.

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

Enum	Description
ethereum	Ethereum mainnet

order

Name	Description
farRank	Sort by Farcaster profile's farrank.
farScore	Sort by Farcaster profile's farcaster score.
followerCount	Sort by the number of users following the Farcaster profile in ascending or descending order.
followingCount	Sort by the number of users being followed by the Farcaster profile in ascending or descending order.
profileCreatedAtBlockTimestamp	Sort by Farcaster profile creation block timestamp in ascending or descending order.
socialCapitalRank	Sort by Farcaster profile's social capital rank.
socialCapitalScore	Sort by Farcaster profile's social capital score.
updatedAt	Sort by Farcaster profile last update timestamp in ascending or descending order.

Outputs

Name	Type	Description
blockchain	Blockchain	Blockchain associated with the social identity
chainId	String	Unique identifier for the blockchain
dappName	SocialDappName	farcaster
dappSlug	SocialDappSlug	Social DApp slug (contract version) with these values: farcaster_optimism, farcaster_goerli, farcaster_v2_optimism,
dappVersion	String	Airstack unique dapp version number
farcasterScore	FarcasterScore	The Farcaster score and rank details associated with the Farcaster user. Keep in mind that the Farscores returned in this field is non-real time. If you are searching for real-time FarScores, then check out realTimeFarScore field instead.
fnames	[String]	Farcaster names of a user, there could be more than one
followerCount	Int	Total number of followers
followerTokenAddress	Address
followers	SocialFollowers	Nested query - list of all followers on Farcaster
followingCount	Int	Total number of followings
followings	SocialFollowings	Nested query – list of all followings on Farcaster
id	ID	Airstack unique identifier for the data point
identity	Identity	Blockchain address, ENS domain name, social identity such as Farcaster (for Farcaster use 'fc_fid:' prefix followed by the Farcaster user ID like fc_fid:5650, or use 'fc_fname:' prefix followed by the Farcaster user ID like 'fc_fname:vbuterin')
isDefault	Boolean	Always false. (Legacy feature)
profileCreatedAtBlockNumber	Int	Block number when the social profile was created.
profileCreatedAtBlockTimestamp	Time	Timestamp when the social profile was created.
profileLastUpdatedAtBlockNumber	Int	Block number when the social profile was last updated.
profileLastUpdatedAtBlockTimestamp	Time	Timestamp when the social profile was last updated.
profileBio	String	Social profile bio on Farcaster.
profileDisplayName	String	Social profile display name on Farcaster.
profileImage	String	Link to Social profile image.
profileUrl	String	Social profile URL.
profileName	String	Farcaster profile name (fname primarily used).
profileTokenAddress	Address	The IdRegistry contract address on Optimism.
profileTokenId	String	The user's FID.
profileTokenIdHex	String	Return the hex value of profileTokenId
profileTokenUri	String	Token URI of Lens Profile NFT. For Farcaster, this will return empty string.
realTimeFarScore	RealTimeFarScore	The real-time FarScore details of the Farcaster users.
socialCapital	SocialCapital	Farcaster user's social capital score.
updatedAt	Time	Timestamp when the social profile was last updated.
userAddressDetails	Wallet	Nested Queries – Wallet details of custody address from userAddress field.
userAssociatedAddressDetails	[Wallet!]	Nested Queries – Wallet details of all associated addresses from userAssociatedAddresses field.
userAddress	Address	User's custody address.
userAssociatedAddresses	[Address!]	All addresses associated with the social profiles. For Farcaster, it will return both the custody and connected addresses. If you are only fetching connected addresses, use connectedAddresses field instead.
userCreatedAtBlockNumber	Int	Block number when the social profile was created.
userCreatedAtBlockTimestamp	Number	Timestamp when the social profile was created.
userHomeURL	String	Social Profile Home URL.
userId	String	For Farcaster, it's the user's FID.
userLastUpdatedAtBlockNumber	Int	Block number when the social profile was last updated.
userLastUpdatedAtBlockTimestamp	Number	Timestamp when the social profile was last updated.
userRecoveryAddress	Address	Farcaster user's recovery address.
handleTokenAddress	Address	Empty string. (Legacy Feature)
handleTokenId	String	Empty string. (Legacy Feature)
metadataURI	String	Empty string. (Legacy Feature)
profileMetadata	Map	LEmpty string. (Legacy Feature)
coverImageURI	String	URI to the cover image of a social profile.
totalSpendAllowance	TotalSpendAllowance	Nested Query – provide details on a user's smart allowances.
twitterUserName	String	Empty string. (Legacy Feature)
website	String	Social profile's website.
location	String	Social profile's location.
profileImageContentValue	Media	Nested Query – resized profile images.
coverImageContentValue	Media	Nested Query – resized cover images.
profileHandle	String	For Farcaster, this is equivalent to profileName.