Socials API
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.
The Socials APIs deliver on-chain and off-chain user-level data pertaining to users of web3 social protocols such as Farcaster, and Lens.
Inputs
filter
Name | Type | Description |
---|---|---|
|
| Social DApp name â lens, farcaster |
|
| Social DApp slug (contract version) â lens_polygon, lens_v2_polygon, farcaster_optimism, farcaster_goerli |
|
| Total number of followers |
|
| Total number of followings |
|
| Identity: blockchain address, domain name, social identity |
|
| True/false if the profile is set to default on the corresponding dApp |
|
| Profile name on the social app (prefix not required) |
|
| Filter by social capital rank of a user. |
|
| Filter by social capital score of a user. |
|
| Last timestamp when Lens/Farcaster profile was updated |
|
| Any associated Wallet address |
|
| user ID on the social app (prefix not required) |
|
| block timestamp when Lens/Farcaster profile was created |
blockchain
For Socials API, it will return Lens & Farcaster data from all onchain and offchain sources, not specifically Ethereum.
You just need to specify the input for the query to work.
Enum | Description |
---|---|
| Ethereum mainnet |
order
Name | Description |
---|---|
| Sort by Farcaster profile's farrank. |
| Sort by Farcaster profile's farcaster score. |
| Sort by the number of users following the Lens/Farcaster profile on Lens/Farcaster in ascending or descending order. |
| Sort by the number of users being followed by the Lens/Farcaster profile on Lens/Farcaster in ascending or descending order. |
| Sort by Lens/Farcaster profile creation block timestamp in ascending or descending order. |
| Sort by Farcaster profile's social capital rank. |
| Sort by Farcaster profile's social capital score. |
| Sort by Lens/Farcaster profile last update timestamp in ascending or descending order. |
Outputs
Name | Type | Description |
---|---|---|
|
| Blockchain associated with the social identity |
|
| Unique identifier for the blockchain |
|
| Either |
|
| Social DApp slug (contract version) with these values: |
|
| Airstack unique dapp version number |
| The Farcaster score and rank details associated with the Farcaster user. This value will not be assigned for Lens accounts. | |
|
| Farcaster names of a user, there could be more than one |
|
| Total number of followers |
|
| |
| Nested query - list of all followers on Farcaster or Lens | |
|
| Total number of followings |
| Nested query â list of all followings on Farcaster or Lens | |
|
| Airstack unique identifier for the data point |
|
| 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') or Lens (e.g. 'stani.lens) |
|
| Whether a social profile is default/primary or not, only apply to Lens, Farcaster always |
|
| Block number when the social profile was created. |
|
| Timestamp when the social profile was created. |
|
| Block number when the social profile was last updated. |
|
| Timestamp when the social profile was last updated. |
|
| Social profile bio on Farcaster or Lens. |
|
| Social profile display name on Farcaster or Lens. |
|
| Link to Social profile image. |
|
| Social profile URL. |
|
| Farcaster profile name (fname primarily used) or Lens profile name (e.g. |
|
| For Farcaster, it is going to return the IdRegistry contract address on Optimism. For Lens, it will return Lens profile NFT contract address on Polygon. |
|
| For Farcaster, it's the user's FID. For Lens, it's the user's profile NFT's token ID. |
|
| Return the hex value of |
|
| Token URI of Lens Profile NFT. For Farcaster, this will return empty string. |
| Farcaster user's social capital score. | |
|
| Timestamp when the social profile was last updated. |
| Nested Queries â Wallet details of custody address from | |
| Nested Queries â Wallet details of all associated addresses from | |
|
| User's custody 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 |
|
| Block number when the social profile was created. |
|
| Timestamp when the social profile was created. |
|
| Social Profile Home URL. |
|
| For Farcaster, it's the user's FID. For Lens, it's the user's profile NFT's token ID. |
|
| Block number when the social profile was last updated. |
|
| Timestamp when the social profile was last updated. |
|
| Farcaster user's recovery address. For Lens, it will return empty string. |
|
| Lens Handle NFT contract address. For Farcaster, this will return an empty string. |
|
| Lens Handle NFT token ID associated with the profile. For Farcaster, this will return an empty string. |
|
| Lens profile NFT metadata URI. This will return |
|
| Lens profile NFT metadata. This will return |
|
| URI to the cover image of a social profile. |
|
| Social profile's twitter (from Lens). |
|
| Social profile's website. |
|
| Social profile's location. |
|
| Nested Query â resized profile images. |
|
| Nested Query â resized cover images. |
|
| For Farcaster, this is equivalent to |
Last updated